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.
Handlers bound for the following event types will receive one of the //freedesktop.org/wiki/Specifications/systemtray-spec <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 TaskBarIcon 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: TaskBarIconEvent TaskBarIcon.CreatePopupMenu if all that the application does is that it shows a popup menu in reaction to mouse click. parameters.
__init__ | Default constructor. |
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). |
Destroy | This method is similar to Window.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. |
IsAvailable | Returns True if system tray is available in the desktop environment the app runs under. |
IsIconInstalled | Returns True if SetIcon was called with no subsequent RemoveIcon . |
IsOk | Returns True if the object initialized successfully. |
PopupMenu | Pops up a menu at the current mouse position. |
RemoveIcon | Removes the icon previously set with SetIcon . |
SetIcon | Sets the icon, and optional tooltip text. |
ShowBalloon | Show a balloon notification (the icon must have been already |
This class represents a taskbar icon.
Possible constructors:
TaskBarIcon(iconType=TBI_DEFAULT_TYPE)
Default constructor.
The iconType is only applicable on OSX_Cocoa.
Parameters: | iconType (TaskBarIconType) – |
---|
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 None (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 TaskBarIcon.
Return type: | Menu |
---|
This method is similar to Window.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.
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).
Return type: | bool |
---|
New in version 2.9.0.
Note
Tray availability may change during application’s lifetime under X11 and so applications shouldn’t cache the result. TaskBarIcon supports older GNOME 1.2 and KDE 1/2 methods of adding icons to tray, but they are unreliable and this method doesn’t detect them.
Returns True if SetIcon was called with no subsequent RemoveIcon .
Return type: | bool |
---|
Returns True if the object initialized successfully.
Return type: | bool |
---|
Pops up a menu at the current mouse position.
The events can be handled by a class derived from TaskBarIcon.
Parameters: | menu (Menu) – |
---|---|
Return type: | bool |
Note
It is recommended to override CreatePopupMenu callback instead of calling this method from event handler, because some ports (e.g. Cocoa) may not implement PopupMenu and mouse click events at all.
Sets the icon, and optional tooltip text.
Parameters: |
|
---|---|
Return type: | bool |
Show a balloon notification (the icon must have been already initialized using SetIcon). Only implemented for Windows.
Return type: | bool |
---|