Difference between revisions of "Projects/Plasma/NewSystemTray"

Jump to: navigation, search
m (Draft of the D-Bus xml service description)
(some examples for the categories)
Line 9: Line 9:
 
* System services
 
* System services
 
* Hardware
 
* 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.
  
 
== Properties ==
 
== Properties ==
  
A System Tray Icon will Have the following properties.
+
A System Tray Icon will Have the following elements and properties.
  
 
* Icon
 
* Icon
 
+
** name
  - name
+
** pixmap (possible size variants)
 
+
  - pixmap (possible size variants)
+
  
 
* Tooltip
 
* Tooltip
 
+
** Headline
  - Headline
+
** Subtext
 
+
** Pixmap
  - Subtext
+
 
+
  - Pixmap
+
  
 
* Status
 
* Status
 
+
** Passive (normal)
  - Passive (normal)
+
** Active
 
+
** Needs Attention
  - Active
+
 
+
  - Needs Attention
+
  
 
* Interaction
 
* Interaction
 
+
** Context menu
  - Context menu
+
** Activate
 
+
** Wheel up/down
  - Activate
+
 
+
  - Wheel up/down
+
  
 
== Interactions ==
 
== Interactions ==
Line 49: Line 40:
  
 
=== Client ===
 
=== 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.
  
 
==== Signals ====
 
==== Signals ====
 
+
* i have a new pixmap
- i have a new pixmap
+
* i have a new status
 
+
- i have a new status
+
 
+
the host will react to these, but with no guarantee of when - expect 500ms.
+
  
 
==== Slots ====
 
==== Slots ====
 
+
* activated
- activated
+
  
 
==== Properties ====
 
==== Properties ====
 
+
* tooltip data
- tooltip data
+
* name
 
+
* pixmap
- name
+
 
+
- pixmap
+
  
 
= Draft of the D-Bus xml service description =
 
= Draft of the D-Bus xml service description =
 
[http://websvn.kde.org/trunk/playground/base/plasma/libknotificationicon/org.kde.SystemTray.xml Websvn link]
 
[http://websvn.kde.org/trunk/playground/base/plasma/libknotificationicon/org.kde.SystemTray.xml Websvn link]

Revision as of 18:59, 26 February 2009

Contents

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.

Properties

A System Tray Icon 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

Interactions

The interactions can be considered in terms of the 'Client' ie the icon itself, and the 'Host' eg. 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.

Signals

  • i have a new pixmap
  • i have a new status

Slots

  • activated

Properties

  • tooltip data
  • name
  • pixmap

Draft of the D-Bus xml service description

Websvn link


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal