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