]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
mac cgcolor changes
[wxWidgets.git] / include / wx / event.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
bd83cb56 2// Name: wx/event.h
c801d85f
KB
3// Purpose: Event classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
1648d51b
VZ
12#ifndef _WX_EVENT_H__
13#define _WX_EVENT_H__
c801d85f 14
c801d85f 15#include "wx/defs.h"
bde626ce 16#include "wx/cpp.h"
c801d85f 17#include "wx/object.h"
341050e2 18#include "wx/clntdata.h"
e90c1d2a
VZ
19
20#if wxUSE_GUI
21 #include "wx/gdicmn.h"
43b5058d 22 #include "wx/cursor.h"
e90c1d2a 23#endif
42e69d6b 24
72cdf4c9 25#include "wx/thread.h"
c801d85f 26
b5a98acd
VZ
27#include "wx/dynarray.h"
28
e90c1d2a
VZ
29// ----------------------------------------------------------------------------
30// forward declarations
31// ----------------------------------------------------------------------------
32
b5dbe15d 33class WXDLLIMPEXP_FWD_BASE wxList;
e90c1d2a
VZ
34
35#if wxUSE_GUI
b5dbe15d
VS
36 class WXDLLIMPEXP_FWD_CORE wxDC;
37 class WXDLLIMPEXP_FWD_CORE wxMenu;
38 class WXDLLIMPEXP_FWD_CORE wxWindow;
39 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
e90c1d2a
VZ
40#endif // wxUSE_GUI
41
b5dbe15d 42class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
432968bf 43
e90c1d2a
VZ
44// ----------------------------------------------------------------------------
45// Event types
46// ----------------------------------------------------------------------------
64693098 47
cbee8f8d
VZ
48typedef int wxEventType;
49
c4fa5aa7
VZ
50#define wxEVT_ANY ((wxEventType)-1)
51
3a818b15
VZ
52// this is used to make the event table entry type safe, so that for an event
53// handler only a function with proper parameter list can be given.
f29fe169 54#define wxStaticCastEvent(type, val) wx_static_cast(type, val)
3a818b15 55
77ffb593 56// in previous versions of wxWidgets the event types used to be constants
cbee8f8d
VZ
57// which created difficulties with custom/user event types definition
58//
77ffb593 59// starting from wxWidgets 2.4 the event types are now dynamically assigned
cbee8f8d
VZ
60// using wxNewEventType() which solves this problem, however at price of
61// several incompatibilities:
62//
63// a) event table macros declaration changed, it now uses wxEventTableEntry
64// ctor instead of initialisation from an agregate - the macro
65// DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
77ffb593 66// with all versions of wxWidgets
cbee8f8d
VZ
67//
68// b) event types can't be used as switch() cases as they're not really
69// constant any more - there is no magic solution here, you just have to
70// change the switch()es to if()s
71//
72// if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
494c7caa
VZ
73// as 1 to get 100% old behaviour, however you won't be able to use the
74// libraries using the new dynamic event type allocation in such case, so avoid
75// it if possible.
76#ifndef WXWIN_COMPATIBILITY_EVENT_TYPES
77 #define WXWIN_COMPATIBILITY_EVENT_TYPES 0
78#endif
cbee8f8d
VZ
79
80#if WXWIN_COMPATIBILITY_EVENT_TYPES
81
d9e2e4c2
DE
82#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
83 { type, winid, idLast, fn, obj }
cbee8f8d 84
2e4df4bf
VZ
85#define BEGIN_DECLARE_EVENT_TYPES() enum {
86#define END_DECLARE_EVENT_TYPES() };
cbee8f8d 87#define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
fdb59905 88#define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value,
886dd7d2
VZ
89#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
90 DECLARE_LOCAL_EVENT_TYPE(name, value)
2e4df4bf 91#define DEFINE_EVENT_TYPE(name)
1a40c31e 92#define DEFINE_LOCAL_EVENT_TYPE(name)
cbee8f8d 93
5527476f 94
cbee8f8d
VZ
95#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
96
d9e2e4c2
DE
97#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
98 wxEventTableEntry(type, winid, idLast, fn, obj)
cbee8f8d 99
2e4df4bf
VZ
100#define BEGIN_DECLARE_EVENT_TYPES()
101#define END_DECLARE_EVENT_TYPES()
886dd7d2
VZ
102#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
103 extern expdecl const wxEventType name;
85664da6 104#define DECLARE_EVENT_TYPE(name, value) \
bddd7a8d 105 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
886dd7d2 106#define DECLARE_LOCAL_EVENT_TYPE(name, value) \
bde626ce 107 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
71499aaf 108#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
886dd7d2 109#define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
cbee8f8d
VZ
110
111// generate a new unique event type
bddd7a8d 112extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
cbee8f8d
VZ
113
114#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
115
2e4df4bf
VZ
116BEGIN_DECLARE_EVENT_TYPES()
117
cbee8f8d 118#if WXWIN_COMPATIBILITY_EVENT_TYPES
cbee8f8d
VZ
119 wxEVT_NULL = 0,
120 wxEVT_FIRST = 10000,
2e4df4bf 121 wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
cbee8f8d 122#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
6164f93c
VZ
123 // it is important to still have these as constants to avoid
124 // initialization order related problems
bddd7a8d
VZ
125 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0)
126 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000)
127 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000)
cbee8f8d
VZ
128#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
129
2e4df4bf
VZ
130 DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
131 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
132 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
133 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
134 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
135 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
ad0bae85
VZ
136 // now they are in wx/textctrl.h
137#if WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
138 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
ad0bae85 140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
d7eee191 141 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
ad0bae85 142#endif // WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
143 DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
144 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
145 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
146 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
147
148 // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
149 // wxEVT_SCROLL... events
150
151 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
152 DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
153 DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
154 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
155 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
156 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
157
a9a0ceca
VZ
158 // Toolbar dropdown arrows
159 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, 19)
160
2e4df4bf 161 // Sockets and timers send events, too
bddd7a8d 162 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50)
c2ca375c 163 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_TIMER , 80)
2e4df4bf
VZ
164
165 // Mouse event types
166 DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
167 DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
168 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
169 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
170 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
171 DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
172 DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
173 DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
174 DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
175 DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
176 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
177 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
178 DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
179 DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
456bc6d9
VZ
180 DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
181 DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
01101e2d
VZ
182 DECLARE_EVENT_TYPE(wxEVT_AUX1_DOWN, 116)
183 DECLARE_EVENT_TYPE(wxEVT_AUX1_UP, 117)
184 DECLARE_EVENT_TYPE(wxEVT_AUX1_DCLICK, 118)
185 DECLARE_EVENT_TYPE(wxEVT_AUX2_DOWN, 119)
186 DECLARE_EVENT_TYPE(wxEVT_AUX2_UP, 120)
187 DECLARE_EVENT_TYPE(wxEVT_AUX2_DCLICK, 121)
2e4df4bf
VZ
188
189 // Non-client mouse events
190 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
191 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
192 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
193 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
194 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
195 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
196 DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
197 DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
198 DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
199 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
200 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
201 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
202
203 // Character input event type
204 DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
205 DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
206 DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
207 DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
208 DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
5048c832
JS
209#if wxUSE_HOTKEY
210 DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217)
211#endif
2e4df4bf
VZ
212 // Set cursor event
213 DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
214
e8b669d3 215 // wxScrollBar and wxSlider event identifiers
2e4df4bf
VZ
216 DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
217 DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
218 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
219 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
220 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
221 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
222 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
223 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
cbc85508 224 DECLARE_EVENT_TYPE(wxEVT_SCROLL_CHANGED, 308)
2e4df4bf
VZ
225
226 // Scroll events from wxWindow
227 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
228 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
229 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
230 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
231 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
232 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
233 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
234 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
235
236 // System events
237 DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
238 DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
239 DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
240 DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
241 DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
242 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
355debca 243 // 406..408 are power events
2e4df4bf
VZ
244 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
245 DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
246 DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
247 DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
248 DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
249 DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
250 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
63e819f2
VS
251 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST, 416)
252 DECLARE_EVENT_TYPE(wxEVT_PAINT, 417)
253 DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 418)
254 DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 419)
255 DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 420)
256 DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 421)
257 DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 422)
258 DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 423)
2e4df4bf
VZ
259 DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
260 DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
574c939e
KB
261 DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
262 DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
263 DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
264 DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
265 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
266 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
267 DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
268 DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
269 DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
270 DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
271 DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
272 DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
273 DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
bddd7a8d 274 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439)
574c939e 275 DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
5706de1c 276 DECLARE_EVENT_TYPE(wxEVT_SIZING, 441)
4d4f4290 277 DECLARE_EVENT_TYPE(wxEVT_MOVING, 442)
aa767a45
JS
278 DECLARE_EVENT_TYPE(wxEVT_MOVE_START, 443)
279 DECLARE_EVENT_TYPE(wxEVT_MOVE_END, 444)
280 DECLARE_EVENT_TYPE(wxEVT_HIBERNATE, 445)
355debca 281 // more power events follow -- see wx/power.h
2e4df4bf 282
78c91815 283 // Clipboard events
aa767a45
JS
284 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY, 446)
285 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT, 447)
286 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE, 448)
78c91815 287
2e4df4bf
VZ
288 // Generic command events
289 // Note: a click is a higher-level event than button down/up
290 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
291 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
292 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
293 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
294 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
295 DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
296 DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
297
298 // Help events
299 DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
300 DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
301
302END_DECLARE_EVENT_TYPES()
96f6c703 303
cbee8f8d
VZ
304// these 2 events are the same
305#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
96f6c703 306
ad0bae85 307// ----------------------------------------------------------------------------
77d4384e 308// Compatibility
ad0bae85
VZ
309// ----------------------------------------------------------------------------
310
311// this event is also used by wxComboBox and wxSpinCtrl which don't include
312// wx/textctrl.h in all ports [yet], so declare it here as well
313//
314// still, any new code using it should include wx/textctrl.h explicitly
315#if !WXWIN_COMPATIBILITY_EVENT_TYPES
bddd7a8d 316 extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
ad0bae85 317#endif
c801d85f 318
1648d51b
VZ
319// the predefined constants for the number of times we propagate event
320// upwards window child-parent chain
321enum Propagation_state
322{
323 // don't propagate it at all
324 wxEVENT_PROPAGATE_NONE = 0,
325
326 // propagate it until it is processed
327 wxEVENT_PROPAGATE_MAX = INT_MAX
328};
329
c801d85f 330/*
77ffb593 331 * wxWidgets events, covering all interesting things that might happen
c801d85f
KB
332 * (button clicking, resizing, setting text in widgets, etc.).
333 *
334 * For each completely new event type, derive a new event class.
335 * An event CLASS represents a C++ class defining a range of similar event TYPES;
336 * examples are canvas events, panel item command events.
337 * An event TYPE is a unique identifier for a particular system event,
338 * such as a button press or a listbox deselection.
339 *
340 */
341
bddd7a8d 342class WXDLLIMPEXP_BASE wxEvent : public wxObject
c801d85f 343{
e6a6feba
GD
344private:
345 wxEvent& operator=(const wxEvent&);
abcbaea7 346
8e72b8b5
RR
347protected:
348 wxEvent(const wxEvent&); // for implementing Clone()
c801d85f
KB
349
350public:
d9e2e4c2 351 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
2b854a32
VZ
352
353 void SetEventType(wxEventType typ) { m_eventType = typ; }
354 wxEventType GetEventType() const { return m_eventType; }
355 wxObject *GetEventObject() const { return m_eventObject; }
356 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
357 long GetTimestamp() const { return m_timeStamp; }
358 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
359 int GetId() const { return m_id; }
360 void SetId(int Id) { m_id = Id; }
361
362 // Can instruct event processor that we wish to ignore this event
363 // (treat as if the event table entry had not been found): this must be done
364 // to allow the event processing by the base classes (calling event.Skip()
a0d9c6cb
WS
365 // is the analog of calling the base class version of a virtual function)
366 void Skip(bool skip = true) { m_skipped = skip; }
47b378bd 367 bool GetSkipped() const { return m_skipped; }
c801d85f 368
acd15a3f
VZ
369 // this function is used to create a copy of the event polymorphically and
370 // all derived classes must implement it because otherwise wxPostEvent()
371 // for them wouldn't work (it needs to do a copy of the event)
372 virtual wxEvent *Clone() const = 0;
a737331d 373
87b6002d 374 // Implementation only: this test is explicitly anti OO and this function
1648d51b
VZ
375 // exists only for optimization purposes.
376 bool IsCommandEvent() const { return m_isCommandEvent; }
377
378 // Determine if this event should be propagating to the parent window.
379 bool ShouldPropagate() const
380 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
381
382 // Stop an event from propagating to its parent window, returns the old
383 // propagation level value
384 int StopPropagation()
385 {
386 int propagationLevel = m_propagationLevel;
387 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
388 return propagationLevel;
389 }
390
391 // Resume the event propagation by restoring the propagation level
392 // (returned by StopPropagation())
393 void ResumePropagation(int propagationLevel)
394 {
395 m_propagationLevel = propagationLevel;
396 }
397
b4b76d61 398protected:
2b854a32 399 wxObject* m_eventObject;
2b854a32
VZ
400 wxEventType m_eventType;
401 long m_timeStamp;
402 int m_id;
b4b76d61
KH
403
404public:
405 // m_callbackUserData is for internal usage only
2b854a32 406 wxObject* m_callbackUserData;
1648d51b
VZ
407
408protected:
409 // the propagation level: while it is positive, we propagate the event to
410 // the parent window (if any)
411 //
412 // this one doesn't have to be public, we don't have to worry about
413 // backwards compatibility as it is new
414 int m_propagationLevel;
415
b4b76d61 416protected:
42e69d6b 417 bool m_skipped;
193bf013 418 bool m_isCommandEvent;
1c624631 419
8e72b8b5 420private:
1648d51b 421 // it needs to access our m_propagationLevel
b5dbe15d 422 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
1648d51b 423
8e72b8b5 424 DECLARE_ABSTRACT_CLASS(wxEvent)
c801d85f
KB
425};
426
1648d51b
VZ
427/*
428 * Helper class to temporarily change an event not to propagate.
429 */
430class WXDLLIMPEXP_BASE wxPropagationDisabler
431{
432public:
433 wxPropagationDisabler(wxEvent& event) : m_event(event)
434 {
435 m_propagationLevelOld = m_event.StopPropagation();
436 }
437
438 ~wxPropagationDisabler()
439 {
440 m_event.ResumePropagation(m_propagationLevelOld);
441 }
442
443private:
444 wxEvent& m_event;
445 int m_propagationLevelOld;
fc7a2a60
VZ
446
447 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
1648d51b
VZ
448};
449
450/*
451 * Another one to temporarily lower propagation level.
452 */
453class WXDLLIMPEXP_BASE wxPropagateOnce
454{
455public:
456 wxPropagateOnce(wxEvent& event) : m_event(event)
457 {
458 wxASSERT_MSG( m_event.m_propagationLevel > 0,
459 _T("shouldn't be used unless ShouldPropagate()!") );
460
461 m_event.m_propagationLevel--;
462 }
463
464 ~wxPropagateOnce()
465 {
466 m_event.m_propagationLevel++;
467 }
468
469private:
470 wxEvent& m_event;
fc7a2a60
VZ
471
472 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
1648d51b
VZ
473};
474
c4fa5aa7 475
e90c1d2a
VZ
476#if wxUSE_GUI
477
1648d51b 478
c801d85f
KB
479// Item or menu event class
480/*
481 wxEVT_COMMAND_BUTTON_CLICKED
482 wxEVT_COMMAND_CHECKBOX_CLICKED
483 wxEVT_COMMAND_CHOICE_SELECTED
484 wxEVT_COMMAND_LISTBOX_SELECTED
485 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
486 wxEVT_COMMAND_TEXT_UPDATED
487 wxEVT_COMMAND_TEXT_ENTER
488 wxEVT_COMMAND_MENU_SELECTED
489 wxEVT_COMMAND_SLIDER_UPDATED
490 wxEVT_COMMAND_RADIOBOX_SELECTED
491 wxEVT_COMMAND_RADIOBUTTON_SELECTED
492 wxEVT_COMMAND_SCROLLBAR_UPDATED
493 wxEVT_COMMAND_VLBOX_SELECTED
494 wxEVT_COMMAND_COMBOBOX_SELECTED
1db8dc4a 495 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
c801d85f
KB
496*/
497
bddd7a8d 498class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
c801d85f 499{
2b854a32 500public:
d9e2e4c2 501 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
c801d85f 502
e6a6feba 503 wxCommandEvent(const wxCommandEvent& event)
497dbbd3 504 : wxEvent(event),
b4b76d61 505 m_cmdString(event.m_cmdString),
497dbbd3
VZ
506 m_commandInt(event.m_commandInt),
507 m_extraLong(event.m_extraLong),
508 m_clientData(event.m_clientData),
509 m_clientObject(event.m_clientObject)
e6a6feba
GD
510 { }
511
2b854a32
VZ
512 // Set/Get client data from controls
513 void SetClientData(void* clientData) { m_clientData = clientData; }
514 void *GetClientData() const { return m_clientData; }
c801d85f 515
2b854a32
VZ
516 // Set/Get client object from controls
517 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
88eadcf2 518 wxClientData *GetClientObject() const { return m_clientObject; }
f5e27805 519
2b854a32
VZ
520 // Get listbox selection if single-choice
521 int GetSelection() const { return m_commandInt; }
c801d85f 522
2b854a32 523 // Set/Get listbox/choice selection string
b4b76d61
KH
524 void SetString(const wxString& s) { m_cmdString = s; }
525 wxString GetString() const;
c801d85f 526
2b854a32 527 // Get checkbox value
3ca6a5f0 528 bool IsChecked() const { return m_commandInt != 0; }
c801d85f 529
a0d9c6cb 530 // true if the listbox event was a selection.
2b854a32 531 bool IsSelection() const { return (m_extraLong != 0); }
c801d85f 532
2b854a32 533 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
a7bc03c9 534 long GetExtraLong() const { return m_extraLong; }
c801d85f 535
2b854a32 536 void SetInt(int i) { m_commandInt = i; }
fd587c7a 537 int GetInt() const { return m_commandInt; }
c801d85f 538
8e72b8b5 539 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
aadbdf11 540
b4b76d61 541protected:
b4b76d61 542 wxString m_cmdString; // String event argument
2b854a32
VZ
543 int m_commandInt;
544 long m_extraLong; // Additional information (e.g. select/deselect)
545 void* m_clientData; // Arbitrary client data
546 wxClientData* m_clientObject; // Arbitrary client object
f97500b8 547
8e72b8b5 548private:
fc7a2a60 549 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
c801d85f
KB
550};
551
fd3f686c
VZ
552// this class adds a possibility to react (from the user) code to a control
553// notification: allow or veto the operation being reported.
bddd7a8d 554class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
555{
556public:
d9e2e4c2
DE
557 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
558 : wxCommandEvent(commandType, winid)
a0d9c6cb 559 { m_bAllow = true; }
e6a6feba
GD
560
561 wxNotifyEvent(const wxNotifyEvent& event)
562 : wxCommandEvent(event)
497dbbd3 563 { m_bAllow = event.m_bAllow; }
fd3f686c 564
23f681ec 565 // veto the operation (usually it's allowed by default)
a0d9c6cb 566 void Veto() { m_bAllow = false; }
fd3f686c 567
23f681ec 568 // allow the operation if it was disabled by default
a0d9c6cb 569 void Allow() { m_bAllow = true; }
23f681ec 570
fd3f686c
VZ
571 // for implementation code only: is the operation allowed?
572 bool IsAllowed() const { return m_bAllow; }
573
8e72b8b5 574 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
924ef850 575
fd3f686c
VZ
576private:
577 bool m_bAllow;
578
8e72b8b5 579private:
fc7a2a60 580 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
fd3f686c
VZ
581};
582
d1367c3d 583// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
e8b669d3 584// sent by wxSlider and wxScrollBar.
c801d85f
KB
585/*
586 wxEVT_SCROLL_TOP
587 wxEVT_SCROLL_BOTTOM
588 wxEVT_SCROLL_LINEUP
589 wxEVT_SCROLL_LINEDOWN
590 wxEVT_SCROLL_PAGEUP
591 wxEVT_SCROLL_PAGEDOWN
592 wxEVT_SCROLL_THUMBTRACK
7d56fb8f 593 wxEVT_SCROLL_THUMBRELEASE
cbc85508 594 wxEVT_SCROLL_CHANGED
c801d85f
KB
595*/
596
bddd7a8d 597class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
c801d85f 598{
2b854a32
VZ
599public:
600 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
d9e2e4c2 601 int winid = 0, int pos = 0, int orient = 0);
2b854a32 602
a7bc03c9
VZ
603 int GetOrientation() const { return (int) m_extraLong; }
604 int GetPosition() const { return m_commandInt; }
2b854a32
VZ
605 void SetOrientation(int orient) { m_extraLong = (long) orient; }
606 void SetPosition(int pos) { m_commandInt = pos; }
f97500b8 607
8e72b8b5 608 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
f97500b8 609
8e72b8b5 610private:
fc7a2a60 611 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
c801d85f
KB
612};
613
d1367c3d
RR
614// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
615// are sent by wxWindow.
616/*
617 wxEVT_SCROLLWIN_TOP
618 wxEVT_SCROLLWIN_BOTTOM
619 wxEVT_SCROLLWIN_LINEUP
620 wxEVT_SCROLLWIN_LINEDOWN
621 wxEVT_SCROLLWIN_PAGEUP
622 wxEVT_SCROLLWIN_PAGEDOWN
623 wxEVT_SCROLLWIN_THUMBTRACK
7d56fb8f 624 wxEVT_SCROLLWIN_THUMBRELEASE
d1367c3d
RR
625*/
626
bddd7a8d 627class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
d1367c3d 628{
d1367c3d
RR
629public:
630 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
631 int pos = 0, int orient = 0);
b2697d42
VZ
632 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
633 { m_commandInt = event.m_commandInt;
634 m_extraLong = event.m_extraLong; }
d1367c3d 635
a7bc03c9
VZ
636 int GetOrientation() const { return (int) m_extraLong; }
637 int GetPosition() const { return m_commandInt; }
d1367c3d
RR
638 void SetOrientation(int orient) { m_extraLong = (long) orient; }
639 void SetPosition(int pos) { m_commandInt = pos; }
640
8e72b8b5 641 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1e6feb95 642
b4b76d61 643protected:
8e72b8b5 644 int m_commandInt;
20947e08 645 long m_extraLong;
1e6feb95 646
8e72b8b5 647private:
fc7a2a60 648 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
d1367c3d
RR
649};
650
c801d85f
KB
651// Mouse event class
652
653/*
654 wxEVT_LEFT_DOWN
655 wxEVT_LEFT_UP
656 wxEVT_MIDDLE_DOWN
657 wxEVT_MIDDLE_UP
658 wxEVT_RIGHT_DOWN
659 wxEVT_RIGHT_UP
660 wxEVT_MOTION
661 wxEVT_ENTER_WINDOW
662 wxEVT_LEAVE_WINDOW
663 wxEVT_LEFT_DCLICK
664 wxEVT_MIDDLE_DCLICK
665 wxEVT_RIGHT_DCLICK
666 wxEVT_NC_LEFT_DOWN
667 wxEVT_NC_LEFT_UP,
668 wxEVT_NC_MIDDLE_DOWN,
669 wxEVT_NC_MIDDLE_UP,
670 wxEVT_NC_RIGHT_DOWN,
671 wxEVT_NC_RIGHT_UP,
672 wxEVT_NC_MOTION,
673 wxEVT_NC_ENTER_WINDOW,
674 wxEVT_NC_LEAVE_WINDOW,
675 wxEVT_NC_LEFT_DCLICK,
676 wxEVT_NC_MIDDLE_DCLICK,
677 wxEVT_NC_RIGHT_DCLICK,
678*/
679
497dbbd3
VZ
680// the symbolic names for the mouse buttons
681enum
682{
683 wxMOUSE_BTN_ANY = -1,
3e89999c
VZ
684 wxMOUSE_BTN_NONE = 0,
685 wxMOUSE_BTN_LEFT = 1,
686 wxMOUSE_BTN_MIDDLE = 2,
01101e2d
VZ
687 wxMOUSE_BTN_RIGHT = 3,
688 wxMOUSE_BTN_AUX1 = 4,
689 wxMOUSE_BTN_AUX2 = 5,
690 wxMOUSE_BTN_MAX
497dbbd3
VZ
691};
692
bddd7a8d 693class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
c801d85f 694{
2b854a32
VZ
695public:
696 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
8866abbb 697 wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
b2697d42 698 { Assign(event); }
c801d85f 699
2b854a32 700 // Was it a button event? (*doesn't* mean: is any button *down*?)
497dbbd3 701 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
c801d85f 702
3e89999c 703 // Was it a down event from this (or any) button?
497dbbd3 704 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
c801d85f 705
3e89999c 706 // Was it a dclick event from this (or any) button?
497dbbd3 707 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
c801d85f 708
3e89999c 709 // Was it a up event from this (or any) button?
497dbbd3 710 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
c801d85f 711
3e89999c 712 // Was the given button?
2b854a32 713 bool Button(int but) const;
c801d85f 714
3e89999c 715 // Was the given button in Down state?
2b854a32 716 bool ButtonIsDown(int but) const;
c801d85f 717
497dbbd3 718 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1e6feb95
VZ
719 int GetButton() const;
720
2b854a32
VZ
721 // Find state of shift/control keys
722 bool ControlDown() const { return m_controlDown; }
723 bool MetaDown() const { return m_metaDown; }
724 bool AltDown() const { return m_altDown; }
725 bool ShiftDown() const { return m_shiftDown; }
a2bd1520
VZ
726 bool CmdDown() const
727 {
728#if defined(__WXMAC__) || defined(__WXCOCOA__)
729 return MetaDown();
730#else
731 return ControlDown();
732#endif
733 }
c801d85f 734
2b854a32
VZ
735 // Find which event was just generated
736 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
737 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
738 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
01101e2d
VZ
739 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
740 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
c801d85f 741
2b854a32
VZ
742 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
743 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
744 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
01101e2d
VZ
745 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
746 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
c801d85f 747
2b854a32
VZ
748 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
749 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
750 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
01101e2d
VZ
751 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
752 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
c801d85f 753
2b854a32
VZ
754 // Find the current state of the mouse buttons (regardless
755 // of current event type)
756 bool LeftIsDown() const { return m_leftDown; }
757 bool MiddleIsDown() const { return m_middleDown; }
758 bool RightIsDown() const { return m_rightDown; }
01101e2d
VZ
759 bool Aux1IsDown() const { return m_aux1Down; }
760 bool Aux2IsDown() const { return m_aux2Down; }
c801d85f 761
2b854a32
VZ
762 // True if a button is down and the mouse is moving
763 bool Dragging() const
764 {
5b66d31a 765 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
2b854a32 766 }
c801d85f 767
2b854a32 768 // True if the mouse is moving, and no button is down
6f63704f
VZ
769 bool Moving() const
770 {
5b66d31a 771 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
6f63704f 772 }
c801d85f 773
2b854a32
VZ
774 // True if the mouse is just entering the window
775 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 776
2b854a32
VZ
777 // True if the mouse is just leaving the window
778 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 779
8866abbb
VZ
780 // Returns the number of mouse clicks associated with this event.
781 int GetClickCount() const { return m_clickCount; }
782
783
2b854a32 784 // Find the position of the event
20947e08 785 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
b02da6b1
VZ
786 {
787 if (xpos)
20947e08 788 *xpos = m_x;
b02da6b1
VZ
789 if (ypos)
790 *ypos = m_y;
791 }
792
bf57d1ad 793 void GetPosition(long *xpos, long *ypos) const
b02da6b1
VZ
794 {
795 if (xpos)
20947e08 796 *xpos = (long)m_x;
b02da6b1 797 if (ypos)
bf57d1ad 798 *ypos = (long)m_y;
b02da6b1 799 }
c801d85f 800
2b854a32
VZ
801 // Find the position of the event
802 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 803
2b854a32 804 // Find the logical position of the event given the DC
a7bc03c9 805 wxPoint GetLogicalPosition(const wxDC& dc) const;
c801d85f 806
2b854a32 807 // Get X position
6cedba09 808 wxCoord GetX() const { return m_x; }
c801d85f 809
2b854a32 810 // Get Y position
6cedba09 811 wxCoord GetY() const { return m_y; }
c801d85f 812
d2c52078
RD
813 // Get wheel rotation, positive or negative indicates direction of
814 // rotation. Current devices all send an event when rotation is equal to
815 // +/-WheelDelta, but this allows for finer resolution devices to be
816 // created in the future. Because of this you shouldn't assume that one
817 // event is equal to 1 line or whatever, but you should be able to either
818 // do partial line scrolling or wait until +/-WheelDelta rotation values
819 // have been accumulated before scrolling.
820 int GetWheelRotation() const { return m_wheelRotation; }
821
822 // Get wheel delta, normally 120. This is the threshold for action to be
823 // taken, and one such action (for example, scrolling one increment)
824 // should occur for each delta.
825 int GetWheelDelta() const { return m_wheelDelta; }
826
aea37008
SC
827 // Gets the axis the wheel operation concerns, 0 being the y axis as on
828 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
829 // or horizontal trackpad scrolling
830 int GetWheelAxis() const { return m_wheelAxis; }
831
d2c52078
RD
832 // Returns the configured number of lines (or whatever) to be scrolled per
833 // wheel action. Defaults to one.
834 int GetLinesPerAction() const { return m_linesPerAction; }
aa767a45 835
9b9337da 836 // Is the system set to do page scrolling?
c2bbeff0 837 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
9b9337da 838
8e72b8b5 839 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
aadbdf11 840
55f9eba3 841 wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
c7d176e2 842
c801d85f 843public:
b02da6b1
VZ
844 wxCoord m_x, m_y;
845
2b854a32
VZ
846 bool m_leftDown;
847 bool m_middleDown;
848 bool m_rightDown;
01101e2d
VZ
849 bool m_aux1Down;
850 bool m_aux2Down;
2b854a32
VZ
851
852 bool m_controlDown;
853 bool m_shiftDown;
854 bool m_altDown;
855 bool m_metaDown;
aa767a45 856
8866abbb
VZ
857 int m_clickCount;
858
aea37008 859 int m_wheelAxis;
d2c52078
RD
860 int m_wheelRotation;
861 int m_wheelDelta;
862 int m_linesPerAction;
1e6feb95 863
abcbaea7
VZ
864protected:
865 void Assign(const wxMouseEvent& evt);
866
1e6feb95
VZ
867private:
868 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f
KB
869};
870
43b5058d
VZ
871// Cursor set event
872
873/*
874 wxEVT_SET_CURSOR
875 */
876
bddd7a8d 877class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
43b5058d
VZ
878{
879public:
8e72b8b5 880 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
497dbbd3
VZ
881 : wxEvent(0, wxEVT_SET_CURSOR),
882 m_x(x), m_y(y), m_cursor()
e6a6feba 883 { }
43b5058d 884
b2697d42
VZ
885 wxSetCursorEvent(const wxSetCursorEvent & event)
886 : wxEvent(event),
887 m_x(event.m_x),
888 m_y(event.m_y),
889 m_cursor(event.m_cursor)
890 { }
1d2eddff 891
43b5058d
VZ
892 wxCoord GetX() const { return m_x; }
893 wxCoord GetY() const { return m_y; }
894
895 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
896 const wxCursor& GetCursor() const { return m_cursor; }
897 bool HasCursor() const { return m_cursor.Ok(); }
898
8e72b8b5 899 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
f97500b8 900
43b5058d
VZ
901private:
902 wxCoord m_x, m_y;
903 wxCursor m_cursor;
f97500b8 904
8e72b8b5 905private:
fc7a2a60 906 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
43b5058d
VZ
907};
908
c801d85f
KB
909// Keyboard input event class
910
911/*
912 wxEVT_CHAR
913 wxEVT_CHAR_HOOK
4ce81a75 914 wxEVT_KEY_DOWN
c801d85f 915 wxEVT_KEY_UP
5048c832 916 wxEVT_HOTKEY
c801d85f
KB
917 */
918
bddd7a8d 919class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
c801d85f 920{
c801d85f 921public:
2b854a32 922 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
b2697d42 923 wxKeyEvent(const wxKeyEvent& evt);
c801d85f 924
e7102772
VZ
925 // can be used check if the key event has exactly the given modifiers:
926 // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
927 // && !MetaDown() && !AltDown() && !ShiftDown()"
928 int GetModifiers() const
929 {
930 return (m_controlDown ? wxMOD_CONTROL : 0) |
931 (m_shiftDown ? wxMOD_SHIFT : 0) |
932 (m_metaDown ? wxMOD_META : 0) |
933 (m_altDown ? wxMOD_ALT : 0);
934 }
935
2b854a32
VZ
936 // Find state of shift/control keys
937 bool ControlDown() const { return m_controlDown; }
e7102772 938 bool ShiftDown() const { return m_shiftDown; }
2b854a32
VZ
939 bool MetaDown() const { return m_metaDown; }
940 bool AltDown() const { return m_altDown; }
f6bcfd97 941
a2bd1520
VZ
942 // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
943 // Apple ("Command") key under Macs: it makes often sense to use it instead
944 // of, say, ControlDown() because Cmd key is used for the same thing under
945 // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
946 // purpose under Mac)
947 bool CmdDown() const
948 {
949#if defined(__WXMAC__) || defined(__WXCOCOA__)
950 return MetaDown();
951#else
952 return ControlDown();
953#endif
954 }
955
d11710cb
VZ
956 // exclude MetaDown() from HasModifiers() because NumLock under X is often
957 // configured as mod2 modifier, yet the key events even when it is pressed
958 // should be processed normally, not like Ctrl- or Alt-key
959 bool HasModifiers() const { return ControlDown() || AltDown(); }
f6bcfd97
BP
960
961 // get the key code: an ASCII7 char or an element of wxKeyCode enum
962 int GetKeyCode() const { return (int)m_keyCode; }
c801d85f 963
a3db5254
VZ
964#if wxUSE_UNICODE
965 // get the Unicode character corresponding to this key
966 wxChar GetUnicodeKey() const { return m_uniChar; }
967#endif // wxUSE_UNICODE
968
9c7df356
VZ
969 // get the raw key code (platform-dependent)
970 wxUint32 GetRawKeyCode() const { return m_rawCode; }
971
972 // get the raw key flags (platform-dependent)
973 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
974
2b854a32 975 // Find the position of the event
b02da6b1
VZ
976 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
977 {
20947e08 978 if (xpos) *xpos = m_x;
b02da6b1
VZ
979 if (ypos) *ypos = m_y;
980 }
981
bf57d1ad 982 void GetPosition(long *xpos, long *ypos) const
b02da6b1 983 {
20947e08 984 if (xpos) *xpos = (long)m_x;
bf57d1ad 985 if (ypos) *ypos = (long)m_y;
b02da6b1 986 }
803ef874
JS
987
988 wxPoint GetPosition() const
989 { return wxPoint(m_x, m_y); }
c801d85f 990
2b854a32 991 // Get X position
b02da6b1 992 wxCoord GetX() const { return m_x; }
c801d85f 993
2b854a32 994 // Get Y position
b02da6b1 995 wxCoord GetY() const { return m_y; }
c801d85f 996
ca3e85cf 997#if WXWIN_COMPATIBILITY_2_6
12a3f227
RL
998 // deprecated, Use GetKeyCode instead.
999 wxDEPRECATED( long KeyCode() const );
ca3e85cf 1000#endif // WXWIN_COMPATIBILITY_2_6
f6bcfd97 1001
8e72b8b5 1002 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
f97500b8
VZ
1003
1004 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1005 // example)
1006 wxKeyEvent& operator=(const wxKeyEvent& evt)
1007 {
1008 m_x = evt.m_x;
1009 m_y = evt.m_y;
1010
1011 m_keyCode = evt.m_keyCode;
1012
1013 m_controlDown = evt.m_controlDown;
1014 m_shiftDown = evt.m_shiftDown;
1015 m_altDown = evt.m_altDown;
1016 m_metaDown = evt.m_metaDown;
1017 m_scanCode = evt.m_scanCode;
9c7df356
VZ
1018 m_rawCode = evt.m_rawCode;
1019 m_rawFlags = evt.m_rawFlags;
cedea72f
VS
1020#if wxUSE_UNICODE
1021 m_uniChar = evt.m_uniChar;
1022#endif
f97500b8
VZ
1023
1024 return *this;
1025 }
1026
2b854a32 1027public:
b02da6b1
VZ
1028 wxCoord m_x, m_y;
1029
2b854a32 1030 long m_keyCode;
b02da6b1 1031
e7102772 1032 // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
2b854a32
VZ
1033 bool m_controlDown;
1034 bool m_shiftDown;
1035 bool m_altDown;
1036 bool m_metaDown;
e7102772
VZ
1037
1038 // FIXME: what is this for? relation to m_rawXXX?
b0e813a0 1039 bool m_scanCode;
f97500b8 1040
2b5f62a0
VZ
1041#if wxUSE_UNICODE
1042 // This contains the full Unicode character
1043 // in a character events in Unicode mode
1044 wxChar m_uniChar;
1045#endif
1046
1047 // these fields contain the platform-specific information about
1048 // key that was pressed
9c7df356
VZ
1049 wxUint32 m_rawCode;
1050 wxUint32 m_rawFlags;
1051
8e72b8b5
RR
1052private:
1053 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
1054};
1055
1056// Size event class
1057/*
1058 wxEVT_SIZE
1059 */
1060
bddd7a8d 1061class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
c801d85f 1062{
2b854a32 1063public:
497dbbd3 1064 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
e6a6feba 1065 { }
d9e2e4c2
DE
1066 wxSizeEvent(const wxSize& sz, int winid = 0)
1067 : wxEvent(winid, wxEVT_SIZE),
497dbbd3 1068 m_size(sz)
e6a6feba 1069 { }
1d2eddff 1070 wxSizeEvent(const wxSizeEvent & event)
b2697d42 1071 : wxEvent(event),
5706de1c 1072 m_size(event.m_size), m_rect(event.m_rect)
b2697d42 1073 { }
5706de1c 1074 wxSizeEvent(const wxRect& rect, int id = 0)
e00865fa 1075 : m_size(rect.GetSize()), m_rect(rect)
5706de1c 1076 { m_eventType = wxEVT_SIZING; m_id = id; }
c2bbeff0 1077
2b854a32 1078 wxSize GetSize() const { return m_size; }
5706de1c 1079 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1080 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1081
8e72b8b5
RR
1082 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1083
1084public:
b4b76d61 1085 // For internal usage only. Will be converted to protected members.
8e72b8b5 1086 wxSize m_size;
5706de1c 1087 wxRect m_rect; // Used for wxEVT_SIZING
8e72b8b5 1088
f97500b8 1089private:
fc7a2a60 1090 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
c801d85f
KB
1091};
1092
1093// Move event class
1094
1095/*
1096 wxEVT_MOVE
1097 */
1098
bddd7a8d 1099class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
c801d85f 1100{
2b854a32 1101public:
e6a6feba
GD
1102 wxMoveEvent()
1103 : wxEvent(0, wxEVT_MOVE)
e6a6feba 1104 { }
d9e2e4c2
DE
1105 wxMoveEvent(const wxPoint& pos, int winid = 0)
1106 : wxEvent(winid, wxEVT_MOVE),
497dbbd3 1107 m_pos(pos)
e6a6feba 1108 { }
1d2eddff
JS
1109 wxMoveEvent(const wxMoveEvent& event)
1110 : wxEvent(event),
b2697d42
VZ
1111 m_pos(event.m_pos)
1112 { }
5706de1c
JS
1113 wxMoveEvent(const wxRect& rect, int id = 0)
1114 : m_pos(rect.GetPosition()), m_rect(rect)
1115 { m_eventType = wxEVT_MOVING; m_id = id; }
c2bbeff0 1116
2b854a32 1117 wxPoint GetPosition() const { return m_pos; }
d7f03cae 1118 void SetPosition(const wxPoint& pos) { m_pos = pos; }
5706de1c 1119 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1120 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1121
8e72b8b5 1122 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
f97500b8 1123
b4b76d61 1124protected:
8e72b8b5 1125 wxPoint m_pos;
5706de1c 1126 wxRect m_rect;
f97500b8 1127
8e72b8b5 1128private:
fc7a2a60 1129 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
c801d85f
KB
1130};
1131
1132// Paint event class
1133/*
1134 wxEVT_PAINT
1135 wxEVT_NC_PAINT
1136 wxEVT_PAINT_ICON
1137 */
1138
b078fa02
JS
1139#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1140 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
bddd7a8d 1141 extern WXDLLIMPEXP_CORE int g_isPainting;
edccf428
VZ
1142#endif // debug
1143
bddd7a8d 1144class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
c801d85f 1145{
2b854a32 1146public:
edccf428 1147 wxPaintEvent(int Id = 0)
e6a6feba 1148 : wxEvent(Id, wxEVT_PAINT)
edccf428 1149 {
b078fa02 1150#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ
1151 // set the internal flag for the duration of processing of WM_PAINT
1152 g_isPainting++;
1153#endif // debug
1154 }
1155
4e689ecd
VZ
1156 // default copy ctor and dtor are normally fine, we only need them to keep
1157 // g_isPainting updated in debug build
b078fa02 1158#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
4e689ecd
VZ
1159 wxPaintEvent(const wxPaintEvent& event)
1160 : wxEvent(event)
1161 {
1162 g_isPainting++;
1163 }
1164
d3c7fc99 1165 virtual ~wxPaintEvent()
edccf428
VZ
1166 {
1167 g_isPainting--;
1168 }
1169#endif // debug
8e72b8b5
RR
1170
1171 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
f97500b8 1172
8e72b8b5 1173private:
fc7a2a60 1174 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
c801d85f
KB
1175};
1176
bddd7a8d 1177class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1e6feb95
VZ
1178{
1179public:
d9e2e4c2
DE
1180 wxNcPaintEvent(int winid = 0)
1181 : wxEvent(winid, wxEVT_NC_PAINT)
e6a6feba 1182 { }
f97500b8 1183
8e72b8b5 1184 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1e6feb95
VZ
1185
1186private:
fc7a2a60 1187 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1e6feb95
VZ
1188};
1189
c801d85f
KB
1190// Erase background event class
1191/*
1192 wxEVT_ERASE_BACKGROUND
1193 */
1194
bddd7a8d 1195class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
c801d85f 1196{
2b854a32 1197public:
2b854a32 1198 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
497dbbd3
VZ
1199 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1200 m_dc(dc)
e6a6feba
GD
1201 { }
1202
1203 wxEraseEvent(const wxEraseEvent& event)
497dbbd3
VZ
1204 : wxEvent(event),
1205 m_dc(event.m_dc)
e6a6feba 1206 { }
f97500b8 1207
2b854a32 1208 wxDC *GetDC() const { return m_dc; }
aadbdf11 1209
8e72b8b5 1210 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
f97500b8 1211
b4b76d61 1212protected:
8e72b8b5
RR
1213 wxDC *m_dc;
1214
1215private:
fc7a2a60 1216 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
c801d85f
KB
1217};
1218
1219// Focus event class
1220/*
1221 wxEVT_SET_FOCUS
1222 wxEVT_KILL_FOCUS
1223 */
1224
bddd7a8d 1225class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
c801d85f 1226{
2b854a32 1227public:
d9e2e4c2
DE
1228 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1229 : wxEvent(winid, type)
497dbbd3 1230 { m_win = NULL; }
e6a6feba
GD
1231
1232 wxFocusEvent(const wxFocusEvent& event)
1233 : wxEvent(event)
497dbbd3 1234 { m_win = event.m_win; }
1e6feb95 1235
8e72b8b5 1236 // The window associated with this event is the window which had focus
1e6feb95 1237 // before for SET event and the window which will have focus for the KILL
8e72b8b5 1238 // one. NB: it may be NULL in both cases!
1e6feb95
VZ
1239 wxWindow *GetWindow() const { return m_win; }
1240 void SetWindow(wxWindow *win) { m_win = win; }
1241
8e72b8b5 1242 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
f97500b8 1243
1e6feb95
VZ
1244private:
1245 wxWindow *m_win;
1246
8e72b8b5 1247private:
fc7a2a60 1248 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
c801d85f
KB
1249};
1250
456bc6d9 1251// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1648d51b 1252// wxFocusEvent it is propagated upwards the window chain
bddd7a8d 1253class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
456bc6d9
VZ
1254{
1255public:
1256 wxChildFocusEvent(wxWindow *win = NULL);
1257
1258 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1259
8e72b8b5 1260 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
f97500b8 1261
8e72b8b5 1262private:
fc7a2a60 1263 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
456bc6d9
VZ
1264};
1265
c801d85f
KB
1266// Activate event class
1267/*
1268 wxEVT_ACTIVATE
1269 wxEVT_ACTIVATE_APP
afafd942 1270 wxEVT_HIBERNATE
c801d85f
KB
1271 */
1272
bddd7a8d 1273class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
c801d85f 1274{
2b854a32 1275public:
a0d9c6cb 1276 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
e6a6feba 1277 : wxEvent(Id, type)
497dbbd3 1278 { m_active = active; }
1d2eddff
JS
1279 wxActivateEvent(const wxActivateEvent& event)
1280 : wxEvent(event)
b2697d42 1281 { m_active = event.m_active; }
c2bbeff0 1282
2b854a32 1283 bool GetActive() const { return m_active; }
c801d85f 1284
8e72b8b5 1285 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
aadbdf11 1286
2b854a32
VZ
1287private:
1288 bool m_active;
8e72b8b5
RR
1289
1290private:
fc7a2a60 1291 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
c801d85f
KB
1292};
1293
1294// InitDialog event class
1295/*
1296 wxEVT_INIT_DIALOG
1297 */
1298
bddd7a8d 1299class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
c801d85f 1300{
2b854a32
VZ
1301public:
1302 wxInitDialogEvent(int Id = 0)
e6a6feba
GD
1303 : wxEvent(Id, wxEVT_INIT_DIALOG)
1304 { }
8e72b8b5
RR
1305
1306 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
f97500b8
VZ
1307
1308private:
fc7a2a60 1309 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
c801d85f
KB
1310};
1311
1312// Miscellaneous menu event class
1313/*
ccef86c7
VZ
1314 wxEVT_MENU_OPEN,
1315 wxEVT_MENU_CLOSE,
c801d85f 1316 wxEVT_MENU_HIGHLIGHT,
c801d85f
KB
1317*/
1318
bddd7a8d 1319class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
c801d85f 1320{
c801d85f 1321public:
92f1a59c 1322 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
d9e2e4c2 1323 : wxEvent(winid, type)
fc7a2a60 1324 { m_menuId = winid; m_menu = menu; }
1d2eddff
JS
1325 wxMenuEvent(const wxMenuEvent & event)
1326 : wxEvent(event)
92f1a59c 1327 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
c2bbeff0 1328
ccef86c7 1329 // only for wxEVT_MENU_HIGHLIGHT
aadbdf11 1330 int GetMenuId() const { return m_menuId; }
c801d85f 1331
ccef86c7 1332 // only for wxEVT_MENU_OPEN/CLOSE
1a18887b 1333 bool IsPopup() const { return m_menuId == wxID_ANY; }
ccef86c7 1334
92f1a59c
JS
1335 // only for wxEVT_MENU_OPEN/CLOSE
1336 wxMenu* GetMenu() const { return m_menu; }
1337
8e72b8b5 1338 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
f97500b8 1339
2b854a32 1340private:
92f1a59c
JS
1341 int m_menuId;
1342 wxMenu* m_menu;
f97500b8 1343
fc7a2a60 1344 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
c801d85f
KB
1345};
1346
1347// Window close or session close event class
1348/*
1349 wxEVT_CLOSE_WINDOW,
1350 wxEVT_END_SESSION,
1351 wxEVT_QUERY_END_SESSION
1352 */
1353
bddd7a8d 1354class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
c801d85f 1355{
c801d85f 1356public:
d9e2e4c2
DE
1357 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1358 : wxEvent(winid, type),
a0d9c6cb
WS
1359 m_loggingOff(true),
1360 m_veto(false), // should be false by default
1361 m_canVeto(true) {}
a3bf7524 1362
1d2eddff
JS
1363 wxCloseEvent(const wxCloseEvent & event)
1364 : wxEvent(event),
b2697d42
VZ
1365 m_loggingOff(event.m_loggingOff),
1366 m_veto(event.m_veto),
a3bf7524 1367 m_canVeto(event.m_canVeto) {}
c2bbeff0 1368
2b854a32 1369 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
4bcfcdef
VZ
1370 bool GetLoggingOff() const
1371 {
1372 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1373 // doesn't make sense for wxEVT_CLOSE_WINDOW
1374 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1375 _T("this flag is for end session events only") );
1376
1377 return m_loggingOff;
1378 }
2b854a32 1379
a0d9c6cb 1380 void Veto(bool veto = true)
fe4e9e6c 1381 {
a0d9c6cb 1382 // GetVeto() will return false anyhow...
fe4e9e6c 1383 wxCHECK_RET( m_canVeto,
223d09f6 1384 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
1385
1386 m_veto = veto;
1387 }
2b854a32
VZ
1388 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1389 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1390 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1391
8e72b8b5 1392 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
aadbdf11 1393
2b854a32 1394protected:
4bcfcdef
VZ
1395 bool m_loggingOff,
1396 m_veto,
1397 m_canVeto;
2b854a32 1398
8e72b8b5 1399private:
fc7a2a60 1400 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
c801d85f
KB
1401};
1402
1403/*
1404 wxEVT_SHOW
1405 */
1406
bddd7a8d 1407class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
c801d85f 1408{
c801d85f 1409public:
a0d9c6cb 1410 wxShowEvent(int winid = 0, bool show = false)
d9e2e4c2 1411 : wxEvent(winid, wxEVT_SHOW)
497dbbd3 1412 { m_show = show; }
1d2eddff
JS
1413 wxShowEvent(const wxShowEvent & event)
1414 : wxEvent(event)
b2697d42 1415 { m_show = event.m_show; }
c2bbeff0 1416
2b854a32
VZ
1417 void SetShow(bool show) { m_show = show; }
1418 bool GetShow() const { return m_show; }
c801d85f 1419
8e72b8b5 1420 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
aadbdf11 1421
c801d85f 1422protected:
2b854a32 1423 bool m_show;
3dd9b88a 1424
8e72b8b5 1425private:
fc7a2a60 1426 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
c801d85f
KB
1427};
1428
1429/*
1430 wxEVT_ICONIZE
1431 */
1432
bddd7a8d 1433class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
c801d85f 1434{
2b854a32 1435public:
a0d9c6cb 1436 wxIconizeEvent(int winid = 0, bool iconized = true)
d9e2e4c2 1437 : wxEvent(winid, wxEVT_ICONIZE)
497dbbd3 1438 { m_iconized = iconized; }
1d2eddff
JS
1439 wxIconizeEvent(const wxIconizeEvent & event)
1440 : wxEvent(event)
b2697d42 1441 { m_iconized = event.m_iconized; }
c2bbeff0 1442
3dd9b88a
VZ
1443 // return true if the frame was iconized, false if restored
1444 bool Iconized() const { return m_iconized; }
1445
8e72b8b5 1446 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
f97500b8 1447
3dd9b88a
VZ
1448protected:
1449 bool m_iconized;
1450
8e72b8b5 1451private:
fc7a2a60 1452 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
c801d85f 1453};
c801d85f
KB
1454/*
1455 wxEVT_MAXIMIZE
1456 */
1457
bddd7a8d 1458class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
c801d85f 1459{
2b854a32 1460public:
d9e2e4c2
DE
1461 wxMaximizeEvent(int winid = 0)
1462 : wxEvent(winid, wxEVT_MAXIMIZE)
e6a6feba 1463 { }
3dd9b88a 1464
8e72b8b5 1465 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
f97500b8 1466
8e72b8b5 1467private:
fc7a2a60 1468 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
c801d85f
KB
1469};
1470
1471// Joystick event class
1472/*
1473 wxEVT_JOY_BUTTON_DOWN,
1474 wxEVT_JOY_BUTTON_UP,
1475 wxEVT_JOY_MOVE,
1476 wxEVT_JOY_ZMOVE
1477*/
1478
1479// Which joystick? Same as Windows ids so no conversion necessary.
497dbbd3
VZ
1480enum
1481{
1482 wxJOYSTICK1,
1483 wxJOYSTICK2
1484};
c801d85f
KB
1485
1486// Which button is down?
497dbbd3
VZ
1487enum
1488{
1489 wxJOY_BUTTON_ANY = -1,
1490 wxJOY_BUTTON1 = 1,
1491 wxJOY_BUTTON2 = 2,
1492 wxJOY_BUTTON3 = 4,
1493 wxJOY_BUTTON4 = 8
1494};
c801d85f 1495
bddd7a8d 1496class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
c801d85f 1497{
b4b76d61 1498protected:
2b854a32
VZ
1499 wxPoint m_pos;
1500 int m_zPosition;
497dbbd3
VZ
1501 int m_buttonChange; // Which button changed?
1502 int m_buttonState; // Which buttons are down?
1503 int m_joyStick; // Which joystick?
2b854a32 1504
b4b76d61 1505public:
2b854a32
VZ
1506 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1507 int state = 0,
1508 int joystick = wxJOYSTICK1,
1509 int change = 0)
497dbbd3 1510 : wxEvent(0, type),
8b5d5223 1511 m_pos(),
497dbbd3
VZ
1512 m_zPosition(0),
1513 m_buttonChange(change),
1514 m_buttonState(state),
1515 m_joyStick(joystick)
2b854a32 1516 {
2b854a32 1517 }
1d2eddff 1518 wxJoystickEvent(const wxJoystickEvent & event)
b2697d42
VZ
1519 : wxEvent(event),
1520 m_pos(event.m_pos),
1521 m_zPosition(event.m_zPosition),
1522 m_buttonChange(event.m_buttonChange),
1523 m_buttonState(event.m_buttonState),
1524 m_joyStick(event.m_joyStick)
1d2eddff 1525 { }
c2bbeff0 1526
2b854a32
VZ
1527 wxPoint GetPosition() const { return m_pos; }
1528 int GetZPosition() const { return m_zPosition; }
1529 int GetButtonState() const { return m_buttonState; }
1530 int GetButtonChange() const { return m_buttonChange; }
1531 int GetJoystick() const { return m_joyStick; }
1532
1533 void SetJoystick(int stick) { m_joyStick = stick; }
1534 void SetButtonState(int state) { m_buttonState = state; }
1535 void SetButtonChange(int change) { m_buttonChange = change; }
1536 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1537 void SetZPosition(int zPos) { m_zPosition = zPos; }
1538
1539 // Was it a button event? (*doesn't* mean: is any button *down*?)
1540 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 1541 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ
1542
1543 // Was it a move event?
a7bc03c9 1544 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2b854a32
VZ
1545
1546 // Was it a zmove event?
a7bc03c9 1547 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2b854a32
VZ
1548
1549 // Was it a down event from button 1, 2, 3, 4 or any?
1550 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1551 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 1552 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1553
2b854a32
VZ
1554 // Was it a up event from button 1, 2, 3 or any?
1555 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 1556 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 1557 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1558
2b854a32
VZ
1559 // Was the given button 1,2,3,4 or any in Down state?
1560 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1561 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 1562 ((m_buttonState & but) == but)); }
f305c661 1563
8e72b8b5 1564 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
f97500b8 1565
8e72b8b5 1566private:
fc7a2a60 1567 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
c801d85f
KB
1568};
1569
1570// Drop files event class
1571/*
1572 wxEVT_DROP_FILES
1573 */
1574
bddd7a8d 1575class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
c801d85f 1576{
2b854a32
VZ
1577public:
1578 int m_noFiles;
1579 wxPoint m_pos;
c3c39620 1580 wxString* m_files;
2b854a32
VZ
1581
1582 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1583 int noFiles = 0,
1584 wxString *files = (wxString *) NULL)
497dbbd3
VZ
1585 : wxEvent(0, type),
1586 m_noFiles(noFiles),
1587 m_pos(),
1588 m_files(files)
e6a6feba 1589 { }
2b854a32 1590
c3c39620
VZ
1591 // we need a copy ctor to avoid deleting m_files pointer twice
1592 wxDropFilesEvent(const wxDropFilesEvent& other)
497dbbd3
VZ
1593 : wxEvent(other),
1594 m_noFiles(other.m_noFiles),
1595 m_pos(other.m_pos),
1596 m_files(NULL)
c3c39620 1597 {
c3c39620
VZ
1598 m_files = new wxString[m_noFiles];
1599 for ( int n = 0; n < m_noFiles; n++ )
1600 {
1601 m_files[n] = other.m_files[n];
1602 }
1603 }
1604
1605 virtual ~wxDropFilesEvent()
1606 {
1607 delete [] m_files;
1608 }
1609
2b854a32
VZ
1610 wxPoint GetPosition() const { return m_pos; }
1611 int GetNumberOfFiles() const { return m_noFiles; }
1612 wxString *GetFiles() const { return m_files; }
f305c661 1613
c3c39620 1614 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
f97500b8 1615
8e72b8b5 1616private:
fc7a2a60 1617 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
c801d85f
KB
1618};
1619
c801d85f
KB
1620// Update UI event
1621/*
1622 wxEVT_UPDATE_UI
1623 */
1624
e39af974
JS
1625// Whether to always send update events to windows, or
1626// to only send update events to those with the
1627// wxWS_EX_PROCESS_UI_UPDATES style.
1628
1629enum wxUpdateUIMode
1630{
1631 // Send UI update events to all windows
1632 wxUPDATE_UI_PROCESS_ALL,
1633
1634 // Send UI update events to windows that have
1635 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1636 wxUPDATE_UI_PROCESS_SPECIFIED
1637};
1638
bddd7a8d 1639class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
c801d85f 1640{
2b854a32
VZ
1641public:
1642 wxUpdateUIEvent(wxWindowID commandId = 0)
e6a6feba 1643 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
497dbbd3
VZ
1644 {
1645 m_checked =
1646 m_enabled =
a3a4105d 1647 m_shown =
497dbbd3 1648 m_setEnabled =
a3a4105d 1649 m_setShown =
9b9337da 1650 m_setText =
a0d9c6cb 1651 m_setChecked = false;
497dbbd3 1652 }
1d2eddff
JS
1653 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1654 : wxCommandEvent(event),
b2697d42
VZ
1655 m_checked(event.m_checked),
1656 m_enabled(event.m_enabled),
a3a4105d 1657 m_shown(event.m_shown),
b2697d42 1658 m_setEnabled(event.m_setEnabled),
a3a4105d 1659 m_setShown(event.m_setShown),
b2697d42
VZ
1660 m_setText(event.m_setText),
1661 m_setChecked(event.m_setChecked),
1662 m_text(event.m_text)
1663 { }
c2bbeff0 1664
2b854a32
VZ
1665 bool GetChecked() const { return m_checked; }
1666 bool GetEnabled() const { return m_enabled; }
a3a4105d 1667 bool GetShown() const { return m_shown; }
2b854a32
VZ
1668 wxString GetText() const { return m_text; }
1669 bool GetSetText() const { return m_setText; }
1670 bool GetSetChecked() const { return m_setChecked; }
1671 bool GetSetEnabled() const { return m_setEnabled; }
a3a4105d 1672 bool GetSetShown() const { return m_setShown; }
2b854a32 1673
a0d9c6cb
WS
1674 void Check(bool check) { m_checked = check; m_setChecked = true; }
1675 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
a3a4105d 1676 void Show(bool show) { m_shown = show; m_setShown = true; }
a0d9c6cb 1677 void SetText(const wxString& text) { m_text = text; m_setText = true; }
c801d85f 1678
0b30bb0b
JS
1679 // Sets the interval between updates in milliseconds.
1680 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
e39af974 1681 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
0b30bb0b
JS
1682
1683 // Returns the current interval between updates in milliseconds
a7bc03c9 1684 static long GetUpdateInterval() { return sm_updateInterval; }
0b30bb0b 1685
e39af974 1686 // Can we update this window?
a7bc03c9 1687 static bool CanUpdate(wxWindowBase *win);
0b30bb0b
JS
1688
1689 // Reset the update time to provide a delay until the next
1690 // time we should update
a7bc03c9 1691 static void ResetUpdateTime();
0b30bb0b 1692
77ffb593 1693 // Specify how wxWidgets will send update events: to
e39af974
JS
1694 // all windows, or only to those which specify that they
1695 // will process the events.
1696 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1697
1698 // Returns the UI update mode
a7bc03c9 1699 static wxUpdateUIMode GetMode() { return sm_updateMode; }
e39af974 1700
8e72b8b5 1701 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
f305c661 1702
2b854a32
VZ
1703protected:
1704 bool m_checked;
1705 bool m_enabled;
a3a4105d 1706 bool m_shown;
2b854a32 1707 bool m_setEnabled;
a3a4105d 1708 bool m_setShown;
2b854a32
VZ
1709 bool m_setText;
1710 bool m_setChecked;
1711 wxString m_text;
0b30bb0b 1712#if wxUSE_LONGLONG
e39af974 1713 static wxLongLong sm_lastUpdate;
0b30bb0b 1714#endif
e39af974
JS
1715 static long sm_updateInterval;
1716 static wxUpdateUIMode sm_updateMode;
f97500b8 1717
8e72b8b5 1718private:
fc7a2a60 1719 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
c801d85f
KB
1720};
1721
1722/*
1723 wxEVT_SYS_COLOUR_CHANGED
1724 */
1725
1726// TODO: shouldn't all events record the window ID?
bddd7a8d 1727class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
c801d85f 1728{
2b854a32
VZ
1729public:
1730 wxSysColourChangedEvent()
e6a6feba
GD
1731 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1732 { }
f97500b8 1733
8e72b8b5 1734 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
f97500b8 1735
8e72b8b5 1736private:
fc7a2a60 1737 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
c801d85f
KB
1738};
1739
a5e84126
JS
1740/*
1741 wxEVT_MOUSE_CAPTURE_CHANGED
1742 The window losing the capture receives this message
1743 (even if it released the capture itself).
1744 */
1745
bddd7a8d 1746class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
a5e84126
JS
1747{
1748public:
d9e2e4c2
DE
1749 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1750 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
497dbbd3 1751 m_gainedCapture(gainedCapture)
e6a6feba
GD
1752 { }
1753
1754 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
497dbbd3
VZ
1755 : wxEvent(event),
1756 m_gainedCapture(event.m_gainedCapture)
e6a6feba 1757 { }
a5e84126
JS
1758
1759 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1760
47b378bd 1761 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
a5e84126
JS
1762
1763private:
1764 wxWindow* m_gainedCapture;
fc7a2a60
VZ
1765
1766 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
a5e84126
JS
1767};
1768
63e819f2
VS
1769/*
1770 wxEVT_MOUSE_CAPTURE_LOST
1771 The window losing the capture receives this message, unless it released it
1772 it itself or unless wxWindow::CaptureMouse was called on another window
1773 (and so capture will be restored when the new capturer releases it).
1774 */
1775
1776class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1777{
1778public:
1779 wxMouseCaptureLostEvent(wxWindowID winid = 0)
1780 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1781 {}
1782
1783 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1784 : wxEvent(event)
1785 {}
1786
1787 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1788
1789 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1790};
1791
574c939e
KB
1792/*
1793 wxEVT_DISPLAY_CHANGED
1794 */
bddd7a8d 1795class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
574c939e
KB
1796{
1797private:
fc7a2a60 1798 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
574c939e
KB
1799
1800public:
1801 wxDisplayChangedEvent()
e6a6feba
GD
1802 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1803 { }
574c939e
KB
1804
1805 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1806};
1807
f7bd2698
JS
1808/*
1809 wxEVT_PALETTE_CHANGED
1810 */
1811
bddd7a8d 1812class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
f7bd2698 1813{
f7bd2698 1814public:
d9e2e4c2
DE
1815 wxPaletteChangedEvent(wxWindowID winid = 0)
1816 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
497dbbd3
VZ
1817 m_changedWindow((wxWindow *) NULL)
1818 { }
e6a6feba
GD
1819
1820 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
497dbbd3
VZ
1821 : wxEvent(event),
1822 m_changedWindow(event.m_changedWindow)
e6a6feba 1823 { }
f7bd2698 1824
2b854a32
VZ
1825 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1826 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 1827
8e72b8b5 1828 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
f305c661 1829
f7bd2698 1830protected:
2b854a32 1831 wxWindow* m_changedWindow;
8e72b8b5
RR
1832
1833private:
fc7a2a60 1834 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
f7bd2698
JS
1835};
1836
1837/*
1838 wxEVT_QUERY_NEW_PALETTE
1839 Indicates the window is getting keyboard focus and should re-do its palette.
1840 */
1841
bddd7a8d 1842class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1843{
f7bd2698 1844public:
d9e2e4c2
DE
1845 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1846 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
a0d9c6cb 1847 m_paletteRealized(false)
e6a6feba 1848 { }
1d2eddff
JS
1849 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1850 : wxEvent(event),
b2697d42
VZ
1851 m_paletteRealized(event.m_paletteRealized)
1852 { }
c2bbeff0 1853
2b854a32
VZ
1854 // App sets this if it changes the palette.
1855 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1856 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 1857
8e72b8b5 1858 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
f305c661 1859
f7bd2698 1860protected:
2b854a32 1861 bool m_paletteRealized;
f97500b8 1862
8e72b8b5 1863private:
fc7a2a60 1864 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
f7bd2698
JS
1865};
1866
7fdefd57
VZ
1867/*
1868 Event generated by dialog navigation keys
1869 wxEVT_NAVIGATION_KEY
1870 */
d9506e77 1871// NB: don't derive from command event to avoid being propagated to the parent
bddd7a8d 1872class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
7fdefd57 1873{
7fdefd57 1874public:
d9506e77 1875 wxNavigationKeyEvent()
497dbbd3 1876 : wxEvent(0, wxEVT_NAVIGATION_KEY),
298ca00c 1877 m_flags(IsForward | FromTab), // defaults are for TAB
497dbbd3 1878 m_focus((wxWindow *)NULL)
aef35d0e
VZ
1879 {
1880 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1881 }
d9506e77 1882
e6a6feba 1883 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
497dbbd3
VZ
1884 : wxEvent(event),
1885 m_flags(event.m_flags),
1886 m_focus(event.m_focus)
e6a6feba 1887 { }
7fdefd57 1888
2b854a32 1889 // direction: forward (true) or backward (false)
d9506e77
VZ
1890 bool GetDirection() const
1891 { return (m_flags & IsForward) != 0; }
1892 void SetDirection(bool bForward)
1893 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 1894
2b854a32
VZ
1895 // it may be a window change event (MDI, notebook pages...) or a control
1896 // change event
d9506e77
VZ
1897 bool IsWindowChange() const
1898 { return (m_flags & WinChange) != 0; }
1899 void SetWindowChange(bool bIs)
1900 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1901
298ca00c
VZ
1902 // Set to true under MSW if the event was generated using the tab key.
1903 // This is required for proper navogation over radio buttons
1904 bool IsFromTab() const
1905 { return (m_flags & FromTab) != 0; }
1906 void SetFromTab(bool bIs)
1907 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1908
2b854a32
VZ
1909 // the child which has the focus currently (may be NULL - use
1910 // wxWindow::FindFocus then)
d9506e77
VZ
1911 wxWindow* GetCurrentFocus() const { return m_focus; }
1912 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1913
54a69edf
JS
1914 // Set flags
1915 void SetFlags(long flags) { m_flags = flags; }
1916
8e72b8b5
RR
1917 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1918
d9506e77
VZ
1919 enum
1920 {
f2de9fee 1921 IsBackward = 0x0000,
d9506e77 1922 IsForward = 0x0001,
298ca00c
VZ
1923 WinChange = 0x0002,
1924 FromTab = 0x0004
d9506e77
VZ
1925 };
1926
1927 long m_flags;
1928 wxWindow *m_focus;
1929
8e72b8b5 1930private:
fc7a2a60 1931 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
7fdefd57
VZ
1932};
1933
42e69d6b
VZ
1934// Window creation/destruction events: the first is sent as soon as window is
1935// created (i.e. the underlying GUI object exists), but when the C++ object is
1936// fully initialized (so virtual functions may be called). The second,
1937// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1938// still safe to call virtual functions at this moment
1939/*
1940 wxEVT_CREATE
1941 wxEVT_DESTROY
1942 */
1943
bddd7a8d 1944class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
42e69d6b 1945{
42e69d6b
VZ
1946public:
1947 wxWindowCreateEvent(wxWindow *win = NULL);
1948
1949 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1950
8e72b8b5 1951 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
f97500b8 1952
8e72b8b5 1953private:
fc7a2a60 1954 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
42e69d6b
VZ
1955};
1956
bddd7a8d 1957class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
42e69d6b 1958{
42e69d6b
VZ
1959public:
1960 wxWindowDestroyEvent(wxWindow *win = NULL);
1961
1962 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1963
8e72b8b5
RR
1964 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1965
1966private:
fc7a2a60 1967 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
42e69d6b
VZ
1968};
1969
bd83cb56 1970// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 1971/*
bd83cb56
VZ
1972 wxEVT_HELP
1973 wxEVT_DETAILED_HELP
1974*/
b96340e6 1975
bddd7a8d 1976class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
b96340e6 1977{
b96340e6 1978public:
b107e8d5
VZ
1979 // how was this help event generated?
1980 enum Origin
1981 {
1982 Origin_Unknown, // unrecognized event source
1983 Origin_Keyboard, // event generated from F1 key press
1984 Origin_HelpButton // event from [?] button on the title bar (Windows)
1985 };
1986
bd83cb56 1987 wxHelpEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 1988 wxWindowID winid = 0,
b107e8d5
VZ
1989 const wxPoint& pt = wxDefaultPosition,
1990 Origin origin = Origin_Unknown)
d9e2e4c2 1991 : wxCommandEvent(type, winid),
b107e8d5
VZ
1992 m_pos(pt),
1993 m_origin(GuessOrigin(origin))
e6a6feba 1994 { }
1d2eddff
JS
1995 wxHelpEvent(const wxHelpEvent & event)
1996 : wxCommandEvent(event),
b2697d42
VZ
1997 m_pos(event.m_pos),
1998 m_target(event.m_target),
b107e8d5
VZ
1999 m_link(event.m_link),
2000 m_origin(event.m_origin)
1d2eddff 2001 { }
c2bbeff0 2002
bd83cb56
VZ
2003 // Position of event (in screen coordinates)
2004 const wxPoint& GetPosition() const { return m_pos; }
2005 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 2006
bd83cb56
VZ
2007 // Optional link to further help
2008 const wxString& GetLink() const { return m_link; }
2009 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 2010
bd83cb56
VZ
2011 // Optional target to display help in. E.g. a window specification
2012 const wxString& GetTarget() const { return m_target; }
2013 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 2014
8e72b8b5 2015 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
f97500b8 2016
b107e8d5
VZ
2017 // optional indication of the event source
2018 Origin GetOrigin() const { return m_origin; }
2019 void SetOrigin(Origin origin) { m_origin = origin; }
2020
bd83cb56
VZ
2021protected:
2022 wxPoint m_pos;
2023 wxString m_target;
2024 wxString m_link;
b107e8d5
VZ
2025 Origin m_origin;
2026
2027 // we can try to guess the event origin ourselves, even if none is
2028 // specified in the ctor
2029 static Origin GuessOrigin(Origin origin);
bd83cb56
VZ
2030
2031private:
fc7a2a60 2032 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
b96340e6
JS
2033};
2034
78c91815
VZ
2035// A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2036// message, i.e. the user has cut/copied/pasted data from/into a text control
2037// via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2038// NOTE : under windows these events are *NOT* generated automatically
2039// for a Rich Edit text control.
2040/*
2041wxEVT_COMMAND_TEXT_COPY
2042wxEVT_COMMAND_TEXT_CUT
2043wxEVT_COMMAND_TEXT_PASTE
2044*/
2045
2046class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2047{
2048public:
2049 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2050 wxWindowID winid = 0)
2051 : wxCommandEvent(type, winid)
2052 { }
2053 wxClipboardTextEvent(const wxClipboardTextEvent & event)
2054 : wxCommandEvent(event)
2055 { }
2056
2057 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2058
2059private:
2060 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2061};
2062
69231000
JS
2063// A Context event is sent when the user right clicks on a window or
2064// presses Shift-F10
2065// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2066// Under other systems it may have to be generated from a right click event
2067/*
2068 wxEVT_CONTEXT_MENU
2069*/
2070
bddd7a8d 2071class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
69231000
JS
2072{
2073public:
2074 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 2075 wxWindowID winid = 0,
e6a6feba 2076 const wxPoint& pt = wxDefaultPosition)
d9e2e4c2 2077 : wxCommandEvent(type, winid),
497dbbd3 2078 m_pos(pt)
e6a6feba 2079 { }
1d2eddff
JS
2080 wxContextMenuEvent(const wxContextMenuEvent & event)
2081 : wxCommandEvent(event),
b2697d42 2082 m_pos(event.m_pos)
1d2eddff 2083 { }
c2bbeff0 2084
69231000
JS
2085 // Position of event (in screen coordinates)
2086 const wxPoint& GetPosition() const { return m_pos; }
2087 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2088
8e72b8b5 2089 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
f97500b8 2090
69231000
JS
2091protected:
2092 wxPoint m_pos;
2093
2094private:
fc7a2a60 2095 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
69231000
JS
2096};
2097
b46b1d59
VZ
2098#endif // wxUSE_GUI
2099
e90c1d2a
VZ
2100// Idle event
2101/*
2102 wxEVT_IDLE
2103 */
2104
e39af974
JS
2105// Whether to always send idle events to windows, or
2106// to only send update events to those with the
2107// wxWS_EX_PROCESS_IDLE style.
2108
2109enum wxIdleMode
2110{
2111 // Send idle events to all windows
2112 wxIDLE_PROCESS_ALL,
2113
2114 // Send idle events to windows that have
2115 // the wxWS_EX_PROCESS_IDLE flag specified
2116 wxIDLE_PROCESS_SPECIFIED
2117};
2118
b46b1d59 2119class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
e90c1d2a 2120{
e90c1d2a
VZ
2121public:
2122 wxIdleEvent()
497dbbd3 2123 : wxEvent(0, wxEVT_IDLE),
a0d9c6cb 2124 m_requestMore(false)
e6a6feba 2125 { }
1d2eddff
JS
2126 wxIdleEvent(const wxIdleEvent & event)
2127 : wxEvent(event),
b2697d42
VZ
2128 m_requestMore(event.m_requestMore)
2129 { }
c2bbeff0 2130
a0d9c6cb 2131 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
e90c1d2a
VZ
2132 bool MoreRequested() const { return m_requestMore; }
2133
8e72b8b5 2134 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
e90c1d2a 2135
77ffb593 2136 // Specify how wxWidgets will send idle events: to
e39af974
JS
2137 // all windows, or only to those which specify that they
2138 // will process the events.
2139 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2140
2141 // Returns the idle event mode
a7bc03c9 2142 static wxIdleMode GetMode() { return sm_idleMode; }
e39af974 2143
e90c1d2a
VZ
2144protected:
2145 bool m_requestMore;
e39af974 2146 static wxIdleMode sm_idleMode;
f97500b8 2147
8e72b8b5 2148private:
fc7a2a60 2149 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
e90c1d2a
VZ
2150};
2151
e5fb7191 2152/* TODO
c801d85f
KB
2153 wxEVT_MOUSE_CAPTURE_CHANGED,
2154 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
2155// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2156 // wxEVT_FONT_CHANGED to all other windows (maybe).
2157 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2158 wxEVT_MEASURE_ITEM,
2159 wxEVT_COMPARE_ITEM
2160*/
2161
88a9f974 2162
8e193f38
VZ
2163// ============================================================================
2164// event handler and related classes
2165// ============================================================================
2166
d5d51013
VZ
2167// for backwards compatibility and to prevent eVC 4 for ARM from crashing with
2168// internal compiler error when compiling wx, we define wxObjectEventFunction
2169// as a wxObject method even though it can only be a wxEvtHandler one
2170typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
c801d85f 2171
2e4df4bf
VZ
2172// we can't have ctors nor base struct in backwards compatibility mode or
2173// otherwise we won't be able to initialize the objects with an agregate, so
2174// we have to keep both versions
2175#if WXWIN_COMPATIBILITY_EVENT_TYPES
2176
bddd7a8d 2177struct WXDLLIMPEXP_BASE wxEventTableEntry
2e4df4bf
VZ
2178{
2179 // For some reason, this can't be wxEventType, or VC++ complains.
2180 int m_eventType; // main event type
2181 int m_id; // control/menu/toolbar id
2182 int m_lastId; // used for ranges of ids
2183 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2184 // because of dependency problems
2185
2186 wxObject* m_callbackUserData;
2187};
2188
2189#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2190
6164f93c
VZ
2191// struct containing the members common to static and dynamic event tables
2192// entries
bddd7a8d 2193struct WXDLLIMPEXP_BASE wxEventTableEntryBase
77d4384e 2194{
e6a6feba
GD
2195private:
2196 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
abcbaea7 2197
e6a6feba 2198public:
d9e2e4c2 2199 wxEventTableEntryBase(int winid, int idLast,
6164f93c 2200 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2201 : m_id(winid),
497dbbd3
VZ
2202 m_lastId(idLast),
2203 m_fn(fn),
2204 m_callbackUserData(data)
e6a6feba
GD
2205 { }
2206
2207 wxEventTableEntryBase(const wxEventTableEntryBase& event)
497dbbd3
VZ
2208 : m_id(event.m_id),
2209 m_lastId(event.m_lastId),
2210 m_fn(event.m_fn),
2211 m_callbackUserData(event.m_callbackUserData)
abcbaea7 2212 { }
6164f93c 2213
497dbbd3
VZ
2214 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2215 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2216 int m_id,
2217 m_lastId;
82a5f02c 2218
6164f93c
VZ
2219 // function to call: not wxEventFunction, because of dependency problems
2220 wxObjectEventFunction m_fn;
77d4384e 2221
6164f93c 2222 // arbitrary user data asosciated with the callback
77d4384e
RR
2223 wxObject* m_callbackUserData;
2224};
2225
6164f93c 2226// an entry from a static event table
bddd7a8d 2227struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
c801d85f 2228{
d9e2e4c2 2229 wxEventTableEntry(const int& evType, int winid, int idLast,
6164f93c 2230 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2231 : wxEventTableEntryBase(winid, idLast, fn, data),
e6a6feba
GD
2232 m_eventType(evType)
2233 { }
6164f93c
VZ
2234
2235 // the reference to event type: this allows us to not care about the
2236 // (undefined) order in which the event table entries and the event types
2237 // are initialized: initially the value of this reference might be
2238 // invalid, but by the time it is used for the first time, all global
2239 // objects will have been initialized (including the event type constants)
2240 // and so it will have the correct value when it is needed
2241 const int& m_eventType;
fc7a2a60
VZ
2242
2243private:
2244 wxEventTableEntry& operator=(const wxEventTableEntry&);
6164f93c
VZ
2245};
2246
2247// an entry used in dynamic event table managed by wxEvtHandler::Connect()
bddd7a8d 2248struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
6164f93c 2249{
d9e2e4c2 2250 wxDynamicEventTableEntry(int evType, int winid, int idLast,
65b17727 2251 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
d9e2e4c2 2252 : wxEventTableEntryBase(winid, idLast, fn, data),
65b17727
JS
2253 m_eventType(evType),
2254 m_eventSink(eventSink)
e6a6feba 2255 { }
6164f93c
VZ
2256
2257 // not a reference here as we can't keep a reference to a temporary int
2258 // created to wrap the constant value typically passed to Connect() - nor
2259 // do we need it
2260 int m_eventType;
65b17727
JS
2261
2262 // Pointer to object whose function is fn - so we don't assume the
1c624631 2263 // EventFunction is always a member of the EventHandler receiving the
65b17727
JS
2264 // message
2265 wxEvtHandler* m_eventSink;
fc7a2a60
VZ
2266
2267 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
c801d85f
KB
2268};
2269
2e4df4bf
VZ
2270#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2271
2272// ----------------------------------------------------------------------------
2273// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2274// ----------------------------------------------------------------------------
886dd7d2 2275
bddd7a8d 2276struct WXDLLIMPEXP_BASE wxEventTable
c801d85f 2277{
0b5eceb6
VZ
2278 const wxEventTable *baseTable; // base event table (next in chain)
2279 const wxEventTableEntry *entries; // bottom of entry array
c801d85f
KB
2280};
2281
b5a98acd
VZ
2282// ----------------------------------------------------------------------------
2283// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2284// ----------------------------------------------------------------------------
2285
d5d29b8a 2286WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
b5a98acd
VZ
2287
2288class WXDLLIMPEXP_BASE wxEventHashTable
2289{
2290private:
2291 // Internal data structs
2292 struct EventTypeTable
2293 {
2294 wxEventType eventType;
2295 wxEventTableEntryPointerArray eventEntryTable;
2296 };
2297 typedef EventTypeTable* EventTypeTablePointer;
2298
2299public:
2300 // Constructor, needs the event table it needs to hash later on.
1c624631
VZ
2301 // Note: hashing of the event table is not done in the constructor as it
2302 // can be that the event table is not yet full initialize, the hash
b5a98acd
VZ
2303 // will gets initialized when handling the first event look-up request.
2304 wxEventHashTable(const wxEventTable &table);
2305 // Destructor.
2306 ~wxEventHashTable();
2307
1c624631 2308 // Handle the given event, in other words search the event table hash
b5a98acd
VZ
2309 // and call self->ProcessEvent() if a match was found.
2310 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2311
afa039f9
JS
2312 // Clear table
2313 void Clear();
2314
aa767a45 2315#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
afa039f9
JS
2316 // Clear all tables
2317 static void ClearAll();
a0826b11 2318#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
afa039f9 2319
b5a98acd
VZ
2320protected:
2321 // Init the hash table with the entries of the static event table.
2322 void InitHashTable();
2323 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2324 void AddEntry(const wxEventTableEntry &entry);
2325 // Allocate and init with null pointers the base hash table.
2326 void AllocEventTypeTable(size_t size);
1c624631 2327 // Grow the hash table in size and transfer all items currently
b5a98acd
VZ
2328 // in the table to the correct location in the new table.
2329 void GrowEventTypeTable();
2330
2331protected:
2332 const wxEventTable &m_table;
2333 bool m_rebuildHash;
2334
2335 size_t m_size;
2336 EventTypeTablePointer *m_eventTypeTable;
fc7a2a60 2337
afa039f9
JS
2338 static wxEventHashTable* sm_first;
2339 wxEventHashTable* m_previous;
2340 wxEventHashTable* m_next;
2341
fc7a2a60 2342 DECLARE_NO_COPY_CLASS(wxEventHashTable)
b5a98acd
VZ
2343};
2344
6164f93c 2345// ----------------------------------------------------------------------------
77ffb593 2346// wxEvtHandler: the base class for all objects handling wxWidgets events
6164f93c
VZ
2347// ----------------------------------------------------------------------------
2348
bddd7a8d 2349class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
c801d85f 2350{
2b854a32
VZ
2351public:
2352 wxEvtHandler();
6164f93c 2353 virtual ~wxEvtHandler();
2b854a32
VZ
2354
2355 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2356 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2357 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2358 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2359
8e193f38 2360 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ
2361 bool GetEvtHandlerEnabled() const { return m_enabled; }
2362
8e193f38
VZ
2363 // process an event right now
2364 virtual bool ProcessEvent(wxEvent& event);
2b854a32 2365
8e193f38 2366 // add an event to be processed later
76bfdc9a 2367 virtual void AddPendingEvent(const wxEvent& event);
2b854a32 2368
8e193f38 2369 void ProcessPendingEvents();
2b854a32 2370
7214297d 2371#if wxUSE_THREADS
76bfdc9a 2372 bool ProcessThreadEvent(const wxEvent& event);
7214297d 2373#endif
2b854a32
VZ
2374
2375 // Dynamic association of a member function handler with the event handler,
d9e2e4c2 2376 // winid and event type
7fa03f04
VZ
2377 void Connect(int winid,
2378 int lastId,
2379 int eventType,
2380 wxObjectEventFunction func,
2381 wxObject *userData = (wxObject *) NULL,
2382 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2b854a32
VZ
2383
2384 // Convenience function: take just one id
7fa03f04
VZ
2385 void Connect(int winid,
2386 int eventType,
2387 wxObjectEventFunction func,
2388 wxObject *userData = (wxObject *) NULL,
2389 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2390 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2b854a32 2391
7fa03f04
VZ
2392 // Even more convenient: without id (same as using id of wxID_ANY)
2393 void Connect(int eventType,
2394 wxObjectEventFunction func,
2395 wxObject *userData = (wxObject *) NULL,
2396 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2397 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2398
2399 bool Disconnect(int winid,
2400 int lastId,
2401 wxEventType eventType,
2402 wxObjectEventFunction func = NULL,
2403 wxObject *userData = (wxObject *) NULL,
2404 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2405
e554d626 2406 bool Disconnect(int winid = wxID_ANY,
7fa03f04
VZ
2407 wxEventType eventType = wxEVT_NULL,
2408 wxObjectEventFunction func = NULL,
2409 wxObject *userData = (wxObject *) NULL,
2410 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2411 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
98243fed 2412
bdbe28fa 2413 bool Disconnect(wxEventType eventType,
e0685bb0 2414 wxObjectEventFunction func,
bdbe28fa
VZ
2415 wxObject *userData = (wxObject *) NULL,
2416 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2417 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
7fa03f04 2418
10da6a8f 2419 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
b88c44e7
RD
2420
2421 // User data can be associated with each wxEvtHandler
2422 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2423 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2424
2425 void SetClientData( void *data ) { DoSetClientData(data); }
2426 void *GetClientData() const { return DoGetClientData(); }
2427
1c624631
VZ
2428 // check if the given event table entry matches this event and call the
2429 // handler if it does
2430 //
2431 // return true if the event was processed, false otherwise (no match or the
2432 // handler decided to skip the event)
2433 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2434 wxEvtHandler *handler,
2435 wxEvent& event);
b88c44e7 2436
8e193f38
VZ
2437 // implementation from now on
2438 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2b854a32 2439 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 2440
63863e09 2441#if wxUSE_THREADS
1c624631
VZ
2442 void ClearEventLocker();
2443#endif // wxUSE_THREADS
63863e09 2444
afa039f9
JS
2445 // Avoid problems at exit by cleaning up static hash table gracefully
2446 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2447
c801d85f 2448private:
8e193f38 2449 static const wxEventTableEntry sm_eventTableEntries[];
2b854a32 2450
c801d85f 2451protected:
4caf847c
VZ
2452 // hooks for wxWindow used by ProcessEvent()
2453 // -----------------------------------------
2454
6eabf58c
VS
2455 // This one is called before trying our own event table to allow plugging
2456 // in the validators.
1c624631 2457 //
6eabf58c
VS
2458 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2459 // It is part of wxBase which doesn't use validators and the code
2460 // is compiled out when building wxBase w/o GUI classes, which affects
3103e8a9 2461 // binary compatibility and wxBase library can't be used by GUI
6eabf58c 2462 // ports.
4caf847c 2463 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
4caf847c
VZ
2464
2465 // this one is called after failing to find the event handle in our own
2466 // table to give a chance to the other windows to process it
2467 //
2468 // base class implementation passes the event to wxTheApp
2469 virtual bool TryParent(wxEvent& event);
2470
2471
1c624631 2472 static const wxEventTable sm_eventTable;
193bf013
VZ
2473 virtual const wxEventTable *GetEventTable() const;
2474
b5a98acd
VZ
2475 static wxEventHashTable sm_eventHashTable;
2476 virtual wxEventHashTable& GetEventHashTable() const;
2477
63863e09
JS
2478 wxEvtHandler* m_nextHandler;
2479 wxEvtHandler* m_previousHandler;
63863e09 2480 wxList* m_dynamicEvents;
42e69d6b 2481 wxList* m_pendingEvents;
6164f93c 2482
7214297d 2483#if wxUSE_THREADS
20947e08 2484#if defined (__VISAGECPP__)
cd30330f
VZ
2485 const wxCriticalSection& Lock() const { return m_eventsLocker; }
2486 wxCriticalSection& Lock() { return m_eventsLocker; }
2487
20947e08
DW
2488 wxCriticalSection m_eventsLocker;
2489# else
cd30330f
VZ
2490 const wxCriticalSection& Lock() const { return *m_eventsLocker; }
2491 wxCriticalSection& Lock() { return *m_eventsLocker; }
2492
63863e09 2493 wxCriticalSection* m_eventsLocker;
20947e08 2494# endif
7214297d 2495#endif
193bf013 2496
8e193f38
VZ
2497 // Is event handler enabled?
2498 bool m_enabled;
6164f93c 2499
b88c44e7
RD
2500
2501 // The user data: either an object which will be deleted by the container
2502 // when it's deleted or some raw pointer which we do nothing with - only
2503 // one type of data can be used with the given window (i.e. you cannot set
2504 // the void data and then associate the container with wxClientData or vice
2505 // versa)
2506 union
2507 {
2508 wxClientData *m_clientObject;
2509 void *m_clientData;
2510 };
2511
2512 // what kind of data do we have?
2513 wxClientDataType m_clientDataType;
2514
2515 // client data accessors
2516 virtual void DoSetClientObject( wxClientData *data );
2517 virtual wxClientData *DoGetClientObject() const;
2518
2519 virtual void DoSetClientData( void *data );
2520 virtual void *DoGetClientData() const;
2521
6164f93c 2522private:
fc7a2a60 2523 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
c801d85f
KB
2524};
2525
e2478fde
VZ
2526// Post a message to the given eventhandler which will be processed during the
2527// next event loop iteration
76bfdc9a 2528inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
e2478fde
VZ
2529{
2530 wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2531
2532 dest->AddPendingEvent(event);
2533}
2534
96d38c7e
VS
2535typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2536
7fa03f04
VZ
2537#define wxEventHandler(func) \
2538 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2539
e90c1d2a 2540#if wxUSE_GUI
7fa03f04 2541
c4fa5aa7
VZ
2542// ----------------------------------------------------------------------------
2543// wxEventBlocker: helper class to temporarily disable event handling for a window
2544// ----------------------------------------------------------------------------
2545
b483f5fe 2546class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
c4fa5aa7
VZ
2547{
2548public:
2549 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2550 virtual ~wxEventBlocker();
2551
2552 void Block(wxEventType type)
2553 {
2554 m_eventsToBlock.push_back(type);
2555 }
2556
2557 virtual bool ProcessEvent(wxEvent& event);
2558
2559protected:
2560 wxArrayInt m_eventsToBlock;
2561 wxWindow *m_window;
2562
2563 DECLARE_NO_COPY_CLASS(wxEventBlocker)
2564};
2565
c801d85f
KB
2566typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2567typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
c5b42c87 2568typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
c801d85f
KB
2569typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2570typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2571typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
7309deea 2572typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
c801d85f
KB
2573typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2574typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2575typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2576typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
456bc6d9 2577typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
c801d85f
KB
2578typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2579typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2580typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2581typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2582typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
7fa03f04
VZ
2583typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2584typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
c801d85f
KB
2585typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2586typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2587typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2588typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
9bc13858 2589typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
98e78a5e 2590typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
81d66cf3 2591typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS
2592typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2593typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
43b5058d
VZ
2594typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2595typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2596typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
669f7a11 2597typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
b96340e6 2598typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
69231000 2599typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
a5e84126 2600typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
63e819f2 2601typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
78c91815 2602typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
7fa03f04 2603
7fa03f04
VZ
2604
2605#define wxCommandEventHandler(func) \
8bc3ec1f 2606 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
7fa03f04 2607#define wxScrollEventHandler(func) \
8bc3ec1f 2608 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
7fa03f04 2609#define wxScrollWinEventHandler(func) \
8bc3ec1f 2610 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
7fa03f04 2611#define wxSizeEventHandler(func) \
8bc3ec1f 2612 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
7fa03f04 2613#define wxMoveEventHandler(func) \
8bc3ec1f 2614 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
7fa03f04 2615#define wxPaintEventHandler(func) \
8bc3ec1f 2616 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
7fa03f04 2617#define wxNcPaintEventHandler(func) \
8bc3ec1f 2618 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
7fa03f04 2619#define wxEraseEventHandler(func) \
8bc3ec1f 2620 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
7fa03f04 2621#define wxMouseEventHandler(func) \
8bc3ec1f 2622 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
7fa03f04 2623#define wxCharEventHandler(func) \
8bc3ec1f 2624 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
7fa03f04
VZ
2625#define wxKeyEventHandler(func) wxCharEventHandler(func)
2626#define wxFocusEventHandler(func) \
8bc3ec1f 2627 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
7fa03f04 2628#define wxChildFocusEventHandler(func) \
8bc3ec1f 2629 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
7fa03f04 2630#define wxActivateEventHandler(func) \
8bc3ec1f 2631 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
7fa03f04 2632#define wxMenuEventHandler(func) \
8bc3ec1f 2633 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
7fa03f04 2634#define wxJoystickEventHandler(func) \
8bc3ec1f 2635 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
7fa03f04 2636#define wxDropFilesEventHandler(func) \
8bc3ec1f 2637 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
7fa03f04 2638#define wxInitDialogEventHandler(func) \
8bc3ec1f 2639 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
7fa03f04 2640#define wxSysColourChangedEventHandler(func) \
8bc3ec1f 2641 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
7fa03f04 2642#define wxDisplayChangedEventHandler(func) \
8bc3ec1f 2643 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
7fa03f04 2644#define wxUpdateUIEventHandler(func) \
8bc3ec1f 2645 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
7fa03f04 2646#define wxIdleEventHandler(func) \
8bc3ec1f 2647 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
7fa03f04 2648#define wxCloseEventHandler(func) \
8bc3ec1f 2649 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
7fa03f04 2650#define wxShowEventHandler(func) \
8bc3ec1f 2651 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
7fa03f04 2652#define wxIconizeEventHandler(func) \
8bc3ec1f 2653 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
7fa03f04 2654#define wxMaximizeEventHandler(func) \
8bc3ec1f 2655 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
7fa03f04 2656#define wxNavigationKeyEventHandler(func) \
8bc3ec1f 2657 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
7fa03f04 2658#define wxPaletteChangedEventHandler(func) \
8bc3ec1f 2659 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
7fa03f04 2660#define wxQueryNewPaletteEventHandler(func) \
8bc3ec1f 2661 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
7fa03f04 2662#define wxWindowCreateEventHandler(func) \
8bc3ec1f 2663 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
7fa03f04 2664#define wxWindowDestroyEventHandler(func) \
8bc3ec1f 2665 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
7fa03f04 2666#define wxSetCursorEventHandler(func) \
8bc3ec1f 2667 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
7fa03f04 2668#define wxNotifyEventHandler(func) \
8bc3ec1f 2669 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
7fa03f04 2670#define wxHelpEventHandler(func) \
8bc3ec1f 2671 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
7fa03f04 2672#define wxContextMenuEventHandler(func) \
8bc3ec1f 2673 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
7fa03f04 2674#define wxMouseCaptureChangedEventHandler(func) \
8bc3ec1f 2675 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
63e819f2
VS
2676#define wxMouseCaptureLostEventHandler(func) \
2677 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
78c91815
VZ
2678#define wxClipboardTextEventHandler(func) \
2679 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
7fa03f04 2680
e90c1d2a 2681#endif // wxUSE_GUI
c801d85f
KB
2682
2683// N.B. In GNU-WIN32, you *have* to take the address of a member function
2684// (use &) or the compiler crashes...
2685
2686#define DECLARE_EVENT_TABLE() \
2e4df4bf
VZ
2687 private: \
2688 static const wxEventTableEntry sm_eventTableEntries[]; \
2689 protected: \
2690 static const wxEventTable sm_eventTable; \
b5a98acd
VZ
2691 virtual const wxEventTable* GetEventTable() const; \
2692 static wxEventHashTable sm_eventHashTable; \
2693 virtual wxEventHashTable& GetEventHashTable() const;
c801d85f 2694
48276300
VZ
2695// N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2696// sm_eventTable before using it in GetEventTable() or the compiler gives
2697// E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
b5a98acd 2698
c801d85f 2699#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2e4df4bf
VZ
2700 const wxEventTable theClass::sm_eventTable = \
2701 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
48276300
VZ
2702 const wxEventTable *theClass::GetEventTable() const \
2703 { return &theClass::sm_eventTable; } \
b5a98acd
VZ
2704 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2705 wxEventHashTable &theClass::GetEventHashTable() const \
2706 { return theClass::sm_eventHashTable; } \
2e4df4bf 2707 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
c801d85f 2708
f96a9d34
JS
2709#define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2710 template<typename T1> \
2711 const wxEventTable theClass<T1>::sm_eventTable = \
2712 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2713 template<typename T1> \
2714 const wxEventTable *theClass<T1>::GetEventTable() const \
2715 { return &theClass<T1>::sm_eventTable; } \
2716 template<typename T1> \
2717 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2718 template<typename T1> \
2719 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2720 { return theClass<T1>::sm_eventHashTable; } \
2721 template<typename T1> \
2722 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2723
2724#define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2725 template<typename T1, typename T2> \
2726 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2727 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2728 template<typename T1, typename T2> \
2729 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2730 { return &theClass<T1, T2>::sm_eventTable; } \
2731 template<typename T1, typename T2> \
2732 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2733 template<typename T1, typename T2> \
2734 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2735 { return theClass<T1, T2>::sm_eventHashTable; } \
2736 template<typename T1, typename T2> \
2737 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2738
2739#define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2740 template<typename T1, typename T2, typename T3> \
2741 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2742 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2743 template<typename T1, typename T2, typename T3> \
2744 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2745 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2746 template<typename T1, typename T2, typename T3> \
2747 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2748 template<typename T1, typename T2, typename T3> \
2749 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2750 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2751 template<typename T1, typename T2, typename T3> \
2752 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2753
2754#define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2755 template<typename T1, typename T2, typename T3, typename T4> \
2756 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2757 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2758 template<typename T1, typename T2, typename T3, typename T4> \
2759 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2760 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2761 template<typename T1, typename T2, typename T3, typename T4> \
2762 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2763 template<typename T1, typename T2, typename T3, typename T4> \
2764 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2765 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2766 template<typename T1, typename T2, typename T3, typename T4> \
2767 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2768
2769#define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2770 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2771 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2772 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2773 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2774 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2775 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2776 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2777 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2778 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2779 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2780 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2781 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2782 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2783
2784#define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2785 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2786 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2787 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2788 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2789 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2790 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2791 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2792 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2793 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2794 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2795 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2796 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2797 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2798
2799#define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2800 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2801 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2802 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2803 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2804 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2805 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2806 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2807 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2808 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2809 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2810 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2811 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2812 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2813
33e29419 2814#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2b854a32 2815
c801d85f
KB
2816/*
2817 * Event table macros
2818 */
2819
7fa03f04
VZ
2820// helpers for writing shorter code below: declare an event macro taking 2, 1
2821// or none ids (the missing ids default to wxID_ANY)
2822//
2823// macro arguments:
2824// - evt one of wxEVT_XXX constants
2825// - id1, id2 ids of the first/last id
2826// - fn the function (should be cast to the right type)
2827#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2828 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2829#define wx__DECLARE_EVT1(evt, id, fn) \
2830 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2831#define wx__DECLARE_EVT0(evt, fn) \
2832 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2833
2834
c801d85f 2835// Generic events
7fa03f04
VZ
2836#define EVT_CUSTOM(event, winid, func) \
2837 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2838#define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2839 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
c801d85f 2840
265accbe 2841// EVT_COMMAND
96eb51bb 2842#define EVT_COMMAND(winid, event, func) \
7fa03f04 2843 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
96eb51bb 2844#define EVT_COMMAND_RANGE(id1, id2, event, func) \
7fa03f04 2845 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
265accbe 2846
7fa03f04
VZ
2847#define EVT_NOTIFY(event, winid, func) \
2848 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2849#define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2850 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
265accbe 2851
c801d85f 2852// Miscellaneous
7fa03f04
VZ
2853#define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2854#define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2855#define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2856#define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
aa767a45
JS
2857#define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
2858#define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
7fa03f04
VZ
2859#define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2860#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2861#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2862#define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2863#define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2864#define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2865#define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2866#define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2867#define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
5048c832 2868#if wxUSE_HOTKEY
7fa03f04 2869#define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
5048c832 2870#endif
7fa03f04
VZ
2871#define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2872#define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2873#define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2874#define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2875#define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2876#define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2877#define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2878#define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2879#define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2880#define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
afafd942 2881#define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
7fa03f04
VZ
2882#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2883#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2884#define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2885#define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2886#define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2887#define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2888#define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2889#define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2890#define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2891#define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2892#define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2893#define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2894#define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2895#define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2896#define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2897#define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
63e819f2 2898#define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
c801d85f
KB
2899
2900// Mouse events
7fa03f04
VZ
2901#define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2902#define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2903#define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2904#define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2905#define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2906#define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2907#define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2908#define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2909#define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2910#define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2911#define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2912#define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2913#define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
01101e2d
VZ
2914#define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
2915#define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
2916#define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
2917#define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
2918#define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
2919#define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
c801d85f
KB
2920
2921// All mouse events
2922#define EVT_MOUSE_EVENTS(func) \
7fa03f04
VZ
2923 EVT_LEFT_DOWN(func) \
2924 EVT_LEFT_UP(func) \
01101e2d 2925 EVT_LEFT_DCLICK(func) \
7fa03f04
VZ
2926 EVT_MIDDLE_DOWN(func) \
2927 EVT_MIDDLE_UP(func) \
01101e2d 2928 EVT_MIDDLE_DCLICK(func) \
7fa03f04
VZ
2929 EVT_RIGHT_DOWN(func) \
2930 EVT_RIGHT_UP(func) \
7fa03f04 2931 EVT_RIGHT_DCLICK(func) \
01101e2d
VZ
2932 EVT_MOUSE_AUX1_DOWN(func) \
2933 EVT_MOUSE_AUX1_UP(func) \
2934 EVT_MOUSE_AUX1_DCLICK(func) \
2935 EVT_MOUSE_AUX2_DOWN(func) \
2936 EVT_MOUSE_AUX2_UP(func) \
2937 EVT_MOUSE_AUX2_DCLICK(func) \
2938 EVT_MOTION(func) \
7fa03f04
VZ
2939 EVT_LEAVE_WINDOW(func) \
2940 EVT_ENTER_WINDOW(func) \
2941 EVT_MOUSEWHEEL(func)
c801d85f 2942
c5b42c87 2943// Scrolling from wxWindow (sent to wxScrolledWindow)
7fa03f04
VZ
2944#define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2945#define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2946#define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2947#define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2948#define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2949#define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2950#define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2951#define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2952
c5b42c87 2953#define EVT_SCROLLWIN(func) \
7fa03f04
VZ
2954 EVT_SCROLLWIN_TOP(func) \
2955 EVT_SCROLLWIN_BOTTOM(func) \
2956 EVT_SCROLLWIN_LINEUP(func) \
2957 EVT_SCROLLWIN_LINEDOWN(func) \
2958 EVT_SCROLLWIN_PAGEUP(func) \
2959 EVT_SCROLLWIN_PAGEDOWN(func) \
2960 EVT_SCROLLWIN_THUMBTRACK(func) \
2961 EVT_SCROLLWIN_THUMBRELEASE(func)
c5b42c87
RR
2962
2963// Scrolling from wxSlider and wxScrollBar
7fa03f04
VZ
2964#define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2965#define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2966#define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2967#define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2968#define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2969#define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2970#define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2971#define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
cbc85508 2972#define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
7fa03f04 2973
c801d85f 2974#define EVT_SCROLL(func) \
7fa03f04
VZ
2975 EVT_SCROLL_TOP(func) \
2976 EVT_SCROLL_BOTTOM(func) \
2977 EVT_SCROLL_LINEUP(func) \
2978 EVT_SCROLL_LINEDOWN(func) \
2979 EVT_SCROLL_PAGEUP(func) \
2980 EVT_SCROLL_PAGEDOWN(func) \
2981 EVT_SCROLL_THUMBTRACK(func) \
e8739575 2982 EVT_SCROLL_THUMBRELEASE(func) \
84006e65 2983 EVT_SCROLL_CHANGED(func)
c801d85f 2984
c5b42c87 2985// Scrolling from wxSlider and wxScrollBar, with an id
7fa03f04
VZ
2986#define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2987#define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2988#define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2989#define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2990#define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2991#define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2992#define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2993#define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
cbc85508 2994#define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
7fa03f04 2995
d9e2e4c2 2996#define EVT_COMMAND_SCROLL(winid, func) \
7fa03f04
VZ
2997 EVT_COMMAND_SCROLL_TOP(winid, func) \
2998 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2999 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3000 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3001 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3002 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3003 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
e8739575 3004 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
84006e65 3005 EVT_COMMAND_SCROLL_CHANGED(winid, func)
cbc85508 3006
ca3e85cf
WS
3007#if WXWIN_COMPATIBILITY_2_6
3008 // compatibility macros for the old name, deprecated in 2.8
3009 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3010 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3011 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3012#endif // WXWIN_COMPATIBILITY_2_6
c801d85f
KB
3013
3014// Convenience macros for commonly-used commands
7fa03f04
VZ
3015#define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3016#define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3017#define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3018#define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3019#define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3020#define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
119727ad 3021#if defined(__SMARTPHONE__)
7fa03f04 3022# define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
119727ad 3023#else
7fa03f04 3024# define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
119727ad 3025#endif
7fa03f04
VZ
3026#define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3027#define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3028#define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
c801d85f 3029// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
7fa03f04
VZ
3030#define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3031#define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3032#define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3033#define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
a9a0ceca 3034#define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
7fa03f04
VZ
3035#define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3036#define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3037#define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3038#define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3039#define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
c801d85f
KB
3040
3041// Generic command events
7fa03f04
VZ
3042#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3043#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3044#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3045#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3046#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3047#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3048#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
c801d85f
KB
3049
3050// Joystick events
1241ab8b 3051
7fa03f04
VZ
3052#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3053#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3054#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3055#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
c801d85f
KB
3056
3057// All joystick events
3058#define EVT_JOYSTICK_EVENTS(func) \
7fa03f04
VZ
3059 EVT_JOY_BUTTON_DOWN(func) \
3060 EVT_JOY_BUTTON_UP(func) \
3061 EVT_JOY_MOVE(func) \
3062 EVT_JOY_ZMOVE(func)
c801d85f
KB
3063
3064// Idle event
7fa03f04 3065#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
c801d85f
KB
3066
3067// Update UI event
7fa03f04
VZ
3068#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3069#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
c801d85f 3070
b96340e6 3071// Help events
7fa03f04
VZ
3072#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3073#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3074#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3075#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
fb6261e9 3076
69231000 3077// Context Menu Events
7fa03f04 3078#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
5cd2a6ae 3079#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
69231000 3080
78c91815
VZ
3081// Clipboard text Events
3082#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3083#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3084#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3085
8e193f38
VZ
3086// ----------------------------------------------------------------------------
3087// Global data
3088// ----------------------------------------------------------------------------
3089
3090// for pending event processing - notice that there is intentionally no
3091// WXDLLEXPORT here
bddd7a8d 3092extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
8e193f38 3093#if wxUSE_THREADS
bddd7a8d 3094 extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
8e193f38
VZ
3095#endif
3096
e90c1d2a
VZ
3097// ----------------------------------------------------------------------------
3098// Helper functions
3099// ----------------------------------------------------------------------------
3100
3101#if wxUSE_GUI
e702ff0f
JS
3102
3103// Find a window with the focus, that is also a descendant of the given window.
3104// This is used to determine the window to initially send commands to.
9f8b9d9c 3105WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
e702ff0f 3106
e90c1d2a
VZ
3107#endif // wxUSE_GUI
3108
1648d51b 3109#endif // _WX_EVENT_H__