include/wx/taskbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/taskbar.h
   3 // Purpose:     wxTaskBarIcon base header and class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // Copyright:   (c) Julian Smart
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TASKBAR_H_BASE_
  13 #define _WX_TASKBAR_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_TASKBARICON
  18
  19 #include "wx/event.h"
  20
  21 class WXDLLIMPEXP_FWD_ADV wxTaskBarIconEvent;
  22
  23 // ----------------------------------------------------------------------------
  24
  25 // type of taskbar item to create.  Only applicable in wxOSX_COCOA
  26 enum wxTaskBarIconType
  27 {
  28     wxTBI_DOCK,
  29     wxTBI_CUSTOM_STATUSITEM,
  30 #if defined(wxOSX_USE_COCOA) && wxOSX_USE_COCOA
  31     wxTBI_DEFAULT_TYPE = wxTBI_CUSTOM_STATUSITEM
  32 #else
  33     wxTBI_DEFAULT_TYPE = wxTBI_DOCK
  34 #endif
  35 };
  36
  37
  38 // ----------------------------------------------------------------------------
  39 // wxTaskBarIconBase: define wxTaskBarIcon interface
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLIMPEXP_ADV wxTaskBarIconBase : public wxEvtHandler
  43 {
  44 public:
  45     wxTaskBarIconBase() { }
  46
  47 #if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
  48     static bool IsAvailable();
  49 #else
  50     static bool IsAvailable() { return true; }
  51 #endif
  52
  53     // Operations:
  54     virtual bool SetIcon(const wxIcon& icon,
  55                          const wxString& tooltip = wxEmptyString) = 0;
  56     virtual bool RemoveIcon() = 0;
  57     virtual bool PopupMenu(wxMenu *menu) = 0;
  58
  59     // delayed destruction (similarly to wxWindow::Destroy())
  60     void Destroy();
  61
  62 protected:
  63     // creates menu to be displayed when user clicks on the icon
  64     virtual wxMenu *CreatePopupMenu() { return NULL; }
  65
  66 private:
  67     // default events handling, calls CreatePopupMenu:
  68     void OnRightButtonDown(wxTaskBarIconEvent& event);
  69
  70     DECLARE_EVENT_TABLE()
  71     wxDECLARE_NO_COPY_CLASS(wxTaskBarIconBase);
  72 };
  73
  74
  75 // ----------------------------------------------------------------------------
  76 // now include the actual class declaration
  77 // ----------------------------------------------------------------------------
  78
  79 #if defined(__WXMSW__)
  80     #include "wx/msw/taskbar.h"
  81 #elif defined(__WXGTK20__)
  82     #include "wx/gtk/taskbar.h"
  83 #elif defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
  84     #include "wx/unix/taskbarx11.h"
  85 #elif defined (__WXMAC__)
  86     #include "wx/osx/taskbarosx.h"
  87 #elif defined (__WXCOCOA__)
  88     #include "wx/cocoa/taskbar.h"
  89 #endif
  90
  91 // ----------------------------------------------------------------------------
  92 // wxTaskBarIcon events
  93 // ----------------------------------------------------------------------------
  94
  95 class WXDLLIMPEXP_ADV wxTaskBarIconEvent : public wxEvent
  96 {
  97 public:
  98     wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon)
  99         : wxEvent(wxID_ANY, evtType)
 100     {
 101         SetEventObject(tbIcon);
 102     }
 103
 104     virtual wxEvent *Clone() const { return new wxTaskBarIconEvent(*this); }
 105
 106 private:
 107     wxDECLARE_NO_ASSIGN_CLASS(wxTaskBarIconEvent);
 108 };
 109
 110 typedef void (wxEvtHandler::*wxTaskBarIconEventFunction)(wxTaskBarIconEvent&);
 111
 112 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_MOVE, wxTaskBarIconEvent );
 113 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_DOWN, wxTaskBarIconEvent );
 114 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_UP, wxTaskBarIconEvent );
 115 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_DOWN, wxTaskBarIconEvent );
 116 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_UP, wxTaskBarIconEvent );
 117 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_DCLICK, wxTaskBarIconEvent );
 118 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_DCLICK, wxTaskBarIconEvent );
 119 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_BALLOON_TIMEOUT, wxTaskBarIconEvent );
 120 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_BALLOON_CLICK, wxTaskBarIconEvent );
 121
 122 #define wxTaskBarIconEventHandler(func) \
 123     wxEVENT_HANDLER_CAST(wxTaskBarIconEventFunction, func)
 124
 125 #define wx__DECLARE_TASKBAREVT(evt, fn) \
 126     wx__DECLARE_EVT0(wxEVT_TASKBAR_ ## evt, wxTaskBarIconEventHandler(fn))
 127
 128 #define EVT_TASKBAR_MOVE(fn)         wx__DECLARE_TASKBAREVT(MOVE, fn)
 129 #define EVT_TASKBAR_LEFT_DOWN(fn)    wx__DECLARE_TASKBAREVT(LEFT_DOWN, fn)
 130 #define EVT_TASKBAR_LEFT_UP(fn)      wx__DECLARE_TASKBAREVT(LEFT_UP, fn)
 131 #define EVT_TASKBAR_RIGHT_DOWN(fn)   wx__DECLARE_TASKBAREVT(RIGHT_DOWN, fn)
 132 #define EVT_TASKBAR_RIGHT_UP(fn)     wx__DECLARE_TASKBAREVT(RIGHT_UP, fn)
 133 #define EVT_TASKBAR_LEFT_DCLICK(fn)  wx__DECLARE_TASKBAREVT(LEFT_DCLICK, fn)
 134 #define EVT_TASKBAR_RIGHT_DCLICK(fn) wx__DECLARE_TASKBAREVT(RIGHT_DCLICK, fn)
 135
 136 // taskbar menu is shown on right button press under all platforms except MSW
 137 // where it's shown on right button release, using this event type and macro
 138 // allows to write code which works correctly on all platforms
 139 #ifdef __WXMSW__
 140     #define wxEVT_TASKBAR_CLICK wxEVT_TASKBAR_RIGHT_UP
 141 #else
 142     #define wxEVT_TASKBAR_CLICK wxEVT_TASKBAR_RIGHT_DOWN
 143 #endif
 144 #define EVT_TASKBAR_CLICK(fn)        wx__DECLARE_TASKBAREVT(CLICK, fn)
 145
 146 // these events are currently generated only under wxMSW and only after (MSW-
 147 // specific) ShowBalloon() had been called, don't use them in portable code
 148 #define EVT_TASKBAR_BALLOON_TIMEOUT(fn) \
 149     wx__DECLARE_TASKBAREVT(BALLOON_TIMEOUT, fn)
 150 #define EVT_TASKBAR_BALLOON_CLICK(fn) \
 151     wx__DECLARE_TASKBAREVT(BALLOON_CLICK, fn)
 152
 153 #endif // wxUSE_TASKBARICON
 154
 155 #endif // _WX_TASKBAR_H_BASE_