Navigation

phoenix_title wx.adv.TaskBarIcon

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.

phoenix_title X Window System Note

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 wx.adv.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. ^^

events Events Emitted by this Class

Handlers bound for the following event types will receive one of the wx.adv.TaskBarIconEvent Note that not all ports are required to send these events and so it’s better to override wx.adv.TaskBarIcon.CreatePopupMenu or wx.adv.TaskBarIcon.GetPopupMenu if all that the application does is that it shows a popup menu in reaction to mouse click. parameters.

  • EVT_TASKBAR_MOVE: Process a wxEVT_TASKBAR_MOVE event.

  • EVT_TASKBAR_LEFT_DOWN: Process a wxEVT_TASKBAR_LEFT_DOWN event.

  • EVT_TASKBAR_LEFT_UP: Process a wxEVT_TASKBAR_LEFT_UP event.

  • EVT_TASKBAR_RIGHT_DOWN: Process a wxEVT_TASKBAR_RIGHT_DOWN event.

  • EVT_TASKBAR_RIGHT_UP: Process a wxEVT_TASKBAR_RIGHT_UP event.

  • EVT_TASKBAR_LEFT_DCLICK: Process a wxEVT_TASKBAR_LEFT_DCLICK event.

  • EVT_TASKBAR_RIGHT_DCLICK: Process a wxEVT_TASKBAR_RIGHT_DCLICK event.

  • EVT_TASKBAR_CLICK: This is a synonym for either EVT_TASKBAR_RIGHT_DOWN or wx.UP depending on the platform, use this event macro to catch the event which should result in the menu being displayed on the current platform. ^^


class_hierarchy Class Hierarchy

Inheritance diagram for class TaskBarIcon:

method_summary Methods Summary

__init__

Default constructor.

CreatePopupMenu

Called by the library when the user requests popup menu if GetPopupMenu is not overridden.

Destroy

This method is similar to wx.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.

GetPopupMenu

Called by the library when the user requests popup menu.

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

api Class API

class wx.adv.TaskBarIcon(EvtHandler)

Possible constructors:

TaskBarIcon(iconType=TBI_DEFAULT_TYPE)

This class represents a taskbar icon.


Methods

__init__(self, iconType=TBI_DEFAULT_TYPE)

Default constructor.

The iconType is only applicable on OSX/Cocoa.

Parameters:

iconType (TaskBarIconType) –


CreatePopupMenu(self)

Called by the library when the user requests popup menu if GetPopupMenu is not overridden.

Override this function in order to provide popup menu associated with the icon if you don’t want to override GetPopupMenu , i.e. if you prefer creating a new menu every time instead of reusing the same menu.

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. If you don’t want the menu to be destroyed when it is dismissed, override GetPopupMenu instead.

Return type:

Menu


Destroy(self)

This method is similar to wx.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.


GetPopupMenu(self)

Called by the library when the user requests popup menu.

On Windows and Unix platforms this happens when the user right-clicks the icon, so overriding this method is the simplest way to implement the standard behaviour of showing a menu when the taskbar icon is clicked.

If GetPopupMenu returns None (this happens by default), CreatePopupMenu is called next and its menu is used (if not None). Otherwise the menu returned by GetPopupMenu is shown and, contrary to CreatePopupMenu , not destroyed when the user dismisses it, allowing to reuse the same menu pointer multiple times.

Return type:

Menu

New in version 4.1/wxWidgets-3.1.5.


static IsAvailable()

Returns True if system tray is available in the desktop environment the app runs under.

On Windows and macOS, 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.

Note

wx.adv.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.


IsIconInstalled(self)

Returns True if SetIcon was called with no subsequent RemoveIcon .

Return type:

bool


IsOk(self)

Returns True if the object initialized successfully.

Return type:

bool


PopupMenu(self, menu)

Pops up a menu at the current mouse position.

The events can be handled by a class derived from wx.adv.TaskBarIcon.

Parameters:

menu (wx.Menu) –

Return type:

bool

Note

It is recommended to override the CreatePopupMenu or GetPopupMenu 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.


RemoveIcon(self)

Removes the icon previously set with SetIcon .

Return type:

bool


SetIcon(self, icon, tooltip="")

Sets the icon, and optional tooltip text.

Parameters:
Return type:

bool


ShowBalloon(self, title, text, msec=0, flags=0)

Show a balloon notification (the icon must have been already initialized using SetIcon). Only implemented for Windows.

The title and text parameters are limited to 63 and 255 characters respectively, msec is the timeout, in milliseconds, before the balloon disappears (will be clamped down to the allowed 10-30s range by Windows if it’s outside it) and flags can include ICON_ERROR/INFO/WARNING to show a corresponding icon.

Returns True if balloon was shown, False on error (incorrect parameters or function unsupported by OS).

Return type:

bool