// Purpose: interface of wxTaskBarIcon
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+/**
+ On OSX Cocoa the taskbar icon can be in the doc or in the status area.
+ This enumeration can be used to select which will be instantiated.
+*/
+enum wxTaskBarIconType
+{
+ wxTBI_DOCK,
+ wxTBI_CUSTOM_STATUSITEM,
+ wxTBI_DEFAULT_TYPE
+};
+
+
/**
@class wxTaskBarIconEvent
wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon);
};
+
/**
@class wxTaskBarIcon
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
{
public:
/**
- Default constructor.
+ Default constructor. The iconType is only applicable on wxOSX_Cocoa.
*/
- wxTaskBarIcon();
+ wxTaskBarIcon(wxTaskBarIconType iconType = wxTBI_DEFAULT_TYPE);
/**
Destroys the wxTaskBarIcon object, removing the icon if not already removed.
virtual wxMenu* CreatePopupMenu();
};
+
+wxEventType wxEVT_TASKBAR_MOVE;
+wxEventType wxEVT_TASKBAR_LEFT_DOWN;
+wxEventType wxEVT_TASKBAR_LEFT_UP;
+wxEventType wxEVT_TASKBAR_RIGHT_DOWN;
+wxEventType wxEVT_TASKBAR_RIGHT_UP;
+wxEventType wxEVT_TASKBAR_LEFT_DCLICK;
+wxEventType wxEVT_TASKBAR_RIGHT_DCLICK;
+wxEventType wxEVT_TASKBAR_CLICK;
+wxEventType wxEVT_TASKBAR_BALLOON_TIMEOUT;
+wxEventType wxEVT_TASKBAR_BALLOON_CLICK;