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