]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
Moved the cleanup code to an EVT_WINDOW_DESTROY handler.
[wxWidgets.git] / include / wx / event.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
bd83cb56 2// Name: wx/event.h
c801d85f
KB
3// Purpose: Event classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
bd83cb56 8// Copyright: (c) wxWindows team
2b854a32 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_EVENTH__
13#define _WX_EVENTH__
c801d85f
KB
14
15#ifdef __GNUG__
2b854a32 16 #pragma interface "event.h"
c801d85f
KB
17#endif
18
19#include "wx/defs.h"
20#include "wx/object.h"
88a9f974 21#include "wx/clntdata.h"
e90c1d2a
VZ
22
23#if wxUSE_GUI
24 #include "wx/gdicmn.h"
43b5058d 25 #include "wx/cursor.h"
e90c1d2a 26#endif
42e69d6b 27
72cdf4c9 28#include "wx/thread.h"
c801d85f 29
e90c1d2a
VZ
30// ----------------------------------------------------------------------------
31// forward declarations
32// ----------------------------------------------------------------------------
33
34class WXDLLEXPORT wxList;
35
36#if wxUSE_GUI
e90c1d2a
VZ
37 class WXDLLEXPORT wxDC;
38 class WXDLLEXPORT wxMenu;
73974df1 39 class WXDLLEXPORT wxWindow;
e90c1d2a
VZ
40#endif // wxUSE_GUI
41
42// ----------------------------------------------------------------------------
43// Event types
44// ----------------------------------------------------------------------------
64693098 45
cbee8f8d
VZ
46typedef int wxEventType;
47
48// in previous versions of wxWindows the event types used to be constants
49// which created difficulties with custom/user event types definition
50//
51// starting from wxWindows 2.4 the event types are now dynamically assigned
52// using wxNewEventType() which solves this problem, however at price of
53// several incompatibilities:
54//
55// a) event table macros declaration changed, it now uses wxEventTableEntry
56// ctor instead of initialisation from an agregate - the macro
57// DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
58// with all versions of wxWindows
59//
60// b) event types can't be used as switch() cases as they're not really
61// constant any more - there is no magic solution here, you just have to
62// change the switch()es to if()s
63//
64// if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
65// to get 100% old behaviour, however you won't be able to use the libraries
66// using the new dynamic event type allocation in such case, so avoid it if
67// possible.
68
69#if WXWIN_COMPATIBILITY_EVENT_TYPES
70
71#define DECLARE_EVENT_TABLE_ENTRY(type, id, idLast, fn, obj) \
72 { type, id, idLast, fn, obj }
73
2e4df4bf
VZ
74#define BEGIN_DECLARE_EVENT_TYPES() enum {
75#define END_DECLARE_EVENT_TYPES() };
cbee8f8d 76#define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
5527476f 77#define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
2e4df4bf 78#define DEFINE_EVENT_TYPE(name)
1a40c31e 79#define DEFINE_LOCAL_EVENT_TYPE(name)
cbee8f8d 80
5527476f 81
cbee8f8d
VZ
82#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
83
84#define DECLARE_EVENT_TABLE_ENTRY(type, id, idLast, fn, obj) \
85 wxEventTableEntry(type, id, idLast, fn, obj)
86
2e4df4bf
VZ
87#define BEGIN_DECLARE_EVENT_TYPES()
88#define END_DECLARE_EVENT_TYPES()
85664da6
VZ
89#define DECLARE_EVENT_TYPE(name, value) \
90 extern const wxEventType WXDLLEXPORT name;
5527476f 91#define DECLARE_LOCAL_EVENT_TYPE(name, value) extern const wxEventType name;
71499aaf 92#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
1a40c31e 93#define DEFINE_LOCAL_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
cbee8f8d
VZ
94
95// generate a new unique event type
96extern WXDLLEXPORT wxEventType wxNewEventType();
97
98#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
99
2e4df4bf
VZ
100BEGIN_DECLARE_EVENT_TYPES()
101
cbee8f8d 102#if WXWIN_COMPATIBILITY_EVENT_TYPES
cbee8f8d
VZ
103 wxEVT_NULL = 0,
104 wxEVT_FIRST = 10000,
2e4df4bf 105 wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
cbee8f8d 106#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
6164f93c
VZ
107 // it is important to still have these as constants to avoid
108 // initialization order related problems
c57e3339 109 DECLARE_EVENT_TYPE(wxEVT_NULL,0);
6164f93c
VZ
110 const wxEventType wxEVT_FIRST = 10000;
111 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
cbee8f8d
VZ
112#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
113
2e4df4bf
VZ
114 DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
115 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
116 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
117 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
118 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
119 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
ad0bae85
VZ
120 // now they are in wx/textctrl.h
121#if WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
122 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
123 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
ad0bae85 124 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
d7eee191 125 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
ad0bae85 126#endif // WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
127 DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
128 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
129 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
130 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
131
132 // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
133 // wxEVT_SCROLL... events
134
135 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
136 DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
137 DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
138 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
141
142 // Sockets and timers send events, too
143 DECLARE_EVENT_TYPE(wxEVT_SOCKET, 50)
144 DECLARE_EVENT_TYPE(wxEVT_TIMER , 80)
145
146 // Mouse event types
147 DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
148 DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
149 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
150 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
151 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
152 DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
153 DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
154 DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
155 DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
156 DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
157 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
158 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
159 DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
160 DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
456bc6d9
VZ
161 DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
162 DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
2e4df4bf
VZ
163
164 // Non-client mouse events
165 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
166 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
167 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
168 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
169 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
170 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
171 DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
172 DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
173 DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
174 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
175 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
176 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
177
178 // Character input event type
179 DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
180 DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
181 DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
182 DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
183 DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
184
185 // Set cursor event
186 DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
187
188 // wxScrollbar and wxSlider event identifiers
189 DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
190 DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
191 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
192 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
193 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
194 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
195 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
196 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
197
198 // Scroll events from wxWindow
199 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
200 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
201 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
202 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
203 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
204 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
205 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
206 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
207
208 // System events
209 DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
210 DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
211 DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
212 DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
213 DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
214 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
215 DECLARE_EVENT_TYPE(wxEVT_POWER, 406)
216 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
217 DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
218 DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
219 DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
220 DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
221 DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
222 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
223 DECLARE_EVENT_TYPE(wxEVT_PAINT, 416)
224 DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 417)
225 DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 418)
226 DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 419)
ccef86c7
VZ
227 DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 420)
228 DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 421)
2e4df4bf 229 DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 422)
ccef86c7 230 // DECLARE_EVENT_TYPE(wxEVT_POPUP_MENU_INIT, 423) -- free slot
2e4df4bf
VZ
231 DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
232 DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
574c939e
KB
233 DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
234 DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
235 DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
236 DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
237 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
238 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
239 DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
240 DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
241 DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
242 DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
243 DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
244 DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
245 DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
246 DECLARE_EVENT_TYPE(wxEVT_IDLE, 439)
247 DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
2e4df4bf
VZ
248
249 // Generic command events
250 // Note: a click is a higher-level event than button down/up
251 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
252 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
253 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
254 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
255 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
256 DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
257 DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
258
259 // Help events
260 DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
261 DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
262
263END_DECLARE_EVENT_TYPES()
96f6c703 264
cbee8f8d
VZ
265// these 2 events are the same
266#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
96f6c703 267
ad0bae85 268// ----------------------------------------------------------------------------
77d4384e 269// Compatibility
ad0bae85
VZ
270// ----------------------------------------------------------------------------
271
272// this event is also used by wxComboBox and wxSpinCtrl which don't include
273// wx/textctrl.h in all ports [yet], so declare it here as well
274//
275// still, any new code using it should include wx/textctrl.h explicitly
276#if !WXWIN_COMPATIBILITY_EVENT_TYPES
277 extern const wxEventType WXDLLEXPORT wxEVT_COMMAND_TEXT_UPDATED;
278#endif
c801d85f
KB
279
280#if WXWIN_COMPATIBILITY
281
282#define wxEVENT_TYPE_BUTTON_COMMAND wxEVT_COMMAND_BUTTON_CLICKED
283#define wxEVENT_TYPE_CHECKBOX_COMMAND wxEVT_COMMAND_CHECKBOX_CLICKED
284#define wxEVENT_TYPE_CHOICE_COMMAND wxEVT_COMMAND_CHOICE_SELECTED
285#define wxEVENT_TYPE_LISTBOX_COMMAND wxEVT_COMMAND_LISTBOX_SELECTED
286#define wxEVENT_TYPE_LISTBOX_DCLICK_COMMAND wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
287#define wxEVENT_TYPE_TEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
288#define wxEVENT_TYPE_MULTITEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
289#define wxEVENT_TYPE_MENU_COMMAND wxEVT_COMMAND_MENU_SELECTED
290#define wxEVENT_TYPE_SLIDER_COMMAND wxEVT_COMMAND_SLIDER_UPDATED
291#define wxEVENT_TYPE_RADIOBOX_COMMAND wxEVT_COMMAND_RADIOBOX_SELECTED
292#define wxEVENT_TYPE_RADIOBUTTON_COMMAND wxEVT_COMMAND_RADIOBUTTON_SELECTED
293#define wxEVENT_TYPE_TEXT_ENTER_COMMAND wxEVT_COMMAND_TEXT_ENTER
294#define wxEVENT_TYPE_SET_FOCUS wxEVT_SET_FOCUS
295#define wxEVENT_TYPE_KILL_FOCUS wxEVT_KILL_FOCUS
296#define wxEVENT_TYPE_SCROLLBAR_COMMAND wxEVT_COMMAND_SCROLLBAR_UPDATED
297#define wxEVENT_TYPE_VIRT_LISTBOX_COMMAND wxEVT_COMMAND_VLBOX_SELECTED
298#define wxEVENT_TYPE_COMBOBOX_COMMAND wxEVT_COMMAND_COMBOBOX_SELECTED
299
300#define wxEVENT_TYPE_LEFT_DOWN wxEVT_LEFT_DOWN
301#define wxEVENT_TYPE_LEFT_UP wxEVT_LEFT_UP
302#define wxEVENT_TYPE_MIDDLE_DOWN wxEVT_MIDDLE_DOWN
303#define wxEVENT_TYPE_MIDDLE_UP wxEVT_MIDDLE_UP
304#define wxEVENT_TYPE_RIGHT_DOWN wxEVT_RIGHT_DOWN
305#define wxEVENT_TYPE_RIGHT_UP wxEVT_RIGHT_UP
306#define wxEVENT_TYPE_MOTION wxEVT_MOTION
307#define wxEVENT_TYPE_ENTER_WINDOW wxEVT_ENTER_WINDOW
308#define wxEVENT_TYPE_LEAVE_WINDOW wxEVT_LEAVE_WINDOW
309#define wxEVENT_TYPE_LEFT_DCLICK wxEVT_LEFT_DCLICK
310#define wxEVENT_TYPE_MIDDLE_DCLICK wxEVT_MIDDLE_DCLICK
311#define wxEVENT_TYPE_RIGHT_DCLICK wxEVT_RIGHT_DCLICK
312#define wxEVENT_TYPE_CHAR wxEVT_CHAR
313#define wxEVENT_TYPE_SCROLL_TOP wxEVT_SCROLL_TOP
314#define wxEVENT_TYPE_SCROLL_BOTTOM wxEVT_SCROLL_BOTTOM
315#define wxEVENT_TYPE_SCROLL_LINEUP wxEVT_SCROLL_LINEUP
316#define wxEVENT_TYPE_SCROLL_LINEDOWN wxEVT_SCROLL_LINEDOWN
317#define wxEVENT_TYPE_SCROLL_PAGEUP wxEVT_SCROLL_PAGEUP
318#define wxEVENT_TYPE_SCROLL_PAGEDOWN wxEVT_SCROLL_PAGEDOWN
319#define wxEVENT_TYPE_SCROLL_THUMBTRACK wxEVT_SCROLL_THUMBTRACK
320
2b854a32 321#endif // WXWIN_COMPATIBILITY
c801d85f
KB
322
323/*
324 * wxWindows events, covering all interesting things that might happen
325 * (button clicking, resizing, setting text in widgets, etc.).
326 *
327 * For each completely new event type, derive a new event class.
328 * An event CLASS represents a C++ class defining a range of similar event TYPES;
329 * examples are canvas events, panel item command events.
330 * An event TYPE is a unique identifier for a particular system event,
331 * such as a button press or a listbox deselection.
332 *
333 */
334
2b854a32 335class WXDLLEXPORT wxEvent : public wxObject
c801d85f 336{
8e72b8b5
RR
337protected:
338 wxEvent(const wxEvent&); // for implementing Clone()
c801d85f
KB
339
340public:
8e72b8b5 341 wxEvent(int id = 0, wxEventType commandType = wxEVT_NULL );
2b854a32
VZ
342
343 void SetEventType(wxEventType typ) { m_eventType = typ; }
344 wxEventType GetEventType() const { return m_eventType; }
345 wxObject *GetEventObject() const { return m_eventObject; }
346 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
347 long GetTimestamp() const { return m_timeStamp; }
348 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
349 int GetId() const { return m_id; }
350 void SetId(int Id) { m_id = Id; }
351
352 // Can instruct event processor that we wish to ignore this event
353 // (treat as if the event table entry had not been found): this must be done
354 // to allow the event processing by the base classes (calling event.Skip()
355 // is the analog of calling the base class verstion of a virtual function)
356 void Skip(bool skip = TRUE) { m_skipped = skip; }
357 bool GetSkipped() const { return m_skipped; };
c801d85f 358
8e72b8b5
RR
359 // Implementation only: this test is explicitlty anti OO and this functions
360 // exists only for optimization purposes.
193bf013
VZ
361 bool IsCommandEvent() const { return m_isCommandEvent; }
362
acd15a3f
VZ
363 // this function is used to create a copy of the event polymorphically and
364 // all derived classes must implement it because otherwise wxPostEvent()
365 // for them wouldn't work (it needs to do a copy of the event)
366 virtual wxEvent *Clone() const = 0;
a737331d 367
c801d85f 368public:
2b854a32 369 wxObject* m_eventObject;
2b854a32
VZ
370 wxEventType m_eventType;
371 long m_timeStamp;
372 int m_id;
373 wxObject* m_callbackUserData;
42e69d6b 374 bool m_skipped;
193bf013 375 bool m_isCommandEvent;
8e72b8b5
RR
376
377private:
378 DECLARE_ABSTRACT_CLASS(wxEvent)
c801d85f
KB
379};
380
e90c1d2a
VZ
381#if wxUSE_GUI
382
c801d85f
KB
383// Item or menu event class
384/*
385 wxEVT_COMMAND_BUTTON_CLICKED
386 wxEVT_COMMAND_CHECKBOX_CLICKED
387 wxEVT_COMMAND_CHOICE_SELECTED
388 wxEVT_COMMAND_LISTBOX_SELECTED
389 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
390 wxEVT_COMMAND_TEXT_UPDATED
391 wxEVT_COMMAND_TEXT_ENTER
392 wxEVT_COMMAND_MENU_SELECTED
393 wxEVT_COMMAND_SLIDER_UPDATED
394 wxEVT_COMMAND_RADIOBOX_SELECTED
395 wxEVT_COMMAND_RADIOBUTTON_SELECTED
396 wxEVT_COMMAND_SCROLLBAR_UPDATED
397 wxEVT_COMMAND_VLBOX_SELECTED
398 wxEVT_COMMAND_COMBOBOX_SELECTED
1db8dc4a 399 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
c801d85f
KB
400*/
401
2b854a32 402class WXDLLEXPORT wxCommandEvent : public wxEvent
c801d85f 403{
2b854a32
VZ
404public:
405 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
c801d85f 406
2b854a32
VZ
407 // Set/Get client data from controls
408 void SetClientData(void* clientData) { m_clientData = clientData; }
409 void *GetClientData() const { return m_clientData; }
c801d85f 410
2b854a32
VZ
411 // Set/Get client object from controls
412 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
413 void *GetClientObject() const { return m_clientObject; }
f5e27805 414
2b854a32
VZ
415 // Get listbox selection if single-choice
416 int GetSelection() const { return m_commandInt; }
c801d85f 417
2b854a32 418 // Set/Get listbox/choice selection string
29006414 419 void SetString(const wxString& s) { m_commandString = s; }
7214297d 420 wxString GetString() const { return m_commandString; }
c801d85f 421
2b854a32 422 // Get checkbox value
3ca6a5f0 423 bool IsChecked() const { return m_commandInt != 0; }
c801d85f 424
2b854a32
VZ
425 // TRUE if the listbox event was a selection.
426 bool IsSelection() const { return (m_extraLong != 0); }
c801d85f 427
2b854a32
VZ
428 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
429 long GetExtraLong() const { return m_extraLong ; }
c801d85f 430
2b854a32
VZ
431 void SetInt(int i) { m_commandInt = i; }
432 long GetInt() const { return m_commandInt ; }
c801d85f 433
8e72b8b5 434 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
aadbdf11 435
0c394212 436#if WXWIN_COMPATIBILITY_2
3ca6a5f0
BP
437 bool Checked() const { return IsChecked(); }
438#endif // WXWIN_COMPATIBILITY_2
439
2b854a32 440public:
29006414 441 wxString m_commandString; // String event argument
2b854a32
VZ
442 int m_commandInt;
443 long m_extraLong; // Additional information (e.g. select/deselect)
444 void* m_clientData; // Arbitrary client data
445 wxClientData* m_clientObject; // Arbitrary client object
f97500b8 446
8e72b8b5
RR
447private:
448 DECLARE_DYNAMIC_CLASS(wxCommandEvent)
c801d85f
KB
449};
450
fd3f686c
VZ
451// this class adds a possibility to react (from the user) code to a control
452// notification: allow or veto the operation being reported.
2b854a32 453class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
454{
455public:
456 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
457 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
458
23f681ec 459 // veto the operation (usually it's allowed by default)
fd3f686c
VZ
460 void Veto() { m_bAllow = FALSE; }
461
23f681ec
VZ
462 // allow the operation if it was disabled by default
463 void Allow() { m_bAllow = TRUE; }
464
fd3f686c
VZ
465 // for implementation code only: is the operation allowed?
466 bool IsAllowed() const { return m_bAllow; }
467
8e72b8b5 468 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
924ef850 469
fd3f686c
VZ
470private:
471 bool m_bAllow;
472
8e72b8b5 473private:
92976ab6 474 DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
fd3f686c
VZ
475};
476
d1367c3d
RR
477// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
478// sent by wxSlider and wxScrollbar.
c801d85f
KB
479/*
480 wxEVT_SCROLL_TOP
481 wxEVT_SCROLL_BOTTOM
482 wxEVT_SCROLL_LINEUP
483 wxEVT_SCROLL_LINEDOWN
484 wxEVT_SCROLL_PAGEUP
485 wxEVT_SCROLL_PAGEDOWN
486 wxEVT_SCROLL_THUMBTRACK
7d56fb8f 487 wxEVT_SCROLL_THUMBRELEASE
c801d85f
KB
488*/
489
2b854a32 490class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
c801d85f 491{
2b854a32
VZ
492public:
493 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
494 int id = 0, int pos = 0, int orient = 0);
2b854a32
VZ
495
496 int GetOrientation() const { return (int) m_extraLong ; }
497 int GetPosition() const { return m_commandInt ; }
498 void SetOrientation(int orient) { m_extraLong = (long) orient; }
499 void SetPosition(int pos) { m_commandInt = pos; }
f97500b8 500
8e72b8b5 501 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
f97500b8 502
8e72b8b5
RR
503private:
504 DECLARE_DYNAMIC_CLASS(wxScrollEvent)
c801d85f
KB
505};
506
d1367c3d
RR
507// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
508// are sent by wxWindow.
509/*
510 wxEVT_SCROLLWIN_TOP
511 wxEVT_SCROLLWIN_BOTTOM
512 wxEVT_SCROLLWIN_LINEUP
513 wxEVT_SCROLLWIN_LINEDOWN
514 wxEVT_SCROLLWIN_PAGEUP
515 wxEVT_SCROLLWIN_PAGEDOWN
516 wxEVT_SCROLLWIN_THUMBTRACK
7d56fb8f 517 wxEVT_SCROLLWIN_THUMBRELEASE
d1367c3d
RR
518*/
519
520class WXDLLEXPORT wxScrollWinEvent : public wxEvent
521{
d1367c3d
RR
522public:
523 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
524 int pos = 0, int orient = 0);
d1367c3d
RR
525
526 int GetOrientation() const { return (int) m_extraLong ; }
527 int GetPosition() const { return m_commandInt ; }
528 void SetOrientation(int orient) { m_extraLong = (long) orient; }
529 void SetPosition(int pos) { m_commandInt = pos; }
530
8e72b8b5 531 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1e6feb95 532
d1367c3d 533public:
8e72b8b5 534 int m_commandInt;
20947e08 535 long m_extraLong;
1e6feb95 536
8e72b8b5 537private:
1e6feb95 538 DECLARE_DYNAMIC_CLASS(wxScrollWinEvent)
d1367c3d
RR
539};
540
c801d85f
KB
541// Mouse event class
542
543/*
544 wxEVT_LEFT_DOWN
545 wxEVT_LEFT_UP
546 wxEVT_MIDDLE_DOWN
547 wxEVT_MIDDLE_UP
548 wxEVT_RIGHT_DOWN
549 wxEVT_RIGHT_UP
550 wxEVT_MOTION
551 wxEVT_ENTER_WINDOW
552 wxEVT_LEAVE_WINDOW
553 wxEVT_LEFT_DCLICK
554 wxEVT_MIDDLE_DCLICK
555 wxEVT_RIGHT_DCLICK
556 wxEVT_NC_LEFT_DOWN
557 wxEVT_NC_LEFT_UP,
558 wxEVT_NC_MIDDLE_DOWN,
559 wxEVT_NC_MIDDLE_UP,
560 wxEVT_NC_RIGHT_DOWN,
561 wxEVT_NC_RIGHT_UP,
562 wxEVT_NC_MOTION,
563 wxEVT_NC_ENTER_WINDOW,
564 wxEVT_NC_LEAVE_WINDOW,
565 wxEVT_NC_LEFT_DCLICK,
566 wxEVT_NC_MIDDLE_DCLICK,
567 wxEVT_NC_RIGHT_DCLICK,
568*/
569
2b854a32 570class WXDLLEXPORT wxMouseEvent : public wxEvent
c801d85f 571{
2b854a32
VZ
572public:
573 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
c801d85f 574
2b854a32
VZ
575 // Was it a button event? (*doesn't* mean: is any button *down*?)
576 bool IsButton() const { return Button(-1); }
c801d85f 577
2b854a32
VZ
578 // Was it a down event from button 1, 2 or 3 or any?
579 bool ButtonDown(int but = -1) const;
c801d85f 580
2b854a32
VZ
581 // Was it a dclick event from button 1, 2 or 3 or any?
582 bool ButtonDClick(int but = -1) const;
c801d85f 583
2b854a32
VZ
584 // Was it a up event from button 1, 2 or 3 or any?
585 bool ButtonUp(int but = -1) const;
c801d85f 586
2b854a32
VZ
587 // Was the given button 1,2,3 or any changing state?
588 bool Button(int but) const;
c801d85f 589
2b854a32
VZ
590 // Was the given button 1,2,3 or any in Down state?
591 bool ButtonIsDown(int but) const;
c801d85f 592
1e6feb95
VZ
593 // Get the button which is changing state (-1 if none)
594 int GetButton() const;
595
2b854a32
VZ
596 // Find state of shift/control keys
597 bool ControlDown() const { return m_controlDown; }
598 bool MetaDown() const { return m_metaDown; }
599 bool AltDown() const { return m_altDown; }
600 bool ShiftDown() const { return m_shiftDown; }
c801d85f 601
2b854a32
VZ
602 // Find which event was just generated
603 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
604 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
605 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
c801d85f 606
2b854a32
VZ
607 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
608 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
609 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
c801d85f 610
2b854a32
VZ
611 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
612 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
613 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
c801d85f 614
2b854a32
VZ
615 // Find the current state of the mouse buttons (regardless
616 // of current event type)
617 bool LeftIsDown() const { return m_leftDown; }
618 bool MiddleIsDown() const { return m_middleDown; }
619 bool RightIsDown() const { return m_rightDown; }
c801d85f 620
2b854a32
VZ
621 // True if a button is down and the mouse is moving
622 bool Dragging() const
623 {
624 return ((m_eventType == wxEVT_MOTION) &&
625 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
626 }
c801d85f 627
2b854a32
VZ
628 // True if the mouse is moving, and no button is down
629 bool Moving() const { return (m_eventType == wxEVT_MOTION); }
c801d85f 630
2b854a32
VZ
631 // True if the mouse is just entering the window
632 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 633
2b854a32
VZ
634 // True if the mouse is just leaving the window
635 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 636
2b854a32 637 // Find the position of the event
20947e08 638 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
b02da6b1
VZ
639 {
640 if (xpos)
20947e08 641 *xpos = m_x;
b02da6b1
VZ
642 if (ypos)
643 *ypos = m_y;
644 }
645
0e528b99 646#ifndef __WIN16__
bf57d1ad 647 void GetPosition(long *xpos, long *ypos) const
b02da6b1
VZ
648 {
649 if (xpos)
20947e08 650 *xpos = (long)m_x;
b02da6b1 651 if (ypos)
bf57d1ad 652 *ypos = (long)m_y;
b02da6b1 653 }
0e528b99 654#endif
c801d85f 655
2b854a32
VZ
656 // Find the position of the event
657 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 658
2b854a32
VZ
659 // Find the logical position of the event given the DC
660 wxPoint GetLogicalPosition(const wxDC& dc) const ;
c801d85f 661
2b854a32
VZ
662 // Compatibility
663#if WXWIN_COMPATIBILITY
20947e08 664 void Position(long *xpos, long *ypos) const
b02da6b1
VZ
665 {
666 if (xpos)
20947e08 667 *xpos = (long)m_x;
b02da6b1
VZ
668 if (ypos)
669 *ypos = (long)m_y;
670 }
671
2b854a32
VZ
672 void Position(float *xpos, float *ypos) const
673 {
674 *xpos = (float) m_x; *ypos = (float) m_y;
675 }
676#endif // WXWIN_COMPATIBILITY
c801d85f 677
2b854a32 678 // Get X position
6cedba09 679 wxCoord GetX() const { return m_x; }
c801d85f 680
2b854a32 681 // Get Y position
6cedba09 682 wxCoord GetY() const { return m_y; }
c801d85f 683
d2c52078
RD
684 // Get wheel rotation, positive or negative indicates direction of
685 // rotation. Current devices all send an event when rotation is equal to
686 // +/-WheelDelta, but this allows for finer resolution devices to be
687 // created in the future. Because of this you shouldn't assume that one
688 // event is equal to 1 line or whatever, but you should be able to either
689 // do partial line scrolling or wait until +/-WheelDelta rotation values
690 // have been accumulated before scrolling.
691 int GetWheelRotation() const { return m_wheelRotation; }
692
693 // Get wheel delta, normally 120. This is the threshold for action to be
694 // taken, and one such action (for example, scrolling one increment)
695 // should occur for each delta.
696 int GetWheelDelta() const { return m_wheelDelta; }
697
698 // Returns the configured number of lines (or whatever) to be scrolled per
699 // wheel action. Defaults to one.
700 int GetLinesPerAction() const { return m_linesPerAction; }
701
8e72b8b5 702 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
aadbdf11 703
c801d85f 704public:
b02da6b1
VZ
705 wxCoord m_x, m_y;
706
2b854a32
VZ
707 bool m_leftDown;
708 bool m_middleDown;
709 bool m_rightDown;
710
711 bool m_controlDown;
712 bool m_shiftDown;
713 bool m_altDown;
714 bool m_metaDown;
d2c52078
RD
715
716 int m_wheelRotation;
717 int m_wheelDelta;
718 int m_linesPerAction;
1e6feb95
VZ
719
720private:
721 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f
KB
722};
723
43b5058d
VZ
724// Cursor set event
725
726/*
727 wxEVT_SET_CURSOR
728 */
729
730class WXDLLEXPORT wxSetCursorEvent : public wxEvent
731{
732public:
8e72b8b5 733 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
43b5058d
VZ
734 {
735 m_eventType = wxEVT_SET_CURSOR;
736
737 m_x = x;
738 m_y = y;
739 }
740
741 wxCoord GetX() const { return m_x; }
742 wxCoord GetY() const { return m_y; }
743
744 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
745 const wxCursor& GetCursor() const { return m_cursor; }
746 bool HasCursor() const { return m_cursor.Ok(); }
747
8e72b8b5 748 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
f97500b8 749
43b5058d
VZ
750private:
751 wxCoord m_x, m_y;
752 wxCursor m_cursor;
f97500b8 753
8e72b8b5
RR
754private:
755 DECLARE_DYNAMIC_CLASS(wxSetCursorEvent)
43b5058d
VZ
756};
757
c801d85f
KB
758// Keyboard input event class
759
760/*
761 wxEVT_CHAR
762 wxEVT_CHAR_HOOK
4ce81a75 763 wxEVT_KEY_DOWN
c801d85f
KB
764 wxEVT_KEY_UP
765 */
766
2b854a32 767class WXDLLEXPORT wxKeyEvent : public wxEvent
c801d85f 768{
c801d85f 769public:
2b854a32 770 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
c801d85f 771
2b854a32
VZ
772 // Find state of shift/control keys
773 bool ControlDown() const { return m_controlDown; }
774 bool MetaDown() const { return m_metaDown; }
775 bool AltDown() const { return m_altDown; }
776 bool ShiftDown() const { return m_shiftDown; }
f6bcfd97 777
d11710cb
VZ
778 // exclude MetaDown() from HasModifiers() because NumLock under X is often
779 // configured as mod2 modifier, yet the key events even when it is pressed
780 // should be processed normally, not like Ctrl- or Alt-key
781 bool HasModifiers() const { return ControlDown() || AltDown(); }
f6bcfd97
BP
782
783 // get the key code: an ASCII7 char or an element of wxKeyCode enum
784 int GetKeyCode() const { return (int)m_keyCode; }
c801d85f 785
9c7df356
VZ
786 // get the raw key code (platform-dependent)
787 wxUint32 GetRawKeyCode() const { return m_rawCode; }
788
789 // get the raw key flags (platform-dependent)
790 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
791
2b854a32 792 // Find the position of the event
b02da6b1
VZ
793 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
794 {
20947e08 795 if (xpos) *xpos = m_x;
b02da6b1
VZ
796 if (ypos) *ypos = m_y;
797 }
798
0e528b99 799#ifndef __WIN16__
bf57d1ad 800 void GetPosition(long *xpos, long *ypos) const
b02da6b1 801 {
20947e08 802 if (xpos) *xpos = (long)m_x;
bf57d1ad 803 if (ypos) *ypos = (long)m_y;
b02da6b1 804 }
0e528b99 805#endif
803ef874
JS
806
807 wxPoint GetPosition() const
808 { return wxPoint(m_x, m_y); }
c801d85f 809
2b854a32 810 // Get X position
b02da6b1 811 wxCoord GetX() const { return m_x; }
c801d85f 812
2b854a32 813 // Get Y position
b02da6b1 814 wxCoord GetY() const { return m_y; }
c801d85f 815
f6bcfd97
BP
816 // deprecated
817 long KeyCode() const { return m_keyCode; }
818
8e72b8b5 819 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
f97500b8
VZ
820
821 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
822 // example)
823 wxKeyEvent& operator=(const wxKeyEvent& evt)
824 {
825 m_x = evt.m_x;
826 m_y = evt.m_y;
827
828 m_keyCode = evt.m_keyCode;
829
830 m_controlDown = evt.m_controlDown;
831 m_shiftDown = evt.m_shiftDown;
832 m_altDown = evt.m_altDown;
833 m_metaDown = evt.m_metaDown;
834 m_scanCode = evt.m_scanCode;
9c7df356
VZ
835 m_rawCode = evt.m_rawCode;
836 m_rawFlags = evt.m_rawFlags;
f97500b8
VZ
837
838 return *this;
839 }
840
2b854a32 841public:
b02da6b1
VZ
842 wxCoord m_x, m_y;
843
2b854a32 844 long m_keyCode;
b02da6b1 845
2b854a32
VZ
846 bool m_controlDown;
847 bool m_shiftDown;
848 bool m_altDown;
849 bool m_metaDown;
b0e813a0 850 bool m_scanCode;
f97500b8 851
9c7df356
VZ
852 // these fields contain the platform-specific information about the pressed
853 // key
854 wxUint32 m_rawCode;
855 wxUint32 m_rawFlags;
856
8e72b8b5
RR
857private:
858 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
859};
860
861// Size event class
862/*
863 wxEVT_SIZE
864 */
865
2b854a32 866class WXDLLEXPORT wxSizeEvent : public wxEvent
c801d85f 867{
2b854a32 868public:
2b854a32
VZ
869 wxSizeEvent() { m_eventType = wxEVT_SIZE; }
870 wxSizeEvent(const wxSize& sz, int id = 0)
871 : m_size(sz)
872 { m_eventType = wxEVT_SIZE; m_id = id; }
c801d85f 873
2b854a32 874 wxSize GetSize() const { return m_size; }
aadbdf11 875
8e72b8b5
RR
876 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
877
878public:
879 wxSize m_size;
880
f97500b8 881private:
8e72b8b5 882 DECLARE_DYNAMIC_CLASS(wxSizeEvent)
c801d85f
KB
883};
884
885// Move event class
886
887/*
888 wxEVT_MOVE
889 */
890
2b854a32 891class WXDLLEXPORT wxMoveEvent : public wxEvent
c801d85f 892{
2b854a32 893public:
2b854a32
VZ
894 wxMoveEvent() { m_eventType = wxEVT_MOVE; }
895 wxMoveEvent(const wxPoint& pos, int id = 0)
896 : m_pos(pos)
897 { m_eventType = wxEVT_MOVE; m_id = id; }
c801d85f 898
2b854a32 899 wxPoint GetPosition() const { return m_pos; }
aadbdf11 900
8e72b8b5 901 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
f97500b8 902
8e72b8b5 903 wxPoint m_pos;
f97500b8 904
8e72b8b5
RR
905private:
906 DECLARE_DYNAMIC_CLASS(wxMoveEvent)
c801d85f
KB
907};
908
909// Paint event class
910/*
911 wxEVT_PAINT
912 wxEVT_NC_PAINT
913 wxEVT_PAINT_ICON
914 */
915
b078fa02
JS
916#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
917 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
98243fed 918 extern WXDLLEXPORT int g_isPainting;
edccf428
VZ
919#endif // debug
920
2b854a32 921class WXDLLEXPORT wxPaintEvent : public wxEvent
c801d85f 922{
2b854a32 923public:
edccf428
VZ
924 wxPaintEvent(int Id = 0)
925 {
926 m_eventType = wxEVT_PAINT;
927 m_id = Id;
928
b078fa02 929#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ
930 // set the internal flag for the duration of processing of WM_PAINT
931 g_isPainting++;
932#endif // debug
933 }
934
b078fa02 935#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ
936 ~wxPaintEvent()
937 {
938 g_isPainting--;
939 }
940#endif // debug
8e72b8b5
RR
941
942 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
f97500b8 943
8e72b8b5
RR
944private:
945 DECLARE_DYNAMIC_CLASS(wxPaintEvent)
c801d85f
KB
946};
947
1e6feb95
VZ
948class WXDLLEXPORT wxNcPaintEvent : public wxEvent
949{
950public:
951 wxNcPaintEvent(int id = 0) : wxEvent(id) { SetEventType(wxEVT_NC_PAINT); }
f97500b8 952
8e72b8b5 953 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1e6feb95
VZ
954
955private:
956 DECLARE_DYNAMIC_CLASS(wxNcPaintEvent)
957};
958
c801d85f
KB
959// Erase background event class
960/*
961 wxEVT_ERASE_BACKGROUND
962 */
963
2b854a32 964class WXDLLEXPORT wxEraseEvent : public wxEvent
c801d85f 965{
2b854a32 966public:
2b854a32
VZ
967 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
968 { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
f97500b8 969
2b854a32 970 wxDC *GetDC() const { return m_dc; }
aadbdf11 971
8e72b8b5 972 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
f97500b8 973
8e72b8b5
RR
974 wxDC *m_dc;
975
976private:
977 DECLARE_DYNAMIC_CLASS(wxEraseEvent)
c801d85f
KB
978};
979
980// Focus event class
981/*
982 wxEVT_SET_FOCUS
983 wxEVT_KILL_FOCUS
984 */
985
2b854a32 986class WXDLLEXPORT wxFocusEvent : public wxEvent
c801d85f 987{
2b854a32 988public:
1e6feb95
VZ
989 wxFocusEvent(wxEventType type = wxEVT_NULL, int id = 0)
990 { m_eventType = type; m_id = id; m_win = NULL; }
991
8e72b8b5 992 // The window associated with this event is the window which had focus
1e6feb95 993 // before for SET event and the window which will have focus for the KILL
8e72b8b5 994 // one. NB: it may be NULL in both cases!
1e6feb95
VZ
995 wxWindow *GetWindow() const { return m_win; }
996 void SetWindow(wxWindow *win) { m_win = win; }
997
8e72b8b5 998 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
f97500b8 999
1e6feb95
VZ
1000private:
1001 wxWindow *m_win;
1002
8e72b8b5 1003private:
1e6feb95 1004 DECLARE_DYNAMIC_CLASS(wxFocusEvent)
c801d85f
KB
1005};
1006
456bc6d9
VZ
1007// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1008// wxFocusEvent it is propgated upwards the window chain
1009class WXDLLEXPORT wxChildFocusEvent : public wxCommandEvent
1010{
1011public:
1012 wxChildFocusEvent(wxWindow *win = NULL);
1013
1014 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1015
8e72b8b5 1016 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
f97500b8 1017
8e72b8b5 1018private:
456bc6d9
VZ
1019 DECLARE_DYNAMIC_CLASS(wxChildFocusEvent)
1020};
1021
c801d85f
KB
1022// Activate event class
1023/*
1024 wxEVT_ACTIVATE
1025 wxEVT_ACTIVATE_APP
1026 */
1027
2b854a32 1028class WXDLLEXPORT wxActivateEvent : public wxEvent
c801d85f 1029{
2b854a32
VZ
1030public:
1031 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
1032 { m_eventType = type; m_active = active; m_id = Id; }
f97500b8 1033
2b854a32 1034 bool GetActive() const { return m_active; }
c801d85f 1035
8e72b8b5 1036 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
aadbdf11 1037
2b854a32
VZ
1038private:
1039 bool m_active;
8e72b8b5
RR
1040
1041private:
1042 DECLARE_DYNAMIC_CLASS(wxActivateEvent)
c801d85f
KB
1043};
1044
1045// InitDialog event class
1046/*
1047 wxEVT_INIT_DIALOG
1048 */
1049
2b854a32 1050class WXDLLEXPORT wxInitDialogEvent : public wxEvent
c801d85f 1051{
2b854a32
VZ
1052public:
1053 wxInitDialogEvent(int Id = 0)
1054 { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
8e72b8b5
RR
1055
1056 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
f97500b8
VZ
1057
1058private:
8e72b8b5 1059 DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
c801d85f
KB
1060};
1061
1062// Miscellaneous menu event class
1063/*
ccef86c7
VZ
1064 wxEVT_MENU_OPEN,
1065 wxEVT_MENU_CLOSE,
c801d85f 1066 wxEVT_MENU_HIGHLIGHT,
c801d85f
KB
1067*/
1068
2b854a32 1069class WXDLLEXPORT wxMenuEvent : public wxEvent
c801d85f 1070{
c801d85f 1071public:
aadbdf11 1072 wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
ccef86c7
VZ
1073 : wxEvent(id, type)
1074 { m_menuId = id; }
c801d85f 1075
ccef86c7 1076 // only for wxEVT_MENU_HIGHLIGHT
aadbdf11 1077 int GetMenuId() const { return m_menuId; }
c801d85f 1078
ccef86c7
VZ
1079 // only for wxEVT_MENU_OPEN/CLOSE
1080 bool IsPopup() const { return m_menuId == -1; }
1081
8e72b8b5 1082 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
f97500b8 1083
2b854a32 1084private:
aadbdf11 1085 int m_menuId;
f97500b8 1086
8e72b8b5 1087 DECLARE_DYNAMIC_CLASS(wxMenuEvent)
c801d85f
KB
1088};
1089
1090// Window close or session close event class
1091/*
1092 wxEVT_CLOSE_WINDOW,
1093 wxEVT_END_SESSION,
1094 wxEVT_QUERY_END_SESSION
1095 */
1096
2b854a32 1097class WXDLLEXPORT wxCloseEvent : public wxEvent
c801d85f 1098{
c801d85f 1099public:
2b854a32
VZ
1100 wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
1101 {
1102 m_eventType = type;
1103 m_loggingOff = TRUE;
1104 m_veto = FALSE; // should be FALSE by default
1105 m_id = id;
1106#if WXWIN_COMPATIBILITY
1107 m_force = FALSE;
1108#endif // WXWIN_COMPATIBILITY
1109 m_canVeto = TRUE;
1110 }
1111
1112 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1113 bool GetLoggingOff() const { return m_loggingOff; }
1114
fe4e9e6c
VZ
1115 void Veto(bool veto = TRUE)
1116 {
1117 // GetVeto() will return FALSE anyhow...
1118 wxCHECK_RET( m_canVeto,
223d09f6 1119 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
1120
1121 m_veto = veto;
1122 }
2b854a32 1123 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
e3065973 1124 // No more asserts here please, the one you put here was wrong.
2b854a32 1125 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1126 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1127
2b854a32
VZ
1128#if WXWIN_COMPATIBILITY
1129 // This is probably obsolete now, since we use CanVeto instead, in
1130 // both OnCloseWindow and OnQueryEndSession.
1131 // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
1132 void SetForce(bool force) { m_force = force; }
1133 bool GetForce() const { return m_force; }
1134#endif
1135
8e72b8b5 1136 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
aadbdf11 1137
2b854a32
VZ
1138protected:
1139 bool m_loggingOff;
1140 bool m_veto, m_canVeto;
1141
1142#if WXWIN_COMPATIBILITY
1143 bool m_force;
1144#endif
8e72b8b5
RR
1145
1146private:
1147 DECLARE_DYNAMIC_CLASS(wxCloseEvent)
1148
c801d85f
KB
1149};
1150
1151/*
1152 wxEVT_SHOW
1153 */
1154
2b854a32 1155class WXDLLEXPORT wxShowEvent : public wxEvent
c801d85f 1156{
c801d85f 1157public:
2b854a32
VZ
1158 wxShowEvent(int id = 0, bool show = FALSE)
1159 { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
c801d85f 1160
2b854a32
VZ
1161 void SetShow(bool show) { m_show = show; }
1162 bool GetShow() const { return m_show; }
c801d85f 1163
8e72b8b5 1164 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
aadbdf11 1165
c801d85f 1166protected:
2b854a32 1167 bool m_show;
3dd9b88a 1168
8e72b8b5 1169private:
3dd9b88a 1170 DECLARE_DYNAMIC_CLASS(wxShowEvent)
c801d85f
KB
1171};
1172
1173/*
1174 wxEVT_ICONIZE
1175 */
1176
2b854a32 1177class WXDLLEXPORT wxIconizeEvent : public wxEvent
c801d85f 1178{
2b854a32 1179public:
3dd9b88a
VZ
1180 wxIconizeEvent(int id = 0, bool iconized = TRUE)
1181 { m_eventType = wxEVT_ICONIZE; m_id = id; m_iconized = iconized; }
1182
1183 // return true if the frame was iconized, false if restored
1184 bool Iconized() const { return m_iconized; }
1185
8e72b8b5 1186 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
f97500b8 1187
3dd9b88a
VZ
1188protected:
1189 bool m_iconized;
1190
8e72b8b5 1191private:
3dd9b88a 1192 DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
c801d85f 1193};
c801d85f
KB
1194/*
1195 wxEVT_MAXIMIZE
1196 */
1197
2b854a32 1198class WXDLLEXPORT wxMaximizeEvent : public wxEvent
c801d85f 1199{
2b854a32 1200public:
3dd9b88a
VZ
1201 wxMaximizeEvent(int id = 0)
1202 { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
1203
8e72b8b5 1204 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
f97500b8 1205
8e72b8b5 1206private:
3dd9b88a 1207 DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
c801d85f
KB
1208};
1209
1210// Joystick event class
1211/*
1212 wxEVT_JOY_BUTTON_DOWN,
1213 wxEVT_JOY_BUTTON_UP,
1214 wxEVT_JOY_MOVE,
1215 wxEVT_JOY_ZMOVE
1216*/
1217
1218// Which joystick? Same as Windows ids so no conversion necessary.
1219#define wxJOYSTICK1 0
1220#define wxJOYSTICK2 1
1221
1222// Which button is down?
1223#define wxJOY_BUTTON1 1
1224#define wxJOY_BUTTON2 2
1225#define wxJOY_BUTTON3 4
1226#define wxJOY_BUTTON4 8
1227#define wxJOY_BUTTON_ANY -1
1228
2b854a32 1229class WXDLLEXPORT wxJoystickEvent : public wxEvent
c801d85f 1230{
2b854a32
VZ
1231public:
1232 wxPoint m_pos;
1233 int m_zPosition;
1234 int m_buttonChange; // Which button changed?
1235 int m_buttonState; // Which buttons are down?
1236 int m_joyStick; // Which joystick?
1237
1238 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1239 int state = 0,
1240 int joystick = wxJOYSTICK1,
1241 int change = 0)
1242 {
1243 m_eventType = type;
1244 m_buttonState = state;
1245 m_pos = wxPoint(0,0);
1246 m_zPosition = 0;
1247 m_joyStick = joystick;
1248 m_buttonChange = change;
1249 }
1250
1251 wxPoint GetPosition() const { return m_pos; }
1252 int GetZPosition() const { return m_zPosition; }
1253 int GetButtonState() const { return m_buttonState; }
1254 int GetButtonChange() const { return m_buttonChange; }
1255 int GetJoystick() const { return m_joyStick; }
1256
1257 void SetJoystick(int stick) { m_joyStick = stick; }
1258 void SetButtonState(int state) { m_buttonState = state; }
1259 void SetButtonChange(int change) { m_buttonChange = change; }
1260 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1261 void SetZPosition(int zPos) { m_zPosition = zPos; }
1262
1263 // Was it a button event? (*doesn't* mean: is any button *down*?)
1264 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 1265 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ
1266
1267 // Was it a move event?
1268 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
1269
1270 // Was it a zmove event?
1271 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
1272
1273 // Was it a down event from button 1, 2, 3, 4 or any?
1274 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1275 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 1276 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1277
2b854a32
VZ
1278 // Was it a up event from button 1, 2, 3 or any?
1279 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 1280 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 1281 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1282
2b854a32
VZ
1283 // Was the given button 1,2,3,4 or any in Down state?
1284 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1285 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 1286 ((m_buttonState & but) == but)); }
f305c661 1287
8e72b8b5 1288 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
f97500b8 1289
8e72b8b5
RR
1290private:
1291 DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
c801d85f
KB
1292};
1293
1294// Drop files event class
1295/*
1296 wxEVT_DROP_FILES
1297 */
1298
2b854a32 1299class WXDLLEXPORT wxDropFilesEvent : public wxEvent
c801d85f 1300{
2b854a32
VZ
1301public:
1302 int m_noFiles;
1303 wxPoint m_pos;
c3c39620 1304 wxString* m_files;
2b854a32
VZ
1305
1306 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1307 int noFiles = 0,
1308 wxString *files = (wxString *) NULL)
1309 { m_eventType = type; m_noFiles = noFiles; m_files = files; }
1310
c3c39620
VZ
1311 // we need a copy ctor to avoid deleting m_files pointer twice
1312 wxDropFilesEvent(const wxDropFilesEvent& other)
1313 : m_pos(other.m_pos)
1314 {
1315 m_noFiles = other.m_noFiles;
1316 m_files = new wxString[m_noFiles];
1317 for ( int n = 0; n < m_noFiles; n++ )
1318 {
1319 m_files[n] = other.m_files[n];
1320 }
1321 }
1322
1323 virtual ~wxDropFilesEvent()
1324 {
1325 delete [] m_files;
1326 }
1327
2b854a32
VZ
1328 wxPoint GetPosition() const { return m_pos; }
1329 int GetNumberOfFiles() const { return m_noFiles; }
1330 wxString *GetFiles() const { return m_files; }
f305c661 1331
c3c39620 1332 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
f97500b8 1333
8e72b8b5
RR
1334private:
1335 DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
c801d85f
KB
1336};
1337
c801d85f
KB
1338// Update UI event
1339/*
1340 wxEVT_UPDATE_UI
1341 */
1342
2b854a32 1343class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
c801d85f 1344{
2b854a32
VZ
1345public:
1346 wxUpdateUIEvent(wxWindowID commandId = 0)
1347 {
1348 m_eventType = wxEVT_UPDATE_UI;
1349 m_id = commandId;
1350 m_checked = FALSE;
1351 m_setChecked = FALSE;
1352 m_enabled = FALSE;
1353 m_setEnabled = FALSE;
1354 m_setText = FALSE;
1355 m_text = "";
1356 }
1357
1358 bool GetChecked() const { return m_checked; }
1359 bool GetEnabled() const { return m_enabled; }
1360 wxString GetText() const { return m_text; }
1361 bool GetSetText() const { return m_setText; }
1362 bool GetSetChecked() const { return m_setChecked; }
1363 bool GetSetEnabled() const { return m_setEnabled; }
1364
1365 void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1366 void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1367 void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
c801d85f 1368
8e72b8b5 1369 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
f305c661 1370
2b854a32
VZ
1371protected:
1372 bool m_checked;
1373 bool m_enabled;
1374 bool m_setEnabled;
1375 bool m_setText;
1376 bool m_setChecked;
1377 wxString m_text;
f97500b8 1378
8e72b8b5
RR
1379private:
1380 DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
c801d85f
KB
1381};
1382
1383/*
1384 wxEVT_SYS_COLOUR_CHANGED
1385 */
1386
1387// TODO: shouldn't all events record the window ID?
2b854a32 1388class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
c801d85f 1389{
2b854a32
VZ
1390public:
1391 wxSysColourChangedEvent()
1392 { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
f97500b8 1393
8e72b8b5 1394 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
f97500b8 1395
8e72b8b5
RR
1396private:
1397 DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
c801d85f
KB
1398};
1399
a5e84126
JS
1400/*
1401 wxEVT_MOUSE_CAPTURE_CHANGED
1402 The window losing the capture receives this message
1403 (even if it released the capture itself).
1404 */
1405
1406class WXDLLEXPORT wxMouseCaptureChangedEvent : public wxEvent
1407{
1408public:
1409 wxMouseCaptureChangedEvent(wxWindowID id = 0, wxWindow* gainedCapture = NULL): wxEvent(id)
1410 { m_eventType = wxEVT_MOUSE_CAPTURE_CHANGED; m_gainedCapture = gainedCapture; }
1411
1412 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1413
1414 wxWindow* GetCapturedWindow() const { return m_gainedCapture; };
1415
1416private:
1417 wxWindow* m_gainedCapture;
1418 DECLARE_DYNAMIC_CLASS(wxMouseCaptureChangedEvent)
1419};
1420
574c939e
KB
1421/*
1422 wxEVT_DISPLAY_CHANGED
1423 */
1424class WXDLLEXPORT wxDisplayChangedEvent : public wxEvent
1425{
1426private:
1427 DECLARE_DYNAMIC_CLASS(wxDisplayChangedEvent)
1428
1429public:
1430 wxDisplayChangedEvent()
1431 { m_eventType = wxEVT_DISPLAY_CHANGED; }
1432
1433 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1434};
1435
f7bd2698
JS
1436/*
1437 wxEVT_PALETTE_CHANGED
1438 */
1439
2b854a32 1440class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
f7bd2698 1441{
f7bd2698 1442public:
2b854a32
VZ
1443 wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1444 {
1445 m_eventType = wxEVT_PALETTE_CHANGED;
1446 m_changedWindow = (wxWindow *) NULL;
1447 }
f7bd2698 1448
2b854a32
VZ
1449 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1450 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 1451
8e72b8b5 1452 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
f305c661 1453
f7bd2698 1454protected:
2b854a32 1455 wxWindow* m_changedWindow;
8e72b8b5
RR
1456
1457private:
1458 DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
f7bd2698
JS
1459};
1460
1461/*
1462 wxEVT_QUERY_NEW_PALETTE
1463 Indicates the window is getting keyboard focus and should re-do its palette.
1464 */
1465
2b854a32 1466class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1467{
f7bd2698 1468public:
2b854a32
VZ
1469 wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1470 { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
f7bd2698 1471
2b854a32
VZ
1472 // App sets this if it changes the palette.
1473 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1474 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 1475
8e72b8b5 1476 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
f305c661 1477
f7bd2698 1478protected:
2b854a32 1479 bool m_paletteRealized;
f97500b8 1480
8e72b8b5
RR
1481private:
1482 DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
f7bd2698
JS
1483};
1484
7fdefd57
VZ
1485/*
1486 Event generated by dialog navigation keys
1487 wxEVT_NAVIGATION_KEY
1488 */
d9506e77
VZ
1489// NB: don't derive from command event to avoid being propagated to the parent
1490class WXDLLEXPORT wxNavigationKeyEvent : public wxEvent
7fdefd57 1491{
7fdefd57 1492public:
d9506e77
VZ
1493 wxNavigationKeyEvent()
1494 {
1495 SetEventType(wxEVT_NAVIGATION_KEY);
1496
1497 m_flags = IsForward | Propagate; // defaults are for TAB
1498 m_focus = (wxWindow *)NULL;
1499 }
7fdefd57 1500
2b854a32 1501 // direction: forward (true) or backward (false)
d9506e77
VZ
1502 bool GetDirection() const
1503 { return (m_flags & IsForward) != 0; }
1504 void SetDirection(bool bForward)
1505 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 1506
2b854a32
VZ
1507 // it may be a window change event (MDI, notebook pages...) or a control
1508 // change event
d9506e77
VZ
1509 bool IsWindowChange() const
1510 { return (m_flags & WinChange) != 0; }
1511 void SetWindowChange(bool bIs)
1512 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1513
1514 // some navigation events are meant to be propagated upwards (Windows
1515 // convention is to do this for TAB events) while others should always
1516 // cycle inside the panel/radiobox/whatever we're current inside
1517 bool ShouldPropagate() const
1518 { return (m_flags & Propagate) != 0; }
1519 void SetPropagate(bool bDoIt)
1520 { if ( bDoIt ) m_flags |= Propagate; else m_flags &= ~Propagate; }
7fdefd57 1521
2b854a32
VZ
1522 // the child which has the focus currently (may be NULL - use
1523 // wxWindow::FindFocus then)
d9506e77
VZ
1524 wxWindow* GetCurrentFocus() const { return m_focus; }
1525 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1526
8e72b8b5
RR
1527 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1528
d9506e77
VZ
1529private:
1530 enum
1531 {
1532 IsForward = 0x0001,
1533 WinChange = 0x0002,
1534 Propagate = 0x0004
1535 };
1536
1537 long m_flags;
1538 wxWindow *m_focus;
1539
8e72b8b5 1540private:
d9506e77 1541 DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
7fdefd57
VZ
1542};
1543
42e69d6b
VZ
1544// Window creation/destruction events: the first is sent as soon as window is
1545// created (i.e. the underlying GUI object exists), but when the C++ object is
1546// fully initialized (so virtual functions may be called). The second,
1547// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1548// still safe to call virtual functions at this moment
1549/*
1550 wxEVT_CREATE
1551 wxEVT_DESTROY
1552 */
1553
f6bcfd97 1554class WXDLLEXPORT wxWindowCreateEvent : public wxCommandEvent
42e69d6b 1555{
42e69d6b
VZ
1556public:
1557 wxWindowCreateEvent(wxWindow *win = NULL);
1558
1559 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1560
8e72b8b5 1561 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
f97500b8 1562
8e72b8b5
RR
1563private:
1564 DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent)
42e69d6b
VZ
1565};
1566
f6bcfd97 1567class WXDLLEXPORT wxWindowDestroyEvent : public wxCommandEvent
42e69d6b 1568{
42e69d6b
VZ
1569public:
1570 wxWindowDestroyEvent(wxWindow *win = NULL);
1571
1572 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1573
8e72b8b5
RR
1574 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1575
1576private:
1577 DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent)
42e69d6b
VZ
1578};
1579
bd83cb56 1580// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 1581/*
bd83cb56
VZ
1582 wxEVT_HELP
1583 wxEVT_DETAILED_HELP
1584*/
b96340e6
JS
1585
1586class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
1587{
b96340e6 1588public:
bd83cb56
VZ
1589 wxHelpEvent(wxEventType type = wxEVT_NULL,
1590 wxWindowID id = 0,
1591 const wxPoint& pt = wxDefaultPosition)
1592 {
1593 m_eventType = type;
1594 m_id = id;
1595 m_pos = pt;
1596 }
b96340e6 1597
bd83cb56
VZ
1598 // Position of event (in screen coordinates)
1599 const wxPoint& GetPosition() const { return m_pos; }
1600 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 1601
bd83cb56
VZ
1602 // Optional link to further help
1603 const wxString& GetLink() const { return m_link; }
1604 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 1605
bd83cb56
VZ
1606 // Optional target to display help in. E.g. a window specification
1607 const wxString& GetTarget() const { return m_target; }
1608 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 1609
8e72b8b5 1610 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
f97500b8 1611
bd83cb56
VZ
1612protected:
1613 wxPoint m_pos;
1614 wxString m_target;
1615 wxString m_link;
1616
1617private:
1618 DECLARE_DYNAMIC_CLASS(wxHelpEvent)
b96340e6
JS
1619};
1620
69231000
JS
1621// A Context event is sent when the user right clicks on a window or
1622// presses Shift-F10
1623// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
1624// Under other systems it may have to be generated from a right click event
1625/*
1626 wxEVT_CONTEXT_MENU
1627*/
1628
1629class WXDLLEXPORT wxContextMenuEvent : public wxCommandEvent
1630{
1631public:
1632 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
1633 wxWindowID id = 0,
1634 const wxPoint& pt = wxDefaultPosition)
1635 {
1636 m_eventType = type;
1637 m_id = id;
1638 m_pos = pt;
1639 }
1640
1641 // Position of event (in screen coordinates)
1642 const wxPoint& GetPosition() const { return m_pos; }
1643 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1644
8e72b8b5 1645 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
f97500b8 1646
69231000
JS
1647protected:
1648 wxPoint m_pos;
1649
1650private:
1651 DECLARE_DYNAMIC_CLASS(wxContextMenuEvent)
1652};
1653
e90c1d2a
VZ
1654// Idle event
1655/*
1656 wxEVT_IDLE
1657 */
1658
1659class WXDLLEXPORT wxIdleEvent : public wxEvent
1660{
e90c1d2a
VZ
1661public:
1662 wxIdleEvent()
1663 { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
1664
1665 void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
1666 bool MoreRequested() const { return m_requestMore; }
1667
8e72b8b5 1668 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
e90c1d2a
VZ
1669
1670protected:
1671 bool m_requestMore;
f97500b8 1672
8e72b8b5
RR
1673private:
1674 DECLARE_DYNAMIC_CLASS(wxIdleEvent)
e90c1d2a
VZ
1675};
1676
6b55490a
VZ
1677#endif // wxUSE_GUI
1678
e5fb7191 1679/* TODO
c801d85f 1680 wxEVT_POWER,
c801d85f
KB
1681 wxEVT_MOUSE_CAPTURE_CHANGED,
1682 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
1683// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1684 // wxEVT_FONT_CHANGED to all other windows (maybe).
1685 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1686 wxEVT_MEASURE_ITEM,
1687 wxEVT_COMPARE_ITEM
1688*/
1689
88a9f974 1690
8e193f38
VZ
1691// ============================================================================
1692// event handler and related classes
1693// ============================================================================
1694
c801d85f
KB
1695typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1696
2e4df4bf
VZ
1697// we can't have ctors nor base struct in backwards compatibility mode or
1698// otherwise we won't be able to initialize the objects with an agregate, so
1699// we have to keep both versions
1700#if WXWIN_COMPATIBILITY_EVENT_TYPES
1701
1702struct WXDLLEXPORT wxEventTableEntry
1703{
1704 // For some reason, this can't be wxEventType, or VC++ complains.
1705 int m_eventType; // main event type
1706 int m_id; // control/menu/toolbar id
1707 int m_lastId; // used for ranges of ids
1708 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1709 // because of dependency problems
1710
1711 wxObject* m_callbackUserData;
1712};
1713
1714#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1715
6164f93c
VZ
1716// struct containing the members common to static and dynamic event tables
1717// entries
1718struct WXDLLEXPORT wxEventTableEntryBase
77d4384e 1719{
6164f93c
VZ
1720 wxEventTableEntryBase(int id, int idLast,
1721 wxObjectEventFunction fn, wxObject *data)
1722 {
1723 m_id = id;
1724 m_lastId = idLast;
1725 m_fn = fn;
1726 m_callbackUserData = data;
1727 }
6164f93c
VZ
1728
1729 // the range of ids for this entry: if m_lastId == -1, the range consists
1730 // only of m_id, otherwise it is m_id..m_lastId inclusive
1731 int m_id, m_lastId;
82a5f02c 1732
6164f93c
VZ
1733 // function to call: not wxEventFunction, because of dependency problems
1734 wxObjectEventFunction m_fn;
77d4384e 1735
6164f93c 1736 // arbitrary user data asosciated with the callback
77d4384e
RR
1737 wxObject* m_callbackUserData;
1738};
1739
6164f93c
VZ
1740// an entry from a static event table
1741struct WXDLLEXPORT wxEventTableEntry : public wxEventTableEntryBase
c801d85f 1742{
6164f93c
VZ
1743 wxEventTableEntry(const int& evType, int id, int idLast,
1744 wxObjectEventFunction fn, wxObject *data)
1745 : wxEventTableEntryBase(id, idLast, fn, data),
1746 m_eventType(evType)
1747 {
1748 }
6164f93c
VZ
1749
1750 // the reference to event type: this allows us to not care about the
1751 // (undefined) order in which the event table entries and the event types
1752 // are initialized: initially the value of this reference might be
1753 // invalid, but by the time it is used for the first time, all global
1754 // objects will have been initialized (including the event type constants)
1755 // and so it will have the correct value when it is needed
1756 const int& m_eventType;
1757};
1758
1759// an entry used in dynamic event table managed by wxEvtHandler::Connect()
1760struct WXDLLEXPORT wxDynamicEventTableEntry : public wxEventTableEntryBase
1761{
0b5eceb6
VZ
1762 wxDynamicEventTableEntry(int evType, int id, int idLast,
1763 wxObjectEventFunction fn, wxObject *data)
6164f93c 1764 : wxEventTableEntryBase(id, idLast, fn, data)
0b5eceb6 1765 {
6164f93c 1766 m_eventType = evType;
0b5eceb6 1767 }
6164f93c
VZ
1768
1769 // not a reference here as we can't keep a reference to a temporary int
1770 // created to wrap the constant value typically passed to Connect() - nor
1771 // do we need it
1772 int m_eventType;
c801d85f
KB
1773};
1774
2e4df4bf
VZ
1775#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
1776
1777// ----------------------------------------------------------------------------
1778// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
1779// ----------------------------------------------------------------------------
c801d85f
KB
1780struct WXDLLEXPORT wxEventTable
1781{
0b5eceb6
VZ
1782 const wxEventTable *baseTable; // base event table (next in chain)
1783 const wxEventTableEntry *entries; // bottom of entry array
c801d85f
KB
1784};
1785
6164f93c
VZ
1786// ----------------------------------------------------------------------------
1787// wxEvtHandler: the base class for all objects handling wxWindows events
1788// ----------------------------------------------------------------------------
1789
b88c44e7 1790class WXDLLEXPORT wxEvtHandler : public wxObject
c801d85f 1791{
2b854a32
VZ
1792public:
1793 wxEvtHandler();
6164f93c 1794 virtual ~wxEvtHandler();
2b854a32
VZ
1795
1796 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1797 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1798 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1799 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1800
8e193f38 1801 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ
1802 bool GetEvtHandlerEnabled() const { return m_enabled; }
1803
8e193f38
VZ
1804 // process an event right now
1805 virtual bool ProcessEvent(wxEvent& event);
2b854a32 1806
8e193f38
VZ
1807 // add an event to be processed later
1808 void AddPendingEvent(wxEvent& event);
2b854a32 1809
8e193f38
VZ
1810 // process all pending events
1811 void ProcessPendingEvents();
2b854a32 1812
20947e08 1813 // add a
7214297d
GL
1814#if wxUSE_THREADS
1815 bool ProcessThreadEvent(wxEvent& event);
7214297d 1816#endif
2b854a32
VZ
1817
1818 // Dynamic association of a member function handler with the event handler,
1819 // id and event type
77d4384e 1820 void Connect( int id, int lastId, int eventType,
2b854a32
VZ
1821 wxObjectEventFunction func,
1822 wxObject *userData = (wxObject *) NULL );
1823
1824 // Convenience function: take just one id
77d4384e 1825 void Connect( int id, int eventType,
2b854a32
VZ
1826 wxObjectEventFunction func,
1827 wxObject *userData = (wxObject *) NULL )
1828 { Connect(id, -1, eventType, func, userData); }
1829
33ac7e6f 1830 bool Disconnect( int id, int lastId, wxEventType eventType,
97d7bfb8
RR
1831 wxObjectEventFunction func = NULL,
1832 wxObject *userData = (wxObject *) NULL );
1833
1834 // Convenience function: take just one id
1835 bool Disconnect( int id, wxEventType eventType = wxEVT_NULL,
1836 wxObjectEventFunction func = NULL,
1837 wxObject *userData = (wxObject *) NULL )
1838 { return Disconnect(id, -1, eventType, func, userData); }
98243fed 1839
b88c44e7
RD
1840
1841 // User data can be associated with each wxEvtHandler
1842 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
1843 wxClientData *GetClientObject() const { return DoGetClientObject(); }
1844
1845 void SetClientData( void *data ) { DoSetClientData(data); }
1846 void *GetClientData() const { return DoGetClientData(); }
1847
1848
8e193f38
VZ
1849 // implementation from now on
1850 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2b854a32 1851 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 1852
63863e09 1853#if wxUSE_THREADS
20947e08
DW
1854 void ClearEventLocker()
1855 {
1856# if !defined(__VISAGECPP__)
1857 delete m_eventsLocker;
1858 m_eventsLocker = NULL;
1859#endif
1860 };
63863e09
JS
1861#endif
1862
8e193f38
VZ
1863 // old stuff
1864
1865#if WXWIN_COMPATIBILITY_2
1866 virtual void OnCommand(wxWindow& WXUNUSED(win),
1867 wxCommandEvent& WXUNUSED(event))
1868 {
1869 wxFAIL_MSG(wxT("shouldn't be called any more"));
1870 }
1871
1872 // Called if child control has no callback function
1873 virtual long Default()
1874 { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1875#endif // WXWIN_COMPATIBILITY_2
1876
1877#if WXWIN_COMPATIBILITY
1878 virtual bool OnClose();
1879#endif
1880
c801d85f 1881private:
8e193f38 1882 static const wxEventTableEntry sm_eventTableEntries[];
2b854a32 1883
c801d85f 1884protected:
193bf013
VZ
1885 static const wxEventTable sm_eventTable;
1886
1887 virtual const wxEventTable *GetEventTable() const;
1888
63863e09
JS
1889 wxEvtHandler* m_nextHandler;
1890 wxEvtHandler* m_previousHandler;
63863e09 1891 wxList* m_dynamicEvents;
42e69d6b 1892 wxList* m_pendingEvents;
6164f93c 1893
7214297d 1894#if wxUSE_THREADS
20947e08
DW
1895#if defined (__VISAGECPP__)
1896 wxCriticalSection m_eventsLocker;
1897# else
63863e09 1898 wxCriticalSection* m_eventsLocker;
20947e08 1899# endif
7214297d 1900#endif
193bf013
VZ
1901
1902 // optimization: instead of using costly IsKindOf() to decide whether we're
1903 // a window (which is true in 99% of cases), use this flag
63863e09 1904 bool m_isWindow;
8e193f38
VZ
1905
1906 // Is event handler enabled?
1907 bool m_enabled;
6164f93c 1908
b88c44e7
RD
1909
1910 // The user data: either an object which will be deleted by the container
1911 // when it's deleted or some raw pointer which we do nothing with - only
1912 // one type of data can be used with the given window (i.e. you cannot set
1913 // the void data and then associate the container with wxClientData or vice
1914 // versa)
1915 union
1916 {
1917 wxClientData *m_clientObject;
1918 void *m_clientData;
1919 };
1920
1921 // what kind of data do we have?
1922 wxClientDataType m_clientDataType;
1923
1924 // client data accessors
1925 virtual void DoSetClientObject( wxClientData *data );
1926 virtual wxClientData *DoGetClientObject() const;
1927
1928 virtual void DoSetClientData( void *data );
1929 virtual void *DoGetClientData() const;
1930
6164f93c 1931private:
cf72f75f 1932 DECLARE_NO_COPY_CLASS(wxEvtHandler)
6164f93c 1933 DECLARE_DYNAMIC_CLASS(wxEvtHandler)
c801d85f
KB
1934};
1935
1936typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
e90c1d2a 1937#if wxUSE_GUI
c801d85f
KB
1938typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1939typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
c5b42c87 1940typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
c801d85f
KB
1941typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1942typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1943typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1944typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1945typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1946typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1947typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
456bc6d9 1948typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
c801d85f
KB
1949typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1950typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1951typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1952typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1953typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1954typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
574c939e 1955typedef void (wxEvtHandler::*wxDisplayChangedFunction)(wxDisplayChangedEvent&);
c801d85f
KB
1956typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1957typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1958typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1959typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1960typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1961typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
81d66cf3 1962typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS
1963typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1964typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
43b5058d
VZ
1965typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
1966typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
1967typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
669f7a11 1968typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
b96340e6 1969typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
69231000 1970typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
a5e84126 1971typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
e90c1d2a 1972#endif // wxUSE_GUI
c801d85f
KB
1973
1974// N.B. In GNU-WIN32, you *have* to take the address of a member function
1975// (use &) or the compiler crashes...
1976
1977#define DECLARE_EVENT_TABLE() \
2e4df4bf
VZ
1978 private: \
1979 static const wxEventTableEntry sm_eventTableEntries[]; \
1980 protected: \
1981 static const wxEventTable sm_eventTable; \
2b854a32 1982 virtual const wxEventTable* GetEventTable() const;
c801d85f
KB
1983
1984#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2e4df4bf
VZ
1985 const wxEventTable *theClass::GetEventTable() const \
1986 { return &theClass::sm_eventTable; } \
1987 const wxEventTable theClass::sm_eventTable = \
1988 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
1989 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
c801d85f 1990
33e29419 1991#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2b854a32 1992
c801d85f
KB
1993/*
1994 * Event table macros
1995 */
1996
1997// Generic events
2e4df4bf
VZ
1998#define EVT_CUSTOM(event, id, func) DECLARE_EVENT_TABLE_ENTRY( event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL ),
1999#define EVT_CUSTOM_RANGE(event, id1, id2, func) DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2000
2001// Miscellaneous
2e4df4bf
VZ
2002#define EVT_SIZE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL ),
2003#define EVT_MOVE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL ),
2004#define EVT_CLOSE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
2005#define EVT_END_SESSION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
2006#define EVT_QUERY_END_SESSION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
2007#define EVT_PAINT(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL ),
1e6feb95 2008#define EVT_NC_PAINT(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_NC_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL ),
2e4df4bf
VZ
2009#define EVT_ERASE_BACKGROUND(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL ),
2010#define EVT_CHAR(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
2011#define EVT_KEY_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
2012#define EVT_KEY_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
2013#define EVT_CHAR_HOOK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL ),
ccef86c7
VZ
2014#define EVT_MENU_OPEN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_OPEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
2015#define EVT_MENU_CLOSE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_CLOSE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
2e4df4bf
VZ
2016#define EVT_MENU_HIGHLIGHT(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
2017#define EVT_MENU_HIGHLIGHT_ALL(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
2018#define EVT_SET_FOCUS(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL ),
2019#define EVT_KILL_FOCUS(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL ),
456bc6d9 2020#define EVT_CHILD_FOCUS(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CHILD_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxChildFocusEventFunction) & func, (wxObject *) NULL ),
2e4df4bf
VZ
2021#define EVT_ACTIVATE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL ),
2022#define EVT_ACTIVATE_APP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL ),
2023#define EVT_END_SESSION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
2024#define EVT_QUERY_END_SESSION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
2025#define EVT_DROP_FILES(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL ),
2026#define EVT_INIT_DIALOG(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL ),
2027#define EVT_SYS_COLOUR_CHANGED(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL ),
574c939e 2028#define EVT_DISPLAY_CHANGED(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_DISPLAY_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDisplayChangedFunction) & func, (wxObject *) NULL ),
2e4df4bf
VZ
2029#define EVT_SHOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL ),
2030#define EVT_MAXIMIZE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL ),
2031#define EVT_ICONIZE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL ),
2032#define EVT_NAVIGATION_KEY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL ),
2033#define EVT_PALETTE_CHANGED(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL ),
2034#define EVT_QUERY_NEW_PALETTE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL ),
2035#define EVT_WINDOW_CREATE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowCreateEventFunction) & func, (wxObject *) NULL ),
2036#define EVT_WINDOW_DESTROY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowDestroyEventFunction) & func, (wxObject *) NULL ),
2037#define EVT_SET_CURSOR(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SET_CURSOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSetCursorEventFunction) & func, (wxObject *) NULL ),
a5e84126 2038#define EVT_MOUSE_CAPTURE_CHANGED(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOUSE_CAPTURE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseCaptureChangedEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2039
2040// Mouse events
2e4df4bf
VZ
2041#define EVT_LEFT_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2042#define EVT_LEFT_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2043#define EVT_MIDDLE_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2044#define EVT_MIDDLE_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2045#define EVT_RIGHT_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2046#define EVT_RIGHT_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2047#define EVT_MOTION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2048#define EVT_LEFT_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2049#define EVT_MIDDLE_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2050#define EVT_RIGHT_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2051#define EVT_LEAVE_WINDOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
2052#define EVT_ENTER_WINDOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
d2c52078 2053#define EVT_MOUSEWHEEL(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOUSEWHEEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2054
2055// All mouse events
2056#define EVT_MOUSE_EVENTS(func) \
2e4df4bf
VZ
2057 DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2058 DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2059 DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2060 DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2061 DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2062 DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2063 DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2064 DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2065 DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2066 DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2067 DECLARE_EVENT_TABLE_ENTRY( wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
d2c52078
RD
2068 DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
2069 DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOUSEWHEEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2070
2071// EVT_COMMAND
2e4df4bf
VZ
2072#define EVT_COMMAND(id, event, fn) DECLARE_EVENT_TABLE_ENTRY( event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2073#define EVT_COMMAND_RANGE(id1, id2, event, fn) DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
c801d85f 2074
c5b42c87
RR
2075// Scrolling from wxWindow (sent to wxScrolledWindow)
2076#define EVT_SCROLLWIN(func) \
2e4df4bf
VZ
2077 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2078 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2079 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2080 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2081 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2082 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2083 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
2084 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2085
2086#define EVT_SCROLLWIN_TOP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2087#define EVT_SCROLLWIN_BOTTOM(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2088#define EVT_SCROLLWIN_LINEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2089#define EVT_SCROLLWIN_LINEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2090#define EVT_SCROLLWIN_PAGEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2091#define EVT_SCROLLWIN_PAGEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2092#define EVT_SCROLLWIN_THUMBTRACK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
2093#define EVT_SCROLLWIN_THUMBRELEASE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
c5b42c87
RR
2094
2095// Scrolling from wxSlider and wxScrollBar
c801d85f 2096#define EVT_SCROLL(func) \
2e4df4bf
VZ
2097 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2098 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2099 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2100 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2101 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2102 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2103 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2104 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2105
2106#define EVT_SCROLL_TOP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2107#define EVT_SCROLL_BOTTOM(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2108#define EVT_SCROLL_LINEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2109#define EVT_SCROLL_LINEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2110#define EVT_SCROLL_PAGEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2111#define EVT_SCROLL_PAGEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2112#define EVT_SCROLL_THUMBTRACK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2113#define EVT_SCROLL_THUMBRELEASE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
c801d85f 2114
c5b42c87 2115// Scrolling from wxSlider and wxScrollBar, with an id
c801d85f 2116#define EVT_COMMAND_SCROLL(id, func) \
2e4df4bf
VZ
2117 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2118 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2119 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2120 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2121 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2122 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2123 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
2124 DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2125
2126#define EVT_COMMAND_SCROLL_TOP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2127#define EVT_COMMAND_SCROLL_BOTTOM(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2128#define EVT_COMMAND_SCROLL_LINEUP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2129#define EVT_COMMAND_SCROLL_LINEDOWN(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2130#define EVT_COMMAND_SCROLL_PAGEUP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2131#define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2132#define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
2133#define EVT_COMMAND_SCROLL_THUMBRELEASE(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2134
2135// Convenience macros for commonly-used commands
2e4df4bf
VZ
2136#define EVT_BUTTON(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2137#define EVT_CHECKBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2138#define EVT_CHOICE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2139#define EVT_LISTBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2140#define EVT_LISTBOX_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2e4df4bf
VZ
2141#define EVT_MENU(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2142#define EVT_MENU_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2143#define EVT_SLIDER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2144#define EVT_RADIOBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2145#define EVT_RADIOBUTTON(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
c801d85f 2146// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
2e4df4bf
VZ
2147#define EVT_SCROLLBAR(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2148#define EVT_VLBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2149#define EVT_COMBOBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2150#define EVT_TOOL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2151#define EVT_TOOL_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2152#define EVT_TOOL_RCLICKED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2153#define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2154#define EVT_TOOL_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2155#define EVT_CHECKLISTBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
c801d85f
KB
2156
2157// Generic command events
2e4df4bf
VZ
2158#define EVT_COMMAND_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2159#define EVT_COMMAND_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2160#define EVT_COMMAND_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2161#define EVT_COMMAND_RIGHT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2162#define EVT_COMMAND_SET_FOCUS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2163#define EVT_COMMAND_KILL_FOCUS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
2164#define EVT_COMMAND_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
c801d85f
KB
2165
2166// Joystick events
2167#define EVT_JOY_DOWN(func) \
2e4df4bf 2168 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
c801d85f 2169#define EVT_JOY_UP(func) \
2e4df4bf 2170 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
c801d85f 2171#define EVT_JOY_MOVE(func) \
2e4df4bf 2172 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
c801d85f 2173#define EVT_JOY_ZMOVE(func) \
2e4df4bf 2174 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2175
2176// All joystick events
2177#define EVT_JOYSTICK_EVENTS(func) \
2e4df4bf
VZ
2178 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
2179 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
2180 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
2181 DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2182
2183// Idle event
2184#define EVT_IDLE(func) \
2e4df4bf 2185 DECLARE_EVENT_TABLE_ENTRY( wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL ),
c801d85f
KB
2186
2187// Update UI event
2188#define EVT_UPDATE_UI(id, func) \
2e4df4bf 2189 DECLARE_EVENT_TABLE_ENTRY( wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL ),
3ca6a5f0 2190#define EVT_UPDATE_UI_RANGE(id1, id2, func) \
2e4df4bf 2191 DECLARE_EVENT_TABLE_ENTRY( wxEVT_UPDATE_UI, id1, id2, (wxObjectEventFunction)(wxEventFunction)(wxUpdateUIEventFunction)&func, (wxObject *) NULL ),
c801d85f 2192
b96340e6
JS
2193// Help events
2194#define EVT_HELP(id, func) \
2e4df4bf 2195 DECLARE_EVENT_TABLE_ENTRY( wxEVT_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
b96340e6
JS
2196
2197#define EVT_HELP_RANGE(id1, id2, func) \
2e4df4bf 2198 DECLARE_EVENT_TABLE_ENTRY( wxEVT_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
b96340e6 2199
fb6261e9 2200#define EVT_DETAILED_HELP(id, func) \
2e4df4bf 2201 DECLARE_EVENT_TABLE_ENTRY( wxEVT_DETAILED_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
fb6261e9
JS
2202
2203#define EVT_DETAILED_HELP_RANGE(id1, id2, func) \
2e4df4bf 2204 DECLARE_EVENT_TABLE_ENTRY( wxEVT_DETAILED_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
fb6261e9 2205
69231000
JS
2206// Context Menu Events
2207#define EVT_CONTEXT_MENU(func) \
2208 DECLARE_EVENT_TABLE_ENTRY(wxEVT_CONTEXT_MENU, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxContextMenuEventFunction) & func, (wxObject *) NULL ),
2209
8e193f38
VZ
2210// ----------------------------------------------------------------------------
2211// Global data
2212// ----------------------------------------------------------------------------
2213
2214// for pending event processing - notice that there is intentionally no
2215// WXDLLEXPORT here
2216extern wxList *wxPendingEvents;
2217#if wxUSE_THREADS
2218 extern wxCriticalSection *wxPendingEventsLocker;
2219#endif
2220
e90c1d2a
VZ
2221// ----------------------------------------------------------------------------
2222// Helper functions
2223// ----------------------------------------------------------------------------
2224
2225#if wxUSE_GUI
e702ff0f
JS
2226
2227// Find a window with the focus, that is also a descendant of the given window.
2228// This is used to determine the window to initially send commands to.
2229wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
2230
e90c1d2a
VZ
2231#endif // wxUSE_GUI
2232
c801d85f 2233#endif
2b854a32 2234 // _WX_EVENTH__