Difference between revisions of "System Tray"

From Trinity Desktop Project Wiki
Jump to navigation Jump to search
imported>Eliddell
(Created page with "A tray window is a small window (typically 24x24 pixel) that docks into the system tray in the desktop panel. It usually displays an icon or an animated icon there. The icon s...")
 
(Small fixes and doc-link update)
Line 1: Line 1:
 
[[Category:KDE3]]
A tray window is a small window (typically 24x24 pixel) that docks into the system tray in the desktop panel. It usually displays an icon or an animated icon there. The icon serves as representative for the application, similar to a taskbar button, but consumes less screen space.
 
 
[[Category:Architecture]]
 
[[Category:Developers]]
  +
{{Applicable to TDE}}
   
[[Image:docking.png|System tray screenshot]]
 
   
 
A '''tray window''' is a small window (typically 24x24 pixel) that docks into the system tray in the desktop panel. It usually displays an icon or an animated icon there. The icon serves as representative for the application, similar to a taskbar button, but consumes less screen space.
A CD Player and a Notes application inside the panel's system tray.
 
   
 
[[Image:docking.png|thumb|A CD Player and a Notes application inside the panel's system tray.]]
When the user clicks with the left mouse button on the icon, the main application window is shown/raised and activated. With the right mouse button, she gets a popupmenu with application specific commands, including "Minimize/Restore" and "Quit".
 
   
 
When the user clicks with the left mouse button on the icon, the main application window is shown/raised and activated. With the right mouse button, (s)he gets a popupmenu with application specific commands, including "Minimize/Restore" and "Quit".
Having an icon on the system tray is a useful technique for daemon-like applications that may run for some time without user interaction but have to be there immediately when the user needs them. Examples are kppp, kisdn, kscd, kmix or knotes. With kppp and kisdn, the docked icon even provides real-time information about the network status.
 
   
 
Having an icon on the system tray is a useful technique for daemon-like applications that may run for some time without user interaction but have to be there immediately when the user needs them. Examples are ''kppp'', ''kisdn'', ''kscd'', ''kmix'' or ''knotes''. With ''kppp'' and ''kisdn'', the docked icon even provides real-time information about the network status.
With the KSystemTray in libkdeui, KDE provides a very simple API to add system tray items from your application. See the KSystemTray documentation in the [https://web.archive.org/web/20030324235403/http://developer.kde.org/documentation/library/3.1-api/classref/kdeui/KSystemTray.html KDE 3.1 API Reference ] for further details.
 
   
 
With the KSystemTray in libtdeui, TDE provides a very simple API to add system tray items from your application. See the KSystemTray documentation in the [http://trinitydesktop.org/docs/trinity/tdelibs/tdeui/html/classKSystemTray.html Trinity API Reference] for further details.
The mechanism works for non-KDE applications just as well. See the description of the [https://web.archive.org/web/20100420080204/http://developer.kde.org/documentation/library/kdeqt/kde3arch/protocols-docking.html system tray docking protocol] for details.
 
   
 
The mechanism works for non-TDE applications just as well. See the description of the [https://web.archive.org/web/20100420080204/http://developer.kde.org/documentation/library/kdeqt/kde3arch/protocols-docking.html system tray docking protocol] for details.
[[Category:KDE3]]
 
[[Category:Architecture]]
 
[[Category:Developers]]
 

Revision as of 20:30, 22 August 2021

TDE Logo.png
Information on this page is applicable to TDE
This page contains archived KDE 3.x content from various sources which is directly applicable to (or has been updated for) the Trinity Desktop Environment.


A tray window is a small window (typically 24x24 pixel) that docks into the system tray in the desktop panel. It usually displays an icon or an animated icon there. The icon serves as representative for the application, similar to a taskbar button, but consumes less screen space.

A CD Player and a Notes application inside the panel's system tray.

When the user clicks with the left mouse button on the icon, the main application window is shown/raised and activated. With the right mouse button, (s)he gets a popupmenu with application specific commands, including "Minimize/Restore" and "Quit".

Having an icon on the system tray is a useful technique for daemon-like applications that may run for some time without user interaction but have to be there immediately when the user needs them. Examples are kppp, kisdn, kscd, kmix or knotes. With kppp and kisdn, the docked icon even provides real-time information about the network status.

With the KSystemTray in libtdeui, TDE provides a very simple API to add system tray items from your application. See the KSystemTray documentation in the Trinity API Reference for further details.

The mechanism works for non-TDE applications just as well. See the description of the system tray docking protocol for details.