1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
6 new_instancemethod
= new
.instancemethod
7 def _swig_setattr_nondynamic(self
,class_type
,name
,value
,static
=1):
8 if (name
== "thisown"): return self
.this
.own(value
)
10 if type(value
).__name
__ == 'PySwigObject':
11 self
.__dict
__[name
] = value
13 method
= class_type
.__swig
_setmethods
__.get(name
,None)
14 if method
: return method(self
,value
)
15 if (not static
) or hasattr(self
,name
):
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 if (name
== "thisown"): return self
.this
.own()
25 method
= class_type
.__swig
_getmethods
__.get(name
,None)
26 if method
: return method(self
)
27 raise AttributeError,name
30 try: strthis
= "proxy of " + self
.this
.__repr
__()
32 return "<%s.%s; %s >" % (self
.__class
__.__module
__, self
.__class
__.__name
__, strthis
,)
36 _object
= types
.ObjectType
38 except AttributeError:
44 def _swig_setattr_nondynamic_method(set):
45 def set_attr(self
,name
,value
):
46 if (name
== "thisown"): return self
.this
.own(value
)
47 if hasattr(self
,name
) or (name
== "this"):
50 raise AttributeError("You cannot add attributes to %s" % self
)
54 #// Give a reference to the dictionary of this module to the C++ extension
56 _core_
._wxPySetDictionary
(vars())
58 #// A little trick to make 'wx' be a reference to this module so wx.Names can
61 wx
= _sys
.modules
[__name__
]
64 #----------------------------------------------------------------------------
66 def _deprecated(callable, msg
=None):
68 Create a wrapper function that will raise a DeprecationWarning
69 before calling the callable.
72 msg
= "%s is deprecated" % callable
73 def deprecatedWrapper(*args
, **kwargs
):
75 warnings
.warn(msg
, DeprecationWarning, stacklevel
=2)
76 return callable(*args
, **kwargs
)
77 deprecatedWrapper
.__doc
__ = msg
78 return deprecatedWrapper
81 #----------------------------------------------------------------------------
83 NOT_FOUND
= _core_
.NOT_FOUND
84 VSCROLL
= _core_
.VSCROLL
85 HSCROLL
= _core_
.HSCROLL
86 CAPTION
= _core_
.CAPTION
87 DOUBLE_BORDER
= _core_
.DOUBLE_BORDER
88 SUNKEN_BORDER
= _core_
.SUNKEN_BORDER
89 RAISED_BORDER
= _core_
.RAISED_BORDER
90 BORDER
= _core_
.BORDER
91 SIMPLE_BORDER
= _core_
.SIMPLE_BORDER
92 STATIC_BORDER
= _core_
.STATIC_BORDER
93 TRANSPARENT_WINDOW
= _core_
.TRANSPARENT_WINDOW
94 NO_BORDER
= _core_
.NO_BORDER
95 DEFAULT_CONTROL_BORDER
= _core_
.DEFAULT_CONTROL_BORDER
96 DEFAULT_STATUSBAR_STYLE
= _core_
.DEFAULT_STATUSBAR_STYLE
97 TAB_TRAVERSAL
= _core_
.TAB_TRAVERSAL
98 WANTS_CHARS
= _core_
.WANTS_CHARS
99 POPUP_WINDOW
= _core_
.POPUP_WINDOW
100 CENTER_FRAME
= _core_
.CENTER_FRAME
101 CENTRE_ON_SCREEN
= _core_
.CENTRE_ON_SCREEN
102 CENTER_ON_SCREEN
= _core_
.CENTER_ON_SCREEN
103 CLIP_CHILDREN
= _core_
.CLIP_CHILDREN
104 CLIP_SIBLINGS
= _core_
.CLIP_SIBLINGS
105 ALWAYS_SHOW_SB
= _core_
.ALWAYS_SHOW_SB
106 RETAINED
= _core_
.RETAINED
107 BACKINGSTORE
= _core_
.BACKINGSTORE
108 COLOURED
= _core_
.COLOURED
109 FIXED_LENGTH
= _core_
.FIXED_LENGTH
110 LB_NEEDED_SB
= _core_
.LB_NEEDED_SB
111 LB_ALWAYS_SB
= _core_
.LB_ALWAYS_SB
112 LB_SORT
= _core_
.LB_SORT
113 LB_SINGLE
= _core_
.LB_SINGLE
114 LB_MULTIPLE
= _core_
.LB_MULTIPLE
115 LB_EXTENDED
= _core_
.LB_EXTENDED
116 LB_OWNERDRAW
= _core_
.LB_OWNERDRAW
117 LB_HSCROLL
= _core_
.LB_HSCROLL
118 PROCESS_ENTER
= _core_
.PROCESS_ENTER
119 PASSWORD
= _core_
.PASSWORD
120 CB_SIMPLE
= _core_
.CB_SIMPLE
121 CB_DROPDOWN
= _core_
.CB_DROPDOWN
122 CB_SORT
= _core_
.CB_SORT
123 CB_READONLY
= _core_
.CB_READONLY
124 RA_HORIZONTAL
= _core_
.RA_HORIZONTAL
125 RA_VERTICAL
= _core_
.RA_VERTICAL
126 RA_SPECIFY_ROWS
= _core_
.RA_SPECIFY_ROWS
127 RA_SPECIFY_COLS
= _core_
.RA_SPECIFY_COLS
128 RA_USE_CHECKBOX
= _core_
.RA_USE_CHECKBOX
129 RB_GROUP
= _core_
.RB_GROUP
130 RB_SINGLE
= _core_
.RB_SINGLE
131 SB_HORIZONTAL
= _core_
.SB_HORIZONTAL
132 SB_VERTICAL
= _core_
.SB_VERTICAL
133 RB_USE_CHECKBOX
= _core_
.RB_USE_CHECKBOX
134 ST_SIZEGRIP
= _core_
.ST_SIZEGRIP
135 ST_NO_AUTORESIZE
= _core_
.ST_NO_AUTORESIZE
136 FLOOD_SURFACE
= _core_
.FLOOD_SURFACE
137 FLOOD_BORDER
= _core_
.FLOOD_BORDER
138 ODDEVEN_RULE
= _core_
.ODDEVEN_RULE
139 WINDING_RULE
= _core_
.WINDING_RULE
140 TOOL_TOP
= _core_
.TOOL_TOP
141 TOOL_BOTTOM
= _core_
.TOOL_BOTTOM
142 TOOL_LEFT
= _core_
.TOOL_LEFT
143 TOOL_RIGHT
= _core_
.TOOL_RIGHT
145 YES_NO
= _core_
.YES_NO
146 CANCEL
= _core_
.CANCEL
149 NO_DEFAULT
= _core_
.NO_DEFAULT
150 YES_DEFAULT
= _core_
.YES_DEFAULT
151 ICON_EXCLAMATION
= _core_
.ICON_EXCLAMATION
152 ICON_HAND
= _core_
.ICON_HAND
153 ICON_QUESTION
= _core_
.ICON_QUESTION
154 ICON_INFORMATION
= _core_
.ICON_INFORMATION
155 ICON_STOP
= _core_
.ICON_STOP
156 ICON_ASTERISK
= _core_
.ICON_ASTERISK
157 ICON_MASK
= _core_
.ICON_MASK
158 ICON_WARNING
= _core_
.ICON_WARNING
159 ICON_ERROR
= _core_
.ICON_ERROR
160 FORWARD
= _core_
.FORWARD
161 BACKWARD
= _core_
.BACKWARD
166 SIZE_AUTO_WIDTH
= _core_
.SIZE_AUTO_WIDTH
167 SIZE_AUTO_HEIGHT
= _core_
.SIZE_AUTO_HEIGHT
168 SIZE_AUTO
= _core_
.SIZE_AUTO
169 SIZE_USE_EXISTING
= _core_
.SIZE_USE_EXISTING
170 SIZE_ALLOW_MINUS_ONE
= _core_
.SIZE_ALLOW_MINUS_ONE
171 SIZE_FORCE
= _core_
.SIZE_FORCE
172 PORTRAIT
= _core_
.PORTRAIT
173 LANDSCAPE
= _core_
.LANDSCAPE
174 PRINT_QUALITY_HIGH
= _core_
.PRINT_QUALITY_HIGH
175 PRINT_QUALITY_MEDIUM
= _core_
.PRINT_QUALITY_MEDIUM
176 PRINT_QUALITY_LOW
= _core_
.PRINT_QUALITY_LOW
177 PRINT_QUALITY_DRAFT
= _core_
.PRINT_QUALITY_DRAFT
178 ID_ANY
= _core_
.ID_ANY
179 ID_SEPARATOR
= _core_
.ID_SEPARATOR
180 ID_NONE
= _core_
.ID_NONE
181 ID_LOWEST
= _core_
.ID_LOWEST
182 ID_OPEN
= _core_
.ID_OPEN
183 ID_CLOSE
= _core_
.ID_CLOSE
184 ID_NEW
= _core_
.ID_NEW
185 ID_SAVE
= _core_
.ID_SAVE
186 ID_SAVEAS
= _core_
.ID_SAVEAS
187 ID_REVERT
= _core_
.ID_REVERT
188 ID_EXIT
= _core_
.ID_EXIT
189 ID_UNDO
= _core_
.ID_UNDO
190 ID_REDO
= _core_
.ID_REDO
191 ID_HELP
= _core_
.ID_HELP
192 ID_PRINT
= _core_
.ID_PRINT
193 ID_PRINT_SETUP
= _core_
.ID_PRINT_SETUP
194 ID_PREVIEW
= _core_
.ID_PREVIEW
195 ID_ABOUT
= _core_
.ID_ABOUT
196 ID_HELP_CONTENTS
= _core_
.ID_HELP_CONTENTS
197 ID_HELP_COMMANDS
= _core_
.ID_HELP_COMMANDS
198 ID_HELP_PROCEDURES
= _core_
.ID_HELP_PROCEDURES
199 ID_HELP_CONTEXT
= _core_
.ID_HELP_CONTEXT
200 ID_CLOSE_ALL
= _core_
.ID_CLOSE_ALL
201 ID_PREFERENCES
= _core_
.ID_PREFERENCES
202 ID_CUT
= _core_
.ID_CUT
203 ID_COPY
= _core_
.ID_COPY
204 ID_PASTE
= _core_
.ID_PASTE
205 ID_CLEAR
= _core_
.ID_CLEAR
206 ID_FIND
= _core_
.ID_FIND
207 ID_DUPLICATE
= _core_
.ID_DUPLICATE
208 ID_SELECTALL
= _core_
.ID_SELECTALL
209 ID_DELETE
= _core_
.ID_DELETE
210 ID_REPLACE
= _core_
.ID_REPLACE
211 ID_REPLACE_ALL
= _core_
.ID_REPLACE_ALL
212 ID_PROPERTIES
= _core_
.ID_PROPERTIES
213 ID_VIEW_DETAILS
= _core_
.ID_VIEW_DETAILS
214 ID_VIEW_LARGEICONS
= _core_
.ID_VIEW_LARGEICONS
215 ID_VIEW_SMALLICONS
= _core_
.ID_VIEW_SMALLICONS
216 ID_VIEW_LIST
= _core_
.ID_VIEW_LIST
217 ID_VIEW_SORTDATE
= _core_
.ID_VIEW_SORTDATE
218 ID_VIEW_SORTNAME
= _core_
.ID_VIEW_SORTNAME
219 ID_VIEW_SORTSIZE
= _core_
.ID_VIEW_SORTSIZE
220 ID_VIEW_SORTTYPE
= _core_
.ID_VIEW_SORTTYPE
221 ID_FILE1
= _core_
.ID_FILE1
222 ID_FILE2
= _core_
.ID_FILE2
223 ID_FILE3
= _core_
.ID_FILE3
224 ID_FILE4
= _core_
.ID_FILE4
225 ID_FILE5
= _core_
.ID_FILE5
226 ID_FILE6
= _core_
.ID_FILE6
227 ID_FILE7
= _core_
.ID_FILE7
228 ID_FILE8
= _core_
.ID_FILE8
229 ID_FILE9
= _core_
.ID_FILE9
231 ID_CANCEL
= _core_
.ID_CANCEL
232 ID_APPLY
= _core_
.ID_APPLY
233 ID_YES
= _core_
.ID_YES
235 ID_STATIC
= _core_
.ID_STATIC
236 ID_FORWARD
= _core_
.ID_FORWARD
237 ID_BACKWARD
= _core_
.ID_BACKWARD
238 ID_DEFAULT
= _core_
.ID_DEFAULT
239 ID_MORE
= _core_
.ID_MORE
240 ID_SETUP
= _core_
.ID_SETUP
241 ID_RESET
= _core_
.ID_RESET
242 ID_CONTEXT_HELP
= _core_
.ID_CONTEXT_HELP
243 ID_YESTOALL
= _core_
.ID_YESTOALL
244 ID_NOTOALL
= _core_
.ID_NOTOALL
245 ID_ABORT
= _core_
.ID_ABORT
246 ID_RETRY
= _core_
.ID_RETRY
247 ID_IGNORE
= _core_
.ID_IGNORE
248 ID_ADD
= _core_
.ID_ADD
249 ID_REMOVE
= _core_
.ID_REMOVE
251 ID_DOWN
= _core_
.ID_DOWN
252 ID_HOME
= _core_
.ID_HOME
253 ID_REFRESH
= _core_
.ID_REFRESH
254 ID_STOP
= _core_
.ID_STOP
255 ID_INDEX
= _core_
.ID_INDEX
256 ID_BOLD
= _core_
.ID_BOLD
257 ID_ITALIC
= _core_
.ID_ITALIC
258 ID_JUSTIFY_CENTER
= _core_
.ID_JUSTIFY_CENTER
259 ID_JUSTIFY_FILL
= _core_
.ID_JUSTIFY_FILL
260 ID_JUSTIFY_RIGHT
= _core_
.ID_JUSTIFY_RIGHT
261 ID_JUSTIFY_LEFT
= _core_
.ID_JUSTIFY_LEFT
262 ID_UNDERLINE
= _core_
.ID_UNDERLINE
263 ID_INDENT
= _core_
.ID_INDENT
264 ID_UNINDENT
= _core_
.ID_UNINDENT
265 ID_ZOOM_100
= _core_
.ID_ZOOM_100
266 ID_ZOOM_FIT
= _core_
.ID_ZOOM_FIT
267 ID_ZOOM_IN
= _core_
.ID_ZOOM_IN
268 ID_ZOOM_OUT
= _core_
.ID_ZOOM_OUT
269 ID_UNDELETE
= _core_
.ID_UNDELETE
270 ID_REVERT_TO_SAVED
= _core_
.ID_REVERT_TO_SAVED
271 ID_HIGHEST
= _core_
.ID_HIGHEST
274 HIDE_READONLY
= _core_
.HIDE_READONLY
275 OVERWRITE_PROMPT
= _core_
.OVERWRITE_PROMPT
276 FILE_MUST_EXIST
= _core_
.FILE_MUST_EXIST
277 MULTIPLE
= _core_
.MULTIPLE
278 CHANGE_DIR
= _core_
.CHANGE_DIR
279 ACCEL_ALT
= _core_
.ACCEL_ALT
280 ACCEL_CTRL
= _core_
.ACCEL_CTRL
281 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
282 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
283 PD_AUTO_HIDE
= _core_
.PD_AUTO_HIDE
284 PD_APP_MODAL
= _core_
.PD_APP_MODAL
285 PD_CAN_ABORT
= _core_
.PD_CAN_ABORT
286 PD_ELAPSED_TIME
= _core_
.PD_ELAPSED_TIME
287 PD_ESTIMATED_TIME
= _core_
.PD_ESTIMATED_TIME
288 PD_REMAINING_TIME
= _core_
.PD_REMAINING_TIME
289 PD_SMOOTH
= _core_
.PD_SMOOTH
290 PD_CAN_SKIP
= _core_
.PD_CAN_SKIP
291 DD_NEW_DIR_BUTTON
= _core_
.DD_NEW_DIR_BUTTON
292 DD_DEFAULT_STYLE
= _core_
.DD_DEFAULT_STYLE
293 MENU_TEAROFF
= _core_
.MENU_TEAROFF
294 MB_DOCKABLE
= _core_
.MB_DOCKABLE
295 NO_FULL_REPAINT_ON_RESIZE
= _core_
.NO_FULL_REPAINT_ON_RESIZE
296 FULL_REPAINT_ON_RESIZE
= _core_
.FULL_REPAINT_ON_RESIZE
297 LI_HORIZONTAL
= _core_
.LI_HORIZONTAL
298 LI_VERTICAL
= _core_
.LI_VERTICAL
299 WS_EX_VALIDATE_RECURSIVELY
= _core_
.WS_EX_VALIDATE_RECURSIVELY
300 WS_EX_BLOCK_EVENTS
= _core_
.WS_EX_BLOCK_EVENTS
301 WS_EX_TRANSIENT
= _core_
.WS_EX_TRANSIENT
302 WS_EX_THEMED_BACKGROUND
= _core_
.WS_EX_THEMED_BACKGROUND
303 WS_EX_PROCESS_IDLE
= _core_
.WS_EX_PROCESS_IDLE
304 WS_EX_PROCESS_UI_UPDATES
= _core_
.WS_EX_PROCESS_UI_UPDATES
305 MM_TEXT
= _core_
.MM_TEXT
306 MM_LOMETRIC
= _core_
.MM_LOMETRIC
307 MM_HIMETRIC
= _core_
.MM_HIMETRIC
308 MM_LOENGLISH
= _core_
.MM_LOENGLISH
309 MM_HIENGLISH
= _core_
.MM_HIENGLISH
310 MM_TWIPS
= _core_
.MM_TWIPS
311 MM_ISOTROPIC
= _core_
.MM_ISOTROPIC
312 MM_ANISOTROPIC
= _core_
.MM_ANISOTROPIC
313 MM_POINTS
= _core_
.MM_POINTS
314 MM_METRIC
= _core_
.MM_METRIC
315 CENTRE
= _core_
.CENTRE
316 CENTER
= _core_
.CENTER
317 HORIZONTAL
= _core_
.HORIZONTAL
318 VERTICAL
= _core_
.VERTICAL
325 BOTTOM
= _core_
.BOTTOM
331 ALIGN_NOT
= _core_
.ALIGN_NOT
332 ALIGN_CENTER_HORIZONTAL
= _core_
.ALIGN_CENTER_HORIZONTAL
333 ALIGN_CENTRE_HORIZONTAL
= _core_
.ALIGN_CENTRE_HORIZONTAL
334 ALIGN_LEFT
= _core_
.ALIGN_LEFT
335 ALIGN_TOP
= _core_
.ALIGN_TOP
336 ALIGN_RIGHT
= _core_
.ALIGN_RIGHT
337 ALIGN_BOTTOM
= _core_
.ALIGN_BOTTOM
338 ALIGN_CENTER_VERTICAL
= _core_
.ALIGN_CENTER_VERTICAL
339 ALIGN_CENTRE_VERTICAL
= _core_
.ALIGN_CENTRE_VERTICAL
340 ALIGN_CENTER
= _core_
.ALIGN_CENTER
341 ALIGN_CENTRE
= _core_
.ALIGN_CENTRE
342 ALIGN_MASK
= _core_
.ALIGN_MASK
343 STRETCH_NOT
= _core_
.STRETCH_NOT
344 SHRINK
= _core_
.SHRINK
346 EXPAND
= _core_
.EXPAND
347 SHAPED
= _core_
.SHAPED
348 FIXED_MINSIZE
= _core_
.FIXED_MINSIZE
350 ADJUST_MINSIZE
= _core_
.ADJUST_MINSIZE
351 BORDER_DEFAULT
= _core_
.BORDER_DEFAULT
352 BORDER_NONE
= _core_
.BORDER_NONE
353 BORDER_STATIC
= _core_
.BORDER_STATIC
354 BORDER_SIMPLE
= _core_
.BORDER_SIMPLE
355 BORDER_RAISED
= _core_
.BORDER_RAISED
356 BORDER_SUNKEN
= _core_
.BORDER_SUNKEN
357 BORDER_DOUBLE
= _core_
.BORDER_DOUBLE
358 BORDER_MASK
= _core_
.BORDER_MASK
359 BG_STYLE_SYSTEM
= _core_
.BG_STYLE_SYSTEM
360 BG_STYLE_COLOUR
= _core_
.BG_STYLE_COLOUR
361 BG_STYLE_CUSTOM
= _core_
.BG_STYLE_CUSTOM
362 DEFAULT
= _core_
.DEFAULT
363 DECORATIVE
= _core_
.DECORATIVE
365 SCRIPT
= _core_
.SCRIPT
367 MODERN
= _core_
.MODERN
368 TELETYPE
= _core_
.TELETYPE
369 VARIABLE
= _core_
.VARIABLE
371 NORMAL
= _core_
.NORMAL
374 ITALIC
= _core_
.ITALIC
378 LONG_DASH
= _core_
.LONG_DASH
379 SHORT_DASH
= _core_
.SHORT_DASH
380 DOT_DASH
= _core_
.DOT_DASH
381 USER_DASH
= _core_
.USER_DASH
382 TRANSPARENT
= _core_
.TRANSPARENT
383 STIPPLE
= _core_
.STIPPLE
384 STIPPLE_MASK
= _core_
.STIPPLE_MASK
385 STIPPLE_MASK_OPAQUE
= _core_
.STIPPLE_MASK_OPAQUE
386 BDIAGONAL_HATCH
= _core_
.BDIAGONAL_HATCH
387 CROSSDIAG_HATCH
= _core_
.CROSSDIAG_HATCH
388 FDIAGONAL_HATCH
= _core_
.FDIAGONAL_HATCH
389 CROSS_HATCH
= _core_
.CROSS_HATCH
390 HORIZONTAL_HATCH
= _core_
.HORIZONTAL_HATCH
391 VERTICAL_HATCH
= _core_
.VERTICAL_HATCH
392 JOIN_BEVEL
= _core_
.JOIN_BEVEL
393 JOIN_MITER
= _core_
.JOIN_MITER
394 JOIN_ROUND
= _core_
.JOIN_ROUND
395 CAP_ROUND
= _core_
.CAP_ROUND
396 CAP_PROJECTING
= _core_
.CAP_PROJECTING
397 CAP_BUTT
= _core_
.CAP_BUTT
400 INVERT
= _core_
.INVERT
401 OR_REVERSE
= _core_
.OR_REVERSE
402 AND_REVERSE
= _core_
.AND_REVERSE
405 AND_INVERT
= _core_
.AND_INVERT
409 SRC_INVERT
= _core_
.SRC_INVERT
410 OR_INVERT
= _core_
.OR_INVERT
414 WXK_BACK
= _core_
.WXK_BACK
415 WXK_TAB
= _core_
.WXK_TAB
416 WXK_RETURN
= _core_
.WXK_RETURN
417 WXK_ESCAPE
= _core_
.WXK_ESCAPE
418 WXK_SPACE
= _core_
.WXK_SPACE
419 WXK_DELETE
= _core_
.WXK_DELETE
420 WXK_START
= _core_
.WXK_START
421 WXK_LBUTTON
= _core_
.WXK_LBUTTON
422 WXK_RBUTTON
= _core_
.WXK_RBUTTON
423 WXK_CANCEL
= _core_
.WXK_CANCEL
424 WXK_MBUTTON
= _core_
.WXK_MBUTTON
425 WXK_CLEAR
= _core_
.WXK_CLEAR
426 WXK_SHIFT
= _core_
.WXK_SHIFT
427 WXK_ALT
= _core_
.WXK_ALT
428 WXK_CONTROL
= _core_
.WXK_CONTROL
429 WXK_MENU
= _core_
.WXK_MENU
430 WXK_PAUSE
= _core_
.WXK_PAUSE
431 WXK_CAPITAL
= _core_
.WXK_CAPITAL
432 WXK_PRIOR
= _core_
.WXK_PRIOR
433 WXK_NEXT
= _core_
.WXK_NEXT
434 WXK_END
= _core_
.WXK_END
435 WXK_HOME
= _core_
.WXK_HOME
436 WXK_LEFT
= _core_
.WXK_LEFT
437 WXK_UP
= _core_
.WXK_UP
438 WXK_RIGHT
= _core_
.WXK_RIGHT
439 WXK_DOWN
= _core_
.WXK_DOWN
440 WXK_SELECT
= _core_
.WXK_SELECT
441 WXK_PRINT
= _core_
.WXK_PRINT
442 WXK_EXECUTE
= _core_
.WXK_EXECUTE
443 WXK_SNAPSHOT
= _core_
.WXK_SNAPSHOT
444 WXK_INSERT
= _core_
.WXK_INSERT
445 WXK_HELP
= _core_
.WXK_HELP
446 WXK_NUMPAD0
= _core_
.WXK_NUMPAD0
447 WXK_NUMPAD1
= _core_
.WXK_NUMPAD1
448 WXK_NUMPAD2
= _core_
.WXK_NUMPAD2
449 WXK_NUMPAD3
= _core_
.WXK_NUMPAD3
450 WXK_NUMPAD4
= _core_
.WXK_NUMPAD4
451 WXK_NUMPAD5
= _core_
.WXK_NUMPAD5
452 WXK_NUMPAD6
= _core_
.WXK_NUMPAD6
453 WXK_NUMPAD7
= _core_
.WXK_NUMPAD7
454 WXK_NUMPAD8
= _core_
.WXK_NUMPAD8
455 WXK_NUMPAD9
= _core_
.WXK_NUMPAD9
456 WXK_MULTIPLY
= _core_
.WXK_MULTIPLY
457 WXK_ADD
= _core_
.WXK_ADD
458 WXK_SEPARATOR
= _core_
.WXK_SEPARATOR
459 WXK_SUBTRACT
= _core_
.WXK_SUBTRACT
460 WXK_DECIMAL
= _core_
.WXK_DECIMAL
461 WXK_DIVIDE
= _core_
.WXK_DIVIDE
462 WXK_F1
= _core_
.WXK_F1
463 WXK_F2
= _core_
.WXK_F2
464 WXK_F3
= _core_
.WXK_F3
465 WXK_F4
= _core_
.WXK_F4
466 WXK_F5
= _core_
.WXK_F5
467 WXK_F6
= _core_
.WXK_F6
468 WXK_F7
= _core_
.WXK_F7
469 WXK_F8
= _core_
.WXK_F8
470 WXK_F9
= _core_
.WXK_F9
471 WXK_F10
= _core_
.WXK_F10
472 WXK_F11
= _core_
.WXK_F11
473 WXK_F12
= _core_
.WXK_F12
474 WXK_F13
= _core_
.WXK_F13
475 WXK_F14
= _core_
.WXK_F14
476 WXK_F15
= _core_
.WXK_F15
477 WXK_F16
= _core_
.WXK_F16
478 WXK_F17
= _core_
.WXK_F17
479 WXK_F18
= _core_
.WXK_F18
480 WXK_F19
= _core_
.WXK_F19
481 WXK_F20
= _core_
.WXK_F20
482 WXK_F21
= _core_
.WXK_F21
483 WXK_F22
= _core_
.WXK_F22
484 WXK_F23
= _core_
.WXK_F23
485 WXK_F24
= _core_
.WXK_F24
486 WXK_NUMLOCK
= _core_
.WXK_NUMLOCK
487 WXK_SCROLL
= _core_
.WXK_SCROLL
488 WXK_PAGEUP
= _core_
.WXK_PAGEUP
489 WXK_PAGEDOWN
= _core_
.WXK_PAGEDOWN
490 WXK_NUMPAD_SPACE
= _core_
.WXK_NUMPAD_SPACE
491 WXK_NUMPAD_TAB
= _core_
.WXK_NUMPAD_TAB
492 WXK_NUMPAD_ENTER
= _core_
.WXK_NUMPAD_ENTER
493 WXK_NUMPAD_F1
= _core_
.WXK_NUMPAD_F1
494 WXK_NUMPAD_F2
= _core_
.WXK_NUMPAD_F2
495 WXK_NUMPAD_F3
= _core_
.WXK_NUMPAD_F3
496 WXK_NUMPAD_F4
= _core_
.WXK_NUMPAD_F4
497 WXK_NUMPAD_HOME
= _core_
.WXK_NUMPAD_HOME
498 WXK_NUMPAD_LEFT
= _core_
.WXK_NUMPAD_LEFT
499 WXK_NUMPAD_UP
= _core_
.WXK_NUMPAD_UP
500 WXK_NUMPAD_RIGHT
= _core_
.WXK_NUMPAD_RIGHT
501 WXK_NUMPAD_DOWN
= _core_
.WXK_NUMPAD_DOWN
502 WXK_NUMPAD_PRIOR
= _core_
.WXK_NUMPAD_PRIOR
503 WXK_NUMPAD_PAGEUP
= _core_
.WXK_NUMPAD_PAGEUP
504 WXK_NUMPAD_NEXT
= _core_
.WXK_NUMPAD_NEXT
505 WXK_NUMPAD_PAGEDOWN
= _core_
.WXK_NUMPAD_PAGEDOWN
506 WXK_NUMPAD_END
= _core_
.WXK_NUMPAD_END
507 WXK_NUMPAD_BEGIN
= _core_
.WXK_NUMPAD_BEGIN
508 WXK_NUMPAD_INSERT
= _core_
.WXK_NUMPAD_INSERT
509 WXK_NUMPAD_DELETE
= _core_
.WXK_NUMPAD_DELETE
510 WXK_NUMPAD_EQUAL
= _core_
.WXK_NUMPAD_EQUAL
511 WXK_NUMPAD_MULTIPLY
= _core_
.WXK_NUMPAD_MULTIPLY
512 WXK_NUMPAD_ADD
= _core_
.WXK_NUMPAD_ADD
513 WXK_NUMPAD_SEPARATOR
= _core_
.WXK_NUMPAD_SEPARATOR
514 WXK_NUMPAD_SUBTRACT
= _core_
.WXK_NUMPAD_SUBTRACT
515 WXK_NUMPAD_DECIMAL
= _core_
.WXK_NUMPAD_DECIMAL
516 WXK_NUMPAD_DIVIDE
= _core_
.WXK_NUMPAD_DIVIDE
517 WXK_WINDOWS_LEFT
= _core_
.WXK_WINDOWS_LEFT
518 WXK_WINDOWS_RIGHT
= _core_
.WXK_WINDOWS_RIGHT
519 WXK_WINDOWS_MENU
= _core_
.WXK_WINDOWS_MENU
520 WXK_COMMAND
= _core_
.WXK_COMMAND
521 WXK_SPECIAL1
= _core_
.WXK_SPECIAL1
522 WXK_SPECIAL2
= _core_
.WXK_SPECIAL2
523 WXK_SPECIAL3
= _core_
.WXK_SPECIAL3
524 WXK_SPECIAL4
= _core_
.WXK_SPECIAL4
525 WXK_SPECIAL5
= _core_
.WXK_SPECIAL5
526 WXK_SPECIAL6
= _core_
.WXK_SPECIAL6
527 WXK_SPECIAL7
= _core_
.WXK_SPECIAL7
528 WXK_SPECIAL8
= _core_
.WXK_SPECIAL8
529 WXK_SPECIAL9
= _core_
.WXK_SPECIAL9
530 WXK_SPECIAL10
= _core_
.WXK_SPECIAL10
531 WXK_SPECIAL11
= _core_
.WXK_SPECIAL11
532 WXK_SPECIAL12
= _core_
.WXK_SPECIAL12
533 WXK_SPECIAL13
= _core_
.WXK_SPECIAL13
534 WXK_SPECIAL14
= _core_
.WXK_SPECIAL14
535 WXK_SPECIAL15
= _core_
.WXK_SPECIAL15
536 WXK_SPECIAL16
= _core_
.WXK_SPECIAL16
537 WXK_SPECIAL17
= _core_
.WXK_SPECIAL17
538 WXK_SPECIAL18
= _core_
.WXK_SPECIAL18
539 WXK_SPECIAL19
= _core_
.WXK_SPECIAL19
540 WXK_SPECIAL20
= _core_
.WXK_SPECIAL20
541 PAPER_NONE
= _core_
.PAPER_NONE
542 PAPER_LETTER
= _core_
.PAPER_LETTER
543 PAPER_LEGAL
= _core_
.PAPER_LEGAL
544 PAPER_A4
= _core_
.PAPER_A4
545 PAPER_CSHEET
= _core_
.PAPER_CSHEET
546 PAPER_DSHEET
= _core_
.PAPER_DSHEET
547 PAPER_ESHEET
= _core_
.PAPER_ESHEET
548 PAPER_LETTERSMALL
= _core_
.PAPER_LETTERSMALL
549 PAPER_TABLOID
= _core_
.PAPER_TABLOID
550 PAPER_LEDGER
= _core_
.PAPER_LEDGER
551 PAPER_STATEMENT
= _core_
.PAPER_STATEMENT
552 PAPER_EXECUTIVE
= _core_
.PAPER_EXECUTIVE
553 PAPER_A3
= _core_
.PAPER_A3
554 PAPER_A4SMALL
= _core_
.PAPER_A4SMALL
555 PAPER_A5
= _core_
.PAPER_A5
556 PAPER_B4
= _core_
.PAPER_B4
557 PAPER_B5
= _core_
.PAPER_B5
558 PAPER_FOLIO
= _core_
.PAPER_FOLIO
559 PAPER_QUARTO
= _core_
.PAPER_QUARTO
560 PAPER_10X14
= _core_
.PAPER_10X14
561 PAPER_11X17
= _core_
.PAPER_11X17
562 PAPER_NOTE
= _core_
.PAPER_NOTE
563 PAPER_ENV_9
= _core_
.PAPER_ENV_9
564 PAPER_ENV_10
= _core_
.PAPER_ENV_10
565 PAPER_ENV_11
= _core_
.PAPER_ENV_11
566 PAPER_ENV_12
= _core_
.PAPER_ENV_12
567 PAPER_ENV_14
= _core_
.PAPER_ENV_14
568 PAPER_ENV_DL
= _core_
.PAPER_ENV_DL
569 PAPER_ENV_C5
= _core_
.PAPER_ENV_C5
570 PAPER_ENV_C3
= _core_
.PAPER_ENV_C3
571 PAPER_ENV_C4
= _core_
.PAPER_ENV_C4
572 PAPER_ENV_C6
= _core_
.PAPER_ENV_C6
573 PAPER_ENV_C65
= _core_
.PAPER_ENV_C65
574 PAPER_ENV_B4
= _core_
.PAPER_ENV_B4
575 PAPER_ENV_B5
= _core_
.PAPER_ENV_B5
576 PAPER_ENV_B6
= _core_
.PAPER_ENV_B6
577 PAPER_ENV_ITALY
= _core_
.PAPER_ENV_ITALY
578 PAPER_ENV_MONARCH
= _core_
.PAPER_ENV_MONARCH
579 PAPER_ENV_PERSONAL
= _core_
.PAPER_ENV_PERSONAL
580 PAPER_FANFOLD_US
= _core_
.PAPER_FANFOLD_US
581 PAPER_FANFOLD_STD_GERMAN
= _core_
.PAPER_FANFOLD_STD_GERMAN
582 PAPER_FANFOLD_LGL_GERMAN
= _core_
.PAPER_FANFOLD_LGL_GERMAN
583 PAPER_ISO_B4
= _core_
.PAPER_ISO_B4
584 PAPER_JAPANESE_POSTCARD
= _core_
.PAPER_JAPANESE_POSTCARD
585 PAPER_9X11
= _core_
.PAPER_9X11
586 PAPER_10X11
= _core_
.PAPER_10X11
587 PAPER_15X11
= _core_
.PAPER_15X11
588 PAPER_ENV_INVITE
= _core_
.PAPER_ENV_INVITE
589 PAPER_LETTER_EXTRA
= _core_
.PAPER_LETTER_EXTRA
590 PAPER_LEGAL_EXTRA
= _core_
.PAPER_LEGAL_EXTRA
591 PAPER_TABLOID_EXTRA
= _core_
.PAPER_TABLOID_EXTRA
592 PAPER_A4_EXTRA
= _core_
.PAPER_A4_EXTRA
593 PAPER_LETTER_TRANSVERSE
= _core_
.PAPER_LETTER_TRANSVERSE
594 PAPER_A4_TRANSVERSE
= _core_
.PAPER_A4_TRANSVERSE
595 PAPER_LETTER_EXTRA_TRANSVERSE
= _core_
.PAPER_LETTER_EXTRA_TRANSVERSE
596 PAPER_A_PLUS
= _core_
.PAPER_A_PLUS
597 PAPER_B_PLUS
= _core_
.PAPER_B_PLUS
598 PAPER_LETTER_PLUS
= _core_
.PAPER_LETTER_PLUS
599 PAPER_A4_PLUS
= _core_
.PAPER_A4_PLUS
600 PAPER_A5_TRANSVERSE
= _core_
.PAPER_A5_TRANSVERSE
601 PAPER_B5_TRANSVERSE
= _core_
.PAPER_B5_TRANSVERSE
602 PAPER_A3_EXTRA
= _core_
.PAPER_A3_EXTRA
603 PAPER_A5_EXTRA
= _core_
.PAPER_A5_EXTRA
604 PAPER_B5_EXTRA
= _core_
.PAPER_B5_EXTRA
605 PAPER_A2
= _core_
.PAPER_A2
606 PAPER_A3_TRANSVERSE
= _core_
.PAPER_A3_TRANSVERSE
607 PAPER_A3_EXTRA_TRANSVERSE
= _core_
.PAPER_A3_EXTRA_TRANSVERSE
608 PAPER_DBL_JAPANESE_POSTCARD
= _core_
.PAPER_DBL_JAPANESE_POSTCARD
609 PAPER_A6
= _core_
.PAPER_A6
610 PAPER_JENV_KAKU2
= _core_
.PAPER_JENV_KAKU2
611 PAPER_JENV_KAKU3
= _core_
.PAPER_JENV_KAKU3
612 PAPER_JENV_CHOU3
= _core_
.PAPER_JENV_CHOU3
613 PAPER_JENV_CHOU4
= _core_
.PAPER_JENV_CHOU4
614 PAPER_LETTER_ROTATED
= _core_
.PAPER_LETTER_ROTATED
615 PAPER_A3_ROTATED
= _core_
.PAPER_A3_ROTATED
616 PAPER_A4_ROTATED
= _core_
.PAPER_A4_ROTATED
617 PAPER_A5_ROTATED
= _core_
.PAPER_A5_ROTATED
618 PAPER_B4_JIS_ROTATED
= _core_
.PAPER_B4_JIS_ROTATED
619 PAPER_B5_JIS_ROTATED
= _core_
.PAPER_B5_JIS_ROTATED
620 PAPER_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_JAPANESE_POSTCARD_ROTATED
621 PAPER_DBL_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
622 PAPER_A6_ROTATED
= _core_
.PAPER_A6_ROTATED
623 PAPER_JENV_KAKU2_ROTATED
= _core_
.PAPER_JENV_KAKU2_ROTATED
624 PAPER_JENV_KAKU3_ROTATED
= _core_
.PAPER_JENV_KAKU3_ROTATED
625 PAPER_JENV_CHOU3_ROTATED
= _core_
.PAPER_JENV_CHOU3_ROTATED
626 PAPER_JENV_CHOU4_ROTATED
= _core_
.PAPER_JENV_CHOU4_ROTATED
627 PAPER_B6_JIS
= _core_
.PAPER_B6_JIS
628 PAPER_B6_JIS_ROTATED
= _core_
.PAPER_B6_JIS_ROTATED
629 PAPER_12X11
= _core_
.PAPER_12X11
630 PAPER_JENV_YOU4
= _core_
.PAPER_JENV_YOU4
631 PAPER_JENV_YOU4_ROTATED
= _core_
.PAPER_JENV_YOU4_ROTATED
632 PAPER_P16K
= _core_
.PAPER_P16K
633 PAPER_P32K
= _core_
.PAPER_P32K
634 PAPER_P32KBIG
= _core_
.PAPER_P32KBIG
635 PAPER_PENV_1
= _core_
.PAPER_PENV_1
636 PAPER_PENV_2
= _core_
.PAPER_PENV_2
637 PAPER_PENV_3
= _core_
.PAPER_PENV_3
638 PAPER_PENV_4
= _core_
.PAPER_PENV_4
639 PAPER_PENV_5
= _core_
.PAPER_PENV_5
640 PAPER_PENV_6
= _core_
.PAPER_PENV_6
641 PAPER_PENV_7
= _core_
.PAPER_PENV_7
642 PAPER_PENV_8
= _core_
.PAPER_PENV_8
643 PAPER_PENV_9
= _core_
.PAPER_PENV_9
644 PAPER_PENV_10
= _core_
.PAPER_PENV_10
645 PAPER_P16K_ROTATED
= _core_
.PAPER_P16K_ROTATED
646 PAPER_P32K_ROTATED
= _core_
.PAPER_P32K_ROTATED
647 PAPER_P32KBIG_ROTATED
= _core_
.PAPER_P32KBIG_ROTATED
648 PAPER_PENV_1_ROTATED
= _core_
.PAPER_PENV_1_ROTATED
649 PAPER_PENV_2_ROTATED
= _core_
.PAPER_PENV_2_ROTATED
650 PAPER_PENV_3_ROTATED
= _core_
.PAPER_PENV_3_ROTATED
651 PAPER_PENV_4_ROTATED
= _core_
.PAPER_PENV_4_ROTATED
652 PAPER_PENV_5_ROTATED
= _core_
.PAPER_PENV_5_ROTATED
653 PAPER_PENV_6_ROTATED
= _core_
.PAPER_PENV_6_ROTATED
654 PAPER_PENV_7_ROTATED
= _core_
.PAPER_PENV_7_ROTATED
655 PAPER_PENV_8_ROTATED
= _core_
.PAPER_PENV_8_ROTATED
656 PAPER_PENV_9_ROTATED
= _core_
.PAPER_PENV_9_ROTATED
657 PAPER_PENV_10_ROTATED
= _core_
.PAPER_PENV_10_ROTATED
658 DUPLEX_SIMPLEX
= _core_
.DUPLEX_SIMPLEX
659 DUPLEX_HORIZONTAL
= _core_
.DUPLEX_HORIZONTAL
660 DUPLEX_VERTICAL
= _core_
.DUPLEX_VERTICAL
661 ITEM_SEPARATOR
= _core_
.ITEM_SEPARATOR
662 ITEM_NORMAL
= _core_
.ITEM_NORMAL
663 ITEM_CHECK
= _core_
.ITEM_CHECK
664 ITEM_RADIO
= _core_
.ITEM_RADIO
665 ITEM_MAX
= _core_
.ITEM_MAX
666 HT_NOWHERE
= _core_
.HT_NOWHERE
667 HT_SCROLLBAR_FIRST
= _core_
.HT_SCROLLBAR_FIRST
668 HT_SCROLLBAR_ARROW_LINE_1
= _core_
.HT_SCROLLBAR_ARROW_LINE_1
669 HT_SCROLLBAR_ARROW_LINE_2
= _core_
.HT_SCROLLBAR_ARROW_LINE_2
670 HT_SCROLLBAR_ARROW_PAGE_1
= _core_
.HT_SCROLLBAR_ARROW_PAGE_1
671 HT_SCROLLBAR_ARROW_PAGE_2
= _core_
.HT_SCROLLBAR_ARROW_PAGE_2
672 HT_SCROLLBAR_THUMB
= _core_
.HT_SCROLLBAR_THUMB
673 HT_SCROLLBAR_BAR_1
= _core_
.HT_SCROLLBAR_BAR_1
674 HT_SCROLLBAR_BAR_2
= _core_
.HT_SCROLLBAR_BAR_2
675 HT_SCROLLBAR_LAST
= _core_
.HT_SCROLLBAR_LAST
676 HT_WINDOW_OUTSIDE
= _core_
.HT_WINDOW_OUTSIDE
677 HT_WINDOW_INSIDE
= _core_
.HT_WINDOW_INSIDE
678 HT_WINDOW_VERT_SCROLLBAR
= _core_
.HT_WINDOW_VERT_SCROLLBAR
679 HT_WINDOW_HORZ_SCROLLBAR
= _core_
.HT_WINDOW_HORZ_SCROLLBAR
680 HT_WINDOW_CORNER
= _core_
.HT_WINDOW_CORNER
681 HT_MAX
= _core_
.HT_MAX
682 MOD_NONE
= _core_
.MOD_NONE
683 MOD_ALT
= _core_
.MOD_ALT
684 MOD_CONTROL
= _core_
.MOD_CONTROL
685 MOD_ALTGR
= _core_
.MOD_ALTGR
686 MOD_SHIFT
= _core_
.MOD_SHIFT
687 MOD_META
= _core_
.MOD_META
688 MOD_WIN
= _core_
.MOD_WIN
689 MOD_CMD
= _core_
.MOD_CMD
690 MOD_ALL
= _core_
.MOD_ALL
691 UPDATE_UI_NONE
= _core_
.UPDATE_UI_NONE
692 UPDATE_UI_RECURSE
= _core_
.UPDATE_UI_RECURSE
693 UPDATE_UI_FROMIDLE
= _core_
.UPDATE_UI_FROMIDLE
694 #---------------------------------------------------------------------------
696 class Object(object):
698 The base class for most wx objects, although in wxPython not
699 much functionality is needed nor exposed.
701 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
702 def __init__(self
): raise AttributeError, "No constructor defined"
703 __repr__
= _swig_repr
704 def GetClassName(*args
, **kwargs
):
706 GetClassName(self) -> String
708 Returns the class name of the C++ class using wxRTTI.
710 return _core_
.Object_GetClassName(*args
, **kwargs
)
712 def Destroy(*args
, **kwargs
):
716 Deletes the C++ object this Python object is a proxy for.
718 val
= _core_
.Object_Destroy(*args
, **kwargs
)
722 Object_swigregister
= _core_
.Object_swigregister
723 Object_swigregister(Object
)
724 _wxPySetDictionary
= _core_
._wxPySetDictionary
725 _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 contains integer width and height
788 properties. In most places in wxPython where a wx.Size is
789 expected a (width, height) tuple can be used instead.
791 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
792 __repr__
= _swig_repr
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 _core_
.Size_swiginit(self
,_core_
.new_Size(*args
, **kwargs
))
803 __swig_destroy__
= _core_
.delete_Size
804 __del__
= lambda self
: None;
805 def __eq__(*args
, **kwargs
):
807 __eq__(self, Size sz) -> bool
809 Test for equality of wx.Size objects.
811 return _core_
.Size___eq__(*args
, **kwargs
)
813 def __ne__(*args
, **kwargs
):
815 __ne__(self, Size sz) -> bool
819 return _core_
.Size___ne__(*args
, **kwargs
)
821 def __add__(*args
, **kwargs
):
823 __add__(self, Size sz) -> Size
825 Add sz's proprties to this and return the result.
827 return _core_
.Size___add__(*args
, **kwargs
)
829 def __sub__(*args
, **kwargs
):
831 __sub__(self, Size sz) -> Size
833 Subtract sz's properties from this and return the result.
835 return _core_
.Size___sub__(*args
, **kwargs
)
837 def IncTo(*args
, **kwargs
):
841 Increments this object so that both of its dimensions are not less
842 than the corresponding dimensions of the size.
844 return _core_
.Size_IncTo(*args
, **kwargs
)
846 def DecTo(*args
, **kwargs
):
850 Decrements this object so that both of its dimensions are not greater
851 than the corresponding dimensions of the size.
853 return _core_
.Size_DecTo(*args
, **kwargs
)
855 def Set(*args
, **kwargs
):
857 Set(self, int w, int h)
859 Set both width and height.
861 return _core_
.Size_Set(*args
, **kwargs
)
863 def SetWidth(*args
, **kwargs
):
864 """SetWidth(self, int w)"""
865 return _core_
.Size_SetWidth(*args
, **kwargs
)
867 def SetHeight(*args
, **kwargs
):
868 """SetHeight(self, int h)"""
869 return _core_
.Size_SetHeight(*args
, **kwargs
)
871 def GetWidth(*args
, **kwargs
):
872 """GetWidth(self) -> int"""
873 return _core_
.Size_GetWidth(*args
, **kwargs
)
875 def GetHeight(*args
, **kwargs
):
876 """GetHeight(self) -> int"""
877 return _core_
.Size_GetHeight(*args
, **kwargs
)
879 def IsFullySpecified(*args
, **kwargs
):
881 IsFullySpecified(self) -> bool
883 Returns True if both components of the size are non-default values.
885 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
887 def SetDefaults(*args
, **kwargs
):
889 SetDefaults(self, Size size)
891 Combine this size with the other one replacing the default components
892 of this object (i.e. equal to -1) with those of the other.
894 return _core_
.Size_SetDefaults(*args
, **kwargs
)
896 def Get(*args
, **kwargs
):
898 Get() -> (width,height)
900 Returns the width and height properties as a tuple.
902 return _core_
.Size_Get(*args
, **kwargs
)
904 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
905 def __str__(self
): return str(self
.Get())
906 def __repr__(self
): return 'wx.Size'+str(self
.Get())
907 def __len__(self
): return len(self
.Get())
908 def __getitem__(self
, index
): return self
.Get()[index
]
909 def __setitem__(self
, index
, val
):
910 if index
== 0: self
.width
= val
911 elif index
== 1: self
.height
= val
912 else: raise IndexError
913 def __nonzero__(self
): return self
.Get() != (0,0)
914 __safe_for_unpickling__
= True
915 def __reduce__(self
): return (wx
.Size
, self
.Get())
917 Size_swigregister
= _core_
.Size_swigregister
918 Size_swigregister(Size
)
920 #---------------------------------------------------------------------------
922 class RealPoint(object):
924 A data structure for representing a point or position with floating
925 point x and y properties. In wxPython most places that expect a
926 wx.RealPoint can also accept a (x,y) tuple.
928 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
929 __repr__
= _swig_repr
930 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
931 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
932 def __init__(self
, *args
, **kwargs
):
934 __init__(self, double x=0.0, double y=0.0) -> RealPoint
936 Create a wx.RealPoint object
938 _core_
.RealPoint_swiginit(self
,_core_
.new_RealPoint(*args
, **kwargs
))
939 __swig_destroy__
= _core_
.delete_RealPoint
940 __del__
= lambda self
: None;
941 def __eq__(*args
, **kwargs
):
943 __eq__(self, RealPoint pt) -> bool
945 Test for equality of wx.RealPoint objects.
947 return _core_
.RealPoint___eq__(*args
, **kwargs
)
949 def __ne__(*args
, **kwargs
):
951 __ne__(self, RealPoint pt) -> bool
953 Test for inequality of wx.RealPoint objects.
955 return _core_
.RealPoint___ne__(*args
, **kwargs
)
957 def __add__(*args
, **kwargs
):
959 __add__(self, RealPoint pt) -> RealPoint
961 Add pt's proprties to this and return the result.
963 return _core_
.RealPoint___add__(*args
, **kwargs
)
965 def __sub__(*args
, **kwargs
):
967 __sub__(self, RealPoint pt) -> RealPoint
969 Subtract pt's proprties from this and return the result
971 return _core_
.RealPoint___sub__(*args
, **kwargs
)
973 def Set(*args
, **kwargs
):
975 Set(self, double x, double y)
977 Set both the x and y properties
979 return _core_
.RealPoint_Set(*args
, **kwargs
)
981 def Get(*args
, **kwargs
):
985 Return the x and y properties as a tuple.
987 return _core_
.RealPoint_Get(*args
, **kwargs
)
989 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
990 def __str__(self
): return str(self
.Get())
991 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
992 def __len__(self
): return len(self
.Get())
993 def __getitem__(self
, index
): return self
.Get()[index
]
994 def __setitem__(self
, index
, val
):
995 if index
== 0: self
.x
= val
996 elif index
== 1: self
.y
= val
997 else: raise IndexError
998 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
999 __safe_for_unpickling__
= True
1000 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
1002 RealPoint_swigregister
= _core_
.RealPoint_swigregister
1003 RealPoint_swigregister(RealPoint
)
1005 #---------------------------------------------------------------------------
1007 class Point(object):
1009 A data structure for representing a point or position with integer x
1010 and y properties. Most places in wxPython that expect a wx.Point can
1011 also accept a (x,y) tuple.
1013 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1014 __repr__
= _swig_repr
1015 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1016 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1017 def __init__(self
, *args
, **kwargs
):
1019 __init__(self, int x=0, int y=0) -> Point
1021 Create a wx.Point object
1023 _core_
.Point_swiginit(self
,_core_
.new_Point(*args
, **kwargs
))
1024 __swig_destroy__
= _core_
.delete_Point
1025 __del__
= lambda self
: None;
1026 def __eq__(*args
, **kwargs
):
1028 __eq__(self, Point pt) -> bool
1030 Test for equality of wx.Point objects.
1032 return _core_
.Point___eq__(*args
, **kwargs
)
1034 def __ne__(*args
, **kwargs
):
1036 __ne__(self, Point pt) -> bool
1038 Test for inequality of wx.Point objects.
1040 return _core_
.Point___ne__(*args
, **kwargs
)
1042 def __add__(*args
, **kwargs
):
1044 __add__(self, Point pt) -> Point
1046 Add pt's proprties to this and return the result.
1048 return _core_
.Point___add__(*args
, **kwargs
)
1050 def __sub__(*args
, **kwargs
):
1052 __sub__(self, Point pt) -> Point
1054 Subtract pt's proprties from this and return the result
1056 return _core_
.Point___sub__(*args
, **kwargs
)
1058 def __iadd__(*args
, **kwargs
):
1060 __iadd__(self, Point pt) -> Point
1062 Add pt to this object.
1064 return _core_
.Point___iadd__(*args
, **kwargs
)
1066 def __isub__(*args
, **kwargs
):
1068 __isub__(self, Point pt) -> Point
1070 Subtract pt from this object.
1072 return _core_
.Point___isub__(*args
, **kwargs
)
1074 def Set(*args
, **kwargs
):
1076 Set(self, long x, long y)
1078 Set both the x and y properties
1080 return _core_
.Point_Set(*args
, **kwargs
)
1082 def Get(*args
, **kwargs
):
1086 Return the x and y properties as a tuple.
1088 return _core_
.Point_Get(*args
, **kwargs
)
1090 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1091 def __str__(self
): return str(self
.Get())
1092 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1093 def __len__(self
): return len(self
.Get())
1094 def __getitem__(self
, index
): return self
.Get()[index
]
1095 def __setitem__(self
, index
, val
):
1096 if index
== 0: self
.x
= val
1097 elif index
== 1: self
.y
= val
1098 else: raise IndexError
1099 def __nonzero__(self
): return self
.Get() != (0,0)
1100 __safe_for_unpickling__
= True
1101 def __reduce__(self
): return (wx
.Point
, self
.Get())
1103 Point_swigregister
= _core_
.Point_swigregister
1104 Point_swigregister(Point
)
1106 #---------------------------------------------------------------------------
1110 A class for representing and manipulating rectangles. It has x, y,
1111 width and height properties. In wxPython most palces that expect a
1112 wx.Rect can also accept a (x,y,width,height) tuple.
1114 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1115 __repr__
= _swig_repr
1116 def __init__(self
, *args
, **kwargs
):
1118 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1120 Create a new Rect object.
1122 _core_
.Rect_swiginit(self
,_core_
.new_Rect(*args
, **kwargs
))
1123 __swig_destroy__
= _core_
.delete_Rect
1124 __del__
= lambda self
: None;
1125 def GetX(*args
, **kwargs
):
1126 """GetX(self) -> int"""
1127 return _core_
.Rect_GetX(*args
, **kwargs
)
1129 def SetX(*args
, **kwargs
):
1130 """SetX(self, int x)"""
1131 return _core_
.Rect_SetX(*args
, **kwargs
)
1133 def GetY(*args
, **kwargs
):
1134 """GetY(self) -> int"""
1135 return _core_
.Rect_GetY(*args
, **kwargs
)
1137 def SetY(*args
, **kwargs
):
1138 """SetY(self, int y)"""
1139 return _core_
.Rect_SetY(*args
, **kwargs
)
1141 def GetWidth(*args
, **kwargs
):
1142 """GetWidth(self) -> int"""
1143 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1145 def SetWidth(*args
, **kwargs
):
1146 """SetWidth(self, int w)"""
1147 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1149 def GetHeight(*args
, **kwargs
):
1150 """GetHeight(self) -> int"""
1151 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1153 def SetHeight(*args
, **kwargs
):
1154 """SetHeight(self, int h)"""
1155 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1157 def GetPosition(*args
, **kwargs
):
1158 """GetPosition(self) -> Point"""
1159 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1161 def SetPosition(*args
, **kwargs
):
1162 """SetPosition(self, Point p)"""
1163 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1165 def GetSize(*args
, **kwargs
):
1166 """GetSize(self) -> Size"""
1167 return _core_
.Rect_GetSize(*args
, **kwargs
)
1169 def SetSize(*args
, **kwargs
):
1170 """SetSize(self, Size s)"""
1171 return _core_
.Rect_SetSize(*args
, **kwargs
)
1173 def IsEmpty(*args
, **kwargs
):
1174 """IsEmpty(self) -> bool"""
1175 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1177 def GetTopLeft(*args
, **kwargs
):
1178 """GetTopLeft(self) -> Point"""
1179 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1181 def SetTopLeft(*args
, **kwargs
):
1182 """SetTopLeft(self, Point p)"""
1183 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1185 def GetBottomRight(*args
, **kwargs
):
1186 """GetBottomRight(self) -> Point"""
1187 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1189 def SetBottomRight(*args
, **kwargs
):
1190 """SetBottomRight(self, Point p)"""
1191 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1193 def GetLeft(*args
, **kwargs
):
1194 """GetLeft(self) -> int"""
1195 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1197 def GetTop(*args
, **kwargs
):
1198 """GetTop(self) -> int"""
1199 return _core_
.Rect_GetTop(*args
, **kwargs
)
1201 def GetBottom(*args
, **kwargs
):
1202 """GetBottom(self) -> int"""
1203 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1205 def GetRight(*args
, **kwargs
):
1206 """GetRight(self) -> int"""
1207 return _core_
.Rect_GetRight(*args
, **kwargs
)
1209 def SetLeft(*args
, **kwargs
):
1210 """SetLeft(self, int left)"""
1211 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1213 def SetRight(*args
, **kwargs
):
1214 """SetRight(self, int right)"""
1215 return _core_
.Rect_SetRight(*args
, **kwargs
)
1217 def SetTop(*args
, **kwargs
):
1218 """SetTop(self, int top)"""
1219 return _core_
.Rect_SetTop(*args
, **kwargs
)
1221 def SetBottom(*args
, **kwargs
):
1222 """SetBottom(self, int bottom)"""
1223 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1225 position
= property(GetPosition
, SetPosition
)
1226 size
= property(GetSize
, SetSize
)
1227 left
= property(GetLeft
, SetLeft
)
1228 right
= property(GetRight
, SetRight
)
1229 top
= property(GetTop
, SetTop
)
1230 bottom
= property(GetBottom
, SetBottom
)
1232 def Inflate(*args
, **kwargs
):
1234 Inflate(self, int dx, int dy) -> Rect
1236 Increases the size of the rectangle.
1238 The left border is moved farther left and the right border is moved
1239 farther right by ``dx``. The upper border is moved farther up and the
1240 bottom border is moved farther down by ``dy``. (Note the the width and
1241 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1242 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1243 opposite happens: the rectangle size decreases in the respective
1246 The change is made to the rectangle inplace, if instead you need a
1247 copy that is inflated, preserving the original then make the copy
1250 copy = wx.Rect(*original)
1255 return _core_
.Rect_Inflate(*args
, **kwargs
)
1257 def Deflate(*args
, **kwargs
):
1259 Deflate(self, int dx, int dy) -> Rect
1261 Decrease the rectangle size. This method is the opposite of `Inflate`
1262 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1263 `Inflate` for a full description.
1265 return _core_
.Rect_Deflate(*args
, **kwargs
)
1267 def OffsetXY(*args
, **kwargs
):
1269 OffsetXY(self, int dx, int dy)
1271 Moves the rectangle by the specified offset. If dx is positive, the
1272 rectangle is moved to the right, if dy is positive, it is moved to the
1273 bottom, otherwise it is moved to the left or top respectively.
1275 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1277 def Offset(*args
, **kwargs
):
1279 Offset(self, Point pt)
1281 Same as `OffsetXY` but uses dx,dy from Point
1283 return _core_
.Rect_Offset(*args
, **kwargs
)
1285 def Intersect(*args
, **kwargs
):
1287 Intersect(self, Rect rect) -> Rect
1289 Returns the intersectsion of this rectangle and rect.
1291 return _core_
.Rect_Intersect(*args
, **kwargs
)
1293 def Union(*args
, **kwargs
):
1295 Union(self, Rect rect) -> Rect
1297 Returns the union of this rectangle and rect.
1299 return _core_
.Rect_Union(*args
, **kwargs
)
1301 def __add__(*args
, **kwargs
):
1303 __add__(self, Rect rect) -> Rect
1305 Add the properties of rect to this rectangle and return the result.
1307 return _core_
.Rect___add__(*args
, **kwargs
)
1309 def __iadd__(*args
, **kwargs
):
1311 __iadd__(self, Rect rect) -> Rect
1313 Add the properties of rect to this rectangle, updating this rectangle.
1315 return _core_
.Rect___iadd__(*args
, **kwargs
)
1317 def __eq__(*args
, **kwargs
):
1319 __eq__(self, Rect rect) -> bool
1323 return _core_
.Rect___eq__(*args
, **kwargs
)
1325 def __ne__(*args
, **kwargs
):
1327 __ne__(self, Rect rect) -> bool
1329 Test for inequality.
1331 return _core_
.Rect___ne__(*args
, **kwargs
)
1333 def InsideXY(*args
, **kwargs
):
1335 InsideXY(self, int x, int y) -> bool
1337 Return True if the point is (not strcitly) inside the rect.
1339 return _core_
.Rect_InsideXY(*args
, **kwargs
)
1341 def Inside(*args
, **kwargs
):
1343 Inside(self, Point pt) -> bool
1345 Return True if the point is (not strcitly) inside the rect.
1347 return _core_
.Rect_Inside(*args
, **kwargs
)
1349 def Intersects(*args
, **kwargs
):
1351 Intersects(self, Rect rect) -> bool
1353 Returns True if the rectangles have a non empty intersection.
1355 return _core_
.Rect_Intersects(*args
, **kwargs
)
1357 def CenterIn(*args
, **kwargs
):
1359 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1361 Center this rectangle within the one passed to the method, which is
1362 usually, but not necessarily, the larger one.
1364 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1367 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1368 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1369 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1370 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1371 def Set(*args
, **kwargs
):
1373 Set(self, int x=0, int y=0, int width=0, int height=0)
1375 Set all rectangle properties.
1377 return _core_
.Rect_Set(*args
, **kwargs
)
1379 def Get(*args
, **kwargs
):
1381 Get() -> (x,y,width,height)
1383 Return the rectangle properties as a tuple.
1385 return _core_
.Rect_Get(*args
, **kwargs
)
1387 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1388 def __str__(self
): return str(self
.Get())
1389 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1390 def __len__(self
): return len(self
.Get())
1391 def __getitem__(self
, index
): return self
.Get()[index
]
1392 def __setitem__(self
, index
, val
):
1393 if index
== 0: self
.x
= val
1394 elif index
== 1: self
.y
= val
1395 elif index
== 2: self
.width
= val
1396 elif index
== 3: self
.height
= val
1397 else: raise IndexError
1398 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1399 __safe_for_unpickling__
= True
1400 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1402 Rect_swigregister
= _core_
.Rect_swigregister
1403 Rect_swigregister(Rect
)
1405 def RectPP(*args
, **kwargs
):
1407 RectPP(Point topLeft, Point bottomRight) -> Rect
1409 Create a new Rect object from Points representing two corners.
1411 val
= _core_
.new_RectPP(*args
, **kwargs
)
1414 def RectPS(*args
, **kwargs
):
1416 RectPS(Point pos, Size size) -> Rect
1418 Create a new Rect from a position and size.
1420 val
= _core_
.new_RectPS(*args
, **kwargs
)
1423 def RectS(*args
, **kwargs
):
1425 RectS(Size size) -> Rect
1427 Create a new Rect from a size only.
1429 val
= _core_
.new_RectS(*args
, **kwargs
)
1433 def IntersectRect(*args
, **kwargs
):
1435 IntersectRect(Rect r1, Rect r2) -> Rect
1437 Calculate and return the intersection of r1 and r2.
1439 return _core_
.IntersectRect(*args
, **kwargs
)
1440 #---------------------------------------------------------------------------
1442 class Point2D(object):
1444 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1445 with floating point values.
1447 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1448 __repr__
= _swig_repr
1449 def __init__(self
, *args
, **kwargs
):
1451 __init__(self, double x=0.0, double y=0.0) -> Point2D
1453 Create a w.Point2D object.
1455 _core_
.Point2D_swiginit(self
,_core_
.new_Point2D(*args
, **kwargs
))
1456 def GetFloor(*args
, **kwargs
):
1462 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1464 def GetRounded(*args
, **kwargs
):
1466 GetRounded() -> (x,y)
1470 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1472 def GetVectorLength(*args
, **kwargs
):
1473 """GetVectorLength(self) -> double"""
1474 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1476 def GetVectorAngle(*args
, **kwargs
):
1477 """GetVectorAngle(self) -> double"""
1478 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1480 def SetVectorLength(*args
, **kwargs
):
1481 """SetVectorLength(self, double length)"""
1482 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1484 def SetVectorAngle(*args
, **kwargs
):
1485 """SetVectorAngle(self, double degrees)"""
1486 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1488 def SetPolarCoordinates(self
, angle
, length
):
1489 self
.SetVectorLength(length
)
1490 self
.SetVectorAngle(angle
)
1491 def Normalize(self
):
1492 self
.SetVectorLength(1.0)
1494 def GetDistance(*args
, **kwargs
):
1495 """GetDistance(self, Point2D pt) -> double"""
1496 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1498 def GetDistanceSquare(*args
, **kwargs
):
1499 """GetDistanceSquare(self, Point2D pt) -> double"""
1500 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1502 def GetDotProduct(*args
, **kwargs
):
1503 """GetDotProduct(self, Point2D vec) -> double"""
1504 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1506 def GetCrossProduct(*args
, **kwargs
):
1507 """GetCrossProduct(self, Point2D vec) -> double"""
1508 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1510 def __neg__(*args
, **kwargs
):
1512 __neg__(self) -> Point2D
1514 the reflection of this point
1516 return _core_
.Point2D___neg__(*args
, **kwargs
)
1518 def __iadd__(*args
, **kwargs
):
1519 """__iadd__(self, Point2D pt) -> Point2D"""
1520 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1522 def __isub__(*args
, **kwargs
):
1523 """__isub__(self, Point2D pt) -> Point2D"""
1524 return _core_
.Point2D___isub__(*args
, **kwargs
)
1526 def __imul__(*args
, **kwargs
):
1527 """__imul__(self, Point2D pt) -> Point2D"""
1528 return _core_
.Point2D___imul__(*args
, **kwargs
)
1530 def __idiv__(*args
, **kwargs
):
1531 """__idiv__(self, Point2D pt) -> Point2D"""
1532 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1534 def __eq__(*args
, **kwargs
):
1536 __eq__(self, Point2D pt) -> bool
1540 return _core_
.Point2D___eq__(*args
, **kwargs
)
1542 def __ne__(*args
, **kwargs
):
1544 __ne__(self, Point2D pt) -> bool
1548 return _core_
.Point2D___ne__(*args
, **kwargs
)
1550 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1551 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1552 def Set(*args
, **kwargs
):
1553 """Set(self, double x=0, double y=0)"""
1554 return _core_
.Point2D_Set(*args
, **kwargs
)
1556 def Get(*args
, **kwargs
):
1560 Return x and y properties as a tuple.
1562 return _core_
.Point2D_Get(*args
, **kwargs
)
1564 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1565 def __str__(self
): return str(self
.Get())
1566 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1567 def __len__(self
): return len(self
.Get())
1568 def __getitem__(self
, index
): return self
.Get()[index
]
1569 def __setitem__(self
, index
, val
):
1570 if index
== 0: self
.x
= val
1571 elif index
== 1: self
.y
= val
1572 else: raise IndexError
1573 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1574 __safe_for_unpickling__
= True
1575 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1577 Point2D_swigregister
= _core_
.Point2D_swigregister
1578 Point2D_swigregister(Point2D
)
1580 def Point2DCopy(*args
, **kwargs
):
1582 Point2DCopy(Point2D pt) -> Point2D
1584 Create a w.Point2D object.
1586 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1589 def Point2DFromPoint(*args
, **kwargs
):
1591 Point2DFromPoint(Point pt) -> Point2D
1593 Create a w.Point2D object.
1595 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1598 #---------------------------------------------------------------------------
1600 FromStart
= _core_
.FromStart
1601 FromCurrent
= _core_
.FromCurrent
1602 FromEnd
= _core_
.FromEnd
1603 class InputStream(object):
1604 """Proxy of C++ InputStream class"""
1605 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1606 __repr__
= _swig_repr
1607 def __init__(self
, *args
, **kwargs
):
1608 """__init__(self, PyObject p) -> InputStream"""
1609 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1610 __swig_destroy__
= _core_
.delete_InputStream
1611 __del__
= lambda self
: None;
1612 def close(*args
, **kwargs
):
1614 return _core_
.InputStream_close(*args
, **kwargs
)
1616 def flush(*args
, **kwargs
):
1618 return _core_
.InputStream_flush(*args
, **kwargs
)
1620 def eof(*args
, **kwargs
):
1621 """eof(self) -> bool"""
1622 return _core_
.InputStream_eof(*args
, **kwargs
)
1624 def read(*args
, **kwargs
):
1625 """read(self, int size=-1) -> PyObject"""
1626 return _core_
.InputStream_read(*args
, **kwargs
)
1628 def readline(*args
, **kwargs
):
1629 """readline(self, int size=-1) -> PyObject"""
1630 return _core_
.InputStream_readline(*args
, **kwargs
)
1632 def readlines(*args
, **kwargs
):
1633 """readlines(self, int sizehint=-1) -> PyObject"""
1634 return _core_
.InputStream_readlines(*args
, **kwargs
)
1636 def seek(*args
, **kwargs
):
1637 """seek(self, int offset, int whence=0)"""
1638 return _core_
.InputStream_seek(*args
, **kwargs
)
1640 def tell(*args
, **kwargs
):
1641 """tell(self) -> int"""
1642 return _core_
.InputStream_tell(*args
, **kwargs
)
1644 def Peek(*args
, **kwargs
):
1645 """Peek(self) -> char"""
1646 return _core_
.InputStream_Peek(*args
, **kwargs
)
1648 def GetC(*args
, **kwargs
):
1649 """GetC(self) -> char"""
1650 return _core_
.InputStream_GetC(*args
, **kwargs
)
1652 def LastRead(*args
, **kwargs
):
1653 """LastRead(self) -> size_t"""
1654 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1656 def CanRead(*args
, **kwargs
):
1657 """CanRead(self) -> bool"""
1658 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1660 def Eof(*args
, **kwargs
):
1661 """Eof(self) -> bool"""
1662 return _core_
.InputStream_Eof(*args
, **kwargs
)
1664 def Ungetch(*args
, **kwargs
):
1665 """Ungetch(self, char c) -> bool"""
1666 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1668 def SeekI(*args
, **kwargs
):
1669 """SeekI(self, long pos, int mode=FromStart) -> long"""
1670 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1672 def TellI(*args
, **kwargs
):
1673 """TellI(self) -> long"""
1674 return _core_
.InputStream_TellI(*args
, **kwargs
)
1676 InputStream_swigregister
= _core_
.InputStream_swigregister
1677 InputStream_swigregister(InputStream
)
1678 DefaultPosition
= cvar
.DefaultPosition
1679 DefaultSize
= cvar
.DefaultSize
1681 class OutputStream(object):
1682 """Proxy of C++ OutputStream class"""
1683 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1684 def __init__(self
): raise AttributeError, "No constructor defined"
1685 __repr__
= _swig_repr
1686 def write(*args
, **kwargs
):
1687 """write(self, PyObject obj)"""
1688 return _core_
.OutputStream_write(*args
, **kwargs
)
1690 def LastWrite(*args
, **kwargs
):
1691 """LastWrite(self) -> size_t"""
1692 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
1694 OutputStream_swigregister
= _core_
.OutputStream_swigregister
1695 OutputStream_swigregister(OutputStream
)
1697 #---------------------------------------------------------------------------
1699 class FSFile(Object
):
1700 """Proxy of C++ FSFile class"""
1701 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1702 __repr__
= _swig_repr
1703 def __init__(self
, *args
, **kwargs
):
1705 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1706 DateTime modif) -> FSFile
1708 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
1709 self
.thisown
= 0 # It will normally be deleted by the user of the wx.FileSystem
1711 __swig_destroy__
= _core_
.delete_FSFile
1712 __del__
= lambda self
: None;
1713 def GetStream(*args
, **kwargs
):
1714 """GetStream(self) -> InputStream"""
1715 return _core_
.FSFile_GetStream(*args
, **kwargs
)
1717 def GetMimeType(*args
, **kwargs
):
1718 """GetMimeType(self) -> String"""
1719 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
1721 def GetLocation(*args
, **kwargs
):
1722 """GetLocation(self) -> String"""
1723 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
1725 def GetAnchor(*args
, **kwargs
):
1726 """GetAnchor(self) -> String"""
1727 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
1729 def GetModificationTime(*args
, **kwargs
):
1730 """GetModificationTime(self) -> DateTime"""
1731 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
1733 FSFile_swigregister
= _core_
.FSFile_swigregister
1734 FSFile_swigregister(FSFile
)
1736 class CPPFileSystemHandler(object):
1737 """Proxy of C++ CPPFileSystemHandler class"""
1738 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1739 def __init__(self
): raise AttributeError, "No constructor defined"
1740 __repr__
= _swig_repr
1741 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
1742 __del__
= lambda self
: None;
1743 CPPFileSystemHandler_swigregister
= _core_
.CPPFileSystemHandler_swigregister
1744 CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
1746 class FileSystemHandler(CPPFileSystemHandler
):
1747 """Proxy of C++ FileSystemHandler class"""
1748 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1749 __repr__
= _swig_repr
1750 def __init__(self
, *args
, **kwargs
):
1751 """__init__(self) -> FileSystemHandler"""
1752 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
1753 self
._setCallbackInfo
(self
, FileSystemHandler
)
1755 def _setCallbackInfo(*args
, **kwargs
):
1756 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1757 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
1759 def CanOpen(*args
, **kwargs
):
1760 """CanOpen(self, String location) -> bool"""
1761 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
1763 def OpenFile(*args
, **kwargs
):
1764 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1765 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
1767 def FindFirst(*args
, **kwargs
):
1768 """FindFirst(self, String spec, int flags=0) -> String"""
1769 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
1771 def FindNext(*args
, **kwargs
):
1772 """FindNext(self) -> String"""
1773 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
1775 def GetProtocol(*args
, **kwargs
):
1776 """GetProtocol(self, String location) -> String"""
1777 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
1779 def GetLeftLocation(*args
, **kwargs
):
1780 """GetLeftLocation(self, String location) -> String"""
1781 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
1783 def GetAnchor(*args
, **kwargs
):
1784 """GetAnchor(self, String location) -> String"""
1785 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
1787 def GetRightLocation(*args
, **kwargs
):
1788 """GetRightLocation(self, String location) -> String"""
1789 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
1791 def GetMimeTypeFromExt(*args
, **kwargs
):
1792 """GetMimeTypeFromExt(self, String location) -> String"""
1793 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
1795 FileSystemHandler_swigregister
= _core_
.FileSystemHandler_swigregister
1796 FileSystemHandler_swigregister(FileSystemHandler
)
1798 class FileSystem(Object
):
1799 """Proxy of C++ FileSystem class"""
1800 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1801 __repr__
= _swig_repr
1802 def __init__(self
, *args
, **kwargs
):
1803 """__init__(self) -> FileSystem"""
1804 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
1805 __swig_destroy__
= _core_
.delete_FileSystem
1806 __del__
= lambda self
: None;
1807 def ChangePathTo(*args
, **kwargs
):
1808 """ChangePathTo(self, String location, bool is_dir=False)"""
1809 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
1811 def GetPath(*args
, **kwargs
):
1812 """GetPath(self) -> String"""
1813 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
1815 def OpenFile(*args
, **kwargs
):
1816 """OpenFile(self, String location) -> FSFile"""
1817 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
1819 def FindFirst(*args
, **kwargs
):
1820 """FindFirst(self, String spec, int flags=0) -> String"""
1821 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
1823 def FindNext(*args
, **kwargs
):
1824 """FindNext(self) -> String"""
1825 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
1827 def AddHandler(*args
, **kwargs
):
1828 """AddHandler(CPPFileSystemHandler handler)"""
1829 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1831 AddHandler
= staticmethod(AddHandler
)
1832 def CleanUpHandlers(*args
, **kwargs
):
1833 """CleanUpHandlers()"""
1834 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
1836 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
1837 def FileNameToURL(*args
, **kwargs
):
1838 """FileNameToURL(String filename) -> String"""
1839 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1841 FileNameToURL
= staticmethod(FileNameToURL
)
1842 def URLToFileName(*args
, **kwargs
):
1843 """URLToFileName(String url) -> String"""
1844 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1846 URLToFileName
= staticmethod(URLToFileName
)
1847 FileSystem_swigregister
= _core_
.FileSystem_swigregister
1848 FileSystem_swigregister(FileSystem
)
1850 def FileSystem_AddHandler(*args
, **kwargs
):
1851 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1852 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1854 def FileSystem_CleanUpHandlers(*args
):
1855 """FileSystem_CleanUpHandlers()"""
1856 return _core_
.FileSystem_CleanUpHandlers(*args
)
1858 def FileSystem_FileNameToURL(*args
, **kwargs
):
1859 """FileSystem_FileNameToURL(String filename) -> String"""
1860 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1862 def FileSystem_URLToFileName(*args
, **kwargs
):
1863 """FileSystem_URLToFileName(String url) -> String"""
1864 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1866 class InternetFSHandler(CPPFileSystemHandler
):
1867 """Proxy of C++ InternetFSHandler class"""
1868 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1869 __repr__
= _swig_repr
1870 def __init__(self
, *args
, **kwargs
):
1871 """__init__(self) -> InternetFSHandler"""
1872 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
1873 def CanOpen(*args
, **kwargs
):
1874 """CanOpen(self, String location) -> bool"""
1875 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
1877 def OpenFile(*args
, **kwargs
):
1878 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1879 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
1881 InternetFSHandler_swigregister
= _core_
.InternetFSHandler_swigregister
1882 InternetFSHandler_swigregister(InternetFSHandler
)
1884 class ZipFSHandler(CPPFileSystemHandler
):
1885 """Proxy of C++ ZipFSHandler class"""
1886 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1887 __repr__
= _swig_repr
1888 def __init__(self
, *args
, **kwargs
):
1889 """__init__(self) -> ZipFSHandler"""
1890 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
1891 def CanOpen(*args
, **kwargs
):
1892 """CanOpen(self, String location) -> bool"""
1893 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
1895 def OpenFile(*args
, **kwargs
):
1896 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1897 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
1899 def FindFirst(*args
, **kwargs
):
1900 """FindFirst(self, String spec, int flags=0) -> String"""
1901 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
1903 def FindNext(*args
, **kwargs
):
1904 """FindNext(self) -> String"""
1905 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
1907 ZipFSHandler_swigregister
= _core_
.ZipFSHandler_swigregister
1908 ZipFSHandler_swigregister(ZipFSHandler
)
1911 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
1912 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1913 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
1915 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
1916 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1917 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
1919 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
1920 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1921 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
1922 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
1924 Add 'file' to the memory filesystem. The dataItem parameter can
1925 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1926 arbitrary data. If a bitmap or image is used then the imgType
1927 parameter should specify what kind of image file it should be
1928 written as, wx.BITMAP_TYPE_PNG, etc.
1930 if isinstance(dataItem
, wx
.Image
):
1931 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
1932 elif isinstance(dataItem
, wx
.Bitmap
):
1933 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
1934 elif type(dataItem
) == str:
1935 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
1937 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1939 class MemoryFSHandler(CPPFileSystemHandler
):
1940 """Proxy of C++ MemoryFSHandler class"""
1941 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1942 __repr__
= _swig_repr
1943 def __init__(self
, *args
, **kwargs
):
1944 """__init__(self) -> MemoryFSHandler"""
1945 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
1946 def RemoveFile(*args
, **kwargs
):
1947 """RemoveFile(String filename)"""
1948 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
1950 RemoveFile
= staticmethod(RemoveFile
)
1951 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
1952 def CanOpen(*args
, **kwargs
):
1953 """CanOpen(self, String location) -> bool"""
1954 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
1956 def OpenFile(*args
, **kwargs
):
1957 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1958 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
1960 def FindFirst(*args
, **kwargs
):
1961 """FindFirst(self, String spec, int flags=0) -> String"""
1962 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
1964 def FindNext(*args
, **kwargs
):
1965 """FindNext(self) -> String"""
1966 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
1968 MemoryFSHandler_swigregister
= _core_
.MemoryFSHandler_swigregister
1969 MemoryFSHandler_swigregister(MemoryFSHandler
)
1971 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
1972 """MemoryFSHandler_RemoveFile(String filename)"""
1973 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
1975 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
1976 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
1977 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
1978 #---------------------------------------------------------------------------
1980 class ImageHandler(Object
):
1982 This is the base class for implementing image file loading/saving, and
1983 image creation from data. It is used within `wx.Image` and is not
1984 normally seen by the application.
1986 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1987 def __init__(self
): raise AttributeError, "No constructor defined"
1988 __repr__
= _swig_repr
1989 def GetName(*args
, **kwargs
):
1990 """GetName(self) -> String"""
1991 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
1993 def GetExtension(*args
, **kwargs
):
1994 """GetExtension(self) -> String"""
1995 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
1997 def GetType(*args
, **kwargs
):
1998 """GetType(self) -> long"""
1999 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2001 def GetMimeType(*args
, **kwargs
):
2002 """GetMimeType(self) -> String"""
2003 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2005 def CanRead(*args
, **kwargs
):
2006 """CanRead(self, String name) -> bool"""
2007 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2009 def SetName(*args
, **kwargs
):
2010 """SetName(self, String name)"""
2011 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2013 def SetExtension(*args
, **kwargs
):
2014 """SetExtension(self, String extension)"""
2015 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2017 def SetType(*args
, **kwargs
):
2018 """SetType(self, long type)"""
2019 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2021 def SetMimeType(*args
, **kwargs
):
2022 """SetMimeType(self, String mimetype)"""
2023 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2025 ImageHandler_swigregister
= _core_
.ImageHandler_swigregister
2026 ImageHandler_swigregister(ImageHandler
)
2028 class PyImageHandler(ImageHandler
):
2030 This is the base class for implementing image file loading/saving, and
2031 image creation from data, all written in Python. To create a custom
2032 image handler derive a new class from wx.PyImageHandler and provide
2033 the following methods::
2035 def DoCanRead(self, stream) --> bool
2036 '''Check if this handler can read the image on the stream'''
2038 def LoadFile(self, image, stream, verbose, index) --> bool
2039 '''Load image data from the stream and load it into image.'''
2041 def SaveFile(self, image, stream, verbose) --> bool
2042 '''Save the iamge data in image to the stream using
2043 this handler's image file format.'''
2045 def GetImageCount(self, stream) --> int
2046 '''If this image format can hold more than one image,
2047 how many does the image on the stream have?'''
2049 To activate your handler create an instance of it and pass it to
2050 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2051 `SetExtension` from your constructor.
2054 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2055 __repr__
= _swig_repr
2056 def __init__(self
, *args
, **kwargs
):
2058 __init__(self) -> PyImageHandler
2060 This is the base class for implementing image file loading/saving, and
2061 image creation from data, all written in Python. To create a custom
2062 image handler derive a new class from wx.PyImageHandler and provide
2063 the following methods::
2065 def DoCanRead(self, stream) --> bool
2066 '''Check if this handler can read the image on the stream'''
2068 def LoadFile(self, image, stream, verbose, index) --> bool
2069 '''Load image data from the stream and load it into image.'''
2071 def SaveFile(self, image, stream, verbose) --> bool
2072 '''Save the iamge data in image to the stream using
2073 this handler's image file format.'''
2075 def GetImageCount(self, stream) --> int
2076 '''If this image format can hold more than one image,
2077 how many does the image on the stream have?'''
2079 To activate your handler create an instance of it and pass it to
2080 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2081 `SetExtension` from your constructor.
2084 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2087 def _SetSelf(*args
, **kwargs
):
2088 """_SetSelf(self, PyObject self)"""
2089 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2091 PyImageHandler_swigregister
= _core_
.PyImageHandler_swigregister
2092 PyImageHandler_swigregister(PyImageHandler
)
2094 class ImageHistogram(object):
2095 """Proxy of C++ ImageHistogram class"""
2096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2097 __repr__
= _swig_repr
2098 def __init__(self
, *args
, **kwargs
):
2099 """__init__(self) -> ImageHistogram"""
2100 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2101 def MakeKey(*args
, **kwargs
):
2103 MakeKey(byte r, byte g, byte b) -> unsigned long
2105 Get the key in the histogram for the given RGB values
2107 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2109 MakeKey
= staticmethod(MakeKey
)
2110 def FindFirstUnusedColour(*args
, **kwargs
):
2112 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2114 Find first colour that is not used in the image and has higher RGB
2115 values than startR, startG, startB. Returns a tuple consisting of a
2116 success flag and rgb values.
2118 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2120 def GetCount(*args
, **kwargs
):
2122 GetCount(self, unsigned long key) -> unsigned long
2124 Returns the pixel count for the given key. Use `MakeKey` to create a
2125 key value from a RGB tripple.
2127 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2129 def GetCountRGB(*args
, **kwargs
):
2131 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2133 Returns the pixel count for the given RGB values.
2135 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2137 def GetCountColour(*args
, **kwargs
):
2139 GetCountColour(self, Colour colour) -> unsigned long
2141 Returns the pixel count for the given `wx.Colour` value.
2143 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2145 ImageHistogram_swigregister
= _core_
.ImageHistogram_swigregister
2146 ImageHistogram_swigregister(ImageHistogram
)
2148 def ImageHistogram_MakeKey(*args
, **kwargs
):
2150 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2152 Get the key in the histogram for the given RGB values
2154 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2156 class Image_RGBValue(object):
2158 An object that contains values for red, green and blue which represent
2159 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2160 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2163 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2164 __repr__
= _swig_repr
2165 def __init__(self
, *args
, **kwargs
):
2167 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2171 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2172 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2173 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2174 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2175 Image_RGBValue_swigregister
= _core_
.Image_RGBValue_swigregister
2176 Image_RGBValue_swigregister(Image_RGBValue
)
2178 class Image_HSVValue(object):
2180 An object that contains values for hue, saturation and value which
2181 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2182 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2185 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2186 __repr__
= _swig_repr
2187 def __init__(self
, *args
, **kwargs
):
2189 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2193 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2194 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2195 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2196 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2197 Image_HSVValue_swigregister
= _core_
.Image_HSVValue_swigregister
2198 Image_HSVValue_swigregister(Image_HSVValue
)
2200 class Image(Object
):
2202 A platform-independent image class. An image can be created from
2203 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2204 variety of formats. Functions are available to set and get image
2205 bits, so it can be used for basic image manipulation.
2207 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2208 platform-specific `wx.Bitmap` object must be created from it using the
2209 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2210 device context, using `wx.DC.DrawBitmap`.
2212 One colour value of the image may be used as a mask colour which will
2213 lead to the automatic creation of a `wx.Mask` object associated to the
2216 wx.Image supports alpha channel data, that is in addition to a byte
2217 for the red, green and blue colour components for each pixel it also
2218 stores a byte representing the pixel opacity. An alpha value of 0
2219 corresponds to a transparent pixel (null opacity) while a value of 255
2220 means that the pixel is 100% opaque.
2222 Unlike RGB data, not all images have an alpha channel and before using
2223 `GetAlpha` you should check if this image contains an alpha channel
2224 with `HasAlpha`. Note that currently only images loaded from PNG files
2225 with transparency information will have an alpha channel.
2227 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2228 __repr__
= _swig_repr
2229 def __init__(self
, *args
, **kwargs
):
2231 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2233 Loads an image from a file.
2235 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2236 __swig_destroy__
= _core_
.delete_Image
2237 __del__
= lambda self
: None;
2238 def Create(*args
, **kwargs
):
2240 Create(self, int width, int height, bool clear=True)
2242 Creates a fresh image. If clear is ``True``, the new image will be
2243 initialized to black. Otherwise, the image data will be uninitialized.
2245 return _core_
.Image_Create(*args
, **kwargs
)
2247 def Destroy(*args
, **kwargs
):
2251 Destroys the image data.
2253 val
= _core_
.Image_Destroy(*args
, **kwargs
)
2257 def Scale(*args
, **kwargs
):
2259 Scale(self, int width, int height) -> Image
2261 Returns a scaled version of the image. This is also useful for scaling
2262 bitmaps in general as the only other way to scale bitmaps is to blit a
2263 `wx.MemoryDC` into another `wx.MemoryDC`.
2265 return _core_
.Image_Scale(*args
, **kwargs
)
2267 def ShrinkBy(*args
, **kwargs
):
2269 ShrinkBy(self, int xFactor, int yFactor) -> Image
2271 Return a version of the image scaled smaller by the given factors.
2273 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2275 def Rescale(*args
, **kwargs
):
2277 Rescale(self, int width, int height) -> Image
2279 Changes the size of the image in-place by scaling it: after a call to
2280 this function, the image will have the given width and height.
2282 Returns the (modified) image itself.
2284 return _core_
.Image_Rescale(*args
, **kwargs
)
2286 def Resize(*args
, **kwargs
):
2288 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2290 Changes the size of the image in-place without scaling it, by adding
2291 either a border with the given colour or cropping as necessary. The
2292 image is pasted into a new image with the given size and background
2293 colour at the position pos relative to the upper left of the new
2294 image. If red = green = blue = -1 then use either the current mask
2295 colour if set or find, use, and set a suitable mask colour for any
2296 newly exposed areas.
2298 Returns the (modified) image itself.
2300 return _core_
.Image_Resize(*args
, **kwargs
)
2302 def SetRGB(*args
, **kwargs
):
2304 SetRGB(self, int x, int y, byte r, byte g, byte b)
2306 Sets the pixel at the given coordinate. This routine performs
2307 bounds-checks for the coordinate so it can be considered a safe way to
2308 manipulate the data, but in some cases this might be too slow so that
2309 the data will have to be set directly. In that case you will have to
2310 get access to the image data using the `GetData` method.
2312 return _core_
.Image_SetRGB(*args
, **kwargs
)
2314 def SetRGBRect(*args
, **kwargs
):
2316 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2318 Sets the colour of the pixels within the given rectangle. This routine
2319 performs bounds-checks for the rectangle so it can be considered a
2320 safe way to manipulate the data.
2322 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2324 def GetRed(*args
, **kwargs
):
2326 GetRed(self, int x, int y) -> byte
2328 Returns the red intensity at the given coordinate.
2330 return _core_
.Image_GetRed(*args
, **kwargs
)
2332 def GetGreen(*args
, **kwargs
):
2334 GetGreen(self, int x, int y) -> byte
2336 Returns the green intensity at the given coordinate.
2338 return _core_
.Image_GetGreen(*args
, **kwargs
)
2340 def GetBlue(*args
, **kwargs
):
2342 GetBlue(self, int x, int y) -> byte
2344 Returns the blue intensity at the given coordinate.
2346 return _core_
.Image_GetBlue(*args
, **kwargs
)
2348 def SetAlpha(*args
, **kwargs
):
2350 SetAlpha(self, int x, int y, byte alpha)
2352 Sets the alpha value for the given pixel. This function should only be
2353 called if the image has alpha channel data, use `HasAlpha` to check
2356 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2358 def GetAlpha(*args
, **kwargs
):
2360 GetAlpha(self, int x, int y) -> byte
2362 Returns the alpha value for the given pixel. This function may only be
2363 called for the images with alpha channel, use `HasAlpha` to check for
2366 The returned value is the *opacity* of the image, i.e. the value of 0
2367 corresponds to the fully transparent pixels while the value of 255 to
2368 the fully opaque pixels.
2370 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2372 def HasAlpha(*args
, **kwargs
):
2374 HasAlpha(self) -> bool
2376 Returns true if this image has alpha channel, false otherwise.
2378 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2380 def InitAlpha(*args
, **kwargs
):
2384 Initializes the image alpha channel data. It is an error to call it if
2385 the image already has alpha data. If it doesn't, alpha data will be by
2386 default initialized to all pixels being fully opaque. But if the image
2387 has a a mask colour, all mask pixels will be completely transparent.
2389 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2391 def IsTransparent(*args
, **kwargs
):
2393 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2395 Returns ``True`` if this pixel is masked or has an alpha value less
2396 than the spcified threshold.
2398 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2400 def FindFirstUnusedColour(*args
, **kwargs
):
2402 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2404 Find first colour that is not used in the image and has higher RGB
2405 values than startR, startG, startB. Returns a tuple consisting of a
2406 success flag and rgb values.
2408 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2410 def ConvertAlphaToMask(*args
, **kwargs
):
2412 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2414 If the image has alpha channel, this method converts it to mask. All
2415 pixels with alpha value less than ``threshold`` are replaced with the
2416 mask colour and the alpha channel is removed. The mask colour is
2417 chosen automatically using `FindFirstUnusedColour`.
2419 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2422 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2424 def ConvertColourToAlpha(*args
, **kwargs
):
2426 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2428 This method converts an image where the original alpha information is
2429 only available as a shades of a colour (actually shades of grey)
2430 typically when you draw anti-aliased text into a bitmap. The DC
2431 drawing routines draw grey values on the black background although
2432 they actually mean to draw white with differnt alpha values. This
2433 method reverses it, assuming a black (!) background and white text.
2434 The method will then fill up the whole image with the colour given.
2436 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2438 def SetMaskFromImage(*args
, **kwargs
):
2440 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2442 Sets the image's mask so that the pixels that have RGB value of
2443 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2444 by first finding an unused colour in the image, setting this colour as
2445 the mask colour and then using this colour to draw all pixels in the
2446 image who corresponding pixel in mask has given RGB value.
2448 Returns ``False`` if ``mask`` does not have same dimensions as the
2449 image or if there is no unused colour left. Returns ``True`` if the
2450 mask was successfully applied.
2452 Note that this method involves computing the histogram, which is
2453 computationally intensive operation.
2455 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2457 def CanRead(*args
, **kwargs
):
2459 CanRead(String filename) -> bool
2461 Returns True if the image handlers can read this file.
2463 return _core_
.Image_CanRead(*args
, **kwargs
)
2465 CanRead
= staticmethod(CanRead
)
2466 def GetImageCount(*args
, **kwargs
):
2468 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2470 If the image file contains more than one image and the image handler
2471 is capable of retrieving these individually, this function will return
2472 the number of available images.
2474 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2476 GetImageCount
= staticmethod(GetImageCount
)
2477 def LoadFile(*args
, **kwargs
):
2479 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2481 Loads an image from a file. If no handler type is provided, the
2482 library will try to autodetect the format.
2484 return _core_
.Image_LoadFile(*args
, **kwargs
)
2486 def LoadMimeFile(*args
, **kwargs
):
2488 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2490 Loads an image from a file, specifying the image type with a MIME type
2493 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2495 def SaveFile(*args
, **kwargs
):
2497 SaveFile(self, String name, int type) -> bool
2499 Saves an image in the named file.
2501 return _core_
.Image_SaveFile(*args
, **kwargs
)
2503 def SaveMimeFile(*args
, **kwargs
):
2505 SaveMimeFile(self, String name, String mimetype) -> bool
2507 Saves an image in the named file.
2509 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2511 def CanReadStream(*args
, **kwargs
):
2513 CanReadStream(InputStream stream) -> bool
2515 Returns True if the image handlers can read an image file from the
2516 data currently on the input stream, or a readable Python file-like
2519 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2521 CanReadStream
= staticmethod(CanReadStream
)
2522 def LoadStream(*args
, **kwargs
):
2524 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2526 Loads an image from an input stream or a readable Python file-like
2527 object. If no handler type is provided, the library will try to
2528 autodetect the format.
2530 return _core_
.Image_LoadStream(*args
, **kwargs
)
2532 def LoadMimeStream(*args
, **kwargs
):
2534 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2536 Loads an image from an input stream or a readable Python file-like
2537 object, using a MIME type string to specify the image file format.
2539 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2541 def Ok(*args
, **kwargs
):
2545 Returns true if image data is present.
2547 return _core_
.Image_Ok(*args
, **kwargs
)
2549 def GetWidth(*args
, **kwargs
):
2551 GetWidth(self) -> int
2553 Gets the width of the image in pixels.
2555 return _core_
.Image_GetWidth(*args
, **kwargs
)
2557 def GetHeight(*args
, **kwargs
):
2559 GetHeight(self) -> int
2561 Gets the height of the image in pixels.
2563 return _core_
.Image_GetHeight(*args
, **kwargs
)
2565 def GetSize(*args
, **kwargs
):
2567 GetSize(self) -> Size
2569 Returns the size of the image in pixels.
2571 return _core_
.Image_GetSize(*args
, **kwargs
)
2573 def GetSubImage(*args
, **kwargs
):
2575 GetSubImage(self, Rect rect) -> Image
2577 Returns a sub image of the current one as long as the rect belongs
2578 entirely to the image.
2580 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2582 def Size(*args
, **kwargs
):
2584 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2586 Returns a resized version of this image without scaling it by adding
2587 either a border with the given colour or cropping as necessary. The
2588 image is pasted into a new image with the given size and background
2589 colour at the position ``pos`` relative to the upper left of the new
2590 image. If red = green = blue = -1 then use either the current mask
2591 colour if set or find, use, and set a suitable mask colour for any
2592 newly exposed areas.
2594 return _core_
.Image_Size(*args
, **kwargs
)
2596 def Copy(*args
, **kwargs
):
2600 Returns an identical copy of the image.
2602 return _core_
.Image_Copy(*args
, **kwargs
)
2604 def Paste(*args
, **kwargs
):
2606 Paste(self, Image image, int x, int y)
2608 Pastes ``image`` into this instance and takes care of the mask colour
2609 and any out of bounds problems.
2611 return _core_
.Image_Paste(*args
, **kwargs
)
2613 def GetData(*args
, **kwargs
):
2615 GetData(self) -> PyObject
2617 Returns a string containing a copy of the RGB bytes of the image.
2619 return _core_
.Image_GetData(*args
, **kwargs
)
2621 def SetData(*args
, **kwargs
):
2623 SetData(self, buffer data)
2625 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2626 either a string or a buffer object holding the data and the length of
2627 the data must be width*height*3.
2629 return _core_
.Image_SetData(*args
, **kwargs
)
2631 def GetDataBuffer(*args
, **kwargs
):
2633 GetDataBuffer(self) -> PyObject
2635 Returns a writable Python buffer object that is pointing at the RGB
2636 image data buffer inside the wx.Image. You need to ensure that you do
2637 not use this buffer object after the image has been destroyed.
2639 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
2641 def SetDataBuffer(*args
, **kwargs
):
2643 SetDataBuffer(self, buffer data)
2645 Sets the internal image data pointer to point at a Python buffer
2646 object. This can save making an extra copy of the data but you must
2647 ensure that the buffer object lives longer than the wx.Image does.
2649 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
2651 def GetAlphaData(*args
, **kwargs
):
2653 GetAlphaData(self) -> PyObject
2655 Returns a string containing a copy of the alpha bytes of the image.
2657 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
2659 def SetAlphaData(*args
, **kwargs
):
2661 SetAlphaData(self, buffer alpha)
2663 Resets the Image's alpha data from a buffer of bytes. Accepts either
2664 a string or a buffer object holding the data and the length of the
2665 data must be width*height.
2667 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
2669 def GetAlphaBuffer(*args
, **kwargs
):
2670 """GetAlphaBuffer(self) -> PyObject"""
2671 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
2673 def SetAlphaBuffer(*args
, **kwargs
):
2674 """SetAlphaBuffer(self, buffer alpha)"""
2675 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
2677 def SetMaskColour(*args
, **kwargs
):
2679 SetMaskColour(self, byte r, byte g, byte b)
2681 Sets the mask colour for this image (and tells the image to use the
2684 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
2686 def GetOrFindMaskColour(*args
, **kwargs
):
2688 GetOrFindMaskColour() -> (r,g,b)
2690 Get the current mask colour or find a suitable colour.
2692 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
2694 def GetMaskRed(*args
, **kwargs
):
2696 GetMaskRed(self) -> byte
2698 Gets the red component of the mask colour.
2700 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
2702 def GetMaskGreen(*args
, **kwargs
):
2704 GetMaskGreen(self) -> byte
2706 Gets the green component of the mask colour.
2708 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
2710 def GetMaskBlue(*args
, **kwargs
):
2712 GetMaskBlue(self) -> byte
2714 Gets the blue component of the mask colour.
2716 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
2718 def SetMask(*args
, **kwargs
):
2720 SetMask(self, bool mask=True)
2722 Specifies whether there is a mask or not. The area of the mask is
2723 determined by the current mask colour.
2725 return _core_
.Image_SetMask(*args
, **kwargs
)
2727 def HasMask(*args
, **kwargs
):
2729 HasMask(self) -> bool
2731 Returns ``True`` if there is a mask active, ``False`` otherwise.
2733 return _core_
.Image_HasMask(*args
, **kwargs
)
2735 def Rotate(*args
, **kwargs
):
2737 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2738 Point offset_after_rotation=None) -> Image
2740 Rotates the image about the given point, by ``angle`` radians. Passing
2741 ``True`` to ``interpolating`` results in better image quality, but is
2742 slower. If the image has a mask, then the mask colour is used for the
2743 uncovered pixels in the rotated image background. Otherwise, black
2744 will be used as the fill colour.
2746 Returns the rotated image, leaving this image intact.
2748 return _core_
.Image_Rotate(*args
, **kwargs
)
2750 def Rotate90(*args
, **kwargs
):
2752 Rotate90(self, bool clockwise=True) -> Image
2754 Returns a copy of the image rotated 90 degrees in the direction
2755 indicated by ``clockwise``.
2757 return _core_
.Image_Rotate90(*args
, **kwargs
)
2759 def Mirror(*args
, **kwargs
):
2761 Mirror(self, bool horizontally=True) -> Image
2763 Returns a mirrored copy of the image. The parameter ``horizontally``
2764 indicates the orientation.
2766 return _core_
.Image_Mirror(*args
, **kwargs
)
2768 def Replace(*args
, **kwargs
):
2770 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2772 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2775 return _core_
.Image_Replace(*args
, **kwargs
)
2777 def ConvertToGreyscale(*args
, **kwargs
):
2779 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2781 Convert to greyscale image. Uses the luminance component (Y) of the
2782 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2783 defaults to ITU-T BT.601
2785 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
2787 def ConvertToMono(*args
, **kwargs
):
2789 ConvertToMono(self, byte r, byte g, byte b) -> Image
2791 Returns monochromatic version of the image. The returned image has
2792 white colour where the original has ``(r,g,b)`` colour and black
2793 colour everywhere else.
2795 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
2797 def SetOption(*args
, **kwargs
):
2799 SetOption(self, String name, String value)
2801 Sets an image handler defined option. For example, when saving as a
2802 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2803 number between 0 and 100 (0 is terrible, 100 is very good).
2805 return _core_
.Image_SetOption(*args
, **kwargs
)
2807 def SetOptionInt(*args
, **kwargs
):
2809 SetOptionInt(self, String name, int value)
2811 Sets an image option as an integer.
2813 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
2815 def GetOption(*args
, **kwargs
):
2817 GetOption(self, String name) -> String
2819 Gets the value of an image handler option.
2821 return _core_
.Image_GetOption(*args
, **kwargs
)
2823 def GetOptionInt(*args
, **kwargs
):
2825 GetOptionInt(self, String name) -> int
2827 Gets the value of an image handler option as an integer. If the given
2828 option is not present, the function returns 0.
2830 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
2832 def HasOption(*args
, **kwargs
):
2834 HasOption(self, String name) -> bool
2836 Returns true if the given option is present.
2838 return _core_
.Image_HasOption(*args
, **kwargs
)
2840 def CountColours(*args
, **kwargs
):
2841 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2842 return _core_
.Image_CountColours(*args
, **kwargs
)
2844 def ComputeHistogram(*args
, **kwargs
):
2845 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2846 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
2848 def AddHandler(*args
, **kwargs
):
2849 """AddHandler(ImageHandler handler)"""
2850 return _core_
.Image_AddHandler(*args
, **kwargs
)
2852 AddHandler
= staticmethod(AddHandler
)
2853 def InsertHandler(*args
, **kwargs
):
2854 """InsertHandler(ImageHandler handler)"""
2855 return _core_
.Image_InsertHandler(*args
, **kwargs
)
2857 InsertHandler
= staticmethod(InsertHandler
)
2858 def RemoveHandler(*args
, **kwargs
):
2859 """RemoveHandler(String name) -> bool"""
2860 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
2862 RemoveHandler
= staticmethod(RemoveHandler
)
2863 def GetHandlers(*args
, **kwargs
):
2864 """GetHandlers() -> PyObject"""
2865 return _core_
.Image_GetHandlers(*args
, **kwargs
)
2867 GetHandlers
= staticmethod(GetHandlers
)
2868 def GetImageExtWildcard(*args
, **kwargs
):
2870 GetImageExtWildcard() -> String
2872 Iterates all registered wxImageHandler objects, and returns a string
2873 containing file extension masks suitable for passing to file open/save
2876 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
2878 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
2879 def ConvertToBitmap(*args
, **kwargs
):
2880 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
2881 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
2883 def ConvertToMonoBitmap(*args
, **kwargs
):
2884 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
2885 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
2887 def RotateHue(*args
, **kwargs
):
2889 RotateHue(self, double angle)
2891 Rotates the hue of each pixel of the image. Hue is a double in the
2892 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2894 return _core_
.Image_RotateHue(*args
, **kwargs
)
2896 def RGBtoHSV(*args
, **kwargs
):
2898 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2900 Converts a color in RGB color space to HSV color space.
2902 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
2904 RGBtoHSV
= staticmethod(RGBtoHSV
)
2905 def HSVtoRGB(*args
, **kwargs
):
2907 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2909 Converts a color in HSV color space to RGB color space.
2911 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
2913 HSVtoRGB
= staticmethod(HSVtoRGB
)
2914 def __nonzero__(self
): return self
.Ok()
2915 Image_swigregister
= _core_
.Image_swigregister
2916 Image_swigregister(Image
)
2918 def ImageFromMime(*args
, **kwargs
):
2920 ImageFromMime(String name, String mimetype, int index=-1) -> Image
2922 Loads an image from a file, using a MIME type string (such as
2923 'image/jpeg') to specify image type.
2925 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
2928 def ImageFromStream(*args
, **kwargs
):
2930 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2932 Loads an image from an input stream, or any readable Python file-like
2935 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
2938 def ImageFromStreamMime(*args
, **kwargs
):
2940 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
2942 Loads an image from an input stream, or any readable Python file-like
2943 object, specifying the image format with a MIME type string.
2945 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
2948 def EmptyImage(*args
, **kwargs
):
2950 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
2952 Construct an empty image of a given size, optionally setting all
2955 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
2958 def ImageFromBitmap(*args
, **kwargs
):
2960 ImageFromBitmap(Bitmap bitmap) -> Image
2962 Construct an Image from a `wx.Bitmap`.
2964 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
2967 def ImageFromData(*args
, **kwargs
):
2969 ImageFromData(int width, int height, buffer data) -> Image
2971 Construct an Image from a buffer of RGB bytes. Accepts either a
2972 string or a buffer object holding the data and the length of the data
2973 must be width*height*3.
2975 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
2978 def ImageFromDataWithAlpha(*args
, **kwargs
):
2980 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
2982 Construct an Image from a buffer of RGB bytes with an Alpha channel.
2983 Accepts either a string or a buffer object holding the data and the
2984 length of the data must be width*height*3 bytes, and the length of the
2985 alpha data must be width*height bytes.
2987 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
2990 def Image_CanRead(*args
, **kwargs
):
2992 Image_CanRead(String filename) -> bool
2994 Returns True if the image handlers can read this file.
2996 return _core_
.Image_CanRead(*args
, **kwargs
)
2998 def Image_GetImageCount(*args
, **kwargs
):
3000 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3002 If the image file contains more than one image and the image handler
3003 is capable of retrieving these individually, this function will return
3004 the number of available images.
3006 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3008 def Image_CanReadStream(*args
, **kwargs
):
3010 Image_CanReadStream(InputStream stream) -> bool
3012 Returns True if the image handlers can read an image file from the
3013 data currently on the input stream, or a readable Python file-like
3016 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3018 def Image_AddHandler(*args
, **kwargs
):
3019 """Image_AddHandler(ImageHandler handler)"""
3020 return _core_
.Image_AddHandler(*args
, **kwargs
)
3022 def Image_InsertHandler(*args
, **kwargs
):
3023 """Image_InsertHandler(ImageHandler handler)"""
3024 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3026 def Image_RemoveHandler(*args
, **kwargs
):
3027 """Image_RemoveHandler(String name) -> bool"""
3028 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3030 def Image_GetHandlers(*args
):
3031 """Image_GetHandlers() -> PyObject"""
3032 return _core_
.Image_GetHandlers(*args
)
3034 def Image_GetImageExtWildcard(*args
):
3036 Image_GetImageExtWildcard() -> String
3038 Iterates all registered wxImageHandler objects, and returns a string
3039 containing file extension masks suitable for passing to file open/save
3042 return _core_
.Image_GetImageExtWildcard(*args
)
3044 def Image_RGBtoHSV(*args
, **kwargs
):
3046 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3048 Converts a color in RGB color space to HSV color space.
3050 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3052 def Image_HSVtoRGB(*args
, **kwargs
):
3054 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3056 Converts a color in HSV color space to RGB color space.
3058 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3060 def InitAllImageHandlers():
3062 The former functionality of InitAllImageHanders is now done internal to
3063 the _core_ extension module and so this function has become a simple NOP.
3067 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3068 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3069 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3070 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3071 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3072 BMP_24BPP
= _core_
.BMP_24BPP
3073 BMP_8BPP
= _core_
.BMP_8BPP
3074 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3075 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3076 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3077 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3078 BMP_4BPP
= _core_
.BMP_4BPP
3079 BMP_1BPP
= _core_
.BMP_1BPP
3080 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3081 class BMPHandler(ImageHandler
):
3082 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3083 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3084 __repr__
= _swig_repr
3085 def __init__(self
, *args
, **kwargs
):
3087 __init__(self) -> BMPHandler
3089 A `wx.ImageHandler` for \*.bmp bitmap files.
3091 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3092 BMPHandler_swigregister
= _core_
.BMPHandler_swigregister
3093 BMPHandler_swigregister(BMPHandler
)
3094 NullImage
= cvar
.NullImage
3095 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3096 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3097 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3098 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3099 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3100 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3101 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3102 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3103 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3104 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3105 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3106 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3107 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3108 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3109 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3111 class ICOHandler(BMPHandler
):
3112 """A `wx.ImageHandler` for \*.ico icon files."""
3113 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3114 __repr__
= _swig_repr
3115 def __init__(self
, *args
, **kwargs
):
3117 __init__(self) -> ICOHandler
3119 A `wx.ImageHandler` for \*.ico icon files.
3121 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3122 ICOHandler_swigregister
= _core_
.ICOHandler_swigregister
3123 ICOHandler_swigregister(ICOHandler
)
3125 class CURHandler(ICOHandler
):
3126 """A `wx.ImageHandler` for \*.cur cursor files."""
3127 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3128 __repr__
= _swig_repr
3129 def __init__(self
, *args
, **kwargs
):
3131 __init__(self) -> CURHandler
3133 A `wx.ImageHandler` for \*.cur cursor files.
3135 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3136 CURHandler_swigregister
= _core_
.CURHandler_swigregister
3137 CURHandler_swigregister(CURHandler
)
3139 class ANIHandler(CURHandler
):
3140 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3141 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3142 __repr__
= _swig_repr
3143 def __init__(self
, *args
, **kwargs
):
3145 __init__(self) -> ANIHandler
3147 A `wx.ImageHandler` for \*.ani animated cursor files.
3149 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3150 ANIHandler_swigregister
= _core_
.ANIHandler_swigregister
3151 ANIHandler_swigregister(ANIHandler
)
3153 class PNGHandler(ImageHandler
):
3154 """A `wx.ImageHandler` for PNG image files."""
3155 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3156 __repr__
= _swig_repr
3157 def __init__(self
, *args
, **kwargs
):
3159 __init__(self) -> PNGHandler
3161 A `wx.ImageHandler` for PNG image files.
3163 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3164 PNGHandler_swigregister
= _core_
.PNGHandler_swigregister
3165 PNGHandler_swigregister(PNGHandler
)
3167 class GIFHandler(ImageHandler
):
3168 """A `wx.ImageHandler` for GIF image files."""
3169 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3170 __repr__
= _swig_repr
3171 def __init__(self
, *args
, **kwargs
):
3173 __init__(self) -> GIFHandler
3175 A `wx.ImageHandler` for GIF image files.
3177 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3178 GIFHandler_swigregister
= _core_
.GIFHandler_swigregister
3179 GIFHandler_swigregister(GIFHandler
)
3181 class PCXHandler(ImageHandler
):
3182 """A `wx.ImageHandler` for PCX imager files."""
3183 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3184 __repr__
= _swig_repr
3185 def __init__(self
, *args
, **kwargs
):
3187 __init__(self) -> PCXHandler
3189 A `wx.ImageHandler` for PCX imager files.
3191 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3192 PCXHandler_swigregister
= _core_
.PCXHandler_swigregister
3193 PCXHandler_swigregister(PCXHandler
)
3195 class JPEGHandler(ImageHandler
):
3196 """A `wx.ImageHandler` for JPEG/JPG image files."""
3197 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3198 __repr__
= _swig_repr
3199 def __init__(self
, *args
, **kwargs
):
3201 __init__(self) -> JPEGHandler
3203 A `wx.ImageHandler` for JPEG/JPG image files.
3205 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3206 JPEGHandler_swigregister
= _core_
.JPEGHandler_swigregister
3207 JPEGHandler_swigregister(JPEGHandler
)
3209 class PNMHandler(ImageHandler
):
3210 """A `wx.ImageHandler` for PNM image files."""
3211 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3212 __repr__
= _swig_repr
3213 def __init__(self
, *args
, **kwargs
):
3215 __init__(self) -> PNMHandler
3217 A `wx.ImageHandler` for PNM image files.
3219 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3220 PNMHandler_swigregister
= _core_
.PNMHandler_swigregister
3221 PNMHandler_swigregister(PNMHandler
)
3223 class XPMHandler(ImageHandler
):
3224 """A `wx.ImageHandler` for XPM image."""
3225 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3226 __repr__
= _swig_repr
3227 def __init__(self
, *args
, **kwargs
):
3229 __init__(self) -> XPMHandler
3231 A `wx.ImageHandler` for XPM image.
3233 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3234 XPMHandler_swigregister
= _core_
.XPMHandler_swigregister
3235 XPMHandler_swigregister(XPMHandler
)
3237 class TIFFHandler(ImageHandler
):
3238 """A `wx.ImageHandler` for TIFF image files."""
3239 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3240 __repr__
= _swig_repr
3241 def __init__(self
, *args
, **kwargs
):
3243 __init__(self) -> TIFFHandler
3245 A `wx.ImageHandler` for TIFF image files.
3247 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3248 TIFFHandler_swigregister
= _core_
.TIFFHandler_swigregister
3249 TIFFHandler_swigregister(TIFFHandler
)
3251 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3252 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3253 class Quantize(object):
3254 """Performs quantization, or colour reduction, on a wxImage."""
3255 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3256 def __init__(self
): raise AttributeError, "No constructor defined"
3257 __repr__
= _swig_repr
3258 def Quantize(*args
, **kwargs
):
3260 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3262 Reduce the colours in the source image and put the result into the
3263 destination image, setting the palette in the destination if
3264 needed. Both images may be the same, to overwrite the source image.
3266 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3268 Quantize
= staticmethod(Quantize
)
3269 Quantize_swigregister
= _core_
.Quantize_swigregister
3270 Quantize_swigregister(Quantize
)
3272 def Quantize_Quantize(*args
, **kwargs
):
3274 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3276 Reduce the colours in the source image and put the result into the
3277 destination image, setting the palette in the destination if
3278 needed. Both images may be the same, to overwrite the source image.
3280 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3282 #---------------------------------------------------------------------------
3284 class EvtHandler(Object
):
3285 """Proxy of C++ EvtHandler class"""
3286 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3287 __repr__
= _swig_repr
3288 def __init__(self
, *args
, **kwargs
):
3289 """__init__(self) -> EvtHandler"""
3290 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3291 def GetNextHandler(*args
, **kwargs
):
3292 """GetNextHandler(self) -> EvtHandler"""
3293 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3295 def GetPreviousHandler(*args
, **kwargs
):
3296 """GetPreviousHandler(self) -> EvtHandler"""
3297 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3299 def SetNextHandler(*args
, **kwargs
):
3300 """SetNextHandler(self, EvtHandler handler)"""
3301 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3303 def SetPreviousHandler(*args
, **kwargs
):
3304 """SetPreviousHandler(self, EvtHandler handler)"""
3305 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3307 def GetEvtHandlerEnabled(*args
, **kwargs
):
3308 """GetEvtHandlerEnabled(self) -> bool"""
3309 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3311 def SetEvtHandlerEnabled(*args
, **kwargs
):
3312 """SetEvtHandlerEnabled(self, bool enabled)"""
3313 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3315 def ProcessEvent(*args
, **kwargs
):
3316 """ProcessEvent(self, Event event) -> bool"""
3317 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3319 def AddPendingEvent(*args
, **kwargs
):
3320 """AddPendingEvent(self, Event event)"""
3321 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3323 def ProcessPendingEvents(*args
, **kwargs
):
3324 """ProcessPendingEvents(self)"""
3325 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3327 def Connect(*args
, **kwargs
):
3328 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3329 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3331 def Disconnect(*args
, **kwargs
):
3332 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
3333 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3335 def _setOORInfo(*args
, **kwargs
):
3336 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3337 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3341 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3343 Bind an event to an event handler.
3345 :param event: One of the EVT_* objects that specifies the
3346 type of event to bind,
3348 :param handler: A callable object to be invoked when the
3349 event is delivered to self. Pass None to
3350 disconnect an event handler.
3352 :param source: Sometimes the event originates from a
3353 different window than self, but you still
3354 want to catch it in self. (For example, a
3355 button event delivered to a frame.) By
3356 passing the source of the event, the event
3357 handling system is able to differentiate
3358 between the same event type from different
3361 :param id: Used to spcify the event source by ID instead
3364 :param id2: Used when it is desirable to bind a handler
3365 to a range of IDs, such as with EVT_MENU_RANGE.
3367 if source
is not None:
3369 event
.Bind(self
, id, id2
, handler
)
3371 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3373 Disconencts the event handler binding for event from self.
3374 Returns True if successful.
3376 if source
is not None:
3378 return event
.Unbind(self
, id, id2
)
3380 EvtHandler_swigregister
= _core_
.EvtHandler_swigregister
3381 EvtHandler_swigregister(EvtHandler
)
3383 #---------------------------------------------------------------------------
3385 class PyEventBinder(object):
3387 Instances of this class are used to bind specific events to event
3390 def __init__(self
, evtType
, expectedIDs
=0):
3391 if expectedIDs
not in [0, 1, 2]:
3392 raise ValueError, "Invalid number of expectedIDs"
3393 self
.expectedIDs
= expectedIDs
3395 if type(evtType
) == list or type(evtType
) == tuple:
3396 self
.evtType
= evtType
3398 self
.evtType
= [evtType
]
3401 def Bind(self
, target
, id1
, id2
, function
):
3402 """Bind this set of event types to target."""
3403 for et
in self
.evtType
:
3404 target
.Connect(id1
, id2
, et
, function
)
3407 def Unbind(self
, target
, id1
, id2
):
3408 """Remove an event binding."""
3410 for et
in self
.evtType
:
3411 success
+= target
.Disconnect(id1
, id2
, et
)
3415 def __call__(self
, *args
):
3417 For backwards compatibility with the old EVT_* functions.
3418 Should be called with either (window, func), (window, ID,
3419 func) or (window, ID1, ID2, func) parameters depending on the
3422 assert len(args
) == 2 + self
.expectedIDs
3426 if self
.expectedIDs
== 0:
3428 elif self
.expectedIDs
== 1:
3431 elif self
.expectedIDs
== 2:
3436 raise ValueError, "Unexpected number of IDs"
3438 self
.Bind(target
, id1
, id2
, func
)
3441 # These two are square pegs that don't fit the PyEventBinder hole...
3442 def EVT_COMMAND(win
, id, cmd
, func
):
3443 win
.Connect(id, -1, cmd
, func
)
3444 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3445 win
.Connect(id1
, id2
, cmd
, func
)
3448 #---------------------------------------------------------------------------
3450 #---------------------------------------------------------------------------
3452 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3453 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3455 def NewEventType(*args
):
3456 """NewEventType() -> wxEventType"""
3457 return _core_
.NewEventType(*args
)
3458 wxEVT_NULL
= _core_
.wxEVT_NULL
3459 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3460 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3461 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3462 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3463 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3464 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3465 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3466 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3467 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3468 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3469 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3470 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3471 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3472 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3473 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3474 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3475 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3476 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3477 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3478 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3479 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3480 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3481 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3482 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3483 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3484 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3485 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3486 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3487 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3488 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3489 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3490 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3491 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3492 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3493 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3494 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3495 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3496 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3497 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3498 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3499 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3500 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3501 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3502 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3503 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3504 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3505 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3506 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3507 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3508 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3509 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3510 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3511 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3512 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3513 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3514 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3515 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3516 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3517 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3518 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3519 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3520 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3521 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3522 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3523 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3524 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3525 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3526 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3527 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3528 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3529 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3530 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3531 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3532 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3533 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3534 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3535 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3536 wxEVT_POWER
= _core_
.wxEVT_POWER
3537 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3538 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3539 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3540 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3541 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3542 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3543 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3544 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3545 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3546 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3547 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3548 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3549 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3550 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3551 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3552 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3553 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3554 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3555 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3556 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3557 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3558 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3559 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3560 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3561 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3562 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3563 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3564 wxEVT_SIZING
= _core_
.wxEVT_SIZING
3565 wxEVT_MOVING
= _core_
.wxEVT_MOVING
3566 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
3567 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
3568 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
3569 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
3570 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
3571 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
3572 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
3573 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
3575 # Create some event binders
3576 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
3577 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
3578 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
3579 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
3580 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
3581 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3582 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3583 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
3584 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
3585 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
3586 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
3587 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
3588 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
3589 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
3590 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
3591 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
3592 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
3593 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
3594 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
3595 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
3596 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
3597 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
3598 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
3599 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
3600 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
3601 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3602 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3603 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
3604 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
3605 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
3606 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
3607 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
3608 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
3609 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
3610 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
3611 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
3612 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
3613 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
3614 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
3615 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
3616 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
3618 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
3619 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
3620 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
3621 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
3622 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
3623 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
3624 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
3625 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
3626 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
3627 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
3628 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
3629 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
3630 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
3632 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
3640 wxEVT_MIDDLE_DCLICK
,
3648 # Scrolling from wxWindow (sent to wxScrolledWindow)
3649 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
3650 wxEVT_SCROLLWIN_BOTTOM
,
3651 wxEVT_SCROLLWIN_LINEUP
,
3652 wxEVT_SCROLLWIN_LINEDOWN
,
3653 wxEVT_SCROLLWIN_PAGEUP
,
3654 wxEVT_SCROLLWIN_PAGEDOWN
,
3655 wxEVT_SCROLLWIN_THUMBTRACK
,
3656 wxEVT_SCROLLWIN_THUMBRELEASE
,
3659 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
3660 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
3661 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
3662 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
3663 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
3664 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
3665 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
3666 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
3668 # Scrolling from wx.Slider and wx.ScrollBar
3669 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3670 wxEVT_SCROLL_BOTTOM
,
3671 wxEVT_SCROLL_LINEUP
,
3672 wxEVT_SCROLL_LINEDOWN
,
3673 wxEVT_SCROLL_PAGEUP
,
3674 wxEVT_SCROLL_PAGEDOWN
,
3675 wxEVT_SCROLL_THUMBTRACK
,
3676 wxEVT_SCROLL_THUMBRELEASE
,
3677 wxEVT_SCROLL_CHANGED
,
3680 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
3681 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
3682 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
3683 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
3684 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
3685 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
3686 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
3687 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
3688 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
3689 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
3691 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3692 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3693 wxEVT_SCROLL_BOTTOM
,
3694 wxEVT_SCROLL_LINEUP
,
3695 wxEVT_SCROLL_LINEDOWN
,
3696 wxEVT_SCROLL_PAGEUP
,
3697 wxEVT_SCROLL_PAGEDOWN
,
3698 wxEVT_SCROLL_THUMBTRACK
,
3699 wxEVT_SCROLL_THUMBRELEASE
,
3700 wxEVT_SCROLL_CHANGED
,
3703 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
3704 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
3705 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
3706 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
3707 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
3708 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
3709 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
3710 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
3711 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
3712 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
3714 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
3715 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
3716 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
3717 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
3718 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
3719 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
3720 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
3721 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
3722 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
3723 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
3725 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
3726 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
3727 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
3728 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
3729 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
3730 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
3731 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
3732 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
3733 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
3736 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
3737 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
3738 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
3739 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
3740 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
3741 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
3742 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
3744 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
3746 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
3747 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
3749 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
3753 #---------------------------------------------------------------------------
3755 class Event(Object
):
3757 An event is a structure holding information about an event passed to a
3758 callback or member function. wx.Event is an abstract base class for
3761 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3762 def __init__(self
): raise AttributeError, "No constructor defined"
3763 __repr__
= _swig_repr
3764 __swig_destroy__
= _core_
.delete_Event
3765 __del__
= lambda self
: None;
3766 def SetEventType(*args
, **kwargs
):
3768 SetEventType(self, wxEventType typ)
3770 Sets the specific type of the event.
3772 return _core_
.Event_SetEventType(*args
, **kwargs
)
3774 def GetEventType(*args
, **kwargs
):
3776 GetEventType(self) -> wxEventType
3778 Returns the identifier of the given event type, such as
3779 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3781 return _core_
.Event_GetEventType(*args
, **kwargs
)
3783 def GetEventObject(*args
, **kwargs
):
3785 GetEventObject(self) -> Object
3787 Returns the object (usually a window) associated with the event, if
3790 return _core_
.Event_GetEventObject(*args
, **kwargs
)
3792 def SetEventObject(*args
, **kwargs
):
3794 SetEventObject(self, Object obj)
3796 Sets the originating object, or in other words, obj is normally the
3797 object that is sending the event.
3799 return _core_
.Event_SetEventObject(*args
, **kwargs
)
3801 def GetTimestamp(*args
, **kwargs
):
3802 """GetTimestamp(self) -> long"""
3803 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
3805 def SetTimestamp(*args
, **kwargs
):
3806 """SetTimestamp(self, long ts=0)"""
3807 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
3809 def GetId(*args
, **kwargs
):
3813 Returns the identifier associated with this event, such as a button
3816 return _core_
.Event_GetId(*args
, **kwargs
)
3818 def SetId(*args
, **kwargs
):
3822 Set's the ID for the event. This is usually the ID of the window that
3823 is sending the event, but it can also be a command id from a menu
3826 return _core_
.Event_SetId(*args
, **kwargs
)
3828 def IsCommandEvent(*args
, **kwargs
):
3830 IsCommandEvent(self) -> bool
3832 Returns true if the event is or is derived from `wx.CommandEvent` else
3833 it returns false. Note: Exists only for optimization purposes.
3835 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
3837 def Skip(*args
, **kwargs
):
3839 Skip(self, bool skip=True)
3841 Called by an event handler, it controls whether additional event
3842 handlers bound to this event will be called after the current event
3843 handler returns. Skip(false) (the default setting) will prevent
3844 additional event handlers from being called and control will be
3845 returned to the sender of the event immediately after the current
3846 handler has finished. Skip(True) will cause the event processing
3847 system to continue searching for a handler function for this event.
3850 return _core_
.Event_Skip(*args
, **kwargs
)
3852 def GetSkipped(*args
, **kwargs
):
3854 GetSkipped(self) -> bool
3856 Returns true if the event handler should be skipped, false otherwise.
3859 return _core_
.Event_GetSkipped(*args
, **kwargs
)
3861 def ShouldPropagate(*args
, **kwargs
):
3863 ShouldPropagate(self) -> bool
3865 Test if this event should be propagated to the parent window or not,
3866 i.e. if the propagation level is currently greater than 0.
3868 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
3870 def StopPropagation(*args
, **kwargs
):
3872 StopPropagation(self) -> int
3874 Stop the event from propagating to its parent window. Returns the old
3875 propagation level value which may be later passed to
3876 `ResumePropagation` to allow propagating the event again.
3878 return _core_
.Event_StopPropagation(*args
, **kwargs
)
3880 def ResumePropagation(*args
, **kwargs
):
3882 ResumePropagation(self, int propagationLevel)
3884 Resume the event propagation by restoring the propagation level. (For
3885 example, you can use the value returned by an earlier call to
3889 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
3891 def Clone(*args
, **kwargs
):
3892 """Clone(self) -> Event"""
3893 return _core_
.Event_Clone(*args
, **kwargs
)
3895 Event_swigregister
= _core_
.Event_swigregister
3896 Event_swigregister(Event
)
3898 #---------------------------------------------------------------------------
3900 class PropagationDisabler(object):
3902 Helper class to temporarily change an event not to propagate. Simply
3903 create an instance of this class and then whe it is destroyed the
3904 propogation of the event will be restored.
3906 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3907 __repr__
= _swig_repr
3908 def __init__(self
, *args
, **kwargs
):
3910 __init__(self, Event event) -> PropagationDisabler
3912 Helper class to temporarily change an event not to propagate. Simply
3913 create an instance of this class and then whe it is destroyed the
3914 propogation of the event will be restored.
3916 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
3917 __swig_destroy__
= _core_
.delete_PropagationDisabler
3918 __del__
= lambda self
: None;
3919 PropagationDisabler_swigregister
= _core_
.PropagationDisabler_swigregister
3920 PropagationDisabler_swigregister(PropagationDisabler
)
3922 class PropagateOnce(object):
3924 A helper class that will temporarily lower propagation level of an
3925 event. Simply create an instance of this class and then whe it is
3926 destroyed the propogation of the event will be restored.
3928 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3929 __repr__
= _swig_repr
3930 def __init__(self
, *args
, **kwargs
):
3932 __init__(self, Event event) -> PropagateOnce
3934 A helper class that will temporarily lower propagation level of an
3935 event. Simply create an instance of this class and then whe it is
3936 destroyed the propogation of the event will be restored.
3938 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
3939 __swig_destroy__
= _core_
.delete_PropagateOnce
3940 __del__
= lambda self
: None;
3941 PropagateOnce_swigregister
= _core_
.PropagateOnce_swigregister
3942 PropagateOnce_swigregister(PropagateOnce
)
3944 #---------------------------------------------------------------------------
3946 class CommandEvent(Event
):
3948 This event class contains information about command events, which
3949 originate from a variety of simple controls, as well as menus and
3952 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3953 __repr__
= _swig_repr
3954 def __init__(self
, *args
, **kwargs
):
3956 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
3958 This event class contains information about command events, which
3959 originate from a variety of simple controls, as well as menus and
3962 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
3963 def GetSelection(*args
, **kwargs
):
3965 GetSelection(self) -> int
3967 Returns item index for a listbox or choice selection event (not valid
3970 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
3972 def SetString(*args
, **kwargs
):
3973 """SetString(self, String s)"""
3974 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
3976 def GetString(*args
, **kwargs
):
3978 GetString(self) -> String
3980 Returns item string for a listbox or choice selection event (not valid
3983 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
3985 def IsChecked(*args
, **kwargs
):
3987 IsChecked(self) -> bool
3989 This method can be used with checkbox and menu events: for the
3990 checkboxes, the method returns true for a selection event and false
3991 for a deselection one. For the menu events, this method indicates if
3992 the menu item just has become checked or unchecked (and thus only
3993 makes sense for checkable menu items).
3995 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
3998 def IsSelection(*args
, **kwargs
):
4000 IsSelection(self) -> bool
4002 For a listbox or similar event, returns true if it is a selection,
4003 false if it is a deselection.
4005 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4007 def SetExtraLong(*args
, **kwargs
):
4008 """SetExtraLong(self, long extraLong)"""
4009 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4011 def GetExtraLong(*args
, **kwargs
):
4013 GetExtraLong(self) -> long
4015 Returns extra information dependant on the event objects type. If the
4016 event comes from a listbox selection, it is a boolean determining
4017 whether the event was a selection (true) or a deselection (false). A
4018 listbox deselection only occurs for multiple-selection boxes, and in
4019 this case the index and string values are indeterminate and the
4020 listbox must be examined by the application.
4022 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4024 def SetInt(*args
, **kwargs
):
4025 """SetInt(self, int i)"""
4026 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4028 def GetInt(*args
, **kwargs
):
4030 GetInt(self) -> long
4032 Returns the integer identifier corresponding to a listbox, choice or
4033 radiobox selection (only if the event was a selection, not a
4034 deselection), or a boolean value representing the value of a checkbox.
4036 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4038 def GetClientData(*args
, **kwargs
):
4040 GetClientData(self) -> PyObject
4042 Returns the client data object for a listbox or choice selection event, (if any.)
4044 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4046 def SetClientData(*args
, **kwargs
):
4048 SetClientData(self, PyObject clientData)
4050 Associate the given client data with the item at position n.
4052 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4054 GetClientObject
= GetClientData
4055 SetClientObject
= SetClientData
4057 def Clone(*args
, **kwargs
):
4058 """Clone(self) -> Event"""
4059 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4061 CommandEvent_swigregister
= _core_
.CommandEvent_swigregister
4062 CommandEvent_swigregister(CommandEvent
)
4064 #---------------------------------------------------------------------------
4066 class NotifyEvent(CommandEvent
):
4068 An instance of this class (or one of its derived classes) is sent from
4069 a control when the control's state is being changed and the control
4070 allows that change to be prevented from happening. The event handler
4071 can call `Veto` or `Allow` to tell the control what to do.
4073 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4074 __repr__
= _swig_repr
4075 def __init__(self
, *args
, **kwargs
):
4077 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4079 An instance of this class (or one of its derived classes) is sent from
4080 a control when the control's state is being changed and the control
4081 allows that change to be prevented from happening. The event handler
4082 can call `Veto` or `Allow` to tell the control what to do.
4084 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4085 def Veto(*args
, **kwargs
):
4089 Prevents the change announced by this event from happening.
4091 It is in general a good idea to notify the user about the reasons for
4092 vetoing the change because otherwise the applications behaviour (which
4093 just refuses to do what the user wants) might be quite surprising.
4095 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4097 def Allow(*args
, **kwargs
):
4101 This is the opposite of `Veto`: it explicitly allows the event to be
4102 processed. For most events it is not necessary to call this method as
4103 the events are allowed anyhow but some are forbidden by default (this
4104 will be mentioned in the corresponding event description).
4106 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4108 def IsAllowed(*args
, **kwargs
):
4110 IsAllowed(self) -> bool
4112 Returns true if the change is allowed (`Veto` hasn't been called) or
4113 false otherwise (if it was).
4115 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4117 NotifyEvent_swigregister
= _core_
.NotifyEvent_swigregister
4118 NotifyEvent_swigregister(NotifyEvent
)
4120 #---------------------------------------------------------------------------
4122 class ScrollEvent(CommandEvent
):
4124 A scroll event holds information about events sent from stand-alone
4125 scrollbars and sliders. Note that scrolled windows do not send
4126 instnaces of this event class, but send the `wx.ScrollWinEvent`
4129 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4130 __repr__
= _swig_repr
4131 def __init__(self
, *args
, **kwargs
):
4133 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4134 int orient=0) -> ScrollEvent
4136 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4137 def GetOrientation(*args
, **kwargs
):
4139 GetOrientation(self) -> int
4141 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4144 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4146 def GetPosition(*args
, **kwargs
):
4148 GetPosition(self) -> int
4150 Returns the position of the scrollbar.
4152 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4154 def SetOrientation(*args
, **kwargs
):
4155 """SetOrientation(self, int orient)"""
4156 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4158 def SetPosition(*args
, **kwargs
):
4159 """SetPosition(self, int pos)"""
4160 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4162 ScrollEvent_swigregister
= _core_
.ScrollEvent_swigregister
4163 ScrollEvent_swigregister(ScrollEvent
)
4165 #---------------------------------------------------------------------------
4167 class ScrollWinEvent(Event
):
4169 A wx.ScrollWinEvent holds information about scrolling and is sent from
4172 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4173 __repr__
= _swig_repr
4174 def __init__(self
, *args
, **kwargs
):
4176 __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4178 A wx.ScrollWinEvent holds information about scrolling and is sent from
4181 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4182 def GetOrientation(*args
, **kwargs
):
4184 GetOrientation(self) -> int
4186 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4189 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4191 def GetPosition(*args
, **kwargs
):
4193 GetPosition(self) -> int
4195 Returns the position of the scrollbar for the thumb track and release
4196 events. Note that this field can't be used for the other events, you
4197 need to query the window itself for the current position in that case.
4199 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4201 def SetOrientation(*args
, **kwargs
):
4202 """SetOrientation(self, int orient)"""
4203 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4205 def SetPosition(*args
, **kwargs
):
4206 """SetPosition(self, int pos)"""
4207 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4209 ScrollWinEvent_swigregister
= _core_
.ScrollWinEvent_swigregister
4210 ScrollWinEvent_swigregister(ScrollWinEvent
)
4212 #---------------------------------------------------------------------------
4214 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4215 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4216 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4217 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4218 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4219 class MouseEvent(Event
):
4221 This event class contains information about the events generated by
4222 the mouse: they include mouse buttons press and release events and
4225 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4226 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4227 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4228 a middle button so a portable application should avoid relying on the
4231 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4232 the former returns true when the event corresponds to the left mouse
4233 button click while the latter returns true if the left mouse button is
4234 currently being pressed. For example, when the user is dragging the
4235 mouse you can use `LeftIsDown` to test whether the left mouse button
4236 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4237 `LeftIsDown` will also return true in wxWidgets whatever the
4238 underlying GUI behaviour is (which is platform-dependent). The same
4239 applies, of course, to other mouse buttons as well.
4241 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4242 __repr__
= _swig_repr
4243 def __init__(self
, *args
, **kwargs
):
4245 __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent
4247 Constructs a wx.MouseEvent. Valid event types are:
4249 * wxEVT_ENTER_WINDOW
4250 * wxEVT_LEAVE_WINDOW
4256 * wxEVT_MIDDLE_DCLICK
4259 * wxEVT_RIGHT_DCLICK
4263 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4264 def IsButton(*args
, **kwargs
):
4266 IsButton(self) -> bool
4268 Returns true if the event was a mouse button event (not necessarily a
4269 button down event - that may be tested using `ButtonDown`).
4271 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4273 def ButtonDown(*args
, **kwargs
):
4275 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4277 If the argument is omitted, this returns true if the event was any
4278 mouse button down event. Otherwise the argument specifies which
4279 button-down event shold be checked for (see `Button` for the possible
4282 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4284 def ButtonDClick(*args
, **kwargs
):
4286 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4288 If the argument is omitted, this returns true if the event was any
4289 mouse double click event. Otherwise the argument specifies which
4290 double click event to check for (see `Button` for the possible
4293 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4295 def ButtonUp(*args
, **kwargs
):
4297 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4299 If the argument is omitted, this returns true if the event was any
4300 mouse button up event. Otherwise the argument specifies which button
4301 up event to check for (see `Button` for the possible values).
4303 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4305 def Button(*args
, **kwargs
):
4307 Button(self, int button) -> bool
4309 Returns true if the identified mouse button is changing state. Valid
4310 values of button are:
4312 ==================== =====================================
4313 wx.MOUSE_BTN_LEFT check if left button was pressed
4314 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4315 wx.MOUSE_BTN_RIGHT check if right button was pressed
4316 wx.MOUSE_BTN_ANY check if any button was pressed
4317 ==================== =====================================
4320 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4322 def ButtonIsDown(*args
, **kwargs
):
4323 """ButtonIsDown(self, int but) -> bool"""
4324 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4326 def GetButton(*args
, **kwargs
):
4328 GetButton(self) -> int
4330 Returns the mouse button which generated this event or
4331 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4332 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4333 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4334 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4335 right buttons respectively.
4337 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4339 def ControlDown(*args
, **kwargs
):
4341 ControlDown(self) -> bool
4343 Returns true if the control key was down at the time of the event.
4345 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4347 def MetaDown(*args
, **kwargs
):
4349 MetaDown(self) -> bool
4351 Returns true if the Meta key was down at the time of the event.
4353 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4355 def AltDown(*args
, **kwargs
):
4357 AltDown(self) -> bool
4359 Returns true if the Alt key was down at the time of the event.
4361 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4363 def ShiftDown(*args
, **kwargs
):
4365 ShiftDown(self) -> bool
4367 Returns true if the Shift key was down at the time of the event.
4369 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4371 def CmdDown(*args
, **kwargs
):
4373 CmdDown(self) -> bool
4375 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4376 platforms but the special "Apple" (a.k.a as "Command") key on
4377 Macs. It often makes sense to use it instead of, say, `ControlDown`
4378 because Cmd key is used for the same thing under Mac as Ctrl
4379 elsewhere. The Ctrl key still exists, it's just not used for this
4380 purpose. So for non-Mac platforms this is the same as `ControlDown`
4381 and Macs this is the same as `MetaDown`.
4383 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4385 def LeftDown(*args
, **kwargs
):
4387 LeftDown(self) -> bool
4389 Returns true if the left mouse button state changed to down.
4391 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4393 def MiddleDown(*args
, **kwargs
):
4395 MiddleDown(self) -> bool
4397 Returns true if the middle mouse button state changed to down.
4399 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4401 def RightDown(*args
, **kwargs
):
4403 RightDown(self) -> bool
4405 Returns true if the right mouse button state changed to down.
4407 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4409 def LeftUp(*args
, **kwargs
):
4411 LeftUp(self) -> bool
4413 Returns true if the left mouse button state changed to up.
4415 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4417 def MiddleUp(*args
, **kwargs
):
4419 MiddleUp(self) -> bool
4421 Returns true if the middle mouse button state changed to up.
4423 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4425 def RightUp(*args
, **kwargs
):
4427 RightUp(self) -> bool
4429 Returns true if the right mouse button state changed to up.
4431 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4433 def LeftDClick(*args
, **kwargs
):
4435 LeftDClick(self) -> bool
4437 Returns true if the event was a left button double click.
4439 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4441 def MiddleDClick(*args
, **kwargs
):
4443 MiddleDClick(self) -> bool
4445 Returns true if the event was a middle button double click.
4447 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4449 def RightDClick(*args
, **kwargs
):
4451 RightDClick(self) -> bool
4453 Returns true if the event was a right button double click.
4455 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4457 def LeftIsDown(*args
, **kwargs
):
4459 LeftIsDown(self) -> bool
4461 Returns true if the left mouse button is currently down, independent
4462 of the current event type.
4464 Please notice that it is not the same as LeftDown which returns true
4465 if the left mouse button was just pressed. Rather, it describes the
4466 state of the mouse button before the event happened.
4468 This event is usually used in the mouse event handlers which process
4469 "move mouse" messages to determine whether the user is (still)
4472 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4474 def MiddleIsDown(*args
, **kwargs
):
4476 MiddleIsDown(self) -> bool
4478 Returns true if the middle mouse button is currently down, independent
4479 of the current event type.
4481 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4483 def RightIsDown(*args
, **kwargs
):
4485 RightIsDown(self) -> bool
4487 Returns true if the right mouse button is currently down, independent
4488 of the current event type.
4490 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4492 def Dragging(*args
, **kwargs
):
4494 Dragging(self) -> bool
4496 Returns true if this was a dragging event (motion while a button is
4499 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4501 def Moving(*args
, **kwargs
):
4503 Moving(self) -> bool
4505 Returns true if this was a motion event and no mouse buttons were
4506 pressed. If any mouse button is held pressed, then this method returns
4507 false and Dragging returns true.
4509 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4511 def Entering(*args
, **kwargs
):
4513 Entering(self) -> bool
4515 Returns true if the mouse was entering the window.
4517 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4519 def Leaving(*args
, **kwargs
):
4521 Leaving(self) -> bool
4523 Returns true if the mouse was leaving the window.
4525 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4527 def GetPosition(*args
, **kwargs
):
4529 GetPosition(self) -> Point
4531 Returns the pixel position of the mouse in window coordinates when the
4534 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4536 def GetPositionTuple(*args
, **kwargs
):
4538 GetPositionTuple() -> (x,y)
4540 Returns the pixel position of the mouse in window coordinates when the
4543 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4545 def GetLogicalPosition(*args
, **kwargs
):
4547 GetLogicalPosition(self, DC dc) -> Point
4549 Returns the logical mouse position in pixels (i.e. translated
4550 according to the translation set for the DC, which usually indicates
4551 that the window has been scrolled).
4553 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
4555 def GetX(*args
, **kwargs
):
4559 Returns X coordinate of the physical mouse event position.
4561 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
4563 def GetY(*args
, **kwargs
):
4567 Returns Y coordinate of the physical mouse event position.
4569 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
4571 def GetWheelRotation(*args
, **kwargs
):
4573 GetWheelRotation(self) -> int
4575 Get wheel rotation, positive or negative indicates direction of
4576 rotation. Current devices all send an event when rotation is equal to
4577 +/-WheelDelta, but this allows for finer resolution devices to be
4578 created in the future. Because of this you shouldn't assume that one
4579 event is equal to 1 line or whatever, but you should be able to either
4580 do partial line scrolling or wait until +/-WheelDelta rotation values
4581 have been accumulated before scrolling.
4583 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
4585 def GetWheelDelta(*args
, **kwargs
):
4587 GetWheelDelta(self) -> int
4589 Get wheel delta, normally 120. This is the threshold for action to be
4590 taken, and one such action (for example, scrolling one increment)
4591 should occur for each delta.
4593 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
4595 def GetLinesPerAction(*args
, **kwargs
):
4597 GetLinesPerAction(self) -> int
4599 Returns the configured number of lines (or whatever) to be scrolled
4600 per wheel action. Defaults to three.
4602 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
4604 def IsPageScroll(*args
, **kwargs
):
4606 IsPageScroll(self) -> bool
4608 Returns true if the system has been setup to do page scrolling with
4609 the mouse wheel instead of line scrolling.
4611 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
4613 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
4614 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
4615 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
4616 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
4617 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
4618 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
4619 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
4620 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
4621 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
4622 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
4623 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
4624 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
4625 MouseEvent_swigregister
= _core_
.MouseEvent_swigregister
4626 MouseEvent_swigregister(MouseEvent
)
4628 #---------------------------------------------------------------------------
4630 class SetCursorEvent(Event
):
4632 A SetCursorEvent is generated when the mouse cursor is about to be set
4633 as a result of mouse motion. This event gives the application the
4634 chance to perform specific mouse cursor processing based on the
4635 current position of the mouse within the window. Use the `SetCursor`
4636 method to specify the cursor you want to be displayed.
4638 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4639 __repr__
= _swig_repr
4640 def __init__(self
, *args
, **kwargs
):
4642 __init__(self, int x=0, int y=0) -> SetCursorEvent
4644 Construct a new `wx.SetCursorEvent`.
4646 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
4647 def GetX(*args
, **kwargs
):
4651 Returns the X coordinate of the mouse in client coordinates.
4653 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
4655 def GetY(*args
, **kwargs
):
4659 Returns the Y coordinate of the mouse in client coordinates.
4661 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
4663 def SetCursor(*args
, **kwargs
):
4665 SetCursor(self, Cursor cursor)
4667 Sets the cursor associated with this event.
4669 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
4671 def GetCursor(*args
, **kwargs
):
4673 GetCursor(self) -> Cursor
4675 Returns a reference to the cursor specified by this event.
4677 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
4679 def HasCursor(*args
, **kwargs
):
4681 HasCursor(self) -> bool
4683 Returns true if the cursor specified by this event is a valid cursor.
4685 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
4687 SetCursorEvent_swigregister
= _core_
.SetCursorEvent_swigregister
4688 SetCursorEvent_swigregister(SetCursorEvent
)
4690 #---------------------------------------------------------------------------
4692 class KeyEvent(Event
):
4694 This event class contains information about keypress and character
4695 events. These events are only sent to the widget that currently has
4698 Notice that there are three different kinds of keyboard events in
4699 wxWidgets: key down and up events and char events. The difference
4700 between the first two is clear - the first corresponds to a key press
4701 and the second to a key release - otherwise they are identical. Just
4702 note that if the key is maintained in a pressed state you will
4703 typically get a lot of (automatically generated) down events but only
4704 one up so it is wrong to assume that there is one up event
4705 corresponding to each down one.
4707 Both key events provide untranslated key codes while the char event
4708 carries the translated one. The untranslated code for alphanumeric
4709 keys is always an upper case value. For the other keys it is one of
4710 WXK_XXX values from the keycodes table. The translated key is, in
4711 general, the character the user expects to appear as the result of the
4712 key combination when typing the text into a text entry zone, for
4715 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4716 and the standard US keyboard): when the 'A' key is pressed, the key
4717 down event key code is equal to ASCII A == 65. But the char event key
4718 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4719 'A' keys simultaneously , the key code in key down event will still be
4720 just 'A' while the char event key code parameter will now be 'A' as
4723 Although in this simple case it is clear that the correct key code
4724 could be found in the key down event handler by checking the value
4725 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4726 as for non alphanumeric keys or non-US keyboard layouts the
4727 translation is keyboard-layout dependent and can only be done properly
4728 by the system itself.
4730 Another kind of translation is done when the control key is pressed:
4731 for example, for CTRL-A key press the key down event still carries the
4732 same key code 'A' as usual but the char event will have key code of 1,
4733 the ASCII value of this key combination.
4735 You may discover how the other keys on your system behave
4736 interactively by running the KeyEvents sample in the wxPython demo and
4737 pressing some keys while the blue box at the top has the keyboard
4740 **Note**: If a key down event is caught and the event handler does not
4741 call event.Skip() then the coresponding char event will not
4742 happen. This is by design and enables the programs that handle both
4743 types of events to be a bit simpler.
4745 **Note for Windows programmers**: The key and char events in wxWidgets
4746 are similar to but slightly different from Windows WM_KEYDOWN and
4747 WM_CHAR events. In particular, Alt-x combination will generate a char
4748 event in wxWidgets (unless it is used as an accelerator).
4750 **Tip**: be sure to call event.Skip() for events that you don't
4751 process in key event function, otherwise menu shortcuts may cease to
4755 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4756 __repr__
= _swig_repr
4757 def __init__(self
, *args
, **kwargs
):
4759 __init__(self, wxEventType eventType=wxEVT_NULL) -> KeyEvent
4761 Construct a new `wx.KeyEvent`. Valid event types are:
4764 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
4765 def GetModifiers(*args
, **kwargs
):
4767 GetModifiers(self) -> int
4769 Returns a bitmask of the current modifier settings. Can be used to
4770 check if the key event has exactly the given modifiers without having
4771 to explicitly check that the other modifiers are not down. For
4774 if event.GetModifers() == wx.MOD_CONTROL:
4778 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
4780 def ControlDown(*args
, **kwargs
):
4782 ControlDown(self) -> bool
4784 Returns ``True`` if the Control key was down at the time of the event.
4786 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
4788 def MetaDown(*args
, **kwargs
):
4790 MetaDown(self) -> bool
4792 Returns ``True`` if the Meta key was down at the time of the event.
4794 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
4796 def AltDown(*args
, **kwargs
):
4798 AltDown(self) -> bool
4800 Returns ``True`` if the Alt key was down at the time of the event.
4802 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
4804 def ShiftDown(*args
, **kwargs
):
4806 ShiftDown(self) -> bool
4808 Returns ``True`` if the Shift key was down at the time of the event.
4810 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
4812 def CmdDown(*args
, **kwargs
):
4814 CmdDown(self) -> bool
4816 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4817 platforms but the special "Apple" (a.k.a as "Command") key on
4818 Macs. It makes often sense to use it instead of, say, `ControlDown`
4819 because Cmd key is used for the same thing under Mac as Ctrl
4820 elsewhere. The Ctrl still exists, it's just not used for this
4821 purpose. So for non-Mac platforms this is the same as `ControlDown`
4822 and Macs this is the same as `MetaDown`.
4824 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
4826 def HasModifiers(*args
, **kwargs
):
4828 HasModifiers(self) -> bool
4830 Returns true if either CTRL or ALT keys was down at the time of the
4831 key event. Note that this function does not take into account neither
4832 SHIFT nor META key states (the reason for ignoring the latter is that
4833 it is common for NUMLOCK key to be configured as META under X but the
4834 key presses even while NUMLOCK is on should be still processed
4837 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
4839 def GetKeyCode(*args
, **kwargs
):
4841 GetKeyCode(self) -> int
4843 Returns the virtual key code. ASCII events return normal ASCII values,
4844 while non-ASCII events return values such as WXK_LEFT for the left
4845 cursor key. See `wx.KeyEvent` for a full list of the virtual key
4848 Note that in Unicode build, the returned value is meaningful only if
4849 the user entered a character that can be represented in current
4850 locale's default charset. You can obtain the corresponding Unicode
4851 character using `GetUnicodeKey`.
4853 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
4855 KeyCode
= GetKeyCode
4856 def GetUnicodeKey(*args
, **kwargs
):
4858 GetUnicodeKey(self) -> int
4860 Returns the Unicode character corresponding to this key event. This
4861 function is only meaningfule in a Unicode build of wxPython.
4863 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
4865 GetUniChar
= GetUnicodeKey
4866 def GetRawKeyCode(*args
, **kwargs
):
4868 GetRawKeyCode(self) -> unsigned int
4870 Returns the raw key code for this event. This is a platform-dependent
4871 scan code which should only be used in advanced
4872 applications. Currently the raw key codes are not supported by all
4875 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
4877 def GetRawKeyFlags(*args
, **kwargs
):
4879 GetRawKeyFlags(self) -> unsigned int
4881 Returns the low level key flags for this event. The flags are
4882 platform-dependent and should only be used in advanced applications.
4883 Currently the raw key flags are not supported by all ports.
4885 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
4887 def GetPosition(*args
, **kwargs
):
4889 GetPosition(self) -> Point
4891 Find the position of the event, if applicable.
4893 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
4895 def GetPositionTuple(*args
, **kwargs
):
4897 GetPositionTuple() -> (x,y)
4899 Find the position of the event, if applicable.
4901 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
4903 def GetX(*args
, **kwargs
):
4907 Returns the X position (in client coordinates) of the event, if
4910 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
4912 def GetY(*args
, **kwargs
):
4916 Returns the Y position (in client coordinates) of the event, if
4919 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
4921 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
4922 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
4923 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
4924 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
4925 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
4926 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
4927 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
4928 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
4929 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
4930 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
4931 KeyEvent_swigregister
= _core_
.KeyEvent_swigregister
4932 KeyEvent_swigregister(KeyEvent
)
4934 #---------------------------------------------------------------------------
4936 class SizeEvent(Event
):
4938 A size event holds information about size change events. The EVT_SIZE
4939 handler function will be called when the window it is bound to has
4942 Note that the size passed is of the whole window: call
4943 `wx.Window.GetClientSize` for the area which may be used by the
4946 When a window is resized, usually only a small part of the window is
4947 damaged and and that area is all that is in the update region for the
4948 next paint event. However, if your drawing depends on the size of the
4949 window, you may need to clear the DC explicitly and repaint the whole
4950 window. In which case, you may need to call `wx.Window.Refresh` to
4951 invalidate the entire window.
4954 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4955 __repr__
= _swig_repr
4956 def __init__(self
, *args
, **kwargs
):
4958 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
4960 Construct a new ``wx.SizeEvent``.
4962 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
4963 def GetSize(*args
, **kwargs
):
4965 GetSize(self) -> Size
4967 Returns the entire size of the window generating the size change
4970 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
4972 def GetRect(*args
, **kwargs
):
4973 """GetRect(self) -> Rect"""
4974 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
4976 def SetRect(*args
, **kwargs
):
4977 """SetRect(self, Rect rect)"""
4978 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
4980 def SetSize(*args
, **kwargs
):
4981 """SetSize(self, Size size)"""
4982 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
4984 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
4985 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
4986 SizeEvent_swigregister
= _core_
.SizeEvent_swigregister
4987 SizeEvent_swigregister(SizeEvent
)
4989 #---------------------------------------------------------------------------
4991 class MoveEvent(Event
):
4993 This event object is sent for EVT_MOVE event bindings when a window is
4994 moved to a new position.
4996 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4997 __repr__
= _swig_repr
4998 def __init__(self
, *args
, **kwargs
):
5000 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5004 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5005 def GetPosition(*args
, **kwargs
):
5007 GetPosition(self) -> Point
5009 Returns the position of the window generating the move change event.
5011 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5013 def GetRect(*args
, **kwargs
):
5014 """GetRect(self) -> Rect"""
5015 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5017 def SetRect(*args
, **kwargs
):
5018 """SetRect(self, Rect rect)"""
5019 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5021 def SetPosition(*args
, **kwargs
):
5022 """SetPosition(self, Point pos)"""
5023 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5025 m_pos
= property(GetPosition
, SetPosition
)
5026 m_rect
= property(GetRect
, SetRect
)
5028 MoveEvent_swigregister
= _core_
.MoveEvent_swigregister
5029 MoveEvent_swigregister(MoveEvent
)
5031 #---------------------------------------------------------------------------
5033 class PaintEvent(Event
):
5035 A paint event is sent when a window's contents needs to be repainted.
5036 Note that in an EVT_PAINT handler the application must *always* create
5037 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5038 Windows assumes that the window has not been painted yet and will send
5039 the event again, causing endless refreshes.
5041 You can optimize painting by retrieving the rectangles that have been
5042 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5043 and only repainting these rectangles. The rectangles are in terms of
5044 the client area, and are unscrolled, so you will need to do some
5045 calculations using the current view position to obtain logical,
5049 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5050 __repr__
= _swig_repr
5051 def __init__(self
, *args
, **kwargs
):
5052 """__init__(self, int Id=0) -> PaintEvent"""
5053 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5054 PaintEvent_swigregister
= _core_
.PaintEvent_swigregister
5055 PaintEvent_swigregister(PaintEvent
)
5057 class NcPaintEvent(Event
):
5058 """Proxy of C++ NcPaintEvent class"""
5059 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5060 __repr__
= _swig_repr
5061 def __init__(self
, *args
, **kwargs
):
5062 """__init__(self, int winid=0) -> NcPaintEvent"""
5063 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5064 NcPaintEvent_swigregister
= _core_
.NcPaintEvent_swigregister
5065 NcPaintEvent_swigregister(NcPaintEvent
)
5067 #---------------------------------------------------------------------------
5069 class EraseEvent(Event
):
5071 An erase event is sent whenever the background of a window needs to be
5072 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5073 binder. On some platforms, such as GTK+, this event is simulated
5074 (simply generated just before the paint event) and may cause flicker.
5076 To paint a custom background use the `GetDC` method and use the returned
5077 device context if it is not ``None``, otherwise create a temporary
5078 `wx.ClientDC` and draw on that.
5081 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5082 __repr__
= _swig_repr
5083 def __init__(self
, *args
, **kwargs
):
5085 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5089 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5090 def GetDC(*args
, **kwargs
):
5094 Returns the device context the event handler should draw upon. If
5095 ``None`` is returned then create a temporary `wx.ClientDC` and use
5098 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5100 EraseEvent_swigregister
= _core_
.EraseEvent_swigregister
5101 EraseEvent_swigregister(EraseEvent
)
5103 #---------------------------------------------------------------------------
5105 class FocusEvent(Event
):
5107 A focus event is sent when a window's focus changes. The window losing
5108 focus receives an EVT_KILL_FOCUS event while the window gaining it
5109 gets an EVT_SET_FOCUS event.
5111 Notice that the set focus event happens both when the user gives focus
5112 to the window (whether using the mouse or keyboard) and when it is
5113 done from the program itself using `wx.Window.SetFocus`.
5116 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5117 __repr__
= _swig_repr
5118 def __init__(self
, *args
, **kwargs
):
5120 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5124 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5125 def GetWindow(*args
, **kwargs
):
5127 GetWindow(self) -> Window
5129 Returns the other window associated with this event, that is the
5130 window which had the focus before for the EVT_SET_FOCUS event and the
5131 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5133 Warning: the window returned may be None!
5135 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5137 def SetWindow(*args
, **kwargs
):
5138 """SetWindow(self, Window win)"""
5139 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5141 FocusEvent_swigregister
= _core_
.FocusEvent_swigregister
5142 FocusEvent_swigregister(FocusEvent
)
5144 #---------------------------------------------------------------------------
5146 class ChildFocusEvent(CommandEvent
):
5148 wx.ChildFocusEvent notifies the parent that a child has received the
5149 focus. Unlike `wx.FocusEvent` it is propagated up the window
5152 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5153 __repr__
= _swig_repr
5154 def __init__(self
, *args
, **kwargs
):
5156 __init__(self, Window win=None) -> ChildFocusEvent
5160 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5161 def GetWindow(*args
, **kwargs
):
5163 GetWindow(self) -> Window
5165 The window which has just received the focus.
5167 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5169 ChildFocusEvent_swigregister
= _core_
.ChildFocusEvent_swigregister
5170 ChildFocusEvent_swigregister(ChildFocusEvent
)
5172 #---------------------------------------------------------------------------
5174 class ActivateEvent(Event
):
5176 An activate event is sent when a top-level window or the entire
5177 application is being activated or deactivated.
5179 A top-level window (a dialog or frame) receives an activate event when
5180 is being activated or deactivated. This is indicated visually by the
5181 title bar changing colour, and a subwindow gaining the keyboard focus.
5182 An application is activated or deactivated when one of its frames
5183 becomes activated, or a frame becomes inactivate resulting in all
5184 application frames being inactive.
5186 Please note that usually you should call event.Skip() in your handlers
5187 for these events so the default handlers will still be called, as not
5188 doing so can result in strange effects.
5191 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5192 __repr__
= _swig_repr
5193 def __init__(self
, *args
, **kwargs
):
5195 __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5199 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5200 def GetActive(*args
, **kwargs
):
5202 GetActive(self) -> bool
5204 Returns true if the application or window is being activated, false
5207 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5209 ActivateEvent_swigregister
= _core_
.ActivateEvent_swigregister
5210 ActivateEvent_swigregister(ActivateEvent
)
5212 #---------------------------------------------------------------------------
5214 class InitDialogEvent(Event
):
5216 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5217 any window when `wx.Window.InitDialog` is called. Handlers for this
5218 event can transfer data to the window, or anything else that should be
5219 done before the user begins editing the form. The default handler
5220 calls `wx.Window.TransferDataToWindow`.
5222 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5223 __repr__
= _swig_repr
5224 def __init__(self
, *args
, **kwargs
):
5226 __init__(self, int Id=0) -> InitDialogEvent
5230 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5231 InitDialogEvent_swigregister
= _core_
.InitDialogEvent_swigregister
5232 InitDialogEvent_swigregister(InitDialogEvent
)
5234 #---------------------------------------------------------------------------
5236 class MenuEvent(Event
):
5238 This class is used for a variety of menu-related events. Note that
5239 these do not include menu command events, which are handled by sending
5240 `wx.CommandEvent` objects.
5242 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5243 text in the first field of the status bar.
5245 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5246 __repr__
= _swig_repr
5247 def __init__(self
, *args
, **kwargs
):
5249 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5253 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5254 def GetMenuId(*args
, **kwargs
):
5256 GetMenuId(self) -> int
5258 Returns the menu identifier associated with the event. This method
5259 should be only used with the HIGHLIGHT events.
5261 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5263 def IsPopup(*args
, **kwargs
):
5265 IsPopup(self) -> bool
5267 Returns ``True`` if the menu which is being opened or closed is a
5268 popup menu, ``False`` if it is a normal one. This method should only
5269 be used with the OPEN and CLOSE events.
5271 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5273 def GetMenu(*args
, **kwargs
):
5275 GetMenu(self) -> Menu
5277 Returns the menu which is being opened or closed. This method should
5278 only be used with the OPEN and CLOSE events.
5280 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5282 MenuEvent_swigregister
= _core_
.MenuEvent_swigregister
5283 MenuEvent_swigregister(MenuEvent
)
5285 #---------------------------------------------------------------------------
5287 class CloseEvent(Event
):
5289 This event class contains information about window and session close
5292 The handler function for EVT_CLOSE is called when the user has tried
5293 to close a a frame or dialog box using the window manager controls or
5294 the system menu. It can also be invoked by the application itself
5295 programmatically, for example by calling the `wx.Window.Close`
5298 You should check whether the application is forcing the deletion of
5299 the window using `CanVeto`. If it returns ``False``, you must destroy
5300 the window using `wx.Window.Destroy`. If the return value is ``True``,
5301 it is up to you whether you respond by destroying the window or not.
5302 For example you may wish to display a message dialog prompting to save
5303 files or to cancel the close.
5305 If you don't destroy the window, you should call `Veto` to let the
5306 calling code know that you did not destroy the window. This allows the
5307 `wx.Window.Close` function to return ``True`` or ``False`` depending
5308 on whether the close instruction was honored or not.
5310 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5311 __repr__
= _swig_repr
5312 def __init__(self
, *args
, **kwargs
):
5314 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5318 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5319 def SetLoggingOff(*args
, **kwargs
):
5321 SetLoggingOff(self, bool logOff)
5323 Sets the 'logging off' flag.
5325 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5327 def GetLoggingOff(*args
, **kwargs
):
5329 GetLoggingOff(self) -> bool
5331 Returns ``True`` if the user is logging off or ``False`` if the
5332 system is shutting down. This method can only be called for end
5333 session and query end session events, it doesn't make sense for close
5336 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5338 def Veto(*args
, **kwargs
):
5340 Veto(self, bool veto=True)
5342 Call this from your event handler to veto a system shutdown or to
5343 signal to the calling application that a window close did not happen.
5345 You can only veto a shutdown or close if `CanVeto` returns true.
5347 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5349 def GetVeto(*args
, **kwargs
):
5350 """GetVeto(self) -> bool"""
5351 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5353 def SetCanVeto(*args
, **kwargs
):
5355 SetCanVeto(self, bool canVeto)
5357 Sets the 'can veto' flag.
5359 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5361 def CanVeto(*args
, **kwargs
):
5363 CanVeto(self) -> bool
5365 Returns true if you can veto a system shutdown or a window close
5366 event. Vetoing a window close event is not possible if the calling
5367 code wishes to force the application to exit, and so this function
5368 must be called to check this.
5370 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5372 CloseEvent_swigregister
= _core_
.CloseEvent_swigregister
5373 CloseEvent_swigregister(CloseEvent
)
5375 #---------------------------------------------------------------------------
5377 class ShowEvent(Event
):
5378 """An EVT_SHOW event is sent when a window is shown or hidden."""
5379 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5380 __repr__
= _swig_repr
5381 def __init__(self
, *args
, **kwargs
):
5383 __init__(self, int winid=0, bool show=False) -> ShowEvent
5385 An EVT_SHOW event is sent when a window is shown or hidden.
5387 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5388 def SetShow(*args
, **kwargs
):
5389 """SetShow(self, bool show)"""
5390 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5392 def GetShow(*args
, **kwargs
):
5393 """GetShow(self) -> bool"""
5394 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5396 ShowEvent_swigregister
= _core_
.ShowEvent_swigregister
5397 ShowEvent_swigregister(ShowEvent
)
5399 #---------------------------------------------------------------------------
5401 class IconizeEvent(Event
):
5403 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5406 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5407 __repr__
= _swig_repr
5408 def __init__(self
, *args
, **kwargs
):
5410 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5412 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5415 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5416 def Iconized(*args
, **kwargs
):
5418 Iconized(self) -> bool
5420 Returns ``True`` if the frame has been iconized, ``False`` if it has
5423 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5425 IconizeEvent_swigregister
= _core_
.IconizeEvent_swigregister
5426 IconizeEvent_swigregister(IconizeEvent
)
5428 #---------------------------------------------------------------------------
5430 class MaximizeEvent(Event
):
5431 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5432 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5433 __repr__
= _swig_repr
5434 def __init__(self
, *args
, **kwargs
):
5436 __init__(self, int id=0) -> MaximizeEvent
5438 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5440 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5441 MaximizeEvent_swigregister
= _core_
.MaximizeEvent_swigregister
5442 MaximizeEvent_swigregister(MaximizeEvent
)
5444 #---------------------------------------------------------------------------
5446 class DropFilesEvent(Event
):
5448 This class is used for drop files events, that is, when files have
5449 been dropped onto the window. This functionality is only available
5450 under Windows. The window must have previously been enabled for
5451 dropping by calling `wx.Window.DragAcceptFiles`.
5453 Important note: this is a separate implementation to the more general
5454 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5455 implementation uses the older, Windows message-based approach of
5458 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5462 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5463 def __init__(self
): raise AttributeError, "No constructor defined"
5464 __repr__
= _swig_repr
5465 def GetPosition(*args
, **kwargs
):
5467 GetPosition(self) -> Point
5469 Returns the position at which the files were dropped.
5471 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5473 def GetNumberOfFiles(*args
, **kwargs
):
5475 GetNumberOfFiles(self) -> int
5477 Returns the number of files dropped.
5479 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5481 def GetFiles(*args
, **kwargs
):
5483 GetFiles(self) -> PyObject
5485 Returns a list of the filenames that were dropped.
5487 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5489 DropFilesEvent_swigregister
= _core_
.DropFilesEvent_swigregister
5490 DropFilesEvent_swigregister(DropFilesEvent
)
5492 #---------------------------------------------------------------------------
5494 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5495 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5496 class UpdateUIEvent(CommandEvent
):
5498 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5499 wxWidgets to give an application the chance to update various user
5502 Without update UI events, an application has to work hard to
5503 check/uncheck, enable/disable, and set the text for elements such as
5504 menu items and toolbar buttons. The code for doing this has to be
5505 mixed up with the code that is invoked when an action is invoked for a
5506 menu item or button.
5508 With update UI events, you define an event handler to look at the
5509 state of the application and change UI elements accordingly. wxWidgets
5510 will call your handler functions in idle time, so you don't have to
5511 worry where to call this code. In addition to being a clearer and more
5512 declarative method, it also means you don't have to worry whether
5513 you're updating a toolbar or menubar identifier. The same handler can
5514 update a menu item and toolbar button, if the ID values are the same.
5516 Instead of directly manipulating the menu or button, you call
5517 functions in the event object, such as `Check`. wxWidgets will
5518 determine whether such a call has been made, and which UI element to
5521 These events will work for popup menus as well as menubars. Just
5522 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5523 any UI events for the window that owns the menu.
5525 If you find that the overhead of UI update processing is affecting
5526 your application, you can do one or both of the following:
5528 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5529 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5530 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5531 receive update events. No other windows will receive update
5534 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5535 value to set the delay between updates. You may need to call
5536 `wx.Window.UpdateWindowUI` at critical points, for example when
5537 a dialog is about to be shown, in case the user sees a slight
5538 delay before windows are updated.
5540 Note that although events are sent in idle time, defining a EVT_IDLE
5541 handler for a window does not affect this because the events are sent
5542 from an internal idle handler.
5544 wxWidgets tries to optimize update events on some platforms. On
5545 Windows and GTK+, events for menubar items are only sent when the menu
5546 is about to be shown, and not in idle time.
5549 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5550 __repr__
= _swig_repr
5551 def __init__(self
, *args
, **kwargs
):
5553 __init__(self, int commandId=0) -> UpdateUIEvent
5557 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
5558 def GetChecked(*args
, **kwargs
):
5560 GetChecked(self) -> bool
5562 Returns ``True`` if the UI element should be checked.
5564 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
5566 def GetEnabled(*args
, **kwargs
):
5568 GetEnabled(self) -> bool
5570 Returns ``True`` if the UI element should be enabled.
5572 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
5574 def GetShown(*args
, **kwargs
):
5576 GetShown(self) -> bool
5578 Returns ``True`` if the UI element should be shown.
5580 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
5582 def GetText(*args
, **kwargs
):
5584 GetText(self) -> String
5586 Returns the text that should be set for the UI element.
5588 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
5590 def GetSetText(*args
, **kwargs
):
5592 GetSetText(self) -> bool
5594 Returns ``True`` if the application has called `SetText`. For
5595 wxWidgets internal use only.
5597 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
5599 def GetSetChecked(*args
, **kwargs
):
5601 GetSetChecked(self) -> bool
5603 Returns ``True`` if the application has called `Check`. For wxWidgets
5606 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
5608 def GetSetEnabled(*args
, **kwargs
):
5610 GetSetEnabled(self) -> bool
5612 Returns ``True`` if the application has called `Enable`. For wxWidgets
5615 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
5617 def GetSetShown(*args
, **kwargs
):
5619 GetSetShown(self) -> bool
5621 Returns ``True`` if the application has called `Show`. For wxWidgets
5624 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
5626 def Check(*args
, **kwargs
):
5628 Check(self, bool check)
5630 Check or uncheck the UI element.
5632 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
5634 def Enable(*args
, **kwargs
):
5636 Enable(self, bool enable)
5638 Enable or disable the UI element.
5640 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
5642 def Show(*args
, **kwargs
):
5644 Show(self, bool show)
5646 Show or hide the UI element.
5648 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
5650 def SetText(*args
, **kwargs
):
5652 SetText(self, String text)
5654 Sets the text for this UI element.
5656 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
5658 def SetUpdateInterval(*args
, **kwargs
):
5660 SetUpdateInterval(long updateInterval)
5662 Sets the interval between updates in milliseconds. Set to -1 to
5663 disable updates, or to 0 to update as frequently as possible. The
5666 Use this to reduce the overhead of UI update events if your
5667 application has a lot of windows. If you set the value to -1 or
5668 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5669 at appropriate points in your application, such as when a dialog is
5672 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5674 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
5675 def GetUpdateInterval(*args
, **kwargs
):
5677 GetUpdateInterval() -> long
5679 Returns the current interval between updates in milliseconds. -1
5680 disables updates, 0 updates as frequently as possible.
5682 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
5684 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
5685 def CanUpdate(*args
, **kwargs
):
5687 CanUpdate(Window win) -> bool
5689 Returns ``True`` if it is appropriate to update (send UI update events
5692 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5693 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5694 events were last sent in idle time, and the update interval, to
5695 determine whether events should be sent to this window now. By default
5696 this will always return true because the update mode is initially
5697 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5698 events will be sent as often as possible. You can reduce the frequency
5699 that events are sent by changing the mode and/or setting an update
5703 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
5705 CanUpdate
= staticmethod(CanUpdate
)
5706 def ResetUpdateTime(*args
, **kwargs
):
5710 Used internally to reset the last-updated time to the current time. It
5711 is assumed that update events are normally sent in idle time, so this
5712 is called at the end of idle processing.
5714 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
5716 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
5717 def SetMode(*args
, **kwargs
):
5721 Specify how wxWidgets will send update events: to all windows, or only
5722 to those which specify that they will process the events.
5724 The mode may be one of the following values:
5726 ============================= ==========================================
5727 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5728 is the default setting.
5729 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5730 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5732 ============================= ==========================================
5735 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
5737 SetMode
= staticmethod(SetMode
)
5738 def GetMode(*args
, **kwargs
):
5742 Returns a value specifying how wxWidgets will send update events: to
5743 all windows, or only to those which specify that they will process the
5746 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
5748 GetMode
= staticmethod(GetMode
)
5749 UpdateUIEvent_swigregister
= _core_
.UpdateUIEvent_swigregister
5750 UpdateUIEvent_swigregister(UpdateUIEvent
)
5752 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
5754 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5756 Sets the interval between updates in milliseconds. Set to -1 to
5757 disable updates, or to 0 to update as frequently as possible. The
5760 Use this to reduce the overhead of UI update events if your
5761 application has a lot of windows. If you set the value to -1 or
5762 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5763 at appropriate points in your application, such as when a dialog is
5766 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5768 def UpdateUIEvent_GetUpdateInterval(*args
):
5770 UpdateUIEvent_GetUpdateInterval() -> long
5772 Returns the current interval between updates in milliseconds. -1
5773 disables updates, 0 updates as frequently as possible.
5775 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
5777 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
5779 UpdateUIEvent_CanUpdate(Window win) -> bool
5781 Returns ``True`` if it is appropriate to update (send UI update events
5784 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5785 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5786 events were last sent in idle time, and the update interval, to
5787 determine whether events should be sent to this window now. By default
5788 this will always return true because the update mode is initially
5789 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5790 events will be sent as often as possible. You can reduce the frequency
5791 that events are sent by changing the mode and/or setting an update
5795 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
5797 def UpdateUIEvent_ResetUpdateTime(*args
):
5799 UpdateUIEvent_ResetUpdateTime()
5801 Used internally to reset the last-updated time to the current time. It
5802 is assumed that update events are normally sent in idle time, so this
5803 is called at the end of idle processing.
5805 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
5807 def UpdateUIEvent_SetMode(*args
, **kwargs
):
5809 UpdateUIEvent_SetMode(int mode)
5811 Specify how wxWidgets will send update events: to all windows, or only
5812 to those which specify that they will process the events.
5814 The mode may be one of the following values:
5816 ============================= ==========================================
5817 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5818 is the default setting.
5819 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5820 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5822 ============================= ==========================================
5825 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
5827 def UpdateUIEvent_GetMode(*args
):
5829 UpdateUIEvent_GetMode() -> int
5831 Returns a value specifying how wxWidgets will send update events: to
5832 all windows, or only to those which specify that they will process the
5835 return _core_
.UpdateUIEvent_GetMode(*args
)
5837 #---------------------------------------------------------------------------
5839 class SysColourChangedEvent(Event
):
5841 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5842 when the user changes the colour settings using the control
5843 panel. This is only applicable under Windows.
5845 The default event handler for this event propagates the event to child
5846 windows, since Windows only sends the events to top-level windows. If
5847 intercepting this event for a top-level window, remember to call
5848 `Skip` so the the base class handler will still be executed, or to
5849 pass the event on to the window's children explicitly.
5852 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5853 __repr__
= _swig_repr
5854 def __init__(self
, *args
, **kwargs
):
5856 __init__(self) -> SysColourChangedEvent
5860 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
5861 SysColourChangedEvent_swigregister
= _core_
.SysColourChangedEvent_swigregister
5862 SysColourChangedEvent_swigregister(SysColourChangedEvent
)
5864 #---------------------------------------------------------------------------
5866 class MouseCaptureChangedEvent(Event
):
5868 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
5869 a window that loses its mouse capture. This is called even if
5870 `wx.Window.ReleaseMouse` was called by the application code. Handling
5871 this event allows an application to cater for unexpected capture
5872 releases which might otherwise confuse mouse handling code.
5874 This event is implemented under Windows only.
5876 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5877 __repr__
= _swig_repr
5878 def __init__(self
, *args
, **kwargs
):
5880 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
5884 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
5885 def GetCapturedWindow(*args
, **kwargs
):
5887 GetCapturedWindow(self) -> Window
5889 Returns the window that gained the capture, or ``None`` if it was a
5890 non-wxWidgets window.
5892 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
5894 MouseCaptureChangedEvent_swigregister
= _core_
.MouseCaptureChangedEvent_swigregister
5895 MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
5897 #---------------------------------------------------------------------------
5899 class DisplayChangedEvent(Event
):
5901 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
5902 resolution has changed.
5904 This event is implemented under Windows only.
5906 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5907 __repr__
= _swig_repr
5908 def __init__(self
, *args
, **kwargs
):
5909 """__init__(self) -> DisplayChangedEvent"""
5910 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
5911 DisplayChangedEvent_swigregister
= _core_
.DisplayChangedEvent_swigregister
5912 DisplayChangedEvent_swigregister(DisplayChangedEvent
)
5914 #---------------------------------------------------------------------------
5916 class PaletteChangedEvent(Event
):
5918 An EVT_PALETTE_CHANGED event is sent when the system palette has
5919 changed, thereby giving each window a chance to redo their own to
5922 This event is implemented under Windows only.
5924 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5925 __repr__
= _swig_repr
5926 def __init__(self
, *args
, **kwargs
):
5928 __init__(self, int id=0) -> PaletteChangedEvent
5930 An EVT_PALETTE_CHANGED event is sent when the system palette has
5931 changed, thereby giving each window a chance to redo their own to
5934 This event is implemented under Windows only.
5936 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
5937 def SetChangedWindow(*args
, **kwargs
):
5938 """SetChangedWindow(self, Window win)"""
5939 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
5941 def GetChangedWindow(*args
, **kwargs
):
5942 """GetChangedWindow(self) -> Window"""
5943 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
5945 PaletteChangedEvent_swigregister
= _core_
.PaletteChangedEvent_swigregister
5946 PaletteChangedEvent_swigregister(PaletteChangedEvent
)
5948 #---------------------------------------------------------------------------
5950 class QueryNewPaletteEvent(Event
):
5952 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
5953 focus and should re-do its palette.
5955 This event is implemented under Windows only.
5957 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5958 __repr__
= _swig_repr
5959 def __init__(self
, *args
, **kwargs
):
5961 __init__(self, int winid=0) -> QueryNewPaletteEvent
5965 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
5966 def SetPaletteRealized(*args
, **kwargs
):
5968 SetPaletteRealized(self, bool realized)
5970 App should set this if it changes the palette.
5972 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
5974 def GetPaletteRealized(*args
, **kwargs
):
5975 """GetPaletteRealized(self) -> bool"""
5976 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
5978 QueryNewPaletteEvent_swigregister
= _core_
.QueryNewPaletteEvent_swigregister
5979 QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
5981 #---------------------------------------------------------------------------
5983 class NavigationKeyEvent(Event
):
5985 EVT_NAVIGATION_KEY events are used to control moving the focus between
5986 widgets, otherwise known as tab-traversal. You woudl normally not
5987 catch navigation events in applications as there are already
5988 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
5989 it useful to send navigation events in certain situations to change
5990 the focus in certain ways, although it's probably easier to just call
5991 `wx.Window.Navigate`.
5993 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5994 __repr__
= _swig_repr
5995 def __init__(self
, *args
, **kwargs
):
5996 """__init__(self) -> NavigationKeyEvent"""
5997 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
5998 def GetDirection(*args
, **kwargs
):
6000 GetDirection(self) -> bool
6002 Returns ``True`` if the direction is forward, ``False`` otherwise.
6004 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6006 def SetDirection(*args
, **kwargs
):
6008 SetDirection(self, bool forward)
6010 Specify the direction that the navigation should take. Usually the
6011 difference between using Tab and Shift-Tab.
6013 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6015 def IsWindowChange(*args
, **kwargs
):
6017 IsWindowChange(self) -> bool
6019 Returns ``True`` if window change is allowed.
6021 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6023 def SetWindowChange(*args
, **kwargs
):
6025 SetWindowChange(self, bool ischange)
6027 Specify if the navigation should be able to change parent windows.
6028 For example, changing notebook pages, etc. This is usually implemented
6029 by using Control-Tab.
6031 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6033 def IsFromTab(*args
, **kwargs
):
6035 IsFromTab(self) -> bool
6037 Returns ``True`` if the navigation event is originated from the Tab
6040 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6042 def SetFromTab(*args
, **kwargs
):
6044 SetFromTab(self, bool bIs)
6046 Set to true under MSW if the event was generated using the tab key.
6047 This is required for proper navogation over radio buttons.
6049 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6051 def SetFlags(*args
, **kwargs
):
6053 SetFlags(self, long flags)
6055 Set the navigation flags to a combination of the following:
6057 * wx.NavigationKeyEvent.IsBackward
6058 * wx.NavigationKeyEvent.IsForward
6059 * wx.NavigationKeyEvent.WinChange
6060 * wx.NavigationKeyEvent.FromTab
6063 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6065 def GetCurrentFocus(*args
, **kwargs
):
6067 GetCurrentFocus(self) -> Window
6069 Returns the child window which currenty has the focus. May be
6072 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6074 def SetCurrentFocus(*args
, **kwargs
):
6076 SetCurrentFocus(self, Window win)
6078 Set the window that has the focus.
6080 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6082 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6083 IsForward
= _core_
.NavigationKeyEvent_IsForward
6084 WinChange
= _core_
.NavigationKeyEvent_WinChange
6085 FromTab
= _core_
.NavigationKeyEvent_FromTab
6086 NavigationKeyEvent_swigregister
= _core_
.NavigationKeyEvent_swigregister
6087 NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6089 #---------------------------------------------------------------------------
6091 class WindowCreateEvent(CommandEvent
):
6093 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6094 underlying GUI object) exists.
6096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6097 __repr__
= _swig_repr
6098 def __init__(self
, *args
, **kwargs
):
6100 __init__(self, Window win=None) -> WindowCreateEvent
6102 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6103 underlying GUI object) exists.
6105 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6106 def GetWindow(*args
, **kwargs
):
6108 GetWindow(self) -> Window
6110 Returns the window that this event refers to.
6112 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6114 WindowCreateEvent_swigregister
= _core_
.WindowCreateEvent_swigregister
6115 WindowCreateEvent_swigregister(WindowCreateEvent
)
6117 class WindowDestroyEvent(CommandEvent
):
6119 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6120 when the GUI window is destroyed.
6122 When a class derived from `wx.Window` is destroyed its destructor will
6123 have already run by the time this event is sent. Therefore this event
6124 will not usually be received at all by the window itself. Since it is
6125 received after the destructor has run, an object should not try to
6126 handle its own wx.WindowDestroyEvent, but it can be used to get
6127 notification of the destruction of another window.
6129 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6130 __repr__
= _swig_repr
6131 def __init__(self
, *args
, **kwargs
):
6133 __init__(self, Window win=None) -> WindowDestroyEvent
6135 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6136 when the GUI window is destroyed.
6138 When a class derived from `wx.Window` is destroyed its destructor will
6139 have already run by the time this event is sent. Therefore this event
6140 will not usually be received at all by the window itself. Since it is
6141 received after the destructor has run, an object should not try to
6142 handle its own wx.WindowDestroyEvent, but it can be used to get
6143 notification of the destruction of another window.
6145 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6146 def GetWindow(*args
, **kwargs
):
6148 GetWindow(self) -> Window
6150 Returns the window that this event refers to.
6152 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6154 WindowDestroyEvent_swigregister
= _core_
.WindowDestroyEvent_swigregister
6155 WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6157 #---------------------------------------------------------------------------
6159 class ContextMenuEvent(CommandEvent
):
6161 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6162 give the application a chance to show a context (popup) menu.
6164 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6165 __repr__
= _swig_repr
6166 def __init__(self
, *args
, **kwargs
):
6168 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6172 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6173 def GetPosition(*args
, **kwargs
):
6175 GetPosition(self) -> Point
6177 Returns the position (in screen coordinants) at which the menu should
6180 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6182 def SetPosition(*args
, **kwargs
):
6184 SetPosition(self, Point pos)
6186 Sets the position at which the menu should be shown.
6188 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6190 ContextMenuEvent_swigregister
= _core_
.ContextMenuEvent_swigregister
6191 ContextMenuEvent_swigregister(ContextMenuEvent
)
6193 #---------------------------------------------------------------------------
6195 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6196 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6197 class IdleEvent(Event
):
6199 This class is used for EVT_IDLE events, which are generated and sent
6200 when the application *becomes* idle. In other words, the when the
6201 event queue becomes empty then idle events are sent to all windows (by
6202 default) and as long as none of them call `RequestMore` then there are
6203 no more idle events until after the system event queue has some normal
6204 events and then becomes empty again.
6206 By default, idle events are sent to all windows. If this is causing a
6207 significant overhead in your application, you can call
6208 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6209 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6210 which should receive idle events. Then idle events will only be sent
6211 to those windows and not to any others.
6213 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6214 __repr__
= _swig_repr
6215 def __init__(self
, *args
, **kwargs
):
6217 __init__(self) -> IdleEvent
6221 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6222 def RequestMore(*args
, **kwargs
):
6224 RequestMore(self, bool needMore=True)
6226 Tells wxWidgets that more processing is required. This function can be
6227 called by an EVT_IDLE handler for a window to indicate that the
6228 application should forward the EVT_IDLE event once more to the
6229 application windows. If no window calls this function during its
6230 EVT_IDLE handler, then the application will remain in a passive event
6231 loop until a new event is posted to the application by the windowing
6234 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6236 def MoreRequested(*args
, **kwargs
):
6238 MoreRequested(self) -> bool
6240 Returns ``True`` if the OnIdle function processing this event
6241 requested more processing time.
6243 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6245 def SetMode(*args
, **kwargs
):
6249 Static method for specifying how wxWidgets will send idle events: to
6250 all windows, or only to those which specify that they will process the
6253 The mode can be one of the following values:
6255 ========================= ========================================
6256 wx.IDLE_PROCESS_ALL Send idle events to all windows
6257 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6258 the wx.WS_EX_PROCESS_IDLE extra style
6260 ========================= ========================================
6263 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6265 SetMode
= staticmethod(SetMode
)
6266 def GetMode(*args
, **kwargs
):
6270 Static method returning a value specifying how wxWidgets will send
6271 idle events: to all windows, or only to those which specify that they
6272 will process the events.
6274 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6276 GetMode
= staticmethod(GetMode
)
6277 def CanSend(*args
, **kwargs
):
6279 CanSend(Window win) -> bool
6281 Returns ``True`` if it is appropriate to send idle events to this
6284 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6285 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6286 events should be sent to this window now. By default this will always
6287 return ``True`` because the update mode is initially
6288 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6289 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6291 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6293 CanSend
= staticmethod(CanSend
)
6294 IdleEvent_swigregister
= _core_
.IdleEvent_swigregister
6295 IdleEvent_swigregister(IdleEvent
)
6297 def IdleEvent_SetMode(*args
, **kwargs
):
6299 IdleEvent_SetMode(int mode)
6301 Static method for specifying how wxWidgets will send idle events: to
6302 all windows, or only to those which specify that they will process the
6305 The mode can be one of the following values:
6307 ========================= ========================================
6308 wx.IDLE_PROCESS_ALL Send idle events to all windows
6309 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6310 the wx.WS_EX_PROCESS_IDLE extra style
6312 ========================= ========================================
6315 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6317 def IdleEvent_GetMode(*args
):
6319 IdleEvent_GetMode() -> int
6321 Static method returning a value specifying how wxWidgets will send
6322 idle events: to all windows, or only to those which specify that they
6323 will process the events.
6325 return _core_
.IdleEvent_GetMode(*args
)
6327 def IdleEvent_CanSend(*args
, **kwargs
):
6329 IdleEvent_CanSend(Window win) -> bool
6331 Returns ``True`` if it is appropriate to send idle events to this
6334 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6335 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6336 events should be sent to this window now. By default this will always
6337 return ``True`` because the update mode is initially
6338 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6339 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6341 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6343 #---------------------------------------------------------------------------
6345 class PyEvent(Event
):
6347 wx.PyEvent can be used as a base class for implementing custom event
6348 types in Python. You should derived from this class instead of
6349 `wx.Event` because this class is Python-aware and is able to transport
6350 its Python bits safely through the wxWidgets event system and have
6351 them still be there when the event handler is invoked.
6353 :see: `wx.PyCommandEvent`
6356 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6357 __repr__
= _swig_repr
6358 def __init__(self
, *args
, **kwargs
):
6359 """__init__(self, int winid=0, wxEventType eventType=wxEVT_NULL) -> PyEvent"""
6360 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6363 __swig_destroy__
= _core_
.delete_PyEvent
6364 __del__
= lambda self
: None;
6365 def _SetSelf(*args
, **kwargs
):
6366 """_SetSelf(self, PyObject self)"""
6367 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6369 def _GetSelf(*args
, **kwargs
):
6370 """_GetSelf(self) -> PyObject"""
6371 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6373 PyEvent_swigregister
= _core_
.PyEvent_swigregister
6374 PyEvent_swigregister(PyEvent
)
6376 class PyCommandEvent(CommandEvent
):
6378 wx.PyCommandEvent can be used as a base class for implementing custom
6379 event types in Python, where the event shoudl travel up to parent
6380 windows looking for a handler. You should derived from this class
6381 instead of `wx.CommandEvent` because this class is Python-aware and is
6382 able to transport its Python bits safely through the wxWidgets event
6383 system and have them still be there when the event handler is invoked.
6388 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6389 __repr__
= _swig_repr
6390 def __init__(self
, *args
, **kwargs
):
6391 """__init__(self, wxEventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6392 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6395 __swig_destroy__
= _core_
.delete_PyCommandEvent
6396 __del__
= lambda self
: None;
6397 def _SetSelf(*args
, **kwargs
):
6398 """_SetSelf(self, PyObject self)"""
6399 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6401 def _GetSelf(*args
, **kwargs
):
6402 """_GetSelf(self) -> PyObject"""
6403 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6405 PyCommandEvent_swigregister
= _core_
.PyCommandEvent_swigregister
6406 PyCommandEvent_swigregister(PyCommandEvent
)
6408 class DateEvent(CommandEvent
):
6410 This event class holds information about a date change event and is
6411 used together with `wx.DatePickerCtrl`. It also serves as a base class
6412 for `wx.calendar.CalendarEvent`. Bind these event types with
6415 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6416 __repr__
= _swig_repr
6417 def __init__(self
, *args
, **kwargs
):
6418 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
6419 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6420 def GetDate(*args
, **kwargs
):
6422 GetDate(self) -> DateTime
6426 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6428 def SetDate(*args
, **kwargs
):
6430 SetDate(self, DateTime date)
6432 Sets the date carried by the event, normally only used by the library
6435 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6437 DateEvent_swigregister
= _core_
.DateEvent_swigregister
6438 DateEvent_swigregister(DateEvent
)
6440 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6441 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6443 #---------------------------------------------------------------------------
6445 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6446 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6447 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6448 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6449 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6450 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6451 class PyApp(EvtHandler
):
6453 The ``wx.PyApp`` class is an *implementation detail*, please use the
6454 `wx.App` class (or some other derived class) instead.
6456 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6457 __repr__
= _swig_repr
6458 def __init__(self
, *args
, **kwargs
):
6460 __init__(self) -> PyApp
6462 Create a new application object, starting the bootstrap process.
6464 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
6465 self
._setCallbackInfo
(self
, PyApp
, False)
6466 self
._setOORInfo
(self
, False)
6468 __swig_destroy__
= _core_
.delete_PyApp
6469 __del__
= lambda self
: None;
6470 def _setCallbackInfo(*args
, **kwargs
):
6471 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6472 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
6474 def GetAppName(*args
, **kwargs
):
6476 GetAppName(self) -> String
6478 Get the application name.
6480 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
6482 def SetAppName(*args
, **kwargs
):
6484 SetAppName(self, String name)
6486 Set the application name. This value may be used automatically by
6487 `wx.Config` and such.
6489 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
6491 def GetClassName(*args
, **kwargs
):
6493 GetClassName(self) -> String
6495 Get the application's class name.
6497 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
6499 def SetClassName(*args
, **kwargs
):
6501 SetClassName(self, String name)
6503 Set the application's class name. This value may be used for
6504 X-resources if applicable for the platform
6506 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
6508 def GetVendorName(*args
, **kwargs
):
6510 GetVendorName(self) -> String
6512 Get the application's vendor name.
6514 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
6516 def SetVendorName(*args
, **kwargs
):
6518 SetVendorName(self, String name)
6520 Set the application's vendor name. This value may be used
6521 automatically by `wx.Config` and such.
6523 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
6525 def GetTraits(*args
, **kwargs
):
6527 GetTraits(self) -> wxAppTraits
6529 Return (and create if necessary) the app traits object to which we
6530 delegate for everything which either should be configurable by the
6531 user (then he can change the default behaviour simply by overriding
6532 CreateTraits() and returning his own traits object) or which is
6533 GUI/console dependent as then wx.AppTraits allows us to abstract the
6534 differences behind the common facade.
6536 :todo: Add support for overriding CreateAppTraits in wxPython.
6538 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
6540 def ProcessPendingEvents(*args
, **kwargs
):
6542 ProcessPendingEvents(self)
6544 Process all events in the Pending Events list -- it is necessary to
6545 call this function to process posted events. This normally happens
6546 during each event loop iteration.
6548 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
6550 def Yield(*args
, **kwargs
):
6552 Yield(self, bool onlyIfNeeded=False) -> bool
6554 Process all currently pending events right now, instead of waiting
6555 until return to the event loop. It is an error to call ``Yield``
6556 recursively unless the value of ``onlyIfNeeded`` is True.
6558 :warning: This function is dangerous as it can lead to unexpected
6559 reentrancies (i.e. when called from an event handler it may
6560 result in calling the same event handler again), use with
6561 extreme care or, better, don't use at all!
6563 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6566 return _core_
.PyApp_Yield(*args
, **kwargs
)
6568 def WakeUpIdle(*args
, **kwargs
):
6572 Make sure that idle events are sent again.
6573 :see: `wx.WakeUpIdle`
6575 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
6577 def IsMainLoopRunning(*args
, **kwargs
):
6579 IsMainLoopRunning() -> bool
6581 Returns True if we're running the main loop, i.e. if the events can
6582 currently be dispatched.
6584 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
6586 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
6587 def MainLoop(*args
, **kwargs
):
6589 MainLoop(self) -> int
6591 Execute the main GUI loop, the function doesn't normally return until
6592 all top level windows have been closed and destroyed.
6594 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
6596 def Exit(*args
, **kwargs
):
6600 Exit the main loop thus terminating the application.
6603 return _core_
.PyApp_Exit(*args
, **kwargs
)
6605 def ExitMainLoop(*args
, **kwargs
):
6609 Exit the main GUI loop during the next iteration of the main
6610 loop, (i.e. it does not stop the program immediately!)
6612 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
6614 def Pending(*args
, **kwargs
):
6616 Pending(self) -> bool
6618 Returns True if there are unprocessed events in the event queue.
6620 return _core_
.PyApp_Pending(*args
, **kwargs
)
6622 def Dispatch(*args
, **kwargs
):
6624 Dispatch(self) -> bool
6626 Process the first event in the event queue (blocks until an event
6627 appears if there are none currently)
6629 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
6631 def ProcessIdle(*args
, **kwargs
):
6633 ProcessIdle(self) -> bool
6635 Called from the MainLoop when the application becomes idle (there are
6636 no pending events) and sends a `wx.IdleEvent` to all interested
6637 parties. Returns True if more idle events are needed, False if not.
6639 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
6641 def SendIdleEvents(*args
, **kwargs
):
6643 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6645 Send idle event to window and all subwindows. Returns True if more
6646 idle time is requested.
6648 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
6650 def IsActive(*args
, **kwargs
):
6652 IsActive(self) -> bool
6654 Return True if our app has focus.
6656 return _core_
.PyApp_IsActive(*args
, **kwargs
)
6658 def SetTopWindow(*args
, **kwargs
):
6660 SetTopWindow(self, Window win)
6662 Set the *main* top level window
6664 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
6666 def GetTopWindow(*args
, **kwargs
):
6668 GetTopWindow(self) -> Window
6670 Return the *main* top level window (if it hadn't been set previously
6671 with SetTopWindow(), will return just some top level window and, if
6672 there not any, will return None)
6674 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
6676 def SetExitOnFrameDelete(*args
, **kwargs
):
6678 SetExitOnFrameDelete(self, bool flag)
6680 Control the exit behaviour: by default, the program will exit the main
6681 loop (and so, usually, terminate) when the last top-level program
6682 window is deleted. Beware that if you disable this behaviour (with
6683 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6684 explicitly from somewhere.
6686 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
6688 def GetExitOnFrameDelete(*args
, **kwargs
):
6690 GetExitOnFrameDelete(self) -> bool
6692 Get the current exit behaviour setting.
6694 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
6696 def SetUseBestVisual(*args
, **kwargs
):
6698 SetUseBestVisual(self, bool flag)
6700 Set whether the app should try to use the best available visual on
6701 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6703 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
6705 def GetUseBestVisual(*args
, **kwargs
):
6707 GetUseBestVisual(self) -> bool
6709 Get current UseBestVisual setting.
6711 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
6713 def SetPrintMode(*args
, **kwargs
):
6714 """SetPrintMode(self, int mode)"""
6715 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
6717 def GetPrintMode(*args
, **kwargs
):
6718 """GetPrintMode(self) -> int"""
6719 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
6721 def SetAssertMode(*args
, **kwargs
):
6723 SetAssertMode(self, int mode)
6725 Set the OnAssert behaviour for debug and hybrid builds.
6727 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
6729 def GetAssertMode(*args
, **kwargs
):
6731 GetAssertMode(self) -> int
6733 Get the current OnAssert behaviour setting.
6735 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
6737 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
6738 """GetMacSupportPCMenuShortcuts() -> bool"""
6739 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
6741 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
6742 def GetMacAboutMenuItemId(*args
, **kwargs
):
6743 """GetMacAboutMenuItemId() -> long"""
6744 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
6746 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
6747 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
6748 """GetMacPreferencesMenuItemId() -> long"""
6749 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
6751 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
6752 def GetMacExitMenuItemId(*args
, **kwargs
):
6753 """GetMacExitMenuItemId() -> long"""
6754 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
6756 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
6757 def GetMacHelpMenuTitleName(*args
, **kwargs
):
6758 """GetMacHelpMenuTitleName() -> String"""
6759 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
6761 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
6762 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
6763 """SetMacSupportPCMenuShortcuts(bool val)"""
6764 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
6766 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
6767 def SetMacAboutMenuItemId(*args
, **kwargs
):
6768 """SetMacAboutMenuItemId(long val)"""
6769 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
6771 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
6772 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
6773 """SetMacPreferencesMenuItemId(long val)"""
6774 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
6776 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
6777 def SetMacExitMenuItemId(*args
, **kwargs
):
6778 """SetMacExitMenuItemId(long val)"""
6779 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
6781 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
6782 def SetMacHelpMenuTitleName(*args
, **kwargs
):
6783 """SetMacHelpMenuTitleName(String val)"""
6784 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
6786 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
6787 def _BootstrapApp(*args
, **kwargs
):
6791 For internal use only
6793 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
6795 def GetComCtl32Version(*args
, **kwargs
):
6797 GetComCtl32Version() -> int
6799 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6800 it wasn't found at all. Raises an exception on non-Windows platforms.
6802 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
6804 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
6805 PyApp_swigregister
= _core_
.PyApp_swigregister
6806 PyApp_swigregister(PyApp
)
6808 def PyApp_IsMainLoopRunning(*args
):
6810 PyApp_IsMainLoopRunning() -> bool
6812 Returns True if we're running the main loop, i.e. if the events can
6813 currently be dispatched.
6815 return _core_
.PyApp_IsMainLoopRunning(*args
)
6817 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
6818 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
6819 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
6821 def PyApp_GetMacAboutMenuItemId(*args
):
6822 """PyApp_GetMacAboutMenuItemId() -> long"""
6823 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
6825 def PyApp_GetMacPreferencesMenuItemId(*args
):
6826 """PyApp_GetMacPreferencesMenuItemId() -> long"""
6827 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
6829 def PyApp_GetMacExitMenuItemId(*args
):
6830 """PyApp_GetMacExitMenuItemId() -> long"""
6831 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
6833 def PyApp_GetMacHelpMenuTitleName(*args
):
6834 """PyApp_GetMacHelpMenuTitleName() -> String"""
6835 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
6837 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
6838 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
6839 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
6841 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
6842 """PyApp_SetMacAboutMenuItemId(long val)"""
6843 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
6845 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
6846 """PyApp_SetMacPreferencesMenuItemId(long val)"""
6847 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
6849 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
6850 """PyApp_SetMacExitMenuItemId(long val)"""
6851 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
6853 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
6854 """PyApp_SetMacHelpMenuTitleName(String val)"""
6855 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
6857 def PyApp_GetComCtl32Version(*args
):
6859 PyApp_GetComCtl32Version() -> int
6861 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6862 it wasn't found at all. Raises an exception on non-Windows platforms.
6864 return _core_
.PyApp_GetComCtl32Version(*args
)
6866 #---------------------------------------------------------------------------
6873 Force an exit of the application. Convenience for wx.GetApp().Exit()
6875 return _core_
.Exit(*args
)
6881 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
6883 return _core_
.Yield(*args
)
6885 def YieldIfNeeded(*args
):
6887 YieldIfNeeded() -> bool
6889 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
6891 return _core_
.YieldIfNeeded(*args
)
6893 def SafeYield(*args
, **kwargs
):
6895 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6897 This function is similar to `wx.Yield`, except that it disables the
6898 user input to all program windows before calling `wx.Yield` and
6899 re-enables it again afterwards. If ``win`` is not None, this window
6900 will remain enabled, allowing the implementation of some limited user
6903 :Returns: the result of the call to `wx.Yield`.
6905 return _core_
.SafeYield(*args
, **kwargs
)
6907 def WakeUpIdle(*args
):
6911 Cause the message queue to become empty again, so idle events will be
6914 return _core_
.WakeUpIdle(*args
)
6916 def PostEvent(*args
, **kwargs
):
6918 PostEvent(EvtHandler dest, Event event)
6920 Send an event to a window or other wx.EvtHandler to be processed
6923 return _core_
.PostEvent(*args
, **kwargs
)
6925 def App_CleanUp(*args
):
6929 For internal use only, it is used to cleanup after wxWidgets when
6932 return _core_
.App_CleanUp(*args
)
6938 Return a reference to the current wx.App object.
6940 return _core_
.GetApp(*args
)
6942 def SetDefaultPyEncoding(*args
, **kwargs
):
6944 SetDefaultPyEncoding(string encoding)
6946 Sets the encoding that wxPython will use when it needs to convert a
6947 Python string or unicode object to or from a wxString.
6949 The default encoding is the value of ``locale.getdefaultlocale()[1]``
6950 but please be aware that the default encoding within the same locale
6951 may be slightly different on different platforms. For example, please
6952 see http://www.alanwood.net/demos/charsetdiffs.html for differences
6953 between the common latin/roman encodings.
6955 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
6957 def GetDefaultPyEncoding(*args
):
6959 GetDefaultPyEncoding() -> string
6961 Gets the current encoding that wxPython will use when it needs to
6962 convert a Python string or unicode object to or from a wxString.
6964 return _core_
.GetDefaultPyEncoding(*args
)
6965 #----------------------------------------------------------------------
6967 class PyOnDemandOutputWindow
:
6969 A class that can be used for redirecting Python's stdout and
6970 stderr streams. It will do nothing until something is wrriten to
6971 the stream at which point it will create a Frame with a text area
6972 and write the text there.
6974 def __init__(self
, title
= "wxPython: stdout/stderr"):
6977 self
.pos
= wx
.DefaultPosition
6978 self
.size
= (450, 300)
6981 def SetParent(self
, parent
):
6982 """Set the window to be used as the popup Frame's parent."""
6983 self
.parent
= parent
6986 def CreateOutputWindow(self
, st
):
6987 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
6988 style
=wx
.DEFAULT_FRAME_STYLE
)
6989 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
6990 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
6991 self
.text
.AppendText(st
)
6992 self
.frame
.Show(True)
6993 EVT_CLOSE(self
.frame
, self
.OnCloseWindow
)
6996 def OnCloseWindow(self
, event
):
6997 if self
.frame
is not None:
6998 self
.frame
.Destroy()
7003 # These methods provide the file-like output behaviour.
7004 def write(self
, text
):
7006 Create the output window if needed and write the string to it.
7007 If not called in the context of the gui thread then uses
7008 CallAfter to do the work there.
7010 if self
.frame
is None:
7011 if not wx
.Thread_IsMain():
7012 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7014 self
.CreateOutputWindow(text
)
7016 if not wx
.Thread_IsMain():
7017 wx
.CallAfter(self
.text
.AppendText
, text
)
7019 self
.text
.AppendText(text
)
7023 if self
.frame
is not None:
7024 wx
.CallAfter(self
.frame
.Close
)
7032 #----------------------------------------------------------------------
7034 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7036 class App(wx
.PyApp
):
7038 The ``wx.App`` class represents the application and is used to:
7040 * bootstrap the wxPython system and initialize the underlying
7042 * set and get application-wide properties
7043 * implement the windowing system main message or event loop,
7044 and to dispatch events to window instances
7047 Every application must have a ``wx.App`` instance, and all
7048 creation of UI objects should be delayed until after the
7049 ``wx.App`` object has been created in order to ensure that the gui
7050 platform and wxWidgets have been fully initialized.
7052 Normally you would derive from this class and implement an
7053 ``OnInit`` method that creates a frame and then calls
7054 ``self.SetTopWindow(frame)``.
7056 :see: `wx.PySimpleApp` for a simpler app class that can be used
7060 outputWindowClass
= PyOnDemandOutputWindow
7062 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7063 useBestVisual
=False, clearSigInt
=True):
7065 Construct a ``wx.App`` object.
7067 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7068 redirected? Defaults to True on Windows and Mac, False
7069 otherwise. If `filename` is None then output will be
7070 redirected to a window that pops up as needed. (You can
7071 control what kind of window is created for the output by
7072 resetting the class variable ``outputWindowClass`` to a
7073 class of your choosing.)
7075 :param filename: The name of a file to redirect output to, if
7078 :param useBestVisual: Should the app try to use the best
7079 available visual provided by the system (only relevant on
7080 systems that have more than one visual.) This parameter
7081 must be used instead of calling `SetUseBestVisual` later
7082 on because it must be set before the underlying GUI
7083 toolkit is initialized.
7085 :param clearSigInt: Should SIGINT be cleared? This allows the
7086 app to terminate upon a Ctrl-C in the console like other
7089 :note: You should override OnInit to do applicaition
7090 initialization to ensure that the system, toolkit and
7091 wxWidgets are fully initialized.
7093 wx
.PyApp
.__init
__(self
)
7095 if wx
.Platform
== "__WXMAC__":
7098 if not MacOS
.WMAvailable():
7100 This program needs access to the screen. Please run with 'pythonw',
7101 not 'python', and only when you are logged in on the main display of
7109 # This has to be done before OnInit
7110 self
.SetUseBestVisual(useBestVisual
)
7112 # Set the default handler for SIGINT. This fixes a problem
7113 # where if Ctrl-C is pressed in the console that started this
7114 # app then it will not appear to do anything, (not even send
7115 # KeyboardInterrupt???) but will later segfault on exit. By
7116 # setting the default handler then the app will exit, as
7117 # expected (depending on platform.)
7121 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7125 # Save and redirect the stdio to a window?
7126 self
.stdioWin
= None
7127 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7129 self
.RedirectStdio(filename
)
7131 # Use Python's install prefix as the default
7132 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7134 # This finishes the initialization of wxWindows and then calls
7135 # the OnInit that should be present in the derived class
7136 self
._BootstrapApp
()
7139 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7140 self
.RestoreStdio() # Just in case the MainLoop was overridden
7144 wx
.PyApp
.Destroy(self
)
7147 def SetTopWindow(self
, frame
):
7148 """Set the \"main\" top level window"""
7150 self
.stdioWin
.SetParent(frame
)
7151 wx
.PyApp
.SetTopWindow(self
, frame
)
7155 """Execute the main GUI event loop"""
7156 wx
.PyApp
.MainLoop(self
)
7160 def RedirectStdio(self
, filename
=None):
7161 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7163 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7165 self
.stdioWin
= self
.outputWindowClass()
7166 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7169 def RestoreStdio(self
):
7171 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7176 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7178 Set the title, position and/or size of the output window if
7179 the stdio has been redirected. This should be called before
7180 any output would cause the output window to be created.
7183 if title
is not None:
7184 self
.stdioWin
.title
= title
7186 self
.stdioWin
.pos
= pos
7187 if size
is not None:
7188 self
.stdioWin
.size
= size
7193 # change from wx.PyApp_XX to wx.App_XX
7194 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7195 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7196 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7197 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7198 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7199 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7200 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7201 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7202 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7203 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7204 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7206 #----------------------------------------------------------------------------
7208 class PySimpleApp(wx
.App
):
7210 A simple application class. You can just create one of these and
7211 then then make your top level windows later, and not have to worry
7212 about OnInit. For example::
7214 app = wx.PySimpleApp()
7215 frame = wx.Frame(None, title='Hello World')
7222 def __init__(self
, redirect
=False, filename
=None,
7223 useBestVisual
=False, clearSigInt
=True):
7225 :see: `wx.App.__init__`
7227 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7234 # Is anybody using this one?
7235 class PyWidgetTester(wx
.App
):
7236 def __init__(self
, size
= (250, 100)):
7238 wx
.App
.__init
__(self
, 0)
7241 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7242 self
.SetTopWindow(self
.frame
)
7245 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7246 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7247 self
.frame
.Show(True)
7249 #----------------------------------------------------------------------------
7250 # DO NOT hold any other references to this object. This is how we
7251 # know when to cleanup system resources that wxWidgets is holding. When
7252 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7253 # goes to zero and it calls the wx.App_CleanUp function.
7255 class __wxPyCleanup
:
7257 self
.cleanup
= _core_
.App_CleanUp
7261 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7263 ## # another possible solution, but it gets called too early...
7265 ## atexit.register(_core_.wxApp_CleanUp)
7268 #----------------------------------------------------------------------------
7270 #---------------------------------------------------------------------------
7272 class EventLoop(object):
7273 """Proxy of C++ EventLoop class"""
7274 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7275 __repr__
= _swig_repr
7276 def __init__(self
, *args
, **kwargs
):
7277 """__init__(self) -> EventLoop"""
7278 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7279 __swig_destroy__
= _core_
.delete_EventLoop
7280 __del__
= lambda self
: None;
7281 def Run(*args
, **kwargs
):
7282 """Run(self) -> int"""
7283 return _core_
.EventLoop_Run(*args
, **kwargs
)
7285 def Exit(*args
, **kwargs
):
7286 """Exit(self, int rc=0)"""
7287 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7289 def Pending(*args
, **kwargs
):
7290 """Pending(self) -> bool"""
7291 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7293 def Dispatch(*args
, **kwargs
):
7294 """Dispatch(self) -> bool"""
7295 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7297 def IsRunning(*args
, **kwargs
):
7298 """IsRunning(self) -> bool"""
7299 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7301 def GetActive(*args
, **kwargs
):
7302 """GetActive() -> EventLoop"""
7303 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7305 GetActive
= staticmethod(GetActive
)
7306 def SetActive(*args
, **kwargs
):
7307 """SetActive(EventLoop loop)"""
7308 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7310 SetActive
= staticmethod(SetActive
)
7311 EventLoop_swigregister
= _core_
.EventLoop_swigregister
7312 EventLoop_swigregister(EventLoop
)
7314 def EventLoop_GetActive(*args
):
7315 """EventLoop_GetActive() -> EventLoop"""
7316 return _core_
.EventLoop_GetActive(*args
)
7318 def EventLoop_SetActive(*args
, **kwargs
):
7319 """EventLoop_SetActive(EventLoop loop)"""
7320 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7322 class EventLoopActivator(object):
7323 """Proxy of C++ EventLoopActivator class"""
7324 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7325 __repr__
= _swig_repr
7326 def __init__(self
, *args
, **kwargs
):
7327 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7328 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7329 __swig_destroy__
= _core_
.delete_EventLoopActivator
7330 __del__
= lambda self
: None;
7331 EventLoopActivator_swigregister
= _core_
.EventLoopActivator_swigregister
7332 EventLoopActivator_swigregister(EventLoopActivator
)
7334 #---------------------------------------------------------------------------
7336 class AcceleratorEntry(object):
7338 A class used to define items in an `wx.AcceleratorTable`. wxPython
7339 programs can choose to use wx.AcceleratorEntry objects, but using a
7340 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7341 as well. See `__init__` for of the tuple values.
7343 :see: `wx.AcceleratorTable`
7345 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7346 __repr__
= _swig_repr
7347 def __init__(self
, *args
, **kwargs
):
7349 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7351 Construct a wx.AcceleratorEntry.
7353 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7354 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7355 __del__
= lambda self
: None;
7356 def Set(*args
, **kwargs
):
7358 Set(self, int flags, int keyCode, int cmd)
7360 (Re)set the attributes of a wx.AcceleratorEntry.
7363 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7365 def GetFlags(*args
, **kwargs
):
7367 GetFlags(self) -> int
7369 Get the AcceleratorEntry's flags.
7371 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
7373 def GetKeyCode(*args
, **kwargs
):
7375 GetKeyCode(self) -> int
7377 Get the AcceleratorEntry's keycode.
7379 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
7381 def GetCommand(*args
, **kwargs
):
7383 GetCommand(self) -> int
7385 Get the AcceleratorEntry's command ID.
7387 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
7389 AcceleratorEntry_swigregister
= _core_
.AcceleratorEntry_swigregister
7390 AcceleratorEntry_swigregister(AcceleratorEntry
)
7392 class AcceleratorTable(Object
):
7394 An accelerator table allows the application to specify a table of
7395 keyboard shortcuts for menus or other commands. On Windows, menu or
7396 button commands are supported; on GTK, only menu commands are
7399 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7400 __repr__
= _swig_repr
7401 def __init__(self
, *args
, **kwargs
):
7403 __init__(entries) -> AcceleratorTable
7405 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7406 items or or of 3-tuples (flags, keyCode, cmdID)
7408 :see: `wx.AcceleratorEntry`
7410 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
7411 __swig_destroy__
= _core_
.delete_AcceleratorTable
7412 __del__
= lambda self
: None;
7413 def Ok(*args
, **kwargs
):
7414 """Ok(self) -> bool"""
7415 return _core_
.AcceleratorTable_Ok(*args
, **kwargs
)
7417 AcceleratorTable_swigregister
= _core_
.AcceleratorTable_swigregister
7418 AcceleratorTable_swigregister(AcceleratorTable
)
7421 def GetAccelFromString(*args
, **kwargs
):
7422 """GetAccelFromString(String label) -> AcceleratorEntry"""
7423 return _core_
.GetAccelFromString(*args
, **kwargs
)
7424 #---------------------------------------------------------------------------
7426 class VisualAttributes(object):
7427 """struct containing all the visual attributes of a control"""
7428 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7429 __repr__
= _swig_repr
7430 def __init__(self
, *args
, **kwargs
):
7432 __init__(self) -> VisualAttributes
7434 struct containing all the visual attributes of a control
7436 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
7437 __swig_destroy__
= _core_
.delete_VisualAttributes
7438 __del__
= lambda self
: None;
7439 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
7440 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
7441 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
7442 VisualAttributes_swigregister
= _core_
.VisualAttributes_swigregister
7443 VisualAttributes_swigregister(VisualAttributes
)
7444 NullAcceleratorTable
= cvar
.NullAcceleratorTable
7445 PanelNameStr
= cvar
.PanelNameStr
7447 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
7448 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
7449 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
7450 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
7451 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
7452 class Window(EvtHandler
):
7454 wx.Window is the base class for all windows and represents any visible
7455 object on the screen. All controls, top level windows and so on are
7456 wx.Windows. Sizers and device contexts are not however, as they don't
7457 appear on screen themselves.
7460 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7461 __repr__
= _swig_repr
7462 def __init__(self
, *args
, **kwargs
):
7464 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7465 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7467 Construct and show a generic Window.
7469 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
7470 self
._setOORInfo
(self
)
7472 def Create(*args
, **kwargs
):
7474 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7475 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7477 Create the GUI part of the Window for 2-phase creation mode.
7479 return _core_
.Window_Create(*args
, **kwargs
)
7481 def Close(*args
, **kwargs
):
7483 Close(self, bool force=False) -> bool
7485 This function simply generates a EVT_CLOSE event whose handler usually
7486 tries to close the window. It doesn't close the window itself,
7487 however. If force is False (the default) then the window's close
7488 handler will be allowed to veto the destruction of the window.
7490 return _core_
.Window_Close(*args
, **kwargs
)
7492 def Destroy(*args
, **kwargs
):
7494 Destroy(self) -> bool
7496 Destroys the window safely. Frames and dialogs are not destroyed
7497 immediately when this function is called -- they are added to a list
7498 of windows to be deleted on idle time, when all the window's events
7499 have been processed. This prevents problems with events being sent to
7500 non-existent windows.
7502 Returns True if the window has either been successfully deleted, or it
7503 has been added to the list of windows pending real deletion.
7505 val
= _core_
.Window_Destroy(*args
, **kwargs
)
7509 def DestroyChildren(*args
, **kwargs
):
7511 DestroyChildren(self) -> bool
7513 Destroys all children of a window. Called automatically by the
7516 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
7518 def IsBeingDeleted(*args
, **kwargs
):
7520 IsBeingDeleted(self) -> bool
7522 Is the window in the process of being deleted?
7524 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
7526 def SetLabel(*args
, **kwargs
):
7528 SetLabel(self, String label)
7530 Set the text which the window shows in its label if applicable.
7532 return _core_
.Window_SetLabel(*args
, **kwargs
)
7534 def GetLabel(*args
, **kwargs
):
7536 GetLabel(self) -> String
7538 Generic way of getting a label from any window, for identification
7539 purposes. The interpretation of this function differs from class to
7540 class. For frames and dialogs, the value returned is the title. For
7541 buttons or static text controls, it is the button text. This function
7542 can be useful for meta-programs such as testing tools or special-needs
7543 access programs)which need to identify windows by name.
7545 return _core_
.Window_GetLabel(*args
, **kwargs
)
7547 def SetName(*args
, **kwargs
):
7549 SetName(self, String name)
7551 Sets the window's name. The window name is used for ressource setting
7552 in X, it is not the same as the window title/label
7554 return _core_
.Window_SetName(*args
, **kwargs
)
7556 def GetName(*args
, **kwargs
):
7558 GetName(self) -> String
7560 Returns the windows name. This name is not guaranteed to be unique;
7561 it is up to the programmer to supply an appropriate name in the window
7562 constructor or via wx.Window.SetName.
7564 return _core_
.Window_GetName(*args
, **kwargs
)
7566 def SetWindowVariant(*args
, **kwargs
):
7568 SetWindowVariant(self, int variant)
7570 Sets the variant of the window/font size to use for this window, if
7571 the platform supports variants, for example, wxMac.
7573 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
7575 def GetWindowVariant(*args
, **kwargs
):
7576 """GetWindowVariant(self) -> int"""
7577 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
7579 def SetId(*args
, **kwargs
):
7581 SetId(self, int winid)
7583 Sets the identifier of the window. Each window has an integer
7584 identifier. If the application has not provided one, an identifier
7585 will be generated. Normally, the identifier should be provided on
7586 creation and should not be modified subsequently.
7588 return _core_
.Window_SetId(*args
, **kwargs
)
7590 def GetId(*args
, **kwargs
):
7594 Returns the identifier of the window. Each window has an integer
7595 identifier. If the application has not provided one (or the default Id
7596 -1 is used) then an unique identifier with a negative value will be
7599 return _core_
.Window_GetId(*args
, **kwargs
)
7601 def NewControlId(*args
, **kwargs
):
7603 NewControlId() -> int
7605 Generate a control id for the controls which were not given one.
7607 return _core_
.Window_NewControlId(*args
, **kwargs
)
7609 NewControlId
= staticmethod(NewControlId
)
7610 def NextControlId(*args
, **kwargs
):
7612 NextControlId(int winid) -> int
7614 Get the id of the control following the one with the given
7617 return _core_
.Window_NextControlId(*args
, **kwargs
)
7619 NextControlId
= staticmethod(NextControlId
)
7620 def PrevControlId(*args
, **kwargs
):
7622 PrevControlId(int winid) -> int
7624 Get the id of the control preceding the one with the given
7627 return _core_
.Window_PrevControlId(*args
, **kwargs
)
7629 PrevControlId
= staticmethod(PrevControlId
)
7630 def SetSize(*args
, **kwargs
):
7632 SetSize(self, Size size)
7634 Sets the size of the window in pixels.
7636 return _core_
.Window_SetSize(*args
, **kwargs
)
7638 def SetDimensions(*args
, **kwargs
):
7640 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7642 Sets the position and size of the window in pixels. The sizeFlags
7643 parameter indicates the interpretation of the other params if they are
7646 ======================== ======================================
7647 wx.SIZE_AUTO A -1 indicates that a class-specific
7648 default should be used.
7649 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
7650 -1 values are supplied.
7651 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
7652 interpreted as real dimensions, not
7654 ======================== ======================================
7657 return _core_
.Window_SetDimensions(*args
, **kwargs
)
7659 def SetRect(*args
, **kwargs
):
7661 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
7663 Sets the position and size of the window in pixels using a wx.Rect.
7665 return _core_
.Window_SetRect(*args
, **kwargs
)
7667 def SetSizeWH(*args
, **kwargs
):
7669 SetSizeWH(self, int width, int height)
7671 Sets the size of the window in pixels.
7673 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
7675 def Move(*args
, **kwargs
):
7677 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
7679 Moves the window to the given position.
7681 return _core_
.Window_Move(*args
, **kwargs
)
7684 def MoveXY(*args
, **kwargs
):
7686 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
7688 Moves the window to the given position.
7690 return _core_
.Window_MoveXY(*args
, **kwargs
)
7692 def SetBestFittingSize(*args
, **kwargs
):
7694 SetBestFittingSize(self, Size size=DefaultSize)
7696 A 'Smart' SetSize that will fill in default size components with the
7697 window's *best size* values. Also set's the minsize for use with sizers.
7699 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
7701 def Raise(*args
, **kwargs
):
7705 Raises the window to the top of the window hierarchy. In current
7706 version of wxWidgets this works both for manage and child windows.
7708 return _core_
.Window_Raise(*args
, **kwargs
)
7710 def Lower(*args
, **kwargs
):
7714 Lowers the window to the bottom of the window hierarchy. In current
7715 version of wxWidgets this works both for manage and child windows.
7717 return _core_
.Window_Lower(*args
, **kwargs
)
7719 def SetClientSize(*args
, **kwargs
):
7721 SetClientSize(self, Size size)
7723 This sets the size of the window client area in pixels. Using this
7724 function to size a window tends to be more device-independent than
7725 wx.Window.SetSize, since the application need not worry about what
7726 dimensions the border or title bar have when trying to fit the window
7727 around panel items, for example.
7729 return _core_
.Window_SetClientSize(*args
, **kwargs
)
7731 def SetClientSizeWH(*args
, **kwargs
):
7733 SetClientSizeWH(self, int width, int height)
7735 This sets the size of the window client area in pixels. Using this
7736 function to size a window tends to be more device-independent than
7737 wx.Window.SetSize, since the application need not worry about what
7738 dimensions the border or title bar have when trying to fit the window
7739 around panel items, for example.
7741 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
7743 def SetClientRect(*args
, **kwargs
):
7745 SetClientRect(self, Rect rect)
7747 This sets the size of the window client area in pixels. Using this
7748 function to size a window tends to be more device-independent than
7749 wx.Window.SetSize, since the application need not worry about what
7750 dimensions the border or title bar have when trying to fit the window
7751 around panel items, for example.
7753 return _core_
.Window_SetClientRect(*args
, **kwargs
)
7755 def GetPosition(*args
, **kwargs
):
7757 GetPosition(self) -> Point
7759 Get the window's position. Notice that the position is in client
7760 coordinates for child windows and screen coordinates for the top level
7761 ones, use `GetScreenPosition` if you need screen coordinates for all
7764 return _core_
.Window_GetPosition(*args
, **kwargs
)
7766 def GetPositionTuple(*args
, **kwargs
):
7768 GetPositionTuple() -> (x,y)
7770 Get the window's position. Notice that the position is in client
7771 coordinates for child windows and screen coordinates for the top level
7772 ones, use `GetScreenPosition` if you need screen coordinates for all
7775 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
7777 def GetScreenPosition(*args
, **kwargs
):
7779 GetScreenPosition(self) -> Point
7781 Get the position of the window in screen coordinantes.
7783 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
7785 def GetScreenPositionTuple(*args
, **kwargs
):
7787 GetScreenPositionTuple() -> (x,y)
7789 Get the position of the window in screen coordinantes.
7791 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
7793 def GetScreenRect(*args
, **kwargs
):
7795 GetScreenRect(self) -> Rect
7797 Returns the size and position of the window in screen coordinantes as
7800 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
7802 def GetSize(*args
, **kwargs
):
7804 GetSize(self) -> Size
7806 Get the window size.
7808 return _core_
.Window_GetSize(*args
, **kwargs
)
7810 def GetSizeTuple(*args
, **kwargs
):
7812 GetSizeTuple() -> (width, height)
7814 Get the window size.
7816 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
7818 def GetRect(*args
, **kwargs
):
7820 GetRect(self) -> Rect
7822 Returns the size and position of the window as a `wx.Rect` object.
7824 return _core_
.Window_GetRect(*args
, **kwargs
)
7826 def GetClientSize(*args
, **kwargs
):
7828 GetClientSize(self) -> Size
7830 This gets the size of the window's 'client area' in pixels. The client
7831 area is the area which may be drawn on by the programmer, excluding
7832 title bar, border, scrollbars, etc.
7834 return _core_
.Window_GetClientSize(*args
, **kwargs
)
7836 def GetClientSizeTuple(*args
, **kwargs
):
7838 GetClientSizeTuple() -> (width, height)
7840 This gets the size of the window's 'client area' in pixels. The client
7841 area is the area which may be drawn on by the programmer, excluding
7842 title bar, border, scrollbars, etc.
7844 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
7846 def GetClientAreaOrigin(*args
, **kwargs
):
7848 GetClientAreaOrigin(self) -> Point
7850 Get the origin of the client area of the window relative to the
7851 window's top left corner (the client area may be shifted because of
7852 the borders, scrollbars, other decorations...)
7854 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
7856 def GetClientRect(*args
, **kwargs
):
7858 GetClientRect(self) -> Rect
7860 Get the client area position and size as a `wx.Rect` object.
7862 return _core_
.Window_GetClientRect(*args
, **kwargs
)
7864 def GetBestSize(*args
, **kwargs
):
7866 GetBestSize(self) -> Size
7868 This function returns the best acceptable minimal size for the
7869 window, if applicable. For example, for a static text control, it will
7870 be the minimal size such that the control label is not truncated. For
7871 windows containing subwindows (suzh aswx.Panel), the size returned by
7872 this function will be the same as the size the window would have had
7875 return _core_
.Window_GetBestSize(*args
, **kwargs
)
7877 def GetBestSizeTuple(*args
, **kwargs
):
7879 GetBestSizeTuple() -> (width, height)
7881 This function returns the best acceptable minimal size for the
7882 window, if applicable. For example, for a static text control, it will
7883 be the minimal size such that the control label is not truncated. For
7884 windows containing subwindows (suzh aswx.Panel), the size returned by
7885 this function will be the same as the size the window would have had
7888 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
7890 def InvalidateBestSize(*args
, **kwargs
):
7892 InvalidateBestSize(self)
7894 Reset the cached best size value so it will be recalculated the next
7897 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
7899 def CacheBestSize(*args
, **kwargs
):
7901 CacheBestSize(self, Size size)
7903 Cache the best size so it doesn't need to be calculated again, (at least until
7904 some properties of the window change.)
7906 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
7908 def GetBestFittingSize(*args
, **kwargs
):
7910 GetBestFittingSize(self) -> Size
7912 This function will merge the window's best size into the window's
7913 minimum size, giving priority to the min size components, and returns
7917 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
7919 def GetAdjustedBestSize(*args
, **kwargs
):
7921 GetAdjustedBestSize(self) -> Size
7923 This method is similar to GetBestSize, except in one
7924 thing. GetBestSize should return the minimum untruncated size of the
7925 window, while this method will return the largest of BestSize and any
7926 user specified minimum size. ie. it is the minimum size the window
7927 should currently be drawn at, not the minimal size it can possibly
7930 return _core_
.Window_GetAdjustedBestSize(*args
, **kwargs
)
7932 def Center(*args
, **kwargs
):
7934 Center(self, int direction=BOTH)
7936 Centers the window. The parameter specifies the direction for
7937 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
7938 also include wx.CENTER_ON_SCREEN flag if you want to center the window
7939 on the entire screen and not on its parent window. If it is a
7940 top-level window and has no parent then it will always be centered
7941 relative to the screen.
7943 return _core_
.Window_Center(*args
, **kwargs
)
7946 def CenterOnParent(*args
, **kwargs
):
7948 CenterOnParent(self, int dir=BOTH)
7950 Center with respect to the the parent window
7952 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
7954 CentreOnParent
= CenterOnParent
7955 def Fit(*args
, **kwargs
):
7959 Sizes the window so that it fits around its subwindows. This function
7960 won't do anything if there are no subwindows and will only really work
7961 correctly if sizers are used for the subwindows layout. Also, if the
7962 window has exactly one subwindow it is better (faster and the result
7963 is more precise as Fit adds some margin to account for fuzziness of
7964 its calculations) to call window.SetClientSize(child.GetSize())
7965 instead of calling Fit.
7967 return _core_
.Window_Fit(*args
, **kwargs
)
7969 def FitInside(*args
, **kwargs
):
7973 Similar to Fit, but sizes the interior (virtual) size of a
7974 window. Mainly useful with scrolled windows to reset scrollbars after
7975 sizing changes that do not trigger a size event, and/or scrolled
7976 windows without an interior sizer. This function similarly won't do
7977 anything if there are no subwindows.
7979 return _core_
.Window_FitInside(*args
, **kwargs
)
7981 def SetSizeHints(*args
, **kwargs
):
7983 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
7986 Allows specification of minimum and maximum window sizes, and window
7987 size increments. If a pair of values is not set (or set to -1), the
7988 default values will be used. If this function is called, the user
7989 will not be able to size the window outside the given bounds (if it is
7990 a top-level window.) Sizers will also inspect the minimum window size
7991 and will use that value if set when calculating layout.
7993 The resizing increments are only significant under Motif or Xt.
7995 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
7997 def SetSizeHintsSz(*args
, **kwargs
):
7999 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8001 Allows specification of minimum and maximum window sizes, and window
8002 size increments. If a pair of values is not set (or set to -1), the
8003 default values will be used. If this function is called, the user
8004 will not be able to size the window outside the given bounds (if it is
8005 a top-level window.) Sizers will also inspect the minimum window size
8006 and will use that value if set when calculating layout.
8008 The resizing increments are only significant under Motif or Xt.
8010 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8012 def SetVirtualSizeHints(*args
, **kwargs
):
8014 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8016 Allows specification of minimum and maximum virtual window sizes. If a
8017 pair of values is not set (or set to -1), the default values will be
8018 used. If this function is called, the user will not be able to size
8019 the virtual area of the window outside the given bounds.
8021 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8023 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8025 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8027 Allows specification of minimum and maximum virtual window sizes. If a
8028 pair of values is not set (or set to -1), the default values will be
8029 used. If this function is called, the user will not be able to size
8030 the virtual area of the window outside the given bounds.
8032 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8034 def GetMaxSize(*args
, **kwargs
):
8035 """GetMaxSize(self) -> Size"""
8036 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8038 def GetMinSize(*args
, **kwargs
):
8039 """GetMinSize(self) -> Size"""
8040 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8042 def SetMinSize(*args
, **kwargs
):
8044 SetMinSize(self, Size minSize)
8046 A more convenient method than `SetSizeHints` for setting just the
8049 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8051 def SetMaxSize(*args
, **kwargs
):
8053 SetMaxSize(self, Size maxSize)
8055 A more convenient method than `SetSizeHints` for setting just the
8058 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8060 def GetMinWidth(*args
, **kwargs
):
8061 """GetMinWidth(self) -> int"""
8062 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8064 def GetMinHeight(*args
, **kwargs
):
8065 """GetMinHeight(self) -> int"""
8066 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8068 def GetMaxWidth(*args
, **kwargs
):
8069 """GetMaxWidth(self) -> int"""
8070 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8072 def GetMaxHeight(*args
, **kwargs
):
8073 """GetMaxHeight(self) -> int"""
8074 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8076 def SetVirtualSize(*args
, **kwargs
):
8078 SetVirtualSize(self, Size size)
8080 Set the the virtual size of a window in pixels. For most windows this
8081 is just the client area of the window, but for some like scrolled
8082 windows it is more or less independent of the screen window size.
8084 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8086 def SetVirtualSizeWH(*args
, **kwargs
):
8088 SetVirtualSizeWH(self, int w, int h)
8090 Set the the virtual size of a window in pixels. For most windows this
8091 is just the client area of the window, but for some like scrolled
8092 windows it is more or less independent of the screen window size.
8094 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8096 def GetVirtualSize(*args
, **kwargs
):
8098 GetVirtualSize(self) -> Size
8100 Get the the virtual size of the window in pixels. For most windows
8101 this is just the client area of the window, but for some like scrolled
8102 windows it is more or less independent of the screen window size.
8104 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8106 def GetVirtualSizeTuple(*args
, **kwargs
):
8108 GetVirtualSizeTuple() -> (width, height)
8110 Get the the virtual size of the window in pixels. For most windows
8111 this is just the client area of the window, but for some like scrolled
8112 windows it is more or less independent of the screen window size.
8114 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8116 def GetBestVirtualSize(*args
, **kwargs
):
8118 GetBestVirtualSize(self) -> Size
8120 Return the largest of ClientSize and BestSize (as determined by a
8121 sizer, interior children, or other means)
8123 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8125 def Show(*args
, **kwargs
):
8127 Show(self, bool show=True) -> bool
8129 Shows or hides the window. You may need to call Raise for a top level
8130 window if you want to bring it to top, although this is not needed if
8131 Show is called immediately after the frame creation. Returns True if
8132 the window has been shown or hidden or False if nothing was done
8133 because it already was in the requested state.
8135 return _core_
.Window_Show(*args
, **kwargs
)
8137 def Hide(*args
, **kwargs
):
8141 Equivalent to calling Show(False).
8143 return _core_
.Window_Hide(*args
, **kwargs
)
8145 def Enable(*args
, **kwargs
):
8147 Enable(self, bool enable=True) -> bool
8149 Enable or disable the window for user input. Note that when a parent
8150 window is disabled, all of its children are disabled as well and they
8151 are reenabled again when the parent is. Returns true if the window
8152 has been enabled or disabled, false if nothing was done, i.e. if the
8153 window had already been in the specified state.
8155 return _core_
.Window_Enable(*args
, **kwargs
)
8157 def Disable(*args
, **kwargs
):
8159 Disable(self) -> bool
8161 Disables the window, same as Enable(false).
8163 return _core_
.Window_Disable(*args
, **kwargs
)
8165 def IsShown(*args
, **kwargs
):
8167 IsShown(self) -> bool
8169 Returns true if the window is shown, false if it has been hidden.
8171 return _core_
.Window_IsShown(*args
, **kwargs
)
8173 def IsEnabled(*args
, **kwargs
):
8175 IsEnabled(self) -> bool
8177 Returns true if the window is enabled for input, false otherwise.
8179 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8181 def SetWindowStyleFlag(*args
, **kwargs
):
8183 SetWindowStyleFlag(self, long style)
8185 Sets the style of the window. Please note that some styles cannot be
8186 changed after the window creation and that Refresh() might need to be
8187 called after changing the others for the change to take place
8190 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8192 def GetWindowStyleFlag(*args
, **kwargs
):
8194 GetWindowStyleFlag(self) -> long
8196 Gets the window style that was passed to the constructor or Create
8199 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8201 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8202 def HasFlag(*args
, **kwargs
):
8204 HasFlag(self, int flag) -> bool
8206 Test if the given style is set for this window.
8208 return _core_
.Window_HasFlag(*args
, **kwargs
)
8210 def IsRetained(*args
, **kwargs
):
8212 IsRetained(self) -> bool
8214 Returns true if the window is retained, false otherwise. Retained
8215 windows are only available on X platforms.
8217 return _core_
.Window_IsRetained(*args
, **kwargs
)
8219 def SetExtraStyle(*args
, **kwargs
):
8221 SetExtraStyle(self, long exStyle)
8223 Sets the extra style bits for the window. Extra styles are the less
8224 often used style bits which can't be set with the constructor or with
8225 SetWindowStyleFlag()
8227 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8229 def GetExtraStyle(*args
, **kwargs
):
8231 GetExtraStyle(self) -> long
8233 Returns the extra style bits for the window.
8235 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8237 def MakeModal(*args
, **kwargs
):
8239 MakeModal(self, bool modal=True)
8241 Disables all other windows in the application so that the user can
8242 only interact with this window. Passing False will reverse this
8245 return _core_
.Window_MakeModal(*args
, **kwargs
)
8247 def SetThemeEnabled(*args
, **kwargs
):
8249 SetThemeEnabled(self, bool enableTheme)
8251 This function tells a window if it should use the system's "theme"
8252 code to draw the windows' background instead if its own background
8253 drawing code. This will only have an effect on platforms that support
8254 the notion of themes in user defined windows. One such platform is
8255 GTK+ where windows can have (very colourful) backgrounds defined by a
8256 user's selected theme.
8258 Dialogs, notebook pages and the status bar have this flag set to true
8259 by default so that the default look and feel is simulated best.
8261 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8263 def GetThemeEnabled(*args
, **kwargs
):
8265 GetThemeEnabled(self) -> bool
8267 Return the themeEnabled flag.
8269 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8271 def SetFocus(*args
, **kwargs
):
8275 Set's the focus to this window, allowing it to receive keyboard input.
8277 return _core_
.Window_SetFocus(*args
, **kwargs
)
8279 def SetFocusFromKbd(*args
, **kwargs
):
8281 SetFocusFromKbd(self)
8283 Set focus to this window as the result of a keyboard action. Normally
8284 only called internally.
8286 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8288 def FindFocus(*args
, **kwargs
):
8290 FindFocus() -> Window
8292 Returns the window or control that currently has the keyboard focus,
8295 return _core_
.Window_FindFocus(*args
, **kwargs
)
8297 FindFocus
= staticmethod(FindFocus
)
8298 def AcceptsFocus(*args
, **kwargs
):
8300 AcceptsFocus(self) -> bool
8302 Can this window have focus?
8304 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8306 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
8308 AcceptsFocusFromKeyboard(self) -> bool
8310 Can this window be given focus by keyboard navigation? if not, the
8311 only way to give it focus (provided it accepts it at all) is to click
8314 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
8316 def GetDefaultItem(*args
, **kwargs
):
8318 GetDefaultItem(self) -> Window
8320 Get the default child of this parent, i.e. the one which is activated
8321 by pressing <Enter> such as the OK button on a wx.Dialog.
8323 return _core_
.Window_GetDefaultItem(*args
, **kwargs
)
8325 def SetDefaultItem(*args
, **kwargs
):
8327 SetDefaultItem(self, Window child) -> Window
8329 Set this child as default, return the old default.
8331 return _core_
.Window_SetDefaultItem(*args
, **kwargs
)
8333 def SetTmpDefaultItem(*args
, **kwargs
):
8335 SetTmpDefaultItem(self, Window win)
8337 Set this child as temporary default
8339 return _core_
.Window_SetTmpDefaultItem(*args
, **kwargs
)
8341 def Navigate(*args
, **kwargs
):
8343 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8345 Does keyboard navigation from this window to another, by sending a
8346 `wx.NavigationKeyEvent`.
8348 return _core_
.Window_Navigate(*args
, **kwargs
)
8350 def MoveAfterInTabOrder(*args
, **kwargs
):
8352 MoveAfterInTabOrder(self, Window win)
8354 Moves this window in the tab navigation order after the specified
8355 sibling window. This means that when the user presses the TAB key on
8356 that other window, the focus switches to this window.
8358 The default tab order is the same as creation order. This function
8359 and `MoveBeforeInTabOrder` allow to change it after creating all the
8363 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
8365 def MoveBeforeInTabOrder(*args
, **kwargs
):
8367 MoveBeforeInTabOrder(self, Window win)
8369 Same as `MoveAfterInTabOrder` except that it inserts this window just
8370 before win instead of putting it right after it.
8372 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
8374 def GetChildren(*args
, **kwargs
):
8376 GetChildren(self) -> PyObject
8378 Returns a list of the window's children. NOTE: Currently this is a
8379 copy of the child window list maintained by the window, so the return
8380 value of this function is only valid as long as the window's children
8383 return _core_
.Window_GetChildren(*args
, **kwargs
)
8385 def GetParent(*args
, **kwargs
):
8387 GetParent(self) -> Window
8389 Returns the parent window of this window, or None if there isn't one.
8391 return _core_
.Window_GetParent(*args
, **kwargs
)
8393 def GetGrandParent(*args
, **kwargs
):
8395 GetGrandParent(self) -> Window
8397 Returns the parent of the parent of this window, or None if there
8400 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
8402 def IsTopLevel(*args
, **kwargs
):
8404 IsTopLevel(self) -> bool
8406 Returns true if the given window is a top-level one. Currently all
8407 frames and dialogs are always considered to be top-level windows (even
8408 if they have a parent window).
8410 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
8412 def Reparent(*args
, **kwargs
):
8414 Reparent(self, Window newParent) -> bool
8416 Reparents the window, i.e the window will be removed from its current
8417 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8418 re-inserted into another. Available on Windows and GTK. Returns True
8419 if the parent was changed, False otherwise (error or newParent ==
8422 return _core_
.Window_Reparent(*args
, **kwargs
)
8424 def AddChild(*args
, **kwargs
):
8426 AddChild(self, Window child)
8428 Adds a child window. This is called automatically by window creation
8429 functions so should not be required by the application programmer.
8431 return _core_
.Window_AddChild(*args
, **kwargs
)
8433 def RemoveChild(*args
, **kwargs
):
8435 RemoveChild(self, Window child)
8437 Removes a child window. This is called automatically by window
8438 deletion functions so should not be required by the application
8441 return _core_
.Window_RemoveChild(*args
, **kwargs
)
8443 def FindWindowById(*args
, **kwargs
):
8445 FindWindowById(self, long winid) -> Window
8447 Find a chld of this window by window ID
8449 return _core_
.Window_FindWindowById(*args
, **kwargs
)
8451 def FindWindowByName(*args
, **kwargs
):
8453 FindWindowByName(self, String name) -> Window
8455 Find a child of this window by name
8457 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
8459 def GetEventHandler(*args
, **kwargs
):
8461 GetEventHandler(self) -> EvtHandler
8463 Returns the event handler for this window. By default, the window is
8464 its own event handler.
8466 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
8468 def SetEventHandler(*args
, **kwargs
):
8470 SetEventHandler(self, EvtHandler handler)
8472 Sets the event handler for this window. An event handler is an object
8473 that is capable of processing the events sent to a window. By default,
8474 the window is its own event handler, but an application may wish to
8475 substitute another, for example to allow central implementation of
8476 event-handling for a variety of different window classes.
8478 It is usually better to use `wx.Window.PushEventHandler` since this sets
8479 up a chain of event handlers, where an event not handled by one event
8480 handler is handed to the next one in the chain.
8482 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
8484 def PushEventHandler(*args
, **kwargs
):
8486 PushEventHandler(self, EvtHandler handler)
8488 Pushes this event handler onto the event handler stack for the window.
8489 An event handler is an object that is capable of processing the events
8490 sent to a window. By default, the window is its own event handler, but
8491 an application may wish to substitute another, for example to allow
8492 central implementation of event-handling for a variety of different
8495 wx.Window.PushEventHandler allows an application to set up a chain of
8496 event handlers, where an event not handled by one event handler is
8497 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
8498 remove the event handler.
8500 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
8502 def PopEventHandler(*args
, **kwargs
):
8504 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8506 Removes and returns the top-most event handler on the event handler
8507 stack. If deleteHandler is True then the wx.EvtHandler object will be
8508 destroyed after it is popped.
8510 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
8512 def RemoveEventHandler(*args
, **kwargs
):
8514 RemoveEventHandler(self, EvtHandler handler) -> bool
8516 Find the given handler in the event handler chain and remove (but not
8517 delete) it from the event handler chain, return True if it was found
8518 and False otherwise (this also results in an assert failure so this
8519 function should only be called when the handler is supposed to be
8522 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
8524 def SetValidator(*args
, **kwargs
):
8526 SetValidator(self, Validator validator)
8528 Deletes the current validator (if any) and sets the window validator,
8529 having called wx.Validator.Clone to create a new validator of this
8532 return _core_
.Window_SetValidator(*args
, **kwargs
)
8534 def GetValidator(*args
, **kwargs
):
8536 GetValidator(self) -> Validator
8538 Returns a pointer to the current validator for the window, or None if
8541 return _core_
.Window_GetValidator(*args
, **kwargs
)
8543 def Validate(*args
, **kwargs
):
8545 Validate(self) -> bool
8547 Validates the current values of the child controls using their
8548 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8549 style flag set, the method will also call Validate() of all child
8550 windows. Returns false if any of the validations failed.
8552 return _core_
.Window_Validate(*args
, **kwargs
)
8554 def TransferDataToWindow(*args
, **kwargs
):
8556 TransferDataToWindow(self) -> bool
8558 Transfers values to child controls from data areas specified by their
8559 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8560 style flag set, the method will also call TransferDataToWindow() of
8563 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
8565 def TransferDataFromWindow(*args
, **kwargs
):
8567 TransferDataFromWindow(self) -> bool
8569 Transfers values from child controls to data areas specified by their
8570 validators. Returns false if a transfer failed. If the window has
8571 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8572 also call TransferDataFromWindow() of all child windows.
8574 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
8576 def InitDialog(*args
, **kwargs
):
8580 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8581 to the dialog via validators.
8583 return _core_
.Window_InitDialog(*args
, **kwargs
)
8585 def SetAcceleratorTable(*args
, **kwargs
):
8587 SetAcceleratorTable(self, AcceleratorTable accel)
8589 Sets the accelerator table for this window.
8591 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
8593 def GetAcceleratorTable(*args
, **kwargs
):
8595 GetAcceleratorTable(self) -> AcceleratorTable
8597 Gets the accelerator table for this window.
8599 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
8601 def RegisterHotKey(*args
, **kwargs
):
8603 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8605 Registers a system wide hotkey. Every time the user presses the hotkey
8606 registered here, this window will receive a hotkey event. It will
8607 receive the event even if the application is in the background and
8608 does not have the input focus because the user is working with some
8609 other application. To bind an event handler function to this hotkey
8610 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
8611 hotkey was registered successfully.
8613 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
8615 def UnregisterHotKey(*args
, **kwargs
):
8617 UnregisterHotKey(self, int hotkeyId) -> bool
8619 Unregisters a system wide hotkey.
8621 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
8623 def ConvertDialogPointToPixels(*args
, **kwargs
):
8625 ConvertDialogPointToPixels(self, Point pt) -> Point
8627 Converts a point or size from dialog units to pixels. Dialog units
8628 are used for maintaining a dialog's proportions even if the font
8629 changes. For the x dimension, the dialog units are multiplied by the
8630 average character width and then divided by 4. For the y dimension,
8631 the dialog units are multiplied by the average character height and
8634 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
8636 def ConvertDialogSizeToPixels(*args
, **kwargs
):
8638 ConvertDialogSizeToPixels(self, Size sz) -> Size
8640 Converts a point or size from dialog units to pixels. Dialog units
8641 are used for maintaining a dialog's proportions even if the font
8642 changes. For the x dimension, the dialog units are multiplied by the
8643 average character width and then divided by 4. For the y dimension,
8644 the dialog units are multiplied by the average character height and
8647 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
8649 def DLG_PNT(*args
, **kwargs
):
8651 DLG_PNT(self, Point pt) -> Point
8653 Converts a point or size from dialog units to pixels. Dialog units
8654 are used for maintaining a dialog's proportions even if the font
8655 changes. For the x dimension, the dialog units are multiplied by the
8656 average character width and then divided by 4. For the y dimension,
8657 the dialog units are multiplied by the average character height and
8660 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
8662 def DLG_SZE(*args
, **kwargs
):
8664 DLG_SZE(self, Size sz) -> Size
8666 Converts a point or size from dialog units to pixels. Dialog units
8667 are used for maintaining a dialog's proportions even if the font
8668 changes. For the x dimension, the dialog units are multiplied by the
8669 average character width and then divided by 4. For the y dimension,
8670 the dialog units are multiplied by the average character height and
8673 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
8675 def ConvertPixelPointToDialog(*args
, **kwargs
):
8676 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
8677 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
8679 def ConvertPixelSizeToDialog(*args
, **kwargs
):
8680 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
8681 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
8683 def WarpPointer(*args
, **kwargs
):
8685 WarpPointer(self, int x, int y)
8687 Moves the pointer to the given position on the window.
8689 NOTE: This function is not supported under Mac because Apple Human
8690 Interface Guidelines forbid moving the mouse cursor programmatically.
8692 return _core_
.Window_WarpPointer(*args
, **kwargs
)
8694 def CaptureMouse(*args
, **kwargs
):
8698 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
8699 release the capture.
8701 Note that wxWindows maintains the stack of windows having captured the
8702 mouse and when the mouse is released the capture returns to the window
8703 which had had captured it previously and it is only really released if
8704 there were no previous window. In particular, this means that you must
8705 release the mouse as many times as you capture it.
8707 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
8709 def ReleaseMouse(*args
, **kwargs
):
8713 Releases mouse input captured with wx.Window.CaptureMouse.
8715 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
8717 def GetCapture(*args
, **kwargs
):
8719 GetCapture() -> Window
8721 Returns the window which currently captures the mouse or None
8723 return _core_
.Window_GetCapture(*args
, **kwargs
)
8725 GetCapture
= staticmethod(GetCapture
)
8726 def HasCapture(*args
, **kwargs
):
8728 HasCapture(self) -> bool
8730 Returns true if this window has the current mouse capture.
8732 return _core_
.Window_HasCapture(*args
, **kwargs
)
8734 def Refresh(*args
, **kwargs
):
8736 Refresh(self, bool eraseBackground=True, Rect rect=None)
8738 Mark the specified rectangle (or the whole window) as "dirty" so it
8739 will be repainted. Causes an EVT_PAINT event to be generated and sent
8742 return _core_
.Window_Refresh(*args
, **kwargs
)
8744 def RefreshRect(*args
, **kwargs
):
8746 RefreshRect(self, Rect rect, bool eraseBackground=True)
8748 Redraws the contents of the given rectangle: the area inside it will
8749 be repainted. This is the same as Refresh but has a nicer syntax.
8751 return _core_
.Window_RefreshRect(*args
, **kwargs
)
8753 def Update(*args
, **kwargs
):
8757 Calling this method immediately repaints the invalidated area of the
8758 window instead of waiting for the EVT_PAINT event to happen, (normally
8759 this would usually only happen when the flow of control returns to the
8760 event loop.) Notice that this function doesn't refresh the window and
8761 does nothing if the window has been already repainted. Use Refresh
8762 first if you want to immediately redraw the window (or some portion of
8763 it) unconditionally.
8765 return _core_
.Window_Update(*args
, **kwargs
)
8767 def ClearBackground(*args
, **kwargs
):
8769 ClearBackground(self)
8771 Clears the window by filling it with the current background
8772 colour. Does not cause an erase background event to be generated.
8774 return _core_
.Window_ClearBackground(*args
, **kwargs
)
8776 def Freeze(*args
, **kwargs
):
8780 Freezes the window or, in other words, prevents any updates from
8781 taking place on screen, the window is not redrawn at all. Thaw must be
8782 called to reenable window redrawing. Calls to Freeze/Thaw may be
8783 nested, with the actual Thaw being delayed until all the nesting has
8786 This method is useful for visual appearance optimization (for example,
8787 it is a good idea to use it before inserting large amount of text into
8788 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
8789 for all controls so it is mostly just a hint to wxWindows and not a
8790 mandatory directive.
8792 return _core_
.Window_Freeze(*args
, **kwargs
)
8794 def Thaw(*args
, **kwargs
):
8798 Reenables window updating after a previous call to Freeze. Calls to
8799 Freeze/Thaw may be nested, so Thaw must be called the same number of
8800 times that Freeze was before the window will be updated.
8802 return _core_
.Window_Thaw(*args
, **kwargs
)
8804 def PrepareDC(*args
, **kwargs
):
8806 PrepareDC(self, DC dc)
8808 Call this function to prepare the device context for drawing a
8809 scrolled image. It sets the device origin according to the current
8812 return _core_
.Window_PrepareDC(*args
, **kwargs
)
8814 def GetUpdateRegion(*args
, **kwargs
):
8816 GetUpdateRegion(self) -> Region
8818 Returns the region specifying which parts of the window have been
8819 damaged. Should only be called within an EVT_PAINT handler.
8821 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
8823 def GetUpdateClientRect(*args
, **kwargs
):
8825 GetUpdateClientRect(self) -> Rect
8827 Get the update rectangle region bounding box in client coords.
8829 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
8831 def IsExposed(*args
, **kwargs
):
8833 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
8835 Returns true if the given point or rectangle area has been exposed
8836 since the last repaint. Call this in an paint event handler to
8837 optimize redrawing by only redrawing those areas, which have been
8840 return _core_
.Window_IsExposed(*args
, **kwargs
)
8842 def IsExposedPoint(*args
, **kwargs
):
8844 IsExposedPoint(self, Point pt) -> bool
8846 Returns true if the given point or rectangle area has been exposed
8847 since the last repaint. Call this in an paint event handler to
8848 optimize redrawing by only redrawing those areas, which have been
8851 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
8853 def IsExposedRect(*args
, **kwargs
):
8855 IsExposedRect(self, Rect rect) -> bool
8857 Returns true if the given point or rectangle area has been exposed
8858 since the last repaint. Call this in an paint event handler to
8859 optimize redrawing by only redrawing those areas, which have been
8862 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
8864 def GetDefaultAttributes(*args
, **kwargs
):
8866 GetDefaultAttributes(self) -> VisualAttributes
8868 Get the default attributes for an instance of this class. This is
8869 useful if you want to use the same font or colour in your own control
8870 as in a standard control -- which is a much better idea than hard
8871 coding specific colours or fonts which might look completely out of
8872 place on the user's system, especially if it uses themes.
8874 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
8876 def GetClassDefaultAttributes(*args
, **kwargs
):
8878 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8880 Get the default attributes for this class. This is useful if you want
8881 to use the same font or colour in your own control as in a standard
8882 control -- which is a much better idea than hard coding specific
8883 colours or fonts which might look completely out of place on the
8884 user's system, especially if it uses themes.
8886 The variant parameter is only relevant under Mac currently and is
8887 ignore under other platforms. Under Mac, it will change the size of
8888 the returned font. See `wx.Window.SetWindowVariant` for more about
8891 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
8893 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
8894 def SetBackgroundColour(*args
, **kwargs
):
8896 SetBackgroundColour(self, Colour colour) -> bool
8898 Sets the background colour of the window. Returns True if the colour
8899 was changed. The background colour is usually painted by the default
8900 EVT_ERASE_BACKGROUND event handler function under Windows and
8901 automatically under GTK. Using `wx.NullColour` will reset the window
8902 to the default background colour.
8904 Note that setting the background colour may not cause an immediate
8905 refresh, so you may wish to call `ClearBackground` or `Refresh` after
8906 calling this function.
8908 Using this function will disable attempts to use themes for this
8909 window, if the system supports them. Use with care since usually the
8910 themes represent the appearance chosen by the user to be used for all
8911 applications on the system.
8913 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
8915 def SetOwnBackgroundColour(*args
, **kwargs
):
8916 """SetOwnBackgroundColour(self, Colour colour)"""
8917 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
8919 def SetForegroundColour(*args
, **kwargs
):
8921 SetForegroundColour(self, Colour colour) -> bool
8923 Sets the foreground colour of the window. Returns True is the colour
8924 was changed. The interpretation of foreground colour is dependent on
8925 the window class; it may be the text colour or other colour, or it may
8928 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
8930 def SetOwnForegroundColour(*args
, **kwargs
):
8931 """SetOwnForegroundColour(self, Colour colour)"""
8932 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
8934 def GetBackgroundColour(*args
, **kwargs
):
8936 GetBackgroundColour(self) -> Colour
8938 Returns the background colour of the window.
8940 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
8942 def GetForegroundColour(*args
, **kwargs
):
8944 GetForegroundColour(self) -> Colour
8946 Returns the foreground colour of the window. The interpretation of
8947 foreground colour is dependent on the window class; it may be the text
8948 colour or other colour, or it may not be used at all.
8950 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
8952 def InheritsBackgroundColour(*args
, **kwargs
):
8953 """InheritsBackgroundColour(self) -> bool"""
8954 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
8956 def UseBgCol(*args
, **kwargs
):
8957 """UseBgCol(self) -> bool"""
8958 return _core_
.Window_UseBgCol(*args
, **kwargs
)
8960 def SetBackgroundStyle(*args
, **kwargs
):
8962 SetBackgroundStyle(self, int style) -> bool
8964 Returns the background style of the window. The background style
8965 indicates how the background of the window is drawn.
8967 ====================== ========================================
8968 wx.BG_STYLE_SYSTEM The background colour or pattern should
8969 be determined by the system
8970 wx.BG_STYLE_COLOUR The background should be a solid colour
8971 wx.BG_STYLE_CUSTOM The background will be implemented by the
8973 ====================== ========================================
8975 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
8976 a custom background, such as a tiled bitmap. Currently the style has
8977 no effect on other platforms.
8979 :see: `GetBackgroundStyle`, `SetBackgroundColour`
8981 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
8983 def GetBackgroundStyle(*args
, **kwargs
):
8985 GetBackgroundStyle(self) -> int
8987 Returns the background style of the window.
8989 :see: `SetBackgroundStyle`
8991 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
8993 def HasTransparentBackground(*args
, **kwargs
):
8995 HasTransparentBackground(self) -> bool
8997 Returns True if this window's background is transparent (as, for
8998 example, for `wx.StaticText`) and should show the parent window's
9001 This method is mostly used internally by the library itself and you
9002 normally shouldn't have to call it. You may, however, have to override
9003 it in your custom control classes to ensure that background is painted
9006 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9008 def SetCursor(*args
, **kwargs
):
9010 SetCursor(self, Cursor cursor) -> bool
9012 Sets the window's cursor. Notice that the window cursor also sets it
9013 for the children of the window implicitly.
9015 The cursor may be wx.NullCursor in which case the window cursor will
9016 be reset back to default.
9018 return _core_
.Window_SetCursor(*args
, **kwargs
)
9020 def GetCursor(*args
, **kwargs
):
9022 GetCursor(self) -> Cursor
9024 Return the cursor associated with this window.
9026 return _core_
.Window_GetCursor(*args
, **kwargs
)
9028 def SetFont(*args
, **kwargs
):
9030 SetFont(self, Font font) -> bool
9032 Sets the font for this window.
9034 return _core_
.Window_SetFont(*args
, **kwargs
)
9036 def SetOwnFont(*args
, **kwargs
):
9037 """SetOwnFont(self, Font font)"""
9038 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9040 def GetFont(*args
, **kwargs
):
9042 GetFont(self) -> Font
9044 Returns the default font used for this window.
9046 return _core_
.Window_GetFont(*args
, **kwargs
)
9048 def SetCaret(*args
, **kwargs
):
9050 SetCaret(self, Caret caret)
9052 Sets the caret associated with the window.
9054 return _core_
.Window_SetCaret(*args
, **kwargs
)
9056 def GetCaret(*args
, **kwargs
):
9058 GetCaret(self) -> Caret
9060 Returns the caret associated with the window.
9062 return _core_
.Window_GetCaret(*args
, **kwargs
)
9064 def GetCharHeight(*args
, **kwargs
):
9066 GetCharHeight(self) -> int
9068 Get the (average) character size for the current font.
9070 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9072 def GetCharWidth(*args
, **kwargs
):
9074 GetCharWidth(self) -> int
9076 Get the (average) character size for the current font.
9078 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9080 def GetTextExtent(*args
, **kwargs
):
9082 GetTextExtent(String string) -> (width, height)
9084 Get the width and height of the text using the current font.
9086 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9088 def GetFullTextExtent(*args
, **kwargs
):
9090 GetFullTextExtent(String string, Font font=None) ->
9091 (width, height, descent, externalLeading)
9093 Get the width, height, decent and leading of the text using the
9094 current or specified font.
9096 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9098 def ClientToScreenXY(*args
, **kwargs
):
9100 ClientToScreenXY(int x, int y) -> (x,y)
9102 Converts to screen coordinates from coordinates relative to this window.
9104 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9106 def ScreenToClientXY(*args
, **kwargs
):
9108 ScreenToClientXY(int x, int y) -> (x,y)
9110 Converts from screen to client window coordinates.
9112 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9114 def ClientToScreen(*args
, **kwargs
):
9116 ClientToScreen(self, Point pt) -> Point
9118 Converts to screen coordinates from coordinates relative to this window.
9120 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9122 def ScreenToClient(*args
, **kwargs
):
9124 ScreenToClient(self, Point pt) -> Point
9126 Converts from screen to client window coordinates.
9128 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9130 def HitTestXY(*args
, **kwargs
):
9132 HitTestXY(self, int x, int y) -> int
9134 Test where the given (in client coords) point lies
9136 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9138 def HitTest(*args
, **kwargs
):
9140 HitTest(self, Point pt) -> int
9142 Test where the given (in client coords) point lies
9144 return _core_
.Window_HitTest(*args
, **kwargs
)
9146 def GetBorder(*args
):
9148 GetBorder(self, long flags) -> int
9149 GetBorder(self) -> int
9151 Get border for the flags of this window
9153 return _core_
.Window_GetBorder(*args
)
9155 def UpdateWindowUI(*args
, **kwargs
):
9157 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9159 This function sends EVT_UPDATE_UI events to the window. The particular
9160 implementation depends on the window; for example a wx.ToolBar will
9161 send an update UI event for each toolbar button, and a wx.Frame will
9162 send an update UI event for each menubar menu item. You can call this
9163 function from your application to ensure that your UI is up-to-date at
9164 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9165 concerned). This may be necessary if you have called
9166 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9167 limit the overhead that wxWindows incurs by sending update UI events
9170 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9172 def PopupMenuXY(*args
, **kwargs
):
9174 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9176 Pops up the given menu at the specified coordinates, relative to this window,
9177 and returns control when the user has dismissed the menu. If a menu item is
9178 selected, the corresponding menu event is generated and will be processed as
9179 usual. If the default position is given then the current position of the
9180 mouse cursor will be used.
9182 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9184 def PopupMenu(*args
, **kwargs
):
9186 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9188 Pops up the given menu at the specified coordinates, relative to this window,
9189 and returns control when the user has dismissed the menu. If a menu item is
9190 selected, the corresponding menu event is generated and will be processed as
9191 usual. If the default position is given then the current position of the
9192 mouse cursor will be used.
9194 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9196 def GetHandle(*args
, **kwargs
):
9198 GetHandle(self) -> long
9200 Returns the platform-specific handle (as a long integer) of the
9201 physical window. Currently on wxMac it returns the handle of the
9202 toplevel parent of the window.
9204 return _core_
.Window_GetHandle(*args
, **kwargs
)
9206 def AssociateHandle(*args
, **kwargs
):
9208 AssociateHandle(self, long handle)
9210 Associate the window with a new native handle
9212 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9214 def DissociateHandle(*args
, **kwargs
):
9216 DissociateHandle(self)
9218 Dissociate the current native handle from the window
9220 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9222 def OnPaint(*args
, **kwargs
):
9223 """OnPaint(self, PaintEvent event)"""
9224 return _core_
.Window_OnPaint(*args
, **kwargs
)
9226 def HasScrollbar(*args
, **kwargs
):
9228 HasScrollbar(self, int orient) -> bool
9230 Does the window have the scrollbar for this orientation?
9232 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9234 def SetScrollbar(*args
, **kwargs
):
9236 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9239 Sets the scrollbar properties of a built-in scrollbar.
9241 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9243 def SetScrollPos(*args
, **kwargs
):
9245 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9247 Sets the position of one of the built-in scrollbars.
9249 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9251 def GetScrollPos(*args
, **kwargs
):
9253 GetScrollPos(self, int orientation) -> int
9255 Returns the built-in scrollbar position.
9257 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9259 def GetScrollThumb(*args
, **kwargs
):
9261 GetScrollThumb(self, int orientation) -> int
9263 Returns the built-in scrollbar thumb size.
9265 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9267 def GetScrollRange(*args
, **kwargs
):
9269 GetScrollRange(self, int orientation) -> int
9271 Returns the built-in scrollbar range.
9273 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9275 def ScrollWindow(*args
, **kwargs
):
9277 ScrollWindow(self, int dx, int dy, Rect rect=None)
9279 Physically scrolls the pixels in the window and move child windows
9280 accordingly. Use this function to optimise your scrolling
9281 implementations, to minimise the area that must be redrawn. Note that
9282 it is rarely required to call this function from a user program.
9284 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9286 def ScrollLines(*args
, **kwargs
):
9288 ScrollLines(self, int lines) -> bool
9290 If the platform and window class supports it, scrolls the window by
9291 the given number of lines down, if lines is positive, or up if lines
9292 is negative. Returns True if the window was scrolled, False if it was
9293 already on top/bottom and nothing was done.
9295 return _core_
.Window_ScrollLines(*args
, **kwargs
)
9297 def ScrollPages(*args
, **kwargs
):
9299 ScrollPages(self, int pages) -> bool
9301 If the platform and window class supports it, scrolls the window by
9302 the given number of pages down, if pages is positive, or up if pages
9303 is negative. Returns True if the window was scrolled, False if it was
9304 already on top/bottom and nothing was done.
9306 return _core_
.Window_ScrollPages(*args
, **kwargs
)
9308 def LineUp(*args
, **kwargs
):
9310 LineUp(self) -> bool
9312 This is just a wrapper for ScrollLines(-1).
9314 return _core_
.Window_LineUp(*args
, **kwargs
)
9316 def LineDown(*args
, **kwargs
):
9318 LineDown(self) -> bool
9320 This is just a wrapper for ScrollLines(1).
9322 return _core_
.Window_LineDown(*args
, **kwargs
)
9324 def PageUp(*args
, **kwargs
):
9326 PageUp(self) -> bool
9328 This is just a wrapper for ScrollPages(-1).
9330 return _core_
.Window_PageUp(*args
, **kwargs
)
9332 def PageDown(*args
, **kwargs
):
9334 PageDown(self) -> bool
9336 This is just a wrapper for ScrollPages(1).
9338 return _core_
.Window_PageDown(*args
, **kwargs
)
9340 def SetHelpText(*args
, **kwargs
):
9342 SetHelpText(self, String text)
9344 Sets the help text to be used as context-sensitive help for this
9345 window. Note that the text is actually stored by the current
9346 `wx.HelpProvider` implementation, and not in the window object itself.
9348 return _core_
.Window_SetHelpText(*args
, **kwargs
)
9350 def SetHelpTextForId(*args
, **kwargs
):
9352 SetHelpTextForId(self, String text)
9354 Associate this help text with all windows with the same id as this
9357 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
9359 def GetHelpText(*args
, **kwargs
):
9361 GetHelpText(self) -> String
9363 Gets the help text to be used as context-sensitive help for this
9364 window. Note that the text is actually stored by the current
9365 `wx.HelpProvider` implementation, and not in the window object itself.
9367 return _core_
.Window_GetHelpText(*args
, **kwargs
)
9369 def SetToolTipString(*args
, **kwargs
):
9371 SetToolTipString(self, String tip)
9373 Attach a tooltip to the window.
9375 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
9377 def SetToolTip(*args
, **kwargs
):
9379 SetToolTip(self, ToolTip tip)
9381 Attach a tooltip to the window.
9383 return _core_
.Window_SetToolTip(*args
, **kwargs
)
9385 def GetToolTip(*args
, **kwargs
):
9387 GetToolTip(self) -> ToolTip
9389 get the associated tooltip or None if none
9391 return _core_
.Window_GetToolTip(*args
, **kwargs
)
9393 def SetDropTarget(*args
, **kwargs
):
9395 SetDropTarget(self, DropTarget dropTarget)
9397 Associates a drop target with this window. If the window already has
9398 a drop target, it is deleted.
9400 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
9402 def GetDropTarget(*args
, **kwargs
):
9404 GetDropTarget(self) -> DropTarget
9406 Returns the associated drop target, which may be None.
9408 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
9410 def DragAcceptFiles(*args
, **kwargs
):
9412 DragAcceptFiles(self, bool accept)
9414 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9415 Only functional on Windows.
9417 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
9419 def SetConstraints(*args
, **kwargs
):
9421 SetConstraints(self, LayoutConstraints constraints)
9423 Sets the window to have the given layout constraints. If an existing
9424 layout constraints object is already owned by the window, it will be
9425 deleted. Pass None to disassociate and delete the window's current
9428 You must call SetAutoLayout to tell a window to use the constraints
9429 automatically in its default EVT_SIZE handler; otherwise, you must
9430 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9431 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9434 return _core_
.Window_SetConstraints(*args
, **kwargs
)
9436 def GetConstraints(*args
, **kwargs
):
9438 GetConstraints(self) -> LayoutConstraints
9440 Returns a pointer to the window's layout constraints, or None if there
9443 return _core_
.Window_GetConstraints(*args
, **kwargs
)
9445 def SetAutoLayout(*args
, **kwargs
):
9447 SetAutoLayout(self, bool autoLayout)
9449 Determines whether the Layout function will be called automatically
9450 when the window is resized. lease note that this only happens for the
9451 windows usually used to contain children, namely `wx.Panel` and
9452 `wx.TopLevelWindow` (and the classes deriving from them).
9454 This method is called implicitly by `SetSizer` but if you use
9455 `SetConstraints` you should call it manually or otherwise the window
9456 layout won't be correctly updated when its size changes.
9458 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
9460 def GetAutoLayout(*args
, **kwargs
):
9462 GetAutoLayout(self) -> bool
9464 Returns the current autoLayout setting
9466 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
9468 def Layout(*args
, **kwargs
):
9470 Layout(self) -> bool
9472 Invokes the constraint-based layout algorithm or the sizer-based
9473 algorithm for this window. See SetAutoLayout: when auto layout is on,
9474 this function gets called automatically by the default EVT_SIZE
9475 handler when the window is resized.
9477 return _core_
.Window_Layout(*args
, **kwargs
)
9479 def SetSizer(*args
, **kwargs
):
9481 SetSizer(self, Sizer sizer, bool deleteOld=True)
9483 Sets the window to have the given layout sizer. The window will then
9484 own the object, and will take care of its deletion. If an existing
9485 layout sizer object is already owned by the window, it will be deleted
9486 if the deleteOld parameter is true. Note that this function will also
9487 call SetAutoLayout implicitly with a True parameter if the sizer is
9488 non-None, and False otherwise.
9490 return _core_
.Window_SetSizer(*args
, **kwargs
)
9492 def SetSizerAndFit(*args
, **kwargs
):
9494 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9496 The same as SetSizer, except it also sets the size hints for the
9497 window based on the sizer's minimum size.
9499 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
9501 def GetSizer(*args
, **kwargs
):
9503 GetSizer(self) -> Sizer
9505 Return the sizer associated with the window by a previous call to
9506 SetSizer or None if there isn't one.
9508 return _core_
.Window_GetSizer(*args
, **kwargs
)
9510 def SetContainingSizer(*args
, **kwargs
):
9512 SetContainingSizer(self, Sizer sizer)
9514 This normally does not need to be called by application code. It is
9515 called internally when a window is added to a sizer, and is used so
9516 the window can remove itself from the sizer when it is destroyed.
9518 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
9520 def GetContainingSizer(*args
, **kwargs
):
9522 GetContainingSizer(self) -> Sizer
9524 Return the sizer that this window is a member of, if any, otherwise None.
9526 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
9528 def InheritAttributes(*args
, **kwargs
):
9530 InheritAttributes(self)
9532 This function is (or should be, in case of custom controls) called
9533 during window creation to intelligently set up the window visual
9534 attributes, that is the font and the foreground and background
9537 By 'intelligently' the following is meant: by default, all windows use
9538 their own default attributes. However if some of the parent's
9539 attributes are explicitly changed (that is, using SetFont and not
9540 SetOwnFont) and if the corresponding attribute hadn't been
9541 explicitly set for this window itself, then this window takes the same
9542 value as used by the parent. In addition, if the window overrides
9543 ShouldInheritColours to return false, the colours will not be changed
9544 no matter what and only the font might.
9546 This rather complicated logic is necessary in order to accommodate the
9547 different usage scenarios. The most common one is when all default
9548 attributes are used and in this case, nothing should be inherited as
9549 in modern GUIs different controls use different fonts (and colours)
9550 than their siblings so they can't inherit the same value from the
9551 parent. However it was also deemed desirable to allow to simply change
9552 the attributes of all children at once by just changing the font or
9553 colour of their common parent, hence in this case we do inherit the
9557 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
9559 def ShouldInheritColours(*args
, **kwargs
):
9561 ShouldInheritColours(self) -> bool
9563 Return true from here to allow the colours of this window to be
9564 changed by InheritAttributes, returning false forbids inheriting them
9565 from the parent window.
9567 The base class version returns false, but this method is overridden in
9568 wxControl where it returns true.
9570 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
9572 def PostCreate(self
, pre
):
9574 Phase 3 of the 2-phase create <wink!>
9575 Call this method after precreating the window with the 2-phase create method.
9577 self
.this
= pre
.this
9578 self
.thisown
= pre
.thisown
9580 if hasattr(self
, '_setOORInfo'):
9581 self
._setOORInfo
(self
)
9582 if hasattr(self
, '_setCallbackInfo'):
9583 self
._setCallbackInfo
(self
, self
.__class
__)
9585 def SendSizeEvent(self
):
9586 self
.GetEventhandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
9588 Window_swigregister
= _core_
.Window_swigregister
9589 Window_swigregister(Window
)
9591 def PreWindow(*args
, **kwargs
):
9593 PreWindow() -> Window
9595 Precreate a Window for 2-phase creation.
9597 val
= _core_
.new_PreWindow(*args
, **kwargs
)
9600 def Window_NewControlId(*args
):
9602 Window_NewControlId() -> int
9604 Generate a control id for the controls which were not given one.
9606 return _core_
.Window_NewControlId(*args
)
9608 def Window_NextControlId(*args
, **kwargs
):
9610 Window_NextControlId(int winid) -> int
9612 Get the id of the control following the one with the given
9615 return _core_
.Window_NextControlId(*args
, **kwargs
)
9617 def Window_PrevControlId(*args
, **kwargs
):
9619 Window_PrevControlId(int winid) -> int
9621 Get the id of the control preceding the one with the given
9624 return _core_
.Window_PrevControlId(*args
, **kwargs
)
9626 def Window_FindFocus(*args
):
9628 Window_FindFocus() -> Window
9630 Returns the window or control that currently has the keyboard focus,
9633 return _core_
.Window_FindFocus(*args
)
9635 def Window_GetCapture(*args
):
9637 Window_GetCapture() -> Window
9639 Returns the window which currently captures the mouse or None
9641 return _core_
.Window_GetCapture(*args
)
9643 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
9645 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9647 Get the default attributes for this class. This is useful if you want
9648 to use the same font or colour in your own control as in a standard
9649 control -- which is a much better idea than hard coding specific
9650 colours or fonts which might look completely out of place on the
9651 user's system, especially if it uses themes.
9653 The variant parameter is only relevant under Mac currently and is
9654 ignore under other platforms. Under Mac, it will change the size of
9655 the returned font. See `wx.Window.SetWindowVariant` for more about
9658 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9660 def DLG_PNT(win
, point_or_x
, y
=None):
9662 Convenience function for converting a Point or (x,y) in
9663 dialog units to pixel units.
9666 return win
.ConvertDialogPointToPixels(point_or_x
)
9668 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
9670 def DLG_SZE(win
, size_width
, height
=None):
9672 Convenience function for converting a Size or (w,h) in
9673 dialog units to pixel units.
9676 return win
.ConvertDialogSizeToPixels(size_width
)
9678 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
9681 def FindWindowById(*args
, **kwargs
):
9683 FindWindowById(long id, Window parent=None) -> Window
9685 Find the first window in the application with the given id. If parent
9686 is None, the search will start from all top-level frames and dialog
9687 boxes; if non-None, the search will be limited to the given window
9688 hierarchy. The search is recursive in both cases.
9690 return _core_
.FindWindowById(*args
, **kwargs
)
9692 def FindWindowByName(*args
, **kwargs
):
9694 FindWindowByName(String name, Window parent=None) -> Window
9696 Find a window by its name (as given in a window constructor or Create
9697 function call). If parent is None, the search will start from all
9698 top-level frames and dialog boxes; if non-None, the search will be
9699 limited to the given window hierarchy. The search is recursive in both
9702 If no window with such name is found, wx.FindWindowByLabel is called.
9704 return _core_
.FindWindowByName(*args
, **kwargs
)
9706 def FindWindowByLabel(*args
, **kwargs
):
9708 FindWindowByLabel(String label, Window parent=None) -> Window
9710 Find a window by its label. Depending on the type of window, the label
9711 may be a window title or panel item label. If parent is None, the
9712 search will start from all top-level frames and dialog boxes; if
9713 non-None, the search will be limited to the given window
9714 hierarchy. The search is recursive in both cases.
9716 return _core_
.FindWindowByLabel(*args
, **kwargs
)
9718 def Window_FromHWND(*args
, **kwargs
):
9719 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
9720 return _core_
.Window_FromHWND(*args
, **kwargs
)
9722 def GetTopLevelWindows(*args
):
9724 GetTopLevelWindows() -> PyObject
9726 Returns a list of the the application's top-level windows, (frames,
9727 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
9728 by wxWidgets, and so it is only valid as long as no top-level windows
9729 are closed or new top-level windows are created.
9732 return _core_
.GetTopLevelWindows(*args
)
9733 #---------------------------------------------------------------------------
9735 class Validator(EvtHandler
):
9736 """Proxy of C++ Validator class"""
9737 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
9738 __repr__
= _swig_repr
9739 def __init__(self
, *args
, **kwargs
):
9740 """__init__(self) -> Validator"""
9741 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
9742 self
._setOORInfo
(self
)
9744 def Clone(*args
, **kwargs
):
9745 """Clone(self) -> Validator"""
9746 return _core_
.Validator_Clone(*args
, **kwargs
)
9748 def Validate(*args
, **kwargs
):
9749 """Validate(self, Window parent) -> bool"""
9750 return _core_
.Validator_Validate(*args
, **kwargs
)
9752 def TransferToWindow(*args
, **kwargs
):
9753 """TransferToWindow(self) -> bool"""
9754 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
9756 def TransferFromWindow(*args
, **kwargs
):
9757 """TransferFromWindow(self) -> bool"""
9758 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
9760 def GetWindow(*args
, **kwargs
):
9761 """GetWindow(self) -> Window"""
9762 return _core_
.Validator_GetWindow(*args
, **kwargs
)
9764 def SetWindow(*args
, **kwargs
):
9765 """SetWindow(self, Window window)"""
9766 return _core_
.Validator_SetWindow(*args
, **kwargs
)
9768 def IsSilent(*args
, **kwargs
):
9769 """IsSilent() -> bool"""
9770 return _core_
.Validator_IsSilent(*args
, **kwargs
)
9772 IsSilent
= staticmethod(IsSilent
)
9773 def SetBellOnError(*args
, **kwargs
):
9774 """SetBellOnError(int doIt=True)"""
9775 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
9777 SetBellOnError
= staticmethod(SetBellOnError
)
9778 Validator_swigregister
= _core_
.Validator_swigregister
9779 Validator_swigregister(Validator
)
9781 def Validator_IsSilent(*args
):
9782 """Validator_IsSilent() -> bool"""
9783 return _core_
.Validator_IsSilent(*args
)
9785 def Validator_SetBellOnError(*args
, **kwargs
):
9786 """Validator_SetBellOnError(int doIt=True)"""
9787 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
9789 class PyValidator(Validator
):
9790 """Proxy of C++ PyValidator class"""
9791 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
9792 __repr__
= _swig_repr
9793 def __init__(self
, *args
, **kwargs
):
9794 """__init__(self) -> PyValidator"""
9795 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
9797 self
._setCallbackInfo
(self
, PyValidator
, 1)
9798 self
._setOORInfo
(self
)
9800 def _setCallbackInfo(*args
, **kwargs
):
9801 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
9802 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
9804 PyValidator_swigregister
= _core_
.PyValidator_swigregister
9805 PyValidator_swigregister(PyValidator
)
9807 #---------------------------------------------------------------------------
9809 class Menu(EvtHandler
):
9810 """Proxy of C++ Menu class"""
9811 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
9812 __repr__
= _swig_repr
9813 def __init__(self
, *args
, **kwargs
):
9814 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
9815 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
9816 self
._setOORInfo
(self
)
9818 def Append(*args
, **kwargs
):
9819 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9820 return _core_
.Menu_Append(*args
, **kwargs
)
9822 def AppendSeparator(*args
, **kwargs
):
9823 """AppendSeparator(self) -> MenuItem"""
9824 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
9826 def AppendCheckItem(*args
, **kwargs
):
9827 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9828 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
9830 def AppendRadioItem(*args
, **kwargs
):
9831 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9832 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
9834 def AppendMenu(*args
, **kwargs
):
9835 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9836 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
9838 def AppendItem(*args
, **kwargs
):
9839 """AppendItem(self, MenuItem item) -> MenuItem"""
9840 return _core_
.Menu_AppendItem(*args
, **kwargs
)
9842 def InsertItem(*args
, **kwargs
):
9843 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
9844 return _core_
.Menu_InsertItem(*args
, **kwargs
)
9846 def PrependItem(*args
, **kwargs
):
9847 """PrependItem(self, MenuItem item) -> MenuItem"""
9848 return _core_
.Menu_PrependItem(*args
, **kwargs
)
9850 def Break(*args
, **kwargs
):
9852 return _core_
.Menu_Break(*args
, **kwargs
)
9854 def Insert(*args
, **kwargs
):
9856 Insert(self, size_t pos, int id, String text, String help=EmptyString,
9857 int kind=ITEM_NORMAL) -> MenuItem
9859 return _core_
.Menu_Insert(*args
, **kwargs
)
9861 def InsertSeparator(*args
, **kwargs
):
9862 """InsertSeparator(self, size_t pos) -> MenuItem"""
9863 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
9865 def InsertCheckItem(*args
, **kwargs
):
9866 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9867 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
9869 def InsertRadioItem(*args
, **kwargs
):
9870 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9871 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
9873 def InsertMenu(*args
, **kwargs
):
9874 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9875 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
9877 def Prepend(*args
, **kwargs
):
9878 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9879 return _core_
.Menu_Prepend(*args
, **kwargs
)
9881 def PrependSeparator(*args
, **kwargs
):
9882 """PrependSeparator(self) -> MenuItem"""
9883 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
9885 def PrependCheckItem(*args
, **kwargs
):
9886 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9887 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
9889 def PrependRadioItem(*args
, **kwargs
):
9890 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9891 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
9893 def PrependMenu(*args
, **kwargs
):
9894 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9895 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
9897 def Remove(*args
, **kwargs
):
9898 """Remove(self, int id) -> MenuItem"""
9899 return _core_
.Menu_Remove(*args
, **kwargs
)
9901 def RemoveItem(*args
, **kwargs
):
9902 """RemoveItem(self, MenuItem item) -> MenuItem"""
9903 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
9905 def Delete(*args
, **kwargs
):
9906 """Delete(self, int id) -> bool"""
9907 return _core_
.Menu_Delete(*args
, **kwargs
)
9909 def DeleteItem(*args
, **kwargs
):
9910 """DeleteItem(self, MenuItem item) -> bool"""
9911 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
9913 def Destroy(*args
, **kwargs
):
9917 Deletes the C++ object this Python object is a proxy for.
9919 val
= _core_
.Menu_Destroy(*args
, **kwargs
)
9923 def DestroyId(*args
, **kwargs
):
9925 DestroyId(self, int id) -> bool
9927 Deletes the C++ object this Python object is a proxy for.
9929 val
= _core_
.Menu_DestroyId(*args
, **kwargs
)
9933 def DestroyItem(*args
, **kwargs
):
9935 DestroyItem(self, MenuItem item) -> bool
9937 Deletes the C++ object this Python object is a proxy for.
9939 val
= _core_
.Menu_DestroyItem(*args
, **kwargs
)
9943 def GetMenuItemCount(*args
, **kwargs
):
9944 """GetMenuItemCount(self) -> size_t"""
9945 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
9947 def GetMenuItems(*args
, **kwargs
):
9948 """GetMenuItems(self) -> PyObject"""
9949 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
9951 def FindItem(*args
, **kwargs
):
9952 """FindItem(self, String item) -> int"""
9953 return _core_
.Menu_FindItem(*args
, **kwargs
)
9955 def FindItemById(*args
, **kwargs
):
9956 """FindItemById(self, int id) -> MenuItem"""
9957 return _core_
.Menu_FindItemById(*args
, **kwargs
)
9959 def FindItemByPosition(*args
, **kwargs
):
9960 """FindItemByPosition(self, size_t position) -> MenuItem"""
9961 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
9963 def Enable(*args
, **kwargs
):
9964 """Enable(self, int id, bool enable)"""
9965 return _core_
.Menu_Enable(*args
, **kwargs
)
9967 def IsEnabled(*args
, **kwargs
):
9968 """IsEnabled(self, int id) -> bool"""
9969 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
9971 def Check(*args
, **kwargs
):
9972 """Check(self, int id, bool check)"""
9973 return _core_
.Menu_Check(*args
, **kwargs
)
9975 def IsChecked(*args
, **kwargs
):
9976 """IsChecked(self, int id) -> bool"""
9977 return _core_
.Menu_IsChecked(*args
, **kwargs
)
9979 def SetLabel(*args
, **kwargs
):
9980 """SetLabel(self, int id, String label)"""
9981 return _core_
.Menu_SetLabel(*args
, **kwargs
)
9983 def GetLabel(*args
, **kwargs
):
9984 """GetLabel(self, int id) -> String"""
9985 return _core_
.Menu_GetLabel(*args
, **kwargs
)
9987 def SetHelpString(*args
, **kwargs
):
9988 """SetHelpString(self, int id, String helpString)"""
9989 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
9991 def GetHelpString(*args
, **kwargs
):
9992 """GetHelpString(self, int id) -> String"""
9993 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
9995 def SetTitle(*args
, **kwargs
):
9996 """SetTitle(self, String title)"""
9997 return _core_
.Menu_SetTitle(*args
, **kwargs
)
9999 def GetTitle(*args
, **kwargs
):
10000 """GetTitle(self) -> String"""
10001 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10003 def SetEventHandler(*args
, **kwargs
):
10004 """SetEventHandler(self, EvtHandler handler)"""
10005 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10007 def GetEventHandler(*args
, **kwargs
):
10008 """GetEventHandler(self) -> EvtHandler"""
10009 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10011 def SetInvokingWindow(*args
, **kwargs
):
10012 """SetInvokingWindow(self, Window win)"""
10013 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10015 def GetInvokingWindow(*args
, **kwargs
):
10016 """GetInvokingWindow(self) -> Window"""
10017 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10019 def GetStyle(*args
, **kwargs
):
10020 """GetStyle(self) -> long"""
10021 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10023 def UpdateUI(*args
, **kwargs
):
10024 """UpdateUI(self, EvtHandler source=None)"""
10025 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10027 def GetMenuBar(*args
, **kwargs
):
10028 """GetMenuBar(self) -> MenuBar"""
10029 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10031 def Attach(*args
, **kwargs
):
10032 """Attach(self, wxMenuBarBase menubar)"""
10033 return _core_
.Menu_Attach(*args
, **kwargs
)
10035 def Detach(*args
, **kwargs
):
10037 return _core_
.Menu_Detach(*args
, **kwargs
)
10039 def IsAttached(*args
, **kwargs
):
10040 """IsAttached(self) -> bool"""
10041 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10043 def SetParent(*args
, **kwargs
):
10044 """SetParent(self, Menu parent)"""
10045 return _core_
.Menu_SetParent(*args
, **kwargs
)
10047 def GetParent(*args
, **kwargs
):
10048 """GetParent(self) -> Menu"""
10049 return _core_
.Menu_GetParent(*args
, **kwargs
)
10051 Menu_swigregister
= _core_
.Menu_swigregister
10052 Menu_swigregister(Menu
)
10053 DefaultValidator
= cvar
.DefaultValidator
10055 #---------------------------------------------------------------------------
10057 class MenuBar(Window
):
10058 """Proxy of C++ MenuBar class"""
10059 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10060 __repr__
= _swig_repr
10061 def __init__(self
, *args
, **kwargs
):
10062 """__init__(self, long style=0) -> MenuBar"""
10063 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10064 self
._setOORInfo
(self
)
10066 def Append(*args
, **kwargs
):
10067 """Append(self, Menu menu, String title) -> bool"""
10068 return _core_
.MenuBar_Append(*args
, **kwargs
)
10070 def Insert(*args
, **kwargs
):
10071 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10072 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10074 def GetMenuCount(*args
, **kwargs
):
10075 """GetMenuCount(self) -> size_t"""
10076 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10078 def GetMenu(*args
, **kwargs
):
10079 """GetMenu(self, size_t pos) -> Menu"""
10080 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10082 def Replace(*args
, **kwargs
):
10083 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10084 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10086 def Remove(*args
, **kwargs
):
10087 """Remove(self, size_t pos) -> Menu"""
10088 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10090 def EnableTop(*args
, **kwargs
):
10091 """EnableTop(self, size_t pos, bool enable)"""
10092 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10094 def IsEnabledTop(*args
, **kwargs
):
10095 """IsEnabledTop(self, size_t pos) -> bool"""
10096 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10098 def SetLabelTop(*args
, **kwargs
):
10099 """SetLabelTop(self, size_t pos, String label)"""
10100 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10102 def GetLabelTop(*args
, **kwargs
):
10103 """GetLabelTop(self, size_t pos) -> String"""
10104 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10106 def FindMenuItem(*args
, **kwargs
):
10107 """FindMenuItem(self, String menu, String item) -> int"""
10108 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10110 def FindItemById(*args
, **kwargs
):
10111 """FindItemById(self, int id) -> MenuItem"""
10112 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10114 def FindMenu(*args
, **kwargs
):
10115 """FindMenu(self, String title) -> int"""
10116 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10118 def Enable(*args
, **kwargs
):
10119 """Enable(self, int id, bool enable)"""
10120 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10122 def Check(*args
, **kwargs
):
10123 """Check(self, int id, bool check)"""
10124 return _core_
.MenuBar_Check(*args
, **kwargs
)
10126 def IsChecked(*args
, **kwargs
):
10127 """IsChecked(self, int id) -> bool"""
10128 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10130 def IsEnabled(*args
, **kwargs
):
10131 """IsEnabled(self, int id) -> bool"""
10132 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10134 def SetLabel(*args
, **kwargs
):
10135 """SetLabel(self, int id, String label)"""
10136 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10138 def GetLabel(*args
, **kwargs
):
10139 """GetLabel(self, int id) -> String"""
10140 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10142 def SetHelpString(*args
, **kwargs
):
10143 """SetHelpString(self, int id, String helpString)"""
10144 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10146 def GetHelpString(*args
, **kwargs
):
10147 """GetHelpString(self, int id) -> String"""
10148 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10150 def GetFrame(*args
, **kwargs
):
10151 """GetFrame(self) -> wxFrame"""
10152 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10154 def IsAttached(*args
, **kwargs
):
10155 """IsAttached(self) -> bool"""
10156 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10158 def Attach(*args
, **kwargs
):
10159 """Attach(self, wxFrame frame)"""
10160 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10162 def Detach(*args
, **kwargs
):
10164 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10166 def SetAutoWindowMenu(*args
, **kwargs
):
10167 """SetAutoWindowMenu(bool enable)"""
10168 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10170 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10171 def GetAutoWindowMenu(*args
, **kwargs
):
10172 """GetAutoWindowMenu() -> bool"""
10173 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10175 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10176 MenuBar_swigregister
= _core_
.MenuBar_swigregister
10177 MenuBar_swigregister(MenuBar
)
10179 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
10180 """MenuBar_SetAutoWindowMenu(bool enable)"""
10181 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10183 def MenuBar_GetAutoWindowMenu(*args
):
10184 """MenuBar_GetAutoWindowMenu() -> bool"""
10185 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
10187 #---------------------------------------------------------------------------
10189 class MenuItem(Object
):
10190 """Proxy of C++ MenuItem class"""
10191 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10192 __repr__
= _swig_repr
10193 def __init__(self
, *args
, **kwargs
):
10195 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10196 String help=EmptyString, int kind=ITEM_NORMAL,
10197 Menu subMenu=None) -> MenuItem
10199 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
10200 __swig_destroy__
= _core_
.delete_MenuItem
10201 __del__
= lambda self
: None;
10202 def GetMenu(*args
, **kwargs
):
10203 """GetMenu(self) -> Menu"""
10204 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
10206 def SetMenu(*args
, **kwargs
):
10207 """SetMenu(self, Menu menu)"""
10208 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
10210 def SetId(*args
, **kwargs
):
10211 """SetId(self, int id)"""
10212 return _core_
.MenuItem_SetId(*args
, **kwargs
)
10214 def GetId(*args
, **kwargs
):
10215 """GetId(self) -> int"""
10216 return _core_
.MenuItem_GetId(*args
, **kwargs
)
10218 def IsSeparator(*args
, **kwargs
):
10219 """IsSeparator(self) -> bool"""
10220 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
10222 def SetText(*args
, **kwargs
):
10223 """SetText(self, String str)"""
10224 return _core_
.MenuItem_SetText(*args
, **kwargs
)
10226 def GetLabel(*args
, **kwargs
):
10227 """GetLabel(self) -> String"""
10228 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
10230 def GetText(*args
, **kwargs
):
10231 """GetText(self) -> String"""
10232 return _core_
.MenuItem_GetText(*args
, **kwargs
)
10234 def GetLabelFromText(*args
, **kwargs
):
10235 """GetLabelFromText(String text) -> String"""
10236 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10238 GetLabelFromText
= staticmethod(GetLabelFromText
)
10239 def GetKind(*args
, **kwargs
):
10240 """GetKind(self) -> int"""
10241 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
10243 def SetKind(*args
, **kwargs
):
10244 """SetKind(self, int kind)"""
10245 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
10247 def SetCheckable(*args
, **kwargs
):
10248 """SetCheckable(self, bool checkable)"""
10249 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
10251 def IsCheckable(*args
, **kwargs
):
10252 """IsCheckable(self) -> bool"""
10253 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
10255 def IsSubMenu(*args
, **kwargs
):
10256 """IsSubMenu(self) -> bool"""
10257 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
10259 def SetSubMenu(*args
, **kwargs
):
10260 """SetSubMenu(self, Menu menu)"""
10261 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
10263 def GetSubMenu(*args
, **kwargs
):
10264 """GetSubMenu(self) -> Menu"""
10265 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
10267 def Enable(*args
, **kwargs
):
10268 """Enable(self, bool enable=True)"""
10269 return _core_
.MenuItem_Enable(*args
, **kwargs
)
10271 def IsEnabled(*args
, **kwargs
):
10272 """IsEnabled(self) -> bool"""
10273 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
10275 def Check(*args
, **kwargs
):
10276 """Check(self, bool check=True)"""
10277 return _core_
.MenuItem_Check(*args
, **kwargs
)
10279 def IsChecked(*args
, **kwargs
):
10280 """IsChecked(self) -> bool"""
10281 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
10283 def Toggle(*args
, **kwargs
):
10285 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
10287 def SetHelp(*args
, **kwargs
):
10288 """SetHelp(self, String str)"""
10289 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
10291 def GetHelp(*args
, **kwargs
):
10292 """GetHelp(self) -> String"""
10293 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
10295 def GetAccel(*args
, **kwargs
):
10296 """GetAccel(self) -> AcceleratorEntry"""
10297 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
10299 def SetAccel(*args
, **kwargs
):
10300 """SetAccel(self, AcceleratorEntry accel)"""
10301 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
10303 def SetBitmap(*args
, **kwargs
):
10304 """SetBitmap(self, Bitmap bitmap)"""
10305 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
10307 def GetBitmap(*args
, **kwargs
):
10308 """GetBitmap(self) -> Bitmap"""
10309 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
10311 def SetFont(*args
, **kwargs
):
10312 """SetFont(self, Font font)"""
10313 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
10315 def GetFont(*args
, **kwargs
):
10316 """GetFont(self) -> Font"""
10317 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
10319 def SetTextColour(*args
, **kwargs
):
10320 """SetTextColour(self, Colour colText)"""
10321 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
10323 def GetTextColour(*args
, **kwargs
):
10324 """GetTextColour(self) -> Colour"""
10325 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
10327 def SetBackgroundColour(*args
, **kwargs
):
10328 """SetBackgroundColour(self, Colour colBack)"""
10329 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
10331 def GetBackgroundColour(*args
, **kwargs
):
10332 """GetBackgroundColour(self) -> Colour"""
10333 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
10335 def SetBitmaps(*args
, **kwargs
):
10336 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10337 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
10339 def SetDisabledBitmap(*args
, **kwargs
):
10340 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10341 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
10343 def GetDisabledBitmap(*args
, **kwargs
):
10344 """GetDisabledBitmap(self) -> Bitmap"""
10345 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
10347 def SetMarginWidth(*args
, **kwargs
):
10348 """SetMarginWidth(self, int nWidth)"""
10349 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
10351 def GetMarginWidth(*args
, **kwargs
):
10352 """GetMarginWidth(self) -> int"""
10353 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
10355 def GetDefaultMarginWidth(*args
, **kwargs
):
10356 """GetDefaultMarginWidth() -> int"""
10357 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
10359 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
10360 def IsOwnerDrawn(*args
, **kwargs
):
10361 """IsOwnerDrawn(self) -> bool"""
10362 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
10364 def SetOwnerDrawn(*args
, **kwargs
):
10365 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10366 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
10368 def ResetOwnerDrawn(*args
, **kwargs
):
10369 """ResetOwnerDrawn(self)"""
10370 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
10372 MenuItem_swigregister
= _core_
.MenuItem_swigregister
10373 MenuItem_swigregister(MenuItem
)
10375 def MenuItem_GetLabelFromText(*args
, **kwargs
):
10376 """MenuItem_GetLabelFromText(String text) -> String"""
10377 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10379 def MenuItem_GetDefaultMarginWidth(*args
):
10380 """MenuItem_GetDefaultMarginWidth() -> int"""
10381 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
10383 #---------------------------------------------------------------------------
10385 class Control(Window
):
10387 This is the base class for a control or 'widget'.
10389 A control is generally a small window which processes user input
10390 and/or displays one or more item of data.
10392 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10393 __repr__
= _swig_repr
10394 def __init__(self
, *args
, **kwargs
):
10396 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10397 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10398 String name=ControlNameStr) -> Control
10400 Create a Control. Normally you should only call this from a subclass'
10401 __init__ as a plain old wx.Control is not very useful.
10403 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
10404 self
._setOORInfo
(self
)
10406 def Create(*args
, **kwargs
):
10408 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10409 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10410 String name=ControlNameStr) -> bool
10412 Do the 2nd phase and create the GUI control.
10414 return _core_
.Control_Create(*args
, **kwargs
)
10416 def Command(*args
, **kwargs
):
10418 Command(self, CommandEvent event)
10420 Simulates the effect of the user issuing a command to the item.
10422 :see: `wx.CommandEvent`
10425 return _core_
.Control_Command(*args
, **kwargs
)
10427 def GetLabel(*args
, **kwargs
):
10429 GetLabel(self) -> String
10431 Return a control's text.
10433 return _core_
.Control_GetLabel(*args
, **kwargs
)
10435 def GetClassDefaultAttributes(*args
, **kwargs
):
10437 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10439 Get the default attributes for this class. This is useful if you want
10440 to use the same font or colour in your own control as in a standard
10441 control -- which is a much better idea than hard coding specific
10442 colours or fonts which might look completely out of place on the
10443 user's system, especially if it uses themes.
10445 The variant parameter is only relevant under Mac currently and is
10446 ignore under other platforms. Under Mac, it will change the size of
10447 the returned font. See `wx.Window.SetWindowVariant` for more about
10450 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
10452 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
10453 Control_swigregister
= _core_
.Control_swigregister
10454 Control_swigregister(Control
)
10455 ControlNameStr
= cvar
.ControlNameStr
10457 def PreControl(*args
, **kwargs
):
10459 PreControl() -> Control
10461 Precreate a Control control for 2-phase creation
10463 val
= _core_
.new_PreControl(*args
, **kwargs
)
10466 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
10468 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10470 Get the default attributes for this class. This is useful if you want
10471 to use the same font or colour in your own control as in a standard
10472 control -- which is a much better idea than hard coding specific
10473 colours or fonts which might look completely out of place on the
10474 user's system, especially if it uses themes.
10476 The variant parameter is only relevant under Mac currently and is
10477 ignore under other platforms. Under Mac, it will change the size of
10478 the returned font. See `wx.Window.SetWindowVariant` for more about
10481 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
10483 #---------------------------------------------------------------------------
10485 class ItemContainer(object):
10487 The wx.ItemContainer class defines an interface which is implemented
10488 by all controls which have string subitems, each of which may be
10489 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
10490 as `wx.ComboBox` which implements an extended interface deriving from
10493 It defines the methods for accessing the control's items and although
10494 each of the derived classes implements them differently, they still
10495 all conform to the same interface.
10497 The items in a wx.ItemContainer have (non empty) string labels and,
10498 optionally, client data associated with them.
10501 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10502 def __init__(self
): raise AttributeError, "No constructor defined"
10503 __repr__
= _swig_repr
10504 def Append(*args
, **kwargs
):
10506 Append(self, String item, PyObject clientData=None) -> int
10508 Adds the item to the control, associating the given data with the item
10509 if not None. The return value is the index of the newly added item
10510 which may be different from the last one if the control is sorted (e.g.
10511 has wx.LB_SORT or wx.CB_SORT style).
10513 return _core_
.ItemContainer_Append(*args
, **kwargs
)
10515 def AppendItems(*args
, **kwargs
):
10517 AppendItems(self, List strings)
10519 Apend several items at once to the control. Notice that calling this
10520 method may be much faster than appending the items one by one if you
10521 need to add a lot of items.
10523 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
10525 def Insert(*args
, **kwargs
):
10527 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
10529 Insert an item into the control before the item at the ``pos`` index,
10530 optionally associating some data object with the item.
10532 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
10534 def Clear(*args
, **kwargs
):
10538 Removes all items from the control.
10540 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
10542 def Delete(*args
, **kwargs
):
10544 Delete(self, unsigned int n)
10546 Deletes the item at the zero-based index 'n' from the control. Note
10547 that it is an error (signalled by a `wx.PyAssertionError` exception if
10548 enabled) to remove an item with the index negative or greater or equal
10549 than the number of items in the control.
10551 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
10553 def GetClientData(*args
, **kwargs
):
10555 GetClientData(self, unsigned int n) -> PyObject
10557 Returns the client data associated with the given item, (if any.)
10559 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
10561 def SetClientData(*args
, **kwargs
):
10563 SetClientData(self, unsigned int n, PyObject clientData)
10565 Associate the given client data with the item at position n.
10567 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
10569 def GetCount(*args
, **kwargs
):
10571 GetCount(self) -> unsigned int
10573 Returns the number of items in the control.
10575 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
10577 def IsEmpty(*args
, **kwargs
):
10579 IsEmpty(self) -> bool
10581 Returns True if the control is empty or False if it has some items.
10583 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
10585 def GetString(*args
, **kwargs
):
10587 GetString(self, unsigned int n) -> String
10589 Returns the label of the item with the given index.
10591 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
10593 def GetStrings(*args
, **kwargs
):
10594 """GetStrings(self) -> wxArrayString"""
10595 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
10597 def SetString(*args
, **kwargs
):
10599 SetString(self, unsigned int n, String s)
10601 Sets the label for the given item.
10603 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
10605 def FindString(*args
, **kwargs
):
10607 FindString(self, String s) -> int
10609 Finds an item whose label matches the given string. Returns the
10610 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
10613 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
10615 def SetSelection(*args
, **kwargs
):
10617 SetSelection(self, int n)
10619 Sets the item at index 'n' to be the selected item.
10621 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
10623 def GetSelection(*args
, **kwargs
):
10625 GetSelection(self) -> int
10627 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
10630 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
10632 def SetStringSelection(*args
, **kwargs
):
10633 """SetStringSelection(self, String s) -> bool"""
10634 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
10636 def GetStringSelection(*args
, **kwargs
):
10638 GetStringSelection(self) -> String
10640 Returns the label of the selected item or an empty string if no item
10643 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
10645 def Select(*args
, **kwargs
):
10647 Select(self, int n)
10649 This is the same as `SetSelection` and exists only because it is
10650 slightly more natural for controls which support multiple selection.
10652 return _core_
.ItemContainer_Select(*args
, **kwargs
)
10654 ItemContainer_swigregister
= _core_
.ItemContainer_swigregister
10655 ItemContainer_swigregister(ItemContainer
)
10657 #---------------------------------------------------------------------------
10659 class ControlWithItems(Control
,ItemContainer
):
10661 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
10662 wx.Control class, and is used for the base class of various controls
10665 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10666 def __init__(self
): raise AttributeError, "No constructor defined"
10667 __repr__
= _swig_repr
10668 ControlWithItems_swigregister
= _core_
.ControlWithItems_swigregister
10669 ControlWithItems_swigregister(ControlWithItems
)
10671 #---------------------------------------------------------------------------
10673 class SizerItem(Object
):
10675 The wx.SizerItem class is used to track the position, size and other
10676 attributes of each item managed by a `wx.Sizer`. In normal usage user
10677 code should never need to deal directly with a wx.SizerItem, but
10678 custom classes derived from `wx.PySizer` will probably need to use the
10679 collection of wx.SizerItems held by wx.Sizer when calculating layout.
10681 :see: `wx.Sizer`, `wx.GBSizerItem`
10683 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10684 __repr__
= _swig_repr
10685 def __init__(self
, *args
, **kwargs
):
10687 __init__(self) -> SizerItem
10689 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
10690 size will need to be set before this item can be used in a Sizer.
10692 You will probably never need to create a wx.SizerItem directly as they
10693 are created automatically when the sizer's Add, Insert or Prepend
10694 methods are called.
10696 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
10698 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
10699 __swig_destroy__
= _core_
.delete_SizerItem
10700 __del__
= lambda self
: None;
10701 def DeleteWindows(*args
, **kwargs
):
10703 DeleteWindows(self)
10705 Destroy the window or the windows in a subsizer, depending on the type
10708 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
10710 def DetachSizer(*args
, **kwargs
):
10714 Enable deleting the SizerItem without destroying the contained sizer.
10716 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
10718 def GetSize(*args
, **kwargs
):
10720 GetSize(self) -> Size
10722 Get the current size of the item, as set in the last Layout.
10724 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
10726 def CalcMin(*args
, **kwargs
):
10728 CalcMin(self) -> Size
10730 Calculates the minimum desired size for the item, including any space
10733 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
10735 def SetDimension(*args
, **kwargs
):
10737 SetDimension(self, Point pos, Size size)
10739 Set the position and size of the space allocated for this item by the
10740 sizer, and adjust the position and size of the item (window or
10741 subsizer) to be within that space taking alignment and borders into
10744 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
10746 def GetMinSize(*args
, **kwargs
):
10748 GetMinSize(self) -> Size
10750 Get the minimum size needed for the item.
10752 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
10754 def GetMinSizeWithBorder(*args
, **kwargs
):
10756 GetMinSizeWithBorder(self) -> Size
10758 Get the minimum size needed for the item with space for the borders
10761 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
10763 def SetInitSize(*args
, **kwargs
):
10764 """SetInitSize(self, int x, int y)"""
10765 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
10767 def SetRatioWH(*args
, **kwargs
):
10769 SetRatioWH(self, int width, int height)
10771 Set the ratio item attribute.
10773 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
10775 def SetRatioSize(*args
, **kwargs
):
10777 SetRatioSize(self, Size size)
10779 Set the ratio item attribute.
10781 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
10783 def SetRatio(*args
, **kwargs
):
10785 SetRatio(self, float ratio)
10787 Set the ratio item attribute.
10789 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
10791 def GetRatio(*args
, **kwargs
):
10793 GetRatio(self) -> float
10795 Set the ratio item attribute.
10797 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
10799 def GetRect(*args
, **kwargs
):
10801 GetRect(self) -> Rect
10803 Returns the rectangle that the sizer item should occupy
10805 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
10807 def IsWindow(*args
, **kwargs
):
10809 IsWindow(self) -> bool
10811 Is this sizer item a window?
10813 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
10815 def IsSizer(*args
, **kwargs
):
10817 IsSizer(self) -> bool
10819 Is this sizer item a subsizer?
10821 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
10823 def IsSpacer(*args
, **kwargs
):
10825 IsSpacer(self) -> bool
10827 Is this sizer item a spacer?
10829 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
10831 def SetProportion(*args
, **kwargs
):
10833 SetProportion(self, int proportion)
10835 Set the proportion value for this item.
10837 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
10839 def GetProportion(*args
, **kwargs
):
10841 GetProportion(self) -> int
10843 Get the proportion value for this item.
10845 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
10847 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
10848 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
10849 def SetFlag(*args
, **kwargs
):
10851 SetFlag(self, int flag)
10853 Set the flag value for this item.
10855 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
10857 def GetFlag(*args
, **kwargs
):
10859 GetFlag(self) -> int
10861 Get the flag value for this item.
10863 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
10865 def SetBorder(*args
, **kwargs
):
10867 SetBorder(self, int border)
10869 Set the border value for this item.
10871 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
10873 def GetBorder(*args
, **kwargs
):
10875 GetBorder(self) -> int
10877 Get the border value for this item.
10879 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
10881 def GetWindow(*args
, **kwargs
):
10883 GetWindow(self) -> Window
10885 Get the window (if any) that is managed by this sizer item.
10887 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
10889 def SetWindow(*args
, **kwargs
):
10891 SetWindow(self, Window window)
10893 Set the window to be managed by this sizer item.
10895 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
10897 def GetSizer(*args
, **kwargs
):
10899 GetSizer(self) -> Sizer
10901 Get the subsizer (if any) that is managed by this sizer item.
10903 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
10905 def SetSizer(*args
, **kwargs
):
10907 SetSizer(self, Sizer sizer)
10909 Set the subsizer to be managed by this sizer item.
10911 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
10913 def GetSpacer(*args
, **kwargs
):
10915 GetSpacer(self) -> Size
10917 Get the size of the spacer managed by this sizer item.
10919 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
10921 def SetSpacer(*args
, **kwargs
):
10923 SetSpacer(self, Size size)
10925 Set the size of the spacer to be managed by this sizer item.
10927 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
10929 def Show(*args
, **kwargs
):
10931 Show(self, bool show)
10933 Set the show item attribute, which sizers use to determine if the item
10934 is to be made part of the layout or not. If the item is tracking a
10935 window then it is shown or hidden as needed.
10937 return _core_
.SizerItem_Show(*args
, **kwargs
)
10939 def IsShown(*args
, **kwargs
):
10941 IsShown(self) -> bool
10943 Is the item to be shown in the layout?
10945 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
10947 def GetPosition(*args
, **kwargs
):
10949 GetPosition(self) -> Point
10951 Returns the current position of the item, as set in the last Layout.
10953 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
10955 def GetUserData(*args
, **kwargs
):
10957 GetUserData(self) -> PyObject
10959 Returns the userData associated with this sizer item, or None if there
10962 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
10964 def SetUserData(*args
, **kwargs
):
10966 SetUserData(self, PyObject userData)
10968 Associate a Python object with this sizer item.
10970 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
10972 SizerItem_swigregister
= _core_
.SizerItem_swigregister
10973 SizerItem_swigregister(SizerItem
)
10975 def SizerItemWindow(*args
, **kwargs
):
10977 SizerItemWindow(Window window, int proportion, int flag, int border,
10978 PyObject userData=None) -> SizerItem
10980 Constructs a `wx.SizerItem` for tracking a window.
10982 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
10985 def SizerItemSpacer(*args
, **kwargs
):
10987 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
10988 PyObject userData=None) -> SizerItem
10990 Constructs a `wx.SizerItem` for tracking a spacer.
10992 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
10995 def SizerItemSizer(*args
, **kwargs
):
10997 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
10998 PyObject userData=None) -> SizerItem
11000 Constructs a `wx.SizerItem` for tracking a subsizer
11002 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11005 class Sizer(Object
):
11007 wx.Sizer is the abstract base class used for laying out subwindows in
11008 a window. You cannot use wx.Sizer directly; instead, you will have to
11009 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11010 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
11011 and `wx.GridBagSizer`.
11013 The concept implemented by sizers in wxWidgets is closely related to
11014 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11015 toolkit or the Qt toolkit. It is based upon the idea of the individual
11016 subwindows reporting their minimal required size and their ability to
11017 get stretched if the size of the parent window has changed. This will
11018 most often mean that the programmer does not set the original size of
11019 a dialog in the beginning, rather the dialog will assigned a sizer and
11020 this sizer will be queried about the recommended size. The sizer in
11021 turn will query its children, which can be normal windows or contorls,
11022 empty space or other sizers, so that a hierarchy of sizers can be
11023 constructed. Note that wxSizer does not derive from wxWindow and thus
11024 do not interfere with tab ordering and requires very little resources
11025 compared to a real window on screen.
11027 What makes sizers so well fitted for use in wxWidgets is the fact that
11028 every control reports its own minimal size and the algorithm can
11029 handle differences in font sizes or different window (dialog item)
11030 sizes on different platforms without problems. If for example the
11031 standard font as well as the overall design of Mac widgets requires
11032 more space than on Windows, then the initial size of a dialog using a
11033 sizer will automatically be bigger on Mac than on Windows.
11035 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11036 def __init__(self
): raise AttributeError, "No constructor defined"
11037 __repr__
= _swig_repr
11038 __swig_destroy__
= _core_
.delete_Sizer
11039 __del__
= lambda self
: None;
11040 def _setOORInfo(*args
, **kwargs
):
11041 """_setOORInfo(self, PyObject _self)"""
11042 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11044 def Add(*args
, **kwargs
):
11046 Add(self, item, int proportion=0, int flag=0, int border=0,
11047 PyObject userData=None) -> wx.SizerItem
11049 Appends a child item to the sizer.
11051 return _core_
.Sizer_Add(*args
, **kwargs
)
11053 def Insert(*args
, **kwargs
):
11055 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11056 PyObject userData=None) -> wx.SizerItem
11058 Inserts a new item into the list of items managed by this sizer before
11059 the item at index *before*. See `Add` for a description of the parameters.
11061 return _core_
.Sizer_Insert(*args
, **kwargs
)
11063 def Prepend(*args
, **kwargs
):
11065 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11066 PyObject userData=None) -> wx.SizerItem
11068 Adds a new item to the begining of the list of sizer items managed by
11069 this sizer. See `Add` for a description of the parameters.
11071 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11073 def Remove(*args
, **kwargs
):
11075 Remove(self, item) -> bool
11077 Removes an item from the sizer and destroys it. This method does not
11078 cause any layout or resizing to take place, call `Layout` to update
11079 the layout on screen after removing a child from the sizer. The
11080 *item* parameter can be either a window, a sizer, or the zero-based
11081 index of an item to remove. Returns True if the child item was found
11084 return _core_
.Sizer_Remove(*args
, **kwargs
)
11086 def Detach(*args
, **kwargs
):
11088 Detach(self, item) -> bool
11090 Detaches an item from the sizer without destroying it. This method
11091 does not cause any layout or resizing to take place, call `Layout` to
11092 do so. The *item* parameter can be either a window, a sizer, or the
11093 zero-based index of the item to be detached. Returns True if the child item
11094 was found and detached.
11096 return _core_
.Sizer_Detach(*args
, **kwargs
)
11098 def GetItem(*args
, **kwargs
):
11100 GetItem(self, item) -> wx.SizerItem
11102 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11103 parameter can be either a window, a sizer, or the zero-based index of
11104 the item to be found.
11106 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11108 def _SetItemMinSize(*args
, **kwargs
):
11109 """_SetItemMinSize(self, PyObject item, Size size)"""
11110 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11112 def SetItemMinSize(self
, item
, *args
):
11114 SetItemMinSize(self, item, Size size)
11116 Sets the minimum size that will be allocated for an item in the sizer.
11117 The *item* parameter can be either a window, a sizer, or the
11118 zero-based index of the item. If a window or sizer is given then it
11119 will be searched for recursivly in subsizers if neccessary.
11122 # for backward compatibility accept separate width,height args too
11123 return self
._SetItemMinSize
(item
, args
)
11125 return self
._SetItemMinSize
(item
, args
[0])
11127 def AddItem(*args
, **kwargs
):
11129 AddItem(self, SizerItem item)
11131 Adds a `wx.SizerItem` to the sizer.
11133 return _core_
.Sizer_AddItem(*args
, **kwargs
)
11135 def InsertItem(*args
, **kwargs
):
11137 InsertItem(self, int index, SizerItem item)
11139 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11141 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
11143 def PrependItem(*args
, **kwargs
):
11145 PrependItem(self, SizerItem item)
11147 Prepends a `wx.SizerItem` to the sizer.
11149 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
11151 def AddMany(self
, items
):
11153 AddMany is a convenience method for adding several items
11154 to a sizer at one time. Simply pass it a list of tuples,
11155 where each tuple consists of the parameters that you
11156 would normally pass to the `Add` method.
11159 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
11163 # for backwards compatibility only, please do not use in new code
11164 def AddWindow(self
, *args
, **kw
):
11165 """Compatibility alias for `Add`."""
11166 return self
.Add(*args
, **kw
)
11167 def AddSizer(self
, *args
, **kw
):
11168 """Compatibility alias for `Add`."""
11169 return self
.Add(*args
, **kw
)
11170 def AddSpacer(self
, *args
, **kw
):
11171 """Compatibility alias for `Add`."""
11172 return self
.Add(*args
, **kw
)
11174 def PrependWindow(self
, *args
, **kw
):
11175 """Compatibility alias for `Prepend`."""
11176 return self
.Prepend(*args
, **kw
)
11177 def PrependSizer(self
, *args
, **kw
):
11178 """Compatibility alias for `Prepend`."""
11179 return self
.Prepend(*args
, **kw
)
11180 def PrependSpacer(self
, *args
, **kw
):
11181 """Compatibility alias for `Prepend`."""
11182 return self
.Prepend(*args
, **kw
)
11184 def InsertWindow(self
, *args
, **kw
):
11185 """Compatibility alias for `Insert`."""
11186 return self
.Insert(*args
, **kw
)
11187 def InsertSizer(self
, *args
, **kw
):
11188 """Compatibility alias for `Insert`."""
11189 return self
.Insert(*args
, **kw
)
11190 def InsertSpacer(self
, *args
, **kw
):
11191 """Compatibility alias for `Insert`."""
11192 return self
.Insert(*args
, **kw
)
11194 def RemoveWindow(self
, *args
, **kw
):
11195 """Compatibility alias for `Remove`."""
11196 return self
.Remove(*args
, **kw
)
11197 def RemoveSizer(self
, *args
, **kw
):
11198 """Compatibility alias for `Remove`."""
11199 return self
.Remove(*args
, **kw
)
11200 def RemovePos(self
, *args
, **kw
):
11201 """Compatibility alias for `Remove`."""
11202 return self
.Remove(*args
, **kw
)
11205 def SetDimension(*args
, **kwargs
):
11207 SetDimension(self, int x, int y, int width, int height)
11209 Call this to force the sizer to take the given dimension and thus
11210 force the items owned by the sizer to resize themselves according to
11211 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11214 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
11216 def SetMinSize(*args
, **kwargs
):
11218 SetMinSize(self, Size size)
11220 Call this to give the sizer a minimal size. Normally, the sizer will
11221 calculate its minimal size based purely on how much space its children
11222 need. After calling this method `GetMinSize` will return either the
11223 minimal size as requested by its children or the minimal size set
11224 here, depending on which is bigger.
11226 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
11228 def GetSize(*args
, **kwargs
):
11230 GetSize(self) -> Size
11232 Returns the current size of the space managed by the sizer.
11234 return _core_
.Sizer_GetSize(*args
, **kwargs
)
11236 def GetPosition(*args
, **kwargs
):
11238 GetPosition(self) -> Point
11240 Returns the current position of the sizer's managed space.
11242 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
11244 def GetMinSize(*args
, **kwargs
):
11246 GetMinSize(self) -> Size
11248 Returns the minimal size of the sizer. This is either the combined
11249 minimal size of all the children and their borders or the minimal size
11250 set by SetMinSize, depending on which is bigger.
11252 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
11254 def GetSizeTuple(self
):
11255 return self
.GetSize().Get()
11256 def GetPositionTuple(self
):
11257 return self
.GetPosition().Get()
11258 def GetMinSizeTuple(self
):
11259 return self
.GetMinSize().Get()
11261 def RecalcSizes(*args
, **kwargs
):
11265 Using the sizes calculated by `CalcMin` reposition and resize all the
11266 items managed by this sizer. You should not need to call this directly as
11267 it is called by `Layout`.
11269 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
11271 def CalcMin(*args
, **kwargs
):
11273 CalcMin(self) -> Size
11275 This method is where the sizer will do the actual calculation of its
11276 children's minimal sizes. You should not need to call this directly as
11277 it is called by `Layout`.
11279 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
11281 def Layout(*args
, **kwargs
):
11285 This method will force the recalculation and layout of the items
11286 controlled by the sizer using the current space allocated to the
11287 sizer. Normally this is called automatically from the owning window's
11288 EVT_SIZE handler, but it is also useful to call it from user code when
11289 one of the items in a sizer change size, or items are added or
11292 return _core_
.Sizer_Layout(*args
, **kwargs
)
11294 def Fit(*args
, **kwargs
):
11296 Fit(self, Window window) -> Size
11298 Tell the sizer to resize the *window* to match the sizer's minimal
11299 size. This is commonly done in the constructor of the window itself in
11300 order to set its initial size to match the needs of the children as
11301 determined by the sizer. Returns the new size.
11303 For a top level window this is the total window size, not the client size.
11305 return _core_
.Sizer_Fit(*args
, **kwargs
)
11307 def FitInside(*args
, **kwargs
):
11309 FitInside(self, Window window)
11311 Tell the sizer to resize the *virtual size* of the *window* to match the
11312 sizer's minimal size. This will not alter the on screen size of the
11313 window, but may cause the addition/removal/alteration of scrollbars
11314 required to view the virtual area in windows which manage it.
11316 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11319 return _core_
.Sizer_FitInside(*args
, **kwargs
)
11321 def SetSizeHints(*args
, **kwargs
):
11323 SetSizeHints(self, Window window)
11325 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11326 match the sizer's minimal size. This is commonly done in the
11327 constructor of the window itself if the window is resizable (as are
11328 many dialogs under Unix and frames on probably all platforms) in order
11329 to prevent the window from being sized smaller than the minimal size
11330 required by the sizer.
11332 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
11334 def SetVirtualSizeHints(*args
, **kwargs
):
11336 SetVirtualSizeHints(self, Window window)
11338 Tell the sizer to set the minimal size of the window virtual area to
11339 match the sizer's minimal size. For windows with managed scrollbars
11340 this will set them appropriately.
11342 :see: `wx.ScrolledWindow.SetScrollbars`
11345 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
11347 def Clear(*args
, **kwargs
):
11349 Clear(self, bool deleteWindows=False)
11351 Clear all items from the sizer, optionally destroying the window items
11354 return _core_
.Sizer_Clear(*args
, **kwargs
)
11356 def DeleteWindows(*args
, **kwargs
):
11358 DeleteWindows(self)
11360 Destroy all windows managed by the sizer.
11362 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
11364 def GetChildren(*args
, **kwargs
):
11366 GetChildren(self) -> list
11368 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11370 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
11372 def Show(*args
, **kwargs
):
11374 Show(self, item, bool show=True, bool recursive=false) -> bool
11376 Shows or hides an item managed by the sizer. To make a sizer item
11377 disappear or reappear, use Show followed by `Layout`. The *item*
11378 parameter can be either a window, a sizer, or the zero-based index of
11379 the item. Use the recursive parameter to show or hide an item in a
11380 subsizer. Returns True if the item was found.
11382 return _core_
.Sizer_Show(*args
, **kwargs
)
11384 def IsShown(*args
, **kwargs
):
11386 IsShown(self, item)
11388 Determines if the item is currently shown. To make a sizer
11389 item disappear or reappear, use Show followed by `Layout`. The *item*
11390 parameter can be either a window, a sizer, or the zero-based index of
11393 return _core_
.Sizer_IsShown(*args
, **kwargs
)
11395 def Hide(self
, item
, recursive
=False):
11397 A convenience method for `Show` (item, False, recursive).
11399 return self
.Show(item
, False, recursive
)
11401 def ShowItems(*args
, **kwargs
):
11403 ShowItems(self, bool show)
11405 Recursively call `wx.SizerItem.Show` on all sizer items.
11407 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
11409 Sizer_swigregister
= _core_
.Sizer_swigregister
11410 Sizer_swigregister(Sizer
)
11412 class PySizer(Sizer
):
11414 wx.PySizer is a special version of `wx.Sizer` that has been
11415 instrumented to allow the C++ virtual methods to be overloaded in
11416 Python derived classes. You would derive from this class if you are
11417 wanting to implement a custom sizer in Python code. Simply implement
11418 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
11421 class MySizer(wx.PySizer):
11422 def __init__(self):
11423 wx.PySizer.__init__(self)
11426 for item in self.GetChildren():
11427 # calculate the total minimum width and height needed
11428 # by all items in the sizer according to this sizer's
11429 # layout algorithm.
11431 return wx.Size(width, height)
11433 def RecalcSizes(self):
11434 # find the space allotted to this sizer
11435 pos = self.GetPosition()
11436 size = self.GetSize()
11437 for item in self.GetChildren():
11438 # Recalculate (if necessary) the position and size of
11439 # each item and then call item.SetDimension to do the
11440 # actual positioning and sizing of the items within the
11441 # space alloted to this sizer.
11443 item.SetDimension(itemPos, itemSize)
11446 When `Layout` is called it first calls `CalcMin` followed by
11447 `RecalcSizes` so you can optimize a bit by saving the results of
11448 `CalcMin` and reusing them in `RecalcSizes`.
11450 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
11454 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11455 __repr__
= _swig_repr
11456 def __init__(self
, *args
, **kwargs
):
11458 __init__(self) -> PySizer
11460 Creates a wx.PySizer. Must be called from the __init__ in the derived
11463 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
11464 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
11466 def _setCallbackInfo(*args
, **kwargs
):
11467 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
11468 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
11470 PySizer_swigregister
= _core_
.PySizer_swigregister
11471 PySizer_swigregister(PySizer
)
11473 #---------------------------------------------------------------------------
11475 class BoxSizer(Sizer
):
11477 The basic idea behind a box sizer is that windows will most often be
11478 laid out in rather simple basic geometry, typically in a row or a
11479 column or nested hierarchies of either. A wx.BoxSizer will lay out
11480 its items in a simple row or column, depending on the orientation
11481 parameter passed to the constructor.
11483 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11484 __repr__
= _swig_repr
11485 def __init__(self
, *args
, **kwargs
):
11487 __init__(self, int orient=HORIZONTAL) -> BoxSizer
11489 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
11490 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
11493 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
11494 self
._setOORInfo
(self
)
11496 def GetOrientation(*args
, **kwargs
):
11498 GetOrientation(self) -> int
11500 Returns the current orientation of the sizer.
11502 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
11504 def SetOrientation(*args
, **kwargs
):
11506 SetOrientation(self, int orient)
11508 Resets the orientation of the sizer.
11510 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
11512 BoxSizer_swigregister
= _core_
.BoxSizer_swigregister
11513 BoxSizer_swigregister(BoxSizer
)
11515 #---------------------------------------------------------------------------
11517 class StaticBoxSizer(BoxSizer
):
11519 wx.StaticBoxSizer derives from and functions identically to the
11520 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
11521 manages. Note that this static box must be created separately and
11522 passed to the sizer constructor.
11524 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11525 __repr__
= _swig_repr
11526 def __init__(self
, *args
, **kwargs
):
11528 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
11530 Constructor. It takes an associated static box and the orientation
11531 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
11534 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
11535 self
._setOORInfo
(self
)
11537 def GetStaticBox(*args
, **kwargs
):
11539 GetStaticBox(self) -> StaticBox
11541 Returns the static box associated with this sizer.
11543 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
11545 StaticBoxSizer_swigregister
= _core_
.StaticBoxSizer_swigregister
11546 StaticBoxSizer_swigregister(StaticBoxSizer
)
11548 #---------------------------------------------------------------------------
11550 class GridSizer(Sizer
):
11552 A grid sizer is a sizer which lays out its children in a
11553 two-dimensional table with all cells having the same size. In other
11554 words, the width of each cell within the grid is the width of the
11555 widest item added to the sizer and the height of each grid cell is the
11556 height of the tallest item. An optional vertical and/or horizontal
11557 gap between items can also be specified (in pixels.)
11559 Items are placed in the cells of the grid in the order they are added,
11560 in row-major order. In other words, the first row is filled first,
11561 then the second, and so on until all items have been added. (If
11562 neccessary, additional rows will be added as items are added.) If you
11563 need to have greater control over the cells that items are placed in
11564 then use the `wx.GridBagSizer`.
11567 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11568 __repr__
= _swig_repr
11569 def __init__(self
, *args
, **kwargs
):
11571 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
11573 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
11574 of columns and rows in the sizer - if either of the parameters is
11575 zero, it will be calculated to from the total number of children in
11576 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11577 define extra space between all children.
11579 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
11580 self
._setOORInfo
(self
)
11582 def SetCols(*args
, **kwargs
):
11584 SetCols(self, int cols)
11586 Sets the number of columns in the sizer.
11588 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
11590 def SetRows(*args
, **kwargs
):
11592 SetRows(self, int rows)
11594 Sets the number of rows in the sizer.
11596 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
11598 def SetVGap(*args
, **kwargs
):
11600 SetVGap(self, int gap)
11602 Sets the vertical gap (in pixels) between the cells in the sizer.
11604 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
11606 def SetHGap(*args
, **kwargs
):
11608 SetHGap(self, int gap)
11610 Sets the horizontal gap (in pixels) between cells in the sizer
11612 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
11614 def GetCols(*args
, **kwargs
):
11616 GetCols(self) -> int
11618 Returns the number of columns in the sizer.
11620 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
11622 def GetRows(*args
, **kwargs
):
11624 GetRows(self) -> int
11626 Returns the number of rows in the sizer.
11628 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
11630 def GetVGap(*args
, **kwargs
):
11632 GetVGap(self) -> int
11634 Returns the vertical gap (in pixels) between the cells in the sizer.
11636 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
11638 def GetHGap(*args
, **kwargs
):
11640 GetHGap(self) -> int
11642 Returns the horizontal gap (in pixels) between cells in the sizer.
11644 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
11646 def CalcRowsCols(self
):
11648 CalcRowsCols() -> (rows, cols)
11650 Calculates how many rows and columns will be in the sizer based
11651 on the current number of items and also the rows, cols specified
11652 in the constructor.
11654 nitems
= len(self
.GetChildren())
11655 rows
= self
.GetRows()
11656 cols
= self
.GetCols()
11657 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
11659 rows
= (nitems
+ cols
- 1) / cols
11661 cols
= (nitems
+ rows
- 1) / rows
11662 return (rows
, cols
)
11664 GridSizer_swigregister
= _core_
.GridSizer_swigregister
11665 GridSizer_swigregister(GridSizer
)
11667 #---------------------------------------------------------------------------
11669 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
11670 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
11671 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
11672 class FlexGridSizer(GridSizer
):
11674 A flex grid sizer is a sizer which lays out its children in a
11675 two-dimensional table with all table cells in one row having the same
11676 height and all cells in one column having the same width, but all
11677 rows or all columns are not necessarily the same height or width as in
11678 the `wx.GridSizer`.
11680 wx.FlexGridSizer can also size items equally in one direction but
11681 unequally ("flexibly") in the other. If the sizer is only flexible
11682 in one direction (this can be changed using `SetFlexibleDirection`), it
11683 needs to be decided how the sizer should grow in the other ("non
11684 flexible") direction in order to fill the available space. The
11685 `SetNonFlexibleGrowMode` method serves this purpose.
11689 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11690 __repr__
= _swig_repr
11691 def __init__(self
, *args
, **kwargs
):
11693 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
11695 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
11696 number of columns and rows in the sizer - if either of the parameters
11697 is zero, it will be calculated to from the total number of children in
11698 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11699 define extra space between all children.
11701 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
11702 self
._setOORInfo
(self
)
11704 def AddGrowableRow(*args
, **kwargs
):
11706 AddGrowableRow(self, size_t idx, int proportion=0)
11708 Specifies that row *idx* (starting from zero) should be grown if there
11709 is extra space available to the sizer.
11711 The *proportion* parameter has the same meaning as the stretch factor
11712 for the box sizers except that if all proportions are 0, then all
11713 columns are resized equally (instead of not being resized at all).
11715 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
11717 def RemoveGrowableRow(*args
, **kwargs
):
11719 RemoveGrowableRow(self, size_t idx)
11721 Specifies that row *idx* is no longer growable.
11723 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
11725 def AddGrowableCol(*args
, **kwargs
):
11727 AddGrowableCol(self, size_t idx, int proportion=0)
11729 Specifies that column *idx* (starting from zero) should be grown if
11730 there is extra space available to the sizer.
11732 The *proportion* parameter has the same meaning as the stretch factor
11733 for the box sizers except that if all proportions are 0, then all
11734 columns are resized equally (instead of not being resized at all).
11736 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
11738 def RemoveGrowableCol(*args
, **kwargs
):
11740 RemoveGrowableCol(self, size_t idx)
11742 Specifies that column *idx* is no longer growable.
11744 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
11746 def SetFlexibleDirection(*args
, **kwargs
):
11748 SetFlexibleDirection(self, int direction)
11750 Specifies whether the sizer should flexibly resize its columns, rows,
11751 or both. Argument *direction* can be one of the following values. Any
11752 other value is ignored.
11754 ============== =======================================
11755 wx.VERTICAL Rows are flexibly sized.
11756 wx.HORIZONTAL Columns are flexibly sized.
11757 wx.BOTH Both rows and columns are flexibly sized
11758 (this is the default value).
11759 ============== =======================================
11761 Note that this method does not trigger relayout.
11764 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
11766 def GetFlexibleDirection(*args
, **kwargs
):
11768 GetFlexibleDirection(self) -> int
11770 Returns a value that specifies whether the sizer
11771 flexibly resizes its columns, rows, or both (default).
11773 :see: `SetFlexibleDirection`
11775 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
11777 def SetNonFlexibleGrowMode(*args
, **kwargs
):
11779 SetNonFlexibleGrowMode(self, int mode)
11781 Specifies how the sizer should grow in the non-flexible direction if
11782 there is one (so `SetFlexibleDirection` must have been called
11783 previously). Argument *mode* can be one of the following values:
11785 ========================== =================================================
11786 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
11787 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
11788 `AddGrowableCol` and `AddGrowableRow`. In this
11789 case equal sizing applies to minimum sizes of
11790 columns or rows (this is the default value).
11791 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
11792 the non flexible direction, whether they are
11793 growable or not in the flexbile direction.
11794 ========================== =================================================
11796 Note that this method does not trigger relayout.
11800 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
11802 def GetNonFlexibleGrowMode(*args
, **kwargs
):
11804 GetNonFlexibleGrowMode(self) -> int
11806 Returns the value that specifies how the sizer grows in the
11807 non-flexible direction if there is one.
11809 :see: `SetNonFlexibleGrowMode`
11811 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
11813 def GetRowHeights(*args
, **kwargs
):
11815 GetRowHeights(self) -> list
11817 Returns a list of integers representing the heights of each of the
11820 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
11822 def GetColWidths(*args
, **kwargs
):
11824 GetColWidths(self) -> list
11826 Returns a list of integers representing the widths of each of the
11827 columns in the sizer.
11829 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
11831 FlexGridSizer_swigregister
= _core_
.FlexGridSizer_swigregister
11832 FlexGridSizer_swigregister(FlexGridSizer
)
11834 class StdDialogButtonSizer(BoxSizer
):
11836 A special sizer that knows how to order and position standard buttons
11837 in order to conform to the current platform's standards. You simply
11838 need to add each `wx.Button` to the sizer, and be sure to create the
11839 buttons using the standard ID's. Then call `Realize` and the sizer
11840 will take care of the rest.
11843 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11844 __repr__
= _swig_repr
11845 def __init__(self
, *args
, **kwargs
):
11846 """__init__(self) -> StdDialogButtonSizer"""
11847 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
11848 def AddButton(*args
, **kwargs
):
11850 AddButton(self, wxButton button)
11852 Use this to add the buttons to this sizer. Do not use the `Add`
11853 method in the base class.
11855 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
11857 def Realize(*args
, **kwargs
):
11861 This funciton needs to be called after all the buttons have been added
11862 to the sizer. It will reorder them and position them in a platform
11865 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
11867 def SetAffirmativeButton(*args
, **kwargs
):
11868 """SetAffirmativeButton(self, wxButton button)"""
11869 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
11871 def SetNegativeButton(*args
, **kwargs
):
11872 """SetNegativeButton(self, wxButton button)"""
11873 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
11875 def SetCancelButton(*args
, **kwargs
):
11876 """SetCancelButton(self, wxButton button)"""
11877 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
11879 def GetAffirmativeButton(*args
, **kwargs
):
11880 """GetAffirmativeButton(self) -> wxButton"""
11881 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
11883 def GetApplyButton(*args
, **kwargs
):
11884 """GetApplyButton(self) -> wxButton"""
11885 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
11887 def GetNegativeButton(*args
, **kwargs
):
11888 """GetNegativeButton(self) -> wxButton"""
11889 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
11891 def GetCancelButton(*args
, **kwargs
):
11892 """GetCancelButton(self) -> wxButton"""
11893 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
11895 def GetHelpButton(*args
, **kwargs
):
11896 """GetHelpButton(self) -> wxButton"""
11897 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
11899 StdDialogButtonSizer_swigregister
= _core_
.StdDialogButtonSizer_swigregister
11900 StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
11902 #---------------------------------------------------------------------------
11904 class GBPosition(object):
11906 This class represents the position of an item in a virtual grid of
11907 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11908 typemaps that will automatically convert from a 2-element sequence of
11909 integers to a wx.GBPosition, so you can use the more pythonic
11910 representation of the position nearly transparently in Python code.
11912 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11913 __repr__
= _swig_repr
11914 def __init__(self
, *args
, **kwargs
):
11916 __init__(self, int row=0, int col=0) -> GBPosition
11918 This class represents the position of an item in a virtual grid of
11919 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11920 typemaps that will automatically convert from a 2-element sequence of
11921 integers to a wx.GBPosition, so you can use the more pythonic
11922 representation of the position nearly transparently in Python code.
11924 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
11925 __swig_destroy__
= _core_
.delete_GBPosition
11926 __del__
= lambda self
: None;
11927 def GetRow(*args
, **kwargs
):
11928 """GetRow(self) -> int"""
11929 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
11931 def GetCol(*args
, **kwargs
):
11932 """GetCol(self) -> int"""
11933 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
11935 def SetRow(*args
, **kwargs
):
11936 """SetRow(self, int row)"""
11937 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
11939 def SetCol(*args
, **kwargs
):
11940 """SetCol(self, int col)"""
11941 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
11943 def __eq__(*args
, **kwargs
):
11944 """__eq__(self, GBPosition other) -> bool"""
11945 return _core_
.GBPosition___eq__(*args
, **kwargs
)
11947 def __ne__(*args
, **kwargs
):
11948 """__ne__(self, GBPosition other) -> bool"""
11949 return _core_
.GBPosition___ne__(*args
, **kwargs
)
11951 def Set(*args
, **kwargs
):
11952 """Set(self, int row=0, int col=0)"""
11953 return _core_
.GBPosition_Set(*args
, **kwargs
)
11955 def Get(*args
, **kwargs
):
11956 """Get(self) -> PyObject"""
11957 return _core_
.GBPosition_Get(*args
, **kwargs
)
11959 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
11960 def __str__(self
): return str(self
.Get())
11961 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
11962 def __len__(self
): return len(self
.Get())
11963 def __getitem__(self
, index
): return self
.Get()[index
]
11964 def __setitem__(self
, index
, val
):
11965 if index
== 0: self
.SetRow(val
)
11966 elif index
== 1: self
.SetCol(val
)
11967 else: raise IndexError
11968 def __nonzero__(self
): return self
.Get() != (0,0)
11969 __safe_for_unpickling__
= True
11970 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
11972 row
= property(GetRow
, SetRow
)
11973 col
= property(GetCol
, SetCol
)
11975 GBPosition_swigregister
= _core_
.GBPosition_swigregister
11976 GBPosition_swigregister(GBPosition
)
11978 class GBSpan(object):
11980 This class is used to hold the row and column spanning attributes of
11981 items in a `wx.GridBagSizer`. wxPython has typemaps that will
11982 automatically convert from a 2-element sequence of integers to a
11983 wx.GBSpan, so you can use the more pythonic representation of the span
11984 nearly transparently in Python code.
11987 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11988 __repr__
= _swig_repr
11989 def __init__(self
, *args
, **kwargs
):
11991 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
11993 Construct a new wxGBSpan, optionally setting the rowspan and
11994 colspan. The default is (1,1). (Meaning that the item occupies one
11995 cell in each direction.
11997 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
11998 __swig_destroy__
= _core_
.delete_GBSpan
11999 __del__
= lambda self
: None;
12000 def GetRowspan(*args
, **kwargs
):
12001 """GetRowspan(self) -> int"""
12002 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12004 def GetColspan(*args
, **kwargs
):
12005 """GetColspan(self) -> int"""
12006 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12008 def SetRowspan(*args
, **kwargs
):
12009 """SetRowspan(self, int rowspan)"""
12010 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12012 def SetColspan(*args
, **kwargs
):
12013 """SetColspan(self, int colspan)"""
12014 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12016 def __eq__(*args
, **kwargs
):
12017 """__eq__(self, GBSpan other) -> bool"""
12018 return _core_
.GBSpan___eq__(*args
, **kwargs
)
12020 def __ne__(*args
, **kwargs
):
12021 """__ne__(self, GBSpan other) -> bool"""
12022 return _core_
.GBSpan___ne__(*args
, **kwargs
)
12024 def Set(*args
, **kwargs
):
12025 """Set(self, int rowspan=1, int colspan=1)"""
12026 return _core_
.GBSpan_Set(*args
, **kwargs
)
12028 def Get(*args
, **kwargs
):
12029 """Get(self) -> PyObject"""
12030 return _core_
.GBSpan_Get(*args
, **kwargs
)
12032 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12033 def __str__(self
): return str(self
.Get())
12034 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
12035 def __len__(self
): return len(self
.Get())
12036 def __getitem__(self
, index
): return self
.Get()[index
]
12037 def __setitem__(self
, index
, val
):
12038 if index
== 0: self
.SetRowspan(val
)
12039 elif index
== 1: self
.SetColspan(val
)
12040 else: raise IndexError
12041 def __nonzero__(self
): return self
.Get() != (0,0)
12042 __safe_for_unpickling__
= True
12043 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
12045 rowspan
= property(GetRowspan
, SetRowspan
)
12046 colspan
= property(GetColspan
, SetColspan
)
12048 GBSpan_swigregister
= _core_
.GBSpan_swigregister
12049 GBSpan_swigregister(GBSpan
)
12051 class GBSizerItem(SizerItem
):
12053 The wx.GBSizerItem class is used to track the additional data about
12054 items in a `wx.GridBagSizer` such as the item's position in the grid
12055 and how many rows or columns it spans.
12058 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12059 __repr__
= _swig_repr
12060 def __init__(self
, *args
, **kwargs
):
12062 __init__(self) -> GBSizerItem
12064 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12065 size will need to be set, as well as a position and span before this
12066 item can be used in a Sizer.
12068 You will probably never need to create a wx.GBSizerItem directly as they
12069 are created automatically when the sizer's Add method is called.
12071 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
12072 __swig_destroy__
= _core_
.delete_GBSizerItem
12073 __del__
= lambda self
: None;
12074 def GetPos(*args
, **kwargs
):
12076 GetPos(self) -> GBPosition
12078 Get the grid position of the item
12080 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
12082 def GetPosTuple(self
): return self
.GetPos().Get()
12083 def GetSpan(*args
, **kwargs
):
12085 GetSpan(self) -> GBSpan
12087 Get the row and column spanning of the item
12089 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
12091 def GetSpanTuple(self
): return self
.GetSpan().Get()
12092 def SetPos(*args
, **kwargs
):
12094 SetPos(self, GBPosition pos) -> bool
12096 If the item is already a member of a sizer then first ensure that
12097 there is no other item that would intersect with this one at the new
12098 position, then set the new position. Returns True if the change is
12099 successful and after the next Layout() the item will be moved.
12101 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
12103 def SetSpan(*args
, **kwargs
):
12105 SetSpan(self, GBSpan span) -> bool
12107 If the item is already a member of a sizer then first ensure that
12108 there is no other item that would intersect with this one with its new
12109 spanning size, then set the new spanning. Returns True if the change
12110 is successful and after the next Layout() the item will be resized.
12113 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
12115 def Intersects(*args
, **kwargs
):
12117 Intersects(self, GBSizerItem other) -> bool
12119 Returns True if this item and the other item instersect.
12121 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
12123 def IntersectsPos(*args
, **kwargs
):
12125 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12127 Returns True if the given pos/span would intersect with this item.
12129 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
12131 def GetEndPos(*args
, **kwargs
):
12133 GetEndPos(self) -> GBPosition
12135 Get the row and column of the endpoint of this item.
12137 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
12139 def GetGBSizer(*args
, **kwargs
):
12141 GetGBSizer(self) -> GridBagSizer
12143 Get the sizer this item is a member of.
12145 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
12147 def SetGBSizer(*args
, **kwargs
):
12149 SetGBSizer(self, GridBagSizer sizer)
12151 Set the sizer this item is a member of.
12153 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
12155 GBSizerItem_swigregister
= _core_
.GBSizerItem_swigregister
12156 GBSizerItem_swigregister(GBSizerItem
)
12157 DefaultSpan
= cvar
.DefaultSpan
12159 def GBSizerItemWindow(*args
, **kwargs
):
12161 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12162 int border, PyObject userData=None) -> GBSizerItem
12164 Construct a `wx.GBSizerItem` for a window.
12166 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
12169 def GBSizerItemSizer(*args
, **kwargs
):
12171 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12172 int border, PyObject userData=None) -> GBSizerItem
12174 Construct a `wx.GBSizerItem` for a sizer
12176 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
12179 def GBSizerItemSpacer(*args
, **kwargs
):
12181 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12182 int flag, int border, PyObject userData=None) -> GBSizerItem
12184 Construct a `wx.GBSizerItem` for a spacer.
12186 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
12189 class GridBagSizer(FlexGridSizer
):
12191 A `wx.Sizer` that can lay out items in a virtual grid like a
12192 `wx.FlexGridSizer` but in this case explicit positioning of the items
12193 is allowed using `wx.GBPosition`, and items can optionally span more
12194 than one row and/or column using `wx.GBSpan`. The total size of the
12195 virtual grid is determined by the largest row and column that items are
12196 positioned at, adjusted for spanning.
12199 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12200 __repr__
= _swig_repr
12201 def __init__(self
, *args
, **kwargs
):
12203 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12205 Constructor, with optional parameters to specify the gap between the
12208 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
12209 self
._setOORInfo
(self
)
12211 def Add(*args
, **kwargs
):
12213 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12214 int border=0, userData=None) -> wx.GBSizerItem
12216 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12217 more than one row or column as specified with *span*. The remaining
12218 args behave similarly to `wx.Sizer.Add`.
12220 Returns True if the item was successfully placed at the given cell
12221 position, False if something was already there.
12224 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
12226 def AddItem(*args
, **kwargs
):
12228 Add(self, GBSizerItem item) -> wx.GBSizerItem
12230 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12231 the item was successfully placed at its given cell position, False if
12232 something was already there.
12234 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
12236 def GetCellSize(*args
, **kwargs
):
12238 GetCellSize(self, int row, int col) -> Size
12240 Get the size of the specified cell, including hgap and
12241 vgap. Only valid after a Layout.
12243 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
12245 def GetEmptyCellSize(*args
, **kwargs
):
12247 GetEmptyCellSize(self) -> Size
12249 Get the size used for cells in the grid with no item.
12251 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
12253 def SetEmptyCellSize(*args
, **kwargs
):
12255 SetEmptyCellSize(self, Size sz)
12257 Set the size used for cells in the grid with no item.
12259 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
12261 def GetItemPosition(*args
):
12263 GetItemPosition(self, item) -> GBPosition
12265 Get the grid position of the specified *item* where *item* is either a
12266 window or subsizer that is a member of this sizer, or a zero-based
12269 return _core_
.GridBagSizer_GetItemPosition(*args
)
12271 def SetItemPosition(*args
):
12273 SetItemPosition(self, item, GBPosition pos) -> bool
12275 Set the grid position of the specified *item* where *item* is either a
12276 window or subsizer that is a member of this sizer, or a zero-based
12277 index of an item. Returns True on success. If the move is not
12278 allowed (because an item is already there) then False is returned.
12281 return _core_
.GridBagSizer_SetItemPosition(*args
)
12283 def GetItemSpan(*args
):
12285 GetItemSpan(self, item) -> GBSpan
12287 Get the row/col spanning of the specified *item* where *item* is
12288 either a window or subsizer that is a member of this sizer, or a
12289 zero-based index of an item.
12291 return _core_
.GridBagSizer_GetItemSpan(*args
)
12293 def SetItemSpan(*args
):
12295 SetItemSpan(self, item, GBSpan span) -> bool
12297 Set the row/col spanning of the specified *item* where *item* is
12298 either a window or subsizer that is a member of this sizer, or a
12299 zero-based index of an item. Returns True on success. If the move is
12300 not allowed (because an item is already there) then False is returned.
12302 return _core_
.GridBagSizer_SetItemSpan(*args
)
12304 def FindItem(*args
):
12306 FindItem(self, item) -> GBSizerItem
12308 Find the sizer item for the given window or subsizer, returns None if
12309 not found. (non-recursive)
12311 return _core_
.GridBagSizer_FindItem(*args
)
12313 def FindItemAtPosition(*args
, **kwargs
):
12315 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12317 Return the sizer item for the given grid cell, or None if there is no
12318 item at that position. (non-recursive)
12320 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
12322 def FindItemAtPoint(*args
, **kwargs
):
12324 FindItemAtPoint(self, Point pt) -> GBSizerItem
12326 Return the sizer item located at the point given in *pt*, or None if
12327 there is no item at that point. The (x,y) coordinates in pt correspond
12328 to the client coordinates of the window using the sizer for
12329 layout. (non-recursive)
12331 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
12333 def CheckForIntersection(*args
, **kwargs
):
12335 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
12337 Look at all items and see if any intersect (or would overlap) the
12338 given *item*. Returns True if so, False if there would be no overlap.
12339 If an *excludeItem* is given then it will not be checked for
12340 intersection, for example it may be the item we are checking the
12344 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
12346 def CheckForIntersectionPos(*args
, **kwargs
):
12348 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
12350 Look at all items and see if any intersect (or would overlap) the
12351 given position and span. Returns True if so, False if there would be
12352 no overlap. If an *excludeItem* is given then it will not be checked
12353 for intersection, for example it may be the item we are checking the
12356 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
12358 GridBagSizer_swigregister
= _core_
.GridBagSizer_swigregister
12359 GridBagSizer_swigregister(GridBagSizer
)
12361 #---------------------------------------------------------------------------
12365 Right
= _core_
.Right
12366 Bottom
= _core_
.Bottom
12367 Width
= _core_
.Width
12368 Height
= _core_
.Height
12369 Centre
= _core_
.Centre
12370 Center
= _core_
.Center
12371 CentreX
= _core_
.CentreX
12372 CentreY
= _core_
.CentreY
12373 Unconstrained
= _core_
.Unconstrained
12375 PercentOf
= _core_
.PercentOf
12376 Above
= _core_
.Above
12377 Below
= _core_
.Below
12378 LeftOf
= _core_
.LeftOf
12379 RightOf
= _core_
.RightOf
12380 SameAs
= _core_
.SameAs
12381 Absolute
= _core_
.Absolute
12382 class IndividualLayoutConstraint(Object
):
12384 Objects of this class are stored in the `wx.LayoutConstraints` class as
12385 one of eight possible constraints that a window can be involved in.
12386 You will never need to create an instance of
12387 wx.IndividualLayoutConstraint, rather you should create a
12388 `wx.LayoutConstraints` instance and use the individual contstraints
12391 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12392 def __init__(self
): raise AttributeError, "No constructor defined"
12393 __repr__
= _swig_repr
12394 def Set(*args
, **kwargs
):
12396 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
12398 Sets the properties of the constraint. Normally called by one of the
12399 convenience functions such as Above, RightOf, SameAs.
12401 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
12403 def LeftOf(*args
, **kwargs
):
12405 LeftOf(self, Window sibling, int marg=0)
12407 Constrains this edge to be to the left of the given window, with an
12408 optional margin. Implicitly, this is relative to the left edge of the
12411 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
12413 def RightOf(*args
, **kwargs
):
12415 RightOf(self, Window sibling, int marg=0)
12417 Constrains this edge to be to the right of the given window, with an
12418 optional margin. Implicitly, this is relative to the right edge of the
12421 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
12423 def Above(*args
, **kwargs
):
12425 Above(self, Window sibling, int marg=0)
12427 Constrains this edge to be above the given window, with an optional
12428 margin. Implicitly, this is relative to the top edge of the other
12431 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
12433 def Below(*args
, **kwargs
):
12435 Below(self, Window sibling, int marg=0)
12437 Constrains this edge to be below the given window, with an optional
12438 margin. Implicitly, this is relative to the bottom edge of the other
12441 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
12443 def SameAs(*args
, **kwargs
):
12445 SameAs(self, Window otherW, int edge, int marg=0)
12447 Constrains this edge or dimension to be to the same as the edge of the
12448 given window, with an optional margin.
12450 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
12452 def PercentOf(*args
, **kwargs
):
12454 PercentOf(self, Window otherW, int wh, int per)
12456 Constrains this edge or dimension to be to a percentage of the given
12457 window, with an optional margin.
12459 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
12461 def Absolute(*args
, **kwargs
):
12463 Absolute(self, int val)
12465 Constrains this edge or dimension to be the given absolute value.
12467 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
12469 def Unconstrained(*args
, **kwargs
):
12471 Unconstrained(self)
12473 Sets this edge or dimension to be unconstrained, that is, dependent on
12474 other edges and dimensions from which this value can be deduced.
12476 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
12478 def AsIs(*args
, **kwargs
):
12482 Sets this edge or constraint to be whatever the window's value is at
12483 the moment. If either of the width and height constraints are *as is*,
12484 the window will not be resized, but moved instead. This is important
12485 when considering panel items which are intended to have a default
12486 size, such as a button, which may take its size from the size of the
12489 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
12491 def GetOtherWindow(*args
, **kwargs
):
12492 """GetOtherWindow(self) -> Window"""
12493 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
12495 def GetMyEdge(*args
, **kwargs
):
12496 """GetMyEdge(self) -> int"""
12497 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
12499 def SetEdge(*args
, **kwargs
):
12500 """SetEdge(self, int which)"""
12501 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
12503 def SetValue(*args
, **kwargs
):
12504 """SetValue(self, int v)"""
12505 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
12507 def GetMargin(*args
, **kwargs
):
12508 """GetMargin(self) -> int"""
12509 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
12511 def SetMargin(*args
, **kwargs
):
12512 """SetMargin(self, int m)"""
12513 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
12515 def GetValue(*args
, **kwargs
):
12516 """GetValue(self) -> int"""
12517 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
12519 def GetPercent(*args
, **kwargs
):
12520 """GetPercent(self) -> int"""
12521 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
12523 def GetOtherEdge(*args
, **kwargs
):
12524 """GetOtherEdge(self) -> int"""
12525 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
12527 def GetDone(*args
, **kwargs
):
12528 """GetDone(self) -> bool"""
12529 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
12531 def SetDone(*args
, **kwargs
):
12532 """SetDone(self, bool d)"""
12533 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
12535 def GetRelationship(*args
, **kwargs
):
12536 """GetRelationship(self) -> int"""
12537 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
12539 def SetRelationship(*args
, **kwargs
):
12540 """SetRelationship(self, int r)"""
12541 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
12543 def ResetIfWin(*args
, **kwargs
):
12545 ResetIfWin(self, Window otherW) -> bool
12547 Reset constraint if it mentions otherWin
12549 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
12551 def SatisfyConstraint(*args
, **kwargs
):
12553 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
12555 Try to satisfy constraint
12557 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
12559 def GetEdge(*args
, **kwargs
):
12561 GetEdge(self, int which, Window thisWin, Window other) -> int
12563 Get the value of this edge or dimension, or if this
12564 is not determinable, -1.
12566 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
12568 IndividualLayoutConstraint_swigregister
= _core_
.IndividualLayoutConstraint_swigregister
12569 IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
12571 class LayoutConstraints(Object
):
12573 **Note:** constraints are now deprecated and you should use sizers
12576 Objects of this class can be associated with a window to define its
12577 layout constraints, with respect to siblings or its parent.
12579 The class consists of the following eight constraints of class
12580 wx.IndividualLayoutConstraint, some or all of which should be accessed
12581 directly to set the appropriate constraints.
12583 * left: represents the left hand edge of the window
12584 * right: represents the right hand edge of the window
12585 * top: represents the top edge of the window
12586 * bottom: represents the bottom edge of the window
12587 * width: represents the width of the window
12588 * height: represents the height of the window
12589 * centreX: represents the horizontal centre point of the window
12590 * centreY: represents the vertical centre point of the window
12592 Most constraints are initially set to have the relationship
12593 wxUnconstrained, which means that their values should be calculated by
12594 looking at known constraints. The exceptions are width and height,
12595 which are set to wxAsIs to ensure that if the user does not specify a
12596 constraint, the existing width and height will be used, to be
12597 compatible with panel items which often have take a default size. If
12598 the constraint is ``wx.AsIs``, the dimension will not be changed.
12600 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
12603 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12604 __repr__
= _swig_repr
12605 left
= property(_core_
.LayoutConstraints_left_get
)
12606 top
= property(_core_
.LayoutConstraints_top_get
)
12607 right
= property(_core_
.LayoutConstraints_right_get
)
12608 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
12609 width
= property(_core_
.LayoutConstraints_width_get
)
12610 height
= property(_core_
.LayoutConstraints_height_get
)
12611 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
12612 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
12613 def __init__(self
, *args
, **kwargs
):
12614 """__init__(self) -> LayoutConstraints"""
12615 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
12616 __swig_destroy__
= _core_
.delete_LayoutConstraints
12617 __del__
= lambda self
: None;
12618 def SatisfyConstraints(*args
, **kwargs
):
12619 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
12620 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
12622 def AreSatisfied(*args
, **kwargs
):
12623 """AreSatisfied(self) -> bool"""
12624 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
12626 LayoutConstraints_swigregister
= _core_
.LayoutConstraints_swigregister
12627 LayoutConstraints_swigregister(LayoutConstraints
)
12629 #----------------------------------------------------------------------------
12631 # Use Python's bool constants if available, make some if not
12635 __builtins__
.True = 1==1
12636 __builtins__
.False = 1==0
12637 def bool(value
): return not not value
12638 __builtins__
.bool = bool
12642 # workarounds for bad wxRTTI names
12643 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
12644 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
12645 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
12648 #----------------------------------------------------------------------------
12649 # Load version numbers from __version__... Ensure that major and minor
12650 # versions are the same for both wxPython and wxWidgets.
12652 from __version__
import *
12653 __version__
= VERSION_STRING
12655 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
12656 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
12657 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
12659 warnings
.warn("wxPython/wxWidgets release number mismatch")
12661 #----------------------------------------------------------------------------
12663 # Set wxPython's default string<-->unicode conversion encoding from
12664 # the locale, but only if Python's default hasn't been changed. (We
12665 # assume that if the user has customized it already then that is the
12666 # encoding we need to use as well.)
12668 # The encoding selected here is used when string or unicode objects
12669 # need to be converted in order to pass them to wxWidgets. Please be
12670 # aware that the default encoding within the same locale may be
12671 # slightly different on different platforms. For example, please see
12672 # http://www.alanwood.net/demos/charsetdiffs.html for differences
12673 # between the common latin/roman encodings.
12675 default
= _sys
.getdefaultencoding()
12676 if default
== 'ascii':
12680 default
= locale
.getdefaultlocale()[1]
12681 codecs
.lookup(default
)
12682 except (ValueError, LookupError, TypeError):
12683 default
= _sys
.getdefaultencoding()
12687 wx
.SetDefaultPyEncoding(default
)
12690 #----------------------------------------------------------------------------
12692 class PyDeadObjectError(AttributeError):
12695 class _wxPyDeadObject(object):
12697 Instances of wx objects that are OOR capable will have their __class__
12698 changed to this class when the C++ object is deleted. This should help
12699 prevent crashes due to referencing a bogus C++ pointer.
12701 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
12702 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
12704 def __repr__(self
):
12705 if not hasattr(self
, "_name"):
12706 self
._name
= "[unknown]"
12707 return self
.reprStr
% self
._name
12709 def __getattr__(self
, *args
):
12710 if not hasattr(self
, "_name"):
12711 self
._name
= "[unknown]"
12712 raise PyDeadObjectError(self
.attrStr
% self
._name
)
12714 def __nonzero__(self
):
12719 class PyUnbornObjectError(AttributeError):
12722 class _wxPyUnbornObject(object):
12724 Some stock objects are created when the wx._core module is
12725 imported, but their C++ instance is not created until the wx.App
12726 object is created and initialized. These object instances will
12727 temporarily have their __class__ changed to this class so an
12728 exception will be raised if they are used before the C++ instance
12732 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
12733 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
12735 def __repr__(self
):
12736 #if not hasattr(self, "_name"):
12737 # self._name = "[unknown]"
12738 return self
.reprStr
#% self._name
12740 def __getattr__(self
, *args
):
12741 #if not hasattr(self, "_name"):
12742 # self._name = "[unknown]"
12743 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
12745 def __nonzero__(self
):
12749 #----------------------------------------------------------------------------
12751 def CallAfter(callable, *args
, **kw
):
12753 Call the specified function after the current and pending event
12754 handlers have been completed. This is also good for making GUI
12755 method calls from non-GUI threads. Any extra positional or
12756 keyword args are passed on to the callable when it is called.
12758 :see: `wx.FutureCall`
12761 assert app
is not None, 'No wx.App created yet'
12763 if not hasattr(app
, "_CallAfterId"):
12764 app
._CallAfterId
= wx
.NewEventType()
12765 app
.Connect(-1, -1, app
._CallAfterId
,
12766 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
12768 evt
.SetEventType(app
._CallAfterId
)
12769 evt
.callable = callable
12772 wx
.PostEvent(app
, evt
)
12774 #----------------------------------------------------------------------------
12779 A convenience class for `wx.Timer`, that calls the given callable
12780 object once after the given amount of milliseconds, passing any
12781 positional or keyword args. The return value of the callable is
12782 availbale after it has been run with the `GetResult` method.
12784 If you don't need to get the return value or restart the timer
12785 then there is no need to hold a reference to this object. It will
12786 hold a reference to itself while the timer is running (the timer
12787 has a reference to self.Notify) but the cycle will be broken when
12788 the timer completes, automatically cleaning up the wx.FutureCall
12791 :see: `wx.CallAfter`
12793 def __init__(self
, millis
, callable, *args
, **kwargs
):
12794 self
.millis
= millis
12795 self
.callable = callable
12796 self
.SetArgs(*args
, **kwargs
)
12798 self
.running
= False
12799 self
.hasRun
= False
12808 def Start(self
, millis
=None, *args
, **kwargs
):
12810 (Re)start the timer
12812 self
.hasRun
= False
12813 if millis
is not None:
12814 self
.millis
= millis
12816 self
.SetArgs(*args
, **kwargs
)
12818 self
.timer
= wx
.PyTimer(self
.Notify
)
12819 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
12820 self
.running
= True
12826 Stop and destroy the timer.
12828 if self
.timer
is not None:
12833 def GetInterval(self
):
12834 if self
.timer
is not None:
12835 return self
.timer
.GetInterval()
12840 def IsRunning(self
):
12841 return self
.timer
is not None and self
.timer
.IsRunning()
12844 def SetArgs(self
, *args
, **kwargs
):
12846 (Re)set the args passed to the callable object. This is
12847 useful in conjunction with Restart if you want to schedule a
12848 new call to the same callable object but with different
12852 self
.kwargs
= kwargs
12858 def GetResult(self
):
12863 The timer has expired so call the callable.
12865 if self
.callable and getattr(self
.callable, 'im_self', True):
12867 self
.running
= False
12868 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
12870 if not self
.running
:
12871 # if it wasn't restarted, then cleanup
12872 wx
.CallAfter(self
.Stop
)
12876 #----------------------------------------------------------------------------
12877 # Control which items in this module should be documented by epydoc.
12878 # We allow only classes and functions, which will help reduce the size
12879 # of the docs by filtering out the zillions of constants, EVT objects,
12880 # and etc that don't make much sense by themselves, but are instead
12881 # documented (or will be) as part of the classes/functions/methods
12882 # where they should be used.
12886 A filter for epydoc that only allows non-Ptr classes and
12887 fucntions, in order to reduce the clutter in the API docs.
12889 def __init__(self
, globals):
12890 self
._globals
= globals
12892 def __call__(self
, name
):
12894 obj
= self
._globals
.get(name
, None)
12895 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
12897 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
12901 #----------------------------------------------------------------------------
12902 #----------------------------------------------------------------------------
12904 # Import other modules in this package that should show up in the
12905 # "core" wx namespace
12907 from _windows
import *
12908 from _controls
import *
12909 from _misc
import *
12912 # Fixup the stock objects since they can't be used yet. (They will be
12913 # restored in wx.PyApp.OnInit.)
12914 _core_
._wxPyFixStockObjects
()
12916 #----------------------------------------------------------------------------
12917 #----------------------------------------------------------------------------