X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/76ef2d39351818726411c961c8c5d2100ba516b4..38534f596974042130716a26276e9564b0b72295:/interface/wx/taskbar.h diff --git a/interface/wx/taskbar.h b/interface/wx/taskbar.h index c159284623..36096618a4 100644 --- a/interface/wx/taskbar.h +++ b/interface/wx/taskbar.h @@ -3,9 +3,21 @@ // 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 @@ -26,6 +38,7 @@ public: wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon); }; + /** @class wxTaskBarIcon @@ -48,24 +61,24 @@ public: 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 @@ -79,9 +92,9 @@ class wxTaskBarIcon : public wxEvtHandler { 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. @@ -167,3 +180,14 @@ protected: 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;