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