Applets
SystemTray::Task Class Reference
System tray task base class. More...
#include <task.h>

Public Types | |
enum | Order { First, Normal, Last } |
Signals | |
void | changed (SystemTray::Task *task=0) |
void | destroyed (SystemTray::Task *task=0) |
Public Member Functions | |
QList< QGraphicsWidget * > | associatedWidgets () const |
virtual QIcon | icon () const =0 |
virtual bool | isEmbeddable () const =0 |
virtual bool | isHideable () const |
virtual QString | name () const =0 |
Order | order () const |
void | setOrder (Order order) |
virtual QString | typeId () const =0 |
QGraphicsWidget * | widget (Plasma::Applet *host) |
virtual | ~Task () |
Protected Member Functions | |
virtual QGraphicsWidget * | createWidget (Plasma::Applet *host)=0 |
Task () |
Detailed Description
System tray task base class.To support a new system tray protocol, Protocol and this class should be subclassed.
Definition at line 45 of file task.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
Member Function Documentation
QList< QGraphicsWidget * > SystemTray::Task::associatedWidgets | ( | ) | const |
void SystemTray::Task::changed | ( | SystemTray::Task * | task = 0 |
) | [signal] |
Emitted when something about the task has changed.
virtual QGraphicsWidget* SystemTray::Task::createWidget | ( | Plasma::Applet * | host | ) | [protected, pure virtual] |
Called when a new widget is required.
Subclasses should implement this to return a graphics widget that handles all user interaction with the task. Ownership of the created widget is handled automatically so subclasses should not delete the created widget.
Implemented in SystemTray::FdoTask, SystemTray::PlasmoidTask, and SystemTray::ExtenderTask.
void SystemTray::Task::destroyed | ( | SystemTray::Task * | task = 0 |
) | [signal] |
Emitted when the task is about to be destroyed.
virtual QIcon SystemTray::Task::icon | ( | ) | const [pure virtual] |
Returns an icon that can be associated with this task.
The icon returned is not necessarily the same icon that appears in the tray icon itself.
Implemented in SystemTray::FdoTask, SystemTray::PlasmoidTask, and SystemTray::ExtenderTask.
virtual bool SystemTray::Task::isEmbeddable | ( | ) | const [pure virtual] |
Returns whether this task can be embeddable.
Depending on the protocol, there may be circumstances under which a new widget can not be created. isEmbeddable() will return false under these circumstances.
Implemented in SystemTray::FdoTask, SystemTray::PlasmoidTask, and SystemTray::ExtenderTask.
bool SystemTray::Task::isHideable | ( | ) | const [virtual] |
Returns whether the task is currently hideable by the user or not.
Reimplemented in SystemTray::ExtenderTask.
virtual QString SystemTray::Task::name | ( | ) | const [pure virtual] |
Returns the name of this task that should be presented to the user.
Implemented in SystemTray::FdoTask, SystemTray::PlasmoidTask, and SystemTray::ExtenderTask.
Task::Order SystemTray::Task::order | ( | ) | const |
void SystemTray::Task::setOrder | ( | Order | order | ) |
virtual QString SystemTray::Task::typeId | ( | ) | const [pure virtual] |
Returns a unique identifier for this task.
The identifier is valid between restarts and so is safe to save
Implemented in SystemTray::FdoTask, SystemTray::PlasmoidTask, and SystemTray::ExtenderTask.
QGraphicsWidget * SystemTray::Task::widget | ( | Plasma::Applet * | host | ) |
Creates a new graphics widget for this task.
isEmbeddable() should be checked before creating a new widget.
The documentation for this class was generated from the following files: