]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/event.h
removing outdated files for mac
[wxWidgets.git] / include / wx / event.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/event.h
3// Purpose: Event classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) wxWidgets team
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_EVENT_H_
13#define _WX_EVENT_H_
14
15#include "wx/defs.h"
16#include "wx/cpp.h"
17#include "wx/object.h"
18#include "wx/clntdata.h"
19
20#if wxUSE_GUI
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23#endif
24
25#include "wx/dynarray.h"
26#include "wx/thread.h"
27#include "wx/tracker.h"
28
29// ----------------------------------------------------------------------------
30// forward declarations
31// ----------------------------------------------------------------------------
32
33class WXDLLIMPEXP_FWD_BASE wxList;
34#if wxUSE_GUI
35 class WXDLLIMPEXP_FWD_CORE wxDC;
36 class WXDLLIMPEXP_FWD_CORE wxMenu;
37 class WXDLLIMPEXP_FWD_CORE wxWindow;
38 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
39#endif // wxUSE_GUI
40
41class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
42class wxEventConnectionRef;
43
44// ----------------------------------------------------------------------------
45// Event types
46// ----------------------------------------------------------------------------
47
48typedef int wxEventType;
49
50#define wxEVT_ANY ((wxEventType)-1)
51
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.
54#define wxStaticCastEvent(type, val) wx_static_cast(type, val)
55
56#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
57 wxEventTableEntry(type, winid, idLast, fn, obj)
58
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
61#define BEGIN_DECLARE_EVENT_TYPES()
62#define END_DECLARE_EVENT_TYPES()
63#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
64 extern expdecl const wxEventType name;
65#define DECLARE_EVENT_TYPE(name, value) \
66 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
67#define DECLARE_LOCAL_EVENT_TYPE(name, value) \
68 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
69#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
70#define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
71
72// generate a new unique event type
73extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
74
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;
102extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED;
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;
152#if wxUSE_HOTKEY
153extern WXDLLIMPEXP_CORE const wxEventType wxEVT_HOTKEY;
154#endif
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;
242
243// these 2 events are the same
244#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
245
246// ----------------------------------------------------------------------------
247// Compatibility
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
254extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
255
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
267/*
268 * wxWidgets events, covering all interesting things that might happen
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
279class WXDLLIMPEXP_BASE wxEvent : public wxObject
280{
281private:
282 wxEvent& operator=(const wxEvent&);
283
284protected:
285 wxEvent(const wxEvent&); // for implementing Clone()
286
287public:
288 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
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()
302 // is the analog of calling the base class version of a virtual function)
303 void Skip(bool skip = true) { m_skipped = skip; }
304 bool GetSkipped() const { return m_skipped; }
305
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;
310
311 // Implementation only: this test is explicitly anti OO and this function
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
335protected:
336 wxObject* m_eventObject;
337 wxEventType m_eventType;
338 long m_timeStamp;
339 int m_id;
340
341public:
342 // m_callbackUserData is for internal usage only
343 wxObject* m_callbackUserData;
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
353protected:
354 bool m_skipped;
355 bool m_isCommandEvent;
356
357private:
358 // it needs to access our m_propagationLevel
359 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
360
361 DECLARE_ABSTRACT_CLASS(wxEvent)
362};
363
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;
383
384 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
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;
408
409 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
410};
411
412
413#if wxUSE_GUI
414
415
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
432 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
433*/
434
435class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
436{
437public:
438 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
439
440 wxCommandEvent(const wxCommandEvent& event)
441 : wxEvent(event),
442 m_cmdString(event.m_cmdString),
443 m_commandInt(event.m_commandInt),
444 m_extraLong(event.m_extraLong),
445 m_clientData(event.m_clientData),
446 m_clientObject(event.m_clientObject)
447 { }
448
449 // Set/Get client data from controls
450 void SetClientData(void* clientData) { m_clientData = clientData; }
451 void *GetClientData() const { return m_clientData; }
452
453 // Set/Get client object from controls
454 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
455 wxClientData *GetClientObject() const { return m_clientObject; }
456
457 // Get listbox selection if single-choice
458 int GetSelection() const { return m_commandInt; }
459
460 // Set/Get listbox/choice selection string
461 void SetString(const wxString& s) { m_cmdString = s; }
462 wxString GetString() const;
463
464 // Get checkbox value
465 bool IsChecked() const { return m_commandInt != 0; }
466
467 // true if the listbox event was a selection.
468 bool IsSelection() const { return (m_extraLong != 0); }
469
470 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
471 long GetExtraLong() const { return m_extraLong; }
472
473 void SetInt(int i) { m_commandInt = i; }
474 int GetInt() const { return m_commandInt; }
475
476 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
477
478protected:
479 wxString m_cmdString; // String event argument
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
484
485private:
486 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
487};
488
489// this class adds a possibility to react (from the user) code to a control
490// notification: allow or veto the operation being reported.
491class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
492{
493public:
494 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
495 : wxCommandEvent(commandType, winid)
496 { m_bAllow = true; }
497
498 wxNotifyEvent(const wxNotifyEvent& event)
499 : wxCommandEvent(event)
500 { m_bAllow = event.m_bAllow; }
501
502 // veto the operation (usually it's allowed by default)
503 void Veto() { m_bAllow = false; }
504
505 // allow the operation if it was disabled by default
506 void Allow() { m_bAllow = true; }
507
508 // for implementation code only: is the operation allowed?
509 bool IsAllowed() const { return m_bAllow; }
510
511 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
512
513private:
514 bool m_bAllow;
515
516private:
517 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
518};
519
520// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
521// sent by wxSlider and wxScrollBar.
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
530 wxEVT_SCROLL_THUMBRELEASE
531 wxEVT_SCROLL_CHANGED
532*/
533
534class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
535{
536public:
537 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
538 int winid = 0, int pos = 0, int orient = 0);
539
540 int GetOrientation() const { return (int) m_extraLong; }
541 int GetPosition() const { return m_commandInt; }
542 void SetOrientation(int orient) { m_extraLong = (long) orient; }
543 void SetPosition(int pos) { m_commandInt = pos; }
544
545 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
546
547private:
548 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
549};
550
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
561 wxEVT_SCROLLWIN_THUMBRELEASE
562*/
563
564class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
565{
566public:
567 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
568 int pos = 0, int orient = 0);
569 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
570 { m_commandInt = event.m_commandInt;
571 m_extraLong = event.m_extraLong; }
572
573 int GetOrientation() const { return (int) m_extraLong; }
574 int GetPosition() const { return m_commandInt; }
575 void SetOrientation(int orient) { m_extraLong = (long) orient; }
576 void SetPosition(int pos) { m_commandInt = pos; }
577
578 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
579
580protected:
581 int m_commandInt;
582 long m_extraLong;
583
584private:
585 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
586};
587
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
617// the symbolic names for the mouse buttons
618enum
619{
620 wxMOUSE_BTN_ANY = -1,
621 wxMOUSE_BTN_NONE = 0,
622 wxMOUSE_BTN_LEFT = 1,
623 wxMOUSE_BTN_MIDDLE = 2,
624 wxMOUSE_BTN_RIGHT = 3,
625 wxMOUSE_BTN_AUX1 = 4,
626 wxMOUSE_BTN_AUX2 = 5,
627 wxMOUSE_BTN_MAX
628};
629
630class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
631{
632public:
633 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
634 wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
635 { Assign(event); }
636
637 // Was it a button event? (*doesn't* mean: is any button *down*?)
638 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
639
640 // Was it a down event from this (or any) button?
641 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
642
643 // Was it a dclick event from this (or any) button?
644 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
645
646 // Was it a up event from this (or any) button?
647 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
648
649 // Was the given button?
650 bool Button(int but) const;
651
652 // Was the given button in Down state?
653 bool ButtonIsDown(int but) const;
654
655 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
656 int GetButton() const;
657
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; }
663 bool CmdDown() const
664 {
665#if defined(__WXMAC__) || defined(__WXCOCOA__)
666 return MetaDown();
667#else
668 return ControlDown();
669#endif
670 }
671
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); }
676 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
677 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
678
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); }
682 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
683 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
684
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); }
688 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
689 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
690
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; }
696 bool Aux1IsDown() const { return m_aux1Down; }
697 bool Aux2IsDown() const { return m_aux2Down; }
698
699 // True if a button is down and the mouse is moving
700 bool Dragging() const
701 {
702 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
703 }
704
705 // True if the mouse is moving, and no button is down
706 bool Moving() const
707 {
708 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
709 }
710
711 // True if the mouse is just entering the window
712 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
713
714 // True if the mouse is just leaving the window
715 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
716
717 // Returns the number of mouse clicks associated with this event.
718 int GetClickCount() const { return m_clickCount; }
719
720
721 // Find the position of the event
722 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
723 {
724 if (xpos)
725 *xpos = m_x;
726 if (ypos)
727 *ypos = m_y;
728 }
729
730 void GetPosition(long *xpos, long *ypos) const
731 {
732 if (xpos)
733 *xpos = (long)m_x;
734 if (ypos)
735 *ypos = (long)m_y;
736 }
737
738 // Find the position of the event
739 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
740
741 // Find the logical position of the event given the DC
742 wxPoint GetLogicalPosition(const wxDC& dc) const;
743
744 // Get X position
745 wxCoord GetX() const { return m_x; }
746
747 // Get Y position
748 wxCoord GetY() const { return m_y; }
749
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
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
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; }
772
773 // Is the system set to do page scrolling?
774 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
775
776 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
777
778 wxMouseEvent& operator=(const wxMouseEvent& event) { if (&event != this) Assign(event); return *this; }
779
780public:
781 wxCoord m_x, m_y;
782
783 bool m_leftDown;
784 bool m_middleDown;
785 bool m_rightDown;
786 bool m_aux1Down;
787 bool m_aux2Down;
788
789 bool m_controlDown;
790 bool m_shiftDown;
791 bool m_altDown;
792 bool m_metaDown;
793
794 int m_clickCount;
795
796 int m_wheelAxis;
797 int m_wheelRotation;
798 int m_wheelDelta;
799 int m_linesPerAction;
800
801protected:
802 void Assign(const wxMouseEvent& evt);
803
804private:
805 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
806};
807
808// Cursor set event
809
810/*
811 wxEVT_SET_CURSOR
812 */
813
814class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
815{
816public:
817 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
818 : wxEvent(0, wxEVT_SET_CURSOR),
819 m_x(x), m_y(y), m_cursor()
820 { }
821
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 { }
828
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
836 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
837
838private:
839 wxCoord m_x, m_y;
840 wxCursor m_cursor;
841
842private:
843 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
844};
845
846// Keyboard input event class
847
848/*
849 wxEVT_CHAR
850 wxEVT_CHAR_HOOK
851 wxEVT_KEY_DOWN
852 wxEVT_KEY_UP
853 wxEVT_HOTKEY
854 */
855
856class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
857{
858public:
859 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
860 wxKeyEvent(const wxKeyEvent& evt);
861
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
873 // Find state of shift/control keys
874 bool ControlDown() const { return m_controlDown; }
875 bool ShiftDown() const { return m_shiftDown; }
876 bool MetaDown() const { return m_metaDown; }
877 bool AltDown() const { return m_altDown; }
878
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
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(); }
897
898 // get the key code: an ASCII7 char or an element of wxKeyCode enum
899 int GetKeyCode() const { return (int)m_keyCode; }
900
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
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
912 // Find the position of the event
913 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
914 {
915 if (xpos) *xpos = m_x;
916 if (ypos) *ypos = m_y;
917 }
918
919 void GetPosition(long *xpos, long *ypos) const
920 {
921 if (xpos) *xpos = (long)m_x;
922 if (ypos) *ypos = (long)m_y;
923 }
924
925 wxPoint GetPosition() const
926 { return wxPoint(m_x, m_y); }
927
928 // Get X position
929 wxCoord GetX() const { return m_x; }
930
931 // Get Y position
932 wxCoord GetY() const { return m_y; }
933
934 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
935
936 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
937 // example)
938 wxKeyEvent& operator=(const wxKeyEvent& evt)
939 {
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;
954#if wxUSE_UNICODE
955 m_uniChar = evt.m_uniChar;
956#endif
957 }
958 return *this;
959 }
960
961public:
962 wxCoord m_x, m_y;
963
964 long m_keyCode;
965
966 // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
967 bool m_controlDown;
968 bool m_shiftDown;
969 bool m_altDown;
970 bool m_metaDown;
971
972 // FIXME: what is this for? relation to m_rawXXX?
973 bool m_scanCode;
974
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
983 wxUint32 m_rawCode;
984 wxUint32 m_rawFlags;
985
986private:
987 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
988};
989
990// Size event class
991/*
992 wxEVT_SIZE
993 */
994
995class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
996{
997public:
998 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
999 { }
1000 wxSizeEvent(const wxSize& sz, int winid = 0)
1001 : wxEvent(winid, wxEVT_SIZE),
1002 m_size(sz)
1003 { }
1004 wxSizeEvent(const wxSizeEvent & event)
1005 : wxEvent(event),
1006 m_size(event.m_size), m_rect(event.m_rect)
1007 { }
1008 wxSizeEvent(const wxRect& rect, int id = 0)
1009 : m_size(rect.GetSize()), m_rect(rect)
1010 { m_eventType = wxEVT_SIZING; m_id = id; }
1011
1012 wxSize GetSize() const { return m_size; }
1013 wxRect GetRect() const { return m_rect; }
1014 void SetRect(const wxRect& rect) { m_rect = rect; }
1015
1016 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1017
1018public:
1019 // For internal usage only. Will be converted to protected members.
1020 wxSize m_size;
1021 wxRect m_rect; // Used for wxEVT_SIZING
1022
1023private:
1024 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1025};
1026
1027// Move event class
1028
1029/*
1030 wxEVT_MOVE
1031 */
1032
1033class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1034{
1035public:
1036 wxMoveEvent()
1037 : wxEvent(0, wxEVT_MOVE)
1038 { }
1039 wxMoveEvent(const wxPoint& pos, int winid = 0)
1040 : wxEvent(winid, wxEVT_MOVE),
1041 m_pos(pos)
1042 { }
1043 wxMoveEvent(const wxMoveEvent& event)
1044 : wxEvent(event),
1045 m_pos(event.m_pos)
1046 { }
1047 wxMoveEvent(const wxRect& rect, int id = 0)
1048 : m_pos(rect.GetPosition()), m_rect(rect)
1049 { m_eventType = wxEVT_MOVING; m_id = id; }
1050
1051 wxPoint GetPosition() const { return m_pos; }
1052 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1053 wxRect GetRect() const { return m_rect; }
1054 void SetRect(const wxRect& rect) { m_rect = rect; }
1055
1056 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1057
1058protected:
1059 wxPoint m_pos;
1060 wxRect m_rect;
1061
1062private:
1063 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1064};
1065
1066// Paint event class
1067/*
1068 wxEVT_PAINT
1069 wxEVT_NC_PAINT
1070 wxEVT_PAINT_ICON
1071 */
1072
1073#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1074 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1075 extern WXDLLIMPEXP_CORE int g_isPainting;
1076#endif // debug
1077
1078class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1079{
1080public:
1081 wxPaintEvent(int Id = 0)
1082 : wxEvent(Id, wxEVT_PAINT)
1083 {
1084#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1085 // set the internal flag for the duration of processing of WM_PAINT
1086 g_isPainting++;
1087#endif // debug
1088 }
1089
1090 // default copy ctor and dtor are normally fine, we only need them to keep
1091 // g_isPainting updated in debug build
1092#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1093 wxPaintEvent(const wxPaintEvent& event)
1094 : wxEvent(event)
1095 {
1096 g_isPainting++;
1097 }
1098
1099 virtual ~wxPaintEvent()
1100 {
1101 g_isPainting--;
1102 }
1103#endif // debug
1104
1105 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1106
1107private:
1108 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1109};
1110
1111class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1112{
1113public:
1114 wxNcPaintEvent(int winid = 0)
1115 : wxEvent(winid, wxEVT_NC_PAINT)
1116 { }
1117
1118 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1119
1120private:
1121 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1122};
1123
1124// Erase background event class
1125/*
1126 wxEVT_ERASE_BACKGROUND
1127 */
1128
1129class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1130{
1131public:
1132 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1133 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1134 m_dc(dc)
1135 { }
1136
1137 wxEraseEvent(const wxEraseEvent& event)
1138 : wxEvent(event),
1139 m_dc(event.m_dc)
1140 { }
1141
1142 wxDC *GetDC() const { return m_dc; }
1143
1144 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1145
1146protected:
1147 wxDC *m_dc;
1148
1149private:
1150 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1151};
1152
1153// Focus event class
1154/*
1155 wxEVT_SET_FOCUS
1156 wxEVT_KILL_FOCUS
1157 */
1158
1159class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1160{
1161public:
1162 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1163 : wxEvent(winid, type)
1164 { m_win = NULL; }
1165
1166 wxFocusEvent(const wxFocusEvent& event)
1167 : wxEvent(event)
1168 { m_win = event.m_win; }
1169
1170 // The window associated with this event is the window which had focus
1171 // before for SET event and the window which will have focus for the KILL
1172 // one. NB: it may be NULL in both cases!
1173 wxWindow *GetWindow() const { return m_win; }
1174 void SetWindow(wxWindow *win) { m_win = win; }
1175
1176 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1177
1178private:
1179 wxWindow *m_win;
1180
1181private:
1182 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1183};
1184
1185// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1186// wxFocusEvent it is propagated upwards the window chain
1187class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1188{
1189public:
1190 wxChildFocusEvent(wxWindow *win = NULL);
1191
1192 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1193
1194 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1195
1196private:
1197 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1198};
1199
1200// Activate event class
1201/*
1202 wxEVT_ACTIVATE
1203 wxEVT_ACTIVATE_APP
1204 wxEVT_HIBERNATE
1205 */
1206
1207class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1208{
1209public:
1210 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1211 : wxEvent(Id, type)
1212 { m_active = active; }
1213 wxActivateEvent(const wxActivateEvent& event)
1214 : wxEvent(event)
1215 { m_active = event.m_active; }
1216
1217 bool GetActive() const { return m_active; }
1218
1219 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1220
1221private:
1222 bool m_active;
1223
1224private:
1225 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1226};
1227
1228// InitDialog event class
1229/*
1230 wxEVT_INIT_DIALOG
1231 */
1232
1233class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1234{
1235public:
1236 wxInitDialogEvent(int Id = 0)
1237 : wxEvent(Id, wxEVT_INIT_DIALOG)
1238 { }
1239
1240 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1241
1242private:
1243 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1244};
1245
1246// Miscellaneous menu event class
1247/*
1248 wxEVT_MENU_OPEN,
1249 wxEVT_MENU_CLOSE,
1250 wxEVT_MENU_HIGHLIGHT,
1251*/
1252
1253class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1254{
1255public:
1256 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1257 : wxEvent(winid, type)
1258 { m_menuId = winid; m_menu = menu; }
1259 wxMenuEvent(const wxMenuEvent & event)
1260 : wxEvent(event)
1261 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1262
1263 // only for wxEVT_MENU_HIGHLIGHT
1264 int GetMenuId() const { return m_menuId; }
1265
1266 // only for wxEVT_MENU_OPEN/CLOSE
1267 bool IsPopup() const { return m_menuId == wxID_ANY; }
1268
1269 // only for wxEVT_MENU_OPEN/CLOSE
1270 wxMenu* GetMenu() const { return m_menu; }
1271
1272 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1273
1274private:
1275 int m_menuId;
1276 wxMenu* m_menu;
1277
1278 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
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
1288class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1289{
1290public:
1291 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1292 : wxEvent(winid, type),
1293 m_loggingOff(true),
1294 m_veto(false), // should be false by default
1295 m_canVeto(true) {}
1296
1297 wxCloseEvent(const wxCloseEvent & event)
1298 : wxEvent(event),
1299 m_loggingOff(event.m_loggingOff),
1300 m_veto(event.m_veto),
1301 m_canVeto(event.m_canVeto) {}
1302
1303 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
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 }
1313
1314 void Veto(bool veto = true)
1315 {
1316 // GetVeto() will return false anyhow...
1317 wxCHECK_RET( m_canVeto,
1318 wxT("call to Veto() ignored (can't veto this event)") );
1319
1320 m_veto = veto;
1321 }
1322 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1323 bool CanVeto() const { return m_canVeto; }
1324 bool GetVeto() const { return m_canVeto && m_veto; }
1325
1326 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1327
1328protected:
1329 bool m_loggingOff,
1330 m_veto,
1331 m_canVeto;
1332
1333private:
1334 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1335};
1336
1337/*
1338 wxEVT_SHOW
1339 */
1340
1341class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1342{
1343public:
1344 wxShowEvent(int winid = 0, bool show = false)
1345 : wxEvent(winid, wxEVT_SHOW)
1346 { m_show = show; }
1347 wxShowEvent(const wxShowEvent & event)
1348 : wxEvent(event)
1349 { m_show = event.m_show; }
1350
1351 void SetShow(bool show) { m_show = show; }
1352 bool GetShow() const { return m_show; }
1353
1354 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1355
1356protected:
1357 bool m_show;
1358
1359private:
1360 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1361};
1362
1363/*
1364 wxEVT_ICONIZE
1365 */
1366
1367class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1368{
1369public:
1370 wxIconizeEvent(int winid = 0, bool iconized = true)
1371 : wxEvent(winid, wxEVT_ICONIZE)
1372 { m_iconized = iconized; }
1373 wxIconizeEvent(const wxIconizeEvent & event)
1374 : wxEvent(event)
1375 { m_iconized = event.m_iconized; }
1376
1377 // return true if the frame was iconized, false if restored
1378 bool Iconized() const { return m_iconized; }
1379
1380 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1381
1382protected:
1383 bool m_iconized;
1384
1385private:
1386 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1387};
1388/*
1389 wxEVT_MAXIMIZE
1390 */
1391
1392class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1393{
1394public:
1395 wxMaximizeEvent(int winid = 0)
1396 : wxEvent(winid, wxEVT_MAXIMIZE)
1397 { }
1398
1399 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1400
1401private:
1402 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
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.
1414enum
1415{
1416 wxJOYSTICK1,
1417 wxJOYSTICK2
1418};
1419
1420// Which button is down?
1421enum
1422{
1423 wxJOY_BUTTON_ANY = -1,
1424 wxJOY_BUTTON1 = 1,
1425 wxJOY_BUTTON2 = 2,
1426 wxJOY_BUTTON3 = 4,
1427 wxJOY_BUTTON4 = 8
1428};
1429
1430class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1431{
1432protected:
1433 wxPoint m_pos;
1434 int m_zPosition;
1435 int m_buttonChange; // Which button changed?
1436 int m_buttonState; // Which buttons are down?
1437 int m_joyStick; // Which joystick?
1438
1439public:
1440 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1441 int state = 0,
1442 int joystick = wxJOYSTICK1,
1443 int change = 0)
1444 : wxEvent(0, type),
1445 m_pos(),
1446 m_zPosition(0),
1447 m_buttonChange(change),
1448 m_buttonState(state),
1449 m_joyStick(joystick)
1450 {
1451 }
1452 wxJoystickEvent(const wxJoystickEvent & event)
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)
1459 { }
1460
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) ||
1475 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1476
1477 // Was it a move event?
1478 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1479
1480 // Was it a zmove event?
1481 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1482
1483 // Was it a down event from button 1, 2, 3, 4 or any?
1484 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1485 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1486 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1487
1488 // Was it a up event from button 1, 2, 3 or any?
1489 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1490 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1491 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1492
1493 // Was the given button 1,2,3,4 or any in Down state?
1494 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
1495 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1496 ((m_buttonState & but) == but)); }
1497
1498 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1499
1500private:
1501 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1502};
1503
1504// Drop files event class
1505/*
1506 wxEVT_DROP_FILES
1507 */
1508
1509class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1510{
1511public:
1512 int m_noFiles;
1513 wxPoint m_pos;
1514 wxString* m_files;
1515
1516 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1517 int noFiles = 0,
1518 wxString *files = (wxString *) NULL)
1519 : wxEvent(0, type),
1520 m_noFiles(noFiles),
1521 m_pos(),
1522 m_files(files)
1523 { }
1524
1525 // we need a copy ctor to avoid deleting m_files pointer twice
1526 wxDropFilesEvent(const wxDropFilesEvent& other)
1527 : wxEvent(other),
1528 m_noFiles(other.m_noFiles),
1529 m_pos(other.m_pos),
1530 m_files(NULL)
1531 {
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
1544 wxPoint GetPosition() const { return m_pos; }
1545 int GetNumberOfFiles() const { return m_noFiles; }
1546 wxString *GetFiles() const { return m_files; }
1547
1548 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1549
1550private:
1551 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1552};
1553
1554// Update UI event
1555/*
1556 wxEVT_UPDATE_UI
1557 */
1558
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
1573class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1574{
1575public:
1576 wxUpdateUIEvent(wxWindowID commandId = 0)
1577 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1578 {
1579 m_checked =
1580 m_enabled =
1581 m_shown =
1582 m_setEnabled =
1583 m_setShown =
1584 m_setText =
1585 m_setChecked = false;
1586 }
1587 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1588 : wxCommandEvent(event),
1589 m_checked(event.m_checked),
1590 m_enabled(event.m_enabled),
1591 m_shown(event.m_shown),
1592 m_setEnabled(event.m_setEnabled),
1593 m_setShown(event.m_setShown),
1594 m_setText(event.m_setText),
1595 m_setChecked(event.m_setChecked),
1596 m_text(event.m_text)
1597 { }
1598
1599 bool GetChecked() const { return m_checked; }
1600 bool GetEnabled() const { return m_enabled; }
1601 bool GetShown() const { return m_shown; }
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; }
1606 bool GetSetShown() const { return m_setShown; }
1607
1608 void Check(bool check) { m_checked = check; m_setChecked = true; }
1609 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1610 void Show(bool show) { m_shown = show; m_setShown = true; }
1611 void SetText(const wxString& text) { m_text = text; m_setText = true; }
1612
1613 // Sets the interval between updates in milliseconds.
1614 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1615 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1616
1617 // Returns the current interval between updates in milliseconds
1618 static long GetUpdateInterval() { return sm_updateInterval; }
1619
1620 // Can we update this window?
1621 static bool CanUpdate(wxWindowBase *win);
1622
1623 // Reset the update time to provide a delay until the next
1624 // time we should update
1625 static void ResetUpdateTime();
1626
1627 // Specify how wxWidgets will send update events: to
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
1633 static wxUpdateUIMode GetMode() { return sm_updateMode; }
1634
1635 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
1636
1637protected:
1638 bool m_checked;
1639 bool m_enabled;
1640 bool m_shown;
1641 bool m_setEnabled;
1642 bool m_setShown;
1643 bool m_setText;
1644 bool m_setChecked;
1645 wxString m_text;
1646#if wxUSE_LONGLONG
1647 static wxLongLong sm_lastUpdate;
1648#endif
1649 static long sm_updateInterval;
1650 static wxUpdateUIMode sm_updateMode;
1651
1652private:
1653 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
1654};
1655
1656/*
1657 wxEVT_SYS_COLOUR_CHANGED
1658 */
1659
1660// TODO: shouldn't all events record the window ID?
1661class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
1662{
1663public:
1664 wxSysColourChangedEvent()
1665 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1666 { }
1667
1668 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
1669
1670private:
1671 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
1672};
1673
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
1680class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
1681{
1682public:
1683 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1684 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
1685 m_gainedCapture(gainedCapture)
1686 { }
1687
1688 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
1689 : wxEvent(event),
1690 m_gainedCapture(event.m_gainedCapture)
1691 { }
1692
1693 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1694
1695 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
1696
1697private:
1698 wxWindow* m_gainedCapture;
1699
1700 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
1701};
1702
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
1726/*
1727 wxEVT_DISPLAY_CHANGED
1728 */
1729class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
1730{
1731private:
1732 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
1733
1734public:
1735 wxDisplayChangedEvent()
1736 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1737 { }
1738
1739 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1740};
1741
1742/*
1743 wxEVT_PALETTE_CHANGED
1744 */
1745
1746class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
1747{
1748public:
1749 wxPaletteChangedEvent(wxWindowID winid = 0)
1750 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
1751 m_changedWindow((wxWindow *) NULL)
1752 { }
1753
1754 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
1755 : wxEvent(event),
1756 m_changedWindow(event.m_changedWindow)
1757 { }
1758
1759 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1760 wxWindow* GetChangedWindow() const { return m_changedWindow; }
1761
1762 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
1763
1764protected:
1765 wxWindow* m_changedWindow;
1766
1767private:
1768 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
1769};
1770
1771/*
1772 wxEVT_QUERY_NEW_PALETTE
1773 Indicates the window is getting keyboard focus and should re-do its palette.
1774 */
1775
1776class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
1777{
1778public:
1779 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1780 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
1781 m_paletteRealized(false)
1782 { }
1783 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1784 : wxEvent(event),
1785 m_paletteRealized(event.m_paletteRealized)
1786 { }
1787
1788 // App sets this if it changes the palette.
1789 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1790 bool GetPaletteRealized() const { return m_paletteRealized; }
1791
1792 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
1793
1794protected:
1795 bool m_paletteRealized;
1796
1797private:
1798 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
1799};
1800
1801/*
1802 Event generated by dialog navigation keys
1803 wxEVT_NAVIGATION_KEY
1804 */
1805// NB: don't derive from command event to avoid being propagated to the parent
1806class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
1807{
1808public:
1809 wxNavigationKeyEvent()
1810 : wxEvent(0, wxEVT_NAVIGATION_KEY),
1811 m_flags(IsForward | FromTab), // defaults are for TAB
1812 m_focus((wxWindow *)NULL)
1813 {
1814 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1815 }
1816
1817 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
1818 : wxEvent(event),
1819 m_flags(event.m_flags),
1820 m_focus(event.m_focus)
1821 { }
1822
1823 // direction: forward (true) or backward (false)
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; }
1828
1829 // it may be a window change event (MDI, notebook pages...) or a control
1830 // change event
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
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
1843 // the child which has the focus currently (may be NULL - use
1844 // wxWindow::FindFocus then)
1845 wxWindow* GetCurrentFocus() const { return m_focus; }
1846 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1847
1848 // Set flags
1849 void SetFlags(long flags) { m_flags = flags; }
1850
1851 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1852
1853 enum
1854 {
1855 IsBackward = 0x0000,
1856 IsForward = 0x0001,
1857 WinChange = 0x0002,
1858 FromTab = 0x0004
1859 };
1860
1861 long m_flags;
1862 wxWindow *m_focus;
1863
1864private:
1865 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
1866};
1867
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
1878class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
1879{
1880public:
1881 wxWindowCreateEvent(wxWindow *win = NULL);
1882
1883 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1884
1885 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
1886
1887private:
1888 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
1889};
1890
1891class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
1892{
1893public:
1894 wxWindowDestroyEvent(wxWindow *win = NULL);
1895
1896 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1897
1898 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1899
1900private:
1901 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
1902};
1903
1904// A help event is sent when the user clicks on a window in context-help mode.
1905/*
1906 wxEVT_HELP
1907 wxEVT_DETAILED_HELP
1908*/
1909
1910class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
1911{
1912public:
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
1921 wxHelpEvent(wxEventType type = wxEVT_NULL,
1922 wxWindowID winid = 0,
1923 const wxPoint& pt = wxDefaultPosition,
1924 Origin origin = Origin_Unknown)
1925 : wxCommandEvent(type, winid),
1926 m_pos(pt),
1927 m_origin(GuessOrigin(origin))
1928 { }
1929 wxHelpEvent(const wxHelpEvent & event)
1930 : wxCommandEvent(event),
1931 m_pos(event.m_pos),
1932 m_target(event.m_target),
1933 m_link(event.m_link),
1934 m_origin(event.m_origin)
1935 { }
1936
1937 // Position of event (in screen coordinates)
1938 const wxPoint& GetPosition() const { return m_pos; }
1939 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1940
1941 // Optional link to further help
1942 const wxString& GetLink() const { return m_link; }
1943 void SetLink(const wxString& link) { m_link = link; }
1944
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; }
1948
1949 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
1950
1951 // optional indication of the event source
1952 Origin GetOrigin() const { return m_origin; }
1953 void SetOrigin(Origin origin) { m_origin = origin; }
1954
1955protected:
1956 wxPoint m_pos;
1957 wxString m_target;
1958 wxString m_link;
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);
1964
1965private:
1966 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
1967};
1968
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
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
2005class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2006{
2007public:
2008 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2009 wxWindowID winid = 0,
2010 const wxPoint& pt = wxDefaultPosition)
2011 : wxCommandEvent(type, winid),
2012 m_pos(pt)
2013 { }
2014 wxContextMenuEvent(const wxContextMenuEvent & event)
2015 : wxCommandEvent(event),
2016 m_pos(event.m_pos)
2017 { }
2018
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
2023 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2024
2025protected:
2026 wxPoint m_pos;
2027
2028private:
2029 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2030};
2031
2032#endif // wxUSE_GUI
2033
2034// Idle event
2035/*
2036 wxEVT_IDLE
2037 */
2038
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
2053class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2054{
2055public:
2056 wxIdleEvent()
2057 : wxEvent(0, wxEVT_IDLE),
2058 m_requestMore(false)
2059 { }
2060 wxIdleEvent(const wxIdleEvent & event)
2061 : wxEvent(event),
2062 m_requestMore(event.m_requestMore)
2063 { }
2064
2065 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2066 bool MoreRequested() const { return m_requestMore; }
2067
2068 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2069
2070 // Specify how wxWidgets will send idle events: to
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
2076 static wxIdleMode GetMode() { return sm_idleMode; }
2077
2078protected:
2079 bool m_requestMore;
2080 static wxIdleMode sm_idleMode;
2081
2082private:
2083 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2084};
2085
2086/* TODO
2087 wxEVT_MOUSE_CAPTURE_CHANGED,
2088 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
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
2096
2097// ============================================================================
2098// event handler and related classes
2099// ============================================================================
2100
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&);
2105
2106// struct containing the members common to static and dynamic event tables
2107// entries
2108struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2109{
2110private:
2111 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
2112
2113public:
2114 wxEventTableEntryBase(int winid, int idLast,
2115 wxObjectEventFunction fn, wxObject *data)
2116 : m_id(winid),
2117 m_lastId(idLast),
2118 m_fn(fn),
2119 m_callbackUserData(data)
2120 { }
2121
2122 wxEventTableEntryBase(const wxEventTableEntryBase& event)
2123 : m_id(event.m_id),
2124 m_lastId(event.m_lastId),
2125 m_fn(event.m_fn),
2126 m_callbackUserData(event.m_callbackUserData)
2127 { }
2128
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;
2133
2134 // function to call: not wxEventFunction, because of dependency problems
2135 wxObjectEventFunction m_fn;
2136
2137 // arbitrary user data asosciated with the callback
2138 wxObject* m_callbackUserData;
2139};
2140
2141// an entry from a static event table
2142struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2143{
2144 wxEventTableEntry(const int& evType, int winid, int idLast,
2145 wxObjectEventFunction fn, wxObject *data)
2146 : wxEventTableEntryBase(winid, idLast, fn, data),
2147 m_eventType(evType)
2148 { }
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;
2157
2158private:
2159 wxEventTableEntry& operator=(const wxEventTableEntry&);
2160};
2161
2162// an entry used in dynamic event table managed by wxEvtHandler::Connect()
2163struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2164{
2165 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2166 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
2167 : wxEventTableEntryBase(winid, idLast, fn, data),
2168 m_eventType(evType),
2169 m_eventSink(eventSink)
2170 { }
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;
2176
2177 // Pointer to object whose function is fn - so we don't assume the
2178 // EventFunction is always a member of the EventHandler receiving the
2179 // message
2180 wxEvtHandler* m_eventSink;
2181
2182 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
2183};
2184
2185// ----------------------------------------------------------------------------
2186// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2187// ----------------------------------------------------------------------------
2188
2189struct WXDLLIMPEXP_BASE wxEventTable
2190{
2191 const wxEventTable *baseTable; // base event table (next in chain)
2192 const wxEventTableEntry *entries; // bottom of entry array
2193};
2194
2195// ----------------------------------------------------------------------------
2196// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2197// ----------------------------------------------------------------------------
2198
2199WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
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.
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
2216 // will gets initialized when handling the first event look-up request.
2217 wxEventHashTable(const wxEventTable &table);
2218 // Destructor.
2219 ~wxEventHashTable();
2220
2221 // Handle the given event, in other words search the event table hash
2222 // and call self->ProcessEvent() if a match was found.
2223 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2224
2225 // Clear table
2226 void Clear();
2227
2228#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2229 // Clear all tables
2230 static void ClearAll();
2231#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2232
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);
2240 // Grow the hash table in size and transfer all items currently
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;
2250
2251 static wxEventHashTable* sm_first;
2252 wxEventHashTable* m_previous;
2253 wxEventHashTable* m_next;
2254
2255 DECLARE_NO_COPY_CLASS(wxEventHashTable)
2256};
2257
2258// ----------------------------------------------------------------------------
2259// wxEvtHandler: the base class for all objects handling wxWidgets events
2260// ----------------------------------------------------------------------------
2261
2262class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2263 , public wxTrackable
2264{
2265public:
2266 wxEvtHandler();
2267 virtual ~wxEvtHandler();
2268
2269 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2270 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2271 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2272 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2273
2274 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2275 bool GetEvtHandlerEnabled() const { return m_enabled; }
2276
2277 // Process an event right now: this can only be called from the main
2278 // thread, use QueueEvent() for scheduling the events for
2279 // processing from other threads.
2280 virtual bool ProcessEvent(wxEvent& event);
2281
2282 // Process an event by calling ProcessEvent and handling any exceptions
2283 // thrown by event handlers. It's mostly useful when processing wx events
2284 // when called from C code (e.g. in GTK+ callback) when the exception
2285 // wouldn't correctly propagate to wxEventLoop.
2286 bool SafelyProcessEvent(wxEvent& event);
2287
2288 // Schedule the given event to be processed later. It takes ownership of
2289 // the event pointer, i.e. it will be deleted later. This is safe to call
2290 // from multiple threads although you still need to ensure that wxString
2291 // fields of the event object are deep copies and not use the same string
2292 // buffer as other wxString objects in this thread.
2293 virtual void QueueEvent(wxEvent *event);
2294
2295 // Add an event to be processed later: notice that this function is not
2296 // safe to call from threads other than main, use QueueEvent()
2297 virtual void AddPendingEvent(const wxEvent& event)
2298 {
2299 // notice that the thread-safety problem comes from the fact that
2300 // Clone() doesn't make deep copies of wxString fields of wxEvent
2301 // object and so the same wxString could be used from both threads when
2302 // the event object is destroyed in this one -- QueueEvent() avoids
2303 // this problem as the event pointer is not used any more in this
2304 // thread at all after it is called.
2305 QueueEvent(event.Clone());
2306 }
2307
2308 void ProcessPendingEvents();
2309
2310#if wxUSE_THREADS
2311 bool ProcessThreadEvent(const wxEvent& event);
2312#endif
2313
2314 // Dynamic association of a member function handler with the event handler,
2315 // winid and event type
2316 void Connect(int winid,
2317 int lastId,
2318 int eventType,
2319 wxObjectEventFunction func,
2320 wxObject *userData = (wxObject *) NULL,
2321 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2322
2323 // Convenience function: take just one id
2324 void Connect(int winid,
2325 int eventType,
2326 wxObjectEventFunction func,
2327 wxObject *userData = (wxObject *) NULL,
2328 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2329 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2330
2331 // Even more convenient: without id (same as using id of wxID_ANY)
2332 void Connect(int eventType,
2333 wxObjectEventFunction func,
2334 wxObject *userData = (wxObject *) NULL,
2335 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2336 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2337
2338 bool Disconnect(int winid,
2339 int lastId,
2340 wxEventType eventType,
2341 wxObjectEventFunction func = NULL,
2342 wxObject *userData = (wxObject *) NULL,
2343 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2344
2345 bool Disconnect(int winid = wxID_ANY,
2346 wxEventType eventType = wxEVT_NULL,
2347 wxObjectEventFunction func = NULL,
2348 wxObject *userData = (wxObject *) NULL,
2349 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2350 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2351
2352 bool Disconnect(wxEventType eventType,
2353 wxObjectEventFunction func,
2354 wxObject *userData = (wxObject *) NULL,
2355 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2356 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2357
2358 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
2359
2360 // User data can be associated with each wxEvtHandler
2361 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2362 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2363
2364 void SetClientData( void *data ) { DoSetClientData(data); }
2365 void *GetClientData() const { return DoGetClientData(); }
2366
2367 // check if the given event table entry matches this event and call the
2368 // handler if it does
2369 //
2370 // return true if the event was processed, false otherwise (no match or the
2371 // handler decided to skip the event)
2372 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2373 wxEvtHandler *handler,
2374 wxEvent& event);
2375
2376 // implementation from now on
2377 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2378 bool SearchDynamicEventTable( wxEvent& event );
2379
2380 // Avoid problems at exit by cleaning up static hash table gracefully
2381 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2382 void OnSinkDestroyed( wxEvtHandler *sink );
2383
2384private:
2385 static const wxEventTableEntry sm_eventTableEntries[];
2386
2387protected:
2388 // hooks for wxWindow used by ProcessEvent()
2389 // -----------------------------------------
2390
2391 // This one is called before trying our own event table to allow plugging
2392 // in the validators.
2393 //
2394 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2395 // It is part of wxBase which doesn't use validators and the code
2396 // is compiled out when building wxBase w/o GUI classes, which affects
2397 // binary compatibility and wxBase library can't be used by GUI
2398 // ports.
2399 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
2400
2401 // this one is called after failing to find the event handle in our own
2402 // table to give a chance to the other windows to process it
2403 //
2404 // base class implementation passes the event to wxTheApp
2405 virtual bool TryParent(wxEvent& event);
2406
2407
2408 static const wxEventTable sm_eventTable;
2409 virtual const wxEventTable *GetEventTable() const;
2410
2411 static wxEventHashTable sm_eventHashTable;
2412 virtual wxEventHashTable& GetEventHashTable() const;
2413
2414 wxEvtHandler* m_nextHandler;
2415 wxEvtHandler* m_previousHandler;
2416 wxList* m_dynamicEvents;
2417 wxList* m_pendingEvents;
2418
2419#if wxUSE_THREADS
2420 // critical section protecting m_pendingEvents
2421 wxCriticalSection m_pendingEventsLock;
2422#endif // wxUSE_THREADS
2423
2424 // Is event handler enabled?
2425 bool m_enabled;
2426
2427
2428 // The user data: either an object which will be deleted by the container
2429 // when it's deleted or some raw pointer which we do nothing with - only
2430 // one type of data can be used with the given window (i.e. you cannot set
2431 // the void data and then associate the container with wxClientData or vice
2432 // versa)
2433 union
2434 {
2435 wxClientData *m_clientObject;
2436 void *m_clientData;
2437 };
2438
2439 // what kind of data do we have?
2440 wxClientDataType m_clientDataType;
2441
2442 // client data accessors
2443 virtual void DoSetClientObject( wxClientData *data );
2444 virtual wxClientData *DoGetClientObject() const;
2445
2446 virtual void DoSetClientData( void *data );
2447 virtual void *DoGetClientData() const;
2448
2449 // Search tracker objects for event connection with this sink
2450 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
2451
2452private:
2453 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
2454};
2455
2456// ----------------------------------------------------------------------------
2457// wxEventConnectionRef represents all connections between two event handlers
2458// and enables automatic disconnect when an event handler sink goes out of
2459// scope. Each connection/disconnect increases/decreases ref count, and
2460// when it reaches zero the node goes out of scope.
2461// ----------------------------------------------------------------------------
2462
2463class wxEventConnectionRef : public wxTrackerNode
2464{
2465public:
2466 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
2467 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
2468 : m_src(src), m_sink(sink), m_refCount(1)
2469 {
2470 m_sink->AddNode(this);
2471 }
2472
2473 // The sink is being destroyed
2474 virtual void OnObjectDestroy( )
2475 {
2476 if ( m_src )
2477 m_src->OnSinkDestroyed( m_sink );
2478 delete this;
2479 }
2480
2481 virtual wxEventConnectionRef *ToEventConnection() { return this; }
2482
2483 void IncRef() { m_refCount++; }
2484 void DecRef()
2485 {
2486 if ( !--m_refCount )
2487 {
2488 // The sink holds the only external pointer to this object
2489 if ( m_sink )
2490 m_sink->RemoveNode(this);
2491 delete this;
2492 }
2493 }
2494
2495private:
2496 wxEvtHandler *m_src,
2497 *m_sink;
2498 int m_refCount;
2499
2500 friend class wxEvtHandler;
2501
2502 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef)
2503};
2504
2505// Post a message to the given event handler which will be processed during the
2506// next event loop iteration.
2507//
2508// Notice that this one is not thread-safe, use wxQueueEvent()
2509inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
2510{
2511 wxCHECK_RET( dest, "need an object to post event to" );
2512
2513 dest->AddPendingEvent(event);
2514}
2515
2516// Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
2517// processing, unlike wxPostEvent it is safe to use from different thread even
2518// for events with wxString members
2519inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
2520{
2521 wxCHECK_RET( dest, "need an object to queue event for" );
2522
2523 dest->QueueEvent(event);
2524}
2525
2526typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2527typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2528
2529#define wxEventHandler(func) \
2530 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2531#define wxIdleEventHandler(func) \
2532 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
2533
2534#if wxUSE_GUI
2535
2536// ----------------------------------------------------------------------------
2537// wxEventBlocker: helper class to temporarily disable event handling for a window
2538// ----------------------------------------------------------------------------
2539
2540class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
2541{
2542public:
2543 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2544 virtual ~wxEventBlocker();
2545
2546 void Block(wxEventType type)
2547 {
2548 m_eventsToBlock.push_back(type);
2549 }
2550
2551 virtual bool ProcessEvent(wxEvent& event);
2552
2553protected:
2554 wxArrayInt m_eventsToBlock;
2555 wxWindow *m_window;
2556
2557 DECLARE_NO_COPY_CLASS(wxEventBlocker)
2558};
2559
2560typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2561typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
2562typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
2563typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2564typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2565typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
2566typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
2567typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2568typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2569typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2570typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
2571typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
2572typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2573typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2574typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2575typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2576typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
2577typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2578typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
2579typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2580typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2581typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
2582typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
2583typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
2584typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
2585typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2586typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
2587typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2588typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2589typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
2590typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
2591typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
2592typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
2593typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
2594typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
2595typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
2596
2597
2598#define wxCommandEventHandler(func) \
2599 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
2600#define wxScrollEventHandler(func) \
2601 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
2602#define wxScrollWinEventHandler(func) \
2603 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
2604#define wxSizeEventHandler(func) \
2605 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
2606#define wxMoveEventHandler(func) \
2607 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
2608#define wxPaintEventHandler(func) \
2609 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
2610#define wxNcPaintEventHandler(func) \
2611 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
2612#define wxEraseEventHandler(func) \
2613 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
2614#define wxMouseEventHandler(func) \
2615 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
2616#define wxCharEventHandler(func) \
2617 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
2618#define wxKeyEventHandler(func) wxCharEventHandler(func)
2619#define wxFocusEventHandler(func) \
2620 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
2621#define wxChildFocusEventHandler(func) \
2622 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
2623#define wxActivateEventHandler(func) \
2624 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
2625#define wxMenuEventHandler(func) \
2626 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
2627#define wxJoystickEventHandler(func) \
2628 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
2629#define wxDropFilesEventHandler(func) \
2630 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
2631#define wxInitDialogEventHandler(func) \
2632 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
2633#define wxSysColourChangedEventHandler(func) \
2634 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
2635#define wxDisplayChangedEventHandler(func) \
2636 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
2637#define wxUpdateUIEventHandler(func) \
2638 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
2639#define wxCloseEventHandler(func) \
2640 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
2641#define wxShowEventHandler(func) \
2642 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
2643#define wxIconizeEventHandler(func) \
2644 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
2645#define wxMaximizeEventHandler(func) \
2646 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
2647#define wxNavigationKeyEventHandler(func) \
2648 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
2649#define wxPaletteChangedEventHandler(func) \
2650 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
2651#define wxQueryNewPaletteEventHandler(func) \
2652 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
2653#define wxWindowCreateEventHandler(func) \
2654 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
2655#define wxWindowDestroyEventHandler(func) \
2656 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
2657#define wxSetCursorEventHandler(func) \
2658 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
2659#define wxNotifyEventHandler(func) \
2660 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
2661#define wxHelpEventHandler(func) \
2662 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
2663#define wxContextMenuEventHandler(func) \
2664 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
2665#define wxMouseCaptureChangedEventHandler(func) \
2666 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
2667#define wxMouseCaptureLostEventHandler(func) \
2668 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
2669#define wxClipboardTextEventHandler(func) \
2670 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
2671
2672#endif // wxUSE_GUI
2673
2674// N.B. In GNU-WIN32, you *have* to take the address of a member function
2675// (use &) or the compiler crashes...
2676
2677#define DECLARE_EVENT_TABLE() \
2678 private: \
2679 static const wxEventTableEntry sm_eventTableEntries[]; \
2680 protected: \
2681 static const wxEventTable sm_eventTable; \
2682 virtual const wxEventTable* GetEventTable() const; \
2683 static wxEventHashTable sm_eventHashTable; \
2684 virtual wxEventHashTable& GetEventHashTable() const;
2685
2686// N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2687// sm_eventTable before using it in GetEventTable() or the compiler gives
2688// E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
2689
2690#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2691 const wxEventTable theClass::sm_eventTable = \
2692 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
2693 const wxEventTable *theClass::GetEventTable() const \
2694 { return &theClass::sm_eventTable; } \
2695 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2696 wxEventHashTable &theClass::GetEventHashTable() const \
2697 { return theClass::sm_eventHashTable; } \
2698 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
2699
2700#define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2701 template<typename T1> \
2702 const wxEventTable theClass<T1>::sm_eventTable = \
2703 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2704 template<typename T1> \
2705 const wxEventTable *theClass<T1>::GetEventTable() const \
2706 { return &theClass<T1>::sm_eventTable; } \
2707 template<typename T1> \
2708 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2709 template<typename T1> \
2710 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2711 { return theClass<T1>::sm_eventHashTable; } \
2712 template<typename T1> \
2713 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2714
2715#define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2716 template<typename T1, typename T2> \
2717 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2718 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2719 template<typename T1, typename T2> \
2720 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2721 { return &theClass<T1, T2>::sm_eventTable; } \
2722 template<typename T1, typename T2> \
2723 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2724 template<typename T1, typename T2> \
2725 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2726 { return theClass<T1, T2>::sm_eventHashTable; } \
2727 template<typename T1, typename T2> \
2728 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2729
2730#define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2731 template<typename T1, typename T2, typename T3> \
2732 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2733 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2734 template<typename T1, typename T2, typename T3> \
2735 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2736 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2737 template<typename T1, typename T2, typename T3> \
2738 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2739 template<typename T1, typename T2, typename T3> \
2740 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2741 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2742 template<typename T1, typename T2, typename T3> \
2743 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2744
2745#define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2746 template<typename T1, typename T2, typename T3, typename T4> \
2747 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2748 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2749 template<typename T1, typename T2, typename T3, typename T4> \
2750 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2751 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2752 template<typename T1, typename T2, typename T3, typename T4> \
2753 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2754 template<typename T1, typename T2, typename T3, typename T4> \
2755 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2756 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2757 template<typename T1, typename T2, typename T3, typename T4> \
2758 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2759
2760#define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2761 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2762 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2763 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2764 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2765 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2766 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2767 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2768 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2769 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2770 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2771 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2772 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2773 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2774
2775#define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2776 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2777 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2778 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2779 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2780 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2781 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2782 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2783 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2784 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2785 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2786 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2787 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2788 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2789
2790#define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2791 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2792 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2793 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2794 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2795 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2796 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2797 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2798 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2799 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2800 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2801 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2802 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2803 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2804
2805#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2806
2807/*
2808 * Event table macros
2809 */
2810
2811// helpers for writing shorter code below: declare an event macro taking 2, 1
2812// or none ids (the missing ids default to wxID_ANY)
2813//
2814// macro arguments:
2815// - evt one of wxEVT_XXX constants
2816// - id1, id2 ids of the first/last id
2817// - fn the function (should be cast to the right type)
2818#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2819 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2820#define wx__DECLARE_EVT1(evt, id, fn) \
2821 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2822#define wx__DECLARE_EVT0(evt, fn) \
2823 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2824
2825
2826// Generic events
2827#define EVT_CUSTOM(event, winid, func) \
2828 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2829#define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2830 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
2831
2832// EVT_COMMAND
2833#define EVT_COMMAND(winid, event, func) \
2834 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
2835#define EVT_COMMAND_RANGE(id1, id2, event, func) \
2836 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
2837
2838#define EVT_NOTIFY(event, winid, func) \
2839 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2840#define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2841 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
2842
2843// Miscellaneous
2844#define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2845#define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2846#define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2847#define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2848#define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
2849#define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
2850#define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2851#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2852#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2853#define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2854#define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2855#define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2856#define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2857#define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2858#define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
2859#if wxUSE_HOTKEY
2860#define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
2861#endif
2862#define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2863#define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2864#define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2865#define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2866#define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2867#define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2868#define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2869#define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2870#define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2871#define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
2872#define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
2873#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2874#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2875#define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2876#define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2877#define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2878#define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2879#define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2880#define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2881#define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2882#define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2883#define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2884#define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2885#define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2886#define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2887#define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2888#define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
2889#define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
2890
2891// Mouse events
2892#define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2893#define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2894#define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2895#define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2896#define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2897#define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2898#define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2899#define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2900#define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2901#define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2902#define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2903#define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2904#define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
2905#define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
2906#define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
2907#define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
2908#define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
2909#define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
2910#define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
2911
2912// All mouse events
2913#define EVT_MOUSE_EVENTS(func) \
2914 EVT_LEFT_DOWN(func) \
2915 EVT_LEFT_UP(func) \
2916 EVT_LEFT_DCLICK(func) \
2917 EVT_MIDDLE_DOWN(func) \
2918 EVT_MIDDLE_UP(func) \
2919 EVT_MIDDLE_DCLICK(func) \
2920 EVT_RIGHT_DOWN(func) \
2921 EVT_RIGHT_UP(func) \
2922 EVT_RIGHT_DCLICK(func) \
2923 EVT_MOUSE_AUX1_DOWN(func) \
2924 EVT_MOUSE_AUX1_UP(func) \
2925 EVT_MOUSE_AUX1_DCLICK(func) \
2926 EVT_MOUSE_AUX2_DOWN(func) \
2927 EVT_MOUSE_AUX2_UP(func) \
2928 EVT_MOUSE_AUX2_DCLICK(func) \
2929 EVT_MOTION(func) \
2930 EVT_LEAVE_WINDOW(func) \
2931 EVT_ENTER_WINDOW(func) \
2932 EVT_MOUSEWHEEL(func)
2933
2934// Scrolling from wxWindow (sent to wxScrolledWindow)
2935#define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2936#define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2937#define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2938#define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2939#define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2940#define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2941#define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2942#define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2943
2944#define EVT_SCROLLWIN(func) \
2945 EVT_SCROLLWIN_TOP(func) \
2946 EVT_SCROLLWIN_BOTTOM(func) \
2947 EVT_SCROLLWIN_LINEUP(func) \
2948 EVT_SCROLLWIN_LINEDOWN(func) \
2949 EVT_SCROLLWIN_PAGEUP(func) \
2950 EVT_SCROLLWIN_PAGEDOWN(func) \
2951 EVT_SCROLLWIN_THUMBTRACK(func) \
2952 EVT_SCROLLWIN_THUMBRELEASE(func)
2953
2954// Scrolling from wxSlider and wxScrollBar
2955#define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2956#define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2957#define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2958#define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2959#define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2960#define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2961#define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2962#define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
2963#define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
2964
2965#define EVT_SCROLL(func) \
2966 EVT_SCROLL_TOP(func) \
2967 EVT_SCROLL_BOTTOM(func) \
2968 EVT_SCROLL_LINEUP(func) \
2969 EVT_SCROLL_LINEDOWN(func) \
2970 EVT_SCROLL_PAGEUP(func) \
2971 EVT_SCROLL_PAGEDOWN(func) \
2972 EVT_SCROLL_THUMBTRACK(func) \
2973 EVT_SCROLL_THUMBRELEASE(func) \
2974 EVT_SCROLL_CHANGED(func)
2975
2976// Scrolling from wxSlider and wxScrollBar, with an id
2977#define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2978#define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2979#define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2980#define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2981#define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2982#define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2983#define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2984#define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
2985#define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
2986
2987#define EVT_COMMAND_SCROLL(winid, func) \
2988 EVT_COMMAND_SCROLL_TOP(winid, func) \
2989 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2990 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
2991 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
2992 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
2993 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
2994 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
2995 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
2996 EVT_COMMAND_SCROLL_CHANGED(winid, func)
2997
2998#if WXWIN_COMPATIBILITY_2_6
2999 // compatibility macros for the old name, deprecated in 2.8
3000 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3001 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3002 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3003#endif // WXWIN_COMPATIBILITY_2_6
3004
3005// Convenience macros for commonly-used commands
3006#define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3007#define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3008#define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3009#define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3010#define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3011#define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3012#if defined(__SMARTPHONE__)
3013# define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3014#else
3015# define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3016#endif
3017#define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3018#define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3019#define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3020// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3021#define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3022#define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3023#define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3024#define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3025#define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3026#define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3027#define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3028#define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3029#define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3030#define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3031
3032// Generic command events
3033#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3034#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3035#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3036#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3037#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3038#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3039#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3040
3041// Joystick events
3042
3043#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3044#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3045#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3046#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3047
3048// All joystick events
3049#define EVT_JOYSTICK_EVENTS(func) \
3050 EVT_JOY_BUTTON_DOWN(func) \
3051 EVT_JOY_BUTTON_UP(func) \
3052 EVT_JOY_MOVE(func) \
3053 EVT_JOY_ZMOVE(func)
3054
3055// Idle event
3056#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3057
3058// Update UI event
3059#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3060#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3061
3062// Help events
3063#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3064#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3065#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3066#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3067
3068// Context Menu Events
3069#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3070#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3071
3072// Clipboard text Events
3073#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3074#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3075#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3076
3077// ----------------------------------------------------------------------------
3078// Global data
3079// ----------------------------------------------------------------------------
3080
3081// list containing event handlers with pending events for them
3082//
3083// notice that each event handler should occur at most once in this list
3084extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
3085#if wxUSE_THREADS
3086 extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
3087#endif
3088
3089// ----------------------------------------------------------------------------
3090// Helper functions
3091// ----------------------------------------------------------------------------
3092
3093#if wxUSE_GUI
3094
3095// Find a window with the focus, that is also a descendant of the given window.
3096// This is used to determine the window to initially send commands to.
3097WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3098
3099#endif // wxUSE_GUI
3100
3101#endif // _WX_EVENT_H_