path: root/core/launcher/serverinterface.cpp

/**********************************************************************
** Copyright (C) 2000-2002 Trolltech AS.  All rights reserved.
**
** This file is part of the Qtopia Environment.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/
#include "serverinterface.h"
#include "server.h"
#include "documentlist.h"

#include <qtopia/qpeapplication.h>
#include <qwindowsystem_qws.h>
#include <qgfx_qws.h>

class LayoutManager : public QObject
{
    Q_OBJECT
public:
    LayoutManager();

    void addDocked( QWidget *w, ServerInterface::DockArea placement );

private:
    struct Item {
	QWidget *w;
	ServerInterface::DockArea p;
    };

    bool eventFilter( QObject *object, QEvent *event );
    void layout();
    Item *findWidget( const QWidget *w ) const;

    QList<Item> docked;
};

LayoutManager::LayoutManager()
{
    docked.setAutoDelete( TRUE );
    qApp->desktop()->installEventFilter( this );
}

void LayoutManager::addDocked( QWidget *w, ServerInterface::DockArea placement )
{
    Item *i = new Item;
    i->w = w;
    i->p = placement;
    w->installEventFilter( this );
    docked.append(i);
    layout();
}

bool LayoutManager::eventFilter( QObject *object, QEvent *event )
{
    if ( object == qApp->desktop() ) {
	if ( event->type() == QEvent::Resize )
	    layout();
	return QObject::eventFilter( object, event );
    }

    Item *item;

    switch ( event->type() ) {
	case QEvent::Destroy:
	    item = findWidget( (QWidget *)object );
	    if ( item ) {
		docked.removeRef( item );
		layout();
	    }
	    break;

	case QEvent::Hide:
	case QEvent::Show:
	    item = findWidget( (QWidget *)object );
	    if ( item )
		layout();
	    break;

	default:
	    break;
    }

    return QObject::eventFilter( object, event );
}

void LayoutManager::layout()
{
    QRect mwr( qApp->desktop()->geometry() );
    QListIterator<Item> it( docked );
    Item *item;
    for ( ; (item = it.current()); ++it ) {
	QWidget *w = item->w;
	if ( !w->isVisible() )
	    continue;

        QSize sh = w->sizeHint();
	switch ( item->p ) {
	    case ServerInterface::Top:
                w->setGeometry( mwr.left(), mwr.top(),
                                mwr.width(), sh.height() );
		mwr.setTop( w->geometry().bottom() + 1 );
		break;
	    case ServerInterface::Bottom:
                w->setGeometry( mwr.left(), mwr.bottom() - sh.height(),
                                mwr.width(), sh.height() );
		mwr.setBottom( w->geometry().top() - 1 );
		break;
	    case ServerInterface::Left:
                w->setGeometry( mwr.left(), mwr.top(),
                                sh.width(), mwr.height() );
		mwr.setLeft( w->geometry().right() + 1 );
		break;
	    case ServerInterface::Right:
                w->setGeometry( mwr.right() - sh.width(), mwr.top(),
                                sh.width(), mwr.height() );
		mwr.setRight( w->geometry().left() - 1 );
		break;
	}
    }

#ifdef Q_WS_QWS
# if QT_VERSION < 0x030000
    QWSServer::setMaxWindowRect( qt_screen->mapToDevice(mwr,
	QSize(qt_screen->width(),qt_screen->height())) );
# else
    QWSServer::setMaxWindowRect( mwr );
# endif
#endif
}

LayoutManager::Item *LayoutManager::findWidget( const QWidget *w ) const
{
    QListIterator<Item> it( docked );
    Item *item;
    for ( ; (item = it.current()); ++it ) {
	if ( item->w == w )
	    return item;
    }

    return 0;
}

//---------------------------------------------------------------------------

/*! \class ServerInterface serverinterface.h
  \brief The ServerInterface class provides an interface for Qtopia
  custom launchers.

  The ServerInterface allows the user interface of the launcher to be
  customized to suit the device.  For a PDA style device, the default
  launcher is strongly recommended, however specialist devices may
  choose to provide a launcher better suited to the application.

  The launcher is fixed for any particular device and is not loaded
  as a plugin.  Launcher interfaces must
  be compilied into the server by editing server.pro and server.cpp.
*/

/*!
  \fn ServerInterface::createGUI()

  Implement this function to create the custom launcher UI.
*/

/*!
  \fn ServerInterface::destroyGUI()

  Implement this function to destroy the custom launcher UI.  All resources
  allocated by createGUI() must be released.
*/

/*!
  \enum ServerInterface::ApplicationState

  The ApplicationState enum type specifies the state of an application.
  The possible values are: <ul>

  <li> \c Launching - the application has been requested, but is not yet running.
  <li> \c Running - the application is running.
  <li> \c Terminated - the application has been terminated.
</ul>
*/

