wx.TaskBarIcon

Inheritance diagram for wx.TaskBarIcon:



Description

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.

Derived From

Event Handling

Event Name Description
wx.EVT_TASKBAR_MOVE(func) Process a wx.wxEVT_TASKBAR_MOVE event.
wx.EVT_TASKBAR_LEFT_DOWN(func) Process a wx.wxEVT_TASKBAR_LEFT_DOWN event.
wx.EVT_TASKBAR_LEFT_UP(func) Process a wx.wxEVT_TASKBAR_LEFT_UP event.
wx.EVT_TASKBAR_RIGHT_DOWN(func) Process a wx.wxEVT_TASKBAR_RIGHT_DOWN event.
wx.EVT_TASKBAR_RIGHT_UP(func) Process a wx.wxEVT_TASKBAR_RIGHT_UP event.
wx.EVT_TASKBAR_LEFT_DCLICK(func) Process a wx.wxEVT_TASKBAR_LEFT_DCLICK event.
wx.EVT_TASKBAR_RIGHT_DCLICK(func) Process a wx.wxEVT_TASKBAR_RIGHT_DCLICK event.
wx.EVT_TASKBAR_CLICK(func) This is a synonym for either wx.EVT_TASKBAR_RIGHT_DOWN or 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 API

Methods

__init__()
No docstrings available for this method.

IsIconInstalled()

Returns True if SetIcon was called with no subsequent RemoveIcon.

Default constructor.

Returns:

bool


IsOk()

Returns True if the object initialized successfully.


Returns:

bool


PopupMenu(menu)

Pops up a menu at the current mouse position. The events can be handled by a class derived from wx.TaskBarIcon.

Parameters:


Returns:

bool


RemoveIcon()

Removes the icon previously set with SetIcon.


Returns:

bool


SetIcon(icon, tooltip)

Sets the icon, and optional tooltip text.

Parameters:


Returns:

bool