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 Inside
= _core_
.Inside
1653 OutLeft
= _core_
.OutLeft
1654 OutRight
= _core_
.OutRight
1655 OutTop
= _core_
.OutTop
1656 OutBottom
= _core_
.OutBottom
1657 class Rect2D(object):
1659 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1660 with floating point component values.
1662 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1663 __repr__
= _swig_repr
1664 def __init__(self
, *args
, **kwargs
):
1666 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1668 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1669 with floating point component values.
1671 _core_
.Rect2D_swiginit(self
,_core_
.new_Rect2D(*args
, **kwargs
))
1672 __swig_destroy__
= _core_
.delete_Rect2D
1673 __del__
= lambda self
: None;
1674 def GetPosition(*args
, **kwargs
):
1675 """GetPosition(self) -> Point2D"""
1676 return _core_
.Rect2D_GetPosition(*args
, **kwargs
)
1678 def GetSize(*args
, **kwargs
):
1679 """GetSize(self) -> Size"""
1680 return _core_
.Rect2D_GetSize(*args
, **kwargs
)
1682 def GetLeft(*args
, **kwargs
):
1683 """GetLeft(self) -> wxDouble"""
1684 return _core_
.Rect2D_GetLeft(*args
, **kwargs
)
1686 def SetLeft(*args
, **kwargs
):
1687 """SetLeft(self, wxDouble n)"""
1688 return _core_
.Rect2D_SetLeft(*args
, **kwargs
)
1690 def MoveLeftTo(*args
, **kwargs
):
1691 """MoveLeftTo(self, wxDouble n)"""
1692 return _core_
.Rect2D_MoveLeftTo(*args
, **kwargs
)
1694 def GetTop(*args
, **kwargs
):
1695 """GetTop(self) -> wxDouble"""
1696 return _core_
.Rect2D_GetTop(*args
, **kwargs
)
1698 def SetTop(*args
, **kwargs
):
1699 """SetTop(self, wxDouble n)"""
1700 return _core_
.Rect2D_SetTop(*args
, **kwargs
)
1702 def MoveTopTo(*args
, **kwargs
):
1703 """MoveTopTo(self, wxDouble n)"""
1704 return _core_
.Rect2D_MoveTopTo(*args
, **kwargs
)
1706 def GetBottom(*args
, **kwargs
):
1707 """GetBottom(self) -> wxDouble"""
1708 return _core_
.Rect2D_GetBottom(*args
, **kwargs
)
1710 def SetBottom(*args
, **kwargs
):
1711 """SetBottom(self, wxDouble n)"""
1712 return _core_
.Rect2D_SetBottom(*args
, **kwargs
)
1714 def MoveBottomTo(*args
, **kwargs
):
1715 """MoveBottomTo(self, wxDouble n)"""
1716 return _core_
.Rect2D_MoveBottomTo(*args
, **kwargs
)
1718 def GetRight(*args
, **kwargs
):
1719 """GetRight(self) -> wxDouble"""
1720 return _core_
.Rect2D_GetRight(*args
, **kwargs
)
1722 def SetRight(*args
, **kwargs
):
1723 """SetRight(self, wxDouble n)"""
1724 return _core_
.Rect2D_SetRight(*args
, **kwargs
)
1726 def MoveRightTo(*args
, **kwargs
):
1727 """MoveRightTo(self, wxDouble n)"""
1728 return _core_
.Rect2D_MoveRightTo(*args
, **kwargs
)
1730 def GetLeftTop(*args
, **kwargs
):
1731 """GetLeftTop(self) -> Point2D"""
1732 return _core_
.Rect2D_GetLeftTop(*args
, **kwargs
)
1734 def SetLeftTop(*args
, **kwargs
):
1735 """SetLeftTop(self, Point2D pt)"""
1736 return _core_
.Rect2D_SetLeftTop(*args
, **kwargs
)
1738 def MoveLeftTopTo(*args
, **kwargs
):
1739 """MoveLeftTopTo(self, Point2D pt)"""
1740 return _core_
.Rect2D_MoveLeftTopTo(*args
, **kwargs
)
1742 def GetLeftBottom(*args
, **kwargs
):
1743 """GetLeftBottom(self) -> Point2D"""
1744 return _core_
.Rect2D_GetLeftBottom(*args
, **kwargs
)
1746 def SetLeftBottom(*args
, **kwargs
):
1747 """SetLeftBottom(self, Point2D pt)"""
1748 return _core_
.Rect2D_SetLeftBottom(*args
, **kwargs
)
1750 def MoveLeftBottomTo(*args
, **kwargs
):
1751 """MoveLeftBottomTo(self, Point2D pt)"""
1752 return _core_
.Rect2D_MoveLeftBottomTo(*args
, **kwargs
)
1754 def GetRightTop(*args
, **kwargs
):
1755 """GetRightTop(self) -> Point2D"""
1756 return _core_
.Rect2D_GetRightTop(*args
, **kwargs
)
1758 def SetRightTop(*args
, **kwargs
):
1759 """SetRightTop(self, Point2D pt)"""
1760 return _core_
.Rect2D_SetRightTop(*args
, **kwargs
)
1762 def MoveRightTopTo(*args
, **kwargs
):
1763 """MoveRightTopTo(self, Point2D pt)"""
1764 return _core_
.Rect2D_MoveRightTopTo(*args
, **kwargs
)
1766 def GetRightBottom(*args
, **kwargs
):
1767 """GetRightBottom(self) -> Point2D"""
1768 return _core_
.Rect2D_GetRightBottom(*args
, **kwargs
)
1770 def SetRightBottom(*args
, **kwargs
):
1771 """SetRightBottom(self, Point2D pt)"""
1772 return _core_
.Rect2D_SetRightBottom(*args
, **kwargs
)
1774 def MoveRightBottomTo(*args
, **kwargs
):
1775 """MoveRightBottomTo(self, Point2D pt)"""
1776 return _core_
.Rect2D_MoveRightBottomTo(*args
, **kwargs
)
1778 def GetCentre(*args
, **kwargs
):
1779 """GetCentre(self) -> Point2D"""
1780 return _core_
.Rect2D_GetCentre(*args
, **kwargs
)
1782 def SetCentre(*args
, **kwargs
):
1783 """SetCentre(self, Point2D pt)"""
1784 return _core_
.Rect2D_SetCentre(*args
, **kwargs
)
1786 def MoveCentreTo(*args
, **kwargs
):
1787 """MoveCentreTo(self, Point2D pt)"""
1788 return _core_
.Rect2D_MoveCentreTo(*args
, **kwargs
)
1790 def GetOutcode(*args
, **kwargs
):
1791 """GetOutcode(self, Point2D pt) -> int"""
1792 return _core_
.Rect2D_GetOutcode(*args
, **kwargs
)
1794 def Contains(*args
, **kwargs
):
1795 """Contains(self, Point2D pt) -> bool"""
1796 return _core_
.Rect2D_Contains(*args
, **kwargs
)
1798 def ContainsRect(*args
, **kwargs
):
1799 """ContainsRect(self, Rect2D rect) -> bool"""
1800 return _core_
.Rect2D_ContainsRect(*args
, **kwargs
)
1802 def IsEmpty(*args
, **kwargs
):
1803 """IsEmpty(self) -> bool"""
1804 return _core_
.Rect2D_IsEmpty(*args
, **kwargs
)
1806 def HaveEqualSize(*args
, **kwargs
):
1807 """HaveEqualSize(self, Rect2D rect) -> bool"""
1808 return _core_
.Rect2D_HaveEqualSize(*args
, **kwargs
)
1812 Inset(self, wxDouble x, wxDouble y)
1813 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1815 return _core_
.Rect2D_Inset(*args
)
1817 def Offset(*args
, **kwargs
):
1818 """Offset(self, Point2D pt)"""
1819 return _core_
.Rect2D_Offset(*args
, **kwargs
)
1821 def ConstrainTo(*args
, **kwargs
):
1822 """ConstrainTo(self, Rect2D rect)"""
1823 return _core_
.Rect2D_ConstrainTo(*args
, **kwargs
)
1825 def Interpolate(*args
, **kwargs
):
1826 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1827 return _core_
.Rect2D_Interpolate(*args
, **kwargs
)
1829 def Intersect(*args
, **kwargs
):
1830 """Intersect(self, Rect2D otherRect)"""
1831 return _core_
.Rect2D_Intersect(*args
, **kwargs
)
1833 def CreateIntersection(*args
, **kwargs
):
1834 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1835 return _core_
.Rect2D_CreateIntersection(*args
, **kwargs
)
1837 def Intersects(*args
, **kwargs
):
1838 """Intersects(self, Rect2D rect) -> bool"""
1839 return _core_
.Rect2D_Intersects(*args
, **kwargs
)
1841 def Union(*args
, **kwargs
):
1842 """Union(self, Rect2D otherRect)"""
1843 return _core_
.Rect2D_Union(*args
, **kwargs
)
1845 def CreateUnion(*args
, **kwargs
):
1846 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1847 return _core_
.Rect2D_CreateUnion(*args
, **kwargs
)
1851 Scale(self, wxDouble f)
1852 Scale(self, int num, int denum)
1854 return _core_
.Rect2D_Scale(*args
)
1856 def __eq__(*args
, **kwargs
):
1858 __eq__(self, PyObject other) -> bool
1860 Test for equality of wx.Rect2D objects.
1862 return _core_
.Rect2D___eq__(*args
, **kwargs
)
1864 def __ne__(*args
, **kwargs
):
1866 __ne__(self, PyObject other) -> bool
1868 Test for inequality of wx.Rect2D objects.
1870 return _core_
.Rect2D___ne__(*args
, **kwargs
)
1872 x
= property(_core_
.Rect2D_x_get
, _core_
.Rect2D_x_set
)
1873 y
= property(_core_
.Rect2D_y_get
, _core_
.Rect2D_y_set
)
1874 width
= property(_core_
.Rect2D_width_get
, _core_
.Rect2D_width_set
)
1875 height
= property(_core_
.Rect2D_height_get
, _core_
.Rect2D_height_set
)
1876 def Set(*args
, **kwargs
):
1877 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1878 return _core_
.Rect2D_Set(*args
, **kwargs
)
1880 def Get(*args
, **kwargs
):
1882 Get() -> (x,y, width, height)
1884 Return x, y, width and height y properties as a tuple.
1886 return _core_
.Rect2D_Get(*args
, **kwargs
)
1888 def __str__(self
): return str(self
.Get())
1889 def __repr__(self
): return 'wx.Rect2D'+str(self
.Get())
1890 def __len__(self
): return len(self
.Get())
1891 def __getitem__(self
, index
): return self
.Get()[index
]
1892 def __setitem__(self
, index
, val
):
1893 if index
== 0: self
.x
= val
1894 elif index
== 1: self
.y
= val
1895 elif index
== 2: self
.width
= val
1896 elif index
== 3: self
.height
= val
1897 else: raise IndexError
1898 def __nonzero__(self
): return self
.Get() != (0.0, 0.0, 0.0, 0.0)
1899 __safe_for_unpickling__
= True
1900 def __reduce__(self
): return (wx
.Rect2D
, self
.Get())
1902 _core_
.Rect2D_swigregister(Rect2D
)
1904 #---------------------------------------------------------------------------
1906 FromStart
= _core_
.FromStart
1907 FromCurrent
= _core_
.FromCurrent
1908 FromEnd
= _core_
.FromEnd
1909 class InputStream(object):
1910 """Proxy of C++ InputStream class"""
1911 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1912 __repr__
= _swig_repr
1913 def __init__(self
, *args
, **kwargs
):
1914 """__init__(self, PyObject p) -> InputStream"""
1915 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1916 __swig_destroy__
= _core_
.delete_InputStream
1917 __del__
= lambda self
: None;
1918 def close(*args
, **kwargs
):
1920 return _core_
.InputStream_close(*args
, **kwargs
)
1922 def flush(*args
, **kwargs
):
1924 return _core_
.InputStream_flush(*args
, **kwargs
)
1926 def eof(*args
, **kwargs
):
1927 """eof(self) -> bool"""
1928 return _core_
.InputStream_eof(*args
, **kwargs
)
1930 def read(*args
, **kwargs
):
1931 """read(self, int size=-1) -> PyObject"""
1932 return _core_
.InputStream_read(*args
, **kwargs
)
1934 def readline(*args
, **kwargs
):
1935 """readline(self, int size=-1) -> PyObject"""
1936 return _core_
.InputStream_readline(*args
, **kwargs
)
1938 def readlines(*args
, **kwargs
):
1939 """readlines(self, int sizehint=-1) -> PyObject"""
1940 return _core_
.InputStream_readlines(*args
, **kwargs
)
1942 def seek(*args
, **kwargs
):
1943 """seek(self, int offset, int whence=0)"""
1944 return _core_
.InputStream_seek(*args
, **kwargs
)
1946 def tell(*args
, **kwargs
):
1947 """tell(self) -> int"""
1948 return _core_
.InputStream_tell(*args
, **kwargs
)
1950 def Peek(*args
, **kwargs
):
1951 """Peek(self) -> char"""
1952 return _core_
.InputStream_Peek(*args
, **kwargs
)
1954 def GetC(*args
, **kwargs
):
1955 """GetC(self) -> char"""
1956 return _core_
.InputStream_GetC(*args
, **kwargs
)
1958 def LastRead(*args
, **kwargs
):
1959 """LastRead(self) -> size_t"""
1960 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1962 def CanRead(*args
, **kwargs
):
1963 """CanRead(self) -> bool"""
1964 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1966 def Eof(*args
, **kwargs
):
1967 """Eof(self) -> bool"""
1968 return _core_
.InputStream_Eof(*args
, **kwargs
)
1970 def Ungetch(*args
, **kwargs
):
1971 """Ungetch(self, char c) -> bool"""
1972 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1974 def SeekI(*args
, **kwargs
):
1975 """SeekI(self, long pos, int mode=FromStart) -> long"""
1976 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1978 def TellI(*args
, **kwargs
):
1979 """TellI(self) -> long"""
1980 return _core_
.InputStream_TellI(*args
, **kwargs
)
1982 _core_
.InputStream_swigregister(InputStream
)
1983 DefaultPosition
= cvar
.DefaultPosition
1984 DefaultSize
= cvar
.DefaultSize
1986 class OutputStream(object):
1987 """Proxy of C++ OutputStream class"""
1988 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1989 def __init__(self
): raise AttributeError, "No constructor defined"
1990 __repr__
= _swig_repr
1991 def write(*args
, **kwargs
):
1992 """write(self, PyObject obj)"""
1993 return _core_
.OutputStream_write(*args
, **kwargs
)
1995 def LastWrite(*args
, **kwargs
):
1996 """LastWrite(self) -> size_t"""
1997 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
1999 _core_
.OutputStream_swigregister(OutputStream
)
2001 #---------------------------------------------------------------------------
2003 class FSFile(Object
):
2004 """Proxy of C++ FSFile class"""
2005 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2006 __repr__
= _swig_repr
2007 def __init__(self
, *args
, **kwargs
):
2009 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2010 DateTime modif) -> FSFile
2012 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
2013 __swig_destroy__
= _core_
.delete_FSFile
2014 __del__
= lambda self
: None;
2015 def GetStream(*args
, **kwargs
):
2016 """GetStream(self) -> InputStream"""
2017 return _core_
.FSFile_GetStream(*args
, **kwargs
)
2019 def DetachStream(*args
, **kwargs
):
2020 """DetachStream(self)"""
2021 return _core_
.FSFile_DetachStream(*args
, **kwargs
)
2023 def GetMimeType(*args
, **kwargs
):
2024 """GetMimeType(self) -> String"""
2025 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
2027 def GetLocation(*args
, **kwargs
):
2028 """GetLocation(self) -> String"""
2029 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
2031 def GetAnchor(*args
, **kwargs
):
2032 """GetAnchor(self) -> String"""
2033 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
2035 def GetModificationTime(*args
, **kwargs
):
2036 """GetModificationTime(self) -> DateTime"""
2037 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
2039 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2040 Location
= property(GetLocation
,doc
="See `GetLocation`")
2041 MimeType
= property(GetMimeType
,doc
="See `GetMimeType`")
2042 ModificationTime
= property(GetModificationTime
,doc
="See `GetModificationTime`")
2043 Stream
= property(GetStream
,doc
="See `GetStream`")
2044 _core_
.FSFile_swigregister(FSFile
)
2046 class CPPFileSystemHandler(object):
2047 """Proxy of C++ CPPFileSystemHandler class"""
2048 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2049 def __init__(self
): raise AttributeError, "No constructor defined"
2050 __repr__
= _swig_repr
2051 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
2052 __del__
= lambda self
: None;
2053 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
2055 class FileSystemHandler(CPPFileSystemHandler
):
2056 """Proxy of C++ FileSystemHandler class"""
2057 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2058 __repr__
= _swig_repr
2059 def __init__(self
, *args
, **kwargs
):
2060 """__init__(self) -> FileSystemHandler"""
2061 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
2062 self
._setCallbackInfo
(self
, FileSystemHandler
)
2064 def _setCallbackInfo(*args
, **kwargs
):
2065 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2066 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
2068 def CanOpen(*args
, **kwargs
):
2069 """CanOpen(self, String location) -> bool"""
2070 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
2072 def OpenFile(*args
, **kwargs
):
2073 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2074 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
2076 def FindFirst(*args
, **kwargs
):
2077 """FindFirst(self, String spec, int flags=0) -> String"""
2078 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
2080 def FindNext(*args
, **kwargs
):
2081 """FindNext(self) -> String"""
2082 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
2084 def GetProtocol(*args
, **kwargs
):
2085 """GetProtocol(self, String location) -> String"""
2086 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
2088 def GetLeftLocation(*args
, **kwargs
):
2089 """GetLeftLocation(self, String location) -> String"""
2090 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
2092 def GetAnchor(*args
, **kwargs
):
2093 """GetAnchor(self, String location) -> String"""
2094 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
2096 def GetRightLocation(*args
, **kwargs
):
2097 """GetRightLocation(self, String location) -> String"""
2098 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
2100 def GetMimeTypeFromExt(*args
, **kwargs
):
2101 """GetMimeTypeFromExt(self, String location) -> String"""
2102 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
2104 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2105 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
2106 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
2107 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
2108 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
2109 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
2111 class FileSystem(Object
):
2112 """Proxy of C++ FileSystem class"""
2113 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2114 __repr__
= _swig_repr
2115 def __init__(self
, *args
, **kwargs
):
2116 """__init__(self) -> FileSystem"""
2117 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
2118 __swig_destroy__
= _core_
.delete_FileSystem
2119 __del__
= lambda self
: None;
2120 def ChangePathTo(*args
, **kwargs
):
2121 """ChangePathTo(self, String location, bool is_dir=False)"""
2122 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
2124 def GetPath(*args
, **kwargs
):
2125 """GetPath(self) -> String"""
2126 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
2128 def OpenFile(*args
, **kwargs
):
2129 """OpenFile(self, String location) -> FSFile"""
2130 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
2132 def FindFirst(*args
, **kwargs
):
2133 """FindFirst(self, String spec, int flags=0) -> String"""
2134 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
2136 def FindNext(*args
, **kwargs
):
2137 """FindNext(self) -> String"""
2138 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
2140 def AddHandler(*args
, **kwargs
):
2141 """AddHandler(CPPFileSystemHandler handler)"""
2142 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2144 AddHandler
= staticmethod(AddHandler
)
2145 def RemoveHandler(*args
, **kwargs
):
2146 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2147 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2149 RemoveHandler
= staticmethod(RemoveHandler
)
2150 def CleanUpHandlers(*args
, **kwargs
):
2151 """CleanUpHandlers()"""
2152 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
2154 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
2155 def FileNameToURL(*args
, **kwargs
):
2156 """FileNameToURL(String filename) -> String"""
2157 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2159 FileNameToURL
= staticmethod(FileNameToURL
)
2160 def URLToFileName(*args
, **kwargs
):
2161 """URLToFileName(String url) -> String"""
2162 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2164 URLToFileName
= staticmethod(URLToFileName
)
2165 Path
= property(GetPath
,doc
="See `GetPath`")
2166 _core_
.FileSystem_swigregister(FileSystem
)
2168 def FileSystem_AddHandler(*args
, **kwargs
):
2169 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2170 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2172 def FileSystem_RemoveHandler(*args
, **kwargs
):
2173 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2174 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2176 def FileSystem_CleanUpHandlers(*args
):
2177 """FileSystem_CleanUpHandlers()"""
2178 return _core_
.FileSystem_CleanUpHandlers(*args
)
2180 def FileSystem_FileNameToURL(*args
, **kwargs
):
2181 """FileSystem_FileNameToURL(String filename) -> String"""
2182 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2184 def FileSystem_URLToFileName(*args
, **kwargs
):
2185 """FileSystem_URLToFileName(String url) -> String"""
2186 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2188 class InternetFSHandler(CPPFileSystemHandler
):
2189 """Proxy of C++ InternetFSHandler class"""
2190 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2191 __repr__
= _swig_repr
2192 def __init__(self
, *args
, **kwargs
):
2193 """__init__(self) -> InternetFSHandler"""
2194 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
2195 def CanOpen(*args
, **kwargs
):
2196 """CanOpen(self, String location) -> bool"""
2197 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
2199 def OpenFile(*args
, **kwargs
):
2200 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2201 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
2203 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
2205 class ZipFSHandler(CPPFileSystemHandler
):
2206 """Proxy of C++ ZipFSHandler class"""
2207 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2208 __repr__
= _swig_repr
2209 def __init__(self
, *args
, **kwargs
):
2210 """__init__(self) -> ZipFSHandler"""
2211 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
2212 def CanOpen(*args
, **kwargs
):
2213 """CanOpen(self, String location) -> bool"""
2214 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
2216 def OpenFile(*args
, **kwargs
):
2217 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2218 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
2220 def FindFirst(*args
, **kwargs
):
2221 """FindFirst(self, String spec, int flags=0) -> String"""
2222 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
2224 def FindNext(*args
, **kwargs
):
2225 """FindNext(self) -> String"""
2226 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
2228 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
2231 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
2232 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2233 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
2235 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
2236 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2237 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
2239 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
2240 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2241 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
2242 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
2244 Add 'file' to the memory filesystem. The dataItem parameter can
2245 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2246 arbitrary data. If a bitmap or image is used then the imgType
2247 parameter should specify what kind of image file it should be
2248 written as, wx.BITMAP_TYPE_PNG, etc.
2250 if isinstance(dataItem
, wx
.Image
):
2251 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
2252 elif isinstance(dataItem
, wx
.Bitmap
):
2253 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2254 elif type(dataItem
) == str:
2255 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2257 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2259 class MemoryFSHandler(CPPFileSystemHandler
):
2260 """Proxy of C++ MemoryFSHandler class"""
2261 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2262 __repr__
= _swig_repr
2263 def __init__(self
, *args
, **kwargs
):
2264 """__init__(self) -> MemoryFSHandler"""
2265 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
2266 def RemoveFile(*args
, **kwargs
):
2267 """RemoveFile(String filename)"""
2268 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2270 RemoveFile
= staticmethod(RemoveFile
)
2271 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2272 def CanOpen(*args
, **kwargs
):
2273 """CanOpen(self, String location) -> bool"""
2274 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2276 def OpenFile(*args
, **kwargs
):
2277 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2278 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2280 def FindFirst(*args
, **kwargs
):
2281 """FindFirst(self, String spec, int flags=0) -> String"""
2282 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2284 def FindNext(*args
, **kwargs
):
2285 """FindNext(self) -> String"""
2286 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2288 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2290 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2291 """MemoryFSHandler_RemoveFile(String filename)"""
2292 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2294 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2295 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2296 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2297 IMAGE_QUALITY_NORMAL
= _core_
.IMAGE_QUALITY_NORMAL
2298 IMAGE_QUALITY_HIGH
= _core_
.IMAGE_QUALITY_HIGH
2299 #---------------------------------------------------------------------------
2301 class ImageHandler(Object
):
2303 This is the base class for implementing image file loading/saving, and
2304 image creation from data. It is used within `wx.Image` and is not
2305 normally seen by the application.
2307 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2308 def __init__(self
): raise AttributeError, "No constructor defined"
2309 __repr__
= _swig_repr
2310 def GetName(*args
, **kwargs
):
2311 """GetName(self) -> String"""
2312 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2314 def GetExtension(*args
, **kwargs
):
2315 """GetExtension(self) -> String"""
2316 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2318 def GetType(*args
, **kwargs
):
2319 """GetType(self) -> long"""
2320 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2322 def GetMimeType(*args
, **kwargs
):
2323 """GetMimeType(self) -> String"""
2324 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2326 def CanRead(*args
, **kwargs
):
2327 """CanRead(self, String name) -> bool"""
2328 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2330 def CanReadStream(*args
, **kwargs
):
2331 """CanReadStream(self, InputStream stream) -> bool"""
2332 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2334 def SetName(*args
, **kwargs
):
2335 """SetName(self, String name)"""
2336 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2338 def SetExtension(*args
, **kwargs
):
2339 """SetExtension(self, String extension)"""
2340 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2342 def SetType(*args
, **kwargs
):
2343 """SetType(self, long type)"""
2344 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2346 def SetMimeType(*args
, **kwargs
):
2347 """SetMimeType(self, String mimetype)"""
2348 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2350 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2351 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2352 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2353 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2354 _core_
.ImageHandler_swigregister(ImageHandler
)
2356 class PyImageHandler(ImageHandler
):
2358 This is the base class for implementing image file loading/saving, and
2359 image creation from data, all written in Python. To create a custom
2360 image handler derive a new class from wx.PyImageHandler and provide
2361 the following methods::
2363 def DoCanRead(self, stream) --> bool
2364 '''Check if this handler can read the image on the stream'''
2366 def LoadFile(self, image, stream, verbose, index) --> bool
2367 '''Load image data from the stream and load it into image.'''
2369 def SaveFile(self, image, stream, verbose) --> bool
2370 '''Save the iamge data in image to the stream using
2371 this handler's image file format.'''
2373 def GetImageCount(self, stream) --> int
2374 '''If this image format can hold more than one image,
2375 how many does the image on the stream have?'''
2377 To activate your handler create an instance of it and pass it to
2378 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2379 `SetExtension` from your constructor.
2382 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2383 __repr__
= _swig_repr
2384 def __init__(self
, *args
, **kwargs
):
2386 __init__(self) -> PyImageHandler
2388 This is the base class for implementing image file loading/saving, and
2389 image creation from data, all written in Python. To create a custom
2390 image handler derive a new class from wx.PyImageHandler and provide
2391 the following methods::
2393 def DoCanRead(self, stream) --> bool
2394 '''Check if this handler can read the image on the stream'''
2396 def LoadFile(self, image, stream, verbose, index) --> bool
2397 '''Load image data from the stream and load it into image.'''
2399 def SaveFile(self, image, stream, verbose) --> bool
2400 '''Save the iamge data in image to the stream using
2401 this handler's image file format.'''
2403 def GetImageCount(self, stream) --> int
2404 '''If this image format can hold more than one image,
2405 how many does the image on the stream have?'''
2407 To activate your handler create an instance of it and pass it to
2408 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2409 `SetExtension` from your constructor.
2412 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2415 def _SetSelf(*args
, **kwargs
):
2416 """_SetSelf(self, PyObject self)"""
2417 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2419 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2421 class ImageHistogram(object):
2422 """Proxy of C++ ImageHistogram class"""
2423 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2424 __repr__
= _swig_repr
2425 def __init__(self
, *args
, **kwargs
):
2426 """__init__(self) -> ImageHistogram"""
2427 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2428 def MakeKey(*args
, **kwargs
):
2430 MakeKey(byte r, byte g, byte b) -> unsigned long
2432 Get the key in the histogram for the given RGB values
2434 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2436 MakeKey
= staticmethod(MakeKey
)
2437 def FindFirstUnusedColour(*args
, **kwargs
):
2439 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2441 Find first colour that is not used in the image and has higher RGB
2442 values than startR, startG, startB. Returns a tuple consisting of a
2443 success flag and rgb values.
2445 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2447 def GetCount(*args
, **kwargs
):
2449 GetCount(self, unsigned long key) -> unsigned long
2451 Returns the pixel count for the given key. Use `MakeKey` to create a
2452 key value from a RGB tripple.
2454 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2456 def GetCountRGB(*args
, **kwargs
):
2458 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2460 Returns the pixel count for the given RGB values.
2462 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2464 def GetCountColour(*args
, **kwargs
):
2466 GetCountColour(self, Colour colour) -> unsigned long
2468 Returns the pixel count for the given `wx.Colour` value.
2470 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2472 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2474 def ImageHistogram_MakeKey(*args
, **kwargs
):
2476 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2478 Get the key in the histogram for the given RGB values
2480 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2482 class Image_RGBValue(object):
2484 An object that contains values for red, green and blue which represent
2485 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2486 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2489 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2490 __repr__
= _swig_repr
2491 def __init__(self
, *args
, **kwargs
):
2493 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2497 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2498 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2499 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2500 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2501 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2503 class Image_HSVValue(object):
2505 An object that contains values for hue, saturation and value which
2506 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2507 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2510 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2511 __repr__
= _swig_repr
2512 def __init__(self
, *args
, **kwargs
):
2514 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2518 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2519 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2520 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2521 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2522 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2524 class Image(Object
):
2526 A platform-independent image class. An image can be created from
2527 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2528 variety of formats. Functions are available to set and get image
2529 bits, so it can be used for basic image manipulation.
2531 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2532 platform-specific `wx.Bitmap` object must be created from it using the
2533 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2534 device context, using `wx.DC.DrawBitmap`.
2536 One colour value of the image may be used as a mask colour which will
2537 lead to the automatic creation of a `wx.Mask` object associated to the
2540 wx.Image supports alpha channel data, that is in addition to a byte
2541 for the red, green and blue colour components for each pixel it also
2542 stores a byte representing the pixel opacity. An alpha value of 0
2543 corresponds to a transparent pixel (null opacity) while a value of 255
2544 means that the pixel is 100% opaque.
2546 Unlike RGB data, not all images have an alpha channel and before using
2547 `GetAlpha` you should check if this image contains an alpha channel
2548 with `HasAlpha`. Note that currently only images loaded from PNG files
2549 with transparency information will have an alpha channel.
2551 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2552 __repr__
= _swig_repr
2553 def __init__(self
, *args
, **kwargs
):
2555 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2557 Loads an image from a file.
2559 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2560 __swig_destroy__
= _core_
.delete_Image
2561 __del__
= lambda self
: None;
2562 def Create(*args
, **kwargs
):
2564 Create(self, int width, int height, bool clear=True)
2566 Creates a fresh image. If clear is ``True``, the new image will be
2567 initialized to black. Otherwise, the image data will be uninitialized.
2569 return _core_
.Image_Create(*args
, **kwargs
)
2571 def Destroy(*args
, **kwargs
):
2575 Destroys the image data.
2577 args
[0].this
.own(False)
2578 return _core_
.Image_Destroy(*args
, **kwargs
)
2580 def Scale(*args
, **kwargs
):
2582 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2584 Returns a scaled version of the image. This is also useful for scaling
2585 bitmaps in general as the only other way to scale bitmaps is to blit a
2586 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2587 specifies what method to use for resampling the image. It can be
2588 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2589 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2590 bicubic and box averaging resampling methods for upsampling and
2591 downsampling respectively.
2593 return _core_
.Image_Scale(*args
, **kwargs
)
2595 def ResampleBox(*args
, **kwargs
):
2596 """ResampleBox(self, int width, int height) -> Image"""
2597 return _core_
.Image_ResampleBox(*args
, **kwargs
)
2599 def ResampleBicubic(*args
, **kwargs
):
2600 """ResampleBicubic(self, int width, int height) -> Image"""
2601 return _core_
.Image_ResampleBicubic(*args
, **kwargs
)
2603 def Blur(*args
, **kwargs
):
2605 Blur(self, int radius) -> Image
2607 Blurs the image in both horizontal and vertical directions by the
2608 specified pixel ``radius``. This should not be used when using a
2609 single mask colour for transparency.
2611 return _core_
.Image_Blur(*args
, **kwargs
)
2613 def BlurHorizontal(*args
, **kwargs
):
2615 BlurHorizontal(self, int radius) -> Image
2617 Blurs the image in the horizontal direction only. This should not be
2618 used when using a single mask colour for transparency.
2621 return _core_
.Image_BlurHorizontal(*args
, **kwargs
)
2623 def BlurVertical(*args
, **kwargs
):
2625 BlurVertical(self, int radius) -> Image
2627 Blurs the image in the vertical direction only. This should not be
2628 used when using a single mask colour for transparency.
2630 return _core_
.Image_BlurVertical(*args
, **kwargs
)
2632 def ShrinkBy(*args
, **kwargs
):
2634 ShrinkBy(self, int xFactor, int yFactor) -> Image
2636 Return a version of the image scaled smaller by the given factors.
2638 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2640 def Rescale(*args
, **kwargs
):
2642 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2644 Changes the size of the image in-place by scaling it: after a call to
2645 this function, the image will have the given width and height.
2647 Returns the (modified) image itself.
2649 return _core_
.Image_Rescale(*args
, **kwargs
)
2651 def Resize(*args
, **kwargs
):
2653 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2655 Changes the size of the image in-place without scaling it, by adding
2656 either a border with the given colour or cropping as necessary. The
2657 image is pasted into a new image with the given size and background
2658 colour at the position pos relative to the upper left of the new
2659 image. If red = green = blue = -1 then use either the current mask
2660 colour if set or find, use, and set a suitable mask colour for any
2661 newly exposed areas.
2663 Returns the (modified) image itself.
2665 return _core_
.Image_Resize(*args
, **kwargs
)
2667 def SetRGB(*args
, **kwargs
):
2669 SetRGB(self, int x, int y, byte r, byte g, byte b)
2671 Sets the pixel at the given coordinate. This routine performs
2672 bounds-checks for the coordinate so it can be considered a safe way to
2673 manipulate the data, but in some cases this might be too slow so that
2674 the data will have to be set directly. In that case you will have to
2675 get access to the image data using the `GetData` method.
2677 return _core_
.Image_SetRGB(*args
, **kwargs
)
2679 def SetRGBRect(*args
, **kwargs
):
2681 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2683 Sets the colour of the pixels within the given rectangle. This routine
2684 performs bounds-checks for the rectangle so it can be considered a
2685 safe way to manipulate the data.
2687 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2689 def GetRed(*args
, **kwargs
):
2691 GetRed(self, int x, int y) -> byte
2693 Returns the red intensity at the given coordinate.
2695 return _core_
.Image_GetRed(*args
, **kwargs
)
2697 def GetGreen(*args
, **kwargs
):
2699 GetGreen(self, int x, int y) -> byte
2701 Returns the green intensity at the given coordinate.
2703 return _core_
.Image_GetGreen(*args
, **kwargs
)
2705 def GetBlue(*args
, **kwargs
):
2707 GetBlue(self, int x, int y) -> byte
2709 Returns the blue intensity at the given coordinate.
2711 return _core_
.Image_GetBlue(*args
, **kwargs
)
2713 def SetAlpha(*args
, **kwargs
):
2715 SetAlpha(self, int x, int y, byte alpha)
2717 Sets the alpha value for the given pixel. This function should only be
2718 called if the image has alpha channel data, use `HasAlpha` to check
2721 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2723 def GetAlpha(*args
, **kwargs
):
2725 GetAlpha(self, int x, int y) -> byte
2727 Returns the alpha value for the given pixel. This function may only be
2728 called for the images with alpha channel, use `HasAlpha` to check for
2731 The returned value is the *opacity* of the image, i.e. the value of 0
2732 corresponds to the fully transparent pixels while the value of 255 to
2733 the fully opaque pixels.
2735 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2737 def HasAlpha(*args
, **kwargs
):
2739 HasAlpha(self) -> bool
2741 Returns true if this image has alpha channel, false otherwise.
2743 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2745 def InitAlpha(*args
, **kwargs
):
2749 Initializes the image alpha channel data. It is an error to call it if
2750 the image already has alpha data. If it doesn't, alpha data will be by
2751 default initialized to all pixels being fully opaque. But if the image
2752 has a a mask colour, all mask pixels will be completely transparent.
2754 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2756 def IsTransparent(*args
, **kwargs
):
2758 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2760 Returns ``True`` if this pixel is masked or has an alpha value less
2761 than the spcified threshold.
2763 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2765 def FindFirstUnusedColour(*args
, **kwargs
):
2767 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2769 Find first colour that is not used in the image and has higher RGB
2770 values than startR, startG, startB. Returns a tuple consisting of a
2771 success flag and rgb values.
2773 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2775 def ConvertAlphaToMask(*args
, **kwargs
):
2777 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2779 If the image has alpha channel, this method converts it to mask. All
2780 pixels with alpha value less than ``threshold`` are replaced with the
2781 mask colour and the alpha channel is removed. The mask colour is
2782 chosen automatically using `FindFirstUnusedColour`.
2784 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2787 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2789 def ConvertColourToAlpha(*args
, **kwargs
):
2791 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2793 This method converts an image where the original alpha information is
2794 only available as a shades of a colour (actually shades of grey)
2795 typically when you draw anti-aliased text into a bitmap. The DC
2796 drawing routines draw grey values on the black background although
2797 they actually mean to draw white with differnt alpha values. This
2798 method reverses it, assuming a black (!) background and white text.
2799 The method will then fill up the whole image with the colour given.
2801 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2803 def SetMaskFromImage(*args
, **kwargs
):
2805 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2807 Sets the image's mask so that the pixels that have RGB value of
2808 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2809 by first finding an unused colour in the image, setting this colour as
2810 the mask colour and then using this colour to draw all pixels in the
2811 image who corresponding pixel in mask has given RGB value.
2813 Returns ``False`` if ``mask`` does not have same dimensions as the
2814 image or if there is no unused colour left. Returns ``True`` if the
2815 mask was successfully applied.
2817 Note that this method involves computing the histogram, which is
2818 computationally intensive operation.
2820 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2822 def CanRead(*args
, **kwargs
):
2824 CanRead(String filename) -> bool
2826 Returns True if the image handlers can read this file.
2828 return _core_
.Image_CanRead(*args
, **kwargs
)
2830 CanRead
= staticmethod(CanRead
)
2831 def GetImageCount(*args
, **kwargs
):
2833 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2835 If the image file contains more than one image and the image handler
2836 is capable of retrieving these individually, this function will return
2837 the number of available images.
2839 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2841 GetImageCount
= staticmethod(GetImageCount
)
2842 def LoadFile(*args
, **kwargs
):
2844 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2846 Loads an image from a file. If no handler type is provided, the
2847 library will try to autodetect the format.
2849 return _core_
.Image_LoadFile(*args
, **kwargs
)
2851 def LoadMimeFile(*args
, **kwargs
):
2853 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2855 Loads an image from a file, specifying the image type with a MIME type
2858 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2860 def SaveFile(*args
, **kwargs
):
2862 SaveFile(self, String name, int type) -> bool
2864 Saves an image in the named file.
2866 return _core_
.Image_SaveFile(*args
, **kwargs
)
2868 def SaveMimeFile(*args
, **kwargs
):
2870 SaveMimeFile(self, String name, String mimetype) -> bool
2872 Saves an image in the named file.
2874 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2876 def CanReadStream(*args
, **kwargs
):
2878 CanReadStream(InputStream stream) -> bool
2880 Returns True if the image handlers can read an image file from the
2881 data currently on the input stream, or a readable Python file-like
2884 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2886 CanReadStream
= staticmethod(CanReadStream
)
2887 def LoadStream(*args
, **kwargs
):
2889 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2891 Loads an image from an input stream or a readable Python file-like
2892 object. If no handler type is provided, the library will try to
2893 autodetect the format.
2895 return _core_
.Image_LoadStream(*args
, **kwargs
)
2897 def LoadMimeStream(*args
, **kwargs
):
2899 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2901 Loads an image from an input stream or a readable Python file-like
2902 object, using a MIME type string to specify the image file format.
2904 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2906 def IsOk(*args
, **kwargs
):
2910 Returns true if image data is present.
2912 return _core_
.Image_IsOk(*args
, **kwargs
)
2915 def GetWidth(*args
, **kwargs
):
2917 GetWidth(self) -> int
2919 Gets the width of the image in pixels.
2921 return _core_
.Image_GetWidth(*args
, **kwargs
)
2923 def GetHeight(*args
, **kwargs
):
2925 GetHeight(self) -> int
2927 Gets the height of the image in pixels.
2929 return _core_
.Image_GetHeight(*args
, **kwargs
)
2931 def GetSize(*args
, **kwargs
):
2933 GetSize(self) -> Size
2935 Returns the size of the image in pixels.
2937 return _core_
.Image_GetSize(*args
, **kwargs
)
2939 def GetSubImage(*args
, **kwargs
):
2941 GetSubImage(self, Rect rect) -> Image
2943 Returns a sub image of the current one as long as the rect belongs
2944 entirely to the image.
2946 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2948 def Size(*args
, **kwargs
):
2950 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2952 Returns a resized version of this image without scaling it by adding
2953 either a border with the given colour or cropping as necessary. The
2954 image is pasted into a new image with the given size and background
2955 colour at the position ``pos`` relative to the upper left of the new
2956 image. If red = green = blue = -1 then use either the current mask
2957 colour if set or find, use, and set a suitable mask colour for any
2958 newly exposed areas.
2960 return _core_
.Image_Size(*args
, **kwargs
)
2962 def Copy(*args
, **kwargs
):
2966 Returns an identical copy of the image.
2968 return _core_
.Image_Copy(*args
, **kwargs
)
2970 def Paste(*args
, **kwargs
):
2972 Paste(self, Image image, int x, int y)
2974 Pastes ``image`` into this instance and takes care of the mask colour
2975 and any out of bounds problems.
2977 return _core_
.Image_Paste(*args
, **kwargs
)
2979 def GetData(*args
, **kwargs
):
2981 GetData(self) -> PyObject
2983 Returns a string containing a copy of the RGB bytes of the image.
2985 return _core_
.Image_GetData(*args
, **kwargs
)
2987 def SetData(*args
, **kwargs
):
2989 SetData(self, buffer data)
2991 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2992 either a string or a buffer object holding the data and the length of
2993 the data must be width*height*3.
2995 return _core_
.Image_SetData(*args
, **kwargs
)
2997 def GetDataBuffer(*args
, **kwargs
):
2999 GetDataBuffer(self) -> PyObject
3001 Returns a writable Python buffer object that is pointing at the RGB
3002 image data buffer inside the wx.Image. You need to ensure that you do
3003 not use this buffer object after the image has been destroyed.
3005 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
3007 def SetDataBuffer(*args
, **kwargs
):
3009 SetDataBuffer(self, buffer data)
3011 Sets the internal image data pointer to point at a Python buffer
3012 object. This can save making an extra copy of the data but you must
3013 ensure that the buffer object lives longer than the wx.Image does.
3015 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
3017 def GetAlphaData(*args
, **kwargs
):
3019 GetAlphaData(self) -> PyObject
3021 Returns a string containing a copy of the alpha bytes of the image.
3023 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
3025 def SetAlphaData(*args
, **kwargs
):
3027 SetAlphaData(self, buffer alpha)
3029 Resets the Image's alpha data from a buffer of bytes. Accepts either
3030 a string or a buffer object holding the data and the length of the
3031 data must be width*height.
3033 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
3035 def GetAlphaBuffer(*args
, **kwargs
):
3037 GetAlphaBuffer(self) -> PyObject
3039 Returns a writable Python buffer object that is pointing at the Alpha
3040 data buffer inside the wx.Image. You need to ensure that you do not
3041 use this buffer object after the image has been destroyed.
3043 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
3045 def SetAlphaBuffer(*args
, **kwargs
):
3047 SetAlphaBuffer(self, buffer alpha)
3049 Sets the internal image alpha pointer to point at a Python buffer
3050 object. This can save making an extra copy of the data but you must
3051 ensure that the buffer object lives as long as the wx.Image does.
3053 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
3055 def SetMaskColour(*args
, **kwargs
):
3057 SetMaskColour(self, byte r, byte g, byte b)
3059 Sets the mask colour for this image (and tells the image to use the
3062 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
3064 def GetOrFindMaskColour(*args
, **kwargs
):
3066 GetOrFindMaskColour() -> (r,g,b)
3068 Get the current mask colour or find a suitable colour.
3070 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
3072 def GetMaskRed(*args
, **kwargs
):
3074 GetMaskRed(self) -> byte
3076 Gets the red component of the mask colour.
3078 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
3080 def GetMaskGreen(*args
, **kwargs
):
3082 GetMaskGreen(self) -> byte
3084 Gets the green component of the mask colour.
3086 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
3088 def GetMaskBlue(*args
, **kwargs
):
3090 GetMaskBlue(self) -> byte
3092 Gets the blue component of the mask colour.
3094 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
3096 def SetMask(*args
, **kwargs
):
3098 SetMask(self, bool mask=True)
3100 Specifies whether there is a mask or not. The area of the mask is
3101 determined by the current mask colour.
3103 return _core_
.Image_SetMask(*args
, **kwargs
)
3105 def HasMask(*args
, **kwargs
):
3107 HasMask(self) -> bool
3109 Returns ``True`` if there is a mask active, ``False`` otherwise.
3111 return _core_
.Image_HasMask(*args
, **kwargs
)
3113 def Rotate(*args
, **kwargs
):
3115 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3116 Point offset_after_rotation=None) -> Image
3118 Rotates the image about the given point, by ``angle`` radians. Passing
3119 ``True`` to ``interpolating`` results in better image quality, but is
3120 slower. If the image has a mask, then the mask colour is used for the
3121 uncovered pixels in the rotated image background. Otherwise, black
3122 will be used as the fill colour.
3124 Returns the rotated image, leaving this image intact.
3126 return _core_
.Image_Rotate(*args
, **kwargs
)
3128 def Rotate90(*args
, **kwargs
):
3130 Rotate90(self, bool clockwise=True) -> Image
3132 Returns a copy of the image rotated 90 degrees in the direction
3133 indicated by ``clockwise``.
3135 return _core_
.Image_Rotate90(*args
, **kwargs
)
3137 def Mirror(*args
, **kwargs
):
3139 Mirror(self, bool horizontally=True) -> Image
3141 Returns a mirrored copy of the image. The parameter ``horizontally``
3142 indicates the orientation.
3144 return _core_
.Image_Mirror(*args
, **kwargs
)
3146 def Replace(*args
, **kwargs
):
3148 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3150 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3153 return _core_
.Image_Replace(*args
, **kwargs
)
3155 def ConvertToGreyscale(*args
, **kwargs
):
3157 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3159 Convert to greyscale image. Uses the luminance component (Y) of the
3160 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3161 defaults to ITU-T BT.601
3163 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
3165 def ConvertToMono(*args
, **kwargs
):
3167 ConvertToMono(self, byte r, byte g, byte b) -> Image
3169 Returns monochromatic version of the image. The returned image has
3170 white colour where the original has ``(r,g,b)`` colour and black
3171 colour everywhere else.
3173 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
3175 def SetOption(*args
, **kwargs
):
3177 SetOption(self, String name, String value)
3179 Sets an image handler defined option. For example, when saving as a
3180 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3181 number between 0 and 100 (0 is terrible, 100 is very good).
3183 return _core_
.Image_SetOption(*args
, **kwargs
)
3185 def SetOptionInt(*args
, **kwargs
):
3187 SetOptionInt(self, String name, int value)
3189 Sets an image option as an integer.
3191 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
3193 def GetOption(*args
, **kwargs
):
3195 GetOption(self, String name) -> String
3197 Gets the value of an image handler option.
3199 return _core_
.Image_GetOption(*args
, **kwargs
)
3201 def GetOptionInt(*args
, **kwargs
):
3203 GetOptionInt(self, String name) -> int
3205 Gets the value of an image handler option as an integer. If the given
3206 option is not present, the function returns 0.
3208 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
3210 def HasOption(*args
, **kwargs
):
3212 HasOption(self, String name) -> bool
3214 Returns true if the given option is present.
3216 return _core_
.Image_HasOption(*args
, **kwargs
)
3218 def CountColours(*args
, **kwargs
):
3219 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3220 return _core_
.Image_CountColours(*args
, **kwargs
)
3222 def ComputeHistogram(*args
, **kwargs
):
3223 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3224 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
3226 def AddHandler(*args
, **kwargs
):
3227 """AddHandler(ImageHandler handler)"""
3228 return _core_
.Image_AddHandler(*args
, **kwargs
)
3230 AddHandler
= staticmethod(AddHandler
)
3231 def InsertHandler(*args
, **kwargs
):
3232 """InsertHandler(ImageHandler handler)"""
3233 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3235 InsertHandler
= staticmethod(InsertHandler
)
3236 def RemoveHandler(*args
, **kwargs
):
3237 """RemoveHandler(String name) -> bool"""
3238 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3240 RemoveHandler
= staticmethod(RemoveHandler
)
3241 def GetHandlers(*args
, **kwargs
):
3242 """GetHandlers() -> PyObject"""
3243 return _core_
.Image_GetHandlers(*args
, **kwargs
)
3245 GetHandlers
= staticmethod(GetHandlers
)
3246 def GetImageExtWildcard(*args
, **kwargs
):
3248 GetImageExtWildcard() -> String
3250 Iterates all registered wxImageHandler objects, and returns a string
3251 containing file extension masks suitable for passing to file open/save
3254 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3256 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3257 def ConvertToBitmap(*args
, **kwargs
):
3258 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3259 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3261 def ConvertToMonoBitmap(*args
, **kwargs
):
3262 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3263 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3265 def RotateHue(*args
, **kwargs
):
3267 RotateHue(self, double angle)
3269 Rotates the hue of each pixel of the image. Hue is a double in the
3270 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3272 return _core_
.Image_RotateHue(*args
, **kwargs
)
3274 def RGBtoHSV(*args
, **kwargs
):
3276 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3278 Converts a color in RGB color space to HSV color space.
3280 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3282 RGBtoHSV
= staticmethod(RGBtoHSV
)
3283 def HSVtoRGB(*args
, **kwargs
):
3285 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3287 Converts a color in HSV color space to RGB color space.
3289 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3291 HSVtoRGB
= staticmethod(HSVtoRGB
)
3292 def __nonzero__(self
): return self
.IsOk()
3293 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3294 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
3295 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
3296 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
3297 Height
= property(GetHeight
,doc
="See `GetHeight`")
3298 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
3299 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
3300 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
3301 Width
= property(GetWidth
,doc
="See `GetWidth`")
3302 _core_
.Image_swigregister(Image
)
3304 def ImageFromMime(*args
, **kwargs
):
3306 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3308 Loads an image from a file, using a MIME type string (such as
3309 'image/jpeg') to specify image type.
3311 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3314 def ImageFromStream(*args
, **kwargs
):
3316 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3318 Loads an image from an input stream, or any readable Python file-like
3321 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3324 def ImageFromStreamMime(*args
, **kwargs
):
3326 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3328 Loads an image from an input stream, or any readable Python file-like
3329 object, specifying the image format with a MIME type string.
3331 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3334 def EmptyImage(*args
, **kwargs
):
3336 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3338 Construct an empty image of a given size, optionally setting all
3341 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3344 def ImageFromBitmap(*args
, **kwargs
):
3346 ImageFromBitmap(Bitmap bitmap) -> Image
3348 Construct an Image from a `wx.Bitmap`.
3350 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3353 def ImageFromData(*args
, **kwargs
):
3355 ImageFromData(int width, int height, buffer data) -> Image
3357 Construct an Image from a buffer of RGB bytes. Accepts either a
3358 string or a buffer object holding the data and the length of the data
3359 must be width*height*3.
3361 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3364 def ImageFromDataWithAlpha(*args
, **kwargs
):
3366 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3368 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3369 Accepts either a string or a buffer object holding the data and the
3370 length of the data must be width*height*3 bytes, and the length of the
3371 alpha data must be width*height bytes.
3373 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3376 def Image_CanRead(*args
, **kwargs
):
3378 Image_CanRead(String filename) -> bool
3380 Returns True if the image handlers can read this file.
3382 return _core_
.Image_CanRead(*args
, **kwargs
)
3384 def Image_GetImageCount(*args
, **kwargs
):
3386 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3388 If the image file contains more than one image and the image handler
3389 is capable of retrieving these individually, this function will return
3390 the number of available images.
3392 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3394 def Image_CanReadStream(*args
, **kwargs
):
3396 Image_CanReadStream(InputStream stream) -> bool
3398 Returns True if the image handlers can read an image file from the
3399 data currently on the input stream, or a readable Python file-like
3402 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3404 def Image_AddHandler(*args
, **kwargs
):
3405 """Image_AddHandler(ImageHandler handler)"""
3406 return _core_
.Image_AddHandler(*args
, **kwargs
)
3408 def Image_InsertHandler(*args
, **kwargs
):
3409 """Image_InsertHandler(ImageHandler handler)"""
3410 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3412 def Image_RemoveHandler(*args
, **kwargs
):
3413 """Image_RemoveHandler(String name) -> bool"""
3414 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3416 def Image_GetHandlers(*args
):
3417 """Image_GetHandlers() -> PyObject"""
3418 return _core_
.Image_GetHandlers(*args
)
3420 def Image_GetImageExtWildcard(*args
):
3422 Image_GetImageExtWildcard() -> String
3424 Iterates all registered wxImageHandler objects, and returns a string
3425 containing file extension masks suitable for passing to file open/save
3428 return _core_
.Image_GetImageExtWildcard(*args
)
3430 def Image_RGBtoHSV(*args
, **kwargs
):
3432 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3434 Converts a color in RGB color space to HSV color space.
3436 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3438 def Image_HSVtoRGB(*args
, **kwargs
):
3440 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3442 Converts a color in HSV color space to RGB color space.
3444 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3447 def _ImageFromBuffer(*args
, **kwargs
):
3448 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3449 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3450 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3452 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3453 parameter must be a Python object that implements the buffer interface,
3454 such as a string, array, etc. The dataBuffer object is expected to
3455 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3456 object can optionally be supplied for the image's alpha channel data, and
3457 it is expected to be width*height bytes long.
3459 The wx.Image will be created with its data and alpha pointers initialized
3460 to the memory address pointed to by the buffer objects, thus saving the
3461 time needed to copy the image data from the buffer object to the wx.Image.
3462 While this has advantages, it also has the shoot-yourself-in-the-foot
3463 risks associated with sharing a C pointer between two objects.
3465 To help alleviate the risk a reference to the data and alpha buffer
3466 objects are kept with the wx.Image, so that they won't get deleted until
3467 after the wx.Image is deleted. However please be aware that it is not
3468 guaranteed that an object won't move its memory buffer to a new location
3469 when it needs to resize its contents. If that happens then the wx.Image
3470 will end up referring to an invalid memory location and could cause the
3471 application to crash. Therefore care should be taken to not manipulate
3472 the objects used for the data and alpha buffers in a way that would cause
3473 them to change size.
3475 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3476 image
._buffer
= dataBuffer
3477 image
._alpha
= alphaBuffer
3480 def InitAllImageHandlers():
3482 The former functionality of InitAllImageHanders is now done internal to
3483 the _core_ extension module and so this function has become a simple NOP.
3487 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3488 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3489 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3490 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3491 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3492 BMP_24BPP
= _core_
.BMP_24BPP
3493 BMP_8BPP
= _core_
.BMP_8BPP
3494 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3495 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3496 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3497 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3498 BMP_4BPP
= _core_
.BMP_4BPP
3499 BMP_1BPP
= _core_
.BMP_1BPP
3500 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3501 class BMPHandler(ImageHandler
):
3502 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3503 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3504 __repr__
= _swig_repr
3505 def __init__(self
, *args
, **kwargs
):
3507 __init__(self) -> BMPHandler
3509 A `wx.ImageHandler` for \*.bmp bitmap files.
3511 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3512 _core_
.BMPHandler_swigregister(BMPHandler
)
3513 NullImage
= cvar
.NullImage
3514 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3515 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3516 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3517 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3518 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3519 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3520 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3521 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3522 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3523 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3524 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3525 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3526 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3527 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3528 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3530 class ICOHandler(BMPHandler
):
3531 """A `wx.ImageHandler` for \*.ico icon files."""
3532 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3533 __repr__
= _swig_repr
3534 def __init__(self
, *args
, **kwargs
):
3536 __init__(self) -> ICOHandler
3538 A `wx.ImageHandler` for \*.ico icon files.
3540 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3541 _core_
.ICOHandler_swigregister(ICOHandler
)
3543 class CURHandler(ICOHandler
):
3544 """A `wx.ImageHandler` for \*.cur cursor files."""
3545 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3546 __repr__
= _swig_repr
3547 def __init__(self
, *args
, **kwargs
):
3549 __init__(self) -> CURHandler
3551 A `wx.ImageHandler` for \*.cur cursor files.
3553 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3554 _core_
.CURHandler_swigregister(CURHandler
)
3556 class ANIHandler(CURHandler
):
3557 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3558 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3559 __repr__
= _swig_repr
3560 def __init__(self
, *args
, **kwargs
):
3562 __init__(self) -> ANIHandler
3564 A `wx.ImageHandler` for \*.ani animated cursor files.
3566 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3567 _core_
.ANIHandler_swigregister(ANIHandler
)
3569 class PNGHandler(ImageHandler
):
3570 """A `wx.ImageHandler` for PNG image files."""
3571 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3572 __repr__
= _swig_repr
3573 def __init__(self
, *args
, **kwargs
):
3575 __init__(self) -> PNGHandler
3577 A `wx.ImageHandler` for PNG image files.
3579 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3580 _core_
.PNGHandler_swigregister(PNGHandler
)
3582 class GIFHandler(ImageHandler
):
3583 """A `wx.ImageHandler` for GIF image files."""
3584 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3585 __repr__
= _swig_repr
3586 def __init__(self
, *args
, **kwargs
):
3588 __init__(self) -> GIFHandler
3590 A `wx.ImageHandler` for GIF image files.
3592 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3593 _core_
.GIFHandler_swigregister(GIFHandler
)
3595 class PCXHandler(ImageHandler
):
3596 """A `wx.ImageHandler` for PCX imager files."""
3597 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3598 __repr__
= _swig_repr
3599 def __init__(self
, *args
, **kwargs
):
3601 __init__(self) -> PCXHandler
3603 A `wx.ImageHandler` for PCX imager files.
3605 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3606 _core_
.PCXHandler_swigregister(PCXHandler
)
3608 class JPEGHandler(ImageHandler
):
3609 """A `wx.ImageHandler` for JPEG/JPG image files."""
3610 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3611 __repr__
= _swig_repr
3612 def __init__(self
, *args
, **kwargs
):
3614 __init__(self) -> JPEGHandler
3616 A `wx.ImageHandler` for JPEG/JPG image files.
3618 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3619 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3621 class PNMHandler(ImageHandler
):
3622 """A `wx.ImageHandler` for PNM image files."""
3623 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3624 __repr__
= _swig_repr
3625 def __init__(self
, *args
, **kwargs
):
3627 __init__(self) -> PNMHandler
3629 A `wx.ImageHandler` for PNM image files.
3631 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3632 _core_
.PNMHandler_swigregister(PNMHandler
)
3634 class XPMHandler(ImageHandler
):
3635 """A `wx.ImageHandler` for XPM image."""
3636 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3637 __repr__
= _swig_repr
3638 def __init__(self
, *args
, **kwargs
):
3640 __init__(self) -> XPMHandler
3642 A `wx.ImageHandler` for XPM image.
3644 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3645 _core_
.XPMHandler_swigregister(XPMHandler
)
3647 class TIFFHandler(ImageHandler
):
3648 """A `wx.ImageHandler` for TIFF image files."""
3649 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3650 __repr__
= _swig_repr
3651 def __init__(self
, *args
, **kwargs
):
3653 __init__(self) -> TIFFHandler
3655 A `wx.ImageHandler` for TIFF image files.
3657 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3658 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3660 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3661 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3662 class Quantize(object):
3663 """Performs quantization, or colour reduction, on a wxImage."""
3664 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3665 def __init__(self
): raise AttributeError, "No constructor defined"
3666 __repr__
= _swig_repr
3667 def Quantize(*args
, **kwargs
):
3669 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3671 Reduce the colours in the source image and put the result into the
3672 destination image, setting the palette in the destination if
3673 needed. Both images may be the same, to overwrite the source image.
3675 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3677 Quantize
= staticmethod(Quantize
)
3678 _core_
.Quantize_swigregister(Quantize
)
3680 def Quantize_Quantize(*args
, **kwargs
):
3682 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3684 Reduce the colours in the source image and put the result into the
3685 destination image, setting the palette in the destination if
3686 needed. Both images may be the same, to overwrite the source image.
3688 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3690 #---------------------------------------------------------------------------
3692 class EvtHandler(Object
):
3693 """Proxy of C++ EvtHandler class"""
3694 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3695 __repr__
= _swig_repr
3696 def __init__(self
, *args
, **kwargs
):
3697 """__init__(self) -> EvtHandler"""
3698 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3699 self
._setOORInfo
(self
)
3701 def GetNextHandler(*args
, **kwargs
):
3702 """GetNextHandler(self) -> EvtHandler"""
3703 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3705 def GetPreviousHandler(*args
, **kwargs
):
3706 """GetPreviousHandler(self) -> EvtHandler"""
3707 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3709 def SetNextHandler(*args
, **kwargs
):
3710 """SetNextHandler(self, EvtHandler handler)"""
3711 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3713 def SetPreviousHandler(*args
, **kwargs
):
3714 """SetPreviousHandler(self, EvtHandler handler)"""
3715 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3717 def GetEvtHandlerEnabled(*args
, **kwargs
):
3718 """GetEvtHandlerEnabled(self) -> bool"""
3719 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3721 def SetEvtHandlerEnabled(*args
, **kwargs
):
3722 """SetEvtHandlerEnabled(self, bool enabled)"""
3723 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3725 def ProcessEvent(*args
, **kwargs
):
3726 """ProcessEvent(self, Event event) -> bool"""
3727 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3729 def AddPendingEvent(*args
, **kwargs
):
3730 """AddPendingEvent(self, Event event)"""
3731 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3733 def ProcessPendingEvents(*args
, **kwargs
):
3734 """ProcessPendingEvents(self)"""
3735 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3737 def AllowReentrance(*args
, **kwargs
):
3738 """AllowReentrance(self, bool allow=True)"""
3739 return _core_
.EvtHandler_AllowReentrance(*args
, **kwargs
)
3741 def IsReentranceAllowed(*args
, **kwargs
):
3742 """IsReentranceAllowed(self) -> bool"""
3743 return _core_
.EvtHandler_IsReentranceAllowed(*args
, **kwargs
)
3745 def IsEventHandlingInProgress(*args
, **kwargs
):
3746 """IsEventHandlingInProgress(self) -> bool"""
3747 return _core_
.EvtHandler_IsEventHandlingInProgress(*args
, **kwargs
)
3749 def Connect(*args
, **kwargs
):
3750 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3751 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3753 def Disconnect(*args
, **kwargs
):
3754 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3755 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3757 def _setOORInfo(*args
, **kwargs
):
3758 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3759 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3763 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3765 Bind an event to an event handler.
3767 :param event: One of the EVT_* objects that specifies the
3768 type of event to bind,
3770 :param handler: A callable object to be invoked when the
3771 event is delivered to self. Pass None to
3772 disconnect an event handler.
3774 :param source: Sometimes the event originates from a
3775 different window than self, but you still
3776 want to catch it in self. (For example, a
3777 button event delivered to a frame.) By
3778 passing the source of the event, the event
3779 handling system is able to differentiate
3780 between the same event type from different
3783 :param id: Used to spcify the event source by ID instead
3786 :param id2: Used when it is desirable to bind a handler
3787 to a range of IDs, such as with EVT_MENU_RANGE.
3789 if source
is not None:
3791 event
.Bind(self
, id, id2
, handler
)
3793 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3795 Disconencts the event handler binding for event from self.
3796 Returns True if successful.
3798 if source
is not None:
3800 return event
.Unbind(self
, id, id2
)
3802 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3803 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3804 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3805 _core_
.EvtHandler_swigregister(EvtHandler
)
3807 #---------------------------------------------------------------------------
3809 class PyEventBinder(object):
3811 Instances of this class are used to bind specific events to event
3814 def __init__(self
, evtType
, expectedIDs
=0):
3815 if expectedIDs
not in [0, 1, 2]:
3816 raise ValueError, "Invalid number of expectedIDs"
3817 self
.expectedIDs
= expectedIDs
3819 if type(evtType
) == list or type(evtType
) == tuple:
3820 self
.evtType
= evtType
3822 self
.evtType
= [evtType
]
3825 def Bind(self
, target
, id1
, id2
, function
):
3826 """Bind this set of event types to target."""
3827 for et
in self
.evtType
:
3828 target
.Connect(id1
, id2
, et
, function
)
3831 def Unbind(self
, target
, id1
, id2
):
3832 """Remove an event binding."""
3834 for et
in self
.evtType
:
3835 success
+= target
.Disconnect(id1
, id2
, et
)
3839 def __call__(self
, *args
):
3841 For backwards compatibility with the old EVT_* functions.
3842 Should be called with either (window, func), (window, ID,
3843 func) or (window, ID1, ID2, func) parameters depending on the
3846 assert len(args
) == 2 + self
.expectedIDs
3850 if self
.expectedIDs
== 0:
3852 elif self
.expectedIDs
== 1:
3855 elif self
.expectedIDs
== 2:
3860 raise ValueError, "Unexpected number of IDs"
3862 self
.Bind(target
, id1
, id2
, func
)
3865 # These two are square pegs that don't fit the PyEventBinder hole...
3866 def EVT_COMMAND(win
, id, cmd
, func
):
3867 win
.Connect(id, -1, cmd
, func
)
3868 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3869 win
.Connect(id1
, id2
, cmd
, func
)
3872 #---------------------------------------------------------------------------
3874 #---------------------------------------------------------------------------
3876 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3877 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3879 def NewEventType(*args
):
3880 """NewEventType() -> EventType"""
3881 return _core_
.NewEventType(*args
)
3882 wxEVT_NULL
= _core_
.wxEVT_NULL
3883 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3884 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3885 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3886 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3887 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3888 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3889 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3890 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3891 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3892 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3893 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3894 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3895 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3896 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3897 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3898 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3899 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3900 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3901 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3902 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3903 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3904 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3905 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3906 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3907 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3908 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3909 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3910 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3911 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3912 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3913 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3914 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3915 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3916 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3917 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3918 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3919 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3920 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3921 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3922 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3923 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3924 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3925 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3926 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3927 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3928 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3929 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3930 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3931 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3932 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3933 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3934 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3935 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3936 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3937 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3938 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3939 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3940 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3941 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3942 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3943 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3944 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3945 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3946 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3947 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3948 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3949 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3950 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3951 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3952 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3953 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3954 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3955 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3956 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3957 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3958 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3959 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3960 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3961 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3962 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3963 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3964 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3965 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3966 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3967 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3968 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3969 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3970 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3971 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3972 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3973 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3974 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3975 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3976 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3977 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3978 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3979 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3980 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3981 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3982 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3983 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3984 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3985 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3986 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3987 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3988 wxEVT_SIZING
= _core_
.wxEVT_SIZING
3989 wxEVT_MOVING
= _core_
.wxEVT_MOVING
3990 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
3991 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
3992 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
3993 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
3994 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
3995 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
3996 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
3997 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
3998 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
3999 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
4000 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
4002 # Create some event binders
4003 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
4004 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
4005 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
4006 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
4007 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
4008 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4009 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4010 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
4011 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
4012 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
4013 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
4014 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
4015 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
4016 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
4017 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
4018 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
4019 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
4020 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
4021 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
4022 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
4023 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
4024 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
4025 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
4026 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
4027 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
4028 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4029 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4030 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
4031 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
4032 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
4033 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
4034 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
4035 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
4036 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
4037 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
4038 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
4039 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
4040 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
4041 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
4042 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
4043 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
4044 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
4046 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
4047 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
4048 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
4049 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
4050 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
4051 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
4052 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
4053 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
4054 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
4055 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
4056 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
4057 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
4058 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
4060 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
4068 wxEVT_MIDDLE_DCLICK
,
4076 # Scrolling from wxWindow (sent to wxScrolledWindow)
4077 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
4078 wxEVT_SCROLLWIN_BOTTOM
,
4079 wxEVT_SCROLLWIN_LINEUP
,
4080 wxEVT_SCROLLWIN_LINEDOWN
,
4081 wxEVT_SCROLLWIN_PAGEUP
,
4082 wxEVT_SCROLLWIN_PAGEDOWN
,
4083 wxEVT_SCROLLWIN_THUMBTRACK
,
4084 wxEVT_SCROLLWIN_THUMBRELEASE
,
4087 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
4088 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
4089 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
4090 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
4091 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
4092 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
4093 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
4094 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
4096 # Scrolling from wx.Slider and wx.ScrollBar
4097 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4098 wxEVT_SCROLL_BOTTOM
,
4099 wxEVT_SCROLL_LINEUP
,
4100 wxEVT_SCROLL_LINEDOWN
,
4101 wxEVT_SCROLL_PAGEUP
,
4102 wxEVT_SCROLL_PAGEDOWN
,
4103 wxEVT_SCROLL_THUMBTRACK
,
4104 wxEVT_SCROLL_THUMBRELEASE
,
4105 wxEVT_SCROLL_CHANGED
,
4108 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
4109 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
4110 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
4111 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
4112 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
4113 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
4114 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
4115 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
4116 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
4117 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
4119 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4120 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4121 wxEVT_SCROLL_BOTTOM
,
4122 wxEVT_SCROLL_LINEUP
,
4123 wxEVT_SCROLL_LINEDOWN
,
4124 wxEVT_SCROLL_PAGEUP
,
4125 wxEVT_SCROLL_PAGEDOWN
,
4126 wxEVT_SCROLL_THUMBTRACK
,
4127 wxEVT_SCROLL_THUMBRELEASE
,
4128 wxEVT_SCROLL_CHANGED
,
4131 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
4132 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
4133 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
4134 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
4135 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
4136 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
4137 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
4138 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
4139 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
4140 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
4142 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
4143 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
4144 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
4145 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
4146 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4147 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4148 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4149 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4150 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4151 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4153 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4154 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4155 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4156 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4157 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4158 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4159 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4160 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4161 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4164 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4165 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4166 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4167 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4168 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4169 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4170 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4172 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4174 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4175 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4177 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4179 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
4180 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
4181 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
4184 #---------------------------------------------------------------------------
4186 class Event(Object
):
4188 An event is a structure holding information about an event passed to a
4189 callback or member function. wx.Event is an abstract base class for
4192 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4193 def __init__(self
): raise AttributeError, "No constructor defined"
4194 __repr__
= _swig_repr
4195 __swig_destroy__
= _core_
.delete_Event
4196 __del__
= lambda self
: None;
4197 def SetEventType(*args
, **kwargs
):
4199 SetEventType(self, EventType typ)
4201 Sets the specific type of the event.
4203 return _core_
.Event_SetEventType(*args
, **kwargs
)
4205 def GetEventType(*args
, **kwargs
):
4207 GetEventType(self) -> EventType
4209 Returns the identifier of the given event type, such as
4210 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4212 return _core_
.Event_GetEventType(*args
, **kwargs
)
4214 def GetEventObject(*args
, **kwargs
):
4216 GetEventObject(self) -> Object
4218 Returns the object (usually a window) associated with the event, if
4221 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4223 def SetEventObject(*args
, **kwargs
):
4225 SetEventObject(self, Object obj)
4227 Sets the originating object, or in other words, obj is normally the
4228 object that is sending the event.
4230 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4232 def GetTimestamp(*args
, **kwargs
):
4233 """GetTimestamp(self) -> long"""
4234 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4236 def SetTimestamp(*args
, **kwargs
):
4237 """SetTimestamp(self, long ts=0)"""
4238 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4240 def GetId(*args
, **kwargs
):
4244 Returns the identifier associated with this event, such as a button
4247 return _core_
.Event_GetId(*args
, **kwargs
)
4249 def SetId(*args
, **kwargs
):
4253 Set's the ID for the event. This is usually the ID of the window that
4254 is sending the event, but it can also be a command id from a menu
4257 return _core_
.Event_SetId(*args
, **kwargs
)
4259 def IsCommandEvent(*args
, **kwargs
):
4261 IsCommandEvent(self) -> bool
4263 Returns true if the event is or is derived from `wx.CommandEvent` else
4264 it returns false. Note: Exists only for optimization purposes.
4266 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4268 def Skip(*args
, **kwargs
):
4270 Skip(self, bool skip=True)
4272 This method can be used inside an event handler to control whether
4273 further event handlers bound to this event will be called after the
4274 current one returns. Without Skip() (or equivalently if Skip(False) is
4275 used), the event will not be processed any more. If Skip(True) is
4276 called, the event processing system continues searching for a further
4277 handler function for this event, even though it has been processed
4278 already in the current handler.
4280 return _core_
.Event_Skip(*args
, **kwargs
)
4282 def GetSkipped(*args
, **kwargs
):
4284 GetSkipped(self) -> bool
4286 Returns true if the event handler should be skipped, false otherwise.
4289 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4291 def ShouldPropagate(*args
, **kwargs
):
4293 ShouldPropagate(self) -> bool
4295 Test if this event should be propagated to the parent window or not,
4296 i.e. if the propagation level is currently greater than 0.
4298 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4300 def StopPropagation(*args
, **kwargs
):
4302 StopPropagation(self) -> int
4304 Stop the event from propagating to its parent window. Returns the old
4305 propagation level value which may be later passed to
4306 `ResumePropagation` to allow propagating the event again.
4308 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4310 def ResumePropagation(*args
, **kwargs
):
4312 ResumePropagation(self, int propagationLevel)
4314 Resume the event propagation by restoring the propagation level. (For
4315 example, you can use the value returned by an earlier call to
4319 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4321 def Clone(*args
, **kwargs
):
4322 """Clone(self) -> Event"""
4323 return _core_
.Event_Clone(*args
, **kwargs
)
4325 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4326 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4327 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4328 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4329 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4330 _core_
.Event_swigregister(Event
)
4332 #---------------------------------------------------------------------------
4334 class PropagationDisabler(object):
4336 Helper class to temporarily change an event not to propagate. Simply
4337 create an instance of this class and then whe it is destroyed the
4338 propogation of the event will be restored.
4340 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4341 __repr__
= _swig_repr
4342 def __init__(self
, *args
, **kwargs
):
4344 __init__(self, Event event) -> PropagationDisabler
4346 Helper class to temporarily change an event not to propagate. Simply
4347 create an instance of this class and then whe it is destroyed the
4348 propogation of the event will be restored.
4350 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4351 __swig_destroy__
= _core_
.delete_PropagationDisabler
4352 __del__
= lambda self
: None;
4353 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4355 class PropagateOnce(object):
4357 A helper class that will temporarily lower propagation level of an
4358 event. Simply create an instance of this class and then whe it is
4359 destroyed the propogation of the event will be restored.
4361 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4362 __repr__
= _swig_repr
4363 def __init__(self
, *args
, **kwargs
):
4365 __init__(self, Event event) -> PropagateOnce
4367 A helper class that will temporarily lower propagation level of an
4368 event. Simply create an instance of this class and then whe it is
4369 destroyed the propogation of the event will be restored.
4371 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4372 __swig_destroy__
= _core_
.delete_PropagateOnce
4373 __del__
= lambda self
: None;
4374 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4376 #---------------------------------------------------------------------------
4378 class CommandEvent(Event
):
4380 This event class contains information about command events, which
4381 originate from a variety of simple controls, as well as menus and
4384 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4385 __repr__
= _swig_repr
4386 def __init__(self
, *args
, **kwargs
):
4388 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4390 This event class contains information about command events, which
4391 originate from a variety of simple controls, as well as menus and
4394 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4395 def GetSelection(*args
, **kwargs
):
4397 GetSelection(self) -> int
4399 Returns item index for a listbox or choice selection event (not valid
4402 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4404 def SetString(*args
, **kwargs
):
4405 """SetString(self, String s)"""
4406 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4408 def GetString(*args
, **kwargs
):
4410 GetString(self) -> String
4412 Returns item string for a listbox or choice selection event (not valid
4415 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4417 def IsChecked(*args
, **kwargs
):
4419 IsChecked(self) -> bool
4421 This method can be used with checkbox and menu events: for the
4422 checkboxes, the method returns true for a selection event and false
4423 for a deselection one. For the menu events, this method indicates if
4424 the menu item just has become checked or unchecked (and thus only
4425 makes sense for checkable menu items).
4427 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4430 def IsSelection(*args
, **kwargs
):
4432 IsSelection(self) -> bool
4434 For a listbox or similar event, returns true if it is a selection,
4435 false if it is a deselection.
4437 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4439 def SetExtraLong(*args
, **kwargs
):
4440 """SetExtraLong(self, long extraLong)"""
4441 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4443 def GetExtraLong(*args
, **kwargs
):
4445 GetExtraLong(self) -> long
4447 Returns extra information dependant on the event objects type. If the
4448 event comes from a listbox selection, it is a boolean determining
4449 whether the event was a selection (true) or a deselection (false). A
4450 listbox deselection only occurs for multiple-selection boxes, and in
4451 this case the index and string values are indeterminate and the
4452 listbox must be examined by the application.
4454 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4456 def SetInt(*args
, **kwargs
):
4457 """SetInt(self, int i)"""
4458 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4460 def GetInt(*args
, **kwargs
):
4464 Returns the integer identifier corresponding to a listbox, choice or
4465 radiobox selection (only if the event was a selection, not a
4466 deselection), or a boolean value representing the value of a checkbox.
4468 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4470 def GetClientData(*args
, **kwargs
):
4472 GetClientData(self) -> PyObject
4474 Returns the client data object for a listbox or choice selection event, (if any.)
4476 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4478 def SetClientData(*args
, **kwargs
):
4480 SetClientData(self, PyObject clientData)
4482 Associate the given client data with the item at position n.
4484 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4486 GetClientObject
= GetClientData
4487 SetClientObject
= SetClientData
4489 def Clone(*args
, **kwargs
):
4490 """Clone(self) -> Event"""
4491 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4493 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4494 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4495 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4496 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4497 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4498 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4499 _core_
.CommandEvent_swigregister(CommandEvent
)
4501 #---------------------------------------------------------------------------
4503 class NotifyEvent(CommandEvent
):
4505 An instance of this class (or one of its derived classes) is sent from
4506 a control when the control's state is being changed and the control
4507 allows that change to be prevented from happening. The event handler
4508 can call `Veto` or `Allow` to tell the control what to do.
4510 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4511 __repr__
= _swig_repr
4512 def __init__(self
, *args
, **kwargs
):
4514 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4516 An instance of this class (or one of its derived classes) is sent from
4517 a control when the control's state is being changed and the control
4518 allows that change to be prevented from happening. The event handler
4519 can call `Veto` or `Allow` to tell the control what to do.
4521 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4522 def Veto(*args
, **kwargs
):
4526 Prevents the change announced by this event from happening.
4528 It is in general a good idea to notify the user about the reasons for
4529 vetoing the change because otherwise the applications behaviour (which
4530 just refuses to do what the user wants) might be quite surprising.
4532 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4534 def Allow(*args
, **kwargs
):
4538 This is the opposite of `Veto`: it explicitly allows the event to be
4539 processed. For most events it is not necessary to call this method as
4540 the events are allowed anyhow but some are forbidden by default (this
4541 will be mentioned in the corresponding event description).
4543 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4545 def IsAllowed(*args
, **kwargs
):
4547 IsAllowed(self) -> bool
4549 Returns true if the change is allowed (`Veto` hasn't been called) or
4550 false otherwise (if it was).
4552 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4554 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4556 #---------------------------------------------------------------------------
4558 class ScrollEvent(CommandEvent
):
4560 A scroll event holds information about events sent from stand-alone
4561 scrollbars and sliders. Note that scrolled windows do not send
4562 instnaces of this event class, but send the `wx.ScrollWinEvent`
4565 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4566 __repr__
= _swig_repr
4567 def __init__(self
, *args
, **kwargs
):
4569 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4570 int orient=0) -> ScrollEvent
4572 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4573 def GetOrientation(*args
, **kwargs
):
4575 GetOrientation(self) -> int
4577 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4580 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4582 def GetPosition(*args
, **kwargs
):
4584 GetPosition(self) -> int
4586 Returns the position of the scrollbar.
4588 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4590 def SetOrientation(*args
, **kwargs
):
4591 """SetOrientation(self, int orient)"""
4592 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4594 def SetPosition(*args
, **kwargs
):
4595 """SetPosition(self, int pos)"""
4596 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4598 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4599 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4600 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4602 #---------------------------------------------------------------------------
4604 class ScrollWinEvent(Event
):
4606 A wx.ScrollWinEvent holds information about scrolling and is sent from
4609 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4610 __repr__
= _swig_repr
4611 def __init__(self
, *args
, **kwargs
):
4613 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4615 A wx.ScrollWinEvent holds information about scrolling and is sent from
4618 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4619 def GetOrientation(*args
, **kwargs
):
4621 GetOrientation(self) -> int
4623 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4626 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4628 def GetPosition(*args
, **kwargs
):
4630 GetPosition(self) -> int
4632 Returns the position of the scrollbar for the thumb track and release
4633 events. Note that this field can't be used for the other events, you
4634 need to query the window itself for the current position in that case.
4636 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4638 def SetOrientation(*args
, **kwargs
):
4639 """SetOrientation(self, int orient)"""
4640 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4642 def SetPosition(*args
, **kwargs
):
4643 """SetPosition(self, int pos)"""
4644 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4646 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4647 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4648 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4650 #---------------------------------------------------------------------------
4652 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4653 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4654 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4655 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4656 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4657 class MouseEvent(Event
):
4659 This event class contains information about the events generated by
4660 the mouse: they include mouse buttons press and release events and
4663 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4664 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4665 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4666 a middle button so a portable application should avoid relying on the
4669 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4670 the former returns true when the event corresponds to the left mouse
4671 button click while the latter returns true if the left mouse button is
4672 currently being pressed. For example, when the user is dragging the
4673 mouse you can use `LeftIsDown` to test whether the left mouse button
4674 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4675 `LeftIsDown` will also return true in wxWidgets whatever the
4676 underlying GUI behaviour is (which is platform-dependent). The same
4677 applies, of course, to other mouse buttons as well.
4679 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4680 __repr__
= _swig_repr
4681 def __init__(self
, *args
, **kwargs
):
4683 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4685 Constructs a wx.MouseEvent. Valid event types are:
4687 * wxEVT_ENTER_WINDOW
4688 * wxEVT_LEAVE_WINDOW
4694 * wxEVT_MIDDLE_DCLICK
4697 * wxEVT_RIGHT_DCLICK
4701 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4702 def IsButton(*args
, **kwargs
):
4704 IsButton(self) -> bool
4706 Returns true if the event was a mouse button event (not necessarily a
4707 button down event - that may be tested using `ButtonDown`).
4709 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4711 def ButtonDown(*args
, **kwargs
):
4713 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4715 If the argument is omitted, this returns true if the event was any
4716 mouse button down event. Otherwise the argument specifies which
4717 button-down event shold be checked for (see `Button` for the possible
4720 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4722 def ButtonDClick(*args
, **kwargs
):
4724 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4726 If the argument is omitted, this returns true if the event was any
4727 mouse double click event. Otherwise the argument specifies which
4728 double click event to check for (see `Button` for the possible
4731 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4733 def ButtonUp(*args
, **kwargs
):
4735 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4737 If the argument is omitted, this returns true if the event was any
4738 mouse button up event. Otherwise the argument specifies which button
4739 up event to check for (see `Button` for the possible values).
4741 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4743 def Button(*args
, **kwargs
):
4745 Button(self, int button) -> bool
4747 Returns true if the identified mouse button is changing state. Valid
4748 values of button are:
4750 ==================== =====================================
4751 wx.MOUSE_BTN_LEFT check if left button was pressed
4752 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4753 wx.MOUSE_BTN_RIGHT check if right button was pressed
4754 wx.MOUSE_BTN_ANY check if any button was pressed
4755 ==================== =====================================
4758 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4760 def ButtonIsDown(*args
, **kwargs
):
4761 """ButtonIsDown(self, int but) -> bool"""
4762 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4764 def GetButton(*args
, **kwargs
):
4766 GetButton(self) -> int
4768 Returns the mouse button which generated this event or
4769 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4770 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4771 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4772 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4773 right buttons respectively.
4775 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4777 def ControlDown(*args
, **kwargs
):
4779 ControlDown(self) -> bool
4781 Returns true if the control key was down at the time of the event.
4783 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4785 def MetaDown(*args
, **kwargs
):
4787 MetaDown(self) -> bool
4789 Returns true if the Meta key was down at the time of the event.
4791 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4793 def AltDown(*args
, **kwargs
):
4795 AltDown(self) -> bool
4797 Returns true if the Alt key was down at the time of the event.
4799 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4801 def ShiftDown(*args
, **kwargs
):
4803 ShiftDown(self) -> bool
4805 Returns true if the Shift key was down at the time of the event.
4807 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4809 def CmdDown(*args
, **kwargs
):
4811 CmdDown(self) -> bool
4813 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4814 platforms but the special "Apple" (a.k.a as "Command") key on
4815 Macs. It often makes sense to use it instead of, say, `ControlDown`
4816 because Cmd key is used for the same thing under Mac as Ctrl
4817 elsewhere. The Ctrl key still exists, it's just not used for this
4818 purpose. So for non-Mac platforms this is the same as `ControlDown`
4819 and Macs this is the same as `MetaDown`.
4821 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4823 def LeftDown(*args
, **kwargs
):
4825 LeftDown(self) -> bool
4827 Returns true if the left mouse button state changed to down.
4829 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4831 def MiddleDown(*args
, **kwargs
):
4833 MiddleDown(self) -> bool
4835 Returns true if the middle mouse button state changed to down.
4837 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4839 def RightDown(*args
, **kwargs
):
4841 RightDown(self) -> bool
4843 Returns true if the right mouse button state changed to down.
4845 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4847 def LeftUp(*args
, **kwargs
):
4849 LeftUp(self) -> bool
4851 Returns true if the left mouse button state changed to up.
4853 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4855 def MiddleUp(*args
, **kwargs
):
4857 MiddleUp(self) -> bool
4859 Returns true if the middle mouse button state changed to up.
4861 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4863 def RightUp(*args
, **kwargs
):
4865 RightUp(self) -> bool
4867 Returns true if the right mouse button state changed to up.
4869 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4871 def LeftDClick(*args
, **kwargs
):
4873 LeftDClick(self) -> bool
4875 Returns true if the event was a left button double click.
4877 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4879 def MiddleDClick(*args
, **kwargs
):
4881 MiddleDClick(self) -> bool
4883 Returns true if the event was a middle button double click.
4885 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4887 def RightDClick(*args
, **kwargs
):
4889 RightDClick(self) -> bool
4891 Returns true if the event was a right button double click.
4893 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4895 def LeftIsDown(*args
, **kwargs
):
4897 LeftIsDown(self) -> bool
4899 Returns true if the left mouse button is currently down, independent
4900 of the current event type.
4902 Please notice that it is not the same as LeftDown which returns true
4903 if the left mouse button was just pressed. Rather, it describes the
4904 state of the mouse button before the event happened.
4906 This event is usually used in the mouse event handlers which process
4907 "move mouse" messages to determine whether the user is (still)
4910 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4912 def MiddleIsDown(*args
, **kwargs
):
4914 MiddleIsDown(self) -> bool
4916 Returns true if the middle mouse button is currently down, independent
4917 of the current event type.
4919 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4921 def RightIsDown(*args
, **kwargs
):
4923 RightIsDown(self) -> bool
4925 Returns true if the right mouse button is currently down, independent
4926 of the current event type.
4928 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4930 def Dragging(*args
, **kwargs
):
4932 Dragging(self) -> bool
4934 Returns true if this was a dragging event (motion while a button is
4937 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4939 def Moving(*args
, **kwargs
):
4941 Moving(self) -> bool
4943 Returns true if this was a motion event and no mouse buttons were
4944 pressed. If any mouse button is held pressed, then this method returns
4945 false and Dragging returns true.
4947 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4949 def Entering(*args
, **kwargs
):
4951 Entering(self) -> bool
4953 Returns true if the mouse was entering the window.
4955 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4957 def Leaving(*args
, **kwargs
):
4959 Leaving(self) -> bool
4961 Returns true if the mouse was leaving the window.
4963 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4965 def GetPosition(*args
, **kwargs
):
4967 GetPosition(self) -> Point
4969 Returns the pixel position of the mouse in window coordinates when the
4972 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4974 def GetPositionTuple(*args
, **kwargs
):
4976 GetPositionTuple() -> (x,y)
4978 Returns the pixel position of the mouse in window coordinates when the
4981 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4983 def GetLogicalPosition(*args
, **kwargs
):
4985 GetLogicalPosition(self, DC dc) -> Point
4987 Returns the logical mouse position in pixels (i.e. translated
4988 according to the translation set for the DC, which usually indicates
4989 that the window has been scrolled).
4991 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
4993 def GetX(*args
, **kwargs
):
4997 Returns X coordinate of the physical mouse event position.
4999 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
5001 def GetY(*args
, **kwargs
):
5005 Returns Y coordinate of the physical mouse event position.
5007 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
5009 def GetWheelRotation(*args
, **kwargs
):
5011 GetWheelRotation(self) -> int
5013 Get wheel rotation, positive or negative indicates direction of
5014 rotation. Current devices all send an event when rotation is equal to
5015 +/-WheelDelta, but this allows for finer resolution devices to be
5016 created in the future. Because of this you shouldn't assume that one
5017 event is equal to 1 line or whatever, but you should be able to either
5018 do partial line scrolling or wait until +/-WheelDelta rotation values
5019 have been accumulated before scrolling.
5021 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
5023 def GetWheelDelta(*args
, **kwargs
):
5025 GetWheelDelta(self) -> int
5027 Get wheel delta, normally 120. This is the threshold for action to be
5028 taken, and one such action (for example, scrolling one increment)
5029 should occur for each delta.
5031 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
5033 def GetLinesPerAction(*args
, **kwargs
):
5035 GetLinesPerAction(self) -> int
5037 Returns the configured number of lines (or whatever) to be scrolled
5038 per wheel action. Defaults to three.
5040 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
5042 def IsPageScroll(*args
, **kwargs
):
5044 IsPageScroll(self) -> bool
5046 Returns true if the system has been setup to do page scrolling with
5047 the mouse wheel instead of line scrolling.
5049 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
5051 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
5052 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
5053 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
5054 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
5055 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
5056 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
5057 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
5058 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
5059 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
5060 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
5061 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
5062 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
5063 Button
= property(GetButton
,doc
="See `GetButton`")
5064 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
5065 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
5066 Position
= property(GetPosition
,doc
="See `GetPosition`")
5067 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
5068 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
5069 X
= property(GetX
,doc
="See `GetX`")
5070 Y
= property(GetY
,doc
="See `GetY`")
5071 _core_
.MouseEvent_swigregister(MouseEvent
)
5073 #---------------------------------------------------------------------------
5075 class SetCursorEvent(Event
):
5077 A SetCursorEvent is generated when the mouse cursor is about to be set
5078 as a result of mouse motion. This event gives the application the
5079 chance to perform specific mouse cursor processing based on the
5080 current position of the mouse within the window. Use the `SetCursor`
5081 method to specify the cursor you want to be displayed.
5083 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5084 __repr__
= _swig_repr
5085 def __init__(self
, *args
, **kwargs
):
5087 __init__(self, int x=0, int y=0) -> SetCursorEvent
5089 Construct a new `wx.SetCursorEvent`.
5091 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
5092 def GetX(*args
, **kwargs
):
5096 Returns the X coordinate of the mouse in client coordinates.
5098 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
5100 def GetY(*args
, **kwargs
):
5104 Returns the Y coordinate of the mouse in client coordinates.
5106 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5108 def SetCursor(*args
, **kwargs
):
5110 SetCursor(self, Cursor cursor)
5112 Sets the cursor associated with this event.
5114 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5116 def GetCursor(*args
, **kwargs
):
5118 GetCursor(self) -> Cursor
5120 Returns a reference to the cursor specified by this event.
5122 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5124 def HasCursor(*args
, **kwargs
):
5126 HasCursor(self) -> bool
5128 Returns true if the cursor specified by this event is a valid cursor.
5130 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5132 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
5133 X
= property(GetX
,doc
="See `GetX`")
5134 Y
= property(GetY
,doc
="See `GetY`")
5135 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
5137 #---------------------------------------------------------------------------
5139 class KeyEvent(Event
):
5141 This event class contains information about keypress and character
5142 events. These events are only sent to the widget that currently has
5145 Notice that there are three different kinds of keyboard events in
5146 wxWidgets: key down and up events and char events. The difference
5147 between the first two is clear - the first corresponds to a key press
5148 and the second to a key release - otherwise they are identical. Just
5149 note that if the key is maintained in a pressed state you will
5150 typically get a lot of (automatically generated) down events but only
5151 one up so it is wrong to assume that there is one up event
5152 corresponding to each down one.
5154 Both key events provide untranslated key codes while the char event
5155 carries the translated one. The untranslated code for alphanumeric
5156 keys is always an upper case value. For the other keys it is one of
5157 WXK_XXX values from the keycodes table. The translated key is, in
5158 general, the character the user expects to appear as the result of the
5159 key combination when typing the text into a text entry zone, for
5162 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5163 and the standard US keyboard): when the 'A' key is pressed, the key
5164 down event key code is equal to ASCII A == 65. But the char event key
5165 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5166 'A' keys simultaneously , the key code in key down event will still be
5167 just 'A' while the char event key code parameter will now be 'A' as
5170 Although in this simple case it is clear that the correct key code
5171 could be found in the key down event handler by checking the value
5172 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5173 as for non alphanumeric keys or non-US keyboard layouts the
5174 translation is keyboard-layout dependent and can only be done properly
5175 by the system itself.
5177 Another kind of translation is done when the control key is pressed:
5178 for example, for CTRL-A key press the key down event still carries the
5179 same key code 'A' as usual but the char event will have key code of 1,
5180 the ASCII value of this key combination.
5182 You may discover how the other keys on your system behave
5183 interactively by running the KeyEvents sample in the wxPython demo and
5184 pressing some keys while the blue box at the top has the keyboard
5187 **Note**: If a key down event is caught and the event handler does not
5188 call event.Skip() then the coresponding char event will not
5189 happen. This is by design and enables the programs that handle both
5190 types of events to be a bit simpler.
5192 **Note for Windows programmers**: The key and char events in wxWidgets
5193 are similar to but slightly different from Windows WM_KEYDOWN and
5194 WM_CHAR events. In particular, Alt-x combination will generate a char
5195 event in wxWidgets (unless it is used as an accelerator).
5197 **Tip**: be sure to call event.Skip() for events that you don't
5198 process in key event function, otherwise menu shortcuts may cease to
5202 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5203 __repr__
= _swig_repr
5204 def __init__(self
, *args
, **kwargs
):
5206 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5208 Construct a new `wx.KeyEvent`. Valid event types are:
5211 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
5212 def GetModifiers(*args
, **kwargs
):
5214 GetModifiers(self) -> int
5216 Returns a bitmask of the current modifier settings. Can be used to
5217 check if the key event has exactly the given modifiers without having
5218 to explicitly check that the other modifiers are not down. For
5221 if event.GetModifers() == wx.MOD_CONTROL:
5225 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5227 def ControlDown(*args
, **kwargs
):
5229 ControlDown(self) -> bool
5231 Returns ``True`` if the Control key was down at the time of the event.
5233 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5235 def MetaDown(*args
, **kwargs
):
5237 MetaDown(self) -> bool
5239 Returns ``True`` if the Meta key was down at the time of the event.
5241 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5243 def AltDown(*args
, **kwargs
):
5245 AltDown(self) -> bool
5247 Returns ``True`` if the Alt key was down at the time of the event.
5249 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5251 def ShiftDown(*args
, **kwargs
):
5253 ShiftDown(self) -> bool
5255 Returns ``True`` if the Shift key was down at the time of the event.
5257 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5259 def CmdDown(*args
, **kwargs
):
5261 CmdDown(self) -> bool
5263 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5264 platforms but the special "Apple" (a.k.a as "Command") key on
5265 Macs. It makes often sense to use it instead of, say, `ControlDown`
5266 because Cmd key is used for the same thing under Mac as Ctrl
5267 elsewhere. The Ctrl still exists, it's just not used for this
5268 purpose. So for non-Mac platforms this is the same as `ControlDown`
5269 and Macs this is the same as `MetaDown`.
5271 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5273 def HasModifiers(*args
, **kwargs
):
5275 HasModifiers(self) -> bool
5277 Returns true if either CTRL or ALT keys was down at the time of the
5278 key event. Note that this function does not take into account neither
5279 SHIFT nor META key states (the reason for ignoring the latter is that
5280 it is common for NUMLOCK key to be configured as META under X but the
5281 key presses even while NUMLOCK is on should be still processed
5284 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5286 def GetKeyCode(*args
, **kwargs
):
5288 GetKeyCode(self) -> int
5290 Returns the virtual key code. ASCII events return normal ASCII values,
5291 while non-ASCII events return values such as WXK_LEFT for the left
5292 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5295 Note that in Unicode build, the returned value is meaningful only if
5296 the user entered a character that can be represented in current
5297 locale's default charset. You can obtain the corresponding Unicode
5298 character using `GetUnicodeKey`.
5300 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5302 def GetUnicodeKey(*args
, **kwargs
):
5304 GetUnicodeKey(self) -> int
5306 Returns the Unicode character corresponding to this key event. This
5307 function is only meaningfule in a Unicode build of wxPython.
5309 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5311 GetUniChar
= GetUnicodeKey
5312 def SetUnicodeKey(*args
, **kwargs
):
5314 SetUnicodeKey(self, int uniChar)
5316 Set the Unicode value of the key event, but only if this is a Unicode
5319 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5321 def GetRawKeyCode(*args
, **kwargs
):
5323 GetRawKeyCode(self) -> unsigned int
5325 Returns the raw key code for this event. This is a platform-dependent
5326 scan code which should only be used in advanced
5327 applications. Currently the raw key codes are not supported by all
5330 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5332 def GetRawKeyFlags(*args
, **kwargs
):
5334 GetRawKeyFlags(self) -> unsigned int
5336 Returns the low level key flags for this event. The flags are
5337 platform-dependent and should only be used in advanced applications.
5338 Currently the raw key flags are not supported by all ports.
5340 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5342 def GetPosition(*args
, **kwargs
):
5344 GetPosition(self) -> Point
5346 Find the position of the event, if applicable.
5348 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5350 def GetPositionTuple(*args
, **kwargs
):
5352 GetPositionTuple() -> (x,y)
5354 Find the position of the event, if applicable.
5356 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5358 def GetX(*args
, **kwargs
):
5362 Returns the X position (in client coordinates) of the event, if
5365 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5367 def GetY(*args
, **kwargs
):
5371 Returns the Y position (in client coordinates) of the event, if
5374 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5376 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5377 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5378 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5379 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5380 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5381 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5382 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5383 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5384 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5385 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5386 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5387 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5388 Position
= property(GetPosition
,doc
="See `GetPosition`")
5389 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5390 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5391 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5392 X
= property(GetX
,doc
="See `GetX`")
5393 Y
= property(GetY
,doc
="See `GetY`")
5394 _core_
.KeyEvent_swigregister(KeyEvent
)
5396 #---------------------------------------------------------------------------
5398 class SizeEvent(Event
):
5400 A size event holds information about size change events. The EVT_SIZE
5401 handler function will be called when the window it is bound to has
5404 Note that the size passed is of the whole window: call
5405 `wx.Window.GetClientSize` for the area which may be used by the
5408 When a window is resized, usually only a small part of the window is
5409 damaged and and that area is all that is in the update region for the
5410 next paint event. However, if your drawing depends on the size of the
5411 window, you may need to clear the DC explicitly and repaint the whole
5412 window. In which case, you may need to call `wx.Window.Refresh` to
5413 invalidate the entire window.
5416 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5417 __repr__
= _swig_repr
5418 def __init__(self
, *args
, **kwargs
):
5420 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5422 Construct a new ``wx.SizeEvent``.
5424 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5425 def GetSize(*args
, **kwargs
):
5427 GetSize(self) -> Size
5429 Returns the entire size of the window generating the size change
5432 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5434 def GetRect(*args
, **kwargs
):
5435 """GetRect(self) -> Rect"""
5436 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5438 def SetRect(*args
, **kwargs
):
5439 """SetRect(self, Rect rect)"""
5440 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5442 def SetSize(*args
, **kwargs
):
5443 """SetSize(self, Size size)"""
5444 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5446 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5447 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5448 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5449 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5450 _core_
.SizeEvent_swigregister(SizeEvent
)
5452 #---------------------------------------------------------------------------
5454 class MoveEvent(Event
):
5456 This event object is sent for EVT_MOVE event bindings when a window is
5457 moved to a new position.
5459 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5460 __repr__
= _swig_repr
5461 def __init__(self
, *args
, **kwargs
):
5463 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5467 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5468 def GetPosition(*args
, **kwargs
):
5470 GetPosition(self) -> Point
5472 Returns the position of the window generating the move change event.
5474 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5476 def GetRect(*args
, **kwargs
):
5477 """GetRect(self) -> Rect"""
5478 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5480 def SetRect(*args
, **kwargs
):
5481 """SetRect(self, Rect rect)"""
5482 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5484 def SetPosition(*args
, **kwargs
):
5485 """SetPosition(self, Point pos)"""
5486 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5488 m_pos
= property(GetPosition
, SetPosition
)
5489 m_rect
= property(GetRect
, SetRect
)
5491 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5492 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5493 _core_
.MoveEvent_swigregister(MoveEvent
)
5495 #---------------------------------------------------------------------------
5497 class PaintEvent(Event
):
5499 A paint event is sent when a window's contents needs to be repainted.
5500 Note that in an EVT_PAINT handler the application must *always* create
5501 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5502 Windows assumes that the window has not been painted yet and will send
5503 the event again, causing endless refreshes.
5505 You can optimize painting by retrieving the rectangles that have been
5506 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5507 and only repainting these rectangles. The rectangles are in terms of
5508 the client area, and are unscrolled, so you will need to do some
5509 calculations using the current view position to obtain logical,
5513 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5514 __repr__
= _swig_repr
5515 def __init__(self
, *args
, **kwargs
):
5516 """__init__(self, int Id=0) -> PaintEvent"""
5517 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5518 _core_
.PaintEvent_swigregister(PaintEvent
)
5520 class NcPaintEvent(Event
):
5521 """Proxy of C++ NcPaintEvent class"""
5522 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5523 __repr__
= _swig_repr
5524 def __init__(self
, *args
, **kwargs
):
5525 """__init__(self, int winid=0) -> NcPaintEvent"""
5526 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5527 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5529 #---------------------------------------------------------------------------
5531 class EraseEvent(Event
):
5533 An erase event is sent whenever the background of a window needs to be
5534 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5535 binder. On some platforms, such as GTK+, this event is simulated
5536 (simply generated just before the paint event) and may cause flicker.
5538 To paint a custom background use the `GetDC` method and use the returned
5539 device context if it is not ``None``, otherwise create a temporary
5540 `wx.ClientDC` and draw on that.
5543 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5544 __repr__
= _swig_repr
5545 def __init__(self
, *args
, **kwargs
):
5547 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5551 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5552 def GetDC(*args
, **kwargs
):
5556 Returns the device context the event handler should draw upon. If
5557 ``None`` is returned then create a temporary `wx.ClientDC` and use
5560 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5562 DC
= property(GetDC
,doc
="See `GetDC`")
5563 _core_
.EraseEvent_swigregister(EraseEvent
)
5565 #---------------------------------------------------------------------------
5567 class FocusEvent(Event
):
5569 A focus event is sent when a window's focus changes. The window losing
5570 focus receives an EVT_KILL_FOCUS event while the window gaining it
5571 gets an EVT_SET_FOCUS event.
5573 Notice that the set focus event happens both when the user gives focus
5574 to the window (whether using the mouse or keyboard) and when it is
5575 done from the program itself using `wx.Window.SetFocus`.
5578 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5579 __repr__
= _swig_repr
5580 def __init__(self
, *args
, **kwargs
):
5582 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5586 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5587 def GetWindow(*args
, **kwargs
):
5589 GetWindow(self) -> Window
5591 Returns the other window associated with this event, that is the
5592 window which had the focus before for the EVT_SET_FOCUS event and the
5593 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5595 Warning: the window returned may be None!
5597 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5599 def SetWindow(*args
, **kwargs
):
5600 """SetWindow(self, Window win)"""
5601 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5603 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5604 _core_
.FocusEvent_swigregister(FocusEvent
)
5606 #---------------------------------------------------------------------------
5608 class ChildFocusEvent(CommandEvent
):
5610 A child focus event is sent to a (parent-)window when one of its child
5611 windows gains focus, so that the window could restore the focus back
5612 to its corresponding child if it loses it now and regains later.
5614 Notice that child window is the direct child of the window receiving
5615 the event, and so may not be the actual widget recieving focus if it
5616 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5617 to get the widget that is actually receiving focus.
5619 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5620 __repr__
= _swig_repr
5621 def __init__(self
, *args
, **kwargs
):
5623 __init__(self, Window win=None) -> ChildFocusEvent
5627 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5628 def GetWindow(*args
, **kwargs
):
5630 GetWindow(self) -> Window
5632 The window, or (grand)parent of the window which has just received the
5635 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5637 Window
= property(GetWindow
,doc
="See `GetWindow`")
5638 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5640 #---------------------------------------------------------------------------
5642 class ActivateEvent(Event
):
5644 An activate event is sent when a top-level window or the entire
5645 application is being activated or deactivated.
5647 A top-level window (a dialog or frame) receives an activate event when
5648 is being activated or deactivated. This is indicated visually by the
5649 title bar changing colour, and a subwindow gaining the keyboard focus.
5650 An application is activated or deactivated when one of its frames
5651 becomes activated, or a frame becomes inactivate resulting in all
5652 application frames being inactive.
5654 Please note that usually you should call event.Skip() in your handlers
5655 for these events so the default handlers will still be called, as not
5656 doing so can result in strange effects.
5659 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5660 __repr__
= _swig_repr
5661 def __init__(self
, *args
, **kwargs
):
5663 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5667 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5668 def GetActive(*args
, **kwargs
):
5670 GetActive(self) -> bool
5672 Returns true if the application or window is being activated, false
5675 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5677 Active
= property(GetActive
,doc
="See `GetActive`")
5678 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5680 #---------------------------------------------------------------------------
5682 class InitDialogEvent(Event
):
5684 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5685 any window when `wx.Window.InitDialog` is called. Handlers for this
5686 event can transfer data to the window, or anything else that should be
5687 done before the user begins editing the form. The default handler
5688 calls `wx.Window.TransferDataToWindow`.
5690 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5691 __repr__
= _swig_repr
5692 def __init__(self
, *args
, **kwargs
):
5694 __init__(self, int Id=0) -> InitDialogEvent
5698 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5699 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5701 #---------------------------------------------------------------------------
5703 class MenuEvent(Event
):
5705 This class is used for a variety of menu-related events. Note that
5706 these do not include menu command events, which are handled by sending
5707 `wx.CommandEvent` objects.
5709 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5710 text in the first field of the status bar.
5712 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5713 __repr__
= _swig_repr
5714 def __init__(self
, *args
, **kwargs
):
5716 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5720 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5721 def GetMenuId(*args
, **kwargs
):
5723 GetMenuId(self) -> int
5725 Returns the menu identifier associated with the event. This method
5726 should be only used with the HIGHLIGHT events.
5728 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5730 def IsPopup(*args
, **kwargs
):
5732 IsPopup(self) -> bool
5734 Returns ``True`` if the menu which is being opened or closed is a
5735 popup menu, ``False`` if it is a normal one. This method should only
5736 be used with the OPEN and CLOSE events.
5738 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5740 def GetMenu(*args
, **kwargs
):
5742 GetMenu(self) -> Menu
5744 Returns the menu which is being opened or closed. This method should
5745 only be used with the OPEN and CLOSE events.
5747 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5749 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5750 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5751 _core_
.MenuEvent_swigregister(MenuEvent
)
5753 #---------------------------------------------------------------------------
5755 class CloseEvent(Event
):
5757 This event class contains information about window and session close
5760 The handler function for EVT_CLOSE is called when the user has tried
5761 to close a a frame or dialog box using the window manager controls or
5762 the system menu. It can also be invoked by the application itself
5763 programmatically, for example by calling the `wx.Window.Close`
5766 You should check whether the application is forcing the deletion of
5767 the window using `CanVeto`. If it returns ``False``, you must destroy
5768 the window using `wx.Window.Destroy`. If the return value is ``True``,
5769 it is up to you whether you respond by destroying the window or not.
5770 For example you may wish to display a message dialog prompting to save
5771 files or to cancel the close.
5773 If you don't destroy the window, you should call `Veto` to let the
5774 calling code know that you did not destroy the window. This allows the
5775 `wx.Window.Close` function to return ``True`` or ``False`` depending
5776 on whether the close instruction was honored or not.
5778 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5779 __repr__
= _swig_repr
5780 def __init__(self
, *args
, **kwargs
):
5782 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5786 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5787 def SetLoggingOff(*args
, **kwargs
):
5789 SetLoggingOff(self, bool logOff)
5791 Sets the 'logging off' flag.
5793 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5795 def GetLoggingOff(*args
, **kwargs
):
5797 GetLoggingOff(self) -> bool
5799 Returns ``True`` if the user is logging off or ``False`` if the
5800 system is shutting down. This method can only be called for end
5801 session and query end session events, it doesn't make sense for close
5804 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5806 def Veto(*args
, **kwargs
):
5808 Veto(self, bool veto=True)
5810 Call this from your event handler to veto a system shutdown or to
5811 signal to the calling application that a window close did not happen.
5813 You can only veto a shutdown or close if `CanVeto` returns true.
5815 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5817 def GetVeto(*args
, **kwargs
):
5818 """GetVeto(self) -> bool"""
5819 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5821 def SetCanVeto(*args
, **kwargs
):
5823 SetCanVeto(self, bool canVeto)
5825 Sets the 'can veto' flag.
5827 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5829 def CanVeto(*args
, **kwargs
):
5831 CanVeto(self) -> bool
5833 Returns true if you can veto a system shutdown or a window close
5834 event. Vetoing a window close event is not possible if the calling
5835 code wishes to force the application to exit, and so this function
5836 must be called to check this.
5838 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5840 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5841 _core_
.CloseEvent_swigregister(CloseEvent
)
5843 #---------------------------------------------------------------------------
5845 class ShowEvent(Event
):
5846 """An EVT_SHOW event is sent when a window is shown or hidden."""
5847 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5848 __repr__
= _swig_repr
5849 def __init__(self
, *args
, **kwargs
):
5851 __init__(self, int winid=0, bool show=False) -> ShowEvent
5853 An EVT_SHOW event is sent when a window is shown or hidden.
5855 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5856 def SetShow(*args
, **kwargs
):
5857 """SetShow(self, bool show)"""
5858 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5860 def GetShow(*args
, **kwargs
):
5861 """GetShow(self) -> bool"""
5862 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5864 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5865 _core_
.ShowEvent_swigregister(ShowEvent
)
5867 #---------------------------------------------------------------------------
5869 class IconizeEvent(Event
):
5871 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5874 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5875 __repr__
= _swig_repr
5876 def __init__(self
, *args
, **kwargs
):
5878 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5880 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5883 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5884 def Iconized(*args
, **kwargs
):
5886 Iconized(self) -> bool
5888 Returns ``True`` if the frame has been iconized, ``False`` if it has
5891 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5893 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5895 #---------------------------------------------------------------------------
5897 class MaximizeEvent(Event
):
5898 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5899 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5900 __repr__
= _swig_repr
5901 def __init__(self
, *args
, **kwargs
):
5903 __init__(self, int id=0) -> MaximizeEvent
5905 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5907 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5908 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5910 #---------------------------------------------------------------------------
5912 class DropFilesEvent(Event
):
5914 This class is used for drop files events, that is, when files have
5915 been dropped onto the window. This functionality is only available
5916 under Windows. The window must have previously been enabled for
5917 dropping by calling `wx.Window.DragAcceptFiles`.
5919 Important note: this is a separate implementation to the more general
5920 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5921 implementation uses the older, Windows message-based approach of
5924 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5928 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5929 def __init__(self
): raise AttributeError, "No constructor defined"
5930 __repr__
= _swig_repr
5931 def GetPosition(*args
, **kwargs
):
5933 GetPosition(self) -> Point
5935 Returns the position at which the files were dropped.
5937 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5939 def GetNumberOfFiles(*args
, **kwargs
):
5941 GetNumberOfFiles(self) -> int
5943 Returns the number of files dropped.
5945 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5947 def GetFiles(*args
, **kwargs
):
5949 GetFiles(self) -> PyObject
5951 Returns a list of the filenames that were dropped.
5953 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5955 Files
= property(GetFiles
,doc
="See `GetFiles`")
5956 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5957 Position
= property(GetPosition
,doc
="See `GetPosition`")
5958 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5960 #---------------------------------------------------------------------------
5962 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5963 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5964 class UpdateUIEvent(CommandEvent
):
5966 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5967 wxWidgets to give an application the chance to update various user
5970 Without update UI events, an application has to work hard to
5971 check/uncheck, enable/disable, and set the text for elements such as
5972 menu items and toolbar buttons. The code for doing this has to be
5973 mixed up with the code that is invoked when an action is invoked for a
5974 menu item or button.
5976 With update UI events, you define an event handler to look at the
5977 state of the application and change UI elements accordingly. wxWidgets
5978 will call your handler functions in idle time, so you don't have to
5979 worry where to call this code. In addition to being a clearer and more
5980 declarative method, it also means you don't have to worry whether
5981 you're updating a toolbar or menubar identifier. The same handler can
5982 update a menu item and toolbar button, if the ID values are the same.
5984 Instead of directly manipulating the menu or button, you call
5985 functions in the event object, such as `Check`. wxWidgets will
5986 determine whether such a call has been made, and which UI element to
5989 These events will work for popup menus as well as menubars. Just
5990 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5991 any UI events for the window that owns the menu.
5993 If you find that the overhead of UI update processing is affecting
5994 your application, you can do one or both of the following:
5996 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5997 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5998 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5999 receive update events. No other windows will receive update
6002 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6003 value to set the delay between updates. You may need to call
6004 `wx.Window.UpdateWindowUI` at critical points, for example when
6005 a dialog is about to be shown, in case the user sees a slight
6006 delay before windows are updated.
6008 Note that although events are sent in idle time, defining a EVT_IDLE
6009 handler for a window does not affect this because the events are sent
6010 from an internal idle handler.
6012 wxWidgets tries to optimize update events on some platforms. On
6013 Windows and GTK+, events for menubar items are only sent when the menu
6014 is about to be shown, and not in idle time.
6017 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6018 __repr__
= _swig_repr
6019 def __init__(self
, *args
, **kwargs
):
6021 __init__(self, int commandId=0) -> UpdateUIEvent
6025 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
6026 def GetChecked(*args
, **kwargs
):
6028 GetChecked(self) -> bool
6030 Returns ``True`` if the UI element should be checked.
6032 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6034 def GetEnabled(*args
, **kwargs
):
6036 GetEnabled(self) -> bool
6038 Returns ``True`` if the UI element should be enabled.
6040 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6042 def GetShown(*args
, **kwargs
):
6044 GetShown(self) -> bool
6046 Returns ``True`` if the UI element should be shown.
6048 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6050 def GetText(*args
, **kwargs
):
6052 GetText(self) -> String
6054 Returns the text that should be set for the UI element.
6056 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6058 def GetSetText(*args
, **kwargs
):
6060 GetSetText(self) -> bool
6062 Returns ``True`` if the application has called `SetText`. For
6063 wxWidgets internal use only.
6065 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6067 def GetSetChecked(*args
, **kwargs
):
6069 GetSetChecked(self) -> bool
6071 Returns ``True`` if the application has called `Check`. For wxWidgets
6074 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6076 def GetSetEnabled(*args
, **kwargs
):
6078 GetSetEnabled(self) -> bool
6080 Returns ``True`` if the application has called `Enable`. For wxWidgets
6083 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6085 def GetSetShown(*args
, **kwargs
):
6087 GetSetShown(self) -> bool
6089 Returns ``True`` if the application has called `Show`. For wxWidgets
6092 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6094 def Check(*args
, **kwargs
):
6096 Check(self, bool check)
6098 Check or uncheck the UI element.
6100 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6102 def Enable(*args
, **kwargs
):
6104 Enable(self, bool enable)
6106 Enable or disable the UI element.
6108 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6110 def Show(*args
, **kwargs
):
6112 Show(self, bool show)
6114 Show or hide the UI element.
6116 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6118 def SetText(*args
, **kwargs
):
6120 SetText(self, String text)
6122 Sets the text for this UI element.
6124 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6126 def SetUpdateInterval(*args
, **kwargs
):
6128 SetUpdateInterval(long updateInterval)
6130 Sets the interval between updates in milliseconds. Set to -1 to
6131 disable updates, or to 0 to update as frequently as possible. The
6134 Use this to reduce the overhead of UI update events if your
6135 application has a lot of windows. If you set the value to -1 or
6136 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6137 at appropriate points in your application, such as when a dialog is
6140 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6142 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6143 def GetUpdateInterval(*args
, **kwargs
):
6145 GetUpdateInterval() -> long
6147 Returns the current interval between updates in milliseconds. -1
6148 disables updates, 0 updates as frequently as possible.
6150 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6152 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6153 def CanUpdate(*args
, **kwargs
):
6155 CanUpdate(Window win) -> bool
6157 Returns ``True`` if it is appropriate to update (send UI update events
6160 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6161 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6162 events were last sent in idle time, and the update interval, to
6163 determine whether events should be sent to this window now. By default
6164 this will always return true because the update mode is initially
6165 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6166 events will be sent as often as possible. You can reduce the frequency
6167 that events are sent by changing the mode and/or setting an update
6171 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6173 CanUpdate
= staticmethod(CanUpdate
)
6174 def ResetUpdateTime(*args
, **kwargs
):
6178 Used internally to reset the last-updated time to the current time. It
6179 is assumed that update events are normally sent in idle time, so this
6180 is called at the end of idle processing.
6182 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6184 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6185 def SetMode(*args
, **kwargs
):
6189 Specify how wxWidgets will send update events: to all windows, or only
6190 to those which specify that they will process the events.
6192 The mode may be one of the following values:
6194 ============================= ==========================================
6195 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6196 is the default setting.
6197 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6198 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6200 ============================= ==========================================
6203 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6205 SetMode
= staticmethod(SetMode
)
6206 def GetMode(*args
, **kwargs
):
6210 Returns a value specifying how wxWidgets will send update events: to
6211 all windows, or only to those which specify that they will process the
6214 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6216 GetMode
= staticmethod(GetMode
)
6217 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
6218 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
6219 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
6220 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
6221 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
6223 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6225 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6227 Sets the interval between updates in milliseconds. Set to -1 to
6228 disable updates, or to 0 to update as frequently as possible. The
6231 Use this to reduce the overhead of UI update events if your
6232 application has a lot of windows. If you set the value to -1 or
6233 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6234 at appropriate points in your application, such as when a dialog is
6237 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6239 def UpdateUIEvent_GetUpdateInterval(*args
):
6241 UpdateUIEvent_GetUpdateInterval() -> long
6243 Returns the current interval between updates in milliseconds. -1
6244 disables updates, 0 updates as frequently as possible.
6246 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
6248 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6250 UpdateUIEvent_CanUpdate(Window win) -> bool
6252 Returns ``True`` if it is appropriate to update (send UI update events
6255 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6256 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6257 events were last sent in idle time, and the update interval, to
6258 determine whether events should be sent to this window now. By default
6259 this will always return true because the update mode is initially
6260 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6261 events will be sent as often as possible. You can reduce the frequency
6262 that events are sent by changing the mode and/or setting an update
6266 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6268 def UpdateUIEvent_ResetUpdateTime(*args
):
6270 UpdateUIEvent_ResetUpdateTime()
6272 Used internally to reset the last-updated time to the current time. It
6273 is assumed that update events are normally sent in idle time, so this
6274 is called at the end of idle processing.
6276 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6278 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6280 UpdateUIEvent_SetMode(int mode)
6282 Specify how wxWidgets will send update events: to all windows, or only
6283 to those which specify that they will process the events.
6285 The mode may be one of the following values:
6287 ============================= ==========================================
6288 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6289 is the default setting.
6290 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6291 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6293 ============================= ==========================================
6296 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6298 def UpdateUIEvent_GetMode(*args
):
6300 UpdateUIEvent_GetMode() -> int
6302 Returns a value specifying how wxWidgets will send update events: to
6303 all windows, or only to those which specify that they will process the
6306 return _core_
.UpdateUIEvent_GetMode(*args
)
6308 #---------------------------------------------------------------------------
6310 class SysColourChangedEvent(Event
):
6312 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6313 when the user changes the colour settings using the control
6314 panel. This is only applicable under Windows.
6316 The default event handler for this event propagates the event to child
6317 windows, since Windows only sends the events to top-level windows. If
6318 intercepting this event for a top-level window, remember to call
6319 `Skip` so the the base class handler will still be executed, or to
6320 pass the event on to the window's children explicitly.
6323 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6324 __repr__
= _swig_repr
6325 def __init__(self
, *args
, **kwargs
):
6327 __init__(self) -> SysColourChangedEvent
6331 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6332 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6334 #---------------------------------------------------------------------------
6336 class MouseCaptureChangedEvent(Event
):
6338 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6339 a window that loses its mouse capture. This is called even if
6340 `wx.Window.ReleaseMouse` was called by the application code. Handling
6341 this event allows an application to cater for unexpected capture
6342 releases which might otherwise confuse mouse handling code.
6344 This event is implemented under Windows only.
6346 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6347 __repr__
= _swig_repr
6348 def __init__(self
, *args
, **kwargs
):
6350 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6354 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6355 def GetCapturedWindow(*args
, **kwargs
):
6357 GetCapturedWindow(self) -> Window
6359 Returns the window that gained the capture, or ``None`` if it was a
6360 non-wxWidgets window.
6362 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6364 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6365 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6367 #---------------------------------------------------------------------------
6369 class MouseCaptureLostEvent(Event
):
6371 A mouse capture lost event is sent to a window that obtained mouse
6372 capture, which was subsequently loss due to "external" event, for
6373 example when a dialog box is shown or if another application captures
6376 If this happens, this event is sent to all windows that are on the
6377 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6378 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6379 if the capture changes because of a call to CaptureMouse or
6382 This event is currently emitted under Windows only.
6385 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6386 __repr__
= _swig_repr
6387 def __init__(self
, *args
, **kwargs
):
6389 __init__(self, int winid=0) -> MouseCaptureLostEvent
6391 A mouse capture lost event is sent to a window that obtained mouse
6392 capture, which was subsequently loss due to "external" event, for
6393 example when a dialog box is shown or if another application captures
6396 If this happens, this event is sent to all windows that are on the
6397 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6398 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6399 if the capture changes because of a call to CaptureMouse or
6402 This event is currently emitted under Windows only.
6405 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6406 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6408 #---------------------------------------------------------------------------
6410 class DisplayChangedEvent(Event
):
6412 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6413 resolution has changed.
6415 This event is implemented under Windows only.
6417 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6418 __repr__
= _swig_repr
6419 def __init__(self
, *args
, **kwargs
):
6420 """__init__(self) -> DisplayChangedEvent"""
6421 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6422 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6424 #---------------------------------------------------------------------------
6426 class PaletteChangedEvent(Event
):
6428 An EVT_PALETTE_CHANGED event is sent when the system palette has
6429 changed, thereby giving each window a chance to redo their own to
6432 This event is implemented under Windows only.
6434 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6435 __repr__
= _swig_repr
6436 def __init__(self
, *args
, **kwargs
):
6438 __init__(self, int id=0) -> PaletteChangedEvent
6440 An EVT_PALETTE_CHANGED event is sent when the system palette has
6441 changed, thereby giving each window a chance to redo their own to
6444 This event is implemented under Windows only.
6446 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6447 def SetChangedWindow(*args
, **kwargs
):
6448 """SetChangedWindow(self, Window win)"""
6449 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6451 def GetChangedWindow(*args
, **kwargs
):
6452 """GetChangedWindow(self) -> Window"""
6453 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6455 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6456 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6458 #---------------------------------------------------------------------------
6460 class QueryNewPaletteEvent(Event
):
6462 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6463 focus and should re-do its palette.
6465 This event is implemented under Windows only.
6467 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6468 __repr__
= _swig_repr
6469 def __init__(self
, *args
, **kwargs
):
6471 __init__(self, int winid=0) -> QueryNewPaletteEvent
6475 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6476 def SetPaletteRealized(*args
, **kwargs
):
6478 SetPaletteRealized(self, bool realized)
6480 App should set this if it changes the palette.
6482 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6484 def GetPaletteRealized(*args
, **kwargs
):
6485 """GetPaletteRealized(self) -> bool"""
6486 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6488 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6489 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6491 #---------------------------------------------------------------------------
6493 class NavigationKeyEvent(Event
):
6495 EVT_NAVIGATION_KEY events are used to control moving the focus between
6496 widgets, otherwise known as tab-traversal. You woudl normally not
6497 catch navigation events in applications as there are already
6498 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6499 it useful to send navigation events in certain situations to change
6500 the focus in certain ways, although it's probably easier to just call
6501 `wx.Window.Navigate`.
6503 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6504 __repr__
= _swig_repr
6505 def __init__(self
, *args
, **kwargs
):
6506 """__init__(self) -> NavigationKeyEvent"""
6507 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6508 def GetDirection(*args
, **kwargs
):
6510 GetDirection(self) -> bool
6512 Returns ``True`` if the direction is forward, ``False`` otherwise.
6514 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6516 def SetDirection(*args
, **kwargs
):
6518 SetDirection(self, bool forward)
6520 Specify the direction that the navigation should take. Usually the
6521 difference between using Tab and Shift-Tab.
6523 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6525 def IsWindowChange(*args
, **kwargs
):
6527 IsWindowChange(self) -> bool
6529 Returns ``True`` if window change is allowed.
6531 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6533 def SetWindowChange(*args
, **kwargs
):
6535 SetWindowChange(self, bool ischange)
6537 Specify if the navigation should be able to change parent windows.
6538 For example, changing notebook pages, etc. This is usually implemented
6539 by using Control-Tab.
6541 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6543 def IsFromTab(*args
, **kwargs
):
6545 IsFromTab(self) -> bool
6547 Returns ``True`` if the navigation event is originated from the Tab
6550 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6552 def SetFromTab(*args
, **kwargs
):
6554 SetFromTab(self, bool bIs)
6556 Set to true under MSW if the event was generated using the tab key.
6557 This is required for proper navogation over radio buttons.
6559 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6561 def SetFlags(*args
, **kwargs
):
6563 SetFlags(self, long flags)
6565 Set the navigation flags to a combination of the following:
6567 * wx.NavigationKeyEvent.IsBackward
6568 * wx.NavigationKeyEvent.IsForward
6569 * wx.NavigationKeyEvent.WinChange
6570 * wx.NavigationKeyEvent.FromTab
6573 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6575 def GetCurrentFocus(*args
, **kwargs
):
6577 GetCurrentFocus(self) -> Window
6579 Returns the child window which currenty has the focus. May be
6582 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6584 def SetCurrentFocus(*args
, **kwargs
):
6586 SetCurrentFocus(self, Window win)
6588 Set the window that has the focus.
6590 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6592 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6593 IsForward
= _core_
.NavigationKeyEvent_IsForward
6594 WinChange
= _core_
.NavigationKeyEvent_WinChange
6595 FromTab
= _core_
.NavigationKeyEvent_FromTab
6596 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6597 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6598 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6600 #---------------------------------------------------------------------------
6602 class WindowCreateEvent(CommandEvent
):
6604 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6605 underlying GUI object) exists.
6607 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6608 __repr__
= _swig_repr
6609 def __init__(self
, *args
, **kwargs
):
6611 __init__(self, Window win=None) -> WindowCreateEvent
6613 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6614 underlying GUI object) exists.
6616 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6617 def GetWindow(*args
, **kwargs
):
6619 GetWindow(self) -> Window
6621 Returns the window that this event refers to.
6623 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6625 Window
= property(GetWindow
,doc
="See `GetWindow`")
6626 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6628 class WindowDestroyEvent(CommandEvent
):
6630 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6631 when the GUI window is destroyed.
6633 When a class derived from `wx.Window` is destroyed its destructor will
6634 have already run by the time this event is sent. Therefore this event
6635 will not usually be received at all by the window itself. Since it is
6636 received after the destructor has run, an object should not try to
6637 handle its own wx.WindowDestroyEvent, but it can be used to get
6638 notification of the destruction of another window.
6640 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6641 __repr__
= _swig_repr
6642 def __init__(self
, *args
, **kwargs
):
6644 __init__(self, Window win=None) -> WindowDestroyEvent
6646 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6647 when the GUI window is destroyed.
6649 When a class derived from `wx.Window` is destroyed its destructor will
6650 have already run by the time this event is sent. Therefore this event
6651 will not usually be received at all by the window itself. Since it is
6652 received after the destructor has run, an object should not try to
6653 handle its own wx.WindowDestroyEvent, but it can be used to get
6654 notification of the destruction of another window.
6656 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6657 def GetWindow(*args
, **kwargs
):
6659 GetWindow(self) -> Window
6661 Returns the window that this event refers to.
6663 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6665 Window
= property(GetWindow
,doc
="See `GetWindow`")
6666 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6668 #---------------------------------------------------------------------------
6670 class ContextMenuEvent(CommandEvent
):
6672 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6673 give the application a chance to show a context (popup) menu.
6675 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6676 __repr__
= _swig_repr
6677 def __init__(self
, *args
, **kwargs
):
6679 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6683 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6684 def GetPosition(*args
, **kwargs
):
6686 GetPosition(self) -> Point
6688 Returns the position (in screen coordinants) at which the menu should
6691 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6693 def SetPosition(*args
, **kwargs
):
6695 SetPosition(self, Point pos)
6697 Sets the position at which the menu should be shown.
6699 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6701 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6702 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6704 #---------------------------------------------------------------------------
6706 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6707 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6708 class IdleEvent(Event
):
6710 This class is used for EVT_IDLE events, which are generated and sent
6711 when the application *becomes* idle. In other words, the when the
6712 event queue becomes empty then idle events are sent to all windows (by
6713 default) and as long as none of them call `RequestMore` then there are
6714 no more idle events until after the system event queue has some normal
6715 events and then becomes empty again.
6717 By default, idle events are sent to all windows. If this is causing a
6718 significant overhead in your application, you can call
6719 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6720 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6721 which should receive idle events. Then idle events will only be sent
6722 to those windows and not to any others.
6724 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6725 __repr__
= _swig_repr
6726 def __init__(self
, *args
, **kwargs
):
6728 __init__(self) -> IdleEvent
6732 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6733 def RequestMore(*args
, **kwargs
):
6735 RequestMore(self, bool needMore=True)
6737 Tells wxWidgets that more processing is required. This function can be
6738 called by an EVT_IDLE handler for a window to indicate that the
6739 application should forward the EVT_IDLE event once more to the
6740 application windows. If no window calls this function during its
6741 EVT_IDLE handler, then the application will remain in a passive event
6742 loop until a new event is posted to the application by the windowing
6745 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6747 def MoreRequested(*args
, **kwargs
):
6749 MoreRequested(self) -> bool
6751 Returns ``True`` if the OnIdle function processing this event
6752 requested more processing time.
6754 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6756 def SetMode(*args
, **kwargs
):
6760 Static method for specifying how wxWidgets will send idle events: to
6761 all windows, or only to those which specify that they will process the
6764 The mode can be one of the following values:
6766 ========================= ========================================
6767 wx.IDLE_PROCESS_ALL Send idle events to all windows
6768 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6769 the wx.WS_EX_PROCESS_IDLE extra style
6771 ========================= ========================================
6774 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6776 SetMode
= staticmethod(SetMode
)
6777 def GetMode(*args
, **kwargs
):
6781 Static method returning a value specifying how wxWidgets will send
6782 idle events: to all windows, or only to those which specify that they
6783 will process the events.
6785 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6787 GetMode
= staticmethod(GetMode
)
6788 def CanSend(*args
, **kwargs
):
6790 CanSend(Window win) -> bool
6792 Returns ``True`` if it is appropriate to send idle events to this
6795 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6796 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6797 events should be sent to this window now. By default this will always
6798 return ``True`` because the update mode is initially
6799 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6800 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6802 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6804 CanSend
= staticmethod(CanSend
)
6805 _core_
.IdleEvent_swigregister(IdleEvent
)
6807 def IdleEvent_SetMode(*args
, **kwargs
):
6809 IdleEvent_SetMode(int mode)
6811 Static method for specifying how wxWidgets will send idle events: to
6812 all windows, or only to those which specify that they will process the
6815 The mode can be one of the following values:
6817 ========================= ========================================
6818 wx.IDLE_PROCESS_ALL Send idle events to all windows
6819 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6820 the wx.WS_EX_PROCESS_IDLE extra style
6822 ========================= ========================================
6825 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6827 def IdleEvent_GetMode(*args
):
6829 IdleEvent_GetMode() -> int
6831 Static method returning a value specifying how wxWidgets will send
6832 idle events: to all windows, or only to those which specify that they
6833 will process the events.
6835 return _core_
.IdleEvent_GetMode(*args
)
6837 def IdleEvent_CanSend(*args
, **kwargs
):
6839 IdleEvent_CanSend(Window win) -> bool
6841 Returns ``True`` if it is appropriate to send idle events to this
6844 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6845 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6846 events should be sent to this window now. By default this will always
6847 return ``True`` because the update mode is initially
6848 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6849 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6851 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6853 #---------------------------------------------------------------------------
6855 class ClipboardTextEvent(CommandEvent
):
6857 A Clipboard Text event is sent when a window intercepts a text
6858 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6859 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6860 popup menu command, etc. NOTE : under windows these events are *NOT*
6861 generated automatically for a Rich Edit text control.
6863 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6864 __repr__
= _swig_repr
6865 def __init__(self
, *args
, **kwargs
):
6867 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6869 A Clipboard Text event is sent when a window intercepts a text
6870 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6871 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6872 popup menu command, etc. NOTE : under windows these events are *NOT*
6873 generated automatically for a Rich Edit text control.
6875 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6876 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6878 #---------------------------------------------------------------------------
6880 class PyEvent(Event
):
6882 wx.PyEvent can be used as a base class for implementing custom event
6883 types in Python. You should derived from this class instead of
6884 `wx.Event` because this class is Python-aware and is able to transport
6885 its Python bits safely through the wxWidgets event system and have
6886 them still be there when the event handler is invoked.
6888 :see: `wx.PyCommandEvent`
6891 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6892 __repr__
= _swig_repr
6893 def __init__(self
, *args
, **kwargs
):
6894 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6895 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6898 __swig_destroy__
= _core_
.delete_PyEvent
6899 __del__
= lambda self
: None;
6900 def _SetSelf(*args
, **kwargs
):
6901 """_SetSelf(self, PyObject self)"""
6902 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6904 def _GetSelf(*args
, **kwargs
):
6905 """_GetSelf(self) -> PyObject"""
6906 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6908 _core_
.PyEvent_swigregister(PyEvent
)
6910 class PyCommandEvent(CommandEvent
):
6912 wx.PyCommandEvent can be used as a base class for implementing custom
6913 event types in Python, where the event shoudl travel up to parent
6914 windows looking for a handler. You should derived from this class
6915 instead of `wx.CommandEvent` because this class is Python-aware and is
6916 able to transport its Python bits safely through the wxWidgets event
6917 system and have them still be there when the event handler is invoked.
6922 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6923 __repr__
= _swig_repr
6924 def __init__(self
, *args
, **kwargs
):
6925 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6926 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6929 __swig_destroy__
= _core_
.delete_PyCommandEvent
6930 __del__
= lambda self
: None;
6931 def _SetSelf(*args
, **kwargs
):
6932 """_SetSelf(self, PyObject self)"""
6933 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6935 def _GetSelf(*args
, **kwargs
):
6936 """_GetSelf(self) -> PyObject"""
6937 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6939 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6941 class DateEvent(CommandEvent
):
6943 This event class holds information about a date change event and is
6944 used together with `wx.DatePickerCtrl`. It also serves as a base class
6945 for `wx.calendar.CalendarEvent`. Bind these event types with
6948 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6949 __repr__
= _swig_repr
6950 def __init__(self
, *args
, **kwargs
):
6951 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6952 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6953 def GetDate(*args
, **kwargs
):
6955 GetDate(self) -> DateTime
6959 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6961 def SetDate(*args
, **kwargs
):
6963 SetDate(self, DateTime date)
6965 Sets the date carried by the event, normally only used by the library
6968 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6970 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6971 _core_
.DateEvent_swigregister(DateEvent
)
6973 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6974 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6976 #---------------------------------------------------------------------------
6978 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6979 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6980 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6981 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6982 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6983 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6984 class PyApp(EvtHandler
):
6986 The ``wx.PyApp`` class is an *implementation detail*, please use the
6987 `wx.App` class (or some other derived class) instead.
6989 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6990 __repr__
= _swig_repr
6991 def __init__(self
, *args
, **kwargs
):
6993 __init__(self) -> PyApp
6995 Create a new application object, starting the bootstrap process.
6997 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
6998 self
._setCallbackInfo
(self
, PyApp
, False)
6999 self
._setOORInfo
(self
, False)
7001 __swig_destroy__
= _core_
.delete_PyApp
7002 __del__
= lambda self
: None;
7003 def _setCallbackInfo(*args
, **kwargs
):
7004 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
7005 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
7007 def GetAppName(*args
, **kwargs
):
7009 GetAppName(self) -> String
7011 Get the application name.
7013 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
7015 def SetAppName(*args
, **kwargs
):
7017 SetAppName(self, String name)
7019 Set the application name. This value may be used automatically by
7020 `wx.Config` and such.
7022 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
7024 def GetClassName(*args
, **kwargs
):
7026 GetClassName(self) -> String
7028 Get the application's class name.
7030 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
7032 def SetClassName(*args
, **kwargs
):
7034 SetClassName(self, String name)
7036 Set the application's class name. This value may be used for
7037 X-resources if applicable for the platform
7039 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
7041 def GetVendorName(*args
, **kwargs
):
7043 GetVendorName(self) -> String
7045 Get the application's vendor name.
7047 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
7049 def SetVendorName(*args
, **kwargs
):
7051 SetVendorName(self, String name)
7053 Set the application's vendor name. This value may be used
7054 automatically by `wx.Config` and such.
7056 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
7058 def GetTraits(*args
, **kwargs
):
7060 GetTraits(self) -> wxAppTraits
7062 Return (and create if necessary) the app traits object to which we
7063 delegate for everything which either should be configurable by the
7064 user (then he can change the default behaviour simply by overriding
7065 CreateTraits() and returning his own traits object) or which is
7066 GUI/console dependent as then wx.AppTraits allows us to abstract the
7067 differences behind the common facade.
7069 :todo: Add support for overriding CreateAppTraits in wxPython.
7071 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
7073 def ProcessPendingEvents(*args
, **kwargs
):
7075 ProcessPendingEvents(self)
7077 Process all events in the Pending Events list -- it is necessary to
7078 call this function to process posted events. This normally happens
7079 during each event loop iteration.
7081 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
7083 def Yield(*args
, **kwargs
):
7085 Yield(self, bool onlyIfNeeded=False) -> bool
7087 Process all currently pending events right now, instead of waiting
7088 until return to the event loop. It is an error to call ``Yield``
7089 recursively unless the value of ``onlyIfNeeded`` is True.
7091 :warning: This function is dangerous as it can lead to unexpected
7092 reentrancies (i.e. when called from an event handler it may
7093 result in calling the same event handler again), use with
7094 extreme care or, better, don't use at all!
7096 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7099 return _core_
.PyApp_Yield(*args
, **kwargs
)
7101 def WakeUpIdle(*args
, **kwargs
):
7105 Make sure that idle events are sent again.
7106 :see: `wx.WakeUpIdle`
7108 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
7110 def IsMainLoopRunning(*args
, **kwargs
):
7112 IsMainLoopRunning() -> bool
7114 Returns True if we're running the main loop, i.e. if the events can
7115 currently be dispatched.
7117 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7119 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
7120 def MainLoop(*args
, **kwargs
):
7122 MainLoop(self) -> int
7124 Execute the main GUI loop, the function doesn't normally return until
7125 all top level windows have been closed and destroyed.
7127 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
7129 def Exit(*args
, **kwargs
):
7133 Exit the main loop thus terminating the application.
7136 return _core_
.PyApp_Exit(*args
, **kwargs
)
7138 def GetLayoutDirection(*args
, **kwargs
):
7140 GetLayoutDirection(self) -> int
7142 Return the layout direction for the current locale.
7144 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
7146 def ExitMainLoop(*args
, **kwargs
):
7150 Exit the main GUI loop during the next iteration of the main
7151 loop, (i.e. it does not stop the program immediately!)
7153 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
7155 def Pending(*args
, **kwargs
):
7157 Pending(self) -> bool
7159 Returns True if there are unprocessed events in the event queue.
7161 return _core_
.PyApp_Pending(*args
, **kwargs
)
7163 def Dispatch(*args
, **kwargs
):
7165 Dispatch(self) -> bool
7167 Process the first event in the event queue (blocks until an event
7168 appears if there are none currently)
7170 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
7172 def ProcessIdle(*args
, **kwargs
):
7174 ProcessIdle(self) -> bool
7176 Called from the MainLoop when the application becomes idle (there are
7177 no pending events) and sends a `wx.IdleEvent` to all interested
7178 parties. Returns True if more idle events are needed, False if not.
7180 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
7182 def SendIdleEvents(*args
, **kwargs
):
7184 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7186 Send idle event to window and all subwindows. Returns True if more
7187 idle time is requested.
7189 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
7191 def IsActive(*args
, **kwargs
):
7193 IsActive(self) -> bool
7195 Return True if our app has focus.
7197 return _core_
.PyApp_IsActive(*args
, **kwargs
)
7199 def SetTopWindow(*args
, **kwargs
):
7201 SetTopWindow(self, Window win)
7203 Set the *main* top level window
7205 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
7207 def GetTopWindow(*args
, **kwargs
):
7209 GetTopWindow(self) -> Window
7211 Return the *main* top level window (if it hadn't been set previously
7212 with SetTopWindow(), will return just some top level window and, if
7213 there not any, will return None)
7215 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
7217 def SetExitOnFrameDelete(*args
, **kwargs
):
7219 SetExitOnFrameDelete(self, bool flag)
7221 Control the exit behaviour: by default, the program will exit the main
7222 loop (and so, usually, terminate) when the last top-level program
7223 window is deleted. Beware that if you disable this behaviour (with
7224 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7225 explicitly from somewhere.
7227 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
7229 def GetExitOnFrameDelete(*args
, **kwargs
):
7231 GetExitOnFrameDelete(self) -> bool
7233 Get the current exit behaviour setting.
7235 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
7237 def SetUseBestVisual(*args
, **kwargs
):
7239 SetUseBestVisual(self, bool flag)
7241 Set whether the app should try to use the best available visual on
7242 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7244 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
7246 def GetUseBestVisual(*args
, **kwargs
):
7248 GetUseBestVisual(self) -> bool
7250 Get current UseBestVisual setting.
7252 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7254 def SetPrintMode(*args
, **kwargs
):
7255 """SetPrintMode(self, int mode)"""
7256 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7258 def GetPrintMode(*args
, **kwargs
):
7259 """GetPrintMode(self) -> int"""
7260 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7262 def SetAssertMode(*args
, **kwargs
):
7264 SetAssertMode(self, int mode)
7266 Set the OnAssert behaviour for debug and hybrid builds.
7268 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7270 def GetAssertMode(*args
, **kwargs
):
7272 GetAssertMode(self) -> int
7274 Get the current OnAssert behaviour setting.
7276 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7278 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7279 """GetMacSupportPCMenuShortcuts() -> bool"""
7280 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7282 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7283 def GetMacAboutMenuItemId(*args
, **kwargs
):
7284 """GetMacAboutMenuItemId() -> long"""
7285 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7287 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7288 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7289 """GetMacPreferencesMenuItemId() -> long"""
7290 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7292 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7293 def GetMacExitMenuItemId(*args
, **kwargs
):
7294 """GetMacExitMenuItemId() -> long"""
7295 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7297 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7298 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7299 """GetMacHelpMenuTitleName() -> String"""
7300 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7302 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7303 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7304 """SetMacSupportPCMenuShortcuts(bool val)"""
7305 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7307 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7308 def SetMacAboutMenuItemId(*args
, **kwargs
):
7309 """SetMacAboutMenuItemId(long val)"""
7310 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7312 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7313 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7314 """SetMacPreferencesMenuItemId(long val)"""
7315 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7317 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7318 def SetMacExitMenuItemId(*args
, **kwargs
):
7319 """SetMacExitMenuItemId(long val)"""
7320 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7322 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7323 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7324 """SetMacHelpMenuTitleName(String val)"""
7325 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7327 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7328 def _BootstrapApp(*args
, **kwargs
):
7332 For internal use only
7334 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7336 def GetComCtl32Version(*args
, **kwargs
):
7338 GetComCtl32Version() -> int
7340 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7341 it wasn't found at all. Raises an exception on non-Windows platforms.
7343 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7345 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7346 def IsDisplayAvailable(*args
, **kwargs
):
7348 IsDisplayAvailable() -> bool
7350 Tests if it is possible to create a GUI in the current environment.
7351 This will mean different things on the different platforms.
7353 * On X Windows systems this function will return ``False`` if it is
7354 not able to open a connection to the X display, which can happen
7355 if $DISPLAY is not set, or is not set correctly.
7357 * On Mac OS X a ``False`` return value will mean that wx is not
7358 able to access the window manager, which can happen if logged in
7359 remotely or if running from the normal version of python instead
7360 of the framework version, (i.e., pythonw.)
7365 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7367 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7368 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7369 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7370 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7371 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7372 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7373 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7374 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7375 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7376 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7377 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7378 Active
= property(IsActive
)
7379 _core_
.PyApp_swigregister(PyApp
)
7381 def PyApp_IsMainLoopRunning(*args
):
7383 PyApp_IsMainLoopRunning() -> bool
7385 Returns True if we're running the main loop, i.e. if the events can
7386 currently be dispatched.
7388 return _core_
.PyApp_IsMainLoopRunning(*args
)
7390 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7391 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7392 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7394 def PyApp_GetMacAboutMenuItemId(*args
):
7395 """PyApp_GetMacAboutMenuItemId() -> long"""
7396 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7398 def PyApp_GetMacPreferencesMenuItemId(*args
):
7399 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7400 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7402 def PyApp_GetMacExitMenuItemId(*args
):
7403 """PyApp_GetMacExitMenuItemId() -> long"""
7404 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7406 def PyApp_GetMacHelpMenuTitleName(*args
):
7407 """PyApp_GetMacHelpMenuTitleName() -> String"""
7408 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7410 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7411 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7412 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7414 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7415 """PyApp_SetMacAboutMenuItemId(long val)"""
7416 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7418 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7419 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7420 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7422 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7423 """PyApp_SetMacExitMenuItemId(long val)"""
7424 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7426 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7427 """PyApp_SetMacHelpMenuTitleName(String val)"""
7428 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7430 def PyApp_GetComCtl32Version(*args
):
7432 PyApp_GetComCtl32Version() -> int
7434 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7435 it wasn't found at all. Raises an exception on non-Windows platforms.
7437 return _core_
.PyApp_GetComCtl32Version(*args
)
7439 def PyApp_IsDisplayAvailable(*args
):
7441 PyApp_IsDisplayAvailable() -> bool
7443 Tests if it is possible to create a GUI in the current environment.
7444 This will mean different things on the different platforms.
7446 * On X Windows systems this function will return ``False`` if it is
7447 not able to open a connection to the X display, which can happen
7448 if $DISPLAY is not set, or is not set correctly.
7450 * On Mac OS X a ``False`` return value will mean that wx is not
7451 able to access the window manager, which can happen if logged in
7452 remotely or if running from the normal version of python instead
7453 of the framework version, (i.e., pythonw.)
7458 return _core_
.PyApp_IsDisplayAvailable(*args
)
7460 #---------------------------------------------------------------------------
7467 Force an exit of the application. Convenience for wx.GetApp().Exit()
7469 return _core_
.Exit(*args
)
7475 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7477 return _core_
.Yield(*args
)
7479 def YieldIfNeeded(*args
):
7481 YieldIfNeeded() -> bool
7483 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7485 return _core_
.YieldIfNeeded(*args
)
7487 def SafeYield(*args
, **kwargs
):
7489 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7491 This function is similar to `wx.Yield`, except that it disables the
7492 user input to all program windows before calling `wx.Yield` and
7493 re-enables it again afterwards. If ``win`` is not None, this window
7494 will remain enabled, allowing the implementation of some limited user
7497 :Returns: the result of the call to `wx.Yield`.
7499 return _core_
.SafeYield(*args
, **kwargs
)
7501 def WakeUpIdle(*args
):
7505 Cause the message queue to become empty again, so idle events will be
7508 return _core_
.WakeUpIdle(*args
)
7510 def PostEvent(*args
, **kwargs
):
7512 PostEvent(EvtHandler dest, Event event)
7514 Send an event to a window or other wx.EvtHandler to be processed
7517 return _core_
.PostEvent(*args
, **kwargs
)
7519 def App_CleanUp(*args
):
7523 For internal use only, it is used to cleanup after wxWidgets when
7526 return _core_
.App_CleanUp(*args
)
7532 Return a reference to the current wx.App object.
7534 return _core_
.GetApp(*args
)
7536 def SetDefaultPyEncoding(*args
, **kwargs
):
7538 SetDefaultPyEncoding(string encoding)
7540 Sets the encoding that wxPython will use when it needs to convert a
7541 Python string or unicode object to or from a wxString.
7543 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7544 but please be aware that the default encoding within the same locale
7545 may be slightly different on different platforms. For example, please
7546 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7547 between the common latin/roman encodings.
7549 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7551 def GetDefaultPyEncoding(*args
):
7553 GetDefaultPyEncoding() -> string
7555 Gets the current encoding that wxPython will use when it needs to
7556 convert a Python string or unicode object to or from a wxString.
7558 return _core_
.GetDefaultPyEncoding(*args
)
7559 #----------------------------------------------------------------------
7561 class PyOnDemandOutputWindow
:
7563 A class that can be used for redirecting Python's stdout and
7564 stderr streams. It will do nothing until something is wrriten to
7565 the stream at which point it will create a Frame with a text area
7566 and write the text there.
7568 def __init__(self
, title
= "wxPython: stdout/stderr"):
7571 self
.pos
= wx
.DefaultPosition
7572 self
.size
= (450, 300)
7575 def SetParent(self
, parent
):
7576 """Set the window to be used as the popup Frame's parent."""
7577 self
.parent
= parent
7580 def CreateOutputWindow(self
, st
):
7581 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7582 style
=wx
.DEFAULT_FRAME_STYLE
)
7583 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7584 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7585 self
.text
.AppendText(st
)
7586 self
.frame
.Show(True)
7587 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7590 def OnCloseWindow(self
, event
):
7591 if self
.frame
is not None:
7592 self
.frame
.Destroy()
7597 # These methods provide the file-like output behaviour.
7598 def write(self
, text
):
7600 Create the output window if needed and write the string to it.
7601 If not called in the context of the gui thread then uses
7602 CallAfter to do the work there.
7604 if self
.frame
is None:
7605 if not wx
.Thread_IsMain():
7606 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7608 self
.CreateOutputWindow(text
)
7610 if not wx
.Thread_IsMain():
7611 wx
.CallAfter(self
.text
.AppendText
, text
)
7613 self
.text
.AppendText(text
)
7617 if self
.frame
is not None:
7618 wx
.CallAfter(self
.frame
.Close
)
7626 #----------------------------------------------------------------------
7628 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7630 class App(wx
.PyApp
):
7632 The ``wx.App`` class represents the application and is used to:
7634 * bootstrap the wxPython system and initialize the underlying
7636 * set and get application-wide properties
7637 * implement the windowing system main message or event loop,
7638 and to dispatch events to window instances
7641 Every application must have a ``wx.App`` instance, and all
7642 creation of UI objects should be delayed until after the
7643 ``wx.App`` object has been created in order to ensure that the gui
7644 platform and wxWidgets have been fully initialized.
7646 Normally you would derive from this class and implement an
7647 ``OnInit`` method that creates a frame and then calls
7648 ``self.SetTopWindow(frame)``.
7650 :see: `wx.PySimpleApp` for a simpler app class that can be used
7654 outputWindowClass
= PyOnDemandOutputWindow
7656 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7657 useBestVisual
=False, clearSigInt
=True):
7659 Construct a ``wx.App`` object.
7661 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7662 redirected? Defaults to True on Windows and Mac, False
7663 otherwise. If `filename` is None then output will be
7664 redirected to a window that pops up as needed. (You can
7665 control what kind of window is created for the output by
7666 resetting the class variable ``outputWindowClass`` to a
7667 class of your choosing.)
7669 :param filename: The name of a file to redirect output to, if
7672 :param useBestVisual: Should the app try to use the best
7673 available visual provided by the system (only relevant on
7674 systems that have more than one visual.) This parameter
7675 must be used instead of calling `SetUseBestVisual` later
7676 on because it must be set before the underlying GUI
7677 toolkit is initialized.
7679 :param clearSigInt: Should SIGINT be cleared? This allows the
7680 app to terminate upon a Ctrl-C in the console like other
7683 :note: You should override OnInit to do applicaition
7684 initialization to ensure that the system, toolkit and
7685 wxWidgets are fully initialized.
7688 wx
.PyApp
.__init
__(self
)
7690 # make sure we can create a GUI
7691 if not self
.IsDisplayAvailable():
7693 if wx
.Platform
== "__WXMAC__":
7694 msg
= """This program needs access to the screen.
7695 Please run with 'pythonw', not 'python', and only when you are logged
7696 in on the main display of your Mac."""
7698 elif wx
.Platform
== "__WXGTK__":
7699 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7702 msg
= "Unable to create GUI"
7703 # TODO: more description is needed for wxMSW...
7705 raise SystemExit(msg
)
7707 # This has to be done before OnInit
7708 self
.SetUseBestVisual(useBestVisual
)
7710 # Set the default handler for SIGINT. This fixes a problem
7711 # where if Ctrl-C is pressed in the console that started this
7712 # app then it will not appear to do anything, (not even send
7713 # KeyboardInterrupt???) but will later segfault on exit. By
7714 # setting the default handler then the app will exit, as
7715 # expected (depending on platform.)
7719 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7723 # Save and redirect the stdio to a window?
7724 self
.stdioWin
= None
7725 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7727 self
.RedirectStdio(filename
)
7729 # Use Python's install prefix as the default
7730 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7732 # This finishes the initialization of wxWindows and then calls
7733 # the OnInit that should be present in the derived class
7734 self
._BootstrapApp
()
7737 def OnPreInit(self
):
7739 Things that must be done after _BootstrapApp has done its
7740 thing, but would be nice if they were already done by the time
7741 that OnInit is called.
7743 wx
.StockGDI
._initStockObjects
()
7746 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7747 self
.RestoreStdio() # Just in case the MainLoop was overridden
7751 self
.this
.own(False)
7752 wx
.PyApp
.Destroy(self
)
7754 def SetTopWindow(self
, frame
):
7755 """Set the \"main\" top level window"""
7757 self
.stdioWin
.SetParent(frame
)
7758 wx
.PyApp
.SetTopWindow(self
, frame
)
7762 """Execute the main GUI event loop"""
7763 wx
.PyApp
.MainLoop(self
)
7767 def RedirectStdio(self
, filename
=None):
7768 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7770 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7772 self
.stdioWin
= self
.outputWindowClass()
7773 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7776 def RestoreStdio(self
):
7778 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7783 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7785 Set the title, position and/or size of the output window if
7786 the stdio has been redirected. This should be called before
7787 any output would cause the output window to be created.
7790 if title
is not None:
7791 self
.stdioWin
.title
= title
7793 self
.stdioWin
.pos
= pos
7794 if size
is not None:
7795 self
.stdioWin
.size
= size
7800 # change from wx.PyApp_XX to wx.App_XX
7801 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7802 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7803 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7804 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7805 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7806 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7807 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7808 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7809 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7810 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7811 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7813 #----------------------------------------------------------------------------
7815 class PySimpleApp(wx
.App
):
7817 A simple application class. You can just create one of these and
7818 then then make your top level windows later, and not have to worry
7819 about OnInit. For example::
7821 app = wx.PySimpleApp()
7822 frame = wx.Frame(None, title='Hello World')
7829 def __init__(self
, redirect
=False, filename
=None,
7830 useBestVisual
=False, clearSigInt
=True):
7832 :see: `wx.App.__init__`
7834 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7841 # Is anybody using this one?
7842 class PyWidgetTester(wx
.App
):
7843 def __init__(self
, size
= (250, 100)):
7845 wx
.App
.__init
__(self
, 0)
7848 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7849 self
.SetTopWindow(self
.frame
)
7852 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7853 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7854 self
.frame
.Show(True)
7856 #----------------------------------------------------------------------------
7857 # DO NOT hold any other references to this object. This is how we
7858 # know when to cleanup system resources that wxWidgets is holding. When
7859 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7860 # goes to zero and it calls the wx.App_CleanUp function.
7862 class __wxPyCleanup
:
7864 self
.cleanup
= _core_
.App_CleanUp
7868 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7870 ## # another possible solution, but it gets called too early...
7872 ## atexit.register(_core_.wxApp_CleanUp)
7875 #----------------------------------------------------------------------------
7877 #---------------------------------------------------------------------------
7879 class EventLoop(object):
7880 """Proxy of C++ EventLoop class"""
7881 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7882 __repr__
= _swig_repr
7883 def __init__(self
, *args
, **kwargs
):
7884 """__init__(self) -> EventLoop"""
7885 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7886 __swig_destroy__
= _core_
.delete_EventLoop
7887 __del__
= lambda self
: None;
7888 def Run(*args
, **kwargs
):
7889 """Run(self) -> int"""
7890 return _core_
.EventLoop_Run(*args
, **kwargs
)
7892 def Exit(*args
, **kwargs
):
7893 """Exit(self, int rc=0)"""
7894 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7896 def Pending(*args
, **kwargs
):
7897 """Pending(self) -> bool"""
7898 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7900 def Dispatch(*args
, **kwargs
):
7901 """Dispatch(self) -> bool"""
7902 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7904 def IsRunning(*args
, **kwargs
):
7905 """IsRunning(self) -> bool"""
7906 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7908 def GetActive(*args
, **kwargs
):
7909 """GetActive() -> EventLoop"""
7910 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7912 GetActive
= staticmethod(GetActive
)
7913 def SetActive(*args
, **kwargs
):
7914 """SetActive(EventLoop loop)"""
7915 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7917 SetActive
= staticmethod(SetActive
)
7918 _core_
.EventLoop_swigregister(EventLoop
)
7920 def EventLoop_GetActive(*args
):
7921 """EventLoop_GetActive() -> EventLoop"""
7922 return _core_
.EventLoop_GetActive(*args
)
7924 def EventLoop_SetActive(*args
, **kwargs
):
7925 """EventLoop_SetActive(EventLoop loop)"""
7926 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7928 class EventLoopActivator(object):
7929 """Proxy of C++ EventLoopActivator class"""
7930 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7931 __repr__
= _swig_repr
7932 def __init__(self
, *args
, **kwargs
):
7933 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7934 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7935 __swig_destroy__
= _core_
.delete_EventLoopActivator
7936 __del__
= lambda self
: None;
7937 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7939 #---------------------------------------------------------------------------
7941 ACCEL_ALT
= _core_
.ACCEL_ALT
7942 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7943 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7944 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7945 ACCEL_CMD
= _core_
.ACCEL_CMD
7946 class AcceleratorEntry(object):
7948 A class used to define items in an `wx.AcceleratorTable`. wxPython
7949 programs can choose to use wx.AcceleratorEntry objects, but using a
7950 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7951 as well. See `__init__` for of the tuple values.
7953 :see: `wx.AcceleratorTable`
7955 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7956 __repr__
= _swig_repr
7957 def __init__(self
, *args
, **kwargs
):
7959 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7961 Construct a wx.AcceleratorEntry.
7963 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7964 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7965 __del__
= lambda self
: None;
7966 def Set(*args
, **kwargs
):
7968 Set(self, int flags, int keyCode, int cmd)
7970 (Re)set the attributes of a wx.AcceleratorEntry.
7973 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7975 def Create(*args
, **kwargs
):
7977 Create(String str) -> AcceleratorEntry
7979 Create accelerator corresponding to the specified string, or None if
7980 it coulnd't be parsed.
7982 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7984 Create
= staticmethod(Create
)
7985 def GetFlags(*args
, **kwargs
):
7987 GetFlags(self) -> int
7989 Get the AcceleratorEntry's flags.
7991 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
7993 def GetKeyCode(*args
, **kwargs
):
7995 GetKeyCode(self) -> int
7997 Get the AcceleratorEntry's keycode.
7999 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8001 def GetCommand(*args
, **kwargs
):
8003 GetCommand(self) -> int
8005 Get the AcceleratorEntry's command ID.
8007 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8009 def IsOk(*args
, **kwargs
):
8010 """IsOk(self) -> bool"""
8011 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
8013 def ToString(*args
, **kwargs
):
8015 ToString(self) -> String
8017 Returns a string representation for the this accelerator. The string
8018 is formatted using the <flags>-<keycode> format where <flags> maybe a
8019 hyphen-separed list of "shift|alt|ctrl"
8022 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
8024 def FromString(*args
, **kwargs
):
8026 FromString(self, String str) -> bool
8028 Returns true if the given string correctly initialized this object.
8030 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
8032 Command
= property(GetCommand
,doc
="See `GetCommand`")
8033 Flags
= property(GetFlags
,doc
="See `GetFlags`")
8034 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
8035 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
8037 def AcceleratorEntry_Create(*args
, **kwargs
):
8039 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8041 Create accelerator corresponding to the specified string, or None if
8042 it coulnd't be parsed.
8044 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8046 class AcceleratorTable(Object
):
8048 An accelerator table allows the application to specify a table of
8049 keyboard shortcuts for menus or other commands. On Windows, menu or
8050 button commands are supported; on GTK, only menu commands are
8053 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8054 __repr__
= _swig_repr
8055 def __init__(self
, *args
, **kwargs
):
8057 __init__(entries) -> AcceleratorTable
8059 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8060 items or or of 3-tuples (flags, keyCode, cmdID)
8062 :see: `wx.AcceleratorEntry`
8064 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
8065 __swig_destroy__
= _core_
.delete_AcceleratorTable
8066 __del__
= lambda self
: None;
8067 def IsOk(*args
, **kwargs
):
8068 """IsOk(self) -> bool"""
8069 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
8072 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
8075 def GetAccelFromString(*args
, **kwargs
):
8076 """GetAccelFromString(String label) -> AcceleratorEntry"""
8077 return _core_
.GetAccelFromString(*args
, **kwargs
)
8078 #---------------------------------------------------------------------------
8080 class VisualAttributes(object):
8081 """struct containing all the visual attributes of a control"""
8082 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8083 __repr__
= _swig_repr
8084 def __init__(self
, *args
, **kwargs
):
8086 __init__(self) -> VisualAttributes
8088 struct containing all the visual attributes of a control
8090 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
8091 __swig_destroy__
= _core_
.delete_VisualAttributes
8092 __del__
= lambda self
: None;
8093 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
8094 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
8095 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
8096 _core_
.VisualAttributes_swigregister(VisualAttributes
)
8097 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8098 PanelNameStr
= cvar
.PanelNameStr
8100 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8101 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8102 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8103 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8104 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8105 class Window(EvtHandler
):
8107 wx.Window is the base class for all windows and represents any visible
8108 object on the screen. All controls, top level windows and so on are
8109 wx.Windows. Sizers and device contexts are not however, as they don't
8110 appear on screen themselves.
8113 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8114 __repr__
= _swig_repr
8115 def __init__(self
, *args
, **kwargs
):
8117 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8118 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8120 Construct and show a generic Window.
8122 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
8123 self
._setOORInfo
(self
)
8125 def Create(*args
, **kwargs
):
8127 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8128 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8130 Create the GUI part of the Window for 2-phase creation mode.
8132 return _core_
.Window_Create(*args
, **kwargs
)
8134 def Close(*args
, **kwargs
):
8136 Close(self, bool force=False) -> bool
8138 This function simply generates a EVT_CLOSE event whose handler usually
8139 tries to close the window. It doesn't close the window itself,
8140 however. If force is False (the default) then the window's close
8141 handler will be allowed to veto the destruction of the window.
8143 return _core_
.Window_Close(*args
, **kwargs
)
8145 def Destroy(*args
, **kwargs
):
8147 Destroy(self) -> bool
8149 Destroys the window safely. Frames and dialogs are not destroyed
8150 immediately when this function is called -- they are added to a list
8151 of windows to be deleted on idle time, when all the window's events
8152 have been processed. This prevents problems with events being sent to
8153 non-existent windows.
8155 Returns True if the window has either been successfully deleted, or it
8156 has been added to the list of windows pending real deletion.
8158 args
[0].this
.own(False)
8159 return _core_
.Window_Destroy(*args
, **kwargs
)
8161 def DestroyChildren(*args
, **kwargs
):
8163 DestroyChildren(self) -> bool
8165 Destroys all children of a window. Called automatically by the
8168 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8170 def IsBeingDeleted(*args
, **kwargs
):
8172 IsBeingDeleted(self) -> bool
8174 Is the window in the process of being deleted?
8176 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8178 def SetLabel(*args
, **kwargs
):
8180 SetLabel(self, String label)
8182 Set the text which the window shows in its label if applicable.
8184 return _core_
.Window_SetLabel(*args
, **kwargs
)
8186 def GetLabel(*args
, **kwargs
):
8188 GetLabel(self) -> String
8190 Generic way of getting a label from any window, for identification
8191 purposes. The interpretation of this function differs from class to
8192 class. For frames and dialogs, the value returned is the title. For
8193 buttons or static text controls, it is the button text. This function
8194 can be useful for meta-programs such as testing tools or special-needs
8195 access programs)which need to identify windows by name.
8197 return _core_
.Window_GetLabel(*args
, **kwargs
)
8199 def SetName(*args
, **kwargs
):
8201 SetName(self, String name)
8203 Sets the window's name. The window name is used for ressource setting
8204 in X, it is not the same as the window title/label
8206 return _core_
.Window_SetName(*args
, **kwargs
)
8208 def GetName(*args
, **kwargs
):
8210 GetName(self) -> String
8212 Returns the windows name. This name is not guaranteed to be unique;
8213 it is up to the programmer to supply an appropriate name in the window
8214 constructor or via wx.Window.SetName.
8216 return _core_
.Window_GetName(*args
, **kwargs
)
8218 def SetWindowVariant(*args
, **kwargs
):
8220 SetWindowVariant(self, int variant)
8222 Sets the variant of the window/font size to use for this window, if
8223 the platform supports variants, for example, wxMac.
8225 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8227 def GetWindowVariant(*args
, **kwargs
):
8228 """GetWindowVariant(self) -> int"""
8229 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8231 def SetId(*args
, **kwargs
):
8233 SetId(self, int winid)
8235 Sets the identifier of the window. Each window has an integer
8236 identifier. If the application has not provided one, an identifier
8237 will be generated. Normally, the identifier should be provided on
8238 creation and should not be modified subsequently.
8240 return _core_
.Window_SetId(*args
, **kwargs
)
8242 def GetId(*args
, **kwargs
):
8246 Returns the identifier of the window. Each window has an integer
8247 identifier. If the application has not provided one (or the default Id
8248 -1 is used) then an unique identifier with a negative value will be
8251 return _core_
.Window_GetId(*args
, **kwargs
)
8253 def NewControlId(*args
, **kwargs
):
8255 NewControlId() -> int
8257 Generate a control id for the controls which were not given one.
8259 return _core_
.Window_NewControlId(*args
, **kwargs
)
8261 NewControlId
= staticmethod(NewControlId
)
8262 def NextControlId(*args
, **kwargs
):
8264 NextControlId(int winid) -> int
8266 Get the id of the control following the one with the given
8269 return _core_
.Window_NextControlId(*args
, **kwargs
)
8271 NextControlId
= staticmethod(NextControlId
)
8272 def PrevControlId(*args
, **kwargs
):
8274 PrevControlId(int winid) -> int
8276 Get the id of the control preceding the one with the given
8279 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8281 PrevControlId
= staticmethod(PrevControlId
)
8282 def GetLayoutDirection(*args
, **kwargs
):
8284 GetLayoutDirection(self) -> int
8286 Get the layout direction (LTR or RTL) for this window. Returns
8287 ``wx.Layout_Default`` if layout direction is not supported.
8289 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8291 def SetLayoutDirection(*args
, **kwargs
):
8293 SetLayoutDirection(self, int dir)
8295 Set the layout direction (LTR or RTL) for this window.
8297 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8299 def AdjustForLayoutDirection(*args
, **kwargs
):
8301 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8303 Mirror coordinates for RTL layout if this window uses it and if the
8304 mirroring is not done automatically like Win32.
8306 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8308 def SetSize(*args
, **kwargs
):
8310 SetSize(self, Size size)
8312 Sets the size of the window in pixels.
8314 return _core_
.Window_SetSize(*args
, **kwargs
)
8316 def SetDimensions(*args
, **kwargs
):
8318 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8320 Sets the position and size of the window in pixels. The sizeFlags
8321 parameter indicates the interpretation of the other params if they are
8324 ======================== ======================================
8325 wx.SIZE_AUTO A -1 indicates that a class-specific
8326 default should be used.
8327 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8328 -1 values are supplied.
8329 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8330 interpreted as real dimensions, not
8332 ======================== ======================================
8335 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8337 def SetRect(*args
, **kwargs
):
8339 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8341 Sets the position and size of the window in pixels using a wx.Rect.
8343 return _core_
.Window_SetRect(*args
, **kwargs
)
8345 def SetSizeWH(*args
, **kwargs
):
8347 SetSizeWH(self, int width, int height)
8349 Sets the size of the window in pixels.
8351 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8353 def Move(*args
, **kwargs
):
8355 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8357 Moves the window to the given position.
8359 return _core_
.Window_Move(*args
, **kwargs
)
8362 def MoveXY(*args
, **kwargs
):
8364 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8366 Moves the window to the given position.
8368 return _core_
.Window_MoveXY(*args
, **kwargs
)
8370 def SetBestFittingSize(*args
, **kwargs
):
8372 SetBestFittingSize(self, Size size=DefaultSize)
8374 A 'Smart' SetSize that will fill in default size components with the
8375 window's *best size* values. Also set's the minsize for use with sizers.
8377 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
8379 def Raise(*args
, **kwargs
):
8383 Raises the window to the top of the window hierarchy. In current
8384 version of wxWidgets this works both for manage and child windows.
8386 return _core_
.Window_Raise(*args
, **kwargs
)
8388 def Lower(*args
, **kwargs
):
8392 Lowers the window to the bottom of the window hierarchy. In current
8393 version of wxWidgets this works both for manage and child windows.
8395 return _core_
.Window_Lower(*args
, **kwargs
)
8397 def SetClientSize(*args
, **kwargs
):
8399 SetClientSize(self, Size size)
8401 This sets the size of the window client area in pixels. Using this
8402 function to size a window tends to be more device-independent than
8403 wx.Window.SetSize, since the application need not worry about what
8404 dimensions the border or title bar have when trying to fit the window
8405 around panel items, for example.
8407 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8409 def SetClientSizeWH(*args
, **kwargs
):
8411 SetClientSizeWH(self, int width, int height)
8413 This sets the size of the window client area in pixels. Using this
8414 function to size a window tends to be more device-independent than
8415 wx.Window.SetSize, since the application need not worry about what
8416 dimensions the border or title bar have when trying to fit the window
8417 around panel items, for example.
8419 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8421 def SetClientRect(*args
, **kwargs
):
8423 SetClientRect(self, Rect rect)
8425 This sets the size of the window client area in pixels. Using this
8426 function to size a window tends to be more device-independent than
8427 wx.Window.SetSize, since the application need not worry about what
8428 dimensions the border or title bar have when trying to fit the window
8429 around panel items, for example.
8431 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8433 def GetPosition(*args
, **kwargs
):
8435 GetPosition(self) -> Point
8437 Get the window's position. Notice that the position is in client
8438 coordinates for child windows and screen coordinates for the top level
8439 ones, use `GetScreenPosition` if you need screen coordinates for all
8442 return _core_
.Window_GetPosition(*args
, **kwargs
)
8444 def GetPositionTuple(*args
, **kwargs
):
8446 GetPositionTuple() -> (x,y)
8448 Get the window's position. Notice that the position is in client
8449 coordinates for child windows and screen coordinates for the top level
8450 ones, use `GetScreenPosition` if you need screen coordinates for all
8453 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8455 def GetScreenPosition(*args
, **kwargs
):
8457 GetScreenPosition(self) -> Point
8459 Get the position of the window in screen coordinantes.
8461 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8463 def GetScreenPositionTuple(*args
, **kwargs
):
8465 GetScreenPositionTuple() -> (x,y)
8467 Get the position of the window in screen coordinantes.
8469 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8471 def GetScreenRect(*args
, **kwargs
):
8473 GetScreenRect(self) -> Rect
8475 Returns the size and position of the window in screen coordinantes as
8478 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8480 def GetSize(*args
, **kwargs
):
8482 GetSize(self) -> Size
8484 Get the window size.
8486 return _core_
.Window_GetSize(*args
, **kwargs
)
8488 def GetSizeTuple(*args
, **kwargs
):
8490 GetSizeTuple() -> (width, height)
8492 Get the window size.
8494 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8496 def GetRect(*args
, **kwargs
):
8498 GetRect(self) -> Rect
8500 Returns the size and position of the window as a `wx.Rect` object.
8502 return _core_
.Window_GetRect(*args
, **kwargs
)
8504 def GetClientSize(*args
, **kwargs
):
8506 GetClientSize(self) -> Size
8508 This gets the size of the window's 'client area' in pixels. The client
8509 area is the area which may be drawn on by the programmer, excluding
8510 title bar, border, scrollbars, etc.
8512 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8514 def GetClientSizeTuple(*args
, **kwargs
):
8516 GetClientSizeTuple() -> (width, height)
8518 This gets the size of the window's 'client area' in pixels. The client
8519 area is the area which may be drawn on by the programmer, excluding
8520 title bar, border, scrollbars, etc.
8522 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8524 def GetClientAreaOrigin(*args
, **kwargs
):
8526 GetClientAreaOrigin(self) -> Point
8528 Get the origin of the client area of the window relative to the
8529 window's top left corner (the client area may be shifted because of
8530 the borders, scrollbars, other decorations...)
8532 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8534 def GetClientRect(*args
, **kwargs
):
8536 GetClientRect(self) -> Rect
8538 Get the client area position and size as a `wx.Rect` object.
8540 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8542 def GetBestSize(*args
, **kwargs
):
8544 GetBestSize(self) -> Size
8546 This function returns the best acceptable minimal size for the
8547 window, if applicable. For example, for a static text control, it will
8548 be the minimal size such that the control label is not truncated. For
8549 windows containing subwindows (suzh aswx.Panel), the size returned by
8550 this function will be the same as the size the window would have had
8553 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8555 def GetBestSizeTuple(*args
, **kwargs
):
8557 GetBestSizeTuple() -> (width, height)
8559 This function returns the best acceptable minimal size for the
8560 window, if applicable. For example, for a static text control, it will
8561 be the minimal size such that the control label is not truncated. For
8562 windows containing subwindows (suzh aswx.Panel), the size returned by
8563 this function will be the same as the size the window would have had
8566 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8568 def InvalidateBestSize(*args
, **kwargs
):
8570 InvalidateBestSize(self)
8572 Reset the cached best size value so it will be recalculated the next
8575 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8577 def CacheBestSize(*args
, **kwargs
):
8579 CacheBestSize(self, Size size)
8581 Cache the best size so it doesn't need to be calculated again, (at least until
8582 some properties of the window change.)
8584 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8586 def GetBestFittingSize(*args
, **kwargs
):
8588 GetBestFittingSize(self) -> Size
8590 This function will merge the window's best size into the window's
8591 minimum size, giving priority to the min size components, and returns
8595 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
8597 def GetAdjustedBestSize(*args
, **kwargs
):
8599 GetAdjustedBestSize(self) -> Size
8601 This method is similar to GetBestSize, except in one
8602 thing. GetBestSize should return the minimum untruncated size of the
8603 window, while this method will return the largest of BestSize and any
8604 user specified minimum size. ie. it is the minimum size the window
8605 should currently be drawn at, not the minimal size it can possibly
8608 return _core_
.Window_GetAdjustedBestSize(*args
, **kwargs
)
8610 def Center(*args
, **kwargs
):
8612 Center(self, int direction=BOTH)
8614 Centers the window. The parameter specifies the direction for
8615 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8616 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8617 on the entire screen and not on its parent window. If it is a
8618 top-level window and has no parent then it will always be centered
8619 relative to the screen.
8621 return _core_
.Window_Center(*args
, **kwargs
)
8624 def CenterOnParent(*args
, **kwargs
):
8626 CenterOnParent(self, int dir=BOTH)
8628 Center with respect to the the parent window
8630 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8632 CentreOnParent
= CenterOnParent
8633 def Fit(*args
, **kwargs
):
8637 Sizes the window so that it fits around its subwindows. This function
8638 won't do anything if there are no subwindows and will only really work
8639 correctly if sizers are used for the subwindows layout. Also, if the
8640 window has exactly one subwindow it is better (faster and the result
8641 is more precise as Fit adds some margin to account for fuzziness of
8642 its calculations) to call window.SetClientSize(child.GetSize())
8643 instead of calling Fit.
8645 return _core_
.Window_Fit(*args
, **kwargs
)
8647 def FitInside(*args
, **kwargs
):
8651 Similar to Fit, but sizes the interior (virtual) size of a
8652 window. Mainly useful with scrolled windows to reset scrollbars after
8653 sizing changes that do not trigger a size event, and/or scrolled
8654 windows without an interior sizer. This function similarly won't do
8655 anything if there are no subwindows.
8657 return _core_
.Window_FitInside(*args
, **kwargs
)
8659 def SetSizeHints(*args
, **kwargs
):
8661 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8664 Allows specification of minimum and maximum window sizes, and window
8665 size increments. If a pair of values is not set (or set to -1), the
8666 default values will be used. If this function is called, the user
8667 will not be able to size the window outside the given bounds (if it is
8668 a top-level window.) Sizers will also inspect the minimum window size
8669 and will use that value if set when calculating layout.
8671 The resizing increments are only significant under Motif or Xt.
8673 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8675 def SetSizeHintsSz(*args
, **kwargs
):
8677 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8679 Allows specification of minimum and maximum window sizes, and window
8680 size increments. If a pair of values is not set (or set to -1), the
8681 default values will be used. If this function is called, the user
8682 will not be able to size the window outside the given bounds (if it is
8683 a top-level window.) Sizers will also inspect the minimum window size
8684 and will use that value if set when calculating layout.
8686 The resizing increments are only significant under Motif or Xt.
8688 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8690 def SetVirtualSizeHints(*args
, **kwargs
):
8692 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8694 Allows specification of minimum and maximum virtual window sizes. If a
8695 pair of values is not set (or set to -1), the default values will be
8696 used. If this function is called, the user will not be able to size
8697 the virtual area of the window outside the given bounds.
8699 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8701 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8703 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8705 Allows specification of minimum and maximum virtual window sizes. If a
8706 pair of values is not set (or set to -1), the default values will be
8707 used. If this function is called, the user will not be able to size
8708 the virtual area of the window outside the given bounds.
8710 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8712 def GetMaxSize(*args
, **kwargs
):
8713 """GetMaxSize(self) -> Size"""
8714 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8716 def GetMinSize(*args
, **kwargs
):
8717 """GetMinSize(self) -> Size"""
8718 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8720 def SetMinSize(*args
, **kwargs
):
8722 SetMinSize(self, Size minSize)
8724 A more convenient method than `SetSizeHints` for setting just the
8727 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8729 def SetMaxSize(*args
, **kwargs
):
8731 SetMaxSize(self, Size maxSize)
8733 A more convenient method than `SetSizeHints` for setting just the
8736 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8738 def GetMinWidth(*args
, **kwargs
):
8739 """GetMinWidth(self) -> int"""
8740 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8742 def GetMinHeight(*args
, **kwargs
):
8743 """GetMinHeight(self) -> int"""
8744 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8746 def GetMaxWidth(*args
, **kwargs
):
8747 """GetMaxWidth(self) -> int"""
8748 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8750 def GetMaxHeight(*args
, **kwargs
):
8751 """GetMaxHeight(self) -> int"""
8752 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8754 def SetVirtualSize(*args
, **kwargs
):
8756 SetVirtualSize(self, Size size)
8758 Set the the virtual size of a window in pixels. For most windows this
8759 is just the client area of the window, but for some like scrolled
8760 windows it is more or less independent of the screen window size.
8762 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8764 def SetVirtualSizeWH(*args
, **kwargs
):
8766 SetVirtualSizeWH(self, int w, int h)
8768 Set the the virtual size of a window in pixels. For most windows this
8769 is just the client area of the window, but for some like scrolled
8770 windows it is more or less independent of the screen window size.
8772 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8774 def GetVirtualSize(*args
, **kwargs
):
8776 GetVirtualSize(self) -> Size
8778 Get the the virtual size of the window in pixels. For most windows
8779 this is just the client area of the window, but for some like scrolled
8780 windows it is more or less independent of the screen window size.
8782 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8784 def GetVirtualSizeTuple(*args
, **kwargs
):
8786 GetVirtualSizeTuple() -> (width, height)
8788 Get the the virtual size of the window in pixels. For most windows
8789 this is just the client area of the window, but for some like scrolled
8790 windows it is more or less independent of the screen window size.
8792 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8794 def GetBestVirtualSize(*args
, **kwargs
):
8796 GetBestVirtualSize(self) -> Size
8798 Return the largest of ClientSize and BestSize (as determined by a
8799 sizer, interior children, or other means)
8801 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8803 def Show(*args
, **kwargs
):
8805 Show(self, bool show=True) -> bool
8807 Shows or hides the window. You may need to call Raise for a top level
8808 window if you want to bring it to top, although this is not needed if
8809 Show is called immediately after the frame creation. Returns True if
8810 the window has been shown or hidden or False if nothing was done
8811 because it already was in the requested state.
8813 return _core_
.Window_Show(*args
, **kwargs
)
8815 def Hide(*args
, **kwargs
):
8819 Equivalent to calling Show(False).
8821 return _core_
.Window_Hide(*args
, **kwargs
)
8823 def Enable(*args
, **kwargs
):
8825 Enable(self, bool enable=True) -> bool
8827 Enable or disable the window for user input. Note that when a parent
8828 window is disabled, all of its children are disabled as well and they
8829 are reenabled again when the parent is. Returns true if the window
8830 has been enabled or disabled, false if nothing was done, i.e. if the
8831 window had already been in the specified state.
8833 return _core_
.Window_Enable(*args
, **kwargs
)
8835 def Disable(*args
, **kwargs
):
8837 Disable(self) -> bool
8839 Disables the window, same as Enable(false).
8841 return _core_
.Window_Disable(*args
, **kwargs
)
8843 def IsShown(*args
, **kwargs
):
8845 IsShown(self) -> bool
8847 Returns true if the window is shown, false if it has been hidden.
8849 return _core_
.Window_IsShown(*args
, **kwargs
)
8851 def IsEnabled(*args
, **kwargs
):
8853 IsEnabled(self) -> bool
8855 Returns true if the window is enabled for input, false otherwise.
8857 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8859 def IsShownOnScreen(*args
, **kwargs
):
8861 IsShownOnScreen(self) -> bool
8863 Returns ``True`` if the window is physically visible on the screen,
8864 i.e. it is shown and all its parents up to the toplevel window are
8867 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8869 def SetWindowStyleFlag(*args
, **kwargs
):
8871 SetWindowStyleFlag(self, long style)
8873 Sets the style of the window. Please note that some styles cannot be
8874 changed after the window creation and that Refresh() might need to be
8875 called after changing the others for the change to take place
8878 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8880 def GetWindowStyleFlag(*args
, **kwargs
):
8882 GetWindowStyleFlag(self) -> long
8884 Gets the window style that was passed to the constructor or Create
8887 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8889 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8890 def HasFlag(*args
, **kwargs
):
8892 HasFlag(self, int flag) -> bool
8894 Test if the given style is set for this window.
8896 return _core_
.Window_HasFlag(*args
, **kwargs
)
8898 def IsRetained(*args
, **kwargs
):
8900 IsRetained(self) -> bool
8902 Returns true if the window is retained, false otherwise. Retained
8903 windows are only available on X platforms.
8905 return _core_
.Window_IsRetained(*args
, **kwargs
)
8907 def SetExtraStyle(*args
, **kwargs
):
8909 SetExtraStyle(self, long exStyle)
8911 Sets the extra style bits for the window. Extra styles are the less
8912 often used style bits which can't be set with the constructor or with
8913 SetWindowStyleFlag()
8915 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8917 def GetExtraStyle(*args
, **kwargs
):
8919 GetExtraStyle(self) -> long
8921 Returns the extra style bits for the window.
8923 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8925 def MakeModal(*args
, **kwargs
):
8927 MakeModal(self, bool modal=True)
8929 Disables all other windows in the application so that the user can
8930 only interact with this window. Passing False will reverse this
8933 return _core_
.Window_MakeModal(*args
, **kwargs
)
8935 def SetThemeEnabled(*args
, **kwargs
):
8937 SetThemeEnabled(self, bool enableTheme)
8939 This function tells a window if it should use the system's "theme"
8940 code to draw the windows' background instead if its own background
8941 drawing code. This will only have an effect on platforms that support
8942 the notion of themes in user defined windows. One such platform is
8943 GTK+ where windows can have (very colourful) backgrounds defined by a
8944 user's selected theme.
8946 Dialogs, notebook pages and the status bar have this flag set to true
8947 by default so that the default look and feel is simulated best.
8949 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8951 def GetThemeEnabled(*args
, **kwargs
):
8953 GetThemeEnabled(self) -> bool
8955 Return the themeEnabled flag.
8957 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8959 def SetFocus(*args
, **kwargs
):
8963 Set's the focus to this window, allowing it to receive keyboard input.
8965 return _core_
.Window_SetFocus(*args
, **kwargs
)
8967 def SetFocusFromKbd(*args
, **kwargs
):
8969 SetFocusFromKbd(self)
8971 Set focus to this window as the result of a keyboard action. Normally
8972 only called internally.
8974 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8976 def FindFocus(*args
, **kwargs
):
8978 FindFocus() -> Window
8980 Returns the window or control that currently has the keyboard focus,
8983 return _core_
.Window_FindFocus(*args
, **kwargs
)
8985 FindFocus
= staticmethod(FindFocus
)
8986 def AcceptsFocus(*args
, **kwargs
):
8988 AcceptsFocus(self) -> bool
8990 Can this window have focus?
8992 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8994 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
8996 AcceptsFocusFromKeyboard(self) -> bool
8998 Can this window be given focus by keyboard navigation? if not, the
8999 only way to give it focus (provided it accepts it at all) is to click
9002 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
9004 def Navigate(*args
, **kwargs
):
9006 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9008 Does keyboard navigation from this window to another, by sending a
9009 `wx.NavigationKeyEvent`.
9011 return _core_
.Window_Navigate(*args
, **kwargs
)
9013 def MoveAfterInTabOrder(*args
, **kwargs
):
9015 MoveAfterInTabOrder(self, Window win)
9017 Moves this window in the tab navigation order after the specified
9018 sibling window. This means that when the user presses the TAB key on
9019 that other window, the focus switches to this window.
9021 The default tab order is the same as creation order. This function
9022 and `MoveBeforeInTabOrder` allow to change it after creating all the
9026 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
9028 def MoveBeforeInTabOrder(*args
, **kwargs
):
9030 MoveBeforeInTabOrder(self, Window win)
9032 Same as `MoveAfterInTabOrder` except that it inserts this window just
9033 before win instead of putting it right after it.
9035 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9037 def GetChildren(*args
, **kwargs
):
9039 GetChildren(self) -> PyObject
9041 Returns a list of the window's children. NOTE: Currently this is a
9042 copy of the child window list maintained by the window, so the return
9043 value of this function is only valid as long as the window's children
9046 return _core_
.Window_GetChildren(*args
, **kwargs
)
9048 def GetParent(*args
, **kwargs
):
9050 GetParent(self) -> Window
9052 Returns the parent window of this window, or None if there isn't one.
9054 return _core_
.Window_GetParent(*args
, **kwargs
)
9056 def GetGrandParent(*args
, **kwargs
):
9058 GetGrandParent(self) -> Window
9060 Returns the parent of the parent of this window, or None if there
9063 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9065 def IsTopLevel(*args
, **kwargs
):
9067 IsTopLevel(self) -> bool
9069 Returns true if the given window is a top-level one. Currently all
9070 frames and dialogs are always considered to be top-level windows (even
9071 if they have a parent window).
9073 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9075 def Reparent(*args
, **kwargs
):
9077 Reparent(self, Window newParent) -> bool
9079 Reparents the window, i.e the window will be removed from its current
9080 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9081 re-inserted into another. Available on Windows and GTK. Returns True
9082 if the parent was changed, False otherwise (error or newParent ==
9085 return _core_
.Window_Reparent(*args
, **kwargs
)
9087 def AddChild(*args
, **kwargs
):
9089 AddChild(self, Window child)
9091 Adds a child window. This is called automatically by window creation
9092 functions so should not be required by the application programmer.
9094 return _core_
.Window_AddChild(*args
, **kwargs
)
9096 def RemoveChild(*args
, **kwargs
):
9098 RemoveChild(self, Window child)
9100 Removes a child window. This is called automatically by window
9101 deletion functions so should not be required by the application
9104 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9106 def SetDoubleBuffered(*args
, **kwargs
):
9108 SetDoubleBuffered(self, bool on)
9110 Currently wxGTK2 only.
9112 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
9114 def FindWindowById(*args
, **kwargs
):
9116 FindWindowById(self, long winid) -> Window
9118 Find a chld of this window by window ID
9120 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9122 def FindWindowByName(*args
, **kwargs
):
9124 FindWindowByName(self, String name) -> Window
9126 Find a child of this window by name
9128 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9130 def GetEventHandler(*args
, **kwargs
):
9132 GetEventHandler(self) -> EvtHandler
9134 Returns the event handler for this window. By default, the window is
9135 its own event handler.
9137 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9139 def SetEventHandler(*args
, **kwargs
):
9141 SetEventHandler(self, EvtHandler handler)
9143 Sets the event handler for this window. An event handler is an object
9144 that is capable of processing the events sent to a window. (In other
9145 words, is able to dispatch the events to handler function.) By
9146 default, the window is its own event handler, but an application may
9147 wish to substitute another, for example to allow central
9148 implementation of event-handling for a variety of different window
9151 It is usually better to use `wx.Window.PushEventHandler` since this sets
9152 up a chain of event handlers, where an event not handled by one event
9153 handler is handed off to the next one in the chain.
9155 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9157 def PushEventHandler(*args
, **kwargs
):
9159 PushEventHandler(self, EvtHandler handler)
9161 Pushes this event handler onto the event handler stack for the window.
9162 An event handler is an object that is capable of processing the events
9163 sent to a window. (In other words, is able to dispatch the events to
9164 handler function.) By default, the window is its own event handler,
9165 but an application may wish to substitute another, for example to
9166 allow central implementation of event-handling for a variety of
9167 different window classes.
9169 wx.Window.PushEventHandler allows an application to set up a chain of
9170 event handlers, where an event not handled by one event handler is
9171 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9172 to remove the event handler. Ownership of the handler is *not* given
9173 to the window, so you should be sure to pop the handler before the
9174 window is destroyed and either let PopEventHandler destroy it, or call
9175 its Destroy method yourself.
9177 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9179 def PopEventHandler(*args
, **kwargs
):
9181 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9183 Removes and returns the top-most event handler on the event handler
9184 stack. If deleteHandler is True then the wx.EvtHandler object will be
9185 destroyed after it is popped, and ``None`` will be returned instead.
9187 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9189 def RemoveEventHandler(*args
, **kwargs
):
9191 RemoveEventHandler(self, EvtHandler handler) -> bool
9193 Find the given handler in the event handler chain and remove (but not
9194 delete) it from the event handler chain, returns True if it was found
9195 and False otherwise (this also results in an assert failure so this
9196 function should only be called when the handler is supposed to be
9199 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9201 def SetValidator(*args
, **kwargs
):
9203 SetValidator(self, Validator validator)
9205 Deletes the current validator (if any) and sets the window validator,
9206 having called wx.Validator.Clone to create a new validator of this
9209 return _core_
.Window_SetValidator(*args
, **kwargs
)
9211 def GetValidator(*args
, **kwargs
):
9213 GetValidator(self) -> Validator
9215 Returns a pointer to the current validator for the window, or None if
9218 return _core_
.Window_GetValidator(*args
, **kwargs
)
9220 def Validate(*args
, **kwargs
):
9222 Validate(self) -> bool
9224 Validates the current values of the child controls using their
9225 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9226 style flag set, the method will also call Validate() of all child
9227 windows. Returns false if any of the validations failed.
9229 return _core_
.Window_Validate(*args
, **kwargs
)
9231 def TransferDataToWindow(*args
, **kwargs
):
9233 TransferDataToWindow(self) -> bool
9235 Transfers values to child controls from data areas specified by their
9236 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9237 style flag set, the method will also call TransferDataToWindow() of
9240 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9242 def TransferDataFromWindow(*args
, **kwargs
):
9244 TransferDataFromWindow(self) -> bool
9246 Transfers values from child controls to data areas specified by their
9247 validators. Returns false if a transfer failed. If the window has
9248 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9249 also call TransferDataFromWindow() of all child windows.
9251 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9253 def InitDialog(*args
, **kwargs
):
9257 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9258 to the dialog via validators.
9260 return _core_
.Window_InitDialog(*args
, **kwargs
)
9262 def SetAcceleratorTable(*args
, **kwargs
):
9264 SetAcceleratorTable(self, AcceleratorTable accel)
9266 Sets the accelerator table for this window.
9268 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9270 def GetAcceleratorTable(*args
, **kwargs
):
9272 GetAcceleratorTable(self) -> AcceleratorTable
9274 Gets the accelerator table for this window.
9276 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9278 def RegisterHotKey(*args
, **kwargs
):
9280 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9282 Registers a system wide hotkey. Every time the user presses the hotkey
9283 registered here, this window will receive a hotkey event. It will
9284 receive the event even if the application is in the background and
9285 does not have the input focus because the user is working with some
9286 other application. To bind an event handler function to this hotkey
9287 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9288 hotkey was registered successfully.
9290 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9292 def UnregisterHotKey(*args
, **kwargs
):
9294 UnregisterHotKey(self, int hotkeyId) -> bool
9296 Unregisters a system wide hotkey.
9298 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9300 def ConvertDialogPointToPixels(*args
, **kwargs
):
9302 ConvertDialogPointToPixels(self, Point pt) -> Point
9304 Converts a point or size from dialog units to pixels. Dialog units
9305 are used for maintaining a dialog's proportions even if the font
9306 changes. For the x dimension, the dialog units are multiplied by the
9307 average character width and then divided by 4. For the y dimension,
9308 the dialog units are multiplied by the average character height and
9311 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9313 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9315 ConvertDialogSizeToPixels(self, Size sz) -> Size
9317 Converts a point or size from dialog units to pixels. Dialog units
9318 are used for maintaining a dialog's proportions even if the font
9319 changes. For the x dimension, the dialog units are multiplied by the
9320 average character width and then divided by 4. For the y dimension,
9321 the dialog units are multiplied by the average character height and
9324 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9326 def DLG_PNT(*args
, **kwargs
):
9328 DLG_PNT(self, Point pt) -> Point
9330 Converts a point or size from dialog units to pixels. Dialog units
9331 are used for maintaining a dialog's proportions even if the font
9332 changes. For the x dimension, the dialog units are multiplied by the
9333 average character width and then divided by 4. For the y dimension,
9334 the dialog units are multiplied by the average character height and
9337 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9339 def DLG_SZE(*args
, **kwargs
):
9341 DLG_SZE(self, Size sz) -> Size
9343 Converts a point or size from dialog units to pixels. Dialog units
9344 are used for maintaining a dialog's proportions even if the font
9345 changes. For the x dimension, the dialog units are multiplied by the
9346 average character width and then divided by 4. For the y dimension,
9347 the dialog units are multiplied by the average character height and
9350 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9352 def ConvertPixelPointToDialog(*args
, **kwargs
):
9353 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9354 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9356 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9357 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9358 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9360 def WarpPointer(*args
, **kwargs
):
9362 WarpPointer(self, int x, int y)
9364 Moves the pointer to the given position on the window.
9366 NOTE: This function is not supported under Mac because Apple Human
9367 Interface Guidelines forbid moving the mouse cursor programmatically.
9369 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9371 def CaptureMouse(*args
, **kwargs
):
9375 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9376 release the capture.
9378 Note that wxWindows maintains the stack of windows having captured the
9379 mouse and when the mouse is released the capture returns to the window
9380 which had had captured it previously and it is only really released if
9381 there were no previous window. In particular, this means that you must
9382 release the mouse as many times as you capture it, unless the window
9383 receives the `wx.MouseCaptureLostEvent` event.
9385 Any application which captures the mouse in the beginning of some
9386 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9387 operation when it receives the event. The event handler must not
9390 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9392 def ReleaseMouse(*args
, **kwargs
):
9396 Releases mouse input captured with wx.Window.CaptureMouse.
9398 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9400 def GetCapture(*args
, **kwargs
):
9402 GetCapture() -> Window
9404 Returns the window which currently captures the mouse or None
9406 return _core_
.Window_GetCapture(*args
, **kwargs
)
9408 GetCapture
= staticmethod(GetCapture
)
9409 def HasCapture(*args
, **kwargs
):
9411 HasCapture(self) -> bool
9413 Returns true if this window has the current mouse capture.
9415 return _core_
.Window_HasCapture(*args
, **kwargs
)
9417 def Refresh(*args
, **kwargs
):
9419 Refresh(self, bool eraseBackground=True, Rect rect=None)
9421 Mark the specified rectangle (or the whole window) as "dirty" so it
9422 will be repainted. Causes an EVT_PAINT event to be generated and sent
9425 return _core_
.Window_Refresh(*args
, **kwargs
)
9427 def RefreshRect(*args
, **kwargs
):
9429 RefreshRect(self, Rect rect, bool eraseBackground=True)
9431 Redraws the contents of the given rectangle: the area inside it will
9432 be repainted. This is the same as Refresh but has a nicer syntax.
9434 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9436 def Update(*args
, **kwargs
):
9440 Calling this method immediately repaints the invalidated area of the
9441 window instead of waiting for the EVT_PAINT event to happen, (normally
9442 this would usually only happen when the flow of control returns to the
9443 event loop.) Notice that this function doesn't refresh the window and
9444 does nothing if the window has been already repainted. Use `Refresh`
9445 first if you want to immediately redraw the window (or some portion of
9446 it) unconditionally.
9448 return _core_
.Window_Update(*args
, **kwargs
)
9450 def ClearBackground(*args
, **kwargs
):
9452 ClearBackground(self)
9454 Clears the window by filling it with the current background
9455 colour. Does not cause an erase background event to be generated.
9457 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9459 def Freeze(*args
, **kwargs
):
9463 Freezes the window or, in other words, prevents any updates from
9464 taking place on screen, the window is not redrawn at all. Thaw must be
9465 called to reenable window redrawing. Calls to Freeze/Thaw may be
9466 nested, with the actual Thaw being delayed until all the nesting has
9469 This method is useful for visual appearance optimization (for example,
9470 it is a good idea to use it before inserting large amount of text into
9471 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9472 for all controls so it is mostly just a hint to wxWindows and not a
9473 mandatory directive.
9475 return _core_
.Window_Freeze(*args
, **kwargs
)
9477 def IsFrozen(*args
, **kwargs
):
9479 IsFrozen(self) -> bool
9481 Returns ``True`` if the window has been frozen and not thawed yet.
9483 :see: `Freeze` and `Thaw`
9485 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9487 def Thaw(*args
, **kwargs
):
9491 Reenables window updating after a previous call to Freeze. Calls to
9492 Freeze/Thaw may be nested, so Thaw must be called the same number of
9493 times that Freeze was before the window will be updated.
9495 return _core_
.Window_Thaw(*args
, **kwargs
)
9497 def PrepareDC(*args
, **kwargs
):
9499 PrepareDC(self, DC dc)
9501 Call this function to prepare the device context for drawing a
9502 scrolled image. It sets the device origin according to the current
9505 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9507 def IsDoubleBuffered(*args
, **kwargs
):
9509 IsDoubleBuffered(self) -> bool
9511 Returns ``True`` if the window contents is double-buffered by the
9512 system, i.e. if any drawing done on the window is really done on a
9513 temporary backing surface and transferred to the screen all at once
9516 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9518 def GetUpdateRegion(*args
, **kwargs
):
9520 GetUpdateRegion(self) -> Region
9522 Returns the region specifying which parts of the window have been
9523 damaged. Should only be called within an EVT_PAINT handler.
9525 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9527 def GetUpdateClientRect(*args
, **kwargs
):
9529 GetUpdateClientRect(self) -> Rect
9531 Get the update rectangle region bounding box in client coords.
9533 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9535 def IsExposed(*args
, **kwargs
):
9537 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9539 Returns true if the given point or rectangle area has been exposed
9540 since the last repaint. Call this in an paint event handler to
9541 optimize redrawing by only redrawing those areas, which have been
9544 return _core_
.Window_IsExposed(*args
, **kwargs
)
9546 def IsExposedPoint(*args
, **kwargs
):
9548 IsExposedPoint(self, Point pt) -> bool
9550 Returns true if the given point or rectangle area has been exposed
9551 since the last repaint. Call this in an paint event handler to
9552 optimize redrawing by only redrawing those areas, which have been
9555 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9557 def IsExposedRect(*args
, **kwargs
):
9559 IsExposedRect(self, Rect rect) -> bool
9561 Returns true if the given point or rectangle area has been exposed
9562 since the last repaint. Call this in an paint event handler to
9563 optimize redrawing by only redrawing those areas, which have been
9566 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9568 def GetDefaultAttributes(*args
, **kwargs
):
9570 GetDefaultAttributes(self) -> VisualAttributes
9572 Get the default attributes for an instance of this class. This is
9573 useful if you want to use the same font or colour in your own control
9574 as in a standard control -- which is a much better idea than hard
9575 coding specific colours or fonts which might look completely out of
9576 place on the user's system, especially if it uses themes.
9578 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9580 def GetClassDefaultAttributes(*args
, **kwargs
):
9582 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9584 Get the default attributes for this class. This is useful if you want
9585 to use the same font or colour in your own control as in a standard
9586 control -- which is a much better idea than hard coding specific
9587 colours or fonts which might look completely out of place on the
9588 user's system, especially if it uses themes.
9590 The variant parameter is only relevant under Mac currently and is
9591 ignore under other platforms. Under Mac, it will change the size of
9592 the returned font. See `wx.Window.SetWindowVariant` for more about
9595 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9597 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9598 def SetBackgroundColour(*args
, **kwargs
):
9600 SetBackgroundColour(self, Colour colour) -> bool
9602 Sets the background colour of the window. Returns True if the colour
9603 was changed. The background colour is usually painted by the default
9604 EVT_ERASE_BACKGROUND event handler function under Windows and
9605 automatically under GTK. Using `wx.NullColour` will reset the window
9606 to the default background colour.
9608 Note that setting the background colour may not cause an immediate
9609 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9610 calling this function.
9612 Using this function will disable attempts to use themes for this
9613 window, if the system supports them. Use with care since usually the
9614 themes represent the appearance chosen by the user to be used for all
9615 applications on the system.
9617 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9619 def SetOwnBackgroundColour(*args
, **kwargs
):
9620 """SetOwnBackgroundColour(self, Colour colour)"""
9621 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9623 def SetForegroundColour(*args
, **kwargs
):
9625 SetForegroundColour(self, Colour colour) -> bool
9627 Sets the foreground colour of the window. Returns True is the colour
9628 was changed. The interpretation of foreground colour is dependent on
9629 the window class; it may be the text colour or other colour, or it may
9632 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9634 def SetOwnForegroundColour(*args
, **kwargs
):
9635 """SetOwnForegroundColour(self, Colour colour)"""
9636 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9638 def GetBackgroundColour(*args
, **kwargs
):
9640 GetBackgroundColour(self) -> Colour
9642 Returns the background colour of the window.
9644 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9646 def GetForegroundColour(*args
, **kwargs
):
9648 GetForegroundColour(self) -> Colour
9650 Returns the foreground colour of the window. The interpretation of
9651 foreground colour is dependent on the window class; it may be the text
9652 colour or other colour, or it may not be used at all.
9654 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9656 def InheritsBackgroundColour(*args
, **kwargs
):
9657 """InheritsBackgroundColour(self) -> bool"""
9658 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9660 def UseBgCol(*args
, **kwargs
):
9661 """UseBgCol(self) -> bool"""
9662 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9664 def SetBackgroundStyle(*args
, **kwargs
):
9666 SetBackgroundStyle(self, int style) -> bool
9668 Returns the background style of the window. The background style
9669 indicates how the background of the window is drawn.
9671 ====================== ========================================
9672 wx.BG_STYLE_SYSTEM The background colour or pattern should
9673 be determined by the system
9674 wx.BG_STYLE_COLOUR The background should be a solid colour
9675 wx.BG_STYLE_CUSTOM The background will be implemented by the
9677 ====================== ========================================
9679 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9680 a custom background, such as a tiled bitmap. Currently the style has
9681 no effect on other platforms.
9683 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9685 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9687 def GetBackgroundStyle(*args
, **kwargs
):
9689 GetBackgroundStyle(self) -> int
9691 Returns the background style of the window.
9693 :see: `SetBackgroundStyle`
9695 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9697 def HasTransparentBackground(*args
, **kwargs
):
9699 HasTransparentBackground(self) -> bool
9701 Returns True if this window's background is transparent (as, for
9702 example, for `wx.StaticText`) and should show the parent window's
9705 This method is mostly used internally by the library itself and you
9706 normally shouldn't have to call it. You may, however, have to override
9707 it in your custom control classes to ensure that background is painted
9710 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9712 def SetCursor(*args
, **kwargs
):
9714 SetCursor(self, Cursor cursor) -> bool
9716 Sets the window's cursor. Notice that the window cursor also sets it
9717 for the children of the window implicitly.
9719 The cursor may be wx.NullCursor in which case the window cursor will
9720 be reset back to default.
9722 return _core_
.Window_SetCursor(*args
, **kwargs
)
9724 def GetCursor(*args
, **kwargs
):
9726 GetCursor(self) -> Cursor
9728 Return the cursor associated with this window.
9730 return _core_
.Window_GetCursor(*args
, **kwargs
)
9732 def SetFont(*args
, **kwargs
):
9734 SetFont(self, Font font) -> bool
9736 Sets the font for this window.
9738 return _core_
.Window_SetFont(*args
, **kwargs
)
9740 def SetOwnFont(*args
, **kwargs
):
9741 """SetOwnFont(self, Font font)"""
9742 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9744 def GetFont(*args
, **kwargs
):
9746 GetFont(self) -> Font
9748 Returns the default font used for this window.
9750 return _core_
.Window_GetFont(*args
, **kwargs
)
9752 def SetCaret(*args
, **kwargs
):
9754 SetCaret(self, Caret caret)
9756 Sets the caret associated with the window.
9758 return _core_
.Window_SetCaret(*args
, **kwargs
)
9760 def GetCaret(*args
, **kwargs
):
9762 GetCaret(self) -> Caret
9764 Returns the caret associated with the window.
9766 return _core_
.Window_GetCaret(*args
, **kwargs
)
9768 def GetCharHeight(*args
, **kwargs
):
9770 GetCharHeight(self) -> int
9772 Get the (average) character size for the current font.
9774 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9776 def GetCharWidth(*args
, **kwargs
):
9778 GetCharWidth(self) -> int
9780 Get the (average) character size for the current font.
9782 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9784 def GetTextExtent(*args
, **kwargs
):
9786 GetTextExtent(String string) -> (width, height)
9788 Get the width and height of the text using the current font.
9790 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9792 def GetFullTextExtent(*args
, **kwargs
):
9794 GetFullTextExtent(String string, Font font=None) ->
9795 (width, height, descent, externalLeading)
9797 Get the width, height, decent and leading of the text using the
9798 current or specified font.
9800 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9802 def ClientToScreenXY(*args
, **kwargs
):
9804 ClientToScreenXY(int x, int y) -> (x,y)
9806 Converts to screen coordinates from coordinates relative to this window.
9808 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9810 def ScreenToClientXY(*args
, **kwargs
):
9812 ScreenToClientXY(int x, int y) -> (x,y)
9814 Converts from screen to client window coordinates.
9816 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9818 def ClientToScreen(*args
, **kwargs
):
9820 ClientToScreen(self, Point pt) -> Point
9822 Converts to screen coordinates from coordinates relative to this window.
9824 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9826 def ScreenToClient(*args
, **kwargs
):
9828 ScreenToClient(self, Point pt) -> Point
9830 Converts from screen to client window coordinates.
9832 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9834 def HitTestXY(*args
, **kwargs
):
9836 HitTestXY(self, int x, int y) -> int
9838 Test where the given (in client coords) point lies
9840 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9842 def HitTest(*args
, **kwargs
):
9844 HitTest(self, Point pt) -> int
9846 Test where the given (in client coords) point lies
9848 return _core_
.Window_HitTest(*args
, **kwargs
)
9850 def GetBorder(*args
):
9852 GetBorder(self, long flags) -> int
9853 GetBorder(self) -> int
9855 Get border for the flags of this window
9857 return _core_
.Window_GetBorder(*args
)
9859 def UpdateWindowUI(*args
, **kwargs
):
9861 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9863 This function sends EVT_UPDATE_UI events to the window. The particular
9864 implementation depends on the window; for example a wx.ToolBar will
9865 send an update UI event for each toolbar button, and a wx.Frame will
9866 send an update UI event for each menubar menu item. You can call this
9867 function from your application to ensure that your UI is up-to-date at
9868 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9869 concerned). This may be necessary if you have called
9870 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9871 limit the overhead that wxWindows incurs by sending update UI events
9874 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9876 def PopupMenuXY(*args
, **kwargs
):
9878 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9880 Pops up the given menu at the specified coordinates, relative to this window,
9881 and returns control when the user has dismissed the menu. If a menu item is
9882 selected, the corresponding menu event is generated and will be processed as
9883 usual. If the default position is given then the current position of the
9884 mouse cursor will be used.
9886 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9888 def PopupMenu(*args
, **kwargs
):
9890 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9892 Pops up the given menu at the specified coordinates, relative to this window,
9893 and returns control when the user has dismissed the menu. If a menu item is
9894 selected, the corresponding menu event is generated and will be processed as
9895 usual. If the default position is given then the current position of the
9896 mouse cursor will be used.
9898 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9900 def HasMultiplePages(*args
, **kwargs
):
9901 """HasMultiplePages(self) -> bool"""
9902 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9904 def GetHandle(*args
, **kwargs
):
9906 GetHandle(self) -> long
9908 Returns the platform-specific handle (as a long integer) of the
9909 physical window. Currently on wxMac it returns the handle of the
9910 toplevel parent of the window.
9912 return _core_
.Window_GetHandle(*args
, **kwargs
)
9914 def AssociateHandle(*args
, **kwargs
):
9916 AssociateHandle(self, long handle)
9918 Associate the window with a new native handle
9920 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9922 def DissociateHandle(*args
, **kwargs
):
9924 DissociateHandle(self)
9926 Dissociate the current native handle from the window
9928 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9930 def HasScrollbar(*args
, **kwargs
):
9932 HasScrollbar(self, int orient) -> bool
9934 Does the window have the scrollbar for this orientation?
9936 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9938 def SetScrollbar(*args
, **kwargs
):
9940 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9943 Sets the scrollbar properties of a built-in scrollbar.
9945 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9947 def SetScrollPos(*args
, **kwargs
):
9949 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9951 Sets the position of one of the built-in scrollbars.
9953 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9955 def GetScrollPos(*args
, **kwargs
):
9957 GetScrollPos(self, int orientation) -> int
9959 Returns the built-in scrollbar position.
9961 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9963 def GetScrollThumb(*args
, **kwargs
):
9965 GetScrollThumb(self, int orientation) -> int
9967 Returns the built-in scrollbar thumb size.
9969 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9971 def GetScrollRange(*args
, **kwargs
):
9973 GetScrollRange(self, int orientation) -> int
9975 Returns the built-in scrollbar range.
9977 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9979 def ScrollWindow(*args
, **kwargs
):
9981 ScrollWindow(self, int dx, int dy, Rect rect=None)
9983 Physically scrolls the pixels in the window and move child windows
9984 accordingly. Use this function to optimise your scrolling
9985 implementations, to minimise the area that must be redrawn. Note that
9986 it is rarely required to call this function from a user program.
9988 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9990 def ScrollLines(*args
, **kwargs
):
9992 ScrollLines(self, int lines) -> bool
9994 If the platform and window class supports it, scrolls the window by
9995 the given number of lines down, if lines is positive, or up if lines
9996 is negative. Returns True if the window was scrolled, False if it was
9997 already on top/bottom and nothing was done.
9999 return _core_
.Window_ScrollLines(*args
, **kwargs
)
10001 def ScrollPages(*args
, **kwargs
):
10003 ScrollPages(self, int pages) -> bool
10005 If the platform and window class supports it, scrolls the window by
10006 the given number of pages down, if pages is positive, or up if pages
10007 is negative. Returns True if the window was scrolled, False if it was
10008 already on top/bottom and nothing was done.
10010 return _core_
.Window_ScrollPages(*args
, **kwargs
)
10012 def LineUp(*args
, **kwargs
):
10014 LineUp(self) -> bool
10016 This is just a wrapper for ScrollLines(-1).
10018 return _core_
.Window_LineUp(*args
, **kwargs
)
10020 def LineDown(*args
, **kwargs
):
10022 LineDown(self) -> bool
10024 This is just a wrapper for ScrollLines(1).
10026 return _core_
.Window_LineDown(*args
, **kwargs
)
10028 def PageUp(*args
, **kwargs
):
10030 PageUp(self) -> bool
10032 This is just a wrapper for ScrollPages(-1).
10034 return _core_
.Window_PageUp(*args
, **kwargs
)
10036 def PageDown(*args
, **kwargs
):
10038 PageDown(self) -> bool
10040 This is just a wrapper for ScrollPages(1).
10042 return _core_
.Window_PageDown(*args
, **kwargs
)
10044 def SetHelpText(*args
, **kwargs
):
10046 SetHelpText(self, String text)
10048 Sets the help text to be used as context-sensitive help for this
10049 window. Note that the text is actually stored by the current
10050 `wx.HelpProvider` implementation, and not in the window object itself.
10052 return _core_
.Window_SetHelpText(*args
, **kwargs
)
10054 def SetHelpTextForId(*args
, **kwargs
):
10056 SetHelpTextForId(self, String text)
10058 Associate this help text with all windows with the same id as this
10061 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
10063 def GetHelpTextAtPoint(*args
, **kwargs
):
10065 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10067 Get the help string associated with the given position in this window.
10069 Notice that pt may be invalid if event origin is keyboard or unknown
10070 and this method should return the global window help text then
10073 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
10075 def GetHelpText(*args
, **kwargs
):
10077 GetHelpText(self) -> String
10079 Gets the help text to be used as context-sensitive help for this
10080 window. Note that the text is actually stored by the current
10081 `wx.HelpProvider` implementation, and not in the window object itself.
10083 return _core_
.Window_GetHelpText(*args
, **kwargs
)
10085 def SetToolTipString(*args
, **kwargs
):
10087 SetToolTipString(self, String tip)
10089 Attach a tooltip to the window.
10091 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10093 def SetToolTip(*args
, **kwargs
):
10095 SetToolTip(self, ToolTip tip)
10097 Attach a tooltip to the window.
10099 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10101 def GetToolTip(*args
, **kwargs
):
10103 GetToolTip(self) -> ToolTip
10105 get the associated tooltip or None if none
10107 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10109 def SetDropTarget(*args
, **kwargs
):
10111 SetDropTarget(self, DropTarget dropTarget)
10113 Associates a drop target with this window. If the window already has
10114 a drop target, it is deleted.
10116 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10118 def GetDropTarget(*args
, **kwargs
):
10120 GetDropTarget(self) -> DropTarget
10122 Returns the associated drop target, which may be None.
10124 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10126 def DragAcceptFiles(*args
, **kwargs
):
10128 DragAcceptFiles(self, bool accept)
10130 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10131 Only functional on Windows.
10133 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10135 def SetConstraints(*args
, **kwargs
):
10137 SetConstraints(self, LayoutConstraints constraints)
10139 Sets the window to have the given layout constraints. If an existing
10140 layout constraints object is already owned by the window, it will be
10141 deleted. Pass None to disassociate and delete the window's current
10144 You must call SetAutoLayout to tell a window to use the constraints
10145 automatically in its default EVT_SIZE handler; otherwise, you must
10146 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10147 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10150 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10152 def GetConstraints(*args
, **kwargs
):
10154 GetConstraints(self) -> LayoutConstraints
10156 Returns a pointer to the window's layout constraints, or None if there
10159 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10161 def SetAutoLayout(*args
, **kwargs
):
10163 SetAutoLayout(self, bool autoLayout)
10165 Determines whether the Layout function will be called automatically
10166 when the window is resized. lease note that this only happens for the
10167 windows usually used to contain children, namely `wx.Panel` and
10168 `wx.TopLevelWindow` (and the classes deriving from them).
10170 This method is called implicitly by `SetSizer` but if you use
10171 `SetConstraints` you should call it manually or otherwise the window
10172 layout won't be correctly updated when its size changes.
10174 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10176 def GetAutoLayout(*args
, **kwargs
):
10178 GetAutoLayout(self) -> bool
10180 Returns the current autoLayout setting
10182 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10184 def Layout(*args
, **kwargs
):
10186 Layout(self) -> bool
10188 Invokes the constraint-based layout algorithm or the sizer-based
10189 algorithm for this window. See SetAutoLayout: when auto layout is on,
10190 this function gets called automatically by the default EVT_SIZE
10191 handler when the window is resized.
10193 return _core_
.Window_Layout(*args
, **kwargs
)
10195 def SetSizer(*args
, **kwargs
):
10197 SetSizer(self, Sizer sizer, bool deleteOld=True)
10199 Sets the window to have the given layout sizer. The window will then
10200 own the object, and will take care of its deletion. If an existing
10201 layout sizer object is already owned by the window, it will be deleted
10202 if the deleteOld parameter is true. Note that this function will also
10203 call SetAutoLayout implicitly with a True parameter if the sizer is
10204 non-None, and False otherwise.
10206 return _core_
.Window_SetSizer(*args
, **kwargs
)
10208 def SetSizerAndFit(*args
, **kwargs
):
10210 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10212 The same as SetSizer, except it also sets the size hints for the
10213 window based on the sizer's minimum size.
10215 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10217 def GetSizer(*args
, **kwargs
):
10219 GetSizer(self) -> Sizer
10221 Return the sizer associated with the window by a previous call to
10222 SetSizer or None if there isn't one.
10224 return _core_
.Window_GetSizer(*args
, **kwargs
)
10226 def SetContainingSizer(*args
, **kwargs
):
10228 SetContainingSizer(self, Sizer sizer)
10230 This normally does not need to be called by application code. It is
10231 called internally when a window is added to a sizer, and is used so
10232 the window can remove itself from the sizer when it is destroyed.
10234 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10236 def GetContainingSizer(*args
, **kwargs
):
10238 GetContainingSizer(self) -> Sizer
10240 Return the sizer that this window is a member of, if any, otherwise None.
10242 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10244 def InheritAttributes(*args
, **kwargs
):
10246 InheritAttributes(self)
10248 This function is (or should be, in case of custom controls) called
10249 during window creation to intelligently set up the window visual
10250 attributes, that is the font and the foreground and background
10253 By 'intelligently' the following is meant: by default, all windows use
10254 their own default attributes. However if some of the parent's
10255 attributes are explicitly changed (that is, using SetFont and not
10256 SetOwnFont) and if the corresponding attribute hadn't been
10257 explicitly set for this window itself, then this window takes the same
10258 value as used by the parent. In addition, if the window overrides
10259 ShouldInheritColours to return false, the colours will not be changed
10260 no matter what and only the font might.
10262 This rather complicated logic is necessary in order to accommodate the
10263 different usage scenarios. The most common one is when all default
10264 attributes are used and in this case, nothing should be inherited as
10265 in modern GUIs different controls use different fonts (and colours)
10266 than their siblings so they can't inherit the same value from the
10267 parent. However it was also deemed desirable to allow to simply change
10268 the attributes of all children at once by just changing the font or
10269 colour of their common parent, hence in this case we do inherit the
10270 parents attributes.
10273 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10275 def ShouldInheritColours(*args
, **kwargs
):
10277 ShouldInheritColours(self) -> bool
10279 Return true from here to allow the colours of this window to be
10280 changed by InheritAttributes, returning false forbids inheriting them
10281 from the parent window.
10283 The base class version returns false, but this method is overridden in
10284 wxControl where it returns true.
10286 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10288 def CanSetTransparent(*args
, **kwargs
):
10290 CanSetTransparent(self) -> bool
10292 Returns ``True`` if the platform supports setting the transparency for
10293 this window. Note that this method will err on the side of caution,
10294 so it is possible that this will return ``False`` when it is in fact
10295 possible to set the transparency.
10297 NOTE: On X-windows systems the X server must have the composite
10298 extension loaded, and there must be a composite manager program (such
10299 as xcompmgr) running.
10301 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10303 def SetTransparent(*args
, **kwargs
):
10305 SetTransparent(self, byte alpha) -> bool
10307 Attempt to set the transparency of this window to the ``alpha`` value,
10308 returns True on success. The ``alpha`` value is an integer in the
10309 range of 0 to 255, where 0 is fully transparent and 255 is fully
10312 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10314 def PostCreate(self
, pre
):
10316 Phase 3 of the 2-phase create <wink!>
10317 Call this method after precreating the window with the 2-phase create method.
10319 self
.this
= pre
.this
10320 self
.thisown
= pre
.thisown
10322 if hasattr(self
, '_setOORInfo'):
10323 self
._setOORInfo
(self
)
10324 if hasattr(self
, '_setCallbackInfo'):
10325 self
._setCallbackInfo
(self
, self
.__class
__)
10327 def SendSizeEvent(self
):
10328 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10330 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10331 AdjustedBestSize
= property(GetAdjustedBestSize
,doc
="See `GetAdjustedBestSize`")
10332 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10333 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10334 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10335 BestFittingSize
= property(GetBestFittingSize
,SetBestFittingSize
,doc
="See `GetBestFittingSize` and `SetBestFittingSize`")
10336 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10337 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10338 Border
= property(GetBorder
,doc
="See `GetBorder`")
10339 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10340 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10341 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10342 Children
= property(GetChildren
,doc
="See `GetChildren`")
10343 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10344 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10345 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10346 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10347 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10348 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10349 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10350 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10351 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10352 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10353 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10354 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10355 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10356 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10357 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10358 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10359 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10360 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10361 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10362 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10363 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10364 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10365 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10366 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10367 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10368 Parent
= property(GetParent
,doc
="See `GetParent`")
10369 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10370 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10371 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10372 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10373 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10374 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10375 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10376 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10377 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10378 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10379 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10380 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10381 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10382 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10383 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10384 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10385 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10386 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10387 _core_
.Window_swigregister(Window
)
10389 def PreWindow(*args
, **kwargs
):
10391 PreWindow() -> Window
10393 Precreate a Window for 2-phase creation.
10395 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10398 def Window_NewControlId(*args
):
10400 Window_NewControlId() -> int
10402 Generate a control id for the controls which were not given one.
10404 return _core_
.Window_NewControlId(*args
)
10406 def Window_NextControlId(*args
, **kwargs
):
10408 Window_NextControlId(int winid) -> int
10410 Get the id of the control following the one with the given
10413 return _core_
.Window_NextControlId(*args
, **kwargs
)
10415 def Window_PrevControlId(*args
, **kwargs
):
10417 Window_PrevControlId(int winid) -> int
10419 Get the id of the control preceding the one with the given
10422 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10424 def Window_FindFocus(*args
):
10426 Window_FindFocus() -> Window
10428 Returns the window or control that currently has the keyboard focus,
10431 return _core_
.Window_FindFocus(*args
)
10433 def Window_GetCapture(*args
):
10435 Window_GetCapture() -> Window
10437 Returns the window which currently captures the mouse or None
10439 return _core_
.Window_GetCapture(*args
)
10441 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10443 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10445 Get the default attributes for this class. This is useful if you want
10446 to use the same font or colour in your own control as in a standard
10447 control -- which is a much better idea than hard coding specific
10448 colours or fonts which might look completely out of place on the
10449 user's system, especially if it uses themes.
10451 The variant parameter is only relevant under Mac currently and is
10452 ignore under other platforms. Under Mac, it will change the size of
10453 the returned font. See `wx.Window.SetWindowVariant` for more about
10456 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10458 def DLG_PNT(win
, point_or_x
, y
=None):
10460 Convenience function for converting a Point or (x,y) in
10461 dialog units to pixel units.
10464 return win
.ConvertDialogPointToPixels(point_or_x
)
10466 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10468 def DLG_SZE(win
, size_width
, height
=None):
10470 Convenience function for converting a Size or (w,h) in
10471 dialog units to pixel units.
10474 return win
.ConvertDialogSizeToPixels(size_width
)
10476 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10479 def FindWindowById(*args
, **kwargs
):
10481 FindWindowById(long id, Window parent=None) -> Window
10483 Find the first window in the application with the given id. If parent
10484 is None, the search will start from all top-level frames and dialog
10485 boxes; if non-None, the search will be limited to the given window
10486 hierarchy. The search is recursive in both cases.
10488 return _core_
.FindWindowById(*args
, **kwargs
)
10490 def FindWindowByName(*args
, **kwargs
):
10492 FindWindowByName(String name, Window parent=None) -> Window
10494 Find a window by its name (as given in a window constructor or Create
10495 function call). If parent is None, the search will start from all
10496 top-level frames and dialog boxes; if non-None, the search will be
10497 limited to the given window hierarchy. The search is recursive in both
10500 If no window with such name is found, wx.FindWindowByLabel is called.
10502 return _core_
.FindWindowByName(*args
, **kwargs
)
10504 def FindWindowByLabel(*args
, **kwargs
):
10506 FindWindowByLabel(String label, Window parent=None) -> Window
10508 Find a window by its label. Depending on the type of window, the label
10509 may be a window title or panel item label. If parent is None, the
10510 search will start from all top-level frames and dialog boxes; if
10511 non-None, the search will be limited to the given window
10512 hierarchy. The search is recursive in both cases.
10514 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10516 def Window_FromHWND(*args
, **kwargs
):
10517 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10518 return _core_
.Window_FromHWND(*args
, **kwargs
)
10520 def GetTopLevelWindows(*args
):
10522 GetTopLevelWindows() -> PyObject
10524 Returns a list of the the application's top-level windows, (frames,
10525 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10526 by wxWidgets, and so it is only valid as long as no top-level windows
10527 are closed or new top-level windows are created.
10530 return _core_
.GetTopLevelWindows(*args
)
10531 #---------------------------------------------------------------------------
10533 class Validator(EvtHandler
):
10534 """Proxy of C++ Validator class"""
10535 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10536 __repr__
= _swig_repr
10537 def __init__(self
, *args
, **kwargs
):
10538 """__init__(self) -> Validator"""
10539 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10540 self
._setOORInfo
(self
)
10542 def Clone(*args
, **kwargs
):
10543 """Clone(self) -> Validator"""
10544 return _core_
.Validator_Clone(*args
, **kwargs
)
10546 def Validate(*args
, **kwargs
):
10547 """Validate(self, Window parent) -> bool"""
10548 return _core_
.Validator_Validate(*args
, **kwargs
)
10550 def TransferToWindow(*args
, **kwargs
):
10551 """TransferToWindow(self) -> bool"""
10552 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10554 def TransferFromWindow(*args
, **kwargs
):
10555 """TransferFromWindow(self) -> bool"""
10556 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10558 def GetWindow(*args
, **kwargs
):
10559 """GetWindow(self) -> Window"""
10560 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10562 def SetWindow(*args
, **kwargs
):
10563 """SetWindow(self, Window window)"""
10564 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10566 def IsSilent(*args
, **kwargs
):
10567 """IsSilent() -> bool"""
10568 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10570 IsSilent
= staticmethod(IsSilent
)
10571 def SetBellOnError(*args
, **kwargs
):
10572 """SetBellOnError(int doIt=True)"""
10573 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10575 SetBellOnError
= staticmethod(SetBellOnError
)
10576 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10577 _core_
.Validator_swigregister(Validator
)
10579 def Validator_IsSilent(*args
):
10580 """Validator_IsSilent() -> bool"""
10581 return _core_
.Validator_IsSilent(*args
)
10583 def Validator_SetBellOnError(*args
, **kwargs
):
10584 """Validator_SetBellOnError(int doIt=True)"""
10585 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10587 class PyValidator(Validator
):
10588 """Proxy of C++ PyValidator class"""
10589 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10590 __repr__
= _swig_repr
10591 def __init__(self
, *args
, **kwargs
):
10592 """__init__(self) -> PyValidator"""
10593 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10595 self
._setCallbackInfo
(self
, PyValidator
, 1)
10596 self
._setOORInfo
(self
)
10598 def _setCallbackInfo(*args
, **kwargs
):
10599 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10600 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10602 _core_
.PyValidator_swigregister(PyValidator
)
10604 #---------------------------------------------------------------------------
10606 class Menu(EvtHandler
):
10607 """Proxy of C++ Menu class"""
10608 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10609 __repr__
= _swig_repr
10610 def __init__(self
, *args
, **kwargs
):
10611 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10612 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10613 self
._setOORInfo
(self
)
10615 def Append(*args
, **kwargs
):
10617 Append(self, int id, String text=EmptyString, String help=EmptyString,
10618 int kind=ITEM_NORMAL) -> MenuItem
10620 return _core_
.Menu_Append(*args
, **kwargs
)
10622 def AppendSeparator(*args
, **kwargs
):
10623 """AppendSeparator(self) -> MenuItem"""
10624 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10626 def AppendCheckItem(*args
, **kwargs
):
10627 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10628 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10630 def AppendRadioItem(*args
, **kwargs
):
10631 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10632 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10634 def AppendMenu(*args
, **kwargs
):
10635 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10636 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10638 def AppendSubMenu(*args
, **kwargs
):
10639 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10640 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10642 def AppendItem(*args
, **kwargs
):
10643 """AppendItem(self, MenuItem item) -> MenuItem"""
10644 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10646 def InsertItem(*args
, **kwargs
):
10647 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10648 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10650 def PrependItem(*args
, **kwargs
):
10651 """PrependItem(self, MenuItem item) -> MenuItem"""
10652 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10654 def Break(*args
, **kwargs
):
10656 return _core_
.Menu_Break(*args
, **kwargs
)
10658 def Insert(*args
, **kwargs
):
10660 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10661 int kind=ITEM_NORMAL) -> MenuItem
10663 return _core_
.Menu_Insert(*args
, **kwargs
)
10665 def InsertSeparator(*args
, **kwargs
):
10666 """InsertSeparator(self, size_t pos) -> MenuItem"""
10667 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10669 def InsertCheckItem(*args
, **kwargs
):
10670 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10671 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10673 def InsertRadioItem(*args
, **kwargs
):
10674 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10675 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10677 def InsertMenu(*args
, **kwargs
):
10678 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10679 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10681 def Prepend(*args
, **kwargs
):
10683 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10684 int kind=ITEM_NORMAL) -> MenuItem
10686 return _core_
.Menu_Prepend(*args
, **kwargs
)
10688 def PrependSeparator(*args
, **kwargs
):
10689 """PrependSeparator(self) -> MenuItem"""
10690 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10692 def PrependCheckItem(*args
, **kwargs
):
10693 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10694 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10696 def PrependRadioItem(*args
, **kwargs
):
10697 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10698 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10700 def PrependMenu(*args
, **kwargs
):
10701 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10702 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10704 def Remove(*args
, **kwargs
):
10705 """Remove(self, int id) -> MenuItem"""
10706 return _core_
.Menu_Remove(*args
, **kwargs
)
10708 def RemoveItem(*args
, **kwargs
):
10709 """RemoveItem(self, MenuItem item) -> MenuItem"""
10710 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10712 def Delete(*args
, **kwargs
):
10713 """Delete(self, int id) -> bool"""
10714 return _core_
.Menu_Delete(*args
, **kwargs
)
10716 def DeleteItem(*args
, **kwargs
):
10717 """DeleteItem(self, MenuItem item) -> bool"""
10718 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10720 def Destroy(*args
, **kwargs
):
10724 Deletes the C++ object this Python object is a proxy for.
10726 args
[0].this
.own(False)
10727 return _core_
.Menu_Destroy(*args
, **kwargs
)
10729 def DestroyId(*args
, **kwargs
):
10730 """DestroyId(self, int id) -> bool"""
10731 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10733 def DestroyItem(*args
, **kwargs
):
10734 """DestroyItem(self, MenuItem item) -> bool"""
10735 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10737 def GetMenuItemCount(*args
, **kwargs
):
10738 """GetMenuItemCount(self) -> size_t"""
10739 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10741 def GetMenuItems(*args
, **kwargs
):
10742 """GetMenuItems(self) -> PyObject"""
10743 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10745 def FindItem(*args
, **kwargs
):
10746 """FindItem(self, String item) -> int"""
10747 return _core_
.Menu_FindItem(*args
, **kwargs
)
10749 def FindItemById(*args
, **kwargs
):
10750 """FindItemById(self, int id) -> MenuItem"""
10751 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10753 def FindItemByPosition(*args
, **kwargs
):
10754 """FindItemByPosition(self, size_t position) -> MenuItem"""
10755 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10757 def Enable(*args
, **kwargs
):
10758 """Enable(self, int id, bool enable)"""
10759 return _core_
.Menu_Enable(*args
, **kwargs
)
10761 def IsEnabled(*args
, **kwargs
):
10762 """IsEnabled(self, int id) -> bool"""
10763 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10765 def Check(*args
, **kwargs
):
10766 """Check(self, int id, bool check)"""
10767 return _core_
.Menu_Check(*args
, **kwargs
)
10769 def IsChecked(*args
, **kwargs
):
10770 """IsChecked(self, int id) -> bool"""
10771 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10773 def SetLabel(*args
, **kwargs
):
10774 """SetLabel(self, int id, String label)"""
10775 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10777 def GetLabel(*args
, **kwargs
):
10778 """GetLabel(self, int id) -> String"""
10779 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10781 def SetHelpString(*args
, **kwargs
):
10782 """SetHelpString(self, int id, String helpString)"""
10783 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10785 def GetHelpString(*args
, **kwargs
):
10786 """GetHelpString(self, int id) -> String"""
10787 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10789 def SetTitle(*args
, **kwargs
):
10790 """SetTitle(self, String title)"""
10791 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10793 def GetTitle(*args
, **kwargs
):
10794 """GetTitle(self) -> String"""
10795 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10797 def SetEventHandler(*args
, **kwargs
):
10798 """SetEventHandler(self, EvtHandler handler)"""
10799 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10801 def GetEventHandler(*args
, **kwargs
):
10802 """GetEventHandler(self) -> EvtHandler"""
10803 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10805 def SetInvokingWindow(*args
, **kwargs
):
10806 """SetInvokingWindow(self, Window win)"""
10807 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10809 def GetInvokingWindow(*args
, **kwargs
):
10810 """GetInvokingWindow(self) -> Window"""
10811 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10813 def GetStyle(*args
, **kwargs
):
10814 """GetStyle(self) -> long"""
10815 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10817 def UpdateUI(*args
, **kwargs
):
10818 """UpdateUI(self, EvtHandler source=None)"""
10819 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10821 def GetMenuBar(*args
, **kwargs
):
10822 """GetMenuBar(self) -> MenuBar"""
10823 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10825 def Attach(*args
, **kwargs
):
10826 """Attach(self, wxMenuBarBase menubar)"""
10827 return _core_
.Menu_Attach(*args
, **kwargs
)
10829 def Detach(*args
, **kwargs
):
10831 return _core_
.Menu_Detach(*args
, **kwargs
)
10833 def IsAttached(*args
, **kwargs
):
10834 """IsAttached(self) -> bool"""
10835 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10837 def SetParent(*args
, **kwargs
):
10838 """SetParent(self, Menu parent)"""
10839 return _core_
.Menu_SetParent(*args
, **kwargs
)
10841 def GetParent(*args
, **kwargs
):
10842 """GetParent(self) -> Menu"""
10843 return _core_
.Menu_GetParent(*args
, **kwargs
)
10845 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10846 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10847 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10848 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10849 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10850 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10851 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10852 Style
= property(GetStyle
,doc
="See `GetStyle`")
10853 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10854 _core_
.Menu_swigregister(Menu
)
10855 DefaultValidator
= cvar
.DefaultValidator
10857 #---------------------------------------------------------------------------
10859 class MenuBar(Window
):
10860 """Proxy of C++ MenuBar class"""
10861 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10862 __repr__
= _swig_repr
10863 def __init__(self
, *args
, **kwargs
):
10864 """__init__(self, long style=0) -> MenuBar"""
10865 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10866 self
._setOORInfo
(self
)
10868 def Append(*args
, **kwargs
):
10869 """Append(self, Menu menu, String title) -> bool"""
10870 return _core_
.MenuBar_Append(*args
, **kwargs
)
10872 def Insert(*args
, **kwargs
):
10873 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10874 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10876 def GetMenuCount(*args
, **kwargs
):
10877 """GetMenuCount(self) -> size_t"""
10878 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10880 def GetMenu(*args
, **kwargs
):
10881 """GetMenu(self, size_t pos) -> Menu"""
10882 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10884 def Replace(*args
, **kwargs
):
10885 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10886 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10888 def Remove(*args
, **kwargs
):
10889 """Remove(self, size_t pos) -> Menu"""
10890 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10892 def EnableTop(*args
, **kwargs
):
10893 """EnableTop(self, size_t pos, bool enable)"""
10894 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10896 def IsEnabledTop(*args
, **kwargs
):
10897 """IsEnabledTop(self, size_t pos) -> bool"""
10898 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10900 def SetLabelTop(*args
, **kwargs
):
10901 """SetLabelTop(self, size_t pos, String label)"""
10902 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10904 def GetLabelTop(*args
, **kwargs
):
10905 """GetLabelTop(self, size_t pos) -> String"""
10906 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10908 def FindMenuItem(*args
, **kwargs
):
10909 """FindMenuItem(self, String menu, String item) -> int"""
10910 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10912 def FindItemById(*args
, **kwargs
):
10913 """FindItemById(self, int id) -> MenuItem"""
10914 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10916 def FindMenu(*args
, **kwargs
):
10917 """FindMenu(self, String title) -> int"""
10918 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10920 def Enable(*args
, **kwargs
):
10921 """Enable(self, int id, bool enable)"""
10922 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10924 def Check(*args
, **kwargs
):
10925 """Check(self, int id, bool check)"""
10926 return _core_
.MenuBar_Check(*args
, **kwargs
)
10928 def IsChecked(*args
, **kwargs
):
10929 """IsChecked(self, int id) -> bool"""
10930 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10932 def IsEnabled(*args
, **kwargs
):
10933 """IsEnabled(self, int id) -> bool"""
10934 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10936 def SetLabel(*args
, **kwargs
):
10937 """SetLabel(self, int id, String label)"""
10938 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10940 def GetLabel(*args
, **kwargs
):
10941 """GetLabel(self, int id) -> String"""
10942 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10944 def SetHelpString(*args
, **kwargs
):
10945 """SetHelpString(self, int id, String helpString)"""
10946 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10948 def GetHelpString(*args
, **kwargs
):
10949 """GetHelpString(self, int id) -> String"""
10950 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10952 def GetFrame(*args
, **kwargs
):
10953 """GetFrame(self) -> wxFrame"""
10954 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10956 def IsAttached(*args
, **kwargs
):
10957 """IsAttached(self) -> bool"""
10958 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10960 def Attach(*args
, **kwargs
):
10961 """Attach(self, wxFrame frame)"""
10962 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10964 def Detach(*args
, **kwargs
):
10966 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10968 def UpdateMenus(*args
, **kwargs
):
10969 """UpdateMenus(self)"""
10970 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10972 def SetAutoWindowMenu(*args
, **kwargs
):
10973 """SetAutoWindowMenu(bool enable)"""
10974 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10976 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10977 def GetAutoWindowMenu(*args
, **kwargs
):
10978 """GetAutoWindowMenu() -> bool"""
10979 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10981 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10982 def GetMenus(self
):
10983 """Return a list of (menu, label) items for the menus in the MenuBar. """
10984 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
10985 for i
in range(self
.GetMenuCount())]
10987 def SetMenus(self
, items
):
10988 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10989 for i
in range(self
.GetMenuCount()-1, -1, -1):
10994 Frame
= property(GetFrame
,doc
="See `GetFrame`")
10995 Menu
= property(GetMenu
,doc
="See `GetMenu`")
10996 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
10997 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
10998 _core_
.MenuBar_swigregister(MenuBar
)
11000 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
11001 """MenuBar_SetAutoWindowMenu(bool enable)"""
11002 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11004 def MenuBar_GetAutoWindowMenu(*args
):
11005 """MenuBar_GetAutoWindowMenu() -> bool"""
11006 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
11008 #---------------------------------------------------------------------------
11010 class MenuItem(Object
):
11011 """Proxy of C++ MenuItem class"""
11012 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11013 __repr__
= _swig_repr
11014 def __init__(self
, *args
, **kwargs
):
11016 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11017 String help=EmptyString, int kind=ITEM_NORMAL,
11018 Menu subMenu=None) -> MenuItem
11020 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
11021 __swig_destroy__
= _core_
.delete_MenuItem
11022 __del__
= lambda self
: None;
11023 def GetMenu(*args
, **kwargs
):
11024 """GetMenu(self) -> Menu"""
11025 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
11027 def SetMenu(*args
, **kwargs
):
11028 """SetMenu(self, Menu menu)"""
11029 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
11031 def SetId(*args
, **kwargs
):
11032 """SetId(self, int id)"""
11033 return _core_
.MenuItem_SetId(*args
, **kwargs
)
11035 def GetId(*args
, **kwargs
):
11036 """GetId(self) -> int"""
11037 return _core_
.MenuItem_GetId(*args
, **kwargs
)
11039 def IsSeparator(*args
, **kwargs
):
11040 """IsSeparator(self) -> bool"""
11041 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
11043 def SetText(*args
, **kwargs
):
11044 """SetText(self, String str)"""
11045 return _core_
.MenuItem_SetText(*args
, **kwargs
)
11047 def GetLabel(*args
, **kwargs
):
11048 """GetLabel(self) -> String"""
11049 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
11051 def GetText(*args
, **kwargs
):
11052 """GetText(self) -> String"""
11053 return _core_
.MenuItem_GetText(*args
, **kwargs
)
11055 def GetLabelFromText(*args
, **kwargs
):
11056 """GetLabelFromText(String text) -> String"""
11057 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11059 GetLabelFromText
= staticmethod(GetLabelFromText
)
11060 def GetKind(*args
, **kwargs
):
11061 """GetKind(self) -> int"""
11062 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
11064 def SetKind(*args
, **kwargs
):
11065 """SetKind(self, int kind)"""
11066 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
11068 def SetCheckable(*args
, **kwargs
):
11069 """SetCheckable(self, bool checkable)"""
11070 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
11072 def IsCheckable(*args
, **kwargs
):
11073 """IsCheckable(self) -> bool"""
11074 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
11076 def IsSubMenu(*args
, **kwargs
):
11077 """IsSubMenu(self) -> bool"""
11078 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
11080 def SetSubMenu(*args
, **kwargs
):
11081 """SetSubMenu(self, Menu menu)"""
11082 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
11084 def GetSubMenu(*args
, **kwargs
):
11085 """GetSubMenu(self) -> Menu"""
11086 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
11088 def Enable(*args
, **kwargs
):
11089 """Enable(self, bool enable=True)"""
11090 return _core_
.MenuItem_Enable(*args
, **kwargs
)
11092 def IsEnabled(*args
, **kwargs
):
11093 """IsEnabled(self) -> bool"""
11094 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
11096 def Check(*args
, **kwargs
):
11097 """Check(self, bool check=True)"""
11098 return _core_
.MenuItem_Check(*args
, **kwargs
)
11100 def IsChecked(*args
, **kwargs
):
11101 """IsChecked(self) -> bool"""
11102 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
11104 def Toggle(*args
, **kwargs
):
11106 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
11108 def SetHelp(*args
, **kwargs
):
11109 """SetHelp(self, String str)"""
11110 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
11112 def GetHelp(*args
, **kwargs
):
11113 """GetHelp(self) -> String"""
11114 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
11116 def GetAccel(*args
, **kwargs
):
11117 """GetAccel(self) -> AcceleratorEntry"""
11118 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
11120 def SetAccel(*args
, **kwargs
):
11121 """SetAccel(self, AcceleratorEntry accel)"""
11122 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
11124 def SetBitmap(*args
, **kwargs
):
11125 """SetBitmap(self, Bitmap bitmap)"""
11126 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
11128 def GetBitmap(*args
, **kwargs
):
11129 """GetBitmap(self) -> Bitmap"""
11130 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
11132 def SetFont(*args
, **kwargs
):
11133 """SetFont(self, Font font)"""
11134 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
11136 def GetFont(*args
, **kwargs
):
11137 """GetFont(self) -> Font"""
11138 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
11140 def SetTextColour(*args
, **kwargs
):
11141 """SetTextColour(self, Colour colText)"""
11142 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
11144 def GetTextColour(*args
, **kwargs
):
11145 """GetTextColour(self) -> Colour"""
11146 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
11148 def SetBackgroundColour(*args
, **kwargs
):
11149 """SetBackgroundColour(self, Colour colBack)"""
11150 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
11152 def GetBackgroundColour(*args
, **kwargs
):
11153 """GetBackgroundColour(self) -> Colour"""
11154 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11156 def SetBitmaps(*args
, **kwargs
):
11157 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11158 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11160 def SetDisabledBitmap(*args
, **kwargs
):
11161 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11162 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11164 def GetDisabledBitmap(*args
, **kwargs
):
11165 """GetDisabledBitmap(self) -> Bitmap"""
11166 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11168 def SetMarginWidth(*args
, **kwargs
):
11169 """SetMarginWidth(self, int nWidth)"""
11170 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11172 def GetMarginWidth(*args
, **kwargs
):
11173 """GetMarginWidth(self) -> int"""
11174 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11176 def GetDefaultMarginWidth(*args
, **kwargs
):
11177 """GetDefaultMarginWidth() -> int"""
11178 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11180 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11181 def IsOwnerDrawn(*args
, **kwargs
):
11182 """IsOwnerDrawn(self) -> bool"""
11183 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11185 def SetOwnerDrawn(*args
, **kwargs
):
11186 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11187 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11189 def ResetOwnerDrawn(*args
, **kwargs
):
11190 """ResetOwnerDrawn(self)"""
11191 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11193 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
11194 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
11195 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
11196 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11197 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
11198 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
11199 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
11200 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
11201 Label
= property(GetLabel
,doc
="See `GetLabel`")
11202 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
11203 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
11204 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
11205 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
11206 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
11207 _core_
.MenuItem_swigregister(MenuItem
)
11209 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11210 """MenuItem_GetLabelFromText(String text) -> String"""
11211 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11213 def MenuItem_GetDefaultMarginWidth(*args
):
11214 """MenuItem_GetDefaultMarginWidth() -> int"""
11215 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
11217 #---------------------------------------------------------------------------
11219 class Control(Window
):
11221 This is the base class for a control or 'widget'.
11223 A control is generally a small window which processes user input
11224 and/or displays one or more item of data.
11226 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11227 __repr__
= _swig_repr
11228 def __init__(self
, *args
, **kwargs
):
11230 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11231 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11232 String name=ControlNameStr) -> Control
11234 Create a Control. Normally you should only call this from a subclass'
11235 __init__ as a plain old wx.Control is not very useful.
11237 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
11238 self
._setOORInfo
(self
)
11240 def Create(*args
, **kwargs
):
11242 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11243 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11244 String name=ControlNameStr) -> bool
11246 Do the 2nd phase and create the GUI control.
11248 return _core_
.Control_Create(*args
, **kwargs
)
11250 def GetAlignment(*args
, **kwargs
):
11252 GetAlignment(self) -> int
11254 Get the control alignment (left/right/centre, top/bottom/centre)
11256 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11258 def GetLabelText(*args
, **kwargs
):
11260 GetLabelText(self) -> String
11262 Get just the text of the label, without mnemonic characters ('&')
11264 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11266 def Command(*args
, **kwargs
):
11268 Command(self, CommandEvent event)
11270 Simulates the effect of the user issuing a command to the item.
11272 :see: `wx.CommandEvent`
11275 return _core_
.Control_Command(*args
, **kwargs
)
11277 def GetClassDefaultAttributes(*args
, **kwargs
):
11279 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11281 Get the default attributes for this class. This is useful if you want
11282 to use the same font or colour in your own control as in a standard
11283 control -- which is a much better idea than hard coding specific
11284 colours or fonts which might look completely out of place on the
11285 user's system, especially if it uses themes.
11287 The variant parameter is only relevant under Mac currently and is
11288 ignore under other platforms. Under Mac, it will change the size of
11289 the returned font. See `wx.Window.SetWindowVariant` for more about
11292 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11294 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11295 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11296 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11297 _core_
.Control_swigregister(Control
)
11298 ControlNameStr
= cvar
.ControlNameStr
11300 def PreControl(*args
, **kwargs
):
11302 PreControl() -> Control
11304 Precreate a Control control for 2-phase creation
11306 val
= _core_
.new_PreControl(*args
, **kwargs
)
11309 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11311 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11313 Get the default attributes for this class. This is useful if you want
11314 to use the same font or colour in your own control as in a standard
11315 control -- which is a much better idea than hard coding specific
11316 colours or fonts which might look completely out of place on the
11317 user's system, especially if it uses themes.
11319 The variant parameter is only relevant under Mac currently and is
11320 ignore under other platforms. Under Mac, it will change the size of
11321 the returned font. See `wx.Window.SetWindowVariant` for more about
11324 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11326 #---------------------------------------------------------------------------
11328 class ItemContainer(object):
11330 The wx.ItemContainer class defines an interface which is implemented
11331 by all controls which have string subitems, each of which may be
11332 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11333 as `wx.ComboBox` which implements an extended interface deriving from
11336 It defines the methods for accessing the control's items and although
11337 each of the derived classes implements them differently, they still
11338 all conform to the same interface.
11340 The items in a wx.ItemContainer have (non empty) string labels and,
11341 optionally, client data associated with them.
11344 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11345 def __init__(self
): raise AttributeError, "No constructor defined"
11346 __repr__
= _swig_repr
11347 def Append(*args
, **kwargs
):
11349 Append(self, String item, PyObject clientData=None) -> int
11351 Adds the item to the control, associating the given data with the item
11352 if not None. The return value is the index of the newly added item
11353 which may be different from the last one if the control is sorted (e.g.
11354 has wx.LB_SORT or wx.CB_SORT style).
11356 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11358 def AppendItems(*args
, **kwargs
):
11360 AppendItems(self, List strings)
11362 Apend several items at once to the control. Notice that calling this
11363 method may be much faster than appending the items one by one if you
11364 need to add a lot of items.
11366 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11368 def Insert(*args
, **kwargs
):
11370 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11372 Insert an item into the control before the item at the ``pos`` index,
11373 optionally associating some data object with the item.
11375 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11377 def Clear(*args
, **kwargs
):
11381 Removes all items from the control.
11383 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11385 def Delete(*args
, **kwargs
):
11387 Delete(self, unsigned int n)
11389 Deletes the item at the zero-based index 'n' from the control. Note
11390 that it is an error (signalled by a `wx.PyAssertionError` exception if
11391 enabled) to remove an item with the index negative or greater or equal
11392 than the number of items in the control.
11394 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11396 def GetClientData(*args
, **kwargs
):
11398 GetClientData(self, unsigned int n) -> PyObject
11400 Returns the client data associated with the given item, (if any.)
11402 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11404 def SetClientData(*args
, **kwargs
):
11406 SetClientData(self, unsigned int n, PyObject clientData)
11408 Associate the given client data with the item at position n.
11410 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11412 def GetCount(*args
, **kwargs
):
11414 GetCount(self) -> unsigned int
11416 Returns the number of items in the control.
11418 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11420 def IsEmpty(*args
, **kwargs
):
11422 IsEmpty(self) -> bool
11424 Returns True if the control is empty or False if it has some items.
11426 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11428 def GetString(*args
, **kwargs
):
11430 GetString(self, unsigned int n) -> String
11432 Returns the label of the item with the given index.
11434 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11436 def GetStrings(*args
, **kwargs
):
11437 """GetStrings(self) -> wxArrayString"""
11438 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11440 def SetString(*args
, **kwargs
):
11442 SetString(self, unsigned int n, String s)
11444 Sets the label for the given item.
11446 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11448 def FindString(*args
, **kwargs
):
11450 FindString(self, String s) -> int
11452 Finds an item whose label matches the given string. Returns the
11453 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11456 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11458 def SetSelection(*args
, **kwargs
):
11460 SetSelection(self, int n)
11462 Sets the item at index 'n' to be the selected item.
11464 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11466 def GetSelection(*args
, **kwargs
):
11468 GetSelection(self) -> int
11470 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11473 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11475 def SetStringSelection(*args
, **kwargs
):
11476 """SetStringSelection(self, String s) -> bool"""
11477 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11479 def GetStringSelection(*args
, **kwargs
):
11481 GetStringSelection(self) -> String
11483 Returns the label of the selected item or an empty string if no item
11486 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11488 def Select(*args
, **kwargs
):
11490 Select(self, int n)
11492 This is the same as `SetSelection` and exists only because it is
11493 slightly more natural for controls which support multiple selection.
11495 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11497 def GetItems(self
):
11498 """Return a list of the strings in the control"""
11499 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11501 def SetItems(self
, items
):
11502 """Clear and set the strings in the control from a list"""
11507 Count
= property(GetCount
,doc
="See `GetCount`")
11508 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11509 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11510 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11511 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11512 _core_
.ItemContainer_swigregister(ItemContainer
)
11514 #---------------------------------------------------------------------------
11516 class ControlWithItems(Control
,ItemContainer
):
11518 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11519 wx.Control class, and is used for the base class of various controls
11522 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11523 def __init__(self
): raise AttributeError, "No constructor defined"
11524 __repr__
= _swig_repr
11525 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11527 #---------------------------------------------------------------------------
11529 class SizerItem(Object
):
11531 The wx.SizerItem class is used to track the position, size and other
11532 attributes of each item managed by a `wx.Sizer`. It is not usually
11533 necessary to use this class because the sizer elements can also be
11534 identified by their positions or window or sizer references but
11535 sometimes it may be more convenient to use wx.SizerItem directly.
11536 Also, custom classes derived from `wx.PySizer` will probably need to
11537 use the collection of wx.SizerItems held by wx.Sizer when calculating
11540 :see: `wx.Sizer`, `wx.GBSizerItem`
11542 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11543 __repr__
= _swig_repr
11544 def __init__(self
, *args
, **kwargs
):
11546 __init__(self) -> SizerItem
11548 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11549 size will need to be set before this item can be used in a Sizer.
11551 You will probably never need to create a wx.SizerItem directly as they
11552 are created automatically when the sizer's Add, Insert or Prepend
11553 methods are called.
11555 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11557 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11558 __swig_destroy__
= _core_
.delete_SizerItem
11559 __del__
= lambda self
: None;
11560 def DeleteWindows(*args
, **kwargs
):
11562 DeleteWindows(self)
11564 Destroy the window or the windows in a subsizer, depending on the type
11567 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11569 def DetachSizer(*args
, **kwargs
):
11573 Enable deleting the SizerItem without destroying the contained sizer.
11575 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11577 def GetSize(*args
, **kwargs
):
11579 GetSize(self) -> Size
11581 Get the current size of the item, as set in the last Layout.
11583 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11585 def CalcMin(*args
, **kwargs
):
11587 CalcMin(self) -> Size
11589 Calculates the minimum desired size for the item, including any space
11592 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11594 def SetDimension(*args
, **kwargs
):
11596 SetDimension(self, Point pos, Size size)
11598 Set the position and size of the space allocated for this item by the
11599 sizer, and adjust the position and size of the item (window or
11600 subsizer) to be within that space taking alignment and borders into
11603 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11605 def GetMinSize(*args
, **kwargs
):
11607 GetMinSize(self) -> Size
11609 Get the minimum size needed for the item.
11611 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11613 def GetMinSizeWithBorder(*args
, **kwargs
):
11615 GetMinSizeWithBorder(self) -> Size
11617 Get the minimum size needed for the item with space for the borders
11620 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11622 def SetInitSize(*args
, **kwargs
):
11623 """SetInitSize(self, int x, int y)"""
11624 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11626 def SetRatioWH(*args
, **kwargs
):
11628 SetRatioWH(self, int width, int height)
11630 Set the ratio item attribute.
11632 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11634 def SetRatioSize(*args
, **kwargs
):
11636 SetRatioSize(self, Size size)
11638 Set the ratio item attribute.
11640 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11642 def SetRatio(*args
, **kwargs
):
11644 SetRatio(self, float ratio)
11646 Set the ratio item attribute.
11648 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11650 def GetRatio(*args
, **kwargs
):
11652 GetRatio(self) -> float
11654 Set the ratio item attribute.
11656 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11658 def GetRect(*args
, **kwargs
):
11660 GetRect(self) -> Rect
11662 Returns the rectangle that the sizer item should occupy
11664 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11666 def IsWindow(*args
, **kwargs
):
11668 IsWindow(self) -> bool
11670 Is this sizer item a window?
11672 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11674 def IsSizer(*args
, **kwargs
):
11676 IsSizer(self) -> bool
11678 Is this sizer item a subsizer?
11680 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11682 def IsSpacer(*args
, **kwargs
):
11684 IsSpacer(self) -> bool
11686 Is this sizer item a spacer?
11688 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11690 def SetProportion(*args
, **kwargs
):
11692 SetProportion(self, int proportion)
11694 Set the proportion value for this item.
11696 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11698 def GetProportion(*args
, **kwargs
):
11700 GetProportion(self) -> int
11702 Get the proportion value for this item.
11704 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11706 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11707 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11708 def SetFlag(*args
, **kwargs
):
11710 SetFlag(self, int flag)
11712 Set the flag value for this item.
11714 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11716 def GetFlag(*args
, **kwargs
):
11718 GetFlag(self) -> int
11720 Get the flag value for this item.
11722 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11724 def SetBorder(*args
, **kwargs
):
11726 SetBorder(self, int border)
11728 Set the border value for this item.
11730 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11732 def GetBorder(*args
, **kwargs
):
11734 GetBorder(self) -> int
11736 Get the border value for this item.
11738 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11740 def GetWindow(*args
, **kwargs
):
11742 GetWindow(self) -> Window
11744 Get the window (if any) that is managed by this sizer item.
11746 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11748 def SetWindow(*args
, **kwargs
):
11750 SetWindow(self, Window window)
11752 Set the window to be managed by this sizer item.
11754 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11756 def GetSizer(*args
, **kwargs
):
11758 GetSizer(self) -> Sizer
11760 Get the subsizer (if any) that is managed by this sizer item.
11762 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11764 def SetSizer(*args
, **kwargs
):
11766 SetSizer(self, Sizer sizer)
11768 Set the subsizer to be managed by this sizer item.
11770 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11772 def GetSpacer(*args
, **kwargs
):
11774 GetSpacer(self) -> Size
11776 Get the size of the spacer managed by this sizer item.
11778 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11780 def SetSpacer(*args
, **kwargs
):
11782 SetSpacer(self, Size size)
11784 Set the size of the spacer to be managed by this sizer item.
11786 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11788 def Show(*args
, **kwargs
):
11790 Show(self, bool show)
11792 Set the show item attribute, which sizers use to determine if the item
11793 is to be made part of the layout or not. If the item is tracking a
11794 window then it is shown or hidden as needed.
11796 return _core_
.SizerItem_Show(*args
, **kwargs
)
11798 def IsShown(*args
, **kwargs
):
11800 IsShown(self) -> bool
11802 Is the item to be shown in the layout?
11804 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11806 def GetPosition(*args
, **kwargs
):
11808 GetPosition(self) -> Point
11810 Returns the current position of the item, as set in the last Layout.
11812 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11814 def GetUserData(*args
, **kwargs
):
11816 GetUserData(self) -> PyObject
11818 Returns the userData associated with this sizer item, or None if there
11821 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11823 def SetUserData(*args
, **kwargs
):
11825 SetUserData(self, PyObject userData)
11827 Associate a Python object with this sizer item.
11829 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11831 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11832 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11833 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11834 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11835 Position
= property(GetPosition
,doc
="See `GetPosition`")
11836 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11837 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11838 Rect
= property(GetRect
,doc
="See `GetRect`")
11839 Size
= property(GetSize
,doc
="See `GetSize`")
11840 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11841 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11842 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11843 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11844 _core_
.SizerItem_swigregister(SizerItem
)
11846 def SizerItemWindow(*args
, **kwargs
):
11848 SizerItemWindow(Window window, int proportion, int flag, int border,
11849 PyObject userData=None) -> SizerItem
11851 Constructs a `wx.SizerItem` for tracking a window.
11853 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11856 def SizerItemSpacer(*args
, **kwargs
):
11858 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11859 PyObject userData=None) -> SizerItem
11861 Constructs a `wx.SizerItem` for tracking a spacer.
11863 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11866 def SizerItemSizer(*args
, **kwargs
):
11868 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11869 PyObject userData=None) -> SizerItem
11871 Constructs a `wx.SizerItem` for tracking a subsizer
11873 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11876 class Sizer(Object
):
11878 wx.Sizer is the abstract base class used for laying out subwindows in
11879 a window. You cannot use wx.Sizer directly; instead, you will have to
11880 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11881 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11884 The concept implemented by sizers in wxWidgets is closely related to
11885 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11886 toolkit or the Qt toolkit. It is based upon the idea of the individual
11887 subwindows reporting their minimal required size and their ability to
11888 get stretched if the size of the parent window has changed. This will
11889 most often mean that the programmer does not set the original size of
11890 a dialog in the beginning, rather the dialog will assigned a sizer and
11891 this sizer will be queried about the recommended size. The sizer in
11892 turn will query its children, which can be normal windows or contorls,
11893 empty space or other sizers, so that a hierarchy of sizers can be
11894 constructed. Note that wxSizer does not derive from wxWindow and thus
11895 do not interfere with tab ordering and requires very little resources
11896 compared to a real window on screen.
11898 What makes sizers so well fitted for use in wxWidgets is the fact that
11899 every control reports its own minimal size and the algorithm can
11900 handle differences in font sizes or different window (dialog item)
11901 sizes on different platforms without problems. If for example the
11902 standard font as well as the overall design of Mac widgets requires
11903 more space than on Windows, then the initial size of a dialog using a
11904 sizer will automatically be bigger on Mac than on Windows.
11906 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11907 def __init__(self
): raise AttributeError, "No constructor defined"
11908 __repr__
= _swig_repr
11909 __swig_destroy__
= _core_
.delete_Sizer
11910 __del__
= lambda self
: None;
11911 def _setOORInfo(*args
, **kwargs
):
11912 """_setOORInfo(self, PyObject _self)"""
11913 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11915 def Add(*args
, **kwargs
):
11917 Add(self, item, int proportion=0, int flag=0, int border=0,
11918 PyObject userData=None) -> wx.SizerItem
11920 Appends a child item to the sizer.
11922 return _core_
.Sizer_Add(*args
, **kwargs
)
11924 def Insert(*args
, **kwargs
):
11926 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11927 PyObject userData=None) -> wx.SizerItem
11929 Inserts a new item into the list of items managed by this sizer before
11930 the item at index *before*. See `Add` for a description of the parameters.
11932 return _core_
.Sizer_Insert(*args
, **kwargs
)
11934 def Prepend(*args
, **kwargs
):
11936 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11937 PyObject userData=None) -> wx.SizerItem
11939 Adds a new item to the begining of the list of sizer items managed by
11940 this sizer. See `Add` for a description of the parameters.
11942 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11944 def Remove(*args
, **kwargs
):
11946 Remove(self, item) -> bool
11948 Removes an item from the sizer and destroys it. This method does not
11949 cause any layout or resizing to take place, call `Layout` to update
11950 the layout on screen after removing a child from the sizer. The
11951 *item* parameter can be either a window, a sizer, or the zero-based
11952 index of an item to remove. Returns True if the child item was found
11955 return _core_
.Sizer_Remove(*args
, **kwargs
)
11957 def Detach(*args
, **kwargs
):
11959 Detach(self, item) -> bool
11961 Detaches an item from the sizer without destroying it. This method
11962 does not cause any layout or resizing to take place, call `Layout` to
11963 do so. The *item* parameter can be either a window, a sizer, or the
11964 zero-based index of the item to be detached. Returns True if the child item
11965 was found and detached.
11967 return _core_
.Sizer_Detach(*args
, **kwargs
)
11969 def GetItem(*args
, **kwargs
):
11971 GetItem(self, item) -> wx.SizerItem
11973 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11974 parameter can be either a window, a sizer, or the zero-based index of
11975 the item to be found.
11977 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11979 def _SetItemMinSize(*args
, **kwargs
):
11980 """_SetItemMinSize(self, PyObject item, Size size)"""
11981 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11983 def _ReplaceWin(*args
, **kwargs
):
11984 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11985 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
11987 def _ReplaceSizer(*args
, **kwargs
):
11988 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11989 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
11991 def _ReplaceItem(*args
, **kwargs
):
11992 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11993 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
11995 def Replace(self
, olditem
, item
, recursive
=False):
11997 Detaches the given ``olditem`` from the sizer and replaces it with
11998 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11999 detached child is destroyed only if it is not a window, (because
12000 windows are owned by their parent, not the sizer.) The
12001 ``recursive`` parameter can be used to search for the given
12002 element recursivly in subsizers.
12004 This method does not cause any layout or resizing to take place,
12005 call `Layout` to do so.
12007 Returns ``True`` if the child item was found and removed.
12009 if isinstance(olditem
, wx
.Window
):
12010 return self
._ReplaceWin
(olditem
, item
, recursive
)
12011 elif isinstnace(olditem
, wx
.Sizer
):
12012 return self
._ReplaceSizer
(olditem
, item
, recursive
)
12013 elif isinstnace(olditem
, int):
12014 return self
._ReplaceItem
(olditem
, item
)
12016 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12018 def SetContainingWindow(*args
, **kwargs
):
12020 SetContainingWindow(self, Window window)
12022 Set (or unset) the window this sizer is used in.
12024 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
12026 def GetContainingWindow(*args
, **kwargs
):
12028 GetContainingWindow(self) -> Window
12030 Get the window this sizer is used in.
12032 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
12034 def SetItemMinSize(self
, item
, *args
):
12036 SetItemMinSize(self, item, Size size)
12038 Sets the minimum size that will be allocated for an item in the sizer.
12039 The *item* parameter can be either a window, a sizer, or the
12040 zero-based index of the item. If a window or sizer is given then it
12041 will be searched for recursivly in subsizers if neccessary.
12044 # for backward compatibility accept separate width,height args too
12045 return self
._SetItemMinSize
(item
, args
)
12047 return self
._SetItemMinSize
(item
, args
[0])
12049 def AddItem(*args
, **kwargs
):
12051 AddItem(self, SizerItem item)
12053 Adds a `wx.SizerItem` to the sizer.
12055 return _core_
.Sizer_AddItem(*args
, **kwargs
)
12057 def InsertItem(*args
, **kwargs
):
12059 InsertItem(self, int index, SizerItem item)
12061 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12063 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
12065 def PrependItem(*args
, **kwargs
):
12067 PrependItem(self, SizerItem item)
12069 Prepends a `wx.SizerItem` to the sizer.
12071 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
12073 def AddMany(self
, items
):
12075 AddMany is a convenience method for adding several items
12076 to a sizer at one time. Simply pass it a list of tuples,
12077 where each tuple consists of the parameters that you
12078 would normally pass to the `Add` method.
12081 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
12085 def AddSpacer(self
, *args
, **kw
):
12086 """AddSpacer(int size) --> SizerItem
12088 Add a spacer that is (size,size) pixels.
12090 if args
and type(args
[0]) == int:
12091 return self
.Add( (args
[0],args
[0] ), 0)
12092 else: # otherwise stay compatible with old AddSpacer
12093 return self
.Add(*args
, **kw
)
12094 def PrependSpacer(self
, *args
, **kw
):
12095 """PrependSpacer(int size) --> SizerItem
12097 Prepend a spacer that is (size, size) pixels."""
12098 if args
and type(args
[0]) == int:
12099 return self
.Prepend( (args
[0],args
[0] ), 0)
12100 else: # otherwise stay compatible with old PrependSpacer
12101 return self
.Prepend(*args
, **kw
)
12102 def InsertSpacer(self
, index
, *args
, **kw
):
12103 """InsertSpacer(int index, int size) --> SizerItem
12105 Insert a spacer at position index that is (size, size) pixels."""
12106 if args
and type(args
[0]) == int:
12107 return self
.Insert( index
, (args
[0],args
[0] ), 0)
12108 else: # otherwise stay compatible with old InsertSpacer
12109 return self
.Insert(index
, *args
, **kw
)
12112 def AddStretchSpacer(self
, prop
=1):
12113 """AddStretchSpacer(int prop=1) --> SizerItem
12115 Add a stretchable spacer."""
12116 return self
.Add((0,0), prop
)
12117 def PrependStretchSpacer(self
, prop
=1):
12118 """PrependStretchSpacer(int prop=1) --> SizerItem
12120 Prepend a stretchable spacer."""
12121 return self
.Prepend((0,0), prop
)
12122 def InsertStretchSpacer(self
, index
, prop
=1):
12123 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12125 Insert a stretchable spacer."""
12126 return self
.Insert(index
, (0,0), prop
)
12129 # for backwards compatibility only, please do not use in new code
12130 def AddWindow(self
, *args
, **kw
):
12131 """Compatibility alias for `Add`."""
12132 return self
.Add(*args
, **kw
)
12133 def AddSizer(self
, *args
, **kw
):
12134 """Compatibility alias for `Add`."""
12135 return self
.Add(*args
, **kw
)
12137 def PrependWindow(self
, *args
, **kw
):
12138 """Compatibility alias for `Prepend`."""
12139 return self
.Prepend(*args
, **kw
)
12140 def PrependSizer(self
, *args
, **kw
):
12141 """Compatibility alias for `Prepend`."""
12142 return self
.Prepend(*args
, **kw
)
12144 def InsertWindow(self
, *args
, **kw
):
12145 """Compatibility alias for `Insert`."""
12146 return self
.Insert(*args
, **kw
)
12147 def InsertSizer(self
, *args
, **kw
):
12148 """Compatibility alias for `Insert`."""
12149 return self
.Insert(*args
, **kw
)
12151 def RemoveWindow(self
, *args
, **kw
):
12152 """Compatibility alias for `Remove`."""
12153 return self
.Remove(*args
, **kw
)
12154 def RemoveSizer(self
, *args
, **kw
):
12155 """Compatibility alias for `Remove`."""
12156 return self
.Remove(*args
, **kw
)
12157 def RemovePos(self
, *args
, **kw
):
12158 """Compatibility alias for `Remove`."""
12159 return self
.Remove(*args
, **kw
)
12162 def SetDimension(*args
, **kwargs
):
12164 SetDimension(self, int x, int y, int width, int height)
12166 Call this to force the sizer to take the given dimension and thus
12167 force the items owned by the sizer to resize themselves according to
12168 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12171 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
12173 def SetMinSize(*args
, **kwargs
):
12175 SetMinSize(self, Size size)
12177 Call this to give the sizer a minimal size. Normally, the sizer will
12178 calculate its minimal size based purely on how much space its children
12179 need. After calling this method `GetMinSize` will return either the
12180 minimal size as requested by its children or the minimal size set
12181 here, depending on which is bigger.
12183 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
12185 def GetSize(*args
, **kwargs
):
12187 GetSize(self) -> Size
12189 Returns the current size of the space managed by the sizer.
12191 return _core_
.Sizer_GetSize(*args
, **kwargs
)
12193 def GetPosition(*args
, **kwargs
):
12195 GetPosition(self) -> Point
12197 Returns the current position of the sizer's managed space.
12199 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
12201 def GetMinSize(*args
, **kwargs
):
12203 GetMinSize(self) -> Size
12205 Returns the minimal size of the sizer. This is either the combined
12206 minimal size of all the children and their borders or the minimal size
12207 set by SetMinSize, depending on which is bigger.
12209 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
12211 def GetSizeTuple(self
):
12212 return self
.GetSize().Get()
12213 def GetPositionTuple(self
):
12214 return self
.GetPosition().Get()
12215 def GetMinSizeTuple(self
):
12216 return self
.GetMinSize().Get()
12218 def RecalcSizes(*args
, **kwargs
):
12222 Using the sizes calculated by `CalcMin` reposition and resize all the
12223 items managed by this sizer. You should not need to call this directly as
12224 it is called by `Layout`.
12226 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
12228 def CalcMin(*args
, **kwargs
):
12230 CalcMin(self) -> Size
12232 This method is where the sizer will do the actual calculation of its
12233 children's minimal sizes. You should not need to call this directly as
12234 it is called by `Layout`.
12236 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
12238 def Layout(*args
, **kwargs
):
12242 This method will force the recalculation and layout of the items
12243 controlled by the sizer using the current space allocated to the
12244 sizer. Normally this is called automatically from the owning window's
12245 EVT_SIZE handler, but it is also useful to call it from user code when
12246 one of the items in a sizer change size, or items are added or
12249 return _core_
.Sizer_Layout(*args
, **kwargs
)
12251 def Fit(*args
, **kwargs
):
12253 Fit(self, Window window) -> Size
12255 Tell the sizer to resize the *window* to match the sizer's minimal
12256 size. This is commonly done in the constructor of the window itself in
12257 order to set its initial size to match the needs of the children as
12258 determined by the sizer. Returns the new size.
12260 For a top level window this is the total window size, not the client size.
12262 return _core_
.Sizer_Fit(*args
, **kwargs
)
12264 def FitInside(*args
, **kwargs
):
12266 FitInside(self, Window window)
12268 Tell the sizer to resize the *virtual size* of the *window* to match the
12269 sizer's minimal size. This will not alter the on screen size of the
12270 window, but may cause the addition/removal/alteration of scrollbars
12271 required to view the virtual area in windows which manage it.
12273 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12276 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12278 def SetSizeHints(*args
, **kwargs
):
12280 SetSizeHints(self, Window window)
12282 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12283 match the sizer's minimal size. This is commonly done in the
12284 constructor of the window itself if the window is resizable (as are
12285 many dialogs under Unix and frames on probably all platforms) in order
12286 to prevent the window from being sized smaller than the minimal size
12287 required by the sizer.
12289 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12291 def SetVirtualSizeHints(*args
, **kwargs
):
12293 SetVirtualSizeHints(self, Window window)
12295 Tell the sizer to set the minimal size of the window virtual area to
12296 match the sizer's minimal size. For windows with managed scrollbars
12297 this will set them appropriately.
12299 :see: `wx.ScrolledWindow.SetScrollbars`
12302 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12304 def Clear(*args
, **kwargs
):
12306 Clear(self, bool deleteWindows=False)
12308 Clear all items from the sizer, optionally destroying the window items
12311 return _core_
.Sizer_Clear(*args
, **kwargs
)
12313 def DeleteWindows(*args
, **kwargs
):
12315 DeleteWindows(self)
12317 Destroy all windows managed by the sizer.
12319 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12321 def GetChildren(*args
, **kwargs
):
12323 GetChildren(self) -> list
12325 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12327 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12329 def Show(*args
, **kwargs
):
12331 Show(self, item, bool show=True, bool recursive=false) -> bool
12333 Shows or hides an item managed by the sizer. To make a sizer item
12334 disappear or reappear, use Show followed by `Layout`. The *item*
12335 parameter can be either a window, a sizer, or the zero-based index of
12336 the item. Use the recursive parameter to show or hide an item in a
12337 subsizer. Returns True if the item was found.
12339 return _core_
.Sizer_Show(*args
, **kwargs
)
12341 def IsShown(*args
, **kwargs
):
12343 IsShown(self, item)
12345 Determines if the item is currently shown. To make a sizer
12346 item disappear or reappear, use Show followed by `Layout`. The *item*
12347 parameter can be either a window, a sizer, or the zero-based index of
12350 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12352 def Hide(self
, item
, recursive
=False):
12354 A convenience method for `Show` (item, False, recursive).
12356 return self
.Show(item
, False, recursive
)
12358 def ShowItems(*args
, **kwargs
):
12360 ShowItems(self, bool show)
12362 Recursively call `wx.SizerItem.Show` on all sizer items.
12364 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12366 Children
= property(GetChildren
,doc
="See `GetChildren`")
12367 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12368 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12369 Position
= property(GetPosition
,doc
="See `GetPosition`")
12370 Size
= property(GetSize
,doc
="See `GetSize`")
12371 _core_
.Sizer_swigregister(Sizer
)
12373 class PySizer(Sizer
):
12375 wx.PySizer is a special version of `wx.Sizer` that has been
12376 instrumented to allow the C++ virtual methods to be overloaded in
12377 Python derived classes. You would derive from this class if you are
12378 wanting to implement a custom sizer in Python code. Simply implement
12379 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12382 class MySizer(wx.PySizer):
12383 def __init__(self):
12384 wx.PySizer.__init__(self)
12387 for item in self.GetChildren():
12388 # calculate the total minimum width and height needed
12389 # by all items in the sizer according to this sizer's
12390 # layout algorithm.
12392 return wx.Size(width, height)
12394 def RecalcSizes(self):
12395 # find the space allotted to this sizer
12396 pos = self.GetPosition()
12397 size = self.GetSize()
12398 for item in self.GetChildren():
12399 # Recalculate (if necessary) the position and size of
12400 # each item and then call item.SetDimension to do the
12401 # actual positioning and sizing of the items within the
12402 # space alloted to this sizer.
12404 item.SetDimension(itemPos, itemSize)
12407 When `Layout` is called it first calls `CalcMin` followed by
12408 `RecalcSizes` so you can optimize a bit by saving the results of
12409 `CalcMin` and reusing them in `RecalcSizes`.
12411 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12415 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12416 __repr__
= _swig_repr
12417 def __init__(self
, *args
, **kwargs
):
12419 __init__(self) -> PySizer
12421 Creates a wx.PySizer. Must be called from the __init__ in the derived
12424 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12425 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12427 def _setCallbackInfo(*args
, **kwargs
):
12428 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12429 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12431 _core_
.PySizer_swigregister(PySizer
)
12433 #---------------------------------------------------------------------------
12435 class BoxSizer(Sizer
):
12437 The basic idea behind a box sizer is that windows will most often be
12438 laid out in rather simple basic geometry, typically in a row or a
12439 column or nested hierarchies of either. A wx.BoxSizer will lay out
12440 its items in a simple row or column, depending on the orientation
12441 parameter passed to the constructor.
12443 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12444 __repr__
= _swig_repr
12445 def __init__(self
, *args
, **kwargs
):
12447 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12449 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12450 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12453 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12454 self
._setOORInfo
(self
)
12456 def GetOrientation(*args
, **kwargs
):
12458 GetOrientation(self) -> int
12460 Returns the current orientation of the sizer.
12462 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12464 def SetOrientation(*args
, **kwargs
):
12466 SetOrientation(self, int orient)
12468 Resets the orientation of the sizer.
12470 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12472 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12473 _core_
.BoxSizer_swigregister(BoxSizer
)
12475 #---------------------------------------------------------------------------
12477 class StaticBoxSizer(BoxSizer
):
12479 wx.StaticBoxSizer derives from and functions identically to the
12480 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12481 manages. Note that this static box must be created separately and
12482 passed to the sizer constructor.
12484 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12485 __repr__
= _swig_repr
12486 def __init__(self
, *args
, **kwargs
):
12488 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12490 Constructor. It takes an associated static box and the orientation
12491 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12494 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12495 self
._setOORInfo
(self
)
12497 def GetStaticBox(*args
, **kwargs
):
12499 GetStaticBox(self) -> StaticBox
12501 Returns the static box associated with this sizer.
12503 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12505 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12506 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12508 #---------------------------------------------------------------------------
12510 class GridSizer(Sizer
):
12512 A grid sizer is a sizer which lays out its children in a
12513 two-dimensional table with all cells having the same size. In other
12514 words, the width of each cell within the grid is the width of the
12515 widest item added to the sizer and the height of each grid cell is the
12516 height of the tallest item. An optional vertical and/or horizontal
12517 gap between items can also be specified (in pixels.)
12519 Items are placed in the cells of the grid in the order they are added,
12520 in row-major order. In other words, the first row is filled first,
12521 then the second, and so on until all items have been added. (If
12522 neccessary, additional rows will be added as items are added.) If you
12523 need to have greater control over the cells that items are placed in
12524 then use the `wx.GridBagSizer`.
12527 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12528 __repr__
= _swig_repr
12529 def __init__(self
, *args
, **kwargs
):
12531 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12533 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12534 of columns and rows in the sizer - if either of the parameters is
12535 zero, it will be calculated to from the total number of children in
12536 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12537 define extra space between all children.
12539 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12540 self
._setOORInfo
(self
)
12542 def SetCols(*args
, **kwargs
):
12544 SetCols(self, int cols)
12546 Sets the number of columns in the sizer.
12548 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12550 def SetRows(*args
, **kwargs
):
12552 SetRows(self, int rows)
12554 Sets the number of rows in the sizer.
12556 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12558 def SetVGap(*args
, **kwargs
):
12560 SetVGap(self, int gap)
12562 Sets the vertical gap (in pixels) between the cells in the sizer.
12564 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12566 def SetHGap(*args
, **kwargs
):
12568 SetHGap(self, int gap)
12570 Sets the horizontal gap (in pixels) between cells in the sizer
12572 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12574 def GetCols(*args
, **kwargs
):
12576 GetCols(self) -> int
12578 Returns the number of columns in the sizer.
12580 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12582 def GetRows(*args
, **kwargs
):
12584 GetRows(self) -> int
12586 Returns the number of rows in the sizer.
12588 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12590 def GetVGap(*args
, **kwargs
):
12592 GetVGap(self) -> int
12594 Returns the vertical gap (in pixels) between the cells in the sizer.
12596 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12598 def GetHGap(*args
, **kwargs
):
12600 GetHGap(self) -> int
12602 Returns the horizontal gap (in pixels) between cells in the sizer.
12604 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12606 def CalcRowsCols(self
):
12608 CalcRowsCols() -> (rows, cols)
12610 Calculates how many rows and columns will be in the sizer based
12611 on the current number of items and also the rows, cols specified
12612 in the constructor.
12614 nitems
= len(self
.GetChildren())
12615 rows
= self
.GetRows()
12616 cols
= self
.GetCols()
12617 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12619 rows
= (nitems
+ cols
- 1) / cols
12621 cols
= (nitems
+ rows
- 1) / rows
12622 return (rows
, cols
)
12624 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12625 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12626 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12627 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12628 _core_
.GridSizer_swigregister(GridSizer
)
12630 #---------------------------------------------------------------------------
12632 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12633 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12634 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12635 class FlexGridSizer(GridSizer
):
12637 A flex grid sizer is a sizer which lays out its children in a
12638 two-dimensional table with all table cells in one row having the same
12639 height and all cells in one column having the same width, but all
12640 rows or all columns are not necessarily the same height or width as in
12641 the `wx.GridSizer`.
12643 wx.FlexGridSizer can also size items equally in one direction but
12644 unequally ("flexibly") in the other. If the sizer is only flexible
12645 in one direction (this can be changed using `SetFlexibleDirection`), it
12646 needs to be decided how the sizer should grow in the other ("non
12647 flexible") direction in order to fill the available space. The
12648 `SetNonFlexibleGrowMode` method serves this purpose.
12652 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12653 __repr__
= _swig_repr
12654 def __init__(self
, *args
, **kwargs
):
12656 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12658 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12659 number of columns and rows in the sizer - if either of the parameters
12660 is zero, it will be calculated to from the total number of children in
12661 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12662 define extra space between all children.
12664 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12665 self
._setOORInfo
(self
)
12667 def AddGrowableRow(*args
, **kwargs
):
12669 AddGrowableRow(self, size_t idx, int proportion=0)
12671 Specifies that row *idx* (starting from zero) should be grown if there
12672 is extra space available to the sizer.
12674 The *proportion* parameter has the same meaning as the stretch factor
12675 for the box sizers except that if all proportions are 0, then all
12676 columns are resized equally (instead of not being resized at all).
12678 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12680 def RemoveGrowableRow(*args
, **kwargs
):
12682 RemoveGrowableRow(self, size_t idx)
12684 Specifies that row *idx* is no longer growable.
12686 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12688 def AddGrowableCol(*args
, **kwargs
):
12690 AddGrowableCol(self, size_t idx, int proportion=0)
12692 Specifies that column *idx* (starting from zero) should be grown if
12693 there is extra space available to the sizer.
12695 The *proportion* parameter has the same meaning as the stretch factor
12696 for the box sizers except that if all proportions are 0, then all
12697 columns are resized equally (instead of not being resized at all).
12699 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12701 def RemoveGrowableCol(*args
, **kwargs
):
12703 RemoveGrowableCol(self, size_t idx)
12705 Specifies that column *idx* is no longer growable.
12707 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12709 def SetFlexibleDirection(*args
, **kwargs
):
12711 SetFlexibleDirection(self, int direction)
12713 Specifies whether the sizer should flexibly resize its columns, rows,
12714 or both. Argument *direction* can be one of the following values. Any
12715 other value is ignored.
12717 ============== =======================================
12718 wx.VERTICAL Rows are flexibly sized.
12719 wx.HORIZONTAL Columns are flexibly sized.
12720 wx.BOTH Both rows and columns are flexibly sized
12721 (this is the default value).
12722 ============== =======================================
12724 Note that this method does not trigger relayout.
12727 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12729 def GetFlexibleDirection(*args
, **kwargs
):
12731 GetFlexibleDirection(self) -> int
12733 Returns a value that specifies whether the sizer
12734 flexibly resizes its columns, rows, or both (default).
12736 :see: `SetFlexibleDirection`
12738 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12740 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12742 SetNonFlexibleGrowMode(self, int mode)
12744 Specifies how the sizer should grow in the non-flexible direction if
12745 there is one (so `SetFlexibleDirection` must have been called
12746 previously). Argument *mode* can be one of the following values:
12748 ========================== =================================================
12749 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12750 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12751 `AddGrowableCol` and `AddGrowableRow`. In this
12752 case equal sizing applies to minimum sizes of
12753 columns or rows (this is the default value).
12754 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12755 the non flexible direction, whether they are
12756 growable or not in the flexbile direction.
12757 ========================== =================================================
12759 Note that this method does not trigger relayout.
12761 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12763 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12765 GetNonFlexibleGrowMode(self) -> int
12767 Returns the value that specifies how the sizer grows in the
12768 non-flexible direction if there is one.
12770 :see: `SetNonFlexibleGrowMode`
12772 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12774 def GetRowHeights(*args
, **kwargs
):
12776 GetRowHeights(self) -> list
12778 Returns a list of integers representing the heights of each of the
12781 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12783 def GetColWidths(*args
, **kwargs
):
12785 GetColWidths(self) -> list
12787 Returns a list of integers representing the widths of each of the
12788 columns in the sizer.
12790 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12792 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12793 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12794 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12795 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12796 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12798 class StdDialogButtonSizer(BoxSizer
):
12800 A special sizer that knows how to order and position standard buttons
12801 in order to conform to the current platform's standards. You simply
12802 need to add each `wx.Button` to the sizer, and be sure to create the
12803 buttons using the standard ID's. Then call `Realize` and the sizer
12804 will take care of the rest.
12807 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12808 __repr__
= _swig_repr
12809 def __init__(self
, *args
, **kwargs
):
12810 """__init__(self) -> StdDialogButtonSizer"""
12811 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12812 def AddButton(*args
, **kwargs
):
12814 AddButton(self, wxButton button)
12816 Use this to add the buttons to this sizer. Do not use the `Add`
12817 method in the base class.
12819 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12821 def Realize(*args
, **kwargs
):
12825 This funciton needs to be called after all the buttons have been added
12826 to the sizer. It will reorder them and position them in a platform
12829 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12831 def SetAffirmativeButton(*args
, **kwargs
):
12832 """SetAffirmativeButton(self, wxButton button)"""
12833 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12835 def SetNegativeButton(*args
, **kwargs
):
12836 """SetNegativeButton(self, wxButton button)"""
12837 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12839 def SetCancelButton(*args
, **kwargs
):
12840 """SetCancelButton(self, wxButton button)"""
12841 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12843 def GetAffirmativeButton(*args
, **kwargs
):
12844 """GetAffirmativeButton(self) -> wxButton"""
12845 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12847 def GetApplyButton(*args
, **kwargs
):
12848 """GetApplyButton(self) -> wxButton"""
12849 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12851 def GetNegativeButton(*args
, **kwargs
):
12852 """GetNegativeButton(self) -> wxButton"""
12853 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12855 def GetCancelButton(*args
, **kwargs
):
12856 """GetCancelButton(self) -> wxButton"""
12857 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12859 def GetHelpButton(*args
, **kwargs
):
12860 """GetHelpButton(self) -> wxButton"""
12861 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12863 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12864 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12865 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12866 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12867 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12868 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12870 #---------------------------------------------------------------------------
12872 class GBPosition(object):
12874 This class represents the position of an item in a virtual grid of
12875 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12876 typemaps that will automatically convert from a 2-element sequence of
12877 integers to a wx.GBPosition, so you can use the more pythonic
12878 representation of the position nearly transparently in Python code.
12880 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12881 __repr__
= _swig_repr
12882 def __init__(self
, *args
, **kwargs
):
12884 __init__(self, int row=0, int col=0) -> GBPosition
12886 This class represents the position of an item in a virtual grid of
12887 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12888 typemaps that will automatically convert from a 2-element sequence of
12889 integers to a wx.GBPosition, so you can use the more pythonic
12890 representation of the position nearly transparently in Python code.
12892 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12893 __swig_destroy__
= _core_
.delete_GBPosition
12894 __del__
= lambda self
: None;
12895 def GetRow(*args
, **kwargs
):
12896 """GetRow(self) -> int"""
12897 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12899 def GetCol(*args
, **kwargs
):
12900 """GetCol(self) -> int"""
12901 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12903 def SetRow(*args
, **kwargs
):
12904 """SetRow(self, int row)"""
12905 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12907 def SetCol(*args
, **kwargs
):
12908 """SetCol(self, int col)"""
12909 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12911 def __eq__(*args
, **kwargs
):
12913 __eq__(self, PyObject other) -> bool
12915 Compare GBPosition for equality.
12917 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12919 def __ne__(*args
, **kwargs
):
12921 __ne__(self, PyObject other) -> bool
12923 Compare GBPosition for inequality.
12925 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12927 def Set(*args
, **kwargs
):
12928 """Set(self, int row=0, int col=0)"""
12929 return _core_
.GBPosition_Set(*args
, **kwargs
)
12931 def Get(*args
, **kwargs
):
12932 """Get(self) -> PyObject"""
12933 return _core_
.GBPosition_Get(*args
, **kwargs
)
12935 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12936 def __str__(self
): return str(self
.Get())
12937 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12938 def __len__(self
): return len(self
.Get())
12939 def __getitem__(self
, index
): return self
.Get()[index
]
12940 def __setitem__(self
, index
, val
):
12941 if index
== 0: self
.SetRow(val
)
12942 elif index
== 1: self
.SetCol(val
)
12943 else: raise IndexError
12944 def __nonzero__(self
): return self
.Get() != (0,0)
12945 __safe_for_unpickling__
= True
12946 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12948 row
= property(GetRow
, SetRow
)
12949 col
= property(GetCol
, SetCol
)
12951 _core_
.GBPosition_swigregister(GBPosition
)
12953 class GBSpan(object):
12955 This class is used to hold the row and column spanning attributes of
12956 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12957 automatically convert from a 2-element sequence of integers to a
12958 wx.GBSpan, so you can use the more pythonic representation of the span
12959 nearly transparently in Python code.
12962 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12963 __repr__
= _swig_repr
12964 def __init__(self
, *args
, **kwargs
):
12966 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12968 Construct a new wxGBSpan, optionally setting the rowspan and
12969 colspan. The default is (1,1). (Meaning that the item occupies one
12970 cell in each direction.
12972 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12973 __swig_destroy__
= _core_
.delete_GBSpan
12974 __del__
= lambda self
: None;
12975 def GetRowspan(*args
, **kwargs
):
12976 """GetRowspan(self) -> int"""
12977 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12979 def GetColspan(*args
, **kwargs
):
12980 """GetColspan(self) -> int"""
12981 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12983 def SetRowspan(*args
, **kwargs
):
12984 """SetRowspan(self, int rowspan)"""
12985 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12987 def SetColspan(*args
, **kwargs
):
12988 """SetColspan(self, int colspan)"""
12989 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12991 def __eq__(*args
, **kwargs
):
12993 __eq__(self, PyObject other) -> bool
12995 Compare wxGBSpan for equality.
12997 return _core_
.GBSpan___eq__(*args
, **kwargs
)
12999 def __ne__(*args
, **kwargs
):
13001 __ne__(self, PyObject other) -> bool
13003 Compare GBSpan for inequality.
13005 return _core_
.GBSpan___ne__(*args
, **kwargs
)
13007 def Set(*args
, **kwargs
):
13008 """Set(self, int rowspan=1, int colspan=1)"""
13009 return _core_
.GBSpan_Set(*args
, **kwargs
)
13011 def Get(*args
, **kwargs
):
13012 """Get(self) -> PyObject"""
13013 return _core_
.GBSpan_Get(*args
, **kwargs
)
13015 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13016 def __str__(self
): return str(self
.Get())
13017 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
13018 def __len__(self
): return len(self
.Get())
13019 def __getitem__(self
, index
): return self
.Get()[index
]
13020 def __setitem__(self
, index
, val
):
13021 if index
== 0: self
.SetRowspan(val
)
13022 elif index
== 1: self
.SetColspan(val
)
13023 else: raise IndexError
13024 def __nonzero__(self
): return self
.Get() != (0,0)
13025 __safe_for_unpickling__
= True
13026 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
13028 rowspan
= property(GetRowspan
, SetRowspan
)
13029 colspan
= property(GetColspan
, SetColspan
)
13031 _core_
.GBSpan_swigregister(GBSpan
)
13033 class GBSizerItem(SizerItem
):
13035 The wx.GBSizerItem class is used to track the additional data about
13036 items in a `wx.GridBagSizer` such as the item's position in the grid
13037 and how many rows or columns it spans.
13040 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13041 __repr__
= _swig_repr
13042 def __init__(self
, *args
, **kwargs
):
13044 __init__(self) -> GBSizerItem
13046 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13047 size will need to be set, as well as a position and span before this
13048 item can be used in a Sizer.
13050 You will probably never need to create a wx.GBSizerItem directly as they
13051 are created automatically when the sizer's Add method is called.
13053 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
13054 __swig_destroy__
= _core_
.delete_GBSizerItem
13055 __del__
= lambda self
: None;
13056 def GetPos(*args
, **kwargs
):
13058 GetPos(self) -> GBPosition
13060 Get the grid position of the item
13062 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
13064 def GetPosTuple(self
): return self
.GetPos().Get()
13065 def GetSpan(*args
, **kwargs
):
13067 GetSpan(self) -> GBSpan
13069 Get the row and column spanning of the item
13071 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
13073 def GetSpanTuple(self
): return self
.GetSpan().Get()
13074 def SetPos(*args
, **kwargs
):
13076 SetPos(self, GBPosition pos) -> bool
13078 If the item is already a member of a sizer then first ensure that
13079 there is no other item that would intersect with this one at the new
13080 position, then set the new position. Returns True if the change is
13081 successful and after the next Layout() the item will be moved.
13083 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
13085 def SetSpan(*args
, **kwargs
):
13087 SetSpan(self, GBSpan span) -> bool
13089 If the item is already a member of a sizer then first ensure that
13090 there is no other item that would intersect with this one with its new
13091 spanning size, then set the new spanning. Returns True if the change
13092 is successful and after the next Layout() the item will be resized.
13095 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
13097 def Intersects(*args
, **kwargs
):
13099 Intersects(self, GBSizerItem other) -> bool
13101 Returns True if this item and the other item instersect.
13103 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
13105 def IntersectsPos(*args
, **kwargs
):
13107 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13109 Returns True if the given pos/span would intersect with this item.
13111 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
13113 def GetEndPos(*args
, **kwargs
):
13115 GetEndPos(self) -> GBPosition
13117 Get the row and column of the endpoint of this item.
13119 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
13121 def GetGBSizer(*args
, **kwargs
):
13123 GetGBSizer(self) -> GridBagSizer
13125 Get the sizer this item is a member of.
13127 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
13129 def SetGBSizer(*args
, **kwargs
):
13131 SetGBSizer(self, GridBagSizer sizer)
13133 Set the sizer this item is a member of.
13135 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
13137 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
13138 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
13139 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
13140 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
13141 _core_
.GBSizerItem_swigregister(GBSizerItem
)
13142 DefaultSpan
= cvar
.DefaultSpan
13144 def GBSizerItemWindow(*args
, **kwargs
):
13146 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13147 int border, PyObject userData=None) -> GBSizerItem
13149 Construct a `wx.GBSizerItem` for a window.
13151 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
13154 def GBSizerItemSizer(*args
, **kwargs
):
13156 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13157 int border, PyObject userData=None) -> GBSizerItem
13159 Construct a `wx.GBSizerItem` for a sizer
13161 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
13164 def GBSizerItemSpacer(*args
, **kwargs
):
13166 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13167 int flag, int border, PyObject userData=None) -> GBSizerItem
13169 Construct a `wx.GBSizerItem` for a spacer.
13171 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
13174 class GridBagSizer(FlexGridSizer
):
13176 A `wx.Sizer` that can lay out items in a virtual grid like a
13177 `wx.FlexGridSizer` but in this case explicit positioning of the items
13178 is allowed using `wx.GBPosition`, and items can optionally span more
13179 than one row and/or column using `wx.GBSpan`. The total size of the
13180 virtual grid is determined by the largest row and column that items are
13181 positioned at, adjusted for spanning.
13184 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13185 __repr__
= _swig_repr
13186 def __init__(self
, *args
, **kwargs
):
13188 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13190 Constructor, with optional parameters to specify the gap between the
13193 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
13194 self
._setOORInfo
(self
)
13196 def Add(*args
, **kwargs
):
13198 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13199 int border=0, userData=None) -> wx.GBSizerItem
13201 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13202 more than one row or column as specified with *span*. The remaining
13203 args behave similarly to `wx.Sizer.Add`.
13205 Returns True if the item was successfully placed at the given cell
13206 position, False if something was already there.
13209 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13211 def AddItem(*args
, **kwargs
):
13213 Add(self, GBSizerItem item) -> wx.GBSizerItem
13215 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13216 the item was successfully placed at its given cell position, False if
13217 something was already there.
13219 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13221 def GetCellSize(*args
, **kwargs
):
13223 GetCellSize(self, int row, int col) -> Size
13225 Get the size of the specified cell, including hgap and
13226 vgap. Only valid after a Layout.
13228 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13230 def GetEmptyCellSize(*args
, **kwargs
):
13232 GetEmptyCellSize(self) -> Size
13234 Get the size used for cells in the grid with no item.
13236 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13238 def SetEmptyCellSize(*args
, **kwargs
):
13240 SetEmptyCellSize(self, Size sz)
13242 Set the size used for cells in the grid with no item.
13244 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13246 def GetItemPosition(*args
):
13248 GetItemPosition(self, item) -> GBPosition
13250 Get the grid position of the specified *item* where *item* is either a
13251 window or subsizer that is a member of this sizer, or a zero-based
13254 return _core_
.GridBagSizer_GetItemPosition(*args
)
13256 def SetItemPosition(*args
):
13258 SetItemPosition(self, item, GBPosition pos) -> bool
13260 Set the grid position of the specified *item* where *item* is either a
13261 window or subsizer that is a member of this sizer, or a zero-based
13262 index of an item. Returns True on success. If the move is not
13263 allowed (because an item is already there) then False is returned.
13266 return _core_
.GridBagSizer_SetItemPosition(*args
)
13268 def GetItemSpan(*args
):
13270 GetItemSpan(self, item) -> GBSpan
13272 Get the row/col spanning of the specified *item* where *item* is
13273 either a window or subsizer that is a member of this sizer, or a
13274 zero-based index of an item.
13276 return _core_
.GridBagSizer_GetItemSpan(*args
)
13278 def SetItemSpan(*args
):
13280 SetItemSpan(self, item, GBSpan span) -> bool
13282 Set the row/col spanning of the specified *item* where *item* is
13283 either a window or subsizer that is a member of this sizer, or a
13284 zero-based index of an item. Returns True on success. If the move is
13285 not allowed (because an item is already there) then False is returned.
13287 return _core_
.GridBagSizer_SetItemSpan(*args
)
13289 def FindItem(*args
):
13291 FindItem(self, item) -> GBSizerItem
13293 Find the sizer item for the given window or subsizer, returns None if
13294 not found. (non-recursive)
13296 return _core_
.GridBagSizer_FindItem(*args
)
13298 def FindItemAtPosition(*args
, **kwargs
):
13300 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13302 Return the sizer item for the given grid cell, or None if there is no
13303 item at that position. (non-recursive)
13305 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13307 def FindItemAtPoint(*args
, **kwargs
):
13309 FindItemAtPoint(self, Point pt) -> GBSizerItem
13311 Return the sizer item located at the point given in *pt*, or None if
13312 there is no item at that point. The (x,y) coordinates in pt correspond
13313 to the client coordinates of the window using the sizer for
13314 layout. (non-recursive)
13316 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13318 def CheckForIntersection(*args
, **kwargs
):
13320 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13322 Look at all items and see if any intersect (or would overlap) the
13323 given *item*. Returns True if so, False if there would be no overlap.
13324 If an *excludeItem* is given then it will not be checked for
13325 intersection, for example it may be the item we are checking the
13329 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13331 def CheckForIntersectionPos(*args
, **kwargs
):
13333 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13335 Look at all items and see if any intersect (or would overlap) the
13336 given position and span. Returns True if so, False if there would be
13337 no overlap. If an *excludeItem* is given then it will not be checked
13338 for intersection, for example it may be the item we are checking the
13341 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13343 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13345 #---------------------------------------------------------------------------
13349 Right
= _core_
.Right
13350 Bottom
= _core_
.Bottom
13351 Width
= _core_
.Width
13352 Height
= _core_
.Height
13353 Centre
= _core_
.Centre
13354 Center
= _core_
.Center
13355 CentreX
= _core_
.CentreX
13356 CentreY
= _core_
.CentreY
13357 Unconstrained
= _core_
.Unconstrained
13359 PercentOf
= _core_
.PercentOf
13360 Above
= _core_
.Above
13361 Below
= _core_
.Below
13362 LeftOf
= _core_
.LeftOf
13363 RightOf
= _core_
.RightOf
13364 SameAs
= _core_
.SameAs
13365 Absolute
= _core_
.Absolute
13366 class IndividualLayoutConstraint(Object
):
13368 Objects of this class are stored in the `wx.LayoutConstraints` class as
13369 one of eight possible constraints that a window can be involved in.
13370 You will never need to create an instance of
13371 wx.IndividualLayoutConstraint, rather you should create a
13372 `wx.LayoutConstraints` instance and use the individual contstraints
13375 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13376 def __init__(self
): raise AttributeError, "No constructor defined"
13377 __repr__
= _swig_repr
13378 def Set(*args
, **kwargs
):
13380 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13382 Sets the properties of the constraint. Normally called by one of the
13383 convenience functions such as Above, RightOf, SameAs.
13385 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13387 def LeftOf(*args
, **kwargs
):
13389 LeftOf(self, Window sibling, int marg=0)
13391 Constrains this edge to be to the left of the given window, with an
13392 optional margin. Implicitly, this is relative to the left edge of the
13395 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13397 def RightOf(*args
, **kwargs
):
13399 RightOf(self, Window sibling, int marg=0)
13401 Constrains this edge to be to the right of the given window, with an
13402 optional margin. Implicitly, this is relative to the right edge of the
13405 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13407 def Above(*args
, **kwargs
):
13409 Above(self, Window sibling, int marg=0)
13411 Constrains this edge to be above the given window, with an optional
13412 margin. Implicitly, this is relative to the top edge of the other
13415 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13417 def Below(*args
, **kwargs
):
13419 Below(self, Window sibling, int marg=0)
13421 Constrains this edge to be below the given window, with an optional
13422 margin. Implicitly, this is relative to the bottom edge of the other
13425 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13427 def SameAs(*args
, **kwargs
):
13429 SameAs(self, Window otherW, int edge, int marg=0)
13431 Constrains this edge or dimension to be to the same as the edge of the
13432 given window, with an optional margin.
13434 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13436 def PercentOf(*args
, **kwargs
):
13438 PercentOf(self, Window otherW, int wh, int per)
13440 Constrains this edge or dimension to be to a percentage of the given
13441 window, with an optional margin.
13443 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13445 def Absolute(*args
, **kwargs
):
13447 Absolute(self, int val)
13449 Constrains this edge or dimension to be the given absolute value.
13451 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13453 def Unconstrained(*args
, **kwargs
):
13455 Unconstrained(self)
13457 Sets this edge or dimension to be unconstrained, that is, dependent on
13458 other edges and dimensions from which this value can be deduced.
13460 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13462 def AsIs(*args
, **kwargs
):
13466 Sets this edge or constraint to be whatever the window's value is at
13467 the moment. If either of the width and height constraints are *as is*,
13468 the window will not be resized, but moved instead. This is important
13469 when considering panel items which are intended to have a default
13470 size, such as a button, which may take its size from the size of the
13473 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13475 def GetOtherWindow(*args
, **kwargs
):
13476 """GetOtherWindow(self) -> Window"""
13477 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13479 def GetMyEdge(*args
, **kwargs
):
13480 """GetMyEdge(self) -> int"""
13481 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13483 def SetEdge(*args
, **kwargs
):
13484 """SetEdge(self, int which)"""
13485 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13487 def SetValue(*args
, **kwargs
):
13488 """SetValue(self, int v)"""
13489 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13491 def GetMargin(*args
, **kwargs
):
13492 """GetMargin(self) -> int"""
13493 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13495 def SetMargin(*args
, **kwargs
):
13496 """SetMargin(self, int m)"""
13497 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13499 def GetValue(*args
, **kwargs
):
13500 """GetValue(self) -> int"""
13501 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13503 def GetPercent(*args
, **kwargs
):
13504 """GetPercent(self) -> int"""
13505 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13507 def GetOtherEdge(*args
, **kwargs
):
13508 """GetOtherEdge(self) -> int"""
13509 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13511 def GetDone(*args
, **kwargs
):
13512 """GetDone(self) -> bool"""
13513 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13515 def SetDone(*args
, **kwargs
):
13516 """SetDone(self, bool d)"""
13517 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13519 def GetRelationship(*args
, **kwargs
):
13520 """GetRelationship(self) -> int"""
13521 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13523 def SetRelationship(*args
, **kwargs
):
13524 """SetRelationship(self, int r)"""
13525 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13527 def ResetIfWin(*args
, **kwargs
):
13529 ResetIfWin(self, Window otherW) -> bool
13531 Reset constraint if it mentions otherWin
13533 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13535 def SatisfyConstraint(*args
, **kwargs
):
13537 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13539 Try to satisfy constraint
13541 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13543 def GetEdge(*args
, **kwargs
):
13545 GetEdge(self, int which, Window thisWin, Window other) -> int
13547 Get the value of this edge or dimension, or if this
13548 is not determinable, -1.
13550 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13552 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13553 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13554 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13555 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13556 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13557 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13558 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13559 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13560 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13562 class LayoutConstraints(Object
):
13564 **Note:** constraints are now deprecated and you should use sizers
13567 Objects of this class can be associated with a window to define its
13568 layout constraints, with respect to siblings or its parent.
13570 The class consists of the following eight constraints of class
13571 wx.IndividualLayoutConstraint, some or all of which should be accessed
13572 directly to set the appropriate constraints.
13574 * left: represents the left hand edge of the window
13575 * right: represents the right hand edge of the window
13576 * top: represents the top edge of the window
13577 * bottom: represents the bottom edge of the window
13578 * width: represents the width of the window
13579 * height: represents the height of the window
13580 * centreX: represents the horizontal centre point of the window
13581 * centreY: represents the vertical centre point of the window
13583 Most constraints are initially set to have the relationship
13584 wxUnconstrained, which means that their values should be calculated by
13585 looking at known constraints. The exceptions are width and height,
13586 which are set to wxAsIs to ensure that if the user does not specify a
13587 constraint, the existing width and height will be used, to be
13588 compatible with panel items which often have take a default size. If
13589 the constraint is ``wx.AsIs``, the dimension will not be changed.
13591 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13594 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13595 __repr__
= _swig_repr
13596 left
= property(_core_
.LayoutConstraints_left_get
)
13597 top
= property(_core_
.LayoutConstraints_top_get
)
13598 right
= property(_core_
.LayoutConstraints_right_get
)
13599 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13600 width
= property(_core_
.LayoutConstraints_width_get
)
13601 height
= property(_core_
.LayoutConstraints_height_get
)
13602 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13603 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13604 def __init__(self
, *args
, **kwargs
):
13605 """__init__(self) -> LayoutConstraints"""
13606 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13607 __swig_destroy__
= _core_
.delete_LayoutConstraints
13608 __del__
= lambda self
: None;
13609 def SatisfyConstraints(*args
, **kwargs
):
13610 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13611 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13613 def AreSatisfied(*args
, **kwargs
):
13614 """AreSatisfied(self) -> bool"""
13615 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13617 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13619 #----------------------------------------------------------------------------
13621 # Use Python's bool constants if available, make some if not
13625 __builtins__
.True = 1==1
13626 __builtins__
.False = 1==0
13627 def bool(value
): return not not value
13628 __builtins__
.bool = bool
13632 # workarounds for bad wxRTTI names
13633 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13634 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13635 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13638 #----------------------------------------------------------------------------
13639 # Load version numbers from __version__... Ensure that major and minor
13640 # versions are the same for both wxPython and wxWidgets.
13642 from __version__
import *
13643 __version__
= VERSION_STRING
13645 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13646 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13647 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13649 warnings
.warn("wxPython/wxWidgets release number mismatch")
13651 #----------------------------------------------------------------------------
13653 # Set wxPython's default string<-->unicode conversion encoding from
13654 # the locale, but only if Python's default hasn't been changed. (We
13655 # assume that if the user has customized it already then that is the
13656 # encoding we need to use as well.)
13658 # The encoding selected here is used when string or unicode objects
13659 # need to be converted in order to pass them to wxWidgets. Please be
13660 # aware that the default encoding within the same locale may be
13661 # slightly different on different platforms. For example, please see
13662 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13663 # between the common latin/roman encodings.
13665 default
= _sys
.getdefaultencoding()
13666 if default
== 'ascii':
13670 default
= locale
.getdefaultlocale()[1]
13671 codecs
.lookup(default
)
13672 except (ValueError, LookupError, TypeError):
13673 default
= _sys
.getdefaultencoding()
13677 wx
.SetDefaultPyEncoding(default
)
13680 #----------------------------------------------------------------------------
13682 class PyDeadObjectError(AttributeError):
13685 class _wxPyDeadObject(object):
13687 Instances of wx objects that are OOR capable will have their __class__
13688 changed to this class when the C++ object is deleted. This should help
13689 prevent crashes due to referencing a bogus C++ pointer.
13691 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13692 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13694 def __repr__(self
):
13695 if not hasattr(self
, "_name"):
13696 self
._name
= "[unknown]"
13697 return self
.reprStr
% self
._name
13699 def __getattr__(self
, *args
):
13700 if not hasattr(self
, "_name"):
13701 self
._name
= "[unknown]"
13702 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13704 def __nonzero__(self
):
13709 class PyUnbornObjectError(AttributeError):
13712 class _wxPyUnbornObject(object):
13714 Some stock objects are created when the wx._core module is
13715 imported, but their C++ instance is not created until the wx.App
13716 object is created and initialized. These object instances will
13717 temporarily have their __class__ changed to this class so an
13718 exception will be raised if they are used before the C++ instance
13722 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13723 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13725 def __repr__(self
):
13726 #if not hasattr(self, "_name"):
13727 # self._name = "[unknown]"
13728 return self
.reprStr
#% self._name
13730 def __getattr__(self
, *args
):
13731 #if not hasattr(self, "_name"):
13732 # self._name = "[unknown]"
13733 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13735 def __nonzero__(self
):
13739 #----------------------------------------------------------------------------
13741 def CallAfter(callable, *args
, **kw
):
13743 Call the specified function after the current and pending event
13744 handlers have been completed. This is also good for making GUI
13745 method calls from non-GUI threads. Any extra positional or
13746 keyword args are passed on to the callable when it is called.
13748 :see: `wx.CallLater`
13751 assert app
is not None, 'No wx.App created yet'
13753 if not hasattr(app
, "_CallAfterId"):
13754 app
._CallAfterId
= wx
.NewEventType()
13755 app
.Connect(-1, -1, app
._CallAfterId
,
13756 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13758 evt
.SetEventType(app
._CallAfterId
)
13759 evt
.callable = callable
13762 wx
.PostEvent(app
, evt
)
13764 #----------------------------------------------------------------------------
13769 A convenience class for `wx.Timer`, that calls the given callable
13770 object once after the given amount of milliseconds, passing any
13771 positional or keyword args. The return value of the callable is
13772 availbale after it has been run with the `GetResult` method.
13774 If you don't need to get the return value or restart the timer
13775 then there is no need to hold a reference to this object. It will
13776 hold a reference to itself while the timer is running (the timer
13777 has a reference to self.Notify) but the cycle will be broken when
13778 the timer completes, automatically cleaning up the wx.CallLater
13781 :see: `wx.CallAfter`
13783 def __init__(self
, millis
, callable, *args
, **kwargs
):
13784 self
.millis
= millis
13785 self
.callable = callable
13786 self
.SetArgs(*args
, **kwargs
)
13788 self
.running
= False
13789 self
.hasRun
= False
13798 def Start(self
, millis
=None, *args
, **kwargs
):
13800 (Re)start the timer
13802 self
.hasRun
= False
13803 if millis
is not None:
13804 self
.millis
= millis
13806 self
.SetArgs(*args
, **kwargs
)
13808 self
.timer
= wx
.PyTimer(self
.Notify
)
13809 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13810 self
.running
= True
13816 Stop and destroy the timer.
13818 if self
.timer
is not None:
13823 def GetInterval(self
):
13824 if self
.timer
is not None:
13825 return self
.timer
.GetInterval()
13830 def IsRunning(self
):
13831 return self
.timer
is not None and self
.timer
.IsRunning()
13834 def SetArgs(self
, *args
, **kwargs
):
13836 (Re)set the args passed to the callable object. This is
13837 useful in conjunction with Restart if you want to schedule a
13838 new call to the same callable object but with different
13842 self
.kwargs
= kwargs
13848 def GetResult(self
):
13853 The timer has expired so call the callable.
13855 if self
.callable and getattr(self
.callable, 'im_self', True):
13857 self
.running
= False
13858 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13860 if not self
.running
:
13861 # if it wasn't restarted, then cleanup
13862 wx
.CallAfter(self
.Stop
)
13864 Interval
= property(GetInterval
)
13865 Result
= property(GetResult
)
13868 class FutureCall(CallLater
):
13869 """A compatibility alias for `CallLater`."""
13871 #----------------------------------------------------------------------------
13872 # Control which items in this module should be documented by epydoc.
13873 # We allow only classes and functions, which will help reduce the size
13874 # of the docs by filtering out the zillions of constants, EVT objects,
13875 # and etc that don't make much sense by themselves, but are instead
13876 # documented (or will be) as part of the classes/functions/methods
13877 # where they should be used.
13881 A filter for epydoc that only allows non-Ptr classes and
13882 functions, in order to reduce the clutter in the API docs.
13884 def __init__(self
, globals):
13885 self
._globals
= globals
13887 def __call__(self
, name
):
13889 obj
= self
._globals
.get(name
, None)
13891 # only document classes and function
13892 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13895 # skip other things that are private or will be documented as part of somethign else
13896 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13899 # skip functions that are duplicates of static functions in a class
13900 if name
.find('_') != -1:
13901 cls
= self
._globals
.get(name
.split('_')[0], None)
13902 methname
= name
.split('_')[1]
13903 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13908 #----------------------------------------------------------------------------
13909 #----------------------------------------------------------------------------
13911 # Import other modules in this package that should show up in the
13912 # "core" wx namespace
13914 from _windows
import *
13915 from _controls
import *
13916 from _misc
import *
13918 #----------------------------------------------------------------------------
13919 #----------------------------------------------------------------------------