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