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