1 # This file was created automatically by SWIG 1.3.27.
2 # Don't modify this file, modify the SWIG interface instead.
6 def _swig_setattr_nondynamic(self
,class_type
,name
,value
,static
=1):
8 if isinstance(value
, class_type
):
9 self
.__dict
__[name
] = value
.this
10 if hasattr(value
,"thisown"): self
.__dict
__["thisown"] = value
.thisown
13 method
= class_type
.__swig
_setmethods
__.get(name
,None)
14 if method
: return method(self
,value
)
15 if (not static
) or hasattr(self
,name
) or (name
== "thisown"):
16 self
.__dict
__[name
] = value
18 raise AttributeError("You cannot add attributes to %s" % self
)
20 def _swig_setattr(self
,class_type
,name
,value
):
21 return _swig_setattr_nondynamic(self
,class_type
,name
,value
,0)
23 def _swig_getattr(self
,class_type
,name
):
24 method
= class_type
.__swig
_getmethods
__.get(name
,None)
25 if method
: return method(self
)
26 raise AttributeError,name
30 _object
= types
.ObjectType
32 except AttributeError:
38 def _swig_setattr_nondynamic_method(set):
39 def set_attr(self
,name
,value
):
40 if hasattr(self
,name
) or (name
in ("this", "thisown")):
43 raise AttributeError("You cannot add attributes to %s" % self
)
47 #// Give a reference to the dictionary of this module to the C++ extension
49 _core_
._wxPySetDictionary
(vars())
51 #// A little trick to make 'wx' be a reference to this module so wx.Names can
54 wx
= _sys
.modules
[__name__
]
57 #----------------------------------------------------------------------------
59 def _deprecated(callable, msg
=None):
61 Create a wrapper function that will raise a DeprecationWarning
62 before calling the callable.
65 msg
= "%s is deprecated" % callable
66 def deprecatedWrapper(*args
, **kwargs
):
68 warnings
.warn(msg
, DeprecationWarning, stacklevel
=2)
69 return callable(*args
, **kwargs
)
70 deprecatedWrapper
.__doc
__ = msg
71 return deprecatedWrapper
74 #----------------------------------------------------------------------------
76 NOT_FOUND
= _core_
.NOT_FOUND
77 VSCROLL
= _core_
.VSCROLL
78 HSCROLL
= _core_
.HSCROLL
79 CAPTION
= _core_
.CAPTION
80 DOUBLE_BORDER
= _core_
.DOUBLE_BORDER
81 SUNKEN_BORDER
= _core_
.SUNKEN_BORDER
82 RAISED_BORDER
= _core_
.RAISED_BORDER
83 BORDER
= _core_
.BORDER
84 SIMPLE_BORDER
= _core_
.SIMPLE_BORDER
85 STATIC_BORDER
= _core_
.STATIC_BORDER
86 TRANSPARENT_WINDOW
= _core_
.TRANSPARENT_WINDOW
87 NO_BORDER
= _core_
.NO_BORDER
88 DEFAULT_CONTROL_BORDER
= _core_
.DEFAULT_CONTROL_BORDER
89 DEFAULT_STATUSBAR_STYLE
= _core_
.DEFAULT_STATUSBAR_STYLE
90 TAB_TRAVERSAL
= _core_
.TAB_TRAVERSAL
91 WANTS_CHARS
= _core_
.WANTS_CHARS
92 POPUP_WINDOW
= _core_
.POPUP_WINDOW
93 CENTER_FRAME
= _core_
.CENTER_FRAME
94 CENTRE_ON_SCREEN
= _core_
.CENTRE_ON_SCREEN
95 CENTER_ON_SCREEN
= _core_
.CENTER_ON_SCREEN
96 CLIP_CHILDREN
= _core_
.CLIP_CHILDREN
97 CLIP_SIBLINGS
= _core_
.CLIP_SIBLINGS
98 ALWAYS_SHOW_SB
= _core_
.ALWAYS_SHOW_SB
99 RETAINED
= _core_
.RETAINED
100 BACKINGSTORE
= _core_
.BACKINGSTORE
101 COLOURED
= _core_
.COLOURED
102 FIXED_LENGTH
= _core_
.FIXED_LENGTH
103 LB_NEEDED_SB
= _core_
.LB_NEEDED_SB
104 LB_ALWAYS_SB
= _core_
.LB_ALWAYS_SB
105 LB_SORT
= _core_
.LB_SORT
106 LB_SINGLE
= _core_
.LB_SINGLE
107 LB_MULTIPLE
= _core_
.LB_MULTIPLE
108 LB_EXTENDED
= _core_
.LB_EXTENDED
109 LB_OWNERDRAW
= _core_
.LB_OWNERDRAW
110 LB_HSCROLL
= _core_
.LB_HSCROLL
111 PROCESS_ENTER
= _core_
.PROCESS_ENTER
112 PASSWORD
= _core_
.PASSWORD
113 CB_SIMPLE
= _core_
.CB_SIMPLE
114 CB_DROPDOWN
= _core_
.CB_DROPDOWN
115 CB_SORT
= _core_
.CB_SORT
116 CB_READONLY
= _core_
.CB_READONLY
117 RA_HORIZONTAL
= _core_
.RA_HORIZONTAL
118 RA_VERTICAL
= _core_
.RA_VERTICAL
119 RA_SPECIFY_ROWS
= _core_
.RA_SPECIFY_ROWS
120 RA_SPECIFY_COLS
= _core_
.RA_SPECIFY_COLS
121 RA_USE_CHECKBOX
= _core_
.RA_USE_CHECKBOX
122 RB_GROUP
= _core_
.RB_GROUP
123 RB_SINGLE
= _core_
.RB_SINGLE
124 SB_HORIZONTAL
= _core_
.SB_HORIZONTAL
125 SB_VERTICAL
= _core_
.SB_VERTICAL
126 RB_USE_CHECKBOX
= _core_
.RB_USE_CHECKBOX
127 ST_SIZEGRIP
= _core_
.ST_SIZEGRIP
128 ST_NO_AUTORESIZE
= _core_
.ST_NO_AUTORESIZE
129 FLOOD_SURFACE
= _core_
.FLOOD_SURFACE
130 FLOOD_BORDER
= _core_
.FLOOD_BORDER
131 ODDEVEN_RULE
= _core_
.ODDEVEN_RULE
132 WINDING_RULE
= _core_
.WINDING_RULE
133 TOOL_TOP
= _core_
.TOOL_TOP
134 TOOL_BOTTOM
= _core_
.TOOL_BOTTOM
135 TOOL_LEFT
= _core_
.TOOL_LEFT
136 TOOL_RIGHT
= _core_
.TOOL_RIGHT
138 YES_NO
= _core_
.YES_NO
139 CANCEL
= _core_
.CANCEL
142 NO_DEFAULT
= _core_
.NO_DEFAULT
143 YES_DEFAULT
= _core_
.YES_DEFAULT
144 ICON_EXCLAMATION
= _core_
.ICON_EXCLAMATION
145 ICON_HAND
= _core_
.ICON_HAND
146 ICON_QUESTION
= _core_
.ICON_QUESTION
147 ICON_INFORMATION
= _core_
.ICON_INFORMATION
148 ICON_STOP
= _core_
.ICON_STOP
149 ICON_ASTERISK
= _core_
.ICON_ASTERISK
150 ICON_MASK
= _core_
.ICON_MASK
151 ICON_WARNING
= _core_
.ICON_WARNING
152 ICON_ERROR
= _core_
.ICON_ERROR
153 FORWARD
= _core_
.FORWARD
154 BACKWARD
= _core_
.BACKWARD
159 SIZE_AUTO_WIDTH
= _core_
.SIZE_AUTO_WIDTH
160 SIZE_AUTO_HEIGHT
= _core_
.SIZE_AUTO_HEIGHT
161 SIZE_AUTO
= _core_
.SIZE_AUTO
162 SIZE_USE_EXISTING
= _core_
.SIZE_USE_EXISTING
163 SIZE_ALLOW_MINUS_ONE
= _core_
.SIZE_ALLOW_MINUS_ONE
164 SIZE_FORCE
= _core_
.SIZE_FORCE
165 PORTRAIT
= _core_
.PORTRAIT
166 LANDSCAPE
= _core_
.LANDSCAPE
167 PRINT_QUALITY_HIGH
= _core_
.PRINT_QUALITY_HIGH
168 PRINT_QUALITY_MEDIUM
= _core_
.PRINT_QUALITY_MEDIUM
169 PRINT_QUALITY_LOW
= _core_
.PRINT_QUALITY_LOW
170 PRINT_QUALITY_DRAFT
= _core_
.PRINT_QUALITY_DRAFT
171 ID_ANY
= _core_
.ID_ANY
172 ID_SEPARATOR
= _core_
.ID_SEPARATOR
173 ID_NONE
= _core_
.ID_NONE
174 ID_LOWEST
= _core_
.ID_LOWEST
175 ID_OPEN
= _core_
.ID_OPEN
176 ID_CLOSE
= _core_
.ID_CLOSE
177 ID_NEW
= _core_
.ID_NEW
178 ID_SAVE
= _core_
.ID_SAVE
179 ID_SAVEAS
= _core_
.ID_SAVEAS
180 ID_REVERT
= _core_
.ID_REVERT
181 ID_EXIT
= _core_
.ID_EXIT
182 ID_UNDO
= _core_
.ID_UNDO
183 ID_REDO
= _core_
.ID_REDO
184 ID_HELP
= _core_
.ID_HELP
185 ID_PRINT
= _core_
.ID_PRINT
186 ID_PRINT_SETUP
= _core_
.ID_PRINT_SETUP
187 ID_PREVIEW
= _core_
.ID_PREVIEW
188 ID_ABOUT
= _core_
.ID_ABOUT
189 ID_HELP_CONTENTS
= _core_
.ID_HELP_CONTENTS
190 ID_HELP_COMMANDS
= _core_
.ID_HELP_COMMANDS
191 ID_HELP_PROCEDURES
= _core_
.ID_HELP_PROCEDURES
192 ID_HELP_CONTEXT
= _core_
.ID_HELP_CONTEXT
193 ID_CLOSE_ALL
= _core_
.ID_CLOSE_ALL
194 ID_PREFERENCES
= _core_
.ID_PREFERENCES
195 ID_CUT
= _core_
.ID_CUT
196 ID_COPY
= _core_
.ID_COPY
197 ID_PASTE
= _core_
.ID_PASTE
198 ID_CLEAR
= _core_
.ID_CLEAR
199 ID_FIND
= _core_
.ID_FIND
200 ID_DUPLICATE
= _core_
.ID_DUPLICATE
201 ID_SELECTALL
= _core_
.ID_SELECTALL
202 ID_DELETE
= _core_
.ID_DELETE
203 ID_REPLACE
= _core_
.ID_REPLACE
204 ID_REPLACE_ALL
= _core_
.ID_REPLACE_ALL
205 ID_PROPERTIES
= _core_
.ID_PROPERTIES
206 ID_VIEW_DETAILS
= _core_
.ID_VIEW_DETAILS
207 ID_VIEW_LARGEICONS
= _core_
.ID_VIEW_LARGEICONS
208 ID_VIEW_SMALLICONS
= _core_
.ID_VIEW_SMALLICONS
209 ID_VIEW_LIST
= _core_
.ID_VIEW_LIST
210 ID_VIEW_SORTDATE
= _core_
.ID_VIEW_SORTDATE
211 ID_VIEW_SORTNAME
= _core_
.ID_VIEW_SORTNAME
212 ID_VIEW_SORTSIZE
= _core_
.ID_VIEW_SORTSIZE
213 ID_VIEW_SORTTYPE
= _core_
.ID_VIEW_SORTTYPE
214 ID_FILE1
= _core_
.ID_FILE1
215 ID_FILE2
= _core_
.ID_FILE2
216 ID_FILE3
= _core_
.ID_FILE3
217 ID_FILE4
= _core_
.ID_FILE4
218 ID_FILE5
= _core_
.ID_FILE5
219 ID_FILE6
= _core_
.ID_FILE6
220 ID_FILE7
= _core_
.ID_FILE7
221 ID_FILE8
= _core_
.ID_FILE8
222 ID_FILE9
= _core_
.ID_FILE9
224 ID_CANCEL
= _core_
.ID_CANCEL
225 ID_APPLY
= _core_
.ID_APPLY
226 ID_YES
= _core_
.ID_YES
228 ID_STATIC
= _core_
.ID_STATIC
229 ID_FORWARD
= _core_
.ID_FORWARD
230 ID_BACKWARD
= _core_
.ID_BACKWARD
231 ID_DEFAULT
= _core_
.ID_DEFAULT
232 ID_MORE
= _core_
.ID_MORE
233 ID_SETUP
= _core_
.ID_SETUP
234 ID_RESET
= _core_
.ID_RESET
235 ID_CONTEXT_HELP
= _core_
.ID_CONTEXT_HELP
236 ID_YESTOALL
= _core_
.ID_YESTOALL
237 ID_NOTOALL
= _core_
.ID_NOTOALL
238 ID_ABORT
= _core_
.ID_ABORT
239 ID_RETRY
= _core_
.ID_RETRY
240 ID_IGNORE
= _core_
.ID_IGNORE
241 ID_ADD
= _core_
.ID_ADD
242 ID_REMOVE
= _core_
.ID_REMOVE
244 ID_DOWN
= _core_
.ID_DOWN
245 ID_HOME
= _core_
.ID_HOME
246 ID_REFRESH
= _core_
.ID_REFRESH
247 ID_STOP
= _core_
.ID_STOP
248 ID_INDEX
= _core_
.ID_INDEX
249 ID_BOLD
= _core_
.ID_BOLD
250 ID_ITALIC
= _core_
.ID_ITALIC
251 ID_JUSTIFY_CENTER
= _core_
.ID_JUSTIFY_CENTER
252 ID_JUSTIFY_FILL
= _core_
.ID_JUSTIFY_FILL
253 ID_JUSTIFY_RIGHT
= _core_
.ID_JUSTIFY_RIGHT
254 ID_JUSTIFY_LEFT
= _core_
.ID_JUSTIFY_LEFT
255 ID_UNDERLINE
= _core_
.ID_UNDERLINE
256 ID_INDENT
= _core_
.ID_INDENT
257 ID_UNINDENT
= _core_
.ID_UNINDENT
258 ID_ZOOM_100
= _core_
.ID_ZOOM_100
259 ID_ZOOM_FIT
= _core_
.ID_ZOOM_FIT
260 ID_ZOOM_IN
= _core_
.ID_ZOOM_IN
261 ID_ZOOM_OUT
= _core_
.ID_ZOOM_OUT
262 ID_UNDELETE
= _core_
.ID_UNDELETE
263 ID_REVERT_TO_SAVED
= _core_
.ID_REVERT_TO_SAVED
264 ID_HIGHEST
= _core_
.ID_HIGHEST
267 HIDE_READONLY
= _core_
.HIDE_READONLY
268 OVERWRITE_PROMPT
= _core_
.OVERWRITE_PROMPT
269 FILE_MUST_EXIST
= _core_
.FILE_MUST_EXIST
270 MULTIPLE
= _core_
.MULTIPLE
271 CHANGE_DIR
= _core_
.CHANGE_DIR
272 ACCEL_ALT
= _core_
.ACCEL_ALT
273 ACCEL_CTRL
= _core_
.ACCEL_CTRL
274 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
275 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
276 PD_AUTO_HIDE
= _core_
.PD_AUTO_HIDE
277 PD_APP_MODAL
= _core_
.PD_APP_MODAL
278 PD_CAN_ABORT
= _core_
.PD_CAN_ABORT
279 PD_ELAPSED_TIME
= _core_
.PD_ELAPSED_TIME
280 PD_ESTIMATED_TIME
= _core_
.PD_ESTIMATED_TIME
281 PD_REMAINING_TIME
= _core_
.PD_REMAINING_TIME
282 PD_SMOOTH
= _core_
.PD_SMOOTH
283 PD_CAN_SKIP
= _core_
.PD_CAN_SKIP
284 DD_NEW_DIR_BUTTON
= _core_
.DD_NEW_DIR_BUTTON
285 DD_DEFAULT_STYLE
= _core_
.DD_DEFAULT_STYLE
286 MENU_TEAROFF
= _core_
.MENU_TEAROFF
287 MB_DOCKABLE
= _core_
.MB_DOCKABLE
288 NO_FULL_REPAINT_ON_RESIZE
= _core_
.NO_FULL_REPAINT_ON_RESIZE
289 FULL_REPAINT_ON_RESIZE
= _core_
.FULL_REPAINT_ON_RESIZE
290 LI_HORIZONTAL
= _core_
.LI_HORIZONTAL
291 LI_VERTICAL
= _core_
.LI_VERTICAL
292 WS_EX_VALIDATE_RECURSIVELY
= _core_
.WS_EX_VALIDATE_RECURSIVELY
293 WS_EX_BLOCK_EVENTS
= _core_
.WS_EX_BLOCK_EVENTS
294 WS_EX_TRANSIENT
= _core_
.WS_EX_TRANSIENT
295 WS_EX_THEMED_BACKGROUND
= _core_
.WS_EX_THEMED_BACKGROUND
296 WS_EX_PROCESS_IDLE
= _core_
.WS_EX_PROCESS_IDLE
297 WS_EX_PROCESS_UI_UPDATES
= _core_
.WS_EX_PROCESS_UI_UPDATES
298 MM_TEXT
= _core_
.MM_TEXT
299 MM_LOMETRIC
= _core_
.MM_LOMETRIC
300 MM_HIMETRIC
= _core_
.MM_HIMETRIC
301 MM_LOENGLISH
= _core_
.MM_LOENGLISH
302 MM_HIENGLISH
= _core_
.MM_HIENGLISH
303 MM_TWIPS
= _core_
.MM_TWIPS
304 MM_ISOTROPIC
= _core_
.MM_ISOTROPIC
305 MM_ANISOTROPIC
= _core_
.MM_ANISOTROPIC
306 MM_POINTS
= _core_
.MM_POINTS
307 MM_METRIC
= _core_
.MM_METRIC
308 CENTRE
= _core_
.CENTRE
309 CENTER
= _core_
.CENTER
310 HORIZONTAL
= _core_
.HORIZONTAL
311 VERTICAL
= _core_
.VERTICAL
318 BOTTOM
= _core_
.BOTTOM
324 ALIGN_NOT
= _core_
.ALIGN_NOT
325 ALIGN_CENTER_HORIZONTAL
= _core_
.ALIGN_CENTER_HORIZONTAL
326 ALIGN_CENTRE_HORIZONTAL
= _core_
.ALIGN_CENTRE_HORIZONTAL
327 ALIGN_LEFT
= _core_
.ALIGN_LEFT
328 ALIGN_TOP
= _core_
.ALIGN_TOP
329 ALIGN_RIGHT
= _core_
.ALIGN_RIGHT
330 ALIGN_BOTTOM
= _core_
.ALIGN_BOTTOM
331 ALIGN_CENTER_VERTICAL
= _core_
.ALIGN_CENTER_VERTICAL
332 ALIGN_CENTRE_VERTICAL
= _core_
.ALIGN_CENTRE_VERTICAL
333 ALIGN_CENTER
= _core_
.ALIGN_CENTER
334 ALIGN_CENTRE
= _core_
.ALIGN_CENTRE
335 ALIGN_MASK
= _core_
.ALIGN_MASK
336 STRETCH_NOT
= _core_
.STRETCH_NOT
337 SHRINK
= _core_
.SHRINK
339 EXPAND
= _core_
.EXPAND
340 SHAPED
= _core_
.SHAPED
341 FIXED_MINSIZE
= _core_
.FIXED_MINSIZE
343 ADJUST_MINSIZE
= _core_
.ADJUST_MINSIZE
344 BORDER_DEFAULT
= _core_
.BORDER_DEFAULT
345 BORDER_NONE
= _core_
.BORDER_NONE
346 BORDER_STATIC
= _core_
.BORDER_STATIC
347 BORDER_SIMPLE
= _core_
.BORDER_SIMPLE
348 BORDER_RAISED
= _core_
.BORDER_RAISED
349 BORDER_SUNKEN
= _core_
.BORDER_SUNKEN
350 BORDER_DOUBLE
= _core_
.BORDER_DOUBLE
351 BORDER_MASK
= _core_
.BORDER_MASK
352 BG_STYLE_SYSTEM
= _core_
.BG_STYLE_SYSTEM
353 BG_STYLE_COLOUR
= _core_
.BG_STYLE_COLOUR
354 BG_STYLE_CUSTOM
= _core_
.BG_STYLE_CUSTOM
355 DEFAULT
= _core_
.DEFAULT
356 DECORATIVE
= _core_
.DECORATIVE
358 SCRIPT
= _core_
.SCRIPT
360 MODERN
= _core_
.MODERN
361 TELETYPE
= _core_
.TELETYPE
362 VARIABLE
= _core_
.VARIABLE
364 NORMAL
= _core_
.NORMAL
367 ITALIC
= _core_
.ITALIC
371 LONG_DASH
= _core_
.LONG_DASH
372 SHORT_DASH
= _core_
.SHORT_DASH
373 DOT_DASH
= _core_
.DOT_DASH
374 USER_DASH
= _core_
.USER_DASH
375 TRANSPARENT
= _core_
.TRANSPARENT
376 STIPPLE
= _core_
.STIPPLE
377 STIPPLE_MASK
= _core_
.STIPPLE_MASK
378 STIPPLE_MASK_OPAQUE
= _core_
.STIPPLE_MASK_OPAQUE
379 BDIAGONAL_HATCH
= _core_
.BDIAGONAL_HATCH
380 CROSSDIAG_HATCH
= _core_
.CROSSDIAG_HATCH
381 FDIAGONAL_HATCH
= _core_
.FDIAGONAL_HATCH
382 CROSS_HATCH
= _core_
.CROSS_HATCH
383 HORIZONTAL_HATCH
= _core_
.HORIZONTAL_HATCH
384 VERTICAL_HATCH
= _core_
.VERTICAL_HATCH
385 JOIN_BEVEL
= _core_
.JOIN_BEVEL
386 JOIN_MITER
= _core_
.JOIN_MITER
387 JOIN_ROUND
= _core_
.JOIN_ROUND
388 CAP_ROUND
= _core_
.CAP_ROUND
389 CAP_PROJECTING
= _core_
.CAP_PROJECTING
390 CAP_BUTT
= _core_
.CAP_BUTT
393 INVERT
= _core_
.INVERT
394 OR_REVERSE
= _core_
.OR_REVERSE
395 AND_REVERSE
= _core_
.AND_REVERSE
398 AND_INVERT
= _core_
.AND_INVERT
402 SRC_INVERT
= _core_
.SRC_INVERT
403 OR_INVERT
= _core_
.OR_INVERT
407 WXK_BACK
= _core_
.WXK_BACK
408 WXK_TAB
= _core_
.WXK_TAB
409 WXK_RETURN
= _core_
.WXK_RETURN
410 WXK_ESCAPE
= _core_
.WXK_ESCAPE
411 WXK_SPACE
= _core_
.WXK_SPACE
412 WXK_DELETE
= _core_
.WXK_DELETE
413 WXK_START
= _core_
.WXK_START
414 WXK_LBUTTON
= _core_
.WXK_LBUTTON
415 WXK_RBUTTON
= _core_
.WXK_RBUTTON
416 WXK_CANCEL
= _core_
.WXK_CANCEL
417 WXK_MBUTTON
= _core_
.WXK_MBUTTON
418 WXK_CLEAR
= _core_
.WXK_CLEAR
419 WXK_SHIFT
= _core_
.WXK_SHIFT
420 WXK_ALT
= _core_
.WXK_ALT
421 WXK_CONTROL
= _core_
.WXK_CONTROL
422 WXK_MENU
= _core_
.WXK_MENU
423 WXK_PAUSE
= _core_
.WXK_PAUSE
424 WXK_CAPITAL
= _core_
.WXK_CAPITAL
425 WXK_PRIOR
= _core_
.WXK_PRIOR
426 WXK_NEXT
= _core_
.WXK_NEXT
427 WXK_END
= _core_
.WXK_END
428 WXK_HOME
= _core_
.WXK_HOME
429 WXK_LEFT
= _core_
.WXK_LEFT
430 WXK_UP
= _core_
.WXK_UP
431 WXK_RIGHT
= _core_
.WXK_RIGHT
432 WXK_DOWN
= _core_
.WXK_DOWN
433 WXK_SELECT
= _core_
.WXK_SELECT
434 WXK_PRINT
= _core_
.WXK_PRINT
435 WXK_EXECUTE
= _core_
.WXK_EXECUTE
436 WXK_SNAPSHOT
= _core_
.WXK_SNAPSHOT
437 WXK_INSERT
= _core_
.WXK_INSERT
438 WXK_HELP
= _core_
.WXK_HELP
439 WXK_NUMPAD0
= _core_
.WXK_NUMPAD0
440 WXK_NUMPAD1
= _core_
.WXK_NUMPAD1
441 WXK_NUMPAD2
= _core_
.WXK_NUMPAD2
442 WXK_NUMPAD3
= _core_
.WXK_NUMPAD3
443 WXK_NUMPAD4
= _core_
.WXK_NUMPAD4
444 WXK_NUMPAD5
= _core_
.WXK_NUMPAD5
445 WXK_NUMPAD6
= _core_
.WXK_NUMPAD6
446 WXK_NUMPAD7
= _core_
.WXK_NUMPAD7
447 WXK_NUMPAD8
= _core_
.WXK_NUMPAD8
448 WXK_NUMPAD9
= _core_
.WXK_NUMPAD9
449 WXK_MULTIPLY
= _core_
.WXK_MULTIPLY
450 WXK_ADD
= _core_
.WXK_ADD
451 WXK_SEPARATOR
= _core_
.WXK_SEPARATOR
452 WXK_SUBTRACT
= _core_
.WXK_SUBTRACT
453 WXK_DECIMAL
= _core_
.WXK_DECIMAL
454 WXK_DIVIDE
= _core_
.WXK_DIVIDE
455 WXK_F1
= _core_
.WXK_F1
456 WXK_F2
= _core_
.WXK_F2
457 WXK_F3
= _core_
.WXK_F3
458 WXK_F4
= _core_
.WXK_F4
459 WXK_F5
= _core_
.WXK_F5
460 WXK_F6
= _core_
.WXK_F6
461 WXK_F7
= _core_
.WXK_F7
462 WXK_F8
= _core_
.WXK_F8
463 WXK_F9
= _core_
.WXK_F9
464 WXK_F10
= _core_
.WXK_F10
465 WXK_F11
= _core_
.WXK_F11
466 WXK_F12
= _core_
.WXK_F12
467 WXK_F13
= _core_
.WXK_F13
468 WXK_F14
= _core_
.WXK_F14
469 WXK_F15
= _core_
.WXK_F15
470 WXK_F16
= _core_
.WXK_F16
471 WXK_F17
= _core_
.WXK_F17
472 WXK_F18
= _core_
.WXK_F18
473 WXK_F19
= _core_
.WXK_F19
474 WXK_F20
= _core_
.WXK_F20
475 WXK_F21
= _core_
.WXK_F21
476 WXK_F22
= _core_
.WXK_F22
477 WXK_F23
= _core_
.WXK_F23
478 WXK_F24
= _core_
.WXK_F24
479 WXK_NUMLOCK
= _core_
.WXK_NUMLOCK
480 WXK_SCROLL
= _core_
.WXK_SCROLL
481 WXK_PAGEUP
= _core_
.WXK_PAGEUP
482 WXK_PAGEDOWN
= _core_
.WXK_PAGEDOWN
483 WXK_NUMPAD_SPACE
= _core_
.WXK_NUMPAD_SPACE
484 WXK_NUMPAD_TAB
= _core_
.WXK_NUMPAD_TAB
485 WXK_NUMPAD_ENTER
= _core_
.WXK_NUMPAD_ENTER
486 WXK_NUMPAD_F1
= _core_
.WXK_NUMPAD_F1
487 WXK_NUMPAD_F2
= _core_
.WXK_NUMPAD_F2
488 WXK_NUMPAD_F3
= _core_
.WXK_NUMPAD_F3
489 WXK_NUMPAD_F4
= _core_
.WXK_NUMPAD_F4
490 WXK_NUMPAD_HOME
= _core_
.WXK_NUMPAD_HOME
491 WXK_NUMPAD_LEFT
= _core_
.WXK_NUMPAD_LEFT
492 WXK_NUMPAD_UP
= _core_
.WXK_NUMPAD_UP
493 WXK_NUMPAD_RIGHT
= _core_
.WXK_NUMPAD_RIGHT
494 WXK_NUMPAD_DOWN
= _core_
.WXK_NUMPAD_DOWN
495 WXK_NUMPAD_PRIOR
= _core_
.WXK_NUMPAD_PRIOR
496 WXK_NUMPAD_PAGEUP
= _core_
.WXK_NUMPAD_PAGEUP
497 WXK_NUMPAD_NEXT
= _core_
.WXK_NUMPAD_NEXT
498 WXK_NUMPAD_PAGEDOWN
= _core_
.WXK_NUMPAD_PAGEDOWN
499 WXK_NUMPAD_END
= _core_
.WXK_NUMPAD_END
500 WXK_NUMPAD_BEGIN
= _core_
.WXK_NUMPAD_BEGIN
501 WXK_NUMPAD_INSERT
= _core_
.WXK_NUMPAD_INSERT
502 WXK_NUMPAD_DELETE
= _core_
.WXK_NUMPAD_DELETE
503 WXK_NUMPAD_EQUAL
= _core_
.WXK_NUMPAD_EQUAL
504 WXK_NUMPAD_MULTIPLY
= _core_
.WXK_NUMPAD_MULTIPLY
505 WXK_NUMPAD_ADD
= _core_
.WXK_NUMPAD_ADD
506 WXK_NUMPAD_SEPARATOR
= _core_
.WXK_NUMPAD_SEPARATOR
507 WXK_NUMPAD_SUBTRACT
= _core_
.WXK_NUMPAD_SUBTRACT
508 WXK_NUMPAD_DECIMAL
= _core_
.WXK_NUMPAD_DECIMAL
509 WXK_NUMPAD_DIVIDE
= _core_
.WXK_NUMPAD_DIVIDE
510 WXK_WINDOWS_LEFT
= _core_
.WXK_WINDOWS_LEFT
511 WXK_WINDOWS_RIGHT
= _core_
.WXK_WINDOWS_RIGHT
512 WXK_WINDOWS_MENU
= _core_
.WXK_WINDOWS_MENU
513 WXK_COMMAND
= _core_
.WXK_COMMAND
514 WXK_SPECIAL1
= _core_
.WXK_SPECIAL1
515 WXK_SPECIAL2
= _core_
.WXK_SPECIAL2
516 WXK_SPECIAL3
= _core_
.WXK_SPECIAL3
517 WXK_SPECIAL4
= _core_
.WXK_SPECIAL4
518 WXK_SPECIAL5
= _core_
.WXK_SPECIAL5
519 WXK_SPECIAL6
= _core_
.WXK_SPECIAL6
520 WXK_SPECIAL7
= _core_
.WXK_SPECIAL7
521 WXK_SPECIAL8
= _core_
.WXK_SPECIAL8
522 WXK_SPECIAL9
= _core_
.WXK_SPECIAL9
523 WXK_SPECIAL10
= _core_
.WXK_SPECIAL10
524 WXK_SPECIAL11
= _core_
.WXK_SPECIAL11
525 WXK_SPECIAL12
= _core_
.WXK_SPECIAL12
526 WXK_SPECIAL13
= _core_
.WXK_SPECIAL13
527 WXK_SPECIAL14
= _core_
.WXK_SPECIAL14
528 WXK_SPECIAL15
= _core_
.WXK_SPECIAL15
529 WXK_SPECIAL16
= _core_
.WXK_SPECIAL16
530 WXK_SPECIAL17
= _core_
.WXK_SPECIAL17
531 WXK_SPECIAL18
= _core_
.WXK_SPECIAL18
532 WXK_SPECIAL19
= _core_
.WXK_SPECIAL19
533 WXK_SPECIAL20
= _core_
.WXK_SPECIAL20
534 PAPER_NONE
= _core_
.PAPER_NONE
535 PAPER_LETTER
= _core_
.PAPER_LETTER
536 PAPER_LEGAL
= _core_
.PAPER_LEGAL
537 PAPER_A4
= _core_
.PAPER_A4
538 PAPER_CSHEET
= _core_
.PAPER_CSHEET
539 PAPER_DSHEET
= _core_
.PAPER_DSHEET
540 PAPER_ESHEET
= _core_
.PAPER_ESHEET
541 PAPER_LETTERSMALL
= _core_
.PAPER_LETTERSMALL
542 PAPER_TABLOID
= _core_
.PAPER_TABLOID
543 PAPER_LEDGER
= _core_
.PAPER_LEDGER
544 PAPER_STATEMENT
= _core_
.PAPER_STATEMENT
545 PAPER_EXECUTIVE
= _core_
.PAPER_EXECUTIVE
546 PAPER_A3
= _core_
.PAPER_A3
547 PAPER_A4SMALL
= _core_
.PAPER_A4SMALL
548 PAPER_A5
= _core_
.PAPER_A5
549 PAPER_B4
= _core_
.PAPER_B4
550 PAPER_B5
= _core_
.PAPER_B5
551 PAPER_FOLIO
= _core_
.PAPER_FOLIO
552 PAPER_QUARTO
= _core_
.PAPER_QUARTO
553 PAPER_10X14
= _core_
.PAPER_10X14
554 PAPER_11X17
= _core_
.PAPER_11X17
555 PAPER_NOTE
= _core_
.PAPER_NOTE
556 PAPER_ENV_9
= _core_
.PAPER_ENV_9
557 PAPER_ENV_10
= _core_
.PAPER_ENV_10
558 PAPER_ENV_11
= _core_
.PAPER_ENV_11
559 PAPER_ENV_12
= _core_
.PAPER_ENV_12
560 PAPER_ENV_14
= _core_
.PAPER_ENV_14
561 PAPER_ENV_DL
= _core_
.PAPER_ENV_DL
562 PAPER_ENV_C5
= _core_
.PAPER_ENV_C5
563 PAPER_ENV_C3
= _core_
.PAPER_ENV_C3
564 PAPER_ENV_C4
= _core_
.PAPER_ENV_C4
565 PAPER_ENV_C6
= _core_
.PAPER_ENV_C6
566 PAPER_ENV_C65
= _core_
.PAPER_ENV_C65
567 PAPER_ENV_B4
= _core_
.PAPER_ENV_B4
568 PAPER_ENV_B5
= _core_
.PAPER_ENV_B5
569 PAPER_ENV_B6
= _core_
.PAPER_ENV_B6
570 PAPER_ENV_ITALY
= _core_
.PAPER_ENV_ITALY
571 PAPER_ENV_MONARCH
= _core_
.PAPER_ENV_MONARCH
572 PAPER_ENV_PERSONAL
= _core_
.PAPER_ENV_PERSONAL
573 PAPER_FANFOLD_US
= _core_
.PAPER_FANFOLD_US
574 PAPER_FANFOLD_STD_GERMAN
= _core_
.PAPER_FANFOLD_STD_GERMAN
575 PAPER_FANFOLD_LGL_GERMAN
= _core_
.PAPER_FANFOLD_LGL_GERMAN
576 PAPER_ISO_B4
= _core_
.PAPER_ISO_B4
577 PAPER_JAPANESE_POSTCARD
= _core_
.PAPER_JAPANESE_POSTCARD
578 PAPER_9X11
= _core_
.PAPER_9X11
579 PAPER_10X11
= _core_
.PAPER_10X11
580 PAPER_15X11
= _core_
.PAPER_15X11
581 PAPER_ENV_INVITE
= _core_
.PAPER_ENV_INVITE
582 PAPER_LETTER_EXTRA
= _core_
.PAPER_LETTER_EXTRA
583 PAPER_LEGAL_EXTRA
= _core_
.PAPER_LEGAL_EXTRA
584 PAPER_TABLOID_EXTRA
= _core_
.PAPER_TABLOID_EXTRA
585 PAPER_A4_EXTRA
= _core_
.PAPER_A4_EXTRA
586 PAPER_LETTER_TRANSVERSE
= _core_
.PAPER_LETTER_TRANSVERSE
587 PAPER_A4_TRANSVERSE
= _core_
.PAPER_A4_TRANSVERSE
588 PAPER_LETTER_EXTRA_TRANSVERSE
= _core_
.PAPER_LETTER_EXTRA_TRANSVERSE
589 PAPER_A_PLUS
= _core_
.PAPER_A_PLUS
590 PAPER_B_PLUS
= _core_
.PAPER_B_PLUS
591 PAPER_LETTER_PLUS
= _core_
.PAPER_LETTER_PLUS
592 PAPER_A4_PLUS
= _core_
.PAPER_A4_PLUS
593 PAPER_A5_TRANSVERSE
= _core_
.PAPER_A5_TRANSVERSE
594 PAPER_B5_TRANSVERSE
= _core_
.PAPER_B5_TRANSVERSE
595 PAPER_A3_EXTRA
= _core_
.PAPER_A3_EXTRA
596 PAPER_A5_EXTRA
= _core_
.PAPER_A5_EXTRA
597 PAPER_B5_EXTRA
= _core_
.PAPER_B5_EXTRA
598 PAPER_A2
= _core_
.PAPER_A2
599 PAPER_A3_TRANSVERSE
= _core_
.PAPER_A3_TRANSVERSE
600 PAPER_A3_EXTRA_TRANSVERSE
= _core_
.PAPER_A3_EXTRA_TRANSVERSE
601 PAPER_DBL_JAPANESE_POSTCARD
= _core_
.PAPER_DBL_JAPANESE_POSTCARD
602 PAPER_A6
= _core_
.PAPER_A6
603 PAPER_JENV_KAKU2
= _core_
.PAPER_JENV_KAKU2
604 PAPER_JENV_KAKU3
= _core_
.PAPER_JENV_KAKU3
605 PAPER_JENV_CHOU3
= _core_
.PAPER_JENV_CHOU3
606 PAPER_JENV_CHOU4
= _core_
.PAPER_JENV_CHOU4
607 PAPER_LETTER_ROTATED
= _core_
.PAPER_LETTER_ROTATED
608 PAPER_A3_ROTATED
= _core_
.PAPER_A3_ROTATED
609 PAPER_A4_ROTATED
= _core_
.PAPER_A4_ROTATED
610 PAPER_A5_ROTATED
= _core_
.PAPER_A5_ROTATED
611 PAPER_B4_JIS_ROTATED
= _core_
.PAPER_B4_JIS_ROTATED
612 PAPER_B5_JIS_ROTATED
= _core_
.PAPER_B5_JIS_ROTATED
613 PAPER_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_JAPANESE_POSTCARD_ROTATED
614 PAPER_DBL_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
615 PAPER_A6_ROTATED
= _core_
.PAPER_A6_ROTATED
616 PAPER_JENV_KAKU2_ROTATED
= _core_
.PAPER_JENV_KAKU2_ROTATED
617 PAPER_JENV_KAKU3_ROTATED
= _core_
.PAPER_JENV_KAKU3_ROTATED
618 PAPER_JENV_CHOU3_ROTATED
= _core_
.PAPER_JENV_CHOU3_ROTATED
619 PAPER_JENV_CHOU4_ROTATED
= _core_
.PAPER_JENV_CHOU4_ROTATED
620 PAPER_B6_JIS
= _core_
.PAPER_B6_JIS
621 PAPER_B6_JIS_ROTATED
= _core_
.PAPER_B6_JIS_ROTATED
622 PAPER_12X11
= _core_
.PAPER_12X11
623 PAPER_JENV_YOU4
= _core_
.PAPER_JENV_YOU4
624 PAPER_JENV_YOU4_ROTATED
= _core_
.PAPER_JENV_YOU4_ROTATED
625 PAPER_P16K
= _core_
.PAPER_P16K
626 PAPER_P32K
= _core_
.PAPER_P32K
627 PAPER_P32KBIG
= _core_
.PAPER_P32KBIG
628 PAPER_PENV_1
= _core_
.PAPER_PENV_1
629 PAPER_PENV_2
= _core_
.PAPER_PENV_2
630 PAPER_PENV_3
= _core_
.PAPER_PENV_3
631 PAPER_PENV_4
= _core_
.PAPER_PENV_4
632 PAPER_PENV_5
= _core_
.PAPER_PENV_5
633 PAPER_PENV_6
= _core_
.PAPER_PENV_6
634 PAPER_PENV_7
= _core_
.PAPER_PENV_7
635 PAPER_PENV_8
= _core_
.PAPER_PENV_8
636 PAPER_PENV_9
= _core_
.PAPER_PENV_9
637 PAPER_PENV_10
= _core_
.PAPER_PENV_10
638 PAPER_P16K_ROTATED
= _core_
.PAPER_P16K_ROTATED
639 PAPER_P32K_ROTATED
= _core_
.PAPER_P32K_ROTATED
640 PAPER_P32KBIG_ROTATED
= _core_
.PAPER_P32KBIG_ROTATED
641 PAPER_PENV_1_ROTATED
= _core_
.PAPER_PENV_1_ROTATED
642 PAPER_PENV_2_ROTATED
= _core_
.PAPER_PENV_2_ROTATED
643 PAPER_PENV_3_ROTATED
= _core_
.PAPER_PENV_3_ROTATED
644 PAPER_PENV_4_ROTATED
= _core_
.PAPER_PENV_4_ROTATED
645 PAPER_PENV_5_ROTATED
= _core_
.PAPER_PENV_5_ROTATED
646 PAPER_PENV_6_ROTATED
= _core_
.PAPER_PENV_6_ROTATED
647 PAPER_PENV_7_ROTATED
= _core_
.PAPER_PENV_7_ROTATED
648 PAPER_PENV_8_ROTATED
= _core_
.PAPER_PENV_8_ROTATED
649 PAPER_PENV_9_ROTATED
= _core_
.PAPER_PENV_9_ROTATED
650 PAPER_PENV_10_ROTATED
= _core_
.PAPER_PENV_10_ROTATED
651 DUPLEX_SIMPLEX
= _core_
.DUPLEX_SIMPLEX
652 DUPLEX_HORIZONTAL
= _core_
.DUPLEX_HORIZONTAL
653 DUPLEX_VERTICAL
= _core_
.DUPLEX_VERTICAL
654 ITEM_SEPARATOR
= _core_
.ITEM_SEPARATOR
655 ITEM_NORMAL
= _core_
.ITEM_NORMAL
656 ITEM_CHECK
= _core_
.ITEM_CHECK
657 ITEM_RADIO
= _core_
.ITEM_RADIO
658 ITEM_MAX
= _core_
.ITEM_MAX
659 HT_NOWHERE
= _core_
.HT_NOWHERE
660 HT_SCROLLBAR_FIRST
= _core_
.HT_SCROLLBAR_FIRST
661 HT_SCROLLBAR_ARROW_LINE_1
= _core_
.HT_SCROLLBAR_ARROW_LINE_1
662 HT_SCROLLBAR_ARROW_LINE_2
= _core_
.HT_SCROLLBAR_ARROW_LINE_2
663 HT_SCROLLBAR_ARROW_PAGE_1
= _core_
.HT_SCROLLBAR_ARROW_PAGE_1
664 HT_SCROLLBAR_ARROW_PAGE_2
= _core_
.HT_SCROLLBAR_ARROW_PAGE_2
665 HT_SCROLLBAR_THUMB
= _core_
.HT_SCROLLBAR_THUMB
666 HT_SCROLLBAR_BAR_1
= _core_
.HT_SCROLLBAR_BAR_1
667 HT_SCROLLBAR_BAR_2
= _core_
.HT_SCROLLBAR_BAR_2
668 HT_SCROLLBAR_LAST
= _core_
.HT_SCROLLBAR_LAST
669 HT_WINDOW_OUTSIDE
= _core_
.HT_WINDOW_OUTSIDE
670 HT_WINDOW_INSIDE
= _core_
.HT_WINDOW_INSIDE
671 HT_WINDOW_VERT_SCROLLBAR
= _core_
.HT_WINDOW_VERT_SCROLLBAR
672 HT_WINDOW_HORZ_SCROLLBAR
= _core_
.HT_WINDOW_HORZ_SCROLLBAR
673 HT_WINDOW_CORNER
= _core_
.HT_WINDOW_CORNER
674 HT_MAX
= _core_
.HT_MAX
675 MOD_NONE
= _core_
.MOD_NONE
676 MOD_ALT
= _core_
.MOD_ALT
677 MOD_CONTROL
= _core_
.MOD_CONTROL
678 MOD_ALTGR
= _core_
.MOD_ALTGR
679 MOD_SHIFT
= _core_
.MOD_SHIFT
680 MOD_META
= _core_
.MOD_META
681 MOD_WIN
= _core_
.MOD_WIN
682 MOD_CMD
= _core_
.MOD_CMD
683 MOD_ALL
= _core_
.MOD_ALL
684 UPDATE_UI_NONE
= _core_
.UPDATE_UI_NONE
685 UPDATE_UI_RECURSE
= _core_
.UPDATE_UI_RECURSE
686 UPDATE_UI_FROMIDLE
= _core_
.UPDATE_UI_FROMIDLE
687 #---------------------------------------------------------------------------
689 class Object(object):
691 The base class for most wx objects, although in wxPython not
692 much functionality is needed nor exposed.
694 def __init__(self
): raise RuntimeError, "No constructor defined"
696 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
697 def GetClassName(*args
, **kwargs
):
699 GetClassName(self) -> String
701 Returns the class name of the C++ class using wxRTTI.
703 return _core_
.Object_GetClassName(*args
, **kwargs
)
705 def Destroy(*args
, **kwargs
):
709 Deletes the C++ object this Python object is a proxy for.
711 val
= _core_
.Object_Destroy(*args
, **kwargs
)
716 class ObjectPtr(Object
):
717 def __init__(self
, this
):
719 if not hasattr(self
,"thisown"): self
.thisown
= 0
720 self
.__class
__ = Object
721 _core_
.Object_swigregister(ObjectPtr
)
722 _wxPySetDictionary
= _core_
._wxPySetDictionary
724 _wxPyFixStockObjects
= _core_
._wxPyFixStockObjects
727 EmptyString
= cvar
.EmptyString
729 #---------------------------------------------------------------------------
731 BITMAP_TYPE_INVALID
= _core_
.BITMAP_TYPE_INVALID
732 BITMAP_TYPE_BMP
= _core_
.BITMAP_TYPE_BMP
733 BITMAP_TYPE_ICO
= _core_
.BITMAP_TYPE_ICO
734 BITMAP_TYPE_CUR
= _core_
.BITMAP_TYPE_CUR
735 BITMAP_TYPE_XBM
= _core_
.BITMAP_TYPE_XBM
736 BITMAP_TYPE_XBM_DATA
= _core_
.BITMAP_TYPE_XBM_DATA
737 BITMAP_TYPE_XPM
= _core_
.BITMAP_TYPE_XPM
738 BITMAP_TYPE_XPM_DATA
= _core_
.BITMAP_TYPE_XPM_DATA
739 BITMAP_TYPE_TIF
= _core_
.BITMAP_TYPE_TIF
740 BITMAP_TYPE_GIF
= _core_
.BITMAP_TYPE_GIF
741 BITMAP_TYPE_PNG
= _core_
.BITMAP_TYPE_PNG
742 BITMAP_TYPE_JPEG
= _core_
.BITMAP_TYPE_JPEG
743 BITMAP_TYPE_PNM
= _core_
.BITMAP_TYPE_PNM
744 BITMAP_TYPE_PCX
= _core_
.BITMAP_TYPE_PCX
745 BITMAP_TYPE_PICT
= _core_
.BITMAP_TYPE_PICT
746 BITMAP_TYPE_ICON
= _core_
.BITMAP_TYPE_ICON
747 BITMAP_TYPE_ANI
= _core_
.BITMAP_TYPE_ANI
748 BITMAP_TYPE_IFF
= _core_
.BITMAP_TYPE_IFF
749 BITMAP_TYPE_MACCURSOR
= _core_
.BITMAP_TYPE_MACCURSOR
750 BITMAP_TYPE_ANY
= _core_
.BITMAP_TYPE_ANY
751 CURSOR_NONE
= _core_
.CURSOR_NONE
752 CURSOR_ARROW
= _core_
.CURSOR_ARROW
753 CURSOR_RIGHT_ARROW
= _core_
.CURSOR_RIGHT_ARROW
754 CURSOR_BULLSEYE
= _core_
.CURSOR_BULLSEYE
755 CURSOR_CHAR
= _core_
.CURSOR_CHAR
756 CURSOR_CROSS
= _core_
.CURSOR_CROSS
757 CURSOR_HAND
= _core_
.CURSOR_HAND
758 CURSOR_IBEAM
= _core_
.CURSOR_IBEAM
759 CURSOR_LEFT_BUTTON
= _core_
.CURSOR_LEFT_BUTTON
760 CURSOR_MAGNIFIER
= _core_
.CURSOR_MAGNIFIER
761 CURSOR_MIDDLE_BUTTON
= _core_
.CURSOR_MIDDLE_BUTTON
762 CURSOR_NO_ENTRY
= _core_
.CURSOR_NO_ENTRY
763 CURSOR_PAINT_BRUSH
= _core_
.CURSOR_PAINT_BRUSH
764 CURSOR_PENCIL
= _core_
.CURSOR_PENCIL
765 CURSOR_POINT_LEFT
= _core_
.CURSOR_POINT_LEFT
766 CURSOR_POINT_RIGHT
= _core_
.CURSOR_POINT_RIGHT
767 CURSOR_QUESTION_ARROW
= _core_
.CURSOR_QUESTION_ARROW
768 CURSOR_RIGHT_BUTTON
= _core_
.CURSOR_RIGHT_BUTTON
769 CURSOR_SIZENESW
= _core_
.CURSOR_SIZENESW
770 CURSOR_SIZENS
= _core_
.CURSOR_SIZENS
771 CURSOR_SIZENWSE
= _core_
.CURSOR_SIZENWSE
772 CURSOR_SIZEWE
= _core_
.CURSOR_SIZEWE
773 CURSOR_SIZING
= _core_
.CURSOR_SIZING
774 CURSOR_SPRAYCAN
= _core_
.CURSOR_SPRAYCAN
775 CURSOR_WAIT
= _core_
.CURSOR_WAIT
776 CURSOR_WATCH
= _core_
.CURSOR_WATCH
777 CURSOR_BLANK
= _core_
.CURSOR_BLANK
778 CURSOR_DEFAULT
= _core_
.CURSOR_DEFAULT
779 CURSOR_COPY_ARROW
= _core_
.CURSOR_COPY_ARROW
780 CURSOR_ARROWWAIT
= _core_
.CURSOR_ARROWWAIT
781 CURSOR_MAX
= _core_
.CURSOR_MAX
782 #---------------------------------------------------------------------------
786 wx.Size is a useful data structure used to represent the size of
787 something. It simply contians integer width and height
788 proprtites. In most places in wxPython where a wx.Size is
789 expected a (width, height) tuple can be used instead.
792 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
793 width
= property(_core_
.Size_width_get
, _core_
.Size_width_set
)
794 height
= property(_core_
.Size_height_get
, _core_
.Size_height_set
)
795 x
= width
; y
= height
796 def __init__(self
, *args
, **kwargs
):
798 __init__(self, int w=0, int h=0) -> Size
800 Creates a size object.
802 newobj
= _core_
.new_Size(*args
, **kwargs
)
803 self
.this
= newobj
.this
806 def __del__(self
, destroy
=_core_
.delete_Size
):
809 if self
.thisown
: destroy(self
)
812 def __eq__(*args
, **kwargs
):
814 __eq__(self, Size sz) -> bool
816 Test for equality of wx.Size objects.
818 return _core_
.Size___eq__(*args
, **kwargs
)
820 def __ne__(*args
, **kwargs
):
822 __ne__(self, Size sz) -> bool
826 return _core_
.Size___ne__(*args
, **kwargs
)
828 def __add__(*args
, **kwargs
):
830 __add__(self, Size sz) -> Size
832 Add sz's proprties to this and return the result.
834 return _core_
.Size___add__(*args
, **kwargs
)
836 def __sub__(*args
, **kwargs
):
838 __sub__(self, Size sz) -> Size
840 Subtract sz's properties from this and return the result.
842 return _core_
.Size___sub__(*args
, **kwargs
)
844 def IncTo(*args
, **kwargs
):
848 Increments this object so that both of its dimensions are not less
849 than the corresponding dimensions of the size.
851 return _core_
.Size_IncTo(*args
, **kwargs
)
853 def DecTo(*args
, **kwargs
):
857 Decrements this object so that both of its dimensions are not greater
858 than the corresponding dimensions of the size.
860 return _core_
.Size_DecTo(*args
, **kwargs
)
862 def Set(*args
, **kwargs
):
864 Set(self, int w, int h)
866 Set both width and height.
868 return _core_
.Size_Set(*args
, **kwargs
)
870 def SetWidth(*args
, **kwargs
):
871 """SetWidth(self, int w)"""
872 return _core_
.Size_SetWidth(*args
, **kwargs
)
874 def SetHeight(*args
, **kwargs
):
875 """SetHeight(self, int h)"""
876 return _core_
.Size_SetHeight(*args
, **kwargs
)
878 def GetWidth(*args
, **kwargs
):
879 """GetWidth(self) -> int"""
880 return _core_
.Size_GetWidth(*args
, **kwargs
)
882 def GetHeight(*args
, **kwargs
):
883 """GetHeight(self) -> int"""
884 return _core_
.Size_GetHeight(*args
, **kwargs
)
886 def IsFullySpecified(*args
, **kwargs
):
888 IsFullySpecified(self) -> bool
890 Returns True if both components of the size are non-default values.
892 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
894 def SetDefaults(*args
, **kwargs
):
896 SetDefaults(self, Size size)
898 Combine this size with the other one replacing the default components
899 of this object (i.e. equal to -1) with those of the other.
901 return _core_
.Size_SetDefaults(*args
, **kwargs
)
903 def Get(*args
, **kwargs
):
905 Get() -> (width,height)
907 Returns the width and height properties as a tuple.
909 return _core_
.Size_Get(*args
, **kwargs
)
911 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
912 def __str__(self
): return str(self
.Get())
913 def __repr__(self
): return 'wx.Size'+str(self
.Get())
914 def __len__(self
): return len(self
.Get())
915 def __getitem__(self
, index
): return self
.Get()[index
]
916 def __setitem__(self
, index
, val
):
917 if index
== 0: self
.width
= val
918 elif index
== 1: self
.height
= val
919 else: raise IndexError
920 def __nonzero__(self
): return self
.Get() != (0,0)
921 __safe_for_unpickling__
= True
922 def __reduce__(self
): return (wx
.Size
, self
.Get())
926 def __init__(self
, this
):
928 if not hasattr(self
,"thisown"): self
.thisown
= 0
929 self
.__class
__ = Size
930 _core_
.Size_swigregister(SizePtr
)
932 #---------------------------------------------------------------------------
934 class RealPoint(object):
936 A data structure for representing a point or position with floating
937 point x and y properties. In wxPython most places that expect a
938 wx.RealPoint can also accept a (x,y) tuple.
941 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
942 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
943 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
944 def __init__(self
, *args
, **kwargs
):
946 __init__(self, double x=0.0, double y=0.0) -> RealPoint
948 Create a wx.RealPoint object
950 newobj
= _core_
.new_RealPoint(*args
, **kwargs
)
951 self
.this
= newobj
.this
954 def __del__(self
, destroy
=_core_
.delete_RealPoint
):
957 if self
.thisown
: destroy(self
)
960 def __eq__(*args
, **kwargs
):
962 __eq__(self, RealPoint pt) -> bool
964 Test for equality of wx.RealPoint objects.
966 return _core_
.RealPoint___eq__(*args
, **kwargs
)
968 def __ne__(*args
, **kwargs
):
970 __ne__(self, RealPoint pt) -> bool
972 Test for inequality of wx.RealPoint objects.
974 return _core_
.RealPoint___ne__(*args
, **kwargs
)
976 def __add__(*args
, **kwargs
):
978 __add__(self, RealPoint pt) -> RealPoint
980 Add pt's proprties to this and return the result.
982 return _core_
.RealPoint___add__(*args
, **kwargs
)
984 def __sub__(*args
, **kwargs
):
986 __sub__(self, RealPoint pt) -> RealPoint
988 Subtract pt's proprties from this and return the result
990 return _core_
.RealPoint___sub__(*args
, **kwargs
)
992 def Set(*args
, **kwargs
):
994 Set(self, double x, double y)
996 Set both the x and y properties
998 return _core_
.RealPoint_Set(*args
, **kwargs
)
1000 def Get(*args
, **kwargs
):
1004 Return the x and y properties as a tuple.
1006 return _core_
.RealPoint_Get(*args
, **kwargs
)
1008 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1009 def __str__(self
): return str(self
.Get())
1010 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
1011 def __len__(self
): return len(self
.Get())
1012 def __getitem__(self
, index
): return self
.Get()[index
]
1013 def __setitem__(self
, index
, val
):
1014 if index
== 0: self
.x
= val
1015 elif index
== 1: self
.y
= val
1016 else: raise IndexError
1017 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1018 __safe_for_unpickling__
= True
1019 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
1022 class RealPointPtr(RealPoint
):
1023 def __init__(self
, this
):
1025 if not hasattr(self
,"thisown"): self
.thisown
= 0
1026 self
.__class
__ = RealPoint
1027 _core_
.RealPoint_swigregister(RealPointPtr
)
1029 #---------------------------------------------------------------------------
1031 class Point(object):
1033 A data structure for representing a point or position with integer x
1034 and y properties. Most places in wxPython that expect a wx.Point can
1035 also accept a (x,y) tuple.
1038 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1039 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1040 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1041 def __init__(self
, *args
, **kwargs
):
1043 __init__(self, int x=0, int y=0) -> Point
1045 Create a wx.Point object
1047 newobj
= _core_
.new_Point(*args
, **kwargs
)
1048 self
.this
= newobj
.this
1051 def __del__(self
, destroy
=_core_
.delete_Point
):
1054 if self
.thisown
: destroy(self
)
1057 def __eq__(*args
, **kwargs
):
1059 __eq__(self, Point pt) -> bool
1061 Test for equality of wx.Point objects.
1063 return _core_
.Point___eq__(*args
, **kwargs
)
1065 def __ne__(*args
, **kwargs
):
1067 __ne__(self, Point pt) -> bool
1069 Test for inequality of wx.Point objects.
1071 return _core_
.Point___ne__(*args
, **kwargs
)
1073 def __add__(*args
, **kwargs
):
1075 __add__(self, Point pt) -> Point
1077 Add pt's proprties to this and return the result.
1079 return _core_
.Point___add__(*args
, **kwargs
)
1081 def __sub__(*args
, **kwargs
):
1083 __sub__(self, Point pt) -> Point
1085 Subtract pt's proprties from this and return the result
1087 return _core_
.Point___sub__(*args
, **kwargs
)
1089 def __iadd__(*args
, **kwargs
):
1091 __iadd__(self, Point pt) -> Point
1093 Add pt to this object.
1095 return _core_
.Point___iadd__(*args
, **kwargs
)
1097 def __isub__(*args
, **kwargs
):
1099 __isub__(self, Point pt) -> Point
1101 Subtract pt from this object.
1103 return _core_
.Point___isub__(*args
, **kwargs
)
1105 def Set(*args
, **kwargs
):
1107 Set(self, long x, long y)
1109 Set both the x and y properties
1111 return _core_
.Point_Set(*args
, **kwargs
)
1113 def Get(*args
, **kwargs
):
1117 Return the x and y properties as a tuple.
1119 return _core_
.Point_Get(*args
, **kwargs
)
1121 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1122 def __str__(self
): return str(self
.Get())
1123 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1124 def __len__(self
): return len(self
.Get())
1125 def __getitem__(self
, index
): return self
.Get()[index
]
1126 def __setitem__(self
, index
, val
):
1127 if index
== 0: self
.x
= val
1128 elif index
== 1: self
.y
= val
1129 else: raise IndexError
1130 def __nonzero__(self
): return self
.Get() != (0,0)
1131 __safe_for_unpickling__
= True
1132 def __reduce__(self
): return (wx
.Point
, self
.Get())
1135 class PointPtr(Point
):
1136 def __init__(self
, this
):
1138 if not hasattr(self
,"thisown"): self
.thisown
= 0
1139 self
.__class
__ = Point
1140 _core_
.Point_swigregister(PointPtr
)
1142 #---------------------------------------------------------------------------
1146 A class for representing and manipulating rectangles. It has x, y,
1147 width and height properties. In wxPython most palces that expect a
1148 wx.Rect can also accept a (x,y,width,height) tuple.
1151 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1152 def __init__(self
, *args
, **kwargs
):
1154 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1156 Create a new Rect object.
1158 newobj
= _core_
.new_Rect(*args
, **kwargs
)
1159 self
.this
= newobj
.this
1162 def __del__(self
, destroy
=_core_
.delete_Rect
):
1165 if self
.thisown
: destroy(self
)
1168 def GetX(*args
, **kwargs
):
1169 """GetX(self) -> int"""
1170 return _core_
.Rect_GetX(*args
, **kwargs
)
1172 def SetX(*args
, **kwargs
):
1173 """SetX(self, int x)"""
1174 return _core_
.Rect_SetX(*args
, **kwargs
)
1176 def GetY(*args
, **kwargs
):
1177 """GetY(self) -> int"""
1178 return _core_
.Rect_GetY(*args
, **kwargs
)
1180 def SetY(*args
, **kwargs
):
1181 """SetY(self, int y)"""
1182 return _core_
.Rect_SetY(*args
, **kwargs
)
1184 def GetWidth(*args
, **kwargs
):
1185 """GetWidth(self) -> int"""
1186 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1188 def SetWidth(*args
, **kwargs
):
1189 """SetWidth(self, int w)"""
1190 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1192 def GetHeight(*args
, **kwargs
):
1193 """GetHeight(self) -> int"""
1194 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1196 def SetHeight(*args
, **kwargs
):
1197 """SetHeight(self, int h)"""
1198 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1200 def GetPosition(*args
, **kwargs
):
1201 """GetPosition(self) -> Point"""
1202 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1204 def SetPosition(*args
, **kwargs
):
1205 """SetPosition(self, Point p)"""
1206 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1208 def GetSize(*args
, **kwargs
):
1209 """GetSize(self) -> Size"""
1210 return _core_
.Rect_GetSize(*args
, **kwargs
)
1212 def SetSize(*args
, **kwargs
):
1213 """SetSize(self, Size s)"""
1214 return _core_
.Rect_SetSize(*args
, **kwargs
)
1216 def IsEmpty(*args
, **kwargs
):
1217 """IsEmpty(self) -> bool"""
1218 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1220 def GetTopLeft(*args
, **kwargs
):
1221 """GetTopLeft(self) -> Point"""
1222 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1224 def SetTopLeft(*args
, **kwargs
):
1225 """SetTopLeft(self, Point p)"""
1226 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1228 def GetBottomRight(*args
, **kwargs
):
1229 """GetBottomRight(self) -> Point"""
1230 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1232 def SetBottomRight(*args
, **kwargs
):
1233 """SetBottomRight(self, Point p)"""
1234 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1236 def GetLeft(*args
, **kwargs
):
1237 """GetLeft(self) -> int"""
1238 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1240 def GetTop(*args
, **kwargs
):
1241 """GetTop(self) -> int"""
1242 return _core_
.Rect_GetTop(*args
, **kwargs
)
1244 def GetBottom(*args
, **kwargs
):
1245 """GetBottom(self) -> int"""
1246 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1248 def GetRight(*args
, **kwargs
):
1249 """GetRight(self) -> int"""
1250 return _core_
.Rect_GetRight(*args
, **kwargs
)
1252 def SetLeft(*args
, **kwargs
):
1253 """SetLeft(self, int left)"""
1254 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1256 def SetRight(*args
, **kwargs
):
1257 """SetRight(self, int right)"""
1258 return _core_
.Rect_SetRight(*args
, **kwargs
)
1260 def SetTop(*args
, **kwargs
):
1261 """SetTop(self, int top)"""
1262 return _core_
.Rect_SetTop(*args
, **kwargs
)
1264 def SetBottom(*args
, **kwargs
):
1265 """SetBottom(self, int bottom)"""
1266 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1268 position
= property(GetPosition
, SetPosition
)
1269 size
= property(GetSize
, SetSize
)
1270 left
= property(GetLeft
, SetLeft
)
1271 right
= property(GetRight
, SetRight
)
1272 top
= property(GetTop
, SetTop
)
1273 bottom
= property(GetBottom
, SetBottom
)
1275 def Inflate(*args
, **kwargs
):
1277 Inflate(self, int dx, int dy) -> Rect
1279 Increases the size of the rectangle.
1281 The left border is moved farther left and the right border is moved
1282 farther right by ``dx``. The upper border is moved farther up and the
1283 bottom border is moved farther down by ``dy``. (Note the the width and
1284 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1285 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1286 opposite happens: the rectangle size decreases in the respective
1289 The change is made to the rectangle inplace, if instead you need a
1290 copy that is inflated, preserving the original then make the copy
1293 copy = wx.Rect(*original)
1298 return _core_
.Rect_Inflate(*args
, **kwargs
)
1300 def Deflate(*args
, **kwargs
):
1302 Deflate(self, int dx, int dy) -> Rect
1304 Decrease the rectangle size. This method is the opposite of `Inflate`
1305 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1306 `Inflate` for a full description.
1308 return _core_
.Rect_Deflate(*args
, **kwargs
)
1310 def OffsetXY(*args
, **kwargs
):
1312 OffsetXY(self, int dx, int dy)
1314 Moves the rectangle by the specified offset. If dx is positive, the
1315 rectangle is moved to the right, if dy is positive, it is moved to the
1316 bottom, otherwise it is moved to the left or top respectively.
1318 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1320 def Offset(*args
, **kwargs
):
1322 Offset(self, Point pt)
1324 Same as `OffsetXY` but uses dx,dy from Point
1326 return _core_
.Rect_Offset(*args
, **kwargs
)
1328 def Intersect(*args
, **kwargs
):
1330 Intersect(self, Rect rect) -> Rect
1332 Returns the intersectsion of this rectangle and rect.
1334 return _core_
.Rect_Intersect(*args
, **kwargs
)
1336 def Union(*args
, **kwargs
):
1338 Union(self, Rect rect) -> Rect
1340 Returns the union of this rectangle and rect.
1342 return _core_
.Rect_Union(*args
, **kwargs
)
1344 def __add__(*args
, **kwargs
):
1346 __add__(self, Rect rect) -> Rect
1348 Add the properties of rect to this rectangle and return the result.
1350 return _core_
.Rect___add__(*args
, **kwargs
)
1352 def __iadd__(*args
, **kwargs
):
1354 __iadd__(self, Rect rect) -> Rect
1356 Add the properties of rect to this rectangle, updating this rectangle.
1358 return _core_
.Rect___iadd__(*args
, **kwargs
)
1360 def __eq__(*args
, **kwargs
):
1362 __eq__(self, Rect rect) -> bool
1366 return _core_
.Rect___eq__(*args
, **kwargs
)
1368 def __ne__(*args
, **kwargs
):
1370 __ne__(self, Rect rect) -> bool
1372 Test for inequality.
1374 return _core_
.Rect___ne__(*args
, **kwargs
)
1376 def InsideXY(*args
, **kwargs
):
1378 InsideXY(self, int x, int y) -> bool
1380 Return True if the point is (not strcitly) inside the rect.
1382 return _core_
.Rect_InsideXY(*args
, **kwargs
)
1384 def Inside(*args
, **kwargs
):
1386 Inside(self, Point pt) -> bool
1388 Return True if the point is (not strcitly) inside the rect.
1390 return _core_
.Rect_Inside(*args
, **kwargs
)
1392 def Intersects(*args
, **kwargs
):
1394 Intersects(self, Rect rect) -> bool
1396 Returns True if the rectangles have a non empty intersection.
1398 return _core_
.Rect_Intersects(*args
, **kwargs
)
1400 def CenterIn(*args
, **kwargs
):
1402 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1404 Center this rectangle within the one passed to the method, which is
1405 usually, but not necessarily, the larger one.
1407 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1410 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1411 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1412 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1413 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1414 def Set(*args
, **kwargs
):
1416 Set(self, int x=0, int y=0, int width=0, int height=0)
1418 Set all rectangle properties.
1420 return _core_
.Rect_Set(*args
, **kwargs
)
1422 def Get(*args
, **kwargs
):
1424 Get() -> (x,y,width,height)
1426 Return the rectangle properties as a tuple.
1428 return _core_
.Rect_Get(*args
, **kwargs
)
1430 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1431 def __str__(self
): return str(self
.Get())
1432 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1433 def __len__(self
): return len(self
.Get())
1434 def __getitem__(self
, index
): return self
.Get()[index
]
1435 def __setitem__(self
, index
, val
):
1436 if index
== 0: self
.x
= val
1437 elif index
== 1: self
.y
= val
1438 elif index
== 2: self
.width
= val
1439 elif index
== 3: self
.height
= val
1440 else: raise IndexError
1441 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1442 __safe_for_unpickling__
= True
1443 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1446 class RectPtr(Rect
):
1447 def __init__(self
, this
):
1449 if not hasattr(self
,"thisown"): self
.thisown
= 0
1450 self
.__class
__ = Rect
1451 _core_
.Rect_swigregister(RectPtr
)
1453 def RectPP(*args
, **kwargs
):
1455 RectPP(Point topLeft, Point bottomRight) -> Rect
1457 Create a new Rect object from Points representing two corners.
1459 val
= _core_
.new_RectPP(*args
, **kwargs
)
1463 def RectPS(*args
, **kwargs
):
1465 RectPS(Point pos, Size size) -> Rect
1467 Create a new Rect from a position and size.
1469 val
= _core_
.new_RectPS(*args
, **kwargs
)
1473 def RectS(*args
, **kwargs
):
1475 RectS(Size size) -> Rect
1477 Create a new Rect from a size only.
1479 val
= _core_
.new_RectS(*args
, **kwargs
)
1484 def IntersectRect(*args
, **kwargs
):
1486 IntersectRect(Rect r1, Rect r2) -> Rect
1488 Calculate and return the intersection of r1 and r2.
1490 return _core_
.IntersectRect(*args
, **kwargs
)
1491 #---------------------------------------------------------------------------
1493 class Point2D(object):
1495 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1496 with floating point values.
1499 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1500 def __init__(self
, *args
, **kwargs
):
1502 __init__(self, double x=0.0, double y=0.0) -> Point2D
1504 Create a w.Point2D object.
1506 newobj
= _core_
.new_Point2D(*args
, **kwargs
)
1507 self
.this
= newobj
.this
1510 def GetFloor(*args
, **kwargs
):
1516 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1518 def GetRounded(*args
, **kwargs
):
1520 GetRounded() -> (x,y)
1524 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1526 def GetVectorLength(*args
, **kwargs
):
1527 """GetVectorLength(self) -> double"""
1528 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1530 def GetVectorAngle(*args
, **kwargs
):
1531 """GetVectorAngle(self) -> double"""
1532 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1534 def SetVectorLength(*args
, **kwargs
):
1535 """SetVectorLength(self, double length)"""
1536 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1538 def SetVectorAngle(*args
, **kwargs
):
1539 """SetVectorAngle(self, double degrees)"""
1540 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1542 def SetPolarCoordinates(self
, angle
, length
):
1543 self
.SetVectorLength(length
)
1544 self
.SetVectorAngle(angle
)
1545 def Normalize(self
):
1546 self
.SetVectorLength(1.0)
1548 def GetDistance(*args
, **kwargs
):
1549 """GetDistance(self, Point2D pt) -> double"""
1550 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1552 def GetDistanceSquare(*args
, **kwargs
):
1553 """GetDistanceSquare(self, Point2D pt) -> double"""
1554 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1556 def GetDotProduct(*args
, **kwargs
):
1557 """GetDotProduct(self, Point2D vec) -> double"""
1558 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1560 def GetCrossProduct(*args
, **kwargs
):
1561 """GetCrossProduct(self, Point2D vec) -> double"""
1562 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1564 def __neg__(*args
, **kwargs
):
1566 __neg__(self) -> Point2D
1568 the reflection of this point
1570 return _core_
.Point2D___neg__(*args
, **kwargs
)
1572 def __iadd__(*args
, **kwargs
):
1573 """__iadd__(self, Point2D pt) -> Point2D"""
1574 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1576 def __isub__(*args
, **kwargs
):
1577 """__isub__(self, Point2D pt) -> Point2D"""
1578 return _core_
.Point2D___isub__(*args
, **kwargs
)
1580 def __imul__(*args
, **kwargs
):
1581 """__imul__(self, Point2D pt) -> Point2D"""
1582 return _core_
.Point2D___imul__(*args
, **kwargs
)
1584 def __idiv__(*args
, **kwargs
):
1585 """__idiv__(self, Point2D pt) -> Point2D"""
1586 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1588 def __eq__(*args
, **kwargs
):
1590 __eq__(self, Point2D pt) -> bool
1594 return _core_
.Point2D___eq__(*args
, **kwargs
)
1596 def __ne__(*args
, **kwargs
):
1598 __ne__(self, Point2D pt) -> bool
1602 return _core_
.Point2D___ne__(*args
, **kwargs
)
1604 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1605 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1606 def Set(*args
, **kwargs
):
1607 """Set(self, double x=0, double y=0)"""
1608 return _core_
.Point2D_Set(*args
, **kwargs
)
1610 def Get(*args
, **kwargs
):
1614 Return x and y properties as a tuple.
1616 return _core_
.Point2D_Get(*args
, **kwargs
)
1618 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1619 def __str__(self
): return str(self
.Get())
1620 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1621 def __len__(self
): return len(self
.Get())
1622 def __getitem__(self
, index
): return self
.Get()[index
]
1623 def __setitem__(self
, index
, val
):
1624 if index
== 0: self
.x
= val
1625 elif index
== 1: self
.y
= val
1626 else: raise IndexError
1627 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1628 __safe_for_unpickling__
= True
1629 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1632 class Point2DPtr(Point2D
):
1633 def __init__(self
, this
):
1635 if not hasattr(self
,"thisown"): self
.thisown
= 0
1636 self
.__class
__ = Point2D
1637 _core_
.Point2D_swigregister(Point2DPtr
)
1639 def Point2DCopy(*args
, **kwargs
):
1641 Point2DCopy(Point2D pt) -> Point2D
1643 Create a w.Point2D object.
1645 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1649 def Point2DFromPoint(*args
, **kwargs
):
1651 Point2DFromPoint(Point pt) -> Point2D
1653 Create a w.Point2D object.
1655 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1659 #---------------------------------------------------------------------------
1661 FromStart
= _core_
.FromStart
1662 FromCurrent
= _core_
.FromCurrent
1663 FromEnd
= _core_
.FromEnd
1664 class InputStream(object):
1665 """Proxy of C++ InputStream class"""
1667 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1668 def __init__(self
, *args
, **kwargs
):
1669 """__init__(self, PyObject p) -> InputStream"""
1670 newobj
= _core_
.new_InputStream(*args
, **kwargs
)
1671 self
.this
= newobj
.this
1674 def __del__(self
, destroy
=_core_
.delete_InputStream
):
1677 if self
.thisown
: destroy(self
)
1680 def close(*args
, **kwargs
):
1682 return _core_
.InputStream_close(*args
, **kwargs
)
1684 def flush(*args
, **kwargs
):
1686 return _core_
.InputStream_flush(*args
, **kwargs
)
1688 def eof(*args
, **kwargs
):
1689 """eof(self) -> bool"""
1690 return _core_
.InputStream_eof(*args
, **kwargs
)
1692 def read(*args
, **kwargs
):
1693 """read(self, int size=-1) -> PyObject"""
1694 return _core_
.InputStream_read(*args
, **kwargs
)
1696 def readline(*args
, **kwargs
):
1697 """readline(self, int size=-1) -> PyObject"""
1698 return _core_
.InputStream_readline(*args
, **kwargs
)
1700 def readlines(*args
, **kwargs
):
1701 """readlines(self, int sizehint=-1) -> PyObject"""
1702 return _core_
.InputStream_readlines(*args
, **kwargs
)
1704 def seek(*args
, **kwargs
):
1705 """seek(self, int offset, int whence=0)"""
1706 return _core_
.InputStream_seek(*args
, **kwargs
)
1708 def tell(*args
, **kwargs
):
1709 """tell(self) -> int"""
1710 return _core_
.InputStream_tell(*args
, **kwargs
)
1712 def Peek(*args
, **kwargs
):
1713 """Peek(self) -> char"""
1714 return _core_
.InputStream_Peek(*args
, **kwargs
)
1716 def GetC(*args
, **kwargs
):
1717 """GetC(self) -> char"""
1718 return _core_
.InputStream_GetC(*args
, **kwargs
)
1720 def LastRead(*args
, **kwargs
):
1721 """LastRead(self) -> size_t"""
1722 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1724 def CanRead(*args
, **kwargs
):
1725 """CanRead(self) -> bool"""
1726 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1728 def Eof(*args
, **kwargs
):
1729 """Eof(self) -> bool"""
1730 return _core_
.InputStream_Eof(*args
, **kwargs
)
1732 def Ungetch(*args
, **kwargs
):
1733 """Ungetch(self, char c) -> bool"""
1734 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1736 def SeekI(*args
, **kwargs
):
1737 """SeekI(self, long pos, int mode=FromStart) -> long"""
1738 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1740 def TellI(*args
, **kwargs
):
1741 """TellI(self) -> long"""
1742 return _core_
.InputStream_TellI(*args
, **kwargs
)
1745 class InputStreamPtr(InputStream
):
1746 def __init__(self
, this
):
1748 if not hasattr(self
,"thisown"): self
.thisown
= 0
1749 self
.__class
__ = InputStream
1750 _core_
.InputStream_swigregister(InputStreamPtr
)
1751 DefaultPosition
= cvar
.DefaultPosition
1752 DefaultSize
= cvar
.DefaultSize
1754 class OutputStream(object):
1755 """Proxy of C++ OutputStream class"""
1756 def __init__(self
): raise RuntimeError, "No constructor defined"
1758 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1759 def write(*args
, **kwargs
):
1760 """write(self, PyObject obj)"""
1761 return _core_
.OutputStream_write(*args
, **kwargs
)
1764 class OutputStreamPtr(OutputStream
):
1765 def __init__(self
, this
):
1767 if not hasattr(self
,"thisown"): self
.thisown
= 0
1768 self
.__class
__ = OutputStream
1769 _core_
.OutputStream_swigregister(OutputStreamPtr
)
1771 #---------------------------------------------------------------------------
1773 class FSFile(Object
):
1774 """Proxy of C++ FSFile class"""
1776 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1777 def __init__(self
, *args
, **kwargs
):
1779 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1780 DateTime modif) -> FSFile
1782 newobj
= _core_
.new_FSFile(*args
, **kwargs
)
1783 self
.this
= newobj
.this
1786 self
.thisown
= 0 # It will normally be deleted by the user of the wx.FileSystem
1788 def __del__(self
, destroy
=_core_
.delete_FSFile
):
1791 if self
.thisown
: destroy(self
)
1794 def GetStream(*args
, **kwargs
):
1795 """GetStream(self) -> InputStream"""
1796 return _core_
.FSFile_GetStream(*args
, **kwargs
)
1798 def GetMimeType(*args
, **kwargs
):
1799 """GetMimeType(self) -> String"""
1800 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
1802 def GetLocation(*args
, **kwargs
):
1803 """GetLocation(self) -> String"""
1804 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
1806 def GetAnchor(*args
, **kwargs
):
1807 """GetAnchor(self) -> String"""
1808 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
1810 def GetModificationTime(*args
, **kwargs
):
1811 """GetModificationTime(self) -> DateTime"""
1812 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
1815 class FSFilePtr(FSFile
):
1816 def __init__(self
, this
):
1818 if not hasattr(self
,"thisown"): self
.thisown
= 0
1819 self
.__class
__ = FSFile
1820 _core_
.FSFile_swigregister(FSFilePtr
)
1822 class CPPFileSystemHandler(object):
1823 """Proxy of C++ CPPFileSystemHandler class"""
1824 def __init__(self
): raise RuntimeError, "No constructor defined"
1826 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1828 class CPPFileSystemHandlerPtr(CPPFileSystemHandler
):
1829 def __init__(self
, this
):
1831 if not hasattr(self
,"thisown"): self
.thisown
= 0
1832 self
.__class
__ = CPPFileSystemHandler
1833 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr
)
1835 class FileSystemHandler(CPPFileSystemHandler
):
1836 """Proxy of C++ FileSystemHandler class"""
1838 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1839 def __init__(self
, *args
, **kwargs
):
1840 """__init__(self) -> FileSystemHandler"""
1841 newobj
= _core_
.new_FileSystemHandler(*args
, **kwargs
)
1842 self
.this
= newobj
.this
1845 self
._setCallbackInfo
(self
, FileSystemHandler
)
1847 def _setCallbackInfo(*args
, **kwargs
):
1848 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1849 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
1851 def CanOpen(*args
, **kwargs
):
1852 """CanOpen(self, String location) -> bool"""
1853 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
1855 def OpenFile(*args
, **kwargs
):
1856 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1857 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
1859 def FindFirst(*args
, **kwargs
):
1860 """FindFirst(self, String spec, int flags=0) -> String"""
1861 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
1863 def FindNext(*args
, **kwargs
):
1864 """FindNext(self) -> String"""
1865 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
1867 def GetProtocol(*args
, **kwargs
):
1868 """GetProtocol(self, String location) -> String"""
1869 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
1871 def GetLeftLocation(*args
, **kwargs
):
1872 """GetLeftLocation(self, String location) -> String"""
1873 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
1875 def GetAnchor(*args
, **kwargs
):
1876 """GetAnchor(self, String location) -> String"""
1877 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
1879 def GetRightLocation(*args
, **kwargs
):
1880 """GetRightLocation(self, String location) -> String"""
1881 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
1883 def GetMimeTypeFromExt(*args
, **kwargs
):
1884 """GetMimeTypeFromExt(self, String location) -> String"""
1885 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
1888 class FileSystemHandlerPtr(FileSystemHandler
):
1889 def __init__(self
, this
):
1891 if not hasattr(self
,"thisown"): self
.thisown
= 0
1892 self
.__class
__ = FileSystemHandler
1893 _core_
.FileSystemHandler_swigregister(FileSystemHandlerPtr
)
1895 class FileSystem(Object
):
1896 """Proxy of C++ FileSystem class"""
1898 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1899 def __init__(self
, *args
, **kwargs
):
1900 """__init__(self) -> FileSystem"""
1901 newobj
= _core_
.new_FileSystem(*args
, **kwargs
)
1902 self
.this
= newobj
.this
1905 def __del__(self
, destroy
=_core_
.delete_FileSystem
):
1908 if self
.thisown
: destroy(self
)
1911 def ChangePathTo(*args
, **kwargs
):
1912 """ChangePathTo(self, String location, bool is_dir=False)"""
1913 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
1915 def GetPath(*args
, **kwargs
):
1916 """GetPath(self) -> String"""
1917 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
1919 def OpenFile(*args
, **kwargs
):
1920 """OpenFile(self, String location) -> FSFile"""
1921 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
1923 def FindFirst(*args
, **kwargs
):
1924 """FindFirst(self, String spec, int flags=0) -> String"""
1925 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
1927 def FindNext(*args
, **kwargs
):
1928 """FindNext(self) -> String"""
1929 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
1931 def AddHandler(*args
, **kwargs
):
1932 """AddHandler(CPPFileSystemHandler handler)"""
1933 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1935 AddHandler
= staticmethod(AddHandler
)
1936 def CleanUpHandlers(*args
, **kwargs
):
1937 """CleanUpHandlers()"""
1938 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
1940 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
1941 def FileNameToURL(*args
, **kwargs
):
1942 """FileNameToURL(String filename) -> String"""
1943 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1945 FileNameToURL
= staticmethod(FileNameToURL
)
1946 def URLToFileName(*args
, **kwargs
):
1947 """URLToFileName(String url) -> String"""
1948 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1950 URLToFileName
= staticmethod(URLToFileName
)
1952 class FileSystemPtr(FileSystem
):
1953 def __init__(self
, this
):
1955 if not hasattr(self
,"thisown"): self
.thisown
= 0
1956 self
.__class
__ = FileSystem
1957 _core_
.FileSystem_swigregister(FileSystemPtr
)
1959 def FileSystem_AddHandler(*args
, **kwargs
):
1960 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1961 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1963 def FileSystem_CleanUpHandlers(*args
, **kwargs
):
1964 """FileSystem_CleanUpHandlers()"""
1965 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
1967 def FileSystem_FileNameToURL(*args
, **kwargs
):
1968 """FileSystem_FileNameToURL(String filename) -> String"""
1969 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1971 def FileSystem_URLToFileName(*args
, **kwargs
):
1972 """FileSystem_URLToFileName(String url) -> String"""
1973 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1975 class InternetFSHandler(CPPFileSystemHandler
):
1976 """Proxy of C++ InternetFSHandler class"""
1978 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
1979 def __init__(self
, *args
, **kwargs
):
1980 """__init__(self) -> InternetFSHandler"""
1981 newobj
= _core_
.new_InternetFSHandler(*args
, **kwargs
)
1982 self
.this
= newobj
.this
1985 def CanOpen(*args
, **kwargs
):
1986 """CanOpen(self, String location) -> bool"""
1987 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
1989 def OpenFile(*args
, **kwargs
):
1990 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1991 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
1994 class InternetFSHandlerPtr(InternetFSHandler
):
1995 def __init__(self
, this
):
1997 if not hasattr(self
,"thisown"): self
.thisown
= 0
1998 self
.__class
__ = InternetFSHandler
1999 _core_
.InternetFSHandler_swigregister(InternetFSHandlerPtr
)
2001 class ZipFSHandler(CPPFileSystemHandler
):
2002 """Proxy of C++ ZipFSHandler class"""
2004 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2005 def __init__(self
, *args
, **kwargs
):
2006 """__init__(self) -> ZipFSHandler"""
2007 newobj
= _core_
.new_ZipFSHandler(*args
, **kwargs
)
2008 self
.this
= newobj
.this
2011 def CanOpen(*args
, **kwargs
):
2012 """CanOpen(self, String location) -> bool"""
2013 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
2015 def OpenFile(*args
, **kwargs
):
2016 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2017 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
2019 def FindFirst(*args
, **kwargs
):
2020 """FindFirst(self, String spec, int flags=0) -> String"""
2021 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
2023 def FindNext(*args
, **kwargs
):
2024 """FindNext(self) -> String"""
2025 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
2028 class ZipFSHandlerPtr(ZipFSHandler
):
2029 def __init__(self
, this
):
2031 if not hasattr(self
,"thisown"): self
.thisown
= 0
2032 self
.__class
__ = ZipFSHandler
2033 _core_
.ZipFSHandler_swigregister(ZipFSHandlerPtr
)
2036 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
2037 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2038 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
2040 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
2041 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2042 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
2044 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
2045 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2046 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
2047 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
2049 Add 'file' to the memory filesystem. The dataItem parameter can
2050 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2051 arbitrary data. If a bitmap or image is used then the imgType
2052 parameter should specify what kind of image file it should be
2053 written as, wx.BITMAP_TYPE_PNG, etc.
2055 if isinstance(dataItem
, wx
.Image
):
2056 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
2057 elif isinstance(dataItem
, wx
.Bitmap
):
2058 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2059 elif type(dataItem
) == str:
2060 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2062 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2064 class MemoryFSHandler(CPPFileSystemHandler
):
2065 """Proxy of C++ MemoryFSHandler class"""
2067 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2068 def __init__(self
, *args
, **kwargs
):
2069 """__init__(self) -> MemoryFSHandler"""
2070 newobj
= _core_
.new_MemoryFSHandler(*args
, **kwargs
)
2071 self
.this
= newobj
.this
2074 def RemoveFile(*args
, **kwargs
):
2075 """RemoveFile(String filename)"""
2076 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2078 RemoveFile
= staticmethod(RemoveFile
)
2079 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2080 def CanOpen(*args
, **kwargs
):
2081 """CanOpen(self, String location) -> bool"""
2082 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2084 def OpenFile(*args
, **kwargs
):
2085 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2086 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2088 def FindFirst(*args
, **kwargs
):
2089 """FindFirst(self, String spec, int flags=0) -> String"""
2090 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2092 def FindNext(*args
, **kwargs
):
2093 """FindNext(self) -> String"""
2094 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2097 class MemoryFSHandlerPtr(MemoryFSHandler
):
2098 def __init__(self
, this
):
2100 if not hasattr(self
,"thisown"): self
.thisown
= 0
2101 self
.__class
__ = MemoryFSHandler
2102 _core_
.MemoryFSHandler_swigregister(MemoryFSHandlerPtr
)
2104 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2105 """MemoryFSHandler_RemoveFile(String filename)"""
2106 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2108 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2109 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2110 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2111 #---------------------------------------------------------------------------
2113 class ImageHandler(Object
):
2115 This is the base class for implementing image file loading/saving, and
2116 image creation from data. It is used within `wx.Image` and is not
2117 normally seen by the application.
2119 def __init__(self
): raise RuntimeError, "No constructor defined"
2121 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2122 def GetName(*args
, **kwargs
):
2123 """GetName(self) -> String"""
2124 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2126 def GetExtension(*args
, **kwargs
):
2127 """GetExtension(self) -> String"""
2128 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2130 def GetType(*args
, **kwargs
):
2131 """GetType(self) -> long"""
2132 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2134 def GetMimeType(*args
, **kwargs
):
2135 """GetMimeType(self) -> String"""
2136 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2138 def CanRead(*args
, **kwargs
):
2139 """CanRead(self, String name) -> bool"""
2140 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2142 def SetName(*args
, **kwargs
):
2143 """SetName(self, String name)"""
2144 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2146 def SetExtension(*args
, **kwargs
):
2147 """SetExtension(self, String extension)"""
2148 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2150 def SetType(*args
, **kwargs
):
2151 """SetType(self, long type)"""
2152 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2154 def SetMimeType(*args
, **kwargs
):
2155 """SetMimeType(self, String mimetype)"""
2156 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2159 class ImageHandlerPtr(ImageHandler
):
2160 def __init__(self
, this
):
2162 if not hasattr(self
,"thisown"): self
.thisown
= 0
2163 self
.__class
__ = ImageHandler
2164 _core_
.ImageHandler_swigregister(ImageHandlerPtr
)
2166 class PyImageHandler(ImageHandler
):
2168 This is the base class for implementing image file loading/saving, and
2169 image creation from data, all written in Python. To create a custom
2170 image handler derive a new class from wx.PyImageHandler and provide
2171 the following methods::
2173 def DoCanRead(self, stream) --> bool
2174 '''Check if this handler can read the image on the stream'''
2176 def LoadFile(self, image, stream, verbose, index) --> bool
2177 '''Load image data from the stream and load it into image.'''
2179 def SaveFile(self, image, stream, verbose) --> bool
2180 '''Save the iamge data in image to the stream using
2181 this handler's image file format.'''
2183 def GetImageCount(self, stream) --> int
2184 '''If this image format can hold more than one image,
2185 how many does the image on the stream have?'''
2187 To activate your handler create an instance of it and pass it to
2188 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2189 `SetExtension` from your constructor.
2193 return "<%s.%s; proxy of C++ wxPyImageHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2194 def __init__(self
, *args
, **kwargs
):
2196 __init__(self) -> PyImageHandler
2198 This is the base class for implementing image file loading/saving, and
2199 image creation from data, all written in Python. To create a custom
2200 image handler derive a new class from wx.PyImageHandler and provide
2201 the following methods::
2203 def DoCanRead(self, stream) --> bool
2204 '''Check if this handler can read the image on the stream'''
2206 def LoadFile(self, image, stream, verbose, index) --> bool
2207 '''Load image data from the stream and load it into image.'''
2209 def SaveFile(self, image, stream, verbose) --> bool
2210 '''Save the iamge data in image to the stream using
2211 this handler's image file format.'''
2213 def GetImageCount(self, stream) --> int
2214 '''If this image format can hold more than one image,
2215 how many does the image on the stream have?'''
2217 To activate your handler create an instance of it and pass it to
2218 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2219 `SetExtension` from your constructor.
2222 newobj
= _core_
.new_PyImageHandler(*args
, **kwargs
)
2223 self
.this
= newobj
.this
2228 def _SetSelf(*args
, **kwargs
):
2229 """_SetSelf(self, PyObject self)"""
2230 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2233 class PyImageHandlerPtr(PyImageHandler
):
2234 def __init__(self
, this
):
2236 if not hasattr(self
,"thisown"): self
.thisown
= 0
2237 self
.__class
__ = PyImageHandler
2238 _core_
.PyImageHandler_swigregister(PyImageHandlerPtr
)
2240 class ImageHistogram(object):
2241 """Proxy of C++ ImageHistogram class"""
2243 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2244 def __init__(self
, *args
, **kwargs
):
2245 """__init__(self) -> ImageHistogram"""
2246 newobj
= _core_
.new_ImageHistogram(*args
, **kwargs
)
2247 self
.this
= newobj
.this
2250 def MakeKey(*args
, **kwargs
):
2252 MakeKey(byte r, byte g, byte b) -> unsigned long
2254 Get the key in the histogram for the given RGB values
2256 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2258 MakeKey
= staticmethod(MakeKey
)
2259 def FindFirstUnusedColour(*args
, **kwargs
):
2261 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2263 Find first colour that is not used in the image and has higher RGB
2264 values than startR, startG, startB. Returns a tuple consisting of a
2265 success flag and rgb values.
2267 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2269 def GetCount(*args
, **kwargs
):
2271 GetCount(self, unsigned long key) -> unsigned long
2273 Returns the pixel count for the given key. Use `MakeKey` to create a
2274 key value from a RGB tripple.
2276 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2278 def GetCountRGB(*args
, **kwargs
):
2280 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2282 Returns the pixel count for the given RGB values.
2284 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2286 def GetCountColour(*args
, **kwargs
):
2288 GetCountColour(self, Colour colour) -> unsigned long
2290 Returns the pixel count for the given `wx.Colour` value.
2292 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2295 class ImageHistogramPtr(ImageHistogram
):
2296 def __init__(self
, this
):
2298 if not hasattr(self
,"thisown"): self
.thisown
= 0
2299 self
.__class
__ = ImageHistogram
2300 _core_
.ImageHistogram_swigregister(ImageHistogramPtr
)
2302 def ImageHistogram_MakeKey(*args
, **kwargs
):
2304 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2306 Get the key in the histogram for the given RGB values
2308 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2310 class Image_RGBValue(object):
2312 An object that contains values for red, green and blue which represent
2313 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2314 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2318 return "<%s.%s; proxy of C++ wxImage_RGBValue instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2319 def __init__(self
, *args
, **kwargs
):
2321 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2325 newobj
= _core_
.new_Image_RGBValue(*args
, **kwargs
)
2326 self
.this
= newobj
.this
2329 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2330 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2331 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2333 class Image_RGBValuePtr(Image_RGBValue
):
2334 def __init__(self
, this
):
2336 if not hasattr(self
,"thisown"): self
.thisown
= 0
2337 self
.__class
__ = Image_RGBValue
2338 _core_
.Image_RGBValue_swigregister(Image_RGBValuePtr
)
2340 class Image_HSVValue(object):
2342 An object that contains values for hue, saturation and value which
2343 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2344 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2348 return "<%s.%s; proxy of C++ wxImage_HSVValue instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2349 def __init__(self
, *args
, **kwargs
):
2351 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2355 newobj
= _core_
.new_Image_HSVValue(*args
, **kwargs
)
2356 self
.this
= newobj
.this
2359 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2360 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2361 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2363 class Image_HSVValuePtr(Image_HSVValue
):
2364 def __init__(self
, this
):
2366 if not hasattr(self
,"thisown"): self
.thisown
= 0
2367 self
.__class
__ = Image_HSVValue
2368 _core_
.Image_HSVValue_swigregister(Image_HSVValuePtr
)
2370 class Image(Object
):
2372 A platform-independent image class. An image can be created from
2373 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2374 variety of formats. Functions are available to set and get image
2375 bits, so it can be used for basic image manipulation.
2377 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2378 platform-specific `wx.Bitmap` object must be created from it using the
2379 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2380 device context, using `wx.DC.DrawBitmap`.
2382 One colour value of the image may be used as a mask colour which will
2383 lead to the automatic creation of a `wx.Mask` object associated to the
2386 wx.Image supports alpha channel data, that is in addition to a byte
2387 for the red, green and blue colour components for each pixel it also
2388 stores a byte representing the pixel opacity. An alpha value of 0
2389 corresponds to a transparent pixel (null opacity) while a value of 255
2390 means that the pixel is 100% opaque.
2392 Unlike RGB data, not all images have an alpha channel and before using
2393 `GetAlpha` you should check if this image contains an alpha channel
2394 with `HasAlpha`. Note that currently only images loaded from PNG files
2395 with transparency information will have an alpha channel.
2398 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
2399 def __init__(self
, *args
, **kwargs
):
2401 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2403 Loads an image from a file.
2405 newobj
= _core_
.new_Image(*args
, **kwargs
)
2406 self
.this
= newobj
.this
2409 def __del__(self
, destroy
=_core_
.delete_Image
):
2412 if self
.thisown
: destroy(self
)
2415 def Create(*args
, **kwargs
):
2417 Create(self, int width, int height, bool clear=True)
2419 Creates a fresh image. If clear is ``True``, the new image will be
2420 initialized to black. Otherwise, the image data will be uninitialized.
2422 return _core_
.Image_Create(*args
, **kwargs
)
2424 def Destroy(*args
, **kwargs
):
2428 Destroys the image data.
2430 val
= _core_
.Image_Destroy(*args
, **kwargs
)
2434 def Scale(*args
, **kwargs
):
2436 Scale(self, int width, int height) -> Image
2438 Returns a scaled version of the image. This is also useful for scaling
2439 bitmaps in general as the only other way to scale bitmaps is to blit a
2440 `wx.MemoryDC` into another `wx.MemoryDC`.
2442 return _core_
.Image_Scale(*args
, **kwargs
)
2444 def ShrinkBy(*args
, **kwargs
):
2446 ShrinkBy(self, int xFactor, int yFactor) -> Image
2448 Return a version of the image scaled smaller by the given factors.
2450 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2452 def Rescale(*args
, **kwargs
):
2454 Rescale(self, int width, int height) -> Image
2456 Changes the size of the image in-place by scaling it: after a call to
2457 this function, the image will have the given width and height.
2459 Returns the (modified) image itself.
2461 return _core_
.Image_Rescale(*args
, **kwargs
)
2463 def Resize(*args
, **kwargs
):
2465 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2467 Changes the size of the image in-place without scaling it, by adding
2468 either a border with the given colour or cropping as necessary. The
2469 image is pasted into a new image with the given size and background
2470 colour at the position pos relative to the upper left of the new
2471 image. If red = green = blue = -1 then use either the current mask
2472 colour if set or find, use, and set a suitable mask colour for any
2473 newly exposed areas.
2475 Returns the (modified) image itself.
2477 return _core_
.Image_Resize(*args
, **kwargs
)
2479 def SetRGB(*args
, **kwargs
):
2481 SetRGB(self, int x, int y, byte r, byte g, byte b)
2483 Sets the pixel at the given coordinate. This routine performs
2484 bounds-checks for the coordinate so it can be considered a safe way to
2485 manipulate the data, but in some cases this might be too slow so that
2486 the data will have to be set directly. In that case you will have to
2487 get access to the image data using the `GetData` method.
2489 return _core_
.Image_SetRGB(*args
, **kwargs
)
2491 def SetRGBRect(*args
, **kwargs
):
2493 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2495 Sets the colour of the pixels within the given rectangle. This routine
2496 performs bounds-checks for the rectangle so it can be considered a
2497 safe way to manipulate the data.
2499 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2501 def GetRed(*args
, **kwargs
):
2503 GetRed(self, int x, int y) -> byte
2505 Returns the red intensity at the given coordinate.
2507 return _core_
.Image_GetRed(*args
, **kwargs
)
2509 def GetGreen(*args
, **kwargs
):
2511 GetGreen(self, int x, int y) -> byte
2513 Returns the green intensity at the given coordinate.
2515 return _core_
.Image_GetGreen(*args
, **kwargs
)
2517 def GetBlue(*args
, **kwargs
):
2519 GetBlue(self, int x, int y) -> byte
2521 Returns the blue intensity at the given coordinate.
2523 return _core_
.Image_GetBlue(*args
, **kwargs
)
2525 def SetAlpha(*args
, **kwargs
):
2527 SetAlpha(self, int x, int y, byte alpha)
2529 Sets the alpha value for the given pixel. This function should only be
2530 called if the image has alpha channel data, use `HasAlpha` to check
2533 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2535 def GetAlpha(*args
, **kwargs
):
2537 GetAlpha(self, int x, int y) -> byte
2539 Returns the alpha value for the given pixel. This function may only be
2540 called for the images with alpha channel, use `HasAlpha` to check for
2543 The returned value is the *opacity* of the image, i.e. the value of 0
2544 corresponds to the fully transparent pixels while the value of 255 to
2545 the fully opaque pixels.
2547 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2549 def HasAlpha(*args
, **kwargs
):
2551 HasAlpha(self) -> bool
2553 Returns true if this image has alpha channel, false otherwise.
2555 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2557 def InitAlpha(*args
, **kwargs
):
2561 Initializes the image alpha channel data. It is an error to call it if
2562 the image already has alpha data. If it doesn't, alpha data will be by
2563 default initialized to all pixels being fully opaque. But if the image
2564 has a a mask colour, all mask pixels will be completely transparent.
2566 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2568 def IsTransparent(*args
, **kwargs
):
2570 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2572 Returns ``True`` if this pixel is masked or has an alpha value less
2573 than the spcified threshold.
2575 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2577 def FindFirstUnusedColour(*args
, **kwargs
):
2579 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2581 Find first colour that is not used in the image and has higher RGB
2582 values than startR, startG, startB. Returns a tuple consisting of a
2583 success flag and rgb values.
2585 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2587 def ConvertAlphaToMask(*args
, **kwargs
):
2589 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2591 If the image has alpha channel, this method converts it to mask. All
2592 pixels with alpha value less than ``threshold`` are replaced with the
2593 mask colour and the alpha channel is removed. The mask colour is
2594 chosen automatically using `FindFirstUnusedColour`.
2596 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2599 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2601 def ConvertColourToAlpha(*args
, **kwargs
):
2603 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2605 This method converts an image where the original alpha information is
2606 only available as a shades of a colour (actually shades of grey)
2607 typically when you draw anti-aliased text into a bitmap. The DC
2608 drawing routines draw grey values on the black background although
2609 they actually mean to draw white with differnt alpha values. This
2610 method reverses it, assuming a black (!) background and white text.
2611 The method will then fill up the whole image with the colour given.
2613 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2615 def SetMaskFromImage(*args
, **kwargs
):
2617 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2619 Sets the image's mask so that the pixels that have RGB value of
2620 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2621 by first finding an unused colour in the image, setting this colour as
2622 the mask colour and then using this colour to draw all pixels in the
2623 image who corresponding pixel in mask has given RGB value.
2625 Returns ``False`` if ``mask`` does not have same dimensions as the
2626 image or if there is no unused colour left. Returns ``True`` if the
2627 mask was successfully applied.
2629 Note that this method involves computing the histogram, which is
2630 computationally intensive operation.
2632 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2634 def CanRead(*args
, **kwargs
):
2636 CanRead(String filename) -> bool
2638 Returns True if the image handlers can read this file.
2640 return _core_
.Image_CanRead(*args
, **kwargs
)
2642 CanRead
= staticmethod(CanRead
)
2643 def GetImageCount(*args
, **kwargs
):
2645 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2647 If the image file contains more than one image and the image handler
2648 is capable of retrieving these individually, this function will return
2649 the number of available images.
2651 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2653 GetImageCount
= staticmethod(GetImageCount
)
2654 def LoadFile(*args
, **kwargs
):
2656 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2658 Loads an image from a file. If no handler type is provided, the
2659 library will try to autodetect the format.
2661 return _core_
.Image_LoadFile(*args
, **kwargs
)
2663 def LoadMimeFile(*args
, **kwargs
):
2665 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2667 Loads an image from a file, specifying the image type with a MIME type
2670 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2672 def SaveFile(*args
, **kwargs
):
2674 SaveFile(self, String name, int type) -> bool
2676 Saves an image in the named file.
2678 return _core_
.Image_SaveFile(*args
, **kwargs
)
2680 def SaveMimeFile(*args
, **kwargs
):
2682 SaveMimeFile(self, String name, String mimetype) -> bool
2684 Saves an image in the named file.
2686 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2688 def CanReadStream(*args
, **kwargs
):
2690 CanReadStream(InputStream stream) -> bool
2692 Returns True if the image handlers can read an image file from the
2693 data currently on the input stream, or a readable Python file-like
2696 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2698 CanReadStream
= staticmethod(CanReadStream
)
2699 def LoadStream(*args
, **kwargs
):
2701 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2703 Loads an image from an input stream or a readable Python file-like
2704 object. If no handler type is provided, the library will try to
2705 autodetect the format.
2707 return _core_
.Image_LoadStream(*args
, **kwargs
)
2709 def LoadMimeStream(*args
, **kwargs
):
2711 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2713 Loads an image from an input stream or a readable Python file-like
2714 object, using a MIME type string to specify the image file format.
2716 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2718 def Ok(*args
, **kwargs
):
2722 Returns true if image data is present.
2724 return _core_
.Image_Ok(*args
, **kwargs
)
2726 def GetWidth(*args
, **kwargs
):
2728 GetWidth(self) -> int
2730 Gets the width of the image in pixels.
2732 return _core_
.Image_GetWidth(*args
, **kwargs
)
2734 def GetHeight(*args
, **kwargs
):
2736 GetHeight(self) -> int
2738 Gets the height of the image in pixels.
2740 return _core_
.Image_GetHeight(*args
, **kwargs
)
2742 def GetSize(*args
, **kwargs
):
2744 GetSize(self) -> Size
2746 Returns the size of the image in pixels.
2748 return _core_
.Image_GetSize(*args
, **kwargs
)
2750 def GetSubImage(*args
, **kwargs
):
2752 GetSubImage(self, Rect rect) -> Image
2754 Returns a sub image of the current one as long as the rect belongs
2755 entirely to the image.
2757 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2759 def Size(*args
, **kwargs
):
2761 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2763 Returns a resized version of this image without scaling it by adding
2764 either a border with the given colour or cropping as necessary. The
2765 image is pasted into a new image with the given size and background
2766 colour at the position ``pos`` relative to the upper left of the new
2767 image. If red = green = blue = -1 then use either the current mask
2768 colour if set or find, use, and set a suitable mask colour for any
2769 newly exposed areas.
2771 return _core_
.Image_Size(*args
, **kwargs
)
2773 def Copy(*args
, **kwargs
):
2777 Returns an identical copy of the image.
2779 return _core_
.Image_Copy(*args
, **kwargs
)
2781 def Paste(*args
, **kwargs
):
2783 Paste(self, Image image, int x, int y)
2785 Pastes ``image`` into this instance and takes care of the mask colour
2786 and any out of bounds problems.
2788 return _core_
.Image_Paste(*args
, **kwargs
)
2790 def GetData(*args
, **kwargs
):
2792 GetData(self) -> PyObject
2794 Returns a string containing a copy of the RGB bytes of the image.
2796 return _core_
.Image_GetData(*args
, **kwargs
)
2798 def SetData(*args
, **kwargs
):
2800 SetData(self, buffer data)
2802 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2803 either a string or a buffer object holding the data and the length of
2804 the data must be width*height*3.
2806 return _core_
.Image_SetData(*args
, **kwargs
)
2808 def GetDataBuffer(*args
, **kwargs
):
2810 GetDataBuffer(self) -> PyObject
2812 Returns a writable Python buffer object that is pointing at the RGB
2813 image data buffer inside the wx.Image. You need to ensure that you do
2814 not use this buffer object after the image has been destroyed.
2816 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
2818 def SetDataBuffer(*args
, **kwargs
):
2820 SetDataBuffer(self, buffer data)
2822 Sets the internal image data pointer to point at a Python buffer
2823 object. This can save making an extra copy of the data but you must
2824 ensure that the buffer object lives longer than the wx.Image does.
2826 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
2828 def GetAlphaData(*args
, **kwargs
):
2830 GetAlphaData(self) -> PyObject
2832 Returns a string containing a copy of the alpha bytes of the image.
2834 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
2836 def SetAlphaData(*args
, **kwargs
):
2838 SetAlphaData(self, buffer alpha)
2840 Resets the Image's alpha data from a buffer of bytes. Accepts either
2841 a string or a buffer object holding the data and the length of the
2842 data must be width*height.
2844 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
2846 def GetAlphaBuffer(*args
, **kwargs
):
2847 """GetAlphaBuffer(self) -> PyObject"""
2848 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
2850 def SetAlphaBuffer(*args
, **kwargs
):
2851 """SetAlphaBuffer(self, buffer alpha)"""
2852 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
2854 def SetMaskColour(*args
, **kwargs
):
2856 SetMaskColour(self, byte r, byte g, byte b)
2858 Sets the mask colour for this image (and tells the image to use the
2861 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
2863 def GetOrFindMaskColour(*args
, **kwargs
):
2865 GetOrFindMaskColour() -> (r,g,b)
2867 Get the current mask colour or find a suitable colour.
2869 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
2871 def GetMaskRed(*args
, **kwargs
):
2873 GetMaskRed(self) -> byte
2875 Gets the red component of the mask colour.
2877 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
2879 def GetMaskGreen(*args
, **kwargs
):
2881 GetMaskGreen(self) -> byte
2883 Gets the green component of the mask colour.
2885 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
2887 def GetMaskBlue(*args
, **kwargs
):
2889 GetMaskBlue(self) -> byte
2891 Gets the blue component of the mask colour.
2893 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
2895 def SetMask(*args
, **kwargs
):
2897 SetMask(self, bool mask=True)
2899 Specifies whether there is a mask or not. The area of the mask is
2900 determined by the current mask colour.
2902 return _core_
.Image_SetMask(*args
, **kwargs
)
2904 def HasMask(*args
, **kwargs
):
2906 HasMask(self) -> bool
2908 Returns ``True`` if there is a mask active, ``False`` otherwise.
2910 return _core_
.Image_HasMask(*args
, **kwargs
)
2912 def Rotate(*args
, **kwargs
):
2914 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2915 Point offset_after_rotation=None) -> Image
2917 Rotates the image about the given point, by ``angle`` radians. Passing
2918 ``True`` to ``interpolating`` results in better image quality, but is
2919 slower. If the image has a mask, then the mask colour is used for the
2920 uncovered pixels in the rotated image background. Otherwise, black
2921 will be used as the fill colour.
2923 Returns the rotated image, leaving this image intact.
2925 return _core_
.Image_Rotate(*args
, **kwargs
)
2927 def Rotate90(*args
, **kwargs
):
2929 Rotate90(self, bool clockwise=True) -> Image
2931 Returns a copy of the image rotated 90 degrees in the direction
2932 indicated by ``clockwise``.
2934 return _core_
.Image_Rotate90(*args
, **kwargs
)
2936 def Mirror(*args
, **kwargs
):
2938 Mirror(self, bool horizontally=True) -> Image
2940 Returns a mirrored copy of the image. The parameter ``horizontally``
2941 indicates the orientation.
2943 return _core_
.Image_Mirror(*args
, **kwargs
)
2945 def Replace(*args
, **kwargs
):
2947 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2949 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2952 return _core_
.Image_Replace(*args
, **kwargs
)
2954 def ConvertToGreyscale(*args
, **kwargs
):
2956 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2958 Convert to greyscale image. Uses the luminance component (Y) of the
2959 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2960 defaults to ITU-T BT.601
2962 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
2964 def ConvertToMono(*args
, **kwargs
):
2966 ConvertToMono(self, byte r, byte g, byte b) -> Image
2968 Returns monochromatic version of the image. The returned image has
2969 white colour where the original has ``(r,g,b)`` colour and black
2970 colour everywhere else.
2972 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
2974 def SetOption(*args
, **kwargs
):
2976 SetOption(self, String name, String value)
2978 Sets an image handler defined option. For example, when saving as a
2979 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2980 number between 0 and 100 (0 is terrible, 100 is very good).
2982 return _core_
.Image_SetOption(*args
, **kwargs
)
2984 def SetOptionInt(*args
, **kwargs
):
2986 SetOptionInt(self, String name, int value)
2988 Sets an image option as an integer.
2990 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
2992 def GetOption(*args
, **kwargs
):
2994 GetOption(self, String name) -> String
2996 Gets the value of an image handler option.
2998 return _core_
.Image_GetOption(*args
, **kwargs
)
3000 def GetOptionInt(*args
, **kwargs
):
3002 GetOptionInt(self, String name) -> int
3004 Gets the value of an image handler option as an integer. If the given
3005 option is not present, the function returns 0.
3007 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
3009 def HasOption(*args
, **kwargs
):
3011 HasOption(self, String name) -> bool
3013 Returns true if the given option is present.
3015 return _core_
.Image_HasOption(*args
, **kwargs
)
3017 def CountColours(*args
, **kwargs
):
3018 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3019 return _core_
.Image_CountColours(*args
, **kwargs
)
3021 def ComputeHistogram(*args
, **kwargs
):
3022 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3023 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
3025 def AddHandler(*args
, **kwargs
):
3026 """AddHandler(ImageHandler handler)"""
3027 return _core_
.Image_AddHandler(*args
, **kwargs
)
3029 AddHandler
= staticmethod(AddHandler
)
3030 def InsertHandler(*args
, **kwargs
):
3031 """InsertHandler(ImageHandler handler)"""
3032 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3034 InsertHandler
= staticmethod(InsertHandler
)
3035 def RemoveHandler(*args
, **kwargs
):
3036 """RemoveHandler(String name) -> bool"""
3037 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3039 RemoveHandler
= staticmethod(RemoveHandler
)
3040 def GetImageExtWildcard(*args
, **kwargs
):
3042 GetImageExtWildcard() -> String
3044 Iterates all registered wxImageHandler objects, and returns a string
3045 containing file extension masks suitable for passing to file open/save
3048 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3050 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3051 def ConvertToBitmap(*args
, **kwargs
):
3052 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3053 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3055 def ConvertToMonoBitmap(*args
, **kwargs
):
3056 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3057 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3059 def RotateHue(*args
, **kwargs
):
3061 RotateHue(self, double angle)
3063 Rotates the hue of each pixel of the image. Hue is a double in the
3064 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3066 return _core_
.Image_RotateHue(*args
, **kwargs
)
3068 def RGBtoHSV(*args
, **kwargs
):
3070 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3072 Converts a color in RGB color space to HSV color space.
3074 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3076 RGBtoHSV
= staticmethod(RGBtoHSV
)
3077 def HSVtoRGB(*args
, **kwargs
):
3079 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3081 Converts a color in HSV color space to RGB color space.
3083 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3085 HSVtoRGB
= staticmethod(HSVtoRGB
)
3086 def __nonzero__(self
): return self
.Ok()
3088 class ImagePtr(Image
):
3089 def __init__(self
, this
):
3091 if not hasattr(self
,"thisown"): self
.thisown
= 0
3092 self
.__class
__ = Image
3093 _core_
.Image_swigregister(ImagePtr
)
3095 def ImageFromMime(*args
, **kwargs
):
3097 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3099 Loads an image from a file, using a MIME type string (such as
3100 'image/jpeg') to specify image type.
3102 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3106 def ImageFromStream(*args
, **kwargs
):
3108 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3110 Loads an image from an input stream, or any readable Python file-like
3113 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3117 def ImageFromStreamMime(*args
, **kwargs
):
3119 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3121 Loads an image from an input stream, or any readable Python file-like
3122 object, specifying the image format with a MIME type string.
3124 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3128 def EmptyImage(*args
, **kwargs
):
3130 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3132 Construct an empty image of a given size, optionally setting all
3135 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3139 def ImageFromBitmap(*args
, **kwargs
):
3141 ImageFromBitmap(Bitmap bitmap) -> Image
3143 Construct an Image from a `wx.Bitmap`.
3145 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3149 def ImageFromData(*args
, **kwargs
):
3151 ImageFromData(int width, int height, buffer data) -> Image
3153 Construct an Image from a buffer of RGB bytes. Accepts either a
3154 string or a buffer object holding the data and the length of the data
3155 must be width*height*3.
3157 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3161 def ImageFromDataWithAlpha(*args
, **kwargs
):
3163 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3165 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3166 Accepts either a string or a buffer object holding the data and the
3167 length of the data must be width*height*3 bytes, and the length of the
3168 alpha data must be width*height bytes.
3170 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3174 def Image_CanRead(*args
, **kwargs
):
3176 Image_CanRead(String filename) -> bool
3178 Returns True if the image handlers can read this file.
3180 return _core_
.Image_CanRead(*args
, **kwargs
)
3182 def Image_GetImageCount(*args
, **kwargs
):
3184 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3186 If the image file contains more than one image and the image handler
3187 is capable of retrieving these individually, this function will return
3188 the number of available images.
3190 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3192 def Image_CanReadStream(*args
, **kwargs
):
3194 Image_CanReadStream(InputStream stream) -> bool
3196 Returns True if the image handlers can read an image file from the
3197 data currently on the input stream, or a readable Python file-like
3200 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3202 def Image_AddHandler(*args
, **kwargs
):
3203 """Image_AddHandler(ImageHandler handler)"""
3204 return _core_
.Image_AddHandler(*args
, **kwargs
)
3206 def Image_InsertHandler(*args
, **kwargs
):
3207 """Image_InsertHandler(ImageHandler handler)"""
3208 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3210 def Image_RemoveHandler(*args
, **kwargs
):
3211 """Image_RemoveHandler(String name) -> bool"""
3212 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3214 def Image_GetImageExtWildcard(*args
, **kwargs
):
3216 Image_GetImageExtWildcard() -> String
3218 Iterates all registered wxImageHandler objects, and returns a string
3219 containing file extension masks suitable for passing to file open/save
3222 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3224 def Image_RGBtoHSV(*args
, **kwargs
):
3226 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3228 Converts a color in RGB color space to HSV color space.
3230 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3232 def Image_HSVtoRGB(*args
, **kwargs
):
3234 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3236 Converts a color in HSV color space to RGB color space.
3238 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3240 def InitAllImageHandlers():
3242 The former functionality of InitAllImageHanders is now done internal to
3243 the _core_ extension module and so this function has become a simple NOP.
3247 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3248 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3249 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3250 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3251 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3252 BMP_24BPP
= _core_
.BMP_24BPP
3253 BMP_8BPP
= _core_
.BMP_8BPP
3254 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3255 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3256 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3257 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3258 BMP_4BPP
= _core_
.BMP_4BPP
3259 BMP_1BPP
= _core_
.BMP_1BPP
3260 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3261 class BMPHandler(ImageHandler
):
3262 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3264 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3265 def __init__(self
, *args
, **kwargs
):
3267 __init__(self) -> BMPHandler
3269 A `wx.ImageHandler` for \*.bmp bitmap files.
3271 newobj
= _core_
.new_BMPHandler(*args
, **kwargs
)
3272 self
.this
= newobj
.this
3276 class BMPHandlerPtr(BMPHandler
):
3277 def __init__(self
, this
):
3279 if not hasattr(self
,"thisown"): self
.thisown
= 0
3280 self
.__class
__ = BMPHandler
3281 _core_
.BMPHandler_swigregister(BMPHandlerPtr
)
3282 NullImage
= cvar
.NullImage
3283 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3284 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3285 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3286 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3287 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3288 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3289 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3290 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3291 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3292 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3293 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3294 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3295 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3296 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3297 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3299 class ICOHandler(BMPHandler
):
3300 """A `wx.ImageHandler` for \*.ico icon files."""
3302 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3303 def __init__(self
, *args
, **kwargs
):
3305 __init__(self) -> ICOHandler
3307 A `wx.ImageHandler` for \*.ico icon files.
3309 newobj
= _core_
.new_ICOHandler(*args
, **kwargs
)
3310 self
.this
= newobj
.this
3314 class ICOHandlerPtr(ICOHandler
):
3315 def __init__(self
, this
):
3317 if not hasattr(self
,"thisown"): self
.thisown
= 0
3318 self
.__class
__ = ICOHandler
3319 _core_
.ICOHandler_swigregister(ICOHandlerPtr
)
3321 class CURHandler(ICOHandler
):
3322 """A `wx.ImageHandler` for \*.cur cursor files."""
3324 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3325 def __init__(self
, *args
, **kwargs
):
3327 __init__(self) -> CURHandler
3329 A `wx.ImageHandler` for \*.cur cursor files.
3331 newobj
= _core_
.new_CURHandler(*args
, **kwargs
)
3332 self
.this
= newobj
.this
3336 class CURHandlerPtr(CURHandler
):
3337 def __init__(self
, this
):
3339 if not hasattr(self
,"thisown"): self
.thisown
= 0
3340 self
.__class
__ = CURHandler
3341 _core_
.CURHandler_swigregister(CURHandlerPtr
)
3343 class ANIHandler(CURHandler
):
3344 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3346 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3347 def __init__(self
, *args
, **kwargs
):
3349 __init__(self) -> ANIHandler
3351 A `wx.ImageHandler` for \*.ani animated cursor files.
3353 newobj
= _core_
.new_ANIHandler(*args
, **kwargs
)
3354 self
.this
= newobj
.this
3358 class ANIHandlerPtr(ANIHandler
):
3359 def __init__(self
, this
):
3361 if not hasattr(self
,"thisown"): self
.thisown
= 0
3362 self
.__class
__ = ANIHandler
3363 _core_
.ANIHandler_swigregister(ANIHandlerPtr
)
3365 class PNGHandler(ImageHandler
):
3366 """A `wx.ImageHandler` for PNG image files."""
3368 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3369 def __init__(self
, *args
, **kwargs
):
3371 __init__(self) -> PNGHandler
3373 A `wx.ImageHandler` for PNG image files.
3375 newobj
= _core_
.new_PNGHandler(*args
, **kwargs
)
3376 self
.this
= newobj
.this
3380 class PNGHandlerPtr(PNGHandler
):
3381 def __init__(self
, this
):
3383 if not hasattr(self
,"thisown"): self
.thisown
= 0
3384 self
.__class
__ = PNGHandler
3385 _core_
.PNGHandler_swigregister(PNGHandlerPtr
)
3387 class GIFHandler(ImageHandler
):
3388 """A `wx.ImageHandler` for GIF image files."""
3390 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3391 def __init__(self
, *args
, **kwargs
):
3393 __init__(self) -> GIFHandler
3395 A `wx.ImageHandler` for GIF image files.
3397 newobj
= _core_
.new_GIFHandler(*args
, **kwargs
)
3398 self
.this
= newobj
.this
3402 class GIFHandlerPtr(GIFHandler
):
3403 def __init__(self
, this
):
3405 if not hasattr(self
,"thisown"): self
.thisown
= 0
3406 self
.__class
__ = GIFHandler
3407 _core_
.GIFHandler_swigregister(GIFHandlerPtr
)
3409 class PCXHandler(ImageHandler
):
3410 """A `wx.ImageHandler` for PCX imager files."""
3412 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3413 def __init__(self
, *args
, **kwargs
):
3415 __init__(self) -> PCXHandler
3417 A `wx.ImageHandler` for PCX imager files.
3419 newobj
= _core_
.new_PCXHandler(*args
, **kwargs
)
3420 self
.this
= newobj
.this
3424 class PCXHandlerPtr(PCXHandler
):
3425 def __init__(self
, this
):
3427 if not hasattr(self
,"thisown"): self
.thisown
= 0
3428 self
.__class
__ = PCXHandler
3429 _core_
.PCXHandler_swigregister(PCXHandlerPtr
)
3431 class JPEGHandler(ImageHandler
):
3432 """A `wx.ImageHandler` for JPEG/JPG image files."""
3434 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3435 def __init__(self
, *args
, **kwargs
):
3437 __init__(self) -> JPEGHandler
3439 A `wx.ImageHandler` for JPEG/JPG image files.
3441 newobj
= _core_
.new_JPEGHandler(*args
, **kwargs
)
3442 self
.this
= newobj
.this
3446 class JPEGHandlerPtr(JPEGHandler
):
3447 def __init__(self
, this
):
3449 if not hasattr(self
,"thisown"): self
.thisown
= 0
3450 self
.__class
__ = JPEGHandler
3451 _core_
.JPEGHandler_swigregister(JPEGHandlerPtr
)
3453 class PNMHandler(ImageHandler
):
3454 """A `wx.ImageHandler` for PNM image files."""
3456 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3457 def __init__(self
, *args
, **kwargs
):
3459 __init__(self) -> PNMHandler
3461 A `wx.ImageHandler` for PNM image files.
3463 newobj
= _core_
.new_PNMHandler(*args
, **kwargs
)
3464 self
.this
= newobj
.this
3468 class PNMHandlerPtr(PNMHandler
):
3469 def __init__(self
, this
):
3471 if not hasattr(self
,"thisown"): self
.thisown
= 0
3472 self
.__class
__ = PNMHandler
3473 _core_
.PNMHandler_swigregister(PNMHandlerPtr
)
3475 class XPMHandler(ImageHandler
):
3476 """A `wx.ImageHandler` for XPM image."""
3478 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3479 def __init__(self
, *args
, **kwargs
):
3481 __init__(self) -> XPMHandler
3483 A `wx.ImageHandler` for XPM image.
3485 newobj
= _core_
.new_XPMHandler(*args
, **kwargs
)
3486 self
.this
= newobj
.this
3490 class XPMHandlerPtr(XPMHandler
):
3491 def __init__(self
, this
):
3493 if not hasattr(self
,"thisown"): self
.thisown
= 0
3494 self
.__class
__ = XPMHandler
3495 _core_
.XPMHandler_swigregister(XPMHandlerPtr
)
3497 class TIFFHandler(ImageHandler
):
3498 """A `wx.ImageHandler` for TIFF image files."""
3500 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3501 def __init__(self
, *args
, **kwargs
):
3503 __init__(self) -> TIFFHandler
3505 A `wx.ImageHandler` for TIFF image files.
3507 newobj
= _core_
.new_TIFFHandler(*args
, **kwargs
)
3508 self
.this
= newobj
.this
3512 class TIFFHandlerPtr(TIFFHandler
):
3513 def __init__(self
, this
):
3515 if not hasattr(self
,"thisown"): self
.thisown
= 0
3516 self
.__class
__ = TIFFHandler
3517 _core_
.TIFFHandler_swigregister(TIFFHandlerPtr
)
3519 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3520 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3521 class Quantize(object):
3522 """Performs quantization, or colour reduction, on a wxImage."""
3523 def __init__(self
): raise RuntimeError, "No constructor defined"
3525 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3526 def Quantize(*args
, **kwargs
):
3528 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3530 Reduce the colours in the source image and put the result into the
3531 destination image, setting the palette in the destination if
3532 needed. Both images may be the same, to overwrite the source image.
3534 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3536 Quantize
= staticmethod(Quantize
)
3538 class QuantizePtr(Quantize
):
3539 def __init__(self
, this
):
3541 if not hasattr(self
,"thisown"): self
.thisown
= 0
3542 self
.__class
__ = Quantize
3543 _core_
.Quantize_swigregister(QuantizePtr
)
3545 def Quantize_Quantize(*args
, **kwargs
):
3547 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3549 Reduce the colours in the source image and put the result into the
3550 destination image, setting the palette in the destination if
3551 needed. Both images may be the same, to overwrite the source image.
3553 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3555 #---------------------------------------------------------------------------
3557 class EvtHandler(Object
):
3558 """Proxy of C++ EvtHandler class"""
3560 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
3561 def __init__(self
, *args
, **kwargs
):
3562 """__init__(self) -> EvtHandler"""
3563 newobj
= _core_
.new_EvtHandler(*args
, **kwargs
)
3564 self
.this
= newobj
.this
3567 def GetNextHandler(*args
, **kwargs
):
3568 """GetNextHandler(self) -> EvtHandler"""
3569 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3571 def GetPreviousHandler(*args
, **kwargs
):
3572 """GetPreviousHandler(self) -> EvtHandler"""
3573 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3575 def SetNextHandler(*args
, **kwargs
):
3576 """SetNextHandler(self, EvtHandler handler)"""
3577 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3579 def SetPreviousHandler(*args
, **kwargs
):
3580 """SetPreviousHandler(self, EvtHandler handler)"""
3581 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3583 def GetEvtHandlerEnabled(*args
, **kwargs
):
3584 """GetEvtHandlerEnabled(self) -> bool"""
3585 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3587 def SetEvtHandlerEnabled(*args
, **kwargs
):
3588 """SetEvtHandlerEnabled(self, bool enabled)"""
3589 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3591 def ProcessEvent(*args
, **kwargs
):
3592 """ProcessEvent(self, Event event) -> bool"""
3593 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3595 def AddPendingEvent(*args
, **kwargs
):
3596 """AddPendingEvent(self, Event event)"""
3597 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3599 def ProcessPendingEvents(*args
, **kwargs
):
3600 """ProcessPendingEvents(self)"""
3601 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3603 def Connect(*args
, **kwargs
):
3604 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3605 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3607 def Disconnect(*args
, **kwargs
):
3608 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
3609 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3611 def _setOORInfo(*args
, **kwargs
):
3612 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3613 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3617 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3619 Bind an event to an event handler.
3621 :param event: One of the EVT_* objects that specifies the
3622 type of event to bind,
3624 :param handler: A callable object to be invoked when the
3625 event is delivered to self. Pass None to
3626 disconnect an event handler.
3628 :param source: Sometimes the event originates from a
3629 different window than self, but you still
3630 want to catch it in self. (For example, a
3631 button event delivered to a frame.) By
3632 passing the source of the event, the event
3633 handling system is able to differentiate
3634 between the same event type from different
3637 :param id: Used to spcify the event source by ID instead
3640 :param id2: Used when it is desirable to bind a handler
3641 to a range of IDs, such as with EVT_MENU_RANGE.
3643 if source
is not None:
3645 event
.Bind(self
, id, id2
, handler
)
3647 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3649 Disconencts the event handler binding for event from self.
3650 Returns True if successful.
3652 if source
is not None:
3654 return event
.Unbind(self
, id, id2
)
3657 class EvtHandlerPtr(EvtHandler
):
3658 def __init__(self
, this
):
3660 if not hasattr(self
,"thisown"): self
.thisown
= 0
3661 self
.__class
__ = EvtHandler
3662 _core_
.EvtHandler_swigregister(EvtHandlerPtr
)
3664 #---------------------------------------------------------------------------
3666 class PyEventBinder(object):
3668 Instances of this class are used to bind specific events to event
3671 def __init__(self
, evtType
, expectedIDs
=0):
3672 if expectedIDs
not in [0, 1, 2]:
3673 raise ValueError, "Invalid number of expectedIDs"
3674 self
.expectedIDs
= expectedIDs
3676 if type(evtType
) == list or type(evtType
) == tuple:
3677 self
.evtType
= evtType
3679 self
.evtType
= [evtType
]
3682 def Bind(self
, target
, id1
, id2
, function
):
3683 """Bind this set of event types to target."""
3684 for et
in self
.evtType
:
3685 target
.Connect(id1
, id2
, et
, function
)
3688 def Unbind(self
, target
, id1
, id2
):
3689 """Remove an event binding."""
3691 for et
in self
.evtType
:
3692 success
+= target
.Disconnect(id1
, id2
, et
)
3696 def __call__(self
, *args
):
3698 For backwards compatibility with the old EVT_* functions.
3699 Should be called with either (window, func), (window, ID,
3700 func) or (window, ID1, ID2, func) parameters depending on the
3703 assert len(args
) == 2 + self
.expectedIDs
3707 if self
.expectedIDs
== 0:
3709 elif self
.expectedIDs
== 1:
3712 elif self
.expectedIDs
== 2:
3717 raise ValueError, "Unexpected number of IDs"
3719 self
.Bind(target
, id1
, id2
, func
)
3722 # These two are square pegs that don't fit the PyEventBinder hole...
3723 def EVT_COMMAND(win
, id, cmd
, func
):
3724 win
.Connect(id, -1, cmd
, func
)
3725 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3726 win
.Connect(id1
, id2
, cmd
, func
)
3729 #---------------------------------------------------------------------------
3731 #---------------------------------------------------------------------------
3733 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3734 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3736 def NewEventType(*args
, **kwargs
):
3737 """NewEventType() -> wxEventType"""
3738 return _core_
.NewEventType(*args
, **kwargs
)
3739 wxEVT_NULL
= _core_
.wxEVT_NULL
3740 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3741 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3742 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3743 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3744 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3745 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3746 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3747 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3748 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3749 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3750 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3751 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3752 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3753 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3754 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3755 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3756 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3757 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3758 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3759 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3760 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3761 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3762 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3763 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3764 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3765 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3766 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3767 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3768 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3769 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3770 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3771 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3772 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3773 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3774 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3775 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3776 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3777 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3778 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3779 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3780 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3781 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3782 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3783 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3784 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3785 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3786 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3787 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3788 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3789 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3790 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3791 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3792 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3793 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3794 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3795 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3796 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3797 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3798 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3799 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3800 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3801 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3802 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3803 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3804 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3805 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3806 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3807 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3808 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3809 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3810 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3811 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3812 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3813 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3814 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3815 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3816 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3817 wxEVT_POWER
= _core_
.wxEVT_POWER
3818 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3819 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3820 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3821 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3822 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3823 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3824 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3825 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3826 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3827 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3828 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3829 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3830 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3831 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3832 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3833 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3834 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3835 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3836 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3837 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3838 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3839 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3840 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3841 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3842 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3843 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3844 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3845 wxEVT_SIZING
= _core_
.wxEVT_SIZING
3846 wxEVT_MOVING
= _core_
.wxEVT_MOVING
3847 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
3848 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
3849 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
3850 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
3851 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
3852 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
3853 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
3854 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
3856 # Create some event binders
3857 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
3858 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
3859 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
3860 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
3861 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
3862 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3863 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3864 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
3865 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
3866 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
3867 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
3868 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
3869 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
3870 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
3871 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
3872 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
3873 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
3874 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
3875 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
3876 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
3877 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
3878 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
3879 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
3880 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
3881 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
3882 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3883 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3884 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
3885 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
3886 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
3887 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
3888 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
3889 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
3890 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
3891 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
3892 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
3893 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
3894 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
3895 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
3896 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
3897 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
3899 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
3900 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
3901 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
3902 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
3903 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
3904 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
3905 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
3906 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
3907 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
3908 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
3909 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
3910 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
3911 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
3913 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
3921 wxEVT_MIDDLE_DCLICK
,
3929 # Scrolling from wxWindow (sent to wxScrolledWindow)
3930 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
3931 wxEVT_SCROLLWIN_BOTTOM
,
3932 wxEVT_SCROLLWIN_LINEUP
,
3933 wxEVT_SCROLLWIN_LINEDOWN
,
3934 wxEVT_SCROLLWIN_PAGEUP
,
3935 wxEVT_SCROLLWIN_PAGEDOWN
,
3936 wxEVT_SCROLLWIN_THUMBTRACK
,
3937 wxEVT_SCROLLWIN_THUMBRELEASE
,
3940 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
3941 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
3942 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
3943 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
3944 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
3945 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
3946 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
3947 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
3949 # Scrolling from wx.Slider and wx.ScrollBar
3950 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3951 wxEVT_SCROLL_BOTTOM
,
3952 wxEVT_SCROLL_LINEUP
,
3953 wxEVT_SCROLL_LINEDOWN
,
3954 wxEVT_SCROLL_PAGEUP
,
3955 wxEVT_SCROLL_PAGEDOWN
,
3956 wxEVT_SCROLL_THUMBTRACK
,
3957 wxEVT_SCROLL_THUMBRELEASE
,
3958 wxEVT_SCROLL_CHANGED
,
3961 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
3962 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
3963 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
3964 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
3965 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
3966 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
3967 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
3968 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
3969 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
3970 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
3972 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3973 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3974 wxEVT_SCROLL_BOTTOM
,
3975 wxEVT_SCROLL_LINEUP
,
3976 wxEVT_SCROLL_LINEDOWN
,
3977 wxEVT_SCROLL_PAGEUP
,
3978 wxEVT_SCROLL_PAGEDOWN
,
3979 wxEVT_SCROLL_THUMBTRACK
,
3980 wxEVT_SCROLL_THUMBRELEASE
,
3981 wxEVT_SCROLL_CHANGED
,
3984 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
3985 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
3986 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
3987 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
3988 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
3989 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
3990 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
3991 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
3992 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
3993 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
3995 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
3996 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
3997 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
3998 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
3999 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4000 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4001 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4002 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4003 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4004 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4006 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4007 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4008 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4009 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4010 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4011 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4012 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4013 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4014 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4017 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4018 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4019 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4020 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4021 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4022 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4023 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4025 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4027 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4028 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4030 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4034 #---------------------------------------------------------------------------
4036 class Event(Object
):
4038 An event is a structure holding information about an event passed to a
4039 callback or member function. wx.Event is an abstract base class for
4042 def __init__(self
): raise RuntimeError, "No constructor defined"
4044 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4045 def __del__(self
, destroy
=_core_
.delete_Event
):
4048 if self
.thisown
: destroy(self
)
4051 def SetEventType(*args
, **kwargs
):
4053 SetEventType(self, wxEventType typ)
4055 Sets the specific type of the event.
4057 return _core_
.Event_SetEventType(*args
, **kwargs
)
4059 def GetEventType(*args
, **kwargs
):
4061 GetEventType(self) -> wxEventType
4063 Returns the identifier of the given event type, such as
4064 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4066 return _core_
.Event_GetEventType(*args
, **kwargs
)
4068 def GetEventObject(*args
, **kwargs
):
4070 GetEventObject(self) -> Object
4072 Returns the object (usually a window) associated with the event, if
4075 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4077 def SetEventObject(*args
, **kwargs
):
4079 SetEventObject(self, Object obj)
4081 Sets the originating object, or in other words, obj is normally the
4082 object that is sending the event.
4084 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4086 def GetTimestamp(*args
, **kwargs
):
4087 """GetTimestamp(self) -> long"""
4088 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4090 def SetTimestamp(*args
, **kwargs
):
4091 """SetTimestamp(self, long ts=0)"""
4092 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4094 def GetId(*args
, **kwargs
):
4098 Returns the identifier associated with this event, such as a button
4101 return _core_
.Event_GetId(*args
, **kwargs
)
4103 def SetId(*args
, **kwargs
):
4107 Set's the ID for the event. This is usually the ID of the window that
4108 is sending the event, but it can also be a command id from a menu
4111 return _core_
.Event_SetId(*args
, **kwargs
)
4113 def IsCommandEvent(*args
, **kwargs
):
4115 IsCommandEvent(self) -> bool
4117 Returns true if the event is or is derived from `wx.CommandEvent` else
4118 it returns false. Note: Exists only for optimization purposes.
4120 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4122 def Skip(*args
, **kwargs
):
4124 Skip(self, bool skip=True)
4126 Called by an event handler, it controls whether additional event
4127 handlers bound to this event will be called after the current event
4128 handler returns. Skip(false) (the default setting) will prevent
4129 additional event handlers from being called and control will be
4130 returned to the sender of the event immediately after the current
4131 handler has finished. Skip(True) will cause the event processing
4132 system to continue searching for a handler function for this event.
4135 return _core_
.Event_Skip(*args
, **kwargs
)
4137 def GetSkipped(*args
, **kwargs
):
4139 GetSkipped(self) -> bool
4141 Returns true if the event handler should be skipped, false otherwise.
4144 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4146 def ShouldPropagate(*args
, **kwargs
):
4148 ShouldPropagate(self) -> bool
4150 Test if this event should be propagated to the parent window or not,
4151 i.e. if the propagation level is currently greater than 0.
4153 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4155 def StopPropagation(*args
, **kwargs
):
4157 StopPropagation(self) -> int
4159 Stop the event from propagating to its parent window. Returns the old
4160 propagation level value which may be later passed to
4161 `ResumePropagation` to allow propagating the event again.
4163 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4165 def ResumePropagation(*args
, **kwargs
):
4167 ResumePropagation(self, int propagationLevel)
4169 Resume the event propagation by restoring the propagation level. (For
4170 example, you can use the value returned by an earlier call to
4174 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4176 def Clone(*args
, **kwargs
):
4177 """Clone(self) -> Event"""
4178 return _core_
.Event_Clone(*args
, **kwargs
)
4181 class EventPtr(Event
):
4182 def __init__(self
, this
):
4184 if not hasattr(self
,"thisown"): self
.thisown
= 0
4185 self
.__class
__ = Event
4186 _core_
.Event_swigregister(EventPtr
)
4188 #---------------------------------------------------------------------------
4190 class PropagationDisabler(object):
4192 Helper class to temporarily change an event not to propagate. Simply
4193 create an instance of this class and then whe it is destroyed the
4194 propogation of the event will be restored.
4197 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4198 def __init__(self
, *args
, **kwargs
):
4200 __init__(self, Event event) -> PropagationDisabler
4202 Helper class to temporarily change an event not to propagate. Simply
4203 create an instance of this class and then whe it is destroyed the
4204 propogation of the event will be restored.
4206 newobj
= _core_
.new_PropagationDisabler(*args
, **kwargs
)
4207 self
.this
= newobj
.this
4210 def __del__(self
, destroy
=_core_
.delete_PropagationDisabler
):
4213 if self
.thisown
: destroy(self
)
4217 class PropagationDisablerPtr(PropagationDisabler
):
4218 def __init__(self
, this
):
4220 if not hasattr(self
,"thisown"): self
.thisown
= 0
4221 self
.__class
__ = PropagationDisabler
4222 _core_
.PropagationDisabler_swigregister(PropagationDisablerPtr
)
4224 class PropagateOnce(object):
4226 A helper class that will temporarily lower propagation level of an
4227 event. Simply create an instance of this class and then whe it is
4228 destroyed the propogation of the event will be restored.
4231 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4232 def __init__(self
, *args
, **kwargs
):
4234 __init__(self, Event event) -> PropagateOnce
4236 A helper class that will temporarily lower propagation level of an
4237 event. Simply create an instance of this class and then whe it is
4238 destroyed the propogation of the event will be restored.
4240 newobj
= _core_
.new_PropagateOnce(*args
, **kwargs
)
4241 self
.this
= newobj
.this
4244 def __del__(self
, destroy
=_core_
.delete_PropagateOnce
):
4247 if self
.thisown
: destroy(self
)
4251 class PropagateOncePtr(PropagateOnce
):
4252 def __init__(self
, this
):
4254 if not hasattr(self
,"thisown"): self
.thisown
= 0
4255 self
.__class
__ = PropagateOnce
4256 _core_
.PropagateOnce_swigregister(PropagateOncePtr
)
4258 #---------------------------------------------------------------------------
4260 class CommandEvent(Event
):
4262 This event class contains information about command events, which
4263 originate from a variety of simple controls, as well as menus and
4267 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4268 def __init__(self
, *args
, **kwargs
):
4270 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4272 This event class contains information about command events, which
4273 originate from a variety of simple controls, as well as menus and
4276 newobj
= _core_
.new_CommandEvent(*args
, **kwargs
)
4277 self
.this
= newobj
.this
4280 def GetSelection(*args
, **kwargs
):
4282 GetSelection(self) -> int
4284 Returns item index for a listbox or choice selection event (not valid
4287 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4289 def SetString(*args
, **kwargs
):
4290 """SetString(self, String s)"""
4291 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4293 def GetString(*args
, **kwargs
):
4295 GetString(self) -> String
4297 Returns item string for a listbox or choice selection event (not valid
4300 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4302 def IsChecked(*args
, **kwargs
):
4304 IsChecked(self) -> bool
4306 This method can be used with checkbox and menu events: for the
4307 checkboxes, the method returns true for a selection event and false
4308 for a deselection one. For the menu events, this method indicates if
4309 the menu item just has become checked or unchecked (and thus only
4310 makes sense for checkable menu items).
4312 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4315 def IsSelection(*args
, **kwargs
):
4317 IsSelection(self) -> bool
4319 For a listbox or similar event, returns true if it is a selection,
4320 false if it is a deselection.
4322 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4324 def SetExtraLong(*args
, **kwargs
):
4325 """SetExtraLong(self, long extraLong)"""
4326 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4328 def GetExtraLong(*args
, **kwargs
):
4330 GetExtraLong(self) -> long
4332 Returns extra information dependant on the event objects type. If the
4333 event comes from a listbox selection, it is a boolean determining
4334 whether the event was a selection (true) or a deselection (false). A
4335 listbox deselection only occurs for multiple-selection boxes, and in
4336 this case the index and string values are indeterminate and the
4337 listbox must be examined by the application.
4339 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4341 def SetInt(*args
, **kwargs
):
4342 """SetInt(self, int i)"""
4343 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4345 def GetInt(*args
, **kwargs
):
4347 GetInt(self) -> long
4349 Returns the integer identifier corresponding to a listbox, choice or
4350 radiobox selection (only if the event was a selection, not a
4351 deselection), or a boolean value representing the value of a checkbox.
4353 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4355 def Clone(*args
, **kwargs
):
4356 """Clone(self) -> Event"""
4357 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4360 class CommandEventPtr(CommandEvent
):
4361 def __init__(self
, this
):
4363 if not hasattr(self
,"thisown"): self
.thisown
= 0
4364 self
.__class
__ = CommandEvent
4365 _core_
.CommandEvent_swigregister(CommandEventPtr
)
4367 #---------------------------------------------------------------------------
4369 class NotifyEvent(CommandEvent
):
4371 An instance of this class (or one of its derived classes) is sent from
4372 a control when the control's state is being changed and the control
4373 allows that change to be prevented from happening. The event handler
4374 can call `Veto` or `Allow` to tell the control what to do.
4377 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4378 def __init__(self
, *args
, **kwargs
):
4380 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4382 An instance of this class (or one of its derived classes) is sent from
4383 a control when the control's state is being changed and the control
4384 allows that change to be prevented from happening. The event handler
4385 can call `Veto` or `Allow` to tell the control what to do.
4387 newobj
= _core_
.new_NotifyEvent(*args
, **kwargs
)
4388 self
.this
= newobj
.this
4391 def Veto(*args
, **kwargs
):
4395 Prevents the change announced by this event from happening.
4397 It is in general a good idea to notify the user about the reasons for
4398 vetoing the change because otherwise the applications behaviour (which
4399 just refuses to do what the user wants) might be quite surprising.
4401 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4403 def Allow(*args
, **kwargs
):
4407 This is the opposite of `Veto`: it explicitly allows the event to be
4408 processed. For most events it is not necessary to call this method as
4409 the events are allowed anyhow but some are forbidden by default (this
4410 will be mentioned in the corresponding event description).
4412 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4414 def IsAllowed(*args
, **kwargs
):
4416 IsAllowed(self) -> bool
4418 Returns true if the change is allowed (`Veto` hasn't been called) or
4419 false otherwise (if it was).
4421 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4424 class NotifyEventPtr(NotifyEvent
):
4425 def __init__(self
, this
):
4427 if not hasattr(self
,"thisown"): self
.thisown
= 0
4428 self
.__class
__ = NotifyEvent
4429 _core_
.NotifyEvent_swigregister(NotifyEventPtr
)
4431 #---------------------------------------------------------------------------
4433 class ScrollEvent(CommandEvent
):
4435 A scroll event holds information about events sent from stand-alone
4436 scrollbars and sliders. Note that scrolled windows do not send
4437 instnaces of this event class, but send the `wx.ScrollWinEvent`
4441 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4442 def __init__(self
, *args
, **kwargs
):
4444 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4445 int orient=0) -> ScrollEvent
4447 newobj
= _core_
.new_ScrollEvent(*args
, **kwargs
)
4448 self
.this
= newobj
.this
4451 def GetOrientation(*args
, **kwargs
):
4453 GetOrientation(self) -> int
4455 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4458 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4460 def GetPosition(*args
, **kwargs
):
4462 GetPosition(self) -> int
4464 Returns the position of the scrollbar.
4466 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4468 def SetOrientation(*args
, **kwargs
):
4469 """SetOrientation(self, int orient)"""
4470 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4472 def SetPosition(*args
, **kwargs
):
4473 """SetPosition(self, int pos)"""
4474 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4477 class ScrollEventPtr(ScrollEvent
):
4478 def __init__(self
, this
):
4480 if not hasattr(self
,"thisown"): self
.thisown
= 0
4481 self
.__class
__ = ScrollEvent
4482 _core_
.ScrollEvent_swigregister(ScrollEventPtr
)
4484 #---------------------------------------------------------------------------
4486 class ScrollWinEvent(Event
):
4488 A wx.ScrollWinEvent holds information about scrolling and is sent from
4492 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4493 def __init__(self
, *args
, **kwargs
):
4495 __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4497 A wx.ScrollWinEvent holds information about scrolling and is sent from
4500 newobj
= _core_
.new_ScrollWinEvent(*args
, **kwargs
)
4501 self
.this
= newobj
.this
4504 def GetOrientation(*args
, **kwargs
):
4506 GetOrientation(self) -> int
4508 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4511 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4513 def GetPosition(*args
, **kwargs
):
4515 GetPosition(self) -> int
4517 Returns the position of the scrollbar for the thumb track and release
4518 events. Note that this field can't be used for the other events, you
4519 need to query the window itself for the current position in that case.
4521 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4523 def SetOrientation(*args
, **kwargs
):
4524 """SetOrientation(self, int orient)"""
4525 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4527 def SetPosition(*args
, **kwargs
):
4528 """SetPosition(self, int pos)"""
4529 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4532 class ScrollWinEventPtr(ScrollWinEvent
):
4533 def __init__(self
, this
):
4535 if not hasattr(self
,"thisown"): self
.thisown
= 0
4536 self
.__class
__ = ScrollWinEvent
4537 _core_
.ScrollWinEvent_swigregister(ScrollWinEventPtr
)
4539 #---------------------------------------------------------------------------
4541 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4542 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4543 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4544 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4545 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4546 class MouseEvent(Event
):
4548 This event class contains information about the events generated by
4549 the mouse: they include mouse buttons press and release events and
4552 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4553 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4554 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4555 a middle button so a portable application should avoid relying on the
4558 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4559 the former returns true when the event corresponds to the left mouse
4560 button click while the latter returns true if the left mouse button is
4561 currently being pressed. For example, when the user is dragging the
4562 mouse you can use `LeftIsDown` to test whether the left mouse button
4563 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4564 `LeftIsDown` will also return true in wxWidgets whatever the
4565 underlying GUI behaviour is (which is platform-dependent). The same
4566 applies, of course, to other mouse buttons as well.
4569 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4570 def __init__(self
, *args
, **kwargs
):
4572 __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent
4574 Constructs a wx.MouseEvent. Valid event types are:
4576 * wxEVT_ENTER_WINDOW
4577 * wxEVT_LEAVE_WINDOW
4583 * wxEVT_MIDDLE_DCLICK
4586 * wxEVT_RIGHT_DCLICK
4590 newobj
= _core_
.new_MouseEvent(*args
, **kwargs
)
4591 self
.this
= newobj
.this
4594 def IsButton(*args
, **kwargs
):
4596 IsButton(self) -> bool
4598 Returns true if the event was a mouse button event (not necessarily a
4599 button down event - that may be tested using `ButtonDown`).
4601 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4603 def ButtonDown(*args
, **kwargs
):
4605 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4607 If the argument is omitted, this returns true if the event was any
4608 mouse button down event. Otherwise the argument specifies which
4609 button-down event shold be checked for (see `Button` for the possible
4612 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4614 def ButtonDClick(*args
, **kwargs
):
4616 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4618 If the argument is omitted, this returns true if the event was any
4619 mouse double click event. Otherwise the argument specifies which
4620 double click event to check for (see `Button` for the possible
4623 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4625 def ButtonUp(*args
, **kwargs
):
4627 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4629 If the argument is omitted, this returns true if the event was any
4630 mouse button up event. Otherwise the argument specifies which button
4631 up event to check for (see `Button` for the possible values).
4633 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4635 def Button(*args
, **kwargs
):
4637 Button(self, int button) -> bool
4639 Returns true if the identified mouse button is changing state. Valid
4640 values of button are:
4642 ==================== =====================================
4643 wx.MOUSE_BTN_LEFT check if left button was pressed
4644 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4645 wx.MOUSE_BTN_RIGHT check if right button was pressed
4646 wx.MOUSE_BTN_ANY check if any button was pressed
4647 ==================== =====================================
4650 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4652 def ButtonIsDown(*args
, **kwargs
):
4653 """ButtonIsDown(self, int but) -> bool"""
4654 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4656 def GetButton(*args
, **kwargs
):
4658 GetButton(self) -> int
4660 Returns the mouse button which generated this event or
4661 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4662 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4663 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4664 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4665 right buttons respectively.
4667 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4669 def ControlDown(*args
, **kwargs
):
4671 ControlDown(self) -> bool
4673 Returns true if the control key was down at the time of the event.
4675 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4677 def MetaDown(*args
, **kwargs
):
4679 MetaDown(self) -> bool
4681 Returns true if the Meta key was down at the time of the event.
4683 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4685 def AltDown(*args
, **kwargs
):
4687 AltDown(self) -> bool
4689 Returns true if the Alt key was down at the time of the event.
4691 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4693 def ShiftDown(*args
, **kwargs
):
4695 ShiftDown(self) -> bool
4697 Returns true if the Shift key was down at the time of the event.
4699 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4701 def CmdDown(*args
, **kwargs
):
4703 CmdDown(self) -> bool
4705 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4706 platforms but the special "Apple" (a.k.a as "Command") key on
4707 Macs. It often makes sense to use it instead of, say, `ControlDown`
4708 because Cmd key is used for the same thing under Mac as Ctrl
4709 elsewhere. The Ctrl key still exists, it's just not used for this
4710 purpose. So for non-Mac platforms this is the same as `ControlDown`
4711 and Macs this is the same as `MetaDown`.
4713 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4715 def LeftDown(*args
, **kwargs
):
4717 LeftDown(self) -> bool
4719 Returns true if the left mouse button state changed to down.
4721 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4723 def MiddleDown(*args
, **kwargs
):
4725 MiddleDown(self) -> bool
4727 Returns true if the middle mouse button state changed to down.
4729 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4731 def RightDown(*args
, **kwargs
):
4733 RightDown(self) -> bool
4735 Returns true if the right mouse button state changed to down.
4737 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4739 def LeftUp(*args
, **kwargs
):
4741 LeftUp(self) -> bool
4743 Returns true if the left mouse button state changed to up.
4745 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4747 def MiddleUp(*args
, **kwargs
):
4749 MiddleUp(self) -> bool
4751 Returns true if the middle mouse button state changed to up.
4753 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4755 def RightUp(*args
, **kwargs
):
4757 RightUp(self) -> bool
4759 Returns true if the right mouse button state changed to up.
4761 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4763 def LeftDClick(*args
, **kwargs
):
4765 LeftDClick(self) -> bool
4767 Returns true if the event was a left button double click.
4769 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4771 def MiddleDClick(*args
, **kwargs
):
4773 MiddleDClick(self) -> bool
4775 Returns true if the event was a middle button double click.
4777 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4779 def RightDClick(*args
, **kwargs
):
4781 RightDClick(self) -> bool
4783 Returns true if the event was a right button double click.
4785 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4787 def LeftIsDown(*args
, **kwargs
):
4789 LeftIsDown(self) -> bool
4791 Returns true if the left mouse button is currently down, independent
4792 of the current event type.
4794 Please notice that it is not the same as LeftDown which returns true
4795 if the left mouse button was just pressed. Rather, it describes the
4796 state of the mouse button before the event happened.
4798 This event is usually used in the mouse event handlers which process
4799 "move mouse" messages to determine whether the user is (still)
4802 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4804 def MiddleIsDown(*args
, **kwargs
):
4806 MiddleIsDown(self) -> bool
4808 Returns true if the middle mouse button is currently down, independent
4809 of the current event type.
4811 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4813 def RightIsDown(*args
, **kwargs
):
4815 RightIsDown(self) -> bool
4817 Returns true if the right mouse button is currently down, independent
4818 of the current event type.
4820 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4822 def Dragging(*args
, **kwargs
):
4824 Dragging(self) -> bool
4826 Returns true if this was a dragging event (motion while a button is
4829 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4831 def Moving(*args
, **kwargs
):
4833 Moving(self) -> bool
4835 Returns true if this was a motion event and no mouse buttons were
4836 pressed. If any mouse button is held pressed, then this method returns
4837 false and Dragging returns true.
4839 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4841 def Entering(*args
, **kwargs
):
4843 Entering(self) -> bool
4845 Returns true if the mouse was entering the window.
4847 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4849 def Leaving(*args
, **kwargs
):
4851 Leaving(self) -> bool
4853 Returns true if the mouse was leaving the window.
4855 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4857 def GetPosition(*args
, **kwargs
):
4859 GetPosition(self) -> Point
4861 Returns the pixel position of the mouse in window coordinates when the
4864 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4866 def GetPositionTuple(*args
, **kwargs
):
4868 GetPositionTuple() -> (x,y)
4870 Returns the pixel position of the mouse in window coordinates when the
4873 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4875 def GetLogicalPosition(*args
, **kwargs
):
4877 GetLogicalPosition(self, DC dc) -> Point
4879 Returns the logical mouse position in pixels (i.e. translated
4880 according to the translation set for the DC, which usually indicates
4881 that the window has been scrolled).
4883 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
4885 def GetX(*args
, **kwargs
):
4889 Returns X coordinate of the physical mouse event position.
4891 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
4893 def GetY(*args
, **kwargs
):
4897 Returns Y coordinate of the physical mouse event position.
4899 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
4901 def GetWheelRotation(*args
, **kwargs
):
4903 GetWheelRotation(self) -> int
4905 Get wheel rotation, positive or negative indicates direction of
4906 rotation. Current devices all send an event when rotation is equal to
4907 +/-WheelDelta, but this allows for finer resolution devices to be
4908 created in the future. Because of this you shouldn't assume that one
4909 event is equal to 1 line or whatever, but you should be able to either
4910 do partial line scrolling or wait until +/-WheelDelta rotation values
4911 have been accumulated before scrolling.
4913 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
4915 def GetWheelDelta(*args
, **kwargs
):
4917 GetWheelDelta(self) -> int
4919 Get wheel delta, normally 120. This is the threshold for action to be
4920 taken, and one such action (for example, scrolling one increment)
4921 should occur for each delta.
4923 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
4925 def GetLinesPerAction(*args
, **kwargs
):
4927 GetLinesPerAction(self) -> int
4929 Returns the configured number of lines (or whatever) to be scrolled
4930 per wheel action. Defaults to three.
4932 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
4934 def IsPageScroll(*args
, **kwargs
):
4936 IsPageScroll(self) -> bool
4938 Returns true if the system has been setup to do page scrolling with
4939 the mouse wheel instead of line scrolling.
4941 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
4943 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
4944 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
4945 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
4946 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
4947 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
4948 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
4949 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
4950 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
4951 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
4952 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
4953 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
4954 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
4956 class MouseEventPtr(MouseEvent
):
4957 def __init__(self
, this
):
4959 if not hasattr(self
,"thisown"): self
.thisown
= 0
4960 self
.__class
__ = MouseEvent
4961 _core_
.MouseEvent_swigregister(MouseEventPtr
)
4963 #---------------------------------------------------------------------------
4965 class SetCursorEvent(Event
):
4967 A SetCursorEvent is generated when the mouse cursor is about to be set
4968 as a result of mouse motion. This event gives the application the
4969 chance to perform specific mouse cursor processing based on the
4970 current position of the mouse within the window. Use the `SetCursor`
4971 method to specify the cursor you want to be displayed.
4974 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
4975 def __init__(self
, *args
, **kwargs
):
4977 __init__(self, int x=0, int y=0) -> SetCursorEvent
4979 Construct a new `wx.SetCursorEvent`.
4981 newobj
= _core_
.new_SetCursorEvent(*args
, **kwargs
)
4982 self
.this
= newobj
.this
4985 def GetX(*args
, **kwargs
):
4989 Returns the X coordinate of the mouse in client coordinates.
4991 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
4993 def GetY(*args
, **kwargs
):
4997 Returns the Y coordinate of the mouse in client coordinates.
4999 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5001 def SetCursor(*args
, **kwargs
):
5003 SetCursor(self, Cursor cursor)
5005 Sets the cursor associated with this event.
5007 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5009 def GetCursor(*args
, **kwargs
):
5011 GetCursor(self) -> Cursor
5013 Returns a reference to the cursor specified by this event.
5015 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5017 def HasCursor(*args
, **kwargs
):
5019 HasCursor(self) -> bool
5021 Returns true if the cursor specified by this event is a valid cursor.
5023 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5026 class SetCursorEventPtr(SetCursorEvent
):
5027 def __init__(self
, this
):
5029 if not hasattr(self
,"thisown"): self
.thisown
= 0
5030 self
.__class
__ = SetCursorEvent
5031 _core_
.SetCursorEvent_swigregister(SetCursorEventPtr
)
5033 #---------------------------------------------------------------------------
5035 class KeyEvent(Event
):
5037 This event class contains information about keypress and character
5038 events. These events are only sent to the widget that currently has
5041 Notice that there are three different kinds of keyboard events in
5042 wxWidgets: key down and up events and char events. The difference
5043 between the first two is clear - the first corresponds to a key press
5044 and the second to a key release - otherwise they are identical. Just
5045 note that if the key is maintained in a pressed state you will
5046 typically get a lot of (automatically generated) down events but only
5047 one up so it is wrong to assume that there is one up event
5048 corresponding to each down one.
5050 Both key events provide untranslated key codes while the char event
5051 carries the translated one. The untranslated code for alphanumeric
5052 keys is always an upper case value. For the other keys it is one of
5053 WXK_XXX values from the keycodes table. The translated key is, in
5054 general, the character the user expects to appear as the result of the
5055 key combination when typing the text into a text entry zone, for
5058 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5059 and the standard US keyboard): when the 'A' key is pressed, the key
5060 down event key code is equal to ASCII A == 65. But the char event key
5061 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5062 'A' keys simultaneously , the key code in key down event will still be
5063 just 'A' while the char event key code parameter will now be 'A' as
5066 Although in this simple case it is clear that the correct key code
5067 could be found in the key down event handler by checking the value
5068 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5069 as for non alphanumeric keys or non-US keyboard layouts the
5070 translation is keyboard-layout dependent and can only be done properly
5071 by the system itself.
5073 Another kind of translation is done when the control key is pressed:
5074 for example, for CTRL-A key press the key down event still carries the
5075 same key code 'A' as usual but the char event will have key code of 1,
5076 the ASCII value of this key combination.
5078 You may discover how the other keys on your system behave
5079 interactively by running the KeyEvents sample in the wxPython demo and
5080 pressing some keys while the blue box at the top has the keyboard
5083 **Note**: If a key down event is caught and the event handler does not
5084 call event.Skip() then the coresponding char event will not
5085 happen. This is by design and enables the programs that handle both
5086 types of events to be a bit simpler.
5088 **Note for Windows programmers**: The key and char events in wxWidgets
5089 are similar to but slightly different from Windows WM_KEYDOWN and
5090 WM_CHAR events. In particular, Alt-x combination will generate a char
5091 event in wxWidgets (unless it is used as an accelerator).
5093 **Tip**: be sure to call event.Skip() for events that you don't
5094 process in key event function, otherwise menu shortcuts may cease to
5099 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5100 def __init__(self
, *args
, **kwargs
):
5102 __init__(self, wxEventType eventType=wxEVT_NULL) -> KeyEvent
5104 Construct a new `wx.KeyEvent`. Valid event types are:
5107 newobj
= _core_
.new_KeyEvent(*args
, **kwargs
)
5108 self
.this
= newobj
.this
5111 def GetModifiers(*args
, **kwargs
):
5113 GetModifiers(self) -> int
5115 Returns a bitmask of the current modifier settings. Can be used to
5116 check if the key event has exactly the given modifiers without having
5117 to explicitly check that the other modifiers are not down. For
5120 if event.GetModifers() == wx.MOD_CONTROL:
5124 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5126 def ControlDown(*args
, **kwargs
):
5128 ControlDown(self) -> bool
5130 Returns ``True`` if the Control key was down at the time of the event.
5132 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5134 def MetaDown(*args
, **kwargs
):
5136 MetaDown(self) -> bool
5138 Returns ``True`` if the Meta key was down at the time of the event.
5140 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5142 def AltDown(*args
, **kwargs
):
5144 AltDown(self) -> bool
5146 Returns ``True`` if the Alt key was down at the time of the event.
5148 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5150 def ShiftDown(*args
, **kwargs
):
5152 ShiftDown(self) -> bool
5154 Returns ``True`` if the Shift key was down at the time of the event.
5156 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5158 def CmdDown(*args
, **kwargs
):
5160 CmdDown(self) -> bool
5162 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5163 platforms but the special "Apple" (a.k.a as "Command") key on
5164 Macs. It makes often sense to use it instead of, say, `ControlDown`
5165 because Cmd key is used for the same thing under Mac as Ctrl
5166 elsewhere. The Ctrl still exists, it's just not used for this
5167 purpose. So for non-Mac platforms this is the same as `ControlDown`
5168 and Macs this is the same as `MetaDown`.
5170 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5172 def HasModifiers(*args
, **kwargs
):
5174 HasModifiers(self) -> bool
5176 Returns true if either CTRL or ALT keys was down at the time of the
5177 key event. Note that this function does not take into account neither
5178 SHIFT nor META key states (the reason for ignoring the latter is that
5179 it is common for NUMLOCK key to be configured as META under X but the
5180 key presses even while NUMLOCK is on should be still processed
5183 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5185 def GetKeyCode(*args
, **kwargs
):
5187 GetKeyCode(self) -> int
5189 Returns the virtual key code. ASCII events return normal ASCII values,
5190 while non-ASCII events return values such as WXK_LEFT for the left
5191 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5194 Note that in Unicode build, the returned value is meaningful only if
5195 the user entered a character that can be represented in current
5196 locale's default charset. You can obtain the corresponding Unicode
5197 character using `GetUnicodeKey`.
5199 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5201 KeyCode
= GetKeyCode
5202 def GetUnicodeKey(*args
, **kwargs
):
5204 GetUnicodeKey(self) -> int
5206 Returns the Unicode character corresponding to this key event. This
5207 function is only meaningfule in a Unicode build of wxPython.
5209 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5211 GetUniChar
= GetUnicodeKey
5212 def GetRawKeyCode(*args
, **kwargs
):
5214 GetRawKeyCode(self) -> unsigned int
5216 Returns the raw key code for this event. This is a platform-dependent
5217 scan code which should only be used in advanced
5218 applications. Currently the raw key codes are not supported by all
5221 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5223 def GetRawKeyFlags(*args
, **kwargs
):
5225 GetRawKeyFlags(self) -> unsigned int
5227 Returns the low level key flags for this event. The flags are
5228 platform-dependent and should only be used in advanced applications.
5229 Currently the raw key flags are not supported by all ports.
5231 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5233 def GetPosition(*args
, **kwargs
):
5235 GetPosition(self) -> Point
5237 Find the position of the event, if applicable.
5239 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5241 def GetPositionTuple(*args
, **kwargs
):
5243 GetPositionTuple() -> (x,y)
5245 Find the position of the event, if applicable.
5247 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5249 def GetX(*args
, **kwargs
):
5253 Returns the X position (in client coordinates) of the event, if
5256 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5258 def GetY(*args
, **kwargs
):
5262 Returns the Y position (in client coordinates) of the event, if
5265 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5267 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5268 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5269 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5270 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5271 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5272 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5273 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5274 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5275 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5276 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5278 class KeyEventPtr(KeyEvent
):
5279 def __init__(self
, this
):
5281 if not hasattr(self
,"thisown"): self
.thisown
= 0
5282 self
.__class
__ = KeyEvent
5283 _core_
.KeyEvent_swigregister(KeyEventPtr
)
5285 #---------------------------------------------------------------------------
5287 class SizeEvent(Event
):
5289 A size event holds information about size change events. The EVT_SIZE
5290 handler function will be called when the window it is bound to has
5293 Note that the size passed is of the whole window: call
5294 `wx.Window.GetClientSize` for the area which may be used by the
5297 When a window is resized, usually only a small part of the window is
5298 damaged and and that area is all that is in the update region for the
5299 next paint event. However, if your drawing depends on the size of the
5300 window, you may need to clear the DC explicitly and repaint the whole
5301 window. In which case, you may need to call `wx.Window.Refresh` to
5302 invalidate the entire window.
5306 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5307 def __init__(self
, *args
, **kwargs
):
5309 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5311 Construct a new ``wx.SizeEvent``.
5313 newobj
= _core_
.new_SizeEvent(*args
, **kwargs
)
5314 self
.this
= newobj
.this
5317 def GetSize(*args
, **kwargs
):
5319 GetSize(self) -> Size
5321 Returns the entire size of the window generating the size change
5324 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5326 def GetRect(*args
, **kwargs
):
5327 """GetRect(self) -> Rect"""
5328 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5330 def SetRect(*args
, **kwargs
):
5331 """SetRect(self, Rect rect)"""
5332 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5334 def SetSize(*args
, **kwargs
):
5335 """SetSize(self, Size size)"""
5336 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5338 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5339 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5341 class SizeEventPtr(SizeEvent
):
5342 def __init__(self
, this
):
5344 if not hasattr(self
,"thisown"): self
.thisown
= 0
5345 self
.__class
__ = SizeEvent
5346 _core_
.SizeEvent_swigregister(SizeEventPtr
)
5348 #---------------------------------------------------------------------------
5350 class MoveEvent(Event
):
5352 This event object is sent for EVT_MOVE event bindings when a window is
5353 moved to a new position.
5356 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5357 def __init__(self
, *args
, **kwargs
):
5359 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5363 newobj
= _core_
.new_MoveEvent(*args
, **kwargs
)
5364 self
.this
= newobj
.this
5367 def GetPosition(*args
, **kwargs
):
5369 GetPosition(self) -> Point
5371 Returns the position of the window generating the move change event.
5373 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5375 def GetRect(*args
, **kwargs
):
5376 """GetRect(self) -> Rect"""
5377 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5379 def SetRect(*args
, **kwargs
):
5380 """SetRect(self, Rect rect)"""
5381 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5383 def SetPosition(*args
, **kwargs
):
5384 """SetPosition(self, Point pos)"""
5385 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5387 m_pos
= property(GetPosition
, SetPosition
)
5388 m_rect
= property(GetRect
, SetRect
)
5391 class MoveEventPtr(MoveEvent
):
5392 def __init__(self
, this
):
5394 if not hasattr(self
,"thisown"): self
.thisown
= 0
5395 self
.__class
__ = MoveEvent
5396 _core_
.MoveEvent_swigregister(MoveEventPtr
)
5398 #---------------------------------------------------------------------------
5400 class PaintEvent(Event
):
5402 A paint event is sent when a window's contents needs to be repainted.
5403 Note that in an EVT_PAINT handler the application must *always* create
5404 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5405 Windows assumes that the window has not been painted yet and will send
5406 the event again, causing endless refreshes.
5408 You can optimize painting by retrieving the rectangles that have been
5409 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5410 and only repainting these rectangles. The rectangles are in terms of
5411 the client area, and are unscrolled, so you will need to do some
5412 calculations using the current view position to obtain logical,
5417 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5418 def __init__(self
, *args
, **kwargs
):
5419 """__init__(self, int Id=0) -> PaintEvent"""
5420 newobj
= _core_
.new_PaintEvent(*args
, **kwargs
)
5421 self
.this
= newobj
.this
5425 class PaintEventPtr(PaintEvent
):
5426 def __init__(self
, this
):
5428 if not hasattr(self
,"thisown"): self
.thisown
= 0
5429 self
.__class
__ = PaintEvent
5430 _core_
.PaintEvent_swigregister(PaintEventPtr
)
5432 class NcPaintEvent(Event
):
5433 """Proxy of C++ NcPaintEvent class"""
5435 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5436 def __init__(self
, *args
, **kwargs
):
5437 """__init__(self, int winid=0) -> NcPaintEvent"""
5438 newobj
= _core_
.new_NcPaintEvent(*args
, **kwargs
)
5439 self
.this
= newobj
.this
5443 class NcPaintEventPtr(NcPaintEvent
):
5444 def __init__(self
, this
):
5446 if not hasattr(self
,"thisown"): self
.thisown
= 0
5447 self
.__class
__ = NcPaintEvent
5448 _core_
.NcPaintEvent_swigregister(NcPaintEventPtr
)
5450 #---------------------------------------------------------------------------
5452 class EraseEvent(Event
):
5454 An erase event is sent whenever the background of a window needs to be
5455 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5456 binder. On some platforms, such as GTK+, this event is simulated
5457 (simply generated just before the paint event) and may cause flicker.
5459 To paint a custom background use the `GetDC` method and use the returned
5460 device context if it is not ``None``, otherwise create a temporary
5461 `wx.ClientDC` and draw on that.
5465 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5466 def __init__(self
, *args
, **kwargs
):
5468 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5472 newobj
= _core_
.new_EraseEvent(*args
, **kwargs
)
5473 self
.this
= newobj
.this
5476 def GetDC(*args
, **kwargs
):
5480 Returns the device context the event handler should draw upon. If
5481 ``None`` is returned then create a temporary `wx.ClientDC` and use
5484 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5487 class EraseEventPtr(EraseEvent
):
5488 def __init__(self
, this
):
5490 if not hasattr(self
,"thisown"): self
.thisown
= 0
5491 self
.__class
__ = EraseEvent
5492 _core_
.EraseEvent_swigregister(EraseEventPtr
)
5494 #---------------------------------------------------------------------------
5496 class FocusEvent(Event
):
5498 A focus event is sent when a window's focus changes. The window losing
5499 focus receives an EVT_KILL_FOCUS event while the window gaining it
5500 gets an EVT_SET_FOCUS event.
5502 Notice that the set focus event happens both when the user gives focus
5503 to the window (whether using the mouse or keyboard) and when it is
5504 done from the program itself using `wx.Window.SetFocus`.
5508 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5509 def __init__(self
, *args
, **kwargs
):
5511 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5515 newobj
= _core_
.new_FocusEvent(*args
, **kwargs
)
5516 self
.this
= newobj
.this
5519 def GetWindow(*args
, **kwargs
):
5521 GetWindow(self) -> Window
5523 Returns the other window associated with this event, that is the
5524 window which had the focus before for the EVT_SET_FOCUS event and the
5525 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5527 Warning: the window returned may be None!
5529 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5531 def SetWindow(*args
, **kwargs
):
5532 """SetWindow(self, Window win)"""
5533 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5536 class FocusEventPtr(FocusEvent
):
5537 def __init__(self
, this
):
5539 if not hasattr(self
,"thisown"): self
.thisown
= 0
5540 self
.__class
__ = FocusEvent
5541 _core_
.FocusEvent_swigregister(FocusEventPtr
)
5543 #---------------------------------------------------------------------------
5545 class ChildFocusEvent(CommandEvent
):
5547 wx.ChildFocusEvent notifies the parent that a child has received the
5548 focus. Unlike `wx.FocusEvent` it is propagated up the window
5552 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5553 def __init__(self
, *args
, **kwargs
):
5555 __init__(self, Window win=None) -> ChildFocusEvent
5559 newobj
= _core_
.new_ChildFocusEvent(*args
, **kwargs
)
5560 self
.this
= newobj
.this
5563 def GetWindow(*args
, **kwargs
):
5565 GetWindow(self) -> Window
5567 The window which has just received the focus.
5569 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5572 class ChildFocusEventPtr(ChildFocusEvent
):
5573 def __init__(self
, this
):
5575 if not hasattr(self
,"thisown"): self
.thisown
= 0
5576 self
.__class
__ = ChildFocusEvent
5577 _core_
.ChildFocusEvent_swigregister(ChildFocusEventPtr
)
5579 #---------------------------------------------------------------------------
5581 class ActivateEvent(Event
):
5583 An activate event is sent when a top-level window or the entire
5584 application is being activated or deactivated.
5586 A top-level window (a dialog or frame) receives an activate event when
5587 is being activated or deactivated. This is indicated visually by the
5588 title bar changing colour, and a subwindow gaining the keyboard focus.
5589 An application is activated or deactivated when one of its frames
5590 becomes activated, or a frame becomes inactivate resulting in all
5591 application frames being inactive.
5593 Please note that usually you should call event.Skip() in your handlers
5594 for these events so the default handlers will still be called, as not
5595 doing so can result in strange effects.
5599 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5600 def __init__(self
, *args
, **kwargs
):
5602 __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5606 newobj
= _core_
.new_ActivateEvent(*args
, **kwargs
)
5607 self
.this
= newobj
.this
5610 def GetActive(*args
, **kwargs
):
5612 GetActive(self) -> bool
5614 Returns true if the application or window is being activated, false
5617 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5620 class ActivateEventPtr(ActivateEvent
):
5621 def __init__(self
, this
):
5623 if not hasattr(self
,"thisown"): self
.thisown
= 0
5624 self
.__class
__ = ActivateEvent
5625 _core_
.ActivateEvent_swigregister(ActivateEventPtr
)
5627 #---------------------------------------------------------------------------
5629 class InitDialogEvent(Event
):
5631 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5632 any window when `wx.Window.InitDialog` is called. Handlers for this
5633 event can transfer data to the window, or anything else that should be
5634 done before the user begins editing the form. The default handler
5635 calls `wx.Window.TransferDataToWindow`.
5638 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5639 def __init__(self
, *args
, **kwargs
):
5641 __init__(self, int Id=0) -> InitDialogEvent
5645 newobj
= _core_
.new_InitDialogEvent(*args
, **kwargs
)
5646 self
.this
= newobj
.this
5650 class InitDialogEventPtr(InitDialogEvent
):
5651 def __init__(self
, this
):
5653 if not hasattr(self
,"thisown"): self
.thisown
= 0
5654 self
.__class
__ = InitDialogEvent
5655 _core_
.InitDialogEvent_swigregister(InitDialogEventPtr
)
5657 #---------------------------------------------------------------------------
5659 class MenuEvent(Event
):
5661 This class is used for a variety of menu-related events. Note that
5662 these do not include menu command events, which are handled by sending
5663 `wx.CommandEvent` objects.
5665 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5666 text in the first field of the status bar.
5669 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5670 def __init__(self
, *args
, **kwargs
):
5672 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5676 newobj
= _core_
.new_MenuEvent(*args
, **kwargs
)
5677 self
.this
= newobj
.this
5680 def GetMenuId(*args
, **kwargs
):
5682 GetMenuId(self) -> int
5684 Returns the menu identifier associated with the event. This method
5685 should be only used with the HIGHLIGHT events.
5687 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5689 def IsPopup(*args
, **kwargs
):
5691 IsPopup(self) -> bool
5693 Returns ``True`` if the menu which is being opened or closed is a
5694 popup menu, ``False`` if it is a normal one. This method should only
5695 be used with the OPEN and CLOSE events.
5697 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5699 def GetMenu(*args
, **kwargs
):
5701 GetMenu(self) -> Menu
5703 Returns the menu which is being opened or closed. This method should
5704 only be used with the OPEN and CLOSE events.
5706 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5709 class MenuEventPtr(MenuEvent
):
5710 def __init__(self
, this
):
5712 if not hasattr(self
,"thisown"): self
.thisown
= 0
5713 self
.__class
__ = MenuEvent
5714 _core_
.MenuEvent_swigregister(MenuEventPtr
)
5716 #---------------------------------------------------------------------------
5718 class CloseEvent(Event
):
5720 This event class contains information about window and session close
5723 The handler function for EVT_CLOSE is called when the user has tried
5724 to close a a frame or dialog box using the window manager controls or
5725 the system menu. It can also be invoked by the application itself
5726 programmatically, for example by calling the `wx.Window.Close`
5729 You should check whether the application is forcing the deletion of
5730 the window using `CanVeto`. If it returns ``False``, you must destroy
5731 the window using `wx.Window.Destroy`. If the return value is ``True``,
5732 it is up to you whether you respond by destroying the window or not.
5733 For example you may wish to display a message dialog prompting to save
5734 files or to cancel the close.
5736 If you don't destroy the window, you should call `Veto` to let the
5737 calling code know that you did not destroy the window. This allows the
5738 `wx.Window.Close` function to return ``True`` or ``False`` depending
5739 on whether the close instruction was honored or not.
5742 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5743 def __init__(self
, *args
, **kwargs
):
5745 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5749 newobj
= _core_
.new_CloseEvent(*args
, **kwargs
)
5750 self
.this
= newobj
.this
5753 def SetLoggingOff(*args
, **kwargs
):
5755 SetLoggingOff(self, bool logOff)
5757 Sets the 'logging off' flag.
5759 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5761 def GetLoggingOff(*args
, **kwargs
):
5763 GetLoggingOff(self) -> bool
5765 Returns ``True`` if the user is logging off or ``False`` if the
5766 system is shutting down. This method can only be called for end
5767 session and query end session events, it doesn't make sense for close
5770 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5772 def Veto(*args
, **kwargs
):
5774 Veto(self, bool veto=True)
5776 Call this from your event handler to veto a system shutdown or to
5777 signal to the calling application that a window close did not happen.
5779 You can only veto a shutdown or close if `CanVeto` returns true.
5781 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5783 def GetVeto(*args
, **kwargs
):
5784 """GetVeto(self) -> bool"""
5785 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5787 def SetCanVeto(*args
, **kwargs
):
5789 SetCanVeto(self, bool canVeto)
5791 Sets the 'can veto' flag.
5793 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5795 def CanVeto(*args
, **kwargs
):
5797 CanVeto(self) -> bool
5799 Returns true if you can veto a system shutdown or a window close
5800 event. Vetoing a window close event is not possible if the calling
5801 code wishes to force the application to exit, and so this function
5802 must be called to check this.
5804 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5807 class CloseEventPtr(CloseEvent
):
5808 def __init__(self
, this
):
5810 if not hasattr(self
,"thisown"): self
.thisown
= 0
5811 self
.__class
__ = CloseEvent
5812 _core_
.CloseEvent_swigregister(CloseEventPtr
)
5814 #---------------------------------------------------------------------------
5816 class ShowEvent(Event
):
5817 """An EVT_SHOW event is sent when a window is shown or hidden."""
5819 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5820 def __init__(self
, *args
, **kwargs
):
5822 __init__(self, int winid=0, bool show=False) -> ShowEvent
5824 An EVT_SHOW event is sent when a window is shown or hidden.
5826 newobj
= _core_
.new_ShowEvent(*args
, **kwargs
)
5827 self
.this
= newobj
.this
5830 def SetShow(*args
, **kwargs
):
5831 """SetShow(self, bool show)"""
5832 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5834 def GetShow(*args
, **kwargs
):
5835 """GetShow(self) -> bool"""
5836 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5839 class ShowEventPtr(ShowEvent
):
5840 def __init__(self
, this
):
5842 if not hasattr(self
,"thisown"): self
.thisown
= 0
5843 self
.__class
__ = ShowEvent
5844 _core_
.ShowEvent_swigregister(ShowEventPtr
)
5846 #---------------------------------------------------------------------------
5848 class IconizeEvent(Event
):
5850 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5854 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5855 def __init__(self
, *args
, **kwargs
):
5857 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5859 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5862 newobj
= _core_
.new_IconizeEvent(*args
, **kwargs
)
5863 self
.this
= newobj
.this
5866 def Iconized(*args
, **kwargs
):
5868 Iconized(self) -> bool
5870 Returns ``True`` if the frame has been iconized, ``False`` if it has
5873 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5876 class IconizeEventPtr(IconizeEvent
):
5877 def __init__(self
, this
):
5879 if not hasattr(self
,"thisown"): self
.thisown
= 0
5880 self
.__class
__ = IconizeEvent
5881 _core_
.IconizeEvent_swigregister(IconizeEventPtr
)
5883 #---------------------------------------------------------------------------
5885 class MaximizeEvent(Event
):
5886 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5888 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5889 def __init__(self
, *args
, **kwargs
):
5891 __init__(self, int id=0) -> MaximizeEvent
5893 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5895 newobj
= _core_
.new_MaximizeEvent(*args
, **kwargs
)
5896 self
.this
= newobj
.this
5900 class MaximizeEventPtr(MaximizeEvent
):
5901 def __init__(self
, this
):
5903 if not hasattr(self
,"thisown"): self
.thisown
= 0
5904 self
.__class
__ = MaximizeEvent
5905 _core_
.MaximizeEvent_swigregister(MaximizeEventPtr
)
5907 #---------------------------------------------------------------------------
5909 class DropFilesEvent(Event
):
5911 This class is used for drop files events, that is, when files have
5912 been dropped onto the window. This functionality is only available
5913 under Windows. The window must have previously been enabled for
5914 dropping by calling `wx.Window.DragAcceptFiles`.
5916 Important note: this is a separate implementation to the more general
5917 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5918 implementation uses the older, Windows message-based approach of
5921 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5925 def __init__(self
): raise RuntimeError, "No constructor defined"
5927 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
5928 def GetPosition(*args
, **kwargs
):
5930 GetPosition(self) -> Point
5932 Returns the position at which the files were dropped.
5934 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5936 def GetNumberOfFiles(*args
, **kwargs
):
5938 GetNumberOfFiles(self) -> int
5940 Returns the number of files dropped.
5942 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5944 def GetFiles(*args
, **kwargs
):
5946 GetFiles(self) -> PyObject
5948 Returns a list of the filenames that were dropped.
5950 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5953 class DropFilesEventPtr(DropFilesEvent
):
5954 def __init__(self
, this
):
5956 if not hasattr(self
,"thisown"): self
.thisown
= 0
5957 self
.__class
__ = DropFilesEvent
5958 _core_
.DropFilesEvent_swigregister(DropFilesEventPtr
)
5960 #---------------------------------------------------------------------------
5962 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5963 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5964 class UpdateUIEvent(CommandEvent
):
5966 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5967 wxWidgets to give an application the chance to update various user
5970 Without update UI events, an application has to work hard to
5971 check/uncheck, enable/disable, and set the text for elements such as
5972 menu items and toolbar buttons. The code for doing this has to be
5973 mixed up with the code that is invoked when an action is invoked for a
5974 menu item or button.
5976 With update UI events, you define an event handler to look at the
5977 state of the application and change UI elements accordingly. wxWidgets
5978 will call your handler functions in idle time, so you don't have to
5979 worry where to call this code. In addition to being a clearer and more
5980 declarative method, it also means you don't have to worry whether
5981 you're updating a toolbar or menubar identifier. The same handler can
5982 update a menu item and toolbar button, if the ID values are the same.
5984 Instead of directly manipulating the menu or button, you call
5985 functions in the event object, such as `Check`. wxWidgets will
5986 determine whether such a call has been made, and which UI element to
5989 These events will work for popup menus as well as menubars. Just
5990 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5991 any UI events for the window that owns the menu.
5993 If you find that the overhead of UI update processing is affecting
5994 your application, you can do one or both of the following:
5996 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5997 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5998 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5999 receive update events. No other windows will receive update
6002 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6003 value to set the delay between updates. You may need to call
6004 `wx.Window.UpdateWindowUI` at critical points, for example when
6005 a dialog is about to be shown, in case the user sees a slight
6006 delay before windows are updated.
6008 Note that although events are sent in idle time, defining a EVT_IDLE
6009 handler for a window does not affect this because the events are sent
6010 from an internal idle handler.
6012 wxWidgets tries to optimize update events on some platforms. On
6013 Windows and GTK+, events for menubar items are only sent when the menu
6014 is about to be shown, and not in idle time.
6018 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6019 def __init__(self
, *args
, **kwargs
):
6021 __init__(self, int commandId=0) -> UpdateUIEvent
6025 newobj
= _core_
.new_UpdateUIEvent(*args
, **kwargs
)
6026 self
.this
= newobj
.this
6029 def GetChecked(*args
, **kwargs
):
6031 GetChecked(self) -> bool
6033 Returns ``True`` if the UI element should be checked.
6035 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6037 def GetEnabled(*args
, **kwargs
):
6039 GetEnabled(self) -> bool
6041 Returns ``True`` if the UI element should be enabled.
6043 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6045 def GetShown(*args
, **kwargs
):
6047 GetShown(self) -> bool
6049 Returns ``True`` if the UI element should be shown.
6051 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6053 def GetText(*args
, **kwargs
):
6055 GetText(self) -> String
6057 Returns the text that should be set for the UI element.
6059 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6061 def GetSetText(*args
, **kwargs
):
6063 GetSetText(self) -> bool
6065 Returns ``True`` if the application has called `SetText`. For
6066 wxWidgets internal use only.
6068 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6070 def GetSetChecked(*args
, **kwargs
):
6072 GetSetChecked(self) -> bool
6074 Returns ``True`` if the application has called `Check`. For wxWidgets
6077 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6079 def GetSetEnabled(*args
, **kwargs
):
6081 GetSetEnabled(self) -> bool
6083 Returns ``True`` if the application has called `Enable`. For wxWidgets
6086 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6088 def GetSetShown(*args
, **kwargs
):
6090 GetSetShown(self) -> bool
6092 Returns ``True`` if the application has called `Show`. For wxWidgets
6095 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6097 def Check(*args
, **kwargs
):
6099 Check(self, bool check)
6101 Check or uncheck the UI element.
6103 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6105 def Enable(*args
, **kwargs
):
6107 Enable(self, bool enable)
6109 Enable or disable the UI element.
6111 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6113 def Show(*args
, **kwargs
):
6115 Show(self, bool show)
6117 Show or hide the UI element.
6119 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6121 def SetText(*args
, **kwargs
):
6123 SetText(self, String text)
6125 Sets the text for this UI element.
6127 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6129 def SetUpdateInterval(*args
, **kwargs
):
6131 SetUpdateInterval(long updateInterval)
6133 Sets the interval between updates in milliseconds. Set to -1 to
6134 disable updates, or to 0 to update as frequently as possible. The
6137 Use this to reduce the overhead of UI update events if your
6138 application has a lot of windows. If you set the value to -1 or
6139 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6140 at appropriate points in your application, such as when a dialog is
6143 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6145 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6146 def GetUpdateInterval(*args
, **kwargs
):
6148 GetUpdateInterval() -> long
6150 Returns the current interval between updates in milliseconds. -1
6151 disables updates, 0 updates as frequently as possible.
6153 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6155 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6156 def CanUpdate(*args
, **kwargs
):
6158 CanUpdate(Window win) -> bool
6160 Returns ``True`` if it is appropriate to update (send UI update events
6163 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6164 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6165 events were last sent in idle time, and the update interval, to
6166 determine whether events should be sent to this window now. By default
6167 this will always return true because the update mode is initially
6168 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6169 events will be sent as often as possible. You can reduce the frequency
6170 that events are sent by changing the mode and/or setting an update
6174 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6176 CanUpdate
= staticmethod(CanUpdate
)
6177 def ResetUpdateTime(*args
, **kwargs
):
6181 Used internally to reset the last-updated time to the current time. It
6182 is assumed that update events are normally sent in idle time, so this
6183 is called at the end of idle processing.
6185 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6187 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6188 def SetMode(*args
, **kwargs
):
6192 Specify how wxWidgets will send update events: to all windows, or only
6193 to those which specify that they will process the events.
6195 The mode may be one of the following values:
6197 ============================= ==========================================
6198 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6199 is the default setting.
6200 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6201 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6203 ============================= ==========================================
6206 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6208 SetMode
= staticmethod(SetMode
)
6209 def GetMode(*args
, **kwargs
):
6213 Returns a value specifying how wxWidgets will send update events: to
6214 all windows, or only to those which specify that they will process the
6217 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6219 GetMode
= staticmethod(GetMode
)
6221 class UpdateUIEventPtr(UpdateUIEvent
):
6222 def __init__(self
, this
):
6224 if not hasattr(self
,"thisown"): self
.thisown
= 0
6225 self
.__class
__ = UpdateUIEvent
6226 _core_
.UpdateUIEvent_swigregister(UpdateUIEventPtr
)
6228 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6230 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6232 Sets the interval between updates in milliseconds. Set to -1 to
6233 disable updates, or to 0 to update as frequently as possible. The
6236 Use this to reduce the overhead of UI update events if your
6237 application has a lot of windows. If you set the value to -1 or
6238 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6239 at appropriate points in your application, such as when a dialog is
6242 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6244 def UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
):
6246 UpdateUIEvent_GetUpdateInterval() -> long
6248 Returns the current interval between updates in milliseconds. -1
6249 disables updates, 0 updates as frequently as possible.
6251 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6253 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6255 UpdateUIEvent_CanUpdate(Window win) -> bool
6257 Returns ``True`` if it is appropriate to update (send UI update events
6260 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6261 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6262 events were last sent in idle time, and the update interval, to
6263 determine whether events should be sent to this window now. By default
6264 this will always return true because the update mode is initially
6265 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6266 events will be sent as often as possible. You can reduce the frequency
6267 that events are sent by changing the mode and/or setting an update
6271 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6273 def UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
):
6275 UpdateUIEvent_ResetUpdateTime()
6277 Used internally to reset the last-updated time to the current time. It
6278 is assumed that update events are normally sent in idle time, so this
6279 is called at the end of idle processing.
6281 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6283 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6285 UpdateUIEvent_SetMode(int mode)
6287 Specify how wxWidgets will send update events: to all windows, or only
6288 to those which specify that they will process the events.
6290 The mode may be one of the following values:
6292 ============================= ==========================================
6293 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6294 is the default setting.
6295 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6296 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6298 ============================= ==========================================
6301 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6303 def UpdateUIEvent_GetMode(*args
, **kwargs
):
6305 UpdateUIEvent_GetMode() -> int
6307 Returns a value specifying how wxWidgets will send update events: to
6308 all windows, or only to those which specify that they will process the
6311 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6313 #---------------------------------------------------------------------------
6315 class SysColourChangedEvent(Event
):
6317 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6318 when the user changes the colour settings using the control
6319 panel. This is only applicable under Windows.
6321 The default event handler for this event propagates the event to child
6322 windows, since Windows only sends the events to top-level windows. If
6323 intercepting this event for a top-level window, remember to call
6324 `Skip` so the the base class handler will still be executed, or to
6325 pass the event on to the window's children explicitly.
6329 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6330 def __init__(self
, *args
, **kwargs
):
6332 __init__(self) -> SysColourChangedEvent
6336 newobj
= _core_
.new_SysColourChangedEvent(*args
, **kwargs
)
6337 self
.this
= newobj
.this
6341 class SysColourChangedEventPtr(SysColourChangedEvent
):
6342 def __init__(self
, this
):
6344 if not hasattr(self
,"thisown"): self
.thisown
= 0
6345 self
.__class
__ = SysColourChangedEvent
6346 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEventPtr
)
6348 #---------------------------------------------------------------------------
6350 class MouseCaptureChangedEvent(Event
):
6352 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6353 a window that loses its mouse capture. This is called even if
6354 `wx.Window.ReleaseMouse` was called by the application code. Handling
6355 this event allows an application to cater for unexpected capture
6356 releases which might otherwise confuse mouse handling code.
6358 This event is implemented under Windows only.
6361 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6362 def __init__(self
, *args
, **kwargs
):
6364 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6368 newobj
= _core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
)
6369 self
.this
= newobj
.this
6372 def GetCapturedWindow(*args
, **kwargs
):
6374 GetCapturedWindow(self) -> Window
6376 Returns the window that gained the capture, or ``None`` if it was a
6377 non-wxWidgets window.
6379 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6382 class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent
):
6383 def __init__(self
, this
):
6385 if not hasattr(self
,"thisown"): self
.thisown
= 0
6386 self
.__class
__ = MouseCaptureChangedEvent
6387 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr
)
6389 #---------------------------------------------------------------------------
6391 class DisplayChangedEvent(Event
):
6393 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6394 resolution has changed.
6396 This event is implemented under Windows only.
6399 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6400 def __init__(self
, *args
, **kwargs
):
6401 """__init__(self) -> DisplayChangedEvent"""
6402 newobj
= _core_
.new_DisplayChangedEvent(*args
, **kwargs
)
6403 self
.this
= newobj
.this
6407 class DisplayChangedEventPtr(DisplayChangedEvent
):
6408 def __init__(self
, this
):
6410 if not hasattr(self
,"thisown"): self
.thisown
= 0
6411 self
.__class
__ = DisplayChangedEvent
6412 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEventPtr
)
6414 #---------------------------------------------------------------------------
6416 class PaletteChangedEvent(Event
):
6418 An EVT_PALETTE_CHANGED event is sent when the system palette has
6419 changed, thereby giving each window a chance to redo their own to
6422 This event is implemented under Windows only.
6425 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6426 def __init__(self
, *args
, **kwargs
):
6428 __init__(self, int id=0) -> PaletteChangedEvent
6430 An EVT_PALETTE_CHANGED event is sent when the system palette has
6431 changed, thereby giving each window a chance to redo their own to
6434 This event is implemented under Windows only.
6436 newobj
= _core_
.new_PaletteChangedEvent(*args
, **kwargs
)
6437 self
.this
= newobj
.this
6440 def SetChangedWindow(*args
, **kwargs
):
6441 """SetChangedWindow(self, Window win)"""
6442 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6444 def GetChangedWindow(*args
, **kwargs
):
6445 """GetChangedWindow(self) -> Window"""
6446 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6449 class PaletteChangedEventPtr(PaletteChangedEvent
):
6450 def __init__(self
, this
):
6452 if not hasattr(self
,"thisown"): self
.thisown
= 0
6453 self
.__class
__ = PaletteChangedEvent
6454 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEventPtr
)
6456 #---------------------------------------------------------------------------
6458 class QueryNewPaletteEvent(Event
):
6460 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6461 focus and should re-do its palette.
6463 This event is implemented under Windows only.
6466 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6467 def __init__(self
, *args
, **kwargs
):
6469 __init__(self, int winid=0) -> QueryNewPaletteEvent
6473 newobj
= _core_
.new_QueryNewPaletteEvent(*args
, **kwargs
)
6474 self
.this
= newobj
.this
6477 def SetPaletteRealized(*args
, **kwargs
):
6479 SetPaletteRealized(self, bool realized)
6481 App should set this if it changes the palette.
6483 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6485 def GetPaletteRealized(*args
, **kwargs
):
6486 """GetPaletteRealized(self) -> bool"""
6487 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6490 class QueryNewPaletteEventPtr(QueryNewPaletteEvent
):
6491 def __init__(self
, this
):
6493 if not hasattr(self
,"thisown"): self
.thisown
= 0
6494 self
.__class
__ = QueryNewPaletteEvent
6495 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr
)
6497 #---------------------------------------------------------------------------
6499 class NavigationKeyEvent(Event
):
6501 EVT_NAVIGATION_KEY events are used to control moving the focus between
6502 widgets, otherwise known as tab-traversal. You woudl normally not
6503 catch navigation events in applications as there are already
6504 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6505 it useful to send navigation events in certain situations to change
6506 the focus in certain ways, although it's probably easier to just call
6507 `wx.Window.Navigate`.
6510 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6511 def __init__(self
, *args
, **kwargs
):
6512 """__init__(self) -> NavigationKeyEvent"""
6513 newobj
= _core_
.new_NavigationKeyEvent(*args
, **kwargs
)
6514 self
.this
= newobj
.this
6517 def GetDirection(*args
, **kwargs
):
6519 GetDirection(self) -> bool
6521 Returns ``True`` if the direction is forward, ``False`` otherwise.
6523 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6525 def SetDirection(*args
, **kwargs
):
6527 SetDirection(self, bool forward)
6529 Specify the direction that the navigation should take. Usually the
6530 difference between using Tab and Shift-Tab.
6532 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6534 def IsWindowChange(*args
, **kwargs
):
6536 IsWindowChange(self) -> bool
6538 Returns ``True`` if window change is allowed.
6540 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6542 def SetWindowChange(*args
, **kwargs
):
6544 SetWindowChange(self, bool ischange)
6546 Specify if the navigation should be able to change parent windows.
6547 For example, changing notebook pages, etc. This is usually implemented
6548 by using Control-Tab.
6550 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6552 def IsFromTab(*args
, **kwargs
):
6554 IsFromTab(self) -> bool
6556 Returns ``True`` if the navigation event is originated from the Tab
6559 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6561 def SetFromTab(*args
, **kwargs
):
6563 SetFromTab(self, bool bIs)
6565 Set to true under MSW if the event was generated using the tab key.
6566 This is required for proper navogation over radio buttons.
6568 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6570 def SetFlags(*args
, **kwargs
):
6572 SetFlags(self, long flags)
6574 Set the navigation flags to a combination of the following:
6576 * wx.NavigationKeyEvent.IsBackward
6577 * wx.NavigationKeyEvent.IsForward
6578 * wx.NavigationKeyEvent.WinChange
6579 * wx.NavigationKeyEvent.FromTab
6582 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6584 def GetCurrentFocus(*args
, **kwargs
):
6586 GetCurrentFocus(self) -> Window
6588 Returns the child window which currenty has the focus. May be
6591 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6593 def SetCurrentFocus(*args
, **kwargs
):
6595 SetCurrentFocus(self, Window win)
6597 Set the window that has the focus.
6599 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6601 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6602 IsForward
= _core_
.NavigationKeyEvent_IsForward
6603 WinChange
= _core_
.NavigationKeyEvent_WinChange
6604 FromTab
= _core_
.NavigationKeyEvent_FromTab
6606 class NavigationKeyEventPtr(NavigationKeyEvent
):
6607 def __init__(self
, this
):
6609 if not hasattr(self
,"thisown"): self
.thisown
= 0
6610 self
.__class
__ = NavigationKeyEvent
6611 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEventPtr
)
6613 #---------------------------------------------------------------------------
6615 class WindowCreateEvent(CommandEvent
):
6617 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6618 underlying GUI object) exists.
6621 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6622 def __init__(self
, *args
, **kwargs
):
6624 __init__(self, Window win=None) -> WindowCreateEvent
6626 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6627 underlying GUI object) exists.
6629 newobj
= _core_
.new_WindowCreateEvent(*args
, **kwargs
)
6630 self
.this
= newobj
.this
6633 def GetWindow(*args
, **kwargs
):
6635 GetWindow(self) -> Window
6637 Returns the window that this event refers to.
6639 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6642 class WindowCreateEventPtr(WindowCreateEvent
):
6643 def __init__(self
, this
):
6645 if not hasattr(self
,"thisown"): self
.thisown
= 0
6646 self
.__class
__ = WindowCreateEvent
6647 _core_
.WindowCreateEvent_swigregister(WindowCreateEventPtr
)
6649 class WindowDestroyEvent(CommandEvent
):
6651 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6652 when the GUI window is destroyed.
6654 When a class derived from `wx.Window` is destroyed its destructor will
6655 have already run by the time this event is sent. Therefore this event
6656 will not usually be received at all by the window itself. Since it is
6657 received after the destructor has run, an object should not try to
6658 handle its own wx.WindowDestroyEvent, but it can be used to get
6659 notification of the destruction of another window.
6662 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6663 def __init__(self
, *args
, **kwargs
):
6665 __init__(self, Window win=None) -> WindowDestroyEvent
6667 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6668 when the GUI window is destroyed.
6670 When a class derived from `wx.Window` is destroyed its destructor will
6671 have already run by the time this event is sent. Therefore this event
6672 will not usually be received at all by the window itself. Since it is
6673 received after the destructor has run, an object should not try to
6674 handle its own wx.WindowDestroyEvent, but it can be used to get
6675 notification of the destruction of another window.
6677 newobj
= _core_
.new_WindowDestroyEvent(*args
, **kwargs
)
6678 self
.this
= newobj
.this
6681 def GetWindow(*args
, **kwargs
):
6683 GetWindow(self) -> Window
6685 Returns the window that this event refers to.
6687 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6690 class WindowDestroyEventPtr(WindowDestroyEvent
):
6691 def __init__(self
, this
):
6693 if not hasattr(self
,"thisown"): self
.thisown
= 0
6694 self
.__class
__ = WindowDestroyEvent
6695 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEventPtr
)
6697 #---------------------------------------------------------------------------
6699 class ContextMenuEvent(CommandEvent
):
6701 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6702 give the application a chance to show a context (popup) menu.
6705 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6706 def __init__(self
, *args
, **kwargs
):
6708 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6712 newobj
= _core_
.new_ContextMenuEvent(*args
, **kwargs
)
6713 self
.this
= newobj
.this
6716 def GetPosition(*args
, **kwargs
):
6718 GetPosition(self) -> Point
6720 Returns the position (in screen coordinants) at which the menu should
6723 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6725 def SetPosition(*args
, **kwargs
):
6727 SetPosition(self, Point pos)
6729 Sets the position at which the menu should be shown.
6731 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6734 class ContextMenuEventPtr(ContextMenuEvent
):
6735 def __init__(self
, this
):
6737 if not hasattr(self
,"thisown"): self
.thisown
= 0
6738 self
.__class
__ = ContextMenuEvent
6739 _core_
.ContextMenuEvent_swigregister(ContextMenuEventPtr
)
6741 #---------------------------------------------------------------------------
6743 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6744 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6745 class IdleEvent(Event
):
6747 This class is used for EVT_IDLE events, which are generated and sent
6748 when the application *becomes* idle. In other words, the when the
6749 event queue becomes empty then idle events are sent to all windows (by
6750 default) and as long as none of them call `RequestMore` then there are
6751 no more idle events until after the system event queue has some normal
6752 events and then becomes empty again.
6754 By default, idle events are sent to all windows. If this is causing a
6755 significant overhead in your application, you can call
6756 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6757 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6758 which should receive idle events. Then idle events will only be sent
6759 to those windows and not to any others.
6762 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6763 def __init__(self
, *args
, **kwargs
):
6765 __init__(self) -> IdleEvent
6769 newobj
= _core_
.new_IdleEvent(*args
, **kwargs
)
6770 self
.this
= newobj
.this
6773 def RequestMore(*args
, **kwargs
):
6775 RequestMore(self, bool needMore=True)
6777 Tells wxWidgets that more processing is required. This function can be
6778 called by an EVT_IDLE handler for a window to indicate that the
6779 application should forward the EVT_IDLE event once more to the
6780 application windows. If no window calls this function during its
6781 EVT_IDLE handler, then the application will remain in a passive event
6782 loop until a new event is posted to the application by the windowing
6785 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6787 def MoreRequested(*args
, **kwargs
):
6789 MoreRequested(self) -> bool
6791 Returns ``True`` if the OnIdle function processing this event
6792 requested more processing time.
6794 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6796 def SetMode(*args
, **kwargs
):
6800 Static method for specifying how wxWidgets will send idle events: to
6801 all windows, or only to those which specify that they will process the
6804 The mode can be one of the following values:
6806 ========================= ========================================
6807 wx.IDLE_PROCESS_ALL Send idle events to all windows
6808 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6809 the wx.WS_EX_PROCESS_IDLE extra style
6811 ========================= ========================================
6814 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6816 SetMode
= staticmethod(SetMode
)
6817 def GetMode(*args
, **kwargs
):
6821 Static method returning a value specifying how wxWidgets will send
6822 idle events: to all windows, or only to those which specify that they
6823 will process the events.
6825 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6827 GetMode
= staticmethod(GetMode
)
6828 def CanSend(*args
, **kwargs
):
6830 CanSend(Window win) -> bool
6832 Returns ``True`` if it is appropriate to send idle events to this
6835 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6836 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6837 events should be sent to this window now. By default this will always
6838 return ``True`` because the update mode is initially
6839 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6840 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6842 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6844 CanSend
= staticmethod(CanSend
)
6846 class IdleEventPtr(IdleEvent
):
6847 def __init__(self
, this
):
6849 if not hasattr(self
,"thisown"): self
.thisown
= 0
6850 self
.__class
__ = IdleEvent
6851 _core_
.IdleEvent_swigregister(IdleEventPtr
)
6853 def IdleEvent_SetMode(*args
, **kwargs
):
6855 IdleEvent_SetMode(int mode)
6857 Static method for specifying how wxWidgets will send idle events: to
6858 all windows, or only to those which specify that they will process the
6861 The mode can be one of the following values:
6863 ========================= ========================================
6864 wx.IDLE_PROCESS_ALL Send idle events to all windows
6865 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6866 the wx.WS_EX_PROCESS_IDLE extra style
6868 ========================= ========================================
6871 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6873 def IdleEvent_GetMode(*args
, **kwargs
):
6875 IdleEvent_GetMode() -> int
6877 Static method returning a value specifying how wxWidgets will send
6878 idle events: to all windows, or only to those which specify that they
6879 will process the events.
6881 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6883 def IdleEvent_CanSend(*args
, **kwargs
):
6885 IdleEvent_CanSend(Window win) -> bool
6887 Returns ``True`` if it is appropriate to send idle events to this
6890 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6891 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6892 events should be sent to this window now. By default this will always
6893 return ``True`` because the update mode is initially
6894 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6895 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6897 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6899 #---------------------------------------------------------------------------
6901 class PyEvent(Event
):
6903 wx.PyEvent can be used as a base class for implementing custom event
6904 types in Python. You should derived from this class instead of
6905 `wx.Event` because this class is Python-aware and is able to transport
6906 its Python bits safely through the wxWidgets event system and have
6907 them still be there when the event handler is invoked.
6909 :see: `wx.PyCommandEvent`
6913 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6914 def __init__(self
, *args
, **kwargs
):
6915 """__init__(self, int winid=0, wxEventType eventType=wxEVT_NULL) -> PyEvent"""
6916 newobj
= _core_
.new_PyEvent(*args
, **kwargs
)
6917 self
.this
= newobj
.this
6922 def __del__(self
, destroy
=_core_
.delete_PyEvent
):
6925 if self
.thisown
: destroy(self
)
6928 def _SetSelf(*args
, **kwargs
):
6929 """_SetSelf(self, PyObject self)"""
6930 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6932 def _GetSelf(*args
, **kwargs
):
6933 """_GetSelf(self) -> PyObject"""
6934 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6937 class PyEventPtr(PyEvent
):
6938 def __init__(self
, this
):
6940 if not hasattr(self
,"thisown"): self
.thisown
= 0
6941 self
.__class
__ = PyEvent
6942 _core_
.PyEvent_swigregister(PyEventPtr
)
6944 class PyCommandEvent(CommandEvent
):
6946 wx.PyCommandEvent can be used as a base class for implementing custom
6947 event types in Python, where the event shoudl travel up to parent
6948 windows looking for a handler. You should derived from this class
6949 instead of `wx.CommandEvent` because this class is Python-aware and is
6950 able to transport its Python bits safely through the wxWidgets event
6951 system and have them still be there when the event handler is invoked.
6957 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6958 def __init__(self
, *args
, **kwargs
):
6959 """__init__(self, wxEventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6960 newobj
= _core_
.new_PyCommandEvent(*args
, **kwargs
)
6961 self
.this
= newobj
.this
6966 def __del__(self
, destroy
=_core_
.delete_PyCommandEvent
):
6969 if self
.thisown
: destroy(self
)
6972 def _SetSelf(*args
, **kwargs
):
6973 """_SetSelf(self, PyObject self)"""
6974 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6976 def _GetSelf(*args
, **kwargs
):
6977 """_GetSelf(self) -> PyObject"""
6978 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6981 class PyCommandEventPtr(PyCommandEvent
):
6982 def __init__(self
, this
):
6984 if not hasattr(self
,"thisown"): self
.thisown
= 0
6985 self
.__class
__ = PyCommandEvent
6986 _core_
.PyCommandEvent_swigregister(PyCommandEventPtr
)
6988 class DateEvent(CommandEvent
):
6990 This event class holds information about a date change event and is
6991 used together with `wx.DatePickerCtrl`. It also serves as a base class
6992 for `wx.calendar.CalendarEvent`. Bind these event types with
6996 return "<%s.%s; proxy of C++ wxDateEvent instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
6997 def __init__(self
, *args
, **kwargs
):
6998 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
6999 newobj
= _core_
.new_DateEvent(*args
, **kwargs
)
7000 self
.this
= newobj
.this
7003 def GetDate(*args
, **kwargs
):
7005 GetDate(self) -> DateTime
7009 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
7011 def SetDate(*args
, **kwargs
):
7013 SetDate(self, DateTime date)
7015 Sets the date carried by the event, normally only used by the library
7018 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
7021 class DateEventPtr(DateEvent
):
7022 def __init__(self
, this
):
7024 if not hasattr(self
,"thisown"): self
.thisown
= 0
7025 self
.__class
__ = DateEvent
7026 _core_
.DateEvent_swigregister(DateEventPtr
)
7028 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
7029 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
7031 #---------------------------------------------------------------------------
7033 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
7034 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
7035 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
7036 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
7037 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
7038 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
7039 class PyApp(EvtHandler
):
7041 The ``wx.PyApp`` class is an *implementation detail*, please use the
7042 `wx.App` class (or some other derived class) instead.
7045 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
7046 def __init__(self
, *args
, **kwargs
):
7048 __init__(self) -> PyApp
7050 Create a new application object, starting the bootstrap process.
7052 newobj
= _core_
.new_PyApp(*args
, **kwargs
)
7053 self
.this
= newobj
.this
7056 self
._setCallbackInfo
(self
, PyApp
, False)
7057 self
._setOORInfo
(self
, False)
7059 def __del__(self
, destroy
=_core_
.delete_PyApp
):
7062 if self
.thisown
: destroy(self
)
7065 def _setCallbackInfo(*args
, **kwargs
):
7066 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
7067 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
7069 def GetAppName(*args
, **kwargs
):
7071 GetAppName(self) -> String
7073 Get the application name.
7075 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
7077 def SetAppName(*args
, **kwargs
):
7079 SetAppName(self, String name)
7081 Set the application name. This value may be used automatically by
7082 `wx.Config` and such.
7084 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
7086 def GetClassName(*args
, **kwargs
):
7088 GetClassName(self) -> String
7090 Get the application's class name.
7092 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
7094 def SetClassName(*args
, **kwargs
):
7096 SetClassName(self, String name)
7098 Set the application's class name. This value may be used for
7099 X-resources if applicable for the platform
7101 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
7103 def GetVendorName(*args
, **kwargs
):
7105 GetVendorName(self) -> String
7107 Get the application's vendor name.
7109 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
7111 def SetVendorName(*args
, **kwargs
):
7113 SetVendorName(self, String name)
7115 Set the application's vendor name. This value may be used
7116 automatically by `wx.Config` and such.
7118 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
7120 def GetTraits(*args
, **kwargs
):
7122 GetTraits(self) -> wxAppTraits
7124 Return (and create if necessary) the app traits object to which we
7125 delegate for everything which either should be configurable by the
7126 user (then he can change the default behaviour simply by overriding
7127 CreateTraits() and returning his own traits object) or which is
7128 GUI/console dependent as then wx.AppTraits allows us to abstract the
7129 differences behind the common facade.
7131 :todo: Add support for overriding CreateAppTraits in wxPython.
7133 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
7135 def ProcessPendingEvents(*args
, **kwargs
):
7137 ProcessPendingEvents(self)
7139 Process all events in the Pending Events list -- it is necessary to
7140 call this function to process posted events. This normally happens
7141 during each event loop iteration.
7143 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
7145 def Yield(*args
, **kwargs
):
7147 Yield(self, bool onlyIfNeeded=False) -> bool
7149 Process all currently pending events right now, instead of waiting
7150 until return to the event loop. It is an error to call ``Yield``
7151 recursively unless the value of ``onlyIfNeeded`` is True.
7153 :warning: This function is dangerous as it can lead to unexpected
7154 reentrancies (i.e. when called from an event handler it may
7155 result in calling the same event handler again), use with
7156 extreme care or, better, don't use at all!
7158 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7161 return _core_
.PyApp_Yield(*args
, **kwargs
)
7163 def WakeUpIdle(*args
, **kwargs
):
7167 Make sure that idle events are sent again.
7168 :see: `wx.WakeUpIdle`
7170 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
7172 def IsMainLoopRunning(*args
, **kwargs
):
7174 IsMainLoopRunning() -> bool
7176 Returns True if we're running the main loop, i.e. if the events can
7177 currently be dispatched.
7179 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7181 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
7182 def MainLoop(*args
, **kwargs
):
7184 MainLoop(self) -> int
7186 Execute the main GUI loop, the function doesn't normally return until
7187 all top level windows have been closed and destroyed.
7189 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
7191 def Exit(*args
, **kwargs
):
7195 Exit the main loop thus terminating the application.
7198 return _core_
.PyApp_Exit(*args
, **kwargs
)
7200 def ExitMainLoop(*args
, **kwargs
):
7204 Exit the main GUI loop during the next iteration of the main
7205 loop, (i.e. it does not stop the program immediately!)
7207 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
7209 def Pending(*args
, **kwargs
):
7211 Pending(self) -> bool
7213 Returns True if there are unprocessed events in the event queue.
7215 return _core_
.PyApp_Pending(*args
, **kwargs
)
7217 def Dispatch(*args
, **kwargs
):
7219 Dispatch(self) -> bool
7221 Process the first event in the event queue (blocks until an event
7222 appears if there are none currently)
7224 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
7226 def ProcessIdle(*args
, **kwargs
):
7228 ProcessIdle(self) -> bool
7230 Called from the MainLoop when the application becomes idle (there are
7231 no pending events) and sends a `wx.IdleEvent` to all interested
7232 parties. Returns True if more idle events are needed, False if not.
7234 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
7236 def SendIdleEvents(*args
, **kwargs
):
7238 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7240 Send idle event to window and all subwindows. Returns True if more
7241 idle time is requested.
7243 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
7245 def IsActive(*args
, **kwargs
):
7247 IsActive(self) -> bool
7249 Return True if our app has focus.
7251 return _core_
.PyApp_IsActive(*args
, **kwargs
)
7253 def SetTopWindow(*args
, **kwargs
):
7255 SetTopWindow(self, Window win)
7257 Set the *main* top level window
7259 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
7261 def GetTopWindow(*args
, **kwargs
):
7263 GetTopWindow(self) -> Window
7265 Return the *main* top level window (if it hadn't been set previously
7266 with SetTopWindow(), will return just some top level window and, if
7267 there not any, will return None)
7269 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
7271 def SetExitOnFrameDelete(*args
, **kwargs
):
7273 SetExitOnFrameDelete(self, bool flag)
7275 Control the exit behaviour: by default, the program will exit the main
7276 loop (and so, usually, terminate) when the last top-level program
7277 window is deleted. Beware that if you disable this behaviour (with
7278 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7279 explicitly from somewhere.
7281 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
7283 def GetExitOnFrameDelete(*args
, **kwargs
):
7285 GetExitOnFrameDelete(self) -> bool
7287 Get the current exit behaviour setting.
7289 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
7291 def SetUseBestVisual(*args
, **kwargs
):
7293 SetUseBestVisual(self, bool flag)
7295 Set whether the app should try to use the best available visual on
7296 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7298 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
7300 def GetUseBestVisual(*args
, **kwargs
):
7302 GetUseBestVisual(self) -> bool
7304 Get current UseBestVisual setting.
7306 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7308 def SetPrintMode(*args
, **kwargs
):
7309 """SetPrintMode(self, int mode)"""
7310 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7312 def GetPrintMode(*args
, **kwargs
):
7313 """GetPrintMode(self) -> int"""
7314 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7316 def SetAssertMode(*args
, **kwargs
):
7318 SetAssertMode(self, int mode)
7320 Set the OnAssert behaviour for debug and hybrid builds.
7322 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7324 def GetAssertMode(*args
, **kwargs
):
7326 GetAssertMode(self) -> int
7328 Get the current OnAssert behaviour setting.
7330 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7332 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7333 """GetMacSupportPCMenuShortcuts() -> bool"""
7334 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7336 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7337 def GetMacAboutMenuItemId(*args
, **kwargs
):
7338 """GetMacAboutMenuItemId() -> long"""
7339 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7341 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7342 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7343 """GetMacPreferencesMenuItemId() -> long"""
7344 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7346 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7347 def GetMacExitMenuItemId(*args
, **kwargs
):
7348 """GetMacExitMenuItemId() -> long"""
7349 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7351 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7352 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7353 """GetMacHelpMenuTitleName() -> String"""
7354 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7356 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7357 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7358 """SetMacSupportPCMenuShortcuts(bool val)"""
7359 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7361 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7362 def SetMacAboutMenuItemId(*args
, **kwargs
):
7363 """SetMacAboutMenuItemId(long val)"""
7364 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7366 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7367 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7368 """SetMacPreferencesMenuItemId(long val)"""
7369 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7371 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7372 def SetMacExitMenuItemId(*args
, **kwargs
):
7373 """SetMacExitMenuItemId(long val)"""
7374 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7376 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7377 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7378 """SetMacHelpMenuTitleName(String val)"""
7379 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7381 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7382 def _BootstrapApp(*args
, **kwargs
):
7386 For internal use only
7388 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7390 def GetComCtl32Version(*args
, **kwargs
):
7392 GetComCtl32Version() -> int
7394 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7395 it wasn't found at all. Raises an exception on non-Windows platforms.
7397 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7399 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7401 class PyAppPtr(PyApp
):
7402 def __init__(self
, this
):
7404 if not hasattr(self
,"thisown"): self
.thisown
= 0
7405 self
.__class
__ = PyApp
7406 _core_
.PyApp_swigregister(PyAppPtr
)
7408 def PyApp_IsMainLoopRunning(*args
, **kwargs
):
7410 PyApp_IsMainLoopRunning() -> bool
7412 Returns True if we're running the main loop, i.e. if the events can
7413 currently be dispatched.
7415 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7417 def PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7418 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7419 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7421 def PyApp_GetMacAboutMenuItemId(*args
, **kwargs
):
7422 """PyApp_GetMacAboutMenuItemId() -> long"""
7423 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7425 def PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
):
7426 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7427 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7429 def PyApp_GetMacExitMenuItemId(*args
, **kwargs
):
7430 """PyApp_GetMacExitMenuItemId() -> long"""
7431 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7433 def PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
):
7434 """PyApp_GetMacHelpMenuTitleName() -> String"""
7435 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7437 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7438 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7439 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7441 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7442 """PyApp_SetMacAboutMenuItemId(long val)"""
7443 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7445 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7446 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7447 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7449 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7450 """PyApp_SetMacExitMenuItemId(long val)"""
7451 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7453 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7454 """PyApp_SetMacHelpMenuTitleName(String val)"""
7455 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7457 def PyApp_GetComCtl32Version(*args
, **kwargs
):
7459 PyApp_GetComCtl32Version() -> int
7461 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7462 it wasn't found at all. Raises an exception on non-Windows platforms.
7464 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7466 #---------------------------------------------------------------------------
7469 def Exit(*args
, **kwargs
):
7473 Force an exit of the application. Convenience for wx.GetApp().Exit()
7475 return _core_
.Exit(*args
, **kwargs
)
7477 def Yield(*args
, **kwargs
):
7481 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7483 return _core_
.Yield(*args
, **kwargs
)
7485 def YieldIfNeeded(*args
, **kwargs
):
7487 YieldIfNeeded() -> bool
7489 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7491 return _core_
.YieldIfNeeded(*args
, **kwargs
)
7493 def SafeYield(*args
, **kwargs
):
7495 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7497 This function is similar to `wx.Yield`, except that it disables the
7498 user input to all program windows before calling `wx.Yield` and
7499 re-enables it again afterwards. If ``win`` is not None, this window
7500 will remain enabled, allowing the implementation of some limited user
7503 :Returns: the result of the call to `wx.Yield`.
7505 return _core_
.SafeYield(*args
, **kwargs
)
7507 def WakeUpIdle(*args
, **kwargs
):
7511 Cause the message queue to become empty again, so idle events will be
7514 return _core_
.WakeUpIdle(*args
, **kwargs
)
7516 def PostEvent(*args
, **kwargs
):
7518 PostEvent(EvtHandler dest, Event event)
7520 Send an event to a window or other wx.EvtHandler to be processed
7523 return _core_
.PostEvent(*args
, **kwargs
)
7525 def App_CleanUp(*args
, **kwargs
):
7529 For internal use only, it is used to cleanup after wxWidgets when
7532 return _core_
.App_CleanUp(*args
, **kwargs
)
7534 def GetApp(*args
, **kwargs
):
7538 Return a reference to the current wx.App object.
7540 return _core_
.GetApp(*args
, **kwargs
)
7542 def SetDefaultPyEncoding(*args
, **kwargs
):
7544 SetDefaultPyEncoding(string encoding)
7546 Sets the encoding that wxPython will use when it needs to convert a
7547 Python string or unicode object to or from a wxString.
7549 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7550 but please be aware that the default encoding within the same locale
7551 may be slightly different on different platforms. For example, please
7552 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7553 between the common latin/roman encodings.
7555 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7557 def GetDefaultPyEncoding(*args
, **kwargs
):
7559 GetDefaultPyEncoding() -> string
7561 Gets the current encoding that wxPython will use when it needs to
7562 convert a Python string or unicode object to or from a wxString.
7564 return _core_
.GetDefaultPyEncoding(*args
, **kwargs
)
7565 #----------------------------------------------------------------------
7567 class PyOnDemandOutputWindow
:
7569 A class that can be used for redirecting Python's stdout and
7570 stderr streams. It will do nothing until something is wrriten to
7571 the stream at which point it will create a Frame with a text area
7572 and write the text there.
7574 def __init__(self
, title
= "wxPython: stdout/stderr"):
7577 self
.pos
= wx
.DefaultPosition
7578 self
.size
= (450, 300)
7581 def SetParent(self
, parent
):
7582 """Set the window to be used as the popup Frame's parent."""
7583 self
.parent
= parent
7586 def CreateOutputWindow(self
, st
):
7587 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7588 style
=wx
.DEFAULT_FRAME_STYLE
)
7589 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7590 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7591 self
.text
.AppendText(st
)
7592 self
.frame
.Show(True)
7593 EVT_CLOSE(self
.frame
, self
.OnCloseWindow
)
7596 def OnCloseWindow(self
, event
):
7597 if self
.frame
is not None:
7598 self
.frame
.Destroy()
7603 # These methods provide the file-like output behaviour.
7604 def write(self
, text
):
7606 Create the output window if needed and write the string to it.
7607 If not called in the context of the gui thread then uses
7608 CallAfter to do the work there.
7610 if self
.frame
is None:
7611 if not wx
.Thread_IsMain():
7612 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7614 self
.CreateOutputWindow(text
)
7616 if not wx
.Thread_IsMain():
7617 wx
.CallAfter(self
.text
.AppendText
, text
)
7619 self
.text
.AppendText(text
)
7623 if self
.frame
is not None:
7624 wx
.CallAfter(self
.frame
.Close
)
7632 #----------------------------------------------------------------------
7634 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7636 class App(wx
.PyApp
):
7638 The ``wx.App`` class represents the application and is used to:
7640 * bootstrap the wxPython system and initialize the underlying
7642 * set and get application-wide properties
7643 * implement the windowing system main message or event loop,
7644 and to dispatch events to window instances
7647 Every application must have a ``wx.App`` instance, and all
7648 creation of UI objects should be delayed until after the
7649 ``wx.App`` object has been created in order to ensure that the gui
7650 platform and wxWidgets have been fully initialized.
7652 Normally you would derive from this class and implement an
7653 ``OnInit`` method that creates a frame and then calls
7654 ``self.SetTopWindow(frame)``.
7656 :see: `wx.PySimpleApp` for a simpler app class that can be used
7660 outputWindowClass
= PyOnDemandOutputWindow
7662 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7663 useBestVisual
=False, clearSigInt
=True):
7665 Construct a ``wx.App`` object.
7667 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7668 redirected? Defaults to True on Windows and Mac, False
7669 otherwise. If `filename` is None then output will be
7670 redirected to a window that pops up as needed. (You can
7671 control what kind of window is created for the output by
7672 resetting the class variable ``outputWindowClass`` to a
7673 class of your choosing.)
7675 :param filename: The name of a file to redirect output to, if
7678 :param useBestVisual: Should the app try to use the best
7679 available visual provided by the system (only relevant on
7680 systems that have more than one visual.) This parameter
7681 must be used instead of calling `SetUseBestVisual` later
7682 on because it must be set before the underlying GUI
7683 toolkit is initialized.
7685 :param clearSigInt: Should SIGINT be cleared? This allows the
7686 app to terminate upon a Ctrl-C in the console like other
7689 :note: You should override OnInit to do applicaition
7690 initialization to ensure that the system, toolkit and
7691 wxWidgets are fully initialized.
7693 wx
.PyApp
.__init
__(self
)
7695 if wx
.Platform
== "__WXMAC__":
7698 if not MacOS
.WMAvailable():
7700 This program needs access to the screen. Please run with 'pythonw',
7701 not 'python', and only when you are logged in on the main display of
7709 # This has to be done before OnInit
7710 self
.SetUseBestVisual(useBestVisual
)
7712 # Set the default handler for SIGINT. This fixes a problem
7713 # where if Ctrl-C is pressed in the console that started this
7714 # app then it will not appear to do anything, (not even send
7715 # KeyboardInterrupt???) but will later segfault on exit. By
7716 # setting the default handler then the app will exit, as
7717 # expected (depending on platform.)
7721 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7725 # Save and redirect the stdio to a window?
7726 self
.stdioWin
= None
7727 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7729 self
.RedirectStdio(filename
)
7731 # Use Python's install prefix as the default
7732 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7734 # This finishes the initialization of wxWindows and then calls
7735 # the OnInit that should be present in the derived class
7736 self
._BootstrapApp
()
7739 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7740 self
.RestoreStdio() # Just in case the MainLoop was overridden
7744 wx
.PyApp
.Destroy(self
)
7747 def SetTopWindow(self
, frame
):
7748 """Set the \"main\" top level window"""
7750 self
.stdioWin
.SetParent(frame
)
7751 wx
.PyApp
.SetTopWindow(self
, frame
)
7755 """Execute the main GUI event loop"""
7756 wx
.PyApp
.MainLoop(self
)
7760 def RedirectStdio(self
, filename
=None):
7761 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7763 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7765 self
.stdioWin
= self
.outputWindowClass()
7766 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7769 def RestoreStdio(self
):
7771 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7776 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7778 Set the title, position and/or size of the output window if
7779 the stdio has been redirected. This should be called before
7780 any output would cause the output window to be created.
7783 if title
is not None:
7784 self
.stdioWin
.title
= title
7786 self
.stdioWin
.pos
= pos
7787 if size
is not None:
7788 self
.stdioWin
.size
= size
7793 # change from wx.PyApp_XX to wx.App_XX
7794 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7795 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7796 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7797 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7798 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7799 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7800 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7801 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7802 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7803 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7804 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7806 #----------------------------------------------------------------------------
7808 class PySimpleApp(wx
.App
):
7810 A simple application class. You can just create one of these and
7811 then then make your top level windows later, and not have to worry
7812 about OnInit. For example::
7814 app = wx.PySimpleApp()
7815 frame = wx.Frame(None, title='Hello World')
7822 def __init__(self
, redirect
=False, filename
=None,
7823 useBestVisual
=False, clearSigInt
=True):
7825 :see: `wx.App.__init__`
7827 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7834 # Is anybody using this one?
7835 class PyWidgetTester(wx
.App
):
7836 def __init__(self
, size
= (250, 100)):
7838 wx
.App
.__init
__(self
, 0)
7841 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7842 self
.SetTopWindow(self
.frame
)
7845 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7846 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7847 self
.frame
.Show(True)
7849 #----------------------------------------------------------------------------
7850 # DO NOT hold any other references to this object. This is how we
7851 # know when to cleanup system resources that wxWidgets is holding. When
7852 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7853 # goes to zero and it calls the wx.App_CleanUp function.
7855 class __wxPyCleanup
:
7857 self
.cleanup
= _core_
.App_CleanUp
7861 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7863 ## # another possible solution, but it gets called too early...
7865 ## atexit.register(_core_.wxApp_CleanUp)
7868 #----------------------------------------------------------------------------
7870 #---------------------------------------------------------------------------
7872 class EventLoop(object):
7873 """Proxy of C++ EventLoop class"""
7875 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
7876 def __init__(self
, *args
, **kwargs
):
7877 """__init__(self) -> EventLoop"""
7878 newobj
= _core_
.new_EventLoop(*args
, **kwargs
)
7879 self
.this
= newobj
.this
7882 def __del__(self
, destroy
=_core_
.delete_EventLoop
):
7885 if self
.thisown
: destroy(self
)
7888 def Run(*args
, **kwargs
):
7889 """Run(self) -> int"""
7890 return _core_
.EventLoop_Run(*args
, **kwargs
)
7892 def Exit(*args
, **kwargs
):
7893 """Exit(self, int rc=0)"""
7894 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7896 def Pending(*args
, **kwargs
):
7897 """Pending(self) -> bool"""
7898 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7900 def Dispatch(*args
, **kwargs
):
7901 """Dispatch(self) -> bool"""
7902 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7904 def IsRunning(*args
, **kwargs
):
7905 """IsRunning(self) -> bool"""
7906 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7908 def GetActive(*args
, **kwargs
):
7909 """GetActive() -> EventLoop"""
7910 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7912 GetActive
= staticmethod(GetActive
)
7913 def SetActive(*args
, **kwargs
):
7914 """SetActive(EventLoop loop)"""
7915 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7917 SetActive
= staticmethod(SetActive
)
7919 class EventLoopPtr(EventLoop
):
7920 def __init__(self
, this
):
7922 if not hasattr(self
,"thisown"): self
.thisown
= 0
7923 self
.__class
__ = EventLoop
7924 _core_
.EventLoop_swigregister(EventLoopPtr
)
7926 def EventLoop_GetActive(*args
, **kwargs
):
7927 """EventLoop_GetActive() -> EventLoop"""
7928 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7930 def EventLoop_SetActive(*args
, **kwargs
):
7931 """EventLoop_SetActive(EventLoop loop)"""
7932 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7934 class EventLoopActivator(object):
7935 """Proxy of C++ EventLoopActivator class"""
7937 return "<%s.%s; proxy of C++ wxEventLoopActivator instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
7938 def __init__(self
, *args
, **kwargs
):
7939 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7940 newobj
= _core_
.new_EventLoopActivator(*args
, **kwargs
)
7941 self
.this
= newobj
.this
7944 def __del__(self
, destroy
=_core_
.delete_EventLoopActivator
):
7947 if self
.thisown
: destroy(self
)
7951 class EventLoopActivatorPtr(EventLoopActivator
):
7952 def __init__(self
, this
):
7954 if not hasattr(self
,"thisown"): self
.thisown
= 0
7955 self
.__class
__ = EventLoopActivator
7956 _core_
.EventLoopActivator_swigregister(EventLoopActivatorPtr
)
7958 #---------------------------------------------------------------------------
7960 class AcceleratorEntry(object):
7962 A class used to define items in an `wx.AcceleratorTable`. wxPython
7963 programs can choose to use wx.AcceleratorEntry objects, but using a
7964 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7965 as well. See `__init__` for of the tuple values.
7967 :see: `wx.AcceleratorTable`
7970 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
7971 def __init__(self
, *args
, **kwargs
):
7973 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7975 Construct a wx.AcceleratorEntry.
7977 newobj
= _core_
.new_AcceleratorEntry(*args
, **kwargs
)
7978 self
.this
= newobj
.this
7981 def __del__(self
, destroy
=_core_
.delete_AcceleratorEntry
):
7984 if self
.thisown
: destroy(self
)
7987 def Set(*args
, **kwargs
):
7989 Set(self, int flags, int keyCode, int cmd)
7991 (Re)set the attributes of a wx.AcceleratorEntry.
7994 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7996 def GetFlags(*args
, **kwargs
):
7998 GetFlags(self) -> int
8000 Get the AcceleratorEntry's flags.
8002 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
8004 def GetKeyCode(*args
, **kwargs
):
8006 GetKeyCode(self) -> int
8008 Get the AcceleratorEntry's keycode.
8010 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8012 def GetCommand(*args
, **kwargs
):
8014 GetCommand(self) -> int
8016 Get the AcceleratorEntry's command ID.
8018 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8021 class AcceleratorEntryPtr(AcceleratorEntry
):
8022 def __init__(self
, this
):
8024 if not hasattr(self
,"thisown"): self
.thisown
= 0
8025 self
.__class
__ = AcceleratorEntry
8026 _core_
.AcceleratorEntry_swigregister(AcceleratorEntryPtr
)
8028 class AcceleratorTable(Object
):
8030 An accelerator table allows the application to specify a table of
8031 keyboard shortcuts for menus or other commands. On Windows, menu or
8032 button commands are supported; on GTK, only menu commands are
8036 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
8037 def __init__(self
, *args
, **kwargs
):
8039 __init__(entries) -> AcceleratorTable
8041 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8042 items or or of 3-tuples (flags, keyCode, cmdID)
8044 :see: `wx.AcceleratorEntry`
8046 newobj
= _core_
.new_AcceleratorTable(*args
, **kwargs
)
8047 self
.this
= newobj
.this
8050 def __del__(self
, destroy
=_core_
.delete_AcceleratorTable
):
8053 if self
.thisown
: destroy(self
)
8056 def Ok(*args
, **kwargs
):
8057 """Ok(self) -> bool"""
8058 return _core_
.AcceleratorTable_Ok(*args
, **kwargs
)
8061 class AcceleratorTablePtr(AcceleratorTable
):
8062 def __init__(self
, this
):
8064 if not hasattr(self
,"thisown"): self
.thisown
= 0
8065 self
.__class
__ = AcceleratorTable
8066 _core_
.AcceleratorTable_swigregister(AcceleratorTablePtr
)
8069 def GetAccelFromString(*args
, **kwargs
):
8070 """GetAccelFromString(String label) -> AcceleratorEntry"""
8071 return _core_
.GetAccelFromString(*args
, **kwargs
)
8072 #---------------------------------------------------------------------------
8074 class VisualAttributes(object):
8075 """struct containing all the visual attributes of a control"""
8077 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
8078 def __init__(self
, *args
, **kwargs
):
8080 __init__(self) -> VisualAttributes
8082 struct containing all the visual attributes of a control
8084 newobj
= _core_
.new_VisualAttributes(*args
, **kwargs
)
8085 self
.this
= newobj
.this
8088 def __del__(self
, destroy
=_core_
.delete_VisualAttributes
):
8091 if self
.thisown
: destroy(self
)
8094 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
8095 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
8096 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
8098 class VisualAttributesPtr(VisualAttributes
):
8099 def __init__(self
, this
):
8101 if not hasattr(self
,"thisown"): self
.thisown
= 0
8102 self
.__class
__ = VisualAttributes
8103 _core_
.VisualAttributes_swigregister(VisualAttributesPtr
)
8104 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8105 PanelNameStr
= cvar
.PanelNameStr
8107 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8108 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8109 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8110 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8111 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8112 class Window(EvtHandler
):
8114 wx.Window is the base class for all windows and represents any visible
8115 object on the screen. All controls, top level windows and so on are
8116 wx.Windows. Sizers and device contexts are not however, as they don't
8117 appear on screen themselves.
8121 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
8122 def __init__(self
, *args
, **kwargs
):
8124 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8125 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8127 Construct and show a generic Window.
8129 newobj
= _core_
.new_Window(*args
, **kwargs
)
8130 self
.this
= newobj
.this
8133 self
._setOORInfo
(self
)
8135 def Create(*args
, **kwargs
):
8137 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8138 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8140 Create the GUI part of the Window for 2-phase creation mode.
8142 return _core_
.Window_Create(*args
, **kwargs
)
8144 def Close(*args
, **kwargs
):
8146 Close(self, bool force=False) -> bool
8148 This function simply generates a EVT_CLOSE event whose handler usually
8149 tries to close the window. It doesn't close the window itself,
8150 however. If force is False (the default) then the window's close
8151 handler will be allowed to veto the destruction of the window.
8153 return _core_
.Window_Close(*args
, **kwargs
)
8155 def Destroy(*args
, **kwargs
):
8157 Destroy(self) -> bool
8159 Destroys the window safely. Frames and dialogs are not destroyed
8160 immediately when this function is called -- they are added to a list
8161 of windows to be deleted on idle time, when all the window's events
8162 have been processed. This prevents problems with events being sent to
8163 non-existent windows.
8165 Returns True if the window has either been successfully deleted, or it
8166 has been added to the list of windows pending real deletion.
8168 val
= _core_
.Window_Destroy(*args
, **kwargs
)
8172 def DestroyChildren(*args
, **kwargs
):
8174 DestroyChildren(self) -> bool
8176 Destroys all children of a window. Called automatically by the
8179 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8181 def IsBeingDeleted(*args
, **kwargs
):
8183 IsBeingDeleted(self) -> bool
8185 Is the window in the process of being deleted?
8187 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8189 def SetLabel(*args
, **kwargs
):
8191 SetLabel(self, String label)
8193 Set the text which the window shows in its label if applicable.
8195 return _core_
.Window_SetLabel(*args
, **kwargs
)
8197 def GetLabel(*args
, **kwargs
):
8199 GetLabel(self) -> String
8201 Generic way of getting a label from any window, for identification
8202 purposes. The interpretation of this function differs from class to
8203 class. For frames and dialogs, the value returned is the title. For
8204 buttons or static text controls, it is the button text. This function
8205 can be useful for meta-programs such as testing tools or special-needs
8206 access programs)which need to identify windows by name.
8208 return _core_
.Window_GetLabel(*args
, **kwargs
)
8210 def SetName(*args
, **kwargs
):
8212 SetName(self, String name)
8214 Sets the window's name. The window name is used for ressource setting
8215 in X, it is not the same as the window title/label
8217 return _core_
.Window_SetName(*args
, **kwargs
)
8219 def GetName(*args
, **kwargs
):
8221 GetName(self) -> String
8223 Returns the windows name. This name is not guaranteed to be unique;
8224 it is up to the programmer to supply an appropriate name in the window
8225 constructor or via wx.Window.SetName.
8227 return _core_
.Window_GetName(*args
, **kwargs
)
8229 def SetWindowVariant(*args
, **kwargs
):
8231 SetWindowVariant(self, int variant)
8233 Sets the variant of the window/font size to use for this window, if
8234 the platform supports variants, for example, wxMac.
8236 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8238 def GetWindowVariant(*args
, **kwargs
):
8239 """GetWindowVariant(self) -> int"""
8240 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8242 def SetId(*args
, **kwargs
):
8244 SetId(self, int winid)
8246 Sets the identifier of the window. Each window has an integer
8247 identifier. If the application has not provided one, an identifier
8248 will be generated. Normally, the identifier should be provided on
8249 creation and should not be modified subsequently.
8251 return _core_
.Window_SetId(*args
, **kwargs
)
8253 def GetId(*args
, **kwargs
):
8257 Returns the identifier of the window. Each window has an integer
8258 identifier. If the application has not provided one (or the default Id
8259 -1 is used) then an unique identifier with a negative value will be
8262 return _core_
.Window_GetId(*args
, **kwargs
)
8264 def NewControlId(*args
, **kwargs
):
8266 NewControlId() -> int
8268 Generate a control id for the controls which were not given one.
8270 return _core_
.Window_NewControlId(*args
, **kwargs
)
8272 NewControlId
= staticmethod(NewControlId
)
8273 def NextControlId(*args
, **kwargs
):
8275 NextControlId(int winid) -> int
8277 Get the id of the control following the one with the given
8280 return _core_
.Window_NextControlId(*args
, **kwargs
)
8282 NextControlId
= staticmethod(NextControlId
)
8283 def PrevControlId(*args
, **kwargs
):
8285 PrevControlId(int winid) -> int
8287 Get the id of the control preceding the one with the given
8290 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8292 PrevControlId
= staticmethod(PrevControlId
)
8293 def SetSize(*args
, **kwargs
):
8295 SetSize(self, Size size)
8297 Sets the size of the window in pixels.
8299 return _core_
.Window_SetSize(*args
, **kwargs
)
8301 def SetDimensions(*args
, **kwargs
):
8303 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8305 Sets the position and size of the window in pixels. The sizeFlags
8306 parameter indicates the interpretation of the other params if they are
8309 ======================== ======================================
8310 wx.SIZE_AUTO A -1 indicates that a class-specific
8311 default should be used.
8312 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8313 -1 values are supplied.
8314 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8315 interpreted as real dimensions, not
8317 ======================== ======================================
8320 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8322 def SetRect(*args
, **kwargs
):
8324 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8326 Sets the position and size of the window in pixels using a wx.Rect.
8328 return _core_
.Window_SetRect(*args
, **kwargs
)
8330 def SetSizeWH(*args
, **kwargs
):
8332 SetSizeWH(self, int width, int height)
8334 Sets the size of the window in pixels.
8336 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8338 def Move(*args
, **kwargs
):
8340 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8342 Moves the window to the given position.
8344 return _core_
.Window_Move(*args
, **kwargs
)
8347 def MoveXY(*args
, **kwargs
):
8349 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8351 Moves the window to the given position.
8353 return _core_
.Window_MoveXY(*args
, **kwargs
)
8355 def SetBestFittingSize(*args
, **kwargs
):
8357 SetBestFittingSize(self, Size size=DefaultSize)
8359 A 'Smart' SetSize that will fill in default size components with the
8360 window's *best size* values. Also set's the minsize for use with sizers.
8362 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
8364 def Raise(*args
, **kwargs
):
8368 Raises the window to the top of the window hierarchy. In current
8369 version of wxWidgets this works both for manage and child windows.
8371 return _core_
.Window_Raise(*args
, **kwargs
)
8373 def Lower(*args
, **kwargs
):
8377 Lowers the window to the bottom of the window hierarchy. In current
8378 version of wxWidgets this works both for manage and child windows.
8380 return _core_
.Window_Lower(*args
, **kwargs
)
8382 def SetClientSize(*args
, **kwargs
):
8384 SetClientSize(self, Size size)
8386 This sets the size of the window client area in pixels. Using this
8387 function to size a window tends to be more device-independent than
8388 wx.Window.SetSize, since the application need not worry about what
8389 dimensions the border or title bar have when trying to fit the window
8390 around panel items, for example.
8392 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8394 def SetClientSizeWH(*args
, **kwargs
):
8396 SetClientSizeWH(self, int width, int height)
8398 This sets the size of the window client area in pixels. Using this
8399 function to size a window tends to be more device-independent than
8400 wx.Window.SetSize, since the application need not worry about what
8401 dimensions the border or title bar have when trying to fit the window
8402 around panel items, for example.
8404 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8406 def SetClientRect(*args
, **kwargs
):
8408 SetClientRect(self, Rect rect)
8410 This sets the size of the window client area in pixels. Using this
8411 function to size a window tends to be more device-independent than
8412 wx.Window.SetSize, since the application need not worry about what
8413 dimensions the border or title bar have when trying to fit the window
8414 around panel items, for example.
8416 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8418 def GetPosition(*args
, **kwargs
):
8420 GetPosition(self) -> Point
8422 Get the window's position.
8424 return _core_
.Window_GetPosition(*args
, **kwargs
)
8426 def GetPositionTuple(*args
, **kwargs
):
8428 GetPositionTuple() -> (x,y)
8430 Get the window's position.
8432 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8434 def GetSize(*args
, **kwargs
):
8436 GetSize(self) -> Size
8438 Get the window size.
8440 return _core_
.Window_GetSize(*args
, **kwargs
)
8442 def GetSizeTuple(*args
, **kwargs
):
8444 GetSizeTuple() -> (width, height)
8446 Get the window size.
8448 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8450 def GetRect(*args
, **kwargs
):
8452 GetRect(self) -> Rect
8454 Returns the size and position of the window as a wx.Rect object.
8456 return _core_
.Window_GetRect(*args
, **kwargs
)
8458 def GetClientSize(*args
, **kwargs
):
8460 GetClientSize(self) -> Size
8462 This gets the size of the window's 'client area' in pixels. The client
8463 area is the area which may be drawn on by the programmer, excluding
8464 title bar, border, scrollbars, etc.
8466 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8468 def GetClientSizeTuple(*args
, **kwargs
):
8470 GetClientSizeTuple() -> (width, height)
8472 This gets the size of the window's 'client area' in pixels. The client
8473 area is the area which may be drawn on by the programmer, excluding
8474 title bar, border, scrollbars, etc.
8476 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8478 def GetClientAreaOrigin(*args
, **kwargs
):
8480 GetClientAreaOrigin(self) -> Point
8482 Get the origin of the client area of the window relative to the
8483 window's top left corner (the client area may be shifted because of
8484 the borders, scrollbars, other decorations...)
8486 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8488 def GetClientRect(*args
, **kwargs
):
8490 GetClientRect(self) -> Rect
8492 Get the client area position and size as a `wx.Rect` object.
8494 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8496 def GetBestSize(*args
, **kwargs
):
8498 GetBestSize(self) -> Size
8500 This function returns the best acceptable minimal size for the
8501 window, if applicable. For example, for a static text control, it will
8502 be the minimal size such that the control label is not truncated. For
8503 windows containing subwindows (suzh aswx.Panel), the size returned by
8504 this function will be the same as the size the window would have had
8507 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8509 def GetBestSizeTuple(*args
, **kwargs
):
8511 GetBestSizeTuple() -> (width, height)
8513 This function returns the best acceptable minimal size for the
8514 window, if applicable. For example, for a static text control, it will
8515 be the minimal size such that the control label is not truncated. For
8516 windows containing subwindows (suzh aswx.Panel), the size returned by
8517 this function will be the same as the size the window would have had
8520 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8522 def InvalidateBestSize(*args
, **kwargs
):
8524 InvalidateBestSize(self)
8526 Reset the cached best size value so it will be recalculated the next
8529 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8531 def CacheBestSize(*args
, **kwargs
):
8533 CacheBestSize(self, Size size)
8535 Cache the best size so it doesn't need to be calculated again, (at least until
8536 some properties of the window change.)
8538 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8540 def GetBestFittingSize(*args
, **kwargs
):
8542 GetBestFittingSize(self) -> Size
8544 This function will merge the window's best size into the window's
8545 minimum size, giving priority to the min size components, and returns
8549 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
8551 def GetAdjustedBestSize(*args
, **kwargs
):
8553 GetAdjustedBestSize(self) -> Size
8555 This method is similar to GetBestSize, except in one
8556 thing. GetBestSize should return the minimum untruncated size of the
8557 window, while this method will return the largest of BestSize and any
8558 user specified minimum size. ie. it is the minimum size the window
8559 should currently be drawn at, not the minimal size it can possibly
8562 return _core_
.Window_GetAdjustedBestSize(*args
, **kwargs
)
8564 def Center(*args
, **kwargs
):
8566 Center(self, int direction=BOTH)
8568 Centers the window. The parameter specifies the direction for
8569 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8570 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8571 on the entire screen and not on its parent window. If it is a
8572 top-level window and has no parent then it will always be centered
8573 relative to the screen.
8575 return _core_
.Window_Center(*args
, **kwargs
)
8578 def CenterOnParent(*args
, **kwargs
):
8580 CenterOnParent(self, int dir=BOTH)
8582 Center with respect to the the parent window
8584 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8586 CentreOnParent
= CenterOnParent
8587 def Fit(*args
, **kwargs
):
8591 Sizes the window so that it fits around its subwindows. This function
8592 won't do anything if there are no subwindows and will only really work
8593 correctly if sizers are used for the subwindows layout. Also, if the
8594 window has exactly one subwindow it is better (faster and the result
8595 is more precise as Fit adds some margin to account for fuzziness of
8596 its calculations) to call window.SetClientSize(child.GetSize())
8597 instead of calling Fit.
8599 return _core_
.Window_Fit(*args
, **kwargs
)
8601 def FitInside(*args
, **kwargs
):
8605 Similar to Fit, but sizes the interior (virtual) size of a
8606 window. Mainly useful with scrolled windows to reset scrollbars after
8607 sizing changes that do not trigger a size event, and/or scrolled
8608 windows without an interior sizer. This function similarly won't do
8609 anything if there are no subwindows.
8611 return _core_
.Window_FitInside(*args
, **kwargs
)
8613 def SetSizeHints(*args
, **kwargs
):
8615 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8618 Allows specification of minimum and maximum window sizes, and window
8619 size increments. If a pair of values is not set (or set to -1), the
8620 default values will be used. If this function is called, the user
8621 will not be able to size the window outside the given bounds (if it is
8622 a top-level window.) Sizers will also inspect the minimum window size
8623 and will use that value if set when calculating layout.
8625 The resizing increments are only significant under Motif or Xt.
8627 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8629 def SetSizeHintsSz(*args
, **kwargs
):
8631 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8633 Allows specification of minimum and maximum window sizes, and window
8634 size increments. If a pair of values is not set (or set to -1), the
8635 default values will be used. If this function is called, the user
8636 will not be able to size the window outside the given bounds (if it is
8637 a top-level window.) Sizers will also inspect the minimum window size
8638 and will use that value if set when calculating layout.
8640 The resizing increments are only significant under Motif or Xt.
8642 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8644 def SetVirtualSizeHints(*args
, **kwargs
):
8646 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8648 Allows specification of minimum and maximum virtual window sizes. If a
8649 pair of values is not set (or set to -1), the default values will be
8650 used. If this function is called, the user will not be able to size
8651 the virtual area of the window outside the given bounds.
8653 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8655 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8657 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8659 Allows specification of minimum and maximum virtual window sizes. If a
8660 pair of values is not set (or set to -1), the default values will be
8661 used. If this function is called, the user will not be able to size
8662 the virtual area of the window outside the given bounds.
8664 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8666 def GetMaxSize(*args
, **kwargs
):
8667 """GetMaxSize(self) -> Size"""
8668 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8670 def GetMinSize(*args
, **kwargs
):
8671 """GetMinSize(self) -> Size"""
8672 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8674 def SetMinSize(*args
, **kwargs
):
8676 SetMinSize(self, Size minSize)
8678 A more convenient method than `SetSizeHints` for setting just the
8681 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8683 def SetMaxSize(*args
, **kwargs
):
8685 SetMaxSize(self, Size maxSize)
8687 A more convenient method than `SetSizeHints` for setting just the
8690 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8692 def GetMinWidth(*args
, **kwargs
):
8693 """GetMinWidth(self) -> int"""
8694 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8696 def GetMinHeight(*args
, **kwargs
):
8697 """GetMinHeight(self) -> int"""
8698 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8700 def GetMaxWidth(*args
, **kwargs
):
8701 """GetMaxWidth(self) -> int"""
8702 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8704 def GetMaxHeight(*args
, **kwargs
):
8705 """GetMaxHeight(self) -> int"""
8706 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8708 def SetVirtualSize(*args
, **kwargs
):
8710 SetVirtualSize(self, Size size)
8712 Set the the virtual size of a window in pixels. For most windows this
8713 is just the client area of the window, but for some like scrolled
8714 windows it is more or less independent of the screen window size.
8716 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8718 def SetVirtualSizeWH(*args
, **kwargs
):
8720 SetVirtualSizeWH(self, int w, int h)
8722 Set the the virtual size of a window in pixels. For most windows this
8723 is just the client area of the window, but for some like scrolled
8724 windows it is more or less independent of the screen window size.
8726 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8728 def GetVirtualSize(*args
, **kwargs
):
8730 GetVirtualSize(self) -> Size
8732 Get the the virtual size of the window in pixels. For most windows
8733 this is just the client area of the window, but for some like scrolled
8734 windows it is more or less independent of the screen window size.
8736 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8738 def GetVirtualSizeTuple(*args
, **kwargs
):
8740 GetVirtualSizeTuple() -> (width, height)
8742 Get the the virtual size of the window in pixels. For most windows
8743 this is just the client area of the window, but for some like scrolled
8744 windows it is more or less independent of the screen window size.
8746 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8748 def GetBestVirtualSize(*args
, **kwargs
):
8750 GetBestVirtualSize(self) -> Size
8752 Return the largest of ClientSize and BestSize (as determined by a
8753 sizer, interior children, or other means)
8755 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8757 def Show(*args
, **kwargs
):
8759 Show(self, bool show=True) -> bool
8761 Shows or hides the window. You may need to call Raise for a top level
8762 window if you want to bring it to top, although this is not needed if
8763 Show is called immediately after the frame creation. Returns True if
8764 the window has been shown or hidden or False if nothing was done
8765 because it already was in the requested state.
8767 return _core_
.Window_Show(*args
, **kwargs
)
8769 def Hide(*args
, **kwargs
):
8773 Equivalent to calling Show(False).
8775 return _core_
.Window_Hide(*args
, **kwargs
)
8777 def Enable(*args
, **kwargs
):
8779 Enable(self, bool enable=True) -> bool
8781 Enable or disable the window for user input. Note that when a parent
8782 window is disabled, all of its children are disabled as well and they
8783 are reenabled again when the parent is. Returns true if the window
8784 has been enabled or disabled, false if nothing was done, i.e. if the
8785 window had already been in the specified state.
8787 return _core_
.Window_Enable(*args
, **kwargs
)
8789 def Disable(*args
, **kwargs
):
8791 Disable(self) -> bool
8793 Disables the window, same as Enable(false).
8795 return _core_
.Window_Disable(*args
, **kwargs
)
8797 def IsShown(*args
, **kwargs
):
8799 IsShown(self) -> bool
8801 Returns true if the window is shown, false if it has been hidden.
8803 return _core_
.Window_IsShown(*args
, **kwargs
)
8805 def IsEnabled(*args
, **kwargs
):
8807 IsEnabled(self) -> bool
8809 Returns true if the window is enabled for input, false otherwise.
8811 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8813 def SetWindowStyleFlag(*args
, **kwargs
):
8815 SetWindowStyleFlag(self, long style)
8817 Sets the style of the window. Please note that some styles cannot be
8818 changed after the window creation and that Refresh() might need to be
8819 called after changing the others for the change to take place
8822 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8824 def GetWindowStyleFlag(*args
, **kwargs
):
8826 GetWindowStyleFlag(self) -> long
8828 Gets the window style that was passed to the constructor or Create
8831 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8833 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8834 def HasFlag(*args
, **kwargs
):
8836 HasFlag(self, int flag) -> bool
8838 Test if the given style is set for this window.
8840 return _core_
.Window_HasFlag(*args
, **kwargs
)
8842 def IsRetained(*args
, **kwargs
):
8844 IsRetained(self) -> bool
8846 Returns true if the window is retained, false otherwise. Retained
8847 windows are only available on X platforms.
8849 return _core_
.Window_IsRetained(*args
, **kwargs
)
8851 def SetExtraStyle(*args
, **kwargs
):
8853 SetExtraStyle(self, long exStyle)
8855 Sets the extra style bits for the window. Extra styles are the less
8856 often used style bits which can't be set with the constructor or with
8857 SetWindowStyleFlag()
8859 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8861 def GetExtraStyle(*args
, **kwargs
):
8863 GetExtraStyle(self) -> long
8865 Returns the extra style bits for the window.
8867 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8869 def MakeModal(*args
, **kwargs
):
8871 MakeModal(self, bool modal=True)
8873 Disables all other windows in the application so that the user can
8874 only interact with this window. Passing False will reverse this
8877 return _core_
.Window_MakeModal(*args
, **kwargs
)
8879 def SetThemeEnabled(*args
, **kwargs
):
8881 SetThemeEnabled(self, bool enableTheme)
8883 This function tells a window if it should use the system's "theme"
8884 code to draw the windows' background instead if its own background
8885 drawing code. This will only have an effect on platforms that support
8886 the notion of themes in user defined windows. One such platform is
8887 GTK+ where windows can have (very colourful) backgrounds defined by a
8888 user's selected theme.
8890 Dialogs, notebook pages and the status bar have this flag set to true
8891 by default so that the default look and feel is simulated best.
8893 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8895 def GetThemeEnabled(*args
, **kwargs
):
8897 GetThemeEnabled(self) -> bool
8899 Return the themeEnabled flag.
8901 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8903 def SetFocus(*args
, **kwargs
):
8907 Set's the focus to this window, allowing it to receive keyboard input.
8909 return _core_
.Window_SetFocus(*args
, **kwargs
)
8911 def SetFocusFromKbd(*args
, **kwargs
):
8913 SetFocusFromKbd(self)
8915 Set focus to this window as the result of a keyboard action. Normally
8916 only called internally.
8918 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8920 def FindFocus(*args
, **kwargs
):
8922 FindFocus() -> Window
8924 Returns the window or control that currently has the keyboard focus,
8927 return _core_
.Window_FindFocus(*args
, **kwargs
)
8929 FindFocus
= staticmethod(FindFocus
)
8930 def AcceptsFocus(*args
, **kwargs
):
8932 AcceptsFocus(self) -> bool
8934 Can this window have focus?
8936 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8938 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
8940 AcceptsFocusFromKeyboard(self) -> bool
8942 Can this window be given focus by keyboard navigation? if not, the
8943 only way to give it focus (provided it accepts it at all) is to click
8946 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
8948 def GetDefaultItem(*args
, **kwargs
):
8950 GetDefaultItem(self) -> Window
8952 Get the default child of this parent, i.e. the one which is activated
8953 by pressing <Enter> such as the OK button on a wx.Dialog.
8955 return _core_
.Window_GetDefaultItem(*args
, **kwargs
)
8957 def SetDefaultItem(*args
, **kwargs
):
8959 SetDefaultItem(self, Window child) -> Window
8961 Set this child as default, return the old default.
8963 return _core_
.Window_SetDefaultItem(*args
, **kwargs
)
8965 def SetTmpDefaultItem(*args
, **kwargs
):
8967 SetTmpDefaultItem(self, Window win)
8969 Set this child as temporary default
8971 return _core_
.Window_SetTmpDefaultItem(*args
, **kwargs
)
8973 def Navigate(*args
, **kwargs
):
8975 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8977 Does keyboard navigation from this window to another, by sending a
8978 `wx.NavigationKeyEvent`.
8980 return _core_
.Window_Navigate(*args
, **kwargs
)
8982 def MoveAfterInTabOrder(*args
, **kwargs
):
8984 MoveAfterInTabOrder(self, Window win)
8986 Moves this window in the tab navigation order after the specified
8987 sibling window. This means that when the user presses the TAB key on
8988 that other window, the focus switches to this window.
8990 The default tab order is the same as creation order. This function
8991 and `MoveBeforeInTabOrder` allow to change it after creating all the
8995 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
8997 def MoveBeforeInTabOrder(*args
, **kwargs
):
8999 MoveBeforeInTabOrder(self, Window win)
9001 Same as `MoveAfterInTabOrder` except that it inserts this window just
9002 before win instead of putting it right after it.
9004 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9006 def GetChildren(*args
, **kwargs
):
9008 GetChildren(self) -> PyObject
9010 Returns a list of the window's children. NOTE: Currently this is a
9011 copy of the child window list maintained by the window, so the return
9012 value of this function is only valid as long as the window's children
9015 return _core_
.Window_GetChildren(*args
, **kwargs
)
9017 def GetParent(*args
, **kwargs
):
9019 GetParent(self) -> Window
9021 Returns the parent window of this window, or None if there isn't one.
9023 return _core_
.Window_GetParent(*args
, **kwargs
)
9025 def GetGrandParent(*args
, **kwargs
):
9027 GetGrandParent(self) -> Window
9029 Returns the parent of the parent of this window, or None if there
9032 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9034 def IsTopLevel(*args
, **kwargs
):
9036 IsTopLevel(self) -> bool
9038 Returns true if the given window is a top-level one. Currently all
9039 frames and dialogs are always considered to be top-level windows (even
9040 if they have a parent window).
9042 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9044 def Reparent(*args
, **kwargs
):
9046 Reparent(self, Window newParent) -> bool
9048 Reparents the window, i.e the window will be removed from its current
9049 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9050 re-inserted into another. Available on Windows and GTK. Returns True
9051 if the parent was changed, False otherwise (error or newParent ==
9054 return _core_
.Window_Reparent(*args
, **kwargs
)
9056 def AddChild(*args
, **kwargs
):
9058 AddChild(self, Window child)
9060 Adds a child window. This is called automatically by window creation
9061 functions so should not be required by the application programmer.
9063 return _core_
.Window_AddChild(*args
, **kwargs
)
9065 def RemoveChild(*args
, **kwargs
):
9067 RemoveChild(self, Window child)
9069 Removes a child window. This is called automatically by window
9070 deletion functions so should not be required by the application
9073 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9075 def FindWindowById(*args
, **kwargs
):
9077 FindWindowById(self, long winid) -> Window
9079 Find a chld of this window by window ID
9081 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9083 def FindWindowByName(*args
, **kwargs
):
9085 FindWindowByName(self, String name) -> Window
9087 Find a child of this window by name
9089 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9091 def GetEventHandler(*args
, **kwargs
):
9093 GetEventHandler(self) -> EvtHandler
9095 Returns the event handler for this window. By default, the window is
9096 its own event handler.
9098 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9100 def SetEventHandler(*args
, **kwargs
):
9102 SetEventHandler(self, EvtHandler handler)
9104 Sets the event handler for this window. An event handler is an object
9105 that is capable of processing the events sent to a window. By default,
9106 the window is its own event handler, but an application may wish to
9107 substitute another, for example to allow central implementation of
9108 event-handling for a variety of different window classes.
9110 It is usually better to use `wx.Window.PushEventHandler` since this sets
9111 up a chain of event handlers, where an event not handled by one event
9112 handler is handed to the next one in the chain.
9114 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9116 def PushEventHandler(*args
, **kwargs
):
9118 PushEventHandler(self, EvtHandler handler)
9120 Pushes this event handler onto the event handler stack for the window.
9121 An event handler is an object that is capable of processing the events
9122 sent to a window. By default, the window is its own event handler, but
9123 an application may wish to substitute another, for example to allow
9124 central implementation of event-handling for a variety of different
9127 wx.Window.PushEventHandler allows an application to set up a chain of
9128 event handlers, where an event not handled by one event handler is
9129 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
9130 remove the event handler.
9132 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9134 def PopEventHandler(*args
, **kwargs
):
9136 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9138 Removes and returns the top-most event handler on the event handler
9139 stack. If deleteHandler is True then the wx.EvtHandler object will be
9140 destroyed after it is popped.
9142 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9144 def RemoveEventHandler(*args
, **kwargs
):
9146 RemoveEventHandler(self, EvtHandler handler) -> bool
9148 Find the given handler in the event handler chain and remove (but not
9149 delete) it from the event handler chain, return True if it was found
9150 and False otherwise (this also results in an assert failure so this
9151 function should only be called when the handler is supposed to be
9154 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9156 def SetValidator(*args
, **kwargs
):
9158 SetValidator(self, Validator validator)
9160 Deletes the current validator (if any) and sets the window validator,
9161 having called wx.Validator.Clone to create a new validator of this
9164 return _core_
.Window_SetValidator(*args
, **kwargs
)
9166 def GetValidator(*args
, **kwargs
):
9168 GetValidator(self) -> Validator
9170 Returns a pointer to the current validator for the window, or None if
9173 return _core_
.Window_GetValidator(*args
, **kwargs
)
9175 def Validate(*args
, **kwargs
):
9177 Validate(self) -> bool
9179 Validates the current values of the child controls using their
9180 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9181 style flag set, the method will also call Validate() of all child
9182 windows. Returns false if any of the validations failed.
9184 return _core_
.Window_Validate(*args
, **kwargs
)
9186 def TransferDataToWindow(*args
, **kwargs
):
9188 TransferDataToWindow(self) -> bool
9190 Transfers values to child controls from data areas specified by their
9191 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9192 style flag set, the method will also call TransferDataToWindow() of
9195 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9197 def TransferDataFromWindow(*args
, **kwargs
):
9199 TransferDataFromWindow(self) -> bool
9201 Transfers values from child controls to data areas specified by their
9202 validators. Returns false if a transfer failed. If the window has
9203 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9204 also call TransferDataFromWindow() of all child windows.
9206 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9208 def InitDialog(*args
, **kwargs
):
9212 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9213 to the dialog via validators.
9215 return _core_
.Window_InitDialog(*args
, **kwargs
)
9217 def SetAcceleratorTable(*args
, **kwargs
):
9219 SetAcceleratorTable(self, AcceleratorTable accel)
9221 Sets the accelerator table for this window.
9223 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9225 def GetAcceleratorTable(*args
, **kwargs
):
9227 GetAcceleratorTable(self) -> AcceleratorTable
9229 Gets the accelerator table for this window.
9231 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9233 def RegisterHotKey(*args
, **kwargs
):
9235 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9237 Registers a system wide hotkey. Every time the user presses the hotkey
9238 registered here, this window will receive a hotkey event. It will
9239 receive the event even if the application is in the background and
9240 does not have the input focus because the user is working with some
9241 other application. To bind an event handler function to this hotkey
9242 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9243 hotkey was registered successfully.
9245 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9247 def UnregisterHotKey(*args
, **kwargs
):
9249 UnregisterHotKey(self, int hotkeyId) -> bool
9251 Unregisters a system wide hotkey.
9253 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9255 def ConvertDialogPointToPixels(*args
, **kwargs
):
9257 ConvertDialogPointToPixels(self, Point pt) -> Point
9259 Converts a point or size from dialog units to pixels. Dialog units
9260 are used for maintaining a dialog's proportions even if the font
9261 changes. For the x dimension, the dialog units are multiplied by the
9262 average character width and then divided by 4. For the y dimension,
9263 the dialog units are multiplied by the average character height and
9266 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9268 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9270 ConvertDialogSizeToPixels(self, Size sz) -> Size
9272 Converts a point or size from dialog units to pixels. Dialog units
9273 are used for maintaining a dialog's proportions even if the font
9274 changes. For the x dimension, the dialog units are multiplied by the
9275 average character width and then divided by 4. For the y dimension,
9276 the dialog units are multiplied by the average character height and
9279 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9281 def DLG_PNT(*args
, **kwargs
):
9283 DLG_PNT(self, Point pt) -> Point
9285 Converts a point or size from dialog units to pixels. Dialog units
9286 are used for maintaining a dialog's proportions even if the font
9287 changes. For the x dimension, the dialog units are multiplied by the
9288 average character width and then divided by 4. For the y dimension,
9289 the dialog units are multiplied by the average character height and
9292 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9294 def DLG_SZE(*args
, **kwargs
):
9296 DLG_SZE(self, Size sz) -> Size
9298 Converts a point or size from dialog units to pixels. Dialog units
9299 are used for maintaining a dialog's proportions even if the font
9300 changes. For the x dimension, the dialog units are multiplied by the
9301 average character width and then divided by 4. For the y dimension,
9302 the dialog units are multiplied by the average character height and
9305 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9307 def ConvertPixelPointToDialog(*args
, **kwargs
):
9308 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9309 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9311 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9312 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9313 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9315 def WarpPointer(*args
, **kwargs
):
9317 WarpPointer(self, int x, int y)
9319 Moves the pointer to the given position on the window.
9321 NOTE: This function is not supported under Mac because Apple Human
9322 Interface Guidelines forbid moving the mouse cursor programmatically.
9324 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9326 def CaptureMouse(*args
, **kwargs
):
9330 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9331 release the capture.
9333 Note that wxWindows maintains the stack of windows having captured the
9334 mouse and when the mouse is released the capture returns to the window
9335 which had had captured it previously and it is only really released if
9336 there were no previous window. In particular, this means that you must
9337 release the mouse as many times as you capture it.
9339 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9341 def ReleaseMouse(*args
, **kwargs
):
9345 Releases mouse input captured with wx.Window.CaptureMouse.
9347 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9349 def GetCapture(*args
, **kwargs
):
9351 GetCapture() -> Window
9353 Returns the window which currently captures the mouse or None
9355 return _core_
.Window_GetCapture(*args
, **kwargs
)
9357 GetCapture
= staticmethod(GetCapture
)
9358 def HasCapture(*args
, **kwargs
):
9360 HasCapture(self) -> bool
9362 Returns true if this window has the current mouse capture.
9364 return _core_
.Window_HasCapture(*args
, **kwargs
)
9366 def Refresh(*args
, **kwargs
):
9368 Refresh(self, bool eraseBackground=True, Rect rect=None)
9370 Mark the specified rectangle (or the whole window) as "dirty" so it
9371 will be repainted. Causes an EVT_PAINT event to be generated and sent
9374 return _core_
.Window_Refresh(*args
, **kwargs
)
9376 def RefreshRect(*args
, **kwargs
):
9378 RefreshRect(self, Rect rect, bool eraseBackground=True)
9380 Redraws the contents of the given rectangle: the area inside it will
9381 be repainted. This is the same as Refresh but has a nicer syntax.
9383 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9385 def Update(*args
, **kwargs
):
9389 Calling this method immediately repaints the invalidated area of the
9390 window instead of waiting for the EVT_PAINT event to happen, (normally
9391 this would usually only happen when the flow of control returns to the
9392 event loop.) Notice that this function doesn't refresh the window and
9393 does nothing if the window has been already repainted. Use Refresh
9394 first if you want to immediately redraw the window (or some portion of
9395 it) unconditionally.
9397 return _core_
.Window_Update(*args
, **kwargs
)
9399 def ClearBackground(*args
, **kwargs
):
9401 ClearBackground(self)
9403 Clears the window by filling it with the current background
9404 colour. Does not cause an erase background event to be generated.
9406 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9408 def Freeze(*args
, **kwargs
):
9412 Freezes the window or, in other words, prevents any updates from
9413 taking place on screen, the window is not redrawn at all. Thaw must be
9414 called to reenable window redrawing. Calls to Freeze/Thaw may be
9415 nested, with the actual Thaw being delayed until all the nesting has
9418 This method is useful for visual appearance optimization (for example,
9419 it is a good idea to use it before inserting large amount of text into
9420 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9421 for all controls so it is mostly just a hint to wxWindows and not a
9422 mandatory directive.
9424 return _core_
.Window_Freeze(*args
, **kwargs
)
9426 def Thaw(*args
, **kwargs
):
9430 Reenables window updating after a previous call to Freeze. Calls to
9431 Freeze/Thaw may be nested, so Thaw must be called the same number of
9432 times that Freeze was before the window will be updated.
9434 return _core_
.Window_Thaw(*args
, **kwargs
)
9436 def PrepareDC(*args
, **kwargs
):
9438 PrepareDC(self, DC dc)
9440 Call this function to prepare the device context for drawing a
9441 scrolled image. It sets the device origin according to the current
9444 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9446 def GetUpdateRegion(*args
, **kwargs
):
9448 GetUpdateRegion(self) -> Region
9450 Returns the region specifying which parts of the window have been
9451 damaged. Should only be called within an EVT_PAINT handler.
9453 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9455 def GetUpdateClientRect(*args
, **kwargs
):
9457 GetUpdateClientRect(self) -> Rect
9459 Get the update rectangle region bounding box in client coords.
9461 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9463 def IsExposed(*args
, **kwargs
):
9465 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9467 Returns true if the given point or rectangle area has been exposed
9468 since the last repaint. Call this in an paint event handler to
9469 optimize redrawing by only redrawing those areas, which have been
9472 return _core_
.Window_IsExposed(*args
, **kwargs
)
9474 def IsExposedPoint(*args
, **kwargs
):
9476 IsExposedPoint(self, Point pt) -> bool
9478 Returns true if the given point or rectangle area has been exposed
9479 since the last repaint. Call this in an paint event handler to
9480 optimize redrawing by only redrawing those areas, which have been
9483 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9485 def IsExposedRect(*args
, **kwargs
):
9487 IsExposedRect(self, Rect rect) -> bool
9489 Returns true if the given point or rectangle area has been exposed
9490 since the last repaint. Call this in an paint event handler to
9491 optimize redrawing by only redrawing those areas, which have been
9494 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9496 def GetDefaultAttributes(*args
, **kwargs
):
9498 GetDefaultAttributes(self) -> VisualAttributes
9500 Get the default attributes for an instance of this class. This is
9501 useful if you want to use the same font or colour in your own control
9502 as in a standard control -- which is a much better idea than hard
9503 coding specific colours or fonts which might look completely out of
9504 place on the user's system, especially if it uses themes.
9506 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9508 def GetClassDefaultAttributes(*args
, **kwargs
):
9510 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9512 Get the default attributes for this class. This is useful if you want
9513 to use the same font or colour in your own control as in a standard
9514 control -- which is a much better idea than hard coding specific
9515 colours or fonts which might look completely out of place on the
9516 user's system, especially if it uses themes.
9518 The variant parameter is only relevant under Mac currently and is
9519 ignore under other platforms. Under Mac, it will change the size of
9520 the returned font. See `wx.Window.SetWindowVariant` for more about
9523 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9525 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9526 def SetBackgroundColour(*args
, **kwargs
):
9528 SetBackgroundColour(self, Colour colour) -> bool
9530 Sets the background colour of the window. Returns True if the colour
9531 was changed. The background colour is usually painted by the default
9532 EVT_ERASE_BACKGROUND event handler function under Windows and
9533 automatically under GTK. Using `wx.NullColour` will reset the window
9534 to the default background colour.
9536 Note that setting the background colour may not cause an immediate
9537 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9538 calling this function.
9540 Using this function will disable attempts to use themes for this
9541 window, if the system supports them. Use with care since usually the
9542 themes represent the appearance chosen by the user to be used for all
9543 applications on the system.
9545 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9547 def SetOwnBackgroundColour(*args
, **kwargs
):
9548 """SetOwnBackgroundColour(self, Colour colour)"""
9549 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9551 def SetForegroundColour(*args
, **kwargs
):
9553 SetForegroundColour(self, Colour colour) -> bool
9555 Sets the foreground colour of the window. Returns True is the colour
9556 was changed. The interpretation of foreground colour is dependent on
9557 the window class; it may be the text colour or other colour, or it may
9560 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9562 def SetOwnForegroundColour(*args
, **kwargs
):
9563 """SetOwnForegroundColour(self, Colour colour)"""
9564 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9566 def GetBackgroundColour(*args
, **kwargs
):
9568 GetBackgroundColour(self) -> Colour
9570 Returns the background colour of the window.
9572 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9574 def GetForegroundColour(*args
, **kwargs
):
9576 GetForegroundColour(self) -> Colour
9578 Returns the foreground colour of the window. The interpretation of
9579 foreground colour is dependent on the window class; it may be the text
9580 colour or other colour, or it may not be used at all.
9582 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9584 def InheritsBackgroundColour(*args
, **kwargs
):
9585 """InheritsBackgroundColour(self) -> bool"""
9586 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9588 def UseBgCol(*args
, **kwargs
):
9589 """UseBgCol(self) -> bool"""
9590 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9592 def SetBackgroundStyle(*args
, **kwargs
):
9594 SetBackgroundStyle(self, int style) -> bool
9596 Returns the background style of the window. The background style
9597 indicates how the background of the window is drawn.
9599 ====================== ========================================
9600 wx.BG_STYLE_SYSTEM The background colour or pattern should
9601 be determined by the system
9602 wx.BG_STYLE_COLOUR The background should be a solid colour
9603 wx.BG_STYLE_CUSTOM The background will be implemented by the
9605 ====================== ========================================
9607 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9608 a custom background, such as a tiled bitmap. Currently the style has
9609 no effect on other platforms.
9611 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9613 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9615 def GetBackgroundStyle(*args
, **kwargs
):
9617 GetBackgroundStyle(self) -> int
9619 Returns the background style of the window.
9621 :see: `SetBackgroundStyle`
9623 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9625 def HasTransparentBackground(*args
, **kwargs
):
9627 HasTransparentBackground(self) -> bool
9629 Returns True if this window's background is transparent (as, for
9630 example, for `wx.StaticText`) and should show the parent window's
9633 This method is mostly used internally by the library itself and you
9634 normally shouldn't have to call it. You may, however, have to override
9635 it in your custom control classes to ensure that background is painted
9638 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9640 def SetCursor(*args
, **kwargs
):
9642 SetCursor(self, Cursor cursor) -> bool
9644 Sets the window's cursor. Notice that the window cursor also sets it
9645 for the children of the window implicitly.
9647 The cursor may be wx.NullCursor in which case the window cursor will
9648 be reset back to default.
9650 return _core_
.Window_SetCursor(*args
, **kwargs
)
9652 def GetCursor(*args
, **kwargs
):
9654 GetCursor(self) -> Cursor
9656 Return the cursor associated with this window.
9658 return _core_
.Window_GetCursor(*args
, **kwargs
)
9660 def SetFont(*args
, **kwargs
):
9662 SetFont(self, Font font) -> bool
9664 Sets the font for this window.
9666 return _core_
.Window_SetFont(*args
, **kwargs
)
9668 def SetOwnFont(*args
, **kwargs
):
9669 """SetOwnFont(self, Font font)"""
9670 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9672 def GetFont(*args
, **kwargs
):
9674 GetFont(self) -> Font
9676 Returns the default font used for this window.
9678 return _core_
.Window_GetFont(*args
, **kwargs
)
9680 def SetCaret(*args
, **kwargs
):
9682 SetCaret(self, Caret caret)
9684 Sets the caret associated with the window.
9686 return _core_
.Window_SetCaret(*args
, **kwargs
)
9688 def GetCaret(*args
, **kwargs
):
9690 GetCaret(self) -> Caret
9692 Returns the caret associated with the window.
9694 return _core_
.Window_GetCaret(*args
, **kwargs
)
9696 def GetCharHeight(*args
, **kwargs
):
9698 GetCharHeight(self) -> int
9700 Get the (average) character size for the current font.
9702 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9704 def GetCharWidth(*args
, **kwargs
):
9706 GetCharWidth(self) -> int
9708 Get the (average) character size for the current font.
9710 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9712 def GetTextExtent(*args
, **kwargs
):
9714 GetTextExtent(String string) -> (width, height)
9716 Get the width and height of the text using the current font.
9718 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9720 def GetFullTextExtent(*args
, **kwargs
):
9722 GetFullTextExtent(String string, Font font=None) ->
9723 (width, height, descent, externalLeading)
9725 Get the width, height, decent and leading of the text using the
9726 current or specified font.
9728 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9730 def ClientToScreenXY(*args
, **kwargs
):
9732 ClientToScreenXY(int x, int y) -> (x,y)
9734 Converts to screen coordinates from coordinates relative to this window.
9736 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9738 def ScreenToClientXY(*args
, **kwargs
):
9740 ScreenToClientXY(int x, int y) -> (x,y)
9742 Converts from screen to client window coordinates.
9744 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9746 def ClientToScreen(*args
, **kwargs
):
9748 ClientToScreen(self, Point pt) -> Point
9750 Converts to screen coordinates from coordinates relative to this window.
9752 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9754 def ScreenToClient(*args
, **kwargs
):
9756 ScreenToClient(self, Point pt) -> Point
9758 Converts from screen to client window coordinates.
9760 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9762 def HitTestXY(*args
, **kwargs
):
9764 HitTestXY(self, int x, int y) -> int
9766 Test where the given (in client coords) point lies
9768 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9770 def HitTest(*args
, **kwargs
):
9772 HitTest(self, Point pt) -> int
9774 Test where the given (in client coords) point lies
9776 return _core_
.Window_HitTest(*args
, **kwargs
)
9778 def GetBorder(*args
):
9780 GetBorder(self, long flags) -> int
9781 GetBorder(self) -> int
9783 Get border for the flags of this window
9785 return _core_
.Window_GetBorder(*args
)
9787 def UpdateWindowUI(*args
, **kwargs
):
9789 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9791 This function sends EVT_UPDATE_UI events to the window. The particular
9792 implementation depends on the window; for example a wx.ToolBar will
9793 send an update UI event for each toolbar button, and a wx.Frame will
9794 send an update UI event for each menubar menu item. You can call this
9795 function from your application to ensure that your UI is up-to-date at
9796 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9797 concerned). This may be necessary if you have called
9798 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9799 limit the overhead that wxWindows incurs by sending update UI events
9802 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9804 def PopupMenuXY(*args
, **kwargs
):
9806 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9808 Pops up the given menu at the specified coordinates, relative to this window,
9809 and returns control when the user has dismissed the menu. If a menu item is
9810 selected, the corresponding menu event is generated and will be processed as
9811 usual. If the default position is given then the current position of the
9812 mouse cursor will be used.
9814 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9816 def PopupMenu(*args
, **kwargs
):
9818 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9820 Pops up the given menu at the specified coordinates, relative to this window,
9821 and returns control when the user has dismissed the menu. If a menu item is
9822 selected, the corresponding menu event is generated and will be processed as
9823 usual. If the default position is given then the current position of the
9824 mouse cursor will be used.
9826 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9828 def GetHandle(*args
, **kwargs
):
9830 GetHandle(self) -> long
9832 Returns the platform-specific handle (as a long integer) of the
9833 physical window. Currently on wxMac it returns the handle of the
9834 toplevel parent of the window.
9836 return _core_
.Window_GetHandle(*args
, **kwargs
)
9838 def AssociateHandle(*args
, **kwargs
):
9840 AssociateHandle(self, long handle)
9842 Associate the window with a new native handle
9844 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9846 def DissociateHandle(*args
, **kwargs
):
9848 DissociateHandle(self)
9850 Dissociate the current native handle from the window
9852 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9854 def HasScrollbar(*args
, **kwargs
):
9856 HasScrollbar(self, int orient) -> bool
9858 Does the window have the scrollbar for this orientation?
9860 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9862 def SetScrollbar(*args
, **kwargs
):
9864 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9867 Sets the scrollbar properties of a built-in scrollbar.
9869 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9871 def SetScrollPos(*args
, **kwargs
):
9873 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9875 Sets the position of one of the built-in scrollbars.
9877 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9879 def GetScrollPos(*args
, **kwargs
):
9881 GetScrollPos(self, int orientation) -> int
9883 Returns the built-in scrollbar position.
9885 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9887 def GetScrollThumb(*args
, **kwargs
):
9889 GetScrollThumb(self, int orientation) -> int
9891 Returns the built-in scrollbar thumb size.
9893 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9895 def GetScrollRange(*args
, **kwargs
):
9897 GetScrollRange(self, int orientation) -> int
9899 Returns the built-in scrollbar range.
9901 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9903 def ScrollWindow(*args
, **kwargs
):
9905 ScrollWindow(self, int dx, int dy, Rect rect=None)
9907 Physically scrolls the pixels in the window and move child windows
9908 accordingly. Use this function to optimise your scrolling
9909 implementations, to minimise the area that must be redrawn. Note that
9910 it is rarely required to call this function from a user program.
9912 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9914 def ScrollLines(*args
, **kwargs
):
9916 ScrollLines(self, int lines) -> bool
9918 If the platform and window class supports it, scrolls the window by
9919 the given number of lines down, if lines is positive, or up if lines
9920 is negative. Returns True if the window was scrolled, False if it was
9921 already on top/bottom and nothing was done.
9923 return _core_
.Window_ScrollLines(*args
, **kwargs
)
9925 def ScrollPages(*args
, **kwargs
):
9927 ScrollPages(self, int pages) -> bool
9929 If the platform and window class supports it, scrolls the window by
9930 the given number of pages down, if pages is positive, or up if pages
9931 is negative. Returns True if the window was scrolled, False if it was
9932 already on top/bottom and nothing was done.
9934 return _core_
.Window_ScrollPages(*args
, **kwargs
)
9936 def LineUp(*args
, **kwargs
):
9938 LineUp(self) -> bool
9940 This is just a wrapper for ScrollLines(-1).
9942 return _core_
.Window_LineUp(*args
, **kwargs
)
9944 def LineDown(*args
, **kwargs
):
9946 LineDown(self) -> bool
9948 This is just a wrapper for ScrollLines(1).
9950 return _core_
.Window_LineDown(*args
, **kwargs
)
9952 def PageUp(*args
, **kwargs
):
9954 PageUp(self) -> bool
9956 This is just a wrapper for ScrollPages(-1).
9958 return _core_
.Window_PageUp(*args
, **kwargs
)
9960 def PageDown(*args
, **kwargs
):
9962 PageDown(self) -> bool
9964 This is just a wrapper for ScrollPages(1).
9966 return _core_
.Window_PageDown(*args
, **kwargs
)
9968 def SetHelpText(*args
, **kwargs
):
9970 SetHelpText(self, String text)
9972 Sets the help text to be used as context-sensitive help for this
9973 window. Note that the text is actually stored by the current
9974 wxHelpProvider implementation, and not in the window object itself.
9976 return _core_
.Window_SetHelpText(*args
, **kwargs
)
9978 def SetHelpTextForId(*args
, **kwargs
):
9980 SetHelpTextForId(self, String text)
9982 Associate this help text with all windows with the same id as this
9985 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
9987 def GetHelpText(*args
, **kwargs
):
9989 GetHelpText(self) -> String
9991 Gets the help text to be used as context-sensitive help for this
9992 window. Note that the text is actually stored by the current
9993 wxHelpProvider implementation, and not in the window object itself.
9995 return _core_
.Window_GetHelpText(*args
, **kwargs
)
9997 def SetToolTipString(*args
, **kwargs
):
9999 SetToolTipString(self, String tip)
10001 Attach a tooltip to the window.
10003 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10005 def SetToolTip(*args
, **kwargs
):
10007 SetToolTip(self, ToolTip tip)
10009 Attach a tooltip to the window.
10011 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10013 def GetToolTip(*args
, **kwargs
):
10015 GetToolTip(self) -> ToolTip
10017 get the associated tooltip or None if none
10019 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10021 def SetDropTarget(*args
, **kwargs
):
10023 SetDropTarget(self, DropTarget dropTarget)
10025 Associates a drop target with this window. If the window already has
10026 a drop target, it is deleted.
10028 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10030 def GetDropTarget(*args
, **kwargs
):
10032 GetDropTarget(self) -> DropTarget
10034 Returns the associated drop target, which may be None.
10036 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10038 def DragAcceptFiles(*args
, **kwargs
):
10040 DragAcceptFiles(self, bool accept)
10042 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10043 Only functional on Windows.
10045 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10047 def SetConstraints(*args
, **kwargs
):
10049 SetConstraints(self, LayoutConstraints constraints)
10051 Sets the window to have the given layout constraints. If an existing
10052 layout constraints object is already owned by the window, it will be
10053 deleted. Pass None to disassociate and delete the window's current
10056 You must call SetAutoLayout to tell a window to use the constraints
10057 automatically in its default EVT_SIZE handler; otherwise, you must
10058 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10059 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10062 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10064 def GetConstraints(*args
, **kwargs
):
10066 GetConstraints(self) -> LayoutConstraints
10068 Returns a pointer to the window's layout constraints, or None if there
10071 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10073 def SetAutoLayout(*args
, **kwargs
):
10075 SetAutoLayout(self, bool autoLayout)
10077 Determines whether the Layout function will be called automatically
10078 when the window is resized. lease note that this only happens for the
10079 windows usually used to contain children, namely `wx.Panel` and
10080 `wx.TopLevelWindow` (and the classes deriving from them).
10082 This method is called implicitly by `SetSizer` but if you use
10083 `SetConstraints` you should call it manually or otherwise the window
10084 layout won't be correctly updated when its size changes.
10086 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10088 def GetAutoLayout(*args
, **kwargs
):
10090 GetAutoLayout(self) -> bool
10092 Returns the current autoLayout setting
10094 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10096 def Layout(*args
, **kwargs
):
10098 Layout(self) -> bool
10100 Invokes the constraint-based layout algorithm or the sizer-based
10101 algorithm for this window. See SetAutoLayout: when auto layout is on,
10102 this function gets called automatically by the default EVT_SIZE
10103 handler when the window is resized.
10105 return _core_
.Window_Layout(*args
, **kwargs
)
10107 def SetSizer(*args
, **kwargs
):
10109 SetSizer(self, Sizer sizer, bool deleteOld=True)
10111 Sets the window to have the given layout sizer. The window will then
10112 own the object, and will take care of its deletion. If an existing
10113 layout sizer object is already owned by the window, it will be deleted
10114 if the deleteOld parameter is true. Note that this function will also
10115 call SetAutoLayout implicitly with a True parameter if the sizer is
10116 non-None, and False otherwise.
10118 return _core_
.Window_SetSizer(*args
, **kwargs
)
10120 def SetSizerAndFit(*args
, **kwargs
):
10122 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10124 The same as SetSizer, except it also sets the size hints for the
10125 window based on the sizer's minimum size.
10127 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10129 def GetSizer(*args
, **kwargs
):
10131 GetSizer(self) -> Sizer
10133 Return the sizer associated with the window by a previous call to
10134 SetSizer or None if there isn't one.
10136 return _core_
.Window_GetSizer(*args
, **kwargs
)
10138 def SetContainingSizer(*args
, **kwargs
):
10140 SetContainingSizer(self, Sizer sizer)
10142 This normally does not need to be called by application code. It is
10143 called internally when a window is added to a sizer, and is used so
10144 the window can remove itself from the sizer when it is destroyed.
10146 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10148 def GetContainingSizer(*args
, **kwargs
):
10150 GetContainingSizer(self) -> Sizer
10152 Return the sizer that this window is a member of, if any, otherwise None.
10154 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10156 def InheritAttributes(*args
, **kwargs
):
10158 InheritAttributes(self)
10160 This function is (or should be, in case of custom controls) called
10161 during window creation to intelligently set up the window visual
10162 attributes, that is the font and the foreground and background
10165 By 'intelligently' the following is meant: by default, all windows use
10166 their own default attributes. However if some of the parent's
10167 attributes are explicitly changed (that is, using SetFont and not
10168 SetOwnFont) and if the corresponding attribute hadn't been
10169 explicitly set for this window itself, then this window takes the same
10170 value as used by the parent. In addition, if the window overrides
10171 ShouldInheritColours to return false, the colours will not be changed
10172 no matter what and only the font might.
10174 This rather complicated logic is necessary in order to accommodate the
10175 different usage scenarios. The most common one is when all default
10176 attributes are used and in this case, nothing should be inherited as
10177 in modern GUIs different controls use different fonts (and colours)
10178 than their siblings so they can't inherit the same value from the
10179 parent. However it was also deemed desirable to allow to simply change
10180 the attributes of all children at once by just changing the font or
10181 colour of their common parent, hence in this case we do inherit the
10182 parents attributes.
10185 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10187 def ShouldInheritColours(*args
, **kwargs
):
10189 ShouldInheritColours(self) -> bool
10191 Return true from here to allow the colours of this window to be
10192 changed by InheritAttributes, returning false forbids inheriting them
10193 from the parent window.
10195 The base class version returns false, but this method is overridden in
10196 wxControl where it returns true.
10198 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10200 def PostCreate(self
, pre
):
10202 Phase 3 of the 2-phase create <wink!>
10203 Call this method after precreating the window with the 2-phase create method.
10205 self
.this
= pre
.this
10206 self
.thisown
= pre
.thisown
10208 if hasattr(self
, '_setOORInfo'):
10209 self
._setOORInfo
(self
)
10210 if hasattr(self
, '_setCallbackInfo'):
10211 self
._setCallbackInfo
(self
, self
.__class
__)
10213 def SendSizeEvent(self
):
10214 self
.GetEventhandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10217 class WindowPtr(Window
):
10218 def __init__(self
, this
):
10220 if not hasattr(self
,"thisown"): self
.thisown
= 0
10221 self
.__class
__ = Window
10222 _core_
.Window_swigregister(WindowPtr
)
10224 def PreWindow(*args
, **kwargs
):
10226 PreWindow() -> Window
10228 Precreate a Window for 2-phase creation.
10230 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10234 def Window_NewControlId(*args
, **kwargs
):
10236 Window_NewControlId() -> int
10238 Generate a control id for the controls which were not given one.
10240 return _core_
.Window_NewControlId(*args
, **kwargs
)
10242 def Window_NextControlId(*args
, **kwargs
):
10244 Window_NextControlId(int winid) -> int
10246 Get the id of the control following the one with the given
10249 return _core_
.Window_NextControlId(*args
, **kwargs
)
10251 def Window_PrevControlId(*args
, **kwargs
):
10253 Window_PrevControlId(int winid) -> int
10255 Get the id of the control preceding the one with the given
10258 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10260 def Window_FindFocus(*args
, **kwargs
):
10262 Window_FindFocus() -> Window
10264 Returns the window or control that currently has the keyboard focus,
10267 return _core_
.Window_FindFocus(*args
, **kwargs
)
10269 def Window_GetCapture(*args
, **kwargs
):
10271 Window_GetCapture() -> Window
10273 Returns the window which currently captures the mouse or None
10275 return _core_
.Window_GetCapture(*args
, **kwargs
)
10277 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10279 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10281 Get the default attributes for this class. This is useful if you want
10282 to use the same font or colour in your own control as in a standard
10283 control -- which is a much better idea than hard coding specific
10284 colours or fonts which might look completely out of place on the
10285 user's system, especially if it uses themes.
10287 The variant parameter is only relevant under Mac currently and is
10288 ignore under other platforms. Under Mac, it will change the size of
10289 the returned font. See `wx.Window.SetWindowVariant` for more about
10292 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10294 def DLG_PNT(win
, point_or_x
, y
=None):
10296 Convenience function for converting a Point or (x,y) in
10297 dialog units to pixel units.
10300 return win
.ConvertDialogPointToPixels(point_or_x
)
10302 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10304 def DLG_SZE(win
, size_width
, height
=None):
10306 Convenience function for converting a Size or (w,h) in
10307 dialog units to pixel units.
10310 return win
.ConvertDialogSizeToPixels(size_width
)
10312 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10315 def FindWindowById(*args
, **kwargs
):
10317 FindWindowById(long id, Window parent=None) -> Window
10319 Find the first window in the application with the given id. If parent
10320 is None, the search will start from all top-level frames and dialog
10321 boxes; if non-None, the search will be limited to the given window
10322 hierarchy. The search is recursive in both cases.
10324 return _core_
.FindWindowById(*args
, **kwargs
)
10326 def FindWindowByName(*args
, **kwargs
):
10328 FindWindowByName(String name, Window parent=None) -> Window
10330 Find a window by its name (as given in a window constructor or Create
10331 function call). If parent is None, the search will start from all
10332 top-level frames and dialog boxes; if non-None, the search will be
10333 limited to the given window hierarchy. The search is recursive in both
10336 If no window with such name is found, wx.FindWindowByLabel is called.
10338 return _core_
.FindWindowByName(*args
, **kwargs
)
10340 def FindWindowByLabel(*args
, **kwargs
):
10342 FindWindowByLabel(String label, Window parent=None) -> Window
10344 Find a window by its label. Depending on the type of window, the label
10345 may be a window title or panel item label. If parent is None, the
10346 search will start from all top-level frames and dialog boxes; if
10347 non-None, the search will be limited to the given window
10348 hierarchy. The search is recursive in both cases.
10350 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10352 def Window_FromHWND(*args
, **kwargs
):
10353 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10354 return _core_
.Window_FromHWND(*args
, **kwargs
)
10356 def GetTopLevelWindows(*args
, **kwargs
):
10358 GetTopLevelWindows() -> PyObject
10360 Returns a list of the the application's top-level windows, (frames,
10361 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10362 by wxWidgets, and so it is only valid as long as no top-level windows
10363 are closed or new top-level windows are created.
10366 return _core_
.GetTopLevelWindows(*args
, **kwargs
)
10367 #---------------------------------------------------------------------------
10369 class Validator(EvtHandler
):
10370 """Proxy of C++ Validator class"""
10371 def __repr__(self
):
10372 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
10373 def __init__(self
, *args
, **kwargs
):
10374 """__init__(self) -> Validator"""
10375 newobj
= _core_
.new_Validator(*args
, **kwargs
)
10376 self
.this
= newobj
.this
10379 self
._setOORInfo
(self
)
10381 def Clone(*args
, **kwargs
):
10382 """Clone(self) -> Validator"""
10383 return _core_
.Validator_Clone(*args
, **kwargs
)
10385 def Validate(*args
, **kwargs
):
10386 """Validate(self, Window parent) -> bool"""
10387 return _core_
.Validator_Validate(*args
, **kwargs
)
10389 def TransferToWindow(*args
, **kwargs
):
10390 """TransferToWindow(self) -> bool"""
10391 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10393 def TransferFromWindow(*args
, **kwargs
):
10394 """TransferFromWindow(self) -> bool"""
10395 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10397 def GetWindow(*args
, **kwargs
):
10398 """GetWindow(self) -> Window"""
10399 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10401 def SetWindow(*args
, **kwargs
):
10402 """SetWindow(self, Window window)"""
10403 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10405 def IsSilent(*args
, **kwargs
):
10406 """IsSilent() -> bool"""
10407 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10409 IsSilent
= staticmethod(IsSilent
)
10410 def SetBellOnError(*args
, **kwargs
):
10411 """SetBellOnError(int doIt=True)"""
10412 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10414 SetBellOnError
= staticmethod(SetBellOnError
)
10416 class ValidatorPtr(Validator
):
10417 def __init__(self
, this
):
10419 if not hasattr(self
,"thisown"): self
.thisown
= 0
10420 self
.__class
__ = Validator
10421 _core_
.Validator_swigregister(ValidatorPtr
)
10423 def Validator_IsSilent(*args
, **kwargs
):
10424 """Validator_IsSilent() -> bool"""
10425 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10427 def Validator_SetBellOnError(*args
, **kwargs
):
10428 """Validator_SetBellOnError(int doIt=True)"""
10429 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10431 class PyValidator(Validator
):
10432 """Proxy of C++ PyValidator class"""
10433 def __repr__(self
):
10434 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
10435 def __init__(self
, *args
, **kwargs
):
10436 """__init__(self) -> PyValidator"""
10437 newobj
= _core_
.new_PyValidator(*args
, **kwargs
)
10438 self
.this
= newobj
.this
10442 self
._setCallbackInfo
(self
, PyValidator
, 1)
10443 self
._setOORInfo
(self
)
10445 def _setCallbackInfo(*args
, **kwargs
):
10446 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10447 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10450 class PyValidatorPtr(PyValidator
):
10451 def __init__(self
, this
):
10453 if not hasattr(self
,"thisown"): self
.thisown
= 0
10454 self
.__class
__ = PyValidator
10455 _core_
.PyValidator_swigregister(PyValidatorPtr
)
10457 #---------------------------------------------------------------------------
10459 class Menu(EvtHandler
):
10460 """Proxy of C++ Menu class"""
10461 def __repr__(self
):
10462 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
10463 def __init__(self
, *args
, **kwargs
):
10464 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10465 newobj
= _core_
.new_Menu(*args
, **kwargs
)
10466 self
.this
= newobj
.this
10469 self
._setOORInfo
(self
)
10471 def Append(*args
, **kwargs
):
10472 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
10473 return _core_
.Menu_Append(*args
, **kwargs
)
10475 def AppendSeparator(*args
, **kwargs
):
10476 """AppendSeparator(self) -> MenuItem"""
10477 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10479 def AppendCheckItem(*args
, **kwargs
):
10480 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10481 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10483 def AppendRadioItem(*args
, **kwargs
):
10484 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10485 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10487 def AppendMenu(*args
, **kwargs
):
10488 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10489 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10491 def AppendItem(*args
, **kwargs
):
10492 """AppendItem(self, MenuItem item) -> MenuItem"""
10493 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10495 def Break(*args
, **kwargs
):
10497 return _core_
.Menu_Break(*args
, **kwargs
)
10499 def InsertItem(*args
, **kwargs
):
10500 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10501 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10503 def Insert(*args
, **kwargs
):
10505 Insert(self, size_t pos, int id, String text, String help=EmptyString,
10506 int kind=ITEM_NORMAL) -> MenuItem
10508 return _core_
.Menu_Insert(*args
, **kwargs
)
10510 def InsertSeparator(*args
, **kwargs
):
10511 """InsertSeparator(self, size_t pos) -> MenuItem"""
10512 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10514 def InsertCheckItem(*args
, **kwargs
):
10515 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10516 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10518 def InsertRadioItem(*args
, **kwargs
):
10519 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10520 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10522 def InsertMenu(*args
, **kwargs
):
10523 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10524 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10526 def PrependItem(*args
, **kwargs
):
10527 """PrependItem(self, MenuItem item) -> MenuItem"""
10528 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10530 def Prepend(*args
, **kwargs
):
10531 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
10532 return _core_
.Menu_Prepend(*args
, **kwargs
)
10534 def PrependSeparator(*args
, **kwargs
):
10535 """PrependSeparator(self) -> MenuItem"""
10536 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10538 def PrependCheckItem(*args
, **kwargs
):
10539 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10540 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10542 def PrependRadioItem(*args
, **kwargs
):
10543 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10544 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10546 def PrependMenu(*args
, **kwargs
):
10547 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10548 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10550 def Remove(*args
, **kwargs
):
10551 """Remove(self, int id) -> MenuItem"""
10552 return _core_
.Menu_Remove(*args
, **kwargs
)
10554 def RemoveItem(*args
, **kwargs
):
10555 """RemoveItem(self, MenuItem item) -> MenuItem"""
10556 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10558 def Delete(*args
, **kwargs
):
10559 """Delete(self, int id) -> bool"""
10560 return _core_
.Menu_Delete(*args
, **kwargs
)
10562 def DeleteItem(*args
, **kwargs
):
10563 """DeleteItem(self, MenuItem item) -> bool"""
10564 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10566 def Destroy(*args
, **kwargs
):
10570 Deletes the C++ object this Python object is a proxy for.
10572 val
= _core_
.Menu_Destroy(*args
, **kwargs
)
10573 args
[0].thisown
= 0
10576 def DestroyId(*args
, **kwargs
):
10578 DestroyId(self, int id) -> bool
10580 Deletes the C++ object this Python object is a proxy for.
10582 val
= _core_
.Menu_DestroyId(*args
, **kwargs
)
10583 args
[0].thisown
= 0
10586 def DestroyItem(*args
, **kwargs
):
10588 DestroyItem(self, MenuItem item) -> bool
10590 Deletes the C++ object this Python object is a proxy for.
10592 val
= _core_
.Menu_DestroyItem(*args
, **kwargs
)
10593 args
[0].thisown
= 0
10596 def GetMenuItemCount(*args
, **kwargs
):
10597 """GetMenuItemCount(self) -> size_t"""
10598 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10600 def GetMenuItems(*args
, **kwargs
):
10601 """GetMenuItems(self) -> PyObject"""
10602 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10604 def FindItem(*args
, **kwargs
):
10605 """FindItem(self, String item) -> int"""
10606 return _core_
.Menu_FindItem(*args
, **kwargs
)
10608 def FindItemById(*args
, **kwargs
):
10609 """FindItemById(self, int id) -> MenuItem"""
10610 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10612 def FindItemByPosition(*args
, **kwargs
):
10613 """FindItemByPosition(self, size_t position) -> MenuItem"""
10614 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10616 def Enable(*args
, **kwargs
):
10617 """Enable(self, int id, bool enable)"""
10618 return _core_
.Menu_Enable(*args
, **kwargs
)
10620 def IsEnabled(*args
, **kwargs
):
10621 """IsEnabled(self, int id) -> bool"""
10622 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10624 def Check(*args
, **kwargs
):
10625 """Check(self, int id, bool check)"""
10626 return _core_
.Menu_Check(*args
, **kwargs
)
10628 def IsChecked(*args
, **kwargs
):
10629 """IsChecked(self, int id) -> bool"""
10630 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10632 def SetLabel(*args
, **kwargs
):
10633 """SetLabel(self, int id, String label)"""
10634 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10636 def GetLabel(*args
, **kwargs
):
10637 """GetLabel(self, int id) -> String"""
10638 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10640 def SetHelpString(*args
, **kwargs
):
10641 """SetHelpString(self, int id, String helpString)"""
10642 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10644 def GetHelpString(*args
, **kwargs
):
10645 """GetHelpString(self, int id) -> String"""
10646 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10648 def SetTitle(*args
, **kwargs
):
10649 """SetTitle(self, String title)"""
10650 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10652 def GetTitle(*args
, **kwargs
):
10653 """GetTitle(self) -> String"""
10654 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10656 def SetEventHandler(*args
, **kwargs
):
10657 """SetEventHandler(self, EvtHandler handler)"""
10658 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10660 def GetEventHandler(*args
, **kwargs
):
10661 """GetEventHandler(self) -> EvtHandler"""
10662 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10664 def SetInvokingWindow(*args
, **kwargs
):
10665 """SetInvokingWindow(self, Window win)"""
10666 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10668 def GetInvokingWindow(*args
, **kwargs
):
10669 """GetInvokingWindow(self) -> Window"""
10670 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10672 def GetStyle(*args
, **kwargs
):
10673 """GetStyle(self) -> long"""
10674 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10676 def UpdateUI(*args
, **kwargs
):
10677 """UpdateUI(self, EvtHandler source=None)"""
10678 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10680 def GetMenuBar(*args
, **kwargs
):
10681 """GetMenuBar(self) -> MenuBar"""
10682 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10684 def Attach(*args
, **kwargs
):
10685 """Attach(self, wxMenuBarBase menubar)"""
10686 return _core_
.Menu_Attach(*args
, **kwargs
)
10688 def Detach(*args
, **kwargs
):
10690 return _core_
.Menu_Detach(*args
, **kwargs
)
10692 def IsAttached(*args
, **kwargs
):
10693 """IsAttached(self) -> bool"""
10694 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10696 def SetParent(*args
, **kwargs
):
10697 """SetParent(self, Menu parent)"""
10698 return _core_
.Menu_SetParent(*args
, **kwargs
)
10700 def GetParent(*args
, **kwargs
):
10701 """GetParent(self) -> Menu"""
10702 return _core_
.Menu_GetParent(*args
, **kwargs
)
10705 class MenuPtr(Menu
):
10706 def __init__(self
, this
):
10708 if not hasattr(self
,"thisown"): self
.thisown
= 0
10709 self
.__class
__ = Menu
10710 _core_
.Menu_swigregister(MenuPtr
)
10711 DefaultValidator
= cvar
.DefaultValidator
10713 #---------------------------------------------------------------------------
10715 class MenuBar(Window
):
10716 """Proxy of C++ MenuBar class"""
10717 def __repr__(self
):
10718 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
10719 def __init__(self
, *args
, **kwargs
):
10720 """__init__(self, long style=0) -> MenuBar"""
10721 newobj
= _core_
.new_MenuBar(*args
, **kwargs
)
10722 self
.this
= newobj
.this
10725 self
._setOORInfo
(self
)
10727 def Append(*args
, **kwargs
):
10728 """Append(self, Menu menu, String title) -> bool"""
10729 return _core_
.MenuBar_Append(*args
, **kwargs
)
10731 def Insert(*args
, **kwargs
):
10732 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10733 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10735 def GetMenuCount(*args
, **kwargs
):
10736 """GetMenuCount(self) -> size_t"""
10737 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10739 def GetMenu(*args
, **kwargs
):
10740 """GetMenu(self, size_t pos) -> Menu"""
10741 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10743 def Replace(*args
, **kwargs
):
10744 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10745 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10747 def Remove(*args
, **kwargs
):
10748 """Remove(self, size_t pos) -> Menu"""
10749 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10751 def EnableTop(*args
, **kwargs
):
10752 """EnableTop(self, size_t pos, bool enable)"""
10753 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10755 def IsEnabledTop(*args
, **kwargs
):
10756 """IsEnabledTop(self, size_t pos) -> bool"""
10757 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10759 def SetLabelTop(*args
, **kwargs
):
10760 """SetLabelTop(self, size_t pos, String label)"""
10761 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10763 def GetLabelTop(*args
, **kwargs
):
10764 """GetLabelTop(self, size_t pos) -> String"""
10765 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10767 def FindMenuItem(*args
, **kwargs
):
10768 """FindMenuItem(self, String menu, String item) -> int"""
10769 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10771 def FindItemById(*args
, **kwargs
):
10772 """FindItemById(self, int id) -> MenuItem"""
10773 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10775 def FindMenu(*args
, **kwargs
):
10776 """FindMenu(self, String title) -> int"""
10777 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10779 def Enable(*args
, **kwargs
):
10780 """Enable(self, int id, bool enable)"""
10781 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10783 def Check(*args
, **kwargs
):
10784 """Check(self, int id, bool check)"""
10785 return _core_
.MenuBar_Check(*args
, **kwargs
)
10787 def IsChecked(*args
, **kwargs
):
10788 """IsChecked(self, int id) -> bool"""
10789 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10791 def IsEnabled(*args
, **kwargs
):
10792 """IsEnabled(self, int id) -> bool"""
10793 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10795 def SetLabel(*args
, **kwargs
):
10796 """SetLabel(self, int id, String label)"""
10797 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10799 def GetLabel(*args
, **kwargs
):
10800 """GetLabel(self, int id) -> String"""
10801 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10803 def SetHelpString(*args
, **kwargs
):
10804 """SetHelpString(self, int id, String helpString)"""
10805 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10807 def GetHelpString(*args
, **kwargs
):
10808 """GetHelpString(self, int id) -> String"""
10809 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10811 def GetFrame(*args
, **kwargs
):
10812 """GetFrame(self) -> wxFrame"""
10813 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10815 def IsAttached(*args
, **kwargs
):
10816 """IsAttached(self) -> bool"""
10817 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10819 def Attach(*args
, **kwargs
):
10820 """Attach(self, wxFrame frame)"""
10821 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10823 def Detach(*args
, **kwargs
):
10825 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10827 def SetAutoWindowMenu(*args
, **kwargs
):
10828 """SetAutoWindowMenu(bool enable)"""
10829 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10831 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10832 def GetAutoWindowMenu(*args
, **kwargs
):
10833 """GetAutoWindowMenu() -> bool"""
10834 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10836 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10838 class MenuBarPtr(MenuBar
):
10839 def __init__(self
, this
):
10841 if not hasattr(self
,"thisown"): self
.thisown
= 0
10842 self
.__class
__ = MenuBar
10843 _core_
.MenuBar_swigregister(MenuBarPtr
)
10845 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
10846 """MenuBar_SetAutoWindowMenu(bool enable)"""
10847 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10849 def MenuBar_GetAutoWindowMenu(*args
, **kwargs
):
10850 """MenuBar_GetAutoWindowMenu() -> bool"""
10851 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10853 #---------------------------------------------------------------------------
10855 class MenuItem(Object
):
10856 """Proxy of C++ MenuItem class"""
10857 def __repr__(self
):
10858 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
10859 def __init__(self
, *args
, **kwargs
):
10861 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10862 String help=EmptyString, int kind=ITEM_NORMAL,
10863 Menu subMenu=None) -> MenuItem
10865 newobj
= _core_
.new_MenuItem(*args
, **kwargs
)
10866 self
.this
= newobj
.this
10869 def GetMenu(*args
, **kwargs
):
10870 """GetMenu(self) -> Menu"""
10871 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
10873 def SetMenu(*args
, **kwargs
):
10874 """SetMenu(self, Menu menu)"""
10875 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
10877 def SetId(*args
, **kwargs
):
10878 """SetId(self, int id)"""
10879 return _core_
.MenuItem_SetId(*args
, **kwargs
)
10881 def GetId(*args
, **kwargs
):
10882 """GetId(self) -> int"""
10883 return _core_
.MenuItem_GetId(*args
, **kwargs
)
10885 def IsSeparator(*args
, **kwargs
):
10886 """IsSeparator(self) -> bool"""
10887 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
10889 def SetText(*args
, **kwargs
):
10890 """SetText(self, String str)"""
10891 return _core_
.MenuItem_SetText(*args
, **kwargs
)
10893 def GetLabel(*args
, **kwargs
):
10894 """GetLabel(self) -> String"""
10895 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
10897 def GetText(*args
, **kwargs
):
10898 """GetText(self) -> String"""
10899 return _core_
.MenuItem_GetText(*args
, **kwargs
)
10901 def GetLabelFromText(*args
, **kwargs
):
10902 """GetLabelFromText(String text) -> String"""
10903 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10905 GetLabelFromText
= staticmethod(GetLabelFromText
)
10906 def GetKind(*args
, **kwargs
):
10907 """GetKind(self) -> int"""
10908 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
10910 def SetKind(*args
, **kwargs
):
10911 """SetKind(self, int kind)"""
10912 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
10914 def SetCheckable(*args
, **kwargs
):
10915 """SetCheckable(self, bool checkable)"""
10916 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
10918 def IsCheckable(*args
, **kwargs
):
10919 """IsCheckable(self) -> bool"""
10920 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
10922 def IsSubMenu(*args
, **kwargs
):
10923 """IsSubMenu(self) -> bool"""
10924 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
10926 def SetSubMenu(*args
, **kwargs
):
10927 """SetSubMenu(self, Menu menu)"""
10928 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
10930 def GetSubMenu(*args
, **kwargs
):
10931 """GetSubMenu(self) -> Menu"""
10932 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
10934 def Enable(*args
, **kwargs
):
10935 """Enable(self, bool enable=True)"""
10936 return _core_
.MenuItem_Enable(*args
, **kwargs
)
10938 def IsEnabled(*args
, **kwargs
):
10939 """IsEnabled(self) -> bool"""
10940 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
10942 def Check(*args
, **kwargs
):
10943 """Check(self, bool check=True)"""
10944 return _core_
.MenuItem_Check(*args
, **kwargs
)
10946 def IsChecked(*args
, **kwargs
):
10947 """IsChecked(self) -> bool"""
10948 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
10950 def Toggle(*args
, **kwargs
):
10952 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
10954 def SetHelp(*args
, **kwargs
):
10955 """SetHelp(self, String str)"""
10956 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
10958 def GetHelp(*args
, **kwargs
):
10959 """GetHelp(self) -> String"""
10960 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
10962 def GetAccel(*args
, **kwargs
):
10963 """GetAccel(self) -> AcceleratorEntry"""
10964 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
10966 def SetAccel(*args
, **kwargs
):
10967 """SetAccel(self, AcceleratorEntry accel)"""
10968 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
10970 def SetBitmap(*args
, **kwargs
):
10971 """SetBitmap(self, Bitmap bitmap)"""
10972 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
10974 def GetBitmap(*args
, **kwargs
):
10975 """GetBitmap(self) -> Bitmap"""
10976 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
10978 def SetFont(*args
, **kwargs
):
10979 """SetFont(self, Font font)"""
10980 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
10982 def GetFont(*args
, **kwargs
):
10983 """GetFont(self) -> Font"""
10984 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
10986 def SetTextColour(*args
, **kwargs
):
10987 """SetTextColour(self, Colour colText)"""
10988 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
10990 def GetTextColour(*args
, **kwargs
):
10991 """GetTextColour(self) -> Colour"""
10992 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
10994 def SetBackgroundColour(*args
, **kwargs
):
10995 """SetBackgroundColour(self, Colour colBack)"""
10996 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
10998 def GetBackgroundColour(*args
, **kwargs
):
10999 """GetBackgroundColour(self) -> Colour"""
11000 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11002 def SetBitmaps(*args
, **kwargs
):
11003 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11004 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11006 def SetDisabledBitmap(*args
, **kwargs
):
11007 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11008 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11010 def GetDisabledBitmap(*args
, **kwargs
):
11011 """GetDisabledBitmap(self) -> Bitmap"""
11012 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11014 def SetMarginWidth(*args
, **kwargs
):
11015 """SetMarginWidth(self, int nWidth)"""
11016 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11018 def GetMarginWidth(*args
, **kwargs
):
11019 """GetMarginWidth(self) -> int"""
11020 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11022 def GetDefaultMarginWidth(*args
, **kwargs
):
11023 """GetDefaultMarginWidth() -> int"""
11024 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11026 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11027 def IsOwnerDrawn(*args
, **kwargs
):
11028 """IsOwnerDrawn(self) -> bool"""
11029 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11031 def SetOwnerDrawn(*args
, **kwargs
):
11032 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11033 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11035 def ResetOwnerDrawn(*args
, **kwargs
):
11036 """ResetOwnerDrawn(self)"""
11037 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11040 class MenuItemPtr(MenuItem
):
11041 def __init__(self
, this
):
11043 if not hasattr(self
,"thisown"): self
.thisown
= 0
11044 self
.__class
__ = MenuItem
11045 _core_
.MenuItem_swigregister(MenuItemPtr
)
11047 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11048 """MenuItem_GetLabelFromText(String text) -> String"""
11049 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11051 def MenuItem_GetDefaultMarginWidth(*args
, **kwargs
):
11052 """MenuItem_GetDefaultMarginWidth() -> int"""
11053 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11055 #---------------------------------------------------------------------------
11057 class Control(Window
):
11059 This is the base class for a control or 'widget'.
11061 A control is generally a small window which processes user input
11062 and/or displays one or more item of data.
11064 def __repr__(self
):
11065 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
11066 def __init__(self
, *args
, **kwargs
):
11068 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11069 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11070 String name=ControlNameStr) -> Control
11072 Create a Control. Normally you should only call this from a subclass'
11073 __init__ as a plain old wx.Control is not very useful.
11075 newobj
= _core_
.new_Control(*args
, **kwargs
)
11076 self
.this
= newobj
.this
11079 self
._setOORInfo
(self
)
11081 def Create(*args
, **kwargs
):
11083 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11084 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11085 String name=ControlNameStr) -> bool
11087 Do the 2nd phase and create the GUI control.
11089 return _core_
.Control_Create(*args
, **kwargs
)
11091 def Command(*args
, **kwargs
):
11093 Command(self, CommandEvent event)
11095 Simulates the effect of the user issuing a command to the item.
11097 :see: `wx.CommandEvent`
11100 return _core_
.Control_Command(*args
, **kwargs
)
11102 def GetLabel(*args
, **kwargs
):
11104 GetLabel(self) -> String
11106 Return a control's text.
11108 return _core_
.Control_GetLabel(*args
, **kwargs
)
11110 def SetLabel(*args
, **kwargs
):
11112 SetLabel(self, String label)
11114 Sets the item's text.
11116 return _core_
.Control_SetLabel(*args
, **kwargs
)
11118 def GetClassDefaultAttributes(*args
, **kwargs
):
11120 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11122 Get the default attributes for this class. This is useful if you want
11123 to use the same font or colour in your own control as in a standard
11124 control -- which is a much better idea than hard coding specific
11125 colours or fonts which might look completely out of place on the
11126 user's system, especially if it uses themes.
11128 The variant parameter is only relevant under Mac currently and is
11129 ignore under other platforms. Under Mac, it will change the size of
11130 the returned font. See `wx.Window.SetWindowVariant` for more about
11133 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11135 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11137 class ControlPtr(Control
):
11138 def __init__(self
, this
):
11140 if not hasattr(self
,"thisown"): self
.thisown
= 0
11141 self
.__class
__ = Control
11142 _core_
.Control_swigregister(ControlPtr
)
11143 ControlNameStr
= cvar
.ControlNameStr
11145 def PreControl(*args
, **kwargs
):
11147 PreControl() -> Control
11149 Precreate a Control control for 2-phase creation
11151 val
= _core_
.new_PreControl(*args
, **kwargs
)
11155 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11157 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11159 Get the default attributes for this class. This is useful if you want
11160 to use the same font or colour in your own control as in a standard
11161 control -- which is a much better idea than hard coding specific
11162 colours or fonts which might look completely out of place on the
11163 user's system, especially if it uses themes.
11165 The variant parameter is only relevant under Mac currently and is
11166 ignore under other platforms. Under Mac, it will change the size of
11167 the returned font. See `wx.Window.SetWindowVariant` for more about
11170 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11172 #---------------------------------------------------------------------------
11174 class ItemContainer(object):
11176 The wx.ItemContainer class defines an interface which is implemented
11177 by all controls which have string subitems, each of which may be
11178 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11179 as `wx.ComboBox` which implements an extended interface deriving from
11182 It defines the methods for accessing the control's items and although
11183 each of the derived classes implements them differently, they still
11184 all conform to the same interface.
11186 The items in a wx.ItemContainer have (non empty) string labels and,
11187 optionally, client data associated with them.
11190 def __init__(self
): raise RuntimeError, "No constructor defined"
11191 def __repr__(self
):
11192 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
11193 def Append(*args
, **kwargs
):
11195 Append(self, String item, PyObject clientData=None) -> int
11197 Adds the item to the control, associating the given data with the item
11198 if not None. The return value is the index of the newly added item
11199 which may be different from the last one if the control is sorted (e.g.
11200 has wx.LB_SORT or wx.CB_SORT style).
11202 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11204 def AppendItems(*args
, **kwargs
):
11206 AppendItems(self, List strings)
11208 Apend several items at once to the control. Notice that calling this
11209 method may be much faster than appending the items one by one if you
11210 need to add a lot of items.
11212 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11214 def Insert(*args
, **kwargs
):
11216 Insert(self, String item, int pos, PyObject clientData=None) -> int
11218 Insert an item into the control before the item at the ``pos`` index,
11219 optionally associating some data object with the item.
11221 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11223 def Clear(*args
, **kwargs
):
11227 Removes all items from the control.
11229 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11231 def Delete(*args
, **kwargs
):
11233 Delete(self, int n)
11235 Deletes the item at the zero-based index 'n' from the control. Note
11236 that it is an error (signalled by a `wx.PyAssertionError` exception if
11237 enabled) to remove an item with the index negative or greater or equal
11238 than the number of items in the control.
11240 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11242 def GetClientData(*args
, **kwargs
):
11244 GetClientData(self, int n) -> PyObject
11246 Returns the client data associated with the given item, (if any.)
11248 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11250 def SetClientData(*args
, **kwargs
):
11252 SetClientData(self, int n, PyObject clientData)
11254 Associate the given client data with the item at position n.
11256 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11258 def GetCount(*args
, **kwargs
):
11260 GetCount(self) -> int
11262 Returns the number of items in the control.
11264 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11266 def IsEmpty(*args
, **kwargs
):
11268 IsEmpty(self) -> bool
11270 Returns True if the control is empty or False if it has some items.
11272 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11274 def GetString(*args
, **kwargs
):
11276 GetString(self, int n) -> String
11278 Returns the label of the item with the given index.
11280 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11282 def GetStrings(*args
, **kwargs
):
11283 """GetStrings(self) -> wxArrayString"""
11284 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11286 def SetString(*args
, **kwargs
):
11288 SetString(self, int n, String s)
11290 Sets the label for the given item.
11292 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11294 def FindString(*args
, **kwargs
):
11296 FindString(self, String s) -> int
11298 Finds an item whose label matches the given string. Returns the
11299 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11302 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11304 def SetSelection(*args
, **kwargs
):
11306 SetSelection(self, int n)
11308 Sets the item at index 'n' to be the selected item.
11310 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11312 def GetSelection(*args
, **kwargs
):
11314 GetSelection(self) -> int
11316 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11319 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11321 def SetStringSelection(*args
, **kwargs
):
11322 """SetStringSelection(self, String s) -> bool"""
11323 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11325 def GetStringSelection(*args
, **kwargs
):
11327 GetStringSelection(self) -> String
11329 Returns the label of the selected item or an empty string if no item
11332 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11334 def Select(*args
, **kwargs
):
11336 Select(self, int n)
11338 This is the same as `SetSelection` and exists only because it is
11339 slightly more natural for controls which support multiple selection.
11341 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11344 class ItemContainerPtr(ItemContainer
):
11345 def __init__(self
, this
):
11347 if not hasattr(self
,"thisown"): self
.thisown
= 0
11348 self
.__class
__ = ItemContainer
11349 _core_
.ItemContainer_swigregister(ItemContainerPtr
)
11351 #---------------------------------------------------------------------------
11353 class ControlWithItems(Control
,ItemContainer
):
11355 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11356 wx.Control class, and is used for the base class of various controls
11359 def __init__(self
): raise RuntimeError, "No constructor defined"
11360 def __repr__(self
):
11361 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
11363 class ControlWithItemsPtr(ControlWithItems
):
11364 def __init__(self
, this
):
11366 if not hasattr(self
,"thisown"): self
.thisown
= 0
11367 self
.__class
__ = ControlWithItems
11368 _core_
.ControlWithItems_swigregister(ControlWithItemsPtr
)
11370 #---------------------------------------------------------------------------
11372 class SizerItem(Object
):
11374 The wx.SizerItem class is used to track the position, size and other
11375 attributes of each item managed by a `wx.Sizer`. In normal usage user
11376 code should never need to deal directly with a wx.SizerItem, but
11377 custom classes derived from `wx.PySizer` will probably need to use the
11378 collection of wx.SizerItems held by wx.Sizer when calculating layout.
11380 :see: `wx.Sizer`, `wx.GBSizerItem`
11382 def __repr__(self
):
11383 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
11384 def __init__(self
, *args
, **kwargs
):
11386 __init__(self) -> SizerItem
11388 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11389 size will need to be set before this item can be used in a Sizer.
11391 You will probably never need to create a wx.SizerItem directly as they
11392 are created automatically when the sizer's Add, Insert or Prepend
11393 methods are called.
11395 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11397 newobj
= _core_
.new_SizerItem(*args
, **kwargs
)
11398 self
.this
= newobj
.this
11401 def __del__(self
, destroy
=_core_
.delete_SizerItem
):
11402 """__del__(self)"""
11404 if self
.thisown
: destroy(self
)
11407 def DeleteWindows(*args
, **kwargs
):
11409 DeleteWindows(self)
11411 Destroy the window or the windows in a subsizer, depending on the type
11414 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11416 def DetachSizer(*args
, **kwargs
):
11420 Enable deleting the SizerItem without destroying the contained sizer.
11422 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11424 def GetSize(*args
, **kwargs
):
11426 GetSize(self) -> Size
11428 Get the current size of the item, as set in the last Layout.
11430 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11432 def CalcMin(*args
, **kwargs
):
11434 CalcMin(self) -> Size
11436 Calculates the minimum desired size for the item, including any space
11439 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11441 def SetDimension(*args
, **kwargs
):
11443 SetDimension(self, Point pos, Size size)
11445 Set the position and size of the space allocated for this item by the
11446 sizer, and adjust the position and size of the item (window or
11447 subsizer) to be within that space taking alignment and borders into
11450 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11452 def GetMinSize(*args
, **kwargs
):
11454 GetMinSize(self) -> Size
11456 Get the minimum size needed for the item.
11458 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11460 def GetMinSizeWithBorder(*args
, **kwargs
):
11462 GetMinSizeWithBorder(self) -> Size
11464 Get the minimum size needed for the item with space for the borders
11467 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11469 def SetInitSize(*args
, **kwargs
):
11470 """SetInitSize(self, int x, int y)"""
11471 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11473 def SetRatioWH(*args
, **kwargs
):
11475 SetRatioWH(self, int width, int height)
11477 Set the ratio item attribute.
11479 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11481 def SetRatioSize(*args
, **kwargs
):
11483 SetRatioSize(self, Size size)
11485 Set the ratio item attribute.
11487 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11489 def SetRatio(*args
, **kwargs
):
11491 SetRatio(self, float ratio)
11493 Set the ratio item attribute.
11495 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11497 def GetRatio(*args
, **kwargs
):
11499 GetRatio(self) -> float
11501 Set the ratio item attribute.
11503 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11505 def GetRect(*args
, **kwargs
):
11507 GetRect(self) -> Rect
11509 Returns the rectangle that the sizer item should occupy
11511 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11513 def IsWindow(*args
, **kwargs
):
11515 IsWindow(self) -> bool
11517 Is this sizer item a window?
11519 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11521 def IsSizer(*args
, **kwargs
):
11523 IsSizer(self) -> bool
11525 Is this sizer item a subsizer?
11527 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11529 def IsSpacer(*args
, **kwargs
):
11531 IsSpacer(self) -> bool
11533 Is this sizer item a spacer?
11535 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11537 def SetProportion(*args
, **kwargs
):
11539 SetProportion(self, int proportion)
11541 Set the proportion value for this item.
11543 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11545 def GetProportion(*args
, **kwargs
):
11547 GetProportion(self) -> int
11549 Get the proportion value for this item.
11551 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11553 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11554 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11555 def SetFlag(*args
, **kwargs
):
11557 SetFlag(self, int flag)
11559 Set the flag value for this item.
11561 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11563 def GetFlag(*args
, **kwargs
):
11565 GetFlag(self) -> int
11567 Get the flag value for this item.
11569 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11571 def SetBorder(*args
, **kwargs
):
11573 SetBorder(self, int border)
11575 Set the border value for this item.
11577 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11579 def GetBorder(*args
, **kwargs
):
11581 GetBorder(self) -> int
11583 Get the border value for this item.
11585 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11587 def GetWindow(*args
, **kwargs
):
11589 GetWindow(self) -> Window
11591 Get the window (if any) that is managed by this sizer item.
11593 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11595 def SetWindow(*args
, **kwargs
):
11597 SetWindow(self, Window window)
11599 Set the window to be managed by this sizer item.
11601 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11603 def GetSizer(*args
, **kwargs
):
11605 GetSizer(self) -> Sizer
11607 Get the subsizer (if any) that is managed by this sizer item.
11609 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11611 def SetSizer(*args
, **kwargs
):
11613 SetSizer(self, Sizer sizer)
11615 Set the subsizer to be managed by this sizer item.
11617 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11619 def GetSpacer(*args
, **kwargs
):
11621 GetSpacer(self) -> Size
11623 Get the size of the spacer managed by this sizer item.
11625 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11627 def SetSpacer(*args
, **kwargs
):
11629 SetSpacer(self, Size size)
11631 Set the size of the spacer to be managed by this sizer item.
11633 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11635 def Show(*args
, **kwargs
):
11637 Show(self, bool show)
11639 Set the show item attribute, which sizers use to determine if the item
11640 is to be made part of the layout or not. If the item is tracking a
11641 window then it is shown or hidden as needed.
11643 return _core_
.SizerItem_Show(*args
, **kwargs
)
11645 def IsShown(*args
, **kwargs
):
11647 IsShown(self) -> bool
11649 Is the item to be shown in the layout?
11651 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11653 def GetPosition(*args
, **kwargs
):
11655 GetPosition(self) -> Point
11657 Returns the current position of the item, as set in the last Layout.
11659 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11661 def GetUserData(*args
, **kwargs
):
11663 GetUserData(self) -> PyObject
11665 Returns the userData associated with this sizer item, or None if there
11668 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11670 def SetUserData(*args
, **kwargs
):
11672 SetUserData(self, PyObject userData)
11674 Associate a Python object with this sizer item.
11676 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11679 class SizerItemPtr(SizerItem
):
11680 def __init__(self
, this
):
11682 if not hasattr(self
,"thisown"): self
.thisown
= 0
11683 self
.__class
__ = SizerItem
11684 _core_
.SizerItem_swigregister(SizerItemPtr
)
11686 def SizerItemWindow(*args
, **kwargs
):
11688 SizerItemWindow(Window window, int proportion, int flag, int border,
11689 PyObject userData=None) -> SizerItem
11691 Constructs a `wx.SizerItem` for tracking a window.
11693 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11697 def SizerItemSpacer(*args
, **kwargs
):
11699 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11700 PyObject userData=None) -> SizerItem
11702 Constructs a `wx.SizerItem` for tracking a spacer.
11704 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11708 def SizerItemSizer(*args
, **kwargs
):
11710 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11711 PyObject userData=None) -> SizerItem
11713 Constructs a `wx.SizerItem` for tracking a subsizer
11715 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11719 class Sizer(Object
):
11721 wx.Sizer is the abstract base class used for laying out subwindows in
11722 a window. You cannot use wx.Sizer directly; instead, you will have to
11723 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11724 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
11725 and `wx.GridBagSizer`.
11727 The concept implemented by sizers in wxWidgets is closely related to
11728 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11729 toolkit or the Qt toolkit. It is based upon the idea of the individual
11730 subwindows reporting their minimal required size and their ability to
11731 get stretched if the size of the parent window has changed. This will
11732 most often mean that the programmer does not set the original size of
11733 a dialog in the beginning, rather the dialog will assigned a sizer and
11734 this sizer will be queried about the recommended size. The sizer in
11735 turn will query its children, which can be normal windows or contorls,
11736 empty space or other sizers, so that a hierarchy of sizers can be
11737 constructed. Note that wxSizer does not derive from wxWindow and thus
11738 do not interfere with tab ordering and requires very little resources
11739 compared to a real window on screen.
11741 What makes sizers so well fitted for use in wxWidgets is the fact that
11742 every control reports its own minimal size and the algorithm can
11743 handle differences in font sizes or different window (dialog item)
11744 sizes on different platforms without problems. If for example the
11745 standard font as well as the overall design of Mac widgets requires
11746 more space than on Windows, then the initial size of a dialog using a
11747 sizer will automatically be bigger on Mac than on Windows.
11749 def __init__(self
): raise RuntimeError, "No constructor defined"
11750 def __repr__(self
):
11751 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
11752 def __del__(self
, destroy
=_core_
.delete_Sizer
):
11753 """__del__(self)"""
11755 if self
.thisown
: destroy(self
)
11758 def _setOORInfo(*args
, **kwargs
):
11759 """_setOORInfo(self, PyObject _self)"""
11760 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11762 def Add(*args
, **kwargs
):
11764 Add(self, item, int proportion=0, int flag=0, int border=0,
11765 PyObject userData=None) -> wx.SizerItem
11767 Appends a child item to the sizer.
11769 return _core_
.Sizer_Add(*args
, **kwargs
)
11771 def Insert(*args
, **kwargs
):
11773 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11774 PyObject userData=None) -> wx.SizerItem
11776 Inserts a new item into the list of items managed by this sizer before
11777 the item at index *before*. See `Add` for a description of the parameters.
11779 return _core_
.Sizer_Insert(*args
, **kwargs
)
11781 def Prepend(*args
, **kwargs
):
11783 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11784 PyObject userData=None) -> wx.SizerItem
11786 Adds a new item to the begining of the list of sizer items managed by
11787 this sizer. See `Add` for a description of the parameters.
11789 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11791 def Remove(*args
, **kwargs
):
11793 Remove(self, item) -> bool
11795 Removes an item from the sizer and destroys it. This method does not
11796 cause any layout or resizing to take place, call `Layout` to update
11797 the layout on screen after removing a child from the sizer. The
11798 *item* parameter can be either a window, a sizer, or the zero-based
11799 index of an item to remove. Returns True if the child item was found
11802 return _core_
.Sizer_Remove(*args
, **kwargs
)
11804 def Detach(*args
, **kwargs
):
11806 Detach(self, item) -> bool
11808 Detaches an item from the sizer without destroying it. This method
11809 does not cause any layout or resizing to take place, call `Layout` to
11810 do so. The *item* parameter can be either a window, a sizer, or the
11811 zero-based index of the item to be detached. Returns True if the child item
11812 was found and detached.
11814 return _core_
.Sizer_Detach(*args
, **kwargs
)
11816 def GetItem(*args
, **kwargs
):
11818 GetItem(self, item) -> wx.SizerItem
11820 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11821 parameter can be either a window, a sizer, or the zero-based index of
11822 the item to be found.
11824 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11826 def _SetItemMinSize(*args
, **kwargs
):
11827 """_SetItemMinSize(self, PyObject item, Size size)"""
11828 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11830 def SetItemMinSize(self
, item
, *args
):
11832 SetItemMinSize(self, item, Size size)
11834 Sets the minimum size that will be allocated for an item in the sizer.
11835 The *item* parameter can be either a window, a sizer, or the
11836 zero-based index of the item. If a window or sizer is given then it
11837 will be searched for recursivly in subsizers if neccessary.
11840 # for backward compatibility accept separate width,height args too
11841 return self
._SetItemMinSize
(item
, args
)
11843 return self
._SetItemMinSize
(item
, args
[0])
11845 def AddItem(*args
, **kwargs
):
11847 AddItem(self, SizerItem item)
11849 Adds a `wx.SizerItem` to the sizer.
11851 return _core_
.Sizer_AddItem(*args
, **kwargs
)
11853 def InsertItem(*args
, **kwargs
):
11855 InsertItem(self, int index, SizerItem item)
11857 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11859 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
11861 def PrependItem(*args
, **kwargs
):
11863 PrependItem(self, SizerItem item)
11865 Prepends a `wx.SizerItem` to the sizer.
11867 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
11869 def AddMany(self
, items
):
11871 AddMany is a convenience method for adding several items
11872 to a sizer at one time. Simply pass it a list of tuples,
11873 where each tuple consists of the parameters that you
11874 would normally pass to the `Add` method.
11877 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
11881 # for backwards compatibility only, please do not use in new code
11882 def AddWindow(self
, *args
, **kw
):
11883 """Compatibility alias for `Add`."""
11884 return self
.Add(*args
, **kw
)
11885 def AddSizer(self
, *args
, **kw
):
11886 """Compatibility alias for `Add`."""
11887 return self
.Add(*args
, **kw
)
11888 def AddSpacer(self
, *args
, **kw
):
11889 """Compatibility alias for `Add`."""
11890 return self
.Add(*args
, **kw
)
11892 def PrependWindow(self
, *args
, **kw
):
11893 """Compatibility alias for `Prepend`."""
11894 return self
.Prepend(*args
, **kw
)
11895 def PrependSizer(self
, *args
, **kw
):
11896 """Compatibility alias for `Prepend`."""
11897 return self
.Prepend(*args
, **kw
)
11898 def PrependSpacer(self
, *args
, **kw
):
11899 """Compatibility alias for `Prepend`."""
11900 return self
.Prepend(*args
, **kw
)
11902 def InsertWindow(self
, *args
, **kw
):
11903 """Compatibility alias for `Insert`."""
11904 return self
.Insert(*args
, **kw
)
11905 def InsertSizer(self
, *args
, **kw
):
11906 """Compatibility alias for `Insert`."""
11907 return self
.Insert(*args
, **kw
)
11908 def InsertSpacer(self
, *args
, **kw
):
11909 """Compatibility alias for `Insert`."""
11910 return self
.Insert(*args
, **kw
)
11912 def RemoveWindow(self
, *args
, **kw
):
11913 """Compatibility alias for `Remove`."""
11914 return self
.Remove(*args
, **kw
)
11915 def RemoveSizer(self
, *args
, **kw
):
11916 """Compatibility alias for `Remove`."""
11917 return self
.Remove(*args
, **kw
)
11918 def RemovePos(self
, *args
, **kw
):
11919 """Compatibility alias for `Remove`."""
11920 return self
.Remove(*args
, **kw
)
11923 def SetDimension(*args
, **kwargs
):
11925 SetDimension(self, int x, int y, int width, int height)
11927 Call this to force the sizer to take the given dimension and thus
11928 force the items owned by the sizer to resize themselves according to
11929 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11932 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
11934 def SetMinSize(*args
, **kwargs
):
11936 SetMinSize(self, Size size)
11938 Call this to give the sizer a minimal size. Normally, the sizer will
11939 calculate its minimal size based purely on how much space its children
11940 need. After calling this method `GetMinSize` will return either the
11941 minimal size as requested by its children or the minimal size set
11942 here, depending on which is bigger.
11944 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
11946 def GetSize(*args
, **kwargs
):
11948 GetSize(self) -> Size
11950 Returns the current size of the space managed by the sizer.
11952 return _core_
.Sizer_GetSize(*args
, **kwargs
)
11954 def GetPosition(*args
, **kwargs
):
11956 GetPosition(self) -> Point
11958 Returns the current position of the sizer's managed space.
11960 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
11962 def GetMinSize(*args
, **kwargs
):
11964 GetMinSize(self) -> Size
11966 Returns the minimal size of the sizer. This is either the combined
11967 minimal size of all the children and their borders or the minimal size
11968 set by SetMinSize, depending on which is bigger.
11970 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
11972 def GetSizeTuple(self
):
11973 return self
.GetSize().Get()
11974 def GetPositionTuple(self
):
11975 return self
.GetPosition().Get()
11976 def GetMinSizeTuple(self
):
11977 return self
.GetMinSize().Get()
11979 def RecalcSizes(*args
, **kwargs
):
11983 Using the sizes calculated by `CalcMin` reposition and resize all the
11984 items managed by this sizer. You should not need to call this directly as
11985 it is called by `Layout`.
11987 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
11989 def CalcMin(*args
, **kwargs
):
11991 CalcMin(self) -> Size
11993 This method is where the sizer will do the actual calculation of its
11994 children's minimal sizes. You should not need to call this directly as
11995 it is called by `Layout`.
11997 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
11999 def Layout(*args
, **kwargs
):
12003 This method will force the recalculation and layout of the items
12004 controlled by the sizer using the current space allocated to the
12005 sizer. Normally this is called automatically from the owning window's
12006 EVT_SIZE handler, but it is also useful to call it from user code when
12007 one of the items in a sizer change size, or items are added or
12010 return _core_
.Sizer_Layout(*args
, **kwargs
)
12012 def Fit(*args
, **kwargs
):
12014 Fit(self, Window window) -> Size
12016 Tell the sizer to resize the *window* to match the sizer's minimal
12017 size. This is commonly done in the constructor of the window itself in
12018 order to set its initial size to match the needs of the children as
12019 determined by the sizer. Returns the new size.
12021 For a top level window this is the total window size, not the client size.
12023 return _core_
.Sizer_Fit(*args
, **kwargs
)
12025 def FitInside(*args
, **kwargs
):
12027 FitInside(self, Window window)
12029 Tell the sizer to resize the *virtual size* of the *window* to match the
12030 sizer's minimal size. This will not alter the on screen size of the
12031 window, but may cause the addition/removal/alteration of scrollbars
12032 required to view the virtual area in windows which manage it.
12034 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12037 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12039 def SetSizeHints(*args
, **kwargs
):
12041 SetSizeHints(self, Window window)
12043 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12044 match the sizer's minimal size. This is commonly done in the
12045 constructor of the window itself if the window is resizable (as are
12046 many dialogs under Unix and frames on probably all platforms) in order
12047 to prevent the window from being sized smaller than the minimal size
12048 required by the sizer.
12050 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12052 def SetVirtualSizeHints(*args
, **kwargs
):
12054 SetVirtualSizeHints(self, Window window)
12056 Tell the sizer to set the minimal size of the window virtual area to
12057 match the sizer's minimal size. For windows with managed scrollbars
12058 this will set them appropriately.
12060 :see: `wx.ScrolledWindow.SetScrollbars`
12063 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12065 def Clear(*args
, **kwargs
):
12067 Clear(self, bool deleteWindows=False)
12069 Clear all items from the sizer, optionally destroying the window items
12072 return _core_
.Sizer_Clear(*args
, **kwargs
)
12074 def DeleteWindows(*args
, **kwargs
):
12076 DeleteWindows(self)
12078 Destroy all windows managed by the sizer.
12080 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12082 def GetChildren(*args
, **kwargs
):
12084 GetChildren(self) -> list
12086 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12088 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12090 def Show(*args
, **kwargs
):
12092 Show(self, item, bool show=True, bool recursive=false) -> bool
12094 Shows or hides an item managed by the sizer. To make a sizer item
12095 disappear or reappear, use Show followed by `Layout`. The *item*
12096 parameter can be either a window, a sizer, or the zero-based index of
12097 the item. Use the recursive parameter to show or hide an item in a
12098 subsizer. Returns True if the item was found.
12100 return _core_
.Sizer_Show(*args
, **kwargs
)
12102 def IsShown(*args
, **kwargs
):
12104 IsShown(self, item)
12106 Determines if the item is currently shown. To make a sizer
12107 item disappear or reappear, use Show followed by `Layout`. The *item*
12108 parameter can be either a window, a sizer, or the zero-based index of
12111 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12113 def Hide(self
, item
, recursive
=False):
12115 A convenience method for `Show` (item, False, recursive).
12117 return self
.Show(item
, False, recursive
)
12119 def ShowItems(*args
, **kwargs
):
12121 ShowItems(self, bool show)
12123 Recursively call `wx.SizerItem.Show` on all sizer items.
12125 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12128 class SizerPtr(Sizer
):
12129 def __init__(self
, this
):
12131 if not hasattr(self
,"thisown"): self
.thisown
= 0
12132 self
.__class
__ = Sizer
12133 _core_
.Sizer_swigregister(SizerPtr
)
12135 class PySizer(Sizer
):
12137 wx.PySizer is a special version of `wx.Sizer` that has been
12138 instrumented to allow the C++ virtual methods to be overloaded in
12139 Python derived classes. You would derive from this class if you are
12140 wanting to implement a custom sizer in Python code. Simply implement
12141 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12144 class MySizer(wx.PySizer):
12145 def __init__(self):
12146 wx.PySizer.__init__(self)
12149 for item in self.GetChildren():
12150 # calculate the total minimum width and height needed
12151 # by all items in the sizer according to this sizer's
12152 # layout algorithm.
12154 return wx.Size(width, height)
12156 def RecalcSizes(self):
12157 # find the space allotted to this sizer
12158 pos = self.GetPosition()
12159 size = self.GetSize()
12160 for item in self.GetChildren():
12161 # Recalculate (if necessary) the position and size of
12162 # each item and then call item.SetDimension to do the
12163 # actual positioning and sizing of the items within the
12164 # space alloted to this sizer.
12166 item.SetDimension(itemPos, itemSize)
12169 When `Layout` is called it first calls `CalcMin` followed by
12170 `RecalcSizes` so you can optimize a bit by saving the results of
12171 `CalcMin` and reusing them in `RecalcSizes`.
12173 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12177 def __repr__(self
):
12178 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12179 def __init__(self
, *args
, **kwargs
):
12181 __init__(self) -> PySizer
12183 Creates a wx.PySizer. Must be called from the __init__ in the derived
12186 newobj
= _core_
.new_PySizer(*args
, **kwargs
)
12187 self
.this
= newobj
.this
12190 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12192 def _setCallbackInfo(*args
, **kwargs
):
12193 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12194 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12197 class PySizerPtr(PySizer
):
12198 def __init__(self
, this
):
12200 if not hasattr(self
,"thisown"): self
.thisown
= 0
12201 self
.__class
__ = PySizer
12202 _core_
.PySizer_swigregister(PySizerPtr
)
12204 #---------------------------------------------------------------------------
12206 class BoxSizer(Sizer
):
12208 The basic idea behind a box sizer is that windows will most often be
12209 laid out in rather simple basic geometry, typically in a row or a
12210 column or nested hierarchies of either. A wx.BoxSizer will lay out
12211 its items in a simple row or column, depending on the orientation
12212 parameter passed to the constructor.
12214 def __repr__(self
):
12215 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12216 def __init__(self
, *args
, **kwargs
):
12218 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12220 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12221 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12224 newobj
= _core_
.new_BoxSizer(*args
, **kwargs
)
12225 self
.this
= newobj
.this
12228 self
._setOORInfo
(self
)
12230 def GetOrientation(*args
, **kwargs
):
12232 GetOrientation(self) -> int
12234 Returns the current orientation of the sizer.
12236 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12238 def SetOrientation(*args
, **kwargs
):
12240 SetOrientation(self, int orient)
12242 Resets the orientation of the sizer.
12244 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12247 class BoxSizerPtr(BoxSizer
):
12248 def __init__(self
, this
):
12250 if not hasattr(self
,"thisown"): self
.thisown
= 0
12251 self
.__class
__ = BoxSizer
12252 _core_
.BoxSizer_swigregister(BoxSizerPtr
)
12254 #---------------------------------------------------------------------------
12256 class StaticBoxSizer(BoxSizer
):
12258 wx.StaticBoxSizer derives from and functions identically to the
12259 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12260 manages. Note that this static box must be created separately and
12261 passed to the sizer constructor.
12263 def __repr__(self
):
12264 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12265 def __init__(self
, *args
, **kwargs
):
12267 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12269 Constructor. It takes an associated static box and the orientation
12270 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12273 newobj
= _core_
.new_StaticBoxSizer(*args
, **kwargs
)
12274 self
.this
= newobj
.this
12277 self
._setOORInfo
(self
)
12279 def GetStaticBox(*args
, **kwargs
):
12281 GetStaticBox(self) -> StaticBox
12283 Returns the static box associated with this sizer.
12285 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12288 class StaticBoxSizerPtr(StaticBoxSizer
):
12289 def __init__(self
, this
):
12291 if not hasattr(self
,"thisown"): self
.thisown
= 0
12292 self
.__class
__ = StaticBoxSizer
12293 _core_
.StaticBoxSizer_swigregister(StaticBoxSizerPtr
)
12295 #---------------------------------------------------------------------------
12297 class GridSizer(Sizer
):
12299 A grid sizer is a sizer which lays out its children in a
12300 two-dimensional table with all cells having the same size. In other
12301 words, the width of each cell within the grid is the width of the
12302 widest item added to the sizer and the height of each grid cell is the
12303 height of the tallest item. An optional vertical and/or horizontal
12304 gap between items can also be specified (in pixels.)
12306 Items are placed in the cells of the grid in the order they are added,
12307 in row-major order. In other words, the first row is filled first,
12308 then the second, and so on until all items have been added. (If
12309 neccessary, additional rows will be added as items are added.) If you
12310 need to have greater control over the cells that items are placed in
12311 then use the `wx.GridBagSizer`.
12314 def __repr__(self
):
12315 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12316 def __init__(self
, *args
, **kwargs
):
12318 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12320 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12321 of columns and rows in the sizer - if either of the parameters is
12322 zero, it will be calculated to from the total number of children in
12323 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12324 define extra space between all children.
12326 newobj
= _core_
.new_GridSizer(*args
, **kwargs
)
12327 self
.this
= newobj
.this
12330 self
._setOORInfo
(self
)
12332 def SetCols(*args
, **kwargs
):
12334 SetCols(self, int cols)
12336 Sets the number of columns in the sizer.
12338 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12340 def SetRows(*args
, **kwargs
):
12342 SetRows(self, int rows)
12344 Sets the number of rows in the sizer.
12346 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12348 def SetVGap(*args
, **kwargs
):
12350 SetVGap(self, int gap)
12352 Sets the vertical gap (in pixels) between the cells in the sizer.
12354 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12356 def SetHGap(*args
, **kwargs
):
12358 SetHGap(self, int gap)
12360 Sets the horizontal gap (in pixels) between cells in the sizer
12362 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12364 def GetCols(*args
, **kwargs
):
12366 GetCols(self) -> int
12368 Returns the number of columns in the sizer.
12370 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12372 def GetRows(*args
, **kwargs
):
12374 GetRows(self) -> int
12376 Returns the number of rows in the sizer.
12378 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12380 def GetVGap(*args
, **kwargs
):
12382 GetVGap(self) -> int
12384 Returns the vertical gap (in pixels) between the cells in the sizer.
12386 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12388 def GetHGap(*args
, **kwargs
):
12390 GetHGap(self) -> int
12392 Returns the horizontal gap (in pixels) between cells in the sizer.
12394 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12397 class GridSizerPtr(GridSizer
):
12398 def __init__(self
, this
):
12400 if not hasattr(self
,"thisown"): self
.thisown
= 0
12401 self
.__class
__ = GridSizer
12402 _core_
.GridSizer_swigregister(GridSizerPtr
)
12404 #---------------------------------------------------------------------------
12406 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12407 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12408 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12409 class FlexGridSizer(GridSizer
):
12411 A flex grid sizer is a sizer which lays out its children in a
12412 two-dimensional table with all table cells in one row having the same
12413 height and all cells in one column having the same width, but all
12414 rows or all columns are not necessarily the same height or width as in
12415 the `wx.GridSizer`.
12417 wx.FlexGridSizer can also size items equally in one direction but
12418 unequally ("flexibly") in the other. If the sizer is only flexible
12419 in one direction (this can be changed using `SetFlexibleDirection`), it
12420 needs to be decided how the sizer should grow in the other ("non
12421 flexible") direction in order to fill the available space. The
12422 `SetNonFlexibleGrowMode` method serves this purpose.
12426 def __repr__(self
):
12427 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12428 def __init__(self
, *args
, **kwargs
):
12430 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12432 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12433 number of columns and rows in the sizer - if either of the parameters
12434 is zero, it will be calculated to from the total number of children in
12435 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12436 define extra space between all children.
12438 newobj
= _core_
.new_FlexGridSizer(*args
, **kwargs
)
12439 self
.this
= newobj
.this
12442 self
._setOORInfo
(self
)
12444 def AddGrowableRow(*args
, **kwargs
):
12446 AddGrowableRow(self, size_t idx, int proportion=0)
12448 Specifies that row *idx* (starting from zero) should be grown if there
12449 is extra space available to the sizer.
12451 The *proportion* parameter has the same meaning as the stretch factor
12452 for the box sizers except that if all proportions are 0, then all
12453 columns are resized equally (instead of not being resized at all).
12455 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12457 def RemoveGrowableRow(*args
, **kwargs
):
12459 RemoveGrowableRow(self, size_t idx)
12461 Specifies that row *idx* is no longer growable.
12463 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12465 def AddGrowableCol(*args
, **kwargs
):
12467 AddGrowableCol(self, size_t idx, int proportion=0)
12469 Specifies that column *idx* (starting from zero) should be grown if
12470 there is extra space available to the sizer.
12472 The *proportion* parameter has the same meaning as the stretch factor
12473 for the box sizers except that if all proportions are 0, then all
12474 columns are resized equally (instead of not being resized at all).
12476 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12478 def RemoveGrowableCol(*args
, **kwargs
):
12480 RemoveGrowableCol(self, size_t idx)
12482 Specifies that column *idx* is no longer growable.
12484 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12486 def SetFlexibleDirection(*args
, **kwargs
):
12488 SetFlexibleDirection(self, int direction)
12490 Specifies whether the sizer should flexibly resize its columns, rows,
12491 or both. Argument *direction* can be one of the following values. Any
12492 other value is ignored.
12494 ============== =======================================
12495 wx.VERTICAL Rows are flexibly sized.
12496 wx.HORIZONTAL Columns are flexibly sized.
12497 wx.BOTH Both rows and columns are flexibly sized
12498 (this is the default value).
12499 ============== =======================================
12501 Note that this method does not trigger relayout.
12504 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12506 def GetFlexibleDirection(*args
, **kwargs
):
12508 GetFlexibleDirection(self) -> int
12510 Returns a value that specifies whether the sizer
12511 flexibly resizes its columns, rows, or both (default).
12513 :see: `SetFlexibleDirection`
12515 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12517 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12519 SetNonFlexibleGrowMode(self, int mode)
12521 Specifies how the sizer should grow in the non-flexible direction if
12522 there is one (so `SetFlexibleDirection` must have been called
12523 previously). Argument *mode* can be one of the following values:
12525 ========================== =================================================
12526 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12527 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12528 `AddGrowableCol` and `AddGrowableRow`. In this
12529 case equal sizing applies to minimum sizes of
12530 columns or rows (this is the default value).
12531 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12532 the non flexible direction, whether they are
12533 growable or not in the flexbile direction.
12534 ========================== =================================================
12536 Note that this method does not trigger relayout.
12540 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12542 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12544 GetNonFlexibleGrowMode(self) -> int
12546 Returns the value that specifies how the sizer grows in the
12547 non-flexible direction if there is one.
12549 :see: `SetNonFlexibleGrowMode`
12551 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12553 def GetRowHeights(*args
, **kwargs
):
12555 GetRowHeights(self) -> list
12557 Returns a list of integers representing the heights of each of the
12560 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12562 def GetColWidths(*args
, **kwargs
):
12564 GetColWidths(self) -> list
12566 Returns a list of integers representing the widths of each of the
12567 columns in the sizer.
12569 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12572 class FlexGridSizerPtr(FlexGridSizer
):
12573 def __init__(self
, this
):
12575 if not hasattr(self
,"thisown"): self
.thisown
= 0
12576 self
.__class
__ = FlexGridSizer
12577 _core_
.FlexGridSizer_swigregister(FlexGridSizerPtr
)
12579 class StdDialogButtonSizer(BoxSizer
):
12581 A special sizer that knows how to order and position standard buttons
12582 in order to conform to the current platform's standards. You simply
12583 need to add each `wx.Button` to the sizer, and be sure to create the
12584 buttons using the standard ID's. Then call `Realize` and the sizer
12585 will take care of the rest.
12588 def __repr__(self
):
12589 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12590 def __init__(self
, *args
, **kwargs
):
12591 """__init__(self) -> StdDialogButtonSizer"""
12592 newobj
= _core_
.new_StdDialogButtonSizer(*args
, **kwargs
)
12593 self
.this
= newobj
.this
12596 def AddButton(*args
, **kwargs
):
12598 AddButton(self, wxButton button)
12600 Use this to add the buttons to this sizer. Do not use the `Add`
12601 method in the base class.
12603 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12605 def Realize(*args
, **kwargs
):
12609 This funciton needs to be called after all the buttons have been added
12610 to the sizer. It will reorder them and position them in a platform
12613 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12615 def SetAffirmativeButton(*args
, **kwargs
):
12616 """SetAffirmativeButton(self, wxButton button)"""
12617 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12619 def SetNegativeButton(*args
, **kwargs
):
12620 """SetNegativeButton(self, wxButton button)"""
12621 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12623 def SetCancelButton(*args
, **kwargs
):
12624 """SetCancelButton(self, wxButton button)"""
12625 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12627 def GetAffirmativeButton(*args
, **kwargs
):
12628 """GetAffirmativeButton(self) -> wxButton"""
12629 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12631 def GetApplyButton(*args
, **kwargs
):
12632 """GetApplyButton(self) -> wxButton"""
12633 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12635 def GetNegativeButton(*args
, **kwargs
):
12636 """GetNegativeButton(self) -> wxButton"""
12637 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12639 def GetCancelButton(*args
, **kwargs
):
12640 """GetCancelButton(self) -> wxButton"""
12641 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12643 def GetHelpButton(*args
, **kwargs
):
12644 """GetHelpButton(self) -> wxButton"""
12645 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12648 class StdDialogButtonSizerPtr(StdDialogButtonSizer
):
12649 def __init__(self
, this
):
12651 if not hasattr(self
,"thisown"): self
.thisown
= 0
12652 self
.__class
__ = StdDialogButtonSizer
12653 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr
)
12655 #---------------------------------------------------------------------------
12657 class GBPosition(object):
12659 This class represents the position of an item in a virtual grid of
12660 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12661 typemaps that will automatically convert from a 2-element sequence of
12662 integers to a wx.GBPosition, so you can use the more pythonic
12663 representation of the position nearly transparently in Python code.
12665 def __repr__(self
):
12666 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12667 def __init__(self
, *args
, **kwargs
):
12669 __init__(self, int row=0, int col=0) -> GBPosition
12671 This class represents the position of an item in a virtual grid of
12672 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12673 typemaps that will automatically convert from a 2-element sequence of
12674 integers to a wx.GBPosition, so you can use the more pythonic
12675 representation of the position nearly transparently in Python code.
12677 newobj
= _core_
.new_GBPosition(*args
, **kwargs
)
12678 self
.this
= newobj
.this
12681 def __del__(self
, destroy
=_core_
.delete_GBPosition
):
12682 """__del__(self)"""
12684 if self
.thisown
: destroy(self
)
12687 def GetRow(*args
, **kwargs
):
12688 """GetRow(self) -> int"""
12689 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12691 def GetCol(*args
, **kwargs
):
12692 """GetCol(self) -> int"""
12693 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12695 def SetRow(*args
, **kwargs
):
12696 """SetRow(self, int row)"""
12697 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12699 def SetCol(*args
, **kwargs
):
12700 """SetCol(self, int col)"""
12701 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12703 def __eq__(*args
, **kwargs
):
12704 """__eq__(self, GBPosition other) -> bool"""
12705 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12707 def __ne__(*args
, **kwargs
):
12708 """__ne__(self, GBPosition other) -> bool"""
12709 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12711 def Set(*args
, **kwargs
):
12712 """Set(self, int row=0, int col=0)"""
12713 return _core_
.GBPosition_Set(*args
, **kwargs
)
12715 def Get(*args
, **kwargs
):
12716 """Get(self) -> PyObject"""
12717 return _core_
.GBPosition_Get(*args
, **kwargs
)
12719 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12720 def __str__(self
): return str(self
.Get())
12721 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12722 def __len__(self
): return len(self
.Get())
12723 def __getitem__(self
, index
): return self
.Get()[index
]
12724 def __setitem__(self
, index
, val
):
12725 if index
== 0: self
.SetRow(val
)
12726 elif index
== 1: self
.SetCol(val
)
12727 else: raise IndexError
12728 def __nonzero__(self
): return self
.Get() != (0,0)
12729 __safe_for_unpickling__
= True
12730 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12732 row
= property(GetRow
, SetRow
)
12733 col
= property(GetCol
, SetCol
)
12736 class GBPositionPtr(GBPosition
):
12737 def __init__(self
, this
):
12739 if not hasattr(self
,"thisown"): self
.thisown
= 0
12740 self
.__class
__ = GBPosition
12741 _core_
.GBPosition_swigregister(GBPositionPtr
)
12743 class GBSpan(object):
12745 This class is used to hold the row and column spanning attributes of
12746 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12747 automatically convert from a 2-element sequence of integers to a
12748 wx.GBSpan, so you can use the more pythonic representation of the span
12749 nearly transparently in Python code.
12752 def __repr__(self
):
12753 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12754 def __init__(self
, *args
, **kwargs
):
12756 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12758 Construct a new wxGBSpan, optionally setting the rowspan and
12759 colspan. The default is (1,1). (Meaning that the item occupies one
12760 cell in each direction.
12762 newobj
= _core_
.new_GBSpan(*args
, **kwargs
)
12763 self
.this
= newobj
.this
12766 def __del__(self
, destroy
=_core_
.delete_GBSpan
):
12767 """__del__(self)"""
12769 if self
.thisown
: destroy(self
)
12772 def GetRowspan(*args
, **kwargs
):
12773 """GetRowspan(self) -> int"""
12774 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12776 def GetColspan(*args
, **kwargs
):
12777 """GetColspan(self) -> int"""
12778 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12780 def SetRowspan(*args
, **kwargs
):
12781 """SetRowspan(self, int rowspan)"""
12782 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12784 def SetColspan(*args
, **kwargs
):
12785 """SetColspan(self, int colspan)"""
12786 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12788 def __eq__(*args
, **kwargs
):
12789 """__eq__(self, GBSpan other) -> bool"""
12790 return _core_
.GBSpan___eq__(*args
, **kwargs
)
12792 def __ne__(*args
, **kwargs
):
12793 """__ne__(self, GBSpan other) -> bool"""
12794 return _core_
.GBSpan___ne__(*args
, **kwargs
)
12796 def Set(*args
, **kwargs
):
12797 """Set(self, int rowspan=1, int colspan=1)"""
12798 return _core_
.GBSpan_Set(*args
, **kwargs
)
12800 def Get(*args
, **kwargs
):
12801 """Get(self) -> PyObject"""
12802 return _core_
.GBSpan_Get(*args
, **kwargs
)
12804 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12805 def __str__(self
): return str(self
.Get())
12806 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
12807 def __len__(self
): return len(self
.Get())
12808 def __getitem__(self
, index
): return self
.Get()[index
]
12809 def __setitem__(self
, index
, val
):
12810 if index
== 0: self
.SetRowspan(val
)
12811 elif index
== 1: self
.SetColspan(val
)
12812 else: raise IndexError
12813 def __nonzero__(self
): return self
.Get() != (0,0)
12814 __safe_for_unpickling__
= True
12815 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
12817 rowspan
= property(GetRowspan
, SetRowspan
)
12818 colspan
= property(GetColspan
, SetColspan
)
12821 class GBSpanPtr(GBSpan
):
12822 def __init__(self
, this
):
12824 if not hasattr(self
,"thisown"): self
.thisown
= 0
12825 self
.__class
__ = GBSpan
12826 _core_
.GBSpan_swigregister(GBSpanPtr
)
12828 class GBSizerItem(SizerItem
):
12830 The wx.GBSizerItem class is used to track the additional data about
12831 items in a `wx.GridBagSizer` such as the item's position in the grid
12832 and how many rows or columns it spans.
12835 def __repr__(self
):
12836 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12837 def __init__(self
, *args
, **kwargs
):
12839 __init__(self) -> GBSizerItem
12841 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12842 size will need to be set, as well as a position and span before this
12843 item can be used in a Sizer.
12845 You will probably never need to create a wx.GBSizerItem directly as they
12846 are created automatically when the sizer's Add method is called.
12848 newobj
= _core_
.new_GBSizerItem(*args
, **kwargs
)
12849 self
.this
= newobj
.this
12852 def __del__(self
, destroy
=_core_
.delete_GBSizerItem
):
12853 """__del__(self)"""
12855 if self
.thisown
: destroy(self
)
12858 def GetPos(*args
, **kwargs
):
12860 GetPos(self) -> GBPosition
12862 Get the grid position of the item
12864 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
12866 def GetPosTuple(self
): return self
.GetPos().Get()
12867 def GetSpan(*args
, **kwargs
):
12869 GetSpan(self) -> GBSpan
12871 Get the row and column spanning of the item
12873 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
12875 def GetSpanTuple(self
): return self
.GetSpan().Get()
12876 def SetPos(*args
, **kwargs
):
12878 SetPos(self, GBPosition pos) -> bool
12880 If the item is already a member of a sizer then first ensure that
12881 there is no other item that would intersect with this one at the new
12882 position, then set the new position. Returns True if the change is
12883 successful and after the next Layout() the item will be moved.
12885 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
12887 def SetSpan(*args
, **kwargs
):
12889 SetSpan(self, GBSpan span) -> bool
12891 If the item is already a member of a sizer then first ensure that
12892 there is no other item that would intersect with this one with its new
12893 spanning size, then set the new spanning. Returns True if the change
12894 is successful and after the next Layout() the item will be resized.
12897 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
12899 def Intersects(*args
, **kwargs
):
12901 Intersects(self, GBSizerItem other) -> bool
12903 Returns True if this item and the other item instersect.
12905 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
12907 def IntersectsPos(*args
, **kwargs
):
12909 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12911 Returns True if the given pos/span would intersect with this item.
12913 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
12915 def GetEndPos(*args
, **kwargs
):
12917 GetEndPos(self) -> GBPosition
12919 Get the row and column of the endpoint of this item.
12921 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
12923 def GetGBSizer(*args
, **kwargs
):
12925 GetGBSizer(self) -> GridBagSizer
12927 Get the sizer this item is a member of.
12929 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
12931 def SetGBSizer(*args
, **kwargs
):
12933 SetGBSizer(self, GridBagSizer sizer)
12935 Set the sizer this item is a member of.
12937 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
12940 class GBSizerItemPtr(GBSizerItem
):
12941 def __init__(self
, this
):
12943 if not hasattr(self
,"thisown"): self
.thisown
= 0
12944 self
.__class
__ = GBSizerItem
12945 _core_
.GBSizerItem_swigregister(GBSizerItemPtr
)
12946 DefaultSpan
= cvar
.DefaultSpan
12948 def GBSizerItemWindow(*args
, **kwargs
):
12950 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12951 int border, PyObject userData=None) -> GBSizerItem
12953 Construct a `wx.GBSizerItem` for a window.
12955 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
12959 def GBSizerItemSizer(*args
, **kwargs
):
12961 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12962 int border, PyObject userData=None) -> GBSizerItem
12964 Construct a `wx.GBSizerItem` for a sizer
12966 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
12970 def GBSizerItemSpacer(*args
, **kwargs
):
12972 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12973 int flag, int border, PyObject userData=None) -> GBSizerItem
12975 Construct a `wx.GBSizerItem` for a spacer.
12977 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
12981 class GridBagSizer(FlexGridSizer
):
12983 A `wx.Sizer` that can lay out items in a virtual grid like a
12984 `wx.FlexGridSizer` but in this case explicit positioning of the items
12985 is allowed using `wx.GBPosition`, and items can optionally span more
12986 than one row and/or column using `wx.GBSpan`. The total size of the
12987 virtual grid is determined by the largest row and column that items are
12988 positioned at, adjusted for spanning.
12991 def __repr__(self
):
12992 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
12993 def __init__(self
, *args
, **kwargs
):
12995 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12997 Constructor, with optional parameters to specify the gap between the
13000 newobj
= _core_
.new_GridBagSizer(*args
, **kwargs
)
13001 self
.this
= newobj
.this
13004 self
._setOORInfo
(self
)
13006 def Add(*args
, **kwargs
):
13008 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13009 int border=0, userData=None) -> wx.GBSizerItem
13011 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13012 more than one row or column as specified with *span*. The remaining
13013 args behave similarly to `wx.Sizer.Add`.
13015 Returns True if the item was successfully placed at the given cell
13016 position, False if something was already there.
13019 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13021 def AddItem(*args
, **kwargs
):
13023 Add(self, GBSizerItem item) -> wx.GBSizerItem
13025 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13026 the item was successfully placed at its given cell position, False if
13027 something was already there.
13029 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13031 def GetCellSize(*args
, **kwargs
):
13033 GetCellSize(self, int row, int col) -> Size
13035 Get the size of the specified cell, including hgap and
13036 vgap. Only valid after a Layout.
13038 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13040 def GetEmptyCellSize(*args
, **kwargs
):
13042 GetEmptyCellSize(self) -> Size
13044 Get the size used for cells in the grid with no item.
13046 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13048 def SetEmptyCellSize(*args
, **kwargs
):
13050 SetEmptyCellSize(self, Size sz)
13052 Set the size used for cells in the grid with no item.
13054 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13056 def GetItemPosition(*args
):
13058 GetItemPosition(self, item) -> GBPosition
13060 Get the grid position of the specified *item* where *item* is either a
13061 window or subsizer that is a member of this sizer, or a zero-based
13064 return _core_
.GridBagSizer_GetItemPosition(*args
)
13066 def SetItemPosition(*args
):
13068 SetItemPosition(self, item, GBPosition pos) -> bool
13070 Set the grid position of the specified *item* where *item* is either a
13071 window or subsizer that is a member of this sizer, or a zero-based
13072 index of an item. Returns True on success. If the move is not
13073 allowed (because an item is already there) then False is returned.
13076 return _core_
.GridBagSizer_SetItemPosition(*args
)
13078 def GetItemSpan(*args
):
13080 GetItemSpan(self, item) -> GBSpan
13082 Get the row/col spanning of the specified *item* where *item* is
13083 either a window or subsizer that is a member of this sizer, or a
13084 zero-based index of an item.
13086 return _core_
.GridBagSizer_GetItemSpan(*args
)
13088 def SetItemSpan(*args
):
13090 SetItemSpan(self, item, GBSpan span) -> bool
13092 Set the row/col spanning of the specified *item* where *item* is
13093 either a window or subsizer that is a member of this sizer, or a
13094 zero-based index of an item. Returns True on success. If the move is
13095 not allowed (because an item is already there) then False is returned.
13097 return _core_
.GridBagSizer_SetItemSpan(*args
)
13099 def FindItem(*args
):
13101 FindItem(self, item) -> GBSizerItem
13103 Find the sizer item for the given window or subsizer, returns None if
13104 not found. (non-recursive)
13106 return _core_
.GridBagSizer_FindItem(*args
)
13108 def FindItemAtPosition(*args
, **kwargs
):
13110 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13112 Return the sizer item for the given grid cell, or None if there is no
13113 item at that position. (non-recursive)
13115 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13117 def FindItemAtPoint(*args
, **kwargs
):
13119 FindItemAtPoint(self, Point pt) -> GBSizerItem
13121 Return the sizer item located at the point given in *pt*, or None if
13122 there is no item at that point. The (x,y) coordinates in pt correspond
13123 to the client coordinates of the window using the sizer for
13124 layout. (non-recursive)
13126 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13128 def CheckForIntersection(*args
, **kwargs
):
13130 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13132 Look at all items and see if any intersect (or would overlap) the
13133 given *item*. Returns True if so, False if there would be no overlap.
13134 If an *excludeItem* is given then it will not be checked for
13135 intersection, for example it may be the item we are checking the
13139 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13141 def CheckForIntersectionPos(*args
, **kwargs
):
13143 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13145 Look at all items and see if any intersect (or would overlap) the
13146 given position and span. Returns True if so, False if there would be
13147 no overlap. If an *excludeItem* is given then it will not be checked
13148 for intersection, for example it may be the item we are checking the
13151 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13154 class GridBagSizerPtr(GridBagSizer
):
13155 def __init__(self
, this
):
13157 if not hasattr(self
,"thisown"): self
.thisown
= 0
13158 self
.__class
__ = GridBagSizer
13159 _core_
.GridBagSizer_swigregister(GridBagSizerPtr
)
13161 #---------------------------------------------------------------------------
13165 Right
= _core_
.Right
13166 Bottom
= _core_
.Bottom
13167 Width
= _core_
.Width
13168 Height
= _core_
.Height
13169 Centre
= _core_
.Centre
13170 Center
= _core_
.Center
13171 CentreX
= _core_
.CentreX
13172 CentreY
= _core_
.CentreY
13173 Unconstrained
= _core_
.Unconstrained
13175 PercentOf
= _core_
.PercentOf
13176 Above
= _core_
.Above
13177 Below
= _core_
.Below
13178 LeftOf
= _core_
.LeftOf
13179 RightOf
= _core_
.RightOf
13180 SameAs
= _core_
.SameAs
13181 Absolute
= _core_
.Absolute
13182 class IndividualLayoutConstraint(Object
):
13184 Objects of this class are stored in the `wx.LayoutConstraints` class as
13185 one of eight possible constraints that a window can be involved in.
13186 You will never need to create an instance of
13187 wx.IndividualLayoutConstraint, rather you should create a
13188 `wx.LayoutConstraints` instance and use the individual contstraints
13191 def __init__(self
): raise RuntimeError, "No constructor defined"
13192 def __repr__(self
):
13193 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
13194 def Set(*args
, **kwargs
):
13196 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13198 Sets the properties of the constraint. Normally called by one of the
13199 convenience functions such as Above, RightOf, SameAs.
13201 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13203 def LeftOf(*args
, **kwargs
):
13205 LeftOf(self, Window sibling, int marg=0)
13207 Constrains this edge to be to the left of the given window, with an
13208 optional margin. Implicitly, this is relative to the left edge of the
13211 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13213 def RightOf(*args
, **kwargs
):
13215 RightOf(self, Window sibling, int marg=0)
13217 Constrains this edge to be to the right of the given window, with an
13218 optional margin. Implicitly, this is relative to the right edge of the
13221 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13223 def Above(*args
, **kwargs
):
13225 Above(self, Window sibling, int marg=0)
13227 Constrains this edge to be above the given window, with an optional
13228 margin. Implicitly, this is relative to the top edge of the other
13231 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13233 def Below(*args
, **kwargs
):
13235 Below(self, Window sibling, int marg=0)
13237 Constrains this edge to be below the given window, with an optional
13238 margin. Implicitly, this is relative to the bottom edge of the other
13241 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13243 def SameAs(*args
, **kwargs
):
13245 SameAs(self, Window otherW, int edge, int marg=0)
13247 Constrains this edge or dimension to be to the same as the edge of the
13248 given window, with an optional margin.
13250 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13252 def PercentOf(*args
, **kwargs
):
13254 PercentOf(self, Window otherW, int wh, int per)
13256 Constrains this edge or dimension to be to a percentage of the given
13257 window, with an optional margin.
13259 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13261 def Absolute(*args
, **kwargs
):
13263 Absolute(self, int val)
13265 Constrains this edge or dimension to be the given absolute value.
13267 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13269 def Unconstrained(*args
, **kwargs
):
13271 Unconstrained(self)
13273 Sets this edge or dimension to be unconstrained, that is, dependent on
13274 other edges and dimensions from which this value can be deduced.
13276 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13278 def AsIs(*args
, **kwargs
):
13282 Sets this edge or constraint to be whatever the window's value is at
13283 the moment. If either of the width and height constraints are *as is*,
13284 the window will not be resized, but moved instead. This is important
13285 when considering panel items which are intended to have a default
13286 size, such as a button, which may take its size from the size of the
13289 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13291 def GetOtherWindow(*args
, **kwargs
):
13292 """GetOtherWindow(self) -> Window"""
13293 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13295 def GetMyEdge(*args
, **kwargs
):
13296 """GetMyEdge(self) -> int"""
13297 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13299 def SetEdge(*args
, **kwargs
):
13300 """SetEdge(self, int which)"""
13301 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13303 def SetValue(*args
, **kwargs
):
13304 """SetValue(self, int v)"""
13305 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13307 def GetMargin(*args
, **kwargs
):
13308 """GetMargin(self) -> int"""
13309 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13311 def SetMargin(*args
, **kwargs
):
13312 """SetMargin(self, int m)"""
13313 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13315 def GetValue(*args
, **kwargs
):
13316 """GetValue(self) -> int"""
13317 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13319 def GetPercent(*args
, **kwargs
):
13320 """GetPercent(self) -> int"""
13321 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13323 def GetOtherEdge(*args
, **kwargs
):
13324 """GetOtherEdge(self) -> int"""
13325 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13327 def GetDone(*args
, **kwargs
):
13328 """GetDone(self) -> bool"""
13329 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13331 def SetDone(*args
, **kwargs
):
13332 """SetDone(self, bool d)"""
13333 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13335 def GetRelationship(*args
, **kwargs
):
13336 """GetRelationship(self) -> int"""
13337 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13339 def SetRelationship(*args
, **kwargs
):
13340 """SetRelationship(self, int r)"""
13341 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13343 def ResetIfWin(*args
, **kwargs
):
13345 ResetIfWin(self, Window otherW) -> bool
13347 Reset constraint if it mentions otherWin
13349 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13351 def SatisfyConstraint(*args
, **kwargs
):
13353 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13355 Try to satisfy constraint
13357 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13359 def GetEdge(*args
, **kwargs
):
13361 GetEdge(self, int which, Window thisWin, Window other) -> int
13363 Get the value of this edge or dimension, or if this
13364 is not determinable, -1.
13366 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13369 class IndividualLayoutConstraintPtr(IndividualLayoutConstraint
):
13370 def __init__(self
, this
):
13372 if not hasattr(self
,"thisown"): self
.thisown
= 0
13373 self
.__class
__ = IndividualLayoutConstraint
13374 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr
)
13376 class LayoutConstraints(Object
):
13378 **Note:** constraints are now deprecated and you should use sizers
13381 Objects of this class can be associated with a window to define its
13382 layout constraints, with respect to siblings or its parent.
13384 The class consists of the following eight constraints of class
13385 wx.IndividualLayoutConstraint, some or all of which should be accessed
13386 directly to set the appropriate constraints.
13388 * left: represents the left hand edge of the window
13389 * right: represents the right hand edge of the window
13390 * top: represents the top edge of the window
13391 * bottom: represents the bottom edge of the window
13392 * width: represents the width of the window
13393 * height: represents the height of the window
13394 * centreX: represents the horizontal centre point of the window
13395 * centreY: represents the vertical centre point of the window
13397 Most constraints are initially set to have the relationship
13398 wxUnconstrained, which means that their values should be calculated by
13399 looking at known constraints. The exceptions are width and height,
13400 which are set to wxAsIs to ensure that if the user does not specify a
13401 constraint, the existing width and height will be used, to be
13402 compatible with panel items which often have take a default size. If
13403 the constraint is ``wx.AsIs``, the dimension will not be changed.
13405 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13408 def __repr__(self
):
13409 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self
.__class
__.__module
__, self
.__class
__.__name
__, self
.this
,)
13410 left
= property(_core_
.LayoutConstraints_left_get
)
13411 top
= property(_core_
.LayoutConstraints_top_get
)
13412 right
= property(_core_
.LayoutConstraints_right_get
)
13413 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13414 width
= property(_core_
.LayoutConstraints_width_get
)
13415 height
= property(_core_
.LayoutConstraints_height_get
)
13416 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13417 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13418 def __init__(self
, *args
, **kwargs
):
13419 """__init__(self) -> LayoutConstraints"""
13420 newobj
= _core_
.new_LayoutConstraints(*args
, **kwargs
)
13421 self
.this
= newobj
.this
13424 def SatisfyConstraints(*args
, **kwargs
):
13425 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13426 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13428 def AreSatisfied(*args
, **kwargs
):
13429 """AreSatisfied(self) -> bool"""
13430 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13433 class LayoutConstraintsPtr(LayoutConstraints
):
13434 def __init__(self
, this
):
13436 if not hasattr(self
,"thisown"): self
.thisown
= 0
13437 self
.__class
__ = LayoutConstraints
13438 _core_
.LayoutConstraints_swigregister(LayoutConstraintsPtr
)
13440 #----------------------------------------------------------------------------
13442 # Use Python's bool constants if available, make some if not
13446 __builtins__
.True = 1==1
13447 __builtins__
.False = 1==0
13448 def bool(value
): return not not value
13449 __builtins__
.bool = bool
13453 # workarounds for bad wxRTTI names
13454 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13455 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13456 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13459 #----------------------------------------------------------------------------
13460 # Load version numbers from __version__... Ensure that major and minor
13461 # versions are the same for both wxPython and wxWidgets.
13463 from __version__
import *
13464 __version__
= VERSION_STRING
13466 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13467 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13468 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13470 warnings
.warn("wxPython/wxWidgets release number mismatch")
13472 #----------------------------------------------------------------------------
13474 # Set wxPython's default string<-->unicode conversion encoding from
13475 # the locale, but only if Python's default hasn't been changed. (We
13476 # assume that if the user has customized it already then that is the
13477 # encoding we need to use as well.)
13479 # The encoding selected here is used when string or unicode objects
13480 # need to be converted in order to pass them to wxWidgets. Please be
13481 # aware that the default encoding within the same locale may be
13482 # slightly different on different platforms. For example, please see
13483 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13484 # between the common latin/roman encodings.
13486 default
= _sys
.getdefaultencoding()
13487 if default
== 'ascii':
13491 default
= locale
.getdefaultlocale()[1]
13492 codecs
.lookup(default
)
13493 except (ValueError, LookupError, TypeError):
13494 default
= _sys
.getdefaultencoding()
13498 wx
.SetDefaultPyEncoding(default
)
13501 #----------------------------------------------------------------------------
13503 class PyDeadObjectError(AttributeError):
13506 class _wxPyDeadObject(object):
13508 Instances of wx objects that are OOR capable will have their __class__
13509 changed to this class when the C++ object is deleted. This should help
13510 prevent crashes due to referencing a bogus C++ pointer.
13512 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13513 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13515 def __repr__(self
):
13516 if not hasattr(self
, "_name"):
13517 self
._name
= "[unknown]"
13518 return self
.reprStr
% self
._name
13520 def __getattr__(self
, *args
):
13521 if not hasattr(self
, "_name"):
13522 self
._name
= "[unknown]"
13523 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13525 def __nonzero__(self
):
13530 class PyUnbornObjectError(AttributeError):
13533 class _wxPyUnbornObject(object):
13535 Some stock objects are created when the wx._core module is
13536 imported, but their C++ instance is not created until the wx.App
13537 object is created and initialized. These object instances will
13538 temporarily have their __class__ changed to this class so an
13539 exception will be raised if they are used before the C++ instance
13543 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13544 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13546 def __repr__(self
):
13547 #if not hasattr(self, "_name"):
13548 # self._name = "[unknown]"
13549 return self
.reprStr
#% self._name
13551 def __getattr__(self
, *args
):
13552 #if not hasattr(self, "_name"):
13553 # self._name = "[unknown]"
13554 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13556 def __nonzero__(self
):
13560 #----------------------------------------------------------------------------
13562 def CallAfter(callable, *args
, **kw
):
13564 Call the specified function after the current and pending event
13565 handlers have been completed. This is also good for making GUI
13566 method calls from non-GUI threads. Any extra positional or
13567 keyword args are passed on to the callable when it is called.
13569 :see: `wx.FutureCall`
13572 assert app
is not None, 'No wx.App created yet'
13574 if not hasattr(app
, "_CallAfterId"):
13575 app
._CallAfterId
= wx
.NewEventType()
13576 app
.Connect(-1, -1, app
._CallAfterId
,
13577 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13579 evt
.SetEventType(app
._CallAfterId
)
13580 evt
.callable = callable
13583 wx
.PostEvent(app
, evt
)
13585 #----------------------------------------------------------------------------
13590 A convenience class for `wx.Timer`, that calls the given callable
13591 object once after the given amount of milliseconds, passing any
13592 positional or keyword args. The return value of the callable is
13593 availbale after it has been run with the `GetResult` method.
13595 If you don't need to get the return value or restart the timer
13596 then there is no need to hold a reference to this object. It will
13597 hold a reference to itself while the timer is running (the timer
13598 has a reference to self.Notify) but the cycle will be broken when
13599 the timer completes, automatically cleaning up the wx.FutureCall
13602 :see: `wx.CallAfter`
13604 def __init__(self
, millis
, callable, *args
, **kwargs
):
13605 self
.millis
= millis
13606 self
.callable = callable
13607 self
.SetArgs(*args
, **kwargs
)
13609 self
.running
= False
13610 self
.hasRun
= False
13619 def Start(self
, millis
=None, *args
, **kwargs
):
13621 (Re)start the timer
13623 self
.hasRun
= False
13624 if millis
is not None:
13625 self
.millis
= millis
13627 self
.SetArgs(*args
, **kwargs
)
13629 self
.timer
= wx
.PyTimer(self
.Notify
)
13630 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13631 self
.running
= True
13637 Stop and destroy the timer.
13639 if self
.timer
is not None:
13644 def GetInterval(self
):
13645 if self
.timer
is not None:
13646 return self
.timer
.GetInterval()
13651 def IsRunning(self
):
13652 return self
.timer
is not None and self
.timer
.IsRunning()
13655 def SetArgs(self
, *args
, **kwargs
):
13657 (Re)set the args passed to the callable object. This is
13658 useful in conjunction with Restart if you want to schedule a
13659 new call to the same callable object but with different
13663 self
.kwargs
= kwargs
13669 def GetResult(self
):
13674 The timer has expired so call the callable.
13676 if self
.callable and getattr(self
.callable, 'im_self', True):
13678 self
.running
= False
13679 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13681 if not self
.running
:
13682 # if it wasn't restarted, then cleanup
13683 wx
.CallAfter(self
.Stop
)
13687 #----------------------------------------------------------------------------
13688 # Control which items in this module should be documented by epydoc.
13689 # We allow only classes and functions, which will help reduce the size
13690 # of the docs by filtering out the zillions of constants, EVT objects,
13691 # and etc that don't make much sense by themselves, but are instead
13692 # documented (or will be) as part of the classes/functions/methods
13693 # where they should be used.
13697 A filter for epydoc that only allows non-Ptr classes and
13698 fucntions, in order to reduce the clutter in the API docs.
13700 def __init__(self
, globals):
13701 self
._globals
= globals
13703 def __call__(self
, name
):
13705 obj
= self
._globals
.get(name
, None)
13706 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13708 if name
.startswith('_') or name
.endswith('Ptr') or name
.startswith('EVT'):
13712 #----------------------------------------------------------------------------
13713 #----------------------------------------------------------------------------
13715 # Import other modules in this package that should show up in the
13716 # "core" wx namespace
13718 from _windows
import *
13719 from _controls
import *
13720 from _misc
import *
13723 # Fixup the stock objects since they can't be used yet. (They will be
13724 # restored in wx.PyApp.OnInit.)
13725 _core_
._wxPyFixStockObjects
()
13727 #----------------------------------------------------------------------------
13728 #----------------------------------------------------------------------------