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 WINDOW_STYLE_MASK
= _core_
.WINDOW_STYLE_MASK
106 ALWAYS_SHOW_SB
= _core_
.ALWAYS_SHOW_SB
107 RETAINED
= _core_
.RETAINED
108 BACKINGSTORE
= _core_
.BACKINGSTORE
109 COLOURED
= _core_
.COLOURED
110 FIXED_LENGTH
= _core_
.FIXED_LENGTH
111 LB_NEEDED_SB
= _core_
.LB_NEEDED_SB
112 LB_ALWAYS_SB
= _core_
.LB_ALWAYS_SB
113 LB_SORT
= _core_
.LB_SORT
114 LB_SINGLE
= _core_
.LB_SINGLE
115 LB_MULTIPLE
= _core_
.LB_MULTIPLE
116 LB_EXTENDED
= _core_
.LB_EXTENDED
117 LB_OWNERDRAW
= _core_
.LB_OWNERDRAW
118 LB_HSCROLL
= _core_
.LB_HSCROLL
119 PROCESS_ENTER
= _core_
.PROCESS_ENTER
120 PASSWORD
= _core_
.PASSWORD
121 CB_SIMPLE
= _core_
.CB_SIMPLE
122 CB_DROPDOWN
= _core_
.CB_DROPDOWN
123 CB_SORT
= _core_
.CB_SORT
124 CB_READONLY
= _core_
.CB_READONLY
125 RA_HORIZONTAL
= _core_
.RA_HORIZONTAL
126 RA_VERTICAL
= _core_
.RA_VERTICAL
127 RA_SPECIFY_ROWS
= _core_
.RA_SPECIFY_ROWS
128 RA_SPECIFY_COLS
= _core_
.RA_SPECIFY_COLS
129 RA_USE_CHECKBOX
= _core_
.RA_USE_CHECKBOX
130 RB_GROUP
= _core_
.RB_GROUP
131 RB_SINGLE
= _core_
.RB_SINGLE
132 SB_HORIZONTAL
= _core_
.SB_HORIZONTAL
133 SB_VERTICAL
= _core_
.SB_VERTICAL
134 RB_USE_CHECKBOX
= _core_
.RB_USE_CHECKBOX
135 ST_SIZEGRIP
= _core_
.ST_SIZEGRIP
136 ST_NO_AUTORESIZE
= _core_
.ST_NO_AUTORESIZE
137 ST_DOTS_MIDDLE
= _core_
.ST_DOTS_MIDDLE
138 ST_DOTS_END
= _core_
.ST_DOTS_END
139 FLOOD_SURFACE
= _core_
.FLOOD_SURFACE
140 FLOOD_BORDER
= _core_
.FLOOD_BORDER
141 ODDEVEN_RULE
= _core_
.ODDEVEN_RULE
142 WINDING_RULE
= _core_
.WINDING_RULE
143 TOOL_TOP
= _core_
.TOOL_TOP
144 TOOL_BOTTOM
= _core_
.TOOL_BOTTOM
145 TOOL_LEFT
= _core_
.TOOL_LEFT
146 TOOL_RIGHT
= _core_
.TOOL_RIGHT
148 YES_NO
= _core_
.YES_NO
149 CANCEL
= _core_
.CANCEL
152 NO_DEFAULT
= _core_
.NO_DEFAULT
153 YES_DEFAULT
= _core_
.YES_DEFAULT
154 ICON_EXCLAMATION
= _core_
.ICON_EXCLAMATION
155 ICON_HAND
= _core_
.ICON_HAND
156 ICON_QUESTION
= _core_
.ICON_QUESTION
157 ICON_INFORMATION
= _core_
.ICON_INFORMATION
158 ICON_STOP
= _core_
.ICON_STOP
159 ICON_ASTERISK
= _core_
.ICON_ASTERISK
160 ICON_MASK
= _core_
.ICON_MASK
161 ICON_WARNING
= _core_
.ICON_WARNING
162 ICON_ERROR
= _core_
.ICON_ERROR
163 FORWARD
= _core_
.FORWARD
164 BACKWARD
= _core_
.BACKWARD
169 SIZE_AUTO_WIDTH
= _core_
.SIZE_AUTO_WIDTH
170 SIZE_AUTO_HEIGHT
= _core_
.SIZE_AUTO_HEIGHT
171 SIZE_AUTO
= _core_
.SIZE_AUTO
172 SIZE_USE_EXISTING
= _core_
.SIZE_USE_EXISTING
173 SIZE_ALLOW_MINUS_ONE
= _core_
.SIZE_ALLOW_MINUS_ONE
174 SIZE_FORCE
= _core_
.SIZE_FORCE
175 PORTRAIT
= _core_
.PORTRAIT
176 LANDSCAPE
= _core_
.LANDSCAPE
177 PRINT_QUALITY_HIGH
= _core_
.PRINT_QUALITY_HIGH
178 PRINT_QUALITY_MEDIUM
= _core_
.PRINT_QUALITY_MEDIUM
179 PRINT_QUALITY_LOW
= _core_
.PRINT_QUALITY_LOW
180 PRINT_QUALITY_DRAFT
= _core_
.PRINT_QUALITY_DRAFT
181 ID_ANY
= _core_
.ID_ANY
182 ID_SEPARATOR
= _core_
.ID_SEPARATOR
183 ID_NONE
= _core_
.ID_NONE
184 ID_LOWEST
= _core_
.ID_LOWEST
185 ID_OPEN
= _core_
.ID_OPEN
186 ID_CLOSE
= _core_
.ID_CLOSE
187 ID_NEW
= _core_
.ID_NEW
188 ID_SAVE
= _core_
.ID_SAVE
189 ID_SAVEAS
= _core_
.ID_SAVEAS
190 ID_REVERT
= _core_
.ID_REVERT
191 ID_EXIT
= _core_
.ID_EXIT
192 ID_UNDO
= _core_
.ID_UNDO
193 ID_REDO
= _core_
.ID_REDO
194 ID_HELP
= _core_
.ID_HELP
195 ID_PRINT
= _core_
.ID_PRINT
196 ID_PRINT_SETUP
= _core_
.ID_PRINT_SETUP
197 ID_PAGE_SETUP
= _core_
.ID_PAGE_SETUP
198 ID_PREVIEW
= _core_
.ID_PREVIEW
199 ID_ABOUT
= _core_
.ID_ABOUT
200 ID_HELP_CONTENTS
= _core_
.ID_HELP_CONTENTS
201 ID_HELP_COMMANDS
= _core_
.ID_HELP_COMMANDS
202 ID_HELP_PROCEDURES
= _core_
.ID_HELP_PROCEDURES
203 ID_HELP_CONTEXT
= _core_
.ID_HELP_CONTEXT
204 ID_HELP_INDEX
= _core_
.ID_HELP_INDEX
205 ID_HELP_SEARCH
= _core_
.ID_HELP_SEARCH
206 ID_CLOSE_ALL
= _core_
.ID_CLOSE_ALL
207 ID_PREFERENCES
= _core_
.ID_PREFERENCES
208 ID_EDIT
= _core_
.ID_EDIT
209 ID_CUT
= _core_
.ID_CUT
210 ID_COPY
= _core_
.ID_COPY
211 ID_PASTE
= _core_
.ID_PASTE
212 ID_CLEAR
= _core_
.ID_CLEAR
213 ID_FIND
= _core_
.ID_FIND
214 ID_DUPLICATE
= _core_
.ID_DUPLICATE
215 ID_SELECTALL
= _core_
.ID_SELECTALL
216 ID_DELETE
= _core_
.ID_DELETE
217 ID_REPLACE
= _core_
.ID_REPLACE
218 ID_REPLACE_ALL
= _core_
.ID_REPLACE_ALL
219 ID_PROPERTIES
= _core_
.ID_PROPERTIES
220 ID_VIEW_DETAILS
= _core_
.ID_VIEW_DETAILS
221 ID_VIEW_LARGEICONS
= _core_
.ID_VIEW_LARGEICONS
222 ID_VIEW_SMALLICONS
= _core_
.ID_VIEW_SMALLICONS
223 ID_VIEW_LIST
= _core_
.ID_VIEW_LIST
224 ID_VIEW_SORTDATE
= _core_
.ID_VIEW_SORTDATE
225 ID_VIEW_SORTNAME
= _core_
.ID_VIEW_SORTNAME
226 ID_VIEW_SORTSIZE
= _core_
.ID_VIEW_SORTSIZE
227 ID_VIEW_SORTTYPE
= _core_
.ID_VIEW_SORTTYPE
228 ID_FILE
= _core_
.ID_FILE
229 ID_FILE1
= _core_
.ID_FILE1
230 ID_FILE2
= _core_
.ID_FILE2
231 ID_FILE3
= _core_
.ID_FILE3
232 ID_FILE4
= _core_
.ID_FILE4
233 ID_FILE5
= _core_
.ID_FILE5
234 ID_FILE6
= _core_
.ID_FILE6
235 ID_FILE7
= _core_
.ID_FILE7
236 ID_FILE8
= _core_
.ID_FILE8
237 ID_FILE9
= _core_
.ID_FILE9
239 ID_CANCEL
= _core_
.ID_CANCEL
240 ID_APPLY
= _core_
.ID_APPLY
241 ID_YES
= _core_
.ID_YES
243 ID_STATIC
= _core_
.ID_STATIC
244 ID_FORWARD
= _core_
.ID_FORWARD
245 ID_BACKWARD
= _core_
.ID_BACKWARD
246 ID_DEFAULT
= _core_
.ID_DEFAULT
247 ID_MORE
= _core_
.ID_MORE
248 ID_SETUP
= _core_
.ID_SETUP
249 ID_RESET
= _core_
.ID_RESET
250 ID_CONTEXT_HELP
= _core_
.ID_CONTEXT_HELP
251 ID_YESTOALL
= _core_
.ID_YESTOALL
252 ID_NOTOALL
= _core_
.ID_NOTOALL
253 ID_ABORT
= _core_
.ID_ABORT
254 ID_RETRY
= _core_
.ID_RETRY
255 ID_IGNORE
= _core_
.ID_IGNORE
256 ID_ADD
= _core_
.ID_ADD
257 ID_REMOVE
= _core_
.ID_REMOVE
259 ID_DOWN
= _core_
.ID_DOWN
260 ID_HOME
= _core_
.ID_HOME
261 ID_REFRESH
= _core_
.ID_REFRESH
262 ID_STOP
= _core_
.ID_STOP
263 ID_INDEX
= _core_
.ID_INDEX
264 ID_BOLD
= _core_
.ID_BOLD
265 ID_ITALIC
= _core_
.ID_ITALIC
266 ID_JUSTIFY_CENTER
= _core_
.ID_JUSTIFY_CENTER
267 ID_JUSTIFY_FILL
= _core_
.ID_JUSTIFY_FILL
268 ID_JUSTIFY_RIGHT
= _core_
.ID_JUSTIFY_RIGHT
269 ID_JUSTIFY_LEFT
= _core_
.ID_JUSTIFY_LEFT
270 ID_UNDERLINE
= _core_
.ID_UNDERLINE
271 ID_INDENT
= _core_
.ID_INDENT
272 ID_UNINDENT
= _core_
.ID_UNINDENT
273 ID_ZOOM_100
= _core_
.ID_ZOOM_100
274 ID_ZOOM_FIT
= _core_
.ID_ZOOM_FIT
275 ID_ZOOM_IN
= _core_
.ID_ZOOM_IN
276 ID_ZOOM_OUT
= _core_
.ID_ZOOM_OUT
277 ID_UNDELETE
= _core_
.ID_UNDELETE
278 ID_REVERT_TO_SAVED
= _core_
.ID_REVERT_TO_SAVED
279 ID_HIGHEST
= _core_
.ID_HIGHEST
280 MENU_TEAROFF
= _core_
.MENU_TEAROFF
281 MB_DOCKABLE
= _core_
.MB_DOCKABLE
282 NO_FULL_REPAINT_ON_RESIZE
= _core_
.NO_FULL_REPAINT_ON_RESIZE
283 FULL_REPAINT_ON_RESIZE
= _core_
.FULL_REPAINT_ON_RESIZE
284 LI_HORIZONTAL
= _core_
.LI_HORIZONTAL
285 LI_VERTICAL
= _core_
.LI_VERTICAL
286 WS_EX_VALIDATE_RECURSIVELY
= _core_
.WS_EX_VALIDATE_RECURSIVELY
287 WS_EX_BLOCK_EVENTS
= _core_
.WS_EX_BLOCK_EVENTS
288 WS_EX_TRANSIENT
= _core_
.WS_EX_TRANSIENT
289 WS_EX_THEMED_BACKGROUND
= _core_
.WS_EX_THEMED_BACKGROUND
290 WS_EX_PROCESS_IDLE
= _core_
.WS_EX_PROCESS_IDLE
291 WS_EX_PROCESS_UI_UPDATES
= _core_
.WS_EX_PROCESS_UI_UPDATES
292 MM_TEXT
= _core_
.MM_TEXT
293 MM_LOMETRIC
= _core_
.MM_LOMETRIC
294 MM_HIMETRIC
= _core_
.MM_HIMETRIC
295 MM_LOENGLISH
= _core_
.MM_LOENGLISH
296 MM_HIENGLISH
= _core_
.MM_HIENGLISH
297 MM_TWIPS
= _core_
.MM_TWIPS
298 MM_ISOTROPIC
= _core_
.MM_ISOTROPIC
299 MM_ANISOTROPIC
= _core_
.MM_ANISOTROPIC
300 MM_POINTS
= _core_
.MM_POINTS
301 MM_METRIC
= _core_
.MM_METRIC
302 CENTRE
= _core_
.CENTRE
303 CENTER
= _core_
.CENTER
304 HORIZONTAL
= _core_
.HORIZONTAL
305 VERTICAL
= _core_
.VERTICAL
312 BOTTOM
= _core_
.BOTTOM
318 ALIGN_NOT
= _core_
.ALIGN_NOT
319 ALIGN_CENTER_HORIZONTAL
= _core_
.ALIGN_CENTER_HORIZONTAL
320 ALIGN_CENTRE_HORIZONTAL
= _core_
.ALIGN_CENTRE_HORIZONTAL
321 ALIGN_LEFT
= _core_
.ALIGN_LEFT
322 ALIGN_TOP
= _core_
.ALIGN_TOP
323 ALIGN_RIGHT
= _core_
.ALIGN_RIGHT
324 ALIGN_BOTTOM
= _core_
.ALIGN_BOTTOM
325 ALIGN_CENTER_VERTICAL
= _core_
.ALIGN_CENTER_VERTICAL
326 ALIGN_CENTRE_VERTICAL
= _core_
.ALIGN_CENTRE_VERTICAL
327 ALIGN_CENTER
= _core_
.ALIGN_CENTER
328 ALIGN_CENTRE
= _core_
.ALIGN_CENTRE
329 ALIGN_MASK
= _core_
.ALIGN_MASK
330 STRETCH_NOT
= _core_
.STRETCH_NOT
331 SHRINK
= _core_
.SHRINK
333 EXPAND
= _core_
.EXPAND
334 SHAPED
= _core_
.SHAPED
335 FIXED_MINSIZE
= _core_
.FIXED_MINSIZE
337 ADJUST_MINSIZE
= _core_
.ADJUST_MINSIZE
338 BORDER_DEFAULT
= _core_
.BORDER_DEFAULT
339 BORDER_NONE
= _core_
.BORDER_NONE
340 BORDER_STATIC
= _core_
.BORDER_STATIC
341 BORDER_SIMPLE
= _core_
.BORDER_SIMPLE
342 BORDER_RAISED
= _core_
.BORDER_RAISED
343 BORDER_SUNKEN
= _core_
.BORDER_SUNKEN
344 BORDER_DOUBLE
= _core_
.BORDER_DOUBLE
345 BORDER_MASK
= _core_
.BORDER_MASK
346 BG_STYLE_SYSTEM
= _core_
.BG_STYLE_SYSTEM
347 BG_STYLE_COLOUR
= _core_
.BG_STYLE_COLOUR
348 BG_STYLE_CUSTOM
= _core_
.BG_STYLE_CUSTOM
349 DEFAULT
= _core_
.DEFAULT
350 DECORATIVE
= _core_
.DECORATIVE
352 SCRIPT
= _core_
.SCRIPT
354 MODERN
= _core_
.MODERN
355 TELETYPE
= _core_
.TELETYPE
356 VARIABLE
= _core_
.VARIABLE
358 NORMAL
= _core_
.NORMAL
361 ITALIC
= _core_
.ITALIC
365 LONG_DASH
= _core_
.LONG_DASH
366 SHORT_DASH
= _core_
.SHORT_DASH
367 DOT_DASH
= _core_
.DOT_DASH
368 USER_DASH
= _core_
.USER_DASH
369 TRANSPARENT
= _core_
.TRANSPARENT
370 STIPPLE
= _core_
.STIPPLE
371 STIPPLE_MASK
= _core_
.STIPPLE_MASK
372 STIPPLE_MASK_OPAQUE
= _core_
.STIPPLE_MASK_OPAQUE
373 BDIAGONAL_HATCH
= _core_
.BDIAGONAL_HATCH
374 CROSSDIAG_HATCH
= _core_
.CROSSDIAG_HATCH
375 FDIAGONAL_HATCH
= _core_
.FDIAGONAL_HATCH
376 CROSS_HATCH
= _core_
.CROSS_HATCH
377 HORIZONTAL_HATCH
= _core_
.HORIZONTAL_HATCH
378 VERTICAL_HATCH
= _core_
.VERTICAL_HATCH
379 JOIN_BEVEL
= _core_
.JOIN_BEVEL
380 JOIN_MITER
= _core_
.JOIN_MITER
381 JOIN_ROUND
= _core_
.JOIN_ROUND
382 CAP_ROUND
= _core_
.CAP_ROUND
383 CAP_PROJECTING
= _core_
.CAP_PROJECTING
384 CAP_BUTT
= _core_
.CAP_BUTT
387 INVERT
= _core_
.INVERT
388 OR_REVERSE
= _core_
.OR_REVERSE
389 AND_REVERSE
= _core_
.AND_REVERSE
392 AND_INVERT
= _core_
.AND_INVERT
396 SRC_INVERT
= _core_
.SRC_INVERT
397 OR_INVERT
= _core_
.OR_INVERT
401 WXK_BACK
= _core_
.WXK_BACK
402 WXK_TAB
= _core_
.WXK_TAB
403 WXK_RETURN
= _core_
.WXK_RETURN
404 WXK_ESCAPE
= _core_
.WXK_ESCAPE
405 WXK_SPACE
= _core_
.WXK_SPACE
406 WXK_DELETE
= _core_
.WXK_DELETE
407 WXK_START
= _core_
.WXK_START
408 WXK_LBUTTON
= _core_
.WXK_LBUTTON
409 WXK_RBUTTON
= _core_
.WXK_RBUTTON
410 WXK_CANCEL
= _core_
.WXK_CANCEL
411 WXK_MBUTTON
= _core_
.WXK_MBUTTON
412 WXK_CLEAR
= _core_
.WXK_CLEAR
413 WXK_SHIFT
= _core_
.WXK_SHIFT
414 WXK_ALT
= _core_
.WXK_ALT
415 WXK_CONTROL
= _core_
.WXK_CONTROL
416 WXK_MENU
= _core_
.WXK_MENU
417 WXK_PAUSE
= _core_
.WXK_PAUSE
418 WXK_CAPITAL
= _core_
.WXK_CAPITAL
419 WXK_PRIOR
= _core_
.WXK_PRIOR
420 WXK_NEXT
= _core_
.WXK_NEXT
421 WXK_END
= _core_
.WXK_END
422 WXK_HOME
= _core_
.WXK_HOME
423 WXK_LEFT
= _core_
.WXK_LEFT
424 WXK_UP
= _core_
.WXK_UP
425 WXK_RIGHT
= _core_
.WXK_RIGHT
426 WXK_DOWN
= _core_
.WXK_DOWN
427 WXK_SELECT
= _core_
.WXK_SELECT
428 WXK_PRINT
= _core_
.WXK_PRINT
429 WXK_EXECUTE
= _core_
.WXK_EXECUTE
430 WXK_SNAPSHOT
= _core_
.WXK_SNAPSHOT
431 WXK_INSERT
= _core_
.WXK_INSERT
432 WXK_HELP
= _core_
.WXK_HELP
433 WXK_NUMPAD0
= _core_
.WXK_NUMPAD0
434 WXK_NUMPAD1
= _core_
.WXK_NUMPAD1
435 WXK_NUMPAD2
= _core_
.WXK_NUMPAD2
436 WXK_NUMPAD3
= _core_
.WXK_NUMPAD3
437 WXK_NUMPAD4
= _core_
.WXK_NUMPAD4
438 WXK_NUMPAD5
= _core_
.WXK_NUMPAD5
439 WXK_NUMPAD6
= _core_
.WXK_NUMPAD6
440 WXK_NUMPAD7
= _core_
.WXK_NUMPAD7
441 WXK_NUMPAD8
= _core_
.WXK_NUMPAD8
442 WXK_NUMPAD9
= _core_
.WXK_NUMPAD9
443 WXK_MULTIPLY
= _core_
.WXK_MULTIPLY
444 WXK_ADD
= _core_
.WXK_ADD
445 WXK_SEPARATOR
= _core_
.WXK_SEPARATOR
446 WXK_SUBTRACT
= _core_
.WXK_SUBTRACT
447 WXK_DECIMAL
= _core_
.WXK_DECIMAL
448 WXK_DIVIDE
= _core_
.WXK_DIVIDE
449 WXK_F1
= _core_
.WXK_F1
450 WXK_F2
= _core_
.WXK_F2
451 WXK_F3
= _core_
.WXK_F3
452 WXK_F4
= _core_
.WXK_F4
453 WXK_F5
= _core_
.WXK_F5
454 WXK_F6
= _core_
.WXK_F6
455 WXK_F7
= _core_
.WXK_F7
456 WXK_F8
= _core_
.WXK_F8
457 WXK_F9
= _core_
.WXK_F9
458 WXK_F10
= _core_
.WXK_F10
459 WXK_F11
= _core_
.WXK_F11
460 WXK_F12
= _core_
.WXK_F12
461 WXK_F13
= _core_
.WXK_F13
462 WXK_F14
= _core_
.WXK_F14
463 WXK_F15
= _core_
.WXK_F15
464 WXK_F16
= _core_
.WXK_F16
465 WXK_F17
= _core_
.WXK_F17
466 WXK_F18
= _core_
.WXK_F18
467 WXK_F19
= _core_
.WXK_F19
468 WXK_F20
= _core_
.WXK_F20
469 WXK_F21
= _core_
.WXK_F21
470 WXK_F22
= _core_
.WXK_F22
471 WXK_F23
= _core_
.WXK_F23
472 WXK_F24
= _core_
.WXK_F24
473 WXK_NUMLOCK
= _core_
.WXK_NUMLOCK
474 WXK_SCROLL
= _core_
.WXK_SCROLL
475 WXK_PAGEUP
= _core_
.WXK_PAGEUP
476 WXK_PAGEDOWN
= _core_
.WXK_PAGEDOWN
477 WXK_NUMPAD_SPACE
= _core_
.WXK_NUMPAD_SPACE
478 WXK_NUMPAD_TAB
= _core_
.WXK_NUMPAD_TAB
479 WXK_NUMPAD_ENTER
= _core_
.WXK_NUMPAD_ENTER
480 WXK_NUMPAD_F1
= _core_
.WXK_NUMPAD_F1
481 WXK_NUMPAD_F2
= _core_
.WXK_NUMPAD_F2
482 WXK_NUMPAD_F3
= _core_
.WXK_NUMPAD_F3
483 WXK_NUMPAD_F4
= _core_
.WXK_NUMPAD_F4
484 WXK_NUMPAD_HOME
= _core_
.WXK_NUMPAD_HOME
485 WXK_NUMPAD_LEFT
= _core_
.WXK_NUMPAD_LEFT
486 WXK_NUMPAD_UP
= _core_
.WXK_NUMPAD_UP
487 WXK_NUMPAD_RIGHT
= _core_
.WXK_NUMPAD_RIGHT
488 WXK_NUMPAD_DOWN
= _core_
.WXK_NUMPAD_DOWN
489 WXK_NUMPAD_PRIOR
= _core_
.WXK_NUMPAD_PRIOR
490 WXK_NUMPAD_PAGEUP
= _core_
.WXK_NUMPAD_PAGEUP
491 WXK_NUMPAD_NEXT
= _core_
.WXK_NUMPAD_NEXT
492 WXK_NUMPAD_PAGEDOWN
= _core_
.WXK_NUMPAD_PAGEDOWN
493 WXK_NUMPAD_END
= _core_
.WXK_NUMPAD_END
494 WXK_NUMPAD_BEGIN
= _core_
.WXK_NUMPAD_BEGIN
495 WXK_NUMPAD_INSERT
= _core_
.WXK_NUMPAD_INSERT
496 WXK_NUMPAD_DELETE
= _core_
.WXK_NUMPAD_DELETE
497 WXK_NUMPAD_EQUAL
= _core_
.WXK_NUMPAD_EQUAL
498 WXK_NUMPAD_MULTIPLY
= _core_
.WXK_NUMPAD_MULTIPLY
499 WXK_NUMPAD_ADD
= _core_
.WXK_NUMPAD_ADD
500 WXK_NUMPAD_SEPARATOR
= _core_
.WXK_NUMPAD_SEPARATOR
501 WXK_NUMPAD_SUBTRACT
= _core_
.WXK_NUMPAD_SUBTRACT
502 WXK_NUMPAD_DECIMAL
= _core_
.WXK_NUMPAD_DECIMAL
503 WXK_NUMPAD_DIVIDE
= _core_
.WXK_NUMPAD_DIVIDE
504 WXK_WINDOWS_LEFT
= _core_
.WXK_WINDOWS_LEFT
505 WXK_WINDOWS_RIGHT
= _core_
.WXK_WINDOWS_RIGHT
506 WXK_WINDOWS_MENU
= _core_
.WXK_WINDOWS_MENU
507 WXK_COMMAND
= _core_
.WXK_COMMAND
508 WXK_SPECIAL1
= _core_
.WXK_SPECIAL1
509 WXK_SPECIAL2
= _core_
.WXK_SPECIAL2
510 WXK_SPECIAL3
= _core_
.WXK_SPECIAL3
511 WXK_SPECIAL4
= _core_
.WXK_SPECIAL4
512 WXK_SPECIAL5
= _core_
.WXK_SPECIAL5
513 WXK_SPECIAL6
= _core_
.WXK_SPECIAL6
514 WXK_SPECIAL7
= _core_
.WXK_SPECIAL7
515 WXK_SPECIAL8
= _core_
.WXK_SPECIAL8
516 WXK_SPECIAL9
= _core_
.WXK_SPECIAL9
517 WXK_SPECIAL10
= _core_
.WXK_SPECIAL10
518 WXK_SPECIAL11
= _core_
.WXK_SPECIAL11
519 WXK_SPECIAL12
= _core_
.WXK_SPECIAL12
520 WXK_SPECIAL13
= _core_
.WXK_SPECIAL13
521 WXK_SPECIAL14
= _core_
.WXK_SPECIAL14
522 WXK_SPECIAL15
= _core_
.WXK_SPECIAL15
523 WXK_SPECIAL16
= _core_
.WXK_SPECIAL16
524 WXK_SPECIAL17
= _core_
.WXK_SPECIAL17
525 WXK_SPECIAL18
= _core_
.WXK_SPECIAL18
526 WXK_SPECIAL19
= _core_
.WXK_SPECIAL19
527 WXK_SPECIAL20
= _core_
.WXK_SPECIAL20
528 PAPER_NONE
= _core_
.PAPER_NONE
529 PAPER_LETTER
= _core_
.PAPER_LETTER
530 PAPER_LEGAL
= _core_
.PAPER_LEGAL
531 PAPER_A4
= _core_
.PAPER_A4
532 PAPER_CSHEET
= _core_
.PAPER_CSHEET
533 PAPER_DSHEET
= _core_
.PAPER_DSHEET
534 PAPER_ESHEET
= _core_
.PAPER_ESHEET
535 PAPER_LETTERSMALL
= _core_
.PAPER_LETTERSMALL
536 PAPER_TABLOID
= _core_
.PAPER_TABLOID
537 PAPER_LEDGER
= _core_
.PAPER_LEDGER
538 PAPER_STATEMENT
= _core_
.PAPER_STATEMENT
539 PAPER_EXECUTIVE
= _core_
.PAPER_EXECUTIVE
540 PAPER_A3
= _core_
.PAPER_A3
541 PAPER_A4SMALL
= _core_
.PAPER_A4SMALL
542 PAPER_A5
= _core_
.PAPER_A5
543 PAPER_B4
= _core_
.PAPER_B4
544 PAPER_B5
= _core_
.PAPER_B5
545 PAPER_FOLIO
= _core_
.PAPER_FOLIO
546 PAPER_QUARTO
= _core_
.PAPER_QUARTO
547 PAPER_10X14
= _core_
.PAPER_10X14
548 PAPER_11X17
= _core_
.PAPER_11X17
549 PAPER_NOTE
= _core_
.PAPER_NOTE
550 PAPER_ENV_9
= _core_
.PAPER_ENV_9
551 PAPER_ENV_10
= _core_
.PAPER_ENV_10
552 PAPER_ENV_11
= _core_
.PAPER_ENV_11
553 PAPER_ENV_12
= _core_
.PAPER_ENV_12
554 PAPER_ENV_14
= _core_
.PAPER_ENV_14
555 PAPER_ENV_DL
= _core_
.PAPER_ENV_DL
556 PAPER_ENV_C5
= _core_
.PAPER_ENV_C5
557 PAPER_ENV_C3
= _core_
.PAPER_ENV_C3
558 PAPER_ENV_C4
= _core_
.PAPER_ENV_C4
559 PAPER_ENV_C6
= _core_
.PAPER_ENV_C6
560 PAPER_ENV_C65
= _core_
.PAPER_ENV_C65
561 PAPER_ENV_B4
= _core_
.PAPER_ENV_B4
562 PAPER_ENV_B5
= _core_
.PAPER_ENV_B5
563 PAPER_ENV_B6
= _core_
.PAPER_ENV_B6
564 PAPER_ENV_ITALY
= _core_
.PAPER_ENV_ITALY
565 PAPER_ENV_MONARCH
= _core_
.PAPER_ENV_MONARCH
566 PAPER_ENV_PERSONAL
= _core_
.PAPER_ENV_PERSONAL
567 PAPER_FANFOLD_US
= _core_
.PAPER_FANFOLD_US
568 PAPER_FANFOLD_STD_GERMAN
= _core_
.PAPER_FANFOLD_STD_GERMAN
569 PAPER_FANFOLD_LGL_GERMAN
= _core_
.PAPER_FANFOLD_LGL_GERMAN
570 PAPER_ISO_B4
= _core_
.PAPER_ISO_B4
571 PAPER_JAPANESE_POSTCARD
= _core_
.PAPER_JAPANESE_POSTCARD
572 PAPER_9X11
= _core_
.PAPER_9X11
573 PAPER_10X11
= _core_
.PAPER_10X11
574 PAPER_15X11
= _core_
.PAPER_15X11
575 PAPER_ENV_INVITE
= _core_
.PAPER_ENV_INVITE
576 PAPER_LETTER_EXTRA
= _core_
.PAPER_LETTER_EXTRA
577 PAPER_LEGAL_EXTRA
= _core_
.PAPER_LEGAL_EXTRA
578 PAPER_TABLOID_EXTRA
= _core_
.PAPER_TABLOID_EXTRA
579 PAPER_A4_EXTRA
= _core_
.PAPER_A4_EXTRA
580 PAPER_LETTER_TRANSVERSE
= _core_
.PAPER_LETTER_TRANSVERSE
581 PAPER_A4_TRANSVERSE
= _core_
.PAPER_A4_TRANSVERSE
582 PAPER_LETTER_EXTRA_TRANSVERSE
= _core_
.PAPER_LETTER_EXTRA_TRANSVERSE
583 PAPER_A_PLUS
= _core_
.PAPER_A_PLUS
584 PAPER_B_PLUS
= _core_
.PAPER_B_PLUS
585 PAPER_LETTER_PLUS
= _core_
.PAPER_LETTER_PLUS
586 PAPER_A4_PLUS
= _core_
.PAPER_A4_PLUS
587 PAPER_A5_TRANSVERSE
= _core_
.PAPER_A5_TRANSVERSE
588 PAPER_B5_TRANSVERSE
= _core_
.PAPER_B5_TRANSVERSE
589 PAPER_A3_EXTRA
= _core_
.PAPER_A3_EXTRA
590 PAPER_A5_EXTRA
= _core_
.PAPER_A5_EXTRA
591 PAPER_B5_EXTRA
= _core_
.PAPER_B5_EXTRA
592 PAPER_A2
= _core_
.PAPER_A2
593 PAPER_A3_TRANSVERSE
= _core_
.PAPER_A3_TRANSVERSE
594 PAPER_A3_EXTRA_TRANSVERSE
= _core_
.PAPER_A3_EXTRA_TRANSVERSE
595 PAPER_DBL_JAPANESE_POSTCARD
= _core_
.PAPER_DBL_JAPANESE_POSTCARD
596 PAPER_A6
= _core_
.PAPER_A6
597 PAPER_JENV_KAKU2
= _core_
.PAPER_JENV_KAKU2
598 PAPER_JENV_KAKU3
= _core_
.PAPER_JENV_KAKU3
599 PAPER_JENV_CHOU3
= _core_
.PAPER_JENV_CHOU3
600 PAPER_JENV_CHOU4
= _core_
.PAPER_JENV_CHOU4
601 PAPER_LETTER_ROTATED
= _core_
.PAPER_LETTER_ROTATED
602 PAPER_A3_ROTATED
= _core_
.PAPER_A3_ROTATED
603 PAPER_A4_ROTATED
= _core_
.PAPER_A4_ROTATED
604 PAPER_A5_ROTATED
= _core_
.PAPER_A5_ROTATED
605 PAPER_B4_JIS_ROTATED
= _core_
.PAPER_B4_JIS_ROTATED
606 PAPER_B5_JIS_ROTATED
= _core_
.PAPER_B5_JIS_ROTATED
607 PAPER_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_JAPANESE_POSTCARD_ROTATED
608 PAPER_DBL_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609 PAPER_A6_ROTATED
= _core_
.PAPER_A6_ROTATED
610 PAPER_JENV_KAKU2_ROTATED
= _core_
.PAPER_JENV_KAKU2_ROTATED
611 PAPER_JENV_KAKU3_ROTATED
= _core_
.PAPER_JENV_KAKU3_ROTATED
612 PAPER_JENV_CHOU3_ROTATED
= _core_
.PAPER_JENV_CHOU3_ROTATED
613 PAPER_JENV_CHOU4_ROTATED
= _core_
.PAPER_JENV_CHOU4_ROTATED
614 PAPER_B6_JIS
= _core_
.PAPER_B6_JIS
615 PAPER_B6_JIS_ROTATED
= _core_
.PAPER_B6_JIS_ROTATED
616 PAPER_12X11
= _core_
.PAPER_12X11
617 PAPER_JENV_YOU4
= _core_
.PAPER_JENV_YOU4
618 PAPER_JENV_YOU4_ROTATED
= _core_
.PAPER_JENV_YOU4_ROTATED
619 PAPER_P16K
= _core_
.PAPER_P16K
620 PAPER_P32K
= _core_
.PAPER_P32K
621 PAPER_P32KBIG
= _core_
.PAPER_P32KBIG
622 PAPER_PENV_1
= _core_
.PAPER_PENV_1
623 PAPER_PENV_2
= _core_
.PAPER_PENV_2
624 PAPER_PENV_3
= _core_
.PAPER_PENV_3
625 PAPER_PENV_4
= _core_
.PAPER_PENV_4
626 PAPER_PENV_5
= _core_
.PAPER_PENV_5
627 PAPER_PENV_6
= _core_
.PAPER_PENV_6
628 PAPER_PENV_7
= _core_
.PAPER_PENV_7
629 PAPER_PENV_8
= _core_
.PAPER_PENV_8
630 PAPER_PENV_9
= _core_
.PAPER_PENV_9
631 PAPER_PENV_10
= _core_
.PAPER_PENV_10
632 PAPER_P16K_ROTATED
= _core_
.PAPER_P16K_ROTATED
633 PAPER_P32K_ROTATED
= _core_
.PAPER_P32K_ROTATED
634 PAPER_P32KBIG_ROTATED
= _core_
.PAPER_P32KBIG_ROTATED
635 PAPER_PENV_1_ROTATED
= _core_
.PAPER_PENV_1_ROTATED
636 PAPER_PENV_2_ROTATED
= _core_
.PAPER_PENV_2_ROTATED
637 PAPER_PENV_3_ROTATED
= _core_
.PAPER_PENV_3_ROTATED
638 PAPER_PENV_4_ROTATED
= _core_
.PAPER_PENV_4_ROTATED
639 PAPER_PENV_5_ROTATED
= _core_
.PAPER_PENV_5_ROTATED
640 PAPER_PENV_6_ROTATED
= _core_
.PAPER_PENV_6_ROTATED
641 PAPER_PENV_7_ROTATED
= _core_
.PAPER_PENV_7_ROTATED
642 PAPER_PENV_8_ROTATED
= _core_
.PAPER_PENV_8_ROTATED
643 PAPER_PENV_9_ROTATED
= _core_
.PAPER_PENV_9_ROTATED
644 PAPER_PENV_10_ROTATED
= _core_
.PAPER_PENV_10_ROTATED
645 DUPLEX_SIMPLEX
= _core_
.DUPLEX_SIMPLEX
646 DUPLEX_HORIZONTAL
= _core_
.DUPLEX_HORIZONTAL
647 DUPLEX_VERTICAL
= _core_
.DUPLEX_VERTICAL
648 ITEM_SEPARATOR
= _core_
.ITEM_SEPARATOR
649 ITEM_NORMAL
= _core_
.ITEM_NORMAL
650 ITEM_CHECK
= _core_
.ITEM_CHECK
651 ITEM_RADIO
= _core_
.ITEM_RADIO
652 ITEM_MAX
= _core_
.ITEM_MAX
653 HT_NOWHERE
= _core_
.HT_NOWHERE
654 HT_SCROLLBAR_FIRST
= _core_
.HT_SCROLLBAR_FIRST
655 HT_SCROLLBAR_ARROW_LINE_1
= _core_
.HT_SCROLLBAR_ARROW_LINE_1
656 HT_SCROLLBAR_ARROW_LINE_2
= _core_
.HT_SCROLLBAR_ARROW_LINE_2
657 HT_SCROLLBAR_ARROW_PAGE_1
= _core_
.HT_SCROLLBAR_ARROW_PAGE_1
658 HT_SCROLLBAR_ARROW_PAGE_2
= _core_
.HT_SCROLLBAR_ARROW_PAGE_2
659 HT_SCROLLBAR_THUMB
= _core_
.HT_SCROLLBAR_THUMB
660 HT_SCROLLBAR_BAR_1
= _core_
.HT_SCROLLBAR_BAR_1
661 HT_SCROLLBAR_BAR_2
= _core_
.HT_SCROLLBAR_BAR_2
662 HT_SCROLLBAR_LAST
= _core_
.HT_SCROLLBAR_LAST
663 HT_WINDOW_OUTSIDE
= _core_
.HT_WINDOW_OUTSIDE
664 HT_WINDOW_INSIDE
= _core_
.HT_WINDOW_INSIDE
665 HT_WINDOW_VERT_SCROLLBAR
= _core_
.HT_WINDOW_VERT_SCROLLBAR
666 HT_WINDOW_HORZ_SCROLLBAR
= _core_
.HT_WINDOW_HORZ_SCROLLBAR
667 HT_WINDOW_CORNER
= _core_
.HT_WINDOW_CORNER
668 HT_MAX
= _core_
.HT_MAX
669 MOD_NONE
= _core_
.MOD_NONE
670 MOD_ALT
= _core_
.MOD_ALT
671 MOD_CONTROL
= _core_
.MOD_CONTROL
672 MOD_ALTGR
= _core_
.MOD_ALTGR
673 MOD_SHIFT
= _core_
.MOD_SHIFT
674 MOD_META
= _core_
.MOD_META
675 MOD_WIN
= _core_
.MOD_WIN
676 MOD_CMD
= _core_
.MOD_CMD
677 MOD_ALL
= _core_
.MOD_ALL
678 UPDATE_UI_NONE
= _core_
.UPDATE_UI_NONE
679 UPDATE_UI_RECURSE
= _core_
.UPDATE_UI_RECURSE
680 UPDATE_UI_FROMIDLE
= _core_
.UPDATE_UI_FROMIDLE
681 Layout_Default
= _core_
.Layout_Default
682 Layout_LeftToRight
= _core_
.Layout_LeftToRight
683 Layout_RightToLeft
= _core_
.Layout_RightToLeft
684 #---------------------------------------------------------------------------
686 class Object(object):
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
691 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
692 def __init__(self
): raise AttributeError, "No constructor defined"
693 __repr__
= _swig_repr
694 def GetClassName(*args
, **kwargs
):
696 GetClassName(self) -> String
698 Returns the class name of the C++ class using wxRTTI.
700 return _core_
.Object_GetClassName(*args
, **kwargs
)
702 def Destroy(*args
, **kwargs
):
706 Deletes the C++ object this Python object is a proxy for.
708 args
[0].this
.own(False)
709 return _core_
.Object_Destroy(*args
, **kwargs
)
711 ClassName
= property(GetClassName
,doc
="See `GetClassName`")
712 _core_
.Object_swigregister(Object
)
713 _wxPySetDictionary
= _core_
._wxPySetDictionary
715 EmptyString
= cvar
.EmptyString
717 #---------------------------------------------------------------------------
719 BITMAP_TYPE_INVALID
= _core_
.BITMAP_TYPE_INVALID
720 BITMAP_TYPE_BMP
= _core_
.BITMAP_TYPE_BMP
721 BITMAP_TYPE_ICO
= _core_
.BITMAP_TYPE_ICO
722 BITMAP_TYPE_CUR
= _core_
.BITMAP_TYPE_CUR
723 BITMAP_TYPE_XBM
= _core_
.BITMAP_TYPE_XBM
724 BITMAP_TYPE_XBM_DATA
= _core_
.BITMAP_TYPE_XBM_DATA
725 BITMAP_TYPE_XPM
= _core_
.BITMAP_TYPE_XPM
726 BITMAP_TYPE_XPM_DATA
= _core_
.BITMAP_TYPE_XPM_DATA
727 BITMAP_TYPE_TIF
= _core_
.BITMAP_TYPE_TIF
728 BITMAP_TYPE_GIF
= _core_
.BITMAP_TYPE_GIF
729 BITMAP_TYPE_PNG
= _core_
.BITMAP_TYPE_PNG
730 BITMAP_TYPE_JPEG
= _core_
.BITMAP_TYPE_JPEG
731 BITMAP_TYPE_PNM
= _core_
.BITMAP_TYPE_PNM
732 BITMAP_TYPE_PCX
= _core_
.BITMAP_TYPE_PCX
733 BITMAP_TYPE_PICT
= _core_
.BITMAP_TYPE_PICT
734 BITMAP_TYPE_ICON
= _core_
.BITMAP_TYPE_ICON
735 BITMAP_TYPE_ANI
= _core_
.BITMAP_TYPE_ANI
736 BITMAP_TYPE_IFF
= _core_
.BITMAP_TYPE_IFF
737 BITMAP_TYPE_MACCURSOR
= _core_
.BITMAP_TYPE_MACCURSOR
738 BITMAP_TYPE_ANY
= _core_
.BITMAP_TYPE_ANY
739 CURSOR_NONE
= _core_
.CURSOR_NONE
740 CURSOR_ARROW
= _core_
.CURSOR_ARROW
741 CURSOR_RIGHT_ARROW
= _core_
.CURSOR_RIGHT_ARROW
742 CURSOR_BULLSEYE
= _core_
.CURSOR_BULLSEYE
743 CURSOR_CHAR
= _core_
.CURSOR_CHAR
744 CURSOR_CROSS
= _core_
.CURSOR_CROSS
745 CURSOR_HAND
= _core_
.CURSOR_HAND
746 CURSOR_IBEAM
= _core_
.CURSOR_IBEAM
747 CURSOR_LEFT_BUTTON
= _core_
.CURSOR_LEFT_BUTTON
748 CURSOR_MAGNIFIER
= _core_
.CURSOR_MAGNIFIER
749 CURSOR_MIDDLE_BUTTON
= _core_
.CURSOR_MIDDLE_BUTTON
750 CURSOR_NO_ENTRY
= _core_
.CURSOR_NO_ENTRY
751 CURSOR_PAINT_BRUSH
= _core_
.CURSOR_PAINT_BRUSH
752 CURSOR_PENCIL
= _core_
.CURSOR_PENCIL
753 CURSOR_POINT_LEFT
= _core_
.CURSOR_POINT_LEFT
754 CURSOR_POINT_RIGHT
= _core_
.CURSOR_POINT_RIGHT
755 CURSOR_QUESTION_ARROW
= _core_
.CURSOR_QUESTION_ARROW
756 CURSOR_RIGHT_BUTTON
= _core_
.CURSOR_RIGHT_BUTTON
757 CURSOR_SIZENESW
= _core_
.CURSOR_SIZENESW
758 CURSOR_SIZENS
= _core_
.CURSOR_SIZENS
759 CURSOR_SIZENWSE
= _core_
.CURSOR_SIZENWSE
760 CURSOR_SIZEWE
= _core_
.CURSOR_SIZEWE
761 CURSOR_SIZING
= _core_
.CURSOR_SIZING
762 CURSOR_SPRAYCAN
= _core_
.CURSOR_SPRAYCAN
763 CURSOR_WAIT
= _core_
.CURSOR_WAIT
764 CURSOR_WATCH
= _core_
.CURSOR_WATCH
765 CURSOR_BLANK
= _core_
.CURSOR_BLANK
766 CURSOR_DEFAULT
= _core_
.CURSOR_DEFAULT
767 CURSOR_COPY_ARROW
= _core_
.CURSOR_COPY_ARROW
768 CURSOR_ARROWWAIT
= _core_
.CURSOR_ARROWWAIT
769 CURSOR_MAX
= _core_
.CURSOR_MAX
770 #---------------------------------------------------------------------------
774 wx.Size is a useful data structure used to represent the size of
775 something. It simply contains integer width and height
776 properties. In most places in wxPython where a wx.Size is
777 expected a (width, height) tuple can be used instead.
779 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
780 __repr__
= _swig_repr
781 width
= property(_core_
.Size_width_get
, _core_
.Size_width_set
)
782 height
= property(_core_
.Size_height_get
, _core_
.Size_height_set
)
783 x
= width
; y
= height
784 def __init__(self
, *args
, **kwargs
):
786 __init__(self, int w=0, int h=0) -> Size
788 Creates a size object.
790 _core_
.Size_swiginit(self
,_core_
.new_Size(*args
, **kwargs
))
791 __swig_destroy__
= _core_
.delete_Size
792 __del__
= lambda self
: None;
793 def __eq__(*args
, **kwargs
):
795 __eq__(self, PyObject other) -> bool
797 Test for equality of wx.Size objects.
799 return _core_
.Size___eq__(*args
, **kwargs
)
801 def __ne__(*args
, **kwargs
):
803 __ne__(self, PyObject other) -> bool
805 Test for inequality of wx.Size objects.
807 return _core_
.Size___ne__(*args
, **kwargs
)
809 def __add__(*args
, **kwargs
):
811 __add__(self, Size sz) -> Size
813 Add sz's proprties to this and return the result.
815 return _core_
.Size___add__(*args
, **kwargs
)
817 def __sub__(*args
, **kwargs
):
819 __sub__(self, Size sz) -> Size
821 Subtract sz's properties from this and return the result.
823 return _core_
.Size___sub__(*args
, **kwargs
)
825 def IncTo(*args
, **kwargs
):
829 Increments this object so that both of its dimensions are not less
830 than the corresponding dimensions of the size.
832 return _core_
.Size_IncTo(*args
, **kwargs
)
834 def DecTo(*args
, **kwargs
):
838 Decrements this object so that both of its dimensions are not greater
839 than the corresponding dimensions of the size.
841 return _core_
.Size_DecTo(*args
, **kwargs
)
843 def IncBy(*args
, **kwargs
):
844 """IncBy(self, int dx, int dy)"""
845 return _core_
.Size_IncBy(*args
, **kwargs
)
847 def DecBy(*args
, **kwargs
):
848 """DecBy(self, int dx, int dy)"""
849 return _core_
.Size_DecBy(*args
, **kwargs
)
851 def Scale(*args
, **kwargs
):
853 Scale(self, float xscale, float yscale)
855 Scales the dimensions of this object by the given factors.
857 return _core_
.Size_Scale(*args
, **kwargs
)
859 def Set(*args
, **kwargs
):
861 Set(self, int w, int h)
863 Set both width and height.
865 return _core_
.Size_Set(*args
, **kwargs
)
867 def SetWidth(*args
, **kwargs
):
868 """SetWidth(self, int w)"""
869 return _core_
.Size_SetWidth(*args
, **kwargs
)
871 def SetHeight(*args
, **kwargs
):
872 """SetHeight(self, int h)"""
873 return _core_
.Size_SetHeight(*args
, **kwargs
)
875 def GetWidth(*args
, **kwargs
):
876 """GetWidth(self) -> int"""
877 return _core_
.Size_GetWidth(*args
, **kwargs
)
879 def GetHeight(*args
, **kwargs
):
880 """GetHeight(self) -> int"""
881 return _core_
.Size_GetHeight(*args
, **kwargs
)
883 def IsFullySpecified(*args
, **kwargs
):
885 IsFullySpecified(self) -> bool
887 Returns True if both components of the size are non-default values.
889 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
891 def SetDefaults(*args
, **kwargs
):
893 SetDefaults(self, Size size)
895 Combine this size with the other one replacing the default components
896 of this object (i.e. equal to -1) with those of the other.
898 return _core_
.Size_SetDefaults(*args
, **kwargs
)
900 def Get(*args
, **kwargs
):
902 Get() -> (width,height)
904 Returns the width and height properties as a tuple.
906 return _core_
.Size_Get(*args
, **kwargs
)
908 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
909 def __str__(self
): return str(self
.Get())
910 def __repr__(self
): return 'wx.Size'+str(self
.Get())
911 def __len__(self
): return len(self
.Get())
912 def __getitem__(self
, index
): return self
.Get()[index
]
913 def __setitem__(self
, index
, val
):
914 if index
== 0: self
.width
= val
915 elif index
== 1: self
.height
= val
916 else: raise IndexError
917 def __nonzero__(self
): return self
.Get() != (0,0)
918 __safe_for_unpickling__
= True
919 def __reduce__(self
): return (wx
.Size
, self
.Get())
921 _core_
.Size_swigregister(Size
)
923 #---------------------------------------------------------------------------
925 class RealPoint(object):
927 A data structure for representing a point or position with floating
928 point x and y properties. In wxPython most places that expect a
929 wx.RealPoint can also accept a (x,y) tuple.
931 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
932 __repr__
= _swig_repr
933 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
934 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
935 def __init__(self
, *args
, **kwargs
):
937 __init__(self, double x=0.0, double y=0.0) -> RealPoint
939 Create a wx.RealPoint object
941 _core_
.RealPoint_swiginit(self
,_core_
.new_RealPoint(*args
, **kwargs
))
942 __swig_destroy__
= _core_
.delete_RealPoint
943 __del__
= lambda self
: None;
944 def __eq__(*args
, **kwargs
):
946 __eq__(self, PyObject other) -> bool
948 Test for equality of wx.RealPoint objects.
950 return _core_
.RealPoint___eq__(*args
, **kwargs
)
952 def __ne__(*args
, **kwargs
):
954 __ne__(self, PyObject other) -> bool
956 Test for inequality of wx.RealPoint objects.
958 return _core_
.RealPoint___ne__(*args
, **kwargs
)
960 def __add__(*args
, **kwargs
):
962 __add__(self, RealPoint pt) -> RealPoint
964 Add pt's proprties to this and return the result.
966 return _core_
.RealPoint___add__(*args
, **kwargs
)
968 def __sub__(*args
, **kwargs
):
970 __sub__(self, RealPoint pt) -> RealPoint
972 Subtract pt's proprties from this and return the result
974 return _core_
.RealPoint___sub__(*args
, **kwargs
)
976 def Set(*args
, **kwargs
):
978 Set(self, double x, double y)
980 Set both the x and y properties
982 return _core_
.RealPoint_Set(*args
, **kwargs
)
984 def Get(*args
, **kwargs
):
988 Return the x and y properties as a tuple.
990 return _core_
.RealPoint_Get(*args
, **kwargs
)
992 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
993 def __str__(self
): return str(self
.Get())
994 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
995 def __len__(self
): return len(self
.Get())
996 def __getitem__(self
, index
): return self
.Get()[index
]
997 def __setitem__(self
, index
, val
):
998 if index
== 0: self
.x
= val
999 elif index
== 1: self
.y
= val
1000 else: raise IndexError
1001 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1002 __safe_for_unpickling__
= True
1003 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
1005 _core_
.RealPoint_swigregister(RealPoint
)
1007 #---------------------------------------------------------------------------
1009 class Point(object):
1011 A data structure for representing a point or position with integer x
1012 and y properties. Most places in wxPython that expect a wx.Point can
1013 also accept a (x,y) tuple.
1015 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1016 __repr__
= _swig_repr
1017 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1018 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1019 def __init__(self
, *args
, **kwargs
):
1021 __init__(self, int x=0, int y=0) -> Point
1023 Create a wx.Point object
1025 _core_
.Point_swiginit(self
,_core_
.new_Point(*args
, **kwargs
))
1026 __swig_destroy__
= _core_
.delete_Point
1027 __del__
= lambda self
: None;
1028 def __eq__(*args
, **kwargs
):
1030 __eq__(self, PyObject other) -> bool
1032 Test for equality of wx.Point objects.
1034 return _core_
.Point___eq__(*args
, **kwargs
)
1036 def __ne__(*args
, **kwargs
):
1038 __ne__(self, PyObject other) -> bool
1040 Test for inequality of wx.Point objects.
1042 return _core_
.Point___ne__(*args
, **kwargs
)
1044 def __add__(*args
, **kwargs
):
1046 __add__(self, Point pt) -> Point
1048 Add pt's proprties to this and return the result.
1050 return _core_
.Point___add__(*args
, **kwargs
)
1052 def __sub__(*args
, **kwargs
):
1054 __sub__(self, Point pt) -> Point
1056 Subtract pt's proprties from this and return the result
1058 return _core_
.Point___sub__(*args
, **kwargs
)
1060 def __iadd__(*args
, **kwargs
):
1062 __iadd__(self, Point pt) -> Point
1064 Add pt to this object.
1066 return _core_
.Point___iadd__(*args
, **kwargs
)
1068 def __isub__(*args
, **kwargs
):
1070 __isub__(self, Point pt) -> Point
1072 Subtract pt from this object.
1074 return _core_
.Point___isub__(*args
, **kwargs
)
1076 def Set(*args
, **kwargs
):
1078 Set(self, long x, long y)
1080 Set both the x and y properties
1082 return _core_
.Point_Set(*args
, **kwargs
)
1084 def Get(*args
, **kwargs
):
1088 Return the x and y properties as a tuple.
1090 return _core_
.Point_Get(*args
, **kwargs
)
1092 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1093 def __str__(self
): return str(self
.Get())
1094 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1095 def __len__(self
): return len(self
.Get())
1096 def __getitem__(self
, index
): return self
.Get()[index
]
1097 def __setitem__(self
, index
, val
):
1098 if index
== 0: self
.x
= val
1099 elif index
== 1: self
.y
= val
1100 else: raise IndexError
1101 def __nonzero__(self
): return self
.Get() != (0,0)
1102 __safe_for_unpickling__
= True
1103 def __reduce__(self
): return (wx
.Point
, self
.Get())
1105 _core_
.Point_swigregister(Point
)
1107 #---------------------------------------------------------------------------
1111 A class for representing and manipulating rectangles. It has x, y,
1112 width and height properties. In wxPython most palces that expect a
1113 wx.Rect can also accept a (x,y,width,height) tuple.
1115 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1116 __repr__
= _swig_repr
1117 def __init__(self
, *args
, **kwargs
):
1119 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1121 Create a new Rect object.
1123 _core_
.Rect_swiginit(self
,_core_
.new_Rect(*args
, **kwargs
))
1124 __swig_destroy__
= _core_
.delete_Rect
1125 __del__
= lambda self
: None;
1126 def GetX(*args
, **kwargs
):
1127 """GetX(self) -> int"""
1128 return _core_
.Rect_GetX(*args
, **kwargs
)
1130 def SetX(*args
, **kwargs
):
1131 """SetX(self, int x)"""
1132 return _core_
.Rect_SetX(*args
, **kwargs
)
1134 def GetY(*args
, **kwargs
):
1135 """GetY(self) -> int"""
1136 return _core_
.Rect_GetY(*args
, **kwargs
)
1138 def SetY(*args
, **kwargs
):
1139 """SetY(self, int y)"""
1140 return _core_
.Rect_SetY(*args
, **kwargs
)
1142 def GetWidth(*args
, **kwargs
):
1143 """GetWidth(self) -> int"""
1144 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1146 def SetWidth(*args
, **kwargs
):
1147 """SetWidth(self, int w)"""
1148 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1150 def GetHeight(*args
, **kwargs
):
1151 """GetHeight(self) -> int"""
1152 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1154 def SetHeight(*args
, **kwargs
):
1155 """SetHeight(self, int h)"""
1156 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1158 def GetPosition(*args
, **kwargs
):
1159 """GetPosition(self) -> Point"""
1160 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1162 def SetPosition(*args
, **kwargs
):
1163 """SetPosition(self, Point p)"""
1164 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1166 def GetSize(*args
, **kwargs
):
1167 """GetSize(self) -> Size"""
1168 return _core_
.Rect_GetSize(*args
, **kwargs
)
1170 def SetSize(*args
, **kwargs
):
1171 """SetSize(self, Size s)"""
1172 return _core_
.Rect_SetSize(*args
, **kwargs
)
1174 def IsEmpty(*args
, **kwargs
):
1175 """IsEmpty(self) -> bool"""
1176 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1178 def GetTopLeft(*args
, **kwargs
):
1179 """GetTopLeft(self) -> Point"""
1180 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1182 def SetTopLeft(*args
, **kwargs
):
1183 """SetTopLeft(self, Point p)"""
1184 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1186 def GetBottomRight(*args
, **kwargs
):
1187 """GetBottomRight(self) -> Point"""
1188 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1190 def SetBottomRight(*args
, **kwargs
):
1191 """SetBottomRight(self, Point p)"""
1192 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1194 def GetTopRight(*args
, **kwargs
):
1195 """GetTopRight(self) -> Point"""
1196 return _core_
.Rect_GetTopRight(*args
, **kwargs
)
1198 def SetTopRight(*args
, **kwargs
):
1199 """SetTopRight(self, Point p)"""
1200 return _core_
.Rect_SetTopRight(*args
, **kwargs
)
1202 def GetBottomLeft(*args
, **kwargs
):
1203 """GetBottomLeft(self) -> Point"""
1204 return _core_
.Rect_GetBottomLeft(*args
, **kwargs
)
1206 def SetBottomLeft(*args
, **kwargs
):
1207 """SetBottomLeft(self, Point p)"""
1208 return _core_
.Rect_SetBottomLeft(*args
, **kwargs
)
1210 def GetLeft(*args
, **kwargs
):
1211 """GetLeft(self) -> int"""
1212 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1214 def GetTop(*args
, **kwargs
):
1215 """GetTop(self) -> int"""
1216 return _core_
.Rect_GetTop(*args
, **kwargs
)
1218 def GetBottom(*args
, **kwargs
):
1219 """GetBottom(self) -> int"""
1220 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1222 def GetRight(*args
, **kwargs
):
1223 """GetRight(self) -> int"""
1224 return _core_
.Rect_GetRight(*args
, **kwargs
)
1226 def SetLeft(*args
, **kwargs
):
1227 """SetLeft(self, int left)"""
1228 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1230 def SetRight(*args
, **kwargs
):
1231 """SetRight(self, int right)"""
1232 return _core_
.Rect_SetRight(*args
, **kwargs
)
1234 def SetTop(*args
, **kwargs
):
1235 """SetTop(self, int top)"""
1236 return _core_
.Rect_SetTop(*args
, **kwargs
)
1238 def SetBottom(*args
, **kwargs
):
1239 """SetBottom(self, int bottom)"""
1240 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1242 position
= property(GetPosition
, SetPosition
)
1243 size
= property(GetSize
, SetSize
)
1244 left
= property(GetLeft
, SetLeft
)
1245 right
= property(GetRight
, SetRight
)
1246 top
= property(GetTop
, SetTop
)
1247 bottom
= property(GetBottom
, SetBottom
)
1249 def Inflate(*args
, **kwargs
):
1251 Inflate(self, int dx, int dy) -> Rect
1253 Increases the size of the rectangle.
1255 The left border is moved farther left and the right border is moved
1256 farther right by ``dx``. The upper border is moved farther up and the
1257 bottom border is moved farther down by ``dy``. (Note the the width and
1258 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1259 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1260 opposite happens: the rectangle size decreases in the respective
1263 The change is made to the rectangle inplace, if instead you need a
1264 copy that is inflated, preserving the original then make the copy
1267 copy = wx.Rect(*original)
1272 return _core_
.Rect_Inflate(*args
, **kwargs
)
1274 def Deflate(*args
, **kwargs
):
1276 Deflate(self, int dx, int dy) -> Rect
1278 Decrease the rectangle size. This method is the opposite of `Inflate`
1279 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1280 `Inflate` for a full description.
1282 return _core_
.Rect_Deflate(*args
, **kwargs
)
1284 def OffsetXY(*args
, **kwargs
):
1286 OffsetXY(self, int dx, int dy)
1288 Moves the rectangle by the specified offset. If dx is positive, the
1289 rectangle is moved to the right, if dy is positive, it is moved to the
1290 bottom, otherwise it is moved to the left or top respectively.
1292 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1294 def Offset(*args
, **kwargs
):
1296 Offset(self, Point pt)
1298 Same as `OffsetXY` but uses dx,dy from Point
1300 return _core_
.Rect_Offset(*args
, **kwargs
)
1302 def Intersect(*args
, **kwargs
):
1304 Intersect(self, Rect rect) -> Rect
1306 Returns the intersectsion of this rectangle and rect.
1308 return _core_
.Rect_Intersect(*args
, **kwargs
)
1310 def Union(*args
, **kwargs
):
1312 Union(self, Rect rect) -> Rect
1314 Returns the union of this rectangle and rect.
1316 return _core_
.Rect_Union(*args
, **kwargs
)
1318 def __add__(*args
, **kwargs
):
1320 __add__(self, Rect rect) -> Rect
1322 Add the properties of rect to this rectangle and return the result.
1324 return _core_
.Rect___add__(*args
, **kwargs
)
1326 def __iadd__(*args
, **kwargs
):
1328 __iadd__(self, Rect rect) -> Rect
1330 Add the properties of rect to this rectangle, updating this rectangle.
1332 return _core_
.Rect___iadd__(*args
, **kwargs
)
1334 def __eq__(*args
, **kwargs
):
1336 __eq__(self, PyObject other) -> bool
1338 Test for equality of wx.Rect objects.
1340 return _core_
.Rect___eq__(*args
, **kwargs
)
1342 def __ne__(*args
, **kwargs
):
1344 __ne__(self, PyObject other) -> bool
1346 Test for inequality of wx.Rect objects.
1348 return _core_
.Rect___ne__(*args
, **kwargs
)
1350 def ContainsXY(*args
, **kwargs
):
1352 ContainsXY(self, int x, int y) -> bool
1354 Return True if the point is inside the rect.
1356 return _core_
.Rect_ContainsXY(*args
, **kwargs
)
1358 def Contains(*args
, **kwargs
):
1360 Contains(self, Point pt) -> bool
1362 Return True if the point is inside the rect.
1364 return _core_
.Rect_Contains(*args
, **kwargs
)
1366 def ContainsRect(*args
, **kwargs
):
1368 ContainsRect(self, Rect rect) -> bool
1370 Returns ``True`` if the given rectangle is completely inside this
1371 rectangle or touches its boundary.
1373 return _core_
.Rect_ContainsRect(*args
, **kwargs
)
1375 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1376 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1377 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1379 InsideXY
= ContainsXY
1380 InsideRect
= ContainsRect
1382 def Intersects(*args
, **kwargs
):
1384 Intersects(self, Rect rect) -> bool
1386 Returns True if the rectangles have a non empty intersection.
1388 return _core_
.Rect_Intersects(*args
, **kwargs
)
1390 def CenterIn(*args
, **kwargs
):
1392 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1394 Center this rectangle within the one passed to the method, which is
1395 usually, but not necessarily, the larger one.
1397 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1400 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1401 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1402 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1403 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1404 def Set(*args
, **kwargs
):
1406 Set(self, int x=0, int y=0, int width=0, int height=0)
1408 Set all rectangle properties.
1410 return _core_
.Rect_Set(*args
, **kwargs
)
1412 def Get(*args
, **kwargs
):
1414 Get() -> (x,y,width,height)
1416 Return the rectangle properties as a tuple.
1418 return _core_
.Rect_Get(*args
, **kwargs
)
1420 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1421 def __str__(self
): return str(self
.Get())
1422 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1423 def __len__(self
): return len(self
.Get())
1424 def __getitem__(self
, index
): return self
.Get()[index
]
1425 def __setitem__(self
, index
, val
):
1426 if index
== 0: self
.x
= val
1427 elif index
== 1: self
.y
= val
1428 elif index
== 2: self
.width
= val
1429 elif index
== 3: self
.height
= val
1430 else: raise IndexError
1431 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1432 __safe_for_unpickling__
= True
1433 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1435 Bottom
= property(GetBottom
,SetBottom
,doc
="See `GetBottom` and `SetBottom`")
1436 BottomRight
= property(GetBottomRight
,SetBottomRight
,doc
="See `GetBottomRight` and `SetBottomRight`")
1437 BottomLeft
= property(GetBottomLeft
,SetBottomLeft
,doc
="See `GetBottomLeft` and `SetBottomLeft`")
1438 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1439 Left
= property(GetLeft
,SetLeft
,doc
="See `GetLeft` and `SetLeft`")
1440 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
1441 Right
= property(GetRight
,SetRight
,doc
="See `GetRight` and `SetRight`")
1442 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
1443 Top
= property(GetTop
,SetTop
,doc
="See `GetTop` and `SetTop`")
1444 TopLeft
= property(GetTopLeft
,SetTopLeft
,doc
="See `GetTopLeft` and `SetTopLeft`")
1445 TopRight
= property(GetTopRight
,SetTopRight
,doc
="See `GetTopRight` and `SetTopRight`")
1446 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1447 X
= property(GetX
,SetX
,doc
="See `GetX` and `SetX`")
1448 Y
= property(GetY
,SetY
,doc
="See `GetY` and `SetY`")
1449 Empty
= property(IsEmpty
,doc
="See `IsEmpty`")
1450 _core_
.Rect_swigregister(Rect
)
1452 def RectPP(*args
, **kwargs
):
1454 RectPP(Point topLeft, Point bottomRight) -> Rect
1456 Create a new Rect object from Points representing two corners.
1458 val
= _core_
.new_RectPP(*args
, **kwargs
)
1461 def RectPS(*args
, **kwargs
):
1463 RectPS(Point pos, Size size) -> Rect
1465 Create a new Rect from a position and size.
1467 val
= _core_
.new_RectPS(*args
, **kwargs
)
1470 def RectS(*args
, **kwargs
):
1472 RectS(Size size) -> Rect
1474 Create a new Rect from a size only.
1476 val
= _core_
.new_RectS(*args
, **kwargs
)
1480 def IntersectRect(*args
, **kwargs
):
1482 IntersectRect(Rect r1, Rect r2) -> Rect
1484 Calculate and return the intersection of r1 and r2.
1486 return _core_
.IntersectRect(*args
, **kwargs
)
1487 #---------------------------------------------------------------------------
1489 class Point2D(object):
1491 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1492 with floating point values.
1494 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1495 __repr__
= _swig_repr
1496 def __init__(self
, *args
, **kwargs
):
1498 __init__(self, double x=0.0, double y=0.0) -> Point2D
1500 Create a w.Point2D object.
1502 _core_
.Point2D_swiginit(self
,_core_
.new_Point2D(*args
, **kwargs
))
1503 __swig_destroy__
= _core_
.delete_Point2D
1504 __del__
= lambda self
: None;
1505 def GetFloor(*args
, **kwargs
):
1511 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1513 def GetRounded(*args
, **kwargs
):
1515 GetRounded() -> (x,y)
1519 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1521 def GetVectorLength(*args
, **kwargs
):
1522 """GetVectorLength(self) -> double"""
1523 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1525 def GetVectorAngle(*args
, **kwargs
):
1526 """GetVectorAngle(self) -> double"""
1527 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1529 def SetVectorLength(*args
, **kwargs
):
1530 """SetVectorLength(self, double length)"""
1531 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1533 def SetVectorAngle(*args
, **kwargs
):
1534 """SetVectorAngle(self, double degrees)"""
1535 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1537 def SetPolarCoordinates(self
, angle
, length
):
1538 self
.SetVectorLength(length
)
1539 self
.SetVectorAngle(angle
)
1540 def Normalize(self
):
1541 self
.SetVectorLength(1.0)
1543 def GetDistance(*args
, **kwargs
):
1544 """GetDistance(self, Point2D pt) -> double"""
1545 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1547 def GetDistanceSquare(*args
, **kwargs
):
1548 """GetDistanceSquare(self, Point2D pt) -> double"""
1549 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1551 def GetDotProduct(*args
, **kwargs
):
1552 """GetDotProduct(self, Point2D vec) -> double"""
1553 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1555 def GetCrossProduct(*args
, **kwargs
):
1556 """GetCrossProduct(self, Point2D vec) -> double"""
1557 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1559 def __neg__(*args
, **kwargs
):
1561 __neg__(self) -> Point2D
1563 the reflection of this point
1565 return _core_
.Point2D___neg__(*args
, **kwargs
)
1567 def __iadd__(*args
, **kwargs
):
1568 """__iadd__(self, Point2D pt) -> Point2D"""
1569 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1571 def __isub__(*args
, **kwargs
):
1572 """__isub__(self, Point2D pt) -> Point2D"""
1573 return _core_
.Point2D___isub__(*args
, **kwargs
)
1575 def __imul__(*args
, **kwargs
):
1576 """__imul__(self, Point2D pt) -> Point2D"""
1577 return _core_
.Point2D___imul__(*args
, **kwargs
)
1579 def __idiv__(*args
, **kwargs
):
1580 """__idiv__(self, Point2D pt) -> Point2D"""
1581 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1583 def __eq__(*args
, **kwargs
):
1585 __eq__(self, PyObject other) -> bool
1587 Test for equality of wx.Point2D objects.
1589 return _core_
.Point2D___eq__(*args
, **kwargs
)
1591 def __ne__(*args
, **kwargs
):
1593 __ne__(self, PyObject other) -> bool
1595 Test for inequality of wx.Point2D objects.
1597 return _core_
.Point2D___ne__(*args
, **kwargs
)
1599 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1600 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1601 def Set(*args
, **kwargs
):
1602 """Set(self, double x=0, double y=0)"""
1603 return _core_
.Point2D_Set(*args
, **kwargs
)
1605 def Get(*args
, **kwargs
):
1609 Return x and y properties as a tuple.
1611 return _core_
.Point2D_Get(*args
, **kwargs
)
1613 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1614 def __str__(self
): return str(self
.Get())
1615 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1616 def __len__(self
): return len(self
.Get())
1617 def __getitem__(self
, index
): return self
.Get()[index
]
1618 def __setitem__(self
, index
, val
):
1619 if index
== 0: self
.x
= val
1620 elif index
== 1: self
.y
= val
1621 else: raise IndexError
1622 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1623 __safe_for_unpickling__
= True
1624 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1626 Floor
= property(GetFloor
,doc
="See `GetFloor`")
1627 Rounded
= property(GetRounded
,doc
="See `GetRounded`")
1628 VectorAngle
= property(GetVectorAngle
,SetVectorAngle
,doc
="See `GetVectorAngle` and `SetVectorAngle`")
1629 VectorLength
= property(GetVectorLength
,SetVectorLength
,doc
="See `GetVectorLength` and `SetVectorLength`")
1630 _core_
.Point2D_swigregister(Point2D
)
1632 def Point2DCopy(*args
, **kwargs
):
1634 Point2DCopy(Point2D pt) -> Point2D
1636 Create a w.Point2D object.
1638 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1641 def Point2DFromPoint(*args
, **kwargs
):
1643 Point2DFromPoint(Point pt) -> Point2D
1645 Create a w.Point2D object.
1647 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1650 #---------------------------------------------------------------------------
1652 FromStart
= _core_
.FromStart
1653 FromCurrent
= _core_
.FromCurrent
1654 FromEnd
= _core_
.FromEnd
1655 class InputStream(object):
1656 """Proxy of C++ InputStream class"""
1657 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1658 __repr__
= _swig_repr
1659 def __init__(self
, *args
, **kwargs
):
1660 """__init__(self, PyObject p) -> InputStream"""
1661 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1662 __swig_destroy__
= _core_
.delete_InputStream
1663 __del__
= lambda self
: None;
1664 def close(*args
, **kwargs
):
1666 return _core_
.InputStream_close(*args
, **kwargs
)
1668 def flush(*args
, **kwargs
):
1670 return _core_
.InputStream_flush(*args
, **kwargs
)
1672 def eof(*args
, **kwargs
):
1673 """eof(self) -> bool"""
1674 return _core_
.InputStream_eof(*args
, **kwargs
)
1676 def read(*args
, **kwargs
):
1677 """read(self, int size=-1) -> PyObject"""
1678 return _core_
.InputStream_read(*args
, **kwargs
)
1680 def readline(*args
, **kwargs
):
1681 """readline(self, int size=-1) -> PyObject"""
1682 return _core_
.InputStream_readline(*args
, **kwargs
)
1684 def readlines(*args
, **kwargs
):
1685 """readlines(self, int sizehint=-1) -> PyObject"""
1686 return _core_
.InputStream_readlines(*args
, **kwargs
)
1688 def seek(*args
, **kwargs
):
1689 """seek(self, int offset, int whence=0)"""
1690 return _core_
.InputStream_seek(*args
, **kwargs
)
1692 def tell(*args
, **kwargs
):
1693 """tell(self) -> int"""
1694 return _core_
.InputStream_tell(*args
, **kwargs
)
1696 def Peek(*args
, **kwargs
):
1697 """Peek(self) -> char"""
1698 return _core_
.InputStream_Peek(*args
, **kwargs
)
1700 def GetC(*args
, **kwargs
):
1701 """GetC(self) -> char"""
1702 return _core_
.InputStream_GetC(*args
, **kwargs
)
1704 def LastRead(*args
, **kwargs
):
1705 """LastRead(self) -> size_t"""
1706 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1708 def CanRead(*args
, **kwargs
):
1709 """CanRead(self) -> bool"""
1710 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1712 def Eof(*args
, **kwargs
):
1713 """Eof(self) -> bool"""
1714 return _core_
.InputStream_Eof(*args
, **kwargs
)
1716 def Ungetch(*args
, **kwargs
):
1717 """Ungetch(self, char c) -> bool"""
1718 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1720 def SeekI(*args
, **kwargs
):
1721 """SeekI(self, long pos, int mode=FromStart) -> long"""
1722 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1724 def TellI(*args
, **kwargs
):
1725 """TellI(self) -> long"""
1726 return _core_
.InputStream_TellI(*args
, **kwargs
)
1728 _core_
.InputStream_swigregister(InputStream
)
1729 DefaultPosition
= cvar
.DefaultPosition
1730 DefaultSize
= cvar
.DefaultSize
1732 class OutputStream(object):
1733 """Proxy of C++ OutputStream class"""
1734 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1735 def __init__(self
): raise AttributeError, "No constructor defined"
1736 __repr__
= _swig_repr
1737 def write(*args
, **kwargs
):
1738 """write(self, PyObject obj)"""
1739 return _core_
.OutputStream_write(*args
, **kwargs
)
1741 def LastWrite(*args
, **kwargs
):
1742 """LastWrite(self) -> size_t"""
1743 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
1745 _core_
.OutputStream_swigregister(OutputStream
)
1747 #---------------------------------------------------------------------------
1749 class FSFile(Object
):
1750 """Proxy of C++ FSFile class"""
1751 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1752 __repr__
= _swig_repr
1753 def __init__(self
, *args
, **kwargs
):
1755 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1756 DateTime modif) -> FSFile
1758 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
1759 __swig_destroy__
= _core_
.delete_FSFile
1760 __del__
= lambda self
: None;
1761 def GetStream(*args
, **kwargs
):
1762 """GetStream(self) -> InputStream"""
1763 return _core_
.FSFile_GetStream(*args
, **kwargs
)
1765 def DetachStream(*args
, **kwargs
):
1766 """DetachStream(self)"""
1767 return _core_
.FSFile_DetachStream(*args
, **kwargs
)
1769 def GetMimeType(*args
, **kwargs
):
1770 """GetMimeType(self) -> String"""
1771 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
1773 def GetLocation(*args
, **kwargs
):
1774 """GetLocation(self) -> String"""
1775 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
1777 def GetAnchor(*args
, **kwargs
):
1778 """GetAnchor(self) -> String"""
1779 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
1781 def GetModificationTime(*args
, **kwargs
):
1782 """GetModificationTime(self) -> DateTime"""
1783 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
1785 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
1786 Location
= property(GetLocation
,doc
="See `GetLocation`")
1787 MimeType
= property(GetMimeType
,doc
="See `GetMimeType`")
1788 ModificationTime
= property(GetModificationTime
,doc
="See `GetModificationTime`")
1789 Stream
= property(GetStream
,doc
="See `GetStream`")
1790 _core_
.FSFile_swigregister(FSFile
)
1792 class CPPFileSystemHandler(object):
1793 """Proxy of C++ CPPFileSystemHandler class"""
1794 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1795 def __init__(self
): raise AttributeError, "No constructor defined"
1796 __repr__
= _swig_repr
1797 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
1798 __del__
= lambda self
: None;
1799 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
1801 class FileSystemHandler(CPPFileSystemHandler
):
1802 """Proxy of C++ FileSystemHandler class"""
1803 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1804 __repr__
= _swig_repr
1805 def __init__(self
, *args
, **kwargs
):
1806 """__init__(self) -> FileSystemHandler"""
1807 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
1808 self
._setCallbackInfo
(self
, FileSystemHandler
)
1810 def _setCallbackInfo(*args
, **kwargs
):
1811 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1812 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
1814 def CanOpen(*args
, **kwargs
):
1815 """CanOpen(self, String location) -> bool"""
1816 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
1818 def OpenFile(*args
, **kwargs
):
1819 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1820 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
1822 def FindFirst(*args
, **kwargs
):
1823 """FindFirst(self, String spec, int flags=0) -> String"""
1824 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
1826 def FindNext(*args
, **kwargs
):
1827 """FindNext(self) -> String"""
1828 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
1830 def GetProtocol(*args
, **kwargs
):
1831 """GetProtocol(self, String location) -> String"""
1832 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
1834 def GetLeftLocation(*args
, **kwargs
):
1835 """GetLeftLocation(self, String location) -> String"""
1836 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
1838 def GetAnchor(*args
, **kwargs
):
1839 """GetAnchor(self, String location) -> String"""
1840 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
1842 def GetRightLocation(*args
, **kwargs
):
1843 """GetRightLocation(self, String location) -> String"""
1844 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
1846 def GetMimeTypeFromExt(*args
, **kwargs
):
1847 """GetMimeTypeFromExt(self, String location) -> String"""
1848 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
1850 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
1851 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
1852 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
1853 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
1854 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
1855 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
1857 class FileSystem(Object
):
1858 """Proxy of C++ FileSystem class"""
1859 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1860 __repr__
= _swig_repr
1861 def __init__(self
, *args
, **kwargs
):
1862 """__init__(self) -> FileSystem"""
1863 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
1864 __swig_destroy__
= _core_
.delete_FileSystem
1865 __del__
= lambda self
: None;
1866 def ChangePathTo(*args
, **kwargs
):
1867 """ChangePathTo(self, String location, bool is_dir=False)"""
1868 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
1870 def GetPath(*args
, **kwargs
):
1871 """GetPath(self) -> String"""
1872 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
1874 def OpenFile(*args
, **kwargs
):
1875 """OpenFile(self, String location) -> FSFile"""
1876 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
1878 def FindFirst(*args
, **kwargs
):
1879 """FindFirst(self, String spec, int flags=0) -> String"""
1880 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
1882 def FindNext(*args
, **kwargs
):
1883 """FindNext(self) -> String"""
1884 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
1886 def AddHandler(*args
, **kwargs
):
1887 """AddHandler(CPPFileSystemHandler handler)"""
1888 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1890 AddHandler
= staticmethod(AddHandler
)
1891 def RemoveHandler(*args
, **kwargs
):
1892 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1893 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
1895 RemoveHandler
= staticmethod(RemoveHandler
)
1896 def CleanUpHandlers(*args
, **kwargs
):
1897 """CleanUpHandlers()"""
1898 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
1900 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
1901 def FileNameToURL(*args
, **kwargs
):
1902 """FileNameToURL(String filename) -> String"""
1903 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1905 FileNameToURL
= staticmethod(FileNameToURL
)
1906 def URLToFileName(*args
, **kwargs
):
1907 """URLToFileName(String url) -> String"""
1908 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1910 URLToFileName
= staticmethod(URLToFileName
)
1911 Path
= property(GetPath
,doc
="See `GetPath`")
1912 _core_
.FileSystem_swigregister(FileSystem
)
1914 def FileSystem_AddHandler(*args
, **kwargs
):
1915 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1916 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1918 def FileSystem_RemoveHandler(*args
, **kwargs
):
1919 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1920 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
1922 def FileSystem_CleanUpHandlers(*args
):
1923 """FileSystem_CleanUpHandlers()"""
1924 return _core_
.FileSystem_CleanUpHandlers(*args
)
1926 def FileSystem_FileNameToURL(*args
, **kwargs
):
1927 """FileSystem_FileNameToURL(String filename) -> String"""
1928 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1930 def FileSystem_URLToFileName(*args
, **kwargs
):
1931 """FileSystem_URLToFileName(String url) -> String"""
1932 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1934 class InternetFSHandler(CPPFileSystemHandler
):
1935 """Proxy of C++ InternetFSHandler class"""
1936 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1937 __repr__
= _swig_repr
1938 def __init__(self
, *args
, **kwargs
):
1939 """__init__(self) -> InternetFSHandler"""
1940 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
1941 def CanOpen(*args
, **kwargs
):
1942 """CanOpen(self, String location) -> bool"""
1943 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
1945 def OpenFile(*args
, **kwargs
):
1946 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1947 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
1949 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
1951 class ZipFSHandler(CPPFileSystemHandler
):
1952 """Proxy of C++ ZipFSHandler class"""
1953 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1954 __repr__
= _swig_repr
1955 def __init__(self
, *args
, **kwargs
):
1956 """__init__(self) -> ZipFSHandler"""
1957 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
1958 def CanOpen(*args
, **kwargs
):
1959 """CanOpen(self, String location) -> bool"""
1960 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
1962 def OpenFile(*args
, **kwargs
):
1963 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1964 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
1966 def FindFirst(*args
, **kwargs
):
1967 """FindFirst(self, String spec, int flags=0) -> String"""
1968 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
1970 def FindNext(*args
, **kwargs
):
1971 """FindNext(self) -> String"""
1972 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
1974 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
1977 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
1978 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1979 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
1981 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
1982 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1983 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
1985 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
1986 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1987 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
1988 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
1990 Add 'file' to the memory filesystem. The dataItem parameter can
1991 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1992 arbitrary data. If a bitmap or image is used then the imgType
1993 parameter should specify what kind of image file it should be
1994 written as, wx.BITMAP_TYPE_PNG, etc.
1996 if isinstance(dataItem
, wx
.Image
):
1997 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
1998 elif isinstance(dataItem
, wx
.Bitmap
):
1999 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2000 elif type(dataItem
) == str:
2001 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2003 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2005 class MemoryFSHandler(CPPFileSystemHandler
):
2006 """Proxy of C++ MemoryFSHandler class"""
2007 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2008 __repr__
= _swig_repr
2009 def __init__(self
, *args
, **kwargs
):
2010 """__init__(self) -> MemoryFSHandler"""
2011 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
2012 def RemoveFile(*args
, **kwargs
):
2013 """RemoveFile(String filename)"""
2014 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2016 RemoveFile
= staticmethod(RemoveFile
)
2017 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2018 def CanOpen(*args
, **kwargs
):
2019 """CanOpen(self, String location) -> bool"""
2020 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2022 def OpenFile(*args
, **kwargs
):
2023 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2024 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2026 def FindFirst(*args
, **kwargs
):
2027 """FindFirst(self, String spec, int flags=0) -> String"""
2028 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2030 def FindNext(*args
, **kwargs
):
2031 """FindNext(self) -> String"""
2032 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2034 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2036 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2037 """MemoryFSHandler_RemoveFile(String filename)"""
2038 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2040 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2041 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2042 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2043 IMAGE_QUALITY_NORMAL
= _core_
.IMAGE_QUALITY_NORMAL
2044 IMAGE_QUALITY_HIGH
= _core_
.IMAGE_QUALITY_HIGH
2045 #---------------------------------------------------------------------------
2047 class ImageHandler(Object
):
2049 This is the base class for implementing image file loading/saving, and
2050 image creation from data. It is used within `wx.Image` and is not
2051 normally seen by the application.
2053 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2054 def __init__(self
): raise AttributeError, "No constructor defined"
2055 __repr__
= _swig_repr
2056 def GetName(*args
, **kwargs
):
2057 """GetName(self) -> String"""
2058 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2060 def GetExtension(*args
, **kwargs
):
2061 """GetExtension(self) -> String"""
2062 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2064 def GetType(*args
, **kwargs
):
2065 """GetType(self) -> long"""
2066 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2068 def GetMimeType(*args
, **kwargs
):
2069 """GetMimeType(self) -> String"""
2070 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2072 def CanRead(*args
, **kwargs
):
2073 """CanRead(self, String name) -> bool"""
2074 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2076 def CanReadStream(*args
, **kwargs
):
2077 """CanReadStream(self, InputStream stream) -> bool"""
2078 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2080 def SetName(*args
, **kwargs
):
2081 """SetName(self, String name)"""
2082 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2084 def SetExtension(*args
, **kwargs
):
2085 """SetExtension(self, String extension)"""
2086 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2088 def SetType(*args
, **kwargs
):
2089 """SetType(self, long type)"""
2090 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2092 def SetMimeType(*args
, **kwargs
):
2093 """SetMimeType(self, String mimetype)"""
2094 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2096 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2097 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2098 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2099 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2100 _core_
.ImageHandler_swigregister(ImageHandler
)
2102 class PyImageHandler(ImageHandler
):
2104 This is the base class for implementing image file loading/saving, and
2105 image creation from data, all written in Python. To create a custom
2106 image handler derive a new class from wx.PyImageHandler and provide
2107 the following methods::
2109 def DoCanRead(self, stream) --> bool
2110 '''Check if this handler can read the image on the stream'''
2112 def LoadFile(self, image, stream, verbose, index) --> bool
2113 '''Load image data from the stream and load it into image.'''
2115 def SaveFile(self, image, stream, verbose) --> bool
2116 '''Save the iamge data in image to the stream using
2117 this handler's image file format.'''
2119 def GetImageCount(self, stream) --> int
2120 '''If this image format can hold more than one image,
2121 how many does the image on the stream have?'''
2123 To activate your handler create an instance of it and pass it to
2124 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2125 `SetExtension` from your constructor.
2128 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2129 __repr__
= _swig_repr
2130 def __init__(self
, *args
, **kwargs
):
2132 __init__(self) -> PyImageHandler
2134 This is the base class for implementing image file loading/saving, and
2135 image creation from data, all written in Python. To create a custom
2136 image handler derive a new class from wx.PyImageHandler and provide
2137 the following methods::
2139 def DoCanRead(self, stream) --> bool
2140 '''Check if this handler can read the image on the stream'''
2142 def LoadFile(self, image, stream, verbose, index) --> bool
2143 '''Load image data from the stream and load it into image.'''
2145 def SaveFile(self, image, stream, verbose) --> bool
2146 '''Save the iamge data in image to the stream using
2147 this handler's image file format.'''
2149 def GetImageCount(self, stream) --> int
2150 '''If this image format can hold more than one image,
2151 how many does the image on the stream have?'''
2153 To activate your handler create an instance of it and pass it to
2154 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2155 `SetExtension` from your constructor.
2158 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2161 def _SetSelf(*args
, **kwargs
):
2162 """_SetSelf(self, PyObject self)"""
2163 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2165 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2167 class ImageHistogram(object):
2168 """Proxy of C++ ImageHistogram class"""
2169 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2170 __repr__
= _swig_repr
2171 def __init__(self
, *args
, **kwargs
):
2172 """__init__(self) -> ImageHistogram"""
2173 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2174 def MakeKey(*args
, **kwargs
):
2176 MakeKey(byte r, byte g, byte b) -> unsigned long
2178 Get the key in the histogram for the given RGB values
2180 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2182 MakeKey
= staticmethod(MakeKey
)
2183 def FindFirstUnusedColour(*args
, **kwargs
):
2185 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2187 Find first colour that is not used in the image and has higher RGB
2188 values than startR, startG, startB. Returns a tuple consisting of a
2189 success flag and rgb values.
2191 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2193 def GetCount(*args
, **kwargs
):
2195 GetCount(self, unsigned long key) -> unsigned long
2197 Returns the pixel count for the given key. Use `MakeKey` to create a
2198 key value from a RGB tripple.
2200 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2202 def GetCountRGB(*args
, **kwargs
):
2204 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2206 Returns the pixel count for the given RGB values.
2208 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2210 def GetCountColour(*args
, **kwargs
):
2212 GetCountColour(self, Colour colour) -> unsigned long
2214 Returns the pixel count for the given `wx.Colour` value.
2216 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2218 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2220 def ImageHistogram_MakeKey(*args
, **kwargs
):
2222 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2224 Get the key in the histogram for the given RGB values
2226 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2228 class Image_RGBValue(object):
2230 An object that contains values for red, green and blue which represent
2231 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2232 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2235 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2236 __repr__
= _swig_repr
2237 def __init__(self
, *args
, **kwargs
):
2239 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2243 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2244 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2245 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2246 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2247 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2249 class Image_HSVValue(object):
2251 An object that contains values for hue, saturation and value which
2252 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2253 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2256 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2257 __repr__
= _swig_repr
2258 def __init__(self
, *args
, **kwargs
):
2260 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2264 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2265 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2266 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2267 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2268 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2270 class Image(Object
):
2272 A platform-independent image class. An image can be created from
2273 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2274 variety of formats. Functions are available to set and get image
2275 bits, so it can be used for basic image manipulation.
2277 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2278 platform-specific `wx.Bitmap` object must be created from it using the
2279 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2280 device context, using `wx.DC.DrawBitmap`.
2282 One colour value of the image may be used as a mask colour which will
2283 lead to the automatic creation of a `wx.Mask` object associated to the
2286 wx.Image supports alpha channel data, that is in addition to a byte
2287 for the red, green and blue colour components for each pixel it also
2288 stores a byte representing the pixel opacity. An alpha value of 0
2289 corresponds to a transparent pixel (null opacity) while a value of 255
2290 means that the pixel is 100% opaque.
2292 Unlike RGB data, not all images have an alpha channel and before using
2293 `GetAlpha` you should check if this image contains an alpha channel
2294 with `HasAlpha`. Note that currently only images loaded from PNG files
2295 with transparency information will have an alpha channel.
2297 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2298 __repr__
= _swig_repr
2299 def __init__(self
, *args
, **kwargs
):
2301 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2303 Loads an image from a file.
2305 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2306 __swig_destroy__
= _core_
.delete_Image
2307 __del__
= lambda self
: None;
2308 def Create(*args
, **kwargs
):
2310 Create(self, int width, int height, bool clear=True)
2312 Creates a fresh image. If clear is ``True``, the new image will be
2313 initialized to black. Otherwise, the image data will be uninitialized.
2315 return _core_
.Image_Create(*args
, **kwargs
)
2317 def Destroy(*args
, **kwargs
):
2321 Destroys the image data.
2323 args
[0].this
.own(False)
2324 return _core_
.Image_Destroy(*args
, **kwargs
)
2326 def Scale(*args
, **kwargs
):
2328 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2330 Returns a scaled version of the image. This is also useful for scaling
2331 bitmaps in general as the only other way to scale bitmaps is to blit a
2332 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2333 specifies what method to use for resampling the image. It can be
2334 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2335 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2336 bicubic and box averaging resampling methods for upsampling and
2337 downsampling respectively.
2339 return _core_
.Image_Scale(*args
, **kwargs
)
2341 def ResampleBox(*args
, **kwargs
):
2342 """ResampleBox(self, int width, int height) -> Image"""
2343 return _core_
.Image_ResampleBox(*args
, **kwargs
)
2345 def ResampleBicubic(*args
, **kwargs
):
2346 """ResampleBicubic(self, int width, int height) -> Image"""
2347 return _core_
.Image_ResampleBicubic(*args
, **kwargs
)
2349 def Blur(*args
, **kwargs
):
2351 Blur(self, int radius) -> Image
2353 Blurs the image in both horizontal and vertical directions by the
2354 specified pixel ``radius``. This should not be used when using a
2355 single mask colour for transparency.
2357 return _core_
.Image_Blur(*args
, **kwargs
)
2359 def BlurHorizontal(*args
, **kwargs
):
2361 BlurHorizontal(self, int radius) -> Image
2363 Blurs the image in the horizontal direction only. This should not be
2364 used when using a single mask colour for transparency.
2367 return _core_
.Image_BlurHorizontal(*args
, **kwargs
)
2369 def BlurVertical(*args
, **kwargs
):
2371 BlurVertical(self, int radius) -> Image
2373 Blurs the image in the vertical direction only. This should not be
2374 used when using a single mask colour for transparency.
2376 return _core_
.Image_BlurVertical(*args
, **kwargs
)
2378 def ShrinkBy(*args
, **kwargs
):
2380 ShrinkBy(self, int xFactor, int yFactor) -> Image
2382 Return a version of the image scaled smaller by the given factors.
2384 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2386 def Rescale(*args
, **kwargs
):
2388 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2390 Changes the size of the image in-place by scaling it: after a call to
2391 this function, the image will have the given width and height.
2393 Returns the (modified) image itself.
2395 return _core_
.Image_Rescale(*args
, **kwargs
)
2397 def Resize(*args
, **kwargs
):
2399 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2401 Changes the size of the image in-place without scaling it, by adding
2402 either a border with the given colour or cropping as necessary. The
2403 image is pasted into a new image with the given size and background
2404 colour at the position pos relative to the upper left of the new
2405 image. If red = green = blue = -1 then use either the current mask
2406 colour if set or find, use, and set a suitable mask colour for any
2407 newly exposed areas.
2409 Returns the (modified) image itself.
2411 return _core_
.Image_Resize(*args
, **kwargs
)
2413 def SetRGB(*args
, **kwargs
):
2415 SetRGB(self, int x, int y, byte r, byte g, byte b)
2417 Sets the pixel at the given coordinate. This routine performs
2418 bounds-checks for the coordinate so it can be considered a safe way to
2419 manipulate the data, but in some cases this might be too slow so that
2420 the data will have to be set directly. In that case you will have to
2421 get access to the image data using the `GetData` method.
2423 return _core_
.Image_SetRGB(*args
, **kwargs
)
2425 def SetRGBRect(*args
, **kwargs
):
2427 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2429 Sets the colour of the pixels within the given rectangle. This routine
2430 performs bounds-checks for the rectangle so it can be considered a
2431 safe way to manipulate the data.
2433 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2435 def GetRed(*args
, **kwargs
):
2437 GetRed(self, int x, int y) -> byte
2439 Returns the red intensity at the given coordinate.
2441 return _core_
.Image_GetRed(*args
, **kwargs
)
2443 def GetGreen(*args
, **kwargs
):
2445 GetGreen(self, int x, int y) -> byte
2447 Returns the green intensity at the given coordinate.
2449 return _core_
.Image_GetGreen(*args
, **kwargs
)
2451 def GetBlue(*args
, **kwargs
):
2453 GetBlue(self, int x, int y) -> byte
2455 Returns the blue intensity at the given coordinate.
2457 return _core_
.Image_GetBlue(*args
, **kwargs
)
2459 def SetAlpha(*args
, **kwargs
):
2461 SetAlpha(self, int x, int y, byte alpha)
2463 Sets the alpha value for the given pixel. This function should only be
2464 called if the image has alpha channel data, use `HasAlpha` to check
2467 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2469 def GetAlpha(*args
, **kwargs
):
2471 GetAlpha(self, int x, int y) -> byte
2473 Returns the alpha value for the given pixel. This function may only be
2474 called for the images with alpha channel, use `HasAlpha` to check for
2477 The returned value is the *opacity* of the image, i.e. the value of 0
2478 corresponds to the fully transparent pixels while the value of 255 to
2479 the fully opaque pixels.
2481 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2483 def HasAlpha(*args
, **kwargs
):
2485 HasAlpha(self) -> bool
2487 Returns true if this image has alpha channel, false otherwise.
2489 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2491 def InitAlpha(*args
, **kwargs
):
2495 Initializes the image alpha channel data. It is an error to call it if
2496 the image already has alpha data. If it doesn't, alpha data will be by
2497 default initialized to all pixels being fully opaque. But if the image
2498 has a a mask colour, all mask pixels will be completely transparent.
2500 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2502 def IsTransparent(*args
, **kwargs
):
2504 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2506 Returns ``True`` if this pixel is masked or has an alpha value less
2507 than the spcified threshold.
2509 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2511 def FindFirstUnusedColour(*args
, **kwargs
):
2513 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2515 Find first colour that is not used in the image and has higher RGB
2516 values than startR, startG, startB. Returns a tuple consisting of a
2517 success flag and rgb values.
2519 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2521 def ConvertAlphaToMask(*args
, **kwargs
):
2523 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2525 If the image has alpha channel, this method converts it to mask. All
2526 pixels with alpha value less than ``threshold`` are replaced with the
2527 mask colour and the alpha channel is removed. The mask colour is
2528 chosen automatically using `FindFirstUnusedColour`.
2530 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2533 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2535 def ConvertColourToAlpha(*args
, **kwargs
):
2537 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2539 This method converts an image where the original alpha information is
2540 only available as a shades of a colour (actually shades of grey)
2541 typically when you draw anti-aliased text into a bitmap. The DC
2542 drawing routines draw grey values on the black background although
2543 they actually mean to draw white with differnt alpha values. This
2544 method reverses it, assuming a black (!) background and white text.
2545 The method will then fill up the whole image with the colour given.
2547 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2549 def SetMaskFromImage(*args
, **kwargs
):
2551 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2553 Sets the image's mask so that the pixels that have RGB value of
2554 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2555 by first finding an unused colour in the image, setting this colour as
2556 the mask colour and then using this colour to draw all pixels in the
2557 image who corresponding pixel in mask has given RGB value.
2559 Returns ``False`` if ``mask`` does not have same dimensions as the
2560 image or if there is no unused colour left. Returns ``True`` if the
2561 mask was successfully applied.
2563 Note that this method involves computing the histogram, which is
2564 computationally intensive operation.
2566 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2568 def CanRead(*args
, **kwargs
):
2570 CanRead(String filename) -> bool
2572 Returns True if the image handlers can read this file.
2574 return _core_
.Image_CanRead(*args
, **kwargs
)
2576 CanRead
= staticmethod(CanRead
)
2577 def GetImageCount(*args
, **kwargs
):
2579 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2581 If the image file contains more than one image and the image handler
2582 is capable of retrieving these individually, this function will return
2583 the number of available images.
2585 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2587 GetImageCount
= staticmethod(GetImageCount
)
2588 def LoadFile(*args
, **kwargs
):
2590 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2592 Loads an image from a file. If no handler type is provided, the
2593 library will try to autodetect the format.
2595 return _core_
.Image_LoadFile(*args
, **kwargs
)
2597 def LoadMimeFile(*args
, **kwargs
):
2599 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2601 Loads an image from a file, specifying the image type with a MIME type
2604 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2606 def SaveFile(*args
, **kwargs
):
2608 SaveFile(self, String name, int type) -> bool
2610 Saves an image in the named file.
2612 return _core_
.Image_SaveFile(*args
, **kwargs
)
2614 def SaveMimeFile(*args
, **kwargs
):
2616 SaveMimeFile(self, String name, String mimetype) -> bool
2618 Saves an image in the named file.
2620 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2622 def CanReadStream(*args
, **kwargs
):
2624 CanReadStream(InputStream stream) -> bool
2626 Returns True if the image handlers can read an image file from the
2627 data currently on the input stream, or a readable Python file-like
2630 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2632 CanReadStream
= staticmethod(CanReadStream
)
2633 def LoadStream(*args
, **kwargs
):
2635 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2637 Loads an image from an input stream or a readable Python file-like
2638 object. If no handler type is provided, the library will try to
2639 autodetect the format.
2641 return _core_
.Image_LoadStream(*args
, **kwargs
)
2643 def LoadMimeStream(*args
, **kwargs
):
2645 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2647 Loads an image from an input stream or a readable Python file-like
2648 object, using a MIME type string to specify the image file format.
2650 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2652 def IsOk(*args
, **kwargs
):
2656 Returns true if image data is present.
2658 return _core_
.Image_IsOk(*args
, **kwargs
)
2661 def GetWidth(*args
, **kwargs
):
2663 GetWidth(self) -> int
2665 Gets the width of the image in pixels.
2667 return _core_
.Image_GetWidth(*args
, **kwargs
)
2669 def GetHeight(*args
, **kwargs
):
2671 GetHeight(self) -> int
2673 Gets the height of the image in pixels.
2675 return _core_
.Image_GetHeight(*args
, **kwargs
)
2677 def GetSize(*args
, **kwargs
):
2679 GetSize(self) -> Size
2681 Returns the size of the image in pixels.
2683 return _core_
.Image_GetSize(*args
, **kwargs
)
2685 def GetSubImage(*args
, **kwargs
):
2687 GetSubImage(self, Rect rect) -> Image
2689 Returns a sub image of the current one as long as the rect belongs
2690 entirely to the image.
2692 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2694 def Size(*args
, **kwargs
):
2696 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2698 Returns a resized version of this image without scaling it by adding
2699 either a border with the given colour or cropping as necessary. The
2700 image is pasted into a new image with the given size and background
2701 colour at the position ``pos`` relative to the upper left of the new
2702 image. If red = green = blue = -1 then use either the current mask
2703 colour if set or find, use, and set a suitable mask colour for any
2704 newly exposed areas.
2706 return _core_
.Image_Size(*args
, **kwargs
)
2708 def Copy(*args
, **kwargs
):
2712 Returns an identical copy of the image.
2714 return _core_
.Image_Copy(*args
, **kwargs
)
2716 def Paste(*args
, **kwargs
):
2718 Paste(self, Image image, int x, int y)
2720 Pastes ``image`` into this instance and takes care of the mask colour
2721 and any out of bounds problems.
2723 return _core_
.Image_Paste(*args
, **kwargs
)
2725 def GetData(*args
, **kwargs
):
2727 GetData(self) -> PyObject
2729 Returns a string containing a copy of the RGB bytes of the image.
2731 return _core_
.Image_GetData(*args
, **kwargs
)
2733 def SetData(*args
, **kwargs
):
2735 SetData(self, buffer data)
2737 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2738 either a string or a buffer object holding the data and the length of
2739 the data must be width*height*3.
2741 return _core_
.Image_SetData(*args
, **kwargs
)
2743 def GetDataBuffer(*args
, **kwargs
):
2745 GetDataBuffer(self) -> PyObject
2747 Returns a writable Python buffer object that is pointing at the RGB
2748 image data buffer inside the wx.Image. You need to ensure that you do
2749 not use this buffer object after the image has been destroyed.
2751 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
2753 def SetDataBuffer(*args
, **kwargs
):
2755 SetDataBuffer(self, buffer data)
2757 Sets the internal image data pointer to point at a Python buffer
2758 object. This can save making an extra copy of the data but you must
2759 ensure that the buffer object lives longer than the wx.Image does.
2761 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
2763 def GetAlphaData(*args
, **kwargs
):
2765 GetAlphaData(self) -> PyObject
2767 Returns a string containing a copy of the alpha bytes of the image.
2769 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
2771 def SetAlphaData(*args
, **kwargs
):
2773 SetAlphaData(self, buffer alpha)
2775 Resets the Image's alpha data from a buffer of bytes. Accepts either
2776 a string or a buffer object holding the data and the length of the
2777 data must be width*height.
2779 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
2781 def GetAlphaBuffer(*args
, **kwargs
):
2783 GetAlphaBuffer(self) -> PyObject
2785 Returns a writable Python buffer object that is pointing at the Alpha
2786 data buffer inside the wx.Image. You need to ensure that you do not
2787 use this buffer object after the image has been destroyed.
2789 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
2791 def SetAlphaBuffer(*args
, **kwargs
):
2793 SetAlphaBuffer(self, buffer alpha)
2795 Sets the internal image alpha pointer to point at a Python buffer
2796 object. This can save making an extra copy of the data but you must
2797 ensure that the buffer object lives as long as the wx.Image does.
2799 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
2801 def SetMaskColour(*args
, **kwargs
):
2803 SetMaskColour(self, byte r, byte g, byte b)
2805 Sets the mask colour for this image (and tells the image to use the
2808 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
2810 def GetOrFindMaskColour(*args
, **kwargs
):
2812 GetOrFindMaskColour() -> (r,g,b)
2814 Get the current mask colour or find a suitable colour.
2816 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
2818 def GetMaskRed(*args
, **kwargs
):
2820 GetMaskRed(self) -> byte
2822 Gets the red component of the mask colour.
2824 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
2826 def GetMaskGreen(*args
, **kwargs
):
2828 GetMaskGreen(self) -> byte
2830 Gets the green component of the mask colour.
2832 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
2834 def GetMaskBlue(*args
, **kwargs
):
2836 GetMaskBlue(self) -> byte
2838 Gets the blue component of the mask colour.
2840 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
2842 def SetMask(*args
, **kwargs
):
2844 SetMask(self, bool mask=True)
2846 Specifies whether there is a mask or not. The area of the mask is
2847 determined by the current mask colour.
2849 return _core_
.Image_SetMask(*args
, **kwargs
)
2851 def HasMask(*args
, **kwargs
):
2853 HasMask(self) -> bool
2855 Returns ``True`` if there is a mask active, ``False`` otherwise.
2857 return _core_
.Image_HasMask(*args
, **kwargs
)
2859 def Rotate(*args
, **kwargs
):
2861 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2862 Point offset_after_rotation=None) -> Image
2864 Rotates the image about the given point, by ``angle`` radians. Passing
2865 ``True`` to ``interpolating`` results in better image quality, but is
2866 slower. If the image has a mask, then the mask colour is used for the
2867 uncovered pixels in the rotated image background. Otherwise, black
2868 will be used as the fill colour.
2870 Returns the rotated image, leaving this image intact.
2872 return _core_
.Image_Rotate(*args
, **kwargs
)
2874 def Rotate90(*args
, **kwargs
):
2876 Rotate90(self, bool clockwise=True) -> Image
2878 Returns a copy of the image rotated 90 degrees in the direction
2879 indicated by ``clockwise``.
2881 return _core_
.Image_Rotate90(*args
, **kwargs
)
2883 def Mirror(*args
, **kwargs
):
2885 Mirror(self, bool horizontally=True) -> Image
2887 Returns a mirrored copy of the image. The parameter ``horizontally``
2888 indicates the orientation.
2890 return _core_
.Image_Mirror(*args
, **kwargs
)
2892 def Replace(*args
, **kwargs
):
2894 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2896 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2899 return _core_
.Image_Replace(*args
, **kwargs
)
2901 def ConvertToGreyscale(*args
, **kwargs
):
2903 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2905 Convert to greyscale image. Uses the luminance component (Y) of the
2906 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2907 defaults to ITU-T BT.601
2909 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
2911 def ConvertToMono(*args
, **kwargs
):
2913 ConvertToMono(self, byte r, byte g, byte b) -> Image
2915 Returns monochromatic version of the image. The returned image has
2916 white colour where the original has ``(r,g,b)`` colour and black
2917 colour everywhere else.
2919 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
2921 def SetOption(*args
, **kwargs
):
2923 SetOption(self, String name, String value)
2925 Sets an image handler defined option. For example, when saving as a
2926 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2927 number between 0 and 100 (0 is terrible, 100 is very good).
2929 return _core_
.Image_SetOption(*args
, **kwargs
)
2931 def SetOptionInt(*args
, **kwargs
):
2933 SetOptionInt(self, String name, int value)
2935 Sets an image option as an integer.
2937 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
2939 def GetOption(*args
, **kwargs
):
2941 GetOption(self, String name) -> String
2943 Gets the value of an image handler option.
2945 return _core_
.Image_GetOption(*args
, **kwargs
)
2947 def GetOptionInt(*args
, **kwargs
):
2949 GetOptionInt(self, String name) -> int
2951 Gets the value of an image handler option as an integer. If the given
2952 option is not present, the function returns 0.
2954 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
2956 def HasOption(*args
, **kwargs
):
2958 HasOption(self, String name) -> bool
2960 Returns true if the given option is present.
2962 return _core_
.Image_HasOption(*args
, **kwargs
)
2964 def CountColours(*args
, **kwargs
):
2965 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2966 return _core_
.Image_CountColours(*args
, **kwargs
)
2968 def ComputeHistogram(*args
, **kwargs
):
2969 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2970 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
2972 def AddHandler(*args
, **kwargs
):
2973 """AddHandler(ImageHandler handler)"""
2974 return _core_
.Image_AddHandler(*args
, **kwargs
)
2976 AddHandler
= staticmethod(AddHandler
)
2977 def InsertHandler(*args
, **kwargs
):
2978 """InsertHandler(ImageHandler handler)"""
2979 return _core_
.Image_InsertHandler(*args
, **kwargs
)
2981 InsertHandler
= staticmethod(InsertHandler
)
2982 def RemoveHandler(*args
, **kwargs
):
2983 """RemoveHandler(String name) -> bool"""
2984 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
2986 RemoveHandler
= staticmethod(RemoveHandler
)
2987 def GetHandlers(*args
, **kwargs
):
2988 """GetHandlers() -> PyObject"""
2989 return _core_
.Image_GetHandlers(*args
, **kwargs
)
2991 GetHandlers
= staticmethod(GetHandlers
)
2992 def GetImageExtWildcard(*args
, **kwargs
):
2994 GetImageExtWildcard() -> String
2996 Iterates all registered wxImageHandler objects, and returns a string
2997 containing file extension masks suitable for passing to file open/save
3000 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3002 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3003 def ConvertToBitmap(*args
, **kwargs
):
3004 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3005 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3007 def ConvertToMonoBitmap(*args
, **kwargs
):
3008 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3009 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3011 def RotateHue(*args
, **kwargs
):
3013 RotateHue(self, double angle)
3015 Rotates the hue of each pixel of the image. Hue is a double in the
3016 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3018 return _core_
.Image_RotateHue(*args
, **kwargs
)
3020 def RGBtoHSV(*args
, **kwargs
):
3022 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3024 Converts a color in RGB color space to HSV color space.
3026 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3028 RGBtoHSV
= staticmethod(RGBtoHSV
)
3029 def HSVtoRGB(*args
, **kwargs
):
3031 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3033 Converts a color in HSV color space to RGB color space.
3035 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3037 HSVtoRGB
= staticmethod(HSVtoRGB
)
3038 def __nonzero__(self
): return self
.IsOk()
3039 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3040 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
3041 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
3042 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
3043 Height
= property(GetHeight
,doc
="See `GetHeight`")
3044 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
3045 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
3046 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
3047 Size
= property(GetSize
,doc
="See `GetSize`")
3048 Width
= property(GetWidth
,doc
="See `GetWidth`")
3049 _core_
.Image_swigregister(Image
)
3051 def ImageFromMime(*args
, **kwargs
):
3053 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3055 Loads an image from a file, using a MIME type string (such as
3056 'image/jpeg') to specify image type.
3058 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3061 def ImageFromStream(*args
, **kwargs
):
3063 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3065 Loads an image from an input stream, or any readable Python file-like
3068 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3071 def ImageFromStreamMime(*args
, **kwargs
):
3073 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3075 Loads an image from an input stream, or any readable Python file-like
3076 object, specifying the image format with a MIME type string.
3078 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3081 def EmptyImage(*args
, **kwargs
):
3083 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3085 Construct an empty image of a given size, optionally setting all
3088 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3091 def ImageFromBitmap(*args
, **kwargs
):
3093 ImageFromBitmap(Bitmap bitmap) -> Image
3095 Construct an Image from a `wx.Bitmap`.
3097 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3100 def ImageFromData(*args
, **kwargs
):
3102 ImageFromData(int width, int height, buffer data) -> Image
3104 Construct an Image from a buffer of RGB bytes. Accepts either a
3105 string or a buffer object holding the data and the length of the data
3106 must be width*height*3.
3108 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3111 def ImageFromDataWithAlpha(*args
, **kwargs
):
3113 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3115 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3116 Accepts either a string or a buffer object holding the data and the
3117 length of the data must be width*height*3 bytes, and the length of the
3118 alpha data must be width*height bytes.
3120 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3123 def Image_CanRead(*args
, **kwargs
):
3125 Image_CanRead(String filename) -> bool
3127 Returns True if the image handlers can read this file.
3129 return _core_
.Image_CanRead(*args
, **kwargs
)
3131 def Image_GetImageCount(*args
, **kwargs
):
3133 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3135 If the image file contains more than one image and the image handler
3136 is capable of retrieving these individually, this function will return
3137 the number of available images.
3139 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3141 def Image_CanReadStream(*args
, **kwargs
):
3143 Image_CanReadStream(InputStream stream) -> bool
3145 Returns True if the image handlers can read an image file from the
3146 data currently on the input stream, or a readable Python file-like
3149 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3151 def Image_AddHandler(*args
, **kwargs
):
3152 """Image_AddHandler(ImageHandler handler)"""
3153 return _core_
.Image_AddHandler(*args
, **kwargs
)
3155 def Image_InsertHandler(*args
, **kwargs
):
3156 """Image_InsertHandler(ImageHandler handler)"""
3157 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3159 def Image_RemoveHandler(*args
, **kwargs
):
3160 """Image_RemoveHandler(String name) -> bool"""
3161 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3163 def Image_GetHandlers(*args
):
3164 """Image_GetHandlers() -> PyObject"""
3165 return _core_
.Image_GetHandlers(*args
)
3167 def Image_GetImageExtWildcard(*args
):
3169 Image_GetImageExtWildcard() -> String
3171 Iterates all registered wxImageHandler objects, and returns a string
3172 containing file extension masks suitable for passing to file open/save
3175 return _core_
.Image_GetImageExtWildcard(*args
)
3177 def Image_RGBtoHSV(*args
, **kwargs
):
3179 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3181 Converts a color in RGB color space to HSV color space.
3183 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3185 def Image_HSVtoRGB(*args
, **kwargs
):
3187 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3189 Converts a color in HSV color space to RGB color space.
3191 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3194 def _ImageFromBuffer(*args
, **kwargs
):
3195 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3196 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3197 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3199 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3200 parameter must be a Python object that implements the buffer interface,
3201 such as a string, array, etc. The dataBuffer object is expected to
3202 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3203 object can optionally be supplied for the image's alpha channel data, and
3204 it is expected to be width*height bytes long.
3206 The wx.Image will be created with its data and alpha pointers initialized
3207 to the memory address pointed to by the buffer objects, thus saving the
3208 time needed to copy the image data from the buffer object to the wx.Image.
3209 While this has advantages, it also has the shoot-yourself-in-the-foot
3210 risks associated with sharing a C pointer between two objects.
3212 To help alleviate the risk a reference to the data and alpha buffer
3213 objects are kept with the wx.Image, so that they won't get deleted until
3214 after the wx.Image is deleted. However please be aware that it is not
3215 guaranteed that an object won't move its memory buffer to a new location
3216 when it needs to resize its contents. If that happens then the wx.Image
3217 will end up referring to an invalid memory location and could cause the
3218 application to crash. Therefore care should be taken to not manipulate
3219 the objects used for the data and alpha buffers in a way that would cause
3220 them to change size.
3222 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3223 image
._buffer
= dataBuffer
3224 image
._alpha
= alphaBuffer
3227 def InitAllImageHandlers():
3229 The former functionality of InitAllImageHanders is now done internal to
3230 the _core_ extension module and so this function has become a simple NOP.
3234 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3235 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3236 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3237 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3238 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3239 BMP_24BPP
= _core_
.BMP_24BPP
3240 BMP_8BPP
= _core_
.BMP_8BPP
3241 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3242 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3243 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3244 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3245 BMP_4BPP
= _core_
.BMP_4BPP
3246 BMP_1BPP
= _core_
.BMP_1BPP
3247 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3248 class BMPHandler(ImageHandler
):
3249 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3250 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3251 __repr__
= _swig_repr
3252 def __init__(self
, *args
, **kwargs
):
3254 __init__(self) -> BMPHandler
3256 A `wx.ImageHandler` for \*.bmp bitmap files.
3258 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3259 _core_
.BMPHandler_swigregister(BMPHandler
)
3260 NullImage
= cvar
.NullImage
3261 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3262 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3263 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3264 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3265 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3266 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3267 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3268 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3269 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3270 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3271 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3272 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3273 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3274 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3275 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3277 class ICOHandler(BMPHandler
):
3278 """A `wx.ImageHandler` for \*.ico icon files."""
3279 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3280 __repr__
= _swig_repr
3281 def __init__(self
, *args
, **kwargs
):
3283 __init__(self) -> ICOHandler
3285 A `wx.ImageHandler` for \*.ico icon files.
3287 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3288 _core_
.ICOHandler_swigregister(ICOHandler
)
3290 class CURHandler(ICOHandler
):
3291 """A `wx.ImageHandler` for \*.cur cursor files."""
3292 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3293 __repr__
= _swig_repr
3294 def __init__(self
, *args
, **kwargs
):
3296 __init__(self) -> CURHandler
3298 A `wx.ImageHandler` for \*.cur cursor files.
3300 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3301 _core_
.CURHandler_swigregister(CURHandler
)
3303 class ANIHandler(CURHandler
):
3304 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3305 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3306 __repr__
= _swig_repr
3307 def __init__(self
, *args
, **kwargs
):
3309 __init__(self) -> ANIHandler
3311 A `wx.ImageHandler` for \*.ani animated cursor files.
3313 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3314 _core_
.ANIHandler_swigregister(ANIHandler
)
3316 class PNGHandler(ImageHandler
):
3317 """A `wx.ImageHandler` for PNG image files."""
3318 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3319 __repr__
= _swig_repr
3320 def __init__(self
, *args
, **kwargs
):
3322 __init__(self) -> PNGHandler
3324 A `wx.ImageHandler` for PNG image files.
3326 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3327 _core_
.PNGHandler_swigregister(PNGHandler
)
3329 class GIFHandler(ImageHandler
):
3330 """A `wx.ImageHandler` for GIF image files."""
3331 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3332 __repr__
= _swig_repr
3333 def __init__(self
, *args
, **kwargs
):
3335 __init__(self) -> GIFHandler
3337 A `wx.ImageHandler` for GIF image files.
3339 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3340 _core_
.GIFHandler_swigregister(GIFHandler
)
3342 class PCXHandler(ImageHandler
):
3343 """A `wx.ImageHandler` for PCX imager files."""
3344 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3345 __repr__
= _swig_repr
3346 def __init__(self
, *args
, **kwargs
):
3348 __init__(self) -> PCXHandler
3350 A `wx.ImageHandler` for PCX imager files.
3352 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3353 _core_
.PCXHandler_swigregister(PCXHandler
)
3355 class JPEGHandler(ImageHandler
):
3356 """A `wx.ImageHandler` for JPEG/JPG image files."""
3357 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3358 __repr__
= _swig_repr
3359 def __init__(self
, *args
, **kwargs
):
3361 __init__(self) -> JPEGHandler
3363 A `wx.ImageHandler` for JPEG/JPG image files.
3365 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3366 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3368 class PNMHandler(ImageHandler
):
3369 """A `wx.ImageHandler` for PNM image files."""
3370 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3371 __repr__
= _swig_repr
3372 def __init__(self
, *args
, **kwargs
):
3374 __init__(self) -> PNMHandler
3376 A `wx.ImageHandler` for PNM image files.
3378 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3379 _core_
.PNMHandler_swigregister(PNMHandler
)
3381 class XPMHandler(ImageHandler
):
3382 """A `wx.ImageHandler` for XPM image."""
3383 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3384 __repr__
= _swig_repr
3385 def __init__(self
, *args
, **kwargs
):
3387 __init__(self) -> XPMHandler
3389 A `wx.ImageHandler` for XPM image.
3391 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3392 _core_
.XPMHandler_swigregister(XPMHandler
)
3394 class TIFFHandler(ImageHandler
):
3395 """A `wx.ImageHandler` for TIFF image files."""
3396 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3397 __repr__
= _swig_repr
3398 def __init__(self
, *args
, **kwargs
):
3400 __init__(self) -> TIFFHandler
3402 A `wx.ImageHandler` for TIFF image files.
3404 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3405 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3407 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3408 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3409 class Quantize(object):
3410 """Performs quantization, or colour reduction, on a wxImage."""
3411 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3412 def __init__(self
): raise AttributeError, "No constructor defined"
3413 __repr__
= _swig_repr
3414 def Quantize(*args
, **kwargs
):
3416 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3418 Reduce the colours in the source image and put the result into the
3419 destination image, setting the palette in the destination if
3420 needed. Both images may be the same, to overwrite the source image.
3422 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3424 Quantize
= staticmethod(Quantize
)
3425 _core_
.Quantize_swigregister(Quantize
)
3427 def Quantize_Quantize(*args
, **kwargs
):
3429 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3431 Reduce the colours in the source image and put the result into the
3432 destination image, setting the palette in the destination if
3433 needed. Both images may be the same, to overwrite the source image.
3435 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3437 #---------------------------------------------------------------------------
3439 class EvtHandler(Object
):
3440 """Proxy of C++ EvtHandler class"""
3441 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3442 __repr__
= _swig_repr
3443 def __init__(self
, *args
, **kwargs
):
3444 """__init__(self) -> EvtHandler"""
3445 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3446 self
._setOORInfo
(self
)
3448 def GetNextHandler(*args
, **kwargs
):
3449 """GetNextHandler(self) -> EvtHandler"""
3450 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3452 def GetPreviousHandler(*args
, **kwargs
):
3453 """GetPreviousHandler(self) -> EvtHandler"""
3454 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3456 def SetNextHandler(*args
, **kwargs
):
3457 """SetNextHandler(self, EvtHandler handler)"""
3458 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3460 def SetPreviousHandler(*args
, **kwargs
):
3461 """SetPreviousHandler(self, EvtHandler handler)"""
3462 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3464 def GetEvtHandlerEnabled(*args
, **kwargs
):
3465 """GetEvtHandlerEnabled(self) -> bool"""
3466 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3468 def SetEvtHandlerEnabled(*args
, **kwargs
):
3469 """SetEvtHandlerEnabled(self, bool enabled)"""
3470 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3472 def ProcessEvent(*args
, **kwargs
):
3473 """ProcessEvent(self, Event event) -> bool"""
3474 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3476 def AddPendingEvent(*args
, **kwargs
):
3477 """AddPendingEvent(self, Event event)"""
3478 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3480 def ProcessPendingEvents(*args
, **kwargs
):
3481 """ProcessPendingEvents(self)"""
3482 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3484 def AllowReentrance(*args
, **kwargs
):
3485 """AllowReentrance(self, bool allow=True)"""
3486 return _core_
.EvtHandler_AllowReentrance(*args
, **kwargs
)
3488 def IsReentranceAllowed(*args
, **kwargs
):
3489 """IsReentranceAllowed(self) -> bool"""
3490 return _core_
.EvtHandler_IsReentranceAllowed(*args
, **kwargs
)
3492 def IsEventHandlingInProgress(*args
, **kwargs
):
3493 """IsEventHandlingInProgress(self) -> bool"""
3494 return _core_
.EvtHandler_IsEventHandlingInProgress(*args
, **kwargs
)
3496 def Connect(*args
, **kwargs
):
3497 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3498 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3500 def Disconnect(*args
, **kwargs
):
3501 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3502 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3504 def _setOORInfo(*args
, **kwargs
):
3505 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3506 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3510 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3512 Bind an event to an event handler.
3514 :param event: One of the EVT_* objects that specifies the
3515 type of event to bind,
3517 :param handler: A callable object to be invoked when the
3518 event is delivered to self. Pass None to
3519 disconnect an event handler.
3521 :param source: Sometimes the event originates from a
3522 different window than self, but you still
3523 want to catch it in self. (For example, a
3524 button event delivered to a frame.) By
3525 passing the source of the event, the event
3526 handling system is able to differentiate
3527 between the same event type from different
3530 :param id: Used to spcify the event source by ID instead
3533 :param id2: Used when it is desirable to bind a handler
3534 to a range of IDs, such as with EVT_MENU_RANGE.
3536 if source
is not None:
3538 event
.Bind(self
, id, id2
, handler
)
3540 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3542 Disconencts the event handler binding for event from self.
3543 Returns True if successful.
3545 if source
is not None:
3547 return event
.Unbind(self
, id, id2
)
3549 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3550 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3551 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3552 _core_
.EvtHandler_swigregister(EvtHandler
)
3554 #---------------------------------------------------------------------------
3556 class PyEventBinder(object):
3558 Instances of this class are used to bind specific events to event
3561 def __init__(self
, evtType
, expectedIDs
=0):
3562 if expectedIDs
not in [0, 1, 2]:
3563 raise ValueError, "Invalid number of expectedIDs"
3564 self
.expectedIDs
= expectedIDs
3566 if type(evtType
) == list or type(evtType
) == tuple:
3567 self
.evtType
= evtType
3569 self
.evtType
= [evtType
]
3572 def Bind(self
, target
, id1
, id2
, function
):
3573 """Bind this set of event types to target."""
3574 for et
in self
.evtType
:
3575 target
.Connect(id1
, id2
, et
, function
)
3578 def Unbind(self
, target
, id1
, id2
):
3579 """Remove an event binding."""
3581 for et
in self
.evtType
:
3582 success
+= target
.Disconnect(id1
, id2
, et
)
3586 def __call__(self
, *args
):
3588 For backwards compatibility with the old EVT_* functions.
3589 Should be called with either (window, func), (window, ID,
3590 func) or (window, ID1, ID2, func) parameters depending on the
3593 assert len(args
) == 2 + self
.expectedIDs
3597 if self
.expectedIDs
== 0:
3599 elif self
.expectedIDs
== 1:
3602 elif self
.expectedIDs
== 2:
3607 raise ValueError, "Unexpected number of IDs"
3609 self
.Bind(target
, id1
, id2
, func
)
3612 # These two are square pegs that don't fit the PyEventBinder hole...
3613 def EVT_COMMAND(win
, id, cmd
, func
):
3614 win
.Connect(id, -1, cmd
, func
)
3615 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3616 win
.Connect(id1
, id2
, cmd
, func
)
3619 #---------------------------------------------------------------------------
3621 #---------------------------------------------------------------------------
3623 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3624 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3626 def NewEventType(*args
):
3627 """NewEventType() -> EventType"""
3628 return _core_
.NewEventType(*args
)
3629 wxEVT_NULL
= _core_
.wxEVT_NULL
3630 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3631 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3632 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3633 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3634 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3635 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3636 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3637 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3638 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3639 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3640 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3641 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3642 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3643 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3644 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3645 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3646 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3647 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3648 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3649 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3650 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3651 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3652 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3653 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3654 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3655 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3656 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3657 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3658 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3659 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3660 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3661 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3662 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3663 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3664 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3665 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3666 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3667 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3668 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3669 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3670 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3671 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3672 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3673 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3674 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3675 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3676 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3677 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3678 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3679 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3680 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3681 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3682 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3683 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3684 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3685 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3686 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3687 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3688 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3689 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3690 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3691 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3692 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3693 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3694 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3695 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3696 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3697 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3698 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3699 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3700 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3701 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3702 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3703 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3704 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3705 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3706 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3707 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3708 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3709 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3710 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3711 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3712 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3713 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3714 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3715 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3716 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3717 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3718 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3719 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3720 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3721 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3722 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3723 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3724 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3725 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3726 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3727 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3728 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3729 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3730 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3731 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3732 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3733 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3734 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3735 wxEVT_SIZING
= _core_
.wxEVT_SIZING
3736 wxEVT_MOVING
= _core_
.wxEVT_MOVING
3737 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
3738 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
3739 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
3740 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
3741 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
3742 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
3743 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
3744 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
3745 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
3746 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
3747 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
3749 # Create some event binders
3750 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
3751 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
3752 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
3753 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
3754 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
3755 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3756 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3757 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
3758 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
3759 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
3760 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
3761 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
3762 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
3763 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
3764 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
3765 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
3766 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
3767 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
3768 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
3769 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
3770 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
3771 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
3772 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
3773 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
3774 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
3775 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3776 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3777 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
3778 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
3779 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
3780 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
3781 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
3782 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
3783 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
3784 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
3785 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
3786 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
3787 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
3788 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
3789 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
3790 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
3791 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
3793 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
3794 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
3795 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
3796 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
3797 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
3798 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
3799 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
3800 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
3801 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
3802 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
3803 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
3804 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
3805 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
3807 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
3815 wxEVT_MIDDLE_DCLICK
,
3823 # Scrolling from wxWindow (sent to wxScrolledWindow)
3824 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
3825 wxEVT_SCROLLWIN_BOTTOM
,
3826 wxEVT_SCROLLWIN_LINEUP
,
3827 wxEVT_SCROLLWIN_LINEDOWN
,
3828 wxEVT_SCROLLWIN_PAGEUP
,
3829 wxEVT_SCROLLWIN_PAGEDOWN
,
3830 wxEVT_SCROLLWIN_THUMBTRACK
,
3831 wxEVT_SCROLLWIN_THUMBRELEASE
,
3834 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
3835 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
3836 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
3837 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
3838 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
3839 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
3840 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
3841 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
3843 # Scrolling from wx.Slider and wx.ScrollBar
3844 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3845 wxEVT_SCROLL_BOTTOM
,
3846 wxEVT_SCROLL_LINEUP
,
3847 wxEVT_SCROLL_LINEDOWN
,
3848 wxEVT_SCROLL_PAGEUP
,
3849 wxEVT_SCROLL_PAGEDOWN
,
3850 wxEVT_SCROLL_THUMBTRACK
,
3851 wxEVT_SCROLL_THUMBRELEASE
,
3852 wxEVT_SCROLL_CHANGED
,
3855 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
3856 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
3857 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
3858 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
3859 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
3860 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
3861 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
3862 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
3863 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
3864 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
3866 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3867 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3868 wxEVT_SCROLL_BOTTOM
,
3869 wxEVT_SCROLL_LINEUP
,
3870 wxEVT_SCROLL_LINEDOWN
,
3871 wxEVT_SCROLL_PAGEUP
,
3872 wxEVT_SCROLL_PAGEDOWN
,
3873 wxEVT_SCROLL_THUMBTRACK
,
3874 wxEVT_SCROLL_THUMBRELEASE
,
3875 wxEVT_SCROLL_CHANGED
,
3878 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
3879 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
3880 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
3881 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
3882 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
3883 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
3884 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
3885 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
3886 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
3887 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
3889 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
3890 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
3891 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
3892 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
3893 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
3894 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
3895 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
3896 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
3897 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
3898 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
3900 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
3901 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
3902 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
3903 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
3904 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
3905 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
3906 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
3907 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
3908 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
3911 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
3912 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
3913 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
3914 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
3915 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
3916 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
3917 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
3919 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
3921 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
3922 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
3924 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
3926 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
3927 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
3928 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
3931 #---------------------------------------------------------------------------
3933 class Event(Object
):
3935 An event is a structure holding information about an event passed to a
3936 callback or member function. wx.Event is an abstract base class for
3939 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3940 def __init__(self
): raise AttributeError, "No constructor defined"
3941 __repr__
= _swig_repr
3942 __swig_destroy__
= _core_
.delete_Event
3943 __del__
= lambda self
: None;
3944 def SetEventType(*args
, **kwargs
):
3946 SetEventType(self, EventType typ)
3948 Sets the specific type of the event.
3950 return _core_
.Event_SetEventType(*args
, **kwargs
)
3952 def GetEventType(*args
, **kwargs
):
3954 GetEventType(self) -> EventType
3956 Returns the identifier of the given event type, such as
3957 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3959 return _core_
.Event_GetEventType(*args
, **kwargs
)
3961 def GetEventObject(*args
, **kwargs
):
3963 GetEventObject(self) -> Object
3965 Returns the object (usually a window) associated with the event, if
3968 return _core_
.Event_GetEventObject(*args
, **kwargs
)
3970 def SetEventObject(*args
, **kwargs
):
3972 SetEventObject(self, Object obj)
3974 Sets the originating object, or in other words, obj is normally the
3975 object that is sending the event.
3977 return _core_
.Event_SetEventObject(*args
, **kwargs
)
3979 def GetTimestamp(*args
, **kwargs
):
3980 """GetTimestamp(self) -> long"""
3981 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
3983 def SetTimestamp(*args
, **kwargs
):
3984 """SetTimestamp(self, long ts=0)"""
3985 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
3987 def GetId(*args
, **kwargs
):
3991 Returns the identifier associated with this event, such as a button
3994 return _core_
.Event_GetId(*args
, **kwargs
)
3996 def SetId(*args
, **kwargs
):
4000 Set's the ID for the event. This is usually the ID of the window that
4001 is sending the event, but it can also be a command id from a menu
4004 return _core_
.Event_SetId(*args
, **kwargs
)
4006 def IsCommandEvent(*args
, **kwargs
):
4008 IsCommandEvent(self) -> bool
4010 Returns true if the event is or is derived from `wx.CommandEvent` else
4011 it returns false. Note: Exists only for optimization purposes.
4013 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4015 def Skip(*args
, **kwargs
):
4017 Skip(self, bool skip=True)
4019 Called by an event handler, it controls whether additional event
4020 handlers bound to this event will be called after the current event
4021 handler returns. Skip(false) (the default setting) will prevent
4022 additional event handlers from being called and control will be
4023 returned to the sender of the event immediately after the current
4024 handler has finished. Skip(True) will cause the event processing
4025 system to continue searching for a handler function for this event.
4028 return _core_
.Event_Skip(*args
, **kwargs
)
4030 def GetSkipped(*args
, **kwargs
):
4032 GetSkipped(self) -> bool
4034 Returns true if the event handler should be skipped, false otherwise.
4037 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4039 def ShouldPropagate(*args
, **kwargs
):
4041 ShouldPropagate(self) -> bool
4043 Test if this event should be propagated to the parent window or not,
4044 i.e. if the propagation level is currently greater than 0.
4046 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4048 def StopPropagation(*args
, **kwargs
):
4050 StopPropagation(self) -> int
4052 Stop the event from propagating to its parent window. Returns the old
4053 propagation level value which may be later passed to
4054 `ResumePropagation` to allow propagating the event again.
4056 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4058 def ResumePropagation(*args
, **kwargs
):
4060 ResumePropagation(self, int propagationLevel)
4062 Resume the event propagation by restoring the propagation level. (For
4063 example, you can use the value returned by an earlier call to
4067 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4069 def Clone(*args
, **kwargs
):
4070 """Clone(self) -> Event"""
4071 return _core_
.Event_Clone(*args
, **kwargs
)
4073 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4074 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4075 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4076 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4077 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4078 _core_
.Event_swigregister(Event
)
4080 #---------------------------------------------------------------------------
4082 class PropagationDisabler(object):
4084 Helper class to temporarily change an event not to propagate. Simply
4085 create an instance of this class and then whe it is destroyed the
4086 propogation of the event will be restored.
4088 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4089 __repr__
= _swig_repr
4090 def __init__(self
, *args
, **kwargs
):
4092 __init__(self, Event event) -> PropagationDisabler
4094 Helper class to temporarily change an event not to propagate. Simply
4095 create an instance of this class and then whe it is destroyed the
4096 propogation of the event will be restored.
4098 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4099 __swig_destroy__
= _core_
.delete_PropagationDisabler
4100 __del__
= lambda self
: None;
4101 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4103 class PropagateOnce(object):
4105 A helper class that will temporarily lower propagation level of an
4106 event. Simply create an instance of this class and then whe it is
4107 destroyed the propogation of the event will be restored.
4109 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4110 __repr__
= _swig_repr
4111 def __init__(self
, *args
, **kwargs
):
4113 __init__(self, Event event) -> PropagateOnce
4115 A helper class that will temporarily lower propagation level of an
4116 event. Simply create an instance of this class and then whe it is
4117 destroyed the propogation of the event will be restored.
4119 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4120 __swig_destroy__
= _core_
.delete_PropagateOnce
4121 __del__
= lambda self
: None;
4122 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4124 #---------------------------------------------------------------------------
4126 class CommandEvent(Event
):
4128 This event class contains information about command events, which
4129 originate from a variety of simple controls, as well as menus and
4132 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4133 __repr__
= _swig_repr
4134 def __init__(self
, *args
, **kwargs
):
4136 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4138 This event class contains information about command events, which
4139 originate from a variety of simple controls, as well as menus and
4142 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4143 def GetSelection(*args
, **kwargs
):
4145 GetSelection(self) -> int
4147 Returns item index for a listbox or choice selection event (not valid
4150 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4152 def SetString(*args
, **kwargs
):
4153 """SetString(self, String s)"""
4154 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4156 def GetString(*args
, **kwargs
):
4158 GetString(self) -> String
4160 Returns item string for a listbox or choice selection event (not valid
4163 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4165 def IsChecked(*args
, **kwargs
):
4167 IsChecked(self) -> bool
4169 This method can be used with checkbox and menu events: for the
4170 checkboxes, the method returns true for a selection event and false
4171 for a deselection one. For the menu events, this method indicates if
4172 the menu item just has become checked or unchecked (and thus only
4173 makes sense for checkable menu items).
4175 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4178 def IsSelection(*args
, **kwargs
):
4180 IsSelection(self) -> bool
4182 For a listbox or similar event, returns true if it is a selection,
4183 false if it is a deselection.
4185 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4187 def SetExtraLong(*args
, **kwargs
):
4188 """SetExtraLong(self, long extraLong)"""
4189 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4191 def GetExtraLong(*args
, **kwargs
):
4193 GetExtraLong(self) -> long
4195 Returns extra information dependant on the event objects type. If the
4196 event comes from a listbox selection, it is a boolean determining
4197 whether the event was a selection (true) or a deselection (false). A
4198 listbox deselection only occurs for multiple-selection boxes, and in
4199 this case the index and string values are indeterminate and the
4200 listbox must be examined by the application.
4202 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4204 def SetInt(*args
, **kwargs
):
4205 """SetInt(self, int i)"""
4206 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4208 def GetInt(*args
, **kwargs
):
4212 Returns the integer identifier corresponding to a listbox, choice or
4213 radiobox selection (only if the event was a selection, not a
4214 deselection), or a boolean value representing the value of a checkbox.
4216 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4218 def GetClientData(*args
, **kwargs
):
4220 GetClientData(self) -> PyObject
4222 Returns the client data object for a listbox or choice selection event, (if any.)
4224 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4226 def SetClientData(*args
, **kwargs
):
4228 SetClientData(self, PyObject clientData)
4230 Associate the given client data with the item at position n.
4232 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4234 GetClientObject
= GetClientData
4235 SetClientObject
= SetClientData
4237 def Clone(*args
, **kwargs
):
4238 """Clone(self) -> Event"""
4239 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4241 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4242 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4243 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4244 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4245 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4246 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4247 _core_
.CommandEvent_swigregister(CommandEvent
)
4249 #---------------------------------------------------------------------------
4251 class NotifyEvent(CommandEvent
):
4253 An instance of this class (or one of its derived classes) is sent from
4254 a control when the control's state is being changed and the control
4255 allows that change to be prevented from happening. The event handler
4256 can call `Veto` or `Allow` to tell the control what to do.
4258 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4259 __repr__
= _swig_repr
4260 def __init__(self
, *args
, **kwargs
):
4262 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4264 An instance of this class (or one of its derived classes) is sent from
4265 a control when the control's state is being changed and the control
4266 allows that change to be prevented from happening. The event handler
4267 can call `Veto` or `Allow` to tell the control what to do.
4269 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4270 def Veto(*args
, **kwargs
):
4274 Prevents the change announced by this event from happening.
4276 It is in general a good idea to notify the user about the reasons for
4277 vetoing the change because otherwise the applications behaviour (which
4278 just refuses to do what the user wants) might be quite surprising.
4280 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4282 def Allow(*args
, **kwargs
):
4286 This is the opposite of `Veto`: it explicitly allows the event to be
4287 processed. For most events it is not necessary to call this method as
4288 the events are allowed anyhow but some are forbidden by default (this
4289 will be mentioned in the corresponding event description).
4291 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4293 def IsAllowed(*args
, **kwargs
):
4295 IsAllowed(self) -> bool
4297 Returns true if the change is allowed (`Veto` hasn't been called) or
4298 false otherwise (if it was).
4300 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4302 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4304 #---------------------------------------------------------------------------
4306 class ScrollEvent(CommandEvent
):
4308 A scroll event holds information about events sent from stand-alone
4309 scrollbars and sliders. Note that scrolled windows do not send
4310 instnaces of this event class, but send the `wx.ScrollWinEvent`
4313 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4314 __repr__
= _swig_repr
4315 def __init__(self
, *args
, **kwargs
):
4317 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4318 int orient=0) -> ScrollEvent
4320 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4321 def GetOrientation(*args
, **kwargs
):
4323 GetOrientation(self) -> int
4325 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4328 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4330 def GetPosition(*args
, **kwargs
):
4332 GetPosition(self) -> int
4334 Returns the position of the scrollbar.
4336 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4338 def SetOrientation(*args
, **kwargs
):
4339 """SetOrientation(self, int orient)"""
4340 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4342 def SetPosition(*args
, **kwargs
):
4343 """SetPosition(self, int pos)"""
4344 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4346 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4347 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4348 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4350 #---------------------------------------------------------------------------
4352 class ScrollWinEvent(Event
):
4354 A wx.ScrollWinEvent holds information about scrolling and is sent from
4357 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4358 __repr__
= _swig_repr
4359 def __init__(self
, *args
, **kwargs
):
4361 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4363 A wx.ScrollWinEvent holds information about scrolling and is sent from
4366 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4367 def GetOrientation(*args
, **kwargs
):
4369 GetOrientation(self) -> int
4371 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4374 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4376 def GetPosition(*args
, **kwargs
):
4378 GetPosition(self) -> int
4380 Returns the position of the scrollbar for the thumb track and release
4381 events. Note that this field can't be used for the other events, you
4382 need to query the window itself for the current position in that case.
4384 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4386 def SetOrientation(*args
, **kwargs
):
4387 """SetOrientation(self, int orient)"""
4388 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4390 def SetPosition(*args
, **kwargs
):
4391 """SetPosition(self, int pos)"""
4392 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4394 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4395 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4396 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4398 #---------------------------------------------------------------------------
4400 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4401 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4402 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4403 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4404 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4405 class MouseEvent(Event
):
4407 This event class contains information about the events generated by
4408 the mouse: they include mouse buttons press and release events and
4411 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4412 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4413 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4414 a middle button so a portable application should avoid relying on the
4417 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4418 the former returns true when the event corresponds to the left mouse
4419 button click while the latter returns true if the left mouse button is
4420 currently being pressed. For example, when the user is dragging the
4421 mouse you can use `LeftIsDown` to test whether the left mouse button
4422 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4423 `LeftIsDown` will also return true in wxWidgets whatever the
4424 underlying GUI behaviour is (which is platform-dependent). The same
4425 applies, of course, to other mouse buttons as well.
4427 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4428 __repr__
= _swig_repr
4429 def __init__(self
, *args
, **kwargs
):
4431 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4433 Constructs a wx.MouseEvent. Valid event types are:
4435 * wxEVT_ENTER_WINDOW
4436 * wxEVT_LEAVE_WINDOW
4442 * wxEVT_MIDDLE_DCLICK
4445 * wxEVT_RIGHT_DCLICK
4449 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4450 def IsButton(*args
, **kwargs
):
4452 IsButton(self) -> bool
4454 Returns true if the event was a mouse button event (not necessarily a
4455 button down event - that may be tested using `ButtonDown`).
4457 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4459 def ButtonDown(*args
, **kwargs
):
4461 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4463 If the argument is omitted, this returns true if the event was any
4464 mouse button down event. Otherwise the argument specifies which
4465 button-down event shold be checked for (see `Button` for the possible
4468 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4470 def ButtonDClick(*args
, **kwargs
):
4472 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4474 If the argument is omitted, this returns true if the event was any
4475 mouse double click event. Otherwise the argument specifies which
4476 double click event to check for (see `Button` for the possible
4479 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4481 def ButtonUp(*args
, **kwargs
):
4483 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4485 If the argument is omitted, this returns true if the event was any
4486 mouse button up event. Otherwise the argument specifies which button
4487 up event to check for (see `Button` for the possible values).
4489 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4491 def Button(*args
, **kwargs
):
4493 Button(self, int button) -> bool
4495 Returns true if the identified mouse button is changing state. Valid
4496 values of button are:
4498 ==================== =====================================
4499 wx.MOUSE_BTN_LEFT check if left button was pressed
4500 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4501 wx.MOUSE_BTN_RIGHT check if right button was pressed
4502 wx.MOUSE_BTN_ANY check if any button was pressed
4503 ==================== =====================================
4506 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4508 def ButtonIsDown(*args
, **kwargs
):
4509 """ButtonIsDown(self, int but) -> bool"""
4510 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4512 def GetButton(*args
, **kwargs
):
4514 GetButton(self) -> int
4516 Returns the mouse button which generated this event or
4517 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4518 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4519 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4520 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4521 right buttons respectively.
4523 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4525 def ControlDown(*args
, **kwargs
):
4527 ControlDown(self) -> bool
4529 Returns true if the control key was down at the time of the event.
4531 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4533 def MetaDown(*args
, **kwargs
):
4535 MetaDown(self) -> bool
4537 Returns true if the Meta key was down at the time of the event.
4539 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4541 def AltDown(*args
, **kwargs
):
4543 AltDown(self) -> bool
4545 Returns true if the Alt key was down at the time of the event.
4547 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4549 def ShiftDown(*args
, **kwargs
):
4551 ShiftDown(self) -> bool
4553 Returns true if the Shift key was down at the time of the event.
4555 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4557 def CmdDown(*args
, **kwargs
):
4559 CmdDown(self) -> bool
4561 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4562 platforms but the special "Apple" (a.k.a as "Command") key on
4563 Macs. It often makes sense to use it instead of, say, `ControlDown`
4564 because Cmd key is used for the same thing under Mac as Ctrl
4565 elsewhere. The Ctrl key still exists, it's just not used for this
4566 purpose. So for non-Mac platforms this is the same as `ControlDown`
4567 and Macs this is the same as `MetaDown`.
4569 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4571 def LeftDown(*args
, **kwargs
):
4573 LeftDown(self) -> bool
4575 Returns true if the left mouse button state changed to down.
4577 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4579 def MiddleDown(*args
, **kwargs
):
4581 MiddleDown(self) -> bool
4583 Returns true if the middle mouse button state changed to down.
4585 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4587 def RightDown(*args
, **kwargs
):
4589 RightDown(self) -> bool
4591 Returns true if the right mouse button state changed to down.
4593 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4595 def LeftUp(*args
, **kwargs
):
4597 LeftUp(self) -> bool
4599 Returns true if the left mouse button state changed to up.
4601 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4603 def MiddleUp(*args
, **kwargs
):
4605 MiddleUp(self) -> bool
4607 Returns true if the middle mouse button state changed to up.
4609 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4611 def RightUp(*args
, **kwargs
):
4613 RightUp(self) -> bool
4615 Returns true if the right mouse button state changed to up.
4617 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4619 def LeftDClick(*args
, **kwargs
):
4621 LeftDClick(self) -> bool
4623 Returns true if the event was a left button double click.
4625 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4627 def MiddleDClick(*args
, **kwargs
):
4629 MiddleDClick(self) -> bool
4631 Returns true if the event was a middle button double click.
4633 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4635 def RightDClick(*args
, **kwargs
):
4637 RightDClick(self) -> bool
4639 Returns true if the event was a right button double click.
4641 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4643 def LeftIsDown(*args
, **kwargs
):
4645 LeftIsDown(self) -> bool
4647 Returns true if the left mouse button is currently down, independent
4648 of the current event type.
4650 Please notice that it is not the same as LeftDown which returns true
4651 if the left mouse button was just pressed. Rather, it describes the
4652 state of the mouse button before the event happened.
4654 This event is usually used in the mouse event handlers which process
4655 "move mouse" messages to determine whether the user is (still)
4658 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4660 def MiddleIsDown(*args
, **kwargs
):
4662 MiddleIsDown(self) -> bool
4664 Returns true if the middle mouse button is currently down, independent
4665 of the current event type.
4667 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4669 def RightIsDown(*args
, **kwargs
):
4671 RightIsDown(self) -> bool
4673 Returns true if the right mouse button is currently down, independent
4674 of the current event type.
4676 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4678 def Dragging(*args
, **kwargs
):
4680 Dragging(self) -> bool
4682 Returns true if this was a dragging event (motion while a button is
4685 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4687 def Moving(*args
, **kwargs
):
4689 Moving(self) -> bool
4691 Returns true if this was a motion event and no mouse buttons were
4692 pressed. If any mouse button is held pressed, then this method returns
4693 false and Dragging returns true.
4695 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4697 def Entering(*args
, **kwargs
):
4699 Entering(self) -> bool
4701 Returns true if the mouse was entering the window.
4703 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4705 def Leaving(*args
, **kwargs
):
4707 Leaving(self) -> bool
4709 Returns true if the mouse was leaving the window.
4711 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4713 def GetPosition(*args
, **kwargs
):
4715 GetPosition(self) -> Point
4717 Returns the pixel position of the mouse in window coordinates when the
4720 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4722 def GetPositionTuple(*args
, **kwargs
):
4724 GetPositionTuple() -> (x,y)
4726 Returns the pixel position of the mouse in window coordinates when the
4729 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4731 def GetLogicalPosition(*args
, **kwargs
):
4733 GetLogicalPosition(self, DC dc) -> Point
4735 Returns the logical mouse position in pixels (i.e. translated
4736 according to the translation set for the DC, which usually indicates
4737 that the window has been scrolled).
4739 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
4741 def GetX(*args
, **kwargs
):
4745 Returns X coordinate of the physical mouse event position.
4747 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
4749 def GetY(*args
, **kwargs
):
4753 Returns Y coordinate of the physical mouse event position.
4755 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
4757 def GetWheelRotation(*args
, **kwargs
):
4759 GetWheelRotation(self) -> int
4761 Get wheel rotation, positive or negative indicates direction of
4762 rotation. Current devices all send an event when rotation is equal to
4763 +/-WheelDelta, but this allows for finer resolution devices to be
4764 created in the future. Because of this you shouldn't assume that one
4765 event is equal to 1 line or whatever, but you should be able to either
4766 do partial line scrolling or wait until +/-WheelDelta rotation values
4767 have been accumulated before scrolling.
4769 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
4771 def GetWheelDelta(*args
, **kwargs
):
4773 GetWheelDelta(self) -> int
4775 Get wheel delta, normally 120. This is the threshold for action to be
4776 taken, and one such action (for example, scrolling one increment)
4777 should occur for each delta.
4779 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
4781 def GetLinesPerAction(*args
, **kwargs
):
4783 GetLinesPerAction(self) -> int
4785 Returns the configured number of lines (or whatever) to be scrolled
4786 per wheel action. Defaults to three.
4788 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
4790 def IsPageScroll(*args
, **kwargs
):
4792 IsPageScroll(self) -> bool
4794 Returns true if the system has been setup to do page scrolling with
4795 the mouse wheel instead of line scrolling.
4797 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
4799 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
4800 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
4801 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
4802 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
4803 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
4804 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
4805 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
4806 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
4807 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
4808 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
4809 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
4810 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
4811 Button
= property(GetButton
,doc
="See `GetButton`")
4812 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
4813 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
4814 Position
= property(GetPosition
,doc
="See `GetPosition`")
4815 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
4816 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
4817 X
= property(GetX
,doc
="See `GetX`")
4818 Y
= property(GetY
,doc
="See `GetY`")
4819 _core_
.MouseEvent_swigregister(MouseEvent
)
4821 #---------------------------------------------------------------------------
4823 class SetCursorEvent(Event
):
4825 A SetCursorEvent is generated when the mouse cursor is about to be set
4826 as a result of mouse motion. This event gives the application the
4827 chance to perform specific mouse cursor processing based on the
4828 current position of the mouse within the window. Use the `SetCursor`
4829 method to specify the cursor you want to be displayed.
4831 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4832 __repr__
= _swig_repr
4833 def __init__(self
, *args
, **kwargs
):
4835 __init__(self, int x=0, int y=0) -> SetCursorEvent
4837 Construct a new `wx.SetCursorEvent`.
4839 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
4840 def GetX(*args
, **kwargs
):
4844 Returns the X coordinate of the mouse in client coordinates.
4846 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
4848 def GetY(*args
, **kwargs
):
4852 Returns the Y coordinate of the mouse in client coordinates.
4854 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
4856 def SetCursor(*args
, **kwargs
):
4858 SetCursor(self, Cursor cursor)
4860 Sets the cursor associated with this event.
4862 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
4864 def GetCursor(*args
, **kwargs
):
4866 GetCursor(self) -> Cursor
4868 Returns a reference to the cursor specified by this event.
4870 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
4872 def HasCursor(*args
, **kwargs
):
4874 HasCursor(self) -> bool
4876 Returns true if the cursor specified by this event is a valid cursor.
4878 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
4880 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
4881 X
= property(GetX
,doc
="See `GetX`")
4882 Y
= property(GetY
,doc
="See `GetY`")
4883 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
4885 #---------------------------------------------------------------------------
4887 class KeyEvent(Event
):
4889 This event class contains information about keypress and character
4890 events. These events are only sent to the widget that currently has
4893 Notice that there are three different kinds of keyboard events in
4894 wxWidgets: key down and up events and char events. The difference
4895 between the first two is clear - the first corresponds to a key press
4896 and the second to a key release - otherwise they are identical. Just
4897 note that if the key is maintained in a pressed state you will
4898 typically get a lot of (automatically generated) down events but only
4899 one up so it is wrong to assume that there is one up event
4900 corresponding to each down one.
4902 Both key events provide untranslated key codes while the char event
4903 carries the translated one. The untranslated code for alphanumeric
4904 keys is always an upper case value. For the other keys it is one of
4905 WXK_XXX values from the keycodes table. The translated key is, in
4906 general, the character the user expects to appear as the result of the
4907 key combination when typing the text into a text entry zone, for
4910 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4911 and the standard US keyboard): when the 'A' key is pressed, the key
4912 down event key code is equal to ASCII A == 65. But the char event key
4913 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4914 'A' keys simultaneously , the key code in key down event will still be
4915 just 'A' while the char event key code parameter will now be 'A' as
4918 Although in this simple case it is clear that the correct key code
4919 could be found in the key down event handler by checking the value
4920 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4921 as for non alphanumeric keys or non-US keyboard layouts the
4922 translation is keyboard-layout dependent and can only be done properly
4923 by the system itself.
4925 Another kind of translation is done when the control key is pressed:
4926 for example, for CTRL-A key press the key down event still carries the
4927 same key code 'A' as usual but the char event will have key code of 1,
4928 the ASCII value of this key combination.
4930 You may discover how the other keys on your system behave
4931 interactively by running the KeyEvents sample in the wxPython demo and
4932 pressing some keys while the blue box at the top has the keyboard
4935 **Note**: If a key down event is caught and the event handler does not
4936 call event.Skip() then the coresponding char event will not
4937 happen. This is by design and enables the programs that handle both
4938 types of events to be a bit simpler.
4940 **Note for Windows programmers**: The key and char events in wxWidgets
4941 are similar to but slightly different from Windows WM_KEYDOWN and
4942 WM_CHAR events. In particular, Alt-x combination will generate a char
4943 event in wxWidgets (unless it is used as an accelerator).
4945 **Tip**: be sure to call event.Skip() for events that you don't
4946 process in key event function, otherwise menu shortcuts may cease to
4950 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4951 __repr__
= _swig_repr
4952 def __init__(self
, *args
, **kwargs
):
4954 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4956 Construct a new `wx.KeyEvent`. Valid event types are:
4959 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
4960 def GetModifiers(*args
, **kwargs
):
4962 GetModifiers(self) -> int
4964 Returns a bitmask of the current modifier settings. Can be used to
4965 check if the key event has exactly the given modifiers without having
4966 to explicitly check that the other modifiers are not down. For
4969 if event.GetModifers() == wx.MOD_CONTROL:
4973 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
4975 def ControlDown(*args
, **kwargs
):
4977 ControlDown(self) -> bool
4979 Returns ``True`` if the Control key was down at the time of the event.
4981 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
4983 def MetaDown(*args
, **kwargs
):
4985 MetaDown(self) -> bool
4987 Returns ``True`` if the Meta key was down at the time of the event.
4989 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
4991 def AltDown(*args
, **kwargs
):
4993 AltDown(self) -> bool
4995 Returns ``True`` if the Alt key was down at the time of the event.
4997 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
4999 def ShiftDown(*args
, **kwargs
):
5001 ShiftDown(self) -> bool
5003 Returns ``True`` if the Shift key was down at the time of the event.
5005 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5007 def CmdDown(*args
, **kwargs
):
5009 CmdDown(self) -> bool
5011 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5012 platforms but the special "Apple" (a.k.a as "Command") key on
5013 Macs. It makes often sense to use it instead of, say, `ControlDown`
5014 because Cmd key is used for the same thing under Mac as Ctrl
5015 elsewhere. The Ctrl still exists, it's just not used for this
5016 purpose. So for non-Mac platforms this is the same as `ControlDown`
5017 and Macs this is the same as `MetaDown`.
5019 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5021 def HasModifiers(*args
, **kwargs
):
5023 HasModifiers(self) -> bool
5025 Returns true if either CTRL or ALT keys was down at the time of the
5026 key event. Note that this function does not take into account neither
5027 SHIFT nor META key states (the reason for ignoring the latter is that
5028 it is common for NUMLOCK key to be configured as META under X but the
5029 key presses even while NUMLOCK is on should be still processed
5032 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5034 def GetKeyCode(*args
, **kwargs
):
5036 GetKeyCode(self) -> int
5038 Returns the virtual key code. ASCII events return normal ASCII values,
5039 while non-ASCII events return values such as WXK_LEFT for the left
5040 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5043 Note that in Unicode build, the returned value is meaningful only if
5044 the user entered a character that can be represented in current
5045 locale's default charset. You can obtain the corresponding Unicode
5046 character using `GetUnicodeKey`.
5048 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5050 def GetUnicodeKey(*args
, **kwargs
):
5052 GetUnicodeKey(self) -> int
5054 Returns the Unicode character corresponding to this key event. This
5055 function is only meaningfule in a Unicode build of wxPython.
5057 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5059 GetUniChar
= GetUnicodeKey
5060 def SetUnicodeKey(*args
, **kwargs
):
5062 SetUnicodeKey(self, int uniChar)
5064 Set the Unicode value of the key event, but only if this is a Unicode
5067 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5069 def GetRawKeyCode(*args
, **kwargs
):
5071 GetRawKeyCode(self) -> unsigned int
5073 Returns the raw key code for this event. This is a platform-dependent
5074 scan code which should only be used in advanced
5075 applications. Currently the raw key codes are not supported by all
5078 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5080 def GetRawKeyFlags(*args
, **kwargs
):
5082 GetRawKeyFlags(self) -> unsigned int
5084 Returns the low level key flags for this event. The flags are
5085 platform-dependent and should only be used in advanced applications.
5086 Currently the raw key flags are not supported by all ports.
5088 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5090 def GetPosition(*args
, **kwargs
):
5092 GetPosition(self) -> Point
5094 Find the position of the event, if applicable.
5096 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5098 def GetPositionTuple(*args
, **kwargs
):
5100 GetPositionTuple() -> (x,y)
5102 Find the position of the event, if applicable.
5104 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5106 def GetX(*args
, **kwargs
):
5110 Returns the X position (in client coordinates) of the event, if
5113 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5115 def GetY(*args
, **kwargs
):
5119 Returns the Y position (in client coordinates) of the event, if
5122 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5124 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5125 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5126 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5127 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5128 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5129 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5130 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5131 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5132 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5133 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5134 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5135 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5136 Position
= property(GetPosition
,doc
="See `GetPosition`")
5137 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5138 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5139 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5140 X
= property(GetX
,doc
="See `GetX`")
5141 Y
= property(GetY
,doc
="See `GetY`")
5142 _core_
.KeyEvent_swigregister(KeyEvent
)
5144 #---------------------------------------------------------------------------
5146 class SizeEvent(Event
):
5148 A size event holds information about size change events. The EVT_SIZE
5149 handler function will be called when the window it is bound to has
5152 Note that the size passed is of the whole window: call
5153 `wx.Window.GetClientSize` for the area which may be used by the
5156 When a window is resized, usually only a small part of the window is
5157 damaged and and that area is all that is in the update region for the
5158 next paint event. However, if your drawing depends on the size of the
5159 window, you may need to clear the DC explicitly and repaint the whole
5160 window. In which case, you may need to call `wx.Window.Refresh` to
5161 invalidate the entire window.
5164 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5165 __repr__
= _swig_repr
5166 def __init__(self
, *args
, **kwargs
):
5168 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5170 Construct a new ``wx.SizeEvent``.
5172 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5173 def GetSize(*args
, **kwargs
):
5175 GetSize(self) -> Size
5177 Returns the entire size of the window generating the size change
5180 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5182 def GetRect(*args
, **kwargs
):
5183 """GetRect(self) -> Rect"""
5184 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5186 def SetRect(*args
, **kwargs
):
5187 """SetRect(self, Rect rect)"""
5188 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5190 def SetSize(*args
, **kwargs
):
5191 """SetSize(self, Size size)"""
5192 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5194 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5195 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5196 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5197 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5198 _core_
.SizeEvent_swigregister(SizeEvent
)
5200 #---------------------------------------------------------------------------
5202 class MoveEvent(Event
):
5204 This event object is sent for EVT_MOVE event bindings when a window is
5205 moved to a new position.
5207 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5208 __repr__
= _swig_repr
5209 def __init__(self
, *args
, **kwargs
):
5211 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5215 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5216 def GetPosition(*args
, **kwargs
):
5218 GetPosition(self) -> Point
5220 Returns the position of the window generating the move change event.
5222 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5224 def GetRect(*args
, **kwargs
):
5225 """GetRect(self) -> Rect"""
5226 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5228 def SetRect(*args
, **kwargs
):
5229 """SetRect(self, Rect rect)"""
5230 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5232 def SetPosition(*args
, **kwargs
):
5233 """SetPosition(self, Point pos)"""
5234 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5236 m_pos
= property(GetPosition
, SetPosition
)
5237 m_rect
= property(GetRect
, SetRect
)
5239 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5240 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5241 _core_
.MoveEvent_swigregister(MoveEvent
)
5243 #---------------------------------------------------------------------------
5245 class PaintEvent(Event
):
5247 A paint event is sent when a window's contents needs to be repainted.
5248 Note that in an EVT_PAINT handler the application must *always* create
5249 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5250 Windows assumes that the window has not been painted yet and will send
5251 the event again, causing endless refreshes.
5253 You can optimize painting by retrieving the rectangles that have been
5254 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5255 and only repainting these rectangles. The rectangles are in terms of
5256 the client area, and are unscrolled, so you will need to do some
5257 calculations using the current view position to obtain logical,
5261 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5262 __repr__
= _swig_repr
5263 def __init__(self
, *args
, **kwargs
):
5264 """__init__(self, int Id=0) -> PaintEvent"""
5265 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5266 _core_
.PaintEvent_swigregister(PaintEvent
)
5268 class NcPaintEvent(Event
):
5269 """Proxy of C++ NcPaintEvent class"""
5270 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5271 __repr__
= _swig_repr
5272 def __init__(self
, *args
, **kwargs
):
5273 """__init__(self, int winid=0) -> NcPaintEvent"""
5274 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5275 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5277 #---------------------------------------------------------------------------
5279 class EraseEvent(Event
):
5281 An erase event is sent whenever the background of a window needs to be
5282 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5283 binder. On some platforms, such as GTK+, this event is simulated
5284 (simply generated just before the paint event) and may cause flicker.
5286 To paint a custom background use the `GetDC` method and use the returned
5287 device context if it is not ``None``, otherwise create a temporary
5288 `wx.ClientDC` and draw on that.
5291 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5292 __repr__
= _swig_repr
5293 def __init__(self
, *args
, **kwargs
):
5295 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5299 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5300 def GetDC(*args
, **kwargs
):
5304 Returns the device context the event handler should draw upon. If
5305 ``None`` is returned then create a temporary `wx.ClientDC` and use
5308 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5310 DC
= property(GetDC
,doc
="See `GetDC`")
5311 _core_
.EraseEvent_swigregister(EraseEvent
)
5313 #---------------------------------------------------------------------------
5315 class FocusEvent(Event
):
5317 A focus event is sent when a window's focus changes. The window losing
5318 focus receives an EVT_KILL_FOCUS event while the window gaining it
5319 gets an EVT_SET_FOCUS event.
5321 Notice that the set focus event happens both when the user gives focus
5322 to the window (whether using the mouse or keyboard) and when it is
5323 done from the program itself using `wx.Window.SetFocus`.
5326 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5327 __repr__
= _swig_repr
5328 def __init__(self
, *args
, **kwargs
):
5330 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5334 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5335 def GetWindow(*args
, **kwargs
):
5337 GetWindow(self) -> Window
5339 Returns the other window associated with this event, that is the
5340 window which had the focus before for the EVT_SET_FOCUS event and the
5341 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5343 Warning: the window returned may be None!
5345 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5347 def SetWindow(*args
, **kwargs
):
5348 """SetWindow(self, Window win)"""
5349 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5351 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5352 _core_
.FocusEvent_swigregister(FocusEvent
)
5354 #---------------------------------------------------------------------------
5356 class ChildFocusEvent(CommandEvent
):
5358 A child focus event is sent to a (parent-)window when one of its child
5359 windows gains focus, so that the window could restore the focus back
5360 to its corresponding child if it loses it now and regains later.
5362 Notice that child window is the direct child of the window receiving
5363 the event, and so may not be the actual widget recieving focus if it
5364 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5365 to get the widget that is actually receiving focus.
5367 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5368 __repr__
= _swig_repr
5369 def __init__(self
, *args
, **kwargs
):
5371 __init__(self, Window win=None) -> ChildFocusEvent
5375 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5376 def GetWindow(*args
, **kwargs
):
5378 GetWindow(self) -> Window
5380 The window, or (grand)parent of the window which has just received the
5383 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5385 Window
= property(GetWindow
,doc
="See `GetWindow`")
5386 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5388 #---------------------------------------------------------------------------
5390 class ActivateEvent(Event
):
5392 An activate event is sent when a top-level window or the entire
5393 application is being activated or deactivated.
5395 A top-level window (a dialog or frame) receives an activate event when
5396 is being activated or deactivated. This is indicated visually by the
5397 title bar changing colour, and a subwindow gaining the keyboard focus.
5398 An application is activated or deactivated when one of its frames
5399 becomes activated, or a frame becomes inactivate resulting in all
5400 application frames being inactive.
5402 Please note that usually you should call event.Skip() in your handlers
5403 for these events so the default handlers will still be called, as not
5404 doing so can result in strange effects.
5407 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5408 __repr__
= _swig_repr
5409 def __init__(self
, *args
, **kwargs
):
5411 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5415 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5416 def GetActive(*args
, **kwargs
):
5418 GetActive(self) -> bool
5420 Returns true if the application or window is being activated, false
5423 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5425 Active
= property(GetActive
,doc
="See `GetActive`")
5426 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5428 #---------------------------------------------------------------------------
5430 class InitDialogEvent(Event
):
5432 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5433 any window when `wx.Window.InitDialog` is called. Handlers for this
5434 event can transfer data to the window, or anything else that should be
5435 done before the user begins editing the form. The default handler
5436 calls `wx.Window.TransferDataToWindow`.
5438 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5439 __repr__
= _swig_repr
5440 def __init__(self
, *args
, **kwargs
):
5442 __init__(self, int Id=0) -> InitDialogEvent
5446 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5447 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5449 #---------------------------------------------------------------------------
5451 class MenuEvent(Event
):
5453 This class is used for a variety of menu-related events. Note that
5454 these do not include menu command events, which are handled by sending
5455 `wx.CommandEvent` objects.
5457 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5458 text in the first field of the status bar.
5460 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5461 __repr__
= _swig_repr
5462 def __init__(self
, *args
, **kwargs
):
5464 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5468 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5469 def GetMenuId(*args
, **kwargs
):
5471 GetMenuId(self) -> int
5473 Returns the menu identifier associated with the event. This method
5474 should be only used with the HIGHLIGHT events.
5476 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5478 def IsPopup(*args
, **kwargs
):
5480 IsPopup(self) -> bool
5482 Returns ``True`` if the menu which is being opened or closed is a
5483 popup menu, ``False`` if it is a normal one. This method should only
5484 be used with the OPEN and CLOSE events.
5486 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5488 def GetMenu(*args
, **kwargs
):
5490 GetMenu(self) -> Menu
5492 Returns the menu which is being opened or closed. This method should
5493 only be used with the OPEN and CLOSE events.
5495 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5497 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5498 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5499 _core_
.MenuEvent_swigregister(MenuEvent
)
5501 #---------------------------------------------------------------------------
5503 class CloseEvent(Event
):
5505 This event class contains information about window and session close
5508 The handler function for EVT_CLOSE is called when the user has tried
5509 to close a a frame or dialog box using the window manager controls or
5510 the system menu. It can also be invoked by the application itself
5511 programmatically, for example by calling the `wx.Window.Close`
5514 You should check whether the application is forcing the deletion of
5515 the window using `CanVeto`. If it returns ``False``, you must destroy
5516 the window using `wx.Window.Destroy`. If the return value is ``True``,
5517 it is up to you whether you respond by destroying the window or not.
5518 For example you may wish to display a message dialog prompting to save
5519 files or to cancel the close.
5521 If you don't destroy the window, you should call `Veto` to let the
5522 calling code know that you did not destroy the window. This allows the
5523 `wx.Window.Close` function to return ``True`` or ``False`` depending
5524 on whether the close instruction was honored or not.
5526 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5527 __repr__
= _swig_repr
5528 def __init__(self
, *args
, **kwargs
):
5530 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5534 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5535 def SetLoggingOff(*args
, **kwargs
):
5537 SetLoggingOff(self, bool logOff)
5539 Sets the 'logging off' flag.
5541 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5543 def GetLoggingOff(*args
, **kwargs
):
5545 GetLoggingOff(self) -> bool
5547 Returns ``True`` if the user is logging off or ``False`` if the
5548 system is shutting down. This method can only be called for end
5549 session and query end session events, it doesn't make sense for close
5552 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5554 def Veto(*args
, **kwargs
):
5556 Veto(self, bool veto=True)
5558 Call this from your event handler to veto a system shutdown or to
5559 signal to the calling application that a window close did not happen.
5561 You can only veto a shutdown or close if `CanVeto` returns true.
5563 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5565 def GetVeto(*args
, **kwargs
):
5566 """GetVeto(self) -> bool"""
5567 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5569 def SetCanVeto(*args
, **kwargs
):
5571 SetCanVeto(self, bool canVeto)
5573 Sets the 'can veto' flag.
5575 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5577 def CanVeto(*args
, **kwargs
):
5579 CanVeto(self) -> bool
5581 Returns true if you can veto a system shutdown or a window close
5582 event. Vetoing a window close event is not possible if the calling
5583 code wishes to force the application to exit, and so this function
5584 must be called to check this.
5586 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5588 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5589 _core_
.CloseEvent_swigregister(CloseEvent
)
5591 #---------------------------------------------------------------------------
5593 class ShowEvent(Event
):
5594 """An EVT_SHOW event is sent when a window is shown or hidden."""
5595 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5596 __repr__
= _swig_repr
5597 def __init__(self
, *args
, **kwargs
):
5599 __init__(self, int winid=0, bool show=False) -> ShowEvent
5601 An EVT_SHOW event is sent when a window is shown or hidden.
5603 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5604 def SetShow(*args
, **kwargs
):
5605 """SetShow(self, bool show)"""
5606 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5608 def GetShow(*args
, **kwargs
):
5609 """GetShow(self) -> bool"""
5610 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5612 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5613 _core_
.ShowEvent_swigregister(ShowEvent
)
5615 #---------------------------------------------------------------------------
5617 class IconizeEvent(Event
):
5619 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5622 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5623 __repr__
= _swig_repr
5624 def __init__(self
, *args
, **kwargs
):
5626 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5628 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5631 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5632 def Iconized(*args
, **kwargs
):
5634 Iconized(self) -> bool
5636 Returns ``True`` if the frame has been iconized, ``False`` if it has
5639 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5641 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5643 #---------------------------------------------------------------------------
5645 class MaximizeEvent(Event
):
5646 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5647 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5648 __repr__
= _swig_repr
5649 def __init__(self
, *args
, **kwargs
):
5651 __init__(self, int id=0) -> MaximizeEvent
5653 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5655 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5656 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5658 #---------------------------------------------------------------------------
5660 class DropFilesEvent(Event
):
5662 This class is used for drop files events, that is, when files have
5663 been dropped onto the window. This functionality is only available
5664 under Windows. The window must have previously been enabled for
5665 dropping by calling `wx.Window.DragAcceptFiles`.
5667 Important note: this is a separate implementation to the more general
5668 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5669 implementation uses the older, Windows message-based approach of
5672 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5676 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5677 def __init__(self
): raise AttributeError, "No constructor defined"
5678 __repr__
= _swig_repr
5679 def GetPosition(*args
, **kwargs
):
5681 GetPosition(self) -> Point
5683 Returns the position at which the files were dropped.
5685 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5687 def GetNumberOfFiles(*args
, **kwargs
):
5689 GetNumberOfFiles(self) -> int
5691 Returns the number of files dropped.
5693 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5695 def GetFiles(*args
, **kwargs
):
5697 GetFiles(self) -> PyObject
5699 Returns a list of the filenames that were dropped.
5701 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5703 Files
= property(GetFiles
,doc
="See `GetFiles`")
5704 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5705 Position
= property(GetPosition
,doc
="See `GetPosition`")
5706 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5708 #---------------------------------------------------------------------------
5710 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5711 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5712 class UpdateUIEvent(CommandEvent
):
5714 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5715 wxWidgets to give an application the chance to update various user
5718 Without update UI events, an application has to work hard to
5719 check/uncheck, enable/disable, and set the text for elements such as
5720 menu items and toolbar buttons. The code for doing this has to be
5721 mixed up with the code that is invoked when an action is invoked for a
5722 menu item or button.
5724 With update UI events, you define an event handler to look at the
5725 state of the application and change UI elements accordingly. wxWidgets
5726 will call your handler functions in idle time, so you don't have to
5727 worry where to call this code. In addition to being a clearer and more
5728 declarative method, it also means you don't have to worry whether
5729 you're updating a toolbar or menubar identifier. The same handler can
5730 update a menu item and toolbar button, if the ID values are the same.
5732 Instead of directly manipulating the menu or button, you call
5733 functions in the event object, such as `Check`. wxWidgets will
5734 determine whether such a call has been made, and which UI element to
5737 These events will work for popup menus as well as menubars. Just
5738 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5739 any UI events for the window that owns the menu.
5741 If you find that the overhead of UI update processing is affecting
5742 your application, you can do one or both of the following:
5744 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5745 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5746 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5747 receive update events. No other windows will receive update
5750 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5751 value to set the delay between updates. You may need to call
5752 `wx.Window.UpdateWindowUI` at critical points, for example when
5753 a dialog is about to be shown, in case the user sees a slight
5754 delay before windows are updated.
5756 Note that although events are sent in idle time, defining a EVT_IDLE
5757 handler for a window does not affect this because the events are sent
5758 from an internal idle handler.
5760 wxWidgets tries to optimize update events on some platforms. On
5761 Windows and GTK+, events for menubar items are only sent when the menu
5762 is about to be shown, and not in idle time.
5765 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5766 __repr__
= _swig_repr
5767 def __init__(self
, *args
, **kwargs
):
5769 __init__(self, int commandId=0) -> UpdateUIEvent
5773 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
5774 def GetChecked(*args
, **kwargs
):
5776 GetChecked(self) -> bool
5778 Returns ``True`` if the UI element should be checked.
5780 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
5782 def GetEnabled(*args
, **kwargs
):
5784 GetEnabled(self) -> bool
5786 Returns ``True`` if the UI element should be enabled.
5788 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
5790 def GetShown(*args
, **kwargs
):
5792 GetShown(self) -> bool
5794 Returns ``True`` if the UI element should be shown.
5796 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
5798 def GetText(*args
, **kwargs
):
5800 GetText(self) -> String
5802 Returns the text that should be set for the UI element.
5804 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
5806 def GetSetText(*args
, **kwargs
):
5808 GetSetText(self) -> bool
5810 Returns ``True`` if the application has called `SetText`. For
5811 wxWidgets internal use only.
5813 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
5815 def GetSetChecked(*args
, **kwargs
):
5817 GetSetChecked(self) -> bool
5819 Returns ``True`` if the application has called `Check`. For wxWidgets
5822 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
5824 def GetSetEnabled(*args
, **kwargs
):
5826 GetSetEnabled(self) -> bool
5828 Returns ``True`` if the application has called `Enable`. For wxWidgets
5831 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
5833 def GetSetShown(*args
, **kwargs
):
5835 GetSetShown(self) -> bool
5837 Returns ``True`` if the application has called `Show`. For wxWidgets
5840 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
5842 def Check(*args
, **kwargs
):
5844 Check(self, bool check)
5846 Check or uncheck the UI element.
5848 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
5850 def Enable(*args
, **kwargs
):
5852 Enable(self, bool enable)
5854 Enable or disable the UI element.
5856 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
5858 def Show(*args
, **kwargs
):
5860 Show(self, bool show)
5862 Show or hide the UI element.
5864 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
5866 def SetText(*args
, **kwargs
):
5868 SetText(self, String text)
5870 Sets the text for this UI element.
5872 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
5874 def SetUpdateInterval(*args
, **kwargs
):
5876 SetUpdateInterval(long updateInterval)
5878 Sets the interval between updates in milliseconds. Set to -1 to
5879 disable updates, or to 0 to update as frequently as possible. The
5882 Use this to reduce the overhead of UI update events if your
5883 application has a lot of windows. If you set the value to -1 or
5884 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5885 at appropriate points in your application, such as when a dialog is
5888 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5890 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
5891 def GetUpdateInterval(*args
, **kwargs
):
5893 GetUpdateInterval() -> long
5895 Returns the current interval between updates in milliseconds. -1
5896 disables updates, 0 updates as frequently as possible.
5898 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
5900 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
5901 def CanUpdate(*args
, **kwargs
):
5903 CanUpdate(Window win) -> bool
5905 Returns ``True`` if it is appropriate to update (send UI update events
5908 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5909 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5910 events were last sent in idle time, and the update interval, to
5911 determine whether events should be sent to this window now. By default
5912 this will always return true because the update mode is initially
5913 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5914 events will be sent as often as possible. You can reduce the frequency
5915 that events are sent by changing the mode and/or setting an update
5919 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
5921 CanUpdate
= staticmethod(CanUpdate
)
5922 def ResetUpdateTime(*args
, **kwargs
):
5926 Used internally to reset the last-updated time to the current time. It
5927 is assumed that update events are normally sent in idle time, so this
5928 is called at the end of idle processing.
5930 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
5932 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
5933 def SetMode(*args
, **kwargs
):
5937 Specify how wxWidgets will send update events: to all windows, or only
5938 to those which specify that they will process the events.
5940 The mode may be one of the following values:
5942 ============================= ==========================================
5943 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5944 is the default setting.
5945 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5946 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5948 ============================= ==========================================
5951 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
5953 SetMode
= staticmethod(SetMode
)
5954 def GetMode(*args
, **kwargs
):
5958 Returns a value specifying how wxWidgets will send update events: to
5959 all windows, or only to those which specify that they will process the
5962 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
5964 GetMode
= staticmethod(GetMode
)
5965 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
5966 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
5967 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
5968 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
5969 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
5971 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
5973 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5975 Sets the interval between updates in milliseconds. Set to -1 to
5976 disable updates, or to 0 to update as frequently as possible. The
5979 Use this to reduce the overhead of UI update events if your
5980 application has a lot of windows. If you set the value to -1 or
5981 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5982 at appropriate points in your application, such as when a dialog is
5985 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5987 def UpdateUIEvent_GetUpdateInterval(*args
):
5989 UpdateUIEvent_GetUpdateInterval() -> long
5991 Returns the current interval between updates in milliseconds. -1
5992 disables updates, 0 updates as frequently as possible.
5994 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
5996 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
5998 UpdateUIEvent_CanUpdate(Window win) -> bool
6000 Returns ``True`` if it is appropriate to update (send UI update events
6003 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6004 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6005 events were last sent in idle time, and the update interval, to
6006 determine whether events should be sent to this window now. By default
6007 this will always return true because the update mode is initially
6008 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6009 events will be sent as often as possible. You can reduce the frequency
6010 that events are sent by changing the mode and/or setting an update
6014 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6016 def UpdateUIEvent_ResetUpdateTime(*args
):
6018 UpdateUIEvent_ResetUpdateTime()
6020 Used internally to reset the last-updated time to the current time. It
6021 is assumed that update events are normally sent in idle time, so this
6022 is called at the end of idle processing.
6024 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6026 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6028 UpdateUIEvent_SetMode(int mode)
6030 Specify how wxWidgets will send update events: to all windows, or only
6031 to those which specify that they will process the events.
6033 The mode may be one of the following values:
6035 ============================= ==========================================
6036 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6037 is the default setting.
6038 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6039 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6041 ============================= ==========================================
6044 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6046 def UpdateUIEvent_GetMode(*args
):
6048 UpdateUIEvent_GetMode() -> int
6050 Returns a value specifying how wxWidgets will send update events: to
6051 all windows, or only to those which specify that they will process the
6054 return _core_
.UpdateUIEvent_GetMode(*args
)
6056 #---------------------------------------------------------------------------
6058 class SysColourChangedEvent(Event
):
6060 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6061 when the user changes the colour settings using the control
6062 panel. This is only applicable under Windows.
6064 The default event handler for this event propagates the event to child
6065 windows, since Windows only sends the events to top-level windows. If
6066 intercepting this event for a top-level window, remember to call
6067 `Skip` so the the base class handler will still be executed, or to
6068 pass the event on to the window's children explicitly.
6071 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6072 __repr__
= _swig_repr
6073 def __init__(self
, *args
, **kwargs
):
6075 __init__(self) -> SysColourChangedEvent
6079 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6080 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6082 #---------------------------------------------------------------------------
6084 class MouseCaptureChangedEvent(Event
):
6086 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6087 a window that loses its mouse capture. This is called even if
6088 `wx.Window.ReleaseMouse` was called by the application code. Handling
6089 this event allows an application to cater for unexpected capture
6090 releases which might otherwise confuse mouse handling code.
6092 This event is implemented under Windows only.
6094 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6095 __repr__
= _swig_repr
6096 def __init__(self
, *args
, **kwargs
):
6098 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6102 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6103 def GetCapturedWindow(*args
, **kwargs
):
6105 GetCapturedWindow(self) -> Window
6107 Returns the window that gained the capture, or ``None`` if it was a
6108 non-wxWidgets window.
6110 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6112 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6113 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6115 #---------------------------------------------------------------------------
6117 class MouseCaptureLostEvent(Event
):
6119 A mouse capture lost event is sent to a window that obtained mouse
6120 capture, which was subsequently loss due to "external" event, for
6121 example when a dialog box is shown or if another application captures
6124 If this happens, this event is sent to all windows that are on the
6125 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6126 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6127 if the capture changes because of a call to CaptureMouse or
6130 This event is currently emitted under Windows only.
6133 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6134 __repr__
= _swig_repr
6135 def __init__(self
, *args
, **kwargs
):
6137 __init__(self, int winid=0) -> MouseCaptureLostEvent
6139 A mouse capture lost event is sent to a window that obtained mouse
6140 capture, which was subsequently loss due to "external" event, for
6141 example when a dialog box is shown or if another application captures
6144 If this happens, this event is sent to all windows that are on the
6145 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6146 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6147 if the capture changes because of a call to CaptureMouse or
6150 This event is currently emitted under Windows only.
6153 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6154 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6156 #---------------------------------------------------------------------------
6158 class DisplayChangedEvent(Event
):
6160 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6161 resolution has changed.
6163 This event is implemented under Windows only.
6165 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6166 __repr__
= _swig_repr
6167 def __init__(self
, *args
, **kwargs
):
6168 """__init__(self) -> DisplayChangedEvent"""
6169 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6170 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6172 #---------------------------------------------------------------------------
6174 class PaletteChangedEvent(Event
):
6176 An EVT_PALETTE_CHANGED event is sent when the system palette has
6177 changed, thereby giving each window a chance to redo their own to
6180 This event is implemented under Windows only.
6182 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6183 __repr__
= _swig_repr
6184 def __init__(self
, *args
, **kwargs
):
6186 __init__(self, int id=0) -> PaletteChangedEvent
6188 An EVT_PALETTE_CHANGED event is sent when the system palette has
6189 changed, thereby giving each window a chance to redo their own to
6192 This event is implemented under Windows only.
6194 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6195 def SetChangedWindow(*args
, **kwargs
):
6196 """SetChangedWindow(self, Window win)"""
6197 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6199 def GetChangedWindow(*args
, **kwargs
):
6200 """GetChangedWindow(self) -> Window"""
6201 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6203 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6204 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6206 #---------------------------------------------------------------------------
6208 class QueryNewPaletteEvent(Event
):
6210 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6211 focus and should re-do its palette.
6213 This event is implemented under Windows only.
6215 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6216 __repr__
= _swig_repr
6217 def __init__(self
, *args
, **kwargs
):
6219 __init__(self, int winid=0) -> QueryNewPaletteEvent
6223 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6224 def SetPaletteRealized(*args
, **kwargs
):
6226 SetPaletteRealized(self, bool realized)
6228 App should set this if it changes the palette.
6230 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6232 def GetPaletteRealized(*args
, **kwargs
):
6233 """GetPaletteRealized(self) -> bool"""
6234 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6236 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6237 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6239 #---------------------------------------------------------------------------
6241 class NavigationKeyEvent(Event
):
6243 EVT_NAVIGATION_KEY events are used to control moving the focus between
6244 widgets, otherwise known as tab-traversal. You woudl normally not
6245 catch navigation events in applications as there are already
6246 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6247 it useful to send navigation events in certain situations to change
6248 the focus in certain ways, although it's probably easier to just call
6249 `wx.Window.Navigate`.
6251 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6252 __repr__
= _swig_repr
6253 def __init__(self
, *args
, **kwargs
):
6254 """__init__(self) -> NavigationKeyEvent"""
6255 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6256 def GetDirection(*args
, **kwargs
):
6258 GetDirection(self) -> bool
6260 Returns ``True`` if the direction is forward, ``False`` otherwise.
6262 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6264 def SetDirection(*args
, **kwargs
):
6266 SetDirection(self, bool forward)
6268 Specify the direction that the navigation should take. Usually the
6269 difference between using Tab and Shift-Tab.
6271 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6273 def IsWindowChange(*args
, **kwargs
):
6275 IsWindowChange(self) -> bool
6277 Returns ``True`` if window change is allowed.
6279 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6281 def SetWindowChange(*args
, **kwargs
):
6283 SetWindowChange(self, bool ischange)
6285 Specify if the navigation should be able to change parent windows.
6286 For example, changing notebook pages, etc. This is usually implemented
6287 by using Control-Tab.
6289 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6291 def IsFromTab(*args
, **kwargs
):
6293 IsFromTab(self) -> bool
6295 Returns ``True`` if the navigation event is originated from the Tab
6298 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6300 def SetFromTab(*args
, **kwargs
):
6302 SetFromTab(self, bool bIs)
6304 Set to true under MSW if the event was generated using the tab key.
6305 This is required for proper navogation over radio buttons.
6307 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6309 def SetFlags(*args
, **kwargs
):
6311 SetFlags(self, long flags)
6313 Set the navigation flags to a combination of the following:
6315 * wx.NavigationKeyEvent.IsBackward
6316 * wx.NavigationKeyEvent.IsForward
6317 * wx.NavigationKeyEvent.WinChange
6318 * wx.NavigationKeyEvent.FromTab
6321 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6323 def GetCurrentFocus(*args
, **kwargs
):
6325 GetCurrentFocus(self) -> Window
6327 Returns the child window which currenty has the focus. May be
6330 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6332 def SetCurrentFocus(*args
, **kwargs
):
6334 SetCurrentFocus(self, Window win)
6336 Set the window that has the focus.
6338 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6340 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6341 IsForward
= _core_
.NavigationKeyEvent_IsForward
6342 WinChange
= _core_
.NavigationKeyEvent_WinChange
6343 FromTab
= _core_
.NavigationKeyEvent_FromTab
6344 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6345 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6346 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6348 #---------------------------------------------------------------------------
6350 class WindowCreateEvent(CommandEvent
):
6352 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6353 underlying GUI object) exists.
6355 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6356 __repr__
= _swig_repr
6357 def __init__(self
, *args
, **kwargs
):
6359 __init__(self, Window win=None) -> WindowCreateEvent
6361 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6362 underlying GUI object) exists.
6364 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6365 def GetWindow(*args
, **kwargs
):
6367 GetWindow(self) -> Window
6369 Returns the window that this event refers to.
6371 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6373 Window
= property(GetWindow
,doc
="See `GetWindow`")
6374 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6376 class WindowDestroyEvent(CommandEvent
):
6378 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6379 when the GUI window is destroyed.
6381 When a class derived from `wx.Window` is destroyed its destructor will
6382 have already run by the time this event is sent. Therefore this event
6383 will not usually be received at all by the window itself. Since it is
6384 received after the destructor has run, an object should not try to
6385 handle its own wx.WindowDestroyEvent, but it can be used to get
6386 notification of the destruction of another window.
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
):
6392 __init__(self, Window win=None) -> WindowDestroyEvent
6394 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6395 when the GUI window is destroyed.
6397 When a class derived from `wx.Window` is destroyed its destructor will
6398 have already run by the time this event is sent. Therefore this event
6399 will not usually be received at all by the window itself. Since it is
6400 received after the destructor has run, an object should not try to
6401 handle its own wx.WindowDestroyEvent, but it can be used to get
6402 notification of the destruction of another window.
6404 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6405 def GetWindow(*args
, **kwargs
):
6407 GetWindow(self) -> Window
6409 Returns the window that this event refers to.
6411 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6413 Window
= property(GetWindow
,doc
="See `GetWindow`")
6414 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6416 #---------------------------------------------------------------------------
6418 class ContextMenuEvent(CommandEvent
):
6420 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6421 give the application a chance to show a context (popup) menu.
6423 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6424 __repr__
= _swig_repr
6425 def __init__(self
, *args
, **kwargs
):
6427 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6431 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6432 def GetPosition(*args
, **kwargs
):
6434 GetPosition(self) -> Point
6436 Returns the position (in screen coordinants) at which the menu should
6439 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6441 def SetPosition(*args
, **kwargs
):
6443 SetPosition(self, Point pos)
6445 Sets the position at which the menu should be shown.
6447 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6449 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6450 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6452 #---------------------------------------------------------------------------
6454 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6455 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6456 class IdleEvent(Event
):
6458 This class is used for EVT_IDLE events, which are generated and sent
6459 when the application *becomes* idle. In other words, the when the
6460 event queue becomes empty then idle events are sent to all windows (by
6461 default) and as long as none of them call `RequestMore` then there are
6462 no more idle events until after the system event queue has some normal
6463 events and then becomes empty again.
6465 By default, idle events are sent to all windows. If this is causing a
6466 significant overhead in your application, you can call
6467 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6468 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6469 which should receive idle events. Then idle events will only be sent
6470 to those windows and not to any others.
6472 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6473 __repr__
= _swig_repr
6474 def __init__(self
, *args
, **kwargs
):
6476 __init__(self) -> IdleEvent
6480 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6481 def RequestMore(*args
, **kwargs
):
6483 RequestMore(self, bool needMore=True)
6485 Tells wxWidgets that more processing is required. This function can be
6486 called by an EVT_IDLE handler for a window to indicate that the
6487 application should forward the EVT_IDLE event once more to the
6488 application windows. If no window calls this function during its
6489 EVT_IDLE handler, then the application will remain in a passive event
6490 loop until a new event is posted to the application by the windowing
6493 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6495 def MoreRequested(*args
, **kwargs
):
6497 MoreRequested(self) -> bool
6499 Returns ``True`` if the OnIdle function processing this event
6500 requested more processing time.
6502 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6504 def SetMode(*args
, **kwargs
):
6508 Static method for specifying how wxWidgets will send idle events: to
6509 all windows, or only to those which specify that they will process the
6512 The mode can be one of the following values:
6514 ========================= ========================================
6515 wx.IDLE_PROCESS_ALL Send idle events to all windows
6516 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6517 the wx.WS_EX_PROCESS_IDLE extra style
6519 ========================= ========================================
6522 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6524 SetMode
= staticmethod(SetMode
)
6525 def GetMode(*args
, **kwargs
):
6529 Static method returning a value specifying how wxWidgets will send
6530 idle events: to all windows, or only to those which specify that they
6531 will process the events.
6533 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6535 GetMode
= staticmethod(GetMode
)
6536 def CanSend(*args
, **kwargs
):
6538 CanSend(Window win) -> bool
6540 Returns ``True`` if it is appropriate to send idle events to this
6543 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6544 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6545 events should be sent to this window now. By default this will always
6546 return ``True`` because the update mode is initially
6547 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6548 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6550 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6552 CanSend
= staticmethod(CanSend
)
6553 _core_
.IdleEvent_swigregister(IdleEvent
)
6555 def IdleEvent_SetMode(*args
, **kwargs
):
6557 IdleEvent_SetMode(int mode)
6559 Static method for specifying how wxWidgets will send idle events: to
6560 all windows, or only to those which specify that they will process the
6563 The mode can be one of the following values:
6565 ========================= ========================================
6566 wx.IDLE_PROCESS_ALL Send idle events to all windows
6567 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6568 the wx.WS_EX_PROCESS_IDLE extra style
6570 ========================= ========================================
6573 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6575 def IdleEvent_GetMode(*args
):
6577 IdleEvent_GetMode() -> int
6579 Static method returning a value specifying how wxWidgets will send
6580 idle events: to all windows, or only to those which specify that they
6581 will process the events.
6583 return _core_
.IdleEvent_GetMode(*args
)
6585 def IdleEvent_CanSend(*args
, **kwargs
):
6587 IdleEvent_CanSend(Window win) -> bool
6589 Returns ``True`` if it is appropriate to send idle events to this
6592 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6593 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6594 events should be sent to this window now. By default this will always
6595 return ``True`` because the update mode is initially
6596 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6597 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6599 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6601 #---------------------------------------------------------------------------
6603 class ClipboardTextEvent(CommandEvent
):
6605 A Clipboard Text event is sent when a window intercepts a text
6606 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6607 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6608 popup menu command, etc. NOTE : under windows these events are *NOT*
6609 generated automatically for a Rich Edit text control.
6611 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6612 __repr__
= _swig_repr
6613 def __init__(self
, *args
, **kwargs
):
6615 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6617 A Clipboard Text event is sent when a window intercepts a text
6618 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6619 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6620 popup menu command, etc. NOTE : under windows these events are *NOT*
6621 generated automatically for a Rich Edit text control.
6623 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6624 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6626 #---------------------------------------------------------------------------
6628 class PyEvent(Event
):
6630 wx.PyEvent can be used as a base class for implementing custom event
6631 types in Python. You should derived from this class instead of
6632 `wx.Event` because this class is Python-aware and is able to transport
6633 its Python bits safely through the wxWidgets event system and have
6634 them still be there when the event handler is invoked.
6636 :see: `wx.PyCommandEvent`
6639 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6640 __repr__
= _swig_repr
6641 def __init__(self
, *args
, **kwargs
):
6642 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6643 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6646 __swig_destroy__
= _core_
.delete_PyEvent
6647 __del__
= lambda self
: None;
6648 def _SetSelf(*args
, **kwargs
):
6649 """_SetSelf(self, PyObject self)"""
6650 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6652 def _GetSelf(*args
, **kwargs
):
6653 """_GetSelf(self) -> PyObject"""
6654 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6656 _core_
.PyEvent_swigregister(PyEvent
)
6658 class PyCommandEvent(CommandEvent
):
6660 wx.PyCommandEvent can be used as a base class for implementing custom
6661 event types in Python, where the event shoudl travel up to parent
6662 windows looking for a handler. You should derived from this class
6663 instead of `wx.CommandEvent` because this class is Python-aware and is
6664 able to transport its Python bits safely through the wxWidgets event
6665 system and have them still be there when the event handler is invoked.
6670 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6671 __repr__
= _swig_repr
6672 def __init__(self
, *args
, **kwargs
):
6673 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6674 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6677 __swig_destroy__
= _core_
.delete_PyCommandEvent
6678 __del__
= lambda self
: None;
6679 def _SetSelf(*args
, **kwargs
):
6680 """_SetSelf(self, PyObject self)"""
6681 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6683 def _GetSelf(*args
, **kwargs
):
6684 """_GetSelf(self) -> PyObject"""
6685 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6687 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6689 class DateEvent(CommandEvent
):
6691 This event class holds information about a date change event and is
6692 used together with `wx.DatePickerCtrl`. It also serves as a base class
6693 for `wx.calendar.CalendarEvent`. Bind these event types with
6696 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6697 __repr__
= _swig_repr
6698 def __init__(self
, *args
, **kwargs
):
6699 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6700 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6701 def GetDate(*args
, **kwargs
):
6703 GetDate(self) -> DateTime
6707 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6709 def SetDate(*args
, **kwargs
):
6711 SetDate(self, DateTime date)
6713 Sets the date carried by the event, normally only used by the library
6716 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6718 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6719 _core_
.DateEvent_swigregister(DateEvent
)
6721 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6722 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6724 #---------------------------------------------------------------------------
6726 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6727 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6728 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6729 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6730 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6731 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6732 class PyApp(EvtHandler
):
6734 The ``wx.PyApp`` class is an *implementation detail*, please use the
6735 `wx.App` class (or some other derived class) instead.
6737 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6738 __repr__
= _swig_repr
6739 def __init__(self
, *args
, **kwargs
):
6741 __init__(self) -> PyApp
6743 Create a new application object, starting the bootstrap process.
6745 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
6746 self
._setCallbackInfo
(self
, PyApp
, False)
6747 self
._setOORInfo
(self
, False)
6749 __swig_destroy__
= _core_
.delete_PyApp
6750 __del__
= lambda self
: None;
6751 def _setCallbackInfo(*args
, **kwargs
):
6752 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6753 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
6755 def GetAppName(*args
, **kwargs
):
6757 GetAppName(self) -> String
6759 Get the application name.
6761 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
6763 def SetAppName(*args
, **kwargs
):
6765 SetAppName(self, String name)
6767 Set the application name. This value may be used automatically by
6768 `wx.Config` and such.
6770 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
6772 def GetClassName(*args
, **kwargs
):
6774 GetClassName(self) -> String
6776 Get the application's class name.
6778 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
6780 def SetClassName(*args
, **kwargs
):
6782 SetClassName(self, String name)
6784 Set the application's class name. This value may be used for
6785 X-resources if applicable for the platform
6787 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
6789 def GetVendorName(*args
, **kwargs
):
6791 GetVendorName(self) -> String
6793 Get the application's vendor name.
6795 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
6797 def SetVendorName(*args
, **kwargs
):
6799 SetVendorName(self, String name)
6801 Set the application's vendor name. This value may be used
6802 automatically by `wx.Config` and such.
6804 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
6806 def GetTraits(*args
, **kwargs
):
6808 GetTraits(self) -> wxAppTraits
6810 Return (and create if necessary) the app traits object to which we
6811 delegate for everything which either should be configurable by the
6812 user (then he can change the default behaviour simply by overriding
6813 CreateTraits() and returning his own traits object) or which is
6814 GUI/console dependent as then wx.AppTraits allows us to abstract the
6815 differences behind the common facade.
6817 :todo: Add support for overriding CreateAppTraits in wxPython.
6819 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
6821 def ProcessPendingEvents(*args
, **kwargs
):
6823 ProcessPendingEvents(self)
6825 Process all events in the Pending Events list -- it is necessary to
6826 call this function to process posted events. This normally happens
6827 during each event loop iteration.
6829 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
6831 def Yield(*args
, **kwargs
):
6833 Yield(self, bool onlyIfNeeded=False) -> bool
6835 Process all currently pending events right now, instead of waiting
6836 until return to the event loop. It is an error to call ``Yield``
6837 recursively unless the value of ``onlyIfNeeded`` is True.
6839 :warning: This function is dangerous as it can lead to unexpected
6840 reentrancies (i.e. when called from an event handler it may
6841 result in calling the same event handler again), use with
6842 extreme care or, better, don't use at all!
6844 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6847 return _core_
.PyApp_Yield(*args
, **kwargs
)
6849 def WakeUpIdle(*args
, **kwargs
):
6853 Make sure that idle events are sent again.
6854 :see: `wx.WakeUpIdle`
6856 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
6858 def IsMainLoopRunning(*args
, **kwargs
):
6860 IsMainLoopRunning() -> bool
6862 Returns True if we're running the main loop, i.e. if the events can
6863 currently be dispatched.
6865 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
6867 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
6868 def MainLoop(*args
, **kwargs
):
6870 MainLoop(self) -> int
6872 Execute the main GUI loop, the function doesn't normally return until
6873 all top level windows have been closed and destroyed.
6875 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
6877 def Exit(*args
, **kwargs
):
6881 Exit the main loop thus terminating the application.
6884 return _core_
.PyApp_Exit(*args
, **kwargs
)
6886 def GetLayoutDirection(*args
, **kwargs
):
6888 GetLayoutDirection(self) -> int
6890 Return the layout direction for the current locale.
6892 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
6894 def ExitMainLoop(*args
, **kwargs
):
6898 Exit the main GUI loop during the next iteration of the main
6899 loop, (i.e. it does not stop the program immediately!)
6901 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
6903 def Pending(*args
, **kwargs
):
6905 Pending(self) -> bool
6907 Returns True if there are unprocessed events in the event queue.
6909 return _core_
.PyApp_Pending(*args
, **kwargs
)
6911 def Dispatch(*args
, **kwargs
):
6913 Dispatch(self) -> bool
6915 Process the first event in the event queue (blocks until an event
6916 appears if there are none currently)
6918 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
6920 def ProcessIdle(*args
, **kwargs
):
6922 ProcessIdle(self) -> bool
6924 Called from the MainLoop when the application becomes idle (there are
6925 no pending events) and sends a `wx.IdleEvent` to all interested
6926 parties. Returns True if more idle events are needed, False if not.
6928 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
6930 def SendIdleEvents(*args
, **kwargs
):
6932 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6934 Send idle event to window and all subwindows. Returns True if more
6935 idle time is requested.
6937 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
6939 def IsActive(*args
, **kwargs
):
6941 IsActive(self) -> bool
6943 Return True if our app has focus.
6945 return _core_
.PyApp_IsActive(*args
, **kwargs
)
6947 def SetTopWindow(*args
, **kwargs
):
6949 SetTopWindow(self, Window win)
6951 Set the *main* top level window
6953 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
6955 def GetTopWindow(*args
, **kwargs
):
6957 GetTopWindow(self) -> Window
6959 Return the *main* top level window (if it hadn't been set previously
6960 with SetTopWindow(), will return just some top level window and, if
6961 there not any, will return None)
6963 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
6965 def SetExitOnFrameDelete(*args
, **kwargs
):
6967 SetExitOnFrameDelete(self, bool flag)
6969 Control the exit behaviour: by default, the program will exit the main
6970 loop (and so, usually, terminate) when the last top-level program
6971 window is deleted. Beware that if you disable this behaviour (with
6972 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6973 explicitly from somewhere.
6975 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
6977 def GetExitOnFrameDelete(*args
, **kwargs
):
6979 GetExitOnFrameDelete(self) -> bool
6981 Get the current exit behaviour setting.
6983 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
6985 def SetUseBestVisual(*args
, **kwargs
):
6987 SetUseBestVisual(self, bool flag)
6989 Set whether the app should try to use the best available visual on
6990 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6992 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
6994 def GetUseBestVisual(*args
, **kwargs
):
6996 GetUseBestVisual(self) -> bool
6998 Get current UseBestVisual setting.
7000 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7002 def SetPrintMode(*args
, **kwargs
):
7003 """SetPrintMode(self, int mode)"""
7004 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7006 def GetPrintMode(*args
, **kwargs
):
7007 """GetPrintMode(self) -> int"""
7008 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7010 def SetAssertMode(*args
, **kwargs
):
7012 SetAssertMode(self, int mode)
7014 Set the OnAssert behaviour for debug and hybrid builds.
7016 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7018 def GetAssertMode(*args
, **kwargs
):
7020 GetAssertMode(self) -> int
7022 Get the current OnAssert behaviour setting.
7024 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7026 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7027 """GetMacSupportPCMenuShortcuts() -> bool"""
7028 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7030 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7031 def GetMacAboutMenuItemId(*args
, **kwargs
):
7032 """GetMacAboutMenuItemId() -> long"""
7033 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7035 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7036 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7037 """GetMacPreferencesMenuItemId() -> long"""
7038 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7040 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7041 def GetMacExitMenuItemId(*args
, **kwargs
):
7042 """GetMacExitMenuItemId() -> long"""
7043 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7045 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7046 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7047 """GetMacHelpMenuTitleName() -> String"""
7048 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7050 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7051 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7052 """SetMacSupportPCMenuShortcuts(bool val)"""
7053 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7055 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7056 def SetMacAboutMenuItemId(*args
, **kwargs
):
7057 """SetMacAboutMenuItemId(long val)"""
7058 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7060 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7061 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7062 """SetMacPreferencesMenuItemId(long val)"""
7063 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7065 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7066 def SetMacExitMenuItemId(*args
, **kwargs
):
7067 """SetMacExitMenuItemId(long val)"""
7068 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7070 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7071 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7072 """SetMacHelpMenuTitleName(String val)"""
7073 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7075 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7076 def _BootstrapApp(*args
, **kwargs
):
7080 For internal use only
7082 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7084 def GetComCtl32Version(*args
, **kwargs
):
7086 GetComCtl32Version() -> int
7088 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7089 it wasn't found at all. Raises an exception on non-Windows platforms.
7091 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7093 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7094 def IsDisplayAvailable(*args
, **kwargs
):
7096 IsDisplayAvailable() -> bool
7098 Tests if it is possible to create a GUI in the current environment.
7099 This will mean different things on the different platforms.
7101 * On X Windows systems this function will return ``False`` if it is
7102 not able to open a connection to the X display, which can happen
7103 if $DISPLAY is not set, or is not set correctly.
7105 * On Mac OS X a ``False`` return value will mean that wx is not
7106 able to access the window manager, which can happen if logged in
7107 remotely or if running from the normal version of python instead
7108 of the framework version, (i.e., pythonw.)
7113 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7115 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7116 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7117 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7118 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7119 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7120 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7121 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7122 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7123 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7124 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7125 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7126 Active
= property(IsActive
)
7127 _core_
.PyApp_swigregister(PyApp
)
7129 def PyApp_IsMainLoopRunning(*args
):
7131 PyApp_IsMainLoopRunning() -> bool
7133 Returns True if we're running the main loop, i.e. if the events can
7134 currently be dispatched.
7136 return _core_
.PyApp_IsMainLoopRunning(*args
)
7138 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7139 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7140 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7142 def PyApp_GetMacAboutMenuItemId(*args
):
7143 """PyApp_GetMacAboutMenuItemId() -> long"""
7144 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7146 def PyApp_GetMacPreferencesMenuItemId(*args
):
7147 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7148 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7150 def PyApp_GetMacExitMenuItemId(*args
):
7151 """PyApp_GetMacExitMenuItemId() -> long"""
7152 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7154 def PyApp_GetMacHelpMenuTitleName(*args
):
7155 """PyApp_GetMacHelpMenuTitleName() -> String"""
7156 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7158 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7159 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7160 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7162 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7163 """PyApp_SetMacAboutMenuItemId(long val)"""
7164 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7166 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7167 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7168 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7170 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7171 """PyApp_SetMacExitMenuItemId(long val)"""
7172 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7174 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7175 """PyApp_SetMacHelpMenuTitleName(String val)"""
7176 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7178 def PyApp_GetComCtl32Version(*args
):
7180 PyApp_GetComCtl32Version() -> int
7182 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7183 it wasn't found at all. Raises an exception on non-Windows platforms.
7185 return _core_
.PyApp_GetComCtl32Version(*args
)
7187 def PyApp_IsDisplayAvailable(*args
):
7189 PyApp_IsDisplayAvailable() -> bool
7191 Tests if it is possible to create a GUI in the current environment.
7192 This will mean different things on the different platforms.
7194 * On X Windows systems this function will return ``False`` if it is
7195 not able to open a connection to the X display, which can happen
7196 if $DISPLAY is not set, or is not set correctly.
7198 * On Mac OS X a ``False`` return value will mean that wx is not
7199 able to access the window manager, which can happen if logged in
7200 remotely or if running from the normal version of python instead
7201 of the framework version, (i.e., pythonw.)
7206 return _core_
.PyApp_IsDisplayAvailable(*args
)
7208 #---------------------------------------------------------------------------
7215 Force an exit of the application. Convenience for wx.GetApp().Exit()
7217 return _core_
.Exit(*args
)
7223 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7225 return _core_
.Yield(*args
)
7227 def YieldIfNeeded(*args
):
7229 YieldIfNeeded() -> bool
7231 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7233 return _core_
.YieldIfNeeded(*args
)
7235 def SafeYield(*args
, **kwargs
):
7237 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7239 This function is similar to `wx.Yield`, except that it disables the
7240 user input to all program windows before calling `wx.Yield` and
7241 re-enables it again afterwards. If ``win`` is not None, this window
7242 will remain enabled, allowing the implementation of some limited user
7245 :Returns: the result of the call to `wx.Yield`.
7247 return _core_
.SafeYield(*args
, **kwargs
)
7249 def WakeUpIdle(*args
):
7253 Cause the message queue to become empty again, so idle events will be
7256 return _core_
.WakeUpIdle(*args
)
7258 def PostEvent(*args
, **kwargs
):
7260 PostEvent(EvtHandler dest, Event event)
7262 Send an event to a window or other wx.EvtHandler to be processed
7265 return _core_
.PostEvent(*args
, **kwargs
)
7267 def App_CleanUp(*args
):
7271 For internal use only, it is used to cleanup after wxWidgets when
7274 return _core_
.App_CleanUp(*args
)
7280 Return a reference to the current wx.App object.
7282 return _core_
.GetApp(*args
)
7284 def SetDefaultPyEncoding(*args
, **kwargs
):
7286 SetDefaultPyEncoding(string encoding)
7288 Sets the encoding that wxPython will use when it needs to convert a
7289 Python string or unicode object to or from a wxString.
7291 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7292 but please be aware that the default encoding within the same locale
7293 may be slightly different on different platforms. For example, please
7294 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7295 between the common latin/roman encodings.
7297 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7299 def GetDefaultPyEncoding(*args
):
7301 GetDefaultPyEncoding() -> string
7303 Gets the current encoding that wxPython will use when it needs to
7304 convert a Python string or unicode object to or from a wxString.
7306 return _core_
.GetDefaultPyEncoding(*args
)
7307 #----------------------------------------------------------------------
7309 class PyOnDemandOutputWindow
:
7311 A class that can be used for redirecting Python's stdout and
7312 stderr streams. It will do nothing until something is wrriten to
7313 the stream at which point it will create a Frame with a text area
7314 and write the text there.
7316 def __init__(self
, title
= "wxPython: stdout/stderr"):
7319 self
.pos
= wx
.DefaultPosition
7320 self
.size
= (450, 300)
7323 def SetParent(self
, parent
):
7324 """Set the window to be used as the popup Frame's parent."""
7325 self
.parent
= parent
7328 def CreateOutputWindow(self
, st
):
7329 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7330 style
=wx
.DEFAULT_FRAME_STYLE
)
7331 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7332 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7333 self
.text
.AppendText(st
)
7334 self
.frame
.Show(True)
7335 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7338 def OnCloseWindow(self
, event
):
7339 if self
.frame
is not None:
7340 self
.frame
.Destroy()
7345 # These methods provide the file-like output behaviour.
7346 def write(self
, text
):
7348 Create the output window if needed and write the string to it.
7349 If not called in the context of the gui thread then uses
7350 CallAfter to do the work there.
7352 if self
.frame
is None:
7353 if not wx
.Thread_IsMain():
7354 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7356 self
.CreateOutputWindow(text
)
7358 if not wx
.Thread_IsMain():
7359 wx
.CallAfter(self
.text
.AppendText
, text
)
7361 self
.text
.AppendText(text
)
7365 if self
.frame
is not None:
7366 wx
.CallAfter(self
.frame
.Close
)
7374 #----------------------------------------------------------------------
7376 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7378 class App(wx
.PyApp
):
7380 The ``wx.App`` class represents the application and is used to:
7382 * bootstrap the wxPython system and initialize the underlying
7384 * set and get application-wide properties
7385 * implement the windowing system main message or event loop,
7386 and to dispatch events to window instances
7389 Every application must have a ``wx.App`` instance, and all
7390 creation of UI objects should be delayed until after the
7391 ``wx.App`` object has been created in order to ensure that the gui
7392 platform and wxWidgets have been fully initialized.
7394 Normally you would derive from this class and implement an
7395 ``OnInit`` method that creates a frame and then calls
7396 ``self.SetTopWindow(frame)``.
7398 :see: `wx.PySimpleApp` for a simpler app class that can be used
7402 outputWindowClass
= PyOnDemandOutputWindow
7404 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7405 useBestVisual
=False, clearSigInt
=True):
7407 Construct a ``wx.App`` object.
7409 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7410 redirected? Defaults to True on Windows and Mac, False
7411 otherwise. If `filename` is None then output will be
7412 redirected to a window that pops up as needed. (You can
7413 control what kind of window is created for the output by
7414 resetting the class variable ``outputWindowClass`` to a
7415 class of your choosing.)
7417 :param filename: The name of a file to redirect output to, if
7420 :param useBestVisual: Should the app try to use the best
7421 available visual provided by the system (only relevant on
7422 systems that have more than one visual.) This parameter
7423 must be used instead of calling `SetUseBestVisual` later
7424 on because it must be set before the underlying GUI
7425 toolkit is initialized.
7427 :param clearSigInt: Should SIGINT be cleared? This allows the
7428 app to terminate upon a Ctrl-C in the console like other
7431 :note: You should override OnInit to do applicaition
7432 initialization to ensure that the system, toolkit and
7433 wxWidgets are fully initialized.
7436 wx
.PyApp
.__init
__(self
)
7438 # make sure we can create a GUI
7439 if not self
.IsDisplayAvailable():
7441 if wx
.Platform
== "__WXMAC__":
7442 msg
= """This program needs access to the screen.
7443 Please run with 'pythonw', not 'python', and only when you are logged
7444 in on the main display of your Mac."""
7446 elif wx
.Platform
== "__WXGTK__":
7447 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7450 msg
= "Unable to create GUI"
7451 # TODO: more description is needed for wxMSW...
7453 raise SystemExit(msg
)
7455 # This has to be done before OnInit
7456 self
.SetUseBestVisual(useBestVisual
)
7458 # Set the default handler for SIGINT. This fixes a problem
7459 # where if Ctrl-C is pressed in the console that started this
7460 # app then it will not appear to do anything, (not even send
7461 # KeyboardInterrupt???) but will later segfault on exit. By
7462 # setting the default handler then the app will exit, as
7463 # expected (depending on platform.)
7467 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7471 # Save and redirect the stdio to a window?
7472 self
.stdioWin
= None
7473 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7475 self
.RedirectStdio(filename
)
7477 # Use Python's install prefix as the default
7478 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7480 # This finishes the initialization of wxWindows and then calls
7481 # the OnInit that should be present in the derived class
7482 self
._BootstrapApp
()
7485 def OnPreInit(self
):
7487 Things that must be done after _BootstrapApp has done its
7488 thing, but would be nice if they were already done by the time
7489 that OnInit is called.
7491 wx
.StockGDI
._initStockObjects
()
7494 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7495 self
.RestoreStdio() # Just in case the MainLoop was overridden
7499 self
.this
.own(False)
7500 wx
.PyApp
.Destroy(self
)
7502 def SetTopWindow(self
, frame
):
7503 """Set the \"main\" top level window"""
7505 self
.stdioWin
.SetParent(frame
)
7506 wx
.PyApp
.SetTopWindow(self
, frame
)
7510 """Execute the main GUI event loop"""
7511 wx
.PyApp
.MainLoop(self
)
7515 def RedirectStdio(self
, filename
=None):
7516 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7518 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7520 self
.stdioWin
= self
.outputWindowClass()
7521 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7524 def RestoreStdio(self
):
7526 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7531 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7533 Set the title, position and/or size of the output window if
7534 the stdio has been redirected. This should be called before
7535 any output would cause the output window to be created.
7538 if title
is not None:
7539 self
.stdioWin
.title
= title
7541 self
.stdioWin
.pos
= pos
7542 if size
is not None:
7543 self
.stdioWin
.size
= size
7548 # change from wx.PyApp_XX to wx.App_XX
7549 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7550 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7551 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7552 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7553 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7554 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7555 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7556 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7557 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7558 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7559 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7561 #----------------------------------------------------------------------------
7563 class PySimpleApp(wx
.App
):
7565 A simple application class. You can just create one of these and
7566 then then make your top level windows later, and not have to worry
7567 about OnInit. For example::
7569 app = wx.PySimpleApp()
7570 frame = wx.Frame(None, title='Hello World')
7577 def __init__(self
, redirect
=False, filename
=None,
7578 useBestVisual
=False, clearSigInt
=True):
7580 :see: `wx.App.__init__`
7582 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7589 # Is anybody using this one?
7590 class PyWidgetTester(wx
.App
):
7591 def __init__(self
, size
= (250, 100)):
7593 wx
.App
.__init
__(self
, 0)
7596 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7597 self
.SetTopWindow(self
.frame
)
7600 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7601 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7602 self
.frame
.Show(True)
7604 #----------------------------------------------------------------------------
7605 # DO NOT hold any other references to this object. This is how we
7606 # know when to cleanup system resources that wxWidgets is holding. When
7607 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7608 # goes to zero and it calls the wx.App_CleanUp function.
7610 class __wxPyCleanup
:
7612 self
.cleanup
= _core_
.App_CleanUp
7616 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7618 ## # another possible solution, but it gets called too early...
7620 ## atexit.register(_core_.wxApp_CleanUp)
7623 #----------------------------------------------------------------------------
7625 #---------------------------------------------------------------------------
7627 class EventLoop(object):
7628 """Proxy of C++ EventLoop class"""
7629 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7630 __repr__
= _swig_repr
7631 def __init__(self
, *args
, **kwargs
):
7632 """__init__(self) -> EventLoop"""
7633 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7634 __swig_destroy__
= _core_
.delete_EventLoop
7635 __del__
= lambda self
: None;
7636 def Run(*args
, **kwargs
):
7637 """Run(self) -> int"""
7638 return _core_
.EventLoop_Run(*args
, **kwargs
)
7640 def Exit(*args
, **kwargs
):
7641 """Exit(self, int rc=0)"""
7642 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7644 def Pending(*args
, **kwargs
):
7645 """Pending(self) -> bool"""
7646 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7648 def Dispatch(*args
, **kwargs
):
7649 """Dispatch(self) -> bool"""
7650 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7652 def IsRunning(*args
, **kwargs
):
7653 """IsRunning(self) -> bool"""
7654 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7656 def GetActive(*args
, **kwargs
):
7657 """GetActive() -> EventLoop"""
7658 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7660 GetActive
= staticmethod(GetActive
)
7661 def SetActive(*args
, **kwargs
):
7662 """SetActive(EventLoop loop)"""
7663 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7665 SetActive
= staticmethod(SetActive
)
7666 _core_
.EventLoop_swigregister(EventLoop
)
7668 def EventLoop_GetActive(*args
):
7669 """EventLoop_GetActive() -> EventLoop"""
7670 return _core_
.EventLoop_GetActive(*args
)
7672 def EventLoop_SetActive(*args
, **kwargs
):
7673 """EventLoop_SetActive(EventLoop loop)"""
7674 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7676 class EventLoopActivator(object):
7677 """Proxy of C++ EventLoopActivator class"""
7678 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7679 __repr__
= _swig_repr
7680 def __init__(self
, *args
, **kwargs
):
7681 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7682 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7683 __swig_destroy__
= _core_
.delete_EventLoopActivator
7684 __del__
= lambda self
: None;
7685 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7687 #---------------------------------------------------------------------------
7689 ACCEL_ALT
= _core_
.ACCEL_ALT
7690 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7691 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7692 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7693 ACCEL_CMD
= _core_
.ACCEL_CMD
7694 class AcceleratorEntry(object):
7696 A class used to define items in an `wx.AcceleratorTable`. wxPython
7697 programs can choose to use wx.AcceleratorEntry objects, but using a
7698 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7699 as well. See `__init__` for of the tuple values.
7701 :see: `wx.AcceleratorTable`
7703 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7704 __repr__
= _swig_repr
7705 def __init__(self
, *args
, **kwargs
):
7707 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7709 Construct a wx.AcceleratorEntry.
7711 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7712 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7713 __del__
= lambda self
: None;
7714 def Set(*args
, **kwargs
):
7716 Set(self, int flags, int keyCode, int cmd)
7718 (Re)set the attributes of a wx.AcceleratorEntry.
7721 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7723 def Create(*args
, **kwargs
):
7725 Create(String str) -> AcceleratorEntry
7727 Create accelerator corresponding to the specified string, or None if
7728 it coulnd't be parsed.
7730 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7732 Create
= staticmethod(Create
)
7733 def GetFlags(*args
, **kwargs
):
7735 GetFlags(self) -> int
7737 Get the AcceleratorEntry's flags.
7739 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
7741 def GetKeyCode(*args
, **kwargs
):
7743 GetKeyCode(self) -> int
7745 Get the AcceleratorEntry's keycode.
7747 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
7749 def GetCommand(*args
, **kwargs
):
7751 GetCommand(self) -> int
7753 Get the AcceleratorEntry's command ID.
7755 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
7757 def IsOk(*args
, **kwargs
):
7758 """IsOk(self) -> bool"""
7759 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
7761 def ToString(*args
, **kwargs
):
7763 ToString(self) -> String
7765 Returns a string representation for the this accelerator. The string
7766 is formatted using the <flags>-<keycode> format where <flags> maybe a
7767 hyphen-separed list of "shift|alt|ctrl"
7770 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
7772 def FromString(*args
, **kwargs
):
7774 FromString(self, String str) -> bool
7776 Returns true if the given string correctly initialized this object.
7778 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
7780 Command
= property(GetCommand
,doc
="See `GetCommand`")
7781 Flags
= property(GetFlags
,doc
="See `GetFlags`")
7782 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
7783 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
7785 def AcceleratorEntry_Create(*args
, **kwargs
):
7787 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7789 Create accelerator corresponding to the specified string, or None if
7790 it coulnd't be parsed.
7792 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7794 class AcceleratorTable(Object
):
7796 An accelerator table allows the application to specify a table of
7797 keyboard shortcuts for menus or other commands. On Windows, menu or
7798 button commands are supported; on GTK, only menu commands are
7801 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7802 __repr__
= _swig_repr
7803 def __init__(self
, *args
, **kwargs
):
7805 __init__(entries) -> AcceleratorTable
7807 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7808 items or or of 3-tuples (flags, keyCode, cmdID)
7810 :see: `wx.AcceleratorEntry`
7812 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
7813 __swig_destroy__
= _core_
.delete_AcceleratorTable
7814 __del__
= lambda self
: None;
7815 def IsOk(*args
, **kwargs
):
7816 """IsOk(self) -> bool"""
7817 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
7820 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
7823 def GetAccelFromString(*args
, **kwargs
):
7824 """GetAccelFromString(String label) -> AcceleratorEntry"""
7825 return _core_
.GetAccelFromString(*args
, **kwargs
)
7826 #---------------------------------------------------------------------------
7828 class VisualAttributes(object):
7829 """struct containing all the visual attributes of a control"""
7830 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7831 __repr__
= _swig_repr
7832 def __init__(self
, *args
, **kwargs
):
7834 __init__(self) -> VisualAttributes
7836 struct containing all the visual attributes of a control
7838 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
7839 __swig_destroy__
= _core_
.delete_VisualAttributes
7840 __del__
= lambda self
: None;
7841 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
7842 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
7843 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
7844 _core_
.VisualAttributes_swigregister(VisualAttributes
)
7845 NullAcceleratorTable
= cvar
.NullAcceleratorTable
7846 PanelNameStr
= cvar
.PanelNameStr
7848 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
7849 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
7850 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
7851 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
7852 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
7853 class Window(EvtHandler
):
7855 wx.Window is the base class for all windows and represents any visible
7856 object on the screen. All controls, top level windows and so on are
7857 wx.Windows. Sizers and device contexts are not however, as they don't
7858 appear on screen themselves.
7861 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7862 __repr__
= _swig_repr
7863 def __init__(self
, *args
, **kwargs
):
7865 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7866 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7868 Construct and show a generic Window.
7870 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
7871 self
._setOORInfo
(self
)
7873 def Create(*args
, **kwargs
):
7875 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7876 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7878 Create the GUI part of the Window for 2-phase creation mode.
7880 return _core_
.Window_Create(*args
, **kwargs
)
7882 def Close(*args
, **kwargs
):
7884 Close(self, bool force=False) -> bool
7886 This function simply generates a EVT_CLOSE event whose handler usually
7887 tries to close the window. It doesn't close the window itself,
7888 however. If force is False (the default) then the window's close
7889 handler will be allowed to veto the destruction of the window.
7891 return _core_
.Window_Close(*args
, **kwargs
)
7893 def Destroy(*args
, **kwargs
):
7895 Destroy(self) -> bool
7897 Destroys the window safely. Frames and dialogs are not destroyed
7898 immediately when this function is called -- they are added to a list
7899 of windows to be deleted on idle time, when all the window's events
7900 have been processed. This prevents problems with events being sent to
7901 non-existent windows.
7903 Returns True if the window has either been successfully deleted, or it
7904 has been added to the list of windows pending real deletion.
7906 args
[0].this
.own(False)
7907 return _core_
.Window_Destroy(*args
, **kwargs
)
7909 def DestroyChildren(*args
, **kwargs
):
7911 DestroyChildren(self) -> bool
7913 Destroys all children of a window. Called automatically by the
7916 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
7918 def IsBeingDeleted(*args
, **kwargs
):
7920 IsBeingDeleted(self) -> bool
7922 Is the window in the process of being deleted?
7924 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
7926 def SetLabel(*args
, **kwargs
):
7928 SetLabel(self, String label)
7930 Set the text which the window shows in its label if applicable.
7932 return _core_
.Window_SetLabel(*args
, **kwargs
)
7934 def GetLabel(*args
, **kwargs
):
7936 GetLabel(self) -> String
7938 Generic way of getting a label from any window, for identification
7939 purposes. The interpretation of this function differs from class to
7940 class. For frames and dialogs, the value returned is the title. For
7941 buttons or static text controls, it is the button text. This function
7942 can be useful for meta-programs such as testing tools or special-needs
7943 access programs)which need to identify windows by name.
7945 return _core_
.Window_GetLabel(*args
, **kwargs
)
7947 def SetName(*args
, **kwargs
):
7949 SetName(self, String name)
7951 Sets the window's name. The window name is used for ressource setting
7952 in X, it is not the same as the window title/label
7954 return _core_
.Window_SetName(*args
, **kwargs
)
7956 def GetName(*args
, **kwargs
):
7958 GetName(self) -> String
7960 Returns the windows name. This name is not guaranteed to be unique;
7961 it is up to the programmer to supply an appropriate name in the window
7962 constructor or via wx.Window.SetName.
7964 return _core_
.Window_GetName(*args
, **kwargs
)
7966 def SetWindowVariant(*args
, **kwargs
):
7968 SetWindowVariant(self, int variant)
7970 Sets the variant of the window/font size to use for this window, if
7971 the platform supports variants, for example, wxMac.
7973 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
7975 def GetWindowVariant(*args
, **kwargs
):
7976 """GetWindowVariant(self) -> int"""
7977 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
7979 def SetId(*args
, **kwargs
):
7981 SetId(self, int winid)
7983 Sets the identifier of the window. Each window has an integer
7984 identifier. If the application has not provided one, an identifier
7985 will be generated. Normally, the identifier should be provided on
7986 creation and should not be modified subsequently.
7988 return _core_
.Window_SetId(*args
, **kwargs
)
7990 def GetId(*args
, **kwargs
):
7994 Returns the identifier of the window. Each window has an integer
7995 identifier. If the application has not provided one (or the default Id
7996 -1 is used) then an unique identifier with a negative value will be
7999 return _core_
.Window_GetId(*args
, **kwargs
)
8001 def NewControlId(*args
, **kwargs
):
8003 NewControlId() -> int
8005 Generate a control id for the controls which were not given one.
8007 return _core_
.Window_NewControlId(*args
, **kwargs
)
8009 NewControlId
= staticmethod(NewControlId
)
8010 def NextControlId(*args
, **kwargs
):
8012 NextControlId(int winid) -> int
8014 Get the id of the control following the one with the given
8017 return _core_
.Window_NextControlId(*args
, **kwargs
)
8019 NextControlId
= staticmethod(NextControlId
)
8020 def PrevControlId(*args
, **kwargs
):
8022 PrevControlId(int winid) -> int
8024 Get the id of the control preceding the one with the given
8027 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8029 PrevControlId
= staticmethod(PrevControlId
)
8030 def GetLayoutDirection(*args
, **kwargs
):
8032 GetLayoutDirection(self) -> int
8034 Get the layout direction (LTR or RTL) for this window. Returns
8035 ``wx.Layout_Default`` if layout direction is not supported.
8037 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8039 def SetLayoutDirection(*args
, **kwargs
):
8041 SetLayoutDirection(self, int dir)
8043 Set the layout direction (LTR or RTL) for this window.
8045 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8047 def AdjustForLayoutDirection(*args
, **kwargs
):
8049 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8051 Mirror coordinates for RTL layout if this window uses it and if the
8052 mirroring is not done automatically like Win32.
8054 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8056 def SetSize(*args
, **kwargs
):
8058 SetSize(self, Size size)
8060 Sets the size of the window in pixels.
8062 return _core_
.Window_SetSize(*args
, **kwargs
)
8064 def SetDimensions(*args
, **kwargs
):
8066 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8068 Sets the position and size of the window in pixels. The sizeFlags
8069 parameter indicates the interpretation of the other params if they are
8072 ======================== ======================================
8073 wx.SIZE_AUTO A -1 indicates that a class-specific
8074 default should be used.
8075 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8076 -1 values are supplied.
8077 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8078 interpreted as real dimensions, not
8080 ======================== ======================================
8083 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8085 def SetRect(*args
, **kwargs
):
8087 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8089 Sets the position and size of the window in pixels using a wx.Rect.
8091 return _core_
.Window_SetRect(*args
, **kwargs
)
8093 def SetSizeWH(*args
, **kwargs
):
8095 SetSizeWH(self, int width, int height)
8097 Sets the size of the window in pixels.
8099 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8101 def Move(*args
, **kwargs
):
8103 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8105 Moves the window to the given position.
8107 return _core_
.Window_Move(*args
, **kwargs
)
8110 def MoveXY(*args
, **kwargs
):
8112 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8114 Moves the window to the given position.
8116 return _core_
.Window_MoveXY(*args
, **kwargs
)
8118 def SetBestFittingSize(*args
, **kwargs
):
8120 SetBestFittingSize(self, Size size=DefaultSize)
8122 A 'Smart' SetSize that will fill in default size components with the
8123 window's *best size* values. Also set's the minsize for use with sizers.
8125 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
8127 def Raise(*args
, **kwargs
):
8131 Raises the window to the top of the window hierarchy. In current
8132 version of wxWidgets this works both for manage and child windows.
8134 return _core_
.Window_Raise(*args
, **kwargs
)
8136 def Lower(*args
, **kwargs
):
8140 Lowers the window to the bottom of the window hierarchy. In current
8141 version of wxWidgets this works both for manage and child windows.
8143 return _core_
.Window_Lower(*args
, **kwargs
)
8145 def SetClientSize(*args
, **kwargs
):
8147 SetClientSize(self, Size size)
8149 This sets the size of the window client area in pixels. Using this
8150 function to size a window tends to be more device-independent than
8151 wx.Window.SetSize, since the application need not worry about what
8152 dimensions the border or title bar have when trying to fit the window
8153 around panel items, for example.
8155 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8157 def SetClientSizeWH(*args
, **kwargs
):
8159 SetClientSizeWH(self, int width, int height)
8161 This sets the size of the window client area in pixels. Using this
8162 function to size a window tends to be more device-independent than
8163 wx.Window.SetSize, since the application need not worry about what
8164 dimensions the border or title bar have when trying to fit the window
8165 around panel items, for example.
8167 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8169 def SetClientRect(*args
, **kwargs
):
8171 SetClientRect(self, Rect rect)
8173 This sets the size of the window client area in pixels. Using this
8174 function to size a window tends to be more device-independent than
8175 wx.Window.SetSize, since the application need not worry about what
8176 dimensions the border or title bar have when trying to fit the window
8177 around panel items, for example.
8179 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8181 def GetPosition(*args
, **kwargs
):
8183 GetPosition(self) -> Point
8185 Get the window's position. Notice that the position is in client
8186 coordinates for child windows and screen coordinates for the top level
8187 ones, use `GetScreenPosition` if you need screen coordinates for all
8190 return _core_
.Window_GetPosition(*args
, **kwargs
)
8192 def GetPositionTuple(*args
, **kwargs
):
8194 GetPositionTuple() -> (x,y)
8196 Get the window's position. Notice that the position is in client
8197 coordinates for child windows and screen coordinates for the top level
8198 ones, use `GetScreenPosition` if you need screen coordinates for all
8201 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8203 def GetScreenPosition(*args
, **kwargs
):
8205 GetScreenPosition(self) -> Point
8207 Get the position of the window in screen coordinantes.
8209 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8211 def GetScreenPositionTuple(*args
, **kwargs
):
8213 GetScreenPositionTuple() -> (x,y)
8215 Get the position of the window in screen coordinantes.
8217 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8219 def GetScreenRect(*args
, **kwargs
):
8221 GetScreenRect(self) -> Rect
8223 Returns the size and position of the window in screen coordinantes as
8226 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8228 def GetSize(*args
, **kwargs
):
8230 GetSize(self) -> Size
8232 Get the window size.
8234 return _core_
.Window_GetSize(*args
, **kwargs
)
8236 def GetSizeTuple(*args
, **kwargs
):
8238 GetSizeTuple() -> (width, height)
8240 Get the window size.
8242 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8244 def GetRect(*args
, **kwargs
):
8246 GetRect(self) -> Rect
8248 Returns the size and position of the window as a `wx.Rect` object.
8250 return _core_
.Window_GetRect(*args
, **kwargs
)
8252 def GetClientSize(*args
, **kwargs
):
8254 GetClientSize(self) -> Size
8256 This gets the size of the window's 'client area' in pixels. The client
8257 area is the area which may be drawn on by the programmer, excluding
8258 title bar, border, scrollbars, etc.
8260 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8262 def GetClientSizeTuple(*args
, **kwargs
):
8264 GetClientSizeTuple() -> (width, height)
8266 This gets the size of the window's 'client area' in pixels. The client
8267 area is the area which may be drawn on by the programmer, excluding
8268 title bar, border, scrollbars, etc.
8270 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8272 def GetClientAreaOrigin(*args
, **kwargs
):
8274 GetClientAreaOrigin(self) -> Point
8276 Get the origin of the client area of the window relative to the
8277 window's top left corner (the client area may be shifted because of
8278 the borders, scrollbars, other decorations...)
8280 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8282 def GetClientRect(*args
, **kwargs
):
8284 GetClientRect(self) -> Rect
8286 Get the client area position and size as a `wx.Rect` object.
8288 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8290 def GetBestSize(*args
, **kwargs
):
8292 GetBestSize(self) -> Size
8294 This function returns the best acceptable minimal size for the
8295 window, if applicable. For example, for a static text control, it will
8296 be the minimal size such that the control label is not truncated. For
8297 windows containing subwindows (suzh aswx.Panel), the size returned by
8298 this function will be the same as the size the window would have had
8301 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8303 def GetBestSizeTuple(*args
, **kwargs
):
8305 GetBestSizeTuple() -> (width, height)
8307 This function returns the best acceptable minimal size for the
8308 window, if applicable. For example, for a static text control, it will
8309 be the minimal size such that the control label is not truncated. For
8310 windows containing subwindows (suzh aswx.Panel), the size returned by
8311 this function will be the same as the size the window would have had
8314 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8316 def InvalidateBestSize(*args
, **kwargs
):
8318 InvalidateBestSize(self)
8320 Reset the cached best size value so it will be recalculated the next
8323 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8325 def CacheBestSize(*args
, **kwargs
):
8327 CacheBestSize(self, Size size)
8329 Cache the best size so it doesn't need to be calculated again, (at least until
8330 some properties of the window change.)
8332 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8334 def GetBestFittingSize(*args
, **kwargs
):
8336 GetBestFittingSize(self) -> Size
8338 This function will merge the window's best size into the window's
8339 minimum size, giving priority to the min size components, and returns
8343 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
8345 def GetAdjustedBestSize(*args
, **kwargs
):
8347 GetAdjustedBestSize(self) -> Size
8349 This method is similar to GetBestSize, except in one
8350 thing. GetBestSize should return the minimum untruncated size of the
8351 window, while this method will return the largest of BestSize and any
8352 user specified minimum size. ie. it is the minimum size the window
8353 should currently be drawn at, not the minimal size it can possibly
8356 return _core_
.Window_GetAdjustedBestSize(*args
, **kwargs
)
8358 def Center(*args
, **kwargs
):
8360 Center(self, int direction=BOTH)
8362 Centers the window. The parameter specifies the direction for
8363 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8364 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8365 on the entire screen and not on its parent window. If it is a
8366 top-level window and has no parent then it will always be centered
8367 relative to the screen.
8369 return _core_
.Window_Center(*args
, **kwargs
)
8372 def CenterOnParent(*args
, **kwargs
):
8374 CenterOnParent(self, int dir=BOTH)
8376 Center with respect to the the parent window
8378 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8380 CentreOnParent
= CenterOnParent
8381 def Fit(*args
, **kwargs
):
8385 Sizes the window so that it fits around its subwindows. This function
8386 won't do anything if there are no subwindows and will only really work
8387 correctly if sizers are used for the subwindows layout. Also, if the
8388 window has exactly one subwindow it is better (faster and the result
8389 is more precise as Fit adds some margin to account for fuzziness of
8390 its calculations) to call window.SetClientSize(child.GetSize())
8391 instead of calling Fit.
8393 return _core_
.Window_Fit(*args
, **kwargs
)
8395 def FitInside(*args
, **kwargs
):
8399 Similar to Fit, but sizes the interior (virtual) size of a
8400 window. Mainly useful with scrolled windows to reset scrollbars after
8401 sizing changes that do not trigger a size event, and/or scrolled
8402 windows without an interior sizer. This function similarly won't do
8403 anything if there are no subwindows.
8405 return _core_
.Window_FitInside(*args
, **kwargs
)
8407 def SetSizeHints(*args
, **kwargs
):
8409 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8412 Allows specification of minimum and maximum window sizes, and window
8413 size increments. If a pair of values is not set (or set to -1), the
8414 default values will be used. If this function is called, the user
8415 will not be able to size the window outside the given bounds (if it is
8416 a top-level window.) Sizers will also inspect the minimum window size
8417 and will use that value if set when calculating layout.
8419 The resizing increments are only significant under Motif or Xt.
8421 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8423 def SetSizeHintsSz(*args
, **kwargs
):
8425 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8427 Allows specification of minimum and maximum window sizes, and window
8428 size increments. If a pair of values is not set (or set to -1), the
8429 default values will be used. If this function is called, the user
8430 will not be able to size the window outside the given bounds (if it is
8431 a top-level window.) Sizers will also inspect the minimum window size
8432 and will use that value if set when calculating layout.
8434 The resizing increments are only significant under Motif or Xt.
8436 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8438 def SetVirtualSizeHints(*args
, **kwargs
):
8440 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8442 Allows specification of minimum and maximum virtual window sizes. If a
8443 pair of values is not set (or set to -1), the default values will be
8444 used. If this function is called, the user will not be able to size
8445 the virtual area of the window outside the given bounds.
8447 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8449 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8451 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8453 Allows specification of minimum and maximum virtual window sizes. If a
8454 pair of values is not set (or set to -1), the default values will be
8455 used. If this function is called, the user will not be able to size
8456 the virtual area of the window outside the given bounds.
8458 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8460 def GetMaxSize(*args
, **kwargs
):
8461 """GetMaxSize(self) -> Size"""
8462 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8464 def GetMinSize(*args
, **kwargs
):
8465 """GetMinSize(self) -> Size"""
8466 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8468 def SetMinSize(*args
, **kwargs
):
8470 SetMinSize(self, Size minSize)
8472 A more convenient method than `SetSizeHints` for setting just the
8475 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8477 def SetMaxSize(*args
, **kwargs
):
8479 SetMaxSize(self, Size maxSize)
8481 A more convenient method than `SetSizeHints` for setting just the
8484 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8486 def GetMinWidth(*args
, **kwargs
):
8487 """GetMinWidth(self) -> int"""
8488 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8490 def GetMinHeight(*args
, **kwargs
):
8491 """GetMinHeight(self) -> int"""
8492 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8494 def GetMaxWidth(*args
, **kwargs
):
8495 """GetMaxWidth(self) -> int"""
8496 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8498 def GetMaxHeight(*args
, **kwargs
):
8499 """GetMaxHeight(self) -> int"""
8500 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8502 def SetVirtualSize(*args
, **kwargs
):
8504 SetVirtualSize(self, Size size)
8506 Set the the virtual size of a window in pixels. For most windows this
8507 is just the client area of the window, but for some like scrolled
8508 windows it is more or less independent of the screen window size.
8510 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8512 def SetVirtualSizeWH(*args
, **kwargs
):
8514 SetVirtualSizeWH(self, int w, int h)
8516 Set the the virtual size of a window in pixels. For most windows this
8517 is just the client area of the window, but for some like scrolled
8518 windows it is more or less independent of the screen window size.
8520 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8522 def GetVirtualSize(*args
, **kwargs
):
8524 GetVirtualSize(self) -> Size
8526 Get the the virtual size of the window in pixels. For most windows
8527 this is just the client area of the window, but for some like scrolled
8528 windows it is more or less independent of the screen window size.
8530 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8532 def GetVirtualSizeTuple(*args
, **kwargs
):
8534 GetVirtualSizeTuple() -> (width, height)
8536 Get the the virtual size of the window in pixels. For most windows
8537 this is just the client area of the window, but for some like scrolled
8538 windows it is more or less independent of the screen window size.
8540 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8542 def GetBestVirtualSize(*args
, **kwargs
):
8544 GetBestVirtualSize(self) -> Size
8546 Return the largest of ClientSize and BestSize (as determined by a
8547 sizer, interior children, or other means)
8549 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8551 def Show(*args
, **kwargs
):
8553 Show(self, bool show=True) -> bool
8555 Shows or hides the window. You may need to call Raise for a top level
8556 window if you want to bring it to top, although this is not needed if
8557 Show is called immediately after the frame creation. Returns True if
8558 the window has been shown or hidden or False if nothing was done
8559 because it already was in the requested state.
8561 return _core_
.Window_Show(*args
, **kwargs
)
8563 def Hide(*args
, **kwargs
):
8567 Equivalent to calling Show(False).
8569 return _core_
.Window_Hide(*args
, **kwargs
)
8571 def Enable(*args
, **kwargs
):
8573 Enable(self, bool enable=True) -> bool
8575 Enable or disable the window for user input. Note that when a parent
8576 window is disabled, all of its children are disabled as well and they
8577 are reenabled again when the parent is. Returns true if the window
8578 has been enabled or disabled, false if nothing was done, i.e. if the
8579 window had already been in the specified state.
8581 return _core_
.Window_Enable(*args
, **kwargs
)
8583 def Disable(*args
, **kwargs
):
8585 Disable(self) -> bool
8587 Disables the window, same as Enable(false).
8589 return _core_
.Window_Disable(*args
, **kwargs
)
8591 def IsShown(*args
, **kwargs
):
8593 IsShown(self) -> bool
8595 Returns true if the window is shown, false if it has been hidden.
8597 return _core_
.Window_IsShown(*args
, **kwargs
)
8599 def IsEnabled(*args
, **kwargs
):
8601 IsEnabled(self) -> bool
8603 Returns true if the window is enabled for input, false otherwise.
8605 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8607 def IsShownOnScreen(*args
, **kwargs
):
8609 IsShownOnScreen(self) -> bool
8611 Returns ``True`` if the window is physically visible on the screen,
8612 i.e. it is shown and all its parents up to the toplevel window are
8615 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8617 def SetWindowStyleFlag(*args
, **kwargs
):
8619 SetWindowStyleFlag(self, long style)
8621 Sets the style of the window. Please note that some styles cannot be
8622 changed after the window creation and that Refresh() might need to be
8623 called after changing the others for the change to take place
8626 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8628 def GetWindowStyleFlag(*args
, **kwargs
):
8630 GetWindowStyleFlag(self) -> long
8632 Gets the window style that was passed to the constructor or Create
8635 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8637 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8638 def HasFlag(*args
, **kwargs
):
8640 HasFlag(self, int flag) -> bool
8642 Test if the given style is set for this window.
8644 return _core_
.Window_HasFlag(*args
, **kwargs
)
8646 def IsRetained(*args
, **kwargs
):
8648 IsRetained(self) -> bool
8650 Returns true if the window is retained, false otherwise. Retained
8651 windows are only available on X platforms.
8653 return _core_
.Window_IsRetained(*args
, **kwargs
)
8655 def SetExtraStyle(*args
, **kwargs
):
8657 SetExtraStyle(self, long exStyle)
8659 Sets the extra style bits for the window. Extra styles are the less
8660 often used style bits which can't be set with the constructor or with
8661 SetWindowStyleFlag()
8663 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8665 def GetExtraStyle(*args
, **kwargs
):
8667 GetExtraStyle(self) -> long
8669 Returns the extra style bits for the window.
8671 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8673 def MakeModal(*args
, **kwargs
):
8675 MakeModal(self, bool modal=True)
8677 Disables all other windows in the application so that the user can
8678 only interact with this window. Passing False will reverse this
8681 return _core_
.Window_MakeModal(*args
, **kwargs
)
8683 def SetThemeEnabled(*args
, **kwargs
):
8685 SetThemeEnabled(self, bool enableTheme)
8687 This function tells a window if it should use the system's "theme"
8688 code to draw the windows' background instead if its own background
8689 drawing code. This will only have an effect on platforms that support
8690 the notion of themes in user defined windows. One such platform is
8691 GTK+ where windows can have (very colourful) backgrounds defined by a
8692 user's selected theme.
8694 Dialogs, notebook pages and the status bar have this flag set to true
8695 by default so that the default look and feel is simulated best.
8697 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8699 def GetThemeEnabled(*args
, **kwargs
):
8701 GetThemeEnabled(self) -> bool
8703 Return the themeEnabled flag.
8705 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8707 def SetFocus(*args
, **kwargs
):
8711 Set's the focus to this window, allowing it to receive keyboard input.
8713 return _core_
.Window_SetFocus(*args
, **kwargs
)
8715 def SetFocusFromKbd(*args
, **kwargs
):
8717 SetFocusFromKbd(self)
8719 Set focus to this window as the result of a keyboard action. Normally
8720 only called internally.
8722 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8724 def FindFocus(*args
, **kwargs
):
8726 FindFocus() -> Window
8728 Returns the window or control that currently has the keyboard focus,
8731 return _core_
.Window_FindFocus(*args
, **kwargs
)
8733 FindFocus
= staticmethod(FindFocus
)
8734 def AcceptsFocus(*args
, **kwargs
):
8736 AcceptsFocus(self) -> bool
8738 Can this window have focus?
8740 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8742 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
8744 AcceptsFocusFromKeyboard(self) -> bool
8746 Can this window be given focus by keyboard navigation? if not, the
8747 only way to give it focus (provided it accepts it at all) is to click
8750 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
8752 def Navigate(*args
, **kwargs
):
8754 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8756 Does keyboard navigation from this window to another, by sending a
8757 `wx.NavigationKeyEvent`.
8759 return _core_
.Window_Navigate(*args
, **kwargs
)
8761 def MoveAfterInTabOrder(*args
, **kwargs
):
8763 MoveAfterInTabOrder(self, Window win)
8765 Moves this window in the tab navigation order after the specified
8766 sibling window. This means that when the user presses the TAB key on
8767 that other window, the focus switches to this window.
8769 The default tab order is the same as creation order. This function
8770 and `MoveBeforeInTabOrder` allow to change it after creating all the
8774 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
8776 def MoveBeforeInTabOrder(*args
, **kwargs
):
8778 MoveBeforeInTabOrder(self, Window win)
8780 Same as `MoveAfterInTabOrder` except that it inserts this window just
8781 before win instead of putting it right after it.
8783 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
8785 def GetChildren(*args
, **kwargs
):
8787 GetChildren(self) -> PyObject
8789 Returns a list of the window's children. NOTE: Currently this is a
8790 copy of the child window list maintained by the window, so the return
8791 value of this function is only valid as long as the window's children
8794 return _core_
.Window_GetChildren(*args
, **kwargs
)
8796 def GetParent(*args
, **kwargs
):
8798 GetParent(self) -> Window
8800 Returns the parent window of this window, or None if there isn't one.
8802 return _core_
.Window_GetParent(*args
, **kwargs
)
8804 def GetGrandParent(*args
, **kwargs
):
8806 GetGrandParent(self) -> Window
8808 Returns the parent of the parent of this window, or None if there
8811 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
8813 def IsTopLevel(*args
, **kwargs
):
8815 IsTopLevel(self) -> bool
8817 Returns true if the given window is a top-level one. Currently all
8818 frames and dialogs are always considered to be top-level windows (even
8819 if they have a parent window).
8821 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
8823 def Reparent(*args
, **kwargs
):
8825 Reparent(self, Window newParent) -> bool
8827 Reparents the window, i.e the window will be removed from its current
8828 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8829 re-inserted into another. Available on Windows and GTK. Returns True
8830 if the parent was changed, False otherwise (error or newParent ==
8833 return _core_
.Window_Reparent(*args
, **kwargs
)
8835 def AddChild(*args
, **kwargs
):
8837 AddChild(self, Window child)
8839 Adds a child window. This is called automatically by window creation
8840 functions so should not be required by the application programmer.
8842 return _core_
.Window_AddChild(*args
, **kwargs
)
8844 def RemoveChild(*args
, **kwargs
):
8846 RemoveChild(self, Window child)
8848 Removes a child window. This is called automatically by window
8849 deletion functions so should not be required by the application
8852 return _core_
.Window_RemoveChild(*args
, **kwargs
)
8854 def SetDoubleBuffered(*args
, **kwargs
):
8856 SetDoubleBuffered(self, bool on)
8858 Currently wxGTK2 only.
8860 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
8862 def FindWindowById(*args
, **kwargs
):
8864 FindWindowById(self, long winid) -> Window
8866 Find a chld of this window by window ID
8868 return _core_
.Window_FindWindowById(*args
, **kwargs
)
8870 def FindWindowByName(*args
, **kwargs
):
8872 FindWindowByName(self, String name) -> Window
8874 Find a child of this window by name
8876 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
8878 def GetEventHandler(*args
, **kwargs
):
8880 GetEventHandler(self) -> EvtHandler
8882 Returns the event handler for this window. By default, the window is
8883 its own event handler.
8885 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
8887 def SetEventHandler(*args
, **kwargs
):
8889 SetEventHandler(self, EvtHandler handler)
8891 Sets the event handler for this window. An event handler is an object
8892 that is capable of processing the events sent to a window. (In other
8893 words, is able to dispatch the events to handler function.) By
8894 default, the window is its own event handler, but an application may
8895 wish to substitute another, for example to allow central
8896 implementation of event-handling for a variety of different window
8899 It is usually better to use `wx.Window.PushEventHandler` since this sets
8900 up a chain of event handlers, where an event not handled by one event
8901 handler is handed off to the next one in the chain.
8903 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
8905 def PushEventHandler(*args
, **kwargs
):
8907 PushEventHandler(self, EvtHandler handler)
8909 Pushes this event handler onto the event handler stack for the window.
8910 An event handler is an object that is capable of processing the events
8911 sent to a window. (In other words, is able to dispatch the events to
8912 handler function.) By default, the window is its own event handler,
8913 but an application may wish to substitute another, for example to
8914 allow central implementation of event-handling for a variety of
8915 different window classes.
8917 wx.Window.PushEventHandler allows an application to set up a chain of
8918 event handlers, where an event not handled by one event handler is
8919 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
8920 to remove the event handler. Ownership of the handler is *not* given
8921 to the window, so you should be sure to pop the handler before the
8922 window is destroyed and either let PopEventHandler destroy it, or call
8923 its Destroy method yourself.
8925 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
8927 def PopEventHandler(*args
, **kwargs
):
8929 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8931 Removes and returns the top-most event handler on the event handler
8932 stack. If deleteHandler is True then the wx.EvtHandler object will be
8933 destroyed after it is popped, and ``None`` will be returned instead.
8935 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
8937 def RemoveEventHandler(*args
, **kwargs
):
8939 RemoveEventHandler(self, EvtHandler handler) -> bool
8941 Find the given handler in the event handler chain and remove (but not
8942 delete) it from the event handler chain, returns True if it was found
8943 and False otherwise (this also results in an assert failure so this
8944 function should only be called when the handler is supposed to be
8947 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
8949 def SetValidator(*args
, **kwargs
):
8951 SetValidator(self, Validator validator)
8953 Deletes the current validator (if any) and sets the window validator,
8954 having called wx.Validator.Clone to create a new validator of this
8957 return _core_
.Window_SetValidator(*args
, **kwargs
)
8959 def GetValidator(*args
, **kwargs
):
8961 GetValidator(self) -> Validator
8963 Returns a pointer to the current validator for the window, or None if
8966 return _core_
.Window_GetValidator(*args
, **kwargs
)
8968 def Validate(*args
, **kwargs
):
8970 Validate(self) -> bool
8972 Validates the current values of the child controls using their
8973 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8974 style flag set, the method will also call Validate() of all child
8975 windows. Returns false if any of the validations failed.
8977 return _core_
.Window_Validate(*args
, **kwargs
)
8979 def TransferDataToWindow(*args
, **kwargs
):
8981 TransferDataToWindow(self) -> bool
8983 Transfers values to child controls from data areas specified by their
8984 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8985 style flag set, the method will also call TransferDataToWindow() of
8988 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
8990 def TransferDataFromWindow(*args
, **kwargs
):
8992 TransferDataFromWindow(self) -> bool
8994 Transfers values from child controls to data areas specified by their
8995 validators. Returns false if a transfer failed. If the window has
8996 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8997 also call TransferDataFromWindow() of all child windows.
8999 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9001 def InitDialog(*args
, **kwargs
):
9005 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9006 to the dialog via validators.
9008 return _core_
.Window_InitDialog(*args
, **kwargs
)
9010 def SetAcceleratorTable(*args
, **kwargs
):
9012 SetAcceleratorTable(self, AcceleratorTable accel)
9014 Sets the accelerator table for this window.
9016 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9018 def GetAcceleratorTable(*args
, **kwargs
):
9020 GetAcceleratorTable(self) -> AcceleratorTable
9022 Gets the accelerator table for this window.
9024 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9026 def RegisterHotKey(*args
, **kwargs
):
9028 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9030 Registers a system wide hotkey. Every time the user presses the hotkey
9031 registered here, this window will receive a hotkey event. It will
9032 receive the event even if the application is in the background and
9033 does not have the input focus because the user is working with some
9034 other application. To bind an event handler function to this hotkey
9035 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9036 hotkey was registered successfully.
9038 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9040 def UnregisterHotKey(*args
, **kwargs
):
9042 UnregisterHotKey(self, int hotkeyId) -> bool
9044 Unregisters a system wide hotkey.
9046 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9048 def ConvertDialogPointToPixels(*args
, **kwargs
):
9050 ConvertDialogPointToPixels(self, Point pt) -> Point
9052 Converts a point or size from dialog units to pixels. Dialog units
9053 are used for maintaining a dialog's proportions even if the font
9054 changes. For the x dimension, the dialog units are multiplied by the
9055 average character width and then divided by 4. For the y dimension,
9056 the dialog units are multiplied by the average character height and
9059 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9061 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9063 ConvertDialogSizeToPixels(self, Size sz) -> Size
9065 Converts a point or size from dialog units to pixels. Dialog units
9066 are used for maintaining a dialog's proportions even if the font
9067 changes. For the x dimension, the dialog units are multiplied by the
9068 average character width and then divided by 4. For the y dimension,
9069 the dialog units are multiplied by the average character height and
9072 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9074 def DLG_PNT(*args
, **kwargs
):
9076 DLG_PNT(self, Point pt) -> Point
9078 Converts a point or size from dialog units to pixels. Dialog units
9079 are used for maintaining a dialog's proportions even if the font
9080 changes. For the x dimension, the dialog units are multiplied by the
9081 average character width and then divided by 4. For the y dimension,
9082 the dialog units are multiplied by the average character height and
9085 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9087 def DLG_SZE(*args
, **kwargs
):
9089 DLG_SZE(self, Size sz) -> Size
9091 Converts a point or size from dialog units to pixels. Dialog units
9092 are used for maintaining a dialog's proportions even if the font
9093 changes. For the x dimension, the dialog units are multiplied by the
9094 average character width and then divided by 4. For the y dimension,
9095 the dialog units are multiplied by the average character height and
9098 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9100 def ConvertPixelPointToDialog(*args
, **kwargs
):
9101 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9102 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9104 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9105 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9106 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9108 def WarpPointer(*args
, **kwargs
):
9110 WarpPointer(self, int x, int y)
9112 Moves the pointer to the given position on the window.
9114 NOTE: This function is not supported under Mac because Apple Human
9115 Interface Guidelines forbid moving the mouse cursor programmatically.
9117 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9119 def CaptureMouse(*args
, **kwargs
):
9123 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9124 release the capture.
9126 Note that wxWindows maintains the stack of windows having captured the
9127 mouse and when the mouse is released the capture returns to the window
9128 which had had captured it previously and it is only really released if
9129 there were no previous window. In particular, this means that you must
9130 release the mouse as many times as you capture it, unless the window
9131 receives the `wx.MouseCaptureLostEvent` event.
9133 Any application which captures the mouse in the beginning of some
9134 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9135 operation when it receives the event. The event handler must not
9138 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9140 def ReleaseMouse(*args
, **kwargs
):
9144 Releases mouse input captured with wx.Window.CaptureMouse.
9146 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9148 def GetCapture(*args
, **kwargs
):
9150 GetCapture() -> Window
9152 Returns the window which currently captures the mouse or None
9154 return _core_
.Window_GetCapture(*args
, **kwargs
)
9156 GetCapture
= staticmethod(GetCapture
)
9157 def HasCapture(*args
, **kwargs
):
9159 HasCapture(self) -> bool
9161 Returns true if this window has the current mouse capture.
9163 return _core_
.Window_HasCapture(*args
, **kwargs
)
9165 def Refresh(*args
, **kwargs
):
9167 Refresh(self, bool eraseBackground=True, Rect rect=None)
9169 Mark the specified rectangle (or the whole window) as "dirty" so it
9170 will be repainted. Causes an EVT_PAINT event to be generated and sent
9173 return _core_
.Window_Refresh(*args
, **kwargs
)
9175 def RefreshRect(*args
, **kwargs
):
9177 RefreshRect(self, Rect rect, bool eraseBackground=True)
9179 Redraws the contents of the given rectangle: the area inside it will
9180 be repainted. This is the same as Refresh but has a nicer syntax.
9182 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9184 def Update(*args
, **kwargs
):
9188 Calling this method immediately repaints the invalidated area of the
9189 window instead of waiting for the EVT_PAINT event to happen, (normally
9190 this would usually only happen when the flow of control returns to the
9191 event loop.) Notice that this function doesn't refresh the window and
9192 does nothing if the window has been already repainted. Use Refresh
9193 first if you want to immediately redraw the window (or some portion of
9194 it) unconditionally.
9196 return _core_
.Window_Update(*args
, **kwargs
)
9198 def ClearBackground(*args
, **kwargs
):
9200 ClearBackground(self)
9202 Clears the window by filling it with the current background
9203 colour. Does not cause an erase background event to be generated.
9205 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9207 def Freeze(*args
, **kwargs
):
9211 Freezes the window or, in other words, prevents any updates from
9212 taking place on screen, the window is not redrawn at all. Thaw must be
9213 called to reenable window redrawing. Calls to Freeze/Thaw may be
9214 nested, with the actual Thaw being delayed until all the nesting has
9217 This method is useful for visual appearance optimization (for example,
9218 it is a good idea to use it before inserting large amount of text into
9219 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9220 for all controls so it is mostly just a hint to wxWindows and not a
9221 mandatory directive.
9223 return _core_
.Window_Freeze(*args
, **kwargs
)
9225 def IsFrozen(*args
, **kwargs
):
9227 IsFrozen(self) -> bool
9229 Returns ``True`` if the window has been frozen and not thawed yet.
9231 :see: `Freeze` and `Thaw`
9233 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9235 def Thaw(*args
, **kwargs
):
9239 Reenables window updating after a previous call to Freeze. Calls to
9240 Freeze/Thaw may be nested, so Thaw must be called the same number of
9241 times that Freeze was before the window will be updated.
9243 return _core_
.Window_Thaw(*args
, **kwargs
)
9245 def PrepareDC(*args
, **kwargs
):
9247 PrepareDC(self, DC dc)
9249 Call this function to prepare the device context for drawing a
9250 scrolled image. It sets the device origin according to the current
9253 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9255 def IsDoubleBuffered(*args
, **kwargs
):
9257 IsDoubleBuffered(self) -> bool
9259 Returns ``True`` if the window contents is double-buffered by the
9260 system, i.e. if any drawing done on the window is really done on a
9261 temporary backing surface and transferred to the screen all at once
9264 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9266 def GetUpdateRegion(*args
, **kwargs
):
9268 GetUpdateRegion(self) -> Region
9270 Returns the region specifying which parts of the window have been
9271 damaged. Should only be called within an EVT_PAINT handler.
9273 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9275 def GetUpdateClientRect(*args
, **kwargs
):
9277 GetUpdateClientRect(self) -> Rect
9279 Get the update rectangle region bounding box in client coords.
9281 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9283 def IsExposed(*args
, **kwargs
):
9285 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9287 Returns true if the given point or rectangle area has been exposed
9288 since the last repaint. Call this in an paint event handler to
9289 optimize redrawing by only redrawing those areas, which have been
9292 return _core_
.Window_IsExposed(*args
, **kwargs
)
9294 def IsExposedPoint(*args
, **kwargs
):
9296 IsExposedPoint(self, Point pt) -> bool
9298 Returns true if the given point or rectangle area has been exposed
9299 since the last repaint. Call this in an paint event handler to
9300 optimize redrawing by only redrawing those areas, which have been
9303 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9305 def IsExposedRect(*args
, **kwargs
):
9307 IsExposedRect(self, Rect rect) -> bool
9309 Returns true if the given point or rectangle area has been exposed
9310 since the last repaint. Call this in an paint event handler to
9311 optimize redrawing by only redrawing those areas, which have been
9314 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9316 def GetDefaultAttributes(*args
, **kwargs
):
9318 GetDefaultAttributes(self) -> VisualAttributes
9320 Get the default attributes for an instance of this class. This is
9321 useful if you want to use the same font or colour in your own control
9322 as in a standard control -- which is a much better idea than hard
9323 coding specific colours or fonts which might look completely out of
9324 place on the user's system, especially if it uses themes.
9326 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9328 def GetClassDefaultAttributes(*args
, **kwargs
):
9330 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9332 Get the default attributes for this class. This is useful if you want
9333 to use the same font or colour in your own control as in a standard
9334 control -- which is a much better idea than hard coding specific
9335 colours or fonts which might look completely out of place on the
9336 user's system, especially if it uses themes.
9338 The variant parameter is only relevant under Mac currently and is
9339 ignore under other platforms. Under Mac, it will change the size of
9340 the returned font. See `wx.Window.SetWindowVariant` for more about
9343 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9345 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9346 def SetBackgroundColour(*args
, **kwargs
):
9348 SetBackgroundColour(self, Colour colour) -> bool
9350 Sets the background colour of the window. Returns True if the colour
9351 was changed. The background colour is usually painted by the default
9352 EVT_ERASE_BACKGROUND event handler function under Windows and
9353 automatically under GTK. Using `wx.NullColour` will reset the window
9354 to the default background colour.
9356 Note that setting the background colour may not cause an immediate
9357 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9358 calling this function.
9360 Using this function will disable attempts to use themes for this
9361 window, if the system supports them. Use with care since usually the
9362 themes represent the appearance chosen by the user to be used for all
9363 applications on the system.
9365 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9367 def SetOwnBackgroundColour(*args
, **kwargs
):
9368 """SetOwnBackgroundColour(self, Colour colour)"""
9369 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9371 def SetForegroundColour(*args
, **kwargs
):
9373 SetForegroundColour(self, Colour colour) -> bool
9375 Sets the foreground colour of the window. Returns True is the colour
9376 was changed. The interpretation of foreground colour is dependent on
9377 the window class; it may be the text colour or other colour, or it may
9380 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9382 def SetOwnForegroundColour(*args
, **kwargs
):
9383 """SetOwnForegroundColour(self, Colour colour)"""
9384 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9386 def GetBackgroundColour(*args
, **kwargs
):
9388 GetBackgroundColour(self) -> Colour
9390 Returns the background colour of the window.
9392 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9394 def GetForegroundColour(*args
, **kwargs
):
9396 GetForegroundColour(self) -> Colour
9398 Returns the foreground colour of the window. The interpretation of
9399 foreground colour is dependent on the window class; it may be the text
9400 colour or other colour, or it may not be used at all.
9402 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9404 def InheritsBackgroundColour(*args
, **kwargs
):
9405 """InheritsBackgroundColour(self) -> bool"""
9406 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9408 def UseBgCol(*args
, **kwargs
):
9409 """UseBgCol(self) -> bool"""
9410 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9412 def SetBackgroundStyle(*args
, **kwargs
):
9414 SetBackgroundStyle(self, int style) -> bool
9416 Returns the background style of the window. The background style
9417 indicates how the background of the window is drawn.
9419 ====================== ========================================
9420 wx.BG_STYLE_SYSTEM The background colour or pattern should
9421 be determined by the system
9422 wx.BG_STYLE_COLOUR The background should be a solid colour
9423 wx.BG_STYLE_CUSTOM The background will be implemented by the
9425 ====================== ========================================
9427 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9428 a custom background, such as a tiled bitmap. Currently the style has
9429 no effect on other platforms.
9431 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9433 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9435 def GetBackgroundStyle(*args
, **kwargs
):
9437 GetBackgroundStyle(self) -> int
9439 Returns the background style of the window.
9441 :see: `SetBackgroundStyle`
9443 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9445 def HasTransparentBackground(*args
, **kwargs
):
9447 HasTransparentBackground(self) -> bool
9449 Returns True if this window's background is transparent (as, for
9450 example, for `wx.StaticText`) and should show the parent window's
9453 This method is mostly used internally by the library itself and you
9454 normally shouldn't have to call it. You may, however, have to override
9455 it in your custom control classes to ensure that background is painted
9458 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9460 def SetCursor(*args
, **kwargs
):
9462 SetCursor(self, Cursor cursor) -> bool
9464 Sets the window's cursor. Notice that the window cursor also sets it
9465 for the children of the window implicitly.
9467 The cursor may be wx.NullCursor in which case the window cursor will
9468 be reset back to default.
9470 return _core_
.Window_SetCursor(*args
, **kwargs
)
9472 def GetCursor(*args
, **kwargs
):
9474 GetCursor(self) -> Cursor
9476 Return the cursor associated with this window.
9478 return _core_
.Window_GetCursor(*args
, **kwargs
)
9480 def SetFont(*args
, **kwargs
):
9482 SetFont(self, Font font) -> bool
9484 Sets the font for this window.
9486 return _core_
.Window_SetFont(*args
, **kwargs
)
9488 def SetOwnFont(*args
, **kwargs
):
9489 """SetOwnFont(self, Font font)"""
9490 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9492 def GetFont(*args
, **kwargs
):
9494 GetFont(self) -> Font
9496 Returns the default font used for this window.
9498 return _core_
.Window_GetFont(*args
, **kwargs
)
9500 def SetCaret(*args
, **kwargs
):
9502 SetCaret(self, Caret caret)
9504 Sets the caret associated with the window.
9506 return _core_
.Window_SetCaret(*args
, **kwargs
)
9508 def GetCaret(*args
, **kwargs
):
9510 GetCaret(self) -> Caret
9512 Returns the caret associated with the window.
9514 return _core_
.Window_GetCaret(*args
, **kwargs
)
9516 def GetCharHeight(*args
, **kwargs
):
9518 GetCharHeight(self) -> int
9520 Get the (average) character size for the current font.
9522 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9524 def GetCharWidth(*args
, **kwargs
):
9526 GetCharWidth(self) -> int
9528 Get the (average) character size for the current font.
9530 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9532 def GetTextExtent(*args
, **kwargs
):
9534 GetTextExtent(String string) -> (width, height)
9536 Get the width and height of the text using the current font.
9538 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9540 def GetFullTextExtent(*args
, **kwargs
):
9542 GetFullTextExtent(String string, Font font=None) ->
9543 (width, height, descent, externalLeading)
9545 Get the width, height, decent and leading of the text using the
9546 current or specified font.
9548 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9550 def ClientToScreenXY(*args
, **kwargs
):
9552 ClientToScreenXY(int x, int y) -> (x,y)
9554 Converts to screen coordinates from coordinates relative to this window.
9556 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9558 def ScreenToClientXY(*args
, **kwargs
):
9560 ScreenToClientXY(int x, int y) -> (x,y)
9562 Converts from screen to client window coordinates.
9564 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9566 def ClientToScreen(*args
, **kwargs
):
9568 ClientToScreen(self, Point pt) -> Point
9570 Converts to screen coordinates from coordinates relative to this window.
9572 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9574 def ScreenToClient(*args
, **kwargs
):
9576 ScreenToClient(self, Point pt) -> Point
9578 Converts from screen to client window coordinates.
9580 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9582 def HitTestXY(*args
, **kwargs
):
9584 HitTestXY(self, int x, int y) -> int
9586 Test where the given (in client coords) point lies
9588 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9590 def HitTest(*args
, **kwargs
):
9592 HitTest(self, Point pt) -> int
9594 Test where the given (in client coords) point lies
9596 return _core_
.Window_HitTest(*args
, **kwargs
)
9598 def GetBorder(*args
):
9600 GetBorder(self, long flags) -> int
9601 GetBorder(self) -> int
9603 Get border for the flags of this window
9605 return _core_
.Window_GetBorder(*args
)
9607 def UpdateWindowUI(*args
, **kwargs
):
9609 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9611 This function sends EVT_UPDATE_UI events to the window. The particular
9612 implementation depends on the window; for example a wx.ToolBar will
9613 send an update UI event for each toolbar button, and a wx.Frame will
9614 send an update UI event for each menubar menu item. You can call this
9615 function from your application to ensure that your UI is up-to-date at
9616 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9617 concerned). This may be necessary if you have called
9618 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9619 limit the overhead that wxWindows incurs by sending update UI events
9622 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9624 def PopupMenuXY(*args
, **kwargs
):
9626 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9628 Pops up the given menu at the specified coordinates, relative to this window,
9629 and returns control when the user has dismissed the menu. If a menu item is
9630 selected, the corresponding menu event is generated and will be processed as
9631 usual. If the default position is given then the current position of the
9632 mouse cursor will be used.
9634 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9636 def PopupMenu(*args
, **kwargs
):
9638 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9640 Pops up the given menu at the specified coordinates, relative to this window,
9641 and returns control when the user has dismissed the menu. If a menu item is
9642 selected, the corresponding menu event is generated and will be processed as
9643 usual. If the default position is given then the current position of the
9644 mouse cursor will be used.
9646 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9648 def HasMultiplePages(*args
, **kwargs
):
9649 """HasMultiplePages(self) -> bool"""
9650 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9652 def GetHandle(*args
, **kwargs
):
9654 GetHandle(self) -> long
9656 Returns the platform-specific handle (as a long integer) of the
9657 physical window. Currently on wxMac it returns the handle of the
9658 toplevel parent of the window.
9660 return _core_
.Window_GetHandle(*args
, **kwargs
)
9662 def AssociateHandle(*args
, **kwargs
):
9664 AssociateHandle(self, long handle)
9666 Associate the window with a new native handle
9668 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9670 def DissociateHandle(*args
, **kwargs
):
9672 DissociateHandle(self)
9674 Dissociate the current native handle from the window
9676 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9678 def OnPaint(*args
, **kwargs
):
9679 """OnPaint(self, PaintEvent event)"""
9680 return _core_
.Window_OnPaint(*args
, **kwargs
)
9682 def HasScrollbar(*args
, **kwargs
):
9684 HasScrollbar(self, int orient) -> bool
9686 Does the window have the scrollbar for this orientation?
9688 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9690 def SetScrollbar(*args
, **kwargs
):
9692 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9695 Sets the scrollbar properties of a built-in scrollbar.
9697 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9699 def SetScrollPos(*args
, **kwargs
):
9701 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9703 Sets the position of one of the built-in scrollbars.
9705 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9707 def GetScrollPos(*args
, **kwargs
):
9709 GetScrollPos(self, int orientation) -> int
9711 Returns the built-in scrollbar position.
9713 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9715 def GetScrollThumb(*args
, **kwargs
):
9717 GetScrollThumb(self, int orientation) -> int
9719 Returns the built-in scrollbar thumb size.
9721 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9723 def GetScrollRange(*args
, **kwargs
):
9725 GetScrollRange(self, int orientation) -> int
9727 Returns the built-in scrollbar range.
9729 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9731 def ScrollWindow(*args
, **kwargs
):
9733 ScrollWindow(self, int dx, int dy, Rect rect=None)
9735 Physically scrolls the pixels in the window and move child windows
9736 accordingly. Use this function to optimise your scrolling
9737 implementations, to minimise the area that must be redrawn. Note that
9738 it is rarely required to call this function from a user program.
9740 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9742 def ScrollLines(*args
, **kwargs
):
9744 ScrollLines(self, int lines) -> bool
9746 If the platform and window class supports it, scrolls the window by
9747 the given number of lines down, if lines is positive, or up if lines
9748 is negative. Returns True if the window was scrolled, False if it was
9749 already on top/bottom and nothing was done.
9751 return _core_
.Window_ScrollLines(*args
, **kwargs
)
9753 def ScrollPages(*args
, **kwargs
):
9755 ScrollPages(self, int pages) -> bool
9757 If the platform and window class supports it, scrolls the window by
9758 the given number of pages down, if pages is positive, or up if pages
9759 is negative. Returns True if the window was scrolled, False if it was
9760 already on top/bottom and nothing was done.
9762 return _core_
.Window_ScrollPages(*args
, **kwargs
)
9764 def LineUp(*args
, **kwargs
):
9766 LineUp(self) -> bool
9768 This is just a wrapper for ScrollLines(-1).
9770 return _core_
.Window_LineUp(*args
, **kwargs
)
9772 def LineDown(*args
, **kwargs
):
9774 LineDown(self) -> bool
9776 This is just a wrapper for ScrollLines(1).
9778 return _core_
.Window_LineDown(*args
, **kwargs
)
9780 def PageUp(*args
, **kwargs
):
9782 PageUp(self) -> bool
9784 This is just a wrapper for ScrollPages(-1).
9786 return _core_
.Window_PageUp(*args
, **kwargs
)
9788 def PageDown(*args
, **kwargs
):
9790 PageDown(self) -> bool
9792 This is just a wrapper for ScrollPages(1).
9794 return _core_
.Window_PageDown(*args
, **kwargs
)
9796 def SetHelpText(*args
, **kwargs
):
9798 SetHelpText(self, String text)
9800 Sets the help text to be used as context-sensitive help for this
9801 window. Note that the text is actually stored by the current
9802 `wx.HelpProvider` implementation, and not in the window object itself.
9804 return _core_
.Window_SetHelpText(*args
, **kwargs
)
9806 def SetHelpTextForId(*args
, **kwargs
):
9808 SetHelpTextForId(self, String text)
9810 Associate this help text with all windows with the same id as this
9813 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
9815 def GetHelpTextAtPoint(*args
, **kwargs
):
9817 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9819 Get the help string associated with the given position in this window.
9821 Notice that pt may be invalid if event origin is keyboard or unknown
9822 and this method should return the global window help text then
9825 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
9827 def GetHelpText(*args
, **kwargs
):
9829 GetHelpText(self) -> String
9831 Gets the help text to be used as context-sensitive help for this
9832 window. Note that the text is actually stored by the current
9833 `wx.HelpProvider` implementation, and not in the window object itself.
9835 return _core_
.Window_GetHelpText(*args
, **kwargs
)
9837 def SetToolTipString(*args
, **kwargs
):
9839 SetToolTipString(self, String tip)
9841 Attach a tooltip to the window.
9843 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
9845 def SetToolTip(*args
, **kwargs
):
9847 SetToolTip(self, ToolTip tip)
9849 Attach a tooltip to the window.
9851 return _core_
.Window_SetToolTip(*args
, **kwargs
)
9853 def GetToolTip(*args
, **kwargs
):
9855 GetToolTip(self) -> ToolTip
9857 get the associated tooltip or None if none
9859 return _core_
.Window_GetToolTip(*args
, **kwargs
)
9861 def SetDropTarget(*args
, **kwargs
):
9863 SetDropTarget(self, DropTarget dropTarget)
9865 Associates a drop target with this window. If the window already has
9866 a drop target, it is deleted.
9868 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
9870 def GetDropTarget(*args
, **kwargs
):
9872 GetDropTarget(self) -> DropTarget
9874 Returns the associated drop target, which may be None.
9876 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
9878 def DragAcceptFiles(*args
, **kwargs
):
9880 DragAcceptFiles(self, bool accept)
9882 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9883 Only functional on Windows.
9885 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
9887 def SetConstraints(*args
, **kwargs
):
9889 SetConstraints(self, LayoutConstraints constraints)
9891 Sets the window to have the given layout constraints. If an existing
9892 layout constraints object is already owned by the window, it will be
9893 deleted. Pass None to disassociate and delete the window's current
9896 You must call SetAutoLayout to tell a window to use the constraints
9897 automatically in its default EVT_SIZE handler; otherwise, you must
9898 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9899 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9902 return _core_
.Window_SetConstraints(*args
, **kwargs
)
9904 def GetConstraints(*args
, **kwargs
):
9906 GetConstraints(self) -> LayoutConstraints
9908 Returns a pointer to the window's layout constraints, or None if there
9911 return _core_
.Window_GetConstraints(*args
, **kwargs
)
9913 def SetAutoLayout(*args
, **kwargs
):
9915 SetAutoLayout(self, bool autoLayout)
9917 Determines whether the Layout function will be called automatically
9918 when the window is resized. lease note that this only happens for the
9919 windows usually used to contain children, namely `wx.Panel` and
9920 `wx.TopLevelWindow` (and the classes deriving from them).
9922 This method is called implicitly by `SetSizer` but if you use
9923 `SetConstraints` you should call it manually or otherwise the window
9924 layout won't be correctly updated when its size changes.
9926 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
9928 def GetAutoLayout(*args
, **kwargs
):
9930 GetAutoLayout(self) -> bool
9932 Returns the current autoLayout setting
9934 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
9936 def Layout(*args
, **kwargs
):
9938 Layout(self) -> bool
9940 Invokes the constraint-based layout algorithm or the sizer-based
9941 algorithm for this window. See SetAutoLayout: when auto layout is on,
9942 this function gets called automatically by the default EVT_SIZE
9943 handler when the window is resized.
9945 return _core_
.Window_Layout(*args
, **kwargs
)
9947 def SetSizer(*args
, **kwargs
):
9949 SetSizer(self, Sizer sizer, bool deleteOld=True)
9951 Sets the window to have the given layout sizer. The window will then
9952 own the object, and will take care of its deletion. If an existing
9953 layout sizer object is already owned by the window, it will be deleted
9954 if the deleteOld parameter is true. Note that this function will also
9955 call SetAutoLayout implicitly with a True parameter if the sizer is
9956 non-None, and False otherwise.
9958 return _core_
.Window_SetSizer(*args
, **kwargs
)
9960 def SetSizerAndFit(*args
, **kwargs
):
9962 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9964 The same as SetSizer, except it also sets the size hints for the
9965 window based on the sizer's minimum size.
9967 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
9969 def GetSizer(*args
, **kwargs
):
9971 GetSizer(self) -> Sizer
9973 Return the sizer associated with the window by a previous call to
9974 SetSizer or None if there isn't one.
9976 return _core_
.Window_GetSizer(*args
, **kwargs
)
9978 def SetContainingSizer(*args
, **kwargs
):
9980 SetContainingSizer(self, Sizer sizer)
9982 This normally does not need to be called by application code. It is
9983 called internally when a window is added to a sizer, and is used so
9984 the window can remove itself from the sizer when it is destroyed.
9986 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
9988 def GetContainingSizer(*args
, **kwargs
):
9990 GetContainingSizer(self) -> Sizer
9992 Return the sizer that this window is a member of, if any, otherwise None.
9994 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
9996 def InheritAttributes(*args
, **kwargs
):
9998 InheritAttributes(self)
10000 This function is (or should be, in case of custom controls) called
10001 during window creation to intelligently set up the window visual
10002 attributes, that is the font and the foreground and background
10005 By 'intelligently' the following is meant: by default, all windows use
10006 their own default attributes. However if some of the parent's
10007 attributes are explicitly changed (that is, using SetFont and not
10008 SetOwnFont) and if the corresponding attribute hadn't been
10009 explicitly set for this window itself, then this window takes the same
10010 value as used by the parent. In addition, if the window overrides
10011 ShouldInheritColours to return false, the colours will not be changed
10012 no matter what and only the font might.
10014 This rather complicated logic is necessary in order to accommodate the
10015 different usage scenarios. The most common one is when all default
10016 attributes are used and in this case, nothing should be inherited as
10017 in modern GUIs different controls use different fonts (and colours)
10018 than their siblings so they can't inherit the same value from the
10019 parent. However it was also deemed desirable to allow to simply change
10020 the attributes of all children at once by just changing the font or
10021 colour of their common parent, hence in this case we do inherit the
10022 parents attributes.
10025 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10027 def ShouldInheritColours(*args
, **kwargs
):
10029 ShouldInheritColours(self) -> bool
10031 Return true from here to allow the colours of this window to be
10032 changed by InheritAttributes, returning false forbids inheriting them
10033 from the parent window.
10035 The base class version returns false, but this method is overridden in
10036 wxControl where it returns true.
10038 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10040 def CanSetTransparent(*args
, **kwargs
):
10042 CanSetTransparent(self) -> bool
10044 Returns ``True`` if the platform supports setting the transparency for
10045 this window. Note that this method will err on the side of caution,
10046 so it is possible that this will return ``False`` when it is in fact
10047 possible to set the transparency.
10049 NOTE: On X-windows systems the X server must have the composite
10050 extension loaded, and there must be a composite manager program (such
10051 as xcompmgr) running.
10053 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10055 def SetTransparent(*args
, **kwargs
):
10057 SetTransparent(self, byte alpha) -> bool
10059 Attempt to set the transparency of this window to the ``alpha`` value,
10060 returns True on success. The ``alpha`` value is an integer in the
10061 range of 0 to 255, where 0 is fully transparent and 255 is fully
10064 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10066 def PostCreate(self
, pre
):
10068 Phase 3 of the 2-phase create <wink!>
10069 Call this method after precreating the window with the 2-phase create method.
10071 self
.this
= pre
.this
10072 self
.thisown
= pre
.thisown
10074 if hasattr(self
, '_setOORInfo'):
10075 self
._setOORInfo
(self
)
10076 if hasattr(self
, '_setCallbackInfo'):
10077 self
._setCallbackInfo
(self
, self
.__class
__)
10079 def SendSizeEvent(self
):
10080 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10082 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10083 AdjustedBestSize
= property(GetAdjustedBestSize
,doc
="See `GetAdjustedBestSize`")
10084 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10085 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10086 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10087 BestFittingSize
= property(GetBestFittingSize
,SetBestFittingSize
,doc
="See `GetBestFittingSize` and `SetBestFittingSize`")
10088 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10089 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10090 Border
= property(GetBorder
,doc
="See `GetBorder`")
10091 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10092 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10093 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10094 Children
= property(GetChildren
,doc
="See `GetChildren`")
10095 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10096 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10097 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10098 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10099 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10100 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10101 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10102 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10103 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10104 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10105 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10106 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10107 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10108 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10109 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10110 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10111 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10112 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10113 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10114 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10115 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10116 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10117 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10118 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10119 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10120 Parent
= property(GetParent
,doc
="See `GetParent`")
10121 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10122 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10123 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10124 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10125 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10126 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10127 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10128 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10129 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10130 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10131 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10132 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10133 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10134 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10135 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10136 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10137 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10138 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10139 _core_
.Window_swigregister(Window
)
10141 def PreWindow(*args
, **kwargs
):
10143 PreWindow() -> Window
10145 Precreate a Window for 2-phase creation.
10147 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10150 def Window_NewControlId(*args
):
10152 Window_NewControlId() -> int
10154 Generate a control id for the controls which were not given one.
10156 return _core_
.Window_NewControlId(*args
)
10158 def Window_NextControlId(*args
, **kwargs
):
10160 Window_NextControlId(int winid) -> int
10162 Get the id of the control following the one with the given
10165 return _core_
.Window_NextControlId(*args
, **kwargs
)
10167 def Window_PrevControlId(*args
, **kwargs
):
10169 Window_PrevControlId(int winid) -> int
10171 Get the id of the control preceding the one with the given
10174 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10176 def Window_FindFocus(*args
):
10178 Window_FindFocus() -> Window
10180 Returns the window or control that currently has the keyboard focus,
10183 return _core_
.Window_FindFocus(*args
)
10185 def Window_GetCapture(*args
):
10187 Window_GetCapture() -> Window
10189 Returns the window which currently captures the mouse or None
10191 return _core_
.Window_GetCapture(*args
)
10193 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10195 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10197 Get the default attributes for this class. This is useful if you want
10198 to use the same font or colour in your own control as in a standard
10199 control -- which is a much better idea than hard coding specific
10200 colours or fonts which might look completely out of place on the
10201 user's system, especially if it uses themes.
10203 The variant parameter is only relevant under Mac currently and is
10204 ignore under other platforms. Under Mac, it will change the size of
10205 the returned font. See `wx.Window.SetWindowVariant` for more about
10208 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10210 def DLG_PNT(win
, point_or_x
, y
=None):
10212 Convenience function for converting a Point or (x,y) in
10213 dialog units to pixel units.
10216 return win
.ConvertDialogPointToPixels(point_or_x
)
10218 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10220 def DLG_SZE(win
, size_width
, height
=None):
10222 Convenience function for converting a Size or (w,h) in
10223 dialog units to pixel units.
10226 return win
.ConvertDialogSizeToPixels(size_width
)
10228 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10231 def FindWindowById(*args
, **kwargs
):
10233 FindWindowById(long id, Window parent=None) -> Window
10235 Find the first window in the application with the given id. If parent
10236 is None, the search will start from all top-level frames and dialog
10237 boxes; if non-None, the search will be limited to the given window
10238 hierarchy. The search is recursive in both cases.
10240 return _core_
.FindWindowById(*args
, **kwargs
)
10242 def FindWindowByName(*args
, **kwargs
):
10244 FindWindowByName(String name, Window parent=None) -> Window
10246 Find a window by its name (as given in a window constructor or Create
10247 function call). If parent is None, the search will start from all
10248 top-level frames and dialog boxes; if non-None, the search will be
10249 limited to the given window hierarchy. The search is recursive in both
10252 If no window with such name is found, wx.FindWindowByLabel is called.
10254 return _core_
.FindWindowByName(*args
, **kwargs
)
10256 def FindWindowByLabel(*args
, **kwargs
):
10258 FindWindowByLabel(String label, Window parent=None) -> Window
10260 Find a window by its label. Depending on the type of window, the label
10261 may be a window title or panel item label. If parent is None, the
10262 search will start from all top-level frames and dialog boxes; if
10263 non-None, the search will be limited to the given window
10264 hierarchy. The search is recursive in both cases.
10266 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10268 def Window_FromHWND(*args
, **kwargs
):
10269 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10270 return _core_
.Window_FromHWND(*args
, **kwargs
)
10272 def GetTopLevelWindows(*args
):
10274 GetTopLevelWindows() -> PyObject
10276 Returns a list of the the application's top-level windows, (frames,
10277 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10278 by wxWidgets, and so it is only valid as long as no top-level windows
10279 are closed or new top-level windows are created.
10282 return _core_
.GetTopLevelWindows(*args
)
10283 #---------------------------------------------------------------------------
10285 class Validator(EvtHandler
):
10286 """Proxy of C++ Validator class"""
10287 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10288 __repr__
= _swig_repr
10289 def __init__(self
, *args
, **kwargs
):
10290 """__init__(self) -> Validator"""
10291 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10292 self
._setOORInfo
(self
)
10294 def Clone(*args
, **kwargs
):
10295 """Clone(self) -> Validator"""
10296 return _core_
.Validator_Clone(*args
, **kwargs
)
10298 def Validate(*args
, **kwargs
):
10299 """Validate(self, Window parent) -> bool"""
10300 return _core_
.Validator_Validate(*args
, **kwargs
)
10302 def TransferToWindow(*args
, **kwargs
):
10303 """TransferToWindow(self) -> bool"""
10304 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10306 def TransferFromWindow(*args
, **kwargs
):
10307 """TransferFromWindow(self) -> bool"""
10308 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10310 def GetWindow(*args
, **kwargs
):
10311 """GetWindow(self) -> Window"""
10312 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10314 def SetWindow(*args
, **kwargs
):
10315 """SetWindow(self, Window window)"""
10316 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10318 def IsSilent(*args
, **kwargs
):
10319 """IsSilent() -> bool"""
10320 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10322 IsSilent
= staticmethod(IsSilent
)
10323 def SetBellOnError(*args
, **kwargs
):
10324 """SetBellOnError(int doIt=True)"""
10325 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10327 SetBellOnError
= staticmethod(SetBellOnError
)
10328 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10329 _core_
.Validator_swigregister(Validator
)
10331 def Validator_IsSilent(*args
):
10332 """Validator_IsSilent() -> bool"""
10333 return _core_
.Validator_IsSilent(*args
)
10335 def Validator_SetBellOnError(*args
, **kwargs
):
10336 """Validator_SetBellOnError(int doIt=True)"""
10337 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10339 class PyValidator(Validator
):
10340 """Proxy of C++ PyValidator class"""
10341 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10342 __repr__
= _swig_repr
10343 def __init__(self
, *args
, **kwargs
):
10344 """__init__(self) -> PyValidator"""
10345 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10347 self
._setCallbackInfo
(self
, PyValidator
, 1)
10348 self
._setOORInfo
(self
)
10350 def _setCallbackInfo(*args
, **kwargs
):
10351 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10352 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10354 _core_
.PyValidator_swigregister(PyValidator
)
10356 #---------------------------------------------------------------------------
10358 class Menu(EvtHandler
):
10359 """Proxy of C++ Menu class"""
10360 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10361 __repr__
= _swig_repr
10362 def __init__(self
, *args
, **kwargs
):
10363 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10364 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10365 self
._setOORInfo
(self
)
10367 def Append(*args
, **kwargs
):
10369 Append(self, int id, String text=EmptyString, String help=EmptyString,
10370 int kind=ITEM_NORMAL) -> MenuItem
10372 return _core_
.Menu_Append(*args
, **kwargs
)
10374 def AppendSeparator(*args
, **kwargs
):
10375 """AppendSeparator(self) -> MenuItem"""
10376 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10378 def AppendCheckItem(*args
, **kwargs
):
10379 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10380 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10382 def AppendRadioItem(*args
, **kwargs
):
10383 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10384 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10386 def AppendMenu(*args
, **kwargs
):
10387 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10388 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10390 def AppendSubMenu(*args
, **kwargs
):
10391 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10392 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10394 def AppendItem(*args
, **kwargs
):
10395 """AppendItem(self, MenuItem item) -> MenuItem"""
10396 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10398 def InsertItem(*args
, **kwargs
):
10399 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10400 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10402 def PrependItem(*args
, **kwargs
):
10403 """PrependItem(self, MenuItem item) -> MenuItem"""
10404 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10406 def Break(*args
, **kwargs
):
10408 return _core_
.Menu_Break(*args
, **kwargs
)
10410 def Insert(*args
, **kwargs
):
10412 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10413 int kind=ITEM_NORMAL) -> MenuItem
10415 return _core_
.Menu_Insert(*args
, **kwargs
)
10417 def InsertSeparator(*args
, **kwargs
):
10418 """InsertSeparator(self, size_t pos) -> MenuItem"""
10419 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10421 def InsertCheckItem(*args
, **kwargs
):
10422 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10423 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10425 def InsertRadioItem(*args
, **kwargs
):
10426 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10427 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10429 def InsertMenu(*args
, **kwargs
):
10430 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10431 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10433 def Prepend(*args
, **kwargs
):
10435 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10436 int kind=ITEM_NORMAL) -> MenuItem
10438 return _core_
.Menu_Prepend(*args
, **kwargs
)
10440 def PrependSeparator(*args
, **kwargs
):
10441 """PrependSeparator(self) -> MenuItem"""
10442 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10444 def PrependCheckItem(*args
, **kwargs
):
10445 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10446 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10448 def PrependRadioItem(*args
, **kwargs
):
10449 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10450 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10452 def PrependMenu(*args
, **kwargs
):
10453 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10454 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10456 def Remove(*args
, **kwargs
):
10457 """Remove(self, int id) -> MenuItem"""
10458 return _core_
.Menu_Remove(*args
, **kwargs
)
10460 def RemoveItem(*args
, **kwargs
):
10461 """RemoveItem(self, MenuItem item) -> MenuItem"""
10462 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10464 def Delete(*args
, **kwargs
):
10465 """Delete(self, int id) -> bool"""
10466 return _core_
.Menu_Delete(*args
, **kwargs
)
10468 def DeleteItem(*args
, **kwargs
):
10469 """DeleteItem(self, MenuItem item) -> bool"""
10470 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10472 def Destroy(*args
, **kwargs
):
10476 Deletes the C++ object this Python object is a proxy for.
10478 args
[0].this
.own(False)
10479 return _core_
.Menu_Destroy(*args
, **kwargs
)
10481 def DestroyId(*args
, **kwargs
):
10482 """DestroyId(self, int id) -> bool"""
10483 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10485 def DestroyItem(*args
, **kwargs
):
10486 """DestroyItem(self, MenuItem item) -> bool"""
10487 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10489 def GetMenuItemCount(*args
, **kwargs
):
10490 """GetMenuItemCount(self) -> size_t"""
10491 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10493 def GetMenuItems(*args
, **kwargs
):
10494 """GetMenuItems(self) -> PyObject"""
10495 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10497 def FindItem(*args
, **kwargs
):
10498 """FindItem(self, String item) -> int"""
10499 return _core_
.Menu_FindItem(*args
, **kwargs
)
10501 def FindItemById(*args
, **kwargs
):
10502 """FindItemById(self, int id) -> MenuItem"""
10503 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10505 def FindItemByPosition(*args
, **kwargs
):
10506 """FindItemByPosition(self, size_t position) -> MenuItem"""
10507 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10509 def Enable(*args
, **kwargs
):
10510 """Enable(self, int id, bool enable)"""
10511 return _core_
.Menu_Enable(*args
, **kwargs
)
10513 def IsEnabled(*args
, **kwargs
):
10514 """IsEnabled(self, int id) -> bool"""
10515 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10517 def Check(*args
, **kwargs
):
10518 """Check(self, int id, bool check)"""
10519 return _core_
.Menu_Check(*args
, **kwargs
)
10521 def IsChecked(*args
, **kwargs
):
10522 """IsChecked(self, int id) -> bool"""
10523 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10525 def SetLabel(*args
, **kwargs
):
10526 """SetLabel(self, int id, String label)"""
10527 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10529 def GetLabel(*args
, **kwargs
):
10530 """GetLabel(self, int id) -> String"""
10531 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10533 def SetHelpString(*args
, **kwargs
):
10534 """SetHelpString(self, int id, String helpString)"""
10535 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10537 def GetHelpString(*args
, **kwargs
):
10538 """GetHelpString(self, int id) -> String"""
10539 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10541 def SetTitle(*args
, **kwargs
):
10542 """SetTitle(self, String title)"""
10543 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10545 def GetTitle(*args
, **kwargs
):
10546 """GetTitle(self) -> String"""
10547 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10549 def SetEventHandler(*args
, **kwargs
):
10550 """SetEventHandler(self, EvtHandler handler)"""
10551 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10553 def GetEventHandler(*args
, **kwargs
):
10554 """GetEventHandler(self) -> EvtHandler"""
10555 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10557 def SetInvokingWindow(*args
, **kwargs
):
10558 """SetInvokingWindow(self, Window win)"""
10559 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10561 def GetInvokingWindow(*args
, **kwargs
):
10562 """GetInvokingWindow(self) -> Window"""
10563 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10565 def GetStyle(*args
, **kwargs
):
10566 """GetStyle(self) -> long"""
10567 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10569 def UpdateUI(*args
, **kwargs
):
10570 """UpdateUI(self, EvtHandler source=None)"""
10571 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10573 def GetMenuBar(*args
, **kwargs
):
10574 """GetMenuBar(self) -> MenuBar"""
10575 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10577 def Attach(*args
, **kwargs
):
10578 """Attach(self, wxMenuBarBase menubar)"""
10579 return _core_
.Menu_Attach(*args
, **kwargs
)
10581 def Detach(*args
, **kwargs
):
10583 return _core_
.Menu_Detach(*args
, **kwargs
)
10585 def IsAttached(*args
, **kwargs
):
10586 """IsAttached(self) -> bool"""
10587 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10589 def SetParent(*args
, **kwargs
):
10590 """SetParent(self, Menu parent)"""
10591 return _core_
.Menu_SetParent(*args
, **kwargs
)
10593 def GetParent(*args
, **kwargs
):
10594 """GetParent(self) -> Menu"""
10595 return _core_
.Menu_GetParent(*args
, **kwargs
)
10597 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10598 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10599 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10600 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10601 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10602 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10603 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10604 Style
= property(GetStyle
,doc
="See `GetStyle`")
10605 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10606 _core_
.Menu_swigregister(Menu
)
10607 DefaultValidator
= cvar
.DefaultValidator
10609 #---------------------------------------------------------------------------
10611 class MenuBar(Window
):
10612 """Proxy of C++ MenuBar class"""
10613 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10614 __repr__
= _swig_repr
10615 def __init__(self
, *args
, **kwargs
):
10616 """__init__(self, long style=0) -> MenuBar"""
10617 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10618 self
._setOORInfo
(self
)
10620 def Append(*args
, **kwargs
):
10621 """Append(self, Menu menu, String title) -> bool"""
10622 return _core_
.MenuBar_Append(*args
, **kwargs
)
10624 def Insert(*args
, **kwargs
):
10625 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10626 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10628 def GetMenuCount(*args
, **kwargs
):
10629 """GetMenuCount(self) -> size_t"""
10630 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10632 def GetMenu(*args
, **kwargs
):
10633 """GetMenu(self, size_t pos) -> Menu"""
10634 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10636 def Replace(*args
, **kwargs
):
10637 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10638 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10640 def Remove(*args
, **kwargs
):
10641 """Remove(self, size_t pos) -> Menu"""
10642 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10644 def EnableTop(*args
, **kwargs
):
10645 """EnableTop(self, size_t pos, bool enable)"""
10646 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10648 def IsEnabledTop(*args
, **kwargs
):
10649 """IsEnabledTop(self, size_t pos) -> bool"""
10650 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10652 def SetLabelTop(*args
, **kwargs
):
10653 """SetLabelTop(self, size_t pos, String label)"""
10654 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10656 def GetLabelTop(*args
, **kwargs
):
10657 """GetLabelTop(self, size_t pos) -> String"""
10658 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10660 def FindMenuItem(*args
, **kwargs
):
10661 """FindMenuItem(self, String menu, String item) -> int"""
10662 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10664 def FindItemById(*args
, **kwargs
):
10665 """FindItemById(self, int id) -> MenuItem"""
10666 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10668 def FindMenu(*args
, **kwargs
):
10669 """FindMenu(self, String title) -> int"""
10670 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10672 def Enable(*args
, **kwargs
):
10673 """Enable(self, int id, bool enable)"""
10674 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10676 def Check(*args
, **kwargs
):
10677 """Check(self, int id, bool check)"""
10678 return _core_
.MenuBar_Check(*args
, **kwargs
)
10680 def IsChecked(*args
, **kwargs
):
10681 """IsChecked(self, int id) -> bool"""
10682 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10684 def IsEnabled(*args
, **kwargs
):
10685 """IsEnabled(self, int id) -> bool"""
10686 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10688 def SetLabel(*args
, **kwargs
):
10689 """SetLabel(self, int id, String label)"""
10690 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10692 def GetLabel(*args
, **kwargs
):
10693 """GetLabel(self, int id) -> String"""
10694 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10696 def SetHelpString(*args
, **kwargs
):
10697 """SetHelpString(self, int id, String helpString)"""
10698 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10700 def GetHelpString(*args
, **kwargs
):
10701 """GetHelpString(self, int id) -> String"""
10702 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10704 def GetFrame(*args
, **kwargs
):
10705 """GetFrame(self) -> wxFrame"""
10706 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10708 def IsAttached(*args
, **kwargs
):
10709 """IsAttached(self) -> bool"""
10710 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10712 def Attach(*args
, **kwargs
):
10713 """Attach(self, wxFrame frame)"""
10714 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10716 def Detach(*args
, **kwargs
):
10718 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10720 def UpdateMenus(*args
, **kwargs
):
10721 """UpdateMenus(self)"""
10722 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10724 def SetAutoWindowMenu(*args
, **kwargs
):
10725 """SetAutoWindowMenu(bool enable)"""
10726 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10728 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10729 def GetAutoWindowMenu(*args
, **kwargs
):
10730 """GetAutoWindowMenu() -> bool"""
10731 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10733 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10734 def GetMenus(self
):
10735 """Return a list of (menu, label) items for the menus in the MenuBar. """
10736 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
10737 for i
in range(self
.GetMenuCount())]
10739 def SetMenus(self
, items
):
10740 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10741 for i
in range(self
.GetMenuCount()-1, -1, -1):
10746 Frame
= property(GetFrame
,doc
="See `GetFrame`")
10747 Menu
= property(GetMenu
,doc
="See `GetMenu`")
10748 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
10749 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
10750 _core_
.MenuBar_swigregister(MenuBar
)
10752 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
10753 """MenuBar_SetAutoWindowMenu(bool enable)"""
10754 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10756 def MenuBar_GetAutoWindowMenu(*args
):
10757 """MenuBar_GetAutoWindowMenu() -> bool"""
10758 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
10760 #---------------------------------------------------------------------------
10762 class MenuItem(Object
):
10763 """Proxy of C++ MenuItem class"""
10764 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10765 __repr__
= _swig_repr
10766 def __init__(self
, *args
, **kwargs
):
10768 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10769 String help=EmptyString, int kind=ITEM_NORMAL,
10770 Menu subMenu=None) -> MenuItem
10772 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
10773 __swig_destroy__
= _core_
.delete_MenuItem
10774 __del__
= lambda self
: None;
10775 def GetMenu(*args
, **kwargs
):
10776 """GetMenu(self) -> Menu"""
10777 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
10779 def SetMenu(*args
, **kwargs
):
10780 """SetMenu(self, Menu menu)"""
10781 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
10783 def SetId(*args
, **kwargs
):
10784 """SetId(self, int id)"""
10785 return _core_
.MenuItem_SetId(*args
, **kwargs
)
10787 def GetId(*args
, **kwargs
):
10788 """GetId(self) -> int"""
10789 return _core_
.MenuItem_GetId(*args
, **kwargs
)
10791 def IsSeparator(*args
, **kwargs
):
10792 """IsSeparator(self) -> bool"""
10793 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
10795 def SetText(*args
, **kwargs
):
10796 """SetText(self, String str)"""
10797 return _core_
.MenuItem_SetText(*args
, **kwargs
)
10799 def GetLabel(*args
, **kwargs
):
10800 """GetLabel(self) -> String"""
10801 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
10803 def GetText(*args
, **kwargs
):
10804 """GetText(self) -> String"""
10805 return _core_
.MenuItem_GetText(*args
, **kwargs
)
10807 def GetLabelFromText(*args
, **kwargs
):
10808 """GetLabelFromText(String text) -> String"""
10809 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10811 GetLabelFromText
= staticmethod(GetLabelFromText
)
10812 def GetKind(*args
, **kwargs
):
10813 """GetKind(self) -> int"""
10814 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
10816 def SetKind(*args
, **kwargs
):
10817 """SetKind(self, int kind)"""
10818 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
10820 def SetCheckable(*args
, **kwargs
):
10821 """SetCheckable(self, bool checkable)"""
10822 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
10824 def IsCheckable(*args
, **kwargs
):
10825 """IsCheckable(self) -> bool"""
10826 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
10828 def IsSubMenu(*args
, **kwargs
):
10829 """IsSubMenu(self) -> bool"""
10830 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
10832 def SetSubMenu(*args
, **kwargs
):
10833 """SetSubMenu(self, Menu menu)"""
10834 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
10836 def GetSubMenu(*args
, **kwargs
):
10837 """GetSubMenu(self) -> Menu"""
10838 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
10840 def Enable(*args
, **kwargs
):
10841 """Enable(self, bool enable=True)"""
10842 return _core_
.MenuItem_Enable(*args
, **kwargs
)
10844 def IsEnabled(*args
, **kwargs
):
10845 """IsEnabled(self) -> bool"""
10846 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
10848 def Check(*args
, **kwargs
):
10849 """Check(self, bool check=True)"""
10850 return _core_
.MenuItem_Check(*args
, **kwargs
)
10852 def IsChecked(*args
, **kwargs
):
10853 """IsChecked(self) -> bool"""
10854 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
10856 def Toggle(*args
, **kwargs
):
10858 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
10860 def SetHelp(*args
, **kwargs
):
10861 """SetHelp(self, String str)"""
10862 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
10864 def GetHelp(*args
, **kwargs
):
10865 """GetHelp(self) -> String"""
10866 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
10868 def GetAccel(*args
, **kwargs
):
10869 """GetAccel(self) -> AcceleratorEntry"""
10870 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
10872 def SetAccel(*args
, **kwargs
):
10873 """SetAccel(self, AcceleratorEntry accel)"""
10874 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
10876 def SetBitmap(*args
, **kwargs
):
10877 """SetBitmap(self, Bitmap bitmap)"""
10878 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
10880 def GetBitmap(*args
, **kwargs
):
10881 """GetBitmap(self) -> Bitmap"""
10882 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
10884 def SetFont(*args
, **kwargs
):
10885 """SetFont(self, Font font)"""
10886 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
10888 def GetFont(*args
, **kwargs
):
10889 """GetFont(self) -> Font"""
10890 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
10892 def SetTextColour(*args
, **kwargs
):
10893 """SetTextColour(self, Colour colText)"""
10894 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
10896 def GetTextColour(*args
, **kwargs
):
10897 """GetTextColour(self) -> Colour"""
10898 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
10900 def SetBackgroundColour(*args
, **kwargs
):
10901 """SetBackgroundColour(self, Colour colBack)"""
10902 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
10904 def GetBackgroundColour(*args
, **kwargs
):
10905 """GetBackgroundColour(self) -> Colour"""
10906 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
10908 def SetBitmaps(*args
, **kwargs
):
10909 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10910 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
10912 def SetDisabledBitmap(*args
, **kwargs
):
10913 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10914 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
10916 def GetDisabledBitmap(*args
, **kwargs
):
10917 """GetDisabledBitmap(self) -> Bitmap"""
10918 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
10920 def SetMarginWidth(*args
, **kwargs
):
10921 """SetMarginWidth(self, int nWidth)"""
10922 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
10924 def GetMarginWidth(*args
, **kwargs
):
10925 """GetMarginWidth(self) -> int"""
10926 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
10928 def GetDefaultMarginWidth(*args
, **kwargs
):
10929 """GetDefaultMarginWidth() -> int"""
10930 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
10932 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
10933 def IsOwnerDrawn(*args
, **kwargs
):
10934 """IsOwnerDrawn(self) -> bool"""
10935 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
10937 def SetOwnerDrawn(*args
, **kwargs
):
10938 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10939 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
10941 def ResetOwnerDrawn(*args
, **kwargs
):
10942 """ResetOwnerDrawn(self)"""
10943 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
10945 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
10946 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10947 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
10948 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10949 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10950 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
10951 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10952 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
10953 Label
= property(GetLabel
,doc
="See `GetLabel`")
10954 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
10955 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
10956 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
10957 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
10958 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
10959 _core_
.MenuItem_swigregister(MenuItem
)
10961 def MenuItem_GetLabelFromText(*args
, **kwargs
):
10962 """MenuItem_GetLabelFromText(String text) -> String"""
10963 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10965 def MenuItem_GetDefaultMarginWidth(*args
):
10966 """MenuItem_GetDefaultMarginWidth() -> int"""
10967 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
10969 #---------------------------------------------------------------------------
10971 class Control(Window
):
10973 This is the base class for a control or 'widget'.
10975 A control is generally a small window which processes user input
10976 and/or displays one or more item of data.
10978 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10979 __repr__
= _swig_repr
10980 def __init__(self
, *args
, **kwargs
):
10982 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10983 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10984 String name=ControlNameStr) -> Control
10986 Create a Control. Normally you should only call this from a subclass'
10987 __init__ as a plain old wx.Control is not very useful.
10989 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
10990 self
._setOORInfo
(self
)
10992 def Create(*args
, **kwargs
):
10994 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10995 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10996 String name=ControlNameStr) -> bool
10998 Do the 2nd phase and create the GUI control.
11000 return _core_
.Control_Create(*args
, **kwargs
)
11002 def GetAlignment(*args
, **kwargs
):
11004 GetAlignment(self) -> int
11006 Get the control alignment (left/right/centre, top/bottom/centre)
11008 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11010 def GetLabelText(*args
, **kwargs
):
11012 GetLabelText(self) -> String
11014 Get just the text of the label, without mnemonic characters ('&')
11016 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11018 def Command(*args
, **kwargs
):
11020 Command(self, CommandEvent event)
11022 Simulates the effect of the user issuing a command to the item.
11024 :see: `wx.CommandEvent`
11027 return _core_
.Control_Command(*args
, **kwargs
)
11029 def GetClassDefaultAttributes(*args
, **kwargs
):
11031 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11033 Get the default attributes for this class. This is useful if you want
11034 to use the same font or colour in your own control as in a standard
11035 control -- which is a much better idea than hard coding specific
11036 colours or fonts which might look completely out of place on the
11037 user's system, especially if it uses themes.
11039 The variant parameter is only relevant under Mac currently and is
11040 ignore under other platforms. Under Mac, it will change the size of
11041 the returned font. See `wx.Window.SetWindowVariant` for more about
11044 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11046 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11047 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11048 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11049 _core_
.Control_swigregister(Control
)
11050 ControlNameStr
= cvar
.ControlNameStr
11052 def PreControl(*args
, **kwargs
):
11054 PreControl() -> Control
11056 Precreate a Control control for 2-phase creation
11058 val
= _core_
.new_PreControl(*args
, **kwargs
)
11061 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11063 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11065 Get the default attributes for this class. This is useful if you want
11066 to use the same font or colour in your own control as in a standard
11067 control -- which is a much better idea than hard coding specific
11068 colours or fonts which might look completely out of place on the
11069 user's system, especially if it uses themes.
11071 The variant parameter is only relevant under Mac currently and is
11072 ignore under other platforms. Under Mac, it will change the size of
11073 the returned font. See `wx.Window.SetWindowVariant` for more about
11076 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11078 #---------------------------------------------------------------------------
11080 class ItemContainer(object):
11082 The wx.ItemContainer class defines an interface which is implemented
11083 by all controls which have string subitems, each of which may be
11084 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11085 as `wx.ComboBox` which implements an extended interface deriving from
11088 It defines the methods for accessing the control's items and although
11089 each of the derived classes implements them differently, they still
11090 all conform to the same interface.
11092 The items in a wx.ItemContainer have (non empty) string labels and,
11093 optionally, client data associated with them.
11096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11097 def __init__(self
): raise AttributeError, "No constructor defined"
11098 __repr__
= _swig_repr
11099 def Append(*args
, **kwargs
):
11101 Append(self, String item, PyObject clientData=None) -> int
11103 Adds the item to the control, associating the given data with the item
11104 if not None. The return value is the index of the newly added item
11105 which may be different from the last one if the control is sorted (e.g.
11106 has wx.LB_SORT or wx.CB_SORT style).
11108 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11110 def AppendItems(*args
, **kwargs
):
11112 AppendItems(self, List strings)
11114 Apend several items at once to the control. Notice that calling this
11115 method may be much faster than appending the items one by one if you
11116 need to add a lot of items.
11118 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11120 def Insert(*args
, **kwargs
):
11122 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11124 Insert an item into the control before the item at the ``pos`` index,
11125 optionally associating some data object with the item.
11127 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11129 def Clear(*args
, **kwargs
):
11133 Removes all items from the control.
11135 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11137 def Delete(*args
, **kwargs
):
11139 Delete(self, unsigned int n)
11141 Deletes the item at the zero-based index 'n' from the control. Note
11142 that it is an error (signalled by a `wx.PyAssertionError` exception if
11143 enabled) to remove an item with the index negative or greater or equal
11144 than the number of items in the control.
11146 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11148 def GetClientData(*args
, **kwargs
):
11150 GetClientData(self, unsigned int n) -> PyObject
11152 Returns the client data associated with the given item, (if any.)
11154 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11156 def SetClientData(*args
, **kwargs
):
11158 SetClientData(self, unsigned int n, PyObject clientData)
11160 Associate the given client data with the item at position n.
11162 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11164 def GetCount(*args
, **kwargs
):
11166 GetCount(self) -> unsigned int
11168 Returns the number of items in the control.
11170 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11172 def IsEmpty(*args
, **kwargs
):
11174 IsEmpty(self) -> bool
11176 Returns True if the control is empty or False if it has some items.
11178 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11180 def GetString(*args
, **kwargs
):
11182 GetString(self, unsigned int n) -> String
11184 Returns the label of the item with the given index.
11186 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11188 def GetStrings(*args
, **kwargs
):
11189 """GetStrings(self) -> wxArrayString"""
11190 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11192 def SetString(*args
, **kwargs
):
11194 SetString(self, unsigned int n, String s)
11196 Sets the label for the given item.
11198 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11200 def FindString(*args
, **kwargs
):
11202 FindString(self, String s) -> int
11204 Finds an item whose label matches the given string. Returns the
11205 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11208 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11210 def SetSelection(*args
, **kwargs
):
11212 SetSelection(self, int n)
11214 Sets the item at index 'n' to be the selected item.
11216 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11218 def GetSelection(*args
, **kwargs
):
11220 GetSelection(self) -> int
11222 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11225 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11227 def SetStringSelection(*args
, **kwargs
):
11228 """SetStringSelection(self, String s) -> bool"""
11229 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11231 def GetStringSelection(*args
, **kwargs
):
11233 GetStringSelection(self) -> String
11235 Returns the label of the selected item or an empty string if no item
11238 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11240 def Select(*args
, **kwargs
):
11242 Select(self, int n)
11244 This is the same as `SetSelection` and exists only because it is
11245 slightly more natural for controls which support multiple selection.
11247 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11249 def GetItems(self
):
11250 """Return a list of the strings in the control"""
11251 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11253 def SetItems(self
, items
):
11254 """Clear and set the strings in the control from a list"""
11259 Count
= property(GetCount
,doc
="See `GetCount`")
11260 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11261 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11262 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11263 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11264 _core_
.ItemContainer_swigregister(ItemContainer
)
11266 #---------------------------------------------------------------------------
11268 class ControlWithItems(Control
,ItemContainer
):
11270 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11271 wx.Control class, and is used for the base class of various controls
11274 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11275 def __init__(self
): raise AttributeError, "No constructor defined"
11276 __repr__
= _swig_repr
11277 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11279 #---------------------------------------------------------------------------
11281 class SizerItem(Object
):
11283 The wx.SizerItem class is used to track the position, size and other
11284 attributes of each item managed by a `wx.Sizer`. It is not usually
11285 necessary to use this class because the sizer elements can also be
11286 identified by their positions or window or sizer references but
11287 sometimes it may be more convenient to use wx.SizerItem directly.
11288 Also, custom classes derived from `wx.PySizer` will probably need to
11289 use the collection of wx.SizerItems held by wx.Sizer when calculating
11292 :see: `wx.Sizer`, `wx.GBSizerItem`
11294 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11295 __repr__
= _swig_repr
11296 def __init__(self
, *args
, **kwargs
):
11298 __init__(self) -> SizerItem
11300 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11301 size will need to be set before this item can be used in a Sizer.
11303 You will probably never need to create a wx.SizerItem directly as they
11304 are created automatically when the sizer's Add, Insert or Prepend
11305 methods are called.
11307 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11309 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11310 __swig_destroy__
= _core_
.delete_SizerItem
11311 __del__
= lambda self
: None;
11312 def DeleteWindows(*args
, **kwargs
):
11314 DeleteWindows(self)
11316 Destroy the window or the windows in a subsizer, depending on the type
11319 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11321 def DetachSizer(*args
, **kwargs
):
11325 Enable deleting the SizerItem without destroying the contained sizer.
11327 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11329 def GetSize(*args
, **kwargs
):
11331 GetSize(self) -> Size
11333 Get the current size of the item, as set in the last Layout.
11335 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11337 def CalcMin(*args
, **kwargs
):
11339 CalcMin(self) -> Size
11341 Calculates the minimum desired size for the item, including any space
11344 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11346 def SetDimension(*args
, **kwargs
):
11348 SetDimension(self, Point pos, Size size)
11350 Set the position and size of the space allocated for this item by the
11351 sizer, and adjust the position and size of the item (window or
11352 subsizer) to be within that space taking alignment and borders into
11355 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11357 def GetMinSize(*args
, **kwargs
):
11359 GetMinSize(self) -> Size
11361 Get the minimum size needed for the item.
11363 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11365 def GetMinSizeWithBorder(*args
, **kwargs
):
11367 GetMinSizeWithBorder(self) -> Size
11369 Get the minimum size needed for the item with space for the borders
11372 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11374 def SetInitSize(*args
, **kwargs
):
11375 """SetInitSize(self, int x, int y)"""
11376 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11378 def SetRatioWH(*args
, **kwargs
):
11380 SetRatioWH(self, int width, int height)
11382 Set the ratio item attribute.
11384 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11386 def SetRatioSize(*args
, **kwargs
):
11388 SetRatioSize(self, Size size)
11390 Set the ratio item attribute.
11392 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11394 def SetRatio(*args
, **kwargs
):
11396 SetRatio(self, float ratio)
11398 Set the ratio item attribute.
11400 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11402 def GetRatio(*args
, **kwargs
):
11404 GetRatio(self) -> float
11406 Set the ratio item attribute.
11408 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11410 def GetRect(*args
, **kwargs
):
11412 GetRect(self) -> Rect
11414 Returns the rectangle that the sizer item should occupy
11416 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11418 def IsWindow(*args
, **kwargs
):
11420 IsWindow(self) -> bool
11422 Is this sizer item a window?
11424 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11426 def IsSizer(*args
, **kwargs
):
11428 IsSizer(self) -> bool
11430 Is this sizer item a subsizer?
11432 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11434 def IsSpacer(*args
, **kwargs
):
11436 IsSpacer(self) -> bool
11438 Is this sizer item a spacer?
11440 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11442 def SetProportion(*args
, **kwargs
):
11444 SetProportion(self, int proportion)
11446 Set the proportion value for this item.
11448 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11450 def GetProportion(*args
, **kwargs
):
11452 GetProportion(self) -> int
11454 Get the proportion value for this item.
11456 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11458 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11459 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11460 def SetFlag(*args
, **kwargs
):
11462 SetFlag(self, int flag)
11464 Set the flag value for this item.
11466 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11468 def GetFlag(*args
, **kwargs
):
11470 GetFlag(self) -> int
11472 Get the flag value for this item.
11474 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11476 def SetBorder(*args
, **kwargs
):
11478 SetBorder(self, int border)
11480 Set the border value for this item.
11482 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11484 def GetBorder(*args
, **kwargs
):
11486 GetBorder(self) -> int
11488 Get the border value for this item.
11490 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11492 def GetWindow(*args
, **kwargs
):
11494 GetWindow(self) -> Window
11496 Get the window (if any) that is managed by this sizer item.
11498 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11500 def SetWindow(*args
, **kwargs
):
11502 SetWindow(self, Window window)
11504 Set the window to be managed by this sizer item.
11506 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11508 def GetSizer(*args
, **kwargs
):
11510 GetSizer(self) -> Sizer
11512 Get the subsizer (if any) that is managed by this sizer item.
11514 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11516 def SetSizer(*args
, **kwargs
):
11518 SetSizer(self, Sizer sizer)
11520 Set the subsizer to be managed by this sizer item.
11522 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11524 def GetSpacer(*args
, **kwargs
):
11526 GetSpacer(self) -> Size
11528 Get the size of the spacer managed by this sizer item.
11530 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11532 def SetSpacer(*args
, **kwargs
):
11534 SetSpacer(self, Size size)
11536 Set the size of the spacer to be managed by this sizer item.
11538 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11540 def Show(*args
, **kwargs
):
11542 Show(self, bool show)
11544 Set the show item attribute, which sizers use to determine if the item
11545 is to be made part of the layout or not. If the item is tracking a
11546 window then it is shown or hidden as needed.
11548 return _core_
.SizerItem_Show(*args
, **kwargs
)
11550 def IsShown(*args
, **kwargs
):
11552 IsShown(self) -> bool
11554 Is the item to be shown in the layout?
11556 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11558 def GetPosition(*args
, **kwargs
):
11560 GetPosition(self) -> Point
11562 Returns the current position of the item, as set in the last Layout.
11564 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11566 def GetUserData(*args
, **kwargs
):
11568 GetUserData(self) -> PyObject
11570 Returns the userData associated with this sizer item, or None if there
11573 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11575 def SetUserData(*args
, **kwargs
):
11577 SetUserData(self, PyObject userData)
11579 Associate a Python object with this sizer item.
11581 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11583 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11584 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11585 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11586 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11587 Position
= property(GetPosition
,doc
="See `GetPosition`")
11588 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11589 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11590 Rect
= property(GetRect
,doc
="See `GetRect`")
11591 Size
= property(GetSize
,doc
="See `GetSize`")
11592 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11593 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11594 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11595 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11596 _core_
.SizerItem_swigregister(SizerItem
)
11598 def SizerItemWindow(*args
, **kwargs
):
11600 SizerItemWindow(Window window, int proportion, int flag, int border,
11601 PyObject userData=None) -> SizerItem
11603 Constructs a `wx.SizerItem` for tracking a window.
11605 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11608 def SizerItemSpacer(*args
, **kwargs
):
11610 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11611 PyObject userData=None) -> SizerItem
11613 Constructs a `wx.SizerItem` for tracking a spacer.
11615 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11618 def SizerItemSizer(*args
, **kwargs
):
11620 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11621 PyObject userData=None) -> SizerItem
11623 Constructs a `wx.SizerItem` for tracking a subsizer
11625 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11628 class Sizer(Object
):
11630 wx.Sizer is the abstract base class used for laying out subwindows in
11631 a window. You cannot use wx.Sizer directly; instead, you will have to
11632 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11633 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11636 The concept implemented by sizers in wxWidgets is closely related to
11637 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11638 toolkit or the Qt toolkit. It is based upon the idea of the individual
11639 subwindows reporting their minimal required size and their ability to
11640 get stretched if the size of the parent window has changed. This will
11641 most often mean that the programmer does not set the original size of
11642 a dialog in the beginning, rather the dialog will assigned a sizer and
11643 this sizer will be queried about the recommended size. The sizer in
11644 turn will query its children, which can be normal windows or contorls,
11645 empty space or other sizers, so that a hierarchy of sizers can be
11646 constructed. Note that wxSizer does not derive from wxWindow and thus
11647 do not interfere with tab ordering and requires very little resources
11648 compared to a real window on screen.
11650 What makes sizers so well fitted for use in wxWidgets is the fact that
11651 every control reports its own minimal size and the algorithm can
11652 handle differences in font sizes or different window (dialog item)
11653 sizes on different platforms without problems. If for example the
11654 standard font as well as the overall design of Mac widgets requires
11655 more space than on Windows, then the initial size of a dialog using a
11656 sizer will automatically be bigger on Mac than on Windows.
11658 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11659 def __init__(self
): raise AttributeError, "No constructor defined"
11660 __repr__
= _swig_repr
11661 __swig_destroy__
= _core_
.delete_Sizer
11662 __del__
= lambda self
: None;
11663 def _setOORInfo(*args
, **kwargs
):
11664 """_setOORInfo(self, PyObject _self)"""
11665 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11667 def Add(*args
, **kwargs
):
11669 Add(self, item, int proportion=0, int flag=0, int border=0,
11670 PyObject userData=None) -> wx.SizerItem
11672 Appends a child item to the sizer.
11674 return _core_
.Sizer_Add(*args
, **kwargs
)
11676 def Insert(*args
, **kwargs
):
11678 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11679 PyObject userData=None) -> wx.SizerItem
11681 Inserts a new item into the list of items managed by this sizer before
11682 the item at index *before*. See `Add` for a description of the parameters.
11684 return _core_
.Sizer_Insert(*args
, **kwargs
)
11686 def Prepend(*args
, **kwargs
):
11688 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11689 PyObject userData=None) -> wx.SizerItem
11691 Adds a new item to the begining of the list of sizer items managed by
11692 this sizer. See `Add` for a description of the parameters.
11694 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11696 def Remove(*args
, **kwargs
):
11698 Remove(self, item) -> bool
11700 Removes an item from the sizer and destroys it. This method does not
11701 cause any layout or resizing to take place, call `Layout` to update
11702 the layout on screen after removing a child from the sizer. The
11703 *item* parameter can be either a window, a sizer, or the zero-based
11704 index of an item to remove. Returns True if the child item was found
11707 return _core_
.Sizer_Remove(*args
, **kwargs
)
11709 def Detach(*args
, **kwargs
):
11711 Detach(self, item) -> bool
11713 Detaches an item from the sizer without destroying it. This method
11714 does not cause any layout or resizing to take place, call `Layout` to
11715 do so. The *item* parameter can be either a window, a sizer, or the
11716 zero-based index of the item to be detached. Returns True if the child item
11717 was found and detached.
11719 return _core_
.Sizer_Detach(*args
, **kwargs
)
11721 def GetItem(*args
, **kwargs
):
11723 GetItem(self, item) -> wx.SizerItem
11725 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11726 parameter can be either a window, a sizer, or the zero-based index of
11727 the item to be found.
11729 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11731 def _SetItemMinSize(*args
, **kwargs
):
11732 """_SetItemMinSize(self, PyObject item, Size size)"""
11733 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11735 def _ReplaceWin(*args
, **kwargs
):
11736 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11737 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
11739 def _ReplaceSizer(*args
, **kwargs
):
11740 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11741 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
11743 def _ReplaceItem(*args
, **kwargs
):
11744 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11745 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
11747 def Replace(self
, olditem
, item
, recursive
=False):
11749 Detaches the given ``olditem`` from the sizer and replaces it with
11750 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11751 detached child is destroyed only if it is not a window, (because
11752 windows are owned by their parent, not the sizer.) The
11753 ``recursive`` parameter can be used to search for the given
11754 element recursivly in subsizers.
11756 This method does not cause any layout or resizing to take place,
11757 call `Layout` to do so.
11759 Returns ``True`` if the child item was found and removed.
11761 if isinstance(olditem
, wx
.Window
):
11762 return self
._ReplaceWin
(olditem
, item
, recursive
)
11763 elif isinstnace(olditem
, wx
.Sizer
):
11764 return self
._ReplaceSizer
(olditem
, item
, recursive
)
11765 elif isinstnace(olditem
, int):
11766 return self
._ReplaceItem
(olditem
, item
)
11768 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11770 def SetContainingWindow(*args
, **kwargs
):
11772 SetContainingWindow(self, Window window)
11774 Set (or unset) the window this sizer is used in.
11776 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
11778 def GetContainingWindow(*args
, **kwargs
):
11780 GetContainingWindow(self) -> Window
11782 Get the window this sizer is used in.
11784 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
11786 def SetItemMinSize(self
, item
, *args
):
11788 SetItemMinSize(self, item, Size size)
11790 Sets the minimum size that will be allocated for an item in the sizer.
11791 The *item* parameter can be either a window, a sizer, or the
11792 zero-based index of the item. If a window or sizer is given then it
11793 will be searched for recursivly in subsizers if neccessary.
11796 # for backward compatibility accept separate width,height args too
11797 return self
._SetItemMinSize
(item
, args
)
11799 return self
._SetItemMinSize
(item
, args
[0])
11801 def AddItem(*args
, **kwargs
):
11803 AddItem(self, SizerItem item)
11805 Adds a `wx.SizerItem` to the sizer.
11807 return _core_
.Sizer_AddItem(*args
, **kwargs
)
11809 def InsertItem(*args
, **kwargs
):
11811 InsertItem(self, int index, SizerItem item)
11813 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11815 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
11817 def PrependItem(*args
, **kwargs
):
11819 PrependItem(self, SizerItem item)
11821 Prepends a `wx.SizerItem` to the sizer.
11823 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
11825 def AddMany(self
, items
):
11827 AddMany is a convenience method for adding several items
11828 to a sizer at one time. Simply pass it a list of tuples,
11829 where each tuple consists of the parameters that you
11830 would normally pass to the `Add` method.
11833 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
11837 def AddSpacer(self
, *args
, **kw
):
11838 """AddSpacer(int size) --> SizerItem
11840 Add a spacer that is (size,size) pixels.
11842 if args
and type(args
[0]) == int:
11843 return self
.Add( (args
[0],args
[0] ), 0)
11844 else: # otherwise stay compatible with old AddSpacer
11845 return self
.Add(*args
, **kw
)
11846 def PrependSpacer(self
, *args
, **kw
):
11847 """PrependSpacer(int size) --> SizerItem
11849 Prepend a spacer that is (size, size) pixels."""
11850 if args
and type(args
[0]) == int:
11851 return self
.Prepend( (args
[0],args
[0] ), 0)
11852 else: # otherwise stay compatible with old PrependSpacer
11853 return self
.Prepend(*args
, **kw
)
11854 def InsertSpacer(self
, index
, *args
, **kw
):
11855 """InsertSpacer(int index, int size) --> SizerItem
11857 Insert a spacer at position index that is (size, size) pixels."""
11858 if args
and type(args
[0]) == int:
11859 return self
.Insert( index
, (args
[0],args
[0] ), 0)
11860 else: # otherwise stay compatible with old InsertSpacer
11861 return self
.Insert(index
, *args
, **kw
)
11864 def AddStretchSpacer(self
, prop
=1):
11865 """AddStretchSpacer(int prop=1) --> SizerItem
11867 Add a stretchable spacer."""
11868 return self
.Add((0,0), prop
)
11869 def PrependStretchSpacer(self
, prop
=1):
11870 """PrependStretchSpacer(int prop=1) --> SizerItem
11872 Prepend a stretchable spacer."""
11873 return self
.Prepend((0,0), prop
)
11874 def InsertStretchSpacer(self
, index
, prop
=1):
11875 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11877 Insert a stretchable spacer."""
11878 return self
.Insert(index
, (0,0), prop
)
11881 # for backwards compatibility only, please do not use in new code
11882 def AddWindow(self
, *args
, **kw
):
11883 """Compatibility alias for `Add`."""
11884 return self
.Add(*args
, **kw
)
11885 def AddSizer(self
, *args
, **kw
):
11886 """Compatibility alias for `Add`."""
11887 return self
.Add(*args
, **kw
)
11889 def PrependWindow(self
, *args
, **kw
):
11890 """Compatibility alias for `Prepend`."""
11891 return self
.Prepend(*args
, **kw
)
11892 def PrependSizer(self
, *args
, **kw
):
11893 """Compatibility alias for `Prepend`."""
11894 return self
.Prepend(*args
, **kw
)
11896 def InsertWindow(self
, *args
, **kw
):
11897 """Compatibility alias for `Insert`."""
11898 return self
.Insert(*args
, **kw
)
11899 def InsertSizer(self
, *args
, **kw
):
11900 """Compatibility alias for `Insert`."""
11901 return self
.Insert(*args
, **kw
)
11903 def RemoveWindow(self
, *args
, **kw
):
11904 """Compatibility alias for `Remove`."""
11905 return self
.Remove(*args
, **kw
)
11906 def RemoveSizer(self
, *args
, **kw
):
11907 """Compatibility alias for `Remove`."""
11908 return self
.Remove(*args
, **kw
)
11909 def RemovePos(self
, *args
, **kw
):
11910 """Compatibility alias for `Remove`."""
11911 return self
.Remove(*args
, **kw
)
11914 def SetDimension(*args
, **kwargs
):
11916 SetDimension(self, int x, int y, int width, int height)
11918 Call this to force the sizer to take the given dimension and thus
11919 force the items owned by the sizer to resize themselves according to
11920 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11923 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
11925 def SetMinSize(*args
, **kwargs
):
11927 SetMinSize(self, Size size)
11929 Call this to give the sizer a minimal size. Normally, the sizer will
11930 calculate its minimal size based purely on how much space its children
11931 need. After calling this method `GetMinSize` will return either the
11932 minimal size as requested by its children or the minimal size set
11933 here, depending on which is bigger.
11935 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
11937 def GetSize(*args
, **kwargs
):
11939 GetSize(self) -> Size
11941 Returns the current size of the space managed by the sizer.
11943 return _core_
.Sizer_GetSize(*args
, **kwargs
)
11945 def GetPosition(*args
, **kwargs
):
11947 GetPosition(self) -> Point
11949 Returns the current position of the sizer's managed space.
11951 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
11953 def GetMinSize(*args
, **kwargs
):
11955 GetMinSize(self) -> Size
11957 Returns the minimal size of the sizer. This is either the combined
11958 minimal size of all the children and their borders or the minimal size
11959 set by SetMinSize, depending on which is bigger.
11961 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
11963 def GetSizeTuple(self
):
11964 return self
.GetSize().Get()
11965 def GetPositionTuple(self
):
11966 return self
.GetPosition().Get()
11967 def GetMinSizeTuple(self
):
11968 return self
.GetMinSize().Get()
11970 def RecalcSizes(*args
, **kwargs
):
11974 Using the sizes calculated by `CalcMin` reposition and resize all the
11975 items managed by this sizer. You should not need to call this directly as
11976 it is called by `Layout`.
11978 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
11980 def CalcMin(*args
, **kwargs
):
11982 CalcMin(self) -> Size
11984 This method is where the sizer will do the actual calculation of its
11985 children's minimal sizes. You should not need to call this directly as
11986 it is called by `Layout`.
11988 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
11990 def Layout(*args
, **kwargs
):
11994 This method will force the recalculation and layout of the items
11995 controlled by the sizer using the current space allocated to the
11996 sizer. Normally this is called automatically from the owning window's
11997 EVT_SIZE handler, but it is also useful to call it from user code when
11998 one of the items in a sizer change size, or items are added or
12001 return _core_
.Sizer_Layout(*args
, **kwargs
)
12003 def Fit(*args
, **kwargs
):
12005 Fit(self, Window window) -> Size
12007 Tell the sizer to resize the *window* to match the sizer's minimal
12008 size. This is commonly done in the constructor of the window itself in
12009 order to set its initial size to match the needs of the children as
12010 determined by the sizer. Returns the new size.
12012 For a top level window this is the total window size, not the client size.
12014 return _core_
.Sizer_Fit(*args
, **kwargs
)
12016 def FitInside(*args
, **kwargs
):
12018 FitInside(self, Window window)
12020 Tell the sizer to resize the *virtual size* of the *window* to match the
12021 sizer's minimal size. This will not alter the on screen size of the
12022 window, but may cause the addition/removal/alteration of scrollbars
12023 required to view the virtual area in windows which manage it.
12025 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12028 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12030 def SetSizeHints(*args
, **kwargs
):
12032 SetSizeHints(self, Window window)
12034 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12035 match the sizer's minimal size. This is commonly done in the
12036 constructor of the window itself if the window is resizable (as are
12037 many dialogs under Unix and frames on probably all platforms) in order
12038 to prevent the window from being sized smaller than the minimal size
12039 required by the sizer.
12041 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12043 def SetVirtualSizeHints(*args
, **kwargs
):
12045 SetVirtualSizeHints(self, Window window)
12047 Tell the sizer to set the minimal size of the window virtual area to
12048 match the sizer's minimal size. For windows with managed scrollbars
12049 this will set them appropriately.
12051 :see: `wx.ScrolledWindow.SetScrollbars`
12054 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12056 def Clear(*args
, **kwargs
):
12058 Clear(self, bool deleteWindows=False)
12060 Clear all items from the sizer, optionally destroying the window items
12063 return _core_
.Sizer_Clear(*args
, **kwargs
)
12065 def DeleteWindows(*args
, **kwargs
):
12067 DeleteWindows(self)
12069 Destroy all windows managed by the sizer.
12071 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12073 def GetChildren(*args
, **kwargs
):
12075 GetChildren(self) -> list
12077 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12079 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12081 def Show(*args
, **kwargs
):
12083 Show(self, item, bool show=True, bool recursive=false) -> bool
12085 Shows or hides an item managed by the sizer. To make a sizer item
12086 disappear or reappear, use Show followed by `Layout`. The *item*
12087 parameter can be either a window, a sizer, or the zero-based index of
12088 the item. Use the recursive parameter to show or hide an item in a
12089 subsizer. Returns True if the item was found.
12091 return _core_
.Sizer_Show(*args
, **kwargs
)
12093 def IsShown(*args
, **kwargs
):
12095 IsShown(self, item)
12097 Determines if the item is currently shown. To make a sizer
12098 item disappear or reappear, use Show followed by `Layout`. The *item*
12099 parameter can be either a window, a sizer, or the zero-based index of
12102 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12104 def Hide(self
, item
, recursive
=False):
12106 A convenience method for `Show` (item, False, recursive).
12108 return self
.Show(item
, False, recursive
)
12110 def ShowItems(*args
, **kwargs
):
12112 ShowItems(self, bool show)
12114 Recursively call `wx.SizerItem.Show` on all sizer items.
12116 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12118 Children
= property(GetChildren
,doc
="See `GetChildren`")
12119 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12120 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12121 Position
= property(GetPosition
,doc
="See `GetPosition`")
12122 Size
= property(GetSize
,doc
="See `GetSize`")
12123 _core_
.Sizer_swigregister(Sizer
)
12125 class PySizer(Sizer
):
12127 wx.PySizer is a special version of `wx.Sizer` that has been
12128 instrumented to allow the C++ virtual methods to be overloaded in
12129 Python derived classes. You would derive from this class if you are
12130 wanting to implement a custom sizer in Python code. Simply implement
12131 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12134 class MySizer(wx.PySizer):
12135 def __init__(self):
12136 wx.PySizer.__init__(self)
12139 for item in self.GetChildren():
12140 # calculate the total minimum width and height needed
12141 # by all items in the sizer according to this sizer's
12142 # layout algorithm.
12144 return wx.Size(width, height)
12146 def RecalcSizes(self):
12147 # find the space allotted to this sizer
12148 pos = self.GetPosition()
12149 size = self.GetSize()
12150 for item in self.GetChildren():
12151 # Recalculate (if necessary) the position and size of
12152 # each item and then call item.SetDimension to do the
12153 # actual positioning and sizing of the items within the
12154 # space alloted to this sizer.
12156 item.SetDimension(itemPos, itemSize)
12159 When `Layout` is called it first calls `CalcMin` followed by
12160 `RecalcSizes` so you can optimize a bit by saving the results of
12161 `CalcMin` and reusing them in `RecalcSizes`.
12163 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12167 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12168 __repr__
= _swig_repr
12169 def __init__(self
, *args
, **kwargs
):
12171 __init__(self) -> PySizer
12173 Creates a wx.PySizer. Must be called from the __init__ in the derived
12176 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12177 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12179 def _setCallbackInfo(*args
, **kwargs
):
12180 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12181 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12183 _core_
.PySizer_swigregister(PySizer
)
12185 #---------------------------------------------------------------------------
12187 class BoxSizer(Sizer
):
12189 The basic idea behind a box sizer is that windows will most often be
12190 laid out in rather simple basic geometry, typically in a row or a
12191 column or nested hierarchies of either. A wx.BoxSizer will lay out
12192 its items in a simple row or column, depending on the orientation
12193 parameter passed to the constructor.
12195 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12196 __repr__
= _swig_repr
12197 def __init__(self
, *args
, **kwargs
):
12199 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12201 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12202 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12205 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12206 self
._setOORInfo
(self
)
12208 def GetOrientation(*args
, **kwargs
):
12210 GetOrientation(self) -> int
12212 Returns the current orientation of the sizer.
12214 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12216 def SetOrientation(*args
, **kwargs
):
12218 SetOrientation(self, int orient)
12220 Resets the orientation of the sizer.
12222 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12224 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12225 _core_
.BoxSizer_swigregister(BoxSizer
)
12227 #---------------------------------------------------------------------------
12229 class StaticBoxSizer(BoxSizer
):
12231 wx.StaticBoxSizer derives from and functions identically to the
12232 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12233 manages. Note that this static box must be created separately and
12234 passed to the sizer constructor.
12236 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12237 __repr__
= _swig_repr
12238 def __init__(self
, *args
, **kwargs
):
12240 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12242 Constructor. It takes an associated static box and the orientation
12243 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12246 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12247 self
._setOORInfo
(self
)
12249 def GetStaticBox(*args
, **kwargs
):
12251 GetStaticBox(self) -> StaticBox
12253 Returns the static box associated with this sizer.
12255 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12257 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12258 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12260 #---------------------------------------------------------------------------
12262 class GridSizer(Sizer
):
12264 A grid sizer is a sizer which lays out its children in a
12265 two-dimensional table with all cells having the same size. In other
12266 words, the width of each cell within the grid is the width of the
12267 widest item added to the sizer and the height of each grid cell is the
12268 height of the tallest item. An optional vertical and/or horizontal
12269 gap between items can also be specified (in pixels.)
12271 Items are placed in the cells of the grid in the order they are added,
12272 in row-major order. In other words, the first row is filled first,
12273 then the second, and so on until all items have been added. (If
12274 neccessary, additional rows will be added as items are added.) If you
12275 need to have greater control over the cells that items are placed in
12276 then use the `wx.GridBagSizer`.
12279 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12280 __repr__
= _swig_repr
12281 def __init__(self
, *args
, **kwargs
):
12283 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12285 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12286 of columns and rows in the sizer - if either of the parameters is
12287 zero, it will be calculated to from the total number of children in
12288 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12289 define extra space between all children.
12291 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12292 self
._setOORInfo
(self
)
12294 def SetCols(*args
, **kwargs
):
12296 SetCols(self, int cols)
12298 Sets the number of columns in the sizer.
12300 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12302 def SetRows(*args
, **kwargs
):
12304 SetRows(self, int rows)
12306 Sets the number of rows in the sizer.
12308 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12310 def SetVGap(*args
, **kwargs
):
12312 SetVGap(self, int gap)
12314 Sets the vertical gap (in pixels) between the cells in the sizer.
12316 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12318 def SetHGap(*args
, **kwargs
):
12320 SetHGap(self, int gap)
12322 Sets the horizontal gap (in pixels) between cells in the sizer
12324 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12326 def GetCols(*args
, **kwargs
):
12328 GetCols(self) -> int
12330 Returns the number of columns in the sizer.
12332 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12334 def GetRows(*args
, **kwargs
):
12336 GetRows(self) -> int
12338 Returns the number of rows in the sizer.
12340 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12342 def GetVGap(*args
, **kwargs
):
12344 GetVGap(self) -> int
12346 Returns the vertical gap (in pixels) between the cells in the sizer.
12348 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12350 def GetHGap(*args
, **kwargs
):
12352 GetHGap(self) -> int
12354 Returns the horizontal gap (in pixels) between cells in the sizer.
12356 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12358 def CalcRowsCols(self
):
12360 CalcRowsCols() -> (rows, cols)
12362 Calculates how many rows and columns will be in the sizer based
12363 on the current number of items and also the rows, cols specified
12364 in the constructor.
12366 nitems
= len(self
.GetChildren())
12367 rows
= self
.GetRows()
12368 cols
= self
.GetCols()
12369 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12371 rows
= (nitems
+ cols
- 1) / cols
12373 cols
= (nitems
+ rows
- 1) / rows
12374 return (rows
, cols
)
12376 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12377 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12378 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12379 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12380 _core_
.GridSizer_swigregister(GridSizer
)
12382 #---------------------------------------------------------------------------
12384 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12385 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12386 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12387 class FlexGridSizer(GridSizer
):
12389 A flex grid sizer is a sizer which lays out its children in a
12390 two-dimensional table with all table cells in one row having the same
12391 height and all cells in one column having the same width, but all
12392 rows or all columns are not necessarily the same height or width as in
12393 the `wx.GridSizer`.
12395 wx.FlexGridSizer can also size items equally in one direction but
12396 unequally ("flexibly") in the other. If the sizer is only flexible
12397 in one direction (this can be changed using `SetFlexibleDirection`), it
12398 needs to be decided how the sizer should grow in the other ("non
12399 flexible") direction in order to fill the available space. The
12400 `SetNonFlexibleGrowMode` method serves this purpose.
12404 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12405 __repr__
= _swig_repr
12406 def __init__(self
, *args
, **kwargs
):
12408 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12410 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12411 number of columns and rows in the sizer - if either of the parameters
12412 is zero, it will be calculated to from the total number of children in
12413 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12414 define extra space between all children.
12416 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12417 self
._setOORInfo
(self
)
12419 def AddGrowableRow(*args
, **kwargs
):
12421 AddGrowableRow(self, size_t idx, int proportion=0)
12423 Specifies that row *idx* (starting from zero) should be grown if there
12424 is extra space available to the sizer.
12426 The *proportion* parameter has the same meaning as the stretch factor
12427 for the box sizers except that if all proportions are 0, then all
12428 columns are resized equally (instead of not being resized at all).
12430 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12432 def RemoveGrowableRow(*args
, **kwargs
):
12434 RemoveGrowableRow(self, size_t idx)
12436 Specifies that row *idx* is no longer growable.
12438 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12440 def AddGrowableCol(*args
, **kwargs
):
12442 AddGrowableCol(self, size_t idx, int proportion=0)
12444 Specifies that column *idx* (starting from zero) should be grown if
12445 there is extra space available to the sizer.
12447 The *proportion* parameter has the same meaning as the stretch factor
12448 for the box sizers except that if all proportions are 0, then all
12449 columns are resized equally (instead of not being resized at all).
12451 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12453 def RemoveGrowableCol(*args
, **kwargs
):
12455 RemoveGrowableCol(self, size_t idx)
12457 Specifies that column *idx* is no longer growable.
12459 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12461 def SetFlexibleDirection(*args
, **kwargs
):
12463 SetFlexibleDirection(self, int direction)
12465 Specifies whether the sizer should flexibly resize its columns, rows,
12466 or both. Argument *direction* can be one of the following values. Any
12467 other value is ignored.
12469 ============== =======================================
12470 wx.VERTICAL Rows are flexibly sized.
12471 wx.HORIZONTAL Columns are flexibly sized.
12472 wx.BOTH Both rows and columns are flexibly sized
12473 (this is the default value).
12474 ============== =======================================
12476 Note that this method does not trigger relayout.
12479 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12481 def GetFlexibleDirection(*args
, **kwargs
):
12483 GetFlexibleDirection(self) -> int
12485 Returns a value that specifies whether the sizer
12486 flexibly resizes its columns, rows, or both (default).
12488 :see: `SetFlexibleDirection`
12490 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12492 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12494 SetNonFlexibleGrowMode(self, int mode)
12496 Specifies how the sizer should grow in the non-flexible direction if
12497 there is one (so `SetFlexibleDirection` must have been called
12498 previously). Argument *mode* can be one of the following values:
12500 ========================== =================================================
12501 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12502 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12503 `AddGrowableCol` and `AddGrowableRow`. In this
12504 case equal sizing applies to minimum sizes of
12505 columns or rows (this is the default value).
12506 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12507 the non flexible direction, whether they are
12508 growable or not in the flexbile direction.
12509 ========================== =================================================
12511 Note that this method does not trigger relayout.
12513 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12515 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12517 GetNonFlexibleGrowMode(self) -> int
12519 Returns the value that specifies how the sizer grows in the
12520 non-flexible direction if there is one.
12522 :see: `SetNonFlexibleGrowMode`
12524 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12526 def GetRowHeights(*args
, **kwargs
):
12528 GetRowHeights(self) -> list
12530 Returns a list of integers representing the heights of each of the
12533 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12535 def GetColWidths(*args
, **kwargs
):
12537 GetColWidths(self) -> list
12539 Returns a list of integers representing the widths of each of the
12540 columns in the sizer.
12542 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12544 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12545 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12546 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12547 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12548 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12550 class StdDialogButtonSizer(BoxSizer
):
12552 A special sizer that knows how to order and position standard buttons
12553 in order to conform to the current platform's standards. You simply
12554 need to add each `wx.Button` to the sizer, and be sure to create the
12555 buttons using the standard ID's. Then call `Realize` and the sizer
12556 will take care of the rest.
12559 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12560 __repr__
= _swig_repr
12561 def __init__(self
, *args
, **kwargs
):
12562 """__init__(self) -> StdDialogButtonSizer"""
12563 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12564 def AddButton(*args
, **kwargs
):
12566 AddButton(self, wxButton button)
12568 Use this to add the buttons to this sizer. Do not use the `Add`
12569 method in the base class.
12571 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12573 def Realize(*args
, **kwargs
):
12577 This funciton needs to be called after all the buttons have been added
12578 to the sizer. It will reorder them and position them in a platform
12581 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12583 def SetAffirmativeButton(*args
, **kwargs
):
12584 """SetAffirmativeButton(self, wxButton button)"""
12585 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12587 def SetNegativeButton(*args
, **kwargs
):
12588 """SetNegativeButton(self, wxButton button)"""
12589 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12591 def SetCancelButton(*args
, **kwargs
):
12592 """SetCancelButton(self, wxButton button)"""
12593 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12595 def GetAffirmativeButton(*args
, **kwargs
):
12596 """GetAffirmativeButton(self) -> wxButton"""
12597 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12599 def GetApplyButton(*args
, **kwargs
):
12600 """GetApplyButton(self) -> wxButton"""
12601 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12603 def GetNegativeButton(*args
, **kwargs
):
12604 """GetNegativeButton(self) -> wxButton"""
12605 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12607 def GetCancelButton(*args
, **kwargs
):
12608 """GetCancelButton(self) -> wxButton"""
12609 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12611 def GetHelpButton(*args
, **kwargs
):
12612 """GetHelpButton(self) -> wxButton"""
12613 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12615 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12616 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12617 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12618 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12619 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12620 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12622 #---------------------------------------------------------------------------
12624 class GBPosition(object):
12626 This class represents the position of an item in a virtual grid of
12627 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12628 typemaps that will automatically convert from a 2-element sequence of
12629 integers to a wx.GBPosition, so you can use the more pythonic
12630 representation of the position nearly transparently in Python code.
12632 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12633 __repr__
= _swig_repr
12634 def __init__(self
, *args
, **kwargs
):
12636 __init__(self, int row=0, int col=0) -> GBPosition
12638 This class represents the position of an item in a virtual grid of
12639 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12640 typemaps that will automatically convert from a 2-element sequence of
12641 integers to a wx.GBPosition, so you can use the more pythonic
12642 representation of the position nearly transparently in Python code.
12644 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12645 __swig_destroy__
= _core_
.delete_GBPosition
12646 __del__
= lambda self
: None;
12647 def GetRow(*args
, **kwargs
):
12648 """GetRow(self) -> int"""
12649 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12651 def GetCol(*args
, **kwargs
):
12652 """GetCol(self) -> int"""
12653 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12655 def SetRow(*args
, **kwargs
):
12656 """SetRow(self, int row)"""
12657 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12659 def SetCol(*args
, **kwargs
):
12660 """SetCol(self, int col)"""
12661 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12663 def __eq__(*args
, **kwargs
):
12665 __eq__(self, PyObject other) -> bool
12667 Compare GBPosition for equality.
12669 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12671 def __ne__(*args
, **kwargs
):
12673 __ne__(self, PyObject other) -> bool
12675 Compare GBPosition for inequality.
12677 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12679 def Set(*args
, **kwargs
):
12680 """Set(self, int row=0, int col=0)"""
12681 return _core_
.GBPosition_Set(*args
, **kwargs
)
12683 def Get(*args
, **kwargs
):
12684 """Get(self) -> PyObject"""
12685 return _core_
.GBPosition_Get(*args
, **kwargs
)
12687 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12688 def __str__(self
): return str(self
.Get())
12689 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12690 def __len__(self
): return len(self
.Get())
12691 def __getitem__(self
, index
): return self
.Get()[index
]
12692 def __setitem__(self
, index
, val
):
12693 if index
== 0: self
.SetRow(val
)
12694 elif index
== 1: self
.SetCol(val
)
12695 else: raise IndexError
12696 def __nonzero__(self
): return self
.Get() != (0,0)
12697 __safe_for_unpickling__
= True
12698 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12700 row
= property(GetRow
, SetRow
)
12701 col
= property(GetCol
, SetCol
)
12703 _core_
.GBPosition_swigregister(GBPosition
)
12705 class GBSpan(object):
12707 This class is used to hold the row and column spanning attributes of
12708 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12709 automatically convert from a 2-element sequence of integers to a
12710 wx.GBSpan, so you can use the more pythonic representation of the span
12711 nearly transparently in Python code.
12714 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12715 __repr__
= _swig_repr
12716 def __init__(self
, *args
, **kwargs
):
12718 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12720 Construct a new wxGBSpan, optionally setting the rowspan and
12721 colspan. The default is (1,1). (Meaning that the item occupies one
12722 cell in each direction.
12724 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12725 __swig_destroy__
= _core_
.delete_GBSpan
12726 __del__
= lambda self
: None;
12727 def GetRowspan(*args
, **kwargs
):
12728 """GetRowspan(self) -> int"""
12729 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12731 def GetColspan(*args
, **kwargs
):
12732 """GetColspan(self) -> int"""
12733 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12735 def SetRowspan(*args
, **kwargs
):
12736 """SetRowspan(self, int rowspan)"""
12737 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12739 def SetColspan(*args
, **kwargs
):
12740 """SetColspan(self, int colspan)"""
12741 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12743 def __eq__(*args
, **kwargs
):
12745 __eq__(self, PyObject other) -> bool
12747 Compare wxGBSpan for equality.
12749 return _core_
.GBSpan___eq__(*args
, **kwargs
)
12751 def __ne__(*args
, **kwargs
):
12753 __ne__(self, PyObject other) -> bool
12755 Compare GBSpan for inequality.
12757 return _core_
.GBSpan___ne__(*args
, **kwargs
)
12759 def Set(*args
, **kwargs
):
12760 """Set(self, int rowspan=1, int colspan=1)"""
12761 return _core_
.GBSpan_Set(*args
, **kwargs
)
12763 def Get(*args
, **kwargs
):
12764 """Get(self) -> PyObject"""
12765 return _core_
.GBSpan_Get(*args
, **kwargs
)
12767 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12768 def __str__(self
): return str(self
.Get())
12769 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
12770 def __len__(self
): return len(self
.Get())
12771 def __getitem__(self
, index
): return self
.Get()[index
]
12772 def __setitem__(self
, index
, val
):
12773 if index
== 0: self
.SetRowspan(val
)
12774 elif index
== 1: self
.SetColspan(val
)
12775 else: raise IndexError
12776 def __nonzero__(self
): return self
.Get() != (0,0)
12777 __safe_for_unpickling__
= True
12778 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
12780 rowspan
= property(GetRowspan
, SetRowspan
)
12781 colspan
= property(GetColspan
, SetColspan
)
12783 _core_
.GBSpan_swigregister(GBSpan
)
12785 class GBSizerItem(SizerItem
):
12787 The wx.GBSizerItem class is used to track the additional data about
12788 items in a `wx.GridBagSizer` such as the item's position in the grid
12789 and how many rows or columns it spans.
12792 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12793 __repr__
= _swig_repr
12794 def __init__(self
, *args
, **kwargs
):
12796 __init__(self) -> GBSizerItem
12798 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12799 size will need to be set, as well as a position and span before this
12800 item can be used in a Sizer.
12802 You will probably never need to create a wx.GBSizerItem directly as they
12803 are created automatically when the sizer's Add method is called.
12805 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
12806 __swig_destroy__
= _core_
.delete_GBSizerItem
12807 __del__
= lambda self
: None;
12808 def GetPos(*args
, **kwargs
):
12810 GetPos(self) -> GBPosition
12812 Get the grid position of the item
12814 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
12816 def GetPosTuple(self
): return self
.GetPos().Get()
12817 def GetSpan(*args
, **kwargs
):
12819 GetSpan(self) -> GBSpan
12821 Get the row and column spanning of the item
12823 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
12825 def GetSpanTuple(self
): return self
.GetSpan().Get()
12826 def SetPos(*args
, **kwargs
):
12828 SetPos(self, GBPosition pos) -> bool
12830 If the item is already a member of a sizer then first ensure that
12831 there is no other item that would intersect with this one at the new
12832 position, then set the new position. Returns True if the change is
12833 successful and after the next Layout() the item will be moved.
12835 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
12837 def SetSpan(*args
, **kwargs
):
12839 SetSpan(self, GBSpan span) -> bool
12841 If the item is already a member of a sizer then first ensure that
12842 there is no other item that would intersect with this one with its new
12843 spanning size, then set the new spanning. Returns True if the change
12844 is successful and after the next Layout() the item will be resized.
12847 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
12849 def Intersects(*args
, **kwargs
):
12851 Intersects(self, GBSizerItem other) -> bool
12853 Returns True if this item and the other item instersect.
12855 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
12857 def IntersectsPos(*args
, **kwargs
):
12859 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12861 Returns True if the given pos/span would intersect with this item.
12863 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
12865 def GetEndPos(*args
, **kwargs
):
12867 GetEndPos(self) -> GBPosition
12869 Get the row and column of the endpoint of this item.
12871 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
12873 def GetGBSizer(*args
, **kwargs
):
12875 GetGBSizer(self) -> GridBagSizer
12877 Get the sizer this item is a member of.
12879 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
12881 def SetGBSizer(*args
, **kwargs
):
12883 SetGBSizer(self, GridBagSizer sizer)
12885 Set the sizer this item is a member of.
12887 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
12889 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
12890 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
12891 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
12892 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
12893 _core_
.GBSizerItem_swigregister(GBSizerItem
)
12894 DefaultSpan
= cvar
.DefaultSpan
12896 def GBSizerItemWindow(*args
, **kwargs
):
12898 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12899 int border, PyObject userData=None) -> GBSizerItem
12901 Construct a `wx.GBSizerItem` for a window.
12903 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
12906 def GBSizerItemSizer(*args
, **kwargs
):
12908 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12909 int border, PyObject userData=None) -> GBSizerItem
12911 Construct a `wx.GBSizerItem` for a sizer
12913 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
12916 def GBSizerItemSpacer(*args
, **kwargs
):
12918 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12919 int flag, int border, PyObject userData=None) -> GBSizerItem
12921 Construct a `wx.GBSizerItem` for a spacer.
12923 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
12926 class GridBagSizer(FlexGridSizer
):
12928 A `wx.Sizer` that can lay out items in a virtual grid like a
12929 `wx.FlexGridSizer` but in this case explicit positioning of the items
12930 is allowed using `wx.GBPosition`, and items can optionally span more
12931 than one row and/or column using `wx.GBSpan`. The total size of the
12932 virtual grid is determined by the largest row and column that items are
12933 positioned at, adjusted for spanning.
12936 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12937 __repr__
= _swig_repr
12938 def __init__(self
, *args
, **kwargs
):
12940 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12942 Constructor, with optional parameters to specify the gap between the
12945 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
12946 self
._setOORInfo
(self
)
12948 def Add(*args
, **kwargs
):
12950 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12951 int border=0, userData=None) -> wx.GBSizerItem
12953 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12954 more than one row or column as specified with *span*. The remaining
12955 args behave similarly to `wx.Sizer.Add`.
12957 Returns True if the item was successfully placed at the given cell
12958 position, False if something was already there.
12961 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
12963 def AddItem(*args
, **kwargs
):
12965 Add(self, GBSizerItem item) -> wx.GBSizerItem
12967 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12968 the item was successfully placed at its given cell position, False if
12969 something was already there.
12971 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
12973 def GetCellSize(*args
, **kwargs
):
12975 GetCellSize(self, int row, int col) -> Size
12977 Get the size of the specified cell, including hgap and
12978 vgap. Only valid after a Layout.
12980 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
12982 def GetEmptyCellSize(*args
, **kwargs
):
12984 GetEmptyCellSize(self) -> Size
12986 Get the size used for cells in the grid with no item.
12988 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
12990 def SetEmptyCellSize(*args
, **kwargs
):
12992 SetEmptyCellSize(self, Size sz)
12994 Set the size used for cells in the grid with no item.
12996 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
12998 def GetItemPosition(*args
):
13000 GetItemPosition(self, item) -> GBPosition
13002 Get the grid position of the specified *item* where *item* is either a
13003 window or subsizer that is a member of this sizer, or a zero-based
13006 return _core_
.GridBagSizer_GetItemPosition(*args
)
13008 def SetItemPosition(*args
):
13010 SetItemPosition(self, item, GBPosition pos) -> bool
13012 Set the grid position of the specified *item* where *item* is either a
13013 window or subsizer that is a member of this sizer, or a zero-based
13014 index of an item. Returns True on success. If the move is not
13015 allowed (because an item is already there) then False is returned.
13018 return _core_
.GridBagSizer_SetItemPosition(*args
)
13020 def GetItemSpan(*args
):
13022 GetItemSpan(self, item) -> GBSpan
13024 Get the row/col spanning of the specified *item* where *item* is
13025 either a window or subsizer that is a member of this sizer, or a
13026 zero-based index of an item.
13028 return _core_
.GridBagSizer_GetItemSpan(*args
)
13030 def SetItemSpan(*args
):
13032 SetItemSpan(self, item, GBSpan span) -> bool
13034 Set the row/col spanning of the specified *item* where *item* is
13035 either a window or subsizer that is a member of this sizer, or a
13036 zero-based index of an item. Returns True on success. If the move is
13037 not allowed (because an item is already there) then False is returned.
13039 return _core_
.GridBagSizer_SetItemSpan(*args
)
13041 def FindItem(*args
):
13043 FindItem(self, item) -> GBSizerItem
13045 Find the sizer item for the given window or subsizer, returns None if
13046 not found. (non-recursive)
13048 return _core_
.GridBagSizer_FindItem(*args
)
13050 def FindItemAtPosition(*args
, **kwargs
):
13052 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13054 Return the sizer item for the given grid cell, or None if there is no
13055 item at that position. (non-recursive)
13057 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13059 def FindItemAtPoint(*args
, **kwargs
):
13061 FindItemAtPoint(self, Point pt) -> GBSizerItem
13063 Return the sizer item located at the point given in *pt*, or None if
13064 there is no item at that point. The (x,y) coordinates in pt correspond
13065 to the client coordinates of the window using the sizer for
13066 layout. (non-recursive)
13068 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13070 def CheckForIntersection(*args
, **kwargs
):
13072 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13074 Look at all items and see if any intersect (or would overlap) the
13075 given *item*. Returns True if so, False if there would be no overlap.
13076 If an *excludeItem* is given then it will not be checked for
13077 intersection, for example it may be the item we are checking the
13081 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13083 def CheckForIntersectionPos(*args
, **kwargs
):
13085 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13087 Look at all items and see if any intersect (or would overlap) the
13088 given position and span. Returns True if so, False if there would be
13089 no overlap. If an *excludeItem* is given then it will not be checked
13090 for intersection, for example it may be the item we are checking the
13093 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13095 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13097 #---------------------------------------------------------------------------
13101 Right
= _core_
.Right
13102 Bottom
= _core_
.Bottom
13103 Width
= _core_
.Width
13104 Height
= _core_
.Height
13105 Centre
= _core_
.Centre
13106 Center
= _core_
.Center
13107 CentreX
= _core_
.CentreX
13108 CentreY
= _core_
.CentreY
13109 Unconstrained
= _core_
.Unconstrained
13111 PercentOf
= _core_
.PercentOf
13112 Above
= _core_
.Above
13113 Below
= _core_
.Below
13114 LeftOf
= _core_
.LeftOf
13115 RightOf
= _core_
.RightOf
13116 SameAs
= _core_
.SameAs
13117 Absolute
= _core_
.Absolute
13118 class IndividualLayoutConstraint(Object
):
13120 Objects of this class are stored in the `wx.LayoutConstraints` class as
13121 one of eight possible constraints that a window can be involved in.
13122 You will never need to create an instance of
13123 wx.IndividualLayoutConstraint, rather you should create a
13124 `wx.LayoutConstraints` instance and use the individual contstraints
13127 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13128 def __init__(self
): raise AttributeError, "No constructor defined"
13129 __repr__
= _swig_repr
13130 def Set(*args
, **kwargs
):
13132 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13134 Sets the properties of the constraint. Normally called by one of the
13135 convenience functions such as Above, RightOf, SameAs.
13137 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13139 def LeftOf(*args
, **kwargs
):
13141 LeftOf(self, Window sibling, int marg=0)
13143 Constrains this edge to be to the left of the given window, with an
13144 optional margin. Implicitly, this is relative to the left edge of the
13147 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13149 def RightOf(*args
, **kwargs
):
13151 RightOf(self, Window sibling, int marg=0)
13153 Constrains this edge to be to the right of the given window, with an
13154 optional margin. Implicitly, this is relative to the right edge of the
13157 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13159 def Above(*args
, **kwargs
):
13161 Above(self, Window sibling, int marg=0)
13163 Constrains this edge to be above the given window, with an optional
13164 margin. Implicitly, this is relative to the top edge of the other
13167 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13169 def Below(*args
, **kwargs
):
13171 Below(self, Window sibling, int marg=0)
13173 Constrains this edge to be below the given window, with an optional
13174 margin. Implicitly, this is relative to the bottom edge of the other
13177 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13179 def SameAs(*args
, **kwargs
):
13181 SameAs(self, Window otherW, int edge, int marg=0)
13183 Constrains this edge or dimension to be to the same as the edge of the
13184 given window, with an optional margin.
13186 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13188 def PercentOf(*args
, **kwargs
):
13190 PercentOf(self, Window otherW, int wh, int per)
13192 Constrains this edge or dimension to be to a percentage of the given
13193 window, with an optional margin.
13195 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13197 def Absolute(*args
, **kwargs
):
13199 Absolute(self, int val)
13201 Constrains this edge or dimension to be the given absolute value.
13203 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13205 def Unconstrained(*args
, **kwargs
):
13207 Unconstrained(self)
13209 Sets this edge or dimension to be unconstrained, that is, dependent on
13210 other edges and dimensions from which this value can be deduced.
13212 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13214 def AsIs(*args
, **kwargs
):
13218 Sets this edge or constraint to be whatever the window's value is at
13219 the moment. If either of the width and height constraints are *as is*,
13220 the window will not be resized, but moved instead. This is important
13221 when considering panel items which are intended to have a default
13222 size, such as a button, which may take its size from the size of the
13225 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13227 def GetOtherWindow(*args
, **kwargs
):
13228 """GetOtherWindow(self) -> Window"""
13229 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13231 def GetMyEdge(*args
, **kwargs
):
13232 """GetMyEdge(self) -> int"""
13233 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13235 def SetEdge(*args
, **kwargs
):
13236 """SetEdge(self, int which)"""
13237 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13239 def SetValue(*args
, **kwargs
):
13240 """SetValue(self, int v)"""
13241 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13243 def GetMargin(*args
, **kwargs
):
13244 """GetMargin(self) -> int"""
13245 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13247 def SetMargin(*args
, **kwargs
):
13248 """SetMargin(self, int m)"""
13249 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13251 def GetValue(*args
, **kwargs
):
13252 """GetValue(self) -> int"""
13253 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13255 def GetPercent(*args
, **kwargs
):
13256 """GetPercent(self) -> int"""
13257 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13259 def GetOtherEdge(*args
, **kwargs
):
13260 """GetOtherEdge(self) -> int"""
13261 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13263 def GetDone(*args
, **kwargs
):
13264 """GetDone(self) -> bool"""
13265 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13267 def SetDone(*args
, **kwargs
):
13268 """SetDone(self, bool d)"""
13269 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13271 def GetRelationship(*args
, **kwargs
):
13272 """GetRelationship(self) -> int"""
13273 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13275 def SetRelationship(*args
, **kwargs
):
13276 """SetRelationship(self, int r)"""
13277 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13279 def ResetIfWin(*args
, **kwargs
):
13281 ResetIfWin(self, Window otherW) -> bool
13283 Reset constraint if it mentions otherWin
13285 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13287 def SatisfyConstraint(*args
, **kwargs
):
13289 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13291 Try to satisfy constraint
13293 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13295 def GetEdge(*args
, **kwargs
):
13297 GetEdge(self, int which, Window thisWin, Window other) -> int
13299 Get the value of this edge or dimension, or if this
13300 is not determinable, -1.
13302 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13304 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13305 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13306 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13307 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13308 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13309 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13310 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13311 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13312 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13314 class LayoutConstraints(Object
):
13316 **Note:** constraints are now deprecated and you should use sizers
13319 Objects of this class can be associated with a window to define its
13320 layout constraints, with respect to siblings or its parent.
13322 The class consists of the following eight constraints of class
13323 wx.IndividualLayoutConstraint, some or all of which should be accessed
13324 directly to set the appropriate constraints.
13326 * left: represents the left hand edge of the window
13327 * right: represents the right hand edge of the window
13328 * top: represents the top edge of the window
13329 * bottom: represents the bottom edge of the window
13330 * width: represents the width of the window
13331 * height: represents the height of the window
13332 * centreX: represents the horizontal centre point of the window
13333 * centreY: represents the vertical centre point of the window
13335 Most constraints are initially set to have the relationship
13336 wxUnconstrained, which means that their values should be calculated by
13337 looking at known constraints. The exceptions are width and height,
13338 which are set to wxAsIs to ensure that if the user does not specify a
13339 constraint, the existing width and height will be used, to be
13340 compatible with panel items which often have take a default size. If
13341 the constraint is ``wx.AsIs``, the dimension will not be changed.
13343 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13346 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13347 __repr__
= _swig_repr
13348 left
= property(_core_
.LayoutConstraints_left_get
)
13349 top
= property(_core_
.LayoutConstraints_top_get
)
13350 right
= property(_core_
.LayoutConstraints_right_get
)
13351 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13352 width
= property(_core_
.LayoutConstraints_width_get
)
13353 height
= property(_core_
.LayoutConstraints_height_get
)
13354 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13355 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13356 def __init__(self
, *args
, **kwargs
):
13357 """__init__(self) -> LayoutConstraints"""
13358 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13359 __swig_destroy__
= _core_
.delete_LayoutConstraints
13360 __del__
= lambda self
: None;
13361 def SatisfyConstraints(*args
, **kwargs
):
13362 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13363 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13365 def AreSatisfied(*args
, **kwargs
):
13366 """AreSatisfied(self) -> bool"""
13367 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13369 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13371 #----------------------------------------------------------------------------
13373 # Use Python's bool constants if available, make some if not
13377 __builtins__
.True = 1==1
13378 __builtins__
.False = 1==0
13379 def bool(value
): return not not value
13380 __builtins__
.bool = bool
13384 # workarounds for bad wxRTTI names
13385 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13386 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13387 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13390 #----------------------------------------------------------------------------
13391 # Load version numbers from __version__... Ensure that major and minor
13392 # versions are the same for both wxPython and wxWidgets.
13394 from __version__
import *
13395 __version__
= VERSION_STRING
13397 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13398 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13399 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13401 warnings
.warn("wxPython/wxWidgets release number mismatch")
13403 #----------------------------------------------------------------------------
13405 # Set wxPython's default string<-->unicode conversion encoding from
13406 # the locale, but only if Python's default hasn't been changed. (We
13407 # assume that if the user has customized it already then that is the
13408 # encoding we need to use as well.)
13410 # The encoding selected here is used when string or unicode objects
13411 # need to be converted in order to pass them to wxWidgets. Please be
13412 # aware that the default encoding within the same locale may be
13413 # slightly different on different platforms. For example, please see
13414 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13415 # between the common latin/roman encodings.
13417 default
= _sys
.getdefaultencoding()
13418 if default
== 'ascii':
13422 default
= locale
.getdefaultlocale()[1]
13423 codecs
.lookup(default
)
13424 except (ValueError, LookupError, TypeError):
13425 default
= _sys
.getdefaultencoding()
13429 wx
.SetDefaultPyEncoding(default
)
13432 #----------------------------------------------------------------------------
13434 class PyDeadObjectError(AttributeError):
13437 class _wxPyDeadObject(object):
13439 Instances of wx objects that are OOR capable will have their __class__
13440 changed to this class when the C++ object is deleted. This should help
13441 prevent crashes due to referencing a bogus C++ pointer.
13443 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13444 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13446 def __repr__(self
):
13447 if not hasattr(self
, "_name"):
13448 self
._name
= "[unknown]"
13449 return self
.reprStr
% self
._name
13451 def __getattr__(self
, *args
):
13452 if not hasattr(self
, "_name"):
13453 self
._name
= "[unknown]"
13454 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13456 def __nonzero__(self
):
13461 class PyUnbornObjectError(AttributeError):
13464 class _wxPyUnbornObject(object):
13466 Some stock objects are created when the wx._core module is
13467 imported, but their C++ instance is not created until the wx.App
13468 object is created and initialized. These object instances will
13469 temporarily have their __class__ changed to this class so an
13470 exception will be raised if they are used before the C++ instance
13474 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13475 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13477 def __repr__(self
):
13478 #if not hasattr(self, "_name"):
13479 # self._name = "[unknown]"
13480 return self
.reprStr
#% self._name
13482 def __getattr__(self
, *args
):
13483 #if not hasattr(self, "_name"):
13484 # self._name = "[unknown]"
13485 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13487 def __nonzero__(self
):
13491 #----------------------------------------------------------------------------
13493 def CallAfter(callable, *args
, **kw
):
13495 Call the specified function after the current and pending event
13496 handlers have been completed. This is also good for making GUI
13497 method calls from non-GUI threads. Any extra positional or
13498 keyword args are passed on to the callable when it is called.
13500 :see: `wx.CallLater`
13503 assert app
is not None, 'No wx.App created yet'
13505 if not hasattr(app
, "_CallAfterId"):
13506 app
._CallAfterId
= wx
.NewEventType()
13507 app
.Connect(-1, -1, app
._CallAfterId
,
13508 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13510 evt
.SetEventType(app
._CallAfterId
)
13511 evt
.callable = callable
13514 wx
.PostEvent(app
, evt
)
13516 #----------------------------------------------------------------------------
13521 A convenience class for `wx.Timer`, that calls the given callable
13522 object once after the given amount of milliseconds, passing any
13523 positional or keyword args. The return value of the callable is
13524 availbale after it has been run with the `GetResult` method.
13526 If you don't need to get the return value or restart the timer
13527 then there is no need to hold a reference to this object. It will
13528 hold a reference to itself while the timer is running (the timer
13529 has a reference to self.Notify) but the cycle will be broken when
13530 the timer completes, automatically cleaning up the wx.CallLater
13533 :see: `wx.CallAfter`
13535 def __init__(self
, millis
, callable, *args
, **kwargs
):
13536 self
.millis
= millis
13537 self
.callable = callable
13538 self
.SetArgs(*args
, **kwargs
)
13540 self
.running
= False
13541 self
.hasRun
= False
13550 def Start(self
, millis
=None, *args
, **kwargs
):
13552 (Re)start the timer
13554 self
.hasRun
= False
13555 if millis
is not None:
13556 self
.millis
= millis
13558 self
.SetArgs(*args
, **kwargs
)
13560 self
.timer
= wx
.PyTimer(self
.Notify
)
13561 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13562 self
.running
= True
13568 Stop and destroy the timer.
13570 if self
.timer
is not None:
13575 def GetInterval(self
):
13576 if self
.timer
is not None:
13577 return self
.timer
.GetInterval()
13582 def IsRunning(self
):
13583 return self
.timer
is not None and self
.timer
.IsRunning()
13586 def SetArgs(self
, *args
, **kwargs
):
13588 (Re)set the args passed to the callable object. This is
13589 useful in conjunction with Restart if you want to schedule a
13590 new call to the same callable object but with different
13594 self
.kwargs
= kwargs
13600 def GetResult(self
):
13605 The timer has expired so call the callable.
13607 if self
.callable and getattr(self
.callable, 'im_self', True):
13609 self
.running
= False
13610 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13612 if not self
.running
:
13613 # if it wasn't restarted, then cleanup
13614 wx
.CallAfter(self
.Stop
)
13616 Interval
= property(GetInterval
)
13617 Result
= property(GetResult
)
13620 class FutureCall(CallLater
):
13621 """A compatibility alias for `CallLater`."""
13623 #----------------------------------------------------------------------------
13624 # Control which items in this module should be documented by epydoc.
13625 # We allow only classes and functions, which will help reduce the size
13626 # of the docs by filtering out the zillions of constants, EVT objects,
13627 # and etc that don't make much sense by themselves, but are instead
13628 # documented (or will be) as part of the classes/functions/methods
13629 # where they should be used.
13633 A filter for epydoc that only allows non-Ptr classes and
13634 functions, in order to reduce the clutter in the API docs.
13636 def __init__(self
, globals):
13637 self
._globals
= globals
13639 def __call__(self
, name
):
13641 obj
= self
._globals
.get(name
, None)
13643 # only document classes and function
13644 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13647 # skip other things that are private or will be documented as part of somethign else
13648 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13651 # skip functions that are duplicates of static functions in a class
13652 if name
.find('_') != -1:
13653 cls
= self
._globals
.get(name
.split('_')[0], None)
13654 methname
= name
.split('_')[1]
13655 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13660 #----------------------------------------------------------------------------
13661 #----------------------------------------------------------------------------
13663 # Import other modules in this package that should show up in the
13664 # "core" wx namespace
13666 from _windows
import *
13667 from _controls
import *
13668 from _misc
import *
13670 #----------------------------------------------------------------------------
13671 #----------------------------------------------------------------------------