]> 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
build fixes for wxUSE_IPV6==1 under Windows
[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.
5c33522f 72#define wxStaticCastEvent(type, val) 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 {
3232da9d 911 if ( &evt != this )
162e998c 912 {
0e097789 913 wxEvent::operator=(evt);
3232da9d
VZ		 914
915 // Borland C++ 5.82 doesn't compile an explicit call to an
916 // implicitly defined operator=() so need to do it this way:
917 *static_cast<wxKeyboardState *>(this) = evt;
0e097789 918
162e998c
PC		 919 m_x = evt.m_x;
920 m_y = evt.m_y;
921
922 m_keyCode = evt.m_keyCode;
923
162e998c
PC		 924 m_scanCode = evt.m_scanCode;
925 m_rawCode = evt.m_rawCode;
926 m_rawFlags = evt.m_rawFlags;
cedea72f 927#if wxUSE_UNICODE
162e998c 928 m_uniChar = evt.m_uniChar;
cedea72f 929#endif
162e998c 930 }
f97500b8
VZ		 931 return *this;
932 }
933
2b854a32 934public:
b02da6b1
VZ		 935 wxCoord m_x, m_y;
936
2b854a32 937 long m_keyCode;
b02da6b1 938
e7102772 939 // FIXME: what is this for? relation to m_rawXXX?
b0e813a0 940 bool m_scanCode;
f97500b8 941
2b5f62a0
VZ		 942#if wxUSE_UNICODE
943 // This contains the full Unicode character
944 // in a character events in Unicode mode
945 wxChar m_uniChar;
946#endif
947
948 // these fields contain the platform-specific information about
949 // key that was pressed
9c7df356
VZ		 950 wxUint32 m_rawCode;
951 wxUint32 m_rawFlags;
952
8e72b8b5
RR		 953private:
954 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB		 955};
956
957// Size event class
958/*
959 wxEVT_SIZE
960 */
961
bddd7a8d 962class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
c801d85f 963{
2b854a32 964public:
497dbbd3 965 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
e6a6feba 966 { }
d9e2e4c2
DE		 967 wxSizeEvent(const wxSize& sz, int winid = 0)
968 : wxEvent(winid, wxEVT_SIZE),
497dbbd3 969 m_size(sz)
e6a6feba 970 { }
1d2eddff 971 wxSizeEvent(const wxSizeEvent & event)
b2697d42 972 : wxEvent(event),
5706de1c 973 m_size(event.m_size), m_rect(event.m_rect)
b2697d42 974 { }
5706de1c 975 wxSizeEvent(const wxRect& rect, int id = 0)
e00865fa 976 : m_size(rect.GetSize()), m_rect(rect)
5706de1c 977 { m_eventType = wxEVT_SIZING; m_id = id; }
c2bbeff0 978
2b854a32 979 wxSize GetSize() const { return m_size; }
5706de1c 980 wxRect GetRect() const { return m_rect; }
fbfb8bcc 981 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 982
8e72b8b5
RR		 983 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
984
985public:
b4b76d61 986 // For internal usage only. Will be converted to protected members.
8e72b8b5 987 wxSize m_size;
5706de1c 988 wxRect m_rect; // Used for wxEVT_SIZING
8e72b8b5 989
f97500b8 990private:
fc7a2a60 991 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
c801d85f
KB		 992};
993
994// Move event class
995
996/*
997 wxEVT_MOVE
998 */
999
bddd7a8d 1000class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
c801d85f 1001{
2b854a32 1002public:
e6a6feba
GD		 1003 wxMoveEvent()
1004 : wxEvent(0, wxEVT_MOVE)
e6a6feba 1005 { }
d9e2e4c2
DE		 1006 wxMoveEvent(const wxPoint& pos, int winid = 0)
1007 : wxEvent(winid, wxEVT_MOVE),
497dbbd3 1008 m_pos(pos)
e6a6feba 1009 { }
1d2eddff
JS		 1010 wxMoveEvent(const wxMoveEvent& event)
1011 : wxEvent(event),
b2697d42
VZ		 1012 m_pos(event.m_pos)
1013 { }
5706de1c
JS		 1014 wxMoveEvent(const wxRect& rect, int id = 0)
1015 : m_pos(rect.GetPosition()), m_rect(rect)
1016 { m_eventType = wxEVT_MOVING; m_id = id; }
c2bbeff0 1017
2b854a32 1018 wxPoint GetPosition() const { return m_pos; }
d7f03cae 1019 void SetPosition(const wxPoint& pos) { m_pos = pos; }
5706de1c 1020 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1021 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1022
8e72b8b5 1023 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
f97500b8 1024
b4b76d61 1025protected:
8e72b8b5 1026 wxPoint m_pos;
5706de1c 1027 wxRect m_rect;
f97500b8 1028
8e72b8b5 1029private:
fc7a2a60 1030 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
c801d85f
KB		 1031};
1032
1033// Paint event class
1034/*
1035 wxEVT_PAINT
1036 wxEVT_NC_PAINT
1037 wxEVT_PAINT_ICON
1038 */
1039
b078fa02
JS		 1040#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1041 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
bddd7a8d 1042 extern WXDLLIMPEXP_CORE int g_isPainting;
edccf428
VZ		 1043#endif // debug
1044
bddd7a8d 1045class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
c801d85f 1046{
2b854a32 1047public:
edccf428 1048 wxPaintEvent(int Id = 0)
e6a6feba 1049 : wxEvent(Id, wxEVT_PAINT)
edccf428 1050 {
b078fa02 1051#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ		 1052 // set the internal flag for the duration of processing of WM_PAINT
1053 g_isPainting++;
1054#endif // debug
1055 }
1056
4e689ecd
VZ		 1057 // default copy ctor and dtor are normally fine, we only need them to keep
1058 // g_isPainting updated in debug build
b078fa02 1059#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
4e689ecd
VZ		 1060 wxPaintEvent(const wxPaintEvent& event)
1061 : wxEvent(event)
1062 {
1063 g_isPainting++;
1064 }
1065
d3c7fc99 1066 virtual ~wxPaintEvent()
edccf428
VZ		 1067 {
1068 g_isPainting--;
1069 }
1070#endif // debug
8e72b8b5
RR		 1071
1072 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
f97500b8 1073
8e72b8b5 1074private:
fc7a2a60 1075 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
c801d85f
KB		 1076};
1077
bddd7a8d 1078class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1e6feb95
VZ		 1079{
1080public:
d9e2e4c2
DE		 1081 wxNcPaintEvent(int winid = 0)
1082 : wxEvent(winid, wxEVT_NC_PAINT)
e6a6feba 1083 { }
f97500b8 1084
8e72b8b5 1085 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1e6feb95
VZ		 1086
1087private:
fc7a2a60 1088 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1e6feb95
VZ		 1089};
1090
c801d85f
KB		 1091// Erase background event class
1092/*
1093 wxEVT_ERASE_BACKGROUND
1094 */
1095
bddd7a8d 1096class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
c801d85f 1097{
2b854a32 1098public:
2b854a32 1099 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
497dbbd3
VZ		 1100 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1101 m_dc(dc)
e6a6feba
GD		 1102 { }
1103
1104 wxEraseEvent(const wxEraseEvent& event)
497dbbd3
VZ		 1105 : wxEvent(event),
1106 m_dc(event.m_dc)
e6a6feba 1107 { }
f97500b8 1108
2b854a32 1109 wxDC *GetDC() const { return m_dc; }
aadbdf11 1110
8e72b8b5 1111 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
f97500b8 1112
b4b76d61 1113protected:
8e72b8b5
RR		 1114 wxDC *m_dc;
1115
1116private:
fc7a2a60 1117 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
c801d85f
KB		 1118};
1119
1120// Focus event class
1121/*
1122 wxEVT_SET_FOCUS
1123 wxEVT_KILL_FOCUS
1124 */
1125
bddd7a8d 1126class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
c801d85f 1127{
2b854a32 1128public:
d9e2e4c2
DE		 1129 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1130 : wxEvent(winid, type)
497dbbd3 1131 { m_win = NULL; }
e6a6feba
GD		 1132
1133 wxFocusEvent(const wxFocusEvent& event)
1134 : wxEvent(event)
497dbbd3 1135 { m_win = event.m_win; }
1e6feb95 1136
8e72b8b5 1137 // The window associated with this event is the window which had focus
1e6feb95 1138 // before for SET event and the window which will have focus for the KILL
8e72b8b5 1139 // one. NB: it may be NULL in both cases!
1e6feb95
VZ		 1140 wxWindow *GetWindow() const { return m_win; }
1141 void SetWindow(wxWindow *win) { m_win = win; }
1142
8e72b8b5 1143 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
f97500b8 1144
1e6feb95
VZ		 1145private:
1146 wxWindow *m_win;
1147
8e72b8b5 1148private:
fc7a2a60 1149 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
c801d85f
KB		 1150};
1151
456bc6d9 1152// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1648d51b 1153// wxFocusEvent it is propagated upwards the window chain
bddd7a8d 1154class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
456bc6d9
VZ		 1155{
1156public:
1157 wxChildFocusEvent(wxWindow *win = NULL);
1158
1159 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1160
8e72b8b5 1161 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
f97500b8 1162
8e72b8b5 1163private:
fc7a2a60 1164 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
456bc6d9
VZ		 1165};
1166
c801d85f
KB		 1167// Activate event class
1168/*
1169 wxEVT_ACTIVATE
1170 wxEVT_ACTIVATE_APP
afafd942 1171 wxEVT_HIBERNATE
c801d85f
KB		 1172 */
1173
bddd7a8d 1174class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
c801d85f 1175{
2b854a32 1176public:
a0d9c6cb 1177 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
e6a6feba 1178 : wxEvent(Id, type)
497dbbd3 1179 { m_active = active; }
1d2eddff
JS		 1180 wxActivateEvent(const wxActivateEvent& event)
1181 : wxEvent(event)
b2697d42 1182 { m_active = event.m_active; }
c2bbeff0 1183
2b854a32 1184 bool GetActive() const { return m_active; }
c801d85f 1185
8e72b8b5 1186 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
aadbdf11 1187
2b854a32
VZ		 1188private:
1189 bool m_active;
8e72b8b5
RR		 1190
1191private:
fc7a2a60 1192 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
c801d85f
KB		 1193};
1194
1195// InitDialog event class
1196/*
1197 wxEVT_INIT_DIALOG
1198 */
1199
bddd7a8d 1200class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
c801d85f 1201{
2b854a32
VZ		 1202public:
1203 wxInitDialogEvent(int Id = 0)
e6a6feba
GD		 1204 : wxEvent(Id, wxEVT_INIT_DIALOG)
1205 { }
8e72b8b5
RR		 1206
1207 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
f97500b8
VZ		 1208
1209private:
fc7a2a60 1210 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
c801d85f
KB		 1211};
1212
1213// Miscellaneous menu event class
1214/*
ccef86c7
VZ		 1215 wxEVT_MENU_OPEN,
1216 wxEVT_MENU_CLOSE,
c801d85f 1217 wxEVT_MENU_HIGHLIGHT,
c801d85f
KB		 1218*/
1219
bddd7a8d 1220class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
c801d85f 1221{
c801d85f 1222public:
92f1a59c 1223 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
d9e2e4c2 1224 : wxEvent(winid, type)
fc7a2a60 1225 { m_menuId = winid; m_menu = menu; }
1d2eddff
JS		 1226 wxMenuEvent(const wxMenuEvent & event)
1227 : wxEvent(event)
92f1a59c 1228 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
c2bbeff0 1229
ccef86c7 1230 // only for wxEVT_MENU_HIGHLIGHT
aadbdf11 1231 int GetMenuId() const { return m_menuId; }
c801d85f 1232
ccef86c7 1233 // only for wxEVT_MENU_OPEN/CLOSE
1a18887b 1234 bool IsPopup() const { return m_menuId == wxID_ANY; }
ccef86c7 1235
92f1a59c
JS		 1236 // only for wxEVT_MENU_OPEN/CLOSE
1237 wxMenu* GetMenu() const { return m_menu; }
1238
8e72b8b5 1239 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
f97500b8 1240
2b854a32 1241private:
92f1a59c
JS		 1242 int m_menuId;
1243 wxMenu* m_menu;
f97500b8 1244
fc7a2a60 1245 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
c801d85f
KB		 1246};
1247
1248// Window close or session close event class
1249/*
1250 wxEVT_CLOSE_WINDOW,
1251 wxEVT_END_SESSION,
1252 wxEVT_QUERY_END_SESSION
1253 */
1254
bddd7a8d 1255class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
c801d85f 1256{
c801d85f 1257public:
d9e2e4c2
DE		 1258 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1259 : wxEvent(winid, type),
a0d9c6cb
WS		 1260 m_loggingOff(true),
1261 m_veto(false), // should be false by default
1262 m_canVeto(true) {}
a3bf7524 1263
1d2eddff
JS		 1264 wxCloseEvent(const wxCloseEvent & event)
1265 : wxEvent(event),
b2697d42
VZ		 1266 m_loggingOff(event.m_loggingOff),
1267 m_veto(event.m_veto),
a3bf7524 1268 m_canVeto(event.m_canVeto) {}
c2bbeff0 1269
2b854a32 1270 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
4bcfcdef
VZ		 1271 bool GetLoggingOff() const
1272 {
1273 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1274 // doesn't make sense for wxEVT_CLOSE_WINDOW
1275 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1276 _T("this flag is for end session events only") );
1277
1278 return m_loggingOff;
1279 }
2b854a32 1280
a0d9c6cb 1281 void Veto(bool veto = true)
fe4e9e6c 1282 {
a0d9c6cb 1283 // GetVeto() will return false anyhow...
fe4e9e6c 1284 wxCHECK_RET( m_canVeto,
223d09f6 1285 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ		 1286
1287 m_veto = veto;
1288 }
2b854a32
VZ		 1289 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1290 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1291 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1292
8e72b8b5 1293 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
aadbdf11 1294
2b854a32 1295protected:
4bcfcdef
VZ		 1296 bool m_loggingOff,
1297 m_veto,
1298 m_canVeto;
2b854a32 1299
8e72b8b5 1300private:
fc7a2a60 1301 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
c801d85f
KB		 1302};
1303
1304/*
1305 wxEVT_SHOW
1306 */
1307
bddd7a8d 1308class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
c801d85f 1309{
c801d85f 1310public:
a0d9c6cb 1311 wxShowEvent(int winid = 0, bool show = false)
d9e2e4c2 1312 : wxEvent(winid, wxEVT_SHOW)
497dbbd3 1313 { m_show = show; }
1d2eddff
JS		 1314 wxShowEvent(const wxShowEvent & event)
1315 : wxEvent(event)
b2697d42 1316 { m_show = event.m_show; }
c2bbeff0 1317
2b854a32 1318 void SetShow(bool show) { m_show = show; }
d317fdeb
VZ		 1319
1320 // return true if the window was shown, false if hidden
1321 bool IsShown() const { return m_show; }
1322
831b64f3 1323#if WXWIN_COMPATIBILITY_2_8
d317fdeb
VZ		 1324 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1325#endif
c801d85f 1326
8e72b8b5 1327 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
aadbdf11 1328
c801d85f 1329protected:
2b854a32 1330 bool m_show;
3dd9b88a 1331
8e72b8b5 1332private:
fc7a2a60 1333 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
c801d85f
KB		 1334};
1335
1336/*
1337 wxEVT_ICONIZE
1338 */
1339
bddd7a8d 1340class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
c801d85f 1341{
2b854a32 1342public:
a0d9c6cb 1343 wxIconizeEvent(int winid = 0, bool iconized = true)
d9e2e4c2 1344 : wxEvent(winid, wxEVT_ICONIZE)
497dbbd3 1345 { m_iconized = iconized; }
1d2eddff
JS		 1346 wxIconizeEvent(const wxIconizeEvent & event)
1347 : wxEvent(event)
b2697d42 1348 { m_iconized = event.m_iconized; }
c2bbeff0 1349
831b64f3 1350#if WXWIN_COMPATIBILITY_2_8
d317fdeb
VZ		 1351 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1352#endif
3dd9b88a 1353 // return true if the frame was iconized, false if restored
d317fdeb 1354 bool IsIconized() const { return m_iconized; }
3dd9b88a 1355
8e72b8b5 1356 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
f97500b8 1357
3dd9b88a
VZ		 1358protected:
1359 bool m_iconized;
1360
8e72b8b5 1361private:
fc7a2a60 1362 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
c801d85f 1363};
c801d85f
KB		 1364/*
1365 wxEVT_MAXIMIZE
1366 */
1367
bddd7a8d 1368class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
c801d85f 1369{
2b854a32 1370public:
d9e2e4c2
DE		 1371 wxMaximizeEvent(int winid = 0)
1372 : wxEvent(winid, wxEVT_MAXIMIZE)
e6a6feba 1373 { }
3dd9b88a 1374
8e72b8b5 1375 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
f97500b8 1376
8e72b8b5 1377private:
fc7a2a60 1378 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
c801d85f
KB		 1379};
1380
1381// Joystick event class
1382/*
1383 wxEVT_JOY_BUTTON_DOWN,
1384 wxEVT_JOY_BUTTON_UP,
1385 wxEVT_JOY_MOVE,
1386 wxEVT_JOY_ZMOVE
1387*/
1388
1389// Which joystick? Same as Windows ids so no conversion necessary.
497dbbd3
VZ		 1390enum
1391{
1392 wxJOYSTICK1,
1393 wxJOYSTICK2
1394};
c801d85f
KB		 1395
1396// Which button is down?
497dbbd3
VZ		 1397enum
1398{
1399 wxJOY_BUTTON_ANY = -1,
1400 wxJOY_BUTTON1 = 1,
1401 wxJOY_BUTTON2 = 2,
1402 wxJOY_BUTTON3 = 4,
1403 wxJOY_BUTTON4 = 8
1404};
c801d85f 1405
bddd7a8d 1406class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
c801d85f 1407{
b4b76d61 1408protected:
2b854a32
VZ		 1409 wxPoint m_pos;
1410 int m_zPosition;
497dbbd3
VZ		 1411 int m_buttonChange; // Which button changed?
1412 int m_buttonState; // Which buttons are down?
1413 int m_joyStick; // Which joystick?
2b854a32 1414
b4b76d61 1415public:
2b854a32
VZ		 1416 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1417 int state = 0,
1418 int joystick = wxJOYSTICK1,
1419 int change = 0)
497dbbd3 1420 : wxEvent(0, type),
8b5d5223 1421 m_pos(),
497dbbd3
VZ		 1422 m_zPosition(0),
1423 m_buttonChange(change),
1424 m_buttonState(state),
1425 m_joyStick(joystick)
2b854a32 1426 {
2b854a32 1427 }
1d2eddff 1428 wxJoystickEvent(const wxJoystickEvent & event)
b2697d42
VZ		 1429 : wxEvent(event),
1430 m_pos(event.m_pos),
1431 m_zPosition(event.m_zPosition),
1432 m_buttonChange(event.m_buttonChange),
1433 m_buttonState(event.m_buttonState),
1434 m_joyStick(event.m_joyStick)
1d2eddff 1435 { }
c2bbeff0 1436
2b854a32
VZ		 1437 wxPoint GetPosition() const { return m_pos; }
1438 int GetZPosition() const { return m_zPosition; }
1439 int GetButtonState() const { return m_buttonState; }
1440 int GetButtonChange() const { return m_buttonChange; }
1441 int GetJoystick() const { return m_joyStick; }
1442
1443 void SetJoystick(int stick) { m_joyStick = stick; }
1444 void SetButtonState(int state) { m_buttonState = state; }
1445 void SetButtonChange(int change) { m_buttonChange = change; }
1446 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1447 void SetZPosition(int zPos) { m_zPosition = zPos; }
1448
1449 // Was it a button event? (*doesn't* mean: is any button *down*?)
1450 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 1451 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ		 1452
1453 // Was it a move event?
a7bc03c9 1454 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2b854a32
VZ		 1455
1456 // Was it a zmove event?
a7bc03c9 1457 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2b854a32
VZ		 1458
1459 // Was it a down event from button 1, 2, 3, 4 or any?
1460 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1461 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 1462 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1463
2b854a32
VZ		 1464 // Was it a up event from button 1, 2, 3 or any?
1465 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 1466 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 1467 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1468
2b854a32
VZ		 1469 // Was the given button 1,2,3,4 or any in Down state?
1470 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1471 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 1472 ((m_buttonState & but) == but)); }
f305c661 1473
8e72b8b5 1474 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
f97500b8 1475
8e72b8b5 1476private:
fc7a2a60 1477 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
c801d85f
KB		 1478};
1479
1480// Drop files event class
1481/*
1482 wxEVT_DROP_FILES
1483 */
1484
bddd7a8d 1485class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
c801d85f 1486{
2b854a32
VZ		 1487public:
1488 int m_noFiles;
1489 wxPoint m_pos;
c3c39620 1490 wxString* m_files;
2b854a32
VZ		 1491
1492 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1493 int noFiles = 0,
1494 wxString *files = (wxString *) NULL)
497dbbd3
VZ		 1495 : wxEvent(0, type),
1496 m_noFiles(noFiles),
1497 m_pos(),
1498 m_files(files)
e6a6feba 1499 { }
2b854a32 1500
c3c39620
VZ		 1501 // we need a copy ctor to avoid deleting m_files pointer twice
1502 wxDropFilesEvent(const wxDropFilesEvent& other)
497dbbd3
VZ		 1503 : wxEvent(other),
1504 m_noFiles(other.m_noFiles),
1505 m_pos(other.m_pos),
1506 m_files(NULL)
c3c39620 1507 {
c3c39620
VZ		 1508 m_files = new wxString[m_noFiles];
1509 for ( int n = 0; n < m_noFiles; n++ )
1510 {
1511 m_files[n] = other.m_files[n];
1512 }
1513 }
1514
1515 virtual ~wxDropFilesEvent()
1516 {
1517 delete [] m_files;
1518 }
1519
2b854a32
VZ		 1520 wxPoint GetPosition() const { return m_pos; }
1521 int GetNumberOfFiles() const { return m_noFiles; }
1522 wxString *GetFiles() const { return m_files; }
f305c661 1523
c3c39620 1524 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
f97500b8 1525
8e72b8b5 1526private:
fc7a2a60 1527 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
c801d85f
KB		 1528};
1529
c801d85f
KB		 1530// Update UI event
1531/*
1532 wxEVT_UPDATE_UI
1533 */
1534
e39af974
JS		 1535// Whether to always send update events to windows, or
1536// to only send update events to those with the
1537// wxWS_EX_PROCESS_UI_UPDATES style.
1538
1539enum wxUpdateUIMode
1540{
1541 // Send UI update events to all windows
1542 wxUPDATE_UI_PROCESS_ALL,
1543
1544 // Send UI update events to windows that have
1545 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1546 wxUPDATE_UI_PROCESS_SPECIFIED
1547};
1548
bddd7a8d 1549class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
c801d85f 1550{
2b854a32
VZ		 1551public:
1552 wxUpdateUIEvent(wxWindowID commandId = 0)
e6a6feba 1553 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
497dbbd3
VZ		 1554 {
1555 m_checked =
1556 m_enabled =
a3a4105d 1557 m_shown =
497dbbd3 1558 m_setEnabled =
a3a4105d 1559 m_setShown =
9b9337da 1560 m_setText =
a0d9c6cb 1561 m_setChecked = false;
497dbbd3 1562 }
1d2eddff
JS		 1563 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1564 : wxCommandEvent(event),
b2697d42
VZ		 1565 m_checked(event.m_checked),
1566 m_enabled(event.m_enabled),
a3a4105d 1567 m_shown(event.m_shown),
b2697d42 1568 m_setEnabled(event.m_setEnabled),
a3a4105d 1569 m_setShown(event.m_setShown),
b2697d42
VZ		 1570 m_setText(event.m_setText),
1571 m_setChecked(event.m_setChecked),
1572 m_text(event.m_text)
1573 { }
c2bbeff0 1574
2b854a32
VZ		 1575 bool GetChecked() const { return m_checked; }
1576 bool GetEnabled() const { return m_enabled; }
a3a4105d 1577 bool GetShown() const { return m_shown; }
2b854a32
VZ		 1578 wxString GetText() const { return m_text; }
1579 bool GetSetText() const { return m_setText; }
1580 bool GetSetChecked() const { return m_setChecked; }
1581 bool GetSetEnabled() const { return m_setEnabled; }
a3a4105d 1582 bool GetSetShown() const { return m_setShown; }
2b854a32 1583
a0d9c6cb
WS		 1584 void Check(bool check) { m_checked = check; m_setChecked = true; }
1585 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
a3a4105d 1586 void Show(bool show) { m_shown = show; m_setShown = true; }
a0d9c6cb 1587 void SetText(const wxString& text) { m_text = text; m_setText = true; }
c801d85f 1588
0b30bb0b
JS		 1589 // Sets the interval between updates in milliseconds.
1590 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
e39af974 1591 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
0b30bb0b
JS		 1592
1593 // Returns the current interval between updates in milliseconds
a7bc03c9 1594 static long GetUpdateInterval() { return sm_updateInterval; }
0b30bb0b 1595
e39af974 1596 // Can we update this window?
a7bc03c9 1597 static bool CanUpdate(wxWindowBase *win);
0b30bb0b
JS		 1598
1599 // Reset the update time to provide a delay until the next
1600 // time we should update
a7bc03c9 1601 static void ResetUpdateTime();
0b30bb0b 1602
77ffb593 1603 // Specify how wxWidgets will send update events: to
e39af974
JS		 1604 // all windows, or only to those which specify that they
1605 // will process the events.
1606 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1607
1608 // Returns the UI update mode
a7bc03c9 1609 static wxUpdateUIMode GetMode() { return sm_updateMode; }
e39af974 1610
8e72b8b5 1611 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
f305c661 1612
2b854a32
VZ		 1613protected:
1614 bool m_checked;
1615 bool m_enabled;
a3a4105d 1616 bool m_shown;
2b854a32 1617 bool m_setEnabled;
a3a4105d 1618 bool m_setShown;
2b854a32
VZ		 1619 bool m_setText;
1620 bool m_setChecked;
1621 wxString m_text;
0b30bb0b 1622#if wxUSE_LONGLONG
e39af974 1623 static wxLongLong sm_lastUpdate;
0b30bb0b 1624#endif
e39af974
JS		 1625 static long sm_updateInterval;
1626 static wxUpdateUIMode sm_updateMode;
f97500b8 1627
8e72b8b5 1628private:
fc7a2a60 1629 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
c801d85f
KB		 1630};
1631
1632/*
1633 wxEVT_SYS_COLOUR_CHANGED
1634 */
1635
1636// TODO: shouldn't all events record the window ID?
bddd7a8d 1637class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
c801d85f 1638{
2b854a32
VZ		 1639public:
1640 wxSysColourChangedEvent()
e6a6feba
GD		 1641 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1642 { }
f97500b8 1643
8e72b8b5 1644 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
f97500b8 1645
8e72b8b5 1646private:
fc7a2a60 1647 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
c801d85f
KB		 1648};
1649
a5e84126
JS		 1650/*
1651 wxEVT_MOUSE_CAPTURE_CHANGED
1652 The window losing the capture receives this message
1653 (even if it released the capture itself).
1654 */
1655
bddd7a8d 1656class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
a5e84126
JS		 1657{
1658public:
d9e2e4c2
DE		 1659 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1660 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
497dbbd3 1661 m_gainedCapture(gainedCapture)
e6a6feba
GD		 1662 { }
1663
1664 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
497dbbd3
VZ		 1665 : wxEvent(event),
1666 m_gainedCapture(event.m_gainedCapture)
e6a6feba 1667 { }
a5e84126
JS		 1668
1669 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1670
47b378bd 1671 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
a5e84126
JS		 1672
1673private:
1674 wxWindow* m_gainedCapture;
fc7a2a60
VZ		 1675
1676 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
a5e84126
JS		 1677};
1678
63e819f2
VS		 1679/*
1680 wxEVT_MOUSE_CAPTURE_LOST
1681 The window losing the capture receives this message, unless it released it
1682 it itself or unless wxWindow::CaptureMouse was called on another window
1683 (and so capture will be restored when the new capturer releases it).
1684 */
1685
1686class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1687{
1688public:
1689 wxMouseCaptureLostEvent(wxWindowID winid = 0)
1690 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1691 {}
1692
1693 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1694 : wxEvent(event)
1695 {}
1696
1697 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1698
1699 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1700};
1701
574c939e
KB		 1702/*
1703 wxEVT_DISPLAY_CHANGED
1704 */
bddd7a8d 1705class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
574c939e
KB		 1706{
1707private:
fc7a2a60 1708 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
574c939e
KB		 1709
1710public:
1711 wxDisplayChangedEvent()
e6a6feba
GD		 1712 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1713 { }
574c939e
KB		 1714
1715 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1716};
1717
f7bd2698
JS		 1718/*
1719 wxEVT_PALETTE_CHANGED
1720 */
1721
bddd7a8d 1722class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
f7bd2698 1723{
f7bd2698 1724public:
d9e2e4c2
DE		 1725 wxPaletteChangedEvent(wxWindowID winid = 0)
1726 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
497dbbd3
VZ		 1727 m_changedWindow((wxWindow *) NULL)
1728 { }
e6a6feba
GD		 1729
1730 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
497dbbd3
VZ		 1731 : wxEvent(event),
1732 m_changedWindow(event.m_changedWindow)
e6a6feba 1733 { }
f7bd2698 1734
2b854a32
VZ		 1735 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1736 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 1737
8e72b8b5 1738 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
f305c661 1739
f7bd2698 1740protected:
2b854a32 1741 wxWindow* m_changedWindow;
8e72b8b5
RR		 1742
1743private:
fc7a2a60 1744 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
f7bd2698
JS		 1745};
1746
1747/*
1748 wxEVT_QUERY_NEW_PALETTE
1749 Indicates the window is getting keyboard focus and should re-do its palette.
1750 */
1751
bddd7a8d 1752class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1753{
f7bd2698 1754public:
d9e2e4c2
DE		 1755 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1756 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
a0d9c6cb 1757 m_paletteRealized(false)
e6a6feba 1758 { }
1d2eddff
JS		 1759 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1760 : wxEvent(event),
b2697d42
VZ		 1761 m_paletteRealized(event.m_paletteRealized)
1762 { }
c2bbeff0 1763
2b854a32
VZ		 1764 // App sets this if it changes the palette.
1765 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1766 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 1767
8e72b8b5 1768 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
f305c661 1769
f7bd2698 1770protected:
2b854a32 1771 bool m_paletteRealized;
f97500b8 1772
8e72b8b5 1773private:
fc7a2a60 1774 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
f7bd2698
JS		 1775};
1776
7fdefd57
VZ		 1777/*
1778 Event generated by dialog navigation keys
1779 wxEVT_NAVIGATION_KEY
1780 */
d9506e77 1781// NB: don't derive from command event to avoid being propagated to the parent
bddd7a8d 1782class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
7fdefd57 1783{
7fdefd57 1784public:
d9506e77 1785 wxNavigationKeyEvent()
497dbbd3 1786 : wxEvent(0, wxEVT_NAVIGATION_KEY),
298ca00c 1787 m_flags(IsForward | FromTab), // defaults are for TAB
497dbbd3 1788 m_focus((wxWindow *)NULL)
aef35d0e
VZ		 1789 {
1790 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1791 }
d9506e77 1792
e6a6feba 1793 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
497dbbd3
VZ		 1794 : wxEvent(event),
1795 m_flags(event.m_flags),
1796 m_focus(event.m_focus)
e6a6feba 1797 { }
7fdefd57 1798
2b854a32 1799 // direction: forward (true) or backward (false)
d9506e77
VZ		 1800 bool GetDirection() const
1801 { return (m_flags & IsForward) != 0; }
1802 void SetDirection(bool bForward)
1803 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 1804
2b854a32
VZ		 1805 // it may be a window change event (MDI, notebook pages...) or a control
1806 // change event
d9506e77
VZ		 1807 bool IsWindowChange() const
1808 { return (m_flags & WinChange) != 0; }
1809 void SetWindowChange(bool bIs)
1810 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1811
298ca00c
VZ		 1812 // Set to true under MSW if the event was generated using the tab key.
1813 // This is required for proper navogation over radio buttons
1814 bool IsFromTab() const
1815 { return (m_flags & FromTab) != 0; }
1816 void SetFromTab(bool bIs)
1817 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1818
2b854a32
VZ		 1819 // the child which has the focus currently (may be NULL - use
1820 // wxWindow::FindFocus then)
d9506e77
VZ		 1821 wxWindow* GetCurrentFocus() const { return m_focus; }
1822 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1823
54a69edf
JS		 1824 // Set flags
1825 void SetFlags(long flags) { m_flags = flags; }
1826
8e72b8b5
RR		 1827 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1828
d9506e77
VZ		 1829 enum
1830 {
f2de9fee 1831 IsBackward = 0x0000,
d9506e77 1832 IsForward = 0x0001,
298ca00c
VZ		 1833 WinChange = 0x0002,
1834 FromTab = 0x0004
d9506e77
VZ		 1835 };
1836
1837 long m_flags;
1838 wxWindow *m_focus;
1839
8e72b8b5 1840private:
fc7a2a60 1841 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
7fdefd57
VZ		 1842};
1843
42e69d6b
VZ		 1844// Window creation/destruction events: the first is sent as soon as window is
1845// created (i.e. the underlying GUI object exists), but when the C++ object is
1846// fully initialized (so virtual functions may be called). The second,
1847// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1848// still safe to call virtual functions at this moment
1849/*
1850 wxEVT_CREATE
1851 wxEVT_DESTROY
1852 */
1853
bddd7a8d 1854class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
42e69d6b 1855{
42e69d6b
VZ		 1856public:
1857 wxWindowCreateEvent(wxWindow *win = NULL);
1858
1859 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1860
8e72b8b5 1861 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
f97500b8 1862
8e72b8b5 1863private:
fc7a2a60 1864 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
42e69d6b
VZ		 1865};
1866
bddd7a8d 1867class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
42e69d6b 1868{
42e69d6b
VZ		 1869public:
1870 wxWindowDestroyEvent(wxWindow *win = NULL);
1871
1872 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1873
8e72b8b5
RR		 1874 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1875
1876private:
fc7a2a60 1877 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
42e69d6b
VZ		 1878};
1879
bd83cb56 1880// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 1881/*
bd83cb56
VZ		 1882 wxEVT_HELP
1883 wxEVT_DETAILED_HELP
1884*/
b96340e6 1885
bddd7a8d 1886class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
b96340e6 1887{
b96340e6 1888public:
b107e8d5
VZ		 1889 // how was this help event generated?
1890 enum Origin
1891 {
1892 Origin_Unknown, // unrecognized event source
1893 Origin_Keyboard, // event generated from F1 key press
1894 Origin_HelpButton // event from [?] button on the title bar (Windows)
1895 };
1896
bd83cb56 1897 wxHelpEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 1898 wxWindowID winid = 0,
b107e8d5
VZ		 1899 const wxPoint& pt = wxDefaultPosition,
1900 Origin origin = Origin_Unknown)
d9e2e4c2 1901 : wxCommandEvent(type, winid),
b107e8d5
VZ		 1902 m_pos(pt),
1903 m_origin(GuessOrigin(origin))
e6a6feba 1904 { }
1d2eddff
JS		 1905 wxHelpEvent(const wxHelpEvent & event)
1906 : wxCommandEvent(event),
b2697d42
VZ		 1907 m_pos(event.m_pos),
1908 m_target(event.m_target),
b107e8d5
VZ		 1909 m_link(event.m_link),
1910 m_origin(event.m_origin)
1d2eddff 1911 { }
c2bbeff0 1912
bd83cb56
VZ		 1913 // Position of event (in screen coordinates)
1914 const wxPoint& GetPosition() const { return m_pos; }
1915 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 1916
bd83cb56
VZ		 1917 // Optional link to further help
1918 const wxString& GetLink() const { return m_link; }
1919 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 1920
bd83cb56
VZ		 1921 // Optional target to display help in. E.g. a window specification
1922 const wxString& GetTarget() const { return m_target; }
1923 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 1924
8e72b8b5 1925 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
f97500b8 1926
b107e8d5
VZ		 1927 // optional indication of the event source
1928 Origin GetOrigin() const { return m_origin; }
1929 void SetOrigin(Origin origin) { m_origin = origin; }
1930
bd83cb56
VZ		 1931protected:
1932 wxPoint m_pos;
1933 wxString m_target;
1934 wxString m_link;
b107e8d5
VZ		 1935 Origin m_origin;
1936
1937 // we can try to guess the event origin ourselves, even if none is
1938 // specified in the ctor
1939 static Origin GuessOrigin(Origin origin);
bd83cb56
VZ		 1940
1941private:
fc7a2a60 1942 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
b96340e6
JS		 1943};
1944
78c91815
VZ		 1945// A Clipboard Text event is sent when a window intercepts text copy/cut/paste
1946// message, i.e. the user has cut/copied/pasted data from/into a text control
1947// via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
1948// NOTE : under windows these events are *NOT* generated automatically
1949// for a Rich Edit text control.
1950/*
1951wxEVT_COMMAND_TEXT_COPY
1952wxEVT_COMMAND_TEXT_CUT
1953wxEVT_COMMAND_TEXT_PASTE
1954*/
1955
1956class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
1957{
1958public:
1959 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
1960 wxWindowID winid = 0)
1961 : wxCommandEvent(type, winid)
1962 { }
1963 wxClipboardTextEvent(const wxClipboardTextEvent & event)
1964 : wxCommandEvent(event)
1965 { }
1966
1967 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
1968
1969private:
1970 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
1971};
1972
69231000
JS		 1973// A Context event is sent when the user right clicks on a window or
1974// presses Shift-F10
1975// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
1976// Under other systems it may have to be generated from a right click event
1977/*
1978 wxEVT_CONTEXT_MENU
1979*/
1980
bddd7a8d 1981class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
69231000
JS		 1982{
1983public:
1984 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 1985 wxWindowID winid = 0,
e6a6feba 1986 const wxPoint& pt = wxDefaultPosition)
d9e2e4c2 1987 : wxCommandEvent(type, winid),
497dbbd3 1988 m_pos(pt)
e6a6feba 1989 { }
1d2eddff
JS		 1990 wxContextMenuEvent(const wxContextMenuEvent & event)
1991 : wxCommandEvent(event),
b2697d42 1992 m_pos(event.m_pos)
1d2eddff 1993 { }
c2bbeff0 1994
69231000
JS		 1995 // Position of event (in screen coordinates)
1996 const wxPoint& GetPosition() const { return m_pos; }
1997 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1998
8e72b8b5 1999 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
f97500b8 2000
69231000
JS		 2001protected:
2002 wxPoint m_pos;
2003
2004private:
fc7a2a60 2005 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
69231000
JS		 2006};
2007
b46b1d59
VZ		 2008#endif // wxUSE_GUI
2009
e90c1d2a
VZ		 2010// Idle event
2011/*
2012 wxEVT_IDLE
2013 */
2014
e39af974
JS		 2015// Whether to always send idle events to windows, or
2016// to only send update events to those with the
2017// wxWS_EX_PROCESS_IDLE style.
2018
2019enum wxIdleMode
2020{
2021 // Send idle events to all windows
2022 wxIDLE_PROCESS_ALL,
2023
2024 // Send idle events to windows that have
2025 // the wxWS_EX_PROCESS_IDLE flag specified
2026 wxIDLE_PROCESS_SPECIFIED
2027};
2028
b46b1d59 2029class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
e90c1d2a 2030{
e90c1d2a
VZ		 2031public:
2032 wxIdleEvent()
497dbbd3 2033 : wxEvent(0, wxEVT_IDLE),
a0d9c6cb 2034 m_requestMore(false)
e6a6feba 2035 { }
1d2eddff
JS		 2036 wxIdleEvent(const wxIdleEvent & event)
2037 : wxEvent(event),
b2697d42
VZ		 2038 m_requestMore(event.m_requestMore)
2039 { }
c2bbeff0 2040
a0d9c6cb 2041 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
e90c1d2a
VZ		 2042 bool MoreRequested() const { return m_requestMore; }
2043
8e72b8b5 2044 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
e90c1d2a 2045
77ffb593 2046 // Specify how wxWidgets will send idle events: to
e39af974
JS		 2047 // all windows, or only to those which specify that they
2048 // will process the events.
2049 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2050
2051 // Returns the idle event mode
a7bc03c9 2052 static wxIdleMode GetMode() { return sm_idleMode; }
e39af974 2053
e90c1d2a
VZ		 2054protected:
2055 bool m_requestMore;
e39af974 2056 static wxIdleMode sm_idleMode;
f97500b8 2057
8e72b8b5 2058private:
fc7a2a60 2059 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
e90c1d2a
VZ		 2060};
2061
e5fb7191 2062/* TODO
c801d85f
KB		 2063 wxEVT_MOUSE_CAPTURE_CHANGED,
2064 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB		 2065// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2066 // wxEVT_FONT_CHANGED to all other windows (maybe).
2067 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2068 wxEVT_MEASURE_ITEM,
2069 wxEVT_COMPARE_ITEM
2070*/
2071
88a9f974 2072
8e193f38
VZ		 2073// ============================================================================
2074// event handler and related classes
2075// ============================================================================
2076
d1a64f69
VZ		 2077typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2078
2079// We had some trouble (specifically with eVC for ARM WinCE build) with using
2080// wxEventFunction in the past so we had introduced wxObjectEventFunction which
2081// used to be a typedef for a member of wxObject and not wxEvtHandler to work
2082// around this but as eVC is not really supported any longer we now only keep
2083// this for backwards compatibility and, despite its name, this is a typedef
2084// for wxEvtHandler member now -- but if we have the same problem with another
2085// compiler we can restore its old definition for it.
2086typedef wxEventFunction wxObjectEventFunction;
c801d85f 2087
6164f93c
VZ		 2088// struct containing the members common to static and dynamic event tables
2089// entries
bddd7a8d 2090struct WXDLLIMPEXP_BASE wxEventTableEntryBase
77d4384e 2091{
e6a6feba
GD		 2092private:
2093 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
abcbaea7 2094
e6a6feba 2095public:
d9e2e4c2 2096 wxEventTableEntryBase(int winid, int idLast,
6164f93c 2097 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2098 : m_id(winid),
497dbbd3
VZ		 2099 m_lastId(idLast),
2100 m_fn(fn),
2101 m_callbackUserData(data)
e6a6feba
GD		 2102 { }
2103
2104 wxEventTableEntryBase(const wxEventTableEntryBase& event)
497dbbd3
VZ		 2105 : m_id(event.m_id),
2106 m_lastId(event.m_lastId),
2107 m_fn(event.m_fn),
2108 m_callbackUserData(event.m_callbackUserData)
abcbaea7 2109 { }
6164f93c 2110
497dbbd3
VZ		 2111 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2112 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2113 int m_id,
2114 m_lastId;
82a5f02c 2115
6164f93c
VZ		 2116 // function to call: not wxEventFunction, because of dependency problems
2117 wxObjectEventFunction m_fn;
77d4384e 2118
6164f93c 2119 // arbitrary user data asosciated with the callback
77d4384e
RR		 2120 wxObject* m_callbackUserData;
2121};
2122
6164f93c 2123// an entry from a static event table
bddd7a8d 2124struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
c801d85f 2125{
d9e2e4c2 2126 wxEventTableEntry(const int& evType, int winid, int idLast,
6164f93c 2127 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2128 : wxEventTableEntryBase(winid, idLast, fn, data),
e6a6feba
GD		 2129 m_eventType(evType)
2130 { }
6164f93c
VZ		 2131
2132 // the reference to event type: this allows us to not care about the
2133 // (undefined) order in which the event table entries and the event types
2134 // are initialized: initially the value of this reference might be
2135 // invalid, but by the time it is used for the first time, all global
2136 // objects will have been initialized (including the event type constants)
2137 // and so it will have the correct value when it is needed
2138 const int& m_eventType;
fc7a2a60
VZ		 2139
2140private:
2141 wxEventTableEntry& operator=(const wxEventTableEntry&);
6164f93c
VZ		 2142};
2143
2144// an entry used in dynamic event table managed by wxEvtHandler::Connect()
bddd7a8d 2145struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
6164f93c 2146{
d9e2e4c2 2147 wxDynamicEventTableEntry(int evType, int winid, int idLast,
65b17727 2148 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
d9e2e4c2 2149 : wxEventTableEntryBase(winid, idLast, fn, data),
65b17727
JS		 2150 m_eventType(evType),
2151 m_eventSink(eventSink)
e6a6feba 2152 { }
6164f93c
VZ		 2153
2154 // not a reference here as we can't keep a reference to a temporary int
2155 // created to wrap the constant value typically passed to Connect() - nor
2156 // do we need it
2157 int m_eventType;
65b17727
JS		 2158
2159 // Pointer to object whose function is fn - so we don't assume the
1c624631 2160 // EventFunction is always a member of the EventHandler receiving the
65b17727
JS		 2161 // message
2162 wxEvtHandler* m_eventSink;
fc7a2a60
VZ		 2163
2164 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
c801d85f
KB		 2165};
2166
2e4df4bf
VZ		 2167// ----------------------------------------------------------------------------
2168// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2169// ----------------------------------------------------------------------------
886dd7d2 2170
bddd7a8d 2171struct WXDLLIMPEXP_BASE wxEventTable
c801d85f 2172{
0b5eceb6
VZ		 2173 const wxEventTable *baseTable; // base event table (next in chain)
2174 const wxEventTableEntry *entries; // bottom of entry array
c801d85f
KB		 2175};
2176
b5a98acd
VZ		 2177// ----------------------------------------------------------------------------
2178// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2179// ----------------------------------------------------------------------------
2180
d5d29b8a 2181WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
b5a98acd
VZ		 2182
2183class WXDLLIMPEXP_BASE wxEventHashTable
2184{
2185private:
2186 // Internal data structs
2187 struct EventTypeTable
2188 {
2189 wxEventType eventType;
2190 wxEventTableEntryPointerArray eventEntryTable;
2191 };
2192 typedef EventTypeTable* EventTypeTablePointer;
2193
2194public:
2195 // Constructor, needs the event table it needs to hash later on.
1c624631
VZ		 2196 // Note: hashing of the event table is not done in the constructor as it
2197 // can be that the event table is not yet full initialize, the hash
b5a98acd
VZ		 2198 // will gets initialized when handling the first event look-up request.
2199 wxEventHashTable(const wxEventTable &table);
2200 // Destructor.
2201 ~wxEventHashTable();
2202
1c624631 2203 // Handle the given event, in other words search the event table hash
b5a98acd
VZ		 2204 // and call self->ProcessEvent() if a match was found.
2205 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2206
afa039f9
JS		 2207 // Clear table
2208 void Clear();
2209
aa767a45 2210#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
afa039f9
JS		 2211 // Clear all tables
2212 static void ClearAll();
a0826b11 2213#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
afa039f9 2214
b5a98acd
VZ		 2215protected:
2216 // Init the hash table with the entries of the static event table.
2217 void InitHashTable();
2218 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2219 void AddEntry(const wxEventTableEntry &entry);
2220 // Allocate and init with null pointers the base hash table.
2221 void AllocEventTypeTable(size_t size);
1c624631 2222 // Grow the hash table in size and transfer all items currently
b5a98acd
VZ		 2223 // in the table to the correct location in the new table.
2224 void GrowEventTypeTable();
2225
2226protected:
2227 const wxEventTable &m_table;
2228 bool m_rebuildHash;
2229
2230 size_t m_size;
2231 EventTypeTablePointer *m_eventTypeTable;
fc7a2a60 2232
afa039f9
JS		 2233 static wxEventHashTable* sm_first;
2234 wxEventHashTable* m_previous;
2235 wxEventHashTable* m_next;
2236
fc7a2a60 2237 DECLARE_NO_COPY_CLASS(wxEventHashTable)
b5a98acd
VZ		 2238};
2239
6164f93c 2240// ----------------------------------------------------------------------------
77ffb593 2241// wxEvtHandler: the base class for all objects handling wxWidgets events
6164f93c
VZ		 2242// ----------------------------------------------------------------------------
2243
4732e2dc 2244class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
4732e2dc 2245 , public wxTrackable
c801d85f 2246{
2b854a32
VZ		 2247public:
2248 wxEvtHandler();
6164f93c 2249 virtual ~wxEvtHandler();
2b854a32
VZ		 2250
2251 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2252 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2253 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2254 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2255
8e193f38 2256 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ		 2257 bool GetEvtHandlerEnabled() const { return m_enabled; }
2258
c3f94162
VZ		 2259 // Process an event right now: this can only be called from the main
2260 // thread, use QueueEvent() for scheduling the events for
2261 // processing from other threads.
8e193f38 2262 virtual bool ProcessEvent(wxEvent& event);
2b854a32 2263
937013e0
VS		 2264 // Process an event by calling ProcessEvent and handling any exceptions
2265 // thrown by event handlers. It's mostly useful when processing wx events
2266 // when called from C code (e.g. in GTK+ callback) when the exception
2267 // wouldn't correctly propagate to wxEventLoop.
2268 bool SafelyProcessEvent(wxEvent& event);
2269
c3f94162
VZ		 2270 // Schedule the given event to be processed later. It takes ownership of
2271 // the event pointer, i.e. it will be deleted later. This is safe to call
2272 // from multiple threads although you still need to ensure that wxString
2273 // fields of the event object are deep copies and not use the same string
2274 // buffer as other wxString objects in this thread.
2275 virtual void QueueEvent(wxEvent *event);
2276
2277 // Add an event to be processed later: notice that this function is not
2278 // safe to call from threads other than main, use QueueEvent()
2279 virtual void AddPendingEvent(const wxEvent& event)
2280 {
2281 // notice that the thread-safety problem comes from the fact that
2282 // Clone() doesn't make deep copies of wxString fields of wxEvent
2283 // object and so the same wxString could be used from both threads when
2284 // the event object is destroyed in this one -- QueueEvent() avoids
2285 // this problem as the event pointer is not used any more in this
2286 // thread at all after it is called.
2287 QueueEvent(event.Clone());
2288 }
2b854a32 2289
8e193f38 2290 void ProcessPendingEvents();
2b854a32 2291
7214297d 2292#if wxUSE_THREADS
76bfdc9a 2293 bool ProcessThreadEvent(const wxEvent& event);
7214297d 2294#endif
2b854a32
VZ		 2295
2296 // Dynamic association of a member function handler with the event handler,
d9e2e4c2 2297 // winid and event type
7fa03f04
VZ		 2298 void Connect(int winid,
2299 int lastId,
c9c1faa4 2300 wxEventType eventType,
7fa03f04
VZ		 2301 wxObjectEventFunction func,
2302 wxObject *userData = (wxObject *) NULL,
2303 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2b854a32
VZ		 2304
2305 // Convenience function: take just one id
7fa03f04 2306 void Connect(int winid,
c9c1faa4 2307 wxEventType eventType,
7fa03f04
VZ		 2308 wxObjectEventFunction func,
2309 wxObject *userData = (wxObject *) NULL,
2310 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2311 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2b854a32 2312
7fa03f04 2313 // Even more convenient: without id (same as using id of wxID_ANY)
c9c1faa4 2314 void Connect(wxEventType eventType,
7fa03f04
VZ		 2315 wxObjectEventFunction func,
2316 wxObject *userData = (wxObject *) NULL,
2317 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2318 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2319
2320 bool Disconnect(int winid,
2321 int lastId,
2322 wxEventType eventType,
2323 wxObjectEventFunction func = NULL,
2324 wxObject *userData = (wxObject *) NULL,
2325 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2326
e554d626 2327 bool Disconnect(int winid = wxID_ANY,
7fa03f04
VZ		 2328 wxEventType eventType = wxEVT_NULL,
2329 wxObjectEventFunction func = NULL,
2330 wxObject *userData = (wxObject *) NULL,
2331 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2332 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
98243fed 2333
bdbe28fa 2334 bool Disconnect(wxEventType eventType,
e0685bb0 2335 wxObjectEventFunction func,
bdbe28fa
VZ		 2336 wxObject *userData = (wxObject *) NULL,
2337 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2338 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
7fa03f04 2339
10da6a8f 2340 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
b88c44e7
RD		 2341
2342 // User data can be associated with each wxEvtHandler
2343 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2344 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2345
2346 void SetClientData( void *data ) { DoSetClientData(data); }
2347 void *GetClientData() const { return DoGetClientData(); }
2348
25250d33
VZ		 2349
2350 // implementation from now on
2351 // --------------------------
2352
1c624631
VZ		 2353 // check if the given event table entry matches this event and call the
2354 // handler if it does
2355 //
2356 // return true if the event was processed, false otherwise (no match or the
2357 // handler decided to skip the event)
2358 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2359 wxEvtHandler *handler,
2360 wxEvent& event);
b88c44e7 2361
8e193f38 2362 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2b854a32 2363 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 2364
afa039f9
JS		 2365 // Avoid problems at exit by cleaning up static hash table gracefully
2366 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2ef989c9 2367 void OnSinkDestroyed( wxEvtHandler *sink );
afa039f9 2368
25250d33
VZ		 2369
2370 // The method processing the event in this event handler (or rather in this
2371 // event handler chain as it also tries the next handler and so on), i.e.
2372 // it returns true if we processed this event or false if we didn't but
2373 // does not call TryParent() in the latter case. It also doesn't call
2374 // wxApp::FilterEvent() before processing it, this is supposed to be done
2375 // by the public ProcessEvent() only once for every event we handle.
2376 //
2377 // It is meant to be called from ProcessEvent() only and is not virtual,
2378 // additional event handlers can be hooked into the normal event processing
2379 // logic using TryValidator() hook.
2380 bool ProcessEventHere(wxEvent& event);
2381
2382
c801d85f 2383private:
8e193f38 2384 static const wxEventTableEntry sm_eventTableEntries[];
2b854a32 2385
c801d85f 2386protected:
4caf847c
VZ		 2387 // hooks for wxWindow used by ProcessEvent()
2388 // -----------------------------------------
2389
6eabf58c
VS		 2390 // This one is called before trying our own event table to allow plugging
2391 // in the validators.
1c624631 2392 //
6eabf58c
VS		 2393 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2394 // It is part of wxBase which doesn't use validators and the code
2395 // is compiled out when building wxBase w/o GUI classes, which affects
3103e8a9 2396 // binary compatibility and wxBase library can't be used by GUI
6eabf58c 2397 // ports.
4caf847c 2398 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
4caf847c
VZ		 2399
2400 // this one is called after failing to find the event handle in our own
2401 // table to give a chance to the other windows to process it
2402 //
2403 // base class implementation passes the event to wxTheApp
2404 virtual bool TryParent(wxEvent& event);
2405
2406
1c624631 2407 static const wxEventTable sm_eventTable;
193bf013
VZ		 2408 virtual const wxEventTable *GetEventTable() const;
2409
b5a98acd
VZ		 2410 static wxEventHashTable sm_eventHashTable;
2411 virtual wxEventHashTable& GetEventHashTable() const;
2412
63863e09
JS		 2413 wxEvtHandler* m_nextHandler;
2414 wxEvtHandler* m_previousHandler;
63863e09 2415 wxList* m_dynamicEvents;
42e69d6b 2416 wxList* m_pendingEvents;
6164f93c 2417
7214297d 2418#if wxUSE_THREADS
8ebec7dc
VZ		 2419 // critical section protecting m_pendingEvents
2420 wxCriticalSection m_pendingEventsLock;
2421#endif // wxUSE_THREADS
193bf013 2422
8e193f38
VZ		 2423 // Is event handler enabled?
2424 bool m_enabled;
6164f93c 2425
b88c44e7
RD		 2426
2427 // The user data: either an object which will be deleted by the container
2428 // when it's deleted or some raw pointer which we do nothing with - only
2429 // one type of data can be used with the given window (i.e. you cannot set
2430 // the void data and then associate the container with wxClientData or vice
2431 // versa)
2432 union
2433 {
2434 wxClientData *m_clientObject;
2435 void *m_clientData;
2436 };
2437
2438 // what kind of data do we have?
2439 wxClientDataType m_clientDataType;
2440
2441 // client data accessors
2442 virtual void DoSetClientObject( wxClientData *data );
2443 virtual wxClientData *DoGetClientObject() const;
2444
2445 virtual void DoSetClientData( void *data );
2446 virtual void *DoGetClientData() const;
2447
2ef989c9 2448 // Search tracker objects for event connection with this sink
cc6ceca7 2449 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
2ef989c9 2450
6164f93c 2451private:
fc7a2a60 2452 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
c801d85f
KB		 2453};
2454
cc6ceca7
VZ		 2455// ----------------------------------------------------------------------------
2456// wxEventConnectionRef represents all connections between two event handlers
2457// and enables automatic disconnect when an event handler sink goes out of
2458// scope. Each connection/disconnect increases/decreases ref count, and
2459// when it reaches zero the node goes out of scope.
2460// ----------------------------------------------------------------------------
2461
2462class wxEventConnectionRef : public wxTrackerNode
2463{
2464public:
2465 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
2466 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
2467 : m_src(src), m_sink(sink), m_refCount(1)
2468 {
2469 m_sink->AddNode(this);
2470 }
2471
2472 // The sink is being destroyed
2473 virtual void OnObjectDestroy( )
2474 {
2475 if ( m_src )
2476 m_src->OnSinkDestroyed( m_sink );
2477 delete this;
2478 }
2479
2480 virtual wxEventConnectionRef *ToEventConnection() { return this; }
2481
2482 void IncRef() { m_refCount++; }
2483 void DecRef()
2484 {
2485 if ( !--m_refCount )
2486 {
2487 // The sink holds the only external pointer to this object
2488 if ( m_sink )
2489 m_sink->RemoveNode(this);
2490 delete this;
2491 }
2492 }
2493
2494private:
2495 wxEvtHandler *m_src,
2496 *m_sink;
2497 int m_refCount;
2498
2499 friend class wxEvtHandler;
2500
2501 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef)
2502};
2503
c3f94162
VZ		 2504// Post a message to the given event handler which will be processed during the
2505// next event loop iteration.
2506//
2507// Notice that this one is not thread-safe, use wxQueueEvent()
76bfdc9a 2508inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
e2478fde 2509{
c3f94162 2510 wxCHECK_RET( dest, "need an object to post event to" );
e2478fde
VZ		 2511
2512 dest->AddPendingEvent(event);
2513}
2514
c3f94162
VZ		 2515// Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
2516// processing, unlike wxPostEvent it is safe to use from different thread even
2517// for events with wxString members
2518inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
2519{
2520 wxCHECK_RET( dest, "need an object to queue event for" );
2521
2522 dest->QueueEvent(event);
2523}
2524
96d38c7e 2525typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
85ee6241 2526typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
96d38c7e 2527
7fa03f04
VZ		 2528#define wxEventHandler(func) \
2529 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
85ee6241
VZ		 2530#define wxIdleEventHandler(func) \
2531 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
7fa03f04 2532
e90c1d2a 2533#if wxUSE_GUI
7fa03f04 2534
c4fa5aa7
VZ		 2535// ----------------------------------------------------------------------------
2536// wxEventBlocker: helper class to temporarily disable event handling for a window
2537// ----------------------------------------------------------------------------
2538
b483f5fe 2539class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
c4fa5aa7
VZ		 2540{
2541public:
2542 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2543 virtual ~wxEventBlocker();
2544
2545 void Block(wxEventType type)
2546 {
2547 m_eventsToBlock.push_back(type);
2548 }
2549
2550 virtual bool ProcessEvent(wxEvent& event);
2551
2552protected:
2553 wxArrayInt m_eventsToBlock;
2554 wxWindow *m_window;
2555
2556 DECLARE_NO_COPY_CLASS(wxEventBlocker)
2557};
2558
c801d85f
KB		 2559typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2560typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
c5b42c87 2561typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
c801d85f
KB		 2562typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2563typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2564typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
7309deea 2565typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
c801d85f
KB		 2566typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2567typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2568typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2569typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
456bc6d9 2570typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
c801d85f
KB		 2571typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2572typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2573typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2574typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2575typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
7fa03f04
VZ		 2576typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2577typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
c801d85f 2578typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
c801d85f
KB		 2579typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2580typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
9bc13858 2581typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
98e78a5e 2582typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
81d66cf3 2583typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS		 2584typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2585typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
43b5058d
VZ		 2586typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2587typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2588typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
669f7a11 2589typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
b96340e6 2590typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
69231000 2591typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
a5e84126 2592typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
63e819f2 2593typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
78c91815 2594typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
7fa03f04 2595
7fa03f04
VZ		 2596
2597#define wxCommandEventHandler(func) \
8bc3ec1f 2598 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
7fa03f04 2599#define wxScrollEventHandler(func) \
8bc3ec1f 2600 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
7fa03f04 2601#define wxScrollWinEventHandler(func) \
8bc3ec1f 2602 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
7fa03f04 2603#define wxSizeEventHandler(func) \
8bc3ec1f 2604 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
7fa03f04 2605#define wxMoveEventHandler(func) \
8bc3ec1f 2606 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
7fa03f04 2607#define wxPaintEventHandler(func) \
8bc3ec1f 2608 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
7fa03f04 2609#define wxNcPaintEventHandler(func) \
8bc3ec1f 2610 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
7fa03f04 2611#define wxEraseEventHandler(func) \
8bc3ec1f 2612 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
7fa03f04 2613#define wxMouseEventHandler(func) \
8bc3ec1f 2614 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
7fa03f04 2615#define wxCharEventHandler(func) \
8bc3ec1f 2616 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
7fa03f04
VZ		 2617#define wxKeyEventHandler(func) wxCharEventHandler(func)
2618#define wxFocusEventHandler(func) \
8bc3ec1f 2619 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
7fa03f04 2620#define wxChildFocusEventHandler(func) \
8bc3ec1f 2621 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
7fa03f04 2622#define wxActivateEventHandler(func) \
8bc3ec1f 2623 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
7fa03f04 2624#define wxMenuEventHandler(func) \
8bc3ec1f 2625 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
7fa03f04 2626#define wxJoystickEventHandler(func) \
8bc3ec1f 2627 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
7fa03f04 2628#define wxDropFilesEventHandler(func) \
8bc3ec1f 2629 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
7fa03f04 2630#define wxInitDialogEventHandler(func) \
8bc3ec1f 2631 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
7fa03f04 2632#define wxSysColourChangedEventHandler(func) \
8bc3ec1f 2633 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
7fa03f04 2634#define wxDisplayChangedEventHandler(func) \
8bc3ec1f 2635 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
7fa03f04 2636#define wxUpdateUIEventHandler(func) \
8bc3ec1f 2637 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
7fa03f04 2638#define wxCloseEventHandler(func) \
8bc3ec1f 2639 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
7fa03f04 2640#define wxShowEventHandler(func) \
8bc3ec1f 2641 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
7fa03f04 2642#define wxIconizeEventHandler(func) \
8bc3ec1f 2643 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
7fa03f04 2644#define wxMaximizeEventHandler(func) \
8bc3ec1f 2645 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
7fa03f04 2646#define wxNavigationKeyEventHandler(func) \
8bc3ec1f 2647 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
7fa03f04 2648#define wxPaletteChangedEventHandler(func) \
8bc3ec1f 2649 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
7fa03f04 2650#define wxQueryNewPaletteEventHandler(func) \
8bc3ec1f 2651 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
7fa03f04 2652#define wxWindowCreateEventHandler(func) \
8bc3ec1f 2653 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
7fa03f04 2654#define wxWindowDestroyEventHandler(func) \
8bc3ec1f 2655 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
7fa03f04 2656#define wxSetCursorEventHandler(func) \
8bc3ec1f 2657 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
7fa03f04 2658#define wxNotifyEventHandler(func) \
8bc3ec1f 2659 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
7fa03f04 2660#define wxHelpEventHandler(func) \
8bc3ec1f 2661 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
7fa03f04 2662#define wxContextMenuEventHandler(func) \
8bc3ec1f 2663 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
7fa03f04 2664#define wxMouseCaptureChangedEventHandler(func) \
8bc3ec1f 2665 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
63e819f2
VS		 2666#define wxMouseCaptureLostEventHandler(func) \
2667 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
78c91815
VZ		 2668#define wxClipboardTextEventHandler(func) \
2669 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
7fa03f04 2670
e90c1d2a 2671#endif // wxUSE_GUI
c801d85f
KB		 2672
2673// N.B. In GNU-WIN32, you *have* to take the address of a member function
2674// (use &) or the compiler crashes...
2675
2676#define DECLARE_EVENT_TABLE() \
2e4df4bf
VZ		 2677 private: \
2678 static const wxEventTableEntry sm_eventTableEntries[]; \
2679 protected: \
2680 static const wxEventTable sm_eventTable; \
b5a98acd
VZ		 2681 virtual const wxEventTable* GetEventTable() const; \
2682 static wxEventHashTable sm_eventHashTable; \
2683 virtual wxEventHashTable& GetEventHashTable() const;
c801d85f 2684
48276300
VZ		 2685// N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2686// sm_eventTable before using it in GetEventTable() or the compiler gives
2687// E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
b5a98acd 2688
c801d85f 2689#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2e4df4bf
VZ		 2690 const wxEventTable theClass::sm_eventTable = \
2691 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
48276300
VZ		 2692 const wxEventTable *theClass::GetEventTable() const \
2693 { return &theClass::sm_eventTable; } \
b5a98acd
VZ		 2694 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2695 wxEventHashTable &theClass::GetEventHashTable() const \
2696 { return theClass::sm_eventHashTable; } \
2e4df4bf 2697 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
c801d85f 2698
f96a9d34
JS		 2699#define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2700 template<typename T1> \
2701 const wxEventTable theClass<T1>::sm_eventTable = \
2702 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2703 template<typename T1> \
2704 const wxEventTable *theClass<T1>::GetEventTable() const \
2705 { return &theClass<T1>::sm_eventTable; } \
2706 template<typename T1> \
2707 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2708 template<typename T1> \
2709 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2710 { return theClass<T1>::sm_eventHashTable; } \
2711 template<typename T1> \
2712 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2713
2714#define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2715 template<typename T1, typename T2> \
2716 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2717 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2718 template<typename T1, typename T2> \
2719 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2720 { return &theClass<T1, T2>::sm_eventTable; } \
2721 template<typename T1, typename T2> \
2722 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2723 template<typename T1, typename T2> \
2724 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2725 { return theClass<T1, T2>::sm_eventHashTable; } \
2726 template<typename T1, typename T2> \
2727 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2728
2729#define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2730 template<typename T1, typename T2, typename T3> \
2731 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2732 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2733 template<typename T1, typename T2, typename T3> \
2734 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2735 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2736 template<typename T1, typename T2, typename T3> \
2737 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2738 template<typename T1, typename T2, typename T3> \
2739 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2740 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2741 template<typename T1, typename T2, typename T3> \
2742 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2743
2744#define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2745 template<typename T1, typename T2, typename T3, typename T4> \
2746 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2747 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2748 template<typename T1, typename T2, typename T3, typename T4> \
2749 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2750 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2751 template<typename T1, typename T2, typename T3, typename T4> \
2752 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2753 template<typename T1, typename T2, typename T3, typename T4> \
2754 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2755 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2756 template<typename T1, typename T2, typename T3, typename T4> \
2757 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2758
2759#define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2760 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2761 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2762 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2763 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2764 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2765 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2766 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2767 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2768 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2769 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2770 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2771 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2772 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2773
2774#define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
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>::sm_eventTable = \
2777 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2778 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2779 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2780 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2781 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2782 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2783 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2784 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2785 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2786 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2787 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2788
2789#define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
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>::sm_eventTable = \
2792 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2793 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2794 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2795 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2796 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2797 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2798 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2799 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2800 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2801 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2802 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2803
33e29419 2804#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2b854a32 2805
c801d85f
KB		 2806/*
2807 * Event table macros
2808 */
2809
7fa03f04
VZ		 2810// helpers for writing shorter code below: declare an event macro taking 2, 1
2811// or none ids (the missing ids default to wxID_ANY)
2812//
2813// macro arguments:
2814// - evt one of wxEVT_XXX constants
2815// - id1, id2 ids of the first/last id
2816// - fn the function (should be cast to the right type)
2817#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2818 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2819#define wx__DECLARE_EVT1(evt, id, fn) \
2820 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2821#define wx__DECLARE_EVT0(evt, fn) \
2822 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2823
2824
c801d85f 2825// Generic events
7fa03f04
VZ		 2826#define EVT_CUSTOM(event, winid, func) \
2827 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2828#define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2829 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
c801d85f 2830
265accbe 2831// EVT_COMMAND
96eb51bb 2832#define EVT_COMMAND(winid, event, func) \
7fa03f04 2833 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
96eb51bb 2834#define EVT_COMMAND_RANGE(id1, id2, event, func) \
7fa03f04 2835 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
265accbe 2836
7fa03f04
VZ		 2837#define EVT_NOTIFY(event, winid, func) \
2838 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2839#define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2840 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
265accbe 2841
c801d85f 2842// Miscellaneous
7fa03f04
VZ		 2843#define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2844#define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2845#define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2846#define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
aa767a45
JS		 2847#define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
2848#define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
7fa03f04
VZ		 2849#define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2850#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2851#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2852#define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2853#define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2854#define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2855#define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2856#define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2857#define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
5048c832 2858#if wxUSE_HOTKEY
7fa03f04 2859#define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
5048c832 2860#endif
7fa03f04
VZ		 2861#define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2862#define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2863#define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2864#define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2865#define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2866#define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2867#define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2868#define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2869#define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2870#define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
afafd942 2871#define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
7fa03f04
VZ		 2872#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2873#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2874#define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2875#define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2876#define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2877#define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2878#define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2879#define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2880#define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2881#define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2882#define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2883#define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2884#define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2885#define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2886#define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2887#define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
63e819f2 2888#define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
c801d85f
KB		 2889
2890// Mouse events
7fa03f04
VZ		 2891#define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2892#define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2893#define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2894#define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2895#define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2896#define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2897#define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2898#define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2899#define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2900#define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2901#define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2902#define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2903#define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
01101e2d
VZ		 2904#define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
2905#define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
2906#define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
2907#define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
2908#define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
2909#define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
c801d85f
KB		 2910
2911// All mouse events
2912#define EVT_MOUSE_EVENTS(func) \
7fa03f04
VZ		 2913 EVT_LEFT_DOWN(func) \
2914 EVT_LEFT_UP(func) \
01101e2d 2915 EVT_LEFT_DCLICK(func) \
7fa03f04
VZ		 2916 EVT_MIDDLE_DOWN(func) \
2917 EVT_MIDDLE_UP(func) \
01101e2d 2918 EVT_MIDDLE_DCLICK(func) \
7fa03f04
VZ		 2919 EVT_RIGHT_DOWN(func) \
2920 EVT_RIGHT_UP(func) \
7fa03f04 2921 EVT_RIGHT_DCLICK(func) \
01101e2d
VZ		 2922 EVT_MOUSE_AUX1_DOWN(func) \
2923 EVT_MOUSE_AUX1_UP(func) \
2924 EVT_MOUSE_AUX1_DCLICK(func) \
2925 EVT_MOUSE_AUX2_DOWN(func) \
2926 EVT_MOUSE_AUX2_UP(func) \
2927 EVT_MOUSE_AUX2_DCLICK(func) \
2928 EVT_MOTION(func) \
7fa03f04
VZ		 2929 EVT_LEAVE_WINDOW(func) \
2930 EVT_ENTER_WINDOW(func) \
2931 EVT_MOUSEWHEEL(func)
c801d85f 2932
c5b42c87 2933// Scrolling from wxWindow (sent to wxScrolledWindow)
7fa03f04
VZ		 2934#define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2935#define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2936#define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2937#define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2938#define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2939#define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2940#define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2941#define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2942
c5b42c87 2943#define EVT_SCROLLWIN(func) \
7fa03f04
VZ		 2944 EVT_SCROLLWIN_TOP(func) \
2945 EVT_SCROLLWIN_BOTTOM(func) \
2946 EVT_SCROLLWIN_LINEUP(func) \
2947 EVT_SCROLLWIN_LINEDOWN(func) \
2948 EVT_SCROLLWIN_PAGEUP(func) \
2949 EVT_SCROLLWIN_PAGEDOWN(func) \
2950 EVT_SCROLLWIN_THUMBTRACK(func) \
2951 EVT_SCROLLWIN_THUMBRELEASE(func)
c5b42c87
RR		 2952
2953// Scrolling from wxSlider and wxScrollBar
7fa03f04
VZ		 2954#define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2955#define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2956#define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2957#define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2958#define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2959#define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2960#define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2961#define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
cbc85508 2962#define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
7fa03f04 2963
c801d85f 2964#define EVT_SCROLL(func) \
7fa03f04
VZ		 2965 EVT_SCROLL_TOP(func) \
2966 EVT_SCROLL_BOTTOM(func) \
2967 EVT_SCROLL_LINEUP(func) \
2968 EVT_SCROLL_LINEDOWN(func) \
2969 EVT_SCROLL_PAGEUP(func) \
2970 EVT_SCROLL_PAGEDOWN(func) \
2971 EVT_SCROLL_THUMBTRACK(func) \
e8739575 2972 EVT_SCROLL_THUMBRELEASE(func) \
84006e65 2973 EVT_SCROLL_CHANGED(func)
c801d85f 2974
c5b42c87 2975// Scrolling from wxSlider and wxScrollBar, with an id
7fa03f04
VZ		 2976#define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2977#define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2978#define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2979#define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2980#define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2981#define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2982#define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2983#define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
cbc85508 2984#define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
7fa03f04 2985
d9e2e4c2 2986#define EVT_COMMAND_SCROLL(winid, func) \
7fa03f04
VZ		 2987 EVT_COMMAND_SCROLL_TOP(winid, func) \
2988 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2989 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
2990 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
2991 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
2992 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
2993 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
e8739575 2994 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
84006e65 2995 EVT_COMMAND_SCROLL_CHANGED(winid, func)
cbc85508 2996
ca3e85cf
WS		 2997#if WXWIN_COMPATIBILITY_2_6
2998 // compatibility macros for the old name, deprecated in 2.8
2999 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3000 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3001 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3002#endif // WXWIN_COMPATIBILITY_2_6
c801d85f
KB		 3003
3004// Convenience macros for commonly-used commands
7fa03f04
VZ		 3005#define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3006#define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3007#define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3008#define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3009#define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3010#define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
119727ad 3011#if defined(__SMARTPHONE__)
7fa03f04 3012# define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
119727ad 3013#else
7fa03f04 3014# define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
119727ad 3015#endif
7fa03f04
VZ		 3016#define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3017#define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3018#define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
c801d85f 3019// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
7fa03f04
VZ		 3020#define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3021#define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3022#define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3023#define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
a9a0ceca 3024#define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
7fa03f04
VZ		 3025#define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3026#define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3027#define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3028#define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3029#define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
c801d85f
KB		 3030
3031// Generic command events
7fa03f04
VZ		 3032#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3033#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3034#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3035#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3036#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3037#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3038#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
c801d85f
KB		 3039
3040// Joystick events
1241ab8b 3041
7fa03f04
VZ		 3042#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3043#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3044#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3045#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
c801d85f
KB		 3046
3047// All joystick events
3048#define EVT_JOYSTICK_EVENTS(func) \
7fa03f04
VZ		 3049 EVT_JOY_BUTTON_DOWN(func) \
3050 EVT_JOY_BUTTON_UP(func) \
3051 EVT_JOY_MOVE(func) \
3052 EVT_JOY_ZMOVE(func)
c801d85f
KB		 3053
3054// Idle event
7fa03f04 3055#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
c801d85f
KB		 3056
3057// Update UI event
7fa03f04
VZ		 3058#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3059#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
c801d85f 3060
b96340e6 3061// Help events
7fa03f04
VZ		 3062#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3063#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3064#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3065#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
fb6261e9 3066
69231000 3067// Context Menu Events
7fa03f04 3068#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
5cd2a6ae 3069#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
69231000 3070
78c91815
VZ		 3071// Clipboard text Events
3072#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3073#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3074#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3075
8e193f38
VZ		 3076// ----------------------------------------------------------------------------
3077// Global data
3078// ----------------------------------------------------------------------------
3079
19c4d916
VZ		 3080// list containing event handlers with pending events for them
3081//
3082// notice that each event handler should occur at most once in this list
079f4130 3083extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingEvents;
8e193f38 3084#if wxUSE_THREADS
079f4130 3085 extern WXDLLIMPEXP_BASE wxCriticalSection *wxHandlersWithPendingEventsLocker;
8e193f38
VZ		 3086#endif
3087
e90c1d2a
VZ		 3088// ----------------------------------------------------------------------------
3089// Helper functions
3090// ----------------------------------------------------------------------------
3091
3092#if wxUSE_GUI
e702ff0f
JS		 3093
3094// Find a window with the focus, that is also a descendant of the given window.
3095// This is used to determine the window to initially send commands to.
9f8b9d9c 3096WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
e702ff0f 3097
e90c1d2a
VZ		 3098#endif // wxUSE_GUI
3099
204abcd4 3100#endif // _WX_EVENT_H_
wxWidgets (Impactor)