/*!
  \fn ServerInterface::applicationStateChanged(const QString& name, ApplicationState state)

  The application \a name has changed state to \a state.  This can be used
  to show launch notification and update a list of running applications.
*/

/*!
  \fn ServerInterface::typeAdded(const QString& type, const QString& name, const QPixmap& pixmap, const QPixmap& bgPixmap)

  An application category \a type has been added, for example "Games".
  \a name is the translated name of the category.  \a pixmap and
  \a bgPixmap are small and large icons for the new type.

  Types can be added or removed at any time, for example, when a storage
  card containing a non-standard category is inserted or removed.

  \sa typeRemoved()
*/

/*!
  \fn ServerInterface::typeRemoved(const QString& type)

  An application category \a type has been removed.

  Types can be added or removed at any time, for example, when a storage
  card containing a non-standard category is inserted or removed.

  \sa typeAdded()
*/

/*!
  \fn ServerInterface::applicationAdded(const QString& type, const AppLnk& app)

  Add an application \a app of type \a type to the launcher.

  \sa applicationRemoved()
*/

/*!
  \fn ServerInterface::applicationRemoved(const QString& type, const AppLnk& app)

  Remove an application \a app of type \a type from the launcher.

  \sa applicationAdded()
*/

/*!
  \fn ServerInterface::allApplicationsRemoved()

  Remove all applications from the launcher.
*/

/*!
  \fn const AppLnkSet &ServerInterface::appLnks()

  Returns the current set of available applications.
*/

/*!
  \fn ServerInterface::documentAdded(const DocLnk& doc)

  Add a document \a doc to the launcher.

  \sa documentRemoved()
*/

/*!
  \fn ServerInterface::documentRemoved(const DocLnk& doc)

  Remove a document \a doc to the launcher.

  \sa documentAdded()
*/

/*!
  \fn ServerInterface::documentChanged(const DocLnk& oldDoc, const DocLnk& newDoc)

  Change document properties of existing document \a oldDoc to \a newDoc.
*/

/*!
  \fn ServerInterface::allDocumentsRemoved()

  Remove all documents from the launcher.
*/

/*!
  \fn ServerInterface::storageChanged(const QList<FileSystem> &)

  A filesystem has been added or removed.
*/

/*!
  \fn ServerInterface::applicationScanningProgress(int percent)

  The system is scanning for installed applications.  \a percent
  provides the percentage of the filesystems scanned.  This function will
  always be called with \a percent equal to zero when scanning starts,
  and with \a percent equal to 100 when scanning is complete.
*/

/*!
  \fn ServerInterface::documentScanningProgress(int percent)

  The system is scanning for documents.  \a percent
  provides the percentage of the filesystems scanned.  This function will
  always be called with \a percent equal to zero when scanning starts,
  and with \a percent equal to 100 when scanning is complete.
*/

/*!
  \fn bool ServerInterface::requiresApplications() const

  Return TRUE if the custom launcher requires the server to scan for
  applications.
*/

/*!
  \fn bool ServerInterface::requiresDocuments() const

  Return TRUE if the custom launcher requires the server to scan for
  documents.
*/

/*!
  \enum ServerInterface::DockArea

  The DockArea enum type defines the areas where widgets can be docked:
  <ul>
  <li> \c Top - the top of the screen.
  <li> \c Bottom - the Bottom of the screen.
  <li> \c Left - the Left of the screen.
  <li> \c Right - the Right of the screen.
  </ul>
*/

/*!
  \fn ServerInterface::dockWidget(QWidget *w, DockArea placement)

  Docks a top-level widget \a w on a side of the screen specified by
  \a placement.  The widget is placed
  according to the order that it was docked, its sizeHint() and whether
  previously docked widgets are visible.  The desktop area available to
  QWidget::showMaximized() will exclude any visible docked widgets.

  For example, if a widget is
  docked at the bottom of the screen, its sizeHint() will define its
  height and it will use the full width of the screen.  If a widget is
  then docked to the right, its sizeHint() will define its width and
  it will be as high as possible without covering
  the widget docked at the bottom.

  This function is useful for reserving system areas such as taskbars
  and input methods that should not be covered by applications.
*/


ServerInterface::~ServerInterface()
{
}

void ServerInterface::dockWidget( QWidget *w, DockArea placement )
{
    static LayoutManager *lm = 0;

    if ( !lm )
	lm = new LayoutManager;

    lm->addDocked( w, placement );
}

const AppLnkSet& ServerInterface::appLnks()
{
    return *DocumentList::appLnkSet;
}

#include "serverinterface.moc"