1
/////////////////////////////////////////////////////////////////////////////
3
// Purpose: wxTaskBarIcon base header and class
4
// Author: Julian Smart
7
// Copyright: (c) Julian Smart
8
// Licence: wxWindows licence
9
/////////////////////////////////////////////////////////////////////////////
11
#ifndef _WX_TASKBAR_H_BASE_
12
#define _WX_TASKBAR_H_BASE_
20
class WXDLLIMPEXP_FWD_ADV wxTaskBarIconEvent;
22
// ----------------------------------------------------------------------------
24
// type of taskbar item to create. Only applicable in wxOSX_COCOA
25
enum wxTaskBarIconType
28
wxTBI_CUSTOM_STATUSITEM,
29
#if defined(wxOSX_USE_COCOA) && wxOSX_USE_COCOA
30
wxTBI_DEFAULT_TYPE = wxTBI_CUSTOM_STATUSITEM
32
wxTBI_DEFAULT_TYPE = wxTBI_DOCK
37
// ----------------------------------------------------------------------------
38
// wxTaskBarIconBase: define wxTaskBarIcon interface
39
// ----------------------------------------------------------------------------
41
class WXDLLIMPEXP_ADV wxTaskBarIconBase : public wxEvtHandler
44
wxTaskBarIconBase() { }
46
#if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
47
static bool IsAvailable();
49
static bool IsAvailable() { return true; }
53
virtual bool SetIcon(const wxIcon& icon,
54
const wxString& tooltip = wxEmptyString) = 0;
55
virtual bool RemoveIcon() = 0;
56
virtual bool PopupMenu(wxMenu *menu) = 0;
58
// delayed destruction (similarly to wxWindow::Destroy())
62
// creates menu to be displayed when user clicks on the icon
63
virtual wxMenu *CreatePopupMenu() { return NULL; }
66
// default events handling, calls CreatePopupMenu:
67
void OnRightButtonDown(wxTaskBarIconEvent& event);
70
wxDECLARE_NO_COPY_CLASS(wxTaskBarIconBase);
74
// ----------------------------------------------------------------------------
75
// now include the actual class declaration
76
// ----------------------------------------------------------------------------
78
#if defined(__WXMSW__)
79
#include "wx/msw/taskbar.h"
80
#elif defined(__WXGTK20__)
81
#include "wx/gtk/taskbar.h"
82
#elif defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
83
#include "wx/unix/taskbarx11.h"
84
#elif defined (__WXMAC__)
85
#include "wx/osx/taskbarosx.h"
86
#elif defined (__WXCOCOA__)
87
#include "wx/cocoa/taskbar.h"
90
// ----------------------------------------------------------------------------
91
// wxTaskBarIcon events
92
// ----------------------------------------------------------------------------
94
class WXDLLIMPEXP_ADV wxTaskBarIconEvent : public wxEvent
97
wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon)
98
: wxEvent(wxID_ANY, evtType)
100
SetEventObject(tbIcon);
103
virtual wxEvent *Clone() const { return new wxTaskBarIconEvent(*this); }
106
wxDECLARE_NO_ASSIGN_CLASS(wxTaskBarIconEvent);
109
typedef void (wxEvtHandler::*wxTaskBarIconEventFunction)(wxTaskBarIconEvent&);
111
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_MOVE, wxTaskBarIconEvent );
112
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_DOWN, wxTaskBarIconEvent );
113
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_UP, wxTaskBarIconEvent );
114
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_DOWN, wxTaskBarIconEvent );
115
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_UP, wxTaskBarIconEvent );
116
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_LEFT_DCLICK, wxTaskBarIconEvent );
117
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_RIGHT_DCLICK, wxTaskBarIconEvent );
118
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_BALLOON_TIMEOUT, wxTaskBarIconEvent );
119
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_TASKBAR_BALLOON_CLICK, wxTaskBarIconEvent );
121
#define wxTaskBarIconEventHandler(func) \
122
wxEVENT_HANDLER_CAST(wxTaskBarIconEventFunction, func)
124
#define wx__DECLARE_TASKBAREVT(evt, fn) \
125
wx__DECLARE_EVT0(wxEVT_TASKBAR_ ## evt, wxTaskBarIconEventHandler(fn))
127
#define EVT_TASKBAR_MOVE(fn) wx__DECLARE_TASKBAREVT(MOVE, fn)
128
#define EVT_TASKBAR_LEFT_DOWN(fn) wx__DECLARE_TASKBAREVT(LEFT_DOWN, fn)
129
#define EVT_TASKBAR_LEFT_UP(fn) wx__DECLARE_TASKBAREVT(LEFT_UP, fn)
130
#define EVT_TASKBAR_RIGHT_DOWN(fn) wx__DECLARE_TASKBAREVT(RIGHT_DOWN, fn)
131
#define EVT_TASKBAR_RIGHT_UP(fn) wx__DECLARE_TASKBAREVT(RIGHT_UP, fn)
132
#define EVT_TASKBAR_LEFT_DCLICK(fn) wx__DECLARE_TASKBAREVT(LEFT_DCLICK, fn)
133
#define EVT_TASKBAR_RIGHT_DCLICK(fn) wx__DECLARE_TASKBAREVT(RIGHT_DCLICK, fn)
135
// taskbar menu is shown on right button press under all platforms except MSW
136
// where it's shown on right button release, using this event type and macro
137
// allows to write code which works correctly on all platforms
139
#define wxEVT_TASKBAR_CLICK wxEVT_TASKBAR_RIGHT_UP
141
#define wxEVT_TASKBAR_CLICK wxEVT_TASKBAR_RIGHT_DOWN
143
#define EVT_TASKBAR_CLICK(fn) wx__DECLARE_TASKBAREVT(CLICK, fn)
145
// these events are currently generated only under wxMSW and only after (MSW-
146
// specific) ShowBalloon() had been called, don't use them in portable code
147
#define EVT_TASKBAR_BALLOON_TIMEOUT(fn) \
148
wx__DECLARE_TASKBAREVT(BALLOON_TIMEOUT, fn)
149
#define EVT_TASKBAR_BALLOON_CLICK(fn) \
150
wx__DECLARE_TASKBAREVT(BALLOON_CLICK, fn)
152
#endif // wxUSE_TASKBARICON
154
#endif // _WX_TASKBAR_H_BASE_