• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Applets

SystemTray::Task

SystemTray::Task Class Reference

System tray task base class. More...

#include <task.h>

Inheritance diagram for SystemTray::Task:

Inheritance graph
[legend]

List of all members.


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

enum SystemTray::Task::Order

Enumerator:
First 
Normal 
Last 

Definition at line 50 of file task.h.


Constructor & Destructor Documentation

SystemTray::Task::~Task (  )  [virtual]

Definition at line 45 of file task.cpp.

SystemTray::Task::Task (  )  [protected]

Definition at line 39 of file task.cpp.


Member Function Documentation

QList< QGraphicsWidget * > SystemTray::Task::associatedWidgets (  )  const

Returns the current list of graphics widgets that have been created for this task and have not yet been deleted.

Definition at line 76 of file task.cpp.

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.

Definition at line 81 of file task.cpp.

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

Returns the order this Task should be placed in: first, normal or last.

Definition at line 86 of file task.cpp.

void SystemTray::Task::setOrder ( Order  order  ) 

Sets which order this task should be placed in, relative to other Tasks.

  • order the order to set this Task to

Definition at line 91 of file task.cpp.

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.

Definition at line 52 of file task.cpp.


The documentation for this class was generated from the following files:
  • task.h
  • task.cpp

Applets

Skip menu "Applets"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal