View source for Projects/Plasma/NewSystemTray

= New System Tray Design =

== Categories ==

System tray icons generally fall into four categories:

* Indicators of application status
* Communications
* System services
* Hardware

Applications registering with the system tray provide one of those categories. An instant messaging application or an email client will fall into 'Communications'. System services are for example software update notifications. Examples for Hardware are a battery monitor a mixer or a Network Management applet. Applications that use the system tray for freeing space in the taskbar use the Application Status category.
The system tray implementation can choose to provide the information delivered by the client application in different ways.

== Properties ==

A System Tray Item will Have the following elements and properties.

* Icon
** name
** pixmap (possible size variants)

* Tooltip
** Headline
** Subtext
** Pixmap

* Status
** Passive (normal)
** Active
** Needs Attention

* Interaction
** Context menu
** Activate
** Wheel up/down

== Visualization ==
The visualization of the registered application is determined by the system tray. It can be implemented as row or grid of icons, as in current system trays. The longer term perspective is to offer category-specific visualization for the applications.
Applications that want to expose more control through desktop elements such as the system tray can choose to offer applets to support their specific requirements.

== Interactions ==
The interactions can be considered in terms of the 'Client' i.e. the icon itself, and the 'Host' e.g. the system tray.

Providing an interface for actions allows for coherent interaction across applications using the system tray. 

=== Client ===
A client of the system tray is an application that registers with the system tray to display its information. The system tray (the host) reacts to signals it receives from the client. The host also can pass back an action to the client application, for example when the application has been activated. The host receives the signals in an asynchronous fashion from the client. The display of the message might happen delayed.

=== Host ===
The Host is the system tray itself. It offers an interface for applications to register in a standardized way, acts on signals sent by these clients, and can do callbacks to the client application (for example to activate a window when the icon has been clicked).

==== Signals ====
The application can signal the following to the system tray host in order to change appearance and status of the icon:
* A new pixmap is available
* The status changed

==== Slots ====
The Host (system tray) can call the following slots in the application:
* activated

==== Properties ====
The Host queries the client for the following properties:
* tooltip data
* name
* pixmap

= Implementation details =
== Draft of the D-Bus xml service description ==
A first draft of the xml describing the spec is here
[http://websvn.kde.org/trunk/playground/base/plasma/libknotificationicon/org.kde.SystemTray.xml (websvn link)]
based on
[http://vizzzion.org/stuff/systray-whiteboard.jpg Whiteboard at TokamakII]

== Components ==
=== SystemTrayDaemon Kded ===

It keeps the list of applications (dbus services actually) that want to use the systemtray, an application must explicitly register here to gain an icon. it's done outside the actual systemtray to mantain the icon list intact across different plasma sessions. Can be found [http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/applets/systemtray/systemtraydaemon/ here].

=== Protocol plugin in the Systemtray plasmoid ===
For now it's called DBusSystemTray, can be found here in
[http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/applets/systemtray/protocols/dbussystemtray/ websvn]. It asks SystemTrayDaemon what the registered icons are and listens from it for new icons or removal of others.
It will dialog with the apps with the protocol described in the above dbus spec.

=== Client library ===
[http://websvn.kde.org/trunk/playground/base/plasma/libknotificationicon/ (websvn link)]
This library is aimed to be a drop-in replacement for KSystemTrayIcon and will talk to SystemtrayDaemon to register the app for the assignment of an icon in the systemtray and to the systemtray widget itself with the dbus calls defined in the protocol