QSoftMenuBarProvider Class Reference
[QtUiModule]

Detailed Description

The QSoftMenuBarProvider class provides the backend for the QSoftMenuBar API.

The QSoftMenuBar class allows applications to control a context specific soft key bar. The QSoftMenuBarProvider manages the state of the soft bar on behalf of a specific UI implementation.

Internally the QSoftMenuBar class sends QCop messages to communicate with the QSoftMenuBarProvider instance. The "context specific" aspects of the bar are managed in the QSoftMenuBar instance and messages are only sent when the bar UI needs to update. Three QCop messages are used on the QPE/QSoftMenuBar channel.

The soft keys available on a device are configured in the SoftKeys group of the defaultbuttons.conf configuration file. For example, the following snippet configures three softkeys - Context1, Select and Back.

    [SoftKeys]
    Count=3
    Key0=Context1
    Key1=Select
    Key2=Back

Valid key entries are those understood by the QKeySequence class. The QSoftMenuBarProvider class will only respond to keys configured in this way.

This class is part of the Qt Extended server and cannot be used by other Qt Extended applications.

Member Function Documentation

QSoftMenuBarProvider::QSoftMenuBarProvider ( QObject * parent = 0 )

Create a new QSoftMenuBarProvider instance, with the specified parent.

QSoftMenuBarProvider::~QSoftMenuBarProvider ()   [virtual]

Destroys the QSoftMenuBarProvider instance.

MenuButton QSoftMenuBarProvider::key ( int index ) const

Returns a key description for the index 'th key. index must be less than keyCount().

void QSoftMenuBarProvider::keyChanged ( const QSoftMenuBarProvider::MenuButton & button )   [signal]

Emitted whenever the text or image for button has changed.

void QSoftMenuBarProvider::keyChanged ( int key )   [signal]

This is an overloaded member function, provided for convenience.

Emitted when the text or image mapped to the Qt::Key key has changed.

int QSoftMenuBarProvider::keyCount () const

Returns the number of configured keys.

QList<MenuButton> QSoftMenuBarProvider::keys () const

Returns a list of key descriptions for all configured keys.