kdeui Library API Documentation

KSystemTray Class Reference

KDE System Tray Window class KDE System Tray Window class. More...

#include <ksystemtray.h>

Inheritance diagram for KSystemTray:

QLabel KDockWindow List of all members.

Signals

void quitSelected ()

Public Methods

 KSystemTray (QWidget *parent=0, const char *name=0)
 ~KSystemTray ()
KPopupMenucontextMenu () const
KActionCollectionactionCollection ()

Static Public Methods

QPixmap loadIcon (const QString &icon, KInstance *instance=KGlobal::instance())

Protected Methods

void mousePressEvent (QMouseEvent *)
void mouseReleaseEvent (QMouseEvent *)
virtual void contextMenuAboutToShow (KPopupMenu *menu)
void showEvent (QShowEvent *)
void enterEvent (QEvent *)
virtual void virtual_hook (int id, void *data)

Detailed Description

KDE System Tray Window class KDE System Tray Window class.

This class implements system tray windows.

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.

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".

Docking happens magically when calling show(). The window undocks with either hide() or when it is destroyed.

KSystemTray inherits methods such as setPixmap() and setMovie() to specify an icon or movie (animated icon) respectively. It is designed to be usable "as is", without the need to subclass it. In case you need to provide something special (such as an additional popupmenu on a click with the left mouse button), you can subclass anyway, of course.

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.

Author:
Matthias Ettrich <ettrich@kde.org>

Definition at line 64 of file ksystemtray.h.


Constructor & Destructor Documentation

KSystemTray::KSystemTray QWidget   parent = 0,
const char *    name = 0
 

Construct a KSystemTray widget just like any other widget.

The parent widget parent has a special meaning: Besides owning the tray window, the parent widget will dissappear from taskbars when it is iconified while the tray window is visible. This is the desired behavior. After all, the tray window is the parent's taskbar icon.

Furthermore, the parent widget is shown or raised respectively when the user clicks on the trray window with the left mouse button.

Definition at line 74 of file ksystemtray.cpp.

References QXEmbed::initialize(), KPopupMenu::insertTitle(), KWin::WindowInfo::onAllDesktops(), KStdAction::quit(), quitSelected(), KWin::setSystemTrayWindowFor(), QWidget::topLevelWidget(), and KWin::windowInfo().


Member Function Documentation

KPopupMenu * KSystemTray::contextMenu   const
 

Access to the context menu.

This makes it easy to add new items to it.

Definition at line 168 of file ksystemtray.cpp.

KActionCollection * KSystemTray::actionCollection  
 

Easy access to the actions in the context menu Currently includes KStdAction::Quit and minimizeRestore

Since:
3.1.

Definition at line 297 of file ksystemtray.cpp.

QPixmap KSystemTray::loadIcon const QString   icon,
KInstance   instance = KGlobal::instance()
[static]
 

Loads an icon icon using the icon loader class of the given instance instance.

The icon is applied the panel effect as it should only be used to be shown in the system tray. It's commonly used in the form : systray->setPixmap( systray->loadIcon( "mysystray" ) );

Since:
3.2

Definition at line 302 of file ksystemtray.cpp.

References KInstance::iconLoader(), KNotifyClient::instance(), and KIconLoader::loadIcon().

void KSystemTray::mousePressEvent QMouseEvent   [protected]
 

Reimplemented to provide the standard show/raise behavior for the parentWidget() and the context menu.

Feel free to reimplement this if you need something special.

Definition at line 174 of file ksystemtray.cpp.

References QMouseEvent::button(), contextMenuAboutToShow(), QMouseEvent::globalPos(), QPopupMenu::popup(), QMouseEvent::pos(), and KAction::setText().

void KSystemTray::mouseReleaseEvent QMouseEvent   [protected]
 

Reimplemented to provide the standard show/raise behavior for the parentWidget() and the context menu.

Feel free to reimplement this if you need something special.

Definition at line 202 of file ksystemtray.cpp.

void KSystemTray::contextMenuAboutToShow KPopupMenu   menu [protected, virtual]
 

Makes it easy to adjust some menu items right before the context menu becomes visible.

Definition at line 207 of file ksystemtray.cpp.

Referenced by mousePressEvent().

void KSystemTray::showEvent QShowEvent   [protected]
 

Reimplemented for internal reasons.

Definition at line 121 of file ksystemtray.cpp.

References QPopupMenu::insertSeparator(), and KAction::plug().

void KSystemTray::enterEvent QEvent   [protected]
 

Reimplemented for internal reasons.

Definition at line 144 of file ksystemtray.cpp.

void KSystemTray::quitSelected   [signal]
 

Emitted when quit is selected in the menu.

If you want to perform any other action than to close the main application window please connect to this signal.

Since:
3.1

Referenced by KSystemTray().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun May 16 22:02:21 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003