// Purpose: interface of wxTaskBarIcon
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+
+/**
+ @class wxTaskBarIconEvent
+
+ The event class used by wxTaskBarIcon.
+ For a list of the event macros meant to be used with wxTaskBarIconEvent,
+ please look at wxTaskBarIcon description.
+
+ @library{wxadv}
+ @category{events}
+*/
+class wxTaskBarIconEvent : public wxEvent
+{
+public:
+ /**
+ Constructor.
+ */
+ wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon);
+};
+
/**
@class wxTaskBarIcon
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.
+
@section taskbaricon_xnote 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,
The user should be required to explicitly enable the taskbar icon on Unix,
it shouldn't be on by default.
- @beginEventTable{wxTaskBarIconEvent}
+ @beginEventEmissionTable{wxTaskBarIconEvent}
Note that not all ports are required to send these events and so it's better
to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
is that it shows a popup menu in reaction to mouse click.
@event{EVT_TASKBAR_MOVE(func)}
- Process a wxEVT_TASKBAR_MOVE event.
+ Process a @c wxEVT_TASKBAR_MOVE event.
@event{EVT_TASKBAR_LEFT_DOWN(func)}
- Process a wxEVT_TASKBAR_LEFT_DOWN event.
+ Process a @c wxEVT_TASKBAR_LEFT_DOWN event.
@event{EVT_TASKBAR_LEFT_UP(func)}
- Process a wxEVT_TASKBAR_LEFT_UP event.
+ Process a @c wxEVT_TASKBAR_LEFT_UP event.
@event{EVT_TASKBAR_RIGHT_DOWN(func)}
- Process a wxEVT_TASKBAR_RIGHT_DOWN event.
+ Process a @c wxEVT_TASKBAR_RIGHT_DOWN event.
@event{EVT_TASKBAR_RIGHT_UP(func)}
- Process a wxEVT_TASKBAR_RIGHT_UP event.
+ Process a @c wxEVT_TASKBAR_RIGHT_UP event.
@event{EVT_TASKBAR_LEFT_DCLICK(func)}
- Process a wxEVT_TASKBAR_LEFT_DCLICK event.
+ Process a @c wxEVT_TASKBAR_LEFT_DCLICK event.
@event{EVT_TASKBAR_RIGHT_DCLICK(func)}
- Process a wxEVT_TASKBAR_RIGHT_DCLICK event.
+ Process a @c wxEVT_TASKBAR_RIGHT_DCLICK event.
@event{EVT_TASKBAR_CLICK(func)}
This is a synonym for either EVT_TASKBAR_RIGHT_DOWN or UP depending on
the platform, use this event macro to catch the event which should result