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