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