]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_event.i
docstring tweak
[wxWidgets.git] / wxPython / src / _event.i
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: _event.i
3 // Purpose: SWIG interface for common event classes and event binders
4 //
5 // Author: Robin Dunn
6 //
7 // Created: 24-May-1998
8 // RCS-ID: $Id$
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
12
13 // Not a %module
14
15
16 //---------------------------------------------------------------------------
17 // Include some extra python code here
18 %pythoncode "_event_ex.py"
19
20 //---------------------------------------------------------------------------
21 %newgroup;
22
23 // the predefined constants for the number of times we propagate event
24 // upwards window child-parent chain
25 enum Propagation_state
26 {
27 // don't propagate it at all
28 wxEVENT_PROPAGATE_NONE = 0,
29
30 // propagate it until it is processed
31 wxEVENT_PROPAGATE_MAX = INT_MAX
32 };
33
34
35 //---------------------------------------------------------------------------
36 // Event types
37
38 wxEventType wxNewEventType();
39
40
41 %constant wxEventType wxEVT_NULL;
42 %constant wxEventType wxEVT_FIRST;
43 %constant wxEventType wxEVT_USER_FIRST;
44
45 %constant wxEventType wxEVT_COMMAND_BUTTON_CLICKED;
46 %constant wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED;
47 %constant wxEventType wxEVT_COMMAND_CHOICE_SELECTED;
48 %constant wxEventType wxEVT_COMMAND_LISTBOX_SELECTED;
49 %constant wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
50 %constant wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED;
51
52 %constant wxEventType wxEVT_COMMAND_MENU_SELECTED;
53 %constant wxEventType wxEVT_COMMAND_TOOL_CLICKED;
54 %constant wxEventType wxEVT_COMMAND_SLIDER_UPDATED;
55 %constant wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED;
56 %constant wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED;
57
58 %constant wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED;
59 %constant wxEventType wxEVT_COMMAND_VLBOX_SELECTED;
60 %constant wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED;
61 %constant wxEventType wxEVT_COMMAND_TOOL_RCLICKED;
62 %constant wxEventType wxEVT_COMMAND_TOOL_ENTER;
63
64 // Mouse event types
65 %constant wxEventType wxEVT_LEFT_DOWN;
66 %constant wxEventType wxEVT_LEFT_UP;
67 %constant wxEventType wxEVT_MIDDLE_DOWN;
68 %constant wxEventType wxEVT_MIDDLE_UP;
69 %constant wxEventType wxEVT_RIGHT_DOWN;
70 %constant wxEventType wxEVT_RIGHT_UP;
71 %constant wxEventType wxEVT_MOTION;
72 %constant wxEventType wxEVT_ENTER_WINDOW;
73 %constant wxEventType wxEVT_LEAVE_WINDOW;
74 %constant wxEventType wxEVT_LEFT_DCLICK;
75 %constant wxEventType wxEVT_MIDDLE_DCLICK;
76 %constant wxEventType wxEVT_RIGHT_DCLICK;
77 %constant wxEventType wxEVT_SET_FOCUS;
78 %constant wxEventType wxEVT_KILL_FOCUS;
79 %constant wxEventType wxEVT_CHILD_FOCUS;
80 %constant wxEventType wxEVT_MOUSEWHEEL;
81
82 // Non-client mouse events
83 %constant wxEventType wxEVT_NC_LEFT_DOWN;
84 %constant wxEventType wxEVT_NC_LEFT_UP;
85 %constant wxEventType wxEVT_NC_MIDDLE_DOWN;
86 %constant wxEventType wxEVT_NC_MIDDLE_UP;
87 %constant wxEventType wxEVT_NC_RIGHT_DOWN;
88 %constant wxEventType wxEVT_NC_RIGHT_UP;
89 %constant wxEventType wxEVT_NC_MOTION;
90 %constant wxEventType wxEVT_NC_ENTER_WINDOW;
91 %constant wxEventType wxEVT_NC_LEAVE_WINDOW;
92 %constant wxEventType wxEVT_NC_LEFT_DCLICK;
93 %constant wxEventType wxEVT_NC_MIDDLE_DCLICK;
94 %constant wxEventType wxEVT_NC_RIGHT_DCLICK;
95
96 // Character input event type
97 %constant wxEventType wxEVT_CHAR;
98 %constant wxEventType wxEVT_CHAR_HOOK;
99 %constant wxEventType wxEVT_NAVIGATION_KEY;
100 %constant wxEventType wxEVT_KEY_DOWN;
101 %constant wxEventType wxEVT_KEY_UP;
102 %constant wxEventType wxEVT_HOTKEY;
103
104 // Set cursor event
105 %constant wxEventType wxEVT_SET_CURSOR;
106
107 // wxScrollBar and wxSlider event identifiers
108 %constant wxEventType wxEVT_SCROLL_TOP;
109 %constant wxEventType wxEVT_SCROLL_BOTTOM;
110 %constant wxEventType wxEVT_SCROLL_LINEUP;
111 %constant wxEventType wxEVT_SCROLL_LINEDOWN;
112 %constant wxEventType wxEVT_SCROLL_PAGEUP;
113 %constant wxEventType wxEVT_SCROLL_PAGEDOWN;
114 %constant wxEventType wxEVT_SCROLL_THUMBTRACK;
115 %constant wxEventType wxEVT_SCROLL_THUMBRELEASE;
116 %constant wxEventType wxEVT_SCROLL_ENDSCROLL;
117
118 // Scroll events from wxWindow
119 %constant wxEventType wxEVT_SCROLLWIN_TOP;
120 %constant wxEventType wxEVT_SCROLLWIN_BOTTOM;
121 %constant wxEventType wxEVT_SCROLLWIN_LINEUP;
122 %constant wxEventType wxEVT_SCROLLWIN_LINEDOWN;
123 %constant wxEventType wxEVT_SCROLLWIN_PAGEUP;
124 %constant wxEventType wxEVT_SCROLLWIN_PAGEDOWN;
125 %constant wxEventType wxEVT_SCROLLWIN_THUMBTRACK;
126 %constant wxEventType wxEVT_SCROLLWIN_THUMBRELEASE;
127
128 // System events
129 %constant wxEventType wxEVT_SIZE;
130 %constant wxEventType wxEVT_MOVE;
131 %constant wxEventType wxEVT_CLOSE_WINDOW;
132 %constant wxEventType wxEVT_END_SESSION;
133 %constant wxEventType wxEVT_QUERY_END_SESSION;
134 %constant wxEventType wxEVT_ACTIVATE_APP;
135 %constant wxEventType wxEVT_POWER;
136 %constant wxEventType wxEVT_ACTIVATE;
137 %constant wxEventType wxEVT_CREATE;
138 %constant wxEventType wxEVT_DESTROY;
139 %constant wxEventType wxEVT_SHOW;
140 %constant wxEventType wxEVT_ICONIZE;
141 %constant wxEventType wxEVT_MAXIMIZE;
142 %constant wxEventType wxEVT_MOUSE_CAPTURE_CHANGED;
143 %constant wxEventType wxEVT_PAINT;
144 %constant wxEventType wxEVT_ERASE_BACKGROUND;
145 %constant wxEventType wxEVT_NC_PAINT;
146 %constant wxEventType wxEVT_PAINT_ICON;
147 %constant wxEventType wxEVT_MENU_OPEN;
148 %constant wxEventType wxEVT_MENU_CLOSE;
149 %constant wxEventType wxEVT_MENU_HIGHLIGHT;
150
151 %constant wxEventType wxEVT_CONTEXT_MENU;
152 %constant wxEventType wxEVT_SYS_COLOUR_CHANGED;
153 %constant wxEventType wxEVT_DISPLAY_CHANGED;
154 %constant wxEventType wxEVT_SETTING_CHANGED;
155 %constant wxEventType wxEVT_QUERY_NEW_PALETTE;
156 %constant wxEventType wxEVT_PALETTE_CHANGED;
157 %constant wxEventType wxEVT_DROP_FILES;
158 %constant wxEventType wxEVT_DRAW_ITEM;
159 %constant wxEventType wxEVT_MEASURE_ITEM;
160 %constant wxEventType wxEVT_COMPARE_ITEM;
161 %constant wxEventType wxEVT_INIT_DIALOG;
162 %constant wxEventType wxEVT_IDLE;
163 %constant wxEventType wxEVT_UPDATE_UI;
164 %constant wxEventType wxEVT_SIZING;
165 %constant wxEventType wxEVT_MOVING;
166
167 // Generic command events
168 // Note: a click is a higher-level event than button down/up
169 %constant wxEventType wxEVT_COMMAND_LEFT_CLICK;
170 %constant wxEventType wxEVT_COMMAND_LEFT_DCLICK;
171 %constant wxEventType wxEVT_COMMAND_RIGHT_CLICK;
172 %constant wxEventType wxEVT_COMMAND_RIGHT_DCLICK;
173 %constant wxEventType wxEVT_COMMAND_SET_FOCUS;
174 %constant wxEventType wxEVT_COMMAND_KILL_FOCUS;
175 %constant wxEventType wxEVT_COMMAND_ENTER;
176
177
178
179 %pythoncode {
180 %#
181 %# Create some event binders
182 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
183 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
184 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
185 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
186 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
187 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
188 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
189 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
190 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
191 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
192 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
193 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
194 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
195 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
196 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
197 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
198 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
199 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
200 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
201 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
202 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
203 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
204 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
205 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
206 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
207 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
208 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
209 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
210 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
211 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
212 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
213 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
214 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
215 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
216 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
217 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
218 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
219 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
220 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
221 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
222
223 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
224 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
225 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
226 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
227 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
228 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
229 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
230 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
231 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
232 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
233 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
234 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
235 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
236
237 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
238 wxEVT_LEFT_UP,
239 wxEVT_MIDDLE_DOWN,
240 wxEVT_MIDDLE_UP,
241 wxEVT_RIGHT_DOWN,
242 wxEVT_RIGHT_UP,
243 wxEVT_MOTION,
244 wxEVT_LEFT_DCLICK,
245 wxEVT_MIDDLE_DCLICK,
246 wxEVT_RIGHT_DCLICK,
247 wxEVT_ENTER_WINDOW,
248 wxEVT_LEAVE_WINDOW,
249 wxEVT_MOUSEWHEEL
250 ])
251
252
253 %# Scrolling from wxWindow (sent to wxScrolledWindow)
254 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
255 wxEVT_SCROLLWIN_BOTTOM,
256 wxEVT_SCROLLWIN_LINEUP,
257 wxEVT_SCROLLWIN_LINEDOWN,
258 wxEVT_SCROLLWIN_PAGEUP,
259 wxEVT_SCROLLWIN_PAGEDOWN,
260 wxEVT_SCROLLWIN_THUMBTRACK,
261 wxEVT_SCROLLWIN_THUMBRELEASE,
262 ])
263
264 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
265 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
266 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
267 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
268 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
269 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
270 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
271 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
272
273 %# Scrolling from wxSlider and wxScrollBar
274 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
275 wxEVT_SCROLL_BOTTOM,
276 wxEVT_SCROLL_LINEUP,
277 wxEVT_SCROLL_LINEDOWN,
278 wxEVT_SCROLL_PAGEUP,
279 wxEVT_SCROLL_PAGEDOWN,
280 wxEVT_SCROLL_THUMBTRACK,
281 wxEVT_SCROLL_THUMBRELEASE,
282 wxEVT_SCROLL_ENDSCROLL,
283 ])
284
285 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
286 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
287 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
288 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
289 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
290 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
291 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
292 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
293 EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
294
295 %# Scrolling from wxSlider and wxScrollBar, with an id
296 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
297 wxEVT_SCROLL_BOTTOM,
298 wxEVT_SCROLL_LINEUP,
299 wxEVT_SCROLL_LINEDOWN,
300 wxEVT_SCROLL_PAGEUP,
301 wxEVT_SCROLL_PAGEDOWN,
302 wxEVT_SCROLL_THUMBTRACK,
303 wxEVT_SCROLL_THUMBRELEASE,
304 wxEVT_SCROLL_ENDSCROLL,
305 ], 1)
306
307 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
308 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
309 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
310 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
311 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
312 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
313 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
314 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
315 EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
316
317 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
318 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
319 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
320 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
321 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
322 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
323 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
324 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
325 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
326 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
327
328 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
329 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
330 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
331 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
332 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
333 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
334 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
335 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
336 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
337
338
339 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
340 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
341 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
342 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
343 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
344 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
345 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
346
347 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
348
349 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
350 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
351
352 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
353
354
355 }
356
357 //---------------------------------------------------------------------------
358 %newgroup;
359
360 class wxEvent : public wxObject {
361 public:
362 // wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL); // *** This class is now an ABC
363 ~wxEvent();
364
365 void SetEventType(wxEventType typ);
366 wxEventType GetEventType() const;
367 wxObject *GetEventObject() const;
368 void SetEventObject(wxObject *obj);
369 long GetTimestamp() const;
370 void SetTimestamp(long ts = 0);
371 int GetId() const;
372 void SetId(int Id);
373
374
375 bool IsCommandEvent() const;
376
377 // Can instruct event processor that we wish to ignore this event
378 // (treat as if the event table entry had not been found): this must be done
379 // to allow the event processing by the base classes (calling event.Skip()
380 // is the analog of calling the base class verstion of a virtual function)
381 void Skip(bool skip = True);
382 bool GetSkipped() const;
383
384 // Determine if this event should be propagating to the parent window.
385 bool ShouldPropagate() const;
386
387 // Stop an event from propagating to its parent window, returns the old
388 // propagation level value
389 int StopPropagation();
390
391 // Resume the event propagation by restoring the propagation level
392 // (returned by StopPropagation())
393 void ResumePropagation(int propagationLevel);
394
395 // this function is used to create a copy of the event polymorphically and
396 // all derived classes must implement it because otherwise wxPostEvent()
397 // for them wouldn't work (it needs to do a copy of the event)
398 virtual wxEvent *Clone() /* =0*/;
399 };
400
401
402 //---------------------------------------------------------------------------
403 %newgroup;
404
405 // Helper class to temporarily change an event not to propagate.
406 class wxPropagationDisabler
407 {
408 public:
409 wxPropagationDisabler(wxEvent& event);
410 ~wxPropagationDisabler();
411 };
412
413
414 // Another one to temporarily lower propagation level.
415 class wxPropagateOnce
416 {
417 public:
418 wxPropagateOnce(wxEvent& event);
419 ~wxPropagateOnce();
420 };
421
422 //---------------------------------------------------------------------------
423 %newgroup;
424
425 class wxCommandEvent : public wxEvent
426 {
427 public:
428 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
429
430
431 // // Set/Get client data from controls
432 // void SetClientData(void* clientData) { m_clientData = clientData; }
433 // void *GetClientData() const { return m_clientData; }
434
435 // // Set/Get client object from controls
436 // void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
437 // void *GetClientObject() const { return m_clientObject; }
438
439
440 // Get listbox selection if single-choice
441 int GetSelection() const;
442
443 // Set/Get listbox/choice selection string
444 void SetString(const wxString& s);
445 wxString GetString() const;
446
447 // Get checkbox value
448 bool IsChecked() const;
449 %pythoncode { Checked = IsChecked }
450
451 // True if the listbox event was a selection.
452 bool IsSelection() const;
453
454 void SetExtraLong(long extraLong);
455 long GetExtraLong() const;
456
457 void SetInt(int i);
458 long GetInt() const;
459
460 virtual wxEvent *Clone() const;
461
462 };
463
464 //---------------------------------------------------------------------------
465 %newgroup;
466
467 // this class adds a possibility to react (from the user) code to a control
468 // notification: allow or veto the operation being reported.
469 class wxNotifyEvent : public wxCommandEvent
470 {
471 public:
472 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
473
474 // veto the operation (usually it's allowed by default)
475 void Veto();
476
477 // allow the operation if it was disabled by default
478 void Allow();
479
480 // for implementation code only: is the operation allowed?
481 bool IsAllowed();
482 };
483
484
485 //---------------------------------------------------------------------------
486 %newgroup;
487
488 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
489 // sent by wxSlider and wxScrollBar.
490 class wxScrollEvent : public wxCommandEvent
491 {
492 public:
493 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
494 int winid = 0, int pos = 0, int orient = 0);
495
496 int GetOrientation() const;
497 int GetPosition() const;
498 void SetOrientation(int orient);
499 void SetPosition(int pos);
500 };
501
502
503 //---------------------------------------------------------------------------
504 %newgroup;
505
506 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
507 // are sent by wxWindow.
508 class wxScrollWinEvent : public wxEvent
509 {
510 public:
511 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
512 int pos = 0, int orient = 0);
513
514 int GetOrientation() const;
515 int GetPosition() const;
516 void SetOrientation(int orient);
517 void SetPosition(int pos);
518 };
519
520 //---------------------------------------------------------------------------
521 %newgroup;
522
523 // the symbolic names for the mouse buttons
524 enum
525 {
526 wxMOUSE_BTN_ANY = -1,
527 wxMOUSE_BTN_NONE = -1,
528 wxMOUSE_BTN_LEFT = 0,
529 wxMOUSE_BTN_MIDDLE = 1,
530 wxMOUSE_BTN_RIGHT = 2
531 };
532
533
534 // Mouse event class
535 class wxMouseEvent : public wxEvent
536 {
537 public:
538 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
539
540 // Was it a button event? (*doesn't* mean: is any button *down*?)
541 bool IsButton() const;
542
543 // Was it a down event from this (or any) button?
544 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
545
546 // Was it a dclick event from this (or any) button?
547 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
548
549 // Was it a up event from this (or any) button?
550 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
551
552 // Was the given button changing state?
553 bool Button(int but) const;
554
555 // Was the given button in Down state?
556 bool ButtonIsDown(int but) const;
557
558 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
559 int GetButton() const;
560
561 // Find state of shift/control keys
562 bool ControlDown() const;
563 bool MetaDown() const;
564 bool AltDown() const;
565 bool ShiftDown() const;
566
567 // Find which event was just generated
568 bool LeftDown() const;
569 bool MiddleDown() const;
570 bool RightDown() const;
571
572 bool LeftUp() const;
573 bool MiddleUp() const;
574 bool RightUp() const;
575
576 bool LeftDClick() const;
577 bool MiddleDClick() const;
578 bool RightDClick() const;
579
580 // Find the current state of the mouse buttons (regardless
581 // of current event type)
582 bool LeftIsDown();
583 bool MiddleIsDown();
584 bool RightIsDown();
585
586 // True if a button is down and the mouse is moving
587 bool Dragging() const;
588
589 // True if the mouse is moving, and no button is down
590 bool Moving() const;
591
592 // True if the mouse is just entering the window
593 bool Entering() const;
594
595 // True if the mouse is just leaving the window
596 bool Leaving() const;
597
598
599 DocStr(GetPosition, // sets the docstring for both
600 "Returns the position of the mouse in window coordinates when the event happened.");
601 wxPoint GetPosition();
602
603 DocDeclAName(
604 void, GetPosition(long *OUTPUT, long *OUTPUT),
605 "GetPositionTuple() -> (x,y)",
606 GetPositionTuple);
607
608 // Find the logical position of the event given the DC
609 wxPoint GetLogicalPosition(const wxDC& dc) const;
610
611 // Get X position
612 wxCoord GetX() const;
613
614 // Get Y position
615 wxCoord GetY() const;
616
617 // Get wheel rotation, positive or negative indicates direction of
618 // rotation. Current devices all send an event when rotation is equal to
619 // +/-WheelDelta, but this allows for finer resolution devices to be
620 // created in the future. Because of this you shouldn't assume that one
621 // event is equal to 1 line or whatever, but you should be able to either
622 // do partial line scrolling or wait until +/-WheelDelta rotation values
623 // have been accumulated before scrolling.
624 int GetWheelRotation() const;
625
626 // Get wheel delta, normally 120. This is the threshold for action to be
627 // taken, and one such action (for example, scrolling one increment)
628 // should occur for each delta.
629 int GetWheelDelta() const;
630
631 // Returns the configured number of lines (or whatever) to be scrolled per
632 // wheel action. Defaults to one.
633 int GetLinesPerAction() const;
634
635 // Is the system set to do page scrolling?
636 bool IsPageScroll() const;
637
638 public:
639 wxCoord m_x, m_y;
640
641 bool m_leftDown;
642 bool m_middleDown;
643 bool m_rightDown;
644
645 bool m_controlDown;
646 bool m_shiftDown;
647 bool m_altDown;
648 bool m_metaDown;
649
650 int m_wheelRotation;
651 int m_wheelDelta;
652 int m_linesPerAction;
653 };
654
655 //---------------------------------------------------------------------------
656 %newgroup;
657
658 // Cursor set event
659 class wxSetCursorEvent : public wxEvent
660 {
661 public:
662 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0);
663
664 wxCoord GetX() const;
665 wxCoord GetY() const;
666
667 void SetCursor(const wxCursor& cursor);
668 const wxCursor& GetCursor() const;
669 bool HasCursor() const;
670 };
671
672 //---------------------------------------------------------------------------
673 %newgroup;
674
675 // Keyboard input event class
676
677 class wxKeyEvent : public wxEvent
678 {
679 public:
680 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
681
682 // Find state of shift/control keys
683 bool ControlDown() const;
684 bool MetaDown() const;
685 bool AltDown() const;
686 bool ShiftDown() const;
687
688 // exclude MetaDown() from HasModifiers() because NumLock under X is often
689 // configured as mod2 modifier, yet the key events even when it is pressed
690 // should be processed normally, not like Ctrl- or Alt-key
691 bool HasModifiers() const;
692
693 // get the key code: an ASCII7 char or an element of wxKeyCode enum
694 int GetKeyCode() const;
695 %pythoncode { KeyCode = GetKeyCode }
696
697 %extend {
698 int GetUniChar() {
699 %#if wxUSE_UNICODE
700 return self->m_uniChar;
701 %#else
702 return 0;
703 %#endif
704 }
705 }
706
707 // get the raw key code (platform-dependent)
708 wxUint32 GetRawKeyCode() const;
709
710 // get the raw key flags (platform-dependent)
711 wxUint32 GetRawKeyFlags() const;
712
713
714 DocStr(GetPosition, // sets the docstring for both
715 "Find the position of the event.");
716 wxPoint GetPosition();
717
718 DocDeclAName(
719 void, GetPosition(long *OUTPUT, long *OUTPUT),
720 "GetPositionTuple() -> (x,y)",
721 GetPositionTuple);
722
723 // Get X position
724 wxCoord GetX() const;
725
726 // Get Y position
727 wxCoord GetY() const;
728
729 public:
730 wxCoord m_x, m_y;
731
732 long m_keyCode;
733
734 bool m_controlDown;
735 bool m_shiftDown;
736 bool m_altDown;
737 bool m_metaDown;
738 bool m_scanCode;
739
740 // these fields contain the platform-specific information about
741 // key that was pressed
742 wxUint32 m_rawCode;
743 wxUint32 m_rawFlags;
744 };
745
746 //---------------------------------------------------------------------------
747 %newgroup;
748
749 // Size event class
750 class wxSizeEvent : public wxEvent
751 {
752 public:
753 wxSizeEvent(const wxSize& sz=wxDefaultSize, int winid = 0);
754
755 wxSize GetSize() const;
756 wxRect GetRect() const;
757 void SetRect(wxRect rect);
758 %extend {
759 void SetSize(wxSize size) {
760 self->m_size = size;
761 }
762 }
763
764 public:
765 wxSize m_size;
766 wxRect m_rect; // Used for wxEVT_SIZING
767 };
768
769
770 //---------------------------------------------------------------------------
771 %newgroup;
772
773 // Move event class
774 class wxMoveEvent : public wxEvent
775 {
776 public:
777 wxMoveEvent(const wxPoint& pos=wxDefaultPosition, int winid = 0);
778
779 wxPoint GetPosition() const;
780 wxRect GetRect() const;
781 void SetRect(wxRect rect);
782 %extend {
783 void SetPosition(wxPoint pos) {
784 self->m_pos = pos;
785 }
786 }
787
788 wxPoint m_pos;
789 wxRect m_rect;
790 };
791
792 //---------------------------------------------------------------------------
793 %newgroup;
794
795 // Paint event class
796 class wxPaintEvent : public wxEvent
797 {
798 public:
799 wxPaintEvent(int Id = 0);
800 };
801
802
803 class wxNcPaintEvent : public wxEvent
804 {
805 public:
806 wxNcPaintEvent(int winid = 0);
807 };
808
809 //---------------------------------------------------------------------------
810 %newgroup;
811
812 class wxEraseEvent : public wxEvent
813 {
814 public:
815 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL);
816
817 wxDC *GetDC() const;
818 };
819
820
821 //---------------------------------------------------------------------------
822 %newgroup;
823
824 class wxFocusEvent : public wxEvent
825 {
826 public:
827 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0);
828
829 // The window associated with this event is the window which had focus
830 // before for SET event and the window which will have focus for the KILL
831 // one. NB: it may be NULL in both cases!
832 wxWindow *GetWindow() const;
833 void SetWindow(wxWindow *win);
834 };
835
836 //---------------------------------------------------------------------------
837 %newgroup;
838
839 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
840 // wxFocusEvent it is propagated upwards the window chain
841 class wxChildFocusEvent : public wxCommandEvent
842 {
843 public:
844 wxChildFocusEvent(wxWindow *win = NULL);
845
846 wxWindow *GetWindow() const;
847 };
848
849 //---------------------------------------------------------------------------
850 %newgroup;
851
852 class wxActivateEvent : public wxEvent
853 {
854 public:
855 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = True, int Id = 0);
856 bool GetActive() const;
857 };
858
859
860 //---------------------------------------------------------------------------
861 %newgroup;
862
863 class wxInitDialogEvent : public wxEvent
864 {
865 public:
866 wxInitDialogEvent(int Id = 0);
867 };
868
869
870 //---------------------------------------------------------------------------
871 %newgroup;
872
873 class wxMenuEvent : public wxEvent
874 {
875 public:
876 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL);
877
878 // only for wxEVT_MENU_HIGHLIGHT
879 int GetMenuId() const;
880
881 // only for wxEVT_MENU_OPEN/CLOSE
882 bool IsPopup() const;
883
884 // only for wxEVT_MENU_OPEN/CLOSE
885 wxMenu* GetMenu() const;
886 };
887
888 //---------------------------------------------------------------------------
889 %newgroup;
890
891 // Window close or session close event class
892 class wxCloseEvent : public wxEvent
893 {
894 public:
895 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0);
896
897 void SetLoggingOff(bool logOff);
898 bool GetLoggingOff() const;
899
900 void Veto(bool veto = True);
901 void SetCanVeto(bool canVeto);
902
903 bool CanVeto() const;
904 bool GetVeto() const;
905 };
906
907
908 //---------------------------------------------------------------------------
909 %newgroup;
910
911 class wxShowEvent : public wxEvent
912 {
913 public:
914 wxShowEvent(int winid = 0, bool show = False);
915
916 void SetShow(bool show);
917 bool GetShow() const;
918
919 };
920
921
922 //---------------------------------------------------------------------------
923 %newgroup;
924
925 class wxIconizeEvent: public wxEvent
926 {
927 public:
928 wxIconizeEvent(int id = 0, bool iconized = True);
929 bool Iconized();
930 };
931
932
933 //---------------------------------------------------------------------------
934 %newgroup;
935
936 class wxMaximizeEvent: public wxEvent
937 {
938 public:
939 wxMaximizeEvent(int id = 0);
940 };
941
942 //---------------------------------------------------------------------------
943 %newgroup;
944
945 class wxDropFilesEvent: public wxEvent
946 {
947 public:
948 wxPoint GetPosition();
949 int GetNumberOfFiles();
950
951 %extend {
952 PyObject* GetFiles() {
953 int count = self->GetNumberOfFiles();
954 wxString* files = self->GetFiles();
955 PyObject* list = PyList_New(count);
956
957 if (!list) {
958 PyErr_SetString(PyExc_MemoryError, "Can't allocate list of files!");
959 return NULL;
960 }
961
962 for (int i=0; i<count; i++) {
963 PyList_SetItem(list, i, wx2PyString(files[i]));
964 }
965 return list;
966 }
967 }
968 };
969
970
971
972 //---------------------------------------------------------------------------
973 %newgroup;
974
975
976 // Whether to always send update events to windows, or
977 // to only send update events to those with the
978 // wxWS_EX_PROCESS_UI_UPDATES style.
979
980 enum wxUpdateUIMode
981 {
982 // Send UI update events to all windows
983 wxUPDATE_UI_PROCESS_ALL,
984
985 // Send UI update events to windows that have
986 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
987 wxUPDATE_UI_PROCESS_SPECIFIED
988 };
989
990
991
992 class wxUpdateUIEvent : public wxCommandEvent
993 {
994 public:
995 wxUpdateUIEvent(wxWindowID commandId = 0);
996
997 bool GetChecked() const;
998 bool GetEnabled() const;
999 wxString GetText() const;
1000 bool GetSetText() const;
1001 bool GetSetChecked() const;
1002 bool GetSetEnabled() const;
1003
1004 void Check(bool check);
1005 void Enable(bool enable);
1006 void SetText(const wxString& text);
1007
1008 // Sets the interval between updates in milliseconds.
1009 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1010 static void SetUpdateInterval(long updateInterval);
1011
1012 // Returns the current interval between updates in milliseconds
1013 static long GetUpdateInterval();
1014
1015 // Can we update this window?
1016 static bool CanUpdate(wxWindow *win);
1017
1018 // Reset the update time to provide a delay until the next
1019 // time we should update
1020 static void ResetUpdateTime();
1021
1022 // Specify how wxWindows will send update events: to
1023 // all windows, or only to those which specify that they
1024 // will process the events.
1025 static void SetMode(wxUpdateUIMode mode);
1026
1027 // Returns the UI update mode
1028 static wxUpdateUIMode GetMode();
1029 };
1030
1031 //---------------------------------------------------------------------------
1032 %newgroup;
1033
1034 class wxSysColourChangedEvent: public wxEvent {
1035 public:
1036 wxSysColourChangedEvent();
1037 };
1038
1039 //---------------------------------------------------------------------------
1040 %newgroup;
1041
1042
1043 // wxEVT_MOUSE_CAPTURE_CHANGED
1044 // The window losing the capture receives this message
1045 // (even if it released the capture itself).
1046 class wxMouseCaptureChangedEvent : public wxEvent
1047 {
1048 public:
1049 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL);
1050
1051 wxWindow* GetCapturedWindow() const;
1052 };
1053
1054 //---------------------------------------------------------------------------
1055 %newgroup;
1056
1057 class wxDisplayChangedEvent : public wxEvent
1058 {
1059 public:
1060 wxDisplayChangedEvent();
1061 };
1062
1063 //---------------------------------------------------------------------------
1064 %newgroup;
1065
1066 class wxPaletteChangedEvent : public wxEvent
1067 {
1068 public:
1069 wxPaletteChangedEvent(wxWindowID id = 0);
1070
1071 void SetChangedWindow(wxWindow* win);
1072 wxWindow* GetChangedWindow();
1073
1074 };
1075
1076 //---------------------------------------------------------------------------
1077 %newgroup;
1078
1079
1080 // wxEVT_QUERY_NEW_PALETTE
1081 // Indicates the window is getting keyboard focus and should re-do its palette.
1082 class wxQueryNewPaletteEvent : public wxEvent
1083 {
1084 public:
1085 wxQueryNewPaletteEvent(wxWindowID winid = 0);
1086
1087 // App sets this if it changes the palette.
1088 void SetPaletteRealized(bool realized);
1089 bool GetPaletteRealized() const;
1090 };
1091
1092 //---------------------------------------------------------------------------
1093 %newgroup;
1094
1095
1096 // Event generated by dialog navigation keys
1097 // wxEVT_NAVIGATION_KEY
1098
1099 class wxNavigationKeyEvent : public wxEvent
1100 {
1101 public:
1102 wxNavigationKeyEvent();
1103
1104 // direction: forward (True) or backward (False)
1105 bool GetDirection() const;
1106 void SetDirection(bool bForward);
1107
1108 // it may be a window change event (MDI, notebook pages...) or a control
1109 // change event
1110 bool IsWindowChange() const;
1111 void SetWindowChange(bool bIs);
1112
1113 // the child which has the focus currently (may be NULL - use
1114 // wxWindow::FindFocus then)
1115 wxWindow* GetCurrentFocus() const;
1116 void SetCurrentFocus(wxWindow *win);
1117 };
1118
1119
1120 //---------------------------------------------------------------------------
1121 %newgroup;
1122
1123 // Window creation/destruction events: the first is sent as soon as window is
1124 // created (i.e. the underlying GUI object exists), but when the C++ object is
1125 // fully initialized (so virtual functions may be called). The second,
1126 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1127 // still safe to call virtual functions at this moment
1128
1129 class wxWindowCreateEvent : public wxCommandEvent
1130 {
1131 public:
1132 wxWindowCreateEvent(wxWindow *win = NULL);
1133 wxWindow *GetWindow() const;
1134 };
1135
1136 class wxWindowDestroyEvent : public wxCommandEvent
1137 {
1138 public:
1139 wxWindowDestroyEvent(wxWindow *win = NULL);
1140 wxWindow *GetWindow() const;
1141 };
1142
1143
1144 //---------------------------------------------------------------------------
1145 %newgroup;
1146
1147 // A Context event is sent when the user right clicks on a window or
1148 // presses Shift-F10
1149 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
1150 // Under other systems it may have to be generated from a right click event
1151 /*
1152 wxEVT_CONTEXT_MENU
1153 */
1154
1155 class wxContextMenuEvent : public wxCommandEvent
1156 {
1157 public:
1158 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
1159 wxWindowID winid = 0,
1160 const wxPoint& pt = wxDefaultPosition);
1161
1162 // Position of event (in screen coordinates)
1163 const wxPoint& GetPosition() const;
1164 void SetPosition(const wxPoint& pos);
1165 };
1166
1167 //---------------------------------------------------------------------------
1168 %newgroup;
1169
1170 // Whether to always send idle events to windows, or
1171 // to only send update events to those with the
1172 // wxWS_EX_PROCESS_IDLE style.
1173
1174 enum wxIdleMode
1175 {
1176 // Send idle events to all windows
1177 wxIDLE_PROCESS_ALL,
1178
1179 // Send idle events to windows that have
1180 // the wxWS_EX_PROCESS_IDLE flag specified
1181 wxIDLE_PROCESS_SPECIFIED
1182 };
1183
1184
1185 class wxIdleEvent : public wxEvent
1186 {
1187 public:
1188 wxIdleEvent();
1189
1190 void RequestMore(bool needMore = True);
1191 bool MoreRequested() const;
1192
1193 // Specify how wxWindows will send idle events: to
1194 // all windows, or only to those which specify that they
1195 // will process the events.
1196 static void SetMode(wxIdleMode mode);
1197
1198 // Returns the idle event mode
1199 static wxIdleMode GetMode();
1200
1201 // Can we send an idle event?
1202 static bool CanSend(wxWindow* win);
1203 };
1204
1205 //---------------------------------------------------------------------------
1206 %newgroup;
1207
1208 // These classes can be derived from in Python and passed through the event
1209 // system without loosing anything. They do this by keeping a reference to
1210 // themselves and some special case handling in wxPyCallback::EventThunker.
1211
1212 class wxPyEvent : public wxEvent {
1213 public:
1214 %pythonAppend wxPyEvent "self.SetSelf(self)"
1215 wxPyEvent(int winid=0, wxEventType commandType = wxEVT_NULL );
1216 ~wxPyEvent();
1217
1218
1219 void SetSelf(PyObject* self);
1220 PyObject* GetSelf();
1221 };
1222
1223
1224 class wxPyCommandEvent : public wxCommandEvent {
1225 public:
1226 %pythonAppend wxPyCommandEvent "self.SetSelf(self)"
1227 wxPyCommandEvent(wxEventType commandType = wxEVT_NULL, int id=0);
1228 ~wxPyCommandEvent();
1229
1230 void SetSelf(PyObject* self);
1231 PyObject* GetSelf();
1232 };
1233
1234
1235
1236 //---------------------------------------------------------------------------
1237
1238
1239