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