Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

MessageBoard Class Reference
[QtTelephonyModule, QtUiModule]

The MessageBoard class provides a message hub for user information. More...

    #include <MessageBoard>

Inherits QObject.

• List of all members, including inherited members

Public Types

• class Note

Public Functions

• MessageBoard ( QObject * parent = 0 )
• ~MessageBoard ()
• void clearMessage ( int identifier )
• bool isEmpty () const
• Note message ( int id ) const
• Note message () const
• int postMessage ( const QString & pixmap, const QString & text, int priority = 10 )

• 29 public functions inherited from QObject

Signals

• void boardUpdated ()

• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The MessageBoard class provides a message hub for user information.

The class stores information to be shown to the user. Messages on the board are sorted according to their priority (0 being the highest priority). New messages can be added to the board via postMessage() and the message with the highest priority can be retrieved via message().

The MessageBoard uses qStableSort to sort messages according to their id. This means that new messages with the same priority as an already existing message will appear after the old message.

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

See also QAbstractHomeScreen and MessageBoard::Note.

Member Function Documentation

MessageBoard::MessageBoard ( QObject * parent = 0 )

Creates a new MessageBoard instance with the given parent.

MessageBoard::~MessageBoard ()

Destroys the message boad instance.

void MessageBoard::boardUpdated ()   [signal]

Emitted when a new message is either added or removed from the board.

void MessageBoard::clearMessage ( int identifier )

Removes the message with the given identifier from the message board.

bool MessageBoard::isEmpty () const

Returns true if there are no messages on the board.

Note MessageBoard::message ( int id ) const

Returns the message with the given id. If no message with the given id exists the returned note contains an empty string.

Note MessageBoard::message () const

This is an overloaded member function, provided for convenience.

This function returns the message with the highest priority.

int MessageBoard::postMessage ( const QString & pixmap, const QString & text, int priority = 10 )

Adds a new message with the given text, pixmap and priority. This function returns -1 if the new message could not be added.