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 CB_SIMPLE
= _core_
.CB_SIMPLE
120 CB_DROPDOWN
= _core_
.CB_DROPDOWN
121 CB_SORT
= _core_
.CB_SORT
122 CB_READONLY
= _core_
.CB_READONLY
123 RA_HORIZONTAL
= _core_
.RA_HORIZONTAL
124 RA_VERTICAL
= _core_
.RA_VERTICAL
125 RA_SPECIFY_ROWS
= _core_
.RA_SPECIFY_ROWS
126 RA_SPECIFY_COLS
= _core_
.RA_SPECIFY_COLS
127 RA_USE_CHECKBOX
= _core_
.RA_USE_CHECKBOX
128 RB_GROUP
= _core_
.RB_GROUP
129 RB_SINGLE
= _core_
.RB_SINGLE
130 SB_HORIZONTAL
= _core_
.SB_HORIZONTAL
131 SB_VERTICAL
= _core_
.SB_VERTICAL
132 RB_USE_CHECKBOX
= _core_
.RB_USE_CHECKBOX
133 ST_SIZEGRIP
= _core_
.ST_SIZEGRIP
134 FLOOD_SURFACE
= _core_
.FLOOD_SURFACE
135 FLOOD_BORDER
= _core_
.FLOOD_BORDER
136 ODDEVEN_RULE
= _core_
.ODDEVEN_RULE
137 WINDING_RULE
= _core_
.WINDING_RULE
138 TOOL_TOP
= _core_
.TOOL_TOP
139 TOOL_BOTTOM
= _core_
.TOOL_BOTTOM
140 TOOL_LEFT
= _core_
.TOOL_LEFT
141 TOOL_RIGHT
= _core_
.TOOL_RIGHT
143 YES_NO
= _core_
.YES_NO
144 CANCEL
= _core_
.CANCEL
147 NO_DEFAULT
= _core_
.NO_DEFAULT
148 YES_DEFAULT
= _core_
.YES_DEFAULT
151 ICON_EXCLAMATION
= _core_
.ICON_EXCLAMATION
152 ICON_HAND
= _core_
.ICON_HAND
153 ICON_QUESTION
= _core_
.ICON_QUESTION
154 ICON_INFORMATION
= _core_
.ICON_INFORMATION
155 ICON_STOP
= _core_
.ICON_STOP
156 ICON_ASTERISK
= _core_
.ICON_ASTERISK
157 ICON_MASK
= _core_
.ICON_MASK
158 ICON_WARNING
= _core_
.ICON_WARNING
159 ICON_ERROR
= _core_
.ICON_ERROR
160 FORWARD
= _core_
.FORWARD
161 BACKWARD
= _core_
.BACKWARD
166 SIZE_AUTO_WIDTH
= _core_
.SIZE_AUTO_WIDTH
167 SIZE_AUTO_HEIGHT
= _core_
.SIZE_AUTO_HEIGHT
168 SIZE_AUTO
= _core_
.SIZE_AUTO
169 SIZE_USE_EXISTING
= _core_
.SIZE_USE_EXISTING
170 SIZE_ALLOW_MINUS_ONE
= _core_
.SIZE_ALLOW_MINUS_ONE
171 SIZE_FORCE
= _core_
.SIZE_FORCE
172 PORTRAIT
= _core_
.PORTRAIT
173 LANDSCAPE
= _core_
.LANDSCAPE
174 PRINT_QUALITY_HIGH
= _core_
.PRINT_QUALITY_HIGH
175 PRINT_QUALITY_MEDIUM
= _core_
.PRINT_QUALITY_MEDIUM
176 PRINT_QUALITY_LOW
= _core_
.PRINT_QUALITY_LOW
177 PRINT_QUALITY_DRAFT
= _core_
.PRINT_QUALITY_DRAFT
178 ID_ANY
= _core_
.ID_ANY
179 ID_SEPARATOR
= _core_
.ID_SEPARATOR
180 ID_NONE
= _core_
.ID_NONE
181 ID_LOWEST
= _core_
.ID_LOWEST
182 ID_OPEN
= _core_
.ID_OPEN
183 ID_CLOSE
= _core_
.ID_CLOSE
184 ID_NEW
= _core_
.ID_NEW
185 ID_SAVE
= _core_
.ID_SAVE
186 ID_SAVEAS
= _core_
.ID_SAVEAS
187 ID_REVERT
= _core_
.ID_REVERT
188 ID_EXIT
= _core_
.ID_EXIT
189 ID_UNDO
= _core_
.ID_UNDO
190 ID_REDO
= _core_
.ID_REDO
191 ID_HELP
= _core_
.ID_HELP
192 ID_PRINT
= _core_
.ID_PRINT
193 ID_PRINT_SETUP
= _core_
.ID_PRINT_SETUP
194 ID_PAGE_SETUP
= _core_
.ID_PAGE_SETUP
195 ID_PREVIEW
= _core_
.ID_PREVIEW
196 ID_ABOUT
= _core_
.ID_ABOUT
197 ID_HELP_CONTENTS
= _core_
.ID_HELP_CONTENTS
198 ID_HELP_COMMANDS
= _core_
.ID_HELP_COMMANDS
199 ID_HELP_PROCEDURES
= _core_
.ID_HELP_PROCEDURES
200 ID_HELP_CONTEXT
= _core_
.ID_HELP_CONTEXT
201 ID_HELP_INDEX
= _core_
.ID_HELP_INDEX
202 ID_HELP_SEARCH
= _core_
.ID_HELP_SEARCH
203 ID_CLOSE_ALL
= _core_
.ID_CLOSE_ALL
204 ID_PREFERENCES
= _core_
.ID_PREFERENCES
205 ID_EDIT
= _core_
.ID_EDIT
206 ID_CUT
= _core_
.ID_CUT
207 ID_COPY
= _core_
.ID_COPY
208 ID_PASTE
= _core_
.ID_PASTE
209 ID_CLEAR
= _core_
.ID_CLEAR
210 ID_FIND
= _core_
.ID_FIND
211 ID_DUPLICATE
= _core_
.ID_DUPLICATE
212 ID_SELECTALL
= _core_
.ID_SELECTALL
213 ID_DELETE
= _core_
.ID_DELETE
214 ID_REPLACE
= _core_
.ID_REPLACE
215 ID_REPLACE_ALL
= _core_
.ID_REPLACE_ALL
216 ID_PROPERTIES
= _core_
.ID_PROPERTIES
217 ID_VIEW_DETAILS
= _core_
.ID_VIEW_DETAILS
218 ID_VIEW_LARGEICONS
= _core_
.ID_VIEW_LARGEICONS
219 ID_VIEW_SMALLICONS
= _core_
.ID_VIEW_SMALLICONS
220 ID_VIEW_LIST
= _core_
.ID_VIEW_LIST
221 ID_VIEW_SORTDATE
= _core_
.ID_VIEW_SORTDATE
222 ID_VIEW_SORTNAME
= _core_
.ID_VIEW_SORTNAME
223 ID_VIEW_SORTSIZE
= _core_
.ID_VIEW_SORTSIZE
224 ID_VIEW_SORTTYPE
= _core_
.ID_VIEW_SORTTYPE
225 ID_FILE
= _core_
.ID_FILE
226 ID_FILE1
= _core_
.ID_FILE1
227 ID_FILE2
= _core_
.ID_FILE2
228 ID_FILE3
= _core_
.ID_FILE3
229 ID_FILE4
= _core_
.ID_FILE4
230 ID_FILE5
= _core_
.ID_FILE5
231 ID_FILE6
= _core_
.ID_FILE6
232 ID_FILE7
= _core_
.ID_FILE7
233 ID_FILE8
= _core_
.ID_FILE8
234 ID_FILE9
= _core_
.ID_FILE9
236 ID_CANCEL
= _core_
.ID_CANCEL
237 ID_APPLY
= _core_
.ID_APPLY
238 ID_YES
= _core_
.ID_YES
240 ID_STATIC
= _core_
.ID_STATIC
241 ID_FORWARD
= _core_
.ID_FORWARD
242 ID_BACKWARD
= _core_
.ID_BACKWARD
243 ID_DEFAULT
= _core_
.ID_DEFAULT
244 ID_MORE
= _core_
.ID_MORE
245 ID_SETUP
= _core_
.ID_SETUP
246 ID_RESET
= _core_
.ID_RESET
247 ID_CONTEXT_HELP
= _core_
.ID_CONTEXT_HELP
248 ID_YESTOALL
= _core_
.ID_YESTOALL
249 ID_NOTOALL
= _core_
.ID_NOTOALL
250 ID_ABORT
= _core_
.ID_ABORT
251 ID_RETRY
= _core_
.ID_RETRY
252 ID_IGNORE
= _core_
.ID_IGNORE
253 ID_ADD
= _core_
.ID_ADD
254 ID_REMOVE
= _core_
.ID_REMOVE
256 ID_DOWN
= _core_
.ID_DOWN
257 ID_HOME
= _core_
.ID_HOME
258 ID_REFRESH
= _core_
.ID_REFRESH
259 ID_STOP
= _core_
.ID_STOP
260 ID_INDEX
= _core_
.ID_INDEX
261 ID_BOLD
= _core_
.ID_BOLD
262 ID_ITALIC
= _core_
.ID_ITALIC
263 ID_JUSTIFY_CENTER
= _core_
.ID_JUSTIFY_CENTER
264 ID_JUSTIFY_FILL
= _core_
.ID_JUSTIFY_FILL
265 ID_JUSTIFY_RIGHT
= _core_
.ID_JUSTIFY_RIGHT
266 ID_JUSTIFY_LEFT
= _core_
.ID_JUSTIFY_LEFT
267 ID_UNDERLINE
= _core_
.ID_UNDERLINE
268 ID_INDENT
= _core_
.ID_INDENT
269 ID_UNINDENT
= _core_
.ID_UNINDENT
270 ID_ZOOM_100
= _core_
.ID_ZOOM_100
271 ID_ZOOM_FIT
= _core_
.ID_ZOOM_FIT
272 ID_ZOOM_IN
= _core_
.ID_ZOOM_IN
273 ID_ZOOM_OUT
= _core_
.ID_ZOOM_OUT
274 ID_UNDELETE
= _core_
.ID_UNDELETE
275 ID_REVERT_TO_SAVED
= _core_
.ID_REVERT_TO_SAVED
276 ID_HIGHEST
= _core_
.ID_HIGHEST
277 MENU_TEAROFF
= _core_
.MENU_TEAROFF
278 MB_DOCKABLE
= _core_
.MB_DOCKABLE
279 NO_FULL_REPAINT_ON_RESIZE
= _core_
.NO_FULL_REPAINT_ON_RESIZE
280 FULL_REPAINT_ON_RESIZE
= _core_
.FULL_REPAINT_ON_RESIZE
281 LI_HORIZONTAL
= _core_
.LI_HORIZONTAL
282 LI_VERTICAL
= _core_
.LI_VERTICAL
283 WS_EX_VALIDATE_RECURSIVELY
= _core_
.WS_EX_VALIDATE_RECURSIVELY
284 WS_EX_BLOCK_EVENTS
= _core_
.WS_EX_BLOCK_EVENTS
285 WS_EX_TRANSIENT
= _core_
.WS_EX_TRANSIENT
286 WS_EX_THEMED_BACKGROUND
= _core_
.WS_EX_THEMED_BACKGROUND
287 WS_EX_PROCESS_IDLE
= _core_
.WS_EX_PROCESS_IDLE
288 WS_EX_PROCESS_UI_UPDATES
= _core_
.WS_EX_PROCESS_UI_UPDATES
289 MM_TEXT
= _core_
.MM_TEXT
290 MM_LOMETRIC
= _core_
.MM_LOMETRIC
291 MM_HIMETRIC
= _core_
.MM_HIMETRIC
292 MM_LOENGLISH
= _core_
.MM_LOENGLISH
293 MM_HIENGLISH
= _core_
.MM_HIENGLISH
294 MM_TWIPS
= _core_
.MM_TWIPS
295 MM_ISOTROPIC
= _core_
.MM_ISOTROPIC
296 MM_ANISOTROPIC
= _core_
.MM_ANISOTROPIC
297 MM_POINTS
= _core_
.MM_POINTS
298 MM_METRIC
= _core_
.MM_METRIC
299 CENTRE
= _core_
.CENTRE
300 CENTER
= _core_
.CENTER
301 HORIZONTAL
= _core_
.HORIZONTAL
302 VERTICAL
= _core_
.VERTICAL
309 BOTTOM
= _core_
.BOTTOM
315 ALIGN_NOT
= _core_
.ALIGN_NOT
316 ALIGN_CENTER_HORIZONTAL
= _core_
.ALIGN_CENTER_HORIZONTAL
317 ALIGN_CENTRE_HORIZONTAL
= _core_
.ALIGN_CENTRE_HORIZONTAL
318 ALIGN_LEFT
= _core_
.ALIGN_LEFT
319 ALIGN_TOP
= _core_
.ALIGN_TOP
320 ALIGN_RIGHT
= _core_
.ALIGN_RIGHT
321 ALIGN_BOTTOM
= _core_
.ALIGN_BOTTOM
322 ALIGN_CENTER_VERTICAL
= _core_
.ALIGN_CENTER_VERTICAL
323 ALIGN_CENTRE_VERTICAL
= _core_
.ALIGN_CENTRE_VERTICAL
324 ALIGN_CENTER
= _core_
.ALIGN_CENTER
325 ALIGN_CENTRE
= _core_
.ALIGN_CENTRE
326 ALIGN_MASK
= _core_
.ALIGN_MASK
327 STRETCH_NOT
= _core_
.STRETCH_NOT
328 SHRINK
= _core_
.SHRINK
330 EXPAND
= _core_
.EXPAND
331 SHAPED
= _core_
.SHAPED
332 FIXED_MINSIZE
= _core_
.FIXED_MINSIZE
335 BORDER_DEFAULT
= _core_
.BORDER_DEFAULT
336 BORDER_NONE
= _core_
.BORDER_NONE
337 BORDER_STATIC
= _core_
.BORDER_STATIC
338 BORDER_SIMPLE
= _core_
.BORDER_SIMPLE
339 BORDER_RAISED
= _core_
.BORDER_RAISED
340 BORDER_SUNKEN
= _core_
.BORDER_SUNKEN
341 BORDER_DOUBLE
= _core_
.BORDER_DOUBLE
342 BORDER_MASK
= _core_
.BORDER_MASK
343 BG_STYLE_SYSTEM
= _core_
.BG_STYLE_SYSTEM
344 BG_STYLE_COLOUR
= _core_
.BG_STYLE_COLOUR
345 BG_STYLE_CUSTOM
= _core_
.BG_STYLE_CUSTOM
346 DEFAULT
= _core_
.DEFAULT
347 DECORATIVE
= _core_
.DECORATIVE
349 SCRIPT
= _core_
.SCRIPT
351 MODERN
= _core_
.MODERN
352 TELETYPE
= _core_
.TELETYPE
353 VARIABLE
= _core_
.VARIABLE
355 NORMAL
= _core_
.NORMAL
358 ITALIC
= _core_
.ITALIC
362 LONG_DASH
= _core_
.LONG_DASH
363 SHORT_DASH
= _core_
.SHORT_DASH
364 DOT_DASH
= _core_
.DOT_DASH
365 USER_DASH
= _core_
.USER_DASH
366 TRANSPARENT
= _core_
.TRANSPARENT
367 STIPPLE
= _core_
.STIPPLE
368 STIPPLE_MASK
= _core_
.STIPPLE_MASK
369 STIPPLE_MASK_OPAQUE
= _core_
.STIPPLE_MASK_OPAQUE
370 BDIAGONAL_HATCH
= _core_
.BDIAGONAL_HATCH
371 CROSSDIAG_HATCH
= _core_
.CROSSDIAG_HATCH
372 FDIAGONAL_HATCH
= _core_
.FDIAGONAL_HATCH
373 CROSS_HATCH
= _core_
.CROSS_HATCH
374 HORIZONTAL_HATCH
= _core_
.HORIZONTAL_HATCH
375 VERTICAL_HATCH
= _core_
.VERTICAL_HATCH
376 JOIN_BEVEL
= _core_
.JOIN_BEVEL
377 JOIN_MITER
= _core_
.JOIN_MITER
378 JOIN_ROUND
= _core_
.JOIN_ROUND
379 CAP_ROUND
= _core_
.CAP_ROUND
380 CAP_PROJECTING
= _core_
.CAP_PROJECTING
381 CAP_BUTT
= _core_
.CAP_BUTT
384 INVERT
= _core_
.INVERT
385 OR_REVERSE
= _core_
.OR_REVERSE
386 AND_REVERSE
= _core_
.AND_REVERSE
389 AND_INVERT
= _core_
.AND_INVERT
393 SRC_INVERT
= _core_
.SRC_INVERT
394 OR_INVERT
= _core_
.OR_INVERT
398 WXK_BACK
= _core_
.WXK_BACK
399 WXK_TAB
= _core_
.WXK_TAB
400 WXK_RETURN
= _core_
.WXK_RETURN
401 WXK_ESCAPE
= _core_
.WXK_ESCAPE
402 WXK_SPACE
= _core_
.WXK_SPACE
403 WXK_DELETE
= _core_
.WXK_DELETE
404 WXK_START
= _core_
.WXK_START
405 WXK_LBUTTON
= _core_
.WXK_LBUTTON
406 WXK_RBUTTON
= _core_
.WXK_RBUTTON
407 WXK_CANCEL
= _core_
.WXK_CANCEL
408 WXK_MBUTTON
= _core_
.WXK_MBUTTON
409 WXK_CLEAR
= _core_
.WXK_CLEAR
410 WXK_SHIFT
= _core_
.WXK_SHIFT
411 WXK_ALT
= _core_
.WXK_ALT
412 WXK_CONTROL
= _core_
.WXK_CONTROL
413 WXK_MENU
= _core_
.WXK_MENU
414 WXK_PAUSE
= _core_
.WXK_PAUSE
415 WXK_CAPITAL
= _core_
.WXK_CAPITAL
416 WXK_END
= _core_
.WXK_END
417 WXK_HOME
= _core_
.WXK_HOME
418 WXK_LEFT
= _core_
.WXK_LEFT
419 WXK_UP
= _core_
.WXK_UP
420 WXK_RIGHT
= _core_
.WXK_RIGHT
421 WXK_DOWN
= _core_
.WXK_DOWN
422 WXK_SELECT
= _core_
.WXK_SELECT
423 WXK_PRINT
= _core_
.WXK_PRINT
424 WXK_EXECUTE
= _core_
.WXK_EXECUTE
425 WXK_SNAPSHOT
= _core_
.WXK_SNAPSHOT
426 WXK_INSERT
= _core_
.WXK_INSERT
427 WXK_HELP
= _core_
.WXK_HELP
428 WXK_NUMPAD0
= _core_
.WXK_NUMPAD0
429 WXK_NUMPAD1
= _core_
.WXK_NUMPAD1
430 WXK_NUMPAD2
= _core_
.WXK_NUMPAD2
431 WXK_NUMPAD3
= _core_
.WXK_NUMPAD3
432 WXK_NUMPAD4
= _core_
.WXK_NUMPAD4
433 WXK_NUMPAD5
= _core_
.WXK_NUMPAD5
434 WXK_NUMPAD6
= _core_
.WXK_NUMPAD6
435 WXK_NUMPAD7
= _core_
.WXK_NUMPAD7
436 WXK_NUMPAD8
= _core_
.WXK_NUMPAD8
437 WXK_NUMPAD9
= _core_
.WXK_NUMPAD9
438 WXK_MULTIPLY
= _core_
.WXK_MULTIPLY
439 WXK_ADD
= _core_
.WXK_ADD
440 WXK_SEPARATOR
= _core_
.WXK_SEPARATOR
441 WXK_SUBTRACT
= _core_
.WXK_SUBTRACT
442 WXK_DECIMAL
= _core_
.WXK_DECIMAL
443 WXK_DIVIDE
= _core_
.WXK_DIVIDE
444 WXK_F1
= _core_
.WXK_F1
445 WXK_F2
= _core_
.WXK_F2
446 WXK_F3
= _core_
.WXK_F3
447 WXK_F4
= _core_
.WXK_F4
448 WXK_F5
= _core_
.WXK_F5
449 WXK_F6
= _core_
.WXK_F6
450 WXK_F7
= _core_
.WXK_F7
451 WXK_F8
= _core_
.WXK_F8
452 WXK_F9
= _core_
.WXK_F9
453 WXK_F10
= _core_
.WXK_F10
454 WXK_F11
= _core_
.WXK_F11
455 WXK_F12
= _core_
.WXK_F12
456 WXK_F13
= _core_
.WXK_F13
457 WXK_F14
= _core_
.WXK_F14
458 WXK_F15
= _core_
.WXK_F15
459 WXK_F16
= _core_
.WXK_F16
460 WXK_F17
= _core_
.WXK_F17
461 WXK_F18
= _core_
.WXK_F18
462 WXK_F19
= _core_
.WXK_F19
463 WXK_F20
= _core_
.WXK_F20
464 WXK_F21
= _core_
.WXK_F21
465 WXK_F22
= _core_
.WXK_F22
466 WXK_F23
= _core_
.WXK_F23
467 WXK_F24
= _core_
.WXK_F24
468 WXK_NUMLOCK
= _core_
.WXK_NUMLOCK
469 WXK_SCROLL
= _core_
.WXK_SCROLL
470 WXK_PAGEUP
= _core_
.WXK_PAGEUP
471 WXK_PAGEDOWN
= _core_
.WXK_PAGEDOWN
472 WXK_NUMPAD_SPACE
= _core_
.WXK_NUMPAD_SPACE
473 WXK_NUMPAD_TAB
= _core_
.WXK_NUMPAD_TAB
474 WXK_NUMPAD_ENTER
= _core_
.WXK_NUMPAD_ENTER
475 WXK_NUMPAD_F1
= _core_
.WXK_NUMPAD_F1
476 WXK_NUMPAD_F2
= _core_
.WXK_NUMPAD_F2
477 WXK_NUMPAD_F3
= _core_
.WXK_NUMPAD_F3
478 WXK_NUMPAD_F4
= _core_
.WXK_NUMPAD_F4
479 WXK_NUMPAD_HOME
= _core_
.WXK_NUMPAD_HOME
480 WXK_NUMPAD_LEFT
= _core_
.WXK_NUMPAD_LEFT
481 WXK_NUMPAD_UP
= _core_
.WXK_NUMPAD_UP
482 WXK_NUMPAD_RIGHT
= _core_
.WXK_NUMPAD_RIGHT
483 WXK_NUMPAD_DOWN
= _core_
.WXK_NUMPAD_DOWN
484 WXK_NUMPAD_PAGEUP
= _core_
.WXK_NUMPAD_PAGEUP
485 WXK_NUMPAD_PAGEDOWN
= _core_
.WXK_NUMPAD_PAGEDOWN
486 WXK_NUMPAD_END
= _core_
.WXK_NUMPAD_END
487 WXK_NUMPAD_BEGIN
= _core_
.WXK_NUMPAD_BEGIN
488 WXK_NUMPAD_INSERT
= _core_
.WXK_NUMPAD_INSERT
489 WXK_NUMPAD_DELETE
= _core_
.WXK_NUMPAD_DELETE
490 WXK_NUMPAD_EQUAL
= _core_
.WXK_NUMPAD_EQUAL
491 WXK_NUMPAD_MULTIPLY
= _core_
.WXK_NUMPAD_MULTIPLY
492 WXK_NUMPAD_ADD
= _core_
.WXK_NUMPAD_ADD
493 WXK_NUMPAD_SEPARATOR
= _core_
.WXK_NUMPAD_SEPARATOR
494 WXK_NUMPAD_SUBTRACT
= _core_
.WXK_NUMPAD_SUBTRACT
495 WXK_NUMPAD_DECIMAL
= _core_
.WXK_NUMPAD_DECIMAL
496 WXK_NUMPAD_DIVIDE
= _core_
.WXK_NUMPAD_DIVIDE
497 WXK_WINDOWS_LEFT
= _core_
.WXK_WINDOWS_LEFT
498 WXK_WINDOWS_RIGHT
= _core_
.WXK_WINDOWS_RIGHT
499 WXK_WINDOWS_MENU
= _core_
.WXK_WINDOWS_MENU
500 WXK_COMMAND
= _core_
.WXK_COMMAND
501 WXK_SPECIAL1
= _core_
.WXK_SPECIAL1
502 WXK_SPECIAL2
= _core_
.WXK_SPECIAL2
503 WXK_SPECIAL3
= _core_
.WXK_SPECIAL3
504 WXK_SPECIAL4
= _core_
.WXK_SPECIAL4
505 WXK_SPECIAL5
= _core_
.WXK_SPECIAL5
506 WXK_SPECIAL6
= _core_
.WXK_SPECIAL6
507 WXK_SPECIAL7
= _core_
.WXK_SPECIAL7
508 WXK_SPECIAL8
= _core_
.WXK_SPECIAL8
509 WXK_SPECIAL9
= _core_
.WXK_SPECIAL9
510 WXK_SPECIAL10
= _core_
.WXK_SPECIAL10
511 WXK_SPECIAL11
= _core_
.WXK_SPECIAL11
512 WXK_SPECIAL12
= _core_
.WXK_SPECIAL12
513 WXK_SPECIAL13
= _core_
.WXK_SPECIAL13
514 WXK_SPECIAL14
= _core_
.WXK_SPECIAL14
515 WXK_SPECIAL15
= _core_
.WXK_SPECIAL15
516 WXK_SPECIAL16
= _core_
.WXK_SPECIAL16
517 WXK_SPECIAL17
= _core_
.WXK_SPECIAL17
518 WXK_SPECIAL18
= _core_
.WXK_SPECIAL18
519 WXK_SPECIAL19
= _core_
.WXK_SPECIAL19
520 WXK_SPECIAL20
= _core_
.WXK_SPECIAL20
521 WXK_PRIOR
= WXK_PAGEUP
522 WXK_NEXT
= WXK_PAGEDOWN
523 WXK_NUMPAD_PRIOR
= WXK_NUMPAD_PAGEUP
524 WXK_NUMPAD_NEXT
= WXK_NUMPAD_PAGEDOWN
526 PAPER_NONE
= _core_
.PAPER_NONE
527 PAPER_LETTER
= _core_
.PAPER_LETTER
528 PAPER_LEGAL
= _core_
.PAPER_LEGAL
529 PAPER_A4
= _core_
.PAPER_A4
530 PAPER_CSHEET
= _core_
.PAPER_CSHEET
531 PAPER_DSHEET
= _core_
.PAPER_DSHEET
532 PAPER_ESHEET
= _core_
.PAPER_ESHEET
533 PAPER_LETTERSMALL
= _core_
.PAPER_LETTERSMALL
534 PAPER_TABLOID
= _core_
.PAPER_TABLOID
535 PAPER_LEDGER
= _core_
.PAPER_LEDGER
536 PAPER_STATEMENT
= _core_
.PAPER_STATEMENT
537 PAPER_EXECUTIVE
= _core_
.PAPER_EXECUTIVE
538 PAPER_A3
= _core_
.PAPER_A3
539 PAPER_A4SMALL
= _core_
.PAPER_A4SMALL
540 PAPER_A5
= _core_
.PAPER_A5
541 PAPER_B4
= _core_
.PAPER_B4
542 PAPER_B5
= _core_
.PAPER_B5
543 PAPER_FOLIO
= _core_
.PAPER_FOLIO
544 PAPER_QUARTO
= _core_
.PAPER_QUARTO
545 PAPER_10X14
= _core_
.PAPER_10X14
546 PAPER_11X17
= _core_
.PAPER_11X17
547 PAPER_NOTE
= _core_
.PAPER_NOTE
548 PAPER_ENV_9
= _core_
.PAPER_ENV_9
549 PAPER_ENV_10
= _core_
.PAPER_ENV_10
550 PAPER_ENV_11
= _core_
.PAPER_ENV_11
551 PAPER_ENV_12
= _core_
.PAPER_ENV_12
552 PAPER_ENV_14
= _core_
.PAPER_ENV_14
553 PAPER_ENV_DL
= _core_
.PAPER_ENV_DL
554 PAPER_ENV_C5
= _core_
.PAPER_ENV_C5
555 PAPER_ENV_C3
= _core_
.PAPER_ENV_C3
556 PAPER_ENV_C4
= _core_
.PAPER_ENV_C4
557 PAPER_ENV_C6
= _core_
.PAPER_ENV_C6
558 PAPER_ENV_C65
= _core_
.PAPER_ENV_C65
559 PAPER_ENV_B4
= _core_
.PAPER_ENV_B4
560 PAPER_ENV_B5
= _core_
.PAPER_ENV_B5
561 PAPER_ENV_B6
= _core_
.PAPER_ENV_B6
562 PAPER_ENV_ITALY
= _core_
.PAPER_ENV_ITALY
563 PAPER_ENV_MONARCH
= _core_
.PAPER_ENV_MONARCH
564 PAPER_ENV_PERSONAL
= _core_
.PAPER_ENV_PERSONAL
565 PAPER_FANFOLD_US
= _core_
.PAPER_FANFOLD_US
566 PAPER_FANFOLD_STD_GERMAN
= _core_
.PAPER_FANFOLD_STD_GERMAN
567 PAPER_FANFOLD_LGL_GERMAN
= _core_
.PAPER_FANFOLD_LGL_GERMAN
568 PAPER_ISO_B4
= _core_
.PAPER_ISO_B4
569 PAPER_JAPANESE_POSTCARD
= _core_
.PAPER_JAPANESE_POSTCARD
570 PAPER_9X11
= _core_
.PAPER_9X11
571 PAPER_10X11
= _core_
.PAPER_10X11
572 PAPER_15X11
= _core_
.PAPER_15X11
573 PAPER_ENV_INVITE
= _core_
.PAPER_ENV_INVITE
574 PAPER_LETTER_EXTRA
= _core_
.PAPER_LETTER_EXTRA
575 PAPER_LEGAL_EXTRA
= _core_
.PAPER_LEGAL_EXTRA
576 PAPER_TABLOID_EXTRA
= _core_
.PAPER_TABLOID_EXTRA
577 PAPER_A4_EXTRA
= _core_
.PAPER_A4_EXTRA
578 PAPER_LETTER_TRANSVERSE
= _core_
.PAPER_LETTER_TRANSVERSE
579 PAPER_A4_TRANSVERSE
= _core_
.PAPER_A4_TRANSVERSE
580 PAPER_LETTER_EXTRA_TRANSVERSE
= _core_
.PAPER_LETTER_EXTRA_TRANSVERSE
581 PAPER_A_PLUS
= _core_
.PAPER_A_PLUS
582 PAPER_B_PLUS
= _core_
.PAPER_B_PLUS
583 PAPER_LETTER_PLUS
= _core_
.PAPER_LETTER_PLUS
584 PAPER_A4_PLUS
= _core_
.PAPER_A4_PLUS
585 PAPER_A5_TRANSVERSE
= _core_
.PAPER_A5_TRANSVERSE
586 PAPER_B5_TRANSVERSE
= _core_
.PAPER_B5_TRANSVERSE
587 PAPER_A3_EXTRA
= _core_
.PAPER_A3_EXTRA
588 PAPER_A5_EXTRA
= _core_
.PAPER_A5_EXTRA
589 PAPER_B5_EXTRA
= _core_
.PAPER_B5_EXTRA
590 PAPER_A2
= _core_
.PAPER_A2
591 PAPER_A3_TRANSVERSE
= _core_
.PAPER_A3_TRANSVERSE
592 PAPER_A3_EXTRA_TRANSVERSE
= _core_
.PAPER_A3_EXTRA_TRANSVERSE
593 PAPER_DBL_JAPANESE_POSTCARD
= _core_
.PAPER_DBL_JAPANESE_POSTCARD
594 PAPER_A6
= _core_
.PAPER_A6
595 PAPER_JENV_KAKU2
= _core_
.PAPER_JENV_KAKU2
596 PAPER_JENV_KAKU3
= _core_
.PAPER_JENV_KAKU3
597 PAPER_JENV_CHOU3
= _core_
.PAPER_JENV_CHOU3
598 PAPER_JENV_CHOU4
= _core_
.PAPER_JENV_CHOU4
599 PAPER_LETTER_ROTATED
= _core_
.PAPER_LETTER_ROTATED
600 PAPER_A3_ROTATED
= _core_
.PAPER_A3_ROTATED
601 PAPER_A4_ROTATED
= _core_
.PAPER_A4_ROTATED
602 PAPER_A5_ROTATED
= _core_
.PAPER_A5_ROTATED
603 PAPER_B4_JIS_ROTATED
= _core_
.PAPER_B4_JIS_ROTATED
604 PAPER_B5_JIS_ROTATED
= _core_
.PAPER_B5_JIS_ROTATED
605 PAPER_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_JAPANESE_POSTCARD_ROTATED
606 PAPER_DBL_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
607 PAPER_A6_ROTATED
= _core_
.PAPER_A6_ROTATED
608 PAPER_JENV_KAKU2_ROTATED
= _core_
.PAPER_JENV_KAKU2_ROTATED
609 PAPER_JENV_KAKU3_ROTATED
= _core_
.PAPER_JENV_KAKU3_ROTATED
610 PAPER_JENV_CHOU3_ROTATED
= _core_
.PAPER_JENV_CHOU3_ROTATED
611 PAPER_JENV_CHOU4_ROTATED
= _core_
.PAPER_JENV_CHOU4_ROTATED
612 PAPER_B6_JIS
= _core_
.PAPER_B6_JIS
613 PAPER_B6_JIS_ROTATED
= _core_
.PAPER_B6_JIS_ROTATED
614 PAPER_12X11
= _core_
.PAPER_12X11
615 PAPER_JENV_YOU4
= _core_
.PAPER_JENV_YOU4
616 PAPER_JENV_YOU4_ROTATED
= _core_
.PAPER_JENV_YOU4_ROTATED
617 PAPER_P16K
= _core_
.PAPER_P16K
618 PAPER_P32K
= _core_
.PAPER_P32K
619 PAPER_P32KBIG
= _core_
.PAPER_P32KBIG
620 PAPER_PENV_1
= _core_
.PAPER_PENV_1
621 PAPER_PENV_2
= _core_
.PAPER_PENV_2
622 PAPER_PENV_3
= _core_
.PAPER_PENV_3
623 PAPER_PENV_4
= _core_
.PAPER_PENV_4
624 PAPER_PENV_5
= _core_
.PAPER_PENV_5
625 PAPER_PENV_6
= _core_
.PAPER_PENV_6
626 PAPER_PENV_7
= _core_
.PAPER_PENV_7
627 PAPER_PENV_8
= _core_
.PAPER_PENV_8
628 PAPER_PENV_9
= _core_
.PAPER_PENV_9
629 PAPER_PENV_10
= _core_
.PAPER_PENV_10
630 PAPER_P16K_ROTATED
= _core_
.PAPER_P16K_ROTATED
631 PAPER_P32K_ROTATED
= _core_
.PAPER_P32K_ROTATED
632 PAPER_P32KBIG_ROTATED
= _core_
.PAPER_P32KBIG_ROTATED
633 PAPER_PENV_1_ROTATED
= _core_
.PAPER_PENV_1_ROTATED
634 PAPER_PENV_2_ROTATED
= _core_
.PAPER_PENV_2_ROTATED
635 PAPER_PENV_3_ROTATED
= _core_
.PAPER_PENV_3_ROTATED
636 PAPER_PENV_4_ROTATED
= _core_
.PAPER_PENV_4_ROTATED
637 PAPER_PENV_5_ROTATED
= _core_
.PAPER_PENV_5_ROTATED
638 PAPER_PENV_6_ROTATED
= _core_
.PAPER_PENV_6_ROTATED
639 PAPER_PENV_7_ROTATED
= _core_
.PAPER_PENV_7_ROTATED
640 PAPER_PENV_8_ROTATED
= _core_
.PAPER_PENV_8_ROTATED
641 PAPER_PENV_9_ROTATED
= _core_
.PAPER_PENV_9_ROTATED
642 PAPER_PENV_10_ROTATED
= _core_
.PAPER_PENV_10_ROTATED
643 DUPLEX_SIMPLEX
= _core_
.DUPLEX_SIMPLEX
644 DUPLEX_HORIZONTAL
= _core_
.DUPLEX_HORIZONTAL
645 DUPLEX_VERTICAL
= _core_
.DUPLEX_VERTICAL
646 ITEM_SEPARATOR
= _core_
.ITEM_SEPARATOR
647 ITEM_NORMAL
= _core_
.ITEM_NORMAL
648 ITEM_CHECK
= _core_
.ITEM_CHECK
649 ITEM_RADIO
= _core_
.ITEM_RADIO
650 ITEM_MAX
= _core_
.ITEM_MAX
651 HT_NOWHERE
= _core_
.HT_NOWHERE
652 HT_SCROLLBAR_FIRST
= _core_
.HT_SCROLLBAR_FIRST
653 HT_SCROLLBAR_ARROW_LINE_1
= _core_
.HT_SCROLLBAR_ARROW_LINE_1
654 HT_SCROLLBAR_ARROW_LINE_2
= _core_
.HT_SCROLLBAR_ARROW_LINE_2
655 HT_SCROLLBAR_ARROW_PAGE_1
= _core_
.HT_SCROLLBAR_ARROW_PAGE_1
656 HT_SCROLLBAR_ARROW_PAGE_2
= _core_
.HT_SCROLLBAR_ARROW_PAGE_2
657 HT_SCROLLBAR_THUMB
= _core_
.HT_SCROLLBAR_THUMB
658 HT_SCROLLBAR_BAR_1
= _core_
.HT_SCROLLBAR_BAR_1
659 HT_SCROLLBAR_BAR_2
= _core_
.HT_SCROLLBAR_BAR_2
660 HT_SCROLLBAR_LAST
= _core_
.HT_SCROLLBAR_LAST
661 HT_WINDOW_OUTSIDE
= _core_
.HT_WINDOW_OUTSIDE
662 HT_WINDOW_INSIDE
= _core_
.HT_WINDOW_INSIDE
663 HT_WINDOW_VERT_SCROLLBAR
= _core_
.HT_WINDOW_VERT_SCROLLBAR
664 HT_WINDOW_HORZ_SCROLLBAR
= _core_
.HT_WINDOW_HORZ_SCROLLBAR
665 HT_WINDOW_CORNER
= _core_
.HT_WINDOW_CORNER
666 HT_MAX
= _core_
.HT_MAX
667 MOD_NONE
= _core_
.MOD_NONE
668 MOD_ALT
= _core_
.MOD_ALT
669 MOD_CONTROL
= _core_
.MOD_CONTROL
670 MOD_ALTGR
= _core_
.MOD_ALTGR
671 MOD_SHIFT
= _core_
.MOD_SHIFT
672 MOD_META
= _core_
.MOD_META
673 MOD_WIN
= _core_
.MOD_WIN
674 MOD_CMD
= _core_
.MOD_CMD
675 MOD_ALL
= _core_
.MOD_ALL
676 UPDATE_UI_NONE
= _core_
.UPDATE_UI_NONE
677 UPDATE_UI_RECURSE
= _core_
.UPDATE_UI_RECURSE
678 UPDATE_UI_FROMIDLE
= _core_
.UPDATE_UI_FROMIDLE
679 Layout_Default
= _core_
.Layout_Default
680 Layout_LeftToRight
= _core_
.Layout_LeftToRight
681 Layout_RightToLeft
= _core_
.Layout_RightToLeft
682 #---------------------------------------------------------------------------
684 class Object(object):
686 The base class for most wx objects, although in wxPython not
687 much functionality is needed nor exposed.
689 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
690 def __init__(self
): raise AttributeError, "No constructor defined"
691 __repr__
= _swig_repr
692 def GetClassName(*args
, **kwargs
):
694 GetClassName(self) -> String
696 Returns the class name of the C++ class using wxRTTI.
698 return _core_
.Object_GetClassName(*args
, **kwargs
)
700 def Destroy(*args
, **kwargs
):
704 Deletes the C++ object this Python object is a proxy for.
706 args
[0].this
.own(False)
707 return _core_
.Object_Destroy(*args
, **kwargs
)
709 def IsSameAs(*args
, **kwargs
):
711 IsSameAs(self, Object p) -> bool
713 For wx.Objects that use C++ reference counting internally, this method
714 can be used to determine if two objects are referencing the same data
717 return _core_
.Object_IsSameAs(*args
, **kwargs
)
719 ClassName
= property(GetClassName
,doc
="See `GetClassName`")
720 _core_
.Object_swigregister(Object
)
721 _wxPySetDictionary
= _core_
._wxPySetDictionary
723 EmptyString
= cvar
.EmptyString
725 #---------------------------------------------------------------------------
727 BITMAP_TYPE_INVALID
= _core_
.BITMAP_TYPE_INVALID
728 BITMAP_TYPE_BMP
= _core_
.BITMAP_TYPE_BMP
729 BITMAP_TYPE_ICO
= _core_
.BITMAP_TYPE_ICO
730 BITMAP_TYPE_CUR
= _core_
.BITMAP_TYPE_CUR
731 BITMAP_TYPE_XBM
= _core_
.BITMAP_TYPE_XBM
732 BITMAP_TYPE_XBM_DATA
= _core_
.BITMAP_TYPE_XBM_DATA
733 BITMAP_TYPE_XPM
= _core_
.BITMAP_TYPE_XPM
734 BITMAP_TYPE_XPM_DATA
= _core_
.BITMAP_TYPE_XPM_DATA
735 BITMAP_TYPE_TIF
= _core_
.BITMAP_TYPE_TIF
736 BITMAP_TYPE_GIF
= _core_
.BITMAP_TYPE_GIF
737 BITMAP_TYPE_PNG
= _core_
.BITMAP_TYPE_PNG
738 BITMAP_TYPE_JPEG
= _core_
.BITMAP_TYPE_JPEG
739 BITMAP_TYPE_PNM
= _core_
.BITMAP_TYPE_PNM
740 BITMAP_TYPE_PCX
= _core_
.BITMAP_TYPE_PCX
741 BITMAP_TYPE_PICT
= _core_
.BITMAP_TYPE_PICT
742 BITMAP_TYPE_ICON
= _core_
.BITMAP_TYPE_ICON
743 BITMAP_TYPE_ANI
= _core_
.BITMAP_TYPE_ANI
744 BITMAP_TYPE_IFF
= _core_
.BITMAP_TYPE_IFF
745 BITMAP_TYPE_TGA
= _core_
.BITMAP_TYPE_TGA
746 BITMAP_TYPE_MACCURSOR
= _core_
.BITMAP_TYPE_MACCURSOR
747 BITMAP_TYPE_ANY
= _core_
.BITMAP_TYPE_ANY
748 CURSOR_NONE
= _core_
.CURSOR_NONE
749 CURSOR_ARROW
= _core_
.CURSOR_ARROW
750 CURSOR_RIGHT_ARROW
= _core_
.CURSOR_RIGHT_ARROW
751 CURSOR_BULLSEYE
= _core_
.CURSOR_BULLSEYE
752 CURSOR_CHAR
= _core_
.CURSOR_CHAR
753 CURSOR_CROSS
= _core_
.CURSOR_CROSS
754 CURSOR_HAND
= _core_
.CURSOR_HAND
755 CURSOR_IBEAM
= _core_
.CURSOR_IBEAM
756 CURSOR_LEFT_BUTTON
= _core_
.CURSOR_LEFT_BUTTON
757 CURSOR_MAGNIFIER
= _core_
.CURSOR_MAGNIFIER
758 CURSOR_MIDDLE_BUTTON
= _core_
.CURSOR_MIDDLE_BUTTON
759 CURSOR_NO_ENTRY
= _core_
.CURSOR_NO_ENTRY
760 CURSOR_PAINT_BRUSH
= _core_
.CURSOR_PAINT_BRUSH
761 CURSOR_PENCIL
= _core_
.CURSOR_PENCIL
762 CURSOR_POINT_LEFT
= _core_
.CURSOR_POINT_LEFT
763 CURSOR_POINT_RIGHT
= _core_
.CURSOR_POINT_RIGHT
764 CURSOR_QUESTION_ARROW
= _core_
.CURSOR_QUESTION_ARROW
765 CURSOR_RIGHT_BUTTON
= _core_
.CURSOR_RIGHT_BUTTON
766 CURSOR_SIZENESW
= _core_
.CURSOR_SIZENESW
767 CURSOR_SIZENS
= _core_
.CURSOR_SIZENS
768 CURSOR_SIZENWSE
= _core_
.CURSOR_SIZENWSE
769 CURSOR_SIZEWE
= _core_
.CURSOR_SIZEWE
770 CURSOR_SIZING
= _core_
.CURSOR_SIZING
771 CURSOR_SPRAYCAN
= _core_
.CURSOR_SPRAYCAN
772 CURSOR_WAIT
= _core_
.CURSOR_WAIT
773 CURSOR_WATCH
= _core_
.CURSOR_WATCH
774 CURSOR_BLANK
= _core_
.CURSOR_BLANK
775 CURSOR_DEFAULT
= _core_
.CURSOR_DEFAULT
776 CURSOR_COPY_ARROW
= _core_
.CURSOR_COPY_ARROW
777 CURSOR_ARROWWAIT
= _core_
.CURSOR_ARROWWAIT
778 CURSOR_MAX
= _core_
.CURSOR_MAX
779 #---------------------------------------------------------------------------
783 wx.Size is a useful data structure used to represent the size of
784 something. It simply contains integer width and height
785 properties. In most places in wxPython where a wx.Size is
786 expected a (width, height) tuple can be used instead.
788 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
789 __repr__
= _swig_repr
790 width
= property(_core_
.Size_width_get
, _core_
.Size_width_set
)
791 height
= property(_core_
.Size_height_get
, _core_
.Size_height_set
)
792 x
= width
; y
= height
793 def __init__(self
, *args
, **kwargs
):
795 __init__(self, int w=0, int h=0) -> Size
797 Creates a size object.
799 _core_
.Size_swiginit(self
,_core_
.new_Size(*args
, **kwargs
))
800 __swig_destroy__
= _core_
.delete_Size
801 __del__
= lambda self
: None;
802 def __eq__(*args
, **kwargs
):
804 __eq__(self, PyObject other) -> bool
806 Test for equality of wx.Size objects.
808 return _core_
.Size___eq__(*args
, **kwargs
)
810 def __ne__(*args
, **kwargs
):
812 __ne__(self, PyObject other) -> bool
814 Test for inequality of wx.Size objects.
816 return _core_
.Size___ne__(*args
, **kwargs
)
818 def __add__(*args
, **kwargs
):
820 __add__(self, Size sz) -> Size
822 Add sz's proprties to this and return the result.
824 return _core_
.Size___add__(*args
, **kwargs
)
826 def __sub__(*args
, **kwargs
):
828 __sub__(self, Size sz) -> Size
830 Subtract sz's properties from this and return the result.
832 return _core_
.Size___sub__(*args
, **kwargs
)
834 def IncTo(*args
, **kwargs
):
838 Increments this object so that both of its dimensions are not less
839 than the corresponding dimensions of the size.
841 return _core_
.Size_IncTo(*args
, **kwargs
)
843 def DecTo(*args
, **kwargs
):
847 Decrements this object so that both of its dimensions are not greater
848 than the corresponding dimensions of the size.
850 return _core_
.Size_DecTo(*args
, **kwargs
)
852 def IncBy(*args
, **kwargs
):
853 """IncBy(self, int dx, int dy)"""
854 return _core_
.Size_IncBy(*args
, **kwargs
)
856 def DecBy(*args
, **kwargs
):
857 """DecBy(self, int dx, int dy)"""
858 return _core_
.Size_DecBy(*args
, **kwargs
)
860 def Scale(*args
, **kwargs
):
862 Scale(self, float xscale, float yscale)
864 Scales the dimensions of this object by the given factors.
866 return _core_
.Size_Scale(*args
, **kwargs
)
868 def Set(*args
, **kwargs
):
870 Set(self, int w, int h)
872 Set both width and height.
874 return _core_
.Size_Set(*args
, **kwargs
)
876 def SetWidth(*args
, **kwargs
):
877 """SetWidth(self, int w)"""
878 return _core_
.Size_SetWidth(*args
, **kwargs
)
880 def SetHeight(*args
, **kwargs
):
881 """SetHeight(self, int h)"""
882 return _core_
.Size_SetHeight(*args
, **kwargs
)
884 def GetWidth(*args
, **kwargs
):
885 """GetWidth(self) -> int"""
886 return _core_
.Size_GetWidth(*args
, **kwargs
)
888 def GetHeight(*args
, **kwargs
):
889 """GetHeight(self) -> int"""
890 return _core_
.Size_GetHeight(*args
, **kwargs
)
892 def IsFullySpecified(*args
, **kwargs
):
894 IsFullySpecified(self) -> bool
896 Returns True if both components of the size are non-default values.
898 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
900 def SetDefaults(*args
, **kwargs
):
902 SetDefaults(self, Size size)
904 Combine this size with the other one replacing the default components
905 of this object (i.e. equal to -1) with those of the other.
907 return _core_
.Size_SetDefaults(*args
, **kwargs
)
909 def Get(*args
, **kwargs
):
911 Get() -> (width,height)
913 Returns the width and height properties as a tuple.
915 return _core_
.Size_Get(*args
, **kwargs
)
917 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
918 def __str__(self
): return str(self
.Get())
919 def __repr__(self
): return 'wx.Size'+str(self
.Get())
920 def __len__(self
): return len(self
.Get())
921 def __getitem__(self
, index
): return self
.Get()[index
]
922 def __setitem__(self
, index
, val
):
923 if index
== 0: self
.width
= val
924 elif index
== 1: self
.height
= val
925 else: raise IndexError
926 def __nonzero__(self
): return self
.Get() != (0,0)
927 __safe_for_unpickling__
= True
928 def __reduce__(self
): return (wx
.Size
, self
.Get())
930 _core_
.Size_swigregister(Size
)
932 #---------------------------------------------------------------------------
934 class RealPoint(object):
936 A data structure for representing a point or position with floating
937 point x and y properties. In wxPython most places that expect a
938 wx.RealPoint can also accept a (x,y) tuple.
940 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
941 __repr__
= _swig_repr
942 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
943 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
944 def __init__(self
, *args
, **kwargs
):
946 __init__(self, double x=0.0, double y=0.0) -> RealPoint
948 Create a wx.RealPoint object
950 _core_
.RealPoint_swiginit(self
,_core_
.new_RealPoint(*args
, **kwargs
))
951 __swig_destroy__
= _core_
.delete_RealPoint
952 __del__
= lambda self
: None;
953 def __eq__(*args
, **kwargs
):
955 __eq__(self, PyObject other) -> bool
957 Test for equality of wx.RealPoint objects.
959 return _core_
.RealPoint___eq__(*args
, **kwargs
)
961 def __ne__(*args
, **kwargs
):
963 __ne__(self, PyObject other) -> bool
965 Test for inequality of wx.RealPoint objects.
967 return _core_
.RealPoint___ne__(*args
, **kwargs
)
969 def __add__(*args
, **kwargs
):
971 __add__(self, RealPoint pt) -> RealPoint
973 Add pt's proprties to this and return the result.
975 return _core_
.RealPoint___add__(*args
, **kwargs
)
977 def __sub__(*args
, **kwargs
):
979 __sub__(self, RealPoint pt) -> RealPoint
981 Subtract pt's proprties from this and return the result
983 return _core_
.RealPoint___sub__(*args
, **kwargs
)
985 def Set(*args
, **kwargs
):
987 Set(self, double x, double y)
989 Set both the x and y properties
991 return _core_
.RealPoint_Set(*args
, **kwargs
)
993 def Get(*args
, **kwargs
):
997 Return the x and y properties as a tuple.
999 return _core_
.RealPoint_Get(*args
, **kwargs
)
1001 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1002 def __str__(self
): return str(self
.Get())
1003 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
1004 def __len__(self
): return len(self
.Get())
1005 def __getitem__(self
, index
): return self
.Get()[index
]
1006 def __setitem__(self
, index
, val
):
1007 if index
== 0: self
.x
= val
1008 elif index
== 1: self
.y
= val
1009 else: raise IndexError
1010 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1011 __safe_for_unpickling__
= True
1012 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
1014 _core_
.RealPoint_swigregister(RealPoint
)
1016 #---------------------------------------------------------------------------
1018 class Point(object):
1020 A data structure for representing a point or position with integer x
1021 and y properties. Most places in wxPython that expect a wx.Point can
1022 also accept a (x,y) tuple.
1024 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1025 __repr__
= _swig_repr
1026 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1027 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1028 def __init__(self
, *args
, **kwargs
):
1030 __init__(self, int x=0, int y=0) -> Point
1032 Create a wx.Point object
1034 _core_
.Point_swiginit(self
,_core_
.new_Point(*args
, **kwargs
))
1035 __swig_destroy__
= _core_
.delete_Point
1036 __del__
= lambda self
: None;
1037 def __eq__(*args
, **kwargs
):
1039 __eq__(self, PyObject other) -> bool
1041 Test for equality of wx.Point objects.
1043 return _core_
.Point___eq__(*args
, **kwargs
)
1045 def __ne__(*args
, **kwargs
):
1047 __ne__(self, PyObject other) -> bool
1049 Test for inequality of wx.Point objects.
1051 return _core_
.Point___ne__(*args
, **kwargs
)
1053 def __add__(*args
, **kwargs
):
1055 __add__(self, Point pt) -> Point
1057 Add pt's proprties to this and return the result.
1059 return _core_
.Point___add__(*args
, **kwargs
)
1061 def __sub__(*args
, **kwargs
):
1063 __sub__(self, Point pt) -> Point
1065 Subtract pt's proprties from this and return the result
1067 return _core_
.Point___sub__(*args
, **kwargs
)
1069 def __iadd__(*args
, **kwargs
):
1071 __iadd__(self, Point pt) -> Point
1073 Add pt to this object.
1075 return _core_
.Point___iadd__(*args
, **kwargs
)
1077 def __isub__(*args
, **kwargs
):
1079 __isub__(self, Point pt) -> Point
1081 Subtract pt from this object.
1083 return _core_
.Point___isub__(*args
, **kwargs
)
1085 def Set(*args
, **kwargs
):
1087 Set(self, long x, long y)
1089 Set both the x and y properties
1091 return _core_
.Point_Set(*args
, **kwargs
)
1093 def Get(*args
, **kwargs
):
1097 Return the x and y properties as a tuple.
1099 return _core_
.Point_Get(*args
, **kwargs
)
1101 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1102 def __str__(self
): return str(self
.Get())
1103 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1104 def __len__(self
): return len(self
.Get())
1105 def __getitem__(self
, index
): return self
.Get()[index
]
1106 def __setitem__(self
, index
, val
):
1107 if index
== 0: self
.x
= val
1108 elif index
== 1: self
.y
= val
1109 else: raise IndexError
1110 def __nonzero__(self
): return self
.Get() != (0,0)
1111 __safe_for_unpickling__
= True
1112 def __reduce__(self
): return (wx
.Point
, self
.Get())
1114 _core_
.Point_swigregister(Point
)
1116 #---------------------------------------------------------------------------
1120 A class for representing and manipulating rectangles. It has x, y,
1121 width and height properties. In wxPython most palces that expect a
1122 wx.Rect can also accept a (x,y,width,height) tuple.
1124 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1125 __repr__
= _swig_repr
1126 def __init__(self
, *args
, **kwargs
):
1128 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1130 Create a new Rect object.
1132 _core_
.Rect_swiginit(self
,_core_
.new_Rect(*args
, **kwargs
))
1133 __swig_destroy__
= _core_
.delete_Rect
1134 __del__
= lambda self
: None;
1135 def GetX(*args
, **kwargs
):
1136 """GetX(self) -> int"""
1137 return _core_
.Rect_GetX(*args
, **kwargs
)
1139 def SetX(*args
, **kwargs
):
1140 """SetX(self, int x)"""
1141 return _core_
.Rect_SetX(*args
, **kwargs
)
1143 def GetY(*args
, **kwargs
):
1144 """GetY(self) -> int"""
1145 return _core_
.Rect_GetY(*args
, **kwargs
)
1147 def SetY(*args
, **kwargs
):
1148 """SetY(self, int y)"""
1149 return _core_
.Rect_SetY(*args
, **kwargs
)
1151 def GetWidth(*args
, **kwargs
):
1152 """GetWidth(self) -> int"""
1153 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1155 def SetWidth(*args
, **kwargs
):
1156 """SetWidth(self, int w)"""
1157 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1159 def GetHeight(*args
, **kwargs
):
1160 """GetHeight(self) -> int"""
1161 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1163 def SetHeight(*args
, **kwargs
):
1164 """SetHeight(self, int h)"""
1165 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1167 def GetPosition(*args
, **kwargs
):
1168 """GetPosition(self) -> Point"""
1169 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1171 def SetPosition(*args
, **kwargs
):
1172 """SetPosition(self, Point p)"""
1173 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1175 def GetSize(*args
, **kwargs
):
1176 """GetSize(self) -> Size"""
1177 return _core_
.Rect_GetSize(*args
, **kwargs
)
1179 def SetSize(*args
, **kwargs
):
1180 """SetSize(self, Size s)"""
1181 return _core_
.Rect_SetSize(*args
, **kwargs
)
1183 def IsEmpty(*args
, **kwargs
):
1184 """IsEmpty(self) -> bool"""
1185 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1187 def GetTopLeft(*args
, **kwargs
):
1188 """GetTopLeft(self) -> Point"""
1189 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1191 def SetTopLeft(*args
, **kwargs
):
1192 """SetTopLeft(self, Point p)"""
1193 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1195 def GetBottomRight(*args
, **kwargs
):
1196 """GetBottomRight(self) -> Point"""
1197 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1199 def SetBottomRight(*args
, **kwargs
):
1200 """SetBottomRight(self, Point p)"""
1201 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1203 def GetTopRight(*args
, **kwargs
):
1204 """GetTopRight(self) -> Point"""
1205 return _core_
.Rect_GetTopRight(*args
, **kwargs
)
1207 def SetTopRight(*args
, **kwargs
):
1208 """SetTopRight(self, Point p)"""
1209 return _core_
.Rect_SetTopRight(*args
, **kwargs
)
1211 def GetBottomLeft(*args
, **kwargs
):
1212 """GetBottomLeft(self) -> Point"""
1213 return _core_
.Rect_GetBottomLeft(*args
, **kwargs
)
1215 def SetBottomLeft(*args
, **kwargs
):
1216 """SetBottomLeft(self, Point p)"""
1217 return _core_
.Rect_SetBottomLeft(*args
, **kwargs
)
1219 def GetLeft(*args
, **kwargs
):
1220 """GetLeft(self) -> int"""
1221 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1223 def GetTop(*args
, **kwargs
):
1224 """GetTop(self) -> int"""
1225 return _core_
.Rect_GetTop(*args
, **kwargs
)
1227 def GetBottom(*args
, **kwargs
):
1228 """GetBottom(self) -> int"""
1229 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1231 def GetRight(*args
, **kwargs
):
1232 """GetRight(self) -> int"""
1233 return _core_
.Rect_GetRight(*args
, **kwargs
)
1235 def SetLeft(*args
, **kwargs
):
1236 """SetLeft(self, int left)"""
1237 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1239 def SetRight(*args
, **kwargs
):
1240 """SetRight(self, int right)"""
1241 return _core_
.Rect_SetRight(*args
, **kwargs
)
1243 def SetTop(*args
, **kwargs
):
1244 """SetTop(self, int top)"""
1245 return _core_
.Rect_SetTop(*args
, **kwargs
)
1247 def SetBottom(*args
, **kwargs
):
1248 """SetBottom(self, int bottom)"""
1249 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1251 position
= property(GetPosition
, SetPosition
)
1252 size
= property(GetSize
, SetSize
)
1253 left
= property(GetLeft
, SetLeft
)
1254 right
= property(GetRight
, SetRight
)
1255 top
= property(GetTop
, SetTop
)
1256 bottom
= property(GetBottom
, SetBottom
)
1258 def Inflate(*args
, **kwargs
):
1260 Inflate(self, int dx, int dy) -> Rect
1262 Increases the size of the rectangle.
1264 The left border is moved farther left and the right border is moved
1265 farther right by ``dx``. The upper border is moved farther up and the
1266 bottom border is moved farther down by ``dy``. (Note the the width and
1267 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1268 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1269 opposite happens: the rectangle size decreases in the respective
1272 The change is made to the rectangle inplace, if instead you need a
1273 copy that is inflated, preserving the original then make the copy
1276 copy = wx.Rect(*original)
1281 return _core_
.Rect_Inflate(*args
, **kwargs
)
1283 def Deflate(*args
, **kwargs
):
1285 Deflate(self, int dx, int dy) -> Rect
1287 Decrease the rectangle size. This method is the opposite of `Inflate`
1288 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1289 `Inflate` for a full description.
1291 return _core_
.Rect_Deflate(*args
, **kwargs
)
1293 def OffsetXY(*args
, **kwargs
):
1295 OffsetXY(self, int dx, int dy)
1297 Moves the rectangle by the specified offset. If dx is positive, the
1298 rectangle is moved to the right, if dy is positive, it is moved to the
1299 bottom, otherwise it is moved to the left or top respectively.
1301 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1303 def Offset(*args
, **kwargs
):
1305 Offset(self, Point pt)
1307 Same as `OffsetXY` but uses dx,dy from Point
1309 return _core_
.Rect_Offset(*args
, **kwargs
)
1311 def Intersect(*args
, **kwargs
):
1313 Intersect(self, Rect rect) -> Rect
1315 Returns the intersectsion of this rectangle and rect.
1317 return _core_
.Rect_Intersect(*args
, **kwargs
)
1319 def Union(*args
, **kwargs
):
1321 Union(self, Rect rect) -> Rect
1323 Returns the union of this rectangle and rect.
1325 return _core_
.Rect_Union(*args
, **kwargs
)
1327 def __add__(*args
, **kwargs
):
1329 __add__(self, Rect rect) -> Rect
1331 Add the properties of rect to this rectangle and return the result.
1333 return _core_
.Rect___add__(*args
, **kwargs
)
1335 def __iadd__(*args
, **kwargs
):
1337 __iadd__(self, Rect rect) -> Rect
1339 Add the properties of rect to this rectangle, updating this rectangle.
1341 return _core_
.Rect___iadd__(*args
, **kwargs
)
1343 def __eq__(*args
, **kwargs
):
1345 __eq__(self, PyObject other) -> bool
1347 Test for equality of wx.Rect objects.
1349 return _core_
.Rect___eq__(*args
, **kwargs
)
1351 def __ne__(*args
, **kwargs
):
1353 __ne__(self, PyObject other) -> bool
1355 Test for inequality of wx.Rect objects.
1357 return _core_
.Rect___ne__(*args
, **kwargs
)
1359 def ContainsXY(*args
, **kwargs
):
1361 ContainsXY(self, int x, int y) -> bool
1363 Return True if the point is inside the rect.
1365 return _core_
.Rect_ContainsXY(*args
, **kwargs
)
1367 def Contains(*args
, **kwargs
):
1369 Contains(self, Point pt) -> bool
1371 Return True if the point is inside the rect.
1373 return _core_
.Rect_Contains(*args
, **kwargs
)
1375 def ContainsRect(*args
, **kwargs
):
1377 ContainsRect(self, Rect rect) -> bool
1379 Returns ``True`` if the given rectangle is completely inside this
1380 rectangle or touches its boundary.
1382 return _core_
.Rect_ContainsRect(*args
, **kwargs
)
1384 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1385 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1386 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1388 InsideXY
= ContainsXY
1389 InsideRect
= ContainsRect
1391 def Intersects(*args
, **kwargs
):
1393 Intersects(self, Rect rect) -> bool
1395 Returns True if the rectangles have a non empty intersection.
1397 return _core_
.Rect_Intersects(*args
, **kwargs
)
1399 def CenterIn(*args
, **kwargs
):
1401 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1403 Center this rectangle within the one passed to the method, which is
1404 usually, but not necessarily, the larger one.
1406 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1409 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1410 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1411 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1412 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1413 def Set(*args
, **kwargs
):
1415 Set(self, int x=0, int y=0, int width=0, int height=0)
1417 Set all rectangle properties.
1419 return _core_
.Rect_Set(*args
, **kwargs
)
1421 def Get(*args
, **kwargs
):
1423 Get() -> (x,y,width,height)
1425 Return the rectangle properties as a tuple.
1427 return _core_
.Rect_Get(*args
, **kwargs
)
1429 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1430 def __str__(self
): return str(self
.Get())
1431 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1432 def __len__(self
): return len(self
.Get())
1433 def __getitem__(self
, index
): return self
.Get()[index
]
1434 def __setitem__(self
, index
, val
):
1435 if index
== 0: self
.x
= val
1436 elif index
== 1: self
.y
= val
1437 elif index
== 2: self
.width
= val
1438 elif index
== 3: self
.height
= val
1439 else: raise IndexError
1440 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1441 __safe_for_unpickling__
= True
1442 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1444 Bottom
= property(GetBottom
,SetBottom
,doc
="See `GetBottom` and `SetBottom`")
1445 BottomRight
= property(GetBottomRight
,SetBottomRight
,doc
="See `GetBottomRight` and `SetBottomRight`")
1446 BottomLeft
= property(GetBottomLeft
,SetBottomLeft
,doc
="See `GetBottomLeft` and `SetBottomLeft`")
1447 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1448 Left
= property(GetLeft
,SetLeft
,doc
="See `GetLeft` and `SetLeft`")
1449 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
1450 Right
= property(GetRight
,SetRight
,doc
="See `GetRight` and `SetRight`")
1451 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
1452 Top
= property(GetTop
,SetTop
,doc
="See `GetTop` and `SetTop`")
1453 TopLeft
= property(GetTopLeft
,SetTopLeft
,doc
="See `GetTopLeft` and `SetTopLeft`")
1454 TopRight
= property(GetTopRight
,SetTopRight
,doc
="See `GetTopRight` and `SetTopRight`")
1455 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1456 X
= property(GetX
,SetX
,doc
="See `GetX` and `SetX`")
1457 Y
= property(GetY
,SetY
,doc
="See `GetY` and `SetY`")
1458 Empty
= property(IsEmpty
,doc
="See `IsEmpty`")
1459 _core_
.Rect_swigregister(Rect
)
1461 def RectPP(*args
, **kwargs
):
1463 RectPP(Point topLeft, Point bottomRight) -> Rect
1465 Create a new Rect object from Points representing two corners.
1467 val
= _core_
.new_RectPP(*args
, **kwargs
)
1470 def RectPS(*args
, **kwargs
):
1472 RectPS(Point pos, Size size) -> Rect
1474 Create a new Rect from a position and size.
1476 val
= _core_
.new_RectPS(*args
, **kwargs
)
1479 def RectS(*args
, **kwargs
):
1481 RectS(Size size) -> Rect
1483 Create a new Rect from a size only.
1485 val
= _core_
.new_RectS(*args
, **kwargs
)
1489 def IntersectRect(*args
, **kwargs
):
1491 IntersectRect(Rect r1, Rect r2) -> Rect
1493 Calculate and return the intersection of r1 and r2.
1495 return _core_
.IntersectRect(*args
, **kwargs
)
1496 #---------------------------------------------------------------------------
1498 class Point2D(object):
1500 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1501 with floating point values.
1503 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1504 __repr__
= _swig_repr
1505 def __init__(self
, *args
, **kwargs
):
1507 __init__(self, double x=0.0, double y=0.0) -> Point2D
1509 Create a w.Point2D object.
1511 _core_
.Point2D_swiginit(self
,_core_
.new_Point2D(*args
, **kwargs
))
1512 __swig_destroy__
= _core_
.delete_Point2D
1513 __del__
= lambda self
: None;
1514 def GetFloor(*args
, **kwargs
):
1520 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1522 def GetRounded(*args
, **kwargs
):
1524 GetRounded() -> (x,y)
1528 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1530 def GetVectorLength(*args
, **kwargs
):
1531 """GetVectorLength(self) -> double"""
1532 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1534 def GetVectorAngle(*args
, **kwargs
):
1535 """GetVectorAngle(self) -> double"""
1536 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1538 def SetVectorLength(*args
, **kwargs
):
1539 """SetVectorLength(self, double length)"""
1540 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1542 def SetVectorAngle(*args
, **kwargs
):
1543 """SetVectorAngle(self, double degrees)"""
1544 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1546 def SetPolarCoordinates(self
, angle
, length
):
1547 self
.SetVectorLength(length
)
1548 self
.SetVectorAngle(angle
)
1549 def Normalize(self
):
1550 self
.SetVectorLength(1.0)
1552 def GetDistance(*args
, **kwargs
):
1553 """GetDistance(self, Point2D pt) -> double"""
1554 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1556 def GetDistanceSquare(*args
, **kwargs
):
1557 """GetDistanceSquare(self, Point2D pt) -> double"""
1558 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1560 def GetDotProduct(*args
, **kwargs
):
1561 """GetDotProduct(self, Point2D vec) -> double"""
1562 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1564 def GetCrossProduct(*args
, **kwargs
):
1565 """GetCrossProduct(self, Point2D vec) -> double"""
1566 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1568 def __neg__(*args
, **kwargs
):
1570 __neg__(self) -> Point2D
1572 the reflection of this point
1574 return _core_
.Point2D___neg__(*args
, **kwargs
)
1576 def __iadd__(*args
, **kwargs
):
1577 """__iadd__(self, Point2D pt) -> Point2D"""
1578 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1580 def __isub__(*args
, **kwargs
):
1581 """__isub__(self, Point2D pt) -> Point2D"""
1582 return _core_
.Point2D___isub__(*args
, **kwargs
)
1584 def __imul__(*args
, **kwargs
):
1585 """__imul__(self, Point2D pt) -> Point2D"""
1586 return _core_
.Point2D___imul__(*args
, **kwargs
)
1588 def __idiv__(*args
, **kwargs
):
1589 """__idiv__(self, Point2D pt) -> Point2D"""
1590 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1592 def __eq__(*args
, **kwargs
):
1594 __eq__(self, PyObject other) -> bool
1596 Test for equality of wx.Point2D objects.
1598 return _core_
.Point2D___eq__(*args
, **kwargs
)
1600 def __ne__(*args
, **kwargs
):
1602 __ne__(self, PyObject other) -> bool
1604 Test for inequality of wx.Point2D objects.
1606 return _core_
.Point2D___ne__(*args
, **kwargs
)
1608 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1609 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1610 def Set(*args
, **kwargs
):
1611 """Set(self, double x=0, double y=0)"""
1612 return _core_
.Point2D_Set(*args
, **kwargs
)
1614 def Get(*args
, **kwargs
):
1618 Return x and y properties as a tuple.
1620 return _core_
.Point2D_Get(*args
, **kwargs
)
1622 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1623 def __str__(self
): return str(self
.Get())
1624 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1625 def __len__(self
): return len(self
.Get())
1626 def __getitem__(self
, index
): return self
.Get()[index
]
1627 def __setitem__(self
, index
, val
):
1628 if index
== 0: self
.x
= val
1629 elif index
== 1: self
.y
= val
1630 else: raise IndexError
1631 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1632 __safe_for_unpickling__
= True
1633 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1635 Floor
= property(GetFloor
,doc
="See `GetFloor`")
1636 Rounded
= property(GetRounded
,doc
="See `GetRounded`")
1637 VectorAngle
= property(GetVectorAngle
,SetVectorAngle
,doc
="See `GetVectorAngle` and `SetVectorAngle`")
1638 VectorLength
= property(GetVectorLength
,SetVectorLength
,doc
="See `GetVectorLength` and `SetVectorLength`")
1639 _core_
.Point2D_swigregister(Point2D
)
1641 def Point2DCopy(*args
, **kwargs
):
1643 Point2DCopy(Point2D pt) -> Point2D
1645 Create a w.Point2D object.
1647 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1650 def Point2DFromPoint(*args
, **kwargs
):
1652 Point2DFromPoint(Point pt) -> Point2D
1654 Create a w.Point2D object.
1656 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1659 #---------------------------------------------------------------------------
1661 Inside
= _core_
.Inside
1662 OutLeft
= _core_
.OutLeft
1663 OutRight
= _core_
.OutRight
1664 OutTop
= _core_
.OutTop
1665 OutBottom
= _core_
.OutBottom
1666 class Rect2D(object):
1668 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1669 with floating point component values.
1671 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1672 __repr__
= _swig_repr
1673 def __init__(self
, *args
, **kwargs
):
1675 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1677 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1678 with floating point component values.
1680 _core_
.Rect2D_swiginit(self
,_core_
.new_Rect2D(*args
, **kwargs
))
1681 __swig_destroy__
= _core_
.delete_Rect2D
1682 __del__
= lambda self
: None;
1683 def GetPosition(*args
, **kwargs
):
1684 """GetPosition(self) -> Point2D"""
1685 return _core_
.Rect2D_GetPosition(*args
, **kwargs
)
1687 def GetSize(*args
, **kwargs
):
1688 """GetSize(self) -> Size"""
1689 return _core_
.Rect2D_GetSize(*args
, **kwargs
)
1691 def GetLeft(*args
, **kwargs
):
1692 """GetLeft(self) -> wxDouble"""
1693 return _core_
.Rect2D_GetLeft(*args
, **kwargs
)
1695 def SetLeft(*args
, **kwargs
):
1696 """SetLeft(self, wxDouble n)"""
1697 return _core_
.Rect2D_SetLeft(*args
, **kwargs
)
1699 def MoveLeftTo(*args
, **kwargs
):
1700 """MoveLeftTo(self, wxDouble n)"""
1701 return _core_
.Rect2D_MoveLeftTo(*args
, **kwargs
)
1703 def GetTop(*args
, **kwargs
):
1704 """GetTop(self) -> wxDouble"""
1705 return _core_
.Rect2D_GetTop(*args
, **kwargs
)
1707 def SetTop(*args
, **kwargs
):
1708 """SetTop(self, wxDouble n)"""
1709 return _core_
.Rect2D_SetTop(*args
, **kwargs
)
1711 def MoveTopTo(*args
, **kwargs
):
1712 """MoveTopTo(self, wxDouble n)"""
1713 return _core_
.Rect2D_MoveTopTo(*args
, **kwargs
)
1715 def GetBottom(*args
, **kwargs
):
1716 """GetBottom(self) -> wxDouble"""
1717 return _core_
.Rect2D_GetBottom(*args
, **kwargs
)
1719 def SetBottom(*args
, **kwargs
):
1720 """SetBottom(self, wxDouble n)"""
1721 return _core_
.Rect2D_SetBottom(*args
, **kwargs
)
1723 def MoveBottomTo(*args
, **kwargs
):
1724 """MoveBottomTo(self, wxDouble n)"""
1725 return _core_
.Rect2D_MoveBottomTo(*args
, **kwargs
)
1727 def GetRight(*args
, **kwargs
):
1728 """GetRight(self) -> wxDouble"""
1729 return _core_
.Rect2D_GetRight(*args
, **kwargs
)
1731 def SetRight(*args
, **kwargs
):
1732 """SetRight(self, wxDouble n)"""
1733 return _core_
.Rect2D_SetRight(*args
, **kwargs
)
1735 def MoveRightTo(*args
, **kwargs
):
1736 """MoveRightTo(self, wxDouble n)"""
1737 return _core_
.Rect2D_MoveRightTo(*args
, **kwargs
)
1739 def GetLeftTop(*args
, **kwargs
):
1740 """GetLeftTop(self) -> Point2D"""
1741 return _core_
.Rect2D_GetLeftTop(*args
, **kwargs
)
1743 def SetLeftTop(*args
, **kwargs
):
1744 """SetLeftTop(self, Point2D pt)"""
1745 return _core_
.Rect2D_SetLeftTop(*args
, **kwargs
)
1747 def MoveLeftTopTo(*args
, **kwargs
):
1748 """MoveLeftTopTo(self, Point2D pt)"""
1749 return _core_
.Rect2D_MoveLeftTopTo(*args
, **kwargs
)
1751 def GetLeftBottom(*args
, **kwargs
):
1752 """GetLeftBottom(self) -> Point2D"""
1753 return _core_
.Rect2D_GetLeftBottom(*args
, **kwargs
)
1755 def SetLeftBottom(*args
, **kwargs
):
1756 """SetLeftBottom(self, Point2D pt)"""
1757 return _core_
.Rect2D_SetLeftBottom(*args
, **kwargs
)
1759 def MoveLeftBottomTo(*args
, **kwargs
):
1760 """MoveLeftBottomTo(self, Point2D pt)"""
1761 return _core_
.Rect2D_MoveLeftBottomTo(*args
, **kwargs
)
1763 def GetRightTop(*args
, **kwargs
):
1764 """GetRightTop(self) -> Point2D"""
1765 return _core_
.Rect2D_GetRightTop(*args
, **kwargs
)
1767 def SetRightTop(*args
, **kwargs
):
1768 """SetRightTop(self, Point2D pt)"""
1769 return _core_
.Rect2D_SetRightTop(*args
, **kwargs
)
1771 def MoveRightTopTo(*args
, **kwargs
):
1772 """MoveRightTopTo(self, Point2D pt)"""
1773 return _core_
.Rect2D_MoveRightTopTo(*args
, **kwargs
)
1775 def GetRightBottom(*args
, **kwargs
):
1776 """GetRightBottom(self) -> Point2D"""
1777 return _core_
.Rect2D_GetRightBottom(*args
, **kwargs
)
1779 def SetRightBottom(*args
, **kwargs
):
1780 """SetRightBottom(self, Point2D pt)"""
1781 return _core_
.Rect2D_SetRightBottom(*args
, **kwargs
)
1783 def MoveRightBottomTo(*args
, **kwargs
):
1784 """MoveRightBottomTo(self, Point2D pt)"""
1785 return _core_
.Rect2D_MoveRightBottomTo(*args
, **kwargs
)
1787 def GetCentre(*args
, **kwargs
):
1788 """GetCentre(self) -> Point2D"""
1789 return _core_
.Rect2D_GetCentre(*args
, **kwargs
)
1791 def SetCentre(*args
, **kwargs
):
1792 """SetCentre(self, Point2D pt)"""
1793 return _core_
.Rect2D_SetCentre(*args
, **kwargs
)
1795 def MoveCentreTo(*args
, **kwargs
):
1796 """MoveCentreTo(self, Point2D pt)"""
1797 return _core_
.Rect2D_MoveCentreTo(*args
, **kwargs
)
1799 def GetOutcode(*args
, **kwargs
):
1800 """GetOutcode(self, Point2D pt) -> int"""
1801 return _core_
.Rect2D_GetOutcode(*args
, **kwargs
)
1803 def Contains(*args
, **kwargs
):
1804 """Contains(self, Point2D pt) -> bool"""
1805 return _core_
.Rect2D_Contains(*args
, **kwargs
)
1807 def ContainsRect(*args
, **kwargs
):
1808 """ContainsRect(self, Rect2D rect) -> bool"""
1809 return _core_
.Rect2D_ContainsRect(*args
, **kwargs
)
1811 def IsEmpty(*args
, **kwargs
):
1812 """IsEmpty(self) -> bool"""
1813 return _core_
.Rect2D_IsEmpty(*args
, **kwargs
)
1815 def HaveEqualSize(*args
, **kwargs
):
1816 """HaveEqualSize(self, Rect2D rect) -> bool"""
1817 return _core_
.Rect2D_HaveEqualSize(*args
, **kwargs
)
1821 Inset(self, wxDouble x, wxDouble y)
1822 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1824 return _core_
.Rect2D_Inset(*args
)
1826 def Offset(*args
, **kwargs
):
1827 """Offset(self, Point2D pt)"""
1828 return _core_
.Rect2D_Offset(*args
, **kwargs
)
1830 def ConstrainTo(*args
, **kwargs
):
1831 """ConstrainTo(self, Rect2D rect)"""
1832 return _core_
.Rect2D_ConstrainTo(*args
, **kwargs
)
1834 def Interpolate(*args
, **kwargs
):
1835 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1836 return _core_
.Rect2D_Interpolate(*args
, **kwargs
)
1838 def Intersect(*args
, **kwargs
):
1839 """Intersect(self, Rect2D otherRect)"""
1840 return _core_
.Rect2D_Intersect(*args
, **kwargs
)
1842 def CreateIntersection(*args
, **kwargs
):
1843 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1844 return _core_
.Rect2D_CreateIntersection(*args
, **kwargs
)
1846 def Intersects(*args
, **kwargs
):
1847 """Intersects(self, Rect2D rect) -> bool"""
1848 return _core_
.Rect2D_Intersects(*args
, **kwargs
)
1850 def Union(*args
, **kwargs
):
1851 """Union(self, Rect2D otherRect)"""
1852 return _core_
.Rect2D_Union(*args
, **kwargs
)
1854 def CreateUnion(*args
, **kwargs
):
1855 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1856 return _core_
.Rect2D_CreateUnion(*args
, **kwargs
)
1860 Scale(self, wxDouble f)
1861 Scale(self, int num, int denum)
1863 return _core_
.Rect2D_Scale(*args
)
1865 def __eq__(*args
, **kwargs
):
1867 __eq__(self, PyObject other) -> bool
1869 Test for equality of wx.Rect2D objects.
1871 return _core_
.Rect2D___eq__(*args
, **kwargs
)
1873 def __ne__(*args
, **kwargs
):
1875 __ne__(self, PyObject other) -> bool
1877 Test for inequality of wx.Rect2D objects.
1879 return _core_
.Rect2D___ne__(*args
, **kwargs
)
1881 x
= property(_core_
.Rect2D_x_get
, _core_
.Rect2D_x_set
)
1882 y
= property(_core_
.Rect2D_y_get
, _core_
.Rect2D_y_set
)
1883 width
= property(_core_
.Rect2D_width_get
, _core_
.Rect2D_width_set
)
1884 height
= property(_core_
.Rect2D_height_get
, _core_
.Rect2D_height_set
)
1885 def Set(*args
, **kwargs
):
1886 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1887 return _core_
.Rect2D_Set(*args
, **kwargs
)
1889 def Get(*args
, **kwargs
):
1891 Get() -> (x,y, width, height)
1893 Return x, y, width and height y properties as a tuple.
1895 return _core_
.Rect2D_Get(*args
, **kwargs
)
1897 def __str__(self
): return str(self
.Get())
1898 def __repr__(self
): return 'wx.Rect2D'+str(self
.Get())
1899 def __len__(self
): return len(self
.Get())
1900 def __getitem__(self
, index
): return self
.Get()[index
]
1901 def __setitem__(self
, index
, val
):
1902 if index
== 0: self
.x
= val
1903 elif index
== 1: self
.y
= val
1904 elif index
== 2: self
.width
= val
1905 elif index
== 3: self
.height
= val
1906 else: raise IndexError
1907 def __nonzero__(self
): return self
.Get() != (0.0, 0.0, 0.0, 0.0)
1908 __safe_for_unpickling__
= True
1909 def __reduce__(self
): return (wx
.Rect2D
, self
.Get())
1911 _core_
.Rect2D_swigregister(Rect2D
)
1913 class Position(object):
1914 """Proxy of C++ Position class"""
1915 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1916 __repr__
= _swig_repr
1917 def __init__(self
, *args
, **kwargs
):
1918 """__init__(self, int row=0, int col=0) -> Position"""
1919 _core_
.Position_swiginit(self
,_core_
.new_Position(*args
, **kwargs
))
1920 __swig_destroy__
= _core_
.delete_Position
1921 __del__
= lambda self
: None;
1922 def GetRow(*args
, **kwargs
):
1923 """GetRow(self) -> int"""
1924 return _core_
.Position_GetRow(*args
, **kwargs
)
1926 def GetColumn(*args
, **kwargs
):
1927 """GetColumn(self) -> int"""
1928 return _core_
.Position_GetColumn(*args
, **kwargs
)
1930 def GetCol(*args
, **kwargs
):
1931 """GetCol(self) -> int"""
1932 return _core_
.Position_GetCol(*args
, **kwargs
)
1934 def SetRow(*args
, **kwargs
):
1935 """SetRow(self, int row)"""
1936 return _core_
.Position_SetRow(*args
, **kwargs
)
1938 def SetColumn(*args
, **kwargs
):
1939 """SetColumn(self, int column)"""
1940 return _core_
.Position_SetColumn(*args
, **kwargs
)
1942 def SetCol(*args
, **kwargs
):
1943 """SetCol(self, int column)"""
1944 return _core_
.Position_SetCol(*args
, **kwargs
)
1946 def __eq__(*args
, **kwargs
):
1948 __eq__(self, PyObject other) -> bool
1950 Test for equality of wx.Position objects.
1952 return _core_
.Position___eq__(*args
, **kwargs
)
1954 def __ne__(*args
, **kwargs
):
1956 __ne__(self, PyObject other) -> bool
1958 Test for inequality of wx.Position objects.
1960 return _core_
.Position___ne__(*args
, **kwargs
)
1964 __add__(self, Position p) -> Position
1965 __add__(self, Size s) -> Position
1967 return _core_
.Position___add__(*args
)
1971 __sub__(self, Position p) -> Position
1972 __sub__(self, Size s) -> Position
1974 return _core_
.Position___sub__(*args
)
1976 row
= property(GetRow
,SetRow
)
1977 col
= property(GetCol
,SetCol
)
1978 _core_
.Position_swigregister(Position
)
1980 #---------------------------------------------------------------------------
1982 FromStart
= _core_
.FromStart
1983 FromCurrent
= _core_
.FromCurrent
1984 FromEnd
= _core_
.FromEnd
1985 class InputStream(object):
1986 """Proxy of C++ InputStream class"""
1987 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1988 __repr__
= _swig_repr
1989 def __init__(self
, *args
, **kwargs
):
1990 """__init__(self, PyObject p) -> InputStream"""
1991 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1992 __swig_destroy__
= _core_
.delete_InputStream
1993 __del__
= lambda self
: None;
1994 def close(*args
, **kwargs
):
1996 return _core_
.InputStream_close(*args
, **kwargs
)
1998 def flush(*args
, **kwargs
):
2000 return _core_
.InputStream_flush(*args
, **kwargs
)
2002 def eof(*args
, **kwargs
):
2003 """eof(self) -> bool"""
2004 return _core_
.InputStream_eof(*args
, **kwargs
)
2006 def read(*args
, **kwargs
):
2007 """read(self, int size=-1) -> PyObject"""
2008 return _core_
.InputStream_read(*args
, **kwargs
)
2010 def readline(*args
, **kwargs
):
2011 """readline(self, int size=-1) -> PyObject"""
2012 return _core_
.InputStream_readline(*args
, **kwargs
)
2014 def readlines(*args
, **kwargs
):
2015 """readlines(self, int sizehint=-1) -> PyObject"""
2016 return _core_
.InputStream_readlines(*args
, **kwargs
)
2018 def seek(*args
, **kwargs
):
2019 """seek(self, int offset, int whence=0)"""
2020 return _core_
.InputStream_seek(*args
, **kwargs
)
2022 def tell(*args
, **kwargs
):
2023 """tell(self) -> int"""
2024 return _core_
.InputStream_tell(*args
, **kwargs
)
2026 def Peek(*args
, **kwargs
):
2027 """Peek(self) -> char"""
2028 return _core_
.InputStream_Peek(*args
, **kwargs
)
2030 def GetC(*args
, **kwargs
):
2031 """GetC(self) -> char"""
2032 return _core_
.InputStream_GetC(*args
, **kwargs
)
2034 def LastRead(*args
, **kwargs
):
2035 """LastRead(self) -> size_t"""
2036 return _core_
.InputStream_LastRead(*args
, **kwargs
)
2038 def CanRead(*args
, **kwargs
):
2039 """CanRead(self) -> bool"""
2040 return _core_
.InputStream_CanRead(*args
, **kwargs
)
2042 def Eof(*args
, **kwargs
):
2043 """Eof(self) -> bool"""
2044 return _core_
.InputStream_Eof(*args
, **kwargs
)
2046 def Ungetch(*args
, **kwargs
):
2047 """Ungetch(self, char c) -> bool"""
2048 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
2050 def SeekI(*args
, **kwargs
):
2051 """SeekI(self, long pos, int mode=FromStart) -> long"""
2052 return _core_
.InputStream_SeekI(*args
, **kwargs
)
2054 def TellI(*args
, **kwargs
):
2055 """TellI(self) -> long"""
2056 return _core_
.InputStream_TellI(*args
, **kwargs
)
2058 _core_
.InputStream_swigregister(InputStream
)
2059 DefaultPosition
= cvar
.DefaultPosition
2060 DefaultSize
= cvar
.DefaultSize
2062 class OutputStream(object):
2063 """Proxy of C++ OutputStream class"""
2064 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2065 def __init__(self
): raise AttributeError, "No constructor defined"
2066 __repr__
= _swig_repr
2067 def write(*args
, **kwargs
):
2068 """write(self, PyObject obj)"""
2069 return _core_
.OutputStream_write(*args
, **kwargs
)
2071 def LastWrite(*args
, **kwargs
):
2072 """LastWrite(self) -> size_t"""
2073 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
2075 _core_
.OutputStream_swigregister(OutputStream
)
2077 #---------------------------------------------------------------------------
2079 class FSFile(Object
):
2080 """Proxy of C++ FSFile class"""
2081 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2082 __repr__
= _swig_repr
2083 def __init__(self
, *args
, **kwargs
):
2085 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2086 DateTime modif) -> FSFile
2088 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
2089 __swig_destroy__
= _core_
.delete_FSFile
2090 __del__
= lambda self
: None;
2091 def GetStream(*args
, **kwargs
):
2092 """GetStream(self) -> InputStream"""
2093 return _core_
.FSFile_GetStream(*args
, **kwargs
)
2095 def DetachStream(*args
, **kwargs
):
2096 """DetachStream(self)"""
2097 return _core_
.FSFile_DetachStream(*args
, **kwargs
)
2099 def GetMimeType(*args
, **kwargs
):
2100 """GetMimeType(self) -> String"""
2101 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
2103 def GetLocation(*args
, **kwargs
):
2104 """GetLocation(self) -> String"""
2105 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
2107 def GetAnchor(*args
, **kwargs
):
2108 """GetAnchor(self) -> String"""
2109 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
2111 def GetModificationTime(*args
, **kwargs
):
2112 """GetModificationTime(self) -> DateTime"""
2113 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
2115 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2116 Location
= property(GetLocation
,doc
="See `GetLocation`")
2117 MimeType
= property(GetMimeType
,doc
="See `GetMimeType`")
2118 ModificationTime
= property(GetModificationTime
,doc
="See `GetModificationTime`")
2119 Stream
= property(GetStream
,doc
="See `GetStream`")
2120 _core_
.FSFile_swigregister(FSFile
)
2122 class CPPFileSystemHandler(object):
2123 """Proxy of C++ CPPFileSystemHandler class"""
2124 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2125 def __init__(self
): raise AttributeError, "No constructor defined"
2126 __repr__
= _swig_repr
2127 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
2128 __del__
= lambda self
: None;
2129 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
2131 class FileSystemHandler(CPPFileSystemHandler
):
2132 """Proxy of C++ FileSystemHandler class"""
2133 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2134 __repr__
= _swig_repr
2135 def __init__(self
, *args
, **kwargs
):
2136 """__init__(self) -> FileSystemHandler"""
2137 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
2138 FileSystemHandler
._setCallbackInfo
(self
, self
, FileSystemHandler
)
2140 def _setCallbackInfo(*args
, **kwargs
):
2141 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2142 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
2144 def CanOpen(*args
, **kwargs
):
2145 """CanOpen(self, String location) -> bool"""
2146 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
2148 def OpenFile(*args
, **kwargs
):
2149 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2150 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
2152 def FindFirst(*args
, **kwargs
):
2153 """FindFirst(self, String spec, int flags=0) -> String"""
2154 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
2156 def FindNext(*args
, **kwargs
):
2157 """FindNext(self) -> String"""
2158 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
2160 def GetProtocol(*args
, **kwargs
):
2161 """GetProtocol(self, String location) -> String"""
2162 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
2164 def GetLeftLocation(*args
, **kwargs
):
2165 """GetLeftLocation(self, String location) -> String"""
2166 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
2168 def GetAnchor(*args
, **kwargs
):
2169 """GetAnchor(self, String location) -> String"""
2170 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
2172 def GetRightLocation(*args
, **kwargs
):
2173 """GetRightLocation(self, String location) -> String"""
2174 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
2176 def GetMimeTypeFromExt(*args
, **kwargs
):
2177 """GetMimeTypeFromExt(self, String location) -> String"""
2178 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
2180 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2181 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
2182 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
2183 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
2184 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
2185 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
2187 class FileSystem(Object
):
2188 """Proxy of C++ FileSystem class"""
2189 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2190 __repr__
= _swig_repr
2191 def __init__(self
, *args
, **kwargs
):
2192 """__init__(self) -> FileSystem"""
2193 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
2194 __swig_destroy__
= _core_
.delete_FileSystem
2195 __del__
= lambda self
: None;
2196 def ChangePathTo(*args
, **kwargs
):
2197 """ChangePathTo(self, String location, bool is_dir=False)"""
2198 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
2200 def GetPath(*args
, **kwargs
):
2201 """GetPath(self) -> String"""
2202 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
2204 def OpenFile(*args
, **kwargs
):
2205 """OpenFile(self, String location) -> FSFile"""
2206 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
2208 def FindFirst(*args
, **kwargs
):
2209 """FindFirst(self, String spec, int flags=0) -> String"""
2210 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
2212 def FindNext(*args
, **kwargs
):
2213 """FindNext(self) -> String"""
2214 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
2216 def AddHandler(*args
, **kwargs
):
2217 """AddHandler(CPPFileSystemHandler handler)"""
2218 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2220 AddHandler
= staticmethod(AddHandler
)
2221 def RemoveHandler(*args
, **kwargs
):
2222 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2223 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2225 RemoveHandler
= staticmethod(RemoveHandler
)
2226 def CleanUpHandlers(*args
, **kwargs
):
2227 """CleanUpHandlers()"""
2228 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
2230 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
2231 def FileNameToURL(*args
, **kwargs
):
2232 """FileNameToURL(String filename) -> String"""
2233 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2235 FileNameToURL
= staticmethod(FileNameToURL
)
2236 def URLToFileName(*args
, **kwargs
):
2237 """URLToFileName(String url) -> String"""
2238 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2240 URLToFileName
= staticmethod(URLToFileName
)
2241 Path
= property(GetPath
,doc
="See `GetPath`")
2242 _core_
.FileSystem_swigregister(FileSystem
)
2244 def FileSystem_AddHandler(*args
, **kwargs
):
2245 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2246 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2248 def FileSystem_RemoveHandler(*args
, **kwargs
):
2249 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2250 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2252 def FileSystem_CleanUpHandlers(*args
):
2253 """FileSystem_CleanUpHandlers()"""
2254 return _core_
.FileSystem_CleanUpHandlers(*args
)
2256 def FileSystem_FileNameToURL(*args
, **kwargs
):
2257 """FileSystem_FileNameToURL(String filename) -> String"""
2258 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2260 def FileSystem_URLToFileName(*args
, **kwargs
):
2261 """FileSystem_URLToFileName(String url) -> String"""
2262 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2264 class InternetFSHandler(CPPFileSystemHandler
):
2265 """Proxy of C++ InternetFSHandler class"""
2266 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2267 __repr__
= _swig_repr
2268 def __init__(self
, *args
, **kwargs
):
2269 """__init__(self) -> InternetFSHandler"""
2270 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
2271 def CanOpen(*args
, **kwargs
):
2272 """CanOpen(self, String location) -> bool"""
2273 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
2275 def OpenFile(*args
, **kwargs
):
2276 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2277 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
2279 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
2281 class ZipFSHandler(CPPFileSystemHandler
):
2282 """Proxy of C++ ZipFSHandler class"""
2283 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2284 __repr__
= _swig_repr
2285 def __init__(self
, *args
, **kwargs
):
2286 """__init__(self) -> ZipFSHandler"""
2287 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
2288 def CanOpen(*args
, **kwargs
):
2289 """CanOpen(self, String location) -> bool"""
2290 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
2292 def OpenFile(*args
, **kwargs
):
2293 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2294 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
2296 def FindFirst(*args
, **kwargs
):
2297 """FindFirst(self, String spec, int flags=0) -> String"""
2298 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
2300 def FindNext(*args
, **kwargs
):
2301 """FindNext(self) -> String"""
2302 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
2304 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
2307 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
2308 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2309 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
2311 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
2312 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2313 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
2315 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
2316 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2317 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
2318 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
2320 Add 'file' to the memory filesystem. The dataItem parameter can
2321 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2322 arbitrary data. If a bitmap or image is used then the imgType
2323 parameter should specify what kind of image file it should be
2324 written as, wx.BITMAP_TYPE_PNG, etc.
2326 if isinstance(dataItem
, wx
.Image
):
2327 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
2328 elif isinstance(dataItem
, wx
.Bitmap
):
2329 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2330 elif type(dataItem
) == str:
2331 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2333 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2335 class MemoryFSHandler(CPPFileSystemHandler
):
2336 """Proxy of C++ MemoryFSHandler class"""
2337 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2338 __repr__
= _swig_repr
2339 def __init__(self
, *args
, **kwargs
):
2340 """__init__(self) -> MemoryFSHandler"""
2341 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
2342 def RemoveFile(*args
, **kwargs
):
2343 """RemoveFile(String filename)"""
2344 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2346 RemoveFile
= staticmethod(RemoveFile
)
2347 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2348 def CanOpen(*args
, **kwargs
):
2349 """CanOpen(self, String location) -> bool"""
2350 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2352 def OpenFile(*args
, **kwargs
):
2353 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2354 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2356 def FindFirst(*args
, **kwargs
):
2357 """FindFirst(self, String spec, int flags=0) -> String"""
2358 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2360 def FindNext(*args
, **kwargs
):
2361 """FindNext(self) -> String"""
2362 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2364 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2366 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2367 """MemoryFSHandler_RemoveFile(String filename)"""
2368 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2370 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2371 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2372 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2373 IMAGE_QUALITY_NORMAL
= _core_
.IMAGE_QUALITY_NORMAL
2374 IMAGE_QUALITY_HIGH
= _core_
.IMAGE_QUALITY_HIGH
2375 #---------------------------------------------------------------------------
2377 class ImageHandler(Object
):
2379 This is the base class for implementing image file loading/saving, and
2380 image creation from data. It is used within `wx.Image` and is not
2381 normally seen by the application.
2383 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2384 def __init__(self
): raise AttributeError, "No constructor defined"
2385 __repr__
= _swig_repr
2386 def GetName(*args
, **kwargs
):
2387 """GetName(self) -> String"""
2388 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2390 def GetExtension(*args
, **kwargs
):
2391 """GetExtension(self) -> String"""
2392 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2394 def GetType(*args
, **kwargs
):
2395 """GetType(self) -> long"""
2396 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2398 def GetMimeType(*args
, **kwargs
):
2399 """GetMimeType(self) -> String"""
2400 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2402 def CanRead(*args
, **kwargs
):
2403 """CanRead(self, String name) -> bool"""
2404 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2406 def CanReadStream(*args
, **kwargs
):
2407 """CanReadStream(self, InputStream stream) -> bool"""
2408 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2410 def SetName(*args
, **kwargs
):
2411 """SetName(self, String name)"""
2412 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2414 def SetExtension(*args
, **kwargs
):
2415 """SetExtension(self, String extension)"""
2416 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2418 def SetType(*args
, **kwargs
):
2419 """SetType(self, long type)"""
2420 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2422 def SetMimeType(*args
, **kwargs
):
2423 """SetMimeType(self, String mimetype)"""
2424 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2426 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2427 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2428 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2429 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2430 _core_
.ImageHandler_swigregister(ImageHandler
)
2432 class PyImageHandler(ImageHandler
):
2434 This is the base class for implementing image file loading/saving, and
2435 image creation from data, all written in Python. To create a custom
2436 image handler derive a new class from wx.PyImageHandler and provide
2437 the following methods::
2439 def DoCanRead(self, stream) --> bool
2440 '''Check if this handler can read the image on the stream'''
2442 def LoadFile(self, image, stream, verbose, index) --> bool
2443 '''Load image data from the stream and load it into image.'''
2445 def SaveFile(self, image, stream, verbose) --> bool
2446 '''Save the iamge data in image to the stream using
2447 this handler's image file format.'''
2449 def GetImageCount(self, stream) --> int
2450 '''If this image format can hold more than one image,
2451 how many does the image on the stream have?'''
2453 To activate your handler create an instance of it and pass it to
2454 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2455 `SetExtension` from your constructor.
2458 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2459 __repr__
= _swig_repr
2460 def __init__(self
, *args
, **kwargs
):
2462 __init__(self) -> PyImageHandler
2464 This is the base class for implementing image file loading/saving, and
2465 image creation from data, all written in Python. To create a custom
2466 image handler derive a new class from wx.PyImageHandler and provide
2467 the following methods::
2469 def DoCanRead(self, stream) --> bool
2470 '''Check if this handler can read the image on the stream'''
2472 def LoadFile(self, image, stream, verbose, index) --> bool
2473 '''Load image data from the stream and load it into image.'''
2475 def SaveFile(self, image, stream, verbose) --> bool
2476 '''Save the iamge data in image to the stream using
2477 this handler's image file format.'''
2479 def GetImageCount(self, stream) --> int
2480 '''If this image format can hold more than one image,
2481 how many does the image on the stream have?'''
2483 To activate your handler create an instance of it and pass it to
2484 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2485 `SetExtension` from your constructor.
2488 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2491 def _SetSelf(*args
, **kwargs
):
2492 """_SetSelf(self, PyObject self)"""
2493 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2495 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2497 class ImageHistogram(object):
2498 """Proxy of C++ ImageHistogram class"""
2499 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2500 __repr__
= _swig_repr
2501 def __init__(self
, *args
, **kwargs
):
2502 """__init__(self) -> ImageHistogram"""
2503 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2504 def MakeKey(*args
, **kwargs
):
2506 MakeKey(byte r, byte g, byte b) -> unsigned long
2508 Get the key in the histogram for the given RGB values
2510 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2512 MakeKey
= staticmethod(MakeKey
)
2513 def FindFirstUnusedColour(*args
, **kwargs
):
2515 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2517 Find first colour that is not used in the image and has higher RGB
2518 values than startR, startG, startB. Returns a tuple consisting of a
2519 success flag and rgb values.
2521 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2523 def GetCount(*args
, **kwargs
):
2525 GetCount(self, unsigned long key) -> unsigned long
2527 Returns the pixel count for the given key. Use `MakeKey` to create a
2528 key value from a RGB tripple.
2530 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2532 def GetCountRGB(*args
, **kwargs
):
2534 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2536 Returns the pixel count for the given RGB values.
2538 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2540 def GetCountColour(*args
, **kwargs
):
2542 GetCountColour(self, Colour colour) -> unsigned long
2544 Returns the pixel count for the given `wx.Colour` value.
2546 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2548 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2550 def ImageHistogram_MakeKey(*args
, **kwargs
):
2552 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2554 Get the key in the histogram for the given RGB values
2556 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2558 class Image_RGBValue(object):
2560 An object that contains values for red, green and blue which represent
2561 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2562 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2565 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2566 __repr__
= _swig_repr
2567 def __init__(self
, *args
, **kwargs
):
2569 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2573 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2574 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2575 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2576 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2577 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2579 class Image_HSVValue(object):
2581 An object that contains values for hue, saturation and value which
2582 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2583 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2586 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2587 __repr__
= _swig_repr
2588 def __init__(self
, *args
, **kwargs
):
2590 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2594 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2595 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2596 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2597 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2598 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2600 class Image(Object
):
2602 A platform-independent image class. An image can be created from
2603 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2604 variety of formats. Functions are available to set and get image
2605 bits, so it can be used for basic image manipulation.
2607 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2608 platform-specific `wx.Bitmap` object must be created from it using the
2609 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2610 device context, using `wx.DC.DrawBitmap`.
2612 One colour value of the image may be used as a mask colour which will
2613 lead to the automatic creation of a `wx.Mask` object associated to the
2616 wx.Image supports alpha channel data, that is in addition to a byte
2617 for the red, green and blue colour components for each pixel it also
2618 stores a byte representing the pixel opacity. An alpha value of 0
2619 corresponds to a transparent pixel (null opacity) while a value of 255
2620 means that the pixel is 100% opaque.
2622 Unlike RGB data, not all images have an alpha channel and before using
2623 `GetAlpha` you should check if this image contains an alpha channel
2624 with `HasAlpha`. Note that currently only images loaded from PNG files
2625 with transparency information will have an alpha channel.
2627 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2628 __repr__
= _swig_repr
2629 def __init__(self
, *args
, **kwargs
):
2631 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2633 Loads an image from a file.
2635 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2636 __swig_destroy__
= _core_
.delete_Image
2637 __del__
= lambda self
: None;
2638 def Create(*args
, **kwargs
):
2640 Create(self, int width, int height, bool clear=True)
2642 Creates a fresh image. If clear is ``True``, the new image will be
2643 initialized to black. Otherwise, the image data will be uninitialized.
2645 return _core_
.Image_Create(*args
, **kwargs
)
2647 def Destroy(*args
, **kwargs
):
2651 Destroys the image data.
2653 args
[0].this
.own(False)
2654 return _core_
.Image_Destroy(*args
, **kwargs
)
2656 def Scale(*args
, **kwargs
):
2658 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2660 Returns a scaled version of the image. This is also useful for scaling
2661 bitmaps in general as the only other way to scale bitmaps is to blit a
2662 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2663 specifies what method to use for resampling the image. It can be
2664 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2665 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2666 bicubic and box averaging resampling methods for upsampling and
2667 downsampling respectively.
2669 return _core_
.Image_Scale(*args
, **kwargs
)
2671 def ResampleBox(*args
, **kwargs
):
2672 """ResampleBox(self, int width, int height) -> Image"""
2673 return _core_
.Image_ResampleBox(*args
, **kwargs
)
2675 def ResampleBicubic(*args
, **kwargs
):
2676 """ResampleBicubic(self, int width, int height) -> Image"""
2677 return _core_
.Image_ResampleBicubic(*args
, **kwargs
)
2679 def Blur(*args
, **kwargs
):
2681 Blur(self, int radius) -> Image
2683 Blurs the image in both horizontal and vertical directions by the
2684 specified pixel ``radius``. This should not be used when using a
2685 single mask colour for transparency.
2687 return _core_
.Image_Blur(*args
, **kwargs
)
2689 def BlurHorizontal(*args
, **kwargs
):
2691 BlurHorizontal(self, int radius) -> Image
2693 Blurs the image in the horizontal direction only. This should not be
2694 used when using a single mask colour for transparency.
2697 return _core_
.Image_BlurHorizontal(*args
, **kwargs
)
2699 def BlurVertical(*args
, **kwargs
):
2701 BlurVertical(self, int radius) -> Image
2703 Blurs the image in the vertical direction only. This should not be
2704 used when using a single mask colour for transparency.
2706 return _core_
.Image_BlurVertical(*args
, **kwargs
)
2708 def ShrinkBy(*args
, **kwargs
):
2710 ShrinkBy(self, int xFactor, int yFactor) -> Image
2712 Return a version of the image scaled smaller by the given factors.
2714 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2716 def Rescale(*args
, **kwargs
):
2718 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2720 Changes the size of the image in-place by scaling it: after a call to
2721 this function, the image will have the given width and height.
2723 Returns the (modified) image itself.
2725 return _core_
.Image_Rescale(*args
, **kwargs
)
2727 def Resize(*args
, **kwargs
):
2729 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2731 Changes the size of the image in-place without scaling it, by adding
2732 either a border with the given colour or cropping as necessary. The
2733 image is pasted into a new image with the given size and background
2734 colour at the position pos relative to the upper left of the new
2735 image. If red = green = blue = -1 then use either the current mask
2736 colour if set or find, use, and set a suitable mask colour for any
2737 newly exposed areas.
2739 Returns the (modified) image itself.
2741 return _core_
.Image_Resize(*args
, **kwargs
)
2743 def SetRGB(*args
, **kwargs
):
2745 SetRGB(self, int x, int y, byte r, byte g, byte b)
2747 Sets the pixel at the given coordinate. This routine performs
2748 bounds-checks for the coordinate so it can be considered a safe way to
2749 manipulate the data, but in some cases this might be too slow so that
2750 the data will have to be set directly. In that case you will have to
2751 get access to the image data using the `GetData` method.
2753 return _core_
.Image_SetRGB(*args
, **kwargs
)
2755 def SetRGBRect(*args
, **kwargs
):
2757 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2759 Sets the colour of the pixels within the given rectangle. This routine
2760 performs bounds-checks for the rectangle so it can be considered a
2761 safe way to manipulate the data.
2763 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2765 def GetRed(*args
, **kwargs
):
2767 GetRed(self, int x, int y) -> byte
2769 Returns the red intensity at the given coordinate.
2771 return _core_
.Image_GetRed(*args
, **kwargs
)
2773 def GetGreen(*args
, **kwargs
):
2775 GetGreen(self, int x, int y) -> byte
2777 Returns the green intensity at the given coordinate.
2779 return _core_
.Image_GetGreen(*args
, **kwargs
)
2781 def GetBlue(*args
, **kwargs
):
2783 GetBlue(self, int x, int y) -> byte
2785 Returns the blue intensity at the given coordinate.
2787 return _core_
.Image_GetBlue(*args
, **kwargs
)
2789 def SetAlpha(*args
, **kwargs
):
2791 SetAlpha(self, int x, int y, byte alpha)
2793 Sets the alpha value for the given pixel. This function should only be
2794 called if the image has alpha channel data, use `HasAlpha` to check
2797 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2799 def GetAlpha(*args
, **kwargs
):
2801 GetAlpha(self, int x, int y) -> byte
2803 Returns the alpha value for the given pixel. This function may only be
2804 called for the images with alpha channel, use `HasAlpha` to check for
2807 The returned value is the *opacity* of the image, i.e. the value of 0
2808 corresponds to the fully transparent pixels while the value of 255 to
2809 the fully opaque pixels.
2811 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2813 def HasAlpha(*args
, **kwargs
):
2815 HasAlpha(self) -> bool
2817 Returns true if this image has alpha channel, false otherwise.
2819 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2821 def InitAlpha(*args
, **kwargs
):
2825 Initializes the image alpha channel data. It is an error to call it if
2826 the image already has alpha data. If it doesn't, alpha data will be by
2827 default initialized to all pixels being fully opaque. But if the image
2828 has a a mask colour, all mask pixels will be completely transparent.
2830 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2832 def IsTransparent(*args
, **kwargs
):
2834 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2836 Returns ``True`` if this pixel is masked or has an alpha value less
2837 than the spcified threshold.
2839 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2841 def FindFirstUnusedColour(*args
, **kwargs
):
2843 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2845 Find first colour that is not used in the image and has higher RGB
2846 values than startR, startG, startB. Returns a tuple consisting of a
2847 success flag and rgb values.
2849 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2851 def ConvertAlphaToMask(*args
, **kwargs
):
2853 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2855 If the image has alpha channel, this method converts it to mask. All
2856 pixels with alpha value less than ``threshold`` are replaced with the
2857 mask colour and the alpha channel is removed. The mask colour is
2858 chosen automatically using `FindFirstUnusedColour`.
2860 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2863 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2865 def ConvertColourToAlpha(*args
, **kwargs
):
2867 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2869 This method converts an image where the original alpha information is
2870 only available as a shades of a colour (actually shades of grey)
2871 typically when you draw anti-aliased text into a bitmap. The DC
2872 drawing routines draw grey values on the black background although
2873 they actually mean to draw white with differnt alpha values. This
2874 method reverses it, assuming a black (!) background and white text.
2875 The method will then fill up the whole image with the colour given.
2877 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2879 def SetMaskFromImage(*args
, **kwargs
):
2881 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2883 Sets the image's mask so that the pixels that have RGB value of
2884 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2885 by first finding an unused colour in the image, setting this colour as
2886 the mask colour and then using this colour to draw all pixels in the
2887 image who corresponding pixel in mask has given RGB value.
2889 Returns ``False`` if ``mask`` does not have same dimensions as the
2890 image or if there is no unused colour left. Returns ``True`` if the
2891 mask was successfully applied.
2893 Note that this method involves computing the histogram, which is
2894 computationally intensive operation.
2896 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2898 def CanRead(*args
, **kwargs
):
2900 CanRead(String filename) -> bool
2902 Returns True if the image handlers can read this file.
2904 return _core_
.Image_CanRead(*args
, **kwargs
)
2906 CanRead
= staticmethod(CanRead
)
2907 def GetImageCount(*args
, **kwargs
):
2909 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2911 If the image file contains more than one image and the image handler
2912 is capable of retrieving these individually, this function will return
2913 the number of available images.
2915 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2917 GetImageCount
= staticmethod(GetImageCount
)
2918 def LoadFile(*args
, **kwargs
):
2920 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2922 Loads an image from a file. If no handler type is provided, the
2923 library will try to autodetect the format.
2925 return _core_
.Image_LoadFile(*args
, **kwargs
)
2927 def LoadMimeFile(*args
, **kwargs
):
2929 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2931 Loads an image from a file, specifying the image type with a MIME type
2934 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2936 def SaveFile(*args
, **kwargs
):
2938 SaveFile(self, String name, int type) -> bool
2940 Saves an image in the named file.
2942 return _core_
.Image_SaveFile(*args
, **kwargs
)
2944 def SaveMimeFile(*args
, **kwargs
):
2946 SaveMimeFile(self, String name, String mimetype) -> bool
2948 Saves an image in the named file.
2950 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2952 def CanReadStream(*args
, **kwargs
):
2954 CanReadStream(InputStream stream) -> bool
2956 Returns True if the image handlers can read an image file from the
2957 data currently on the input stream, or a readable Python file-like
2960 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2962 CanReadStream
= staticmethod(CanReadStream
)
2963 def LoadStream(*args
, **kwargs
):
2965 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2967 Loads an image from an input stream or a readable Python file-like
2968 object. If no handler type is provided, the library will try to
2969 autodetect the format.
2971 return _core_
.Image_LoadStream(*args
, **kwargs
)
2973 def LoadMimeStream(*args
, **kwargs
):
2975 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2977 Loads an image from an input stream or a readable Python file-like
2978 object, using a MIME type string to specify the image file format.
2980 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2982 def IsOk(*args
, **kwargs
):
2986 Returns true if image data is present.
2988 return _core_
.Image_IsOk(*args
, **kwargs
)
2991 def GetWidth(*args
, **kwargs
):
2993 GetWidth(self) -> int
2995 Gets the width of the image in pixels.
2997 return _core_
.Image_GetWidth(*args
, **kwargs
)
2999 def GetHeight(*args
, **kwargs
):
3001 GetHeight(self) -> int
3003 Gets the height of the image in pixels.
3005 return _core_
.Image_GetHeight(*args
, **kwargs
)
3007 def GetSize(*args
, **kwargs
):
3009 GetSize(self) -> Size
3011 Returns the size of the image in pixels.
3013 return _core_
.Image_GetSize(*args
, **kwargs
)
3015 def GetSubImage(*args
, **kwargs
):
3017 GetSubImage(self, Rect rect) -> Image
3019 Returns a sub image of the current one as long as the rect belongs
3020 entirely to the image.
3022 return _core_
.Image_GetSubImage(*args
, **kwargs
)
3024 def Size(*args
, **kwargs
):
3026 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
3028 Returns a resized version of this image without scaling it by adding
3029 either a border with the given colour or cropping as necessary. The
3030 image is pasted into a new image with the given size and background
3031 colour at the position ``pos`` relative to the upper left of the new
3032 image. If red = green = blue = -1 then use either the current mask
3033 colour if set or find, use, and set a suitable mask colour for any
3034 newly exposed areas.
3036 return _core_
.Image_Size(*args
, **kwargs
)
3038 def Copy(*args
, **kwargs
):
3042 Returns an identical copy of the image.
3044 return _core_
.Image_Copy(*args
, **kwargs
)
3046 def Paste(*args
, **kwargs
):
3048 Paste(self, Image image, int x, int y)
3050 Pastes ``image`` into this instance and takes care of the mask colour
3051 and any out of bounds problems.
3053 return _core_
.Image_Paste(*args
, **kwargs
)
3055 def GetData(*args
, **kwargs
):
3057 GetData(self) -> PyObject
3059 Returns a string containing a copy of the RGB bytes of the image.
3061 return _core_
.Image_GetData(*args
, **kwargs
)
3063 def SetData(*args
, **kwargs
):
3065 SetData(self, buffer data)
3067 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3068 either a string or a buffer object holding the data and the length of
3069 the data must be width*height*3.
3071 return _core_
.Image_SetData(*args
, **kwargs
)
3073 def GetDataBuffer(*args
, **kwargs
):
3075 GetDataBuffer(self) -> PyObject
3077 Returns a writable Python buffer object that is pointing at the RGB
3078 image data buffer inside the wx.Image. You need to ensure that you do
3079 not use this buffer object after the image has been destroyed.
3081 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
3083 def SetDataBuffer(*args
, **kwargs
):
3085 SetDataBuffer(self, buffer data)
3087 Sets the internal image data pointer to point at a Python buffer
3088 object. This can save making an extra copy of the data but you must
3089 ensure that the buffer object lives longer than the wx.Image does.
3091 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
3093 def GetAlphaData(*args
, **kwargs
):
3095 GetAlphaData(self) -> PyObject
3097 Returns a string containing a copy of the alpha bytes of the image.
3099 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
3101 def SetAlphaData(*args
, **kwargs
):
3103 SetAlphaData(self, buffer alpha)
3105 Resets the Image's alpha data from a buffer of bytes. Accepts either
3106 a string or a buffer object holding the data and the length of the
3107 data must be width*height.
3109 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
3111 def GetAlphaBuffer(*args
, **kwargs
):
3113 GetAlphaBuffer(self) -> PyObject
3115 Returns a writable Python buffer object that is pointing at the Alpha
3116 data buffer inside the wx.Image. You need to ensure that you do not
3117 use this buffer object after the image has been destroyed.
3119 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
3121 def SetAlphaBuffer(*args
, **kwargs
):
3123 SetAlphaBuffer(self, buffer alpha)
3125 Sets the internal image alpha pointer to point at a Python buffer
3126 object. This can save making an extra copy of the data but you must
3127 ensure that the buffer object lives as long as the wx.Image does.
3129 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
3131 def SetMaskColour(*args
, **kwargs
):
3133 SetMaskColour(self, byte r, byte g, byte b)
3135 Sets the mask colour for this image (and tells the image to use the
3138 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
3140 def GetOrFindMaskColour(*args
, **kwargs
):
3142 GetOrFindMaskColour() -> (r,g,b)
3144 Get the current mask colour or find a suitable colour.
3146 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
3148 def GetMaskRed(*args
, **kwargs
):
3150 GetMaskRed(self) -> byte
3152 Gets the red component of the mask colour.
3154 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
3156 def GetMaskGreen(*args
, **kwargs
):
3158 GetMaskGreen(self) -> byte
3160 Gets the green component of the mask colour.
3162 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
3164 def GetMaskBlue(*args
, **kwargs
):
3166 GetMaskBlue(self) -> byte
3168 Gets the blue component of the mask colour.
3170 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
3172 def SetMask(*args
, **kwargs
):
3174 SetMask(self, bool mask=True)
3176 Specifies whether there is a mask or not. The area of the mask is
3177 determined by the current mask colour.
3179 return _core_
.Image_SetMask(*args
, **kwargs
)
3181 def HasMask(*args
, **kwargs
):
3183 HasMask(self) -> bool
3185 Returns ``True`` if there is a mask active, ``False`` otherwise.
3187 return _core_
.Image_HasMask(*args
, **kwargs
)
3189 def Rotate(*args
, **kwargs
):
3191 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3192 Point offset_after_rotation=None) -> Image
3194 Rotates the image about the given point, by ``angle`` radians. Passing
3195 ``True`` to ``interpolating`` results in better image quality, but is
3196 slower. If the image has a mask, then the mask colour is used for the
3197 uncovered pixels in the rotated image background. Otherwise, black
3198 will be used as the fill colour.
3200 Returns the rotated image, leaving this image intact.
3202 return _core_
.Image_Rotate(*args
, **kwargs
)
3204 def Rotate90(*args
, **kwargs
):
3206 Rotate90(self, bool clockwise=True) -> Image
3208 Returns a copy of the image rotated 90 degrees in the direction
3209 indicated by ``clockwise``.
3211 return _core_
.Image_Rotate90(*args
, **kwargs
)
3213 def Mirror(*args
, **kwargs
):
3215 Mirror(self, bool horizontally=True) -> Image
3217 Returns a mirrored copy of the image. The parameter ``horizontally``
3218 indicates the orientation.
3220 return _core_
.Image_Mirror(*args
, **kwargs
)
3222 def Replace(*args
, **kwargs
):
3224 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3226 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3229 return _core_
.Image_Replace(*args
, **kwargs
)
3231 def ConvertToGreyscale(*args
, **kwargs
):
3233 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3235 Convert to greyscale image. Uses the luminance component (Y) of the
3236 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3237 defaults to ITU-T BT.601
3239 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
3241 def ConvertToMono(*args
, **kwargs
):
3243 ConvertToMono(self, byte r, byte g, byte b) -> Image
3245 Returns monochromatic version of the image. The returned image has
3246 white colour where the original has ``(r,g,b)`` colour and black
3247 colour everywhere else.
3249 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
3251 def SetOption(*args
, **kwargs
):
3253 SetOption(self, String name, String value)
3255 Sets an image handler defined option. For example, when saving as a
3256 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3257 number between 0 and 100 (0 is terrible, 100 is very good).
3259 return _core_
.Image_SetOption(*args
, **kwargs
)
3261 def SetOptionInt(*args
, **kwargs
):
3263 SetOptionInt(self, String name, int value)
3265 Sets an image option as an integer.
3267 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
3269 def GetOption(*args
, **kwargs
):
3271 GetOption(self, String name) -> String
3273 Gets the value of an image handler option.
3275 return _core_
.Image_GetOption(*args
, **kwargs
)
3277 def GetOptionInt(*args
, **kwargs
):
3279 GetOptionInt(self, String name) -> int
3281 Gets the value of an image handler option as an integer. If the given
3282 option is not present, the function returns 0.
3284 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
3286 def HasOption(*args
, **kwargs
):
3288 HasOption(self, String name) -> bool
3290 Returns true if the given option is present.
3292 return _core_
.Image_HasOption(*args
, **kwargs
)
3294 def CountColours(*args
, **kwargs
):
3295 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3296 return _core_
.Image_CountColours(*args
, **kwargs
)
3298 def ComputeHistogram(*args
, **kwargs
):
3299 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3300 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
3302 def AddHandler(*args
, **kwargs
):
3303 """AddHandler(ImageHandler handler)"""
3304 return _core_
.Image_AddHandler(*args
, **kwargs
)
3306 AddHandler
= staticmethod(AddHandler
)
3307 def InsertHandler(*args
, **kwargs
):
3308 """InsertHandler(ImageHandler handler)"""
3309 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3311 InsertHandler
= staticmethod(InsertHandler
)
3312 def RemoveHandler(*args
, **kwargs
):
3313 """RemoveHandler(String name) -> bool"""
3314 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3316 RemoveHandler
= staticmethod(RemoveHandler
)
3317 def GetHandlers(*args
, **kwargs
):
3318 """GetHandlers() -> PyObject"""
3319 return _core_
.Image_GetHandlers(*args
, **kwargs
)
3321 GetHandlers
= staticmethod(GetHandlers
)
3322 def GetImageExtWildcard(*args
, **kwargs
):
3324 GetImageExtWildcard() -> String
3326 Iterates all registered wxImageHandler objects, and returns a string
3327 containing file extension masks suitable for passing to file open/save
3330 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3332 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3333 def ConvertToBitmap(*args
, **kwargs
):
3334 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3335 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3337 def ConvertToMonoBitmap(*args
, **kwargs
):
3338 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3339 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3341 def RotateHue(*args
, **kwargs
):
3343 RotateHue(self, double angle)
3345 Rotates the hue of each pixel of the image. Hue is a double in the
3346 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3348 return _core_
.Image_RotateHue(*args
, **kwargs
)
3350 def RGBtoHSV(*args
, **kwargs
):
3352 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3354 Converts a color in RGB color space to HSV color space.
3356 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3358 RGBtoHSV
= staticmethod(RGBtoHSV
)
3359 def HSVtoRGB(*args
, **kwargs
):
3361 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3363 Converts a color in HSV color space to RGB color space.
3365 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3367 HSVtoRGB
= staticmethod(HSVtoRGB
)
3368 def __nonzero__(self
): return self
.IsOk()
3369 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3370 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
3371 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
3372 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
3373 Height
= property(GetHeight
,doc
="See `GetHeight`")
3374 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
3375 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
3376 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
3377 Width
= property(GetWidth
,doc
="See `GetWidth`")
3378 _core_
.Image_swigregister(Image
)
3380 def ImageFromMime(*args
, **kwargs
):
3382 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3384 Loads an image from a file, using a MIME type string (such as
3385 'image/jpeg') to specify image type.
3387 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3390 def ImageFromStream(*args
, **kwargs
):
3392 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3394 Loads an image from an input stream, or any readable Python file-like
3397 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3400 def ImageFromStreamMime(*args
, **kwargs
):
3402 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3404 Loads an image from an input stream, or any readable Python file-like
3405 object, specifying the image format with a MIME type string.
3407 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3410 def EmptyImage(*args
, **kwargs
):
3412 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3414 Construct an empty image of a given size, optionally setting all
3417 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3420 def ImageFromBitmap(*args
, **kwargs
):
3422 ImageFromBitmap(Bitmap bitmap) -> Image
3424 Construct an Image from a `wx.Bitmap`.
3426 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3429 def ImageFromData(*args
, **kwargs
):
3431 ImageFromData(int width, int height, buffer data) -> Image
3433 Construct an Image from a buffer of RGB bytes. Accepts either a
3434 string or a buffer object holding the data and the length of the data
3435 must be width*height*3.
3437 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3440 def ImageFromDataWithAlpha(*args
, **kwargs
):
3442 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3444 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3445 Accepts either a string or a buffer object holding the data and the
3446 length of the data must be width*height*3 bytes, and the length of the
3447 alpha data must be width*height bytes.
3449 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3452 def Image_CanRead(*args
, **kwargs
):
3454 Image_CanRead(String filename) -> bool
3456 Returns True if the image handlers can read this file.
3458 return _core_
.Image_CanRead(*args
, **kwargs
)
3460 def Image_GetImageCount(*args
, **kwargs
):
3462 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3464 If the image file contains more than one image and the image handler
3465 is capable of retrieving these individually, this function will return
3466 the number of available images.
3468 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3470 def Image_CanReadStream(*args
, **kwargs
):
3472 Image_CanReadStream(InputStream stream) -> bool
3474 Returns True if the image handlers can read an image file from the
3475 data currently on the input stream, or a readable Python file-like
3478 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3480 def Image_AddHandler(*args
, **kwargs
):
3481 """Image_AddHandler(ImageHandler handler)"""
3482 return _core_
.Image_AddHandler(*args
, **kwargs
)
3484 def Image_InsertHandler(*args
, **kwargs
):
3485 """Image_InsertHandler(ImageHandler handler)"""
3486 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3488 def Image_RemoveHandler(*args
, **kwargs
):
3489 """Image_RemoveHandler(String name) -> bool"""
3490 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3492 def Image_GetHandlers(*args
):
3493 """Image_GetHandlers() -> PyObject"""
3494 return _core_
.Image_GetHandlers(*args
)
3496 def Image_GetImageExtWildcard(*args
):
3498 Image_GetImageExtWildcard() -> String
3500 Iterates all registered wxImageHandler objects, and returns a string
3501 containing file extension masks suitable for passing to file open/save
3504 return _core_
.Image_GetImageExtWildcard(*args
)
3506 def Image_RGBtoHSV(*args
, **kwargs
):
3508 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3510 Converts a color in RGB color space to HSV color space.
3512 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3514 def Image_HSVtoRGB(*args
, **kwargs
):
3516 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3518 Converts a color in HSV color space to RGB color space.
3520 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3523 def _ImageFromBuffer(*args
, **kwargs
):
3524 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3525 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3526 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3528 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3529 parameter must be a Python object that implements the buffer interface,
3530 such as a string, array, etc. The dataBuffer object is expected to
3531 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3532 object can optionally be supplied for the image's alpha channel data, and
3533 it is expected to be width*height bytes long.
3535 The wx.Image will be created with its data and alpha pointers initialized
3536 to the memory address pointed to by the buffer objects, thus saving the
3537 time needed to copy the image data from the buffer object to the wx.Image.
3538 While this has advantages, it also has the shoot-yourself-in-the-foot
3539 risks associated with sharing a C pointer between two objects.
3541 To help alleviate the risk a reference to the data and alpha buffer
3542 objects are kept with the wx.Image, so that they won't get deleted until
3543 after the wx.Image is deleted. However please be aware that it is not
3544 guaranteed that an object won't move its memory buffer to a new location
3545 when it needs to resize its contents. If that happens then the wx.Image
3546 will end up referring to an invalid memory location and could cause the
3547 application to crash. Therefore care should be taken to not manipulate
3548 the objects used for the data and alpha buffers in a way that would cause
3549 them to change size.
3551 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3552 image
._buffer
= dataBuffer
3553 image
._alpha
= alphaBuffer
3556 def InitAllImageHandlers():
3558 The former functionality of InitAllImageHanders is now done internal to
3559 the _core_ extension module and so this function has become a simple NOP.
3563 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3564 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3565 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3566 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3567 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3568 BMP_24BPP
= _core_
.BMP_24BPP
3569 BMP_8BPP
= _core_
.BMP_8BPP
3570 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3571 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3572 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3573 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3574 BMP_4BPP
= _core_
.BMP_4BPP
3575 BMP_1BPP
= _core_
.BMP_1BPP
3576 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3577 class BMPHandler(ImageHandler
):
3578 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3579 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3580 __repr__
= _swig_repr
3581 def __init__(self
, *args
, **kwargs
):
3583 __init__(self) -> BMPHandler
3585 A `wx.ImageHandler` for \*.bmp bitmap files.
3587 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3588 _core_
.BMPHandler_swigregister(BMPHandler
)
3589 NullImage
= cvar
.NullImage
3590 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3591 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3592 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3593 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3594 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3595 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3596 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3597 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3598 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3599 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3600 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3601 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3602 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3603 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3604 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3606 class ICOHandler(BMPHandler
):
3607 """A `wx.ImageHandler` for \*.ico icon files."""
3608 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3609 __repr__
= _swig_repr
3610 def __init__(self
, *args
, **kwargs
):
3612 __init__(self) -> ICOHandler
3614 A `wx.ImageHandler` for \*.ico icon files.
3616 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3617 _core_
.ICOHandler_swigregister(ICOHandler
)
3619 class CURHandler(ICOHandler
):
3620 """A `wx.ImageHandler` for \*.cur cursor files."""
3621 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3622 __repr__
= _swig_repr
3623 def __init__(self
, *args
, **kwargs
):
3625 __init__(self) -> CURHandler
3627 A `wx.ImageHandler` for \*.cur cursor files.
3629 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3630 _core_
.CURHandler_swigregister(CURHandler
)
3632 class ANIHandler(CURHandler
):
3633 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3634 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3635 __repr__
= _swig_repr
3636 def __init__(self
, *args
, **kwargs
):
3638 __init__(self) -> ANIHandler
3640 A `wx.ImageHandler` for \*.ani animated cursor files.
3642 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3643 _core_
.ANIHandler_swigregister(ANIHandler
)
3645 class PNGHandler(ImageHandler
):
3646 """A `wx.ImageHandler` for PNG image files."""
3647 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3648 __repr__
= _swig_repr
3649 def __init__(self
, *args
, **kwargs
):
3651 __init__(self) -> PNGHandler
3653 A `wx.ImageHandler` for PNG image files.
3655 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3656 _core_
.PNGHandler_swigregister(PNGHandler
)
3658 class GIFHandler(ImageHandler
):
3659 """A `wx.ImageHandler` for GIF image files."""
3660 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3661 __repr__
= _swig_repr
3662 def __init__(self
, *args
, **kwargs
):
3664 __init__(self) -> GIFHandler
3666 A `wx.ImageHandler` for GIF image files.
3668 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3669 _core_
.GIFHandler_swigregister(GIFHandler
)
3671 class PCXHandler(ImageHandler
):
3672 """A `wx.ImageHandler` for PCX imager files."""
3673 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3674 __repr__
= _swig_repr
3675 def __init__(self
, *args
, **kwargs
):
3677 __init__(self) -> PCXHandler
3679 A `wx.ImageHandler` for PCX imager files.
3681 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3682 _core_
.PCXHandler_swigregister(PCXHandler
)
3684 class JPEGHandler(ImageHandler
):
3685 """A `wx.ImageHandler` for JPEG/JPG image files."""
3686 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3687 __repr__
= _swig_repr
3688 def __init__(self
, *args
, **kwargs
):
3690 __init__(self) -> JPEGHandler
3692 A `wx.ImageHandler` for JPEG/JPG image files.
3694 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3695 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3697 class PNMHandler(ImageHandler
):
3698 """A `wx.ImageHandler` for PNM image files."""
3699 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3700 __repr__
= _swig_repr
3701 def __init__(self
, *args
, **kwargs
):
3703 __init__(self) -> PNMHandler
3705 A `wx.ImageHandler` for PNM image files.
3707 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3708 _core_
.PNMHandler_swigregister(PNMHandler
)
3710 class XPMHandler(ImageHandler
):
3711 """A `wx.ImageHandler` for XPM image."""
3712 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3713 __repr__
= _swig_repr
3714 def __init__(self
, *args
, **kwargs
):
3716 __init__(self) -> XPMHandler
3718 A `wx.ImageHandler` for XPM image.
3720 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3721 _core_
.XPMHandler_swigregister(XPMHandler
)
3723 class TIFFHandler(ImageHandler
):
3724 """A `wx.ImageHandler` for TIFF image files."""
3725 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3726 __repr__
= _swig_repr
3727 def __init__(self
, *args
, **kwargs
):
3729 __init__(self) -> TIFFHandler
3731 A `wx.ImageHandler` for TIFF image files.
3733 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3734 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3736 class TGAHandler(ImageHandler
):
3737 """A `wx.ImageHandler` for TGA image files."""
3738 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3739 __repr__
= _swig_repr
3740 def __init__(self
, *args
, **kwargs
):
3742 __init__(self) -> TGAHandler
3744 A `wx.ImageHandler` for TGA image files.
3746 _core_
.TGAHandler_swiginit(self
,_core_
.new_TGAHandler(*args
, **kwargs
))
3747 _core_
.TGAHandler_swigregister(TGAHandler
)
3749 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3750 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3751 class Quantize(object):
3752 """Performs quantization, or colour reduction, on a wxImage."""
3753 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3754 def __init__(self
): raise AttributeError, "No constructor defined"
3755 __repr__
= _swig_repr
3756 def Quantize(*args
, **kwargs
):
3758 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3760 Reduce the colours in the source image and put the result into the
3761 destination image, setting the palette in the destination if
3762 needed. Both images may be the same, to overwrite the source image.
3764 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3766 Quantize
= staticmethod(Quantize
)
3767 _core_
.Quantize_swigregister(Quantize
)
3769 def Quantize_Quantize(*args
, **kwargs
):
3771 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3773 Reduce the colours in the source image and put the result into the
3774 destination image, setting the palette in the destination if
3775 needed. Both images may be the same, to overwrite the source image.
3777 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3779 #---------------------------------------------------------------------------
3781 class EvtHandler(Object
):
3782 """Proxy of C++ EvtHandler class"""
3783 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3784 __repr__
= _swig_repr
3785 def __init__(self
, *args
, **kwargs
):
3786 """__init__(self) -> EvtHandler"""
3787 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3788 self
._setOORInfo
(self
)
3790 def GetNextHandler(*args
, **kwargs
):
3791 """GetNextHandler(self) -> EvtHandler"""
3792 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3794 def GetPreviousHandler(*args
, **kwargs
):
3795 """GetPreviousHandler(self) -> EvtHandler"""
3796 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3798 def SetNextHandler(*args
, **kwargs
):
3799 """SetNextHandler(self, EvtHandler handler)"""
3800 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3802 def SetPreviousHandler(*args
, **kwargs
):
3803 """SetPreviousHandler(self, EvtHandler handler)"""
3804 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3806 def GetEvtHandlerEnabled(*args
, **kwargs
):
3807 """GetEvtHandlerEnabled(self) -> bool"""
3808 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3810 def SetEvtHandlerEnabled(*args
, **kwargs
):
3811 """SetEvtHandlerEnabled(self, bool enabled)"""
3812 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3814 def ProcessEvent(*args
, **kwargs
):
3815 """ProcessEvent(self, Event event) -> bool"""
3816 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3818 def AddPendingEvent(*args
, **kwargs
):
3819 """AddPendingEvent(self, Event event)"""
3820 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3822 def ProcessPendingEvents(*args
, **kwargs
):
3823 """ProcessPendingEvents(self)"""
3824 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3826 def Connect(*args
, **kwargs
):
3827 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3828 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3830 def Disconnect(*args
, **kwargs
):
3831 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3832 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3834 def _setOORInfo(*args
, **kwargs
):
3835 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3836 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3837 args
[0].this
.own(False)
3840 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3842 Bind an event to an event handler.
3844 :param event: One of the EVT_* objects that specifies the
3845 type of event to bind,
3847 :param handler: A callable object to be invoked when the
3848 event is delivered to self. Pass None to
3849 disconnect an event handler.
3851 :param source: Sometimes the event originates from a
3852 different window than self, but you still
3853 want to catch it in self. (For example, a
3854 button event delivered to a frame.) By
3855 passing the source of the event, the event
3856 handling system is able to differentiate
3857 between the same event type from different
3860 :param id: Used to spcify the event source by ID instead
3863 :param id2: Used when it is desirable to bind a handler
3864 to a range of IDs, such as with EVT_MENU_RANGE.
3866 if source
is not None:
3868 event
.Bind(self
, id, id2
, handler
)
3870 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3872 Disconencts the event handler binding for event from self.
3873 Returns True if successful.
3875 if source
is not None:
3877 return event
.Unbind(self
, id, id2
)
3879 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3880 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3881 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3882 _core_
.EvtHandler_swigregister(EvtHandler
)
3884 #---------------------------------------------------------------------------
3886 class PyEventBinder(object):
3888 Instances of this class are used to bind specific events to event
3891 def __init__(self
, evtType
, expectedIDs
=0):
3892 if expectedIDs
not in [0, 1, 2]:
3893 raise ValueError, "Invalid number of expectedIDs"
3894 self
.expectedIDs
= expectedIDs
3896 if type(evtType
) == list or type(evtType
) == tuple:
3897 self
.evtType
= evtType
3899 self
.evtType
= [evtType
]
3902 def Bind(self
, target
, id1
, id2
, function
):
3903 """Bind this set of event types to target."""
3904 for et
in self
.evtType
:
3905 target
.Connect(id1
, id2
, et
, function
)
3908 def Unbind(self
, target
, id1
, id2
):
3909 """Remove an event binding."""
3911 for et
in self
.evtType
:
3912 success
+= target
.Disconnect(id1
, id2
, et
)
3915 def _getEvtType(self
):
3917 Make it easy to get to the default wxEventType typeID for this
3920 return self
.evtType
[0]
3922 typeId
= property(_getEvtType
)
3925 def __call__(self
, *args
):
3927 For backwards compatibility with the old EVT_* functions.
3928 Should be called with either (window, func), (window, ID,
3929 func) or (window, ID1, ID2, func) parameters depending on the
3932 assert len(args
) == 2 + self
.expectedIDs
3936 if self
.expectedIDs
== 0:
3938 elif self
.expectedIDs
== 1:
3941 elif self
.expectedIDs
== 2:
3946 raise ValueError, "Unexpected number of IDs"
3948 self
.Bind(target
, id1
, id2
, func
)
3951 # These two are square pegs that don't fit the PyEventBinder hole...
3952 def EVT_COMMAND(win
, id, cmd
, func
):
3953 win
.Connect(id, -1, cmd
, func
)
3954 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3955 win
.Connect(id1
, id2
, cmd
, func
)
3958 #---------------------------------------------------------------------------
3960 #---------------------------------------------------------------------------
3962 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3963 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3965 def NewEventType(*args
):
3966 """NewEventType() -> EventType"""
3967 return _core_
.NewEventType(*args
)
3968 wxEVT_ANY
= _core_
.wxEVT_ANY
3969 wxEVT_NULL
= _core_
.wxEVT_NULL
3970 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3971 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3972 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3973 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3974 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3975 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3976 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3977 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3978 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3979 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3980 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3981 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3982 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3983 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3984 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3985 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3986 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3987 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3988 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3989 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3990 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3991 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3992 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3993 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3994 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3995 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3996 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3997 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3998 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3999 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
4000 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
4001 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
4002 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
4003 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
4004 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
4005 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
4006 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
4007 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
4008 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
4009 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
4010 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
4011 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
4012 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
4013 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
4014 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
4015 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
4016 wxEVT_CHAR
= _core_
.wxEVT_CHAR
4017 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
4018 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
4019 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
4020 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
4021 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
4022 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
4023 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
4024 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
4025 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
4026 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
4027 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
4028 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
4029 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
4030 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
4031 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
4032 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
4033 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
4034 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
4035 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
4036 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
4037 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
4038 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
4039 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
4040 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
4041 wxEVT_SIZE
= _core_
.wxEVT_SIZE
4042 wxEVT_MOVE
= _core_
.wxEVT_MOVE
4043 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
4044 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
4045 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
4046 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
4047 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
4048 wxEVT_CREATE
= _core_
.wxEVT_CREATE
4049 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
4050 wxEVT_SHOW
= _core_
.wxEVT_SHOW
4051 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
4052 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
4053 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
4054 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
4055 wxEVT_PAINT
= _core_
.wxEVT_PAINT
4056 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
4057 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
4058 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
4059 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
4060 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
4061 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
4062 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
4063 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
4064 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
4065 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
4066 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
4067 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
4068 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
4069 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
4070 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
4071 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
4072 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
4073 wxEVT_IDLE
= _core_
.wxEVT_IDLE
4074 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
4075 wxEVT_SIZING
= _core_
.wxEVT_SIZING
4076 wxEVT_MOVING
= _core_
.wxEVT_MOVING
4077 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
4078 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
4079 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
4080 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
4081 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
4082 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
4083 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
4084 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
4085 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
4086 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
4087 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
4089 # Create some event binders
4090 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
4091 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
4092 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
4093 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
4094 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
4095 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4096 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4097 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
4098 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
4099 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
4100 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
4101 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
4102 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
4103 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
4104 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
4105 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
4106 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
4107 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
4108 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
4109 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
4110 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
4111 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
4112 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
4113 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
4114 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
4115 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4116 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4117 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
4118 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
4119 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
4120 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
4121 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
4122 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
4123 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
4124 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
4125 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
4126 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
4127 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
4128 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
4129 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
4130 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
4131 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
4133 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
4134 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
4135 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
4136 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
4137 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
4138 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
4139 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
4140 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
4141 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
4142 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
4143 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
4144 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
4145 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
4147 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
4155 wxEVT_MIDDLE_DCLICK
,
4163 # Scrolling from wxWindow (sent to wxScrolledWindow)
4164 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
4165 wxEVT_SCROLLWIN_BOTTOM
,
4166 wxEVT_SCROLLWIN_LINEUP
,
4167 wxEVT_SCROLLWIN_LINEDOWN
,
4168 wxEVT_SCROLLWIN_PAGEUP
,
4169 wxEVT_SCROLLWIN_PAGEDOWN
,
4170 wxEVT_SCROLLWIN_THUMBTRACK
,
4171 wxEVT_SCROLLWIN_THUMBRELEASE
,
4174 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
4175 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
4176 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
4177 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
4178 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
4179 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
4180 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
4181 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
4183 # Scrolling from wx.Slider and wx.ScrollBar
4184 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4185 wxEVT_SCROLL_BOTTOM
,
4186 wxEVT_SCROLL_LINEUP
,
4187 wxEVT_SCROLL_LINEDOWN
,
4188 wxEVT_SCROLL_PAGEUP
,
4189 wxEVT_SCROLL_PAGEDOWN
,
4190 wxEVT_SCROLL_THUMBTRACK
,
4191 wxEVT_SCROLL_THUMBRELEASE
,
4192 wxEVT_SCROLL_CHANGED
,
4195 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
4196 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
4197 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
4198 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
4199 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
4200 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
4201 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
4202 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
4203 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
4204 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
4206 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4207 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4208 wxEVT_SCROLL_BOTTOM
,
4209 wxEVT_SCROLL_LINEUP
,
4210 wxEVT_SCROLL_LINEDOWN
,
4211 wxEVT_SCROLL_PAGEUP
,
4212 wxEVT_SCROLL_PAGEDOWN
,
4213 wxEVT_SCROLL_THUMBTRACK
,
4214 wxEVT_SCROLL_THUMBRELEASE
,
4215 wxEVT_SCROLL_CHANGED
,
4218 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
4219 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
4220 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
4221 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
4222 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
4223 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
4224 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
4225 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
4226 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
4227 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
4229 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
4230 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
4231 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
4232 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
4233 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4234 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4235 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4236 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4237 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4238 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4240 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4241 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4242 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4243 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4244 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4245 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4246 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4247 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4248 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4251 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4252 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4253 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4254 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4255 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4256 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4257 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4259 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4261 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4262 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4264 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4266 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
4267 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
4268 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
4271 #---------------------------------------------------------------------------
4273 class Event(Object
):
4275 An event is a structure holding information about an event passed to a
4276 callback or member function. wx.Event is an abstract base class for
4279 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4280 def __init__(self
): raise AttributeError, "No constructor defined"
4281 __repr__
= _swig_repr
4282 __swig_destroy__
= _core_
.delete_Event
4283 __del__
= lambda self
: None;
4284 def SetEventType(*args
, **kwargs
):
4286 SetEventType(self, EventType typ)
4288 Sets the specific type of the event.
4290 return _core_
.Event_SetEventType(*args
, **kwargs
)
4292 def GetEventType(*args
, **kwargs
):
4294 GetEventType(self) -> EventType
4296 Returns the identifier of the given event type, such as
4297 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4299 return _core_
.Event_GetEventType(*args
, **kwargs
)
4301 def GetEventObject(*args
, **kwargs
):
4303 GetEventObject(self) -> Object
4305 Returns the object (usually a window) associated with the event, if
4308 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4310 def SetEventObject(*args
, **kwargs
):
4312 SetEventObject(self, Object obj)
4314 Sets the originating object, or in other words, obj is normally the
4315 object that is sending the event.
4317 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4319 def GetTimestamp(*args
, **kwargs
):
4320 """GetTimestamp(self) -> long"""
4321 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4323 def SetTimestamp(*args
, **kwargs
):
4324 """SetTimestamp(self, long ts=0)"""
4325 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4327 def GetId(*args
, **kwargs
):
4331 Returns the identifier associated with this event, such as a button
4334 return _core_
.Event_GetId(*args
, **kwargs
)
4336 def SetId(*args
, **kwargs
):
4340 Set's the ID for the event. This is usually the ID of the window that
4341 is sending the event, but it can also be a command id from a menu
4344 return _core_
.Event_SetId(*args
, **kwargs
)
4346 def IsCommandEvent(*args
, **kwargs
):
4348 IsCommandEvent(self) -> bool
4350 Returns true if the event is or is derived from `wx.CommandEvent` else
4351 it returns false. Note: Exists only for optimization purposes.
4353 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4355 def Skip(*args
, **kwargs
):
4357 Skip(self, bool skip=True)
4359 This method can be used inside an event handler to control whether
4360 further event handlers bound to this event will be called after the
4361 current one returns. Without Skip() (or equivalently if Skip(False) is
4362 used), the event will not be processed any more. If Skip(True) is
4363 called, the event processing system continues searching for a further
4364 handler function for this event, even though it has been processed
4365 already in the current handler.
4367 return _core_
.Event_Skip(*args
, **kwargs
)
4369 def GetSkipped(*args
, **kwargs
):
4371 GetSkipped(self) -> bool
4373 Returns true if the event handler should be skipped, false otherwise.
4376 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4378 def ShouldPropagate(*args
, **kwargs
):
4380 ShouldPropagate(self) -> bool
4382 Test if this event should be propagated to the parent window or not,
4383 i.e. if the propagation level is currently greater than 0.
4385 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4387 def StopPropagation(*args
, **kwargs
):
4389 StopPropagation(self) -> int
4391 Stop the event from propagating to its parent window. Returns the old
4392 propagation level value which may be later passed to
4393 `ResumePropagation` to allow propagating the event again.
4395 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4397 def ResumePropagation(*args
, **kwargs
):
4399 ResumePropagation(self, int propagationLevel)
4401 Resume the event propagation by restoring the propagation level. (For
4402 example, you can use the value returned by an earlier call to
4406 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4408 def Clone(*args
, **kwargs
):
4409 """Clone(self) -> Event"""
4410 return _core_
.Event_Clone(*args
, **kwargs
)
4412 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4413 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4414 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4415 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4416 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4417 _core_
.Event_swigregister(Event
)
4419 #---------------------------------------------------------------------------
4421 class PropagationDisabler(object):
4423 Helper class to temporarily change an event not to propagate. Simply
4424 create an instance of this class and then whe it is destroyed the
4425 propogation of the event will be restored.
4427 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4428 __repr__
= _swig_repr
4429 def __init__(self
, *args
, **kwargs
):
4431 __init__(self, Event event) -> PropagationDisabler
4433 Helper class to temporarily change an event not to propagate. Simply
4434 create an instance of this class and then whe it is destroyed the
4435 propogation of the event will be restored.
4437 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4438 __swig_destroy__
= _core_
.delete_PropagationDisabler
4439 __del__
= lambda self
: None;
4440 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4442 class PropagateOnce(object):
4444 A helper class that will temporarily lower propagation level of an
4445 event. Simply create an instance of this class and then whe it is
4446 destroyed the propogation of the event will be restored.
4448 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4449 __repr__
= _swig_repr
4450 def __init__(self
, *args
, **kwargs
):
4452 __init__(self, Event event) -> PropagateOnce
4454 A helper class that will temporarily lower propagation level of an
4455 event. Simply create an instance of this class and then whe it is
4456 destroyed the propogation of the event will be restored.
4458 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4459 __swig_destroy__
= _core_
.delete_PropagateOnce
4460 __del__
= lambda self
: None;
4461 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4463 #---------------------------------------------------------------------------
4465 class CommandEvent(Event
):
4467 This event class contains information about command events, which
4468 originate from a variety of simple controls, as well as menus and
4471 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4472 __repr__
= _swig_repr
4473 def __init__(self
, *args
, **kwargs
):
4475 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4477 This event class contains information about command events, which
4478 originate from a variety of simple controls, as well as menus and
4481 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4482 def GetSelection(*args
, **kwargs
):
4484 GetSelection(self) -> int
4486 Returns item index for a listbox or choice selection event (not valid
4489 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4491 def SetString(*args
, **kwargs
):
4492 """SetString(self, String s)"""
4493 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4495 def GetString(*args
, **kwargs
):
4497 GetString(self) -> String
4499 Returns item string for a listbox or choice selection event (not valid
4502 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4504 def IsChecked(*args
, **kwargs
):
4506 IsChecked(self) -> bool
4508 This method can be used with checkbox and menu events: for the
4509 checkboxes, the method returns true for a selection event and false
4510 for a deselection one. For the menu events, this method indicates if
4511 the menu item just has become checked or unchecked (and thus only
4512 makes sense for checkable menu items).
4514 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4517 def IsSelection(*args
, **kwargs
):
4519 IsSelection(self) -> bool
4521 For a listbox or similar event, returns true if it is a selection,
4522 false if it is a deselection.
4524 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4526 def SetExtraLong(*args
, **kwargs
):
4527 """SetExtraLong(self, long extraLong)"""
4528 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4530 def GetExtraLong(*args
, **kwargs
):
4532 GetExtraLong(self) -> long
4534 Returns extra information dependant on the event objects type. If the
4535 event comes from a listbox selection, it is a boolean determining
4536 whether the event was a selection (true) or a deselection (false). A
4537 listbox deselection only occurs for multiple-selection boxes, and in
4538 this case the index and string values are indeterminate and the
4539 listbox must be examined by the application.
4541 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4543 def SetInt(*args
, **kwargs
):
4544 """SetInt(self, int i)"""
4545 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4547 def GetInt(*args
, **kwargs
):
4551 Returns the integer identifier corresponding to a listbox, choice or
4552 radiobox selection (only if the event was a selection, not a
4553 deselection), or a boolean value representing the value of a checkbox.
4555 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4557 def GetClientData(*args
, **kwargs
):
4559 GetClientData(self) -> PyObject
4561 Returns the client data object for a listbox or choice selection event, (if any.)
4563 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4565 def SetClientData(*args
, **kwargs
):
4567 SetClientData(self, PyObject clientData)
4569 Associate the given client data with the item at position n.
4571 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4573 GetClientObject
= GetClientData
4574 SetClientObject
= SetClientData
4576 def Clone(*args
, **kwargs
):
4577 """Clone(self) -> Event"""
4578 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4580 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4581 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4582 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4583 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4584 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4585 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4586 _core_
.CommandEvent_swigregister(CommandEvent
)
4588 #---------------------------------------------------------------------------
4590 class NotifyEvent(CommandEvent
):
4592 An instance of this class (or one of its derived classes) is sent from
4593 a control when the control's state is being changed and the control
4594 allows that change to be prevented from happening. The event handler
4595 can call `Veto` or `Allow` to tell the control what to do.
4597 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4598 __repr__
= _swig_repr
4599 def __init__(self
, *args
, **kwargs
):
4601 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4603 An instance of this class (or one of its derived classes) is sent from
4604 a control when the control's state is being changed and the control
4605 allows that change to be prevented from happening. The event handler
4606 can call `Veto` or `Allow` to tell the control what to do.
4608 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4609 def Veto(*args
, **kwargs
):
4613 Prevents the change announced by this event from happening.
4615 It is in general a good idea to notify the user about the reasons for
4616 vetoing the change because otherwise the applications behaviour (which
4617 just refuses to do what the user wants) might be quite surprising.
4619 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4621 def Allow(*args
, **kwargs
):
4625 This is the opposite of `Veto`: it explicitly allows the event to be
4626 processed. For most events it is not necessary to call this method as
4627 the events are allowed anyhow but some are forbidden by default (this
4628 will be mentioned in the corresponding event description).
4630 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4632 def IsAllowed(*args
, **kwargs
):
4634 IsAllowed(self) -> bool
4636 Returns true if the change is allowed (`Veto` hasn't been called) or
4637 false otherwise (if it was).
4639 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4641 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4643 #---------------------------------------------------------------------------
4645 class ScrollEvent(CommandEvent
):
4647 A scroll event holds information about events sent from stand-alone
4648 scrollbars and sliders. Note that scrolled windows do not send
4649 instances of this event class, but send the `wx.ScrollWinEvent`
4652 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4653 __repr__
= _swig_repr
4654 def __init__(self
, *args
, **kwargs
):
4656 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4657 int orient=0) -> ScrollEvent
4659 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4660 def GetOrientation(*args
, **kwargs
):
4662 GetOrientation(self) -> int
4664 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4667 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4669 def GetPosition(*args
, **kwargs
):
4671 GetPosition(self) -> int
4673 Returns the position of the scrollbar.
4675 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4677 def SetOrientation(*args
, **kwargs
):
4678 """SetOrientation(self, int orient)"""
4679 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4681 def SetPosition(*args
, **kwargs
):
4682 """SetPosition(self, int pos)"""
4683 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4685 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4686 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4687 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4689 #---------------------------------------------------------------------------
4691 class ScrollWinEvent(Event
):
4693 A wx.ScrollWinEvent holds information about scrolling and is sent from
4696 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4697 __repr__
= _swig_repr
4698 def __init__(self
, *args
, **kwargs
):
4700 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4702 A wx.ScrollWinEvent holds information about scrolling and is sent from
4705 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4706 def GetOrientation(*args
, **kwargs
):
4708 GetOrientation(self) -> int
4710 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4713 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4715 def GetPosition(*args
, **kwargs
):
4717 GetPosition(self) -> int
4719 Returns the position of the scrollbar for the thumb track and release
4720 events. Note that this field can't be used for the other events, you
4721 need to query the window itself for the current position in that case.
4723 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4725 def SetOrientation(*args
, **kwargs
):
4726 """SetOrientation(self, int orient)"""
4727 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4729 def SetPosition(*args
, **kwargs
):
4730 """SetPosition(self, int pos)"""
4731 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4733 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4734 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4735 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4737 #---------------------------------------------------------------------------
4739 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4740 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4741 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4742 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4743 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4744 class MouseEvent(Event
):
4746 This event class contains information about the events generated by
4747 the mouse: they include mouse buttons press and release events and
4750 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4751 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4752 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4753 a middle button so a portable application should avoid relying on the
4756 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4757 the former returns true when the event corresponds to the left mouse
4758 button click while the latter returns true if the left mouse button is
4759 currently being pressed. For example, when the user is dragging the
4760 mouse you can use `LeftIsDown` to test whether the left mouse button
4761 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4762 `LeftIsDown` will also return true in wxWidgets whatever the
4763 underlying GUI behaviour is (which is platform-dependent). The same
4764 applies, of course, to other mouse buttons as well.
4766 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4767 __repr__
= _swig_repr
4768 def __init__(self
, *args
, **kwargs
):
4770 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4772 Constructs a wx.MouseEvent. Valid event types are:
4774 * wxEVT_ENTER_WINDOW
4775 * wxEVT_LEAVE_WINDOW
4781 * wxEVT_MIDDLE_DCLICK
4784 * wxEVT_RIGHT_DCLICK
4788 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4789 def IsButton(*args
, **kwargs
):
4791 IsButton(self) -> bool
4793 Returns true if the event was a mouse button event (not necessarily a
4794 button down event - that may be tested using `ButtonDown`).
4796 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4798 def ButtonDown(*args
, **kwargs
):
4800 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4802 If the argument is omitted, this returns true if the event was any
4803 mouse button down event. Otherwise the argument specifies which
4804 button-down event shold be checked for (see `Button` for the possible
4807 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4809 def ButtonDClick(*args
, **kwargs
):
4811 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4813 If the argument is omitted, this returns true if the event was any
4814 mouse double click event. Otherwise the argument specifies which
4815 double click event to check for (see `Button` for the possible
4818 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4820 def ButtonUp(*args
, **kwargs
):
4822 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4824 If the argument is omitted, this returns true if the event was any
4825 mouse button up event. Otherwise the argument specifies which button
4826 up event to check for (see `Button` for the possible values).
4828 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4830 def Button(*args
, **kwargs
):
4832 Button(self, int button) -> bool
4834 Returns true if the identified mouse button is changing state. Valid
4835 values of button are:
4837 ==================== =====================================
4838 wx.MOUSE_BTN_LEFT check if left button was pressed
4839 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4840 wx.MOUSE_BTN_RIGHT check if right button was pressed
4841 wx.MOUSE_BTN_ANY check if any button was pressed
4842 ==================== =====================================
4845 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4847 def ButtonIsDown(*args
, **kwargs
):
4848 """ButtonIsDown(self, int but) -> bool"""
4849 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4851 def GetButton(*args
, **kwargs
):
4853 GetButton(self) -> int
4855 Returns the mouse button which generated this event or
4856 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4857 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4858 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4859 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4860 right buttons respectively.
4862 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4864 def ControlDown(*args
, **kwargs
):
4866 ControlDown(self) -> bool
4868 Returns true if the control key was down at the time of the event.
4870 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4872 def MetaDown(*args
, **kwargs
):
4874 MetaDown(self) -> bool
4876 Returns true if the Meta key was down at the time of the event.
4878 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4880 def AltDown(*args
, **kwargs
):
4882 AltDown(self) -> bool
4884 Returns true if the Alt key was down at the time of the event.
4886 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4888 def ShiftDown(*args
, **kwargs
):
4890 ShiftDown(self) -> bool
4892 Returns true if the Shift key was down at the time of the event.
4894 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4896 def CmdDown(*args
, **kwargs
):
4898 CmdDown(self) -> bool
4900 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4901 platforms but the special "Apple" (a.k.a as "Command") key on
4902 Macs. It often makes sense to use it instead of, say, `ControlDown`
4903 because Cmd key is used for the same thing under Mac as Ctrl
4904 elsewhere. The Ctrl key still exists, it's just not used for this
4905 purpose. So for non-Mac platforms this is the same as `ControlDown`
4906 and Macs this is the same as `MetaDown`.
4908 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4910 def LeftDown(*args
, **kwargs
):
4912 LeftDown(self) -> bool
4914 Returns true if the left mouse button state changed to down.
4916 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4918 def MiddleDown(*args
, **kwargs
):
4920 MiddleDown(self) -> bool
4922 Returns true if the middle mouse button state changed to down.
4924 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4926 def RightDown(*args
, **kwargs
):
4928 RightDown(self) -> bool
4930 Returns true if the right mouse button state changed to down.
4932 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4934 def LeftUp(*args
, **kwargs
):
4936 LeftUp(self) -> bool
4938 Returns true if the left mouse button state changed to up.
4940 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4942 def MiddleUp(*args
, **kwargs
):
4944 MiddleUp(self) -> bool
4946 Returns true if the middle mouse button state changed to up.
4948 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4950 def RightUp(*args
, **kwargs
):
4952 RightUp(self) -> bool
4954 Returns true if the right mouse button state changed to up.
4956 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4958 def LeftDClick(*args
, **kwargs
):
4960 LeftDClick(self) -> bool
4962 Returns true if the event was a left button double click.
4964 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4966 def MiddleDClick(*args
, **kwargs
):
4968 MiddleDClick(self) -> bool
4970 Returns true if the event was a middle button double click.
4972 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4974 def RightDClick(*args
, **kwargs
):
4976 RightDClick(self) -> bool
4978 Returns true if the event was a right button double click.
4980 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4982 def LeftIsDown(*args
, **kwargs
):
4984 LeftIsDown(self) -> bool
4986 Returns true if the left mouse button is currently down, independent
4987 of the current event type.
4989 Please notice that it is not the same as LeftDown which returns true
4990 if the left mouse button was just pressed. Rather, it describes the
4991 state of the mouse button before the event happened.
4993 This event is usually used in the mouse event handlers which process
4994 "move mouse" messages to determine whether the user is (still)
4997 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4999 def MiddleIsDown(*args
, **kwargs
):
5001 MiddleIsDown(self) -> bool
5003 Returns true if the middle mouse button is currently down, independent
5004 of the current event type.
5006 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
5008 def RightIsDown(*args
, **kwargs
):
5010 RightIsDown(self) -> bool
5012 Returns true if the right mouse button is currently down, independent
5013 of the current event type.
5015 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
5017 def Dragging(*args
, **kwargs
):
5019 Dragging(self) -> bool
5021 Returns true if this was a dragging event (motion while a button is
5024 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
5026 def Moving(*args
, **kwargs
):
5028 Moving(self) -> bool
5030 Returns true if this was a motion event and no mouse buttons were
5031 pressed. If any mouse button is held pressed, then this method returns
5032 false and Dragging returns true.
5034 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
5036 def Entering(*args
, **kwargs
):
5038 Entering(self) -> bool
5040 Returns true if the mouse was entering the window.
5042 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
5044 def Leaving(*args
, **kwargs
):
5046 Leaving(self) -> bool
5048 Returns true if the mouse was leaving the window.
5050 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
5052 def GetPosition(*args
, **kwargs
):
5054 GetPosition(self) -> Point
5056 Returns the pixel position of the mouse in window coordinates when the
5059 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
5061 def GetPositionTuple(*args
, **kwargs
):
5063 GetPositionTuple() -> (x,y)
5065 Returns the pixel position of the mouse in window coordinates when the
5068 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
5070 def GetLogicalPosition(*args
, **kwargs
):
5072 GetLogicalPosition(self, DC dc) -> Point
5074 Returns the logical mouse position in pixels (i.e. translated
5075 according to the translation set for the DC, which usually indicates
5076 that the window has been scrolled).
5078 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
5080 def GetX(*args
, **kwargs
):
5084 Returns X coordinate of the physical mouse event position.
5086 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
5088 def GetY(*args
, **kwargs
):
5092 Returns Y coordinate of the physical mouse event position.
5094 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
5096 def GetWheelRotation(*args
, **kwargs
):
5098 GetWheelRotation(self) -> int
5100 Get wheel rotation, positive or negative indicates direction of
5101 rotation. Current devices all send an event when rotation is equal to
5102 +/-WheelDelta, but this allows for finer resolution devices to be
5103 created in the future. Because of this you shouldn't assume that one
5104 event is equal to 1 line or whatever, but you should be able to either
5105 do partial line scrolling or wait until +/-WheelDelta rotation values
5106 have been accumulated before scrolling.
5108 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
5110 def GetWheelDelta(*args
, **kwargs
):
5112 GetWheelDelta(self) -> int
5114 Get wheel delta, normally 120. This is the threshold for action to be
5115 taken, and one such action (for example, scrolling one increment)
5116 should occur for each delta.
5118 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
5120 def GetWheelAxis(*args
, **kwargs
):
5122 GetWheelAxis(self) -> int
5124 Gets the axis the wheel operation concerns, 0 being the y axis as on
5125 most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
5126 or horizontal trackpad scrolling.
5128 return _core_
.MouseEvent_GetWheelAxis(*args
, **kwargs
)
5130 def GetLinesPerAction(*args
, **kwargs
):
5132 GetLinesPerAction(self) -> int
5134 Returns the configured number of lines (or whatever) to be scrolled
5135 per wheel action. Defaults to three.
5137 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
5139 def IsPageScroll(*args
, **kwargs
):
5141 IsPageScroll(self) -> bool
5143 Returns true if the system has been setup to do page scrolling with
5144 the mouse wheel instead of line scrolling.
5146 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
5148 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
5149 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
5150 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
5151 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
5152 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
5153 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
5154 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
5155 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
5156 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
5157 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
5158 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
5159 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
5160 Button
= property(GetButton
,doc
="See `GetButton`")
5161 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
5162 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
5163 Position
= property(GetPosition
,doc
="See `GetPosition`")
5164 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
5165 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
5166 X
= property(GetX
,doc
="See `GetX`")
5167 Y
= property(GetY
,doc
="See `GetY`")
5168 _core_
.MouseEvent_swigregister(MouseEvent
)
5170 #---------------------------------------------------------------------------
5172 class SetCursorEvent(Event
):
5174 A SetCursorEvent is generated when the mouse cursor is about to be set
5175 as a result of mouse motion. This event gives the application the
5176 chance to perform specific mouse cursor processing based on the
5177 current position of the mouse within the window. Use the `SetCursor`
5178 method to specify the cursor you want to be displayed.
5180 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5181 __repr__
= _swig_repr
5182 def __init__(self
, *args
, **kwargs
):
5184 __init__(self, int x=0, int y=0) -> SetCursorEvent
5186 Construct a new `wx.SetCursorEvent`.
5188 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
5189 def GetX(*args
, **kwargs
):
5193 Returns the X coordinate of the mouse in client coordinates.
5195 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
5197 def GetY(*args
, **kwargs
):
5201 Returns the Y coordinate of the mouse in client coordinates.
5203 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5205 def SetCursor(*args
, **kwargs
):
5207 SetCursor(self, Cursor cursor)
5209 Sets the cursor associated with this event.
5211 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5213 def GetCursor(*args
, **kwargs
):
5215 GetCursor(self) -> Cursor
5217 Returns a reference to the cursor specified by this event.
5219 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5221 def HasCursor(*args
, **kwargs
):
5223 HasCursor(self) -> bool
5225 Returns true if the cursor specified by this event is a valid cursor.
5227 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5229 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
5230 X
= property(GetX
,doc
="See `GetX`")
5231 Y
= property(GetY
,doc
="See `GetY`")
5232 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
5234 #---------------------------------------------------------------------------
5236 class KeyEvent(Event
):
5238 This event class contains information about keypress and character
5239 events. These events are only sent to the widget that currently has
5242 Notice that there are three different kinds of keyboard events in
5243 wxWidgets: key down and up events and char events. The difference
5244 between the first two is clear - the first corresponds to a key press
5245 and the second to a key release - otherwise they are identical. Just
5246 note that if the key is maintained in a pressed state you will
5247 typically get a lot of (automatically generated) down events but only
5248 one up so it is wrong to assume that there is one up event
5249 corresponding to each down one.
5251 Both key events provide untranslated key codes while the char event
5252 carries the translated one. The untranslated code for alphanumeric
5253 keys is always an upper case value. For the other keys it is one of
5254 WXK_XXX values from the keycodes table. The translated key is, in
5255 general, the character the user expects to appear as the result of the
5256 key combination when typing the text into a text entry zone, for
5259 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5260 and the standard US keyboard): when the 'A' key is pressed, the key
5261 down event key code is equal to ASCII A == 65. But the char event key
5262 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5263 'A' keys simultaneously , the key code in key down event will still be
5264 just 'A' while the char event key code parameter will now be 'A' as
5267 Although in this simple case it is clear that the correct key code
5268 could be found in the key down event handler by checking the value
5269 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5270 as for non alphanumeric keys or non-US keyboard layouts the
5271 translation is keyboard-layout dependent and can only be done properly
5272 by the system itself.
5274 Another kind of translation is done when the control key is pressed:
5275 for example, for CTRL-A key press the key down event still carries the
5276 same key code 'A' as usual but the char event will have key code of 1,
5277 the ASCII value of this key combination.
5279 You may discover how the other keys on your system behave
5280 interactively by running the KeyEvents sample in the wxPython demo and
5281 pressing some keys while the blue box at the top has the keyboard
5284 **Note**: If a key down event is caught and the event handler does not
5285 call event.Skip() then the coresponding char event will not
5286 happen. This is by design and enables the programs that handle both
5287 types of events to be a bit simpler.
5289 **Note for Windows programmers**: The key and char events in wxWidgets
5290 are similar to but slightly different from Windows WM_KEYDOWN and
5291 WM_CHAR events. In particular, Alt-x combination will generate a char
5292 event in wxWidgets (unless it is used as an accelerator).
5294 **Tip**: be sure to call event.Skip() for events that you don't
5295 process in key event function, otherwise menu shortcuts may cease to
5299 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5300 __repr__
= _swig_repr
5301 def __init__(self
, *args
, **kwargs
):
5303 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5305 Construct a new `wx.KeyEvent`. Valid event types are:
5308 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
5309 def GetModifiers(*args
, **kwargs
):
5311 GetModifiers(self) -> int
5313 Returns a bitmask of the current modifier settings. Can be used to
5314 check if the key event has exactly the given modifiers without having
5315 to explicitly check that the other modifiers are not down. For
5318 if event.GetModifers() == wx.MOD_CONTROL:
5322 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5324 def ControlDown(*args
, **kwargs
):
5326 ControlDown(self) -> bool
5328 Returns ``True`` if the Control key was down at the time of the event.
5330 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5332 def MetaDown(*args
, **kwargs
):
5334 MetaDown(self) -> bool
5336 Returns ``True`` if the Meta key was down at the time of the event.
5338 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5340 def AltDown(*args
, **kwargs
):
5342 AltDown(self) -> bool
5344 Returns ``True`` if the Alt key was down at the time of the event.
5346 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5348 def ShiftDown(*args
, **kwargs
):
5350 ShiftDown(self) -> bool
5352 Returns ``True`` if the Shift key was down at the time of the event.
5354 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5356 def CmdDown(*args
, **kwargs
):
5358 CmdDown(self) -> bool
5360 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5361 platforms but the special "Apple" (a.k.a as "Command") key on
5362 Macs. It makes often sense to use it instead of, say, `ControlDown`
5363 because Cmd key is used for the same thing under Mac as Ctrl
5364 elsewhere. The Ctrl still exists, it's just not used for this
5365 purpose. So for non-Mac platforms this is the same as `ControlDown`
5366 and Macs this is the same as `MetaDown`.
5368 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5370 def HasModifiers(*args
, **kwargs
):
5372 HasModifiers(self) -> bool
5374 Returns true if either CTRL or ALT keys was down at the time of the
5375 key event. Note that this function does not take into account neither
5376 SHIFT nor META key states (the reason for ignoring the latter is that
5377 it is common for NUMLOCK key to be configured as META under X but the
5378 key presses even while NUMLOCK is on should be still processed
5381 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5383 def GetKeyCode(*args
, **kwargs
):
5385 GetKeyCode(self) -> int
5387 Returns the virtual key code. ASCII events return normal ASCII values,
5388 while non-ASCII events return values such as WXK_LEFT for the left
5389 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5392 Note that in Unicode build, the returned value is meaningful only if
5393 the user entered a character that can be represented in current
5394 locale's default charset. You can obtain the corresponding Unicode
5395 character using `GetUnicodeKey`.
5397 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5399 def GetUnicodeKey(*args
, **kwargs
):
5401 GetUnicodeKey(self) -> int
5403 Returns the Unicode character corresponding to this key event. This
5404 function is only meaningfule in a Unicode build of wxPython.
5406 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5408 GetUniChar
= GetUnicodeKey
5409 def SetUnicodeKey(*args
, **kwargs
):
5411 SetUnicodeKey(self, int uniChar)
5413 Set the Unicode value of the key event, but only if this is a Unicode
5416 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5418 def GetRawKeyCode(*args
, **kwargs
):
5420 GetRawKeyCode(self) -> unsigned int
5422 Returns the raw key code for this event. This is a platform-dependent
5423 scan code which should only be used in advanced
5424 applications. Currently the raw key codes are not supported by all
5427 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5429 def GetRawKeyFlags(*args
, **kwargs
):
5431 GetRawKeyFlags(self) -> unsigned int
5433 Returns the low level key flags for this event. The flags are
5434 platform-dependent and should only be used in advanced applications.
5435 Currently the raw key flags are not supported by all ports.
5437 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5439 def GetPosition(*args
, **kwargs
):
5441 GetPosition(self) -> Point
5443 Find the position of the event, if applicable.
5445 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5447 def GetPositionTuple(*args
, **kwargs
):
5449 GetPositionTuple() -> (x,y)
5451 Find the position of the event, if applicable.
5453 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5455 def GetX(*args
, **kwargs
):
5459 Returns the X position (in client coordinates) of the event, if
5462 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5464 def GetY(*args
, **kwargs
):
5468 Returns the Y position (in client coordinates) of the event, if
5471 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5473 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5474 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5475 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5476 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5477 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5478 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5479 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5480 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5481 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5482 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5483 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5484 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5485 Position
= property(GetPosition
,doc
="See `GetPosition`")
5486 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5487 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5488 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5489 X
= property(GetX
,doc
="See `GetX`")
5490 Y
= property(GetY
,doc
="See `GetY`")
5491 _core_
.KeyEvent_swigregister(KeyEvent
)
5493 #---------------------------------------------------------------------------
5495 class SizeEvent(Event
):
5497 A size event holds information about size change events. The EVT_SIZE
5498 handler function will be called when the window it is bound to has
5501 Note that the size passed is of the whole window: call
5502 `wx.Window.GetClientSize` for the area which may be used by the
5505 When a window is resized, usually only a small part of the window is
5506 damaged and and that area is all that is in the update region for the
5507 next paint event. However, if your drawing depends on the size of the
5508 window, you may need to clear the DC explicitly and repaint the whole
5509 window. In which case, you may need to call `wx.Window.Refresh` to
5510 invalidate the entire window.
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
):
5517 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5519 Construct a new ``wx.SizeEvent``.
5521 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5522 def GetSize(*args
, **kwargs
):
5524 GetSize(self) -> Size
5526 Returns the entire size of the window generating the size change
5529 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5531 def GetRect(*args
, **kwargs
):
5532 """GetRect(self) -> Rect"""
5533 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5535 def SetRect(*args
, **kwargs
):
5536 """SetRect(self, Rect rect)"""
5537 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5539 def SetSize(*args
, **kwargs
):
5540 """SetSize(self, Size size)"""
5541 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5543 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5544 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5545 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5546 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5547 _core_
.SizeEvent_swigregister(SizeEvent
)
5549 #---------------------------------------------------------------------------
5551 class MoveEvent(Event
):
5553 This event object is sent for EVT_MOVE event bindings when a window is
5554 moved to a new position.
5556 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5557 __repr__
= _swig_repr
5558 def __init__(self
, *args
, **kwargs
):
5560 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5564 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5565 def GetPosition(*args
, **kwargs
):
5567 GetPosition(self) -> Point
5569 Returns the position of the window generating the move change event.
5571 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5573 def GetRect(*args
, **kwargs
):
5574 """GetRect(self) -> Rect"""
5575 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5577 def SetRect(*args
, **kwargs
):
5578 """SetRect(self, Rect rect)"""
5579 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5581 def SetPosition(*args
, **kwargs
):
5582 """SetPosition(self, Point pos)"""
5583 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5585 m_pos
= property(GetPosition
, SetPosition
)
5586 m_rect
= property(GetRect
, SetRect
)
5588 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5589 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5590 _core_
.MoveEvent_swigregister(MoveEvent
)
5592 #---------------------------------------------------------------------------
5594 class PaintEvent(Event
):
5596 A paint event is sent when a window's contents needs to be repainted.
5597 Note that in an EVT_PAINT handler the application must *always* create
5598 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5599 Windows assumes that the window has not been painted yet and will send
5600 the event again, causing endless refreshes.
5602 You can optimize painting by retrieving the rectangles that have been
5603 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5604 and only repainting these rectangles. The rectangles are in terms of
5605 the client area, and are unscrolled, so you will need to do some
5606 calculations using the current view position to obtain logical,
5610 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5611 __repr__
= _swig_repr
5612 def __init__(self
, *args
, **kwargs
):
5613 """__init__(self, int Id=0) -> PaintEvent"""
5614 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5615 _core_
.PaintEvent_swigregister(PaintEvent
)
5617 class NcPaintEvent(Event
):
5618 """Proxy of C++ NcPaintEvent class"""
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
):
5622 """__init__(self, int winid=0) -> NcPaintEvent"""
5623 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5624 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5626 #---------------------------------------------------------------------------
5628 class EraseEvent(Event
):
5630 An erase event is sent whenever the background of a window needs to be
5631 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5632 binder. On some platforms, such as GTK+, this event is simulated
5633 (simply generated just before the paint event) and may cause flicker.
5635 To paint a custom background use the `GetDC` method and use the returned
5636 device context if it is not ``None``, otherwise create a temporary
5637 `wx.ClientDC` and draw on that.
5640 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5641 __repr__
= _swig_repr
5642 def __init__(self
, *args
, **kwargs
):
5644 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5648 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5649 def GetDC(*args
, **kwargs
):
5653 Returns the device context the event handler should draw upon. If
5654 ``None`` is returned then create a temporary `wx.ClientDC` and use
5657 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5659 DC
= property(GetDC
,doc
="See `GetDC`")
5660 _core_
.EraseEvent_swigregister(EraseEvent
)
5662 #---------------------------------------------------------------------------
5664 class FocusEvent(Event
):
5666 A focus event is sent when a window's focus changes. The window losing
5667 focus receives an EVT_KILL_FOCUS event while the window gaining it
5668 gets an EVT_SET_FOCUS event.
5670 Notice that the set focus event happens both when the user gives focus
5671 to the window (whether using the mouse or keyboard) and when it is
5672 done from the program itself using `wx.Window.SetFocus`.
5675 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5676 __repr__
= _swig_repr
5677 def __init__(self
, *args
, **kwargs
):
5679 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5683 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5684 def GetWindow(*args
, **kwargs
):
5686 GetWindow(self) -> Window
5688 Returns the other window associated with this event, that is the
5689 window which had the focus before for the EVT_SET_FOCUS event and the
5690 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5692 Warning: the window returned may be None!
5694 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5696 def SetWindow(*args
, **kwargs
):
5697 """SetWindow(self, Window win)"""
5698 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5700 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5701 _core_
.FocusEvent_swigregister(FocusEvent
)
5703 #---------------------------------------------------------------------------
5705 class ChildFocusEvent(CommandEvent
):
5707 A child focus event is sent to a (parent-)window when one of its child
5708 windows gains focus, so that the window could restore the focus back
5709 to its corresponding child if it loses it now and regains later.
5711 Notice that child window is the direct child of the window receiving
5712 the event, and so may not be the actual widget recieving focus if it
5713 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5714 to get the widget that is actually receiving focus.
5716 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5717 __repr__
= _swig_repr
5718 def __init__(self
, *args
, **kwargs
):
5720 __init__(self, Window win=None) -> ChildFocusEvent
5724 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5725 def GetWindow(*args
, **kwargs
):
5727 GetWindow(self) -> Window
5729 The window, or (grand)parent of the window which has just received the
5732 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5734 Window
= property(GetWindow
,doc
="See `GetWindow`")
5735 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5737 #---------------------------------------------------------------------------
5739 class ActivateEvent(Event
):
5741 An activate event is sent when a top-level window or the entire
5742 application is being activated or deactivated.
5744 A top-level window (a dialog or frame) receives an activate event when
5745 is being activated or deactivated. This is indicated visually by the
5746 title bar changing colour, and a subwindow gaining the keyboard focus.
5747 An application is activated or deactivated when one of its frames
5748 becomes activated, or a frame becomes inactivate resulting in all
5749 application frames being inactive.
5751 Please note that usually you should call event.Skip() in your handlers
5752 for these events so the default handlers will still be called, as not
5753 doing so can result in strange effects.
5756 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5757 __repr__
= _swig_repr
5758 def __init__(self
, *args
, **kwargs
):
5760 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5764 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5765 def GetActive(*args
, **kwargs
):
5767 GetActive(self) -> bool
5769 Returns true if the application or window is being activated, false
5772 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5774 Active
= property(GetActive
,doc
="See `GetActive`")
5775 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5777 #---------------------------------------------------------------------------
5779 class InitDialogEvent(Event
):
5781 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5782 any window when `wx.Window.InitDialog` is called. Handlers for this
5783 event can transfer data to the window, or anything else that should be
5784 done before the user begins editing the form. The default handler
5785 calls `wx.Window.TransferDataToWindow`.
5787 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5788 __repr__
= _swig_repr
5789 def __init__(self
, *args
, **kwargs
):
5791 __init__(self, int Id=0) -> InitDialogEvent
5795 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5796 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5798 #---------------------------------------------------------------------------
5800 class MenuEvent(Event
):
5802 This class is used for a variety of menu-related events. Note that
5803 these do not include menu command events, which are handled by sending
5804 `wx.CommandEvent` objects.
5806 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5807 text in the first field of the status bar.
5809 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5810 __repr__
= _swig_repr
5811 def __init__(self
, *args
, **kwargs
):
5813 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5817 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5818 def GetMenuId(*args
, **kwargs
):
5820 GetMenuId(self) -> int
5822 Returns the menu identifier associated with the event. This method
5823 should be only used with the HIGHLIGHT events.
5825 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5827 def IsPopup(*args
, **kwargs
):
5829 IsPopup(self) -> bool
5831 Returns ``True`` if the menu which is being opened or closed is a
5832 popup menu, ``False`` if it is a normal one. This method should only
5833 be used with the OPEN and CLOSE events.
5835 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5837 def GetMenu(*args
, **kwargs
):
5839 GetMenu(self) -> Menu
5841 Returns the menu which is being opened or closed. This method should
5842 only be used with the OPEN and CLOSE events.
5844 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5846 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5847 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5848 _core_
.MenuEvent_swigregister(MenuEvent
)
5850 #---------------------------------------------------------------------------
5852 class CloseEvent(Event
):
5854 This event class contains information about window and session close
5857 The handler function for EVT_CLOSE is called when the user has tried
5858 to close a a frame or dialog box using the window manager controls or
5859 the system menu. It can also be invoked by the application itself
5860 programmatically, for example by calling the `wx.Window.Close`
5863 You should check whether the application is forcing the deletion of
5864 the window using `CanVeto`. If it returns ``False``, you must destroy
5865 the window using `wx.Window.Destroy`. If the return value is ``True``,
5866 it is up to you whether you respond by destroying the window or not.
5867 For example you may wish to display a message dialog prompting to save
5868 files or to cancel the close.
5870 If you don't destroy the window, you should call `Veto` to let the
5871 calling code know that you did not destroy the window. This allows the
5872 `wx.Window.Close` function to return ``True`` or ``False`` depending
5873 on whether the close instruction was honored or not.
5875 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5876 __repr__
= _swig_repr
5877 def __init__(self
, *args
, **kwargs
):
5879 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5883 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5884 def SetLoggingOff(*args
, **kwargs
):
5886 SetLoggingOff(self, bool logOff)
5888 Sets the 'logging off' flag.
5890 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5892 def GetLoggingOff(*args
, **kwargs
):
5894 GetLoggingOff(self) -> bool
5896 Returns ``True`` if the user is logging off or ``False`` if the
5897 system is shutting down. This method can only be called for end
5898 session and query end session events, it doesn't make sense for close
5901 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5903 def Veto(*args
, **kwargs
):
5905 Veto(self, bool veto=True)
5907 Call this from your event handler to veto a system shutdown or to
5908 signal to the calling application that a window close did not happen.
5910 You can only veto a shutdown or close if `CanVeto` returns true.
5912 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5914 def GetVeto(*args
, **kwargs
):
5915 """GetVeto(self) -> bool"""
5916 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5918 def SetCanVeto(*args
, **kwargs
):
5920 SetCanVeto(self, bool canVeto)
5922 Sets the 'can veto' flag.
5924 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5926 def CanVeto(*args
, **kwargs
):
5928 CanVeto(self) -> bool
5930 Returns true if you can veto a system shutdown or a window close
5931 event. Vetoing a window close event is not possible if the calling
5932 code wishes to force the application to exit, and so this function
5933 must be called to check this.
5935 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5937 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5938 _core_
.CloseEvent_swigregister(CloseEvent
)
5940 #---------------------------------------------------------------------------
5942 class ShowEvent(Event
):
5943 """An EVT_SHOW event is sent when a window is shown or hidden."""
5944 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5945 __repr__
= _swig_repr
5946 def __init__(self
, *args
, **kwargs
):
5948 __init__(self, int winid=0, bool show=False) -> ShowEvent
5950 An EVT_SHOW event is sent when a window is shown or hidden.
5952 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5953 def SetShow(*args
, **kwargs
):
5954 """SetShow(self, bool show)"""
5955 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5957 def GetShow(*args
, **kwargs
):
5958 """GetShow(self) -> bool"""
5959 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5961 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5962 _core_
.ShowEvent_swigregister(ShowEvent
)
5964 #---------------------------------------------------------------------------
5966 class IconizeEvent(Event
):
5968 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5971 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5972 __repr__
= _swig_repr
5973 def __init__(self
, *args
, **kwargs
):
5975 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5977 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5980 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5981 def Iconized(*args
, **kwargs
):
5983 Iconized(self) -> bool
5985 Returns ``True`` if the frame has been iconized, ``False`` if it has
5988 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5990 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5992 #---------------------------------------------------------------------------
5994 class MaximizeEvent(Event
):
5995 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5996 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5997 __repr__
= _swig_repr
5998 def __init__(self
, *args
, **kwargs
):
6000 __init__(self, int id=0) -> MaximizeEvent
6002 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
6004 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
6005 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
6007 #---------------------------------------------------------------------------
6009 class DropFilesEvent(Event
):
6011 This class is used for drop files events, that is, when files have
6012 been dropped onto the window. This functionality is only available
6013 under Windows. The window must have previously been enabled for
6014 dropping by calling `wx.Window.DragAcceptFiles`.
6016 Important note: this is a separate implementation to the more general
6017 drag and drop implementation using `wx.FileDropTarget`, and etc. This
6018 implementation uses the older, Windows message-based approach of
6021 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
6025 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6026 def __init__(self
): raise AttributeError, "No constructor defined"
6027 __repr__
= _swig_repr
6028 def GetPosition(*args
, **kwargs
):
6030 GetPosition(self) -> Point
6032 Returns the position at which the files were dropped.
6034 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
6036 def GetNumberOfFiles(*args
, **kwargs
):
6038 GetNumberOfFiles(self) -> int
6040 Returns the number of files dropped.
6042 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
6044 def GetFiles(*args
, **kwargs
):
6046 GetFiles(self) -> PyObject
6048 Returns a list of the filenames that were dropped.
6050 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
6052 Files
= property(GetFiles
,doc
="See `GetFiles`")
6053 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
6054 Position
= property(GetPosition
,doc
="See `GetPosition`")
6055 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
6057 #---------------------------------------------------------------------------
6059 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
6060 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
6061 class UpdateUIEvent(CommandEvent
):
6063 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
6064 wxWidgets to give an application the chance to update various user
6067 Without update UI events, an application has to work hard to
6068 check/uncheck, enable/disable, and set the text for elements such as
6069 menu items and toolbar buttons. The code for doing this has to be
6070 mixed up with the code that is invoked when an action is invoked for a
6071 menu item or button.
6073 With update UI events, you define an event handler to look at the
6074 state of the application and change UI elements accordingly. wxWidgets
6075 will call your handler functions in idle time, so you don't have to
6076 worry where to call this code. In addition to being a clearer and more
6077 declarative method, it also means you don't have to worry whether
6078 you're updating a toolbar or menubar identifier. The same handler can
6079 update a menu item and toolbar button, if the ID values are the same.
6081 Instead of directly manipulating the menu or button, you call
6082 functions in the event object, such as `Check`. wxWidgets will
6083 determine whether such a call has been made, and which UI element to
6086 These events will work for popup menus as well as menubars. Just
6087 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6088 any UI events for the window that owns the menu.
6090 If you find that the overhead of UI update processing is affecting
6091 your application, you can do one or both of the following:
6093 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6094 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6095 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6096 receive update events. No other windows will receive update
6099 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6100 value to set the delay between updates. You may need to call
6101 `wx.Window.UpdateWindowUI` at critical points, for example when
6102 a dialog is about to be shown, in case the user sees a slight
6103 delay before windows are updated.
6105 Note that although events are sent in idle time, defining a EVT_IDLE
6106 handler for a window does not affect this because the events are sent
6107 from an internal idle handler.
6109 wxWidgets tries to optimize update events on some platforms. On
6110 Windows and GTK+, events for menubar items are only sent when the menu
6111 is about to be shown, and not in idle time.
6114 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6115 __repr__
= _swig_repr
6116 def __init__(self
, *args
, **kwargs
):
6118 __init__(self, int commandId=0) -> UpdateUIEvent
6122 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
6123 def GetChecked(*args
, **kwargs
):
6125 GetChecked(self) -> bool
6127 Returns ``True`` if the UI element should be checked.
6129 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6131 def GetEnabled(*args
, **kwargs
):
6133 GetEnabled(self) -> bool
6135 Returns ``True`` if the UI element should be enabled.
6137 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6139 def GetShown(*args
, **kwargs
):
6141 GetShown(self) -> bool
6143 Returns ``True`` if the UI element should be shown.
6145 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6147 def GetText(*args
, **kwargs
):
6149 GetText(self) -> String
6151 Returns the text that should be set for the UI element.
6153 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6155 def GetSetText(*args
, **kwargs
):
6157 GetSetText(self) -> bool
6159 Returns ``True`` if the application has called `SetText`. For
6160 wxWidgets internal use only.
6162 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6164 def GetSetChecked(*args
, **kwargs
):
6166 GetSetChecked(self) -> bool
6168 Returns ``True`` if the application has called `Check`. For wxWidgets
6171 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6173 def GetSetEnabled(*args
, **kwargs
):
6175 GetSetEnabled(self) -> bool
6177 Returns ``True`` if the application has called `Enable`. For wxWidgets
6180 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6182 def GetSetShown(*args
, **kwargs
):
6184 GetSetShown(self) -> bool
6186 Returns ``True`` if the application has called `Show`. For wxWidgets
6189 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6191 def Check(*args
, **kwargs
):
6193 Check(self, bool check)
6195 Check or uncheck the UI element.
6197 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6199 def Enable(*args
, **kwargs
):
6201 Enable(self, bool enable)
6203 Enable or disable the UI element.
6205 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6207 def Show(*args
, **kwargs
):
6209 Show(self, bool show)
6211 Show or hide the UI element.
6213 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6215 def SetText(*args
, **kwargs
):
6217 SetText(self, String text)
6219 Sets the text for this UI element.
6221 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6223 def SetUpdateInterval(*args
, **kwargs
):
6225 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 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6240 def GetUpdateInterval(*args
, **kwargs
):
6242 GetUpdateInterval() -> long
6244 Returns the current interval between updates in milliseconds. -1
6245 disables updates, 0 updates as frequently as possible.
6247 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6249 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6250 def CanUpdate(*args
, **kwargs
):
6252 CanUpdate(Window win) -> bool
6254 Returns ``True`` if it is appropriate to update (send UI update events
6257 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6258 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6259 events were last sent in idle time, and the update interval, to
6260 determine whether events should be sent to this window now. By default
6261 this will always return true because the update mode is initially
6262 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6263 events will be sent as often as possible. You can reduce the frequency
6264 that events are sent by changing the mode and/or setting an update
6268 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6270 CanUpdate
= staticmethod(CanUpdate
)
6271 def ResetUpdateTime(*args
, **kwargs
):
6275 Used internally to reset the last-updated time to the current time. It
6276 is assumed that update events are normally sent in idle time, so this
6277 is called at the end of idle processing.
6279 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6281 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6282 def SetMode(*args
, **kwargs
):
6286 Specify how wxWidgets will send update events: to all windows, or only
6287 to those which specify that they will process the events.
6289 The mode may be one of the following values:
6291 ============================= ==========================================
6292 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6293 is the default setting.
6294 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6295 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6297 ============================= ==========================================
6300 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6302 SetMode
= staticmethod(SetMode
)
6303 def GetMode(*args
, **kwargs
):
6307 Returns a value specifying how wxWidgets will send update events: to
6308 all windows, or only to those which specify that they will process the
6311 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6313 GetMode
= staticmethod(GetMode
)
6314 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
6315 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
6316 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
6317 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
6318 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
6320 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6322 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6324 Sets the interval between updates in milliseconds. Set to -1 to
6325 disable updates, or to 0 to update as frequently as possible. The
6328 Use this to reduce the overhead of UI update events if your
6329 application has a lot of windows. If you set the value to -1 or
6330 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6331 at appropriate points in your application, such as when a dialog is
6334 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6336 def UpdateUIEvent_GetUpdateInterval(*args
):
6338 UpdateUIEvent_GetUpdateInterval() -> long
6340 Returns the current interval between updates in milliseconds. -1
6341 disables updates, 0 updates as frequently as possible.
6343 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
6345 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6347 UpdateUIEvent_CanUpdate(Window win) -> bool
6349 Returns ``True`` if it is appropriate to update (send UI update events
6352 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6353 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6354 events were last sent in idle time, and the update interval, to
6355 determine whether events should be sent to this window now. By default
6356 this will always return true because the update mode is initially
6357 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6358 events will be sent as often as possible. You can reduce the frequency
6359 that events are sent by changing the mode and/or setting an update
6363 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6365 def UpdateUIEvent_ResetUpdateTime(*args
):
6367 UpdateUIEvent_ResetUpdateTime()
6369 Used internally to reset the last-updated time to the current time. It
6370 is assumed that update events are normally sent in idle time, so this
6371 is called at the end of idle processing.
6373 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6375 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6377 UpdateUIEvent_SetMode(int mode)
6379 Specify how wxWidgets will send update events: to all windows, or only
6380 to those which specify that they will process the events.
6382 The mode may be one of the following values:
6384 ============================= ==========================================
6385 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6386 is the default setting.
6387 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6388 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6390 ============================= ==========================================
6393 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6395 def UpdateUIEvent_GetMode(*args
):
6397 UpdateUIEvent_GetMode() -> int
6399 Returns a value specifying how wxWidgets will send update events: to
6400 all windows, or only to those which specify that they will process the
6403 return _core_
.UpdateUIEvent_GetMode(*args
)
6405 #---------------------------------------------------------------------------
6407 class SysColourChangedEvent(Event
):
6409 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6410 when the user changes the colour settings using the control
6411 panel. This is only applicable under Windows.
6413 The default event handler for this event propagates the event to child
6414 windows, since Windows only sends the events to top-level windows. If
6415 intercepting this event for a top-level window, remember to call
6416 `Skip` so the the base class handler will still be executed, or to
6417 pass the event on to the window's children explicitly.
6420 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6421 __repr__
= _swig_repr
6422 def __init__(self
, *args
, **kwargs
):
6424 __init__(self) -> SysColourChangedEvent
6428 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6429 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6431 #---------------------------------------------------------------------------
6433 class MouseCaptureChangedEvent(Event
):
6435 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6436 a window that loses its mouse capture. This is called even if
6437 `wx.Window.ReleaseMouse` was called by the application code. Handling
6438 this event allows an application to cater for unexpected capture
6439 releases which might otherwise confuse mouse handling code.
6441 This event is implemented under Windows only.
6443 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6444 __repr__
= _swig_repr
6445 def __init__(self
, *args
, **kwargs
):
6447 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6451 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6452 def GetCapturedWindow(*args
, **kwargs
):
6454 GetCapturedWindow(self) -> Window
6456 Returns the window that gained the capture, or ``None`` if it was a
6457 non-wxWidgets window.
6459 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6461 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6462 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6464 #---------------------------------------------------------------------------
6466 class MouseCaptureLostEvent(Event
):
6468 A mouse capture lost event is sent to a window that obtained mouse
6469 capture, which was subsequently loss due to "external" event, for
6470 example when a dialog box is shown or if another application captures
6473 If this happens, this event is sent to all windows that are on the
6474 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6475 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6476 if the capture changes because of a call to CaptureMouse or
6479 This event is currently emitted under Windows only.
6482 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6483 __repr__
= _swig_repr
6484 def __init__(self
, *args
, **kwargs
):
6486 __init__(self, int winid=0) -> MouseCaptureLostEvent
6488 A mouse capture lost event is sent to a window that obtained mouse
6489 capture, which was subsequently loss due to "external" event, for
6490 example when a dialog box is shown or if another application captures
6493 If this happens, this event is sent to all windows that are on the
6494 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6495 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6496 if the capture changes because of a call to CaptureMouse or
6499 This event is currently emitted under Windows only.
6502 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6503 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6505 #---------------------------------------------------------------------------
6507 class DisplayChangedEvent(Event
):
6509 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6510 resolution has changed.
6512 This event is implemented under Windows only.
6514 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6515 __repr__
= _swig_repr
6516 def __init__(self
, *args
, **kwargs
):
6517 """__init__(self) -> DisplayChangedEvent"""
6518 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6519 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6521 #---------------------------------------------------------------------------
6523 class PaletteChangedEvent(Event
):
6525 An EVT_PALETTE_CHANGED event is sent when the system palette has
6526 changed, thereby giving each window a chance to redo their own to
6529 This event is implemented under Windows only.
6531 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6532 __repr__
= _swig_repr
6533 def __init__(self
, *args
, **kwargs
):
6535 __init__(self, int id=0) -> PaletteChangedEvent
6537 An EVT_PALETTE_CHANGED event is sent when the system palette has
6538 changed, thereby giving each window a chance to redo their own to
6541 This event is implemented under Windows only.
6543 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6544 def SetChangedWindow(*args
, **kwargs
):
6545 """SetChangedWindow(self, Window win)"""
6546 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6548 def GetChangedWindow(*args
, **kwargs
):
6549 """GetChangedWindow(self) -> Window"""
6550 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6552 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6553 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6555 #---------------------------------------------------------------------------
6557 class QueryNewPaletteEvent(Event
):
6559 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6560 focus and should re-do its palette.
6562 This event is implemented under Windows only.
6564 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6565 __repr__
= _swig_repr
6566 def __init__(self
, *args
, **kwargs
):
6568 __init__(self, int winid=0) -> QueryNewPaletteEvent
6572 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6573 def SetPaletteRealized(*args
, **kwargs
):
6575 SetPaletteRealized(self, bool realized)
6577 App should set this if it changes the palette.
6579 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6581 def GetPaletteRealized(*args
, **kwargs
):
6582 """GetPaletteRealized(self) -> bool"""
6583 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6585 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6586 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6588 #---------------------------------------------------------------------------
6590 class NavigationKeyEvent(Event
):
6592 EVT_NAVIGATION_KEY events are used to control moving the focus between
6593 widgets, otherwise known as tab-traversal. You woudl normally not
6594 catch navigation events in applications as there are already
6595 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6596 it useful to send navigation events in certain situations to change
6597 the focus in certain ways, although it's probably easier to just call
6598 `wx.Window.Navigate`.
6600 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6601 __repr__
= _swig_repr
6602 def __init__(self
, *args
, **kwargs
):
6603 """__init__(self) -> NavigationKeyEvent"""
6604 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6605 def GetDirection(*args
, **kwargs
):
6607 GetDirection(self) -> bool
6609 Returns ``True`` if the direction is forward, ``False`` otherwise.
6611 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6613 def SetDirection(*args
, **kwargs
):
6615 SetDirection(self, bool forward)
6617 Specify the direction that the navigation should take. Usually the
6618 difference between using Tab and Shift-Tab.
6620 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6622 def IsWindowChange(*args
, **kwargs
):
6624 IsWindowChange(self) -> bool
6626 Returns ``True`` if window change is allowed.
6628 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6630 def SetWindowChange(*args
, **kwargs
):
6632 SetWindowChange(self, bool ischange)
6634 Specify if the navigation should be able to change parent windows.
6635 For example, changing notebook pages, etc. This is usually implemented
6636 by using Control-Tab.
6638 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6640 def IsFromTab(*args
, **kwargs
):
6642 IsFromTab(self) -> bool
6644 Returns ``True`` if the navigation event is originated from the Tab
6647 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6649 def SetFromTab(*args
, **kwargs
):
6651 SetFromTab(self, bool bIs)
6653 Set to true under MSW if the event was generated using the tab key.
6654 This is required for proper navogation over radio buttons.
6656 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6658 def SetFlags(*args
, **kwargs
):
6660 SetFlags(self, long flags)
6662 Set the navigation flags to a combination of the following:
6664 * wx.NavigationKeyEvent.IsBackward
6665 * wx.NavigationKeyEvent.IsForward
6666 * wx.NavigationKeyEvent.WinChange
6667 * wx.NavigationKeyEvent.FromTab
6670 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6672 def GetCurrentFocus(*args
, **kwargs
):
6674 GetCurrentFocus(self) -> Window
6676 Returns the child window which currenty has the focus. May be
6679 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6681 def SetCurrentFocus(*args
, **kwargs
):
6683 SetCurrentFocus(self, Window win)
6685 Set the window that has the focus.
6687 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6689 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6690 IsForward
= _core_
.NavigationKeyEvent_IsForward
6691 WinChange
= _core_
.NavigationKeyEvent_WinChange
6692 FromTab
= _core_
.NavigationKeyEvent_FromTab
6693 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6694 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6695 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6697 #---------------------------------------------------------------------------
6699 class WindowCreateEvent(CommandEvent
):
6701 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6702 underlying GUI object) exists.
6704 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6705 __repr__
= _swig_repr
6706 def __init__(self
, *args
, **kwargs
):
6708 __init__(self, Window win=None) -> WindowCreateEvent
6710 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6711 underlying GUI object) exists.
6713 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6714 def GetWindow(*args
, **kwargs
):
6716 GetWindow(self) -> Window
6718 Returns the window that this event refers to.
6720 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6722 Window
= property(GetWindow
,doc
="See `GetWindow`")
6723 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6725 class WindowDestroyEvent(CommandEvent
):
6727 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6728 when the GUI window is destroyed.
6730 When a class derived from `wx.Window` is destroyed its destructor will
6731 have already run by the time this event is sent. Therefore this event
6732 will not usually be received at all by the window itself. Since it is
6733 received after the destructor has run, an object should not try to
6734 handle its own wx.WindowDestroyEvent, but it can be used to get
6735 notification of the destruction of another window.
6737 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6738 __repr__
= _swig_repr
6739 def __init__(self
, *args
, **kwargs
):
6741 __init__(self, Window win=None) -> WindowDestroyEvent
6743 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6744 when the GUI window is destroyed.
6746 When a class derived from `wx.Window` is destroyed its destructor will
6747 have already run by the time this event is sent. Therefore this event
6748 will not usually be received at all by the window itself. Since it is
6749 received after the destructor has run, an object should not try to
6750 handle its own wx.WindowDestroyEvent, but it can be used to get
6751 notification of the destruction of another window.
6753 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6754 def GetWindow(*args
, **kwargs
):
6756 GetWindow(self) -> Window
6758 Returns the window that this event refers to.
6760 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6762 Window
= property(GetWindow
,doc
="See `GetWindow`")
6763 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6765 #---------------------------------------------------------------------------
6767 class ContextMenuEvent(CommandEvent
):
6769 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6770 give the application a chance to show a context (popup) menu.
6772 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6773 __repr__
= _swig_repr
6774 def __init__(self
, *args
, **kwargs
):
6776 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6780 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6781 def GetPosition(*args
, **kwargs
):
6783 GetPosition(self) -> Point
6785 Returns the position (in screen coordinants) at which the menu should
6788 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6790 def SetPosition(*args
, **kwargs
):
6792 SetPosition(self, Point pos)
6794 Sets the position at which the menu should be shown.
6796 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6798 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6799 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6801 #---------------------------------------------------------------------------
6803 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6804 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6805 class IdleEvent(Event
):
6807 This class is used for EVT_IDLE events, which are generated and sent
6808 when the application *becomes* idle. In other words, the when the
6809 event queue becomes empty then idle events are sent to all windows (by
6810 default) and as long as none of them call `RequestMore` then there are
6811 no more idle events until after the system event queue has some normal
6812 events and then becomes empty again.
6814 By default, idle events are sent to all windows. If this is causing a
6815 significant overhead in your application, you can call
6816 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6817 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6818 which should receive idle events. Then idle events will only be sent
6819 to those windows and not to any others.
6821 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6822 __repr__
= _swig_repr
6823 def __init__(self
, *args
, **kwargs
):
6825 __init__(self) -> IdleEvent
6829 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6830 def RequestMore(*args
, **kwargs
):
6832 RequestMore(self, bool needMore=True)
6834 Tells wxWidgets that more processing is required. This function can be
6835 called by an EVT_IDLE handler for a window to indicate that the
6836 application should forward the EVT_IDLE event once more to the
6837 application windows. If no window calls this function during its
6838 EVT_IDLE handler, then the application will remain in a passive event
6839 loop until a new event is posted to the application by the windowing
6842 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6844 def MoreRequested(*args
, **kwargs
):
6846 MoreRequested(self) -> bool
6848 Returns ``True`` if the OnIdle function processing this event
6849 requested more processing time.
6851 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6853 def SetMode(*args
, **kwargs
):
6857 Static method for specifying how wxWidgets will send idle events: to
6858 all windows, or only to those which specify that they will process the
6861 The mode can be one of the following values:
6863 ========================= ========================================
6864 wx.IDLE_PROCESS_ALL Send idle events to all windows
6865 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6866 the wx.WS_EX_PROCESS_IDLE extra style
6868 ========================= ========================================
6871 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6873 SetMode
= staticmethod(SetMode
)
6874 def GetMode(*args
, **kwargs
):
6878 Static method returning a value specifying how wxWidgets will send
6879 idle events: to all windows, or only to those which specify that they
6880 will process the events.
6882 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6884 GetMode
= staticmethod(GetMode
)
6885 def CanSend(*args
, **kwargs
):
6887 CanSend(Window win) -> bool
6889 Returns ``True`` if it is appropriate to send idle events to this
6892 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6893 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6894 events should be sent to this window now. By default this will always
6895 return ``True`` because the update mode is initially
6896 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6897 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6899 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6901 CanSend
= staticmethod(CanSend
)
6902 _core_
.IdleEvent_swigregister(IdleEvent
)
6904 def IdleEvent_SetMode(*args
, **kwargs
):
6906 IdleEvent_SetMode(int mode)
6908 Static method for specifying how wxWidgets will send idle events: to
6909 all windows, or only to those which specify that they will process the
6912 The mode can be one of the following values:
6914 ========================= ========================================
6915 wx.IDLE_PROCESS_ALL Send idle events to all windows
6916 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6917 the wx.WS_EX_PROCESS_IDLE extra style
6919 ========================= ========================================
6922 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6924 def IdleEvent_GetMode(*args
):
6926 IdleEvent_GetMode() -> int
6928 Static method returning a value specifying how wxWidgets will send
6929 idle events: to all windows, or only to those which specify that they
6930 will process the events.
6932 return _core_
.IdleEvent_GetMode(*args
)
6934 def IdleEvent_CanSend(*args
, **kwargs
):
6936 IdleEvent_CanSend(Window win) -> bool
6938 Returns ``True`` if it is appropriate to send idle events to this
6941 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6942 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6943 events should be sent to this window now. By default this will always
6944 return ``True`` because the update mode is initially
6945 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6946 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6948 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6950 #---------------------------------------------------------------------------
6952 class ClipboardTextEvent(CommandEvent
):
6954 A Clipboard Text event is sent when a window intercepts a text
6955 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6956 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6957 popup menu command, etc. NOTE : under windows these events are *NOT*
6958 generated automatically for a Rich Edit text control.
6960 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6961 __repr__
= _swig_repr
6962 def __init__(self
, *args
, **kwargs
):
6964 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6966 A Clipboard Text event is sent when a window intercepts a text
6967 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6968 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6969 popup menu command, etc. NOTE : under windows these events are *NOT*
6970 generated automatically for a Rich Edit text control.
6972 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6973 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6975 #---------------------------------------------------------------------------
6977 class PyEvent(Event
):
6979 wx.PyEvent can be used as a base class for implementing custom event
6980 types in Python. You should derived from this class instead of
6981 `wx.Event` because this class is Python-aware and is able to transport
6982 its Python bits safely through the wxWidgets event system and have
6983 them still be there when the event handler is invoked.
6985 :see: `wx.PyCommandEvent`
6988 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6989 __repr__
= _swig_repr
6990 def __init__(self
, *args
, **kwargs
):
6991 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6992 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6995 __swig_destroy__
= _core_
.delete_PyEvent
6996 __del__
= lambda self
: None;
6997 def _SetSelf(*args
, **kwargs
):
6998 """_SetSelf(self, PyObject self)"""
6999 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
7001 def _GetSelf(*args
, **kwargs
):
7002 """_GetSelf(self) -> PyObject"""
7003 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
7005 _core_
.PyEvent_swigregister(PyEvent
)
7007 class PyCommandEvent(CommandEvent
):
7009 wx.PyCommandEvent can be used as a base class for implementing custom
7010 event types in Python, where the event shoudl travel up to parent
7011 windows looking for a handler. You should derived from this class
7012 instead of `wx.CommandEvent` because this class is Python-aware and is
7013 able to transport its Python bits safely through the wxWidgets event
7014 system and have them still be there when the event handler is invoked.
7019 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7020 __repr__
= _swig_repr
7021 def __init__(self
, *args
, **kwargs
):
7022 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
7023 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
7026 __swig_destroy__
= _core_
.delete_PyCommandEvent
7027 __del__
= lambda self
: None;
7028 def _SetSelf(*args
, **kwargs
):
7029 """_SetSelf(self, PyObject self)"""
7030 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
7032 def _GetSelf(*args
, **kwargs
):
7033 """_GetSelf(self) -> PyObject"""
7034 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
7036 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
7038 class DateEvent(CommandEvent
):
7040 This event class holds information about a date change event and is
7041 used together with `wx.DatePickerCtrl`. It also serves as a base class
7042 for `wx.calendar.CalendarEvent`. Bind these event types with
7045 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7046 __repr__
= _swig_repr
7047 def __init__(self
, *args
, **kwargs
):
7048 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
7049 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
7050 def GetDate(*args
, **kwargs
):
7052 GetDate(self) -> DateTime
7056 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
7058 def SetDate(*args
, **kwargs
):
7060 SetDate(self, DateTime date)
7062 Sets the date carried by the event, normally only used by the library
7065 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
7067 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
7068 _core_
.DateEvent_swigregister(DateEvent
)
7070 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
7071 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
7073 class EventBlocker(EvtHandler
):
7074 """Helper class to temporarily disable event handling for a window."""
7075 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7076 __repr__
= _swig_repr
7077 def __init__(self
, *args
, **kwargs
):
7079 __init__(self, Window win, EventType type=wxEVT_ANY) -> EventBlocker
7081 Helper class to temporarily disable event handling for a window.
7083 _core_
.EventBlocker_swiginit(self
,_core_
.new_EventBlocker(*args
, **kwargs
))
7084 __swig_destroy__
= _core_
.delete_EventBlocker
7085 __del__
= lambda self
: None;
7086 def Block(*args
, **kwargs
):
7087 """Block(self, EventType type)"""
7088 return _core_
.EventBlocker_Block(*args
, **kwargs
)
7090 _core_
.EventBlocker_swigregister(EventBlocker
)
7092 #---------------------------------------------------------------------------
7094 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
7095 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
7096 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
7097 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
7098 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
7099 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
7100 class PyApp(EvtHandler
):
7102 The ``wx.PyApp`` class is an *implementation detail*, please use the
7103 `wx.App` class (or some other derived class) instead.
7105 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7106 __repr__
= _swig_repr
7107 def __init__(self
, *args
, **kwargs
):
7109 __init__(self) -> PyApp
7111 Create a new application object, starting the bootstrap process.
7113 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
7114 self
._setOORInfo
(self
, False);PyApp
._setCallbackInfo
(self
, self
, PyApp
)
7116 __swig_destroy__
= _core_
.delete_PyApp
7117 __del__
= lambda self
: None;
7118 def _setCallbackInfo(*args
, **kwargs
):
7119 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
7120 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
7122 def GetAppName(*args
, **kwargs
):
7124 GetAppName(self) -> String
7126 Get the application name.
7128 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
7130 def SetAppName(*args
, **kwargs
):
7132 SetAppName(self, String name)
7134 Set the application name. This value may be used automatically by
7135 `wx.Config` and such.
7137 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
7139 def GetClassName(*args
, **kwargs
):
7141 GetClassName(self) -> String
7143 Get the application's class name.
7145 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
7147 def SetClassName(*args
, **kwargs
):
7149 SetClassName(self, String name)
7151 Set the application's class name. This value may be used for
7152 X-resources if applicable for the platform
7154 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
7156 def GetVendorName(*args
, **kwargs
):
7158 GetVendorName(self) -> String
7160 Get the application's vendor name.
7162 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
7164 def SetVendorName(*args
, **kwargs
):
7166 SetVendorName(self, String name)
7168 Set the application's vendor name. This value may be used
7169 automatically by `wx.Config` and such.
7171 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
7173 def GetTraits(*args
, **kwargs
):
7175 GetTraits(self) -> wxAppTraits
7177 Return (and create if necessary) the app traits object to which we
7178 delegate for everything which either should be configurable by the
7179 user (then he can change the default behaviour simply by overriding
7180 CreateTraits() and returning his own traits object) or which is
7181 GUI/console dependent as then wx.AppTraits allows us to abstract the
7182 differences behind the common facade.
7184 :todo: Add support for overriding CreateAppTraits in wxPython.
7186 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
7188 def ProcessPendingEvents(*args
, **kwargs
):
7190 ProcessPendingEvents(self)
7192 Process all events in the Pending Events list -- it is necessary to
7193 call this function to process posted events. This normally happens
7194 during each event loop iteration.
7196 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
7198 def Yield(*args
, **kwargs
):
7200 Yield(self, bool onlyIfNeeded=False) -> bool
7202 Process all currently pending events right now, instead of waiting
7203 until return to the event loop. It is an error to call ``Yield``
7204 recursively unless the value of ``onlyIfNeeded`` is True.
7206 :warning: This function is dangerous as it can lead to unexpected
7207 reentrancies (i.e. when called from an event handler it may
7208 result in calling the same event handler again), use with
7209 extreme care or, better, don't use at all!
7211 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7214 return _core_
.PyApp_Yield(*args
, **kwargs
)
7216 def WakeUpIdle(*args
, **kwargs
):
7220 Make sure that idle events are sent again.
7221 :see: `wx.WakeUpIdle`
7223 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
7225 def IsMainLoopRunning(*args
, **kwargs
):
7227 IsMainLoopRunning() -> bool
7229 Returns True if we're running the main loop, i.e. if the events can
7230 currently be dispatched.
7232 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7234 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
7235 def MainLoop(*args
, **kwargs
):
7237 MainLoop(self) -> int
7239 Execute the main GUI loop, the function doesn't normally return until
7240 all top level windows have been closed and destroyed.
7242 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
7244 def Exit(*args
, **kwargs
):
7248 Exit the main loop thus terminating the application.
7251 return _core_
.PyApp_Exit(*args
, **kwargs
)
7253 def GetLayoutDirection(*args
, **kwargs
):
7255 GetLayoutDirection(self) -> int
7257 Return the layout direction for the current locale.
7259 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
7261 def ExitMainLoop(*args
, **kwargs
):
7265 Exit the main GUI loop during the next iteration of the main
7266 loop, (i.e. it does not stop the program immediately!)
7268 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
7270 def Pending(*args
, **kwargs
):
7272 Pending(self) -> bool
7274 Returns True if there are unprocessed events in the event queue.
7276 return _core_
.PyApp_Pending(*args
, **kwargs
)
7278 def Dispatch(*args
, **kwargs
):
7280 Dispatch(self) -> bool
7282 Process the first event in the event queue (blocks until an event
7283 appears if there are none currently)
7285 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
7287 def ProcessIdle(*args
, **kwargs
):
7289 ProcessIdle(self) -> bool
7291 Called from the MainLoop when the application becomes idle (there are
7292 no pending events) and sends a `wx.IdleEvent` to all interested
7293 parties. Returns True if more idle events are needed, False if not.
7295 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
7297 def SendIdleEvents(*args
, **kwargs
):
7299 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7301 Send idle event to window and all subwindows. Returns True if more
7302 idle time is requested.
7304 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
7306 def IsActive(*args
, **kwargs
):
7308 IsActive(self) -> bool
7310 Return True if our app has focus.
7312 return _core_
.PyApp_IsActive(*args
, **kwargs
)
7314 def SetTopWindow(*args
, **kwargs
):
7316 SetTopWindow(self, Window win)
7318 Set the *main* top level window
7320 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
7322 def GetTopWindow(*args
, **kwargs
):
7324 GetTopWindow(self) -> Window
7326 Return the *main* top level window (if it hadn't been set previously
7327 with SetTopWindow(), will return just some top level window and, if
7328 there not any, will return None)
7330 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
7332 def SetExitOnFrameDelete(*args
, **kwargs
):
7334 SetExitOnFrameDelete(self, bool flag)
7336 Control the exit behaviour: by default, the program will exit the main
7337 loop (and so, usually, terminate) when the last top-level program
7338 window is deleted. Beware that if you disable this behaviour (with
7339 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7340 explicitly from somewhere.
7342 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
7344 def GetExitOnFrameDelete(*args
, **kwargs
):
7346 GetExitOnFrameDelete(self) -> bool
7348 Get the current exit behaviour setting.
7350 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
7352 def SetUseBestVisual(*args
, **kwargs
):
7354 SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
7356 Set whether the app should try to use the best available visual on
7357 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7359 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
7361 def GetUseBestVisual(*args
, **kwargs
):
7363 GetUseBestVisual(self) -> bool
7365 Get current UseBestVisual setting.
7367 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7369 def SetPrintMode(*args
, **kwargs
):
7370 """SetPrintMode(self, int mode)"""
7371 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7373 def GetPrintMode(*args
, **kwargs
):
7374 """GetPrintMode(self) -> int"""
7375 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7377 def SetAssertMode(*args
, **kwargs
):
7379 SetAssertMode(self, int mode)
7381 Set the OnAssert behaviour for debug and hybrid builds.
7383 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7385 def GetAssertMode(*args
, **kwargs
):
7387 GetAssertMode(self) -> int
7389 Get the current OnAssert behaviour setting.
7391 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7393 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7394 """GetMacSupportPCMenuShortcuts() -> bool"""
7395 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7397 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7398 def GetMacAboutMenuItemId(*args
, **kwargs
):
7399 """GetMacAboutMenuItemId() -> long"""
7400 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7402 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7403 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7404 """GetMacPreferencesMenuItemId() -> long"""
7405 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7407 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7408 def GetMacExitMenuItemId(*args
, **kwargs
):
7409 """GetMacExitMenuItemId() -> long"""
7410 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7412 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7413 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7414 """GetMacHelpMenuTitleName() -> String"""
7415 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7417 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7418 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7419 """SetMacSupportPCMenuShortcuts(bool val)"""
7420 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7422 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7423 def SetMacAboutMenuItemId(*args
, **kwargs
):
7424 """SetMacAboutMenuItemId(long val)"""
7425 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7427 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7428 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7429 """SetMacPreferencesMenuItemId(long val)"""
7430 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7432 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7433 def SetMacExitMenuItemId(*args
, **kwargs
):
7434 """SetMacExitMenuItemId(long val)"""
7435 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7437 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7438 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7439 """SetMacHelpMenuTitleName(String val)"""
7440 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7442 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7443 def _BootstrapApp(*args
, **kwargs
):
7447 For internal use only
7449 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7451 def GetComCtl32Version(*args
, **kwargs
):
7453 GetComCtl32Version() -> int
7455 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7456 it wasn't found at all. Raises an exception on non-Windows platforms.
7458 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7460 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7461 def IsDisplayAvailable(*args
, **kwargs
):
7463 IsDisplayAvailable() -> bool
7465 Tests if it is possible to create a GUI in the current environment.
7466 This will mean different things on the different platforms.
7468 * On X Windows systems this function will return ``False`` if it is
7469 not able to open a connection to the X display, which can happen
7470 if $DISPLAY is not set, or is not set correctly.
7472 * On Mac OS X a ``False`` return value will mean that wx is not
7473 able to access the window manager, which can happen if logged in
7474 remotely or if running from the normal version of python instead
7475 of the framework version, (i.e., pythonw.)
7480 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7482 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7483 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7484 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7485 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7486 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7487 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7488 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7489 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7490 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7491 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7492 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7493 Active
= property(IsActive
)
7494 _core_
.PyApp_swigregister(PyApp
)
7496 def PyApp_IsMainLoopRunning(*args
):
7498 PyApp_IsMainLoopRunning() -> bool
7500 Returns True if we're running the main loop, i.e. if the events can
7501 currently be dispatched.
7503 return _core_
.PyApp_IsMainLoopRunning(*args
)
7505 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7506 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7507 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7509 def PyApp_GetMacAboutMenuItemId(*args
):
7510 """PyApp_GetMacAboutMenuItemId() -> long"""
7511 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7513 def PyApp_GetMacPreferencesMenuItemId(*args
):
7514 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7515 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7517 def PyApp_GetMacExitMenuItemId(*args
):
7518 """PyApp_GetMacExitMenuItemId() -> long"""
7519 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7521 def PyApp_GetMacHelpMenuTitleName(*args
):
7522 """PyApp_GetMacHelpMenuTitleName() -> String"""
7523 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7525 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7526 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7527 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7529 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7530 """PyApp_SetMacAboutMenuItemId(long val)"""
7531 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7533 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7534 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7535 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7537 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7538 """PyApp_SetMacExitMenuItemId(long val)"""
7539 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7541 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7542 """PyApp_SetMacHelpMenuTitleName(String val)"""
7543 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7545 def PyApp_GetComCtl32Version(*args
):
7547 PyApp_GetComCtl32Version() -> int
7549 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7550 it wasn't found at all. Raises an exception on non-Windows platforms.
7552 return _core_
.PyApp_GetComCtl32Version(*args
)
7554 def PyApp_IsDisplayAvailable(*args
):
7556 PyApp_IsDisplayAvailable() -> bool
7558 Tests if it is possible to create a GUI in the current environment.
7559 This will mean different things on the different platforms.
7561 * On X Windows systems this function will return ``False`` if it is
7562 not able to open a connection to the X display, which can happen
7563 if $DISPLAY is not set, or is not set correctly.
7565 * On Mac OS X a ``False`` return value will mean that wx is not
7566 able to access the window manager, which can happen if logged in
7567 remotely or if running from the normal version of python instead
7568 of the framework version, (i.e., pythonw.)
7573 return _core_
.PyApp_IsDisplayAvailable(*args
)
7575 #---------------------------------------------------------------------------
7582 Force an exit of the application. Convenience for wx.GetApp().Exit()
7584 return _core_
.Exit(*args
)
7590 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7592 return _core_
.Yield(*args
)
7594 def YieldIfNeeded(*args
):
7596 YieldIfNeeded() -> bool
7598 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7600 return _core_
.YieldIfNeeded(*args
)
7602 def SafeYield(*args
, **kwargs
):
7604 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7606 This function is similar to `wx.Yield`, except that it disables the
7607 user input to all program windows before calling `wx.Yield` and
7608 re-enables it again afterwards. If ``win`` is not None, this window
7609 will remain enabled, allowing the implementation of some limited user
7612 :Returns: the result of the call to `wx.Yield`.
7614 return _core_
.SafeYield(*args
, **kwargs
)
7616 def WakeUpIdle(*args
):
7620 Cause the message queue to become empty again, so idle events will be
7623 return _core_
.WakeUpIdle(*args
)
7625 def PostEvent(*args
, **kwargs
):
7627 PostEvent(EvtHandler dest, Event event)
7629 Send an event to a window or other wx.EvtHandler to be processed
7632 return _core_
.PostEvent(*args
, **kwargs
)
7634 def App_CleanUp(*args
):
7638 For internal use only, it is used to cleanup after wxWidgets when
7641 return _core_
.App_CleanUp(*args
)
7647 Return a reference to the current wx.App object.
7649 return _core_
.GetApp(*args
)
7651 def SetDefaultPyEncoding(*args
, **kwargs
):
7653 SetDefaultPyEncoding(string encoding)
7655 Sets the encoding that wxPython will use when it needs to convert a
7656 Python string or unicode object to or from a wxString.
7658 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7659 but please be aware that the default encoding within the same locale
7660 may be slightly different on different platforms. For example, please
7661 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7662 between the common latin/roman encodings.
7664 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7666 def GetDefaultPyEncoding(*args
):
7668 GetDefaultPyEncoding() -> string
7670 Gets the current encoding that wxPython will use when it needs to
7671 convert a Python string or unicode object to or from a wxString.
7673 return _core_
.GetDefaultPyEncoding(*args
)
7674 #----------------------------------------------------------------------
7676 class PyOnDemandOutputWindow
:
7678 A class that can be used for redirecting Python's stdout and
7679 stderr streams. It will do nothing until something is wrriten to
7680 the stream at which point it will create a Frame with a text area
7681 and write the text there.
7683 def __init__(self
, title
= "wxPython: stdout/stderr"):
7686 self
.pos
= wx
.DefaultPosition
7687 self
.size
= (450, 300)
7690 def SetParent(self
, parent
):
7691 """Set the window to be used as the popup Frame's parent."""
7692 self
.parent
= parent
7695 def CreateOutputWindow(self
, st
):
7696 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7697 style
=wx
.DEFAULT_FRAME_STYLE
)
7698 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7699 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7700 self
.text
.AppendText(st
)
7701 self
.frame
.Show(True)
7702 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7705 def OnCloseWindow(self
, event
):
7706 if self
.frame
is not None:
7707 self
.frame
.Destroy()
7712 # These methods provide the file-like output behaviour.
7713 def write(self
, text
):
7715 Create the output window if needed and write the string to it.
7716 If not called in the context of the gui thread then uses
7717 CallAfter to do the work there.
7719 if self
.frame
is None:
7720 if not wx
.Thread_IsMain():
7721 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7723 self
.CreateOutputWindow(text
)
7725 if not wx
.Thread_IsMain():
7726 wx
.CallAfter(self
.text
.AppendText
, text
)
7728 self
.text
.AppendText(text
)
7732 if self
.frame
is not None:
7733 wx
.CallAfter(self
.frame
.Close
)
7741 #----------------------------------------------------------------------
7743 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7745 class App(wx
.PyApp
):
7747 The ``wx.App`` class represents the application and is used to:
7749 * bootstrap the wxPython system and initialize the underlying
7751 * set and get application-wide properties
7752 * implement the windowing system main message or event loop,
7753 and to dispatch events to window instances
7756 Every application must have a ``wx.App`` instance, and all
7757 creation of UI objects should be delayed until after the
7758 ``wx.App`` object has been created in order to ensure that the gui
7759 platform and wxWidgets have been fully initialized.
7761 Normally you would derive from this class and implement an
7762 ``OnInit`` method that creates a frame and then calls
7763 ``self.SetTopWindow(frame)``.
7765 :see: `wx.PySimpleApp` for a simpler app class that can be used
7769 outputWindowClass
= PyOnDemandOutputWindow
7771 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7772 useBestVisual
=False, clearSigInt
=True):
7774 Construct a ``wx.App`` object.
7776 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7777 redirected? Defaults to True on Windows and Mac, False
7778 otherwise. If `filename` is None then output will be
7779 redirected to a window that pops up as needed. (You can
7780 control what kind of window is created for the output by
7781 resetting the class variable ``outputWindowClass`` to a
7782 class of your choosing.)
7784 :param filename: The name of a file to redirect output to, if
7787 :param useBestVisual: Should the app try to use the best
7788 available visual provided by the system (only relevant on
7789 systems that have more than one visual.) This parameter
7790 must be used instead of calling `SetUseBestVisual` later
7791 on because it must be set before the underlying GUI
7792 toolkit is initialized.
7794 :param clearSigInt: Should SIGINT be cleared? This allows the
7795 app to terminate upon a Ctrl-C in the console like other
7798 :note: You should override OnInit to do applicaition
7799 initialization to ensure that the system, toolkit and
7800 wxWidgets are fully initialized.
7803 wx
.PyApp
.__init
__(self
)
7805 # make sure we can create a GUI
7806 if not self
.IsDisplayAvailable():
7808 if wx
.Platform
== "__WXMAC__":
7809 msg
= """This program needs access to the screen.
7810 Please run with 'pythonw', not 'python', and only when you are logged
7811 in on the main display of your Mac."""
7813 elif wx
.Platform
== "__WXGTK__":
7814 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7817 msg
= "Unable to create GUI"
7818 # TODO: more description is needed for wxMSW...
7820 raise SystemExit(msg
)
7822 # This has to be done before OnInit
7823 self
.SetUseBestVisual(useBestVisual
)
7825 # Set the default handler for SIGINT. This fixes a problem
7826 # where if Ctrl-C is pressed in the console that started this
7827 # app then it will not appear to do anything, (not even send
7828 # KeyboardInterrupt???) but will later segfault on exit. By
7829 # setting the default handler then the app will exit, as
7830 # expected (depending on platform.)
7834 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7838 # Save and redirect the stdio to a window?
7839 self
.stdioWin
= None
7840 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7842 self
.RedirectStdio(filename
)
7844 # Use Python's install prefix as the default
7845 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7847 # Until the new native control for wxMac is up to par, still use the generic one.
7848 wx
.SystemOptions
.SetOptionInt("mac.listctrl.always_use_generic", 1)
7850 # This finishes the initialization of wxWindows and then calls
7851 # the OnInit that should be present in the derived class
7852 self
._BootstrapApp
()
7855 def OnPreInit(self
):
7857 Things that must be done after _BootstrapApp has done its
7858 thing, but would be nice if they were already done by the time
7859 that OnInit is called.
7861 wx
.StockGDI
._initStockObjects
()
7864 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7865 self
.RestoreStdio() # Just in case the MainLoop was overridden
7869 self
.this
.own(False)
7870 wx
.PyApp
.Destroy(self
)
7872 def SetTopWindow(self
, frame
):
7873 """Set the \"main\" top level window"""
7875 self
.stdioWin
.SetParent(frame
)
7876 wx
.PyApp
.SetTopWindow(self
, frame
)
7880 """Execute the main GUI event loop"""
7881 wx
.PyApp
.MainLoop(self
)
7885 def RedirectStdio(self
, filename
=None):
7886 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7888 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7890 self
.stdioWin
= self
.outputWindowClass()
7891 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7894 def RestoreStdio(self
):
7896 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7901 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7903 Set the title, position and/or size of the output window if
7904 the stdio has been redirected. This should be called before
7905 any output would cause the output window to be created.
7908 if title
is not None:
7909 self
.stdioWin
.title
= title
7911 self
.stdioWin
.pos
= pos
7912 if size
is not None:
7913 self
.stdioWin
.size
= size
7918 # change from wx.PyApp_XX to wx.App_XX
7919 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7920 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7921 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7922 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7923 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7924 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7925 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7926 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7927 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7928 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7929 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7931 #----------------------------------------------------------------------------
7933 class PySimpleApp(wx
.App
):
7935 A simple application class. You can just create one of these and
7936 then then make your top level windows later, and not have to worry
7937 about OnInit. For example::
7939 app = wx.PySimpleApp()
7940 frame = wx.Frame(None, title='Hello World')
7947 def __init__(self
, redirect
=False, filename
=None,
7948 useBestVisual
=False, clearSigInt
=True):
7950 :see: `wx.App.__init__`
7952 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7959 # Is anybody using this one?
7960 class PyWidgetTester(wx
.App
):
7961 def __init__(self
, size
= (250, 100)):
7963 wx
.App
.__init
__(self
, 0)
7966 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7967 self
.SetTopWindow(self
.frame
)
7970 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7971 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7972 self
.frame
.Show(True)
7974 #----------------------------------------------------------------------------
7975 # DO NOT hold any other references to this object. This is how we
7976 # know when to cleanup system resources that wxWidgets is holding. When
7977 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7978 # goes to zero and it calls the wx.App_CleanUp function.
7980 class __wxPyCleanup
:
7982 self
.cleanup
= _core_
.App_CleanUp
7986 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7988 ## # another possible solution, but it gets called too early...
7990 ## atexit.register(_core_.wxApp_CleanUp)
7993 #----------------------------------------------------------------------------
7995 #---------------------------------------------------------------------------
7997 class EventLoop(object):
7998 """Proxy of C++ EventLoop class"""
7999 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8000 __repr__
= _swig_repr
8001 def __init__(self
, *args
, **kwargs
):
8002 """__init__(self) -> EventLoop"""
8003 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
8004 __swig_destroy__
= _core_
.delete_EventLoop
8005 __del__
= lambda self
: None;
8006 def Run(*args
, **kwargs
):
8007 """Run(self) -> int"""
8008 return _core_
.EventLoop_Run(*args
, **kwargs
)
8010 def Exit(*args
, **kwargs
):
8011 """Exit(self, int rc=0)"""
8012 return _core_
.EventLoop_Exit(*args
, **kwargs
)
8014 def Pending(*args
, **kwargs
):
8015 """Pending(self) -> bool"""
8016 return _core_
.EventLoop_Pending(*args
, **kwargs
)
8018 def Dispatch(*args
, **kwargs
):
8019 """Dispatch(self) -> bool"""
8020 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
8022 def IsRunning(*args
, **kwargs
):
8023 """IsRunning(self) -> bool"""
8024 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
8026 def GetActive(*args
, **kwargs
):
8027 """GetActive() -> EventLoop"""
8028 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
8030 GetActive
= staticmethod(GetActive
)
8031 def SetActive(*args
, **kwargs
):
8032 """SetActive(EventLoop loop)"""
8033 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
8035 SetActive
= staticmethod(SetActive
)
8036 _core_
.EventLoop_swigregister(EventLoop
)
8038 def EventLoop_GetActive(*args
):
8039 """EventLoop_GetActive() -> EventLoop"""
8040 return _core_
.EventLoop_GetActive(*args
)
8042 def EventLoop_SetActive(*args
, **kwargs
):
8043 """EventLoop_SetActive(EventLoop loop)"""
8044 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
8046 class EventLoopActivator(object):
8047 """Proxy of C++ EventLoopActivator class"""
8048 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8049 __repr__
= _swig_repr
8050 def __init__(self
, *args
, **kwargs
):
8051 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
8052 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
8053 __swig_destroy__
= _core_
.delete_EventLoopActivator
8054 __del__
= lambda self
: None;
8055 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
8057 #---------------------------------------------------------------------------
8059 ACCEL_ALT
= _core_
.ACCEL_ALT
8060 ACCEL_CTRL
= _core_
.ACCEL_CTRL
8061 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
8062 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
8063 ACCEL_CMD
= _core_
.ACCEL_CMD
8064 class AcceleratorEntry(object):
8066 A class used to define items in an `wx.AcceleratorTable`. wxPython
8067 programs can choose to use wx.AcceleratorEntry objects, but using a
8068 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
8069 as well. See `__init__` for of the tuple values.
8071 :see: `wx.AcceleratorTable`
8073 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8074 __repr__
= _swig_repr
8075 def __init__(self
, *args
, **kwargs
):
8077 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
8079 Construct a wx.AcceleratorEntry.
8081 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
8082 __swig_destroy__
= _core_
.delete_AcceleratorEntry
8083 __del__
= lambda self
: None;
8084 def Set(*args
, **kwargs
):
8086 Set(self, int flags, int keyCode, int cmd)
8088 (Re)set the attributes of a wx.AcceleratorEntry.
8091 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
8093 def Create(*args
, **kwargs
):
8095 Create(String str) -> AcceleratorEntry
8097 Create accelerator corresponding to the specified string, or None if
8098 it coulnd't be parsed.
8100 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8102 Create
= staticmethod(Create
)
8103 def GetFlags(*args
, **kwargs
):
8105 GetFlags(self) -> int
8107 Get the AcceleratorEntry's flags.
8109 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
8111 def GetKeyCode(*args
, **kwargs
):
8113 GetKeyCode(self) -> int
8115 Get the AcceleratorEntry's keycode.
8117 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8119 def GetCommand(*args
, **kwargs
):
8121 GetCommand(self) -> int
8123 Get the AcceleratorEntry's command ID.
8125 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8127 def IsOk(*args
, **kwargs
):
8128 """IsOk(self) -> bool"""
8129 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
8131 def ToString(*args
, **kwargs
):
8133 ToString(self) -> String
8135 Returns a string representation for the this accelerator. The string
8136 is formatted using the <flags>-<keycode> format where <flags> maybe a
8137 hyphen-separed list of "shift|alt|ctrl"
8140 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
8142 def FromString(*args
, **kwargs
):
8144 FromString(self, String str) -> bool
8146 Returns true if the given string correctly initialized this object.
8148 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
8150 Command
= property(GetCommand
,doc
="See `GetCommand`")
8151 Flags
= property(GetFlags
,doc
="See `GetFlags`")
8152 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
8153 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
8155 def AcceleratorEntry_Create(*args
, **kwargs
):
8157 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8159 Create accelerator corresponding to the specified string, or None if
8160 it coulnd't be parsed.
8162 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8164 class AcceleratorTable(Object
):
8166 An accelerator table allows the application to specify a table of
8167 keyboard shortcuts for menus or other commands. On Windows, menu or
8168 button commands are supported; on GTK, only menu commands are
8171 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8172 __repr__
= _swig_repr
8173 def __init__(self
, *args
, **kwargs
):
8175 __init__(entries) -> AcceleratorTable
8177 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8178 items or or of 3-tuples (flags, keyCode, cmdID)
8180 :see: `wx.AcceleratorEntry`
8182 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
8183 __swig_destroy__
= _core_
.delete_AcceleratorTable
8184 __del__
= lambda self
: None;
8185 def IsOk(*args
, **kwargs
):
8186 """IsOk(self) -> bool"""
8187 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
8190 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
8192 def GetAccelFromString(label
):
8193 entry
= AcceleratorEntry()
8194 entry
.FromString(label
)
8197 #---------------------------------------------------------------------------
8199 class VisualAttributes(object):
8200 """struct containing all the visual attributes of a control"""
8201 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8202 __repr__
= _swig_repr
8203 def __init__(self
, *args
, **kwargs
):
8205 __init__(self) -> VisualAttributes
8207 struct containing all the visual attributes of a control
8209 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
8210 __swig_destroy__
= _core_
.delete_VisualAttributes
8211 __del__
= lambda self
: None;
8212 def _get_font(*args
, **kwargs
):
8213 """_get_font(self) -> Font"""
8214 return _core_
.VisualAttributes__get_font(*args
, **kwargs
)
8216 def _get_colFg(*args
, **kwargs
):
8217 """_get_colFg(self) -> Colour"""
8218 return _core_
.VisualAttributes__get_colFg(*args
, **kwargs
)
8220 def _get_colBg(*args
, **kwargs
):
8221 """_get_colBg(self) -> Colour"""
8222 return _core_
.VisualAttributes__get_colBg(*args
, **kwargs
)
8224 font
= property(_get_font
)
8225 colFg
= property(_get_colFg
)
8226 colBg
= property(_get_colBg
)
8227 _core_
.VisualAttributes_swigregister(VisualAttributes
)
8228 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8229 PanelNameStr
= cvar
.PanelNameStr
8231 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8232 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8233 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8234 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8235 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8236 class Window(EvtHandler
):
8238 wx.Window is the base class for all windows and represents any visible
8239 object on the screen. All controls, top level windows and so on are
8240 wx.Windows. Sizers and device contexts are not however, as they don't
8241 appear on screen themselves.
8244 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8245 __repr__
= _swig_repr
8246 def __init__(self
, *args
, **kwargs
):
8248 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8249 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8251 Construct and show a generic Window.
8253 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
8254 self
._setOORInfo
(self
)
8256 def Create(*args
, **kwargs
):
8258 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8259 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8261 Create the GUI part of the Window for 2-phase creation mode.
8263 return _core_
.Window_Create(*args
, **kwargs
)
8265 def Close(*args
, **kwargs
):
8267 Close(self, bool force=False) -> bool
8269 This function simply generates a EVT_CLOSE event whose handler usually
8270 tries to close the window. It doesn't close the window itself,
8271 however. If force is False (the default) then the window's close
8272 handler will be allowed to veto the destruction of the window.
8274 return _core_
.Window_Close(*args
, **kwargs
)
8276 def Destroy(*args
, **kwargs
):
8278 Destroy(self) -> bool
8280 Destroys the window safely. Frames and dialogs are not destroyed
8281 immediately when this function is called -- they are added to a list
8282 of windows to be deleted on idle time, when all the window's events
8283 have been processed. This prevents problems with events being sent to
8284 non-existent windows.
8286 Returns True if the window has either been successfully deleted, or it
8287 has been added to the list of windows pending real deletion.
8289 args
[0].this
.own(False)
8290 return _core_
.Window_Destroy(*args
, **kwargs
)
8292 def DestroyChildren(*args
, **kwargs
):
8294 DestroyChildren(self) -> bool
8296 Destroys all children of a window. Called automatically by the
8299 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8301 def IsBeingDeleted(*args
, **kwargs
):
8303 IsBeingDeleted(self) -> bool
8305 Is the window in the process of being deleted?
8307 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8309 def SetLabel(*args
, **kwargs
):
8311 SetLabel(self, String label)
8313 Set the text which the window shows in its label if applicable.
8315 return _core_
.Window_SetLabel(*args
, **kwargs
)
8317 def GetLabel(*args
, **kwargs
):
8319 GetLabel(self) -> String
8321 Generic way of getting a label from any window, for identification
8322 purposes. The interpretation of this function differs from class to
8323 class. For frames and dialogs, the value returned is the title. For
8324 buttons or static text controls, it is the button text. This function
8325 can be useful for meta-programs such as testing tools or special-needs
8326 access programs)which need to identify windows by name.
8328 return _core_
.Window_GetLabel(*args
, **kwargs
)
8330 def SetName(*args
, **kwargs
):
8332 SetName(self, String name)
8334 Sets the window's name. The window name is used for ressource setting
8335 in X, it is not the same as the window title/label
8337 return _core_
.Window_SetName(*args
, **kwargs
)
8339 def GetName(*args
, **kwargs
):
8341 GetName(self) -> String
8343 Returns the windows name. This name is not guaranteed to be unique;
8344 it is up to the programmer to supply an appropriate name in the window
8345 constructor or via wx.Window.SetName.
8347 return _core_
.Window_GetName(*args
, **kwargs
)
8349 def SetWindowVariant(*args
, **kwargs
):
8351 SetWindowVariant(self, int variant)
8353 Sets the variant of the window/font size to use for this window, if
8354 the platform supports variants, for example, wxMac.
8356 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8358 def GetWindowVariant(*args
, **kwargs
):
8359 """GetWindowVariant(self) -> int"""
8360 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8362 def SetId(*args
, **kwargs
):
8364 SetId(self, int winid)
8366 Sets the identifier of the window. Each window has an integer
8367 identifier. If the application has not provided one, an identifier
8368 will be generated. Normally, the identifier should be provided on
8369 creation and should not be modified subsequently.
8371 return _core_
.Window_SetId(*args
, **kwargs
)
8373 def GetId(*args
, **kwargs
):
8377 Returns the identifier of the window. Each window has an integer
8378 identifier. If the application has not provided one (or the default Id
8379 -1 is used) then an unique identifier with a negative value will be
8382 return _core_
.Window_GetId(*args
, **kwargs
)
8384 def NewControlId(*args
, **kwargs
):
8386 NewControlId() -> int
8388 Generate a control id for the controls which were not given one.
8390 return _core_
.Window_NewControlId(*args
, **kwargs
)
8392 NewControlId
= staticmethod(NewControlId
)
8393 def NextControlId(*args
, **kwargs
):
8395 NextControlId(int winid) -> int
8397 Get the id of the control following the one with the given
8400 return _core_
.Window_NextControlId(*args
, **kwargs
)
8402 NextControlId
= staticmethod(NextControlId
)
8403 def PrevControlId(*args
, **kwargs
):
8405 PrevControlId(int winid) -> int
8407 Get the id of the control preceding the one with the given
8410 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8412 PrevControlId
= staticmethod(PrevControlId
)
8413 def GetLayoutDirection(*args
, **kwargs
):
8415 GetLayoutDirection(self) -> int
8417 Get the layout direction (LTR or RTL) for this window. Returns
8418 ``wx.Layout_Default`` if layout direction is not supported.
8420 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8422 def SetLayoutDirection(*args
, **kwargs
):
8424 SetLayoutDirection(self, int dir)
8426 Set the layout direction (LTR or RTL) for this window.
8428 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8430 def AdjustForLayoutDirection(*args
, **kwargs
):
8432 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8434 Mirror coordinates for RTL layout if this window uses it and if the
8435 mirroring is not done automatically like Win32.
8437 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8439 def SetSize(*args
, **kwargs
):
8441 SetSize(self, Size size)
8443 Sets the size of the window in pixels.
8445 return _core_
.Window_SetSize(*args
, **kwargs
)
8447 def SetDimensions(*args
, **kwargs
):
8449 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8451 Sets the position and size of the window in pixels. The sizeFlags
8452 parameter indicates the interpretation of the other params if they are
8455 ======================== ======================================
8456 wx.SIZE_AUTO A -1 indicates that a class-specific
8457 default should be used.
8458 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8459 -1 values are supplied.
8460 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8461 interpreted as real dimensions, not
8463 ======================== ======================================
8466 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8468 def SetRect(*args
, **kwargs
):
8470 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8472 Sets the position and size of the window in pixels using a wx.Rect.
8474 return _core_
.Window_SetRect(*args
, **kwargs
)
8476 def SetSizeWH(*args
, **kwargs
):
8478 SetSizeWH(self, int width, int height)
8480 Sets the size of the window in pixels.
8482 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8484 def Move(*args
, **kwargs
):
8486 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8488 Moves the window to the given position.
8490 return _core_
.Window_Move(*args
, **kwargs
)
8493 def MoveXY(*args
, **kwargs
):
8495 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8497 Moves the window to the given position.
8499 return _core_
.Window_MoveXY(*args
, **kwargs
)
8501 def SetInitialSize(*args
, **kwargs
):
8503 SetInitialSize(self, Size size=DefaultSize)
8505 A 'Smart' SetSize that will fill in default size components with the
8506 window's *best size* values. Also set's the minsize for use with sizers.
8508 return _core_
.Window_SetInitialSize(*args
, **kwargs
)
8510 SetBestFittingSize
= wx
._deprecated
(SetInitialSize
, 'Use `SetInitialSize`')
8511 def Raise(*args
, **kwargs
):
8515 Raises the window to the top of the window hierarchy. In current
8516 version of wxWidgets this works both for managed and child windows.
8518 return _core_
.Window_Raise(*args
, **kwargs
)
8520 def Lower(*args
, **kwargs
):
8524 Lowers the window to the bottom of the window hierarchy. In current
8525 version of wxWidgets this works both for managed and child windows.
8527 return _core_
.Window_Lower(*args
, **kwargs
)
8529 def SetClientSize(*args
, **kwargs
):
8531 SetClientSize(self, Size size)
8533 This sets the size of the window client area in pixels. Using this
8534 function to size a window tends to be more device-independent than
8535 wx.Window.SetSize, since the application need not worry about what
8536 dimensions the border or title bar have when trying to fit the window
8537 around panel items, for example.
8539 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8541 def SetClientSizeWH(*args
, **kwargs
):
8543 SetClientSizeWH(self, int width, int height)
8545 This sets the size of the window client area in pixels. Using this
8546 function to size a window tends to be more device-independent than
8547 wx.Window.SetSize, since the application need not worry about what
8548 dimensions the border or title bar have when trying to fit the window
8549 around panel items, for example.
8551 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8553 def SetClientRect(*args
, **kwargs
):
8555 SetClientRect(self, Rect rect)
8557 This sets the size of the window client area in pixels. Using this
8558 function to size a window tends to be more device-independent than
8559 wx.Window.SetSize, since the application need not worry about what
8560 dimensions the border or title bar have when trying to fit the window
8561 around panel items, for example.
8563 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8565 def GetPosition(*args
, **kwargs
):
8567 GetPosition(self) -> Point
8569 Get the window's position. Notice that the position is in client
8570 coordinates for child windows and screen coordinates for the top level
8571 ones, use `GetScreenPosition` if you need screen coordinates for all
8574 return _core_
.Window_GetPosition(*args
, **kwargs
)
8576 def GetPositionTuple(*args
, **kwargs
):
8578 GetPositionTuple() -> (x,y)
8580 Get the window's position. Notice that the position is in client
8581 coordinates for child windows and screen coordinates for the top level
8582 ones, use `GetScreenPosition` if you need screen coordinates for all
8585 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8587 def GetScreenPosition(*args
, **kwargs
):
8589 GetScreenPosition(self) -> Point
8591 Get the position of the window in screen coordinantes.
8593 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8595 def GetScreenPositionTuple(*args
, **kwargs
):
8597 GetScreenPositionTuple() -> (x,y)
8599 Get the position of the window in screen coordinantes.
8601 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8603 def GetScreenRect(*args
, **kwargs
):
8605 GetScreenRect(self) -> Rect
8607 Returns the size and position of the window in screen coordinantes as
8610 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8612 def GetSize(*args
, **kwargs
):
8614 GetSize(self) -> Size
8616 Get the window size.
8618 return _core_
.Window_GetSize(*args
, **kwargs
)
8620 def GetSizeTuple(*args
, **kwargs
):
8622 GetSizeTuple() -> (width, height)
8624 Get the window size.
8626 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8628 def GetRect(*args
, **kwargs
):
8630 GetRect(self) -> Rect
8632 Returns the size and position of the window as a `wx.Rect` object.
8634 return _core_
.Window_GetRect(*args
, **kwargs
)
8636 def GetClientSize(*args
, **kwargs
):
8638 GetClientSize(self) -> Size
8640 This gets the size of the window's 'client area' in pixels. The client
8641 area is the area which may be drawn on by the programmer, excluding
8642 title bar, border, scrollbars, etc.
8644 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8646 def GetClientSizeTuple(*args
, **kwargs
):
8648 GetClientSizeTuple() -> (width, height)
8650 This gets the size of the window's 'client area' in pixels. The client
8651 area is the area which may be drawn on by the programmer, excluding
8652 title bar, border, scrollbars, etc.
8654 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8656 def GetClientAreaOrigin(*args
, **kwargs
):
8658 GetClientAreaOrigin(self) -> Point
8660 Get the origin of the client area of the window relative to the
8661 window's top left corner (the client area may be shifted because of
8662 the borders, scrollbars, other decorations...)
8664 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8666 def GetClientRect(*args
, **kwargs
):
8668 GetClientRect(self) -> Rect
8670 Get the client area position and size as a `wx.Rect` object.
8672 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8674 def GetBestSize(*args
, **kwargs
):
8676 GetBestSize(self) -> Size
8678 This function returns the best acceptable minimal size for the
8679 window, if applicable. For example, for a static text control, it will
8680 be the minimal size such that the control label is not truncated. For
8681 windows containing subwindows (suzh aswx.Panel), the size returned by
8682 this function will be the same as the size the window would have had
8685 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8687 def GetBestSizeTuple(*args
, **kwargs
):
8689 GetBestSizeTuple() -> (width, height)
8691 This function returns the best acceptable minimal size for the
8692 window, if applicable. For example, for a static text control, it will
8693 be the minimal size such that the control label is not truncated. For
8694 windows containing subwindows (suzh aswx.Panel), the size returned by
8695 this function will be the same as the size the window would have had
8698 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8700 def InvalidateBestSize(*args
, **kwargs
):
8702 InvalidateBestSize(self)
8704 Reset the cached best size value so it will be recalculated the next
8707 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8709 def CacheBestSize(*args
, **kwargs
):
8711 CacheBestSize(self, Size size)
8713 Cache the best size so it doesn't need to be calculated again, (at least until
8714 some properties of the window change.)
8716 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8718 def GetEffectiveMinSize(*args
, **kwargs
):
8720 GetEffectiveMinSize(self) -> Size
8722 This function will merge the window's best size into the window's
8723 minimum size, giving priority to the min size components, and returns
8727 return _core_
.Window_GetEffectiveMinSize(*args
, **kwargs
)
8729 GetBestFittingSize
= wx
._deprecated
(GetEffectiveMinSize
, 'Use `GetEffectiveMinSize` instead.')
8730 def GetAdjustedBestSize(self
):
8731 s
= self
.GetBestSize()
8732 return wx
.Size(max(s
.width
, self
.GetMinWidth()),
8733 max(s
.height
, self
.GetMinHeight()))
8734 GetAdjustedBestSize
= wx
._deprecated
(GetAdjustedBestSize
, 'Use `GetEffectiveMinSize` instead.')
8736 def Center(*args
, **kwargs
):
8738 Center(self, int direction=BOTH)
8740 Centers the window. The parameter specifies the direction for
8741 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8742 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8743 on the entire screen and not on its parent window. If it is a
8744 top-level window and has no parent then it will always be centered
8745 relative to the screen.
8747 return _core_
.Window_Center(*args
, **kwargs
)
8750 def CenterOnParent(*args
, **kwargs
):
8752 CenterOnParent(self, int dir=BOTH)
8754 Center with respect to the the parent window
8756 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8758 CentreOnParent
= CenterOnParent
8759 def Fit(*args
, **kwargs
):
8763 Sizes the window so that it fits around its subwindows. This function
8764 won't do anything if there are no subwindows and will only really work
8765 correctly if sizers are used for the subwindows layout. Also, if the
8766 window has exactly one subwindow it is better (faster and the result
8767 is more precise as Fit adds some margin to account for fuzziness of
8768 its calculations) to call window.SetClientSize(child.GetSize())
8769 instead of calling Fit.
8771 return _core_
.Window_Fit(*args
, **kwargs
)
8773 def FitInside(*args
, **kwargs
):
8777 Similar to Fit, but sizes the interior (virtual) size of a
8778 window. Mainly useful with scrolled windows to reset scrollbars after
8779 sizing changes that do not trigger a size event, and/or scrolled
8780 windows without an interior sizer. This function similarly won't do
8781 anything if there are no subwindows.
8783 return _core_
.Window_FitInside(*args
, **kwargs
)
8785 def SetSizeHints(*args
, **kwargs
):
8787 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8790 Allows specification of minimum and maximum window sizes, and window
8791 size increments. If a pair of values is not set (or set to -1), the
8792 default values will be used. If this function is called, the user
8793 will not be able to size the window outside the given bounds (if it is
8794 a top-level window.) Sizers will also inspect the minimum window size
8795 and will use that value if set when calculating layout.
8797 The resizing increments are only significant under Motif or Xt.
8799 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8801 def SetSizeHintsSz(*args
, **kwargs
):
8803 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8805 Allows specification of minimum and maximum window sizes, and window
8806 size increments. If a pair of values is not set (or set to -1), the
8807 default values will be used. If this function is called, the user
8808 will not be able to size the window outside the given bounds (if it is
8809 a top-level window.) Sizers will also inspect the minimum window size
8810 and will use that value if set when calculating layout.
8812 The resizing increments are only significant under Motif or Xt.
8814 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8816 def SetVirtualSizeHints(*args
, **kwargs
):
8818 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8820 Allows specification of minimum and maximum virtual window sizes. If a
8821 pair of values is not set (or set to -1), the default values will be
8822 used. If this function is called, the user will not be able to size
8823 the virtual area of the window outside the given bounds.
8825 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8827 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8829 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8831 Allows specification of minimum and maximum virtual window sizes. If a
8832 pair of values is not set (or set to -1), the default values will be
8833 used. If this function is called, the user will not be able to size
8834 the virtual area of the window outside the given bounds.
8836 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8838 def GetMaxSize(*args
, **kwargs
):
8839 """GetMaxSize(self) -> Size"""
8840 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8842 def GetMinSize(*args
, **kwargs
):
8843 """GetMinSize(self) -> Size"""
8844 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8846 def SetMinSize(*args
, **kwargs
):
8848 SetMinSize(self, Size minSize)
8850 A more convenient method than `SetSizeHints` for setting just the
8853 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8855 def SetMaxSize(*args
, **kwargs
):
8857 SetMaxSize(self, Size maxSize)
8859 A more convenient method than `SetSizeHints` for setting just the
8862 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8864 def GetMinWidth(*args
, **kwargs
):
8865 """GetMinWidth(self) -> int"""
8866 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8868 def GetMinHeight(*args
, **kwargs
):
8869 """GetMinHeight(self) -> int"""
8870 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8872 def GetMaxWidth(*args
, **kwargs
):
8873 """GetMaxWidth(self) -> int"""
8874 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8876 def GetMaxHeight(*args
, **kwargs
):
8877 """GetMaxHeight(self) -> int"""
8878 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8880 def SetVirtualSize(*args
, **kwargs
):
8882 SetVirtualSize(self, Size size)
8884 Set the the virtual size of a window in pixels. For most windows this
8885 is just the client area of the window, but for some like scrolled
8886 windows it is more or less independent of the screen window size.
8888 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8890 def SetVirtualSizeWH(*args
, **kwargs
):
8892 SetVirtualSizeWH(self, int w, int h)
8894 Set the the virtual size of a window in pixels. For most windows this
8895 is just the client area of the window, but for some like scrolled
8896 windows it is more or less independent of the screen window size.
8898 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8900 def GetVirtualSize(*args
, **kwargs
):
8902 GetVirtualSize(self) -> Size
8904 Get the the virtual size of the window in pixels. For most windows
8905 this is just the client area of the window, but for some like scrolled
8906 windows it is more or less independent of the screen window size.
8908 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8910 def GetVirtualSizeTuple(*args
, **kwargs
):
8912 GetVirtualSizeTuple() -> (width, height)
8914 Get the the virtual size of the window in pixels. For most windows
8915 this is just the client area of the window, but for some like scrolled
8916 windows it is more or less independent of the screen window size.
8918 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8920 def GetWindowBorderSize(*args
, **kwargs
):
8922 GetWindowBorderSize(self) -> Size
8924 Return the size of the left/right and top/bottom borders.
8926 return _core_
.Window_GetWindowBorderSize(*args
, **kwargs
)
8928 def GetBestVirtualSize(*args
, **kwargs
):
8930 GetBestVirtualSize(self) -> Size
8932 Return the largest of ClientSize and BestSize (as determined by a
8933 sizer, interior children, or other means)
8935 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8937 def Show(*args
, **kwargs
):
8939 Show(self, bool show=True) -> bool
8941 Shows or hides the window. You may need to call Raise for a top level
8942 window if you want to bring it to top, although this is not needed if
8943 Show is called immediately after the frame creation. Returns True if
8944 the window has been shown or hidden or False if nothing was done
8945 because it already was in the requested state.
8947 return _core_
.Window_Show(*args
, **kwargs
)
8949 def Hide(*args
, **kwargs
):
8953 Equivalent to calling Show(False).
8955 return _core_
.Window_Hide(*args
, **kwargs
)
8957 def Enable(*args
, **kwargs
):
8959 Enable(self, bool enable=True) -> bool
8961 Enable or disable the window for user input. Note that when a parent
8962 window is disabled, all of its children are disabled as well and they
8963 are reenabled again when the parent is. Returns true if the window
8964 has been enabled or disabled, false if nothing was done, i.e. if the
8965 window had already been in the specified state.
8967 return _core_
.Window_Enable(*args
, **kwargs
)
8969 def Disable(*args
, **kwargs
):
8971 Disable(self) -> bool
8973 Disables the window, same as Enable(false).
8975 return _core_
.Window_Disable(*args
, **kwargs
)
8977 def IsShown(*args
, **kwargs
):
8979 IsShown(self) -> bool
8981 Returns true if the window is shown, false if it has been hidden.
8983 return _core_
.Window_IsShown(*args
, **kwargs
)
8985 def IsEnabled(*args
, **kwargs
):
8987 IsEnabled(self) -> bool
8989 Returns true if the window is enabled for input, false otherwise.
8990 This method takes into account the enabled state of parent windows up
8991 to the top-level window.
8993 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8995 def IsThisEnabled(*args
, **kwargs
):
8997 IsThisEnabled(self) -> bool
8999 Returns the internal enabled state independent of the parent(s) state,
9000 i.e. the state in which the window would be if all of its parents are
9001 enabled. Use `IsEnabled` to get the effective window state.
9003 return _core_
.Window_IsThisEnabled(*args
, **kwargs
)
9005 def IsShownOnScreen(*args
, **kwargs
):
9007 IsShownOnScreen(self) -> bool
9009 Returns ``True`` if the window is physically visible on the screen,
9010 i.e. it is shown and all its parents up to the toplevel window are
9013 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
9015 def SetWindowStyleFlag(*args
, **kwargs
):
9017 SetWindowStyleFlag(self, long style)
9019 Sets the style of the window. Please note that some styles cannot be
9020 changed after the window creation and that Refresh() might need to be
9021 called after changing the others for the change to take place
9024 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
9026 def GetWindowStyleFlag(*args
, **kwargs
):
9028 GetWindowStyleFlag(self) -> long
9030 Gets the window style that was passed to the constructor or Create
9033 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
9035 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
9036 def HasFlag(*args
, **kwargs
):
9038 HasFlag(self, int flag) -> bool
9040 Test if the given style is set for this window.
9042 return _core_
.Window_HasFlag(*args
, **kwargs
)
9044 def IsRetained(*args
, **kwargs
):
9046 IsRetained(self) -> bool
9048 Returns true if the window is retained, false otherwise. Retained
9049 windows are only available on X platforms.
9051 return _core_
.Window_IsRetained(*args
, **kwargs
)
9053 def ToggleWindowStyle(*args
, **kwargs
):
9055 ToggleWindowStyle(self, int flag) -> bool
9057 Turn the flag on if it had been turned off before and vice versa,
9058 returns True if the flag is turned on by this function call.
9060 return _core_
.Window_ToggleWindowStyle(*args
, **kwargs
)
9062 def SetExtraStyle(*args
, **kwargs
):
9064 SetExtraStyle(self, long exStyle)
9066 Sets the extra style bits for the window. Extra styles are the less
9067 often used style bits which can't be set with the constructor or with
9068 SetWindowStyleFlag()
9070 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
9072 def GetExtraStyle(*args
, **kwargs
):
9074 GetExtraStyle(self) -> long
9076 Returns the extra style bits for the window.
9078 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
9080 def MakeModal(*args
, **kwargs
):
9082 MakeModal(self, bool modal=True)
9084 Disables all other windows in the application so that the user can
9085 only interact with this window. Passing False will reverse this
9088 return _core_
.Window_MakeModal(*args
, **kwargs
)
9090 def SetThemeEnabled(*args
, **kwargs
):
9092 SetThemeEnabled(self, bool enableTheme)
9094 This function tells a window if it should use the system's "theme"
9095 code to draw the windows' background instead if its own background
9096 drawing code. This will only have an effect on platforms that support
9097 the notion of themes in user defined windows. One such platform is
9098 GTK+ where windows can have (very colourful) backgrounds defined by a
9099 user's selected theme.
9101 Dialogs, notebook pages and the status bar have this flag set to true
9102 by default so that the default look and feel is simulated best.
9104 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
9106 def GetThemeEnabled(*args
, **kwargs
):
9108 GetThemeEnabled(self) -> bool
9110 Return the themeEnabled flag.
9112 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
9114 def SetFocus(*args
, **kwargs
):
9118 Set's the focus to this window, allowing it to receive keyboard input.
9120 return _core_
.Window_SetFocus(*args
, **kwargs
)
9122 def SetFocusFromKbd(*args
, **kwargs
):
9124 SetFocusFromKbd(self)
9126 Set focus to this window as the result of a keyboard action. Normally
9127 only called internally.
9129 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
9131 def FindFocus(*args
, **kwargs
):
9133 FindFocus() -> Window
9135 Returns the window or control that currently has the keyboard focus,
9138 return _core_
.Window_FindFocus(*args
, **kwargs
)
9140 FindFocus
= staticmethod(FindFocus
)
9141 def AcceptsFocus(*args
, **kwargs
):
9143 AcceptsFocus(self) -> bool
9145 Can this window have focus?
9147 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
9149 def CanAcceptFocus(*args
, **kwargs
):
9151 CanAcceptFocus(self) -> bool
9153 Can this window have focus right now?
9155 return _core_
.Window_CanAcceptFocus(*args
, **kwargs
)
9157 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
9159 AcceptsFocusFromKeyboard(self) -> bool
9161 Can this window be given focus by keyboard navigation? if not, the
9162 only way to give it focus (provided it accepts it at all) is to click
9165 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
9167 def CanAcceptFocusFromKeyboard(*args
, **kwargs
):
9169 CanAcceptFocusFromKeyboard(self) -> bool
9171 Can this window be assigned focus from keyboard right now?
9173 return _core_
.Window_CanAcceptFocusFromKeyboard(*args
, **kwargs
)
9175 def SetCanFocus(*args
, **kwargs
):
9176 """SetCanFocus(self, bool canFocus)"""
9177 return _core_
.Window_SetCanFocus(*args
, **kwargs
)
9179 def NavigateIn(*args
, **kwargs
):
9181 NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool
9183 Navigates inside this window.
9185 return _core_
.Window_NavigateIn(*args
, **kwargs
)
9187 def Navigate(*args
, **kwargs
):
9189 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9191 Does keyboard navigation starting from this window to another. This is
9192 equivalient to self.GetParent().NavigateIn().
9194 return _core_
.Window_Navigate(*args
, **kwargs
)
9196 def MoveAfterInTabOrder(*args
, **kwargs
):
9198 MoveAfterInTabOrder(self, Window win)
9200 Moves this window in the tab navigation order after the specified
9201 sibling window. This means that when the user presses the TAB key on
9202 that other window, the focus switches to this window.
9204 The default tab order is the same as creation order. This function
9205 and `MoveBeforeInTabOrder` allow to change it after creating all the
9209 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
9211 def MoveBeforeInTabOrder(*args
, **kwargs
):
9213 MoveBeforeInTabOrder(self, Window win)
9215 Same as `MoveAfterInTabOrder` except that it inserts this window just
9216 before win instead of putting it right after it.
9218 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9220 def GetChildren(*args
, **kwargs
):
9222 GetChildren(self) -> PyObject
9224 Returns a list of the window's children. NOTE: Currently this is a
9225 copy of the child window list maintained by the window, so the return
9226 value of this function is only valid as long as the window's children
9229 return _core_
.Window_GetChildren(*args
, **kwargs
)
9231 def GetParent(*args
, **kwargs
):
9233 GetParent(self) -> Window
9235 Returns the parent window of this window, or None if there isn't one.
9237 return _core_
.Window_GetParent(*args
, **kwargs
)
9239 def GetGrandParent(*args
, **kwargs
):
9241 GetGrandParent(self) -> Window
9243 Returns the parent of the parent of this window, or None if there
9246 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9248 def GetTopLevelParent(*args
, **kwargs
):
9250 GetTopLevelParent(self) -> Window
9252 Returns the first frame or dialog in this window's parental hierarchy.
9254 return _core_
.Window_GetTopLevelParent(*args
, **kwargs
)
9256 def IsTopLevel(*args
, **kwargs
):
9258 IsTopLevel(self) -> bool
9260 Returns true if the given window is a top-level one. Currently all
9261 frames and dialogs are always considered to be top-level windows (even
9262 if they have a parent window).
9264 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9266 def Reparent(*args
, **kwargs
):
9268 Reparent(self, Window newParent) -> bool
9270 Reparents the window, i.e the window will be removed from its current
9271 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9272 re-inserted into another. Available on Windows and GTK. Returns True
9273 if the parent was changed, False otherwise (error or newParent ==
9276 return _core_
.Window_Reparent(*args
, **kwargs
)
9278 def AddChild(*args
, **kwargs
):
9280 AddChild(self, Window child)
9282 Adds a child window. This is called automatically by window creation
9283 functions so should not be required by the application programmer.
9285 return _core_
.Window_AddChild(*args
, **kwargs
)
9287 def RemoveChild(*args
, **kwargs
):
9289 RemoveChild(self, Window child)
9291 Removes a child window. This is called automatically by window
9292 deletion functions so should not be required by the application
9295 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9297 def SetDoubleBuffered(*args
, **kwargs
):
9299 SetDoubleBuffered(self, bool on)
9301 Currently wxGTK2 only.
9303 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
9305 def FindWindowById(*args
, **kwargs
):
9307 FindWindowById(self, long winid) -> Window
9309 Find a chld of this window by window ID
9311 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9313 def FindWindowByName(*args
, **kwargs
):
9315 FindWindowByName(self, String name) -> Window
9317 Find a child of this window by name
9319 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9321 def GetEventHandler(*args
, **kwargs
):
9323 GetEventHandler(self) -> EvtHandler
9325 Returns the event handler for this window. By default, the window is
9326 its own event handler.
9328 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9330 def SetEventHandler(*args
, **kwargs
):
9332 SetEventHandler(self, EvtHandler handler)
9334 Sets the event handler for this window. An event handler is an object
9335 that is capable of processing the events sent to a window. (In other
9336 words, is able to dispatch the events to handler function.) By
9337 default, the window is its own event handler, but an application may
9338 wish to substitute another, for example to allow central
9339 implementation of event-handling for a variety of different window
9342 It is usually better to use `wx.Window.PushEventHandler` since this sets
9343 up a chain of event handlers, where an event not handled by one event
9344 handler is handed off to the next one in the chain.
9346 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9348 def PushEventHandler(*args
, **kwargs
):
9350 PushEventHandler(self, EvtHandler handler)
9352 Pushes this event handler onto the event handler stack for the window.
9353 An event handler is an object that is capable of processing the events
9354 sent to a window. (In other words, is able to dispatch the events to
9355 handler function.) By default, the window is its own event handler,
9356 but an application may wish to substitute another, for example to
9357 allow central implementation of event-handling for a variety of
9358 different window classes.
9360 wx.Window.PushEventHandler allows an application to set up a chain of
9361 event handlers, where an event not handled by one event handler is
9362 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9363 to remove the event handler. Ownership of the handler is *not* given
9364 to the window, so you should be sure to pop the handler before the
9365 window is destroyed and either let PopEventHandler destroy it, or call
9366 its Destroy method yourself.
9368 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9370 def PopEventHandler(*args
, **kwargs
):
9372 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9374 Removes and returns the top-most event handler on the event handler
9375 stack. If deleteHandler is True then the wx.EvtHandler object will be
9376 destroyed after it is popped, and ``None`` will be returned instead.
9378 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9380 def RemoveEventHandler(*args
, **kwargs
):
9382 RemoveEventHandler(self, EvtHandler handler) -> bool
9384 Find the given handler in the event handler chain and remove (but not
9385 delete) it from the event handler chain, returns True if it was found
9386 and False otherwise (this also results in an assert failure so this
9387 function should only be called when the handler is supposed to be
9390 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9392 def SetValidator(*args
, **kwargs
):
9394 SetValidator(self, Validator validator)
9396 Deletes the current validator (if any) and sets the window validator,
9397 having called wx.Validator.Clone to create a new validator of this
9400 return _core_
.Window_SetValidator(*args
, **kwargs
)
9402 def GetValidator(*args
, **kwargs
):
9404 GetValidator(self) -> Validator
9406 Returns a pointer to the current validator for the window, or None if
9409 return _core_
.Window_GetValidator(*args
, **kwargs
)
9411 def Validate(*args
, **kwargs
):
9413 Validate(self) -> bool
9415 Validates the current values of the child controls using their
9416 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9417 style flag set, the method will also call Validate() of all child
9418 windows. Returns false if any of the validations failed.
9420 return _core_
.Window_Validate(*args
, **kwargs
)
9422 def TransferDataToWindow(*args
, **kwargs
):
9424 TransferDataToWindow(self) -> bool
9426 Transfers values to child controls from data areas specified by their
9427 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9428 style flag set, the method will also call TransferDataToWindow() of
9431 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9433 def TransferDataFromWindow(*args
, **kwargs
):
9435 TransferDataFromWindow(self) -> bool
9437 Transfers values from child controls to data areas specified by their
9438 validators. Returns false if a transfer failed. If the window has
9439 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9440 also call TransferDataFromWindow() of all child windows.
9442 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9444 def InitDialog(*args
, **kwargs
):
9448 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9449 to the dialog via validators.
9451 return _core_
.Window_InitDialog(*args
, **kwargs
)
9453 def SetAcceleratorTable(*args
, **kwargs
):
9455 SetAcceleratorTable(self, AcceleratorTable accel)
9457 Sets the accelerator table for this window.
9459 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9461 def GetAcceleratorTable(*args
, **kwargs
):
9463 GetAcceleratorTable(self) -> AcceleratorTable
9465 Gets the accelerator table for this window.
9467 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9469 def RegisterHotKey(*args
, **kwargs
):
9471 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9473 Registers a system wide hotkey. Every time the user presses the hotkey
9474 registered here, this window will receive a hotkey event. It will
9475 receive the event even if the application is in the background and
9476 does not have the input focus because the user is working with some
9477 other application. To bind an event handler function to this hotkey
9478 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9479 hotkey was registered successfully.
9481 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9483 def UnregisterHotKey(*args
, **kwargs
):
9485 UnregisterHotKey(self, int hotkeyId) -> bool
9487 Unregisters a system wide hotkey.
9489 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9491 def ConvertDialogPointToPixels(*args
, **kwargs
):
9493 ConvertDialogPointToPixels(self, Point pt) -> Point
9495 Converts a point or size from dialog units to pixels. Dialog units
9496 are used for maintaining a dialog's proportions even if the font
9497 changes. For the x dimension, the dialog units are multiplied by the
9498 average character width and then divided by 4. For the y dimension,
9499 the dialog units are multiplied by the average character height and
9502 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9504 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9506 ConvertDialogSizeToPixels(self, Size sz) -> Size
9508 Converts a point or size from dialog units to pixels. Dialog units
9509 are used for maintaining a dialog's proportions even if the font
9510 changes. For the x dimension, the dialog units are multiplied by the
9511 average character width and then divided by 4. For the y dimension,
9512 the dialog units are multiplied by the average character height and
9515 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9517 def DLG_PNT(*args
, **kwargs
):
9519 DLG_PNT(self, Point pt) -> Point
9521 Converts a point or size from dialog units to pixels. Dialog units
9522 are used for maintaining a dialog's proportions even if the font
9523 changes. For the x dimension, the dialog units are multiplied by the
9524 average character width and then divided by 4. For the y dimension,
9525 the dialog units are multiplied by the average character height and
9528 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9530 def DLG_SZE(*args
, **kwargs
):
9532 DLG_SZE(self, Size sz) -> Size
9534 Converts a point or size from dialog units to pixels. Dialog units
9535 are used for maintaining a dialog's proportions even if the font
9536 changes. For the x dimension, the dialog units are multiplied by the
9537 average character width and then divided by 4. For the y dimension,
9538 the dialog units are multiplied by the average character height and
9541 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9543 def ConvertPixelPointToDialog(*args
, **kwargs
):
9544 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9545 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9547 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9548 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9549 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9551 def WarpPointer(*args
, **kwargs
):
9553 WarpPointer(self, int x, int y)
9555 Moves the pointer to the given position on the window.
9557 NOTE: This function is not supported under Mac because Apple Human
9558 Interface Guidelines forbid moving the mouse cursor programmatically.
9560 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9562 def CaptureMouse(*args
, **kwargs
):
9566 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9567 release the capture.
9569 Note that wxWindows maintains the stack of windows having captured the
9570 mouse and when the mouse is released the capture returns to the window
9571 which had had captured it previously and it is only really released if
9572 there were no previous window. In particular, this means that you must
9573 release the mouse as many times as you capture it, unless the window
9574 receives the `wx.MouseCaptureLostEvent` event.
9576 Any application which captures the mouse in the beginning of some
9577 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9578 operation when it receives the event. The event handler must not
9581 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9583 def ReleaseMouse(*args
, **kwargs
):
9587 Releases mouse input captured with wx.Window.CaptureMouse.
9589 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9591 def GetCapture(*args
, **kwargs
):
9593 GetCapture() -> Window
9595 Returns the window which currently captures the mouse or None
9597 return _core_
.Window_GetCapture(*args
, **kwargs
)
9599 GetCapture
= staticmethod(GetCapture
)
9600 def HasCapture(*args
, **kwargs
):
9602 HasCapture(self) -> bool
9604 Returns true if this window has the current mouse capture.
9606 return _core_
.Window_HasCapture(*args
, **kwargs
)
9608 def Refresh(*args
, **kwargs
):
9610 Refresh(self, bool eraseBackground=True, Rect rect=None)
9612 Mark the specified rectangle (or the whole window) as "dirty" so it
9613 will be repainted. Causes an EVT_PAINT event to be generated and sent
9616 return _core_
.Window_Refresh(*args
, **kwargs
)
9618 def RefreshRect(*args
, **kwargs
):
9620 RefreshRect(self, Rect rect, bool eraseBackground=True)
9622 Redraws the contents of the given rectangle: the area inside it will
9623 be repainted. This is the same as Refresh but has a nicer syntax.
9625 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9627 def Update(*args
, **kwargs
):
9631 Calling this method immediately repaints the invalidated area of the
9632 window instead of waiting for the EVT_PAINT event to happen, (normally
9633 this would usually only happen when the flow of control returns to the
9634 event loop.) Notice that this function doesn't refresh the window and
9635 does nothing if the window has been already repainted. Use `Refresh`
9636 first if you want to immediately redraw the window (or some portion of
9637 it) unconditionally.
9639 return _core_
.Window_Update(*args
, **kwargs
)
9641 def ClearBackground(*args
, **kwargs
):
9643 ClearBackground(self)
9645 Clears the window by filling it with the current background
9646 colour. Does not cause an erase background event to be generated.
9648 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9650 def Freeze(*args
, **kwargs
):
9654 Freezes the window or, in other words, prevents any updates from
9655 taking place on screen, the window is not redrawn at all. Thaw must be
9656 called to reenable window redrawing. Calls to Freeze/Thaw may be
9657 nested, with the actual Thaw being delayed until all the nesting has
9660 This method is useful for visual appearance optimization (for example,
9661 it is a good idea to use it before inserting large amount of text into
9662 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9663 for all controls so it is mostly just a hint to wxWindows and not a
9664 mandatory directive.
9666 return _core_
.Window_Freeze(*args
, **kwargs
)
9668 def IsFrozen(*args
, **kwargs
):
9670 IsFrozen(self) -> bool
9672 Returns ``True`` if the window has been frozen and not thawed yet.
9674 :see: `Freeze` and `Thaw`
9676 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9678 def Thaw(*args
, **kwargs
):
9682 Reenables window updating after a previous call to Freeze. Calls to
9683 Freeze/Thaw may be nested, so Thaw must be called the same number of
9684 times that Freeze was before the window will be updated.
9686 return _core_
.Window_Thaw(*args
, **kwargs
)
9688 def PrepareDC(*args
, **kwargs
):
9690 PrepareDC(self, DC dc)
9692 Call this function to prepare the device context for drawing a
9693 scrolled image. It sets the device origin according to the current
9696 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9698 def IsDoubleBuffered(*args
, **kwargs
):
9700 IsDoubleBuffered(self) -> bool
9702 Returns ``True`` if the window contents is double-buffered by the
9703 system, i.e. if any drawing done on the window is really done on a
9704 temporary backing surface and transferred to the screen all at once
9707 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9709 def GetUpdateRegion(*args
, **kwargs
):
9711 GetUpdateRegion(self) -> Region
9713 Returns the region specifying which parts of the window have been
9714 damaged. Should only be called within an EVT_PAINT handler.
9716 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9718 def GetUpdateClientRect(*args
, **kwargs
):
9720 GetUpdateClientRect(self) -> Rect
9722 Get the update rectangle region bounding box in client coords.
9724 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9726 def IsExposed(*args
, **kwargs
):
9728 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9730 Returns true if the given point or rectangle area has been exposed
9731 since the last repaint. Call this in an paint event handler to
9732 optimize redrawing by only redrawing those areas, which have been
9735 return _core_
.Window_IsExposed(*args
, **kwargs
)
9737 def IsExposedPoint(*args
, **kwargs
):
9739 IsExposedPoint(self, Point pt) -> bool
9741 Returns true if the given point or rectangle area has been exposed
9742 since the last repaint. Call this in an paint event handler to
9743 optimize redrawing by only redrawing those areas, which have been
9746 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9748 def IsExposedRect(*args
, **kwargs
):
9750 IsExposedRect(self, Rect rect) -> bool
9752 Returns true if the given point or rectangle area has been exposed
9753 since the last repaint. Call this in an paint event handler to
9754 optimize redrawing by only redrawing those areas, which have been
9757 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9759 def GetDefaultAttributes(*args
, **kwargs
):
9761 GetDefaultAttributes(self) -> VisualAttributes
9763 Get the default attributes for an instance of this class. This is
9764 useful if you want to use the same font or colour in your own control
9765 as in a standard control -- which is a much better idea than hard
9766 coding specific colours or fonts which might look completely out of
9767 place on the user's system, especially if it uses themes.
9769 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9771 def GetClassDefaultAttributes(*args
, **kwargs
):
9773 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9775 Get the default attributes for this class. This is useful if you want
9776 to use the same font or colour in your own control as in a standard
9777 control -- which is a much better idea than hard coding specific
9778 colours or fonts which might look completely out of place on the
9779 user's system, especially if it uses themes.
9781 The variant parameter is only relevant under Mac currently and is
9782 ignore under other platforms. Under Mac, it will change the size of
9783 the returned font. See `wx.Window.SetWindowVariant` for more about
9786 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9788 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9789 def SetBackgroundColour(*args
, **kwargs
):
9791 SetBackgroundColour(self, Colour colour) -> bool
9793 Sets the background colour of the window. Returns True if the colour
9794 was changed. The background colour is usually painted by the default
9795 EVT_ERASE_BACKGROUND event handler function under Windows and
9796 automatically under GTK. Using `wx.NullColour` will reset the window
9797 to the default background colour.
9799 Note that setting the background colour may not cause an immediate
9800 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9801 calling this function.
9803 Using this function will disable attempts to use themes for this
9804 window, if the system supports them. Use with care since usually the
9805 themes represent the appearance chosen by the user to be used for all
9806 applications on the system.
9808 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9810 def SetOwnBackgroundColour(*args
, **kwargs
):
9811 """SetOwnBackgroundColour(self, Colour colour)"""
9812 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9814 def SetForegroundColour(*args
, **kwargs
):
9816 SetForegroundColour(self, Colour colour) -> bool
9818 Sets the foreground colour of the window. Returns True is the colour
9819 was changed. The interpretation of foreground colour is dependent on
9820 the window class; it may be the text colour or other colour, or it may
9823 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9825 def SetOwnForegroundColour(*args
, **kwargs
):
9826 """SetOwnForegroundColour(self, Colour colour)"""
9827 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9829 def GetBackgroundColour(*args
, **kwargs
):
9831 GetBackgroundColour(self) -> Colour
9833 Returns the background colour of the window.
9835 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9837 def GetForegroundColour(*args
, **kwargs
):
9839 GetForegroundColour(self) -> Colour
9841 Returns the foreground colour of the window. The interpretation of
9842 foreground colour is dependent on the window class; it may be the text
9843 colour or other colour, or it may not be used at all.
9845 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9847 def InheritsBackgroundColour(*args
, **kwargs
):
9848 """InheritsBackgroundColour(self) -> bool"""
9849 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9851 def UseBgCol(*args
, **kwargs
):
9852 """UseBgCol(self) -> bool"""
9853 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9855 def SetBackgroundStyle(*args
, **kwargs
):
9857 SetBackgroundStyle(self, int style) -> bool
9859 Returns the background style of the window. The background style
9860 indicates how the background of the window is drawn.
9862 ====================== ========================================
9863 wx.BG_STYLE_SYSTEM The background colour or pattern should
9864 be determined by the system
9865 wx.BG_STYLE_COLOUR The background should be a solid colour
9866 wx.BG_STYLE_CUSTOM The background will be implemented by the
9868 ====================== ========================================
9870 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9871 a custom background, such as a tiled bitmap. Currently the style has
9872 no effect on other platforms.
9874 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9876 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9878 def GetBackgroundStyle(*args
, **kwargs
):
9880 GetBackgroundStyle(self) -> int
9882 Returns the background style of the window.
9884 :see: `SetBackgroundStyle`
9886 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9888 def HasTransparentBackground(*args
, **kwargs
):
9890 HasTransparentBackground(self) -> bool
9892 Returns True if this window's background is transparent (as, for
9893 example, for `wx.StaticText`) and should show the parent window's
9896 This method is mostly used internally by the library itself and you
9897 normally shouldn't have to call it. You may, however, have to override
9898 it in your custom control classes to ensure that background is painted
9901 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9903 def SetCursor(*args
, **kwargs
):
9905 SetCursor(self, Cursor cursor) -> bool
9907 Sets the window's cursor. Notice that the window cursor also sets it
9908 for the children of the window implicitly.
9910 The cursor may be wx.NullCursor in which case the window cursor will
9911 be reset back to default.
9913 return _core_
.Window_SetCursor(*args
, **kwargs
)
9915 def GetCursor(*args
, **kwargs
):
9917 GetCursor(self) -> Cursor
9919 Return the cursor associated with this window.
9921 return _core_
.Window_GetCursor(*args
, **kwargs
)
9923 def SetFont(*args
, **kwargs
):
9925 SetFont(self, Font font) -> bool
9927 Sets the font for this window.
9929 return _core_
.Window_SetFont(*args
, **kwargs
)
9931 def SetOwnFont(*args
, **kwargs
):
9932 """SetOwnFont(self, Font font)"""
9933 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9935 def GetFont(*args
, **kwargs
):
9937 GetFont(self) -> Font
9939 Returns the default font used for this window.
9941 return _core_
.Window_GetFont(*args
, **kwargs
)
9943 def SetCaret(*args
, **kwargs
):
9945 SetCaret(self, Caret caret)
9947 Sets the caret associated with the window.
9949 return _core_
.Window_SetCaret(*args
, **kwargs
)
9951 def GetCaret(*args
, **kwargs
):
9953 GetCaret(self) -> Caret
9955 Returns the caret associated with the window.
9957 return _core_
.Window_GetCaret(*args
, **kwargs
)
9959 def GetCharHeight(*args
, **kwargs
):
9961 GetCharHeight(self) -> int
9963 Get the (average) character size for the current font.
9965 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9967 def GetCharWidth(*args
, **kwargs
):
9969 GetCharWidth(self) -> int
9971 Get the (average) character size for the current font.
9973 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9975 def GetTextExtent(*args
, **kwargs
):
9977 GetTextExtent(String string) -> (width, height)
9979 Get the width and height of the text using the current font.
9981 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9983 def GetFullTextExtent(*args
, **kwargs
):
9985 GetFullTextExtent(String string, Font font=None) ->
9986 (width, height, descent, externalLeading)
9988 Get the width, height, decent and leading of the text using the
9989 current or specified font.
9991 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9993 def ClientToScreenXY(*args
, **kwargs
):
9995 ClientToScreenXY(int x, int y) -> (x,y)
9997 Converts to screen coordinates from coordinates relative to this window.
9999 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
10001 def ScreenToClientXY(*args
, **kwargs
):
10003 ScreenToClientXY(int x, int y) -> (x,y)
10005 Converts from screen to client window coordinates.
10007 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
10009 def ClientToScreen(*args
, **kwargs
):
10011 ClientToScreen(self, Point pt) -> Point
10013 Converts to screen coordinates from coordinates relative to this window.
10015 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
10017 def ScreenToClient(*args
, **kwargs
):
10019 ScreenToClient(self, Point pt) -> Point
10021 Converts from screen to client window coordinates.
10023 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
10025 def HitTestXY(*args
, **kwargs
):
10027 HitTestXY(self, int x, int y) -> int
10029 Test where the given (in client coords) point lies
10031 return _core_
.Window_HitTestXY(*args
, **kwargs
)
10033 def HitTest(*args
, **kwargs
):
10035 HitTest(self, Point pt) -> int
10037 Test where the given (in client coords) point lies
10039 return _core_
.Window_HitTest(*args
, **kwargs
)
10041 def GetBorder(*args
):
10043 GetBorder(self, long flags) -> int
10044 GetBorder(self) -> int
10046 Get border for the flags of this window
10048 return _core_
.Window_GetBorder(*args
)
10050 def UpdateWindowUI(*args
, **kwargs
):
10052 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
10054 This function sends EVT_UPDATE_UI events to the window. The particular
10055 implementation depends on the window; for example a wx.ToolBar will
10056 send an update UI event for each toolbar button, and a wx.Frame will
10057 send an update UI event for each menubar menu item. You can call this
10058 function from your application to ensure that your UI is up-to-date at
10059 a particular point in time (as far as your EVT_UPDATE_UI handlers are
10060 concerned). This may be necessary if you have called
10061 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
10062 limit the overhead that wxWindows incurs by sending update UI events
10065 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
10067 def PopupMenuXY(*args
, **kwargs
):
10069 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
10071 Pops up the given menu at the specified coordinates, relative to this window,
10072 and returns control when the user has dismissed the menu. If a menu item is
10073 selected, the corresponding menu event is generated and will be processed as
10074 usual. If the default position is given then the current position of the
10075 mouse cursor will be used.
10077 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
10079 def PopupMenu(*args
, **kwargs
):
10081 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
10083 Pops up the given menu at the specified coordinates, relative to this window,
10084 and returns control when the user has dismissed the menu. If a menu item is
10085 selected, the corresponding menu event is generated and will be processed as
10086 usual. If the default position is given then the current position of the
10087 mouse cursor will be used.
10089 return _core_
.Window_PopupMenu(*args
, **kwargs
)
10091 def HasMultiplePages(*args
, **kwargs
):
10092 """HasMultiplePages(self) -> bool"""
10093 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
10095 def GetHandle(*args
, **kwargs
):
10097 GetHandle(self) -> long
10099 Returns the platform-specific handle (as a long integer) of the
10100 physical window. Currently on wxMac it returns the handle of the
10101 toplevel parent of the window.
10103 return _core_
.Window_GetHandle(*args
, **kwargs
)
10105 def AssociateHandle(*args
, **kwargs
):
10107 AssociateHandle(self, long handle)
10109 Associate the window with a new native handle
10111 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
10113 def DissociateHandle(*args
, **kwargs
):
10115 DissociateHandle(self)
10117 Dissociate the current native handle from the window
10119 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
10121 def HasScrollbar(*args
, **kwargs
):
10123 HasScrollbar(self, int orient) -> bool
10125 Does the window have the scrollbar for this orientation?
10127 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
10129 def SetScrollbar(*args
, **kwargs
):
10131 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
10134 Sets the scrollbar properties of a built-in scrollbar.
10136 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
10138 def SetScrollPos(*args
, **kwargs
):
10140 SetScrollPos(self, int orientation, int pos, bool refresh=True)
10142 Sets the position of one of the built-in scrollbars.
10144 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
10146 def GetScrollPos(*args
, **kwargs
):
10148 GetScrollPos(self, int orientation) -> int
10150 Returns the built-in scrollbar position.
10152 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
10154 def GetScrollThumb(*args
, **kwargs
):
10156 GetScrollThumb(self, int orientation) -> int
10158 Returns the built-in scrollbar thumb size.
10160 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
10162 def GetScrollRange(*args
, **kwargs
):
10164 GetScrollRange(self, int orientation) -> int
10166 Returns the built-in scrollbar range.
10168 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
10170 def ScrollWindow(*args
, **kwargs
):
10172 ScrollWindow(self, int dx, int dy, Rect rect=None)
10174 Physically scrolls the pixels in the window and move child windows
10175 accordingly. Use this function to optimise your scrolling
10176 implementations, to minimise the area that must be redrawn. Note that
10177 it is rarely required to call this function from a user program.
10179 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
10181 def ScrollLines(*args
, **kwargs
):
10183 ScrollLines(self, int lines) -> bool
10185 If the platform and window class supports it, scrolls the window by
10186 the given number of lines down, if lines is positive, or up if lines
10187 is negative. Returns True if the window was scrolled, False if it was
10188 already on top/bottom and nothing was done.
10190 return _core_
.Window_ScrollLines(*args
, **kwargs
)
10192 def ScrollPages(*args
, **kwargs
):
10194 ScrollPages(self, int pages) -> bool
10196 If the platform and window class supports it, scrolls the window by
10197 the given number of pages down, if pages is positive, or up if pages
10198 is negative. Returns True if the window was scrolled, False if it was
10199 already on top/bottom and nothing was done.
10201 return _core_
.Window_ScrollPages(*args
, **kwargs
)
10203 def LineUp(*args
, **kwargs
):
10205 LineUp(self) -> bool
10207 This is just a wrapper for ScrollLines(-1).
10209 return _core_
.Window_LineUp(*args
, **kwargs
)
10211 def LineDown(*args
, **kwargs
):
10213 LineDown(self) -> bool
10215 This is just a wrapper for ScrollLines(1).
10217 return _core_
.Window_LineDown(*args
, **kwargs
)
10219 def PageUp(*args
, **kwargs
):
10221 PageUp(self) -> bool
10223 This is just a wrapper for ScrollPages(-1).
10225 return _core_
.Window_PageUp(*args
, **kwargs
)
10227 def PageDown(*args
, **kwargs
):
10229 PageDown(self) -> bool
10231 This is just a wrapper for ScrollPages(1).
10233 return _core_
.Window_PageDown(*args
, **kwargs
)
10235 def SetHelpText(*args
, **kwargs
):
10237 SetHelpText(self, String text)
10239 Sets the help text to be used as context-sensitive help for this
10240 window. Note that the text is actually stored by the current
10241 `wx.HelpProvider` implementation, and not in the window object itself.
10243 return _core_
.Window_SetHelpText(*args
, **kwargs
)
10245 def SetHelpTextForId(*args
, **kwargs
):
10247 SetHelpTextForId(self, String text)
10249 Associate this help text with all windows with the same id as this
10252 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
10254 def GetHelpTextAtPoint(*args
, **kwargs
):
10256 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10258 Get the help string associated with the given position in this window.
10260 Notice that pt may be invalid if event origin is keyboard or unknown
10261 and this method should return the global window help text then
10264 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
10266 def GetHelpText(*args
, **kwargs
):
10268 GetHelpText(self) -> String
10270 Gets the help text to be used as context-sensitive help for this
10271 window. Note that the text is actually stored by the current
10272 `wx.HelpProvider` implementation, and not in the window object itself.
10274 return _core_
.Window_GetHelpText(*args
, **kwargs
)
10276 def SetToolTipString(*args
, **kwargs
):
10278 SetToolTipString(self, String tip)
10280 Attach a tooltip to the window.
10282 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10284 def SetToolTip(*args
, **kwargs
):
10286 SetToolTip(self, ToolTip tip)
10288 Attach a tooltip to the window.
10290 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10292 def GetToolTip(*args
, **kwargs
):
10294 GetToolTip(self) -> ToolTip
10296 get the associated tooltip or None if none
10298 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10300 def SetDropTarget(*args
, **kwargs
):
10302 SetDropTarget(self, DropTarget dropTarget)
10304 Associates a drop target with this window. If the window already has
10305 a drop target, it is deleted.
10307 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10309 def GetDropTarget(*args
, **kwargs
):
10311 GetDropTarget(self) -> DropTarget
10313 Returns the associated drop target, which may be None.
10315 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10317 def DragAcceptFiles(*args
, **kwargs
):
10319 DragAcceptFiles(self, bool accept)
10321 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10322 Only functional on Windows.
10324 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10326 def SetConstraints(*args
, **kwargs
):
10328 SetConstraints(self, LayoutConstraints constraints)
10330 Sets the window to have the given layout constraints. If an existing
10331 layout constraints object is already owned by the window, it will be
10332 deleted. Pass None to disassociate and delete the window's current
10335 You must call SetAutoLayout to tell a window to use the constraints
10336 automatically in its default EVT_SIZE handler; otherwise, you must
10337 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10338 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10341 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10343 def GetConstraints(*args
, **kwargs
):
10345 GetConstraints(self) -> LayoutConstraints
10347 Returns a pointer to the window's layout constraints, or None if there
10350 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10352 def SetAutoLayout(*args
, **kwargs
):
10354 SetAutoLayout(self, bool autoLayout)
10356 Determines whether the Layout function will be called automatically
10357 when the window is resized. lease note that this only happens for the
10358 windows usually used to contain children, namely `wx.Panel` and
10359 `wx.TopLevelWindow` (and the classes deriving from them).
10361 This method is called implicitly by `SetSizer` but if you use
10362 `SetConstraints` you should call it manually or otherwise the window
10363 layout won't be correctly updated when its size changes.
10365 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10367 def GetAutoLayout(*args
, **kwargs
):
10369 GetAutoLayout(self) -> bool
10371 Returns the current autoLayout setting
10373 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10375 def Layout(*args
, **kwargs
):
10377 Layout(self) -> bool
10379 Invokes the constraint-based layout algorithm or the sizer-based
10380 algorithm for this window. See SetAutoLayout: when auto layout is on,
10381 this function gets called automatically by the default EVT_SIZE
10382 handler when the window is resized.
10384 return _core_
.Window_Layout(*args
, **kwargs
)
10386 def SetSizer(*args
, **kwargs
):
10388 SetSizer(self, Sizer sizer, bool deleteOld=True)
10390 Sets the window to have the given layout sizer. The window will then
10391 own the object, and will take care of its deletion. If an existing
10392 layout sizer object is already owned by the window, it will be deleted
10393 if the deleteOld parameter is true. Note that this function will also
10394 call SetAutoLayout implicitly with a True parameter if the sizer is
10395 non-None, and False otherwise.
10397 return _core_
.Window_SetSizer(*args
, **kwargs
)
10399 def SetSizerAndFit(*args
, **kwargs
):
10401 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10403 The same as SetSizer, except it also sets the size hints for the
10404 window based on the sizer's minimum size.
10406 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10408 def GetSizer(*args
, **kwargs
):
10410 GetSizer(self) -> Sizer
10412 Return the sizer associated with the window by a previous call to
10413 SetSizer or None if there isn't one.
10415 return _core_
.Window_GetSizer(*args
, **kwargs
)
10417 def SetContainingSizer(*args
, **kwargs
):
10419 SetContainingSizer(self, Sizer sizer)
10421 This normally does not need to be called by application code. It is
10422 called internally when a window is added to a sizer, and is used so
10423 the window can remove itself from the sizer when it is destroyed.
10425 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10427 def GetContainingSizer(*args
, **kwargs
):
10429 GetContainingSizer(self) -> Sizer
10431 Return the sizer that this window is a member of, if any, otherwise None.
10433 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10435 def InheritAttributes(*args
, **kwargs
):
10437 InheritAttributes(self)
10439 This function is (or should be, in case of custom controls) called
10440 during window creation to intelligently set up the window visual
10441 attributes, that is the font and the foreground and background
10444 By 'intelligently' the following is meant: by default, all windows use
10445 their own default attributes. However if some of the parent's
10446 attributes are explicitly changed (that is, using SetFont and not
10447 SetOwnFont) and if the corresponding attribute hadn't been
10448 explicitly set for this window itself, then this window takes the same
10449 value as used by the parent. In addition, if the window overrides
10450 ShouldInheritColours to return false, the colours will not be changed
10451 no matter what and only the font might.
10453 This rather complicated logic is necessary in order to accommodate the
10454 different usage scenarios. The most common one is when all default
10455 attributes are used and in this case, nothing should be inherited as
10456 in modern GUIs different controls use different fonts (and colours)
10457 than their siblings so they can't inherit the same value from the
10458 parent. However it was also deemed desirable to allow to simply change
10459 the attributes of all children at once by just changing the font or
10460 colour of their common parent, hence in this case we do inherit the
10461 parents attributes.
10464 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10466 def ShouldInheritColours(*args
, **kwargs
):
10468 ShouldInheritColours(self) -> bool
10470 Return true from here to allow the colours of this window to be
10471 changed by InheritAttributes, returning false forbids inheriting them
10472 from the parent window.
10474 The base class version returns false, but this method is overridden in
10475 wxControl where it returns true.
10477 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10479 def CanSetTransparent(*args
, **kwargs
):
10481 CanSetTransparent(self) -> bool
10483 Returns ``True`` if the platform supports setting the transparency for
10484 this window. Note that this method will err on the side of caution,
10485 so it is possible that this will return ``False`` when it is in fact
10486 possible to set the transparency.
10488 NOTE: On X-windows systems the X server must have the composite
10489 extension loaded, and there must be a composite manager program (such
10490 as xcompmgr) running.
10492 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10494 def SetTransparent(*args
, **kwargs
):
10496 SetTransparent(self, byte alpha) -> bool
10498 Attempt to set the transparency of this window to the ``alpha`` value,
10499 returns True on success. The ``alpha`` value is an integer in the
10500 range of 0 to 255, where 0 is fully transparent and 255 is fully
10503 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10505 def PostCreate(self
, pre
):
10507 Phase 3 of the 2-phase create <wink!>
10508 Call this method after precreating the window with the 2-phase create method.
10510 self
.this
= pre
.this
10511 self
.thisown
= pre
.thisown
10513 if hasattr(self
, '_setOORInfo'):
10515 self
._setOORInfo
(self
)
10518 if hasattr(self
, '_setCallbackInfo'):
10520 self
._setCallbackInfo
(self
, pre
.__class
__)
10524 def SendSizeEvent(self
):
10525 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10527 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10528 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10529 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10530 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10531 EffectiveMinSize
= property(GetEffectiveMinSize
,doc
="See `GetEffectiveMinSize`")
10532 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10533 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10534 Border
= property(GetBorder
,doc
="See `GetBorder`")
10535 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10536 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10537 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10538 Children
= property(GetChildren
,doc
="See `GetChildren`")
10539 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10540 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10541 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10542 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10543 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10544 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10545 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10546 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10547 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10548 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10549 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10550 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10551 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10552 TopLevelParent
= property(GetTopLevelParent
,doc
="See `GetTopLevelParent`")
10553 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10554 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10555 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10556 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10557 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10558 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10559 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10560 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10561 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10562 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10563 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10564 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10565 Parent
= property(GetParent
,doc
="See `GetParent`")
10566 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10567 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10568 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10569 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10570 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10571 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10572 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10573 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10574 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10575 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10576 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10577 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10578 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10579 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10580 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10581 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10582 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10583 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10584 _core_
.Window_swigregister(Window
)
10586 def PreWindow(*args
, **kwargs
):
10588 PreWindow() -> Window
10590 Precreate a Window for 2-phase creation.
10592 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10595 def Window_NewControlId(*args
):
10597 Window_NewControlId() -> int
10599 Generate a control id for the controls which were not given one.
10601 return _core_
.Window_NewControlId(*args
)
10603 def Window_NextControlId(*args
, **kwargs
):
10605 Window_NextControlId(int winid) -> int
10607 Get the id of the control following the one with the given
10610 return _core_
.Window_NextControlId(*args
, **kwargs
)
10612 def Window_PrevControlId(*args
, **kwargs
):
10614 Window_PrevControlId(int winid) -> int
10616 Get the id of the control preceding the one with the given
10619 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10621 def Window_FindFocus(*args
):
10623 Window_FindFocus() -> Window
10625 Returns the window or control that currently has the keyboard focus,
10628 return _core_
.Window_FindFocus(*args
)
10630 def Window_GetCapture(*args
):
10632 Window_GetCapture() -> Window
10634 Returns the window which currently captures the mouse or None
10636 return _core_
.Window_GetCapture(*args
)
10638 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10640 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10642 Get the default attributes for this class. This is useful if you want
10643 to use the same font or colour in your own control as in a standard
10644 control -- which is a much better idea than hard coding specific
10645 colours or fonts which might look completely out of place on the
10646 user's system, especially if it uses themes.
10648 The variant parameter is only relevant under Mac currently and is
10649 ignore under other platforms. Under Mac, it will change the size of
10650 the returned font. See `wx.Window.SetWindowVariant` for more about
10653 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10655 def DLG_PNT(win
, point_or_x
, y
=None):
10657 Convenience function for converting a Point or (x,y) in
10658 dialog units to pixel units.
10661 return win
.ConvertDialogPointToPixels(point_or_x
)
10663 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10665 def DLG_SZE(win
, size_width
, height
=None):
10667 Convenience function for converting a Size or (w,h) in
10668 dialog units to pixel units.
10671 return win
.ConvertDialogSizeToPixels(size_width
)
10673 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10676 def FindWindowById(*args
, **kwargs
):
10678 FindWindowById(long id, Window parent=None) -> Window
10680 Find the first window in the application with the given id. If parent
10681 is None, the search will start from all top-level frames and dialog
10682 boxes; if non-None, the search will be limited to the given window
10683 hierarchy. The search is recursive in both cases.
10685 return _core_
.FindWindowById(*args
, **kwargs
)
10687 def FindWindowByName(*args
, **kwargs
):
10689 FindWindowByName(String name, Window parent=None) -> Window
10691 Find a window by its name (as given in a window constructor or Create
10692 function call). If parent is None, the search will start from all
10693 top-level frames and dialog boxes; if non-None, the search will be
10694 limited to the given window hierarchy. The search is recursive in both
10697 If no window with such name is found, wx.FindWindowByLabel is called.
10699 return _core_
.FindWindowByName(*args
, **kwargs
)
10701 def FindWindowByLabel(*args
, **kwargs
):
10703 FindWindowByLabel(String label, Window parent=None) -> Window
10705 Find a window by its label. Depending on the type of window, the label
10706 may be a window title or panel item label. If parent is None, the
10707 search will start from all top-level frames and dialog boxes; if
10708 non-None, the search will be limited to the given window
10709 hierarchy. The search is recursive in both cases.
10711 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10713 def Window_FromHWND(*args
, **kwargs
):
10714 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10715 return _core_
.Window_FromHWND(*args
, **kwargs
)
10717 def GetTopLevelWindows(*args
):
10719 GetTopLevelWindows() -> PyObject
10721 Returns a list of the the application's top-level windows, (frames,
10722 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10723 by wxWidgets, and so it is only valid as long as no top-level windows
10724 are closed or new top-level windows are created.
10727 return _core_
.GetTopLevelWindows(*args
)
10728 #---------------------------------------------------------------------------
10730 class Validator(EvtHandler
):
10731 """Proxy of C++ Validator class"""
10732 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10733 __repr__
= _swig_repr
10734 def __init__(self
, *args
, **kwargs
):
10735 """__init__(self) -> Validator"""
10736 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10737 self
._setOORInfo
(self
)
10739 def Clone(*args
, **kwargs
):
10740 """Clone(self) -> Validator"""
10741 return _core_
.Validator_Clone(*args
, **kwargs
)
10743 def Validate(*args
, **kwargs
):
10744 """Validate(self, Window parent) -> bool"""
10745 return _core_
.Validator_Validate(*args
, **kwargs
)
10747 def TransferToWindow(*args
, **kwargs
):
10748 """TransferToWindow(self) -> bool"""
10749 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10751 def TransferFromWindow(*args
, **kwargs
):
10752 """TransferFromWindow(self) -> bool"""
10753 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10755 def GetWindow(*args
, **kwargs
):
10756 """GetWindow(self) -> Window"""
10757 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10759 def SetWindow(*args
, **kwargs
):
10760 """SetWindow(self, Window window)"""
10761 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10763 def IsSilent(*args
, **kwargs
):
10764 """IsSilent() -> bool"""
10765 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10767 IsSilent
= staticmethod(IsSilent
)
10768 def SetBellOnError(*args
, **kwargs
):
10769 """SetBellOnError(int doIt=True)"""
10770 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10772 SetBellOnError
= staticmethod(SetBellOnError
)
10773 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10774 _core_
.Validator_swigregister(Validator
)
10776 def Validator_IsSilent(*args
):
10777 """Validator_IsSilent() -> bool"""
10778 return _core_
.Validator_IsSilent(*args
)
10780 def Validator_SetBellOnError(*args
, **kwargs
):
10781 """Validator_SetBellOnError(int doIt=True)"""
10782 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10784 class PyValidator(Validator
):
10785 """Proxy of C++ PyValidator class"""
10786 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10787 __repr__
= _swig_repr
10788 def __init__(self
, *args
, **kwargs
):
10789 """__init__(self) -> PyValidator"""
10790 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10791 self
._setOORInfo
(self
);PyValidator
._setCallbackInfo
(self
, self
, PyValidator
)
10793 def _setCallbackInfo(*args
, **kwargs
):
10794 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
10795 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10797 _core_
.PyValidator_swigregister(PyValidator
)
10799 #---------------------------------------------------------------------------
10801 class Menu(EvtHandler
):
10802 """Proxy of C++ Menu class"""
10803 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10804 __repr__
= _swig_repr
10805 def __init__(self
, *args
, **kwargs
):
10806 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10807 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10808 self
._setOORInfo
(self
)
10810 def Append(*args
, **kwargs
):
10812 Append(self, int id, String text=EmptyString, String help=EmptyString,
10813 int kind=ITEM_NORMAL) -> MenuItem
10815 return _core_
.Menu_Append(*args
, **kwargs
)
10817 def AppendSeparator(*args
, **kwargs
):
10818 """AppendSeparator(self) -> MenuItem"""
10819 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10821 def AppendCheckItem(*args
, **kwargs
):
10822 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10823 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10825 def AppendRadioItem(*args
, **kwargs
):
10826 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10827 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10829 def AppendMenu(*args
, **kwargs
):
10830 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10831 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10833 def AppendSubMenu(*args
, **kwargs
):
10834 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10835 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10837 def AppendItem(*args
, **kwargs
):
10838 """AppendItem(self, MenuItem item) -> MenuItem"""
10839 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10841 def InsertItem(*args
, **kwargs
):
10842 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10843 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10845 def PrependItem(*args
, **kwargs
):
10846 """PrependItem(self, MenuItem item) -> MenuItem"""
10847 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10849 def Break(*args
, **kwargs
):
10851 return _core_
.Menu_Break(*args
, **kwargs
)
10853 def Insert(*args
, **kwargs
):
10855 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10856 int kind=ITEM_NORMAL) -> MenuItem
10858 return _core_
.Menu_Insert(*args
, **kwargs
)
10860 def InsertSeparator(*args
, **kwargs
):
10861 """InsertSeparator(self, size_t pos) -> MenuItem"""
10862 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10864 def InsertCheckItem(*args
, **kwargs
):
10865 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10866 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10868 def InsertRadioItem(*args
, **kwargs
):
10869 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10870 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10872 def InsertMenu(*args
, **kwargs
):
10873 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10874 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10876 def Prepend(*args
, **kwargs
):
10878 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10879 int kind=ITEM_NORMAL) -> MenuItem
10881 return _core_
.Menu_Prepend(*args
, **kwargs
)
10883 def PrependSeparator(*args
, **kwargs
):
10884 """PrependSeparator(self) -> MenuItem"""
10885 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10887 def PrependCheckItem(*args
, **kwargs
):
10888 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10889 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10891 def PrependRadioItem(*args
, **kwargs
):
10892 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10893 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10895 def PrependMenu(*args
, **kwargs
):
10896 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10897 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10899 def Remove(*args
, **kwargs
):
10900 """Remove(self, int id) -> MenuItem"""
10901 return _core_
.Menu_Remove(*args
, **kwargs
)
10903 def RemoveItem(self
, item
):
10904 """RemoveItem(self, MenuItem item) -> MenuItem"""
10905 #// The return object is always the parameter, so return that
10906 #// proxy instead of the new one
10907 val
= _core_
.Menu_RemoveItem(self
, item
)
10908 item
.this
.own(val
.this
.own())
10913 def Delete(*args
, **kwargs
):
10914 """Delete(self, int id) -> bool"""
10915 return _core_
.Menu_Delete(*args
, **kwargs
)
10917 def DeleteItem(*args
, **kwargs
):
10918 """DeleteItem(self, MenuItem item) -> bool"""
10919 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10921 def Destroy(*args
, **kwargs
):
10925 Deletes the C++ object this Python object is a proxy for.
10927 args
[0].this
.own(False)
10928 return _core_
.Menu_Destroy(*args
, **kwargs
)
10930 def DestroyId(*args
, **kwargs
):
10931 """DestroyId(self, int id) -> bool"""
10932 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10934 def DestroyItem(*args
, **kwargs
):
10935 """DestroyItem(self, MenuItem item) -> bool"""
10936 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10938 def GetMenuItemCount(*args
, **kwargs
):
10939 """GetMenuItemCount(self) -> size_t"""
10940 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10942 def GetMenuItems(*args
, **kwargs
):
10943 """GetMenuItems(self) -> PyObject"""
10944 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10946 def FindItem(*args
, **kwargs
):
10947 """FindItem(self, String item) -> int"""
10948 return _core_
.Menu_FindItem(*args
, **kwargs
)
10950 def FindItemById(*args
, **kwargs
):
10951 """FindItemById(self, int id) -> MenuItem"""
10952 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10954 def FindItemByPosition(*args
, **kwargs
):
10955 """FindItemByPosition(self, size_t position) -> MenuItem"""
10956 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10958 def Enable(*args
, **kwargs
):
10959 """Enable(self, int id, bool enable)"""
10960 return _core_
.Menu_Enable(*args
, **kwargs
)
10962 def IsEnabled(*args
, **kwargs
):
10963 """IsEnabled(self, int id) -> bool"""
10964 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10966 def Check(*args
, **kwargs
):
10967 """Check(self, int id, bool check)"""
10968 return _core_
.Menu_Check(*args
, **kwargs
)
10970 def IsChecked(*args
, **kwargs
):
10971 """IsChecked(self, int id) -> bool"""
10972 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10974 def SetLabel(*args
, **kwargs
):
10975 """SetLabel(self, int id, String label)"""
10976 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10978 def GetLabel(*args
, **kwargs
):
10979 """GetLabel(self, int id) -> String"""
10980 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10982 def SetHelpString(*args
, **kwargs
):
10983 """SetHelpString(self, int id, String helpString)"""
10984 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10986 def GetHelpString(*args
, **kwargs
):
10987 """GetHelpString(self, int id) -> String"""
10988 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10990 def SetTitle(*args
, **kwargs
):
10991 """SetTitle(self, String title)"""
10992 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10994 def GetTitle(*args
, **kwargs
):
10995 """GetTitle(self) -> String"""
10996 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10998 def SetEventHandler(*args
, **kwargs
):
10999 """SetEventHandler(self, EvtHandler handler)"""
11000 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
11002 def GetEventHandler(*args
, **kwargs
):
11003 """GetEventHandler(self) -> EvtHandler"""
11004 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
11006 def SetInvokingWindow(*args
, **kwargs
):
11007 """SetInvokingWindow(self, Window win)"""
11008 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
11010 def GetInvokingWindow(*args
, **kwargs
):
11011 """GetInvokingWindow(self) -> Window"""
11012 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
11014 def GetStyle(*args
, **kwargs
):
11015 """GetStyle(self) -> long"""
11016 return _core_
.Menu_GetStyle(*args
, **kwargs
)
11018 def UpdateUI(*args
, **kwargs
):
11019 """UpdateUI(self, EvtHandler source=None)"""
11020 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
11022 def GetMenuBar(*args
, **kwargs
):
11023 """GetMenuBar(self) -> MenuBar"""
11024 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
11026 def Attach(*args
, **kwargs
):
11027 """Attach(self, wxMenuBarBase menubar)"""
11028 return _core_
.Menu_Attach(*args
, **kwargs
)
11030 def Detach(*args
, **kwargs
):
11032 return _core_
.Menu_Detach(*args
, **kwargs
)
11034 def IsAttached(*args
, **kwargs
):
11035 """IsAttached(self) -> bool"""
11036 return _core_
.Menu_IsAttached(*args
, **kwargs
)
11038 def SetParent(*args
, **kwargs
):
11039 """SetParent(self, Menu parent)"""
11040 return _core_
.Menu_SetParent(*args
, **kwargs
)
11042 def GetParent(*args
, **kwargs
):
11043 """GetParent(self) -> Menu"""
11044 return _core_
.Menu_GetParent(*args
, **kwargs
)
11046 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
11047 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
11048 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
11049 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
11050 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
11051 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
11052 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
11053 Style
= property(GetStyle
,doc
="See `GetStyle`")
11054 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
11055 _core_
.Menu_swigregister(Menu
)
11056 DefaultValidator
= cvar
.DefaultValidator
11058 #---------------------------------------------------------------------------
11060 class MenuBar(Window
):
11061 """Proxy of C++ MenuBar class"""
11062 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11063 __repr__
= _swig_repr
11064 def __init__(self
, *args
, **kwargs
):
11065 """__init__(self, long style=0) -> MenuBar"""
11066 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
11067 self
._setOORInfo
(self
)
11069 def Append(*args
, **kwargs
):
11070 """Append(self, Menu menu, String title) -> bool"""
11071 return _core_
.MenuBar_Append(*args
, **kwargs
)
11073 def Insert(*args
, **kwargs
):
11074 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
11075 return _core_
.MenuBar_Insert(*args
, **kwargs
)
11077 def GetMenuCount(*args
, **kwargs
):
11078 """GetMenuCount(self) -> size_t"""
11079 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
11081 def GetMenu(*args
, **kwargs
):
11082 """GetMenu(self, size_t pos) -> Menu"""
11083 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
11085 def Replace(*args
, **kwargs
):
11086 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
11087 return _core_
.MenuBar_Replace(*args
, **kwargs
)
11089 def Remove(*args
, **kwargs
):
11090 """Remove(self, size_t pos) -> Menu"""
11091 return _core_
.MenuBar_Remove(*args
, **kwargs
)
11093 def EnableTop(*args
, **kwargs
):
11094 """EnableTop(self, size_t pos, bool enable)"""
11095 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
11097 def IsEnabledTop(*args
, **kwargs
):
11098 """IsEnabledTop(self, size_t pos) -> bool"""
11099 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
11101 def SetLabelTop(*args
, **kwargs
):
11102 """SetLabelTop(self, size_t pos, String label)"""
11103 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
11105 def GetLabelTop(*args
, **kwargs
):
11106 """GetLabelTop(self, size_t pos) -> String"""
11107 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
11109 def FindMenuItem(*args
, **kwargs
):
11110 """FindMenuItem(self, String menu, String item) -> int"""
11111 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
11113 def FindItemById(*args
, **kwargs
):
11114 """FindItemById(self, int id) -> MenuItem"""
11115 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
11117 def FindMenu(*args
, **kwargs
):
11118 """FindMenu(self, String title) -> int"""
11119 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
11121 def Enable(*args
, **kwargs
):
11122 """Enable(self, int id, bool enable)"""
11123 return _core_
.MenuBar_Enable(*args
, **kwargs
)
11125 def Check(*args
, **kwargs
):
11126 """Check(self, int id, bool check)"""
11127 return _core_
.MenuBar_Check(*args
, **kwargs
)
11129 def IsChecked(*args
, **kwargs
):
11130 """IsChecked(self, int id) -> bool"""
11131 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
11133 def IsEnabled(*args
, **kwargs
):
11134 """IsEnabled(self, int id) -> bool"""
11135 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
11137 def SetLabel(*args
, **kwargs
):
11138 """SetLabel(self, int id, String label)"""
11139 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
11141 def GetLabel(*args
, **kwargs
):
11142 """GetLabel(self, int id) -> String"""
11143 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
11145 def SetHelpString(*args
, **kwargs
):
11146 """SetHelpString(self, int id, String helpString)"""
11147 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
11149 def GetHelpString(*args
, **kwargs
):
11150 """GetHelpString(self, int id) -> String"""
11151 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
11153 def GetFrame(*args
, **kwargs
):
11154 """GetFrame(self) -> wxFrame"""
11155 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
11157 def IsAttached(*args
, **kwargs
):
11158 """IsAttached(self) -> bool"""
11159 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
11161 def Attach(*args
, **kwargs
):
11162 """Attach(self, wxFrame frame)"""
11163 return _core_
.MenuBar_Attach(*args
, **kwargs
)
11165 def Detach(*args
, **kwargs
):
11167 return _core_
.MenuBar_Detach(*args
, **kwargs
)
11169 def UpdateMenus(*args
, **kwargs
):
11170 """UpdateMenus(self)"""
11171 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
11173 def SetAutoWindowMenu(*args
, **kwargs
):
11174 """SetAutoWindowMenu(bool enable)"""
11175 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11177 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
11178 def GetAutoWindowMenu(*args
, **kwargs
):
11179 """GetAutoWindowMenu() -> bool"""
11180 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
11182 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
11183 def GetMenus(self
):
11184 """Return a list of (menu, label) items for the menus in the MenuBar. """
11185 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
11186 for i
in range(self
.GetMenuCount())]
11188 def SetMenus(self
, items
):
11189 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11190 for i
in range(self
.GetMenuCount()-1, -1, -1):
11195 Frame
= property(GetFrame
,doc
="See `GetFrame`")
11196 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
11197 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
11198 _core_
.MenuBar_swigregister(MenuBar
)
11200 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
11201 """MenuBar_SetAutoWindowMenu(bool enable)"""
11202 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11204 def MenuBar_GetAutoWindowMenu(*args
):
11205 """MenuBar_GetAutoWindowMenu() -> bool"""
11206 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
11208 #---------------------------------------------------------------------------
11210 class MenuItem(Object
):
11211 """Proxy of C++ MenuItem class"""
11212 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11213 __repr__
= _swig_repr
11214 def __init__(self
, *args
, **kwargs
):
11216 __init__(self, Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString,
11217 String help=EmptyString, int kind=ITEM_NORMAL,
11218 Menu subMenu=None) -> MenuItem
11220 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
11221 __swig_destroy__
= _core_
.delete_MenuItem
11222 __del__
= lambda self
: None;
11223 def Destroy(self
): pass
11224 def GetMenu(*args
, **kwargs
):
11225 """GetMenu(self) -> Menu"""
11226 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
11228 def SetMenu(*args
, **kwargs
):
11229 """SetMenu(self, Menu menu)"""
11230 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
11232 def SetId(*args
, **kwargs
):
11233 """SetId(self, int id)"""
11234 return _core_
.MenuItem_SetId(*args
, **kwargs
)
11236 def GetId(*args
, **kwargs
):
11237 """GetId(self) -> int"""
11238 return _core_
.MenuItem_GetId(*args
, **kwargs
)
11240 def IsSeparator(*args
, **kwargs
):
11241 """IsSeparator(self) -> bool"""
11242 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
11244 def SetText(*args
, **kwargs
):
11245 """SetText(self, String str)"""
11246 return _core_
.MenuItem_SetText(*args
, **kwargs
)
11248 def GetLabel(*args
, **kwargs
):
11249 """GetLabel(self) -> String"""
11250 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
11252 def GetText(*args
, **kwargs
):
11253 """GetText(self) -> String"""
11254 return _core_
.MenuItem_GetText(*args
, **kwargs
)
11256 def GetLabelFromText(*args
, **kwargs
):
11257 """GetLabelFromText(String text) -> String"""
11258 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11260 GetLabelFromText
= staticmethod(GetLabelFromText
)
11261 def GetKind(*args
, **kwargs
):
11262 """GetKind(self) -> int"""
11263 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
11265 def SetKind(*args
, **kwargs
):
11266 """SetKind(self, int kind)"""
11267 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
11269 def SetCheckable(*args
, **kwargs
):
11270 """SetCheckable(self, bool checkable)"""
11271 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
11273 def IsCheckable(*args
, **kwargs
):
11274 """IsCheckable(self) -> bool"""
11275 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
11277 def IsSubMenu(*args
, **kwargs
):
11278 """IsSubMenu(self) -> bool"""
11279 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
11281 def SetSubMenu(*args
, **kwargs
):
11282 """SetSubMenu(self, Menu menu)"""
11283 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
11285 def GetSubMenu(*args
, **kwargs
):
11286 """GetSubMenu(self) -> Menu"""
11287 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
11289 def Enable(*args
, **kwargs
):
11290 """Enable(self, bool enable=True)"""
11291 return _core_
.MenuItem_Enable(*args
, **kwargs
)
11293 def IsEnabled(*args
, **kwargs
):
11294 """IsEnabled(self) -> bool"""
11295 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
11297 def Check(*args
, **kwargs
):
11298 """Check(self, bool check=True)"""
11299 return _core_
.MenuItem_Check(*args
, **kwargs
)
11301 def IsChecked(*args
, **kwargs
):
11302 """IsChecked(self) -> bool"""
11303 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
11305 def Toggle(*args
, **kwargs
):
11307 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
11309 def SetHelp(*args
, **kwargs
):
11310 """SetHelp(self, String str)"""
11311 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
11313 def GetHelp(*args
, **kwargs
):
11314 """GetHelp(self) -> String"""
11315 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
11317 def GetAccel(*args
, **kwargs
):
11318 """GetAccel(self) -> AcceleratorEntry"""
11319 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
11321 def SetAccel(*args
, **kwargs
):
11322 """SetAccel(self, AcceleratorEntry accel)"""
11323 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
11325 def SetBitmap(*args
, **kwargs
):
11326 """SetBitmap(self, Bitmap bitmap)"""
11327 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
11329 def GetBitmap(*args
, **kwargs
):
11330 """GetBitmap(self) -> Bitmap"""
11331 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
11333 def SetFont(*args
, **kwargs
):
11334 """SetFont(self, Font font)"""
11335 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
11337 def GetFont(*args
, **kwargs
):
11338 """GetFont(self) -> Font"""
11339 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
11341 def SetTextColour(*args
, **kwargs
):
11342 """SetTextColour(self, Colour colText)"""
11343 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
11345 def GetTextColour(*args
, **kwargs
):
11346 """GetTextColour(self) -> Colour"""
11347 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
11349 def SetBackgroundColour(*args
, **kwargs
):
11350 """SetBackgroundColour(self, Colour colBack)"""
11351 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
11353 def GetBackgroundColour(*args
, **kwargs
):
11354 """GetBackgroundColour(self) -> Colour"""
11355 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11357 def SetBitmaps(*args
, **kwargs
):
11358 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11359 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11361 def SetDisabledBitmap(*args
, **kwargs
):
11362 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11363 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11365 def GetDisabledBitmap(*args
, **kwargs
):
11366 """GetDisabledBitmap(self) -> Bitmap"""
11367 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11369 def SetMarginWidth(*args
, **kwargs
):
11370 """SetMarginWidth(self, int nWidth)"""
11371 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11373 def GetMarginWidth(*args
, **kwargs
):
11374 """GetMarginWidth(self) -> int"""
11375 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11377 def GetDefaultMarginWidth(*args
, **kwargs
):
11378 """GetDefaultMarginWidth() -> int"""
11379 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11381 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11382 def IsOwnerDrawn(*args
, **kwargs
):
11383 """IsOwnerDrawn(self) -> bool"""
11384 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11386 def SetOwnerDrawn(*args
, **kwargs
):
11387 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11388 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11390 def ResetOwnerDrawn(*args
, **kwargs
):
11391 """ResetOwnerDrawn(self)"""
11392 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11394 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
11395 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
11396 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
11397 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11398 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
11399 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
11400 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
11401 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
11402 Label
= property(GetLabel
,doc
="See `GetLabel`")
11403 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
11404 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
11405 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
11406 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
11407 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
11408 _core_
.MenuItem_swigregister(MenuItem
)
11410 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11411 """MenuItem_GetLabelFromText(String text) -> String"""
11412 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11414 def MenuItem_GetDefaultMarginWidth(*args
):
11415 """MenuItem_GetDefaultMarginWidth() -> int"""
11416 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
11418 #---------------------------------------------------------------------------
11420 class Control(Window
):
11422 This is the base class for a control or 'widget'.
11424 A control is generally a small window which processes user input
11425 and/or displays one or more item of data.
11427 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11428 __repr__
= _swig_repr
11429 def __init__(self
, *args
, **kwargs
):
11431 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11432 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11433 String name=ControlNameStr) -> Control
11435 Create a Control. Normally you should only call this from a subclass'
11436 __init__ as a plain old wx.Control is not very useful.
11438 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
11439 self
._setOORInfo
(self
)
11441 def Create(*args
, **kwargs
):
11443 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11444 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11445 String name=ControlNameStr) -> bool
11447 Do the 2nd phase and create the GUI control.
11449 return _core_
.Control_Create(*args
, **kwargs
)
11451 def GetAlignment(*args
, **kwargs
):
11453 GetAlignment(self) -> int
11455 Get the control alignment (left/right/centre, top/bottom/centre)
11457 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11459 def GetLabelText(*args
, **kwargs
):
11461 GetLabelText(self) -> String
11463 Get just the text of the label, without mnemonic characters ('&')
11465 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11467 def Command(*args
, **kwargs
):
11469 Command(self, CommandEvent event)
11471 Simulates the effect of the user issuing a command to the item.
11473 :see: `wx.CommandEvent`
11476 return _core_
.Control_Command(*args
, **kwargs
)
11478 def RemoveMnemonics(*args
, **kwargs
):
11480 RemoveMnemonics(String str) -> String
11482 removes the mnemonics characters
11484 return _core_
.Control_RemoveMnemonics(*args
, **kwargs
)
11486 RemoveMnemonics
= staticmethod(RemoveMnemonics
)
11487 def GetClassDefaultAttributes(*args
, **kwargs
):
11489 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11491 Get the default attributes for this class. This is useful if you want
11492 to use the same font or colour in your own control as in a standard
11493 control -- which is a much better idea than hard coding specific
11494 colours or fonts which might look completely out of place on the
11495 user's system, especially if it uses themes.
11497 The variant parameter is only relevant under Mac currently and is
11498 ignore under other platforms. Under Mac, it will change the size of
11499 the returned font. See `wx.Window.SetWindowVariant` for more about
11502 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11504 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11505 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11506 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11507 _core_
.Control_swigregister(Control
)
11508 ControlNameStr
= cvar
.ControlNameStr
11510 def PreControl(*args
, **kwargs
):
11512 PreControl() -> Control
11514 Precreate a Control control for 2-phase creation
11516 val
= _core_
.new_PreControl(*args
, **kwargs
)
11519 def Control_RemoveMnemonics(*args
, **kwargs
):
11521 Control_RemoveMnemonics(String str) -> String
11523 removes the mnemonics characters
11525 return _core_
.Control_RemoveMnemonics(*args
, **kwargs
)
11527 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11529 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11531 Get the default attributes for this class. This is useful if you want
11532 to use the same font or colour in your own control as in a standard
11533 control -- which is a much better idea than hard coding specific
11534 colours or fonts which might look completely out of place on the
11535 user's system, especially if it uses themes.
11537 The variant parameter is only relevant under Mac currently and is
11538 ignore under other platforms. Under Mac, it will change the size of
11539 the returned font. See `wx.Window.SetWindowVariant` for more about
11542 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11544 #---------------------------------------------------------------------------
11546 class ItemContainer(object):
11548 The wx.ItemContainer class defines an interface which is implemented
11549 by all controls which have string subitems, each of which may be
11550 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11551 as `wx.ComboBox` which implements an extended interface deriving from
11554 It defines the methods for accessing the control's items and although
11555 each of the derived classes implements them differently, they still
11556 all conform to the same interface.
11558 The items in a wx.ItemContainer have (non empty) string labels and,
11559 optionally, client data associated with them.
11562 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11563 def __init__(self
): raise AttributeError, "No constructor defined"
11564 __repr__
= _swig_repr
11565 def Append(*args
, **kwargs
):
11567 Append(self, String item, PyObject clientData=None) -> int
11569 Adds the item to the control, associating the given data with the item
11570 if not None. The return value is the index of the newly added item
11571 which may be different from the last one if the control is sorted (e.g.
11572 has wx.LB_SORT or wx.CB_SORT style).
11574 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11576 def AppendItems(*args
, **kwargs
):
11578 AppendItems(self, List strings)
11580 Apend several items at once to the control. Notice that calling this
11581 method may be much faster than appending the items one by one if you
11582 need to add a lot of items.
11584 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11586 def Insert(*args
, **kwargs
):
11588 Insert(self, String item, int pos, PyObject clientData=None) -> int
11590 Insert an item into the control before the item at the ``pos`` index,
11591 optionally associating some data object with the item.
11593 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11595 def Clear(*args
, **kwargs
):
11599 Removes all items from the control.
11601 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11603 def Delete(*args
, **kwargs
):
11605 Delete(self, int n)
11607 Deletes the item at the zero-based index 'n' from the control. Note
11608 that it is an error (signalled by a `wx.PyAssertionError` exception if
11609 enabled) to remove an item with the index negative or greater or equal
11610 than the number of items in the control.
11612 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11614 def GetClientData(*args
, **kwargs
):
11616 GetClientData(self, int n) -> PyObject
11618 Returns the client data associated with the given item, (if any.)
11620 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11622 def SetClientData(*args
, **kwargs
):
11624 SetClientData(self, int n, PyObject clientData)
11626 Associate the given client data with the item at position n.
11628 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11630 def GetCount(*args
, **kwargs
):
11632 GetCount(self) -> int
11634 Returns the number of items in the control.
11636 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11638 def IsEmpty(*args
, **kwargs
):
11640 IsEmpty(self) -> bool
11642 Returns True if the control is empty or False if it has some items.
11644 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11646 def GetString(*args
, **kwargs
):
11648 GetString(self, int n) -> String
11650 Returns the label of the item with the given index.
11652 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11654 def GetStrings(*args
, **kwargs
):
11655 """GetStrings(self) -> wxArrayString"""
11656 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11658 def SetString(*args
, **kwargs
):
11660 SetString(self, int n, String s)
11662 Sets the label for the given item.
11664 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11666 def FindString(*args
, **kwargs
):
11668 FindString(self, String s) -> int
11670 Finds an item whose label matches the given string. Returns the
11671 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11674 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11676 def SetSelection(*args
, **kwargs
):
11678 SetSelection(self, int n)
11680 Sets the item at index 'n' to be the selected item.
11682 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11684 def GetSelection(*args
, **kwargs
):
11686 GetSelection(self) -> int
11688 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11691 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11693 def SetStringSelection(*args
, **kwargs
):
11694 """SetStringSelection(self, String s) -> bool"""
11695 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11697 def GetStringSelection(*args
, **kwargs
):
11699 GetStringSelection(self) -> String
11701 Returns the label of the selected item or an empty string if no item
11704 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11706 def Select(*args
, **kwargs
):
11708 Select(self, int n)
11710 This is the same as `SetSelection` and exists only because it is
11711 slightly more natural for controls which support multiple selection.
11713 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11715 def GetItems(self
):
11716 """Return a list of the strings in the control"""
11717 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11719 def SetItems(self
, items
):
11720 """Clear and set the strings in the control from a list"""
11725 Count
= property(GetCount
,doc
="See `GetCount`")
11726 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11727 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11728 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11729 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11730 _core_
.ItemContainer_swigregister(ItemContainer
)
11732 #---------------------------------------------------------------------------
11734 class ControlWithItems(Control
,ItemContainer
):
11736 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11737 wx.Control class, and is used for the base class of various controls
11740 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11741 def __init__(self
): raise AttributeError, "No constructor defined"
11742 __repr__
= _swig_repr
11743 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11745 #---------------------------------------------------------------------------
11747 class SizerFlags(object):
11749 Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
11750 to specify a lot of flags and parameters which can be unwieldy. This
11751 is where wx.SizerFlags comes in: it allows you to specify all
11752 parameters using the named methods instead. For example, instead of::
11754 sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
11756 you can now write::
11758 sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(wx.ALL, 10))
11760 This is more readable and also allows you to create wx.SizerFlags
11761 objects which can be reused for several sizer items.::
11763 flagsExpand = wx.SizerFlags(1)
11764 flagsExpand.Expand().Border(wx.ALL, 10)
11765 sizer.AddF(ctrl1, flagsExpand)
11766 sizer.AddF(ctrl2, flagsExpand)
11768 Note that by specification, all methods of wx.SizerFlags return the
11769 wx.SizerFlags object itself allowing chaining multiple method calls
11770 like in the examples above.
11772 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11773 __repr__
= _swig_repr
11774 def __init__(self
, *args
, **kwargs
):
11776 __init__(self, int proportion=0) -> SizerFlags
11778 Constructs the flags object with the specified proportion.
11780 _core_
.SizerFlags_swiginit(self
,_core_
.new_SizerFlags(*args
, **kwargs
))
11781 __swig_destroy__
= _core_
.delete_SizerFlags
11782 __del__
= lambda self
: None;
11783 def Proportion(*args
, **kwargs
):
11785 Proportion(self, int proportion) -> SizerFlags
11787 Sets the item's proportion value.
11789 return _core_
.SizerFlags_Proportion(*args
, **kwargs
)
11791 def Align(*args
, **kwargs
):
11793 Align(self, int alignment) -> SizerFlags
11795 Sets the item's alignment
11797 return _core_
.SizerFlags_Align(*args
, **kwargs
)
11799 def Expand(*args
, **kwargs
):
11801 Expand(self) -> SizerFlags
11803 Sets the wx.EXPAND flag, which will cause the item to be expanded to
11804 fill as much space as it is given by the sizer.
11806 return _core_
.SizerFlags_Expand(*args
, **kwargs
)
11808 def Centre(*args
, **kwargs
):
11810 Centre(self) -> SizerFlags
11812 Same as `Center` for those with an alternate dialect of English.
11814 return _core_
.SizerFlags_Centre(*args
, **kwargs
)
11816 def Center(*args
, **kwargs
):
11818 Center(self) -> SizerFlags
11820 Sets the centering alignment flags.
11822 return _core_
.SizerFlags_Center(*args
, **kwargs
)
11824 def Left(*args
, **kwargs
):
11826 Left(self) -> SizerFlags
11828 Aligns the object to the left, a shortcut for calling
11829 Align(wx.ALIGN_LEFT)
11831 return _core_
.SizerFlags_Left(*args
, **kwargs
)
11833 def Right(*args
, **kwargs
):
11835 Right(self) -> SizerFlags
11837 Aligns the object to the right, a shortcut for calling
11838 Align(wx.ALIGN_RIGHT)
11840 return _core_
.SizerFlags_Right(*args
, **kwargs
)
11842 def Top(*args
, **kwargs
):
11844 Top(self) -> SizerFlags
11846 Aligns the object to the top of the available space, a shortcut for
11847 calling Align(wx.ALIGN_TOP)
11849 return _core_
.SizerFlags_Top(*args
, **kwargs
)
11851 def Bottom(*args
, **kwargs
):
11853 Bottom(self) -> SizerFlags
11855 Aligns the object to the bottom of the available space, a shortcut for
11856 calling Align(wx.ALIGN_BOTTOM)
11858 return _core_
.SizerFlags_Bottom(*args
, **kwargs
)
11860 def Shaped(*args
, **kwargs
):
11862 Shaped(self) -> SizerFlags
11864 Sets the wx.SHAPED flag.
11866 return _core_
.SizerFlags_Shaped(*args
, **kwargs
)
11868 def FixedMinSize(*args
, **kwargs
):
11870 FixedMinSize(self) -> SizerFlags
11872 Sets the wx.FIXED_MINSIZE flag.
11874 return _core_
.SizerFlags_FixedMinSize(*args
, **kwargs
)
11876 def Border(*args
, **kwargs
):
11878 Border(self, int direction=ALL, int borderInPixels=-1) -> SizerFlags
11880 Sets the border of the item in the direction(s) or sides given by the
11881 direction parameter. If the borderInPixels value is not given then
11882 the default border size (see `GetDefaultBorder`) will be used.
11884 return _core_
.SizerFlags_Border(*args
, **kwargs
)
11886 def DoubleBorder(*args
, **kwargs
):
11888 DoubleBorder(self, int direction=ALL) -> SizerFlags
11890 Sets the border in the given direction to twice the default border
11893 return _core_
.SizerFlags_DoubleBorder(*args
, **kwargs
)
11895 def TripleBorder(*args
, **kwargs
):
11897 TripleBorder(self, int direction=ALL) -> SizerFlags
11899 Sets the border in the given direction to three times the default
11902 return _core_
.SizerFlags_TripleBorder(*args
, **kwargs
)
11904 def HorzBorder(*args
, **kwargs
):
11906 HorzBorder(self) -> SizerFlags
11908 Sets the left and right borders to the default border size.
11910 return _core_
.SizerFlags_HorzBorder(*args
, **kwargs
)
11912 def DoubleHorzBorder(*args
, **kwargs
):
11914 DoubleHorzBorder(self) -> SizerFlags
11916 Sets the left and right borders to twice the default border size.
11918 return _core_
.SizerFlags_DoubleHorzBorder(*args
, **kwargs
)
11920 def GetDefaultBorder(*args
, **kwargs
):
11922 GetDefaultBorder() -> int
11924 Returns the default border size used by the other border methods
11926 return _core_
.SizerFlags_GetDefaultBorder(*args
, **kwargs
)
11928 GetDefaultBorder
= staticmethod(GetDefaultBorder
)
11929 def GetProportion(*args
, **kwargs
):
11931 GetProportion(self) -> int
11933 Returns the proportion value to be used in the sizer item.
11935 return _core_
.SizerFlags_GetProportion(*args
, **kwargs
)
11937 def GetFlags(*args
, **kwargs
):
11939 GetFlags(self) -> int
11941 Returns the flags value to be used in the sizer item.
11943 return _core_
.SizerFlags_GetFlags(*args
, **kwargs
)
11945 def GetBorderInPixels(*args
, **kwargs
):
11947 GetBorderInPixels(self) -> int
11949 Returns the border value in pixels to be used in the sizer item.
11951 return _core_
.SizerFlags_GetBorderInPixels(*args
, **kwargs
)
11953 _core_
.SizerFlags_swigregister(SizerFlags
)
11955 def SizerFlags_GetDefaultBorder(*args
):
11957 SizerFlags_GetDefaultBorder() -> int
11959 Returns the default border size used by the other border methods
11961 return _core_
.SizerFlags_GetDefaultBorder(*args
)
11963 class SizerItem(Object
):
11965 The wx.SizerItem class is used to track the position, size and other
11966 attributes of each item managed by a `wx.Sizer`. It is not usually
11967 necessary to use this class because the sizer elements can also be
11968 identified by their positions or window or sizer references but
11969 sometimes it may be more convenient to use wx.SizerItem directly.
11970 Also, custom classes derived from `wx.PySizer` will probably need to
11971 use the collection of wx.SizerItems held by wx.Sizer when calculating
11974 :see: `wx.Sizer`, `wx.GBSizerItem`
11976 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11977 __repr__
= _swig_repr
11978 def __init__(self
, *args
, **kwargs
):
11980 __init__(self) -> SizerItem
11982 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11983 size will need to be set before this item can be used in a Sizer.
11985 You will probably never need to create a wx.SizerItem directly as they
11986 are created automatically when the sizer's Add, Insert or Prepend
11987 methods are called.
11989 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11991 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11992 __swig_destroy__
= _core_
.delete_SizerItem
11993 __del__
= lambda self
: None;
11994 def DeleteWindows(*args
, **kwargs
):
11996 DeleteWindows(self)
11998 Destroy the window or the windows in a subsizer, depending on the type
12001 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
12003 def DetachSizer(*args
, **kwargs
):
12007 Enable deleting the SizerItem without destroying the contained sizer.
12009 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
12011 def GetSize(*args
, **kwargs
):
12013 GetSize(self) -> Size
12015 Get the current size of the item, as set in the last Layout.
12017 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
12019 def CalcMin(*args
, **kwargs
):
12021 CalcMin(self) -> Size
12023 Calculates the minimum desired size for the item, including any space
12026 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
12028 def SetDimension(*args
, **kwargs
):
12030 SetDimension(self, Point pos, Size size)
12032 Set the position and size of the space allocated for this item by the
12033 sizer, and adjust the position and size of the item (window or
12034 subsizer) to be within that space taking alignment and borders into
12037 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
12039 def GetMinSize(*args
, **kwargs
):
12041 GetMinSize(self) -> Size
12043 Get the minimum size needed for the item.
12045 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
12047 def GetMinSizeWithBorder(*args
, **kwargs
):
12049 GetMinSizeWithBorder(self) -> Size
12051 Get the minimum size needed for the item with space for the borders
12054 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
12056 def SetInitSize(*args
, **kwargs
):
12057 """SetInitSize(self, int x, int y)"""
12058 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
12060 def SetRatioWH(*args
, **kwargs
):
12062 SetRatioWH(self, int width, int height)
12064 Set the ratio item attribute.
12066 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
12068 def SetRatioSize(*args
, **kwargs
):
12070 SetRatioSize(self, Size size)
12072 Set the ratio item attribute.
12074 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
12076 def SetRatio(*args
, **kwargs
):
12078 SetRatio(self, float ratio)
12080 Set the ratio item attribute.
12082 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
12084 def GetRatio(*args
, **kwargs
):
12086 GetRatio(self) -> float
12088 Set the ratio item attribute.
12090 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
12092 def GetRect(*args
, **kwargs
):
12094 GetRect(self) -> Rect
12096 Returns the rectangle that the sizer item should occupy
12098 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
12100 def IsWindow(*args
, **kwargs
):
12102 IsWindow(self) -> bool
12104 Is this sizer item a window?
12106 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
12108 def IsSizer(*args
, **kwargs
):
12110 IsSizer(self) -> bool
12112 Is this sizer item a subsizer?
12114 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
12116 def IsSpacer(*args
, **kwargs
):
12118 IsSpacer(self) -> bool
12120 Is this sizer item a spacer?
12122 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
12124 def SetProportion(*args
, **kwargs
):
12126 SetProportion(self, int proportion)
12128 Set the proportion value for this item.
12130 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
12132 def GetProportion(*args
, **kwargs
):
12134 GetProportion(self) -> int
12136 Get the proportion value for this item.
12138 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
12140 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
12141 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
12142 def SetFlag(*args
, **kwargs
):
12144 SetFlag(self, int flag)
12146 Set the flag value for this item.
12148 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
12150 def GetFlag(*args
, **kwargs
):
12152 GetFlag(self) -> int
12154 Get the flag value for this item.
12156 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
12158 def SetBorder(*args
, **kwargs
):
12160 SetBorder(self, int border)
12162 Set the border value for this item.
12164 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
12166 def GetBorder(*args
, **kwargs
):
12168 GetBorder(self) -> int
12170 Get the border value for this item.
12172 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
12174 def GetWindow(*args
, **kwargs
):
12176 GetWindow(self) -> Window
12178 Get the window (if any) that is managed by this sizer item.
12180 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
12182 def GetSizer(*args
, **kwargs
):
12184 GetSizer(self) -> Sizer
12186 Get the subsizer (if any) that is managed by this sizer item.
12188 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
12190 def GetSpacer(*args
, **kwargs
):
12192 GetSpacer(self) -> Size
12194 Get the size of the spacer managed by this sizer item.
12196 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
12198 def SetWindow(*args
, **kwargs
):
12200 SetWindow(self, Window window)
12202 Set the window to be managed by this sizer item.
12204 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
12206 def SetSizer(*args
, **kwargs
):
12208 SetSizer(self, Sizer sizer)
12210 Set the subsizer to be managed by this sizer item.
12212 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
12214 def SetSpacer(*args
, **kwargs
):
12216 SetSpacer(self, Size size)
12218 Set the size of the spacer to be managed by this sizer item.
12220 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
12222 SetWindow
= wx
._deprecated
(SetWindow
, "Use `AssignWindow` instead.")
12223 SetSizer
= wx
._deprecated
(SetSizer
, "Use `AssignSizer` instead.")
12224 SetSpacer
= wx
._deprecated
(SetSpacer
, "Use `AssignSpacer` instead.")
12226 def AssignWindow(*args
, **kwargs
):
12228 AssignWindow(self, Window window)
12230 Set the window to be managed by this sizer item.
12232 return _core_
.SizerItem_AssignWindow(*args
, **kwargs
)
12234 def AssignSizer(*args
, **kwargs
):
12236 AssignSizer(self, Sizer sizer)
12238 Set the subsizer to be managed by this sizer item.
12240 return _core_
.SizerItem_AssignSizer(*args
, **kwargs
)
12242 def AssignSpacer(*args
, **kwargs
):
12244 AssignSpacer(self, Size size)
12246 Set the size of the spacer to be managed by this sizer item.
12248 return _core_
.SizerItem_AssignSpacer(*args
, **kwargs
)
12250 def Show(*args
, **kwargs
):
12252 Show(self, bool show)
12254 Set the show item attribute, which sizers use to determine if the item
12255 is to be made part of the layout or not. If the item is tracking a
12256 window then it is shown or hidden as needed.
12258 return _core_
.SizerItem_Show(*args
, **kwargs
)
12260 def IsShown(*args
, **kwargs
):
12262 IsShown(self) -> bool
12264 Is the item to be shown in the layout?
12266 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
12268 def GetPosition(*args
, **kwargs
):
12270 GetPosition(self) -> Point
12272 Returns the current position of the item, as set in the last Layout.
12274 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
12276 def GetUserData(*args
, **kwargs
):
12278 GetUserData(self) -> PyObject
12280 Returns the userData associated with this sizer item, or None if there
12283 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
12285 def SetUserData(*args
, **kwargs
):
12287 SetUserData(self, PyObject userData)
12289 Associate a Python object with this sizer item.
12291 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
12293 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
12294 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
12295 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
12296 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
12297 Position
= property(GetPosition
,doc
="See `GetPosition`")
12298 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
12299 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
12300 Rect
= property(GetRect
,doc
="See `GetRect`")
12301 Size
= property(GetSize
,doc
="See `GetSize`")
12302 Sizer
= property(GetSizer
,AssignSizer
,doc
="See `GetSizer` and `AssignSizer`")
12303 Spacer
= property(GetSpacer
,AssignSpacer
,doc
="See `GetSpacer` and `AssignSpacer`")
12304 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
12305 Window
= property(GetWindow
,AssignWindow
,doc
="See `GetWindow` and `AssignWindow`")
12306 _core_
.SizerItem_swigregister(SizerItem
)
12308 def SizerItemWindow(*args
, **kwargs
):
12310 SizerItemWindow(Window window, int proportion, int flag, int border,
12311 PyObject userData=None) -> SizerItem
12313 Constructs a `wx.SizerItem` for tracking a window.
12315 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
12318 def SizerItemSpacer(*args
, **kwargs
):
12320 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
12321 PyObject userData=None) -> SizerItem
12323 Constructs a `wx.SizerItem` for tracking a spacer.
12325 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
12328 def SizerItemSizer(*args
, **kwargs
):
12330 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
12331 PyObject userData=None) -> SizerItem
12333 Constructs a `wx.SizerItem` for tracking a subsizer
12335 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
12338 class Sizer(Object
):
12340 wx.Sizer is the abstract base class used for laying out subwindows in
12341 a window. You cannot use wx.Sizer directly; instead, you will have to
12342 use one of the sizer classes derived from it such as `wx.BoxSizer`,
12343 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
12346 The concept implemented by sizers in wxWidgets is closely related to
12347 layout tools in other GUI toolkits, such as Java's AWT, the GTK
12348 toolkit or the Qt toolkit. It is based upon the idea of the individual
12349 subwindows reporting their minimal required size and their ability to
12350 get stretched if the size of the parent window has changed. This will
12351 most often mean that the programmer does not set the original size of
12352 a dialog in the beginning, rather the dialog will assigned a sizer and
12353 this sizer will be queried about the recommended size. The sizer in
12354 turn will query its children, which can be normal windows or contorls,
12355 empty space or other sizers, so that a hierarchy of sizers can be
12356 constructed. Note that wxSizer does not derive from wxWindow and thus
12357 do not interfere with tab ordering and requires very little resources
12358 compared to a real window on screen.
12360 What makes sizers so well fitted for use in wxWidgets is the fact that
12361 every control reports its own minimal size and the algorithm can
12362 handle differences in font sizes or different window (dialog item)
12363 sizes on different platforms without problems. If for example the
12364 standard font as well as the overall design of Mac widgets requires
12365 more space than on Windows, then the initial size of a dialog using a
12366 sizer will automatically be bigger on Mac than on Windows.
12368 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12369 def __init__(self
): raise AttributeError, "No constructor defined"
12370 __repr__
= _swig_repr
12371 __swig_destroy__
= _core_
.delete_Sizer
12372 __del__
= lambda self
: None;
12373 def _setOORInfo(*args
, **kwargs
):
12374 """_setOORInfo(self, PyObject _self)"""
12375 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
12377 def Add(*args
, **kwargs
):
12379 Add(self, item, int proportion=0, int flag=0, int border=0,
12380 PyObject userData=None) -> wx.SizerItem
12382 Appends a child item to the sizer.
12384 return _core_
.Sizer_Add(*args
, **kwargs
)
12386 def AddF(*args
, **kwargs
):
12388 AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem
12390 Similar to `Add` but uses the `wx.SizerFlags` convenience class for
12391 setting the various flags, options and borders.
12393 return _core_
.Sizer_AddF(*args
, **kwargs
)
12395 def Insert(*args
, **kwargs
):
12397 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
12398 PyObject userData=None) -> wx.SizerItem
12400 Inserts a new item into the list of items managed by this sizer before
12401 the item at index *before*. See `Add` for a description of the parameters.
12403 return _core_
.Sizer_Insert(*args
, **kwargs
)
12405 def InsertF(*args
, **kwargs
):
12407 InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem
12409 Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
12410 for setting the various flags, options and borders.
12412 return _core_
.Sizer_InsertF(*args
, **kwargs
)
12414 def Prepend(*args
, **kwargs
):
12416 Prepend(self, item, int proportion=0, int flag=0, int border=0,
12417 PyObject userData=None) -> wx.SizerItem
12419 Adds a new item to the begining of the list of sizer items managed by
12420 this sizer. See `Add` for a description of the parameters.
12422 return _core_
.Sizer_Prepend(*args
, **kwargs
)
12424 def PrependF(*args
, **kwargs
):
12426 PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem
12428 Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
12429 for setting the various flags, options and borders.
12431 return _core_
.Sizer_PrependF(*args
, **kwargs
)
12433 def Remove(*args
, **kwargs
):
12435 Remove(self, item) -> bool
12437 Removes an item from the sizer and destroys it. This method does not
12438 cause any layout or resizing to take place, call `Layout` to update
12439 the layout on screen after removing a child from the sizer. The
12440 *item* parameter can be either a window, a sizer, or the zero-based
12441 index of an item to remove. Returns True if the child item was found
12444 return _core_
.Sizer_Remove(*args
, **kwargs
)
12446 def Detach(*args
, **kwargs
):
12448 Detach(self, item) -> bool
12450 Detaches an item from the sizer without destroying it. This method
12451 does not cause any layout or resizing to take place, call `Layout` to
12452 do so. The *item* parameter can be either a window, a sizer, or the
12453 zero-based index of the item to be detached. Returns True if the child item
12454 was found and detached.
12456 return _core_
.Sizer_Detach(*args
, **kwargs
)
12458 def GetItem(*args
, **kwargs
):
12460 GetItem(self, item, recursive=False) -> wx.SizerItem
12462 Returns the `wx.SizerItem` which holds the *item* given. The *item*
12463 parameter can be either a window, a sizer, or the zero-based index of
12464 the item to be found.
12466 return _core_
.Sizer_GetItem(*args
, **kwargs
)
12468 def _SetItemMinSize(*args
, **kwargs
):
12469 """_SetItemMinSize(self, PyObject item, Size size)"""
12470 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
12472 def _ReplaceWin(*args
, **kwargs
):
12473 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12474 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
12476 def _ReplaceSizer(*args
, **kwargs
):
12477 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12478 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
12480 def _ReplaceItem(*args
, **kwargs
):
12481 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12482 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
12484 def Replace(self
, olditem
, item
, recursive
=False):
12486 Detaches the given ``olditem`` from the sizer and replaces it with
12487 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12488 detached child is destroyed only if it is not a window, (because
12489 windows are owned by their parent, not the sizer.) The
12490 ``recursive`` parameter can be used to search for the given
12491 element recursivly in subsizers.
12493 This method does not cause any layout or resizing to take place,
12494 call `Layout` to do so.
12496 Returns ``True`` if the child item was found and removed.
12498 if isinstance(olditem
, wx
.Window
):
12499 return self
._ReplaceWin
(olditem
, item
, recursive
)
12500 elif isinstance(olditem
, wx
.Sizer
):
12501 return self
._ReplaceSizer
(olditem
, item
, recursive
)
12502 elif isinstance(olditem
, int):
12503 return self
._ReplaceItem
(olditem
, item
)
12505 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12507 def SetContainingWindow(*args
, **kwargs
):
12509 SetContainingWindow(self, Window window)
12511 Set (or unset) the window this sizer is used in.
12513 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
12515 def GetContainingWindow(*args
, **kwargs
):
12517 GetContainingWindow(self) -> Window
12519 Get the window this sizer is used in.
12521 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
12523 def SetItemMinSize(self
, item
, *args
):
12525 SetItemMinSize(self, item, Size size)
12527 Sets the minimum size that will be allocated for an item in the sizer.
12528 The *item* parameter can be either a window, a sizer, or the
12529 zero-based index of the item. If a window or sizer is given then it
12530 will be searched for recursivly in subsizers if neccessary.
12533 # for backward compatibility accept separate width,height args too
12534 return self
._SetItemMinSize
(item
, args
)
12536 return self
._SetItemMinSize
(item
, args
[0])
12538 def AddItem(*args
, **kwargs
):
12540 AddItem(self, SizerItem item)
12542 Adds a `wx.SizerItem` to the sizer.
12544 return _core_
.Sizer_AddItem(*args
, **kwargs
)
12546 def InsertItem(*args
, **kwargs
):
12548 InsertItem(self, int index, SizerItem item)
12550 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12552 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
12554 def PrependItem(*args
, **kwargs
):
12556 PrependItem(self, SizerItem item)
12558 Prepends a `wx.SizerItem` to the sizer.
12560 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
12562 def AddMany(self
, items
):
12564 AddMany is a convenience method for adding several items
12565 to a sizer at one time. Simply pass it a list of tuples,
12566 where each tuple consists of the parameters that you
12567 would normally pass to the `Add` method.
12570 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
12574 def AddSpacer(self
, *args
, **kw
):
12575 """AddSpacer(int size) --> SizerItem
12577 Add a spacer that is (size,size) pixels.
12579 if args
and type(args
[0]) == int:
12580 return self
.Add( (args
[0],args
[0] ), 0)
12581 else: # otherwise stay compatible with old AddSpacer
12582 return self
.Add(*args
, **kw
)
12583 def PrependSpacer(self
, *args
, **kw
):
12584 """PrependSpacer(int size) --> SizerItem
12586 Prepend a spacer that is (size, size) pixels."""
12587 if args
and type(args
[0]) == int:
12588 return self
.Prepend( (args
[0],args
[0] ), 0)
12589 else: # otherwise stay compatible with old PrependSpacer
12590 return self
.Prepend(*args
, **kw
)
12591 def InsertSpacer(self
, index
, *args
, **kw
):
12592 """InsertSpacer(int index, int size) --> SizerItem
12594 Insert a spacer at position index that is (size, size) pixels."""
12595 if args
and type(args
[0]) == int:
12596 return self
.Insert( index
, (args
[0],args
[0] ), 0)
12597 else: # otherwise stay compatible with old InsertSpacer
12598 return self
.Insert(index
, *args
, **kw
)
12601 def AddStretchSpacer(self
, prop
=1):
12602 """AddStretchSpacer(int prop=1) --> SizerItem
12604 Add a stretchable spacer."""
12605 return self
.Add((0,0), prop
)
12606 def PrependStretchSpacer(self
, prop
=1):
12607 """PrependStretchSpacer(int prop=1) --> SizerItem
12609 Prepend a stretchable spacer."""
12610 return self
.Prepend((0,0), prop
)
12611 def InsertStretchSpacer(self
, index
, prop
=1):
12612 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12614 Insert a stretchable spacer."""
12615 return self
.Insert(index
, (0,0), prop
)
12618 # for backwards compatibility only, please do not use in new code
12619 def AddWindow(self
, *args
, **kw
):
12620 """Compatibility alias for `Add`."""
12621 return self
.Add(*args
, **kw
)
12622 def AddSizer(self
, *args
, **kw
):
12623 """Compatibility alias for `Add`."""
12624 return self
.Add(*args
, **kw
)
12626 def PrependWindow(self
, *args
, **kw
):
12627 """Compatibility alias for `Prepend`."""
12628 return self
.Prepend(*args
, **kw
)
12629 def PrependSizer(self
, *args
, **kw
):
12630 """Compatibility alias for `Prepend`."""
12631 return self
.Prepend(*args
, **kw
)
12633 def InsertWindow(self
, *args
, **kw
):
12634 """Compatibility alias for `Insert`."""
12635 return self
.Insert(*args
, **kw
)
12636 def InsertSizer(self
, *args
, **kw
):
12637 """Compatibility alias for `Insert`."""
12638 return self
.Insert(*args
, **kw
)
12640 def RemoveWindow(self
, *args
, **kw
):
12641 """Compatibility alias for `Remove`."""
12642 return self
.Remove(*args
, **kw
)
12643 def RemoveSizer(self
, *args
, **kw
):
12644 """Compatibility alias for `Remove`."""
12645 return self
.Remove(*args
, **kw
)
12646 def RemovePos(self
, *args
, **kw
):
12647 """Compatibility alias for `Remove`."""
12648 return self
.Remove(*args
, **kw
)
12651 def SetDimension(*args
, **kwargs
):
12653 SetDimension(self, int x, int y, int width, int height)
12655 Call this to force the sizer to take the given dimension and thus
12656 force the items owned by the sizer to resize themselves according to
12657 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12660 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
12662 def SetMinSize(*args
, **kwargs
):
12664 SetMinSize(self, Size size)
12666 Call this to give the sizer a minimal size. Normally, the sizer will
12667 calculate its minimal size based purely on how much space its children
12668 need. After calling this method `GetMinSize` will return either the
12669 minimal size as requested by its children or the minimal size set
12670 here, depending on which is bigger.
12672 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
12674 def GetSize(*args
, **kwargs
):
12676 GetSize(self) -> Size
12678 Returns the current size of the space managed by the sizer.
12680 return _core_
.Sizer_GetSize(*args
, **kwargs
)
12682 def GetPosition(*args
, **kwargs
):
12684 GetPosition(self) -> Point
12686 Returns the current position of the sizer's managed space.
12688 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
12690 def GetMinSize(*args
, **kwargs
):
12692 GetMinSize(self) -> Size
12694 Returns the minimal size of the sizer. This is either the combined
12695 minimal size of all the children and their borders or the minimal size
12696 set by SetMinSize, depending on which is bigger.
12698 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
12700 def GetSizeTuple(self
):
12701 return self
.GetSize().Get()
12702 def GetPositionTuple(self
):
12703 return self
.GetPosition().Get()
12704 def GetMinSizeTuple(self
):
12705 return self
.GetMinSize().Get()
12707 def RecalcSizes(*args
, **kwargs
):
12711 Using the sizes calculated by `CalcMin` reposition and resize all the
12712 items managed by this sizer. You should not need to call this directly as
12713 it is called by `Layout`.
12715 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
12717 def CalcMin(*args
, **kwargs
):
12719 CalcMin(self) -> Size
12721 This method is where the sizer will do the actual calculation of its
12722 children's minimal sizes. You should not need to call this directly as
12723 it is called by `Layout`.
12725 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
12727 def Layout(*args
, **kwargs
):
12731 This method will force the recalculation and layout of the items
12732 controlled by the sizer using the current space allocated to the
12733 sizer. Normally this is called automatically from the owning window's
12734 EVT_SIZE handler, but it is also useful to call it from user code when
12735 one of the items in a sizer change size, or items are added or
12738 return _core_
.Sizer_Layout(*args
, **kwargs
)
12740 def Fit(*args
, **kwargs
):
12742 Fit(self, Window window) -> Size
12744 Tell the sizer to resize the *window* to match the sizer's minimal
12745 size. This is commonly done in the constructor of the window itself in
12746 order to set its initial size to match the needs of the children as
12747 determined by the sizer. Returns the new size.
12749 For a top level window this is the total window size, not the client size.
12751 return _core_
.Sizer_Fit(*args
, **kwargs
)
12753 def FitInside(*args
, **kwargs
):
12755 FitInside(self, Window window)
12757 Tell the sizer to resize the *virtual size* of the *window* to match the
12758 sizer's minimal size. This will not alter the on screen size of the
12759 window, but may cause the addition/removal/alteration of scrollbars
12760 required to view the virtual area in windows which manage it.
12762 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12765 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12767 def SetSizeHints(*args
, **kwargs
):
12769 SetSizeHints(self, Window window)
12771 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12772 match the sizer's minimal size. This is commonly done in the
12773 constructor of the window itself if the window is resizable (as are
12774 many dialogs under Unix and frames on probably all platforms) in order
12775 to prevent the window from being sized smaller than the minimal size
12776 required by the sizer.
12778 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12780 def SetVirtualSizeHints(*args
, **kwargs
):
12782 SetVirtualSizeHints(self, Window window)
12784 Tell the sizer to set the minimal size of the window virtual area to
12785 match the sizer's minimal size. For windows with managed scrollbars
12786 this will set them appropriately.
12788 :see: `wx.ScrolledWindow.SetScrollbars`
12791 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12793 def Clear(*args
, **kwargs
):
12795 Clear(self, bool deleteWindows=False)
12797 Clear all items from the sizer, optionally destroying the window items
12800 return _core_
.Sizer_Clear(*args
, **kwargs
)
12802 def DeleteWindows(*args
, **kwargs
):
12804 DeleteWindows(self)
12806 Destroy all windows managed by the sizer.
12808 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12810 def GetChildren(*args
, **kwargs
):
12812 GetChildren(self) -> list
12814 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12816 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12818 def Show(*args
, **kwargs
):
12820 Show(self, item, bool show=True, bool recursive=false) -> bool
12822 Shows or hides an item managed by the sizer. To make a sizer item
12823 disappear or reappear, use Show followed by `Layout`. The *item*
12824 parameter can be either a window, a sizer, or the zero-based index of
12825 the item. Use the recursive parameter to show or hide an item in a
12826 subsizer. Returns True if the item was found.
12828 return _core_
.Sizer_Show(*args
, **kwargs
)
12830 def IsShown(*args
, **kwargs
):
12832 IsShown(self, item)
12834 Determines if the item is currently shown. To make a sizer
12835 item disappear or reappear, use Show followed by `Layout`. The *item*
12836 parameter can be either a window, a sizer, or the zero-based index of
12839 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12841 def Hide(self
, item
, recursive
=False):
12843 A convenience method for `Show` (item, False, recursive).
12845 return self
.Show(item
, False, recursive
)
12847 def ShowItems(*args
, **kwargs
):
12849 ShowItems(self, bool show)
12851 Recursively call `wx.SizerItem.Show` on all sizer items.
12853 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12855 Children
= property(GetChildren
,doc
="See `GetChildren`")
12856 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12857 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12858 Position
= property(GetPosition
,doc
="See `GetPosition`")
12859 Size
= property(GetSize
,doc
="See `GetSize`")
12860 _core_
.Sizer_swigregister(Sizer
)
12862 class PySizer(Sizer
):
12864 wx.PySizer is a special version of `wx.Sizer` that has been
12865 instrumented to allow the C++ virtual methods to be overloaded in
12866 Python derived classes. You would derive from this class if you are
12867 wanting to implement a custom sizer in Python code. Simply implement
12868 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12871 class MySizer(wx.PySizer):
12872 def __init__(self):
12873 wx.PySizer.__init__(self)
12876 for item in self.GetChildren():
12877 # calculate the total minimum width and height needed
12878 # by all items in the sizer according to this sizer's
12879 # layout algorithm.
12881 return wx.Size(width, height)
12883 def RecalcSizes(self):
12884 # find the space allotted to this sizer
12885 pos = self.GetPosition()
12886 size = self.GetSize()
12887 for item in self.GetChildren():
12888 # Recalculate (if necessary) the position and size of
12889 # each item and then call item.SetDimension to do the
12890 # actual positioning and sizing of the items within the
12891 # space alloted to this sizer.
12893 item.SetDimension(itemPos, itemSize)
12896 When `Layout` is called it first calls `CalcMin` followed by
12897 `RecalcSizes` so you can optimize a bit by saving the results of
12898 `CalcMin` and reusing them in `RecalcSizes`.
12900 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12904 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12905 __repr__
= _swig_repr
12906 def __init__(self
, *args
, **kwargs
):
12908 __init__(self) -> PySizer
12910 Creates a wx.PySizer. Must be called from the __init__ in the derived
12913 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12914 self
._setOORInfo
(self
);PySizer
._setCallbackInfo
(self
, self
, PySizer
)
12916 def _setCallbackInfo(*args
, **kwargs
):
12917 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12918 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12920 _core_
.PySizer_swigregister(PySizer
)
12922 #---------------------------------------------------------------------------
12924 class BoxSizer(Sizer
):
12926 The basic idea behind a box sizer is that windows will most often be
12927 laid out in rather simple basic geometry, typically in a row or a
12928 column or nested hierarchies of either. A wx.BoxSizer will lay out
12929 its items in a simple row or column, depending on the orientation
12930 parameter passed to the constructor.
12932 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12933 __repr__
= _swig_repr
12934 def __init__(self
, *args
, **kwargs
):
12936 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12938 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12939 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12942 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12943 self
._setOORInfo
(self
)
12945 def GetOrientation(*args
, **kwargs
):
12947 GetOrientation(self) -> int
12949 Returns the current orientation of the sizer.
12951 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12953 def SetOrientation(*args
, **kwargs
):
12955 SetOrientation(self, int orient)
12957 Resets the orientation of the sizer.
12959 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12961 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12962 _core_
.BoxSizer_swigregister(BoxSizer
)
12964 #---------------------------------------------------------------------------
12966 class StaticBoxSizer(BoxSizer
):
12968 wx.StaticBoxSizer derives from and functions identically to the
12969 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12970 manages. Note that this static box must be created separately and
12971 passed to the sizer constructor.
12973 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12974 __repr__
= _swig_repr
12975 def __init__(self
, *args
, **kwargs
):
12977 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12979 Constructor. It takes an associated static box and the orientation
12980 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12983 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12984 self
._setOORInfo
(self
)
12986 def GetStaticBox(*args
, **kwargs
):
12988 GetStaticBox(self) -> StaticBox
12990 Returns the static box associated with this sizer.
12992 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12994 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12995 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12997 #---------------------------------------------------------------------------
12999 class GridSizer(Sizer
):
13001 A grid sizer is a sizer which lays out its children in a
13002 two-dimensional table with all cells having the same size. In other
13003 words, the width of each cell within the grid is the width of the
13004 widest item added to the sizer and the height of each grid cell is the
13005 height of the tallest item. An optional vertical and/or horizontal
13006 gap between items can also be specified (in pixels.)
13008 Items are placed in the cells of the grid in the order they are added,
13009 in row-major order. In other words, the first row is filled first,
13010 then the second, and so on until all items have been added. (If
13011 neccessary, additional rows will be added as items are added.) If you
13012 need to have greater control over the cells that items are placed in
13013 then use the `wx.GridBagSizer`.
13016 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13017 __repr__
= _swig_repr
13018 def __init__(self
, *args
, **kwargs
):
13020 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
13022 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
13023 of columns and rows in the sizer - if either of the parameters is
13024 zero, it will be calculated to from the total number of children in
13025 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
13026 define extra space between all children.
13028 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
13029 self
._setOORInfo
(self
)
13031 def SetCols(*args
, **kwargs
):
13033 SetCols(self, int cols)
13035 Sets the number of columns in the sizer.
13037 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
13039 def SetRows(*args
, **kwargs
):
13041 SetRows(self, int rows)
13043 Sets the number of rows in the sizer.
13045 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
13047 def SetVGap(*args
, **kwargs
):
13049 SetVGap(self, int gap)
13051 Sets the vertical gap (in pixels) between the cells in the sizer.
13053 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
13055 def SetHGap(*args
, **kwargs
):
13057 SetHGap(self, int gap)
13059 Sets the horizontal gap (in pixels) between cells in the sizer
13061 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
13063 def GetCols(*args
, **kwargs
):
13065 GetCols(self) -> int
13067 Returns the number of columns in the sizer.
13069 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
13071 def GetRows(*args
, **kwargs
):
13073 GetRows(self) -> int
13075 Returns the number of rows in the sizer.
13077 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
13079 def GetVGap(*args
, **kwargs
):
13081 GetVGap(self) -> int
13083 Returns the vertical gap (in pixels) between the cells in the sizer.
13085 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
13087 def GetHGap(*args
, **kwargs
):
13089 GetHGap(self) -> int
13091 Returns the horizontal gap (in pixels) between cells in the sizer.
13093 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
13095 def CalcRowsCols(self
):
13097 CalcRowsCols() -> (rows, cols)
13099 Calculates how many rows and columns will be in the sizer based
13100 on the current number of items and also the rows, cols specified
13101 in the constructor.
13103 nitems
= len(self
.GetChildren())
13104 rows
= self
.GetRows()
13105 cols
= self
.GetCols()
13106 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
13108 rows
= (nitems
+ cols
- 1) / cols
13110 cols
= (nitems
+ rows
- 1) / rows
13111 return (rows
, cols
)
13113 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
13114 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
13115 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
13116 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
13117 _core_
.GridSizer_swigregister(GridSizer
)
13119 #---------------------------------------------------------------------------
13121 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
13122 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
13123 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
13124 class FlexGridSizer(GridSizer
):
13126 A flex grid sizer is a sizer which lays out its children in a
13127 two-dimensional table with all table cells in one row having the same
13128 height and all cells in one column having the same width, but all
13129 rows or all columns are not necessarily the same height or width as in
13130 the `wx.GridSizer`.
13132 wx.FlexGridSizer can also size items equally in one direction but
13133 unequally ("flexibly") in the other. If the sizer is only flexible
13134 in one direction (this can be changed using `SetFlexibleDirection`), it
13135 needs to be decided how the sizer should grow in the other ("non
13136 flexible") direction in order to fill the available space. The
13137 `SetNonFlexibleGrowMode` method serves this purpose.
13141 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13142 __repr__
= _swig_repr
13143 def __init__(self
, *args
, **kwargs
):
13145 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
13147 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
13148 number of columns and rows in the sizer - if either of the parameters
13149 is zero, it will be calculated to from the total number of children in
13150 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
13151 define extra space between all children.
13153 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
13154 self
._setOORInfo
(self
)
13156 def AddGrowableRow(*args
, **kwargs
):
13158 AddGrowableRow(self, size_t idx, int proportion=0)
13160 Specifies that row *idx* (starting from zero) should be grown if there
13161 is extra space available to the sizer.
13163 The *proportion* parameter has the same meaning as the stretch factor
13164 for the box sizers except that if all proportions are 0, then all
13165 columns are resized equally (instead of not being resized at all).
13167 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
13169 def RemoveGrowableRow(*args
, **kwargs
):
13171 RemoveGrowableRow(self, size_t idx)
13173 Specifies that row *idx* is no longer growable.
13175 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
13177 def AddGrowableCol(*args
, **kwargs
):
13179 AddGrowableCol(self, size_t idx, int proportion=0)
13181 Specifies that column *idx* (starting from zero) should be grown if
13182 there is extra space available to the sizer.
13184 The *proportion* parameter has the same meaning as the stretch factor
13185 for the box sizers except that if all proportions are 0, then all
13186 columns are resized equally (instead of not being resized at all).
13188 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
13190 def RemoveGrowableCol(*args
, **kwargs
):
13192 RemoveGrowableCol(self, size_t idx)
13194 Specifies that column *idx* is no longer growable.
13196 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
13198 def SetFlexibleDirection(*args
, **kwargs
):
13200 SetFlexibleDirection(self, int direction)
13202 Specifies whether the sizer should flexibly resize its columns, rows,
13203 or both. Argument *direction* can be one of the following values. Any
13204 other value is ignored.
13206 ============== =======================================
13207 wx.VERTICAL Rows are flexibly sized.
13208 wx.HORIZONTAL Columns are flexibly sized.
13209 wx.BOTH Both rows and columns are flexibly sized
13210 (this is the default value).
13211 ============== =======================================
13213 Note that this method does not trigger relayout.
13216 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
13218 def GetFlexibleDirection(*args
, **kwargs
):
13220 GetFlexibleDirection(self) -> int
13222 Returns a value that specifies whether the sizer
13223 flexibly resizes its columns, rows, or both (default).
13225 :see: `SetFlexibleDirection`
13227 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
13229 def SetNonFlexibleGrowMode(*args
, **kwargs
):
13231 SetNonFlexibleGrowMode(self, int mode)
13233 Specifies how the sizer should grow in the non-flexible direction if
13234 there is one (so `SetFlexibleDirection` must have been called
13235 previously). Argument *mode* can be one of the following values:
13237 ========================== =================================================
13238 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
13239 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
13240 `AddGrowableCol` and `AddGrowableRow`. In this
13241 case equal sizing applies to minimum sizes of
13242 columns or rows (this is the default value).
13243 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
13244 the non flexible direction, whether they are
13245 growable or not in the flexbile direction.
13246 ========================== =================================================
13248 Note that this method does not trigger relayout.
13250 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
13252 def GetNonFlexibleGrowMode(*args
, **kwargs
):
13254 GetNonFlexibleGrowMode(self) -> int
13256 Returns the value that specifies how the sizer grows in the
13257 non-flexible direction if there is one.
13259 :see: `SetNonFlexibleGrowMode`
13261 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
13263 def GetRowHeights(*args
, **kwargs
):
13265 GetRowHeights(self) -> list
13267 Returns a list of integers representing the heights of each of the
13270 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
13272 def GetColWidths(*args
, **kwargs
):
13274 GetColWidths(self) -> list
13276 Returns a list of integers representing the widths of each of the
13277 columns in the sizer.
13279 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
13281 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
13282 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
13283 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
13284 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
13285 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
13287 class StdDialogButtonSizer(BoxSizer
):
13289 A special sizer that knows how to order and position standard buttons
13290 in order to conform to the current platform's standards. You simply
13291 need to add each `wx.Button` to the sizer, and be sure to create the
13292 buttons using the standard ID's. Then call `Realize` and the sizer
13293 will take care of the rest.
13296 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13297 __repr__
= _swig_repr
13298 def __init__(self
, *args
, **kwargs
):
13299 """__init__(self) -> StdDialogButtonSizer"""
13300 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
13301 def AddButton(*args
, **kwargs
):
13303 AddButton(self, wxButton button)
13305 Use this to add the buttons to this sizer. Do not use the `Add`
13306 method in the base class.
13308 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
13310 def Realize(*args
, **kwargs
):
13314 This funciton needs to be called after all the buttons have been added
13315 to the sizer. It will reorder them and position them in a platform
13318 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
13320 def SetAffirmativeButton(*args
, **kwargs
):
13321 """SetAffirmativeButton(self, wxButton button)"""
13322 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
13324 def SetNegativeButton(*args
, **kwargs
):
13325 """SetNegativeButton(self, wxButton button)"""
13326 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
13328 def SetCancelButton(*args
, **kwargs
):
13329 """SetCancelButton(self, wxButton button)"""
13330 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
13332 def GetAffirmativeButton(*args
, **kwargs
):
13333 """GetAffirmativeButton(self) -> wxButton"""
13334 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
13336 def GetApplyButton(*args
, **kwargs
):
13337 """GetApplyButton(self) -> wxButton"""
13338 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
13340 def GetNegativeButton(*args
, **kwargs
):
13341 """GetNegativeButton(self) -> wxButton"""
13342 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
13344 def GetCancelButton(*args
, **kwargs
):
13345 """GetCancelButton(self) -> wxButton"""
13346 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
13348 def GetHelpButton(*args
, **kwargs
):
13349 """GetHelpButton(self) -> wxButton"""
13350 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
13352 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
13353 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
13354 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
13355 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
13356 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
13357 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
13359 #---------------------------------------------------------------------------
13361 class GBPosition(object):
13363 This class represents the position of an item in a virtual grid of
13364 rows and columns managed by a `wx.GridBagSizer`. wxPython has
13365 typemaps that will automatically convert from a 2-element sequence of
13366 integers to a wx.GBPosition, so you can use the more pythonic
13367 representation of the position nearly transparently in Python code.
13369 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13370 __repr__
= _swig_repr
13371 def __init__(self
, *args
, **kwargs
):
13373 __init__(self, int row=0, int col=0) -> GBPosition
13375 This class represents the position of an item in a virtual grid of
13376 rows and columns managed by a `wx.GridBagSizer`. wxPython has
13377 typemaps that will automatically convert from a 2-element sequence of
13378 integers to a wx.GBPosition, so you can use the more pythonic
13379 representation of the position nearly transparently in Python code.
13381 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
13382 __swig_destroy__
= _core_
.delete_GBPosition
13383 __del__
= lambda self
: None;
13384 def GetRow(*args
, **kwargs
):
13385 """GetRow(self) -> int"""
13386 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
13388 def GetCol(*args
, **kwargs
):
13389 """GetCol(self) -> int"""
13390 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
13392 def SetRow(*args
, **kwargs
):
13393 """SetRow(self, int row)"""
13394 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
13396 def SetCol(*args
, **kwargs
):
13397 """SetCol(self, int col)"""
13398 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
13400 def __eq__(*args
, **kwargs
):
13402 __eq__(self, PyObject other) -> bool
13404 Compare GBPosition for equality.
13406 return _core_
.GBPosition___eq__(*args
, **kwargs
)
13408 def __ne__(*args
, **kwargs
):
13410 __ne__(self, PyObject other) -> bool
13412 Compare GBPosition for inequality.
13414 return _core_
.GBPosition___ne__(*args
, **kwargs
)
13416 def Set(*args
, **kwargs
):
13417 """Set(self, int row=0, int col=0)"""
13418 return _core_
.GBPosition_Set(*args
, **kwargs
)
13420 def Get(*args
, **kwargs
):
13421 """Get(self) -> PyObject"""
13422 return _core_
.GBPosition_Get(*args
, **kwargs
)
13424 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13425 def __str__(self
): return str(self
.Get())
13426 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
13427 def __len__(self
): return len(self
.Get())
13428 def __getitem__(self
, index
): return self
.Get()[index
]
13429 def __setitem__(self
, index
, val
):
13430 if index
== 0: self
.SetRow(val
)
13431 elif index
== 1: self
.SetCol(val
)
13432 else: raise IndexError
13433 def __nonzero__(self
): return self
.Get() != (0,0)
13434 __safe_for_unpickling__
= True
13435 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
13437 row
= property(GetRow
, SetRow
)
13438 col
= property(GetCol
, SetCol
)
13440 _core_
.GBPosition_swigregister(GBPosition
)
13442 class GBSpan(object):
13444 This class is used to hold the row and column spanning attributes of
13445 items in a `wx.GridBagSizer`. wxPython has typemaps that will
13446 automatically convert from a 2-element sequence of integers to a
13447 wx.GBSpan, so you can use the more pythonic representation of the span
13448 nearly transparently in Python code.
13451 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13452 __repr__
= _swig_repr
13453 def __init__(self
, *args
, **kwargs
):
13455 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
13457 Construct a new wxGBSpan, optionally setting the rowspan and
13458 colspan. The default is (1,1). (Meaning that the item occupies one
13459 cell in each direction.
13461 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
13462 __swig_destroy__
= _core_
.delete_GBSpan
13463 __del__
= lambda self
: None;
13464 def GetRowspan(*args
, **kwargs
):
13465 """GetRowspan(self) -> int"""
13466 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
13468 def GetColspan(*args
, **kwargs
):
13469 """GetColspan(self) -> int"""
13470 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
13472 def SetRowspan(*args
, **kwargs
):
13473 """SetRowspan(self, int rowspan)"""
13474 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
13476 def SetColspan(*args
, **kwargs
):
13477 """SetColspan(self, int colspan)"""
13478 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
13480 def __eq__(*args
, **kwargs
):
13482 __eq__(self, PyObject other) -> bool
13484 Compare wxGBSpan for equality.
13486 return _core_
.GBSpan___eq__(*args
, **kwargs
)
13488 def __ne__(*args
, **kwargs
):
13490 __ne__(self, PyObject other) -> bool
13492 Compare GBSpan for inequality.
13494 return _core_
.GBSpan___ne__(*args
, **kwargs
)
13496 def Set(*args
, **kwargs
):
13497 """Set(self, int rowspan=1, int colspan=1)"""
13498 return _core_
.GBSpan_Set(*args
, **kwargs
)
13500 def Get(*args
, **kwargs
):
13501 """Get(self) -> PyObject"""
13502 return _core_
.GBSpan_Get(*args
, **kwargs
)
13504 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13505 def __str__(self
): return str(self
.Get())
13506 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
13507 def __len__(self
): return len(self
.Get())
13508 def __getitem__(self
, index
): return self
.Get()[index
]
13509 def __setitem__(self
, index
, val
):
13510 if index
== 0: self
.SetRowspan(val
)
13511 elif index
== 1: self
.SetColspan(val
)
13512 else: raise IndexError
13513 def __nonzero__(self
): return self
.Get() != (0,0)
13514 __safe_for_unpickling__
= True
13515 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
13517 rowspan
= property(GetRowspan
, SetRowspan
)
13518 colspan
= property(GetColspan
, SetColspan
)
13520 _core_
.GBSpan_swigregister(GBSpan
)
13522 class GBSizerItem(SizerItem
):
13524 The wx.GBSizerItem class is used to track the additional data about
13525 items in a `wx.GridBagSizer` such as the item's position in the grid
13526 and how many rows or columns it spans.
13529 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13530 __repr__
= _swig_repr
13531 def __init__(self
, *args
, **kwargs
):
13533 __init__(self) -> GBSizerItem
13535 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13536 size will need to be set, as well as a position and span before this
13537 item can be used in a Sizer.
13539 You will probably never need to create a wx.GBSizerItem directly as they
13540 are created automatically when the sizer's Add method is called.
13542 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
13543 __swig_destroy__
= _core_
.delete_GBSizerItem
13544 __del__
= lambda self
: None;
13545 def GetPos(*args
, **kwargs
):
13547 GetPos(self) -> GBPosition
13549 Get the grid position of the item
13551 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
13553 def GetPosTuple(self
): return self
.GetPos().Get()
13554 def GetSpan(*args
, **kwargs
):
13556 GetSpan(self) -> GBSpan
13558 Get the row and column spanning of the item
13560 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
13562 def GetSpanTuple(self
): return self
.GetSpan().Get()
13563 def SetPos(*args
, **kwargs
):
13565 SetPos(self, GBPosition pos) -> bool
13567 If the item is already a member of a sizer then first ensure that
13568 there is no other item that would intersect with this one at the new
13569 position, then set the new position. Returns True if the change is
13570 successful and after the next Layout() the item will be moved.
13572 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
13574 def SetSpan(*args
, **kwargs
):
13576 SetSpan(self, GBSpan span) -> bool
13578 If the item is already a member of a sizer then first ensure that
13579 there is no other item that would intersect with this one with its new
13580 spanning size, then set the new spanning. Returns True if the change
13581 is successful and after the next Layout() the item will be resized.
13584 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
13586 def Intersects(*args
, **kwargs
):
13588 Intersects(self, GBSizerItem other) -> bool
13590 Returns True if this item and the other item instersect.
13592 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
13594 def IntersectsPos(*args
, **kwargs
):
13596 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13598 Returns True if the given pos/span would intersect with this item.
13600 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
13602 def GetEndPos(*args
, **kwargs
):
13604 GetEndPos(self) -> GBPosition
13606 Get the row and column of the endpoint of this item.
13608 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
13610 def GetGBSizer(*args
, **kwargs
):
13612 GetGBSizer(self) -> GridBagSizer
13614 Get the sizer this item is a member of.
13616 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
13618 def SetGBSizer(*args
, **kwargs
):
13620 SetGBSizer(self, GridBagSizer sizer)
13622 Set the sizer this item is a member of.
13624 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
13626 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
13627 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
13628 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
13629 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
13630 _core_
.GBSizerItem_swigregister(GBSizerItem
)
13631 DefaultSpan
= cvar
.DefaultSpan
13633 def GBSizerItemWindow(*args
, **kwargs
):
13635 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13636 int border, PyObject userData=None) -> GBSizerItem
13638 Construct a `wx.GBSizerItem` for a window.
13640 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
13643 def GBSizerItemSizer(*args
, **kwargs
):
13645 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13646 int border, PyObject userData=None) -> GBSizerItem
13648 Construct a `wx.GBSizerItem` for a sizer
13650 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
13653 def GBSizerItemSpacer(*args
, **kwargs
):
13655 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13656 int flag, int border, PyObject userData=None) -> GBSizerItem
13658 Construct a `wx.GBSizerItem` for a spacer.
13660 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
13663 class GridBagSizer(FlexGridSizer
):
13665 A `wx.Sizer` that can lay out items in a virtual grid like a
13666 `wx.FlexGridSizer` but in this case explicit positioning of the items
13667 is allowed using `wx.GBPosition`, and items can optionally span more
13668 than one row and/or column using `wx.GBSpan`. The total size of the
13669 virtual grid is determined by the largest row and column that items are
13670 positioned at, adjusted for spanning.
13673 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13674 __repr__
= _swig_repr
13675 def __init__(self
, *args
, **kwargs
):
13677 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13679 Constructor, with optional parameters to specify the gap between the
13682 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
13683 self
._setOORInfo
(self
)
13685 def Add(*args
, **kwargs
):
13687 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13688 int border=0, userData=None) -> wx.GBSizerItem
13690 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13691 more than one row or column as specified with *span*. The remaining
13692 args behave similarly to `wx.Sizer.Add`.
13694 Returns True if the item was successfully placed at the given cell
13695 position, False if something was already there.
13698 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13700 def AddItem(*args
, **kwargs
):
13702 Add(self, GBSizerItem item) -> wx.GBSizerItem
13704 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13705 the item was successfully placed at its given cell position, False if
13706 something was already there.
13708 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13710 def GetCellSize(*args
, **kwargs
):
13712 GetCellSize(self, int row, int col) -> Size
13714 Get the size of the specified cell, including hgap and
13715 vgap. Only valid after a Layout.
13717 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13719 def GetEmptyCellSize(*args
, **kwargs
):
13721 GetEmptyCellSize(self) -> Size
13723 Get the size used for cells in the grid with no item.
13725 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13727 def SetEmptyCellSize(*args
, **kwargs
):
13729 SetEmptyCellSize(self, Size sz)
13731 Set the size used for cells in the grid with no item.
13733 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13735 def GetItemPosition(*args
):
13737 GetItemPosition(self, item) -> GBPosition
13739 Get the grid position of the specified *item* where *item* is either a
13740 window or subsizer that is a member of this sizer, or a zero-based
13743 return _core_
.GridBagSizer_GetItemPosition(*args
)
13745 def SetItemPosition(*args
):
13747 SetItemPosition(self, item, GBPosition pos) -> bool
13749 Set the grid position of the specified *item* where *item* is either a
13750 window or subsizer that is a member of this sizer, or a zero-based
13751 index of an item. Returns True on success. If the move is not
13752 allowed (because an item is already there) then False is returned.
13755 return _core_
.GridBagSizer_SetItemPosition(*args
)
13757 def GetItemSpan(*args
):
13759 GetItemSpan(self, item) -> GBSpan
13761 Get the row/col spanning of the specified *item* where *item* is
13762 either a window or subsizer that is a member of this sizer, or a
13763 zero-based index of an item.
13765 return _core_
.GridBagSizer_GetItemSpan(*args
)
13767 def SetItemSpan(*args
):
13769 SetItemSpan(self, item, GBSpan span) -> bool
13771 Set the row/col spanning of the specified *item* where *item* is
13772 either a window or subsizer that is a member of this sizer, or a
13773 zero-based index of an item. Returns True on success. If the move is
13774 not allowed (because an item is already there) then False is returned.
13776 return _core_
.GridBagSizer_SetItemSpan(*args
)
13778 def FindItem(*args
):
13780 FindItem(self, item) -> GBSizerItem
13782 Find the sizer item for the given window or subsizer, returns None if
13783 not found. (non-recursive)
13785 return _core_
.GridBagSizer_FindItem(*args
)
13787 def GetItem(self
, item
):
13789 si
= wx
.FlexGridSizer
.GetItem(self
, item
)
13792 if type(item
) is not int:
13793 gbsi
= self
.FindItem(item
)
13794 if gbsi
: return gbsi
13797 def FindItemAtPosition(*args
, **kwargs
):
13799 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13801 Return the sizer item for the given grid cell, or None if there is no
13802 item at that position. (non-recursive)
13804 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13806 def FindItemAtPoint(*args
, **kwargs
):
13808 FindItemAtPoint(self, Point pt) -> GBSizerItem
13810 Return the sizer item located at the point given in *pt*, or None if
13811 there is no item at that point. The (x,y) coordinates in pt correspond
13812 to the client coordinates of the window using the sizer for
13813 layout. (non-recursive)
13815 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13817 def CheckForIntersection(*args
, **kwargs
):
13819 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13821 Look at all items and see if any intersect (or would overlap) the
13822 given *item*. Returns True if so, False if there would be no overlap.
13823 If an *excludeItem* is given then it will not be checked for
13824 intersection, for example it may be the item we are checking the
13828 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13830 def CheckForIntersectionPos(*args
, **kwargs
):
13832 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13834 Look at all items and see if any intersect (or would overlap) the
13835 given position and span. Returns True if so, False if there would be
13836 no overlap. If an *excludeItem* is given then it will not be checked
13837 for intersection, for example it may be the item we are checking the
13840 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13842 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13844 #---------------------------------------------------------------------------
13848 Right
= _core_
.Right
13849 Bottom
= _core_
.Bottom
13850 Width
= _core_
.Width
13851 Height
= _core_
.Height
13852 Centre
= _core_
.Centre
13853 Center
= _core_
.Center
13854 CentreX
= _core_
.CentreX
13855 CentreY
= _core_
.CentreY
13856 Unconstrained
= _core_
.Unconstrained
13858 PercentOf
= _core_
.PercentOf
13859 Above
= _core_
.Above
13860 Below
= _core_
.Below
13861 LeftOf
= _core_
.LeftOf
13862 RightOf
= _core_
.RightOf
13863 SameAs
= _core_
.SameAs
13864 Absolute
= _core_
.Absolute
13865 class IndividualLayoutConstraint(Object
):
13867 Objects of this class are stored in the `wx.LayoutConstraints` class as
13868 one of eight possible constraints that a window can be involved in.
13869 You will never need to create an instance of
13870 wx.IndividualLayoutConstraint, rather you should create a
13871 `wx.LayoutConstraints` instance and use the individual contstraints
13874 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13875 def __init__(self
): raise AttributeError, "No constructor defined"
13876 __repr__
= _swig_repr
13877 def Set(*args
, **kwargs
):
13879 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13881 Sets the properties of the constraint. Normally called by one of the
13882 convenience functions such as Above, RightOf, SameAs.
13884 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13886 def LeftOf(*args
, **kwargs
):
13888 LeftOf(self, Window sibling, int marg=0)
13890 Constrains this edge to be to the left of the given window, with an
13891 optional margin. Implicitly, this is relative to the left edge of the
13894 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13896 def RightOf(*args
, **kwargs
):
13898 RightOf(self, Window sibling, int marg=0)
13900 Constrains this edge to be to the right of the given window, with an
13901 optional margin. Implicitly, this is relative to the right edge of the
13904 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13906 def Above(*args
, **kwargs
):
13908 Above(self, Window sibling, int marg=0)
13910 Constrains this edge to be above the given window, with an optional
13911 margin. Implicitly, this is relative to the top edge of the other
13914 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13916 def Below(*args
, **kwargs
):
13918 Below(self, Window sibling, int marg=0)
13920 Constrains this edge to be below the given window, with an optional
13921 margin. Implicitly, this is relative to the bottom edge of the other
13924 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13926 def SameAs(*args
, **kwargs
):
13928 SameAs(self, Window otherW, int edge, int marg=0)
13930 Constrains this edge or dimension to be to the same as the edge of the
13931 given window, with an optional margin.
13933 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13935 def PercentOf(*args
, **kwargs
):
13937 PercentOf(self, Window otherW, int wh, int per)
13939 Constrains this edge or dimension to be to a percentage of the given
13940 window, with an optional margin.
13942 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13944 def Absolute(*args
, **kwargs
):
13946 Absolute(self, int val)
13948 Constrains this edge or dimension to be the given absolute value.
13950 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13952 def Unconstrained(*args
, **kwargs
):
13954 Unconstrained(self)
13956 Sets this edge or dimension to be unconstrained, that is, dependent on
13957 other edges and dimensions from which this value can be deduced.
13959 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13961 def AsIs(*args
, **kwargs
):
13965 Sets this edge or constraint to be whatever the window's value is at
13966 the moment. If either of the width and height constraints are *as is*,
13967 the window will not be resized, but moved instead. This is important
13968 when considering panel items which are intended to have a default
13969 size, such as a button, which may take its size from the size of the
13972 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13974 def GetOtherWindow(*args
, **kwargs
):
13975 """GetOtherWindow(self) -> Window"""
13976 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13978 def GetMyEdge(*args
, **kwargs
):
13979 """GetMyEdge(self) -> int"""
13980 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13982 def SetEdge(*args
, **kwargs
):
13983 """SetEdge(self, int which)"""
13984 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13986 def SetValue(*args
, **kwargs
):
13987 """SetValue(self, int v)"""
13988 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13990 def GetMargin(*args
, **kwargs
):
13991 """GetMargin(self) -> int"""
13992 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13994 def SetMargin(*args
, **kwargs
):
13995 """SetMargin(self, int m)"""
13996 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13998 def GetValue(*args
, **kwargs
):
13999 """GetValue(self) -> int"""
14000 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
14002 def GetPercent(*args
, **kwargs
):
14003 """GetPercent(self) -> int"""
14004 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
14006 def GetOtherEdge(*args
, **kwargs
):
14007 """GetOtherEdge(self) -> int"""
14008 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
14010 def GetDone(*args
, **kwargs
):
14011 """GetDone(self) -> bool"""
14012 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
14014 def SetDone(*args
, **kwargs
):
14015 """SetDone(self, bool d)"""
14016 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
14018 def GetRelationship(*args
, **kwargs
):
14019 """GetRelationship(self) -> int"""
14020 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
14022 def SetRelationship(*args
, **kwargs
):
14023 """SetRelationship(self, int r)"""
14024 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
14026 def ResetIfWin(*args
, **kwargs
):
14028 ResetIfWin(self, Window otherW) -> bool
14030 Reset constraint if it mentions otherWin
14032 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
14034 def SatisfyConstraint(*args
, **kwargs
):
14036 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
14038 Try to satisfy constraint
14040 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
14042 def GetEdge(*args
, **kwargs
):
14044 GetEdge(self, int which, Window thisWin, Window other) -> int
14046 Get the value of this edge or dimension, or if this
14047 is not determinable, -1.
14049 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
14051 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
14052 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
14053 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
14054 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
14055 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
14056 Percent
= property(GetPercent
,doc
="See `GetPercent`")
14057 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
14058 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
14059 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
14061 class LayoutConstraints(Object
):
14063 **Note:** constraints are now deprecated and you should use sizers
14066 Objects of this class can be associated with a window to define its
14067 layout constraints, with respect to siblings or its parent.
14069 The class consists of the following eight constraints of class
14070 wx.IndividualLayoutConstraint, some or all of which should be accessed
14071 directly to set the appropriate constraints.
14073 * left: represents the left hand edge of the window
14074 * right: represents the right hand edge of the window
14075 * top: represents the top edge of the window
14076 * bottom: represents the bottom edge of the window
14077 * width: represents the width of the window
14078 * height: represents the height of the window
14079 * centreX: represents the horizontal centre point of the window
14080 * centreY: represents the vertical centre point of the window
14082 Most constraints are initially set to have the relationship
14083 wxUnconstrained, which means that their values should be calculated by
14084 looking at known constraints. The exceptions are width and height,
14085 which are set to wxAsIs to ensure that if the user does not specify a
14086 constraint, the existing width and height will be used, to be
14087 compatible with panel items which often have take a default size. If
14088 the constraint is ``wx.AsIs``, the dimension will not be changed.
14090 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
14093 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
14094 __repr__
= _swig_repr
14095 left
= property(_core_
.LayoutConstraints_left_get
)
14096 top
= property(_core_
.LayoutConstraints_top_get
)
14097 right
= property(_core_
.LayoutConstraints_right_get
)
14098 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
14099 width
= property(_core_
.LayoutConstraints_width_get
)
14100 height
= property(_core_
.LayoutConstraints_height_get
)
14101 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
14102 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
14103 def __init__(self
, *args
, **kwargs
):
14104 """__init__(self) -> LayoutConstraints"""
14105 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
14106 __swig_destroy__
= _core_
.delete_LayoutConstraints
14107 __del__
= lambda self
: None;
14108 def SatisfyConstraints(*args
, **kwargs
):
14109 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
14110 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
14112 def AreSatisfied(*args
, **kwargs
):
14113 """AreSatisfied(self) -> bool"""
14114 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
14116 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
14118 #----------------------------------------------------------------------------
14120 # Use Python's bool constants if available, make some if not
14124 __builtins__
.True = 1==1
14125 __builtins__
.False = 1==0
14126 def bool(value
): return not not value
14127 __builtins__
.bool = bool
14131 # workarounds for bad wxRTTI names
14132 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
14133 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
14134 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
14137 #----------------------------------------------------------------------------
14138 # Load version numbers from __version__... Ensure that major and minor
14139 # versions are the same for both wxPython and wxWidgets.
14141 from __version__
import *
14142 __version__
= VERSION_STRING
14144 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
14145 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
14146 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
14148 warnings
.warn("wxPython/wxWidgets release number mismatch")
14152 """Returns a string containing version and port info"""
14153 ctype
= wx
.USE_UNICODE
and 'unicode' or 'ansi'
14154 if wx
.Platform
== '__WXMSW__':
14156 elif wx
.Platform
== '__WXMAC__':
14158 elif wx
.Platform
== '__WXGTK__':
14160 if 'gtk2' in wx
.PlatformInfo
:
14165 return "%s (%s-%s)" % (wx
.VERSION_STRING
, port
, ctype
)
14168 #----------------------------------------------------------------------------
14170 # Set wxPython's default string<-->unicode conversion encoding from
14171 # the locale, but only if Python's default hasn't been changed. (We
14172 # assume that if the user has customized it already then that is the
14173 # encoding we need to use as well.)
14175 # The encoding selected here is used when string or unicode objects
14176 # need to be converted in order to pass them to wxWidgets. Please be
14177 # aware that the default encoding within the same locale may be
14178 # slightly different on different platforms. For example, please see
14179 # http://www.alanwood.net/demos/charsetdiffs.html for differences
14180 # between the common latin/roman encodings.
14182 default
= _sys
.getdefaultencoding()
14183 if default
== 'ascii':
14187 if hasattr(locale
, 'getpreferredencoding'):
14188 default
= locale
.getpreferredencoding()
14190 default
= locale
.getdefaultlocale()[1]
14191 codecs
.lookup(default
)
14192 except (ValueError, LookupError, TypeError):
14193 default
= _sys
.getdefaultencoding()
14197 wx
.SetDefaultPyEncoding(default
)
14200 #----------------------------------------------------------------------------
14202 class PyDeadObjectError(AttributeError):
14205 class _wxPyDeadObject(object):
14207 Instances of wx objects that are OOR capable will have their __class__
14208 changed to this class when the C++ object is deleted. This should help
14209 prevent crashes due to referencing a bogus C++ pointer.
14211 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
14212 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
14214 def __repr__(self
):
14215 if not hasattr(self
, "_name"):
14216 self
._name
= "[unknown]"
14217 return self
.reprStr
% self
._name
14219 def __getattr__(self
, *args
):
14220 if not hasattr(self
, "_name"):
14221 self
._name
= "[unknown]"
14222 raise PyDeadObjectError(self
.attrStr
% self
._name
)
14224 def __nonzero__(self
):
14229 class PyUnbornObjectError(AttributeError):
14232 class _wxPyUnbornObject(object):
14234 Some stock objects are created when the wx._core module is
14235 imported, but their C++ instance is not created until the wx.App
14236 object is created and initialized. These object instances will
14237 temporarily have their __class__ changed to this class so an
14238 exception will be raised if they are used before the C++ instance
14242 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
14243 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
14245 def __repr__(self
):
14246 #if not hasattr(self, "_name"):
14247 # self._name = "[unknown]"
14248 return self
.reprStr
#% self._name
14250 def __getattr__(self
, *args
):
14251 #if not hasattr(self, "_name"):
14252 # self._name = "[unknown]"
14253 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
14255 def __nonzero__(self
):
14259 #----------------------------------------------------------------------------
14261 def CallAfter(callable, *args
, **kw
):
14263 Call the specified function after the current and pending event
14264 handlers have been completed. This is also good for making GUI
14265 method calls from non-GUI threads. Any extra positional or
14266 keyword args are passed on to the callable when it is called.
14268 :see: `wx.CallLater`
14271 assert app
is not None, 'No wx.App created yet'
14273 if not hasattr(app
, "_CallAfterId"):
14274 app
._CallAfterId
= wx
.NewEventType()
14275 app
.Connect(-1, -1, app
._CallAfterId
,
14276 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
14278 evt
.SetEventType(app
._CallAfterId
)
14279 evt
.callable = callable
14282 wx
.PostEvent(app
, evt
)
14284 #----------------------------------------------------------------------------
14289 A convenience class for `wx.Timer`, that calls the given callable
14290 object once after the given amount of milliseconds, passing any
14291 positional or keyword args. The return value of the callable is
14292 availbale after it has been run with the `GetResult` method.
14294 If you don't need to get the return value or restart the timer
14295 then there is no need to hold a reference to this object. It will
14296 hold a reference to itself while the timer is running (the timer
14297 has a reference to self.Notify) but the cycle will be broken when
14298 the timer completes, automatically cleaning up the wx.CallLater
14301 :see: `wx.CallAfter`
14303 def __init__(self
, millis
, callable, *args
, **kwargs
):
14304 self
.millis
= millis
14305 self
.callable = callable
14306 self
.SetArgs(*args
, **kwargs
)
14308 self
.running
= False
14309 self
.hasRun
= False
14318 def Start(self
, millis
=None, *args
, **kwargs
):
14320 (Re)start the timer
14322 self
.hasRun
= False
14323 if millis
is not None:
14324 self
.millis
= millis
14326 self
.SetArgs(*args
, **kwargs
)
14328 self
.timer
= wx
.PyTimer(self
.Notify
)
14329 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
14330 self
.running
= True
14336 Stop and destroy the timer.
14338 if self
.timer
is not None:
14343 def GetInterval(self
):
14344 if self
.timer
is not None:
14345 return self
.timer
.GetInterval()
14350 def IsRunning(self
):
14351 return self
.timer
is not None and self
.timer
.IsRunning()
14354 def SetArgs(self
, *args
, **kwargs
):
14356 (Re)set the args passed to the callable object. This is
14357 useful in conjunction with Restart if you want to schedule a
14358 new call to the same callable object but with different
14362 self
.kwargs
= kwargs
14368 def GetResult(self
):
14373 The timer has expired so call the callable.
14375 if self
.callable and getattr(self
.callable, 'im_self', True):
14377 self
.running
= False
14378 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
14380 if not self
.running
:
14381 # if it wasn't restarted, then cleanup
14382 wx
.CallAfter(self
.Stop
)
14384 Interval
= property(GetInterval
)
14385 Result
= property(GetResult
)
14388 class FutureCall(CallLater
):
14389 """A compatibility alias for `CallLater`."""
14391 #----------------------------------------------------------------------------
14392 # Control which items in this module should be documented by epydoc.
14393 # We allow only classes and functions, which will help reduce the size
14394 # of the docs by filtering out the zillions of constants, EVT objects,
14395 # and etc that don't make much sense by themselves, but are instead
14396 # documented (or will be) as part of the classes/functions/methods
14397 # where they should be used.
14401 A filter for epydoc that only allows non-Ptr classes and
14402 functions, in order to reduce the clutter in the API docs.
14404 def __init__(self
, globals):
14405 self
._globals
= globals
14407 def __call__(self
, name
):
14409 obj
= self
._globals
.get(name
, None)
14411 # only document classes and function
14412 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
14415 # skip other things that are private or will be documented as part of somethign else
14416 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
14419 # skip functions that are duplicates of static functions in a class
14420 if name
.find('_') != -1:
14421 cls
= self
._globals
.get(name
.split('_')[0], None)
14422 methname
= name
.split('_')[1]
14423 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
14428 #----------------------------------------------------------------------------
14429 #----------------------------------------------------------------------------
14431 # Import other modules in this package that should show up in the
14432 # "core" wx namespace
14434 from _windows
import *
14435 from _controls
import *
14436 from _misc
import *
14438 #----------------------------------------------------------------------------
14439 #----------------------------------------------------------------------------