#include </home/zeitlin/src/wx/github/interface/wx/taskbar.h>
This class represents a taskbar icon.
A taskbar icon is an icon that appears in the 'system tray' and responds to mouse clicks, optionally with a tooltip above it to help provide information.
Under X Window System, the window manager must support either the "System Tray Protocol" (see http://freedesktop.org/wiki/Specifications/systemtray-spec) by freedesktop.org (WMs used by modern desktop environments such as GNOME >= 2, KDE >= 3 and XFCE >= 4 all do) or the older methods used in GNOME 1.2 and KDE 1 and 2.
If it doesn't, the icon will appear as a toplevel window on user's desktop. Because not all window managers have system tray, there's no guarantee that wxTaskBarIcon will work correctly under X Window System and so the applications should use it only as an optional component of their user interface. The user should be required to explicitly enable the taskbar icon on Unix, it shouldn't be on by default.
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros for events emitted by this class:
wxEVT_TASKBAR_MOVE
event. wxEVT_TASKBAR_LEFT_DOWN
event. wxEVT_TASKBAR_LEFT_UP
event. wxEVT_TASKBAR_RIGHT_DOWN
event. wxEVT_TASKBAR_RIGHT_UP
event. wxEVT_TASKBAR_LEFT_DCLICK
event. wxEVT_TASKBAR_RIGHT_DCLICK
event. Public Member Functions | |
wxTaskBarIcon (wxTaskBarIconType iconType=wxTBI_DEFAULT_TYPE) | |
Default constructor. | |
virtual | ~wxTaskBarIcon () |
Destroys the wxTaskBarIcon object, removing the icon if not already removed. | |
void | Destroy () |
This method is similar to wxWindow::Destroy and can be used to schedule the task bar icon object for the delayed destruction: it will be deleted during the next event loop iteration, which allows the task bar icon to process any pending events for it before being destroyed. | |
bool | IsIconInstalled () const |
Returns true if SetIcon() was called with no subsequent RemoveIcon(). | |
bool | IsOk () const |
Returns true if the object initialized successfully. | |
virtual bool | PopupMenu (wxMenu *menu) |
Pops up a menu at the current mouse position. | |
virtual bool | RemoveIcon () |
Removes the icon previously set with SetIcon(). | |
virtual bool | SetIcon (const wxIcon &icon, const wxString &tooltip=wxEmptyString) |
Sets the icon, and optional tooltip text. | |
Static Public Member Functions | |
static bool | IsAvailable () |
Returns true if system tray is available in the desktop environment the app runs under. | |
Protected Member Functions | |
virtual wxMenu * | CreatePopupMenu () |
This method is called by the library when the user requests popup menu (on Windows and Unix platforms, this is when the user right-clicks the icon). |
wxTaskBarIcon::wxTaskBarIcon | ( | wxTaskBarIconType | iconType = wxTBI_DEFAULT_TYPE | ) |
Default constructor.
The iconType is only applicable on wxOSX_Cocoa.
virtual wxTaskBarIcon::~wxTaskBarIcon | ( | ) | [virtual] |
Destroys the wxTaskBarIcon object, removing the icon if not already removed.
virtual wxMenu* wxTaskBarIcon::CreatePopupMenu | ( | ) | [protected, virtual] |
This method is called by the library when the user requests popup menu (on Windows and Unix platforms, this is when the user right-clicks the icon).
Override this function in order to provide popup menu associated with the icon. If CreatePopupMenu() returns NULL (this happens by default), no menu is shown, otherwise the menu is displayed and then deleted by the library as soon as the user dismisses it.
The events can be handled by a class derived from wxTaskBarIcon.
void wxTaskBarIcon::Destroy | ( | ) |
This method is similar to wxWindow::Destroy and can be used to schedule the task bar icon object for the delayed destruction: it will be deleted during the next event loop iteration, which allows the task bar icon to process any pending events for it before being destroyed.
static bool wxTaskBarIcon::IsAvailable | ( | ) | [static] |
Returns true if system tray is available in the desktop environment the app runs under.
On Windows and Mac OS X, the tray is always available and this function simply returns true.
On Unix, X11 environment may or may not provide the tray, depending on user's desktop environment. Most modern desktops support the tray via the System Tray Protocol by freedesktop.org (http://freedesktop.org/wiki/Specifications/systemtray-spec).
bool wxTaskBarIcon::IsIconInstalled | ( | ) | const |
Returns true if SetIcon() was called with no subsequent RemoveIcon().
bool wxTaskBarIcon::IsOk | ( | ) | const |
Returns true if the object initialized successfully.
virtual bool wxTaskBarIcon::PopupMenu | ( | wxMenu * | menu | ) | [virtual] |
Pops up a menu at the current mouse position.
The events can be handled by a class derived from wxTaskBarIcon.
virtual bool wxTaskBarIcon::RemoveIcon | ( | ) | [virtual] |
Removes the icon previously set with SetIcon().
virtual bool wxTaskBarIcon::SetIcon | ( | const wxIcon & | icon, |
const wxString & | tooltip = wxEmptyString |
||
) | [virtual] |
Sets the icon, and optional tooltip text.