1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
6 new_instancemethod
= new
.instancemethod
7 def _swig_setattr_nondynamic(self
,class_type
,name
,value
,static
=1):
8 if (name
== "thisown"): return self
.this
.own(value
)
10 if type(value
).__name
__ == 'PySwigObject':
11 self
.__dict
__[name
] = value
13 method
= class_type
.__swig
_setmethods
__.get(name
,None)
14 if method
: return method(self
,value
)
15 if (not static
) or hasattr(self
,name
):
16 self
.__dict
__[name
] = value
18 raise AttributeError("You cannot add attributes to %s" % self
)
20 def _swig_setattr(self
,class_type
,name
,value
):
21 return _swig_setattr_nondynamic(self
,class_type
,name
,value
,0)
23 def _swig_getattr(self
,class_type
,name
):
24 if (name
== "thisown"): return self
.this
.own()
25 method
= class_type
.__swig
_getmethods
__.get(name
,None)
26 if method
: return method(self
)
27 raise AttributeError,name
30 try: strthis
= "proxy of " + self
.this
.__repr
__()
32 return "<%s.%s; %s >" % (self
.__class
__.__module
__, self
.__class
__.__name
__, strthis
,)
36 _object
= types
.ObjectType
38 except AttributeError:
44 def _swig_setattr_nondynamic_method(set):
45 def set_attr(self
,name
,value
):
46 if (name
== "thisown"): return self
.this
.own(value
)
47 if hasattr(self
,name
) or (name
== "this"):
50 raise AttributeError("You cannot add attributes to %s" % self
)
54 #// Give a reference to the dictionary of this module to the C++ extension
56 _core_
._wxPySetDictionary
(vars())
58 #// A little trick to make 'wx' be a reference to this module so wx.Names can
61 wx
= _sys
.modules
[__name__
]
64 #----------------------------------------------------------------------------
66 def _deprecated(callable, msg
=None):
68 Create a wrapper function that will raise a DeprecationWarning
69 before calling the callable.
72 msg
= "%s is deprecated" % callable
73 def deprecatedWrapper(*args
, **kwargs
):
75 warnings
.warn(msg
, DeprecationWarning, stacklevel
=2)
76 return callable(*args
, **kwargs
)
77 deprecatedWrapper
.__doc
__ = msg
78 return deprecatedWrapper
81 #----------------------------------------------------------------------------
83 NOT_FOUND
= _core_
.NOT_FOUND
84 VSCROLL
= _core_
.VSCROLL
85 HSCROLL
= _core_
.HSCROLL
86 CAPTION
= _core_
.CAPTION
87 DOUBLE_BORDER
= _core_
.DOUBLE_BORDER
88 SUNKEN_BORDER
= _core_
.SUNKEN_BORDER
89 RAISED_BORDER
= _core_
.RAISED_BORDER
90 BORDER
= _core_
.BORDER
91 SIMPLE_BORDER
= _core_
.SIMPLE_BORDER
92 STATIC_BORDER
= _core_
.STATIC_BORDER
93 TRANSPARENT_WINDOW
= _core_
.TRANSPARENT_WINDOW
94 NO_BORDER
= _core_
.NO_BORDER
95 DEFAULT_CONTROL_BORDER
= _core_
.DEFAULT_CONTROL_BORDER
96 DEFAULT_STATUSBAR_STYLE
= _core_
.DEFAULT_STATUSBAR_STYLE
97 TAB_TRAVERSAL
= _core_
.TAB_TRAVERSAL
98 WANTS_CHARS
= _core_
.WANTS_CHARS
99 POPUP_WINDOW
= _core_
.POPUP_WINDOW
100 CENTER_FRAME
= _core_
.CENTER_FRAME
101 CENTRE_ON_SCREEN
= _core_
.CENTRE_ON_SCREEN
102 CENTER_ON_SCREEN
= _core_
.CENTER_ON_SCREEN
103 CLIP_CHILDREN
= _core_
.CLIP_CHILDREN
104 CLIP_SIBLINGS
= _core_
.CLIP_SIBLINGS
105 WINDOW_STYLE_MASK
= _core_
.WINDOW_STYLE_MASK
106 ALWAYS_SHOW_SB
= _core_
.ALWAYS_SHOW_SB
107 RETAINED
= _core_
.RETAINED
108 BACKINGSTORE
= _core_
.BACKINGSTORE
109 COLOURED
= _core_
.COLOURED
110 FIXED_LENGTH
= _core_
.FIXED_LENGTH
111 LB_NEEDED_SB
= _core_
.LB_NEEDED_SB
112 LB_ALWAYS_SB
= _core_
.LB_ALWAYS_SB
113 LB_SORT
= _core_
.LB_SORT
114 LB_SINGLE
= _core_
.LB_SINGLE
115 LB_MULTIPLE
= _core_
.LB_MULTIPLE
116 LB_EXTENDED
= _core_
.LB_EXTENDED
117 LB_OWNERDRAW
= _core_
.LB_OWNERDRAW
118 LB_HSCROLL
= _core_
.LB_HSCROLL
119 PROCESS_ENTER
= _core_
.PROCESS_ENTER
120 PASSWORD
= _core_
.PASSWORD
121 CB_SIMPLE
= _core_
.CB_SIMPLE
122 CB_DROPDOWN
= _core_
.CB_DROPDOWN
123 CB_SORT
= _core_
.CB_SORT
124 CB_READONLY
= _core_
.CB_READONLY
125 RA_HORIZONTAL
= _core_
.RA_HORIZONTAL
126 RA_VERTICAL
= _core_
.RA_VERTICAL
127 RA_SPECIFY_ROWS
= _core_
.RA_SPECIFY_ROWS
128 RA_SPECIFY_COLS
= _core_
.RA_SPECIFY_COLS
129 RA_USE_CHECKBOX
= _core_
.RA_USE_CHECKBOX
130 RB_GROUP
= _core_
.RB_GROUP
131 RB_SINGLE
= _core_
.RB_SINGLE
132 SB_HORIZONTAL
= _core_
.SB_HORIZONTAL
133 SB_VERTICAL
= _core_
.SB_VERTICAL
134 RB_USE_CHECKBOX
= _core_
.RB_USE_CHECKBOX
135 ST_SIZEGRIP
= _core_
.ST_SIZEGRIP
136 ST_NO_AUTORESIZE
= _core_
.ST_NO_AUTORESIZE
137 ST_DOTS_MIDDLE
= _core_
.ST_DOTS_MIDDLE
138 ST_DOTS_END
= _core_
.ST_DOTS_END
139 FLOOD_SURFACE
= _core_
.FLOOD_SURFACE
140 FLOOD_BORDER
= _core_
.FLOOD_BORDER
141 ODDEVEN_RULE
= _core_
.ODDEVEN_RULE
142 WINDING_RULE
= _core_
.WINDING_RULE
143 TOOL_TOP
= _core_
.TOOL_TOP
144 TOOL_BOTTOM
= _core_
.TOOL_BOTTOM
145 TOOL_LEFT
= _core_
.TOOL_LEFT
146 TOOL_RIGHT
= _core_
.TOOL_RIGHT
148 YES_NO
= _core_
.YES_NO
149 CANCEL
= _core_
.CANCEL
152 NO_DEFAULT
= _core_
.NO_DEFAULT
153 YES_DEFAULT
= _core_
.YES_DEFAULT
154 ICON_EXCLAMATION
= _core_
.ICON_EXCLAMATION
155 ICON_HAND
= _core_
.ICON_HAND
156 ICON_QUESTION
= _core_
.ICON_QUESTION
157 ICON_INFORMATION
= _core_
.ICON_INFORMATION
158 ICON_STOP
= _core_
.ICON_STOP
159 ICON_ASTERISK
= _core_
.ICON_ASTERISK
160 ICON_MASK
= _core_
.ICON_MASK
161 ICON_WARNING
= _core_
.ICON_WARNING
162 ICON_ERROR
= _core_
.ICON_ERROR
163 FORWARD
= _core_
.FORWARD
164 BACKWARD
= _core_
.BACKWARD
169 SIZE_AUTO_WIDTH
= _core_
.SIZE_AUTO_WIDTH
170 SIZE_AUTO_HEIGHT
= _core_
.SIZE_AUTO_HEIGHT
171 SIZE_AUTO
= _core_
.SIZE_AUTO
172 SIZE_USE_EXISTING
= _core_
.SIZE_USE_EXISTING
173 SIZE_ALLOW_MINUS_ONE
= _core_
.SIZE_ALLOW_MINUS_ONE
174 SIZE_FORCE
= _core_
.SIZE_FORCE
175 PORTRAIT
= _core_
.PORTRAIT
176 LANDSCAPE
= _core_
.LANDSCAPE
177 PRINT_QUALITY_HIGH
= _core_
.PRINT_QUALITY_HIGH
178 PRINT_QUALITY_MEDIUM
= _core_
.PRINT_QUALITY_MEDIUM
179 PRINT_QUALITY_LOW
= _core_
.PRINT_QUALITY_LOW
180 PRINT_QUALITY_DRAFT
= _core_
.PRINT_QUALITY_DRAFT
181 ID_ANY
= _core_
.ID_ANY
182 ID_SEPARATOR
= _core_
.ID_SEPARATOR
183 ID_NONE
= _core_
.ID_NONE
184 ID_LOWEST
= _core_
.ID_LOWEST
185 ID_OPEN
= _core_
.ID_OPEN
186 ID_CLOSE
= _core_
.ID_CLOSE
187 ID_NEW
= _core_
.ID_NEW
188 ID_SAVE
= _core_
.ID_SAVE
189 ID_SAVEAS
= _core_
.ID_SAVEAS
190 ID_REVERT
= _core_
.ID_REVERT
191 ID_EXIT
= _core_
.ID_EXIT
192 ID_UNDO
= _core_
.ID_UNDO
193 ID_REDO
= _core_
.ID_REDO
194 ID_HELP
= _core_
.ID_HELP
195 ID_PRINT
= _core_
.ID_PRINT
196 ID_PRINT_SETUP
= _core_
.ID_PRINT_SETUP
197 ID_PAGE_SETUP
= _core_
.ID_PAGE_SETUP
198 ID_PREVIEW
= _core_
.ID_PREVIEW
199 ID_ABOUT
= _core_
.ID_ABOUT
200 ID_HELP_CONTENTS
= _core_
.ID_HELP_CONTENTS
201 ID_HELP_COMMANDS
= _core_
.ID_HELP_COMMANDS
202 ID_HELP_PROCEDURES
= _core_
.ID_HELP_PROCEDURES
203 ID_HELP_CONTEXT
= _core_
.ID_HELP_CONTEXT
204 ID_HELP_INDEX
= _core_
.ID_HELP_INDEX
205 ID_HELP_SEARCH
= _core_
.ID_HELP_SEARCH
206 ID_CLOSE_ALL
= _core_
.ID_CLOSE_ALL
207 ID_PREFERENCES
= _core_
.ID_PREFERENCES
208 ID_EDIT
= _core_
.ID_EDIT
209 ID_CUT
= _core_
.ID_CUT
210 ID_COPY
= _core_
.ID_COPY
211 ID_PASTE
= _core_
.ID_PASTE
212 ID_CLEAR
= _core_
.ID_CLEAR
213 ID_FIND
= _core_
.ID_FIND
214 ID_DUPLICATE
= _core_
.ID_DUPLICATE
215 ID_SELECTALL
= _core_
.ID_SELECTALL
216 ID_DELETE
= _core_
.ID_DELETE
217 ID_REPLACE
= _core_
.ID_REPLACE
218 ID_REPLACE_ALL
= _core_
.ID_REPLACE_ALL
219 ID_PROPERTIES
= _core_
.ID_PROPERTIES
220 ID_VIEW_DETAILS
= _core_
.ID_VIEW_DETAILS
221 ID_VIEW_LARGEICONS
= _core_
.ID_VIEW_LARGEICONS
222 ID_VIEW_SMALLICONS
= _core_
.ID_VIEW_SMALLICONS
223 ID_VIEW_LIST
= _core_
.ID_VIEW_LIST
224 ID_VIEW_SORTDATE
= _core_
.ID_VIEW_SORTDATE
225 ID_VIEW_SORTNAME
= _core_
.ID_VIEW_SORTNAME
226 ID_VIEW_SORTSIZE
= _core_
.ID_VIEW_SORTSIZE
227 ID_VIEW_SORTTYPE
= _core_
.ID_VIEW_SORTTYPE
228 ID_FILE
= _core_
.ID_FILE
229 ID_FILE1
= _core_
.ID_FILE1
230 ID_FILE2
= _core_
.ID_FILE2
231 ID_FILE3
= _core_
.ID_FILE3
232 ID_FILE4
= _core_
.ID_FILE4
233 ID_FILE5
= _core_
.ID_FILE5
234 ID_FILE6
= _core_
.ID_FILE6
235 ID_FILE7
= _core_
.ID_FILE7
236 ID_FILE8
= _core_
.ID_FILE8
237 ID_FILE9
= _core_
.ID_FILE9
239 ID_CANCEL
= _core_
.ID_CANCEL
240 ID_APPLY
= _core_
.ID_APPLY
241 ID_YES
= _core_
.ID_YES
243 ID_STATIC
= _core_
.ID_STATIC
244 ID_FORWARD
= _core_
.ID_FORWARD
245 ID_BACKWARD
= _core_
.ID_BACKWARD
246 ID_DEFAULT
= _core_
.ID_DEFAULT
247 ID_MORE
= _core_
.ID_MORE
248 ID_SETUP
= _core_
.ID_SETUP
249 ID_RESET
= _core_
.ID_RESET
250 ID_CONTEXT_HELP
= _core_
.ID_CONTEXT_HELP
251 ID_YESTOALL
= _core_
.ID_YESTOALL
252 ID_NOTOALL
= _core_
.ID_NOTOALL
253 ID_ABORT
= _core_
.ID_ABORT
254 ID_RETRY
= _core_
.ID_RETRY
255 ID_IGNORE
= _core_
.ID_IGNORE
256 ID_ADD
= _core_
.ID_ADD
257 ID_REMOVE
= _core_
.ID_REMOVE
259 ID_DOWN
= _core_
.ID_DOWN
260 ID_HOME
= _core_
.ID_HOME
261 ID_REFRESH
= _core_
.ID_REFRESH
262 ID_STOP
= _core_
.ID_STOP
263 ID_INDEX
= _core_
.ID_INDEX
264 ID_BOLD
= _core_
.ID_BOLD
265 ID_ITALIC
= _core_
.ID_ITALIC
266 ID_JUSTIFY_CENTER
= _core_
.ID_JUSTIFY_CENTER
267 ID_JUSTIFY_FILL
= _core_
.ID_JUSTIFY_FILL
268 ID_JUSTIFY_RIGHT
= _core_
.ID_JUSTIFY_RIGHT
269 ID_JUSTIFY_LEFT
= _core_
.ID_JUSTIFY_LEFT
270 ID_UNDERLINE
= _core_
.ID_UNDERLINE
271 ID_INDENT
= _core_
.ID_INDENT
272 ID_UNINDENT
= _core_
.ID_UNINDENT
273 ID_ZOOM_100
= _core_
.ID_ZOOM_100
274 ID_ZOOM_FIT
= _core_
.ID_ZOOM_FIT
275 ID_ZOOM_IN
= _core_
.ID_ZOOM_IN
276 ID_ZOOM_OUT
= _core_
.ID_ZOOM_OUT
277 ID_UNDELETE
= _core_
.ID_UNDELETE
278 ID_REVERT_TO_SAVED
= _core_
.ID_REVERT_TO_SAVED
279 ID_HIGHEST
= _core_
.ID_HIGHEST
280 MENU_TEAROFF
= _core_
.MENU_TEAROFF
281 MB_DOCKABLE
= _core_
.MB_DOCKABLE
282 NO_FULL_REPAINT_ON_RESIZE
= _core_
.NO_FULL_REPAINT_ON_RESIZE
283 FULL_REPAINT_ON_RESIZE
= _core_
.FULL_REPAINT_ON_RESIZE
284 LI_HORIZONTAL
= _core_
.LI_HORIZONTAL
285 LI_VERTICAL
= _core_
.LI_VERTICAL
286 WS_EX_VALIDATE_RECURSIVELY
= _core_
.WS_EX_VALIDATE_RECURSIVELY
287 WS_EX_BLOCK_EVENTS
= _core_
.WS_EX_BLOCK_EVENTS
288 WS_EX_TRANSIENT
= _core_
.WS_EX_TRANSIENT
289 WS_EX_THEMED_BACKGROUND
= _core_
.WS_EX_THEMED_BACKGROUND
290 WS_EX_PROCESS_IDLE
= _core_
.WS_EX_PROCESS_IDLE
291 WS_EX_PROCESS_UI_UPDATES
= _core_
.WS_EX_PROCESS_UI_UPDATES
292 MM_TEXT
= _core_
.MM_TEXT
293 MM_LOMETRIC
= _core_
.MM_LOMETRIC
294 MM_HIMETRIC
= _core_
.MM_HIMETRIC
295 MM_LOENGLISH
= _core_
.MM_LOENGLISH
296 MM_HIENGLISH
= _core_
.MM_HIENGLISH
297 MM_TWIPS
= _core_
.MM_TWIPS
298 MM_ISOTROPIC
= _core_
.MM_ISOTROPIC
299 MM_ANISOTROPIC
= _core_
.MM_ANISOTROPIC
300 MM_POINTS
= _core_
.MM_POINTS
301 MM_METRIC
= _core_
.MM_METRIC
302 CENTRE
= _core_
.CENTRE
303 CENTER
= _core_
.CENTER
304 HORIZONTAL
= _core_
.HORIZONTAL
305 VERTICAL
= _core_
.VERTICAL
312 BOTTOM
= _core_
.BOTTOM
318 ALIGN_NOT
= _core_
.ALIGN_NOT
319 ALIGN_CENTER_HORIZONTAL
= _core_
.ALIGN_CENTER_HORIZONTAL
320 ALIGN_CENTRE_HORIZONTAL
= _core_
.ALIGN_CENTRE_HORIZONTAL
321 ALIGN_LEFT
= _core_
.ALIGN_LEFT
322 ALIGN_TOP
= _core_
.ALIGN_TOP
323 ALIGN_RIGHT
= _core_
.ALIGN_RIGHT
324 ALIGN_BOTTOM
= _core_
.ALIGN_BOTTOM
325 ALIGN_CENTER_VERTICAL
= _core_
.ALIGN_CENTER_VERTICAL
326 ALIGN_CENTRE_VERTICAL
= _core_
.ALIGN_CENTRE_VERTICAL
327 ALIGN_CENTER
= _core_
.ALIGN_CENTER
328 ALIGN_CENTRE
= _core_
.ALIGN_CENTRE
329 ALIGN_MASK
= _core_
.ALIGN_MASK
330 STRETCH_NOT
= _core_
.STRETCH_NOT
331 SHRINK
= _core_
.SHRINK
333 EXPAND
= _core_
.EXPAND
334 SHAPED
= _core_
.SHAPED
335 FIXED_MINSIZE
= _core_
.FIXED_MINSIZE
337 ADJUST_MINSIZE
= _core_
.ADJUST_MINSIZE
338 BORDER_DEFAULT
= _core_
.BORDER_DEFAULT
339 BORDER_NONE
= _core_
.BORDER_NONE
340 BORDER_STATIC
= _core_
.BORDER_STATIC
341 BORDER_SIMPLE
= _core_
.BORDER_SIMPLE
342 BORDER_RAISED
= _core_
.BORDER_RAISED
343 BORDER_SUNKEN
= _core_
.BORDER_SUNKEN
344 BORDER_DOUBLE
= _core_
.BORDER_DOUBLE
345 BORDER_MASK
= _core_
.BORDER_MASK
346 BG_STYLE_SYSTEM
= _core_
.BG_STYLE_SYSTEM
347 BG_STYLE_COLOUR
= _core_
.BG_STYLE_COLOUR
348 BG_STYLE_CUSTOM
= _core_
.BG_STYLE_CUSTOM
349 DEFAULT
= _core_
.DEFAULT
350 DECORATIVE
= _core_
.DECORATIVE
352 SCRIPT
= _core_
.SCRIPT
354 MODERN
= _core_
.MODERN
355 TELETYPE
= _core_
.TELETYPE
356 VARIABLE
= _core_
.VARIABLE
358 NORMAL
= _core_
.NORMAL
361 ITALIC
= _core_
.ITALIC
365 LONG_DASH
= _core_
.LONG_DASH
366 SHORT_DASH
= _core_
.SHORT_DASH
367 DOT_DASH
= _core_
.DOT_DASH
368 USER_DASH
= _core_
.USER_DASH
369 TRANSPARENT
= _core_
.TRANSPARENT
370 STIPPLE
= _core_
.STIPPLE
371 STIPPLE_MASK
= _core_
.STIPPLE_MASK
372 STIPPLE_MASK_OPAQUE
= _core_
.STIPPLE_MASK_OPAQUE
373 BDIAGONAL_HATCH
= _core_
.BDIAGONAL_HATCH
374 CROSSDIAG_HATCH
= _core_
.CROSSDIAG_HATCH
375 FDIAGONAL_HATCH
= _core_
.FDIAGONAL_HATCH
376 CROSS_HATCH
= _core_
.CROSS_HATCH
377 HORIZONTAL_HATCH
= _core_
.HORIZONTAL_HATCH
378 VERTICAL_HATCH
= _core_
.VERTICAL_HATCH
379 JOIN_BEVEL
= _core_
.JOIN_BEVEL
380 JOIN_MITER
= _core_
.JOIN_MITER
381 JOIN_ROUND
= _core_
.JOIN_ROUND
382 CAP_ROUND
= _core_
.CAP_ROUND
383 CAP_PROJECTING
= _core_
.CAP_PROJECTING
384 CAP_BUTT
= _core_
.CAP_BUTT
387 INVERT
= _core_
.INVERT
388 OR_REVERSE
= _core_
.OR_REVERSE
389 AND_REVERSE
= _core_
.AND_REVERSE
392 AND_INVERT
= _core_
.AND_INVERT
396 SRC_INVERT
= _core_
.SRC_INVERT
397 OR_INVERT
= _core_
.OR_INVERT
401 WXK_BACK
= _core_
.WXK_BACK
402 WXK_TAB
= _core_
.WXK_TAB
403 WXK_RETURN
= _core_
.WXK_RETURN
404 WXK_ESCAPE
= _core_
.WXK_ESCAPE
405 WXK_SPACE
= _core_
.WXK_SPACE
406 WXK_DELETE
= _core_
.WXK_DELETE
407 WXK_START
= _core_
.WXK_START
408 WXK_LBUTTON
= _core_
.WXK_LBUTTON
409 WXK_RBUTTON
= _core_
.WXK_RBUTTON
410 WXK_CANCEL
= _core_
.WXK_CANCEL
411 WXK_MBUTTON
= _core_
.WXK_MBUTTON
412 WXK_CLEAR
= _core_
.WXK_CLEAR
413 WXK_SHIFT
= _core_
.WXK_SHIFT
414 WXK_ALT
= _core_
.WXK_ALT
415 WXK_CONTROL
= _core_
.WXK_CONTROL
416 WXK_MENU
= _core_
.WXK_MENU
417 WXK_PAUSE
= _core_
.WXK_PAUSE
418 WXK_CAPITAL
= _core_
.WXK_CAPITAL
419 WXK_PRIOR
= _core_
.WXK_PRIOR
420 WXK_NEXT
= _core_
.WXK_NEXT
421 WXK_END
= _core_
.WXK_END
422 WXK_HOME
= _core_
.WXK_HOME
423 WXK_LEFT
= _core_
.WXK_LEFT
424 WXK_UP
= _core_
.WXK_UP
425 WXK_RIGHT
= _core_
.WXK_RIGHT
426 WXK_DOWN
= _core_
.WXK_DOWN
427 WXK_SELECT
= _core_
.WXK_SELECT
428 WXK_PRINT
= _core_
.WXK_PRINT
429 WXK_EXECUTE
= _core_
.WXK_EXECUTE
430 WXK_SNAPSHOT
= _core_
.WXK_SNAPSHOT
431 WXK_INSERT
= _core_
.WXK_INSERT
432 WXK_HELP
= _core_
.WXK_HELP
433 WXK_NUMPAD0
= _core_
.WXK_NUMPAD0
434 WXK_NUMPAD1
= _core_
.WXK_NUMPAD1
435 WXK_NUMPAD2
= _core_
.WXK_NUMPAD2
436 WXK_NUMPAD3
= _core_
.WXK_NUMPAD3
437 WXK_NUMPAD4
= _core_
.WXK_NUMPAD4
438 WXK_NUMPAD5
= _core_
.WXK_NUMPAD5
439 WXK_NUMPAD6
= _core_
.WXK_NUMPAD6
440 WXK_NUMPAD7
= _core_
.WXK_NUMPAD7
441 WXK_NUMPAD8
= _core_
.WXK_NUMPAD8
442 WXK_NUMPAD9
= _core_
.WXK_NUMPAD9
443 WXK_MULTIPLY
= _core_
.WXK_MULTIPLY
444 WXK_ADD
= _core_
.WXK_ADD
445 WXK_SEPARATOR
= _core_
.WXK_SEPARATOR
446 WXK_SUBTRACT
= _core_
.WXK_SUBTRACT
447 WXK_DECIMAL
= _core_
.WXK_DECIMAL
448 WXK_DIVIDE
= _core_
.WXK_DIVIDE
449 WXK_F1
= _core_
.WXK_F1
450 WXK_F2
= _core_
.WXK_F2
451 WXK_F3
= _core_
.WXK_F3
452 WXK_F4
= _core_
.WXK_F4
453 WXK_F5
= _core_
.WXK_F5
454 WXK_F6
= _core_
.WXK_F6
455 WXK_F7
= _core_
.WXK_F7
456 WXK_F8
= _core_
.WXK_F8
457 WXK_F9
= _core_
.WXK_F9
458 WXK_F10
= _core_
.WXK_F10
459 WXK_F11
= _core_
.WXK_F11
460 WXK_F12
= _core_
.WXK_F12
461 WXK_F13
= _core_
.WXK_F13
462 WXK_F14
= _core_
.WXK_F14
463 WXK_F15
= _core_
.WXK_F15
464 WXK_F16
= _core_
.WXK_F16
465 WXK_F17
= _core_
.WXK_F17
466 WXK_F18
= _core_
.WXK_F18
467 WXK_F19
= _core_
.WXK_F19
468 WXK_F20
= _core_
.WXK_F20
469 WXK_F21
= _core_
.WXK_F21
470 WXK_F22
= _core_
.WXK_F22
471 WXK_F23
= _core_
.WXK_F23
472 WXK_F24
= _core_
.WXK_F24
473 WXK_NUMLOCK
= _core_
.WXK_NUMLOCK
474 WXK_SCROLL
= _core_
.WXK_SCROLL
475 WXK_PAGEUP
= _core_
.WXK_PAGEUP
476 WXK_PAGEDOWN
= _core_
.WXK_PAGEDOWN
477 WXK_NUMPAD_SPACE
= _core_
.WXK_NUMPAD_SPACE
478 WXK_NUMPAD_TAB
= _core_
.WXK_NUMPAD_TAB
479 WXK_NUMPAD_ENTER
= _core_
.WXK_NUMPAD_ENTER
480 WXK_NUMPAD_F1
= _core_
.WXK_NUMPAD_F1
481 WXK_NUMPAD_F2
= _core_
.WXK_NUMPAD_F2
482 WXK_NUMPAD_F3
= _core_
.WXK_NUMPAD_F3
483 WXK_NUMPAD_F4
= _core_
.WXK_NUMPAD_F4
484 WXK_NUMPAD_HOME
= _core_
.WXK_NUMPAD_HOME
485 WXK_NUMPAD_LEFT
= _core_
.WXK_NUMPAD_LEFT
486 WXK_NUMPAD_UP
= _core_
.WXK_NUMPAD_UP
487 WXK_NUMPAD_RIGHT
= _core_
.WXK_NUMPAD_RIGHT
488 WXK_NUMPAD_DOWN
= _core_
.WXK_NUMPAD_DOWN
489 WXK_NUMPAD_PRIOR
= _core_
.WXK_NUMPAD_PRIOR
490 WXK_NUMPAD_PAGEUP
= _core_
.WXK_NUMPAD_PAGEUP
491 WXK_NUMPAD_NEXT
= _core_
.WXK_NUMPAD_NEXT
492 WXK_NUMPAD_PAGEDOWN
= _core_
.WXK_NUMPAD_PAGEDOWN
493 WXK_NUMPAD_END
= _core_
.WXK_NUMPAD_END
494 WXK_NUMPAD_BEGIN
= _core_
.WXK_NUMPAD_BEGIN
495 WXK_NUMPAD_INSERT
= _core_
.WXK_NUMPAD_INSERT
496 WXK_NUMPAD_DELETE
= _core_
.WXK_NUMPAD_DELETE
497 WXK_NUMPAD_EQUAL
= _core_
.WXK_NUMPAD_EQUAL
498 WXK_NUMPAD_MULTIPLY
= _core_
.WXK_NUMPAD_MULTIPLY
499 WXK_NUMPAD_ADD
= _core_
.WXK_NUMPAD_ADD
500 WXK_NUMPAD_SEPARATOR
= _core_
.WXK_NUMPAD_SEPARATOR
501 WXK_NUMPAD_SUBTRACT
= _core_
.WXK_NUMPAD_SUBTRACT
502 WXK_NUMPAD_DECIMAL
= _core_
.WXK_NUMPAD_DECIMAL
503 WXK_NUMPAD_DIVIDE
= _core_
.WXK_NUMPAD_DIVIDE
504 WXK_WINDOWS_LEFT
= _core_
.WXK_WINDOWS_LEFT
505 WXK_WINDOWS_RIGHT
= _core_
.WXK_WINDOWS_RIGHT
506 WXK_WINDOWS_MENU
= _core_
.WXK_WINDOWS_MENU
507 WXK_COMMAND
= _core_
.WXK_COMMAND
508 WXK_SPECIAL1
= _core_
.WXK_SPECIAL1
509 WXK_SPECIAL2
= _core_
.WXK_SPECIAL2
510 WXK_SPECIAL3
= _core_
.WXK_SPECIAL3
511 WXK_SPECIAL4
= _core_
.WXK_SPECIAL4
512 WXK_SPECIAL5
= _core_
.WXK_SPECIAL5
513 WXK_SPECIAL6
= _core_
.WXK_SPECIAL6
514 WXK_SPECIAL7
= _core_
.WXK_SPECIAL7
515 WXK_SPECIAL8
= _core_
.WXK_SPECIAL8
516 WXK_SPECIAL9
= _core_
.WXK_SPECIAL9
517 WXK_SPECIAL10
= _core_
.WXK_SPECIAL10
518 WXK_SPECIAL11
= _core_
.WXK_SPECIAL11
519 WXK_SPECIAL12
= _core_
.WXK_SPECIAL12
520 WXK_SPECIAL13
= _core_
.WXK_SPECIAL13
521 WXK_SPECIAL14
= _core_
.WXK_SPECIAL14
522 WXK_SPECIAL15
= _core_
.WXK_SPECIAL15
523 WXK_SPECIAL16
= _core_
.WXK_SPECIAL16
524 WXK_SPECIAL17
= _core_
.WXK_SPECIAL17
525 WXK_SPECIAL18
= _core_
.WXK_SPECIAL18
526 WXK_SPECIAL19
= _core_
.WXK_SPECIAL19
527 WXK_SPECIAL20
= _core_
.WXK_SPECIAL20
528 PAPER_NONE
= _core_
.PAPER_NONE
529 PAPER_LETTER
= _core_
.PAPER_LETTER
530 PAPER_LEGAL
= _core_
.PAPER_LEGAL
531 PAPER_A4
= _core_
.PAPER_A4
532 PAPER_CSHEET
= _core_
.PAPER_CSHEET
533 PAPER_DSHEET
= _core_
.PAPER_DSHEET
534 PAPER_ESHEET
= _core_
.PAPER_ESHEET
535 PAPER_LETTERSMALL
= _core_
.PAPER_LETTERSMALL
536 PAPER_TABLOID
= _core_
.PAPER_TABLOID
537 PAPER_LEDGER
= _core_
.PAPER_LEDGER
538 PAPER_STATEMENT
= _core_
.PAPER_STATEMENT
539 PAPER_EXECUTIVE
= _core_
.PAPER_EXECUTIVE
540 PAPER_A3
= _core_
.PAPER_A3
541 PAPER_A4SMALL
= _core_
.PAPER_A4SMALL
542 PAPER_A5
= _core_
.PAPER_A5
543 PAPER_B4
= _core_
.PAPER_B4
544 PAPER_B5
= _core_
.PAPER_B5
545 PAPER_FOLIO
= _core_
.PAPER_FOLIO
546 PAPER_QUARTO
= _core_
.PAPER_QUARTO
547 PAPER_10X14
= _core_
.PAPER_10X14
548 PAPER_11X17
= _core_
.PAPER_11X17
549 PAPER_NOTE
= _core_
.PAPER_NOTE
550 PAPER_ENV_9
= _core_
.PAPER_ENV_9
551 PAPER_ENV_10
= _core_
.PAPER_ENV_10
552 PAPER_ENV_11
= _core_
.PAPER_ENV_11
553 PAPER_ENV_12
= _core_
.PAPER_ENV_12
554 PAPER_ENV_14
= _core_
.PAPER_ENV_14
555 PAPER_ENV_DL
= _core_
.PAPER_ENV_DL
556 PAPER_ENV_C5
= _core_
.PAPER_ENV_C5
557 PAPER_ENV_C3
= _core_
.PAPER_ENV_C3
558 PAPER_ENV_C4
= _core_
.PAPER_ENV_C4
559 PAPER_ENV_C6
= _core_
.PAPER_ENV_C6
560 PAPER_ENV_C65
= _core_
.PAPER_ENV_C65
561 PAPER_ENV_B4
= _core_
.PAPER_ENV_B4
562 PAPER_ENV_B5
= _core_
.PAPER_ENV_B5
563 PAPER_ENV_B6
= _core_
.PAPER_ENV_B6
564 PAPER_ENV_ITALY
= _core_
.PAPER_ENV_ITALY
565 PAPER_ENV_MONARCH
= _core_
.PAPER_ENV_MONARCH
566 PAPER_ENV_PERSONAL
= _core_
.PAPER_ENV_PERSONAL
567 PAPER_FANFOLD_US
= _core_
.PAPER_FANFOLD_US
568 PAPER_FANFOLD_STD_GERMAN
= _core_
.PAPER_FANFOLD_STD_GERMAN
569 PAPER_FANFOLD_LGL_GERMAN
= _core_
.PAPER_FANFOLD_LGL_GERMAN
570 PAPER_ISO_B4
= _core_
.PAPER_ISO_B4
571 PAPER_JAPANESE_POSTCARD
= _core_
.PAPER_JAPANESE_POSTCARD
572 PAPER_9X11
= _core_
.PAPER_9X11
573 PAPER_10X11
= _core_
.PAPER_10X11
574 PAPER_15X11
= _core_
.PAPER_15X11
575 PAPER_ENV_INVITE
= _core_
.PAPER_ENV_INVITE
576 PAPER_LETTER_EXTRA
= _core_
.PAPER_LETTER_EXTRA
577 PAPER_LEGAL_EXTRA
= _core_
.PAPER_LEGAL_EXTRA
578 PAPER_TABLOID_EXTRA
= _core_
.PAPER_TABLOID_EXTRA
579 PAPER_A4_EXTRA
= _core_
.PAPER_A4_EXTRA
580 PAPER_LETTER_TRANSVERSE
= _core_
.PAPER_LETTER_TRANSVERSE
581 PAPER_A4_TRANSVERSE
= _core_
.PAPER_A4_TRANSVERSE
582 PAPER_LETTER_EXTRA_TRANSVERSE
= _core_
.PAPER_LETTER_EXTRA_TRANSVERSE
583 PAPER_A_PLUS
= _core_
.PAPER_A_PLUS
584 PAPER_B_PLUS
= _core_
.PAPER_B_PLUS
585 PAPER_LETTER_PLUS
= _core_
.PAPER_LETTER_PLUS
586 PAPER_A4_PLUS
= _core_
.PAPER_A4_PLUS
587 PAPER_A5_TRANSVERSE
= _core_
.PAPER_A5_TRANSVERSE
588 PAPER_B5_TRANSVERSE
= _core_
.PAPER_B5_TRANSVERSE
589 PAPER_A3_EXTRA
= _core_
.PAPER_A3_EXTRA
590 PAPER_A5_EXTRA
= _core_
.PAPER_A5_EXTRA
591 PAPER_B5_EXTRA
= _core_
.PAPER_B5_EXTRA
592 PAPER_A2
= _core_
.PAPER_A2
593 PAPER_A3_TRANSVERSE
= _core_
.PAPER_A3_TRANSVERSE
594 PAPER_A3_EXTRA_TRANSVERSE
= _core_
.PAPER_A3_EXTRA_TRANSVERSE
595 PAPER_DBL_JAPANESE_POSTCARD
= _core_
.PAPER_DBL_JAPANESE_POSTCARD
596 PAPER_A6
= _core_
.PAPER_A6
597 PAPER_JENV_KAKU2
= _core_
.PAPER_JENV_KAKU2
598 PAPER_JENV_KAKU3
= _core_
.PAPER_JENV_KAKU3
599 PAPER_JENV_CHOU3
= _core_
.PAPER_JENV_CHOU3
600 PAPER_JENV_CHOU4
= _core_
.PAPER_JENV_CHOU4
601 PAPER_LETTER_ROTATED
= _core_
.PAPER_LETTER_ROTATED
602 PAPER_A3_ROTATED
= _core_
.PAPER_A3_ROTATED
603 PAPER_A4_ROTATED
= _core_
.PAPER_A4_ROTATED
604 PAPER_A5_ROTATED
= _core_
.PAPER_A5_ROTATED
605 PAPER_B4_JIS_ROTATED
= _core_
.PAPER_B4_JIS_ROTATED
606 PAPER_B5_JIS_ROTATED
= _core_
.PAPER_B5_JIS_ROTATED
607 PAPER_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_JAPANESE_POSTCARD_ROTATED
608 PAPER_DBL_JAPANESE_POSTCARD_ROTATED
= _core_
.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609 PAPER_A6_ROTATED
= _core_
.PAPER_A6_ROTATED
610 PAPER_JENV_KAKU2_ROTATED
= _core_
.PAPER_JENV_KAKU2_ROTATED
611 PAPER_JENV_KAKU3_ROTATED
= _core_
.PAPER_JENV_KAKU3_ROTATED
612 PAPER_JENV_CHOU3_ROTATED
= _core_
.PAPER_JENV_CHOU3_ROTATED
613 PAPER_JENV_CHOU4_ROTATED
= _core_
.PAPER_JENV_CHOU4_ROTATED
614 PAPER_B6_JIS
= _core_
.PAPER_B6_JIS
615 PAPER_B6_JIS_ROTATED
= _core_
.PAPER_B6_JIS_ROTATED
616 PAPER_12X11
= _core_
.PAPER_12X11
617 PAPER_JENV_YOU4
= _core_
.PAPER_JENV_YOU4
618 PAPER_JENV_YOU4_ROTATED
= _core_
.PAPER_JENV_YOU4_ROTATED
619 PAPER_P16K
= _core_
.PAPER_P16K
620 PAPER_P32K
= _core_
.PAPER_P32K
621 PAPER_P32KBIG
= _core_
.PAPER_P32KBIG
622 PAPER_PENV_1
= _core_
.PAPER_PENV_1
623 PAPER_PENV_2
= _core_
.PAPER_PENV_2
624 PAPER_PENV_3
= _core_
.PAPER_PENV_3
625 PAPER_PENV_4
= _core_
.PAPER_PENV_4
626 PAPER_PENV_5
= _core_
.PAPER_PENV_5
627 PAPER_PENV_6
= _core_
.PAPER_PENV_6
628 PAPER_PENV_7
= _core_
.PAPER_PENV_7
629 PAPER_PENV_8
= _core_
.PAPER_PENV_8
630 PAPER_PENV_9
= _core_
.PAPER_PENV_9
631 PAPER_PENV_10
= _core_
.PAPER_PENV_10
632 PAPER_P16K_ROTATED
= _core_
.PAPER_P16K_ROTATED
633 PAPER_P32K_ROTATED
= _core_
.PAPER_P32K_ROTATED
634 PAPER_P32KBIG_ROTATED
= _core_
.PAPER_P32KBIG_ROTATED
635 PAPER_PENV_1_ROTATED
= _core_
.PAPER_PENV_1_ROTATED
636 PAPER_PENV_2_ROTATED
= _core_
.PAPER_PENV_2_ROTATED
637 PAPER_PENV_3_ROTATED
= _core_
.PAPER_PENV_3_ROTATED
638 PAPER_PENV_4_ROTATED
= _core_
.PAPER_PENV_4_ROTATED
639 PAPER_PENV_5_ROTATED
= _core_
.PAPER_PENV_5_ROTATED
640 PAPER_PENV_6_ROTATED
= _core_
.PAPER_PENV_6_ROTATED
641 PAPER_PENV_7_ROTATED
= _core_
.PAPER_PENV_7_ROTATED
642 PAPER_PENV_8_ROTATED
= _core_
.PAPER_PENV_8_ROTATED
643 PAPER_PENV_9_ROTATED
= _core_
.PAPER_PENV_9_ROTATED
644 PAPER_PENV_10_ROTATED
= _core_
.PAPER_PENV_10_ROTATED
645 DUPLEX_SIMPLEX
= _core_
.DUPLEX_SIMPLEX
646 DUPLEX_HORIZONTAL
= _core_
.DUPLEX_HORIZONTAL
647 DUPLEX_VERTICAL
= _core_
.DUPLEX_VERTICAL
648 ITEM_SEPARATOR
= _core_
.ITEM_SEPARATOR
649 ITEM_NORMAL
= _core_
.ITEM_NORMAL
650 ITEM_CHECK
= _core_
.ITEM_CHECK
651 ITEM_RADIO
= _core_
.ITEM_RADIO
652 ITEM_MAX
= _core_
.ITEM_MAX
653 HT_NOWHERE
= _core_
.HT_NOWHERE
654 HT_SCROLLBAR_FIRST
= _core_
.HT_SCROLLBAR_FIRST
655 HT_SCROLLBAR_ARROW_LINE_1
= _core_
.HT_SCROLLBAR_ARROW_LINE_1
656 HT_SCROLLBAR_ARROW_LINE_2
= _core_
.HT_SCROLLBAR_ARROW_LINE_2
657 HT_SCROLLBAR_ARROW_PAGE_1
= _core_
.HT_SCROLLBAR_ARROW_PAGE_1
658 HT_SCROLLBAR_ARROW_PAGE_2
= _core_
.HT_SCROLLBAR_ARROW_PAGE_2
659 HT_SCROLLBAR_THUMB
= _core_
.HT_SCROLLBAR_THUMB
660 HT_SCROLLBAR_BAR_1
= _core_
.HT_SCROLLBAR_BAR_1
661 HT_SCROLLBAR_BAR_2
= _core_
.HT_SCROLLBAR_BAR_2
662 HT_SCROLLBAR_LAST
= _core_
.HT_SCROLLBAR_LAST
663 HT_WINDOW_OUTSIDE
= _core_
.HT_WINDOW_OUTSIDE
664 HT_WINDOW_INSIDE
= _core_
.HT_WINDOW_INSIDE
665 HT_WINDOW_VERT_SCROLLBAR
= _core_
.HT_WINDOW_VERT_SCROLLBAR
666 HT_WINDOW_HORZ_SCROLLBAR
= _core_
.HT_WINDOW_HORZ_SCROLLBAR
667 HT_WINDOW_CORNER
= _core_
.HT_WINDOW_CORNER
668 HT_MAX
= _core_
.HT_MAX
669 MOD_NONE
= _core_
.MOD_NONE
670 MOD_ALT
= _core_
.MOD_ALT
671 MOD_CONTROL
= _core_
.MOD_CONTROL
672 MOD_ALTGR
= _core_
.MOD_ALTGR
673 MOD_SHIFT
= _core_
.MOD_SHIFT
674 MOD_META
= _core_
.MOD_META
675 MOD_WIN
= _core_
.MOD_WIN
676 MOD_CMD
= _core_
.MOD_CMD
677 MOD_ALL
= _core_
.MOD_ALL
678 UPDATE_UI_NONE
= _core_
.UPDATE_UI_NONE
679 UPDATE_UI_RECURSE
= _core_
.UPDATE_UI_RECURSE
680 UPDATE_UI_FROMIDLE
= _core_
.UPDATE_UI_FROMIDLE
681 Layout_Default
= _core_
.Layout_Default
682 Layout_LeftToRight
= _core_
.Layout_LeftToRight
683 Layout_RightToLeft
= _core_
.Layout_RightToLeft
684 #---------------------------------------------------------------------------
686 class Object(object):
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
691 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
692 def __init__(self
): raise AttributeError, "No constructor defined"
693 __repr__
= _swig_repr
694 def GetClassName(*args
, **kwargs
):
696 GetClassName(self) -> String
698 Returns the class name of the C++ class using wxRTTI.
700 return _core_
.Object_GetClassName(*args
, **kwargs
)
702 def Destroy(*args
, **kwargs
):
706 Deletes the C++ object this Python object is a proxy for.
708 args
[0].this
.own(False)
709 return _core_
.Object_Destroy(*args
, **kwargs
)
711 def IsSameAs(*args
, **kwargs
):
713 IsSameAs(self, Object p) -> bool
715 For wx.Objects that use C++ reference counting internally, this method
716 can be used to determine if two objects are referencing the same data
719 return _core_
.Object_IsSameAs(*args
, **kwargs
)
721 ClassName
= property(GetClassName
,doc
="See `GetClassName`")
722 _core_
.Object_swigregister(Object
)
723 _wxPySetDictionary
= _core_
._wxPySetDictionary
725 EmptyString
= cvar
.EmptyString
727 #---------------------------------------------------------------------------
729 BITMAP_TYPE_INVALID
= _core_
.BITMAP_TYPE_INVALID
730 BITMAP_TYPE_BMP
= _core_
.BITMAP_TYPE_BMP
731 BITMAP_TYPE_ICO
= _core_
.BITMAP_TYPE_ICO
732 BITMAP_TYPE_CUR
= _core_
.BITMAP_TYPE_CUR
733 BITMAP_TYPE_XBM
= _core_
.BITMAP_TYPE_XBM
734 BITMAP_TYPE_XBM_DATA
= _core_
.BITMAP_TYPE_XBM_DATA
735 BITMAP_TYPE_XPM
= _core_
.BITMAP_TYPE_XPM
736 BITMAP_TYPE_XPM_DATA
= _core_
.BITMAP_TYPE_XPM_DATA
737 BITMAP_TYPE_TIF
= _core_
.BITMAP_TYPE_TIF
738 BITMAP_TYPE_GIF
= _core_
.BITMAP_TYPE_GIF
739 BITMAP_TYPE_PNG
= _core_
.BITMAP_TYPE_PNG
740 BITMAP_TYPE_JPEG
= _core_
.BITMAP_TYPE_JPEG
741 BITMAP_TYPE_PNM
= _core_
.BITMAP_TYPE_PNM
742 BITMAP_TYPE_PCX
= _core_
.BITMAP_TYPE_PCX
743 BITMAP_TYPE_PICT
= _core_
.BITMAP_TYPE_PICT
744 BITMAP_TYPE_ICON
= _core_
.BITMAP_TYPE_ICON
745 BITMAP_TYPE_ANI
= _core_
.BITMAP_TYPE_ANI
746 BITMAP_TYPE_IFF
= _core_
.BITMAP_TYPE_IFF
747 BITMAP_TYPE_TGA
= _core_
.BITMAP_TYPE_TGA
748 BITMAP_TYPE_MACCURSOR
= _core_
.BITMAP_TYPE_MACCURSOR
749 BITMAP_TYPE_ANY
= _core_
.BITMAP_TYPE_ANY
750 CURSOR_NONE
= _core_
.CURSOR_NONE
751 CURSOR_ARROW
= _core_
.CURSOR_ARROW
752 CURSOR_RIGHT_ARROW
= _core_
.CURSOR_RIGHT_ARROW
753 CURSOR_BULLSEYE
= _core_
.CURSOR_BULLSEYE
754 CURSOR_CHAR
= _core_
.CURSOR_CHAR
755 CURSOR_CROSS
= _core_
.CURSOR_CROSS
756 CURSOR_HAND
= _core_
.CURSOR_HAND
757 CURSOR_IBEAM
= _core_
.CURSOR_IBEAM
758 CURSOR_LEFT_BUTTON
= _core_
.CURSOR_LEFT_BUTTON
759 CURSOR_MAGNIFIER
= _core_
.CURSOR_MAGNIFIER
760 CURSOR_MIDDLE_BUTTON
= _core_
.CURSOR_MIDDLE_BUTTON
761 CURSOR_NO_ENTRY
= _core_
.CURSOR_NO_ENTRY
762 CURSOR_PAINT_BRUSH
= _core_
.CURSOR_PAINT_BRUSH
763 CURSOR_PENCIL
= _core_
.CURSOR_PENCIL
764 CURSOR_POINT_LEFT
= _core_
.CURSOR_POINT_LEFT
765 CURSOR_POINT_RIGHT
= _core_
.CURSOR_POINT_RIGHT
766 CURSOR_QUESTION_ARROW
= _core_
.CURSOR_QUESTION_ARROW
767 CURSOR_RIGHT_BUTTON
= _core_
.CURSOR_RIGHT_BUTTON
768 CURSOR_SIZENESW
= _core_
.CURSOR_SIZENESW
769 CURSOR_SIZENS
= _core_
.CURSOR_SIZENS
770 CURSOR_SIZENWSE
= _core_
.CURSOR_SIZENWSE
771 CURSOR_SIZEWE
= _core_
.CURSOR_SIZEWE
772 CURSOR_SIZING
= _core_
.CURSOR_SIZING
773 CURSOR_SPRAYCAN
= _core_
.CURSOR_SPRAYCAN
774 CURSOR_WAIT
= _core_
.CURSOR_WAIT
775 CURSOR_WATCH
= _core_
.CURSOR_WATCH
776 CURSOR_BLANK
= _core_
.CURSOR_BLANK
777 CURSOR_DEFAULT
= _core_
.CURSOR_DEFAULT
778 CURSOR_COPY_ARROW
= _core_
.CURSOR_COPY_ARROW
779 CURSOR_ARROWWAIT
= _core_
.CURSOR_ARROWWAIT
780 CURSOR_MAX
= _core_
.CURSOR_MAX
781 #---------------------------------------------------------------------------
785 wx.Size is a useful data structure used to represent the size of
786 something. It simply contains integer width and height
787 properties. In most places in wxPython where a wx.Size is
788 expected a (width, height) tuple can be used instead.
790 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
791 __repr__
= _swig_repr
792 width
= property(_core_
.Size_width_get
, _core_
.Size_width_set
)
793 height
= property(_core_
.Size_height_get
, _core_
.Size_height_set
)
794 x
= width
; y
= height
795 def __init__(self
, *args
, **kwargs
):
797 __init__(self, int w=0, int h=0) -> Size
799 Creates a size object.
801 _core_
.Size_swiginit(self
,_core_
.new_Size(*args
, **kwargs
))
802 __swig_destroy__
= _core_
.delete_Size
803 __del__
= lambda self
: None;
804 def __eq__(*args
, **kwargs
):
806 __eq__(self, PyObject other) -> bool
808 Test for equality of wx.Size objects.
810 return _core_
.Size___eq__(*args
, **kwargs
)
812 def __ne__(*args
, **kwargs
):
814 __ne__(self, PyObject other) -> bool
816 Test for inequality of wx.Size objects.
818 return _core_
.Size___ne__(*args
, **kwargs
)
820 def __add__(*args
, **kwargs
):
822 __add__(self, Size sz) -> Size
824 Add sz's proprties to this and return the result.
826 return _core_
.Size___add__(*args
, **kwargs
)
828 def __sub__(*args
, **kwargs
):
830 __sub__(self, Size sz) -> Size
832 Subtract sz's properties from this and return the result.
834 return _core_
.Size___sub__(*args
, **kwargs
)
836 def IncTo(*args
, **kwargs
):
840 Increments this object so that both of its dimensions are not less
841 than the corresponding dimensions of the size.
843 return _core_
.Size_IncTo(*args
, **kwargs
)
845 def DecTo(*args
, **kwargs
):
849 Decrements this object so that both of its dimensions are not greater
850 than the corresponding dimensions of the size.
852 return _core_
.Size_DecTo(*args
, **kwargs
)
854 def IncBy(*args
, **kwargs
):
855 """IncBy(self, int dx, int dy)"""
856 return _core_
.Size_IncBy(*args
, **kwargs
)
858 def DecBy(*args
, **kwargs
):
859 """DecBy(self, int dx, int dy)"""
860 return _core_
.Size_DecBy(*args
, **kwargs
)
862 def Scale(*args
, **kwargs
):
864 Scale(self, float xscale, float yscale)
866 Scales the dimensions of this object by the given factors.
868 return _core_
.Size_Scale(*args
, **kwargs
)
870 def Set(*args
, **kwargs
):
872 Set(self, int w, int h)
874 Set both width and height.
876 return _core_
.Size_Set(*args
, **kwargs
)
878 def SetWidth(*args
, **kwargs
):
879 """SetWidth(self, int w)"""
880 return _core_
.Size_SetWidth(*args
, **kwargs
)
882 def SetHeight(*args
, **kwargs
):
883 """SetHeight(self, int h)"""
884 return _core_
.Size_SetHeight(*args
, **kwargs
)
886 def GetWidth(*args
, **kwargs
):
887 """GetWidth(self) -> int"""
888 return _core_
.Size_GetWidth(*args
, **kwargs
)
890 def GetHeight(*args
, **kwargs
):
891 """GetHeight(self) -> int"""
892 return _core_
.Size_GetHeight(*args
, **kwargs
)
894 def IsFullySpecified(*args
, **kwargs
):
896 IsFullySpecified(self) -> bool
898 Returns True if both components of the size are non-default values.
900 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
902 def SetDefaults(*args
, **kwargs
):
904 SetDefaults(self, Size size)
906 Combine this size with the other one replacing the default components
907 of this object (i.e. equal to -1) with those of the other.
909 return _core_
.Size_SetDefaults(*args
, **kwargs
)
911 def Get(*args
, **kwargs
):
913 Get() -> (width,height)
915 Returns the width and height properties as a tuple.
917 return _core_
.Size_Get(*args
, **kwargs
)
919 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
920 def __str__(self
): return str(self
.Get())
921 def __repr__(self
): return 'wx.Size'+str(self
.Get())
922 def __len__(self
): return len(self
.Get())
923 def __getitem__(self
, index
): return self
.Get()[index
]
924 def __setitem__(self
, index
, val
):
925 if index
== 0: self
.width
= val
926 elif index
== 1: self
.height
= val
927 else: raise IndexError
928 def __nonzero__(self
): return self
.Get() != (0,0)
929 __safe_for_unpickling__
= True
930 def __reduce__(self
): return (wx
.Size
, self
.Get())
932 _core_
.Size_swigregister(Size
)
934 #---------------------------------------------------------------------------
936 class RealPoint(object):
938 A data structure for representing a point or position with floating
939 point x and y properties. In wxPython most places that expect a
940 wx.RealPoint can also accept a (x,y) tuple.
942 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
943 __repr__
= _swig_repr
944 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
945 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
946 def __init__(self
, *args
, **kwargs
):
948 __init__(self, double x=0.0, double y=0.0) -> RealPoint
950 Create a wx.RealPoint object
952 _core_
.RealPoint_swiginit(self
,_core_
.new_RealPoint(*args
, **kwargs
))
953 __swig_destroy__
= _core_
.delete_RealPoint
954 __del__
= lambda self
: None;
955 def __eq__(*args
, **kwargs
):
957 __eq__(self, PyObject other) -> bool
959 Test for equality of wx.RealPoint objects.
961 return _core_
.RealPoint___eq__(*args
, **kwargs
)
963 def __ne__(*args
, **kwargs
):
965 __ne__(self, PyObject other) -> bool
967 Test for inequality of wx.RealPoint objects.
969 return _core_
.RealPoint___ne__(*args
, **kwargs
)
971 def __add__(*args
, **kwargs
):
973 __add__(self, RealPoint pt) -> RealPoint
975 Add pt's proprties to this and return the result.
977 return _core_
.RealPoint___add__(*args
, **kwargs
)
979 def __sub__(*args
, **kwargs
):
981 __sub__(self, RealPoint pt) -> RealPoint
983 Subtract pt's proprties from this and return the result
985 return _core_
.RealPoint___sub__(*args
, **kwargs
)
987 def Set(*args
, **kwargs
):
989 Set(self, double x, double y)
991 Set both the x and y properties
993 return _core_
.RealPoint_Set(*args
, **kwargs
)
995 def Get(*args
, **kwargs
):
999 Return the x and y properties as a tuple.
1001 return _core_
.RealPoint_Get(*args
, **kwargs
)
1003 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1004 def __str__(self
): return str(self
.Get())
1005 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
1006 def __len__(self
): return len(self
.Get())
1007 def __getitem__(self
, index
): return self
.Get()[index
]
1008 def __setitem__(self
, index
, val
):
1009 if index
== 0: self
.x
= val
1010 elif index
== 1: self
.y
= val
1011 else: raise IndexError
1012 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1013 __safe_for_unpickling__
= True
1014 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
1016 _core_
.RealPoint_swigregister(RealPoint
)
1018 #---------------------------------------------------------------------------
1020 class Point(object):
1022 A data structure for representing a point or position with integer x
1023 and y properties. Most places in wxPython that expect a wx.Point can
1024 also accept a (x,y) tuple.
1026 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1027 __repr__
= _swig_repr
1028 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1029 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1030 def __init__(self
, *args
, **kwargs
):
1032 __init__(self, int x=0, int y=0) -> Point
1034 Create a wx.Point object
1036 _core_
.Point_swiginit(self
,_core_
.new_Point(*args
, **kwargs
))
1037 __swig_destroy__
= _core_
.delete_Point
1038 __del__
= lambda self
: None;
1039 def __eq__(*args
, **kwargs
):
1041 __eq__(self, PyObject other) -> bool
1043 Test for equality of wx.Point objects.
1045 return _core_
.Point___eq__(*args
, **kwargs
)
1047 def __ne__(*args
, **kwargs
):
1049 __ne__(self, PyObject other) -> bool
1051 Test for inequality of wx.Point objects.
1053 return _core_
.Point___ne__(*args
, **kwargs
)
1055 def __add__(*args
, **kwargs
):
1057 __add__(self, Point pt) -> Point
1059 Add pt's proprties to this and return the result.
1061 return _core_
.Point___add__(*args
, **kwargs
)
1063 def __sub__(*args
, **kwargs
):
1065 __sub__(self, Point pt) -> Point
1067 Subtract pt's proprties from this and return the result
1069 return _core_
.Point___sub__(*args
, **kwargs
)
1071 def __iadd__(*args
, **kwargs
):
1073 __iadd__(self, Point pt) -> Point
1075 Add pt to this object.
1077 return _core_
.Point___iadd__(*args
, **kwargs
)
1079 def __isub__(*args
, **kwargs
):
1081 __isub__(self, Point pt) -> Point
1083 Subtract pt from this object.
1085 return _core_
.Point___isub__(*args
, **kwargs
)
1087 def Set(*args
, **kwargs
):
1089 Set(self, long x, long y)
1091 Set both the x and y properties
1093 return _core_
.Point_Set(*args
, **kwargs
)
1095 def Get(*args
, **kwargs
):
1099 Return the x and y properties as a tuple.
1101 return _core_
.Point_Get(*args
, **kwargs
)
1103 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1104 def __str__(self
): return str(self
.Get())
1105 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1106 def __len__(self
): return len(self
.Get())
1107 def __getitem__(self
, index
): return self
.Get()[index
]
1108 def __setitem__(self
, index
, val
):
1109 if index
== 0: self
.x
= val
1110 elif index
== 1: self
.y
= val
1111 else: raise IndexError
1112 def __nonzero__(self
): return self
.Get() != (0,0)
1113 __safe_for_unpickling__
= True
1114 def __reduce__(self
): return (wx
.Point
, self
.Get())
1116 _core_
.Point_swigregister(Point
)
1118 #---------------------------------------------------------------------------
1122 A class for representing and manipulating rectangles. It has x, y,
1123 width and height properties. In wxPython most palces that expect a
1124 wx.Rect can also accept a (x,y,width,height) tuple.
1126 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1127 __repr__
= _swig_repr
1128 def __init__(self
, *args
, **kwargs
):
1130 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1132 Create a new Rect object.
1134 _core_
.Rect_swiginit(self
,_core_
.new_Rect(*args
, **kwargs
))
1135 __swig_destroy__
= _core_
.delete_Rect
1136 __del__
= lambda self
: None;
1137 def GetX(*args
, **kwargs
):
1138 """GetX(self) -> int"""
1139 return _core_
.Rect_GetX(*args
, **kwargs
)
1141 def SetX(*args
, **kwargs
):
1142 """SetX(self, int x)"""
1143 return _core_
.Rect_SetX(*args
, **kwargs
)
1145 def GetY(*args
, **kwargs
):
1146 """GetY(self) -> int"""
1147 return _core_
.Rect_GetY(*args
, **kwargs
)
1149 def SetY(*args
, **kwargs
):
1150 """SetY(self, int y)"""
1151 return _core_
.Rect_SetY(*args
, **kwargs
)
1153 def GetWidth(*args
, **kwargs
):
1154 """GetWidth(self) -> int"""
1155 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1157 def SetWidth(*args
, **kwargs
):
1158 """SetWidth(self, int w)"""
1159 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1161 def GetHeight(*args
, **kwargs
):
1162 """GetHeight(self) -> int"""
1163 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1165 def SetHeight(*args
, **kwargs
):
1166 """SetHeight(self, int h)"""
1167 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1169 def GetPosition(*args
, **kwargs
):
1170 """GetPosition(self) -> Point"""
1171 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1173 def SetPosition(*args
, **kwargs
):
1174 """SetPosition(self, Point p)"""
1175 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1177 def GetSize(*args
, **kwargs
):
1178 """GetSize(self) -> Size"""
1179 return _core_
.Rect_GetSize(*args
, **kwargs
)
1181 def SetSize(*args
, **kwargs
):
1182 """SetSize(self, Size s)"""
1183 return _core_
.Rect_SetSize(*args
, **kwargs
)
1185 def IsEmpty(*args
, **kwargs
):
1186 """IsEmpty(self) -> bool"""
1187 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1189 def GetTopLeft(*args
, **kwargs
):
1190 """GetTopLeft(self) -> Point"""
1191 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1193 def SetTopLeft(*args
, **kwargs
):
1194 """SetTopLeft(self, Point p)"""
1195 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1197 def GetBottomRight(*args
, **kwargs
):
1198 """GetBottomRight(self) -> Point"""
1199 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1201 def SetBottomRight(*args
, **kwargs
):
1202 """SetBottomRight(self, Point p)"""
1203 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1205 def GetTopRight(*args
, **kwargs
):
1206 """GetTopRight(self) -> Point"""
1207 return _core_
.Rect_GetTopRight(*args
, **kwargs
)
1209 def SetTopRight(*args
, **kwargs
):
1210 """SetTopRight(self, Point p)"""
1211 return _core_
.Rect_SetTopRight(*args
, **kwargs
)
1213 def GetBottomLeft(*args
, **kwargs
):
1214 """GetBottomLeft(self) -> Point"""
1215 return _core_
.Rect_GetBottomLeft(*args
, **kwargs
)
1217 def SetBottomLeft(*args
, **kwargs
):
1218 """SetBottomLeft(self, Point p)"""
1219 return _core_
.Rect_SetBottomLeft(*args
, **kwargs
)
1221 def GetLeft(*args
, **kwargs
):
1222 """GetLeft(self) -> int"""
1223 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1225 def GetTop(*args
, **kwargs
):
1226 """GetTop(self) -> int"""
1227 return _core_
.Rect_GetTop(*args
, **kwargs
)
1229 def GetBottom(*args
, **kwargs
):
1230 """GetBottom(self) -> int"""
1231 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1233 def GetRight(*args
, **kwargs
):
1234 """GetRight(self) -> int"""
1235 return _core_
.Rect_GetRight(*args
, **kwargs
)
1237 def SetLeft(*args
, **kwargs
):
1238 """SetLeft(self, int left)"""
1239 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1241 def SetRight(*args
, **kwargs
):
1242 """SetRight(self, int right)"""
1243 return _core_
.Rect_SetRight(*args
, **kwargs
)
1245 def SetTop(*args
, **kwargs
):
1246 """SetTop(self, int top)"""
1247 return _core_
.Rect_SetTop(*args
, **kwargs
)
1249 def SetBottom(*args
, **kwargs
):
1250 """SetBottom(self, int bottom)"""
1251 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1253 position
= property(GetPosition
, SetPosition
)
1254 size
= property(GetSize
, SetSize
)
1255 left
= property(GetLeft
, SetLeft
)
1256 right
= property(GetRight
, SetRight
)
1257 top
= property(GetTop
, SetTop
)
1258 bottom
= property(GetBottom
, SetBottom
)
1260 def Inflate(*args
, **kwargs
):
1262 Inflate(self, int dx, int dy) -> Rect
1264 Increases the size of the rectangle.
1266 The left border is moved farther left and the right border is moved
1267 farther right by ``dx``. The upper border is moved farther up and the
1268 bottom border is moved farther down by ``dy``. (Note the the width and
1269 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1270 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1271 opposite happens: the rectangle size decreases in the respective
1274 The change is made to the rectangle inplace, if instead you need a
1275 copy that is inflated, preserving the original then make the copy
1278 copy = wx.Rect(*original)
1283 return _core_
.Rect_Inflate(*args
, **kwargs
)
1285 def Deflate(*args
, **kwargs
):
1287 Deflate(self, int dx, int dy) -> Rect
1289 Decrease the rectangle size. This method is the opposite of `Inflate`
1290 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1291 `Inflate` for a full description.
1293 return _core_
.Rect_Deflate(*args
, **kwargs
)
1295 def OffsetXY(*args
, **kwargs
):
1297 OffsetXY(self, int dx, int dy)
1299 Moves the rectangle by the specified offset. If dx is positive, the
1300 rectangle is moved to the right, if dy is positive, it is moved to the
1301 bottom, otherwise it is moved to the left or top respectively.
1303 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1305 def Offset(*args
, **kwargs
):
1307 Offset(self, Point pt)
1309 Same as `OffsetXY` but uses dx,dy from Point
1311 return _core_
.Rect_Offset(*args
, **kwargs
)
1313 def Intersect(*args
, **kwargs
):
1315 Intersect(self, Rect rect) -> Rect
1317 Returns the intersectsion of this rectangle and rect.
1319 return _core_
.Rect_Intersect(*args
, **kwargs
)
1321 def Union(*args
, **kwargs
):
1323 Union(self, Rect rect) -> Rect
1325 Returns the union of this rectangle and rect.
1327 return _core_
.Rect_Union(*args
, **kwargs
)
1329 def __add__(*args
, **kwargs
):
1331 __add__(self, Rect rect) -> Rect
1333 Add the properties of rect to this rectangle and return the result.
1335 return _core_
.Rect___add__(*args
, **kwargs
)
1337 def __iadd__(*args
, **kwargs
):
1339 __iadd__(self, Rect rect) -> Rect
1341 Add the properties of rect to this rectangle, updating this rectangle.
1343 return _core_
.Rect___iadd__(*args
, **kwargs
)
1345 def __eq__(*args
, **kwargs
):
1347 __eq__(self, PyObject other) -> bool
1349 Test for equality of wx.Rect objects.
1351 return _core_
.Rect___eq__(*args
, **kwargs
)
1353 def __ne__(*args
, **kwargs
):
1355 __ne__(self, PyObject other) -> bool
1357 Test for inequality of wx.Rect objects.
1359 return _core_
.Rect___ne__(*args
, **kwargs
)
1361 def ContainsXY(*args
, **kwargs
):
1363 ContainsXY(self, int x, int y) -> bool
1365 Return True if the point is inside the rect.
1367 return _core_
.Rect_ContainsXY(*args
, **kwargs
)
1369 def Contains(*args
, **kwargs
):
1371 Contains(self, Point pt) -> bool
1373 Return True if the point is inside the rect.
1375 return _core_
.Rect_Contains(*args
, **kwargs
)
1377 def ContainsRect(*args
, **kwargs
):
1379 ContainsRect(self, Rect rect) -> bool
1381 Returns ``True`` if the given rectangle is completely inside this
1382 rectangle or touches its boundary.
1384 return _core_
.Rect_ContainsRect(*args
, **kwargs
)
1386 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1387 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1388 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1390 InsideXY
= ContainsXY
1391 InsideRect
= ContainsRect
1393 def Intersects(*args
, **kwargs
):
1395 Intersects(self, Rect rect) -> bool
1397 Returns True if the rectangles have a non empty intersection.
1399 return _core_
.Rect_Intersects(*args
, **kwargs
)
1401 def CenterIn(*args
, **kwargs
):
1403 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1405 Center this rectangle within the one passed to the method, which is
1406 usually, but not necessarily, the larger one.
1408 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1411 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1412 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1413 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1414 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1415 def Set(*args
, **kwargs
):
1417 Set(self, int x=0, int y=0, int width=0, int height=0)
1419 Set all rectangle properties.
1421 return _core_
.Rect_Set(*args
, **kwargs
)
1423 def Get(*args
, **kwargs
):
1425 Get() -> (x,y,width,height)
1427 Return the rectangle properties as a tuple.
1429 return _core_
.Rect_Get(*args
, **kwargs
)
1431 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1432 def __str__(self
): return str(self
.Get())
1433 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1434 def __len__(self
): return len(self
.Get())
1435 def __getitem__(self
, index
): return self
.Get()[index
]
1436 def __setitem__(self
, index
, val
):
1437 if index
== 0: self
.x
= val
1438 elif index
== 1: self
.y
= val
1439 elif index
== 2: self
.width
= val
1440 elif index
== 3: self
.height
= val
1441 else: raise IndexError
1442 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1443 __safe_for_unpickling__
= True
1444 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1446 Bottom
= property(GetBottom
,SetBottom
,doc
="See `GetBottom` and `SetBottom`")
1447 BottomRight
= property(GetBottomRight
,SetBottomRight
,doc
="See `GetBottomRight` and `SetBottomRight`")
1448 BottomLeft
= property(GetBottomLeft
,SetBottomLeft
,doc
="See `GetBottomLeft` and `SetBottomLeft`")
1449 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1450 Left
= property(GetLeft
,SetLeft
,doc
="See `GetLeft` and `SetLeft`")
1451 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
1452 Right
= property(GetRight
,SetRight
,doc
="See `GetRight` and `SetRight`")
1453 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
1454 Top
= property(GetTop
,SetTop
,doc
="See `GetTop` and `SetTop`")
1455 TopLeft
= property(GetTopLeft
,SetTopLeft
,doc
="See `GetTopLeft` and `SetTopLeft`")
1456 TopRight
= property(GetTopRight
,SetTopRight
,doc
="See `GetTopRight` and `SetTopRight`")
1457 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1458 X
= property(GetX
,SetX
,doc
="See `GetX` and `SetX`")
1459 Y
= property(GetY
,SetY
,doc
="See `GetY` and `SetY`")
1460 Empty
= property(IsEmpty
,doc
="See `IsEmpty`")
1461 _core_
.Rect_swigregister(Rect
)
1463 def RectPP(*args
, **kwargs
):
1465 RectPP(Point topLeft, Point bottomRight) -> Rect
1467 Create a new Rect object from Points representing two corners.
1469 val
= _core_
.new_RectPP(*args
, **kwargs
)
1472 def RectPS(*args
, **kwargs
):
1474 RectPS(Point pos, Size size) -> Rect
1476 Create a new Rect from a position and size.
1478 val
= _core_
.new_RectPS(*args
, **kwargs
)
1481 def RectS(*args
, **kwargs
):
1483 RectS(Size size) -> Rect
1485 Create a new Rect from a size only.
1487 val
= _core_
.new_RectS(*args
, **kwargs
)
1491 def IntersectRect(*args
, **kwargs
):
1493 IntersectRect(Rect r1, Rect r2) -> Rect
1495 Calculate and return the intersection of r1 and r2.
1497 return _core_
.IntersectRect(*args
, **kwargs
)
1498 #---------------------------------------------------------------------------
1500 class Point2D(object):
1502 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503 with floating point values.
1505 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1506 __repr__
= _swig_repr
1507 def __init__(self
, *args
, **kwargs
):
1509 __init__(self, double x=0.0, double y=0.0) -> Point2D
1511 Create a w.Point2D object.
1513 _core_
.Point2D_swiginit(self
,_core_
.new_Point2D(*args
, **kwargs
))
1514 __swig_destroy__
= _core_
.delete_Point2D
1515 __del__
= lambda self
: None;
1516 def GetFloor(*args
, **kwargs
):
1522 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1524 def GetRounded(*args
, **kwargs
):
1526 GetRounded() -> (x,y)
1530 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1532 def GetVectorLength(*args
, **kwargs
):
1533 """GetVectorLength(self) -> double"""
1534 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1536 def GetVectorAngle(*args
, **kwargs
):
1537 """GetVectorAngle(self) -> double"""
1538 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1540 def SetVectorLength(*args
, **kwargs
):
1541 """SetVectorLength(self, double length)"""
1542 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1544 def SetVectorAngle(*args
, **kwargs
):
1545 """SetVectorAngle(self, double degrees)"""
1546 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1548 def SetPolarCoordinates(self
, angle
, length
):
1549 self
.SetVectorLength(length
)
1550 self
.SetVectorAngle(angle
)
1551 def Normalize(self
):
1552 self
.SetVectorLength(1.0)
1554 def GetDistance(*args
, **kwargs
):
1555 """GetDistance(self, Point2D pt) -> double"""
1556 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1558 def GetDistanceSquare(*args
, **kwargs
):
1559 """GetDistanceSquare(self, Point2D pt) -> double"""
1560 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1562 def GetDotProduct(*args
, **kwargs
):
1563 """GetDotProduct(self, Point2D vec) -> double"""
1564 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1566 def GetCrossProduct(*args
, **kwargs
):
1567 """GetCrossProduct(self, Point2D vec) -> double"""
1568 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1570 def __neg__(*args
, **kwargs
):
1572 __neg__(self) -> Point2D
1574 the reflection of this point
1576 return _core_
.Point2D___neg__(*args
, **kwargs
)
1578 def __iadd__(*args
, **kwargs
):
1579 """__iadd__(self, Point2D pt) -> Point2D"""
1580 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1582 def __isub__(*args
, **kwargs
):
1583 """__isub__(self, Point2D pt) -> Point2D"""
1584 return _core_
.Point2D___isub__(*args
, **kwargs
)
1586 def __imul__(*args
, **kwargs
):
1587 """__imul__(self, Point2D pt) -> Point2D"""
1588 return _core_
.Point2D___imul__(*args
, **kwargs
)
1590 def __idiv__(*args
, **kwargs
):
1591 """__idiv__(self, Point2D pt) -> Point2D"""
1592 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1594 def __eq__(*args
, **kwargs
):
1596 __eq__(self, PyObject other) -> bool
1598 Test for equality of wx.Point2D objects.
1600 return _core_
.Point2D___eq__(*args
, **kwargs
)
1602 def __ne__(*args
, **kwargs
):
1604 __ne__(self, PyObject other) -> bool
1606 Test for inequality of wx.Point2D objects.
1608 return _core_
.Point2D___ne__(*args
, **kwargs
)
1610 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1611 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1612 def Set(*args
, **kwargs
):
1613 """Set(self, double x=0, double y=0)"""
1614 return _core_
.Point2D_Set(*args
, **kwargs
)
1616 def Get(*args
, **kwargs
):
1620 Return x and y properties as a tuple.
1622 return _core_
.Point2D_Get(*args
, **kwargs
)
1624 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1625 def __str__(self
): return str(self
.Get())
1626 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1627 def __len__(self
): return len(self
.Get())
1628 def __getitem__(self
, index
): return self
.Get()[index
]
1629 def __setitem__(self
, index
, val
):
1630 if index
== 0: self
.x
= val
1631 elif index
== 1: self
.y
= val
1632 else: raise IndexError
1633 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1634 __safe_for_unpickling__
= True
1635 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1637 Floor
= property(GetFloor
,doc
="See `GetFloor`")
1638 Rounded
= property(GetRounded
,doc
="See `GetRounded`")
1639 VectorAngle
= property(GetVectorAngle
,SetVectorAngle
,doc
="See `GetVectorAngle` and `SetVectorAngle`")
1640 VectorLength
= property(GetVectorLength
,SetVectorLength
,doc
="See `GetVectorLength` and `SetVectorLength`")
1641 _core_
.Point2D_swigregister(Point2D
)
1643 def Point2DCopy(*args
, **kwargs
):
1645 Point2DCopy(Point2D pt) -> Point2D
1647 Create a w.Point2D object.
1649 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1652 def Point2DFromPoint(*args
, **kwargs
):
1654 Point2DFromPoint(Point pt) -> Point2D
1656 Create a w.Point2D object.
1658 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1661 #---------------------------------------------------------------------------
1663 Inside
= _core_
.Inside
1664 OutLeft
= _core_
.OutLeft
1665 OutRight
= _core_
.OutRight
1666 OutTop
= _core_
.OutTop
1667 OutBottom
= _core_
.OutBottom
1668 class Rect2D(object):
1670 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1671 with floating point component values.
1673 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1674 __repr__
= _swig_repr
1675 def __init__(self
, *args
, **kwargs
):
1677 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1679 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1680 with floating point component values.
1682 _core_
.Rect2D_swiginit(self
,_core_
.new_Rect2D(*args
, **kwargs
))
1683 __swig_destroy__
= _core_
.delete_Rect2D
1684 __del__
= lambda self
: None;
1685 def GetPosition(*args
, **kwargs
):
1686 """GetPosition(self) -> Point2D"""
1687 return _core_
.Rect2D_GetPosition(*args
, **kwargs
)
1689 def GetSize(*args
, **kwargs
):
1690 """GetSize(self) -> Size"""
1691 return _core_
.Rect2D_GetSize(*args
, **kwargs
)
1693 def GetLeft(*args
, **kwargs
):
1694 """GetLeft(self) -> wxDouble"""
1695 return _core_
.Rect2D_GetLeft(*args
, **kwargs
)
1697 def SetLeft(*args
, **kwargs
):
1698 """SetLeft(self, wxDouble n)"""
1699 return _core_
.Rect2D_SetLeft(*args
, **kwargs
)
1701 def MoveLeftTo(*args
, **kwargs
):
1702 """MoveLeftTo(self, wxDouble n)"""
1703 return _core_
.Rect2D_MoveLeftTo(*args
, **kwargs
)
1705 def GetTop(*args
, **kwargs
):
1706 """GetTop(self) -> wxDouble"""
1707 return _core_
.Rect2D_GetTop(*args
, **kwargs
)
1709 def SetTop(*args
, **kwargs
):
1710 """SetTop(self, wxDouble n)"""
1711 return _core_
.Rect2D_SetTop(*args
, **kwargs
)
1713 def MoveTopTo(*args
, **kwargs
):
1714 """MoveTopTo(self, wxDouble n)"""
1715 return _core_
.Rect2D_MoveTopTo(*args
, **kwargs
)
1717 def GetBottom(*args
, **kwargs
):
1718 """GetBottom(self) -> wxDouble"""
1719 return _core_
.Rect2D_GetBottom(*args
, **kwargs
)
1721 def SetBottom(*args
, **kwargs
):
1722 """SetBottom(self, wxDouble n)"""
1723 return _core_
.Rect2D_SetBottom(*args
, **kwargs
)
1725 def MoveBottomTo(*args
, **kwargs
):
1726 """MoveBottomTo(self, wxDouble n)"""
1727 return _core_
.Rect2D_MoveBottomTo(*args
, **kwargs
)
1729 def GetRight(*args
, **kwargs
):
1730 """GetRight(self) -> wxDouble"""
1731 return _core_
.Rect2D_GetRight(*args
, **kwargs
)
1733 def SetRight(*args
, **kwargs
):
1734 """SetRight(self, wxDouble n)"""
1735 return _core_
.Rect2D_SetRight(*args
, **kwargs
)
1737 def MoveRightTo(*args
, **kwargs
):
1738 """MoveRightTo(self, wxDouble n)"""
1739 return _core_
.Rect2D_MoveRightTo(*args
, **kwargs
)
1741 def GetLeftTop(*args
, **kwargs
):
1742 """GetLeftTop(self) -> Point2D"""
1743 return _core_
.Rect2D_GetLeftTop(*args
, **kwargs
)
1745 def SetLeftTop(*args
, **kwargs
):
1746 """SetLeftTop(self, Point2D pt)"""
1747 return _core_
.Rect2D_SetLeftTop(*args
, **kwargs
)
1749 def MoveLeftTopTo(*args
, **kwargs
):
1750 """MoveLeftTopTo(self, Point2D pt)"""
1751 return _core_
.Rect2D_MoveLeftTopTo(*args
, **kwargs
)
1753 def GetLeftBottom(*args
, **kwargs
):
1754 """GetLeftBottom(self) -> Point2D"""
1755 return _core_
.Rect2D_GetLeftBottom(*args
, **kwargs
)
1757 def SetLeftBottom(*args
, **kwargs
):
1758 """SetLeftBottom(self, Point2D pt)"""
1759 return _core_
.Rect2D_SetLeftBottom(*args
, **kwargs
)
1761 def MoveLeftBottomTo(*args
, **kwargs
):
1762 """MoveLeftBottomTo(self, Point2D pt)"""
1763 return _core_
.Rect2D_MoveLeftBottomTo(*args
, **kwargs
)
1765 def GetRightTop(*args
, **kwargs
):
1766 """GetRightTop(self) -> Point2D"""
1767 return _core_
.Rect2D_GetRightTop(*args
, **kwargs
)
1769 def SetRightTop(*args
, **kwargs
):
1770 """SetRightTop(self, Point2D pt)"""
1771 return _core_
.Rect2D_SetRightTop(*args
, **kwargs
)
1773 def MoveRightTopTo(*args
, **kwargs
):
1774 """MoveRightTopTo(self, Point2D pt)"""
1775 return _core_
.Rect2D_MoveRightTopTo(*args
, **kwargs
)
1777 def GetRightBottom(*args
, **kwargs
):
1778 """GetRightBottom(self) -> Point2D"""
1779 return _core_
.Rect2D_GetRightBottom(*args
, **kwargs
)
1781 def SetRightBottom(*args
, **kwargs
):
1782 """SetRightBottom(self, Point2D pt)"""
1783 return _core_
.Rect2D_SetRightBottom(*args
, **kwargs
)
1785 def MoveRightBottomTo(*args
, **kwargs
):
1786 """MoveRightBottomTo(self, Point2D pt)"""
1787 return _core_
.Rect2D_MoveRightBottomTo(*args
, **kwargs
)
1789 def GetCentre(*args
, **kwargs
):
1790 """GetCentre(self) -> Point2D"""
1791 return _core_
.Rect2D_GetCentre(*args
, **kwargs
)
1793 def SetCentre(*args
, **kwargs
):
1794 """SetCentre(self, Point2D pt)"""
1795 return _core_
.Rect2D_SetCentre(*args
, **kwargs
)
1797 def MoveCentreTo(*args
, **kwargs
):
1798 """MoveCentreTo(self, Point2D pt)"""
1799 return _core_
.Rect2D_MoveCentreTo(*args
, **kwargs
)
1801 def GetOutcode(*args
, **kwargs
):
1802 """GetOutcode(self, Point2D pt) -> int"""
1803 return _core_
.Rect2D_GetOutcode(*args
, **kwargs
)
1805 def Contains(*args
, **kwargs
):
1806 """Contains(self, Point2D pt) -> bool"""
1807 return _core_
.Rect2D_Contains(*args
, **kwargs
)
1809 def ContainsRect(*args
, **kwargs
):
1810 """ContainsRect(self, Rect2D rect) -> bool"""
1811 return _core_
.Rect2D_ContainsRect(*args
, **kwargs
)
1813 def IsEmpty(*args
, **kwargs
):
1814 """IsEmpty(self) -> bool"""
1815 return _core_
.Rect2D_IsEmpty(*args
, **kwargs
)
1817 def HaveEqualSize(*args
, **kwargs
):
1818 """HaveEqualSize(self, Rect2D rect) -> bool"""
1819 return _core_
.Rect2D_HaveEqualSize(*args
, **kwargs
)
1823 Inset(self, wxDouble x, wxDouble y)
1824 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1826 return _core_
.Rect2D_Inset(*args
)
1828 def Offset(*args
, **kwargs
):
1829 """Offset(self, Point2D pt)"""
1830 return _core_
.Rect2D_Offset(*args
, **kwargs
)
1832 def ConstrainTo(*args
, **kwargs
):
1833 """ConstrainTo(self, Rect2D rect)"""
1834 return _core_
.Rect2D_ConstrainTo(*args
, **kwargs
)
1836 def Interpolate(*args
, **kwargs
):
1837 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1838 return _core_
.Rect2D_Interpolate(*args
, **kwargs
)
1840 def Intersect(*args
, **kwargs
):
1841 """Intersect(self, Rect2D otherRect)"""
1842 return _core_
.Rect2D_Intersect(*args
, **kwargs
)
1844 def CreateIntersection(*args
, **kwargs
):
1845 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1846 return _core_
.Rect2D_CreateIntersection(*args
, **kwargs
)
1848 def Intersects(*args
, **kwargs
):
1849 """Intersects(self, Rect2D rect) -> bool"""
1850 return _core_
.Rect2D_Intersects(*args
, **kwargs
)
1852 def Union(*args
, **kwargs
):
1853 """Union(self, Rect2D otherRect)"""
1854 return _core_
.Rect2D_Union(*args
, **kwargs
)
1856 def CreateUnion(*args
, **kwargs
):
1857 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1858 return _core_
.Rect2D_CreateUnion(*args
, **kwargs
)
1862 Scale(self, wxDouble f)
1863 Scale(self, int num, int denum)
1865 return _core_
.Rect2D_Scale(*args
)
1867 def __eq__(*args
, **kwargs
):
1869 __eq__(self, PyObject other) -> bool
1871 Test for equality of wx.Rect2D objects.
1873 return _core_
.Rect2D___eq__(*args
, **kwargs
)
1875 def __ne__(*args
, **kwargs
):
1877 __ne__(self, PyObject other) -> bool
1879 Test for inequality of wx.Rect2D objects.
1881 return _core_
.Rect2D___ne__(*args
, **kwargs
)
1883 x
= property(_core_
.Rect2D_x_get
, _core_
.Rect2D_x_set
)
1884 y
= property(_core_
.Rect2D_y_get
, _core_
.Rect2D_y_set
)
1885 width
= property(_core_
.Rect2D_width_get
, _core_
.Rect2D_width_set
)
1886 height
= property(_core_
.Rect2D_height_get
, _core_
.Rect2D_height_set
)
1887 def Set(*args
, **kwargs
):
1888 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1889 return _core_
.Rect2D_Set(*args
, **kwargs
)
1891 def Get(*args
, **kwargs
):
1893 Get() -> (x,y, width, height)
1895 Return x, y, width and height y properties as a tuple.
1897 return _core_
.Rect2D_Get(*args
, **kwargs
)
1899 def __str__(self
): return str(self
.Get())
1900 def __repr__(self
): return 'wx.Rect2D'+str(self
.Get())
1901 def __len__(self
): return len(self
.Get())
1902 def __getitem__(self
, index
): return self
.Get()[index
]
1903 def __setitem__(self
, index
, val
):
1904 if index
== 0: self
.x
= val
1905 elif index
== 1: self
.y
= val
1906 elif index
== 2: self
.width
= val
1907 elif index
== 3: self
.height
= val
1908 else: raise IndexError
1909 def __nonzero__(self
): return self
.Get() != (0.0, 0.0, 0.0, 0.0)
1910 __safe_for_unpickling__
= True
1911 def __reduce__(self
): return (wx
.Rect2D
, self
.Get())
1913 _core_
.Rect2D_swigregister(Rect2D
)
1915 #---------------------------------------------------------------------------
1917 FromStart
= _core_
.FromStart
1918 FromCurrent
= _core_
.FromCurrent
1919 FromEnd
= _core_
.FromEnd
1920 class InputStream(object):
1921 """Proxy of C++ InputStream class"""
1922 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1923 __repr__
= _swig_repr
1924 def __init__(self
, *args
, **kwargs
):
1925 """__init__(self, PyObject p) -> InputStream"""
1926 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1927 __swig_destroy__
= _core_
.delete_InputStream
1928 __del__
= lambda self
: None;
1929 def close(*args
, **kwargs
):
1931 return _core_
.InputStream_close(*args
, **kwargs
)
1933 def flush(*args
, **kwargs
):
1935 return _core_
.InputStream_flush(*args
, **kwargs
)
1937 def eof(*args
, **kwargs
):
1938 """eof(self) -> bool"""
1939 return _core_
.InputStream_eof(*args
, **kwargs
)
1941 def read(*args
, **kwargs
):
1942 """read(self, int size=-1) -> PyObject"""
1943 return _core_
.InputStream_read(*args
, **kwargs
)
1945 def readline(*args
, **kwargs
):
1946 """readline(self, int size=-1) -> PyObject"""
1947 return _core_
.InputStream_readline(*args
, **kwargs
)
1949 def readlines(*args
, **kwargs
):
1950 """readlines(self, int sizehint=-1) -> PyObject"""
1951 return _core_
.InputStream_readlines(*args
, **kwargs
)
1953 def seek(*args
, **kwargs
):
1954 """seek(self, int offset, int whence=0)"""
1955 return _core_
.InputStream_seek(*args
, **kwargs
)
1957 def tell(*args
, **kwargs
):
1958 """tell(self) -> int"""
1959 return _core_
.InputStream_tell(*args
, **kwargs
)
1961 def Peek(*args
, **kwargs
):
1962 """Peek(self) -> char"""
1963 return _core_
.InputStream_Peek(*args
, **kwargs
)
1965 def GetC(*args
, **kwargs
):
1966 """GetC(self) -> char"""
1967 return _core_
.InputStream_GetC(*args
, **kwargs
)
1969 def LastRead(*args
, **kwargs
):
1970 """LastRead(self) -> size_t"""
1971 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1973 def CanRead(*args
, **kwargs
):
1974 """CanRead(self) -> bool"""
1975 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1977 def Eof(*args
, **kwargs
):
1978 """Eof(self) -> bool"""
1979 return _core_
.InputStream_Eof(*args
, **kwargs
)
1981 def Ungetch(*args
, **kwargs
):
1982 """Ungetch(self, char c) -> bool"""
1983 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1985 def SeekI(*args
, **kwargs
):
1986 """SeekI(self, long pos, int mode=FromStart) -> long"""
1987 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1989 def TellI(*args
, **kwargs
):
1990 """TellI(self) -> long"""
1991 return _core_
.InputStream_TellI(*args
, **kwargs
)
1993 _core_
.InputStream_swigregister(InputStream
)
1994 DefaultPosition
= cvar
.DefaultPosition
1995 DefaultSize
= cvar
.DefaultSize
1997 class OutputStream(object):
1998 """Proxy of C++ OutputStream class"""
1999 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2000 def __init__(self
): raise AttributeError, "No constructor defined"
2001 __repr__
= _swig_repr
2002 def write(*args
, **kwargs
):
2003 """write(self, PyObject obj)"""
2004 return _core_
.OutputStream_write(*args
, **kwargs
)
2006 def LastWrite(*args
, **kwargs
):
2007 """LastWrite(self) -> size_t"""
2008 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
2010 _core_
.OutputStream_swigregister(OutputStream
)
2012 #---------------------------------------------------------------------------
2014 class FSFile(Object
):
2015 """Proxy of C++ FSFile class"""
2016 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2017 __repr__
= _swig_repr
2018 def __init__(self
, *args
, **kwargs
):
2020 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2021 DateTime modif) -> FSFile
2023 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
2024 __swig_destroy__
= _core_
.delete_FSFile
2025 __del__
= lambda self
: None;
2026 def GetStream(*args
, **kwargs
):
2027 """GetStream(self) -> InputStream"""
2028 return _core_
.FSFile_GetStream(*args
, **kwargs
)
2030 def DetachStream(*args
, **kwargs
):
2031 """DetachStream(self)"""
2032 return _core_
.FSFile_DetachStream(*args
, **kwargs
)
2034 def GetMimeType(*args
, **kwargs
):
2035 """GetMimeType(self) -> String"""
2036 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
2038 def GetLocation(*args
, **kwargs
):
2039 """GetLocation(self) -> String"""
2040 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
2042 def GetAnchor(*args
, **kwargs
):
2043 """GetAnchor(self) -> String"""
2044 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
2046 def GetModificationTime(*args
, **kwargs
):
2047 """GetModificationTime(self) -> DateTime"""
2048 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
2050 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2051 Location
= property(GetLocation
,doc
="See `GetLocation`")
2052 MimeType
= property(GetMimeType
,doc
="See `GetMimeType`")
2053 ModificationTime
= property(GetModificationTime
,doc
="See `GetModificationTime`")
2054 Stream
= property(GetStream
,doc
="See `GetStream`")
2055 _core_
.FSFile_swigregister(FSFile
)
2057 class CPPFileSystemHandler(object):
2058 """Proxy of C++ CPPFileSystemHandler class"""
2059 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2060 def __init__(self
): raise AttributeError, "No constructor defined"
2061 __repr__
= _swig_repr
2062 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
2063 __del__
= lambda self
: None;
2064 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
2066 class FileSystemHandler(CPPFileSystemHandler
):
2067 """Proxy of C++ FileSystemHandler class"""
2068 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2069 __repr__
= _swig_repr
2070 def __init__(self
, *args
, **kwargs
):
2071 """__init__(self) -> FileSystemHandler"""
2072 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
2073 self
._setCallbackInfo
(self
, FileSystemHandler
)
2075 def _setCallbackInfo(*args
, **kwargs
):
2076 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2077 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
2079 def CanOpen(*args
, **kwargs
):
2080 """CanOpen(self, String location) -> bool"""
2081 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
2083 def OpenFile(*args
, **kwargs
):
2084 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2085 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
2087 def FindFirst(*args
, **kwargs
):
2088 """FindFirst(self, String spec, int flags=0) -> String"""
2089 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
2091 def FindNext(*args
, **kwargs
):
2092 """FindNext(self) -> String"""
2093 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
2095 def GetProtocol(*args
, **kwargs
):
2096 """GetProtocol(self, String location) -> String"""
2097 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
2099 def GetLeftLocation(*args
, **kwargs
):
2100 """GetLeftLocation(self, String location) -> String"""
2101 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
2103 def GetAnchor(*args
, **kwargs
):
2104 """GetAnchor(self, String location) -> String"""
2105 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
2107 def GetRightLocation(*args
, **kwargs
):
2108 """GetRightLocation(self, String location) -> String"""
2109 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
2111 def GetMimeTypeFromExt(*args
, **kwargs
):
2112 """GetMimeTypeFromExt(self, String location) -> String"""
2113 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
2115 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2116 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
2117 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
2118 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
2119 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
2120 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
2122 class FileSystem(Object
):
2123 """Proxy of C++ FileSystem class"""
2124 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2125 __repr__
= _swig_repr
2126 def __init__(self
, *args
, **kwargs
):
2127 """__init__(self) -> FileSystem"""
2128 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
2129 __swig_destroy__
= _core_
.delete_FileSystem
2130 __del__
= lambda self
: None;
2131 def ChangePathTo(*args
, **kwargs
):
2132 """ChangePathTo(self, String location, bool is_dir=False)"""
2133 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
2135 def GetPath(*args
, **kwargs
):
2136 """GetPath(self) -> String"""
2137 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
2139 def OpenFile(*args
, **kwargs
):
2140 """OpenFile(self, String location) -> FSFile"""
2141 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
2143 def FindFirst(*args
, **kwargs
):
2144 """FindFirst(self, String spec, int flags=0) -> String"""
2145 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
2147 def FindNext(*args
, **kwargs
):
2148 """FindNext(self) -> String"""
2149 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
2151 def AddHandler(*args
, **kwargs
):
2152 """AddHandler(CPPFileSystemHandler handler)"""
2153 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2155 AddHandler
= staticmethod(AddHandler
)
2156 def RemoveHandler(*args
, **kwargs
):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2160 RemoveHandler
= staticmethod(RemoveHandler
)
2161 def CleanUpHandlers(*args
, **kwargs
):
2162 """CleanUpHandlers()"""
2163 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
2165 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
2166 def FileNameToURL(*args
, **kwargs
):
2167 """FileNameToURL(String filename) -> String"""
2168 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2170 FileNameToURL
= staticmethod(FileNameToURL
)
2171 def URLToFileName(*args
, **kwargs
):
2172 """URLToFileName(String url) -> String"""
2173 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2175 URLToFileName
= staticmethod(URLToFileName
)
2176 Path
= property(GetPath
,doc
="See `GetPath`")
2177 _core_
.FileSystem_swigregister(FileSystem
)
2179 def FileSystem_AddHandler(*args
, **kwargs
):
2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2183 def FileSystem_RemoveHandler(*args
, **kwargs
):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2187 def FileSystem_CleanUpHandlers(*args
):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_
.FileSystem_CleanUpHandlers(*args
)
2191 def FileSystem_FileNameToURL(*args
, **kwargs
):
2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2195 def FileSystem_URLToFileName(*args
, **kwargs
):
2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2199 class InternetFSHandler(CPPFileSystemHandler
):
2200 """Proxy of C++ InternetFSHandler class"""
2201 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2202 __repr__
= _swig_repr
2203 def __init__(self
, *args
, **kwargs
):
2204 """__init__(self) -> InternetFSHandler"""
2205 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
2206 def CanOpen(*args
, **kwargs
):
2207 """CanOpen(self, String location) -> bool"""
2208 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
2210 def OpenFile(*args
, **kwargs
):
2211 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2212 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
2214 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
2216 class ZipFSHandler(CPPFileSystemHandler
):
2217 """Proxy of C++ ZipFSHandler class"""
2218 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2219 __repr__
= _swig_repr
2220 def __init__(self
, *args
, **kwargs
):
2221 """__init__(self) -> ZipFSHandler"""
2222 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
2223 def CanOpen(*args
, **kwargs
):
2224 """CanOpen(self, String location) -> bool"""
2225 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
2227 def OpenFile(*args
, **kwargs
):
2228 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2229 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
2231 def FindFirst(*args
, **kwargs
):
2232 """FindFirst(self, String spec, int flags=0) -> String"""
2233 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
2235 def FindNext(*args
, **kwargs
):
2236 """FindNext(self) -> String"""
2237 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
2239 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
2242 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
2246 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
2250 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
2253 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
2255 Add 'file' to the memory filesystem. The dataItem parameter can
2256 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257 arbitrary data. If a bitmap or image is used then the imgType
2258 parameter should specify what kind of image file it should be
2259 written as, wx.BITMAP_TYPE_PNG, etc.
2261 if isinstance(dataItem
, wx
.Image
):
2262 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
2263 elif isinstance(dataItem
, wx
.Bitmap
):
2264 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2265 elif type(dataItem
) == str:
2266 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2268 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2270 class MemoryFSHandler(CPPFileSystemHandler
):
2271 """Proxy of C++ MemoryFSHandler class"""
2272 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2273 __repr__
= _swig_repr
2274 def __init__(self
, *args
, **kwargs
):
2275 """__init__(self) -> MemoryFSHandler"""
2276 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
2277 def RemoveFile(*args
, **kwargs
):
2278 """RemoveFile(String filename)"""
2279 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2281 RemoveFile
= staticmethod(RemoveFile
)
2282 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2283 def CanOpen(*args
, **kwargs
):
2284 """CanOpen(self, String location) -> bool"""
2285 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2287 def OpenFile(*args
, **kwargs
):
2288 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2289 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2291 def FindFirst(*args
, **kwargs
):
2292 """FindFirst(self, String spec, int flags=0) -> String"""
2293 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2295 def FindNext(*args
, **kwargs
):
2296 """FindNext(self) -> String"""
2297 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2299 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2301 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2305 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2306 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2307 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2308 IMAGE_QUALITY_NORMAL
= _core_
.IMAGE_QUALITY_NORMAL
2309 IMAGE_QUALITY_HIGH
= _core_
.IMAGE_QUALITY_HIGH
2310 #---------------------------------------------------------------------------
2312 class ImageHandler(Object
):
2314 This is the base class for implementing image file loading/saving, and
2315 image creation from data. It is used within `wx.Image` and is not
2316 normally seen by the application.
2318 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2319 def __init__(self
): raise AttributeError, "No constructor defined"
2320 __repr__
= _swig_repr
2321 def GetName(*args
, **kwargs
):
2322 """GetName(self) -> String"""
2323 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2325 def GetExtension(*args
, **kwargs
):
2326 """GetExtension(self) -> String"""
2327 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2329 def GetType(*args
, **kwargs
):
2330 """GetType(self) -> long"""
2331 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2333 def GetMimeType(*args
, **kwargs
):
2334 """GetMimeType(self) -> String"""
2335 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2337 def CanRead(*args
, **kwargs
):
2338 """CanRead(self, String name) -> bool"""
2339 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2341 def CanReadStream(*args
, **kwargs
):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2345 def SetName(*args
, **kwargs
):
2346 """SetName(self, String name)"""
2347 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2349 def SetExtension(*args
, **kwargs
):
2350 """SetExtension(self, String extension)"""
2351 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2353 def SetType(*args
, **kwargs
):
2354 """SetType(self, long type)"""
2355 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2357 def SetMimeType(*args
, **kwargs
):
2358 """SetMimeType(self, String mimetype)"""
2359 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2361 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2362 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2363 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2364 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2365 _core_
.ImageHandler_swigregister(ImageHandler
)
2367 class PyImageHandler(ImageHandler
):
2369 This is the base class for implementing image file loading/saving, and
2370 image creation from data, all written in Python. To create a custom
2371 image handler derive a new class from wx.PyImageHandler and provide
2372 the following methods::
2374 def DoCanRead(self, stream) --> bool
2375 '''Check if this handler can read the image on the stream'''
2377 def LoadFile(self, image, stream, verbose, index) --> bool
2378 '''Load image data from the stream and load it into image.'''
2380 def SaveFile(self, image, stream, verbose) --> bool
2381 '''Save the iamge data in image to the stream using
2382 this handler's image file format.'''
2384 def GetImageCount(self, stream) --> int
2385 '''If this image format can hold more than one image,
2386 how many does the image on the stream have?'''
2388 To activate your handler create an instance of it and pass it to
2389 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2390 `SetExtension` from your constructor.
2393 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2394 __repr__
= _swig_repr
2395 def __init__(self
, *args
, **kwargs
):
2397 __init__(self) -> PyImageHandler
2399 This is the base class for implementing image file loading/saving, and
2400 image creation from data, all written in Python. To create a custom
2401 image handler derive a new class from wx.PyImageHandler and provide
2402 the following methods::
2404 def DoCanRead(self, stream) --> bool
2405 '''Check if this handler can read the image on the stream'''
2407 def LoadFile(self, image, stream, verbose, index) --> bool
2408 '''Load image data from the stream and load it into image.'''
2410 def SaveFile(self, image, stream, verbose) --> bool
2411 '''Save the iamge data in image to the stream using
2412 this handler's image file format.'''
2414 def GetImageCount(self, stream) --> int
2415 '''If this image format can hold more than one image,
2416 how many does the image on the stream have?'''
2418 To activate your handler create an instance of it and pass it to
2419 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2420 `SetExtension` from your constructor.
2423 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2426 def _SetSelf(*args
, **kwargs
):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2430 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2432 class ImageHistogram(object):
2433 """Proxy of C++ ImageHistogram class"""
2434 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2435 __repr__
= _swig_repr
2436 def __init__(self
, *args
, **kwargs
):
2437 """__init__(self) -> ImageHistogram"""
2438 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2439 def MakeKey(*args
, **kwargs
):
2441 MakeKey(byte r, byte g, byte b) -> unsigned long
2443 Get the key in the histogram for the given RGB values
2445 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2447 MakeKey
= staticmethod(MakeKey
)
2448 def FindFirstUnusedColour(*args
, **kwargs
):
2450 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2452 Find first colour that is not used in the image and has higher RGB
2453 values than startR, startG, startB. Returns a tuple consisting of a
2454 success flag and rgb values.
2456 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2458 def GetCount(*args
, **kwargs
):
2460 GetCount(self, unsigned long key) -> unsigned long
2462 Returns the pixel count for the given key. Use `MakeKey` to create a
2463 key value from a RGB tripple.
2465 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2467 def GetCountRGB(*args
, **kwargs
):
2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2471 Returns the pixel count for the given RGB values.
2473 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2475 def GetCountColour(*args
, **kwargs
):
2477 GetCountColour(self, Colour colour) -> unsigned long
2479 Returns the pixel count for the given `wx.Colour` value.
2481 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2483 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2485 def ImageHistogram_MakeKey(*args
, **kwargs
):
2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2489 Get the key in the histogram for the given RGB values
2491 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2493 class Image_RGBValue(object):
2495 An object that contains values for red, green and blue which represent
2496 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2500 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2501 __repr__
= _swig_repr
2502 def __init__(self
, *args
, **kwargs
):
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2508 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2509 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2510 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2511 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2512 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2514 class Image_HSVValue(object):
2516 An object that contains values for hue, saturation and value which
2517 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2518 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2521 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2522 __repr__
= _swig_repr
2523 def __init__(self
, *args
, **kwargs
):
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2529 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2530 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2531 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2532 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2533 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2535 class Image(Object
):
2537 A platform-independent image class. An image can be created from
2538 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539 variety of formats. Functions are available to set and get image
2540 bits, so it can be used for basic image manipulation.
2542 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2543 platform-specific `wx.Bitmap` object must be created from it using the
2544 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545 device context, using `wx.DC.DrawBitmap`.
2547 One colour value of the image may be used as a mask colour which will
2548 lead to the automatic creation of a `wx.Mask` object associated to the
2551 wx.Image supports alpha channel data, that is in addition to a byte
2552 for the red, green and blue colour components for each pixel it also
2553 stores a byte representing the pixel opacity. An alpha value of 0
2554 corresponds to a transparent pixel (null opacity) while a value of 255
2555 means that the pixel is 100% opaque.
2557 Unlike RGB data, not all images have an alpha channel and before using
2558 `GetAlpha` you should check if this image contains an alpha channel
2559 with `HasAlpha`. Note that currently only images loaded from PNG files
2560 with transparency information will have an alpha channel.
2562 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2563 __repr__
= _swig_repr
2564 def __init__(self
, *args
, **kwargs
):
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2568 Loads an image from a file.
2570 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2571 __swig_destroy__
= _core_
.delete_Image
2572 __del__
= lambda self
: None;
2573 def Create(*args
, **kwargs
):
2575 Create(self, int width, int height, bool clear=True)
2577 Creates a fresh image. If clear is ``True``, the new image will be
2578 initialized to black. Otherwise, the image data will be uninitialized.
2580 return _core_
.Image_Create(*args
, **kwargs
)
2582 def Destroy(*args
, **kwargs
):
2586 Destroys the image data.
2588 args
[0].this
.own(False)
2589 return _core_
.Image_Destroy(*args
, **kwargs
)
2591 def Scale(*args
, **kwargs
):
2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2595 Returns a scaled version of the image. This is also useful for scaling
2596 bitmaps in general as the only other way to scale bitmaps is to blit a
2597 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2598 specifies what method to use for resampling the image. It can be
2599 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601 bicubic and box averaging resampling methods for upsampling and
2602 downsampling respectively.
2604 return _core_
.Image_Scale(*args
, **kwargs
)
2606 def ResampleBox(*args
, **kwargs
):
2607 """ResampleBox(self, int width, int height) -> Image"""
2608 return _core_
.Image_ResampleBox(*args
, **kwargs
)
2610 def ResampleBicubic(*args
, **kwargs
):
2611 """ResampleBicubic(self, int width, int height) -> Image"""
2612 return _core_
.Image_ResampleBicubic(*args
, **kwargs
)
2614 def Blur(*args
, **kwargs
):
2616 Blur(self, int radius) -> Image
2618 Blurs the image in both horizontal and vertical directions by the
2619 specified pixel ``radius``. This should not be used when using a
2620 single mask colour for transparency.
2622 return _core_
.Image_Blur(*args
, **kwargs
)
2624 def BlurHorizontal(*args
, **kwargs
):
2626 BlurHorizontal(self, int radius) -> Image
2628 Blurs the image in the horizontal direction only. This should not be
2629 used when using a single mask colour for transparency.
2632 return _core_
.Image_BlurHorizontal(*args
, **kwargs
)
2634 def BlurVertical(*args
, **kwargs
):
2636 BlurVertical(self, int radius) -> Image
2638 Blurs the image in the vertical direction only. This should not be
2639 used when using a single mask colour for transparency.
2641 return _core_
.Image_BlurVertical(*args
, **kwargs
)
2643 def ShrinkBy(*args
, **kwargs
):
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2647 Return a version of the image scaled smaller by the given factors.
2649 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2651 def Rescale(*args
, **kwargs
):
2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2655 Changes the size of the image in-place by scaling it: after a call to
2656 this function, the image will have the given width and height.
2658 Returns the (modified) image itself.
2660 return _core_
.Image_Rescale(*args
, **kwargs
)
2662 def Resize(*args
, **kwargs
):
2664 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2666 Changes the size of the image in-place without scaling it, by adding
2667 either a border with the given colour or cropping as necessary. The
2668 image is pasted into a new image with the given size and background
2669 colour at the position pos relative to the upper left of the new
2670 image. If red = green = blue = -1 then use either the current mask
2671 colour if set or find, use, and set a suitable mask colour for any
2672 newly exposed areas.
2674 Returns the (modified) image itself.
2676 return _core_
.Image_Resize(*args
, **kwargs
)
2678 def SetRGB(*args
, **kwargs
):
2680 SetRGB(self, int x, int y, byte r, byte g, byte b)
2682 Sets the pixel at the given coordinate. This routine performs
2683 bounds-checks for the coordinate so it can be considered a safe way to
2684 manipulate the data, but in some cases this might be too slow so that
2685 the data will have to be set directly. In that case you will have to
2686 get access to the image data using the `GetData` method.
2688 return _core_
.Image_SetRGB(*args
, **kwargs
)
2690 def SetRGBRect(*args
, **kwargs
):
2692 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2694 Sets the colour of the pixels within the given rectangle. This routine
2695 performs bounds-checks for the rectangle so it can be considered a
2696 safe way to manipulate the data.
2698 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2700 def GetRed(*args
, **kwargs
):
2702 GetRed(self, int x, int y) -> byte
2704 Returns the red intensity at the given coordinate.
2706 return _core_
.Image_GetRed(*args
, **kwargs
)
2708 def GetGreen(*args
, **kwargs
):
2710 GetGreen(self, int x, int y) -> byte
2712 Returns the green intensity at the given coordinate.
2714 return _core_
.Image_GetGreen(*args
, **kwargs
)
2716 def GetBlue(*args
, **kwargs
):
2718 GetBlue(self, int x, int y) -> byte
2720 Returns the blue intensity at the given coordinate.
2722 return _core_
.Image_GetBlue(*args
, **kwargs
)
2724 def SetAlpha(*args
, **kwargs
):
2726 SetAlpha(self, int x, int y, byte alpha)
2728 Sets the alpha value for the given pixel. This function should only be
2729 called if the image has alpha channel data, use `HasAlpha` to check
2732 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2734 def GetAlpha(*args
, **kwargs
):
2736 GetAlpha(self, int x, int y) -> byte
2738 Returns the alpha value for the given pixel. This function may only be
2739 called for the images with alpha channel, use `HasAlpha` to check for
2742 The returned value is the *opacity* of the image, i.e. the value of 0
2743 corresponds to the fully transparent pixels while the value of 255 to
2744 the fully opaque pixels.
2746 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2748 def HasAlpha(*args
, **kwargs
):
2750 HasAlpha(self) -> bool
2752 Returns true if this image has alpha channel, false otherwise.
2754 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2756 def InitAlpha(*args
, **kwargs
):
2760 Initializes the image alpha channel data. It is an error to call it if
2761 the image already has alpha data. If it doesn't, alpha data will be by
2762 default initialized to all pixels being fully opaque. But if the image
2763 has a a mask colour, all mask pixels will be completely transparent.
2765 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2767 def IsTransparent(*args
, **kwargs
):
2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
2774 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2776 def FindFirstUnusedColour(*args
, **kwargs
):
2778 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2780 Find first colour that is not used in the image and has higher RGB
2781 values than startR, startG, startB. Returns a tuple consisting of a
2782 success flag and rgb values.
2784 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2786 def ConvertAlphaToMask(*args
, **kwargs
):
2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2790 If the image has alpha channel, this method converts it to mask. All
2791 pixels with alpha value less than ``threshold`` are replaced with the
2792 mask colour and the alpha channel is removed. The mask colour is
2793 chosen automatically using `FindFirstUnusedColour`.
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2798 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2800 def ConvertColourToAlpha(*args
, **kwargs
):
2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2804 This method converts an image where the original alpha information is
2805 only available as a shades of a colour (actually shades of grey)
2806 typically when you draw anti-aliased text into a bitmap. The DC
2807 drawing routines draw grey values on the black background although
2808 they actually mean to draw white with differnt alpha values. This
2809 method reverses it, assuming a black (!) background and white text.
2810 The method will then fill up the whole image with the colour given.
2812 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2814 def SetMaskFromImage(*args
, **kwargs
):
2816 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2818 Sets the image's mask so that the pixels that have RGB value of
2819 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820 by first finding an unused colour in the image, setting this colour as
2821 the mask colour and then using this colour to draw all pixels in the
2822 image who corresponding pixel in mask has given RGB value.
2824 Returns ``False`` if ``mask`` does not have same dimensions as the
2825 image or if there is no unused colour left. Returns ``True`` if the
2826 mask was successfully applied.
2828 Note that this method involves computing the histogram, which is
2829 computationally intensive operation.
2831 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2833 def CanRead(*args
, **kwargs
):
2835 CanRead(String filename) -> bool
2837 Returns True if the image handlers can read this file.
2839 return _core_
.Image_CanRead(*args
, **kwargs
)
2841 CanRead
= staticmethod(CanRead
)
2842 def GetImageCount(*args
, **kwargs
):
2844 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2846 If the image file contains more than one image and the image handler
2847 is capable of retrieving these individually, this function will return
2848 the number of available images.
2850 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2852 GetImageCount
= staticmethod(GetImageCount
)
2853 def LoadFile(*args
, **kwargs
):
2855 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2857 Loads an image from a file. If no handler type is provided, the
2858 library will try to autodetect the format.
2860 return _core_
.Image_LoadFile(*args
, **kwargs
)
2862 def LoadMimeFile(*args
, **kwargs
):
2864 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2866 Loads an image from a file, specifying the image type with a MIME type
2869 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2871 def SaveFile(*args
, **kwargs
):
2873 SaveFile(self, String name, int type) -> bool
2875 Saves an image in the named file.
2877 return _core_
.Image_SaveFile(*args
, **kwargs
)
2879 def SaveMimeFile(*args
, **kwargs
):
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2883 Saves an image in the named file.
2885 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2887 def CanReadStream(*args
, **kwargs
):
2889 CanReadStream(InputStream stream) -> bool
2891 Returns True if the image handlers can read an image file from the
2892 data currently on the input stream, or a readable Python file-like
2895 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2897 CanReadStream
= staticmethod(CanReadStream
)
2898 def LoadStream(*args
, **kwargs
):
2900 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2902 Loads an image from an input stream or a readable Python file-like
2903 object. If no handler type is provided, the library will try to
2904 autodetect the format.
2906 return _core_
.Image_LoadStream(*args
, **kwargs
)
2908 def LoadMimeStream(*args
, **kwargs
):
2910 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2912 Loads an image from an input stream or a readable Python file-like
2913 object, using a MIME type string to specify the image file format.
2915 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2917 def IsOk(*args
, **kwargs
):
2921 Returns true if image data is present.
2923 return _core_
.Image_IsOk(*args
, **kwargs
)
2926 def GetWidth(*args
, **kwargs
):
2928 GetWidth(self) -> int
2930 Gets the width of the image in pixels.
2932 return _core_
.Image_GetWidth(*args
, **kwargs
)
2934 def GetHeight(*args
, **kwargs
):
2936 GetHeight(self) -> int
2938 Gets the height of the image in pixels.
2940 return _core_
.Image_GetHeight(*args
, **kwargs
)
2942 def GetSize(*args
, **kwargs
):
2944 GetSize(self) -> Size
2946 Returns the size of the image in pixels.
2948 return _core_
.Image_GetSize(*args
, **kwargs
)
2950 def GetSubImage(*args
, **kwargs
):
2952 GetSubImage(self, Rect rect) -> Image
2954 Returns a sub image of the current one as long as the rect belongs
2955 entirely to the image.
2957 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2959 def Size(*args
, **kwargs
):
2961 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2963 Returns a resized version of this image without scaling it by adding
2964 either a border with the given colour or cropping as necessary. The
2965 image is pasted into a new image with the given size and background
2966 colour at the position ``pos`` relative to the upper left of the new
2967 image. If red = green = blue = -1 then use either the current mask
2968 colour if set or find, use, and set a suitable mask colour for any
2969 newly exposed areas.
2971 return _core_
.Image_Size(*args
, **kwargs
)
2973 def Copy(*args
, **kwargs
):
2977 Returns an identical copy of the image.
2979 return _core_
.Image_Copy(*args
, **kwargs
)
2981 def Paste(*args
, **kwargs
):
2983 Paste(self, Image image, int x, int y)
2985 Pastes ``image`` into this instance and takes care of the mask colour
2986 and any out of bounds problems.
2988 return _core_
.Image_Paste(*args
, **kwargs
)
2990 def GetData(*args
, **kwargs
):
2992 GetData(self) -> PyObject
2994 Returns a string containing a copy of the RGB bytes of the image.
2996 return _core_
.Image_GetData(*args
, **kwargs
)
2998 def SetData(*args
, **kwargs
):
3000 SetData(self, buffer data)
3002 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3003 either a string or a buffer object holding the data and the length of
3004 the data must be width*height*3.
3006 return _core_
.Image_SetData(*args
, **kwargs
)
3008 def GetDataBuffer(*args
, **kwargs
):
3010 GetDataBuffer(self) -> PyObject
3012 Returns a writable Python buffer object that is pointing at the RGB
3013 image data buffer inside the wx.Image. You need to ensure that you do
3014 not use this buffer object after the image has been destroyed.
3016 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
3018 def SetDataBuffer(*args
, **kwargs
):
3020 SetDataBuffer(self, buffer data)
3022 Sets the internal image data pointer to point at a Python buffer
3023 object. This can save making an extra copy of the data but you must
3024 ensure that the buffer object lives longer than the wx.Image does.
3026 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
3028 def GetAlphaData(*args
, **kwargs
):
3030 GetAlphaData(self) -> PyObject
3032 Returns a string containing a copy of the alpha bytes of the image.
3034 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
3036 def SetAlphaData(*args
, **kwargs
):
3038 SetAlphaData(self, buffer alpha)
3040 Resets the Image's alpha data from a buffer of bytes. Accepts either
3041 a string or a buffer object holding the data and the length of the
3042 data must be width*height.
3044 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
3046 def GetAlphaBuffer(*args
, **kwargs
):
3048 GetAlphaBuffer(self) -> PyObject
3050 Returns a writable Python buffer object that is pointing at the Alpha
3051 data buffer inside the wx.Image. You need to ensure that you do not
3052 use this buffer object after the image has been destroyed.
3054 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
3056 def SetAlphaBuffer(*args
, **kwargs
):
3058 SetAlphaBuffer(self, buffer alpha)
3060 Sets the internal image alpha pointer to point at a Python buffer
3061 object. This can save making an extra copy of the data but you must
3062 ensure that the buffer object lives as long as the wx.Image does.
3064 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
3066 def SetMaskColour(*args
, **kwargs
):
3068 SetMaskColour(self, byte r, byte g, byte b)
3070 Sets the mask colour for this image (and tells the image to use the
3073 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
3075 def GetOrFindMaskColour(*args
, **kwargs
):
3077 GetOrFindMaskColour() -> (r,g,b)
3079 Get the current mask colour or find a suitable colour.
3081 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
3083 def GetMaskRed(*args
, **kwargs
):
3085 GetMaskRed(self) -> byte
3087 Gets the red component of the mask colour.
3089 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
3091 def GetMaskGreen(*args
, **kwargs
):
3093 GetMaskGreen(self) -> byte
3095 Gets the green component of the mask colour.
3097 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
3099 def GetMaskBlue(*args
, **kwargs
):
3101 GetMaskBlue(self) -> byte
3103 Gets the blue component of the mask colour.
3105 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
3107 def SetMask(*args
, **kwargs
):
3109 SetMask(self, bool mask=True)
3111 Specifies whether there is a mask or not. The area of the mask is
3112 determined by the current mask colour.
3114 return _core_
.Image_SetMask(*args
, **kwargs
)
3116 def HasMask(*args
, **kwargs
):
3118 HasMask(self) -> bool
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3122 return _core_
.Image_HasMask(*args
, **kwargs
)
3124 def Rotate(*args
, **kwargs
):
3126 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3127 Point offset_after_rotation=None) -> Image
3129 Rotates the image about the given point, by ``angle`` radians. Passing
3130 ``True`` to ``interpolating`` results in better image quality, but is
3131 slower. If the image has a mask, then the mask colour is used for the
3132 uncovered pixels in the rotated image background. Otherwise, black
3133 will be used as the fill colour.
3135 Returns the rotated image, leaving this image intact.
3137 return _core_
.Image_Rotate(*args
, **kwargs
)
3139 def Rotate90(*args
, **kwargs
):
3141 Rotate90(self, bool clockwise=True) -> Image
3143 Returns a copy of the image rotated 90 degrees in the direction
3144 indicated by ``clockwise``.
3146 return _core_
.Image_Rotate90(*args
, **kwargs
)
3148 def Mirror(*args
, **kwargs
):
3150 Mirror(self, bool horizontally=True) -> Image
3152 Returns a mirrored copy of the image. The parameter ``horizontally``
3153 indicates the orientation.
3155 return _core_
.Image_Mirror(*args
, **kwargs
)
3157 def Replace(*args
, **kwargs
):
3159 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3161 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3164 return _core_
.Image_Replace(*args
, **kwargs
)
3166 def ConvertToGreyscale(*args
, **kwargs
):
3168 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3170 Convert to greyscale image. Uses the luminance component (Y) of the
3171 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172 defaults to ITU-T BT.601
3174 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
3176 def ConvertToMono(*args
, **kwargs
):
3178 ConvertToMono(self, byte r, byte g, byte b) -> Image
3180 Returns monochromatic version of the image. The returned image has
3181 white colour where the original has ``(r,g,b)`` colour and black
3182 colour everywhere else.
3184 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
3186 def SetOption(*args
, **kwargs
):
3188 SetOption(self, String name, String value)
3190 Sets an image handler defined option. For example, when saving as a
3191 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192 number between 0 and 100 (0 is terrible, 100 is very good).
3194 return _core_
.Image_SetOption(*args
, **kwargs
)
3196 def SetOptionInt(*args
, **kwargs
):
3198 SetOptionInt(self, String name, int value)
3200 Sets an image option as an integer.
3202 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
3204 def GetOption(*args
, **kwargs
):
3206 GetOption(self, String name) -> String
3208 Gets the value of an image handler option.
3210 return _core_
.Image_GetOption(*args
, **kwargs
)
3212 def GetOptionInt(*args
, **kwargs
):
3214 GetOptionInt(self, String name) -> int
3216 Gets the value of an image handler option as an integer. If the given
3217 option is not present, the function returns 0.
3219 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
3221 def HasOption(*args
, **kwargs
):
3223 HasOption(self, String name) -> bool
3225 Returns true if the given option is present.
3227 return _core_
.Image_HasOption(*args
, **kwargs
)
3229 def CountColours(*args
, **kwargs
):
3230 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3231 return _core_
.Image_CountColours(*args
, **kwargs
)
3233 def ComputeHistogram(*args
, **kwargs
):
3234 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3235 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
3237 def AddHandler(*args
, **kwargs
):
3238 """AddHandler(ImageHandler handler)"""
3239 return _core_
.Image_AddHandler(*args
, **kwargs
)
3241 AddHandler
= staticmethod(AddHandler
)
3242 def InsertHandler(*args
, **kwargs
):
3243 """InsertHandler(ImageHandler handler)"""
3244 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3246 InsertHandler
= staticmethod(InsertHandler
)
3247 def RemoveHandler(*args
, **kwargs
):
3248 """RemoveHandler(String name) -> bool"""
3249 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3251 RemoveHandler
= staticmethod(RemoveHandler
)
3252 def GetHandlers(*args
, **kwargs
):
3253 """GetHandlers() -> PyObject"""
3254 return _core_
.Image_GetHandlers(*args
, **kwargs
)
3256 GetHandlers
= staticmethod(GetHandlers
)
3257 def GetImageExtWildcard(*args
, **kwargs
):
3259 GetImageExtWildcard() -> String
3261 Iterates all registered wxImageHandler objects, and returns a string
3262 containing file extension masks suitable for passing to file open/save
3265 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3267 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3268 def ConvertToBitmap(*args
, **kwargs
):
3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3270 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3272 def ConvertToMonoBitmap(*args
, **kwargs
):
3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3274 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3276 def RotateHue(*args
, **kwargs
):
3278 RotateHue(self, double angle)
3280 Rotates the hue of each pixel of the image. Hue is a double in the
3281 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3283 return _core_
.Image_RotateHue(*args
, **kwargs
)
3285 def RGBtoHSV(*args
, **kwargs
):
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3289 Converts a color in RGB color space to HSV color space.
3291 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3293 RGBtoHSV
= staticmethod(RGBtoHSV
)
3294 def HSVtoRGB(*args
, **kwargs
):
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3298 Converts a color in HSV color space to RGB color space.
3300 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3302 HSVtoRGB
= staticmethod(HSVtoRGB
)
3303 def __nonzero__(self
): return self
.IsOk()
3304 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
3306 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
3307 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
3308 Height
= property(GetHeight
,doc
="See `GetHeight`")
3309 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
3310 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
3311 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
3312 Width
= property(GetWidth
,doc
="See `GetWidth`")
3313 _core_
.Image_swigregister(Image
)
3315 def ImageFromMime(*args
, **kwargs
):
3317 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3319 Loads an image from a file, using a MIME type string (such as
3320 'image/jpeg') to specify image type.
3322 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3325 def ImageFromStream(*args
, **kwargs
):
3327 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3329 Loads an image from an input stream, or any readable Python file-like
3332 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3335 def ImageFromStreamMime(*args
, **kwargs
):
3337 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3339 Loads an image from an input stream, or any readable Python file-like
3340 object, specifying the image format with a MIME type string.
3342 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3345 def EmptyImage(*args
, **kwargs
):
3347 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3349 Construct an empty image of a given size, optionally setting all
3352 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3355 def ImageFromBitmap(*args
, **kwargs
):
3357 ImageFromBitmap(Bitmap bitmap) -> Image
3359 Construct an Image from a `wx.Bitmap`.
3361 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3364 def ImageFromData(*args
, **kwargs
):
3366 ImageFromData(int width, int height, buffer data) -> Image
3368 Construct an Image from a buffer of RGB bytes. Accepts either a
3369 string or a buffer object holding the data and the length of the data
3370 must be width*height*3.
3372 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3375 def ImageFromDataWithAlpha(*args
, **kwargs
):
3377 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3379 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380 Accepts either a string or a buffer object holding the data and the
3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
3384 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3387 def Image_CanRead(*args
, **kwargs
):
3389 Image_CanRead(String filename) -> bool
3391 Returns True if the image handlers can read this file.
3393 return _core_
.Image_CanRead(*args
, **kwargs
)
3395 def Image_GetImageCount(*args
, **kwargs
):
3397 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3399 If the image file contains more than one image and the image handler
3400 is capable of retrieving these individually, this function will return
3401 the number of available images.
3403 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3405 def Image_CanReadStream(*args
, **kwargs
):
3407 Image_CanReadStream(InputStream stream) -> bool
3409 Returns True if the image handlers can read an image file from the
3410 data currently on the input stream, or a readable Python file-like
3413 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3415 def Image_AddHandler(*args
, **kwargs
):
3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_
.Image_AddHandler(*args
, **kwargs
)
3419 def Image_InsertHandler(*args
, **kwargs
):
3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3423 def Image_RemoveHandler(*args
, **kwargs
):
3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3427 def Image_GetHandlers(*args
):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_
.Image_GetHandlers(*args
)
3431 def Image_GetImageExtWildcard(*args
):
3433 Image_GetImageExtWildcard() -> String
3435 Iterates all registered wxImageHandler objects, and returns a string
3436 containing file extension masks suitable for passing to file open/save
3439 return _core_
.Image_GetImageExtWildcard(*args
)
3441 def Image_RGBtoHSV(*args
, **kwargs
):
3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3445 Converts a color in RGB color space to HSV color space.
3447 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3449 def Image_HSVtoRGB(*args
, **kwargs
):
3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3453 Converts a color in HSV color space to RGB color space.
3455 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3458 def _ImageFromBuffer(*args
, **kwargs
):
3459 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3461 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3463 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3464 parameter must be a Python object that implements the buffer interface,
3465 such as a string, array, etc. The dataBuffer object is expected to
3466 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3467 object can optionally be supplied for the image's alpha channel data, and
3468 it is expected to be width*height bytes long.
3470 The wx.Image will be created with its data and alpha pointers initialized
3471 to the memory address pointed to by the buffer objects, thus saving the
3472 time needed to copy the image data from the buffer object to the wx.Image.
3473 While this has advantages, it also has the shoot-yourself-in-the-foot
3474 risks associated with sharing a C pointer between two objects.
3476 To help alleviate the risk a reference to the data and alpha buffer
3477 objects are kept with the wx.Image, so that they won't get deleted until
3478 after the wx.Image is deleted. However please be aware that it is not
3479 guaranteed that an object won't move its memory buffer to a new location
3480 when it needs to resize its contents. If that happens then the wx.Image
3481 will end up referring to an invalid memory location and could cause the
3482 application to crash. Therefore care should be taken to not manipulate
3483 the objects used for the data and alpha buffers in a way that would cause
3484 them to change size.
3486 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3487 image
._buffer
= dataBuffer
3488 image
._alpha
= alphaBuffer
3491 def InitAllImageHandlers():
3493 The former functionality of InitAllImageHanders is now done internal to
3494 the _core_ extension module and so this function has become a simple NOP.
3498 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3499 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3500 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3501 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3502 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3503 BMP_24BPP
= _core_
.BMP_24BPP
3504 BMP_8BPP
= _core_
.BMP_8BPP
3505 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3506 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3507 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3508 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3509 BMP_4BPP
= _core_
.BMP_4BPP
3510 BMP_1BPP
= _core_
.BMP_1BPP
3511 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3512 class BMPHandler(ImageHandler
):
3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3514 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3515 __repr__
= _swig_repr
3516 def __init__(self
, *args
, **kwargs
):
3518 __init__(self) -> BMPHandler
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3522 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3523 _core_
.BMPHandler_swigregister(BMPHandler
)
3524 NullImage
= cvar
.NullImage
3525 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3526 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3527 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3528 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3529 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3530 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3531 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3532 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3533 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3534 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3535 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3536 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3537 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3538 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3539 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3541 class ICOHandler(BMPHandler
):
3542 """A `wx.ImageHandler` for \*.ico icon files."""
3543 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3544 __repr__
= _swig_repr
3545 def __init__(self
, *args
, **kwargs
):
3547 __init__(self) -> ICOHandler
3549 A `wx.ImageHandler` for \*.ico icon files.
3551 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3552 _core_
.ICOHandler_swigregister(ICOHandler
)
3554 class CURHandler(ICOHandler
):
3555 """A `wx.ImageHandler` for \*.cur cursor files."""
3556 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3557 __repr__
= _swig_repr
3558 def __init__(self
, *args
, **kwargs
):
3560 __init__(self) -> CURHandler
3562 A `wx.ImageHandler` for \*.cur cursor files.
3564 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3565 _core_
.CURHandler_swigregister(CURHandler
)
3567 class ANIHandler(CURHandler
):
3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3569 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3570 __repr__
= _swig_repr
3571 def __init__(self
, *args
, **kwargs
):
3573 __init__(self) -> ANIHandler
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3577 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3578 _core_
.ANIHandler_swigregister(ANIHandler
)
3580 class PNGHandler(ImageHandler
):
3581 """A `wx.ImageHandler` for PNG image files."""
3582 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3583 __repr__
= _swig_repr
3584 def __init__(self
, *args
, **kwargs
):
3586 __init__(self) -> PNGHandler
3588 A `wx.ImageHandler` for PNG image files.
3590 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3591 _core_
.PNGHandler_swigregister(PNGHandler
)
3593 class GIFHandler(ImageHandler
):
3594 """A `wx.ImageHandler` for GIF image files."""
3595 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3596 __repr__
= _swig_repr
3597 def __init__(self
, *args
, **kwargs
):
3599 __init__(self) -> GIFHandler
3601 A `wx.ImageHandler` for GIF image files.
3603 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3604 _core_
.GIFHandler_swigregister(GIFHandler
)
3606 class PCXHandler(ImageHandler
):
3607 """A `wx.ImageHandler` for PCX imager 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) -> PCXHandler
3614 A `wx.ImageHandler` for PCX imager files.
3616 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3617 _core_
.PCXHandler_swigregister(PCXHandler
)
3619 class JPEGHandler(ImageHandler
):
3620 """A `wx.ImageHandler` for JPEG/JPG image 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) -> JPEGHandler
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3629 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3630 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3632 class PNMHandler(ImageHandler
):
3633 """A `wx.ImageHandler` for PNM image 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) -> PNMHandler
3640 A `wx.ImageHandler` for PNM image files.
3642 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3643 _core_
.PNMHandler_swigregister(PNMHandler
)
3645 class XPMHandler(ImageHandler
):
3646 """A `wx.ImageHandler` for XPM image."""
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) -> XPMHandler
3653 A `wx.ImageHandler` for XPM image.
3655 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3656 _core_
.XPMHandler_swigregister(XPMHandler
)
3658 class TIFFHandler(ImageHandler
):
3659 """A `wx.ImageHandler` for TIFF 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) -> TIFFHandler
3666 A `wx.ImageHandler` for TIFF image files.
3668 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3669 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3671 class TGAHandler(ImageHandler
):
3672 """A `wx.ImageHandler` for TGA image 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) -> TGAHandler
3679 A `wx.ImageHandler` for TGA image files.
3681 _core_
.TGAHandler_swiginit(self
,_core_
.new_TGAHandler(*args
, **kwargs
))
3682 _core_
.TGAHandler_swigregister(TGAHandler
)
3684 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3686 class Quantize(object):
3687 """Performs quantization, or colour reduction, on a wxImage."""
3688 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3689 def __init__(self
): raise AttributeError, "No constructor defined"
3690 __repr__
= _swig_repr
3691 def Quantize(*args
, **kwargs
):
3693 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3695 Reduce the colours in the source image and put the result into the
3696 destination image, setting the palette in the destination if
3697 needed. Both images may be the same, to overwrite the source image.
3699 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3701 Quantize
= staticmethod(Quantize
)
3702 _core_
.Quantize_swigregister(Quantize
)
3704 def Quantize_Quantize(*args
, **kwargs
):
3706 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3708 Reduce the colours in the source image and put the result into the
3709 destination image, setting the palette in the destination if
3710 needed. Both images may be the same, to overwrite the source image.
3712 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3714 #---------------------------------------------------------------------------
3716 class EvtHandler(Object
):
3717 """Proxy of C++ EvtHandler class"""
3718 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3719 __repr__
= _swig_repr
3720 def __init__(self
, *args
, **kwargs
):
3721 """__init__(self) -> EvtHandler"""
3722 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3723 self
._setOORInfo
(self
)
3725 def GetNextHandler(*args
, **kwargs
):
3726 """GetNextHandler(self) -> EvtHandler"""
3727 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3729 def GetPreviousHandler(*args
, **kwargs
):
3730 """GetPreviousHandler(self) -> EvtHandler"""
3731 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3733 def SetNextHandler(*args
, **kwargs
):
3734 """SetNextHandler(self, EvtHandler handler)"""
3735 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3737 def SetPreviousHandler(*args
, **kwargs
):
3738 """SetPreviousHandler(self, EvtHandler handler)"""
3739 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3741 def GetEvtHandlerEnabled(*args
, **kwargs
):
3742 """GetEvtHandlerEnabled(self) -> bool"""
3743 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3745 def SetEvtHandlerEnabled(*args
, **kwargs
):
3746 """SetEvtHandlerEnabled(self, bool enabled)"""
3747 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3749 def ProcessEvent(*args
, **kwargs
):
3750 """ProcessEvent(self, Event event) -> bool"""
3751 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3753 def AddPendingEvent(*args
, **kwargs
):
3754 """AddPendingEvent(self, Event event)"""
3755 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3757 def ProcessPendingEvents(*args
, **kwargs
):
3758 """ProcessPendingEvents(self)"""
3759 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3761 def AllowReentrance(*args
, **kwargs
):
3762 """AllowReentrance(self, bool allow=True)"""
3763 return _core_
.EvtHandler_AllowReentrance(*args
, **kwargs
)
3765 def IsReentranceAllowed(*args
, **kwargs
):
3766 """IsReentranceAllowed(self) -> bool"""
3767 return _core_
.EvtHandler_IsReentranceAllowed(*args
, **kwargs
)
3769 def IsEventHandlingInProgress(*args
, **kwargs
):
3770 """IsEventHandlingInProgress(self) -> bool"""
3771 return _core_
.EvtHandler_IsEventHandlingInProgress(*args
, **kwargs
)
3773 def Connect(*args
, **kwargs
):
3774 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3775 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3777 def Disconnect(*args
, **kwargs
):
3778 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3779 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3781 def _setOORInfo(*args
, **kwargs
):
3782 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3783 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3787 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3789 Bind an event to an event handler.
3791 :param event: One of the EVT_* objects that specifies the
3792 type of event to bind,
3794 :param handler: A callable object to be invoked when the
3795 event is delivered to self. Pass None to
3796 disconnect an event handler.
3798 :param source: Sometimes the event originates from a
3799 different window than self, but you still
3800 want to catch it in self. (For example, a
3801 button event delivered to a frame.) By
3802 passing the source of the event, the event
3803 handling system is able to differentiate
3804 between the same event type from different
3807 :param id: Used to spcify the event source by ID instead
3810 :param id2: Used when it is desirable to bind a handler
3811 to a range of IDs, such as with EVT_MENU_RANGE.
3813 if source
is not None:
3815 event
.Bind(self
, id, id2
, handler
)
3817 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3819 Disconencts the event handler binding for event from self.
3820 Returns True if successful.
3822 if source
is not None:
3824 return event
.Unbind(self
, id, id2
)
3826 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3827 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3828 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3829 _core_
.EvtHandler_swigregister(EvtHandler
)
3831 #---------------------------------------------------------------------------
3833 class PyEventBinder(object):
3835 Instances of this class are used to bind specific events to event
3838 def __init__(self
, evtType
, expectedIDs
=0):
3839 if expectedIDs
not in [0, 1, 2]:
3840 raise ValueError, "Invalid number of expectedIDs"
3841 self
.expectedIDs
= expectedIDs
3843 if type(evtType
) == list or type(evtType
) == tuple:
3844 self
.evtType
= evtType
3846 self
.evtType
= [evtType
]
3849 def Bind(self
, target
, id1
, id2
, function
):
3850 """Bind this set of event types to target."""
3851 for et
in self
.evtType
:
3852 target
.Connect(id1
, id2
, et
, function
)
3855 def Unbind(self
, target
, id1
, id2
):
3856 """Remove an event binding."""
3858 for et
in self
.evtType
:
3859 success
+= target
.Disconnect(id1
, id2
, et
)
3863 def __call__(self
, *args
):
3865 For backwards compatibility with the old EVT_* functions.
3866 Should be called with either (window, func), (window, ID,
3867 func) or (window, ID1, ID2, func) parameters depending on the
3870 assert len(args
) == 2 + self
.expectedIDs
3874 if self
.expectedIDs
== 0:
3876 elif self
.expectedIDs
== 1:
3879 elif self
.expectedIDs
== 2:
3884 raise ValueError, "Unexpected number of IDs"
3886 self
.Bind(target
, id1
, id2
, func
)
3889 # These two are square pegs that don't fit the PyEventBinder hole...
3890 def EVT_COMMAND(win
, id, cmd
, func
):
3891 win
.Connect(id, -1, cmd
, func
)
3892 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3893 win
.Connect(id1
, id2
, cmd
, func
)
3896 #---------------------------------------------------------------------------
3898 #---------------------------------------------------------------------------
3900 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3901 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3903 def NewEventType(*args
):
3904 """NewEventType() -> EventType"""
3905 return _core_
.NewEventType(*args
)
3906 wxEVT_NULL
= _core_
.wxEVT_NULL
3907 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3908 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3909 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3910 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3911 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3912 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3913 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3914 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3915 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3916 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3917 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3918 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3919 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3920 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3921 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3922 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3923 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3924 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3925 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3926 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3927 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3928 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3929 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3930 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3931 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3932 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3933 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3934 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3935 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3936 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3937 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3938 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3939 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3940 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3941 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3942 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3943 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3944 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3945 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3946 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3947 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3948 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3949 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3950 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3951 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3952 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3953 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3954 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3955 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3956 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3957 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3958 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3959 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3960 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3961 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3962 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3963 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3964 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3965 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3966 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3967 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3968 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3969 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3970 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3971 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3972 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3973 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3974 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3975 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3976 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3977 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3978 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3979 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3980 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3981 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3982 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3983 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3984 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3985 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3986 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3987 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3988 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3989 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3990 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3991 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3992 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3993 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3994 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3995 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3996 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3997 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3998 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3999 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
4000 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
4001 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
4002 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
4003 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
4004 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
4005 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
4006 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
4007 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
4008 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
4009 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
4010 wxEVT_IDLE
= _core_
.wxEVT_IDLE
4011 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
4012 wxEVT_SIZING
= _core_
.wxEVT_SIZING
4013 wxEVT_MOVING
= _core_
.wxEVT_MOVING
4014 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
4015 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
4016 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
4017 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
4018 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
4019 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
4020 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
4021 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
4022 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
4023 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
4024 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
4026 # Create some event binders
4027 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
4028 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
4029 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
4030 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
4031 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
4032 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4033 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4034 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
4035 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
4036 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
4037 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
4038 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
4039 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
4040 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
4041 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
4042 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
4043 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
4044 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
4045 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
4046 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
4047 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
4048 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
4049 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
4050 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
4051 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
4052 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4053 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4054 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
4055 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
4056 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
4057 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
4058 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
4059 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
4060 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
4061 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
4062 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
4063 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
4064 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
4065 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
4066 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
4067 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
4068 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
4070 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
4071 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
4072 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
4073 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
4074 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
4075 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
4076 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
4077 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
4078 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
4079 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
4080 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
4081 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
4082 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
4084 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
4092 wxEVT_MIDDLE_DCLICK
,
4100 # Scrolling from wxWindow (sent to wxScrolledWindow)
4101 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
4102 wxEVT_SCROLLWIN_BOTTOM
,
4103 wxEVT_SCROLLWIN_LINEUP
,
4104 wxEVT_SCROLLWIN_LINEDOWN
,
4105 wxEVT_SCROLLWIN_PAGEUP
,
4106 wxEVT_SCROLLWIN_PAGEDOWN
,
4107 wxEVT_SCROLLWIN_THUMBTRACK
,
4108 wxEVT_SCROLLWIN_THUMBRELEASE
,
4111 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
4112 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
4113 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
4114 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
4115 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
4116 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
4117 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
4118 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
4120 # Scrolling from wx.Slider and wx.ScrollBar
4121 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4122 wxEVT_SCROLL_BOTTOM
,
4123 wxEVT_SCROLL_LINEUP
,
4124 wxEVT_SCROLL_LINEDOWN
,
4125 wxEVT_SCROLL_PAGEUP
,
4126 wxEVT_SCROLL_PAGEDOWN
,
4127 wxEVT_SCROLL_THUMBTRACK
,
4128 wxEVT_SCROLL_THUMBRELEASE
,
4129 wxEVT_SCROLL_CHANGED
,
4132 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
4133 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
4134 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
4135 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
4136 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
4137 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
4138 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
4139 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
4140 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
4141 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
4143 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4144 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4145 wxEVT_SCROLL_BOTTOM
,
4146 wxEVT_SCROLL_LINEUP
,
4147 wxEVT_SCROLL_LINEDOWN
,
4148 wxEVT_SCROLL_PAGEUP
,
4149 wxEVT_SCROLL_PAGEDOWN
,
4150 wxEVT_SCROLL_THUMBTRACK
,
4151 wxEVT_SCROLL_THUMBRELEASE
,
4152 wxEVT_SCROLL_CHANGED
,
4155 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
4156 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
4157 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
4158 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
4159 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
4160 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
4161 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
4162 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
4163 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
4164 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
4166 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
4167 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
4168 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
4169 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
4170 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4171 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4172 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4173 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4174 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4175 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4177 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4178 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4179 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4180 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4181 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4182 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4183 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4184 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4185 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4188 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4189 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4190 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4191 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4192 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4193 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4194 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4196 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4198 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4199 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4201 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4203 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
4204 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
4205 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
4208 #---------------------------------------------------------------------------
4210 class Event(Object
):
4212 An event is a structure holding information about an event passed to a
4213 callback or member function. wx.Event is an abstract base class for
4216 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4217 def __init__(self
): raise AttributeError, "No constructor defined"
4218 __repr__
= _swig_repr
4219 __swig_destroy__
= _core_
.delete_Event
4220 __del__
= lambda self
: None;
4221 def SetEventType(*args
, **kwargs
):
4223 SetEventType(self, EventType typ)
4225 Sets the specific type of the event.
4227 return _core_
.Event_SetEventType(*args
, **kwargs
)
4229 def GetEventType(*args
, **kwargs
):
4231 GetEventType(self) -> EventType
4233 Returns the identifier of the given event type, such as
4234 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4236 return _core_
.Event_GetEventType(*args
, **kwargs
)
4238 def GetEventObject(*args
, **kwargs
):
4240 GetEventObject(self) -> Object
4242 Returns the object (usually a window) associated with the event, if
4245 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4247 def SetEventObject(*args
, **kwargs
):
4249 SetEventObject(self, Object obj)
4251 Sets the originating object, or in other words, obj is normally the
4252 object that is sending the event.
4254 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4256 def GetTimestamp(*args
, **kwargs
):
4257 """GetTimestamp(self) -> long"""
4258 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4260 def SetTimestamp(*args
, **kwargs
):
4261 """SetTimestamp(self, long ts=0)"""
4262 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4264 def GetId(*args
, **kwargs
):
4268 Returns the identifier associated with this event, such as a button
4271 return _core_
.Event_GetId(*args
, **kwargs
)
4273 def SetId(*args
, **kwargs
):
4277 Set's the ID for the event. This is usually the ID of the window that
4278 is sending the event, but it can also be a command id from a menu
4281 return _core_
.Event_SetId(*args
, **kwargs
)
4283 def IsCommandEvent(*args
, **kwargs
):
4285 IsCommandEvent(self) -> bool
4287 Returns true if the event is or is derived from `wx.CommandEvent` else
4288 it returns false. Note: Exists only for optimization purposes.
4290 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4292 def Skip(*args
, **kwargs
):
4294 Skip(self, bool skip=True)
4296 This method can be used inside an event handler to control whether
4297 further event handlers bound to this event will be called after the
4298 current one returns. Without Skip() (or equivalently if Skip(False) is
4299 used), the event will not be processed any more. If Skip(True) is
4300 called, the event processing system continues searching for a further
4301 handler function for this event, even though it has been processed
4302 already in the current handler.
4304 return _core_
.Event_Skip(*args
, **kwargs
)
4306 def GetSkipped(*args
, **kwargs
):
4308 GetSkipped(self) -> bool
4310 Returns true if the event handler should be skipped, false otherwise.
4313 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4315 def ShouldPropagate(*args
, **kwargs
):
4317 ShouldPropagate(self) -> bool
4319 Test if this event should be propagated to the parent window or not,
4320 i.e. if the propagation level is currently greater than 0.
4322 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4324 def StopPropagation(*args
, **kwargs
):
4326 StopPropagation(self) -> int
4328 Stop the event from propagating to its parent window. Returns the old
4329 propagation level value which may be later passed to
4330 `ResumePropagation` to allow propagating the event again.
4332 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4334 def ResumePropagation(*args
, **kwargs
):
4336 ResumePropagation(self, int propagationLevel)
4338 Resume the event propagation by restoring the propagation level. (For
4339 example, you can use the value returned by an earlier call to
4343 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4345 def Clone(*args
, **kwargs
):
4346 """Clone(self) -> Event"""
4347 return _core_
.Event_Clone(*args
, **kwargs
)
4349 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4350 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4351 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4352 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4353 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4354 _core_
.Event_swigregister(Event
)
4356 #---------------------------------------------------------------------------
4358 class PropagationDisabler(object):
4360 Helper class to temporarily change an event not to propagate. Simply
4361 create an instance of this class and then whe it is destroyed the
4362 propogation of the event will be restored.
4364 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4365 __repr__
= _swig_repr
4366 def __init__(self
, *args
, **kwargs
):
4368 __init__(self, Event event) -> PropagationDisabler
4370 Helper class to temporarily change an event not to propagate. Simply
4371 create an instance of this class and then whe it is destroyed the
4372 propogation of the event will be restored.
4374 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4375 __swig_destroy__
= _core_
.delete_PropagationDisabler
4376 __del__
= lambda self
: None;
4377 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4379 class PropagateOnce(object):
4381 A helper class that will temporarily lower propagation level of an
4382 event. Simply create an instance of this class and then whe it is
4383 destroyed the propogation of the event will be restored.
4385 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4386 __repr__
= _swig_repr
4387 def __init__(self
, *args
, **kwargs
):
4389 __init__(self, Event event) -> PropagateOnce
4391 A helper class that will temporarily lower propagation level of an
4392 event. Simply create an instance of this class and then whe it is
4393 destroyed the propogation of the event will be restored.
4395 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4396 __swig_destroy__
= _core_
.delete_PropagateOnce
4397 __del__
= lambda self
: None;
4398 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4400 #---------------------------------------------------------------------------
4402 class CommandEvent(Event
):
4404 This event class contains information about command events, which
4405 originate from a variety of simple controls, as well as menus and
4408 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4409 __repr__
= _swig_repr
4410 def __init__(self
, *args
, **kwargs
):
4412 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4414 This event class contains information about command events, which
4415 originate from a variety of simple controls, as well as menus and
4418 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4419 def GetSelection(*args
, **kwargs
):
4421 GetSelection(self) -> int
4423 Returns item index for a listbox or choice selection event (not valid
4426 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4428 def SetString(*args
, **kwargs
):
4429 """SetString(self, String s)"""
4430 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4432 def GetString(*args
, **kwargs
):
4434 GetString(self) -> String
4436 Returns item string for a listbox or choice selection event (not valid
4439 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4441 def IsChecked(*args
, **kwargs
):
4443 IsChecked(self) -> bool
4445 This method can be used with checkbox and menu events: for the
4446 checkboxes, the method returns true for a selection event and false
4447 for a deselection one. For the menu events, this method indicates if
4448 the menu item just has become checked or unchecked (and thus only
4449 makes sense for checkable menu items).
4451 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4454 def IsSelection(*args
, **kwargs
):
4456 IsSelection(self) -> bool
4458 For a listbox or similar event, returns true if it is a selection,
4459 false if it is a deselection.
4461 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4463 def SetExtraLong(*args
, **kwargs
):
4464 """SetExtraLong(self, long extraLong)"""
4465 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4467 def GetExtraLong(*args
, **kwargs
):
4469 GetExtraLong(self) -> long
4471 Returns extra information dependant on the event objects type. If the
4472 event comes from a listbox selection, it is a boolean determining
4473 whether the event was a selection (true) or a deselection (false). A
4474 listbox deselection only occurs for multiple-selection boxes, and in
4475 this case the index and string values are indeterminate and the
4476 listbox must be examined by the application.
4478 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4480 def SetInt(*args
, **kwargs
):
4481 """SetInt(self, int i)"""
4482 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4484 def GetInt(*args
, **kwargs
):
4488 Returns the integer identifier corresponding to a listbox, choice or
4489 radiobox selection (only if the event was a selection, not a
4490 deselection), or a boolean value representing the value of a checkbox.
4492 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4494 def GetClientData(*args
, **kwargs
):
4496 GetClientData(self) -> PyObject
4498 Returns the client data object for a listbox or choice selection event, (if any.)
4500 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4502 def SetClientData(*args
, **kwargs
):
4504 SetClientData(self, PyObject clientData)
4506 Associate the given client data with the item at position n.
4508 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4510 GetClientObject
= GetClientData
4511 SetClientObject
= SetClientData
4513 def Clone(*args
, **kwargs
):
4514 """Clone(self) -> Event"""
4515 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4517 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4518 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4519 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4520 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4521 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4522 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4523 _core_
.CommandEvent_swigregister(CommandEvent
)
4525 #---------------------------------------------------------------------------
4527 class NotifyEvent(CommandEvent
):
4529 An instance of this class (or one of its derived classes) is sent from
4530 a control when the control's state is being changed and the control
4531 allows that change to be prevented from happening. The event handler
4532 can call `Veto` or `Allow` to tell the control what to do.
4534 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4535 __repr__
= _swig_repr
4536 def __init__(self
, *args
, **kwargs
):
4538 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4540 An instance of this class (or one of its derived classes) is sent from
4541 a control when the control's state is being changed and the control
4542 allows that change to be prevented from happening. The event handler
4543 can call `Veto` or `Allow` to tell the control what to do.
4545 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4546 def Veto(*args
, **kwargs
):
4550 Prevents the change announced by this event from happening.
4552 It is in general a good idea to notify the user about the reasons for
4553 vetoing the change because otherwise the applications behaviour (which
4554 just refuses to do what the user wants) might be quite surprising.
4556 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4558 def Allow(*args
, **kwargs
):
4562 This is the opposite of `Veto`: it explicitly allows the event to be
4563 processed. For most events it is not necessary to call this method as
4564 the events are allowed anyhow but some are forbidden by default (this
4565 will be mentioned in the corresponding event description).
4567 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4569 def IsAllowed(*args
, **kwargs
):
4571 IsAllowed(self) -> bool
4573 Returns true if the change is allowed (`Veto` hasn't been called) or
4574 false otherwise (if it was).
4576 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4578 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4580 #---------------------------------------------------------------------------
4582 class ScrollEvent(CommandEvent
):
4584 A scroll event holds information about events sent from stand-alone
4585 scrollbars and sliders. Note that scrolled windows do not send
4586 instnaces of this event class, but send the `wx.ScrollWinEvent`
4589 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4590 __repr__
= _swig_repr
4591 def __init__(self
, *args
, **kwargs
):
4593 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4594 int orient=0) -> ScrollEvent
4596 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4597 def GetOrientation(*args
, **kwargs
):
4599 GetOrientation(self) -> int
4601 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4604 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4606 def GetPosition(*args
, **kwargs
):
4608 GetPosition(self) -> int
4610 Returns the position of the scrollbar.
4612 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4614 def SetOrientation(*args
, **kwargs
):
4615 """SetOrientation(self, int orient)"""
4616 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4618 def SetPosition(*args
, **kwargs
):
4619 """SetPosition(self, int pos)"""
4620 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4622 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4623 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4624 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4626 #---------------------------------------------------------------------------
4628 class ScrollWinEvent(Event
):
4630 A wx.ScrollWinEvent holds information about scrolling and is sent from
4633 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4634 __repr__
= _swig_repr
4635 def __init__(self
, *args
, **kwargs
):
4637 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4639 A wx.ScrollWinEvent holds information about scrolling and is sent from
4642 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4643 def GetOrientation(*args
, **kwargs
):
4645 GetOrientation(self) -> int
4647 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4650 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4652 def GetPosition(*args
, **kwargs
):
4654 GetPosition(self) -> int
4656 Returns the position of the scrollbar for the thumb track and release
4657 events. Note that this field can't be used for the other events, you
4658 need to query the window itself for the current position in that case.
4660 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4662 def SetOrientation(*args
, **kwargs
):
4663 """SetOrientation(self, int orient)"""
4664 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4666 def SetPosition(*args
, **kwargs
):
4667 """SetPosition(self, int pos)"""
4668 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4670 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4671 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4672 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4674 #---------------------------------------------------------------------------
4676 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4677 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4678 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4679 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4680 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4681 class MouseEvent(Event
):
4683 This event class contains information about the events generated by
4684 the mouse: they include mouse buttons press and release events and
4687 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4688 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4689 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4690 a middle button so a portable application should avoid relying on the
4693 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4694 the former returns true when the event corresponds to the left mouse
4695 button click while the latter returns true if the left mouse button is
4696 currently being pressed. For example, when the user is dragging the
4697 mouse you can use `LeftIsDown` to test whether the left mouse button
4698 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4699 `LeftIsDown` will also return true in wxWidgets whatever the
4700 underlying GUI behaviour is (which is platform-dependent). The same
4701 applies, of course, to other mouse buttons as well.
4703 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4704 __repr__
= _swig_repr
4705 def __init__(self
, *args
, **kwargs
):
4707 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4709 Constructs a wx.MouseEvent. Valid event types are:
4711 * wxEVT_ENTER_WINDOW
4712 * wxEVT_LEAVE_WINDOW
4718 * wxEVT_MIDDLE_DCLICK
4721 * wxEVT_RIGHT_DCLICK
4725 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4726 def IsButton(*args
, **kwargs
):
4728 IsButton(self) -> bool
4730 Returns true if the event was a mouse button event (not necessarily a
4731 button down event - that may be tested using `ButtonDown`).
4733 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4735 def ButtonDown(*args
, **kwargs
):
4737 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4739 If the argument is omitted, this returns true if the event was any
4740 mouse button down event. Otherwise the argument specifies which
4741 button-down event shold be checked for (see `Button` for the possible
4744 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4746 def ButtonDClick(*args
, **kwargs
):
4748 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4750 If the argument is omitted, this returns true if the event was any
4751 mouse double click event. Otherwise the argument specifies which
4752 double click event to check for (see `Button` for the possible
4755 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4757 def ButtonUp(*args
, **kwargs
):
4759 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4761 If the argument is omitted, this returns true if the event was any
4762 mouse button up event. Otherwise the argument specifies which button
4763 up event to check for (see `Button` for the possible values).
4765 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4767 def Button(*args
, **kwargs
):
4769 Button(self, int button) -> bool
4771 Returns true if the identified mouse button is changing state. Valid
4772 values of button are:
4774 ==================== =====================================
4775 wx.MOUSE_BTN_LEFT check if left button was pressed
4776 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4777 wx.MOUSE_BTN_RIGHT check if right button was pressed
4778 wx.MOUSE_BTN_ANY check if any button was pressed
4779 ==================== =====================================
4782 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4784 def ButtonIsDown(*args
, **kwargs
):
4785 """ButtonIsDown(self, int but) -> bool"""
4786 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4788 def GetButton(*args
, **kwargs
):
4790 GetButton(self) -> int
4792 Returns the mouse button which generated this event or
4793 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4794 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4795 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4796 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4797 right buttons respectively.
4799 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4801 def ControlDown(*args
, **kwargs
):
4803 ControlDown(self) -> bool
4805 Returns true if the control key was down at the time of the event.
4807 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4809 def MetaDown(*args
, **kwargs
):
4811 MetaDown(self) -> bool
4813 Returns true if the Meta key was down at the time of the event.
4815 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4817 def AltDown(*args
, **kwargs
):
4819 AltDown(self) -> bool
4821 Returns true if the Alt key was down at the time of the event.
4823 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4825 def ShiftDown(*args
, **kwargs
):
4827 ShiftDown(self) -> bool
4829 Returns true if the Shift key was down at the time of the event.
4831 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4833 def CmdDown(*args
, **kwargs
):
4835 CmdDown(self) -> bool
4837 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4838 platforms but the special "Apple" (a.k.a as "Command") key on
4839 Macs. It often makes sense to use it instead of, say, `ControlDown`
4840 because Cmd key is used for the same thing under Mac as Ctrl
4841 elsewhere. The Ctrl key still exists, it's just not used for this
4842 purpose. So for non-Mac platforms this is the same as `ControlDown`
4843 and Macs this is the same as `MetaDown`.
4845 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4847 def LeftDown(*args
, **kwargs
):
4849 LeftDown(self) -> bool
4851 Returns true if the left mouse button state changed to down.
4853 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4855 def MiddleDown(*args
, **kwargs
):
4857 MiddleDown(self) -> bool
4859 Returns true if the middle mouse button state changed to down.
4861 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4863 def RightDown(*args
, **kwargs
):
4865 RightDown(self) -> bool
4867 Returns true if the right mouse button state changed to down.
4869 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4871 def LeftUp(*args
, **kwargs
):
4873 LeftUp(self) -> bool
4875 Returns true if the left mouse button state changed to up.
4877 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4879 def MiddleUp(*args
, **kwargs
):
4881 MiddleUp(self) -> bool
4883 Returns true if the middle mouse button state changed to up.
4885 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4887 def RightUp(*args
, **kwargs
):
4889 RightUp(self) -> bool
4891 Returns true if the right mouse button state changed to up.
4893 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4895 def LeftDClick(*args
, **kwargs
):
4897 LeftDClick(self) -> bool
4899 Returns true if the event was a left button double click.
4901 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4903 def MiddleDClick(*args
, **kwargs
):
4905 MiddleDClick(self) -> bool
4907 Returns true if the event was a middle button double click.
4909 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4911 def RightDClick(*args
, **kwargs
):
4913 RightDClick(self) -> bool
4915 Returns true if the event was a right button double click.
4917 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4919 def LeftIsDown(*args
, **kwargs
):
4921 LeftIsDown(self) -> bool
4923 Returns true if the left mouse button is currently down, independent
4924 of the current event type.
4926 Please notice that it is not the same as LeftDown which returns true
4927 if the left mouse button was just pressed. Rather, it describes the
4928 state of the mouse button before the event happened.
4930 This event is usually used in the mouse event handlers which process
4931 "move mouse" messages to determine whether the user is (still)
4934 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4936 def MiddleIsDown(*args
, **kwargs
):
4938 MiddleIsDown(self) -> bool
4940 Returns true if the middle mouse button is currently down, independent
4941 of the current event type.
4943 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4945 def RightIsDown(*args
, **kwargs
):
4947 RightIsDown(self) -> bool
4949 Returns true if the right mouse button is currently down, independent
4950 of the current event type.
4952 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4954 def Dragging(*args
, **kwargs
):
4956 Dragging(self) -> bool
4958 Returns true if this was a dragging event (motion while a button is
4961 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4963 def Moving(*args
, **kwargs
):
4965 Moving(self) -> bool
4967 Returns true if this was a motion event and no mouse buttons were
4968 pressed. If any mouse button is held pressed, then this method returns
4969 false and Dragging returns true.
4971 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4973 def Entering(*args
, **kwargs
):
4975 Entering(self) -> bool
4977 Returns true if the mouse was entering the window.
4979 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4981 def Leaving(*args
, **kwargs
):
4983 Leaving(self) -> bool
4985 Returns true if the mouse was leaving the window.
4987 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4989 def GetPosition(*args
, **kwargs
):
4991 GetPosition(self) -> Point
4993 Returns the pixel position of the mouse in window coordinates when the
4996 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4998 def GetPositionTuple(*args
, **kwargs
):
5000 GetPositionTuple() -> (x,y)
5002 Returns the pixel position of the mouse in window coordinates when the
5005 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
5007 def GetLogicalPosition(*args
, **kwargs
):
5009 GetLogicalPosition(self, DC dc) -> Point
5011 Returns the logical mouse position in pixels (i.e. translated
5012 according to the translation set for the DC, which usually indicates
5013 that the window has been scrolled).
5015 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
5017 def GetX(*args
, **kwargs
):
5021 Returns X coordinate of the physical mouse event position.
5023 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
5025 def GetY(*args
, **kwargs
):
5029 Returns Y coordinate of the physical mouse event position.
5031 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
5033 def GetWheelRotation(*args
, **kwargs
):
5035 GetWheelRotation(self) -> int
5037 Get wheel rotation, positive or negative indicates direction of
5038 rotation. Current devices all send an event when rotation is equal to
5039 +/-WheelDelta, but this allows for finer resolution devices to be
5040 created in the future. Because of this you shouldn't assume that one
5041 event is equal to 1 line or whatever, but you should be able to either
5042 do partial line scrolling or wait until +/-WheelDelta rotation values
5043 have been accumulated before scrolling.
5045 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
5047 def GetWheelDelta(*args
, **kwargs
):
5049 GetWheelDelta(self) -> int
5051 Get wheel delta, normally 120. This is the threshold for action to be
5052 taken, and one such action (for example, scrolling one increment)
5053 should occur for each delta.
5055 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
5057 def GetLinesPerAction(*args
, **kwargs
):
5059 GetLinesPerAction(self) -> int
5061 Returns the configured number of lines (or whatever) to be scrolled
5062 per wheel action. Defaults to three.
5064 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
5066 def IsPageScroll(*args
, **kwargs
):
5068 IsPageScroll(self) -> bool
5070 Returns true if the system has been setup to do page scrolling with
5071 the mouse wheel instead of line scrolling.
5073 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
5075 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
5076 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
5077 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
5078 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
5079 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
5080 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
5081 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
5082 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
5083 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
5084 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
5085 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
5086 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
5087 Button
= property(GetButton
,doc
="See `GetButton`")
5088 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
5089 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
5090 Position
= property(GetPosition
,doc
="See `GetPosition`")
5091 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
5092 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
5093 X
= property(GetX
,doc
="See `GetX`")
5094 Y
= property(GetY
,doc
="See `GetY`")
5095 _core_
.MouseEvent_swigregister(MouseEvent
)
5097 #---------------------------------------------------------------------------
5099 class SetCursorEvent(Event
):
5101 A SetCursorEvent is generated when the mouse cursor is about to be set
5102 as a result of mouse motion. This event gives the application the
5103 chance to perform specific mouse cursor processing based on the
5104 current position of the mouse within the window. Use the `SetCursor`
5105 method to specify the cursor you want to be displayed.
5107 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5108 __repr__
= _swig_repr
5109 def __init__(self
, *args
, **kwargs
):
5111 __init__(self, int x=0, int y=0) -> SetCursorEvent
5113 Construct a new `wx.SetCursorEvent`.
5115 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
5116 def GetX(*args
, **kwargs
):
5120 Returns the X coordinate of the mouse in client coordinates.
5122 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
5124 def GetY(*args
, **kwargs
):
5128 Returns the Y coordinate of the mouse in client coordinates.
5130 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5132 def SetCursor(*args
, **kwargs
):
5134 SetCursor(self, Cursor cursor)
5136 Sets the cursor associated with this event.
5138 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5140 def GetCursor(*args
, **kwargs
):
5142 GetCursor(self) -> Cursor
5144 Returns a reference to the cursor specified by this event.
5146 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5148 def HasCursor(*args
, **kwargs
):
5150 HasCursor(self) -> bool
5152 Returns true if the cursor specified by this event is a valid cursor.
5154 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5156 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
5157 X
= property(GetX
,doc
="See `GetX`")
5158 Y
= property(GetY
,doc
="See `GetY`")
5159 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
5161 #---------------------------------------------------------------------------
5163 class KeyEvent(Event
):
5165 This event class contains information about keypress and character
5166 events. These events are only sent to the widget that currently has
5169 Notice that there are three different kinds of keyboard events in
5170 wxWidgets: key down and up events and char events. The difference
5171 between the first two is clear - the first corresponds to a key press
5172 and the second to a key release - otherwise they are identical. Just
5173 note that if the key is maintained in a pressed state you will
5174 typically get a lot of (automatically generated) down events but only
5175 one up so it is wrong to assume that there is one up event
5176 corresponding to each down one.
5178 Both key events provide untranslated key codes while the char event
5179 carries the translated one. The untranslated code for alphanumeric
5180 keys is always an upper case value. For the other keys it is one of
5181 WXK_XXX values from the keycodes table. The translated key is, in
5182 general, the character the user expects to appear as the result of the
5183 key combination when typing the text into a text entry zone, for
5186 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5187 and the standard US keyboard): when the 'A' key is pressed, the key
5188 down event key code is equal to ASCII A == 65. But the char event key
5189 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5190 'A' keys simultaneously , the key code in key down event will still be
5191 just 'A' while the char event key code parameter will now be 'A' as
5194 Although in this simple case it is clear that the correct key code
5195 could be found in the key down event handler by checking the value
5196 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5197 as for non alphanumeric keys or non-US keyboard layouts the
5198 translation is keyboard-layout dependent and can only be done properly
5199 by the system itself.
5201 Another kind of translation is done when the control key is pressed:
5202 for example, for CTRL-A key press the key down event still carries the
5203 same key code 'A' as usual but the char event will have key code of 1,
5204 the ASCII value of this key combination.
5206 You may discover how the other keys on your system behave
5207 interactively by running the KeyEvents sample in the wxPython demo and
5208 pressing some keys while the blue box at the top has the keyboard
5211 **Note**: If a key down event is caught and the event handler does not
5212 call event.Skip() then the coresponding char event will not
5213 happen. This is by design and enables the programs that handle both
5214 types of events to be a bit simpler.
5216 **Note for Windows programmers**: The key and char events in wxWidgets
5217 are similar to but slightly different from Windows WM_KEYDOWN and
5218 WM_CHAR events. In particular, Alt-x combination will generate a char
5219 event in wxWidgets (unless it is used as an accelerator).
5221 **Tip**: be sure to call event.Skip() for events that you don't
5222 process in key event function, otherwise menu shortcuts may cease to
5226 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5227 __repr__
= _swig_repr
5228 def __init__(self
, *args
, **kwargs
):
5230 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5232 Construct a new `wx.KeyEvent`. Valid event types are:
5235 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
5236 def GetModifiers(*args
, **kwargs
):
5238 GetModifiers(self) -> int
5240 Returns a bitmask of the current modifier settings. Can be used to
5241 check if the key event has exactly the given modifiers without having
5242 to explicitly check that the other modifiers are not down. For
5245 if event.GetModifers() == wx.MOD_CONTROL:
5249 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5251 def ControlDown(*args
, **kwargs
):
5253 ControlDown(self) -> bool
5255 Returns ``True`` if the Control key was down at the time of the event.
5257 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5259 def MetaDown(*args
, **kwargs
):
5261 MetaDown(self) -> bool
5263 Returns ``True`` if the Meta key was down at the time of the event.
5265 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5267 def AltDown(*args
, **kwargs
):
5269 AltDown(self) -> bool
5271 Returns ``True`` if the Alt key was down at the time of the event.
5273 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5275 def ShiftDown(*args
, **kwargs
):
5277 ShiftDown(self) -> bool
5279 Returns ``True`` if the Shift key was down at the time of the event.
5281 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5283 def CmdDown(*args
, **kwargs
):
5285 CmdDown(self) -> bool
5287 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5288 platforms but the special "Apple" (a.k.a as "Command") key on
5289 Macs. It makes often sense to use it instead of, say, `ControlDown`
5290 because Cmd key is used for the same thing under Mac as Ctrl
5291 elsewhere. The Ctrl still exists, it's just not used for this
5292 purpose. So for non-Mac platforms this is the same as `ControlDown`
5293 and Macs this is the same as `MetaDown`.
5295 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5297 def HasModifiers(*args
, **kwargs
):
5299 HasModifiers(self) -> bool
5301 Returns true if either CTRL or ALT keys was down at the time of the
5302 key event. Note that this function does not take into account neither
5303 SHIFT nor META key states (the reason for ignoring the latter is that
5304 it is common for NUMLOCK key to be configured as META under X but the
5305 key presses even while NUMLOCK is on should be still processed
5308 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5310 def GetKeyCode(*args
, **kwargs
):
5312 GetKeyCode(self) -> int
5314 Returns the virtual key code. ASCII events return normal ASCII values,
5315 while non-ASCII events return values such as WXK_LEFT for the left
5316 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5319 Note that in Unicode build, the returned value is meaningful only if
5320 the user entered a character that can be represented in current
5321 locale's default charset. You can obtain the corresponding Unicode
5322 character using `GetUnicodeKey`.
5324 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5326 def GetUnicodeKey(*args
, **kwargs
):
5328 GetUnicodeKey(self) -> int
5330 Returns the Unicode character corresponding to this key event. This
5331 function is only meaningfule in a Unicode build of wxPython.
5333 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5335 GetUniChar
= GetUnicodeKey
5336 def SetUnicodeKey(*args
, **kwargs
):
5338 SetUnicodeKey(self, int uniChar)
5340 Set the Unicode value of the key event, but only if this is a Unicode
5343 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5345 def GetRawKeyCode(*args
, **kwargs
):
5347 GetRawKeyCode(self) -> unsigned int
5349 Returns the raw key code for this event. This is a platform-dependent
5350 scan code which should only be used in advanced
5351 applications. Currently the raw key codes are not supported by all
5354 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5356 def GetRawKeyFlags(*args
, **kwargs
):
5358 GetRawKeyFlags(self) -> unsigned int
5360 Returns the low level key flags for this event. The flags are
5361 platform-dependent and should only be used in advanced applications.
5362 Currently the raw key flags are not supported by all ports.
5364 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5366 def GetPosition(*args
, **kwargs
):
5368 GetPosition(self) -> Point
5370 Find the position of the event, if applicable.
5372 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5374 def GetPositionTuple(*args
, **kwargs
):
5376 GetPositionTuple() -> (x,y)
5378 Find the position of the event, if applicable.
5380 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5382 def GetX(*args
, **kwargs
):
5386 Returns the X position (in client coordinates) of the event, if
5389 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5391 def GetY(*args
, **kwargs
):
5395 Returns the Y position (in client coordinates) of the event, if
5398 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5400 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5401 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5402 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5403 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5404 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5405 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5406 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5407 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5408 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5409 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5410 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5411 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5412 Position
= property(GetPosition
,doc
="See `GetPosition`")
5413 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5414 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5415 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5416 X
= property(GetX
,doc
="See `GetX`")
5417 Y
= property(GetY
,doc
="See `GetY`")
5418 _core_
.KeyEvent_swigregister(KeyEvent
)
5420 #---------------------------------------------------------------------------
5422 class SizeEvent(Event
):
5424 A size event holds information about size change events. The EVT_SIZE
5425 handler function will be called when the window it is bound to has
5428 Note that the size passed is of the whole window: call
5429 `wx.Window.GetClientSize` for the area which may be used by the
5432 When a window is resized, usually only a small part of the window is
5433 damaged and and that area is all that is in the update region for the
5434 next paint event. However, if your drawing depends on the size of the
5435 window, you may need to clear the DC explicitly and repaint the whole
5436 window. In which case, you may need to call `wx.Window.Refresh` to
5437 invalidate the entire window.
5440 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5441 __repr__
= _swig_repr
5442 def __init__(self
, *args
, **kwargs
):
5444 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5446 Construct a new ``wx.SizeEvent``.
5448 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5449 def GetSize(*args
, **kwargs
):
5451 GetSize(self) -> Size
5453 Returns the entire size of the window generating the size change
5456 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5458 def GetRect(*args
, **kwargs
):
5459 """GetRect(self) -> Rect"""
5460 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5462 def SetRect(*args
, **kwargs
):
5463 """SetRect(self, Rect rect)"""
5464 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5466 def SetSize(*args
, **kwargs
):
5467 """SetSize(self, Size size)"""
5468 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5470 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5471 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5472 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5473 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5474 _core_
.SizeEvent_swigregister(SizeEvent
)
5476 #---------------------------------------------------------------------------
5478 class MoveEvent(Event
):
5480 This event object is sent for EVT_MOVE event bindings when a window is
5481 moved to a new position.
5483 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5484 __repr__
= _swig_repr
5485 def __init__(self
, *args
, **kwargs
):
5487 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5491 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5492 def GetPosition(*args
, **kwargs
):
5494 GetPosition(self) -> Point
5496 Returns the position of the window generating the move change event.
5498 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5500 def GetRect(*args
, **kwargs
):
5501 """GetRect(self) -> Rect"""
5502 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5504 def SetRect(*args
, **kwargs
):
5505 """SetRect(self, Rect rect)"""
5506 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5508 def SetPosition(*args
, **kwargs
):
5509 """SetPosition(self, Point pos)"""
5510 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5512 m_pos
= property(GetPosition
, SetPosition
)
5513 m_rect
= property(GetRect
, SetRect
)
5515 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5516 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5517 _core_
.MoveEvent_swigregister(MoveEvent
)
5519 #---------------------------------------------------------------------------
5521 class PaintEvent(Event
):
5523 A paint event is sent when a window's contents needs to be repainted.
5524 Note that in an EVT_PAINT handler the application must *always* create
5525 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5526 Windows assumes that the window has not been painted yet and will send
5527 the event again, causing endless refreshes.
5529 You can optimize painting by retrieving the rectangles that have been
5530 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5531 and only repainting these rectangles. The rectangles are in terms of
5532 the client area, and are unscrolled, so you will need to do some
5533 calculations using the current view position to obtain logical,
5537 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5538 __repr__
= _swig_repr
5539 def __init__(self
, *args
, **kwargs
):
5540 """__init__(self, int Id=0) -> PaintEvent"""
5541 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5542 _core_
.PaintEvent_swigregister(PaintEvent
)
5544 class NcPaintEvent(Event
):
5545 """Proxy of C++ NcPaintEvent class"""
5546 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5547 __repr__
= _swig_repr
5548 def __init__(self
, *args
, **kwargs
):
5549 """__init__(self, int winid=0) -> NcPaintEvent"""
5550 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5551 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5553 #---------------------------------------------------------------------------
5555 class EraseEvent(Event
):
5557 An erase event is sent whenever the background of a window needs to be
5558 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5559 binder. On some platforms, such as GTK+, this event is simulated
5560 (simply generated just before the paint event) and may cause flicker.
5562 To paint a custom background use the `GetDC` method and use the returned
5563 device context if it is not ``None``, otherwise create a temporary
5564 `wx.ClientDC` and draw on that.
5567 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5568 __repr__
= _swig_repr
5569 def __init__(self
, *args
, **kwargs
):
5571 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5575 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5576 def GetDC(*args
, **kwargs
):
5580 Returns the device context the event handler should draw upon. If
5581 ``None`` is returned then create a temporary `wx.ClientDC` and use
5584 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5586 DC
= property(GetDC
,doc
="See `GetDC`")
5587 _core_
.EraseEvent_swigregister(EraseEvent
)
5589 #---------------------------------------------------------------------------
5591 class FocusEvent(Event
):
5593 A focus event is sent when a window's focus changes. The window losing
5594 focus receives an EVT_KILL_FOCUS event while the window gaining it
5595 gets an EVT_SET_FOCUS event.
5597 Notice that the set focus event happens both when the user gives focus
5598 to the window (whether using the mouse or keyboard) and when it is
5599 done from the program itself using `wx.Window.SetFocus`.
5602 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5603 __repr__
= _swig_repr
5604 def __init__(self
, *args
, **kwargs
):
5606 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5610 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5611 def GetWindow(*args
, **kwargs
):
5613 GetWindow(self) -> Window
5615 Returns the other window associated with this event, that is the
5616 window which had the focus before for the EVT_SET_FOCUS event and the
5617 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5619 Warning: the window returned may be None!
5621 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5623 def SetWindow(*args
, **kwargs
):
5624 """SetWindow(self, Window win)"""
5625 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5627 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5628 _core_
.FocusEvent_swigregister(FocusEvent
)
5630 #---------------------------------------------------------------------------
5632 class ChildFocusEvent(CommandEvent
):
5634 A child focus event is sent to a (parent-)window when one of its child
5635 windows gains focus, so that the window could restore the focus back
5636 to its corresponding child if it loses it now and regains later.
5638 Notice that child window is the direct child of the window receiving
5639 the event, and so may not be the actual widget recieving focus if it
5640 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5641 to get the widget that is actually receiving focus.
5643 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5644 __repr__
= _swig_repr
5645 def __init__(self
, *args
, **kwargs
):
5647 __init__(self, Window win=None) -> ChildFocusEvent
5651 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5652 def GetWindow(*args
, **kwargs
):
5654 GetWindow(self) -> Window
5656 The window, or (grand)parent of the window which has just received the
5659 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5661 Window
= property(GetWindow
,doc
="See `GetWindow`")
5662 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5664 #---------------------------------------------------------------------------
5666 class ActivateEvent(Event
):
5668 An activate event is sent when a top-level window or the entire
5669 application is being activated or deactivated.
5671 A top-level window (a dialog or frame) receives an activate event when
5672 is being activated or deactivated. This is indicated visually by the
5673 title bar changing colour, and a subwindow gaining the keyboard focus.
5674 An application is activated or deactivated when one of its frames
5675 becomes activated, or a frame becomes inactivate resulting in all
5676 application frames being inactive.
5678 Please note that usually you should call event.Skip() in your handlers
5679 for these events so the default handlers will still be called, as not
5680 doing so can result in strange effects.
5683 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5684 __repr__
= _swig_repr
5685 def __init__(self
, *args
, **kwargs
):
5687 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5691 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5692 def GetActive(*args
, **kwargs
):
5694 GetActive(self) -> bool
5696 Returns true if the application or window is being activated, false
5699 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5701 Active
= property(GetActive
,doc
="See `GetActive`")
5702 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5704 #---------------------------------------------------------------------------
5706 class InitDialogEvent(Event
):
5708 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5709 any window when `wx.Window.InitDialog` is called. Handlers for this
5710 event can transfer data to the window, or anything else that should be
5711 done before the user begins editing the form. The default handler
5712 calls `wx.Window.TransferDataToWindow`.
5714 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5715 __repr__
= _swig_repr
5716 def __init__(self
, *args
, **kwargs
):
5718 __init__(self, int Id=0) -> InitDialogEvent
5722 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5723 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5725 #---------------------------------------------------------------------------
5727 class MenuEvent(Event
):
5729 This class is used for a variety of menu-related events. Note that
5730 these do not include menu command events, which are handled by sending
5731 `wx.CommandEvent` objects.
5733 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5734 text in the first field of the status bar.
5736 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5737 __repr__
= _swig_repr
5738 def __init__(self
, *args
, **kwargs
):
5740 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5744 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5745 def GetMenuId(*args
, **kwargs
):
5747 GetMenuId(self) -> int
5749 Returns the menu identifier associated with the event. This method
5750 should be only used with the HIGHLIGHT events.
5752 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5754 def IsPopup(*args
, **kwargs
):
5756 IsPopup(self) -> bool
5758 Returns ``True`` if the menu which is being opened or closed is a
5759 popup menu, ``False`` if it is a normal one. This method should only
5760 be used with the OPEN and CLOSE events.
5762 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5764 def GetMenu(*args
, **kwargs
):
5766 GetMenu(self) -> Menu
5768 Returns the menu which is being opened or closed. This method should
5769 only be used with the OPEN and CLOSE events.
5771 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5773 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5774 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5775 _core_
.MenuEvent_swigregister(MenuEvent
)
5777 #---------------------------------------------------------------------------
5779 class CloseEvent(Event
):
5781 This event class contains information about window and session close
5784 The handler function for EVT_CLOSE is called when the user has tried
5785 to close a a frame or dialog box using the window manager controls or
5786 the system menu. It can also be invoked by the application itself
5787 programmatically, for example by calling the `wx.Window.Close`
5790 You should check whether the application is forcing the deletion of
5791 the window using `CanVeto`. If it returns ``False``, you must destroy
5792 the window using `wx.Window.Destroy`. If the return value is ``True``,
5793 it is up to you whether you respond by destroying the window or not.
5794 For example you may wish to display a message dialog prompting to save
5795 files or to cancel the close.
5797 If you don't destroy the window, you should call `Veto` to let the
5798 calling code know that you did not destroy the window. This allows the
5799 `wx.Window.Close` function to return ``True`` or ``False`` depending
5800 on whether the close instruction was honored or not.
5802 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5803 __repr__
= _swig_repr
5804 def __init__(self
, *args
, **kwargs
):
5806 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5810 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5811 def SetLoggingOff(*args
, **kwargs
):
5813 SetLoggingOff(self, bool logOff)
5815 Sets the 'logging off' flag.
5817 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5819 def GetLoggingOff(*args
, **kwargs
):
5821 GetLoggingOff(self) -> bool
5823 Returns ``True`` if the user is logging off or ``False`` if the
5824 system is shutting down. This method can only be called for end
5825 session and query end session events, it doesn't make sense for close
5828 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5830 def Veto(*args
, **kwargs
):
5832 Veto(self, bool veto=True)
5834 Call this from your event handler to veto a system shutdown or to
5835 signal to the calling application that a window close did not happen.
5837 You can only veto a shutdown or close if `CanVeto` returns true.
5839 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5841 def GetVeto(*args
, **kwargs
):
5842 """GetVeto(self) -> bool"""
5843 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5845 def SetCanVeto(*args
, **kwargs
):
5847 SetCanVeto(self, bool canVeto)
5849 Sets the 'can veto' flag.
5851 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5853 def CanVeto(*args
, **kwargs
):
5855 CanVeto(self) -> bool
5857 Returns true if you can veto a system shutdown or a window close
5858 event. Vetoing a window close event is not possible if the calling
5859 code wishes to force the application to exit, and so this function
5860 must be called to check this.
5862 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5864 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5865 _core_
.CloseEvent_swigregister(CloseEvent
)
5867 #---------------------------------------------------------------------------
5869 class ShowEvent(Event
):
5870 """An EVT_SHOW event is sent when a window is shown or hidden."""
5871 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5872 __repr__
= _swig_repr
5873 def __init__(self
, *args
, **kwargs
):
5875 __init__(self, int winid=0, bool show=False) -> ShowEvent
5877 An EVT_SHOW event is sent when a window is shown or hidden.
5879 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5880 def SetShow(*args
, **kwargs
):
5881 """SetShow(self, bool show)"""
5882 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5884 def GetShow(*args
, **kwargs
):
5885 """GetShow(self) -> bool"""
5886 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5888 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5889 _core_
.ShowEvent_swigregister(ShowEvent
)
5891 #---------------------------------------------------------------------------
5893 class IconizeEvent(Event
):
5895 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5898 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5899 __repr__
= _swig_repr
5900 def __init__(self
, *args
, **kwargs
):
5902 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5904 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5907 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5908 def Iconized(*args
, **kwargs
):
5910 Iconized(self) -> bool
5912 Returns ``True`` if the frame has been iconized, ``False`` if it has
5915 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5917 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5919 #---------------------------------------------------------------------------
5921 class MaximizeEvent(Event
):
5922 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5923 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5924 __repr__
= _swig_repr
5925 def __init__(self
, *args
, **kwargs
):
5927 __init__(self, int id=0) -> MaximizeEvent
5929 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5931 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5932 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5934 #---------------------------------------------------------------------------
5936 class DropFilesEvent(Event
):
5938 This class is used for drop files events, that is, when files have
5939 been dropped onto the window. This functionality is only available
5940 under Windows. The window must have previously been enabled for
5941 dropping by calling `wx.Window.DragAcceptFiles`.
5943 Important note: this is a separate implementation to the more general
5944 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5945 implementation uses the older, Windows message-based approach of
5948 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5952 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5953 def __init__(self
): raise AttributeError, "No constructor defined"
5954 __repr__
= _swig_repr
5955 def GetPosition(*args
, **kwargs
):
5957 GetPosition(self) -> Point
5959 Returns the position at which the files were dropped.
5961 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5963 def GetNumberOfFiles(*args
, **kwargs
):
5965 GetNumberOfFiles(self) -> int
5967 Returns the number of files dropped.
5969 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5971 def GetFiles(*args
, **kwargs
):
5973 GetFiles(self) -> PyObject
5975 Returns a list of the filenames that were dropped.
5977 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5979 Files
= property(GetFiles
,doc
="See `GetFiles`")
5980 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5981 Position
= property(GetPosition
,doc
="See `GetPosition`")
5982 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5984 #---------------------------------------------------------------------------
5986 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5987 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5988 class UpdateUIEvent(CommandEvent
):
5990 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5991 wxWidgets to give an application the chance to update various user
5994 Without update UI events, an application has to work hard to
5995 check/uncheck, enable/disable, and set the text for elements such as
5996 menu items and toolbar buttons. The code for doing this has to be
5997 mixed up with the code that is invoked when an action is invoked for a
5998 menu item or button.
6000 With update UI events, you define an event handler to look at the
6001 state of the application and change UI elements accordingly. wxWidgets
6002 will call your handler functions in idle time, so you don't have to
6003 worry where to call this code. In addition to being a clearer and more
6004 declarative method, it also means you don't have to worry whether
6005 you're updating a toolbar or menubar identifier. The same handler can
6006 update a menu item and toolbar button, if the ID values are the same.
6008 Instead of directly manipulating the menu or button, you call
6009 functions in the event object, such as `Check`. wxWidgets will
6010 determine whether such a call has been made, and which UI element to
6013 These events will work for popup menus as well as menubars. Just
6014 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6015 any UI events for the window that owns the menu.
6017 If you find that the overhead of UI update processing is affecting
6018 your application, you can do one or both of the following:
6020 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6021 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6022 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6023 receive update events. No other windows will receive update
6026 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6027 value to set the delay between updates. You may need to call
6028 `wx.Window.UpdateWindowUI` at critical points, for example when
6029 a dialog is about to be shown, in case the user sees a slight
6030 delay before windows are updated.
6032 Note that although events are sent in idle time, defining a EVT_IDLE
6033 handler for a window does not affect this because the events are sent
6034 from an internal idle handler.
6036 wxWidgets tries to optimize update events on some platforms. On
6037 Windows and GTK+, events for menubar items are only sent when the menu
6038 is about to be shown, and not in idle time.
6041 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6042 __repr__
= _swig_repr
6043 def __init__(self
, *args
, **kwargs
):
6045 __init__(self, int commandId=0) -> UpdateUIEvent
6049 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
6050 def GetChecked(*args
, **kwargs
):
6052 GetChecked(self) -> bool
6054 Returns ``True`` if the UI element should be checked.
6056 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6058 def GetEnabled(*args
, **kwargs
):
6060 GetEnabled(self) -> bool
6062 Returns ``True`` if the UI element should be enabled.
6064 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6066 def GetShown(*args
, **kwargs
):
6068 GetShown(self) -> bool
6070 Returns ``True`` if the UI element should be shown.
6072 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6074 def GetText(*args
, **kwargs
):
6076 GetText(self) -> String
6078 Returns the text that should be set for the UI element.
6080 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6082 def GetSetText(*args
, **kwargs
):
6084 GetSetText(self) -> bool
6086 Returns ``True`` if the application has called `SetText`. For
6087 wxWidgets internal use only.
6089 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6091 def GetSetChecked(*args
, **kwargs
):
6093 GetSetChecked(self) -> bool
6095 Returns ``True`` if the application has called `Check`. For wxWidgets
6098 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6100 def GetSetEnabled(*args
, **kwargs
):
6102 GetSetEnabled(self) -> bool
6104 Returns ``True`` if the application has called `Enable`. For wxWidgets
6107 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6109 def GetSetShown(*args
, **kwargs
):
6111 GetSetShown(self) -> bool
6113 Returns ``True`` if the application has called `Show`. For wxWidgets
6116 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6118 def Check(*args
, **kwargs
):
6120 Check(self, bool check)
6122 Check or uncheck the UI element.
6124 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6126 def Enable(*args
, **kwargs
):
6128 Enable(self, bool enable)
6130 Enable or disable the UI element.
6132 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6134 def Show(*args
, **kwargs
):
6136 Show(self, bool show)
6138 Show or hide the UI element.
6140 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6142 def SetText(*args
, **kwargs
):
6144 SetText(self, String text)
6146 Sets the text for this UI element.
6148 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6150 def SetUpdateInterval(*args
, **kwargs
):
6152 SetUpdateInterval(long updateInterval)
6154 Sets the interval between updates in milliseconds. Set to -1 to
6155 disable updates, or to 0 to update as frequently as possible. The
6158 Use this to reduce the overhead of UI update events if your
6159 application has a lot of windows. If you set the value to -1 or
6160 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6161 at appropriate points in your application, such as when a dialog is
6164 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6166 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6167 def GetUpdateInterval(*args
, **kwargs
):
6169 GetUpdateInterval() -> long
6171 Returns the current interval between updates in milliseconds. -1
6172 disables updates, 0 updates as frequently as possible.
6174 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6176 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6177 def CanUpdate(*args
, **kwargs
):
6179 CanUpdate(Window win) -> bool
6181 Returns ``True`` if it is appropriate to update (send UI update events
6184 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6185 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6186 events were last sent in idle time, and the update interval, to
6187 determine whether events should be sent to this window now. By default
6188 this will always return true because the update mode is initially
6189 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6190 events will be sent as often as possible. You can reduce the frequency
6191 that events are sent by changing the mode and/or setting an update
6195 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6197 CanUpdate
= staticmethod(CanUpdate
)
6198 def ResetUpdateTime(*args
, **kwargs
):
6202 Used internally to reset the last-updated time to the current time. It
6203 is assumed that update events are normally sent in idle time, so this
6204 is called at the end of idle processing.
6206 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6208 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6209 def SetMode(*args
, **kwargs
):
6213 Specify how wxWidgets will send update events: to all windows, or only
6214 to those which specify that they will process the events.
6216 The mode may be one of the following values:
6218 ============================= ==========================================
6219 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6220 is the default setting.
6221 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6222 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6224 ============================= ==========================================
6227 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6229 SetMode
= staticmethod(SetMode
)
6230 def GetMode(*args
, **kwargs
):
6234 Returns a value specifying how wxWidgets will send update events: to
6235 all windows, or only to those which specify that they will process the
6238 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6240 GetMode
= staticmethod(GetMode
)
6241 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
6242 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
6243 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
6244 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
6245 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
6247 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6249 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6251 Sets the interval between updates in milliseconds. Set to -1 to
6252 disable updates, or to 0 to update as frequently as possible. The
6255 Use this to reduce the overhead of UI update events if your
6256 application has a lot of windows. If you set the value to -1 or
6257 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6258 at appropriate points in your application, such as when a dialog is
6261 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6263 def UpdateUIEvent_GetUpdateInterval(*args
):
6265 UpdateUIEvent_GetUpdateInterval() -> long
6267 Returns the current interval between updates in milliseconds. -1
6268 disables updates, 0 updates as frequently as possible.
6270 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
6272 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6274 UpdateUIEvent_CanUpdate(Window win) -> bool
6276 Returns ``True`` if it is appropriate to update (send UI update events
6279 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6280 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6281 events were last sent in idle time, and the update interval, to
6282 determine whether events should be sent to this window now. By default
6283 this will always return true because the update mode is initially
6284 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6285 events will be sent as often as possible. You can reduce the frequency
6286 that events are sent by changing the mode and/or setting an update
6290 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6292 def UpdateUIEvent_ResetUpdateTime(*args
):
6294 UpdateUIEvent_ResetUpdateTime()
6296 Used internally to reset the last-updated time to the current time. It
6297 is assumed that update events are normally sent in idle time, so this
6298 is called at the end of idle processing.
6300 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6302 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6304 UpdateUIEvent_SetMode(int mode)
6306 Specify how wxWidgets will send update events: to all windows, or only
6307 to those which specify that they will process the events.
6309 The mode may be one of the following values:
6311 ============================= ==========================================
6312 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6313 is the default setting.
6314 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6315 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6317 ============================= ==========================================
6320 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6322 def UpdateUIEvent_GetMode(*args
):
6324 UpdateUIEvent_GetMode() -> int
6326 Returns a value specifying how wxWidgets will send update events: to
6327 all windows, or only to those which specify that they will process the
6330 return _core_
.UpdateUIEvent_GetMode(*args
)
6332 #---------------------------------------------------------------------------
6334 class SysColourChangedEvent(Event
):
6336 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6337 when the user changes the colour settings using the control
6338 panel. This is only applicable under Windows.
6340 The default event handler for this event propagates the event to child
6341 windows, since Windows only sends the events to top-level windows. If
6342 intercepting this event for a top-level window, remember to call
6343 `Skip` so the the base class handler will still be executed, or to
6344 pass the event on to the window's children explicitly.
6347 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6348 __repr__
= _swig_repr
6349 def __init__(self
, *args
, **kwargs
):
6351 __init__(self) -> SysColourChangedEvent
6355 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6356 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6358 #---------------------------------------------------------------------------
6360 class MouseCaptureChangedEvent(Event
):
6362 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6363 a window that loses its mouse capture. This is called even if
6364 `wx.Window.ReleaseMouse` was called by the application code. Handling
6365 this event allows an application to cater for unexpected capture
6366 releases which might otherwise confuse mouse handling code.
6368 This event is implemented under Windows only.
6370 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6371 __repr__
= _swig_repr
6372 def __init__(self
, *args
, **kwargs
):
6374 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6378 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6379 def GetCapturedWindow(*args
, **kwargs
):
6381 GetCapturedWindow(self) -> Window
6383 Returns the window that gained the capture, or ``None`` if it was a
6384 non-wxWidgets window.
6386 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6388 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6389 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6391 #---------------------------------------------------------------------------
6393 class MouseCaptureLostEvent(Event
):
6395 A mouse capture lost event is sent to a window that obtained mouse
6396 capture, which was subsequently loss due to "external" event, for
6397 example when a dialog box is shown or if another application captures
6400 If this happens, this event is sent to all windows that are on the
6401 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6402 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6403 if the capture changes because of a call to CaptureMouse or
6406 This event is currently emitted under Windows only.
6409 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6410 __repr__
= _swig_repr
6411 def __init__(self
, *args
, **kwargs
):
6413 __init__(self, int winid=0) -> MouseCaptureLostEvent
6415 A mouse capture lost event is sent to a window that obtained mouse
6416 capture, which was subsequently loss due to "external" event, for
6417 example when a dialog box is shown or if another application captures
6420 If this happens, this event is sent to all windows that are on the
6421 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6422 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6423 if the capture changes because of a call to CaptureMouse or
6426 This event is currently emitted under Windows only.
6429 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6430 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6432 #---------------------------------------------------------------------------
6434 class DisplayChangedEvent(Event
):
6436 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6437 resolution has changed.
6439 This event is implemented under Windows only.
6441 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6442 __repr__
= _swig_repr
6443 def __init__(self
, *args
, **kwargs
):
6444 """__init__(self) -> DisplayChangedEvent"""
6445 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6446 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6448 #---------------------------------------------------------------------------
6450 class PaletteChangedEvent(Event
):
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6456 This event is implemented under Windows only.
6458 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6459 __repr__
= _swig_repr
6460 def __init__(self
, *args
, **kwargs
):
6462 __init__(self, int id=0) -> PaletteChangedEvent
6464 An EVT_PALETTE_CHANGED event is sent when the system palette has
6465 changed, thereby giving each window a chance to redo their own to
6468 This event is implemented under Windows only.
6470 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6471 def SetChangedWindow(*args
, **kwargs
):
6472 """SetChangedWindow(self, Window win)"""
6473 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6475 def GetChangedWindow(*args
, **kwargs
):
6476 """GetChangedWindow(self) -> Window"""
6477 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6479 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6480 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6482 #---------------------------------------------------------------------------
6484 class QueryNewPaletteEvent(Event
):
6486 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6487 focus and should re-do its palette.
6489 This event is implemented under Windows only.
6491 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6492 __repr__
= _swig_repr
6493 def __init__(self
, *args
, **kwargs
):
6495 __init__(self, int winid=0) -> QueryNewPaletteEvent
6499 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6500 def SetPaletteRealized(*args
, **kwargs
):
6502 SetPaletteRealized(self, bool realized)
6504 App should set this if it changes the palette.
6506 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6508 def GetPaletteRealized(*args
, **kwargs
):
6509 """GetPaletteRealized(self) -> bool"""
6510 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6512 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6513 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6515 #---------------------------------------------------------------------------
6517 class NavigationKeyEvent(Event
):
6519 EVT_NAVIGATION_KEY events are used to control moving the focus between
6520 widgets, otherwise known as tab-traversal. You woudl normally not
6521 catch navigation events in applications as there are already
6522 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6523 it useful to send navigation events in certain situations to change
6524 the focus in certain ways, although it's probably easier to just call
6525 `wx.Window.Navigate`.
6527 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6528 __repr__
= _swig_repr
6529 def __init__(self
, *args
, **kwargs
):
6530 """__init__(self) -> NavigationKeyEvent"""
6531 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6532 def GetDirection(*args
, **kwargs
):
6534 GetDirection(self) -> bool
6536 Returns ``True`` if the direction is forward, ``False`` otherwise.
6538 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6540 def SetDirection(*args
, **kwargs
):
6542 SetDirection(self, bool forward)
6544 Specify the direction that the navigation should take. Usually the
6545 difference between using Tab and Shift-Tab.
6547 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6549 def IsWindowChange(*args
, **kwargs
):
6551 IsWindowChange(self) -> bool
6553 Returns ``True`` if window change is allowed.
6555 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6557 def SetWindowChange(*args
, **kwargs
):
6559 SetWindowChange(self, bool ischange)
6561 Specify if the navigation should be able to change parent windows.
6562 For example, changing notebook pages, etc. This is usually implemented
6563 by using Control-Tab.
6565 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6567 def IsFromTab(*args
, **kwargs
):
6569 IsFromTab(self) -> bool
6571 Returns ``True`` if the navigation event is originated from the Tab
6574 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6576 def SetFromTab(*args
, **kwargs
):
6578 SetFromTab(self, bool bIs)
6580 Set to true under MSW if the event was generated using the tab key.
6581 This is required for proper navogation over radio buttons.
6583 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6585 def SetFlags(*args
, **kwargs
):
6587 SetFlags(self, long flags)
6589 Set the navigation flags to a combination of the following:
6591 * wx.NavigationKeyEvent.IsBackward
6592 * wx.NavigationKeyEvent.IsForward
6593 * wx.NavigationKeyEvent.WinChange
6594 * wx.NavigationKeyEvent.FromTab
6597 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6599 def GetCurrentFocus(*args
, **kwargs
):
6601 GetCurrentFocus(self) -> Window
6603 Returns the child window which currenty has the focus. May be
6606 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6608 def SetCurrentFocus(*args
, **kwargs
):
6610 SetCurrentFocus(self, Window win)
6612 Set the window that has the focus.
6614 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6616 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6617 IsForward
= _core_
.NavigationKeyEvent_IsForward
6618 WinChange
= _core_
.NavigationKeyEvent_WinChange
6619 FromTab
= _core_
.NavigationKeyEvent_FromTab
6620 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6621 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6622 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6624 #---------------------------------------------------------------------------
6626 class WindowCreateEvent(CommandEvent
):
6628 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6629 underlying GUI object) exists.
6631 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6632 __repr__
= _swig_repr
6633 def __init__(self
, *args
, **kwargs
):
6635 __init__(self, Window win=None) -> WindowCreateEvent
6637 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6638 underlying GUI object) exists.
6640 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6641 def GetWindow(*args
, **kwargs
):
6643 GetWindow(self) -> Window
6645 Returns the window that this event refers to.
6647 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6649 Window
= property(GetWindow
,doc
="See `GetWindow`")
6650 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6652 class WindowDestroyEvent(CommandEvent
):
6654 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6655 when the GUI window is destroyed.
6657 When a class derived from `wx.Window` is destroyed its destructor will
6658 have already run by the time this event is sent. Therefore this event
6659 will not usually be received at all by the window itself. Since it is
6660 received after the destructor has run, an object should not try to
6661 handle its own wx.WindowDestroyEvent, but it can be used to get
6662 notification of the destruction of another window.
6664 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6665 __repr__
= _swig_repr
6666 def __init__(self
, *args
, **kwargs
):
6668 __init__(self, Window win=None) -> WindowDestroyEvent
6670 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6671 when the GUI window is destroyed.
6673 When a class derived from `wx.Window` is destroyed its destructor will
6674 have already run by the time this event is sent. Therefore this event
6675 will not usually be received at all by the window itself. Since it is
6676 received after the destructor has run, an object should not try to
6677 handle its own wx.WindowDestroyEvent, but it can be used to get
6678 notification of the destruction of another window.
6680 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6681 def GetWindow(*args
, **kwargs
):
6683 GetWindow(self) -> Window
6685 Returns the window that this event refers to.
6687 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6689 Window
= property(GetWindow
,doc
="See `GetWindow`")
6690 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6692 #---------------------------------------------------------------------------
6694 class ContextMenuEvent(CommandEvent
):
6696 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6697 give the application a chance to show a context (popup) menu.
6699 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6700 __repr__
= _swig_repr
6701 def __init__(self
, *args
, **kwargs
):
6703 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6707 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6708 def GetPosition(*args
, **kwargs
):
6710 GetPosition(self) -> Point
6712 Returns the position (in screen coordinants) at which the menu should
6715 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6717 def SetPosition(*args
, **kwargs
):
6719 SetPosition(self, Point pos)
6721 Sets the position at which the menu should be shown.
6723 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6725 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6726 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6728 #---------------------------------------------------------------------------
6730 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6731 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6732 class IdleEvent(Event
):
6734 This class is used for EVT_IDLE events, which are generated and sent
6735 when the application *becomes* idle. In other words, the when the
6736 event queue becomes empty then idle events are sent to all windows (by
6737 default) and as long as none of them call `RequestMore` then there are
6738 no more idle events until after the system event queue has some normal
6739 events and then becomes empty again.
6741 By default, idle events are sent to all windows. If this is causing a
6742 significant overhead in your application, you can call
6743 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6744 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6745 which should receive idle events. Then idle events will only be sent
6746 to those windows and not to any others.
6748 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6749 __repr__
= _swig_repr
6750 def __init__(self
, *args
, **kwargs
):
6752 __init__(self) -> IdleEvent
6756 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6757 def RequestMore(*args
, **kwargs
):
6759 RequestMore(self, bool needMore=True)
6761 Tells wxWidgets that more processing is required. This function can be
6762 called by an EVT_IDLE handler for a window to indicate that the
6763 application should forward the EVT_IDLE event once more to the
6764 application windows. If no window calls this function during its
6765 EVT_IDLE handler, then the application will remain in a passive event
6766 loop until a new event is posted to the application by the windowing
6769 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6771 def MoreRequested(*args
, **kwargs
):
6773 MoreRequested(self) -> bool
6775 Returns ``True`` if the OnIdle function processing this event
6776 requested more processing time.
6778 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6780 def SetMode(*args
, **kwargs
):
6784 Static method for specifying how wxWidgets will send idle events: to
6785 all windows, or only to those which specify that they will process the
6788 The mode can be one of the following values:
6790 ========================= ========================================
6791 wx.IDLE_PROCESS_ALL Send idle events to all windows
6792 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6793 the wx.WS_EX_PROCESS_IDLE extra style
6795 ========================= ========================================
6798 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6800 SetMode
= staticmethod(SetMode
)
6801 def GetMode(*args
, **kwargs
):
6805 Static method returning a value specifying how wxWidgets will send
6806 idle events: to all windows, or only to those which specify that they
6807 will process the events.
6809 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6811 GetMode
= staticmethod(GetMode
)
6812 def CanSend(*args
, **kwargs
):
6814 CanSend(Window win) -> bool
6816 Returns ``True`` if it is appropriate to send idle events to this
6819 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6820 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6821 events should be sent to this window now. By default this will always
6822 return ``True`` because the update mode is initially
6823 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6824 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6826 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6828 CanSend
= staticmethod(CanSend
)
6829 _core_
.IdleEvent_swigregister(IdleEvent
)
6831 def IdleEvent_SetMode(*args
, **kwargs
):
6833 IdleEvent_SetMode(int mode)
6835 Static method for specifying how wxWidgets will send idle events: to
6836 all windows, or only to those which specify that they will process the
6839 The mode can be one of the following values:
6841 ========================= ========================================
6842 wx.IDLE_PROCESS_ALL Send idle events to all windows
6843 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6844 the wx.WS_EX_PROCESS_IDLE extra style
6846 ========================= ========================================
6849 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6851 def IdleEvent_GetMode(*args
):
6853 IdleEvent_GetMode() -> int
6855 Static method returning a value specifying how wxWidgets will send
6856 idle events: to all windows, or only to those which specify that they
6857 will process the events.
6859 return _core_
.IdleEvent_GetMode(*args
)
6861 def IdleEvent_CanSend(*args
, **kwargs
):
6863 IdleEvent_CanSend(Window win) -> bool
6865 Returns ``True`` if it is appropriate to send idle events to this
6868 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6869 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6870 events should be sent to this window now. By default this will always
6871 return ``True`` because the update mode is initially
6872 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6873 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6875 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6877 #---------------------------------------------------------------------------
6879 class ClipboardTextEvent(CommandEvent
):
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6887 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6888 __repr__
= _swig_repr
6889 def __init__(self
, *args
, **kwargs
):
6891 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6893 A Clipboard Text event is sent when a window intercepts a text
6894 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6895 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6896 popup menu command, etc. NOTE : under windows these events are *NOT*
6897 generated automatically for a Rich Edit text control.
6899 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6900 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6902 #---------------------------------------------------------------------------
6904 class PyEvent(Event
):
6906 wx.PyEvent can be used as a base class for implementing custom event
6907 types in Python. You should derived from this class instead of
6908 `wx.Event` because this class is Python-aware and is able to transport
6909 its Python bits safely through the wxWidgets event system and have
6910 them still be there when the event handler is invoked.
6912 :see: `wx.PyCommandEvent`
6915 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6916 __repr__
= _swig_repr
6917 def __init__(self
, *args
, **kwargs
):
6918 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6919 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6922 __swig_destroy__
= _core_
.delete_PyEvent
6923 __del__
= lambda self
: None;
6924 def _SetSelf(*args
, **kwargs
):
6925 """_SetSelf(self, PyObject self)"""
6926 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6928 def _GetSelf(*args
, **kwargs
):
6929 """_GetSelf(self) -> PyObject"""
6930 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6932 _core_
.PyEvent_swigregister(PyEvent
)
6934 class PyCommandEvent(CommandEvent
):
6936 wx.PyCommandEvent can be used as a base class for implementing custom
6937 event types in Python, where the event shoudl travel up to parent
6938 windows looking for a handler. You should derived from this class
6939 instead of `wx.CommandEvent` because this class is Python-aware and is
6940 able to transport its Python bits safely through the wxWidgets event
6941 system and have them still be there when the event handler is invoked.
6946 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6947 __repr__
= _swig_repr
6948 def __init__(self
, *args
, **kwargs
):
6949 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6950 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6953 __swig_destroy__
= _core_
.delete_PyCommandEvent
6954 __del__
= lambda self
: None;
6955 def _SetSelf(*args
, **kwargs
):
6956 """_SetSelf(self, PyObject self)"""
6957 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6959 def _GetSelf(*args
, **kwargs
):
6960 """_GetSelf(self) -> PyObject"""
6961 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6963 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6965 class DateEvent(CommandEvent
):
6967 This event class holds information about a date change event and is
6968 used together with `wx.DatePickerCtrl`. It also serves as a base class
6969 for `wx.calendar.CalendarEvent`. Bind these event types with
6972 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6973 __repr__
= _swig_repr
6974 def __init__(self
, *args
, **kwargs
):
6975 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6976 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6977 def GetDate(*args
, **kwargs
):
6979 GetDate(self) -> DateTime
6983 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6985 def SetDate(*args
, **kwargs
):
6987 SetDate(self, DateTime date)
6989 Sets the date carried by the event, normally only used by the library
6992 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6994 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6995 _core_
.DateEvent_swigregister(DateEvent
)
6997 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6998 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
7000 #---------------------------------------------------------------------------
7002 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
7003 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
7004 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
7005 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
7006 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
7007 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
7008 class PyApp(EvtHandler
):
7010 The ``wx.PyApp`` class is an *implementation detail*, please use the
7011 `wx.App` class (or some other derived class) instead.
7013 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7014 __repr__
= _swig_repr
7015 def __init__(self
, *args
, **kwargs
):
7017 __init__(self) -> PyApp
7019 Create a new application object, starting the bootstrap process.
7021 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
7022 self
._setCallbackInfo
(self
, PyApp
, False)
7023 self
._setOORInfo
(self
, False)
7025 __swig_destroy__
= _core_
.delete_PyApp
7026 __del__
= lambda self
: None;
7027 def _setCallbackInfo(*args
, **kwargs
):
7028 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
7029 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
7031 def GetAppName(*args
, **kwargs
):
7033 GetAppName(self) -> String
7035 Get the application name.
7037 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
7039 def SetAppName(*args
, **kwargs
):
7041 SetAppName(self, String name)
7043 Set the application name. This value may be used automatically by
7044 `wx.Config` and such.
7046 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
7048 def GetClassName(*args
, **kwargs
):
7050 GetClassName(self) -> String
7052 Get the application's class name.
7054 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
7056 def SetClassName(*args
, **kwargs
):
7058 SetClassName(self, String name)
7060 Set the application's class name. This value may be used for
7061 X-resources if applicable for the platform
7063 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
7065 def GetVendorName(*args
, **kwargs
):
7067 GetVendorName(self) -> String
7069 Get the application's vendor name.
7071 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
7073 def SetVendorName(*args
, **kwargs
):
7075 SetVendorName(self, String name)
7077 Set the application's vendor name. This value may be used
7078 automatically by `wx.Config` and such.
7080 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
7082 def GetTraits(*args
, **kwargs
):
7084 GetTraits(self) -> wxAppTraits
7086 Return (and create if necessary) the app traits object to which we
7087 delegate for everything which either should be configurable by the
7088 user (then he can change the default behaviour simply by overriding
7089 CreateTraits() and returning his own traits object) or which is
7090 GUI/console dependent as then wx.AppTraits allows us to abstract the
7091 differences behind the common facade.
7093 :todo: Add support for overriding CreateAppTraits in wxPython.
7095 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
7097 def ProcessPendingEvents(*args
, **kwargs
):
7099 ProcessPendingEvents(self)
7101 Process all events in the Pending Events list -- it is necessary to
7102 call this function to process posted events. This normally happens
7103 during each event loop iteration.
7105 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
7107 def Yield(*args
, **kwargs
):
7109 Yield(self, bool onlyIfNeeded=False) -> bool
7111 Process all currently pending events right now, instead of waiting
7112 until return to the event loop. It is an error to call ``Yield``
7113 recursively unless the value of ``onlyIfNeeded`` is True.
7115 :warning: This function is dangerous as it can lead to unexpected
7116 reentrancies (i.e. when called from an event handler it may
7117 result in calling the same event handler again), use with
7118 extreme care or, better, don't use at all!
7120 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7123 return _core_
.PyApp_Yield(*args
, **kwargs
)
7125 def WakeUpIdle(*args
, **kwargs
):
7129 Make sure that idle events are sent again.
7130 :see: `wx.WakeUpIdle`
7132 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
7134 def IsMainLoopRunning(*args
, **kwargs
):
7136 IsMainLoopRunning() -> bool
7138 Returns True if we're running the main loop, i.e. if the events can
7139 currently be dispatched.
7141 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7143 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
7144 def MainLoop(*args
, **kwargs
):
7146 MainLoop(self) -> int
7148 Execute the main GUI loop, the function doesn't normally return until
7149 all top level windows have been closed and destroyed.
7151 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
7153 def Exit(*args
, **kwargs
):
7157 Exit the main loop thus terminating the application.
7160 return _core_
.PyApp_Exit(*args
, **kwargs
)
7162 def GetLayoutDirection(*args
, **kwargs
):
7164 GetLayoutDirection(self) -> int
7166 Return the layout direction for the current locale.
7168 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
7170 def ExitMainLoop(*args
, **kwargs
):
7174 Exit the main GUI loop during the next iteration of the main
7175 loop, (i.e. it does not stop the program immediately!)
7177 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
7179 def Pending(*args
, **kwargs
):
7181 Pending(self) -> bool
7183 Returns True if there are unprocessed events in the event queue.
7185 return _core_
.PyApp_Pending(*args
, **kwargs
)
7187 def Dispatch(*args
, **kwargs
):
7189 Dispatch(self) -> bool
7191 Process the first event in the event queue (blocks until an event
7192 appears if there are none currently)
7194 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
7196 def ProcessIdle(*args
, **kwargs
):
7198 ProcessIdle(self) -> bool
7200 Called from the MainLoop when the application becomes idle (there are
7201 no pending events) and sends a `wx.IdleEvent` to all interested
7202 parties. Returns True if more idle events are needed, False if not.
7204 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
7206 def SendIdleEvents(*args
, **kwargs
):
7208 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7210 Send idle event to window and all subwindows. Returns True if more
7211 idle time is requested.
7213 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
7215 def IsActive(*args
, **kwargs
):
7217 IsActive(self) -> bool
7219 Return True if our app has focus.
7221 return _core_
.PyApp_IsActive(*args
, **kwargs
)
7223 def SetTopWindow(*args
, **kwargs
):
7225 SetTopWindow(self, Window win)
7227 Set the *main* top level window
7229 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
7231 def GetTopWindow(*args
, **kwargs
):
7233 GetTopWindow(self) -> Window
7235 Return the *main* top level window (if it hadn't been set previously
7236 with SetTopWindow(), will return just some top level window and, if
7237 there not any, will return None)
7239 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
7241 def SetExitOnFrameDelete(*args
, **kwargs
):
7243 SetExitOnFrameDelete(self, bool flag)
7245 Control the exit behaviour: by default, the program will exit the main
7246 loop (and so, usually, terminate) when the last top-level program
7247 window is deleted. Beware that if you disable this behaviour (with
7248 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7249 explicitly from somewhere.
7251 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
7253 def GetExitOnFrameDelete(*args
, **kwargs
):
7255 GetExitOnFrameDelete(self) -> bool
7257 Get the current exit behaviour setting.
7259 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
7261 def SetUseBestVisual(*args
, **kwargs
):
7263 SetUseBestVisual(self, bool flag)
7265 Set whether the app should try to use the best available visual on
7266 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7268 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
7270 def GetUseBestVisual(*args
, **kwargs
):
7272 GetUseBestVisual(self) -> bool
7274 Get current UseBestVisual setting.
7276 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7278 def SetPrintMode(*args
, **kwargs
):
7279 """SetPrintMode(self, int mode)"""
7280 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7282 def GetPrintMode(*args
, **kwargs
):
7283 """GetPrintMode(self) -> int"""
7284 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7286 def SetAssertMode(*args
, **kwargs
):
7288 SetAssertMode(self, int mode)
7290 Set the OnAssert behaviour for debug and hybrid builds.
7292 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7294 def GetAssertMode(*args
, **kwargs
):
7296 GetAssertMode(self) -> int
7298 Get the current OnAssert behaviour setting.
7300 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7302 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7303 """GetMacSupportPCMenuShortcuts() -> bool"""
7304 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7306 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7307 def GetMacAboutMenuItemId(*args
, **kwargs
):
7308 """GetMacAboutMenuItemId() -> long"""
7309 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7311 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7312 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7313 """GetMacPreferencesMenuItemId() -> long"""
7314 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7316 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7317 def GetMacExitMenuItemId(*args
, **kwargs
):
7318 """GetMacExitMenuItemId() -> long"""
7319 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7321 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7322 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7323 """GetMacHelpMenuTitleName() -> String"""
7324 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7326 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7327 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7328 """SetMacSupportPCMenuShortcuts(bool val)"""
7329 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7331 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7332 def SetMacAboutMenuItemId(*args
, **kwargs
):
7333 """SetMacAboutMenuItemId(long val)"""
7334 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7336 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7337 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7338 """SetMacPreferencesMenuItemId(long val)"""
7339 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7341 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7342 def SetMacExitMenuItemId(*args
, **kwargs
):
7343 """SetMacExitMenuItemId(long val)"""
7344 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7346 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7347 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7348 """SetMacHelpMenuTitleName(String val)"""
7349 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7351 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7352 def _BootstrapApp(*args
, **kwargs
):
7356 For internal use only
7358 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7360 def GetComCtl32Version(*args
, **kwargs
):
7362 GetComCtl32Version() -> int
7364 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7365 it wasn't found at all. Raises an exception on non-Windows platforms.
7367 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7369 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7370 def IsDisplayAvailable(*args
, **kwargs
):
7372 IsDisplayAvailable() -> bool
7374 Tests if it is possible to create a GUI in the current environment.
7375 This will mean different things on the different platforms.
7377 * On X Windows systems this function will return ``False`` if it is
7378 not able to open a connection to the X display, which can happen
7379 if $DISPLAY is not set, or is not set correctly.
7381 * On Mac OS X a ``False`` return value will mean that wx is not
7382 able to access the window manager, which can happen if logged in
7383 remotely or if running from the normal version of python instead
7384 of the framework version, (i.e., pythonw.)
7389 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7391 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7392 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7393 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7394 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7395 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7396 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7397 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7398 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7399 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7400 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7401 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7402 Active
= property(IsActive
)
7403 _core_
.PyApp_swigregister(PyApp
)
7405 def PyApp_IsMainLoopRunning(*args
):
7407 PyApp_IsMainLoopRunning() -> bool
7409 Returns True if we're running the main loop, i.e. if the events can
7410 currently be dispatched.
7412 return _core_
.PyApp_IsMainLoopRunning(*args
)
7414 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7415 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7416 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7418 def PyApp_GetMacAboutMenuItemId(*args
):
7419 """PyApp_GetMacAboutMenuItemId() -> long"""
7420 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7422 def PyApp_GetMacPreferencesMenuItemId(*args
):
7423 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7424 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7426 def PyApp_GetMacExitMenuItemId(*args
):
7427 """PyApp_GetMacExitMenuItemId() -> long"""
7428 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7430 def PyApp_GetMacHelpMenuTitleName(*args
):
7431 """PyApp_GetMacHelpMenuTitleName() -> String"""
7432 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7434 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7435 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7436 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7438 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7439 """PyApp_SetMacAboutMenuItemId(long val)"""
7440 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7442 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7443 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7444 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7446 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7447 """PyApp_SetMacExitMenuItemId(long val)"""
7448 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7450 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7451 """PyApp_SetMacHelpMenuTitleName(String val)"""
7452 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7454 def PyApp_GetComCtl32Version(*args
):
7456 PyApp_GetComCtl32Version() -> int
7458 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7459 it wasn't found at all. Raises an exception on non-Windows platforms.
7461 return _core_
.PyApp_GetComCtl32Version(*args
)
7463 def PyApp_IsDisplayAvailable(*args
):
7465 PyApp_IsDisplayAvailable() -> bool
7467 Tests if it is possible to create a GUI in the current environment.
7468 This will mean different things on the different platforms.
7470 * On X Windows systems this function will return ``False`` if it is
7471 not able to open a connection to the X display, which can happen
7472 if $DISPLAY is not set, or is not set correctly.
7474 * On Mac OS X a ``False`` return value will mean that wx is not
7475 able to access the window manager, which can happen if logged in
7476 remotely or if running from the normal version of python instead
7477 of the framework version, (i.e., pythonw.)
7482 return _core_
.PyApp_IsDisplayAvailable(*args
)
7484 #---------------------------------------------------------------------------
7491 Force an exit of the application. Convenience for wx.GetApp().Exit()
7493 return _core_
.Exit(*args
)
7499 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7501 return _core_
.Yield(*args
)
7503 def YieldIfNeeded(*args
):
7505 YieldIfNeeded() -> bool
7507 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7509 return _core_
.YieldIfNeeded(*args
)
7511 def SafeYield(*args
, **kwargs
):
7513 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7515 This function is similar to `wx.Yield`, except that it disables the
7516 user input to all program windows before calling `wx.Yield` and
7517 re-enables it again afterwards. If ``win`` is not None, this window
7518 will remain enabled, allowing the implementation of some limited user
7521 :Returns: the result of the call to `wx.Yield`.
7523 return _core_
.SafeYield(*args
, **kwargs
)
7525 def WakeUpIdle(*args
):
7529 Cause the message queue to become empty again, so idle events will be
7532 return _core_
.WakeUpIdle(*args
)
7534 def PostEvent(*args
, **kwargs
):
7536 PostEvent(EvtHandler dest, Event event)
7538 Send an event to a window or other wx.EvtHandler to be processed
7541 return _core_
.PostEvent(*args
, **kwargs
)
7543 def App_CleanUp(*args
):
7547 For internal use only, it is used to cleanup after wxWidgets when
7550 return _core_
.App_CleanUp(*args
)
7556 Return a reference to the current wx.App object.
7558 return _core_
.GetApp(*args
)
7560 def SetDefaultPyEncoding(*args
, **kwargs
):
7562 SetDefaultPyEncoding(string encoding)
7564 Sets the encoding that wxPython will use when it needs to convert a
7565 Python string or unicode object to or from a wxString.
7567 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7568 but please be aware that the default encoding within the same locale
7569 may be slightly different on different platforms. For example, please
7570 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7571 between the common latin/roman encodings.
7573 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7575 def GetDefaultPyEncoding(*args
):
7577 GetDefaultPyEncoding() -> string
7579 Gets the current encoding that wxPython will use when it needs to
7580 convert a Python string or unicode object to or from a wxString.
7582 return _core_
.GetDefaultPyEncoding(*args
)
7583 #----------------------------------------------------------------------
7585 class PyOnDemandOutputWindow
:
7587 A class that can be used for redirecting Python's stdout and
7588 stderr streams. It will do nothing until something is wrriten to
7589 the stream at which point it will create a Frame with a text area
7590 and write the text there.
7592 def __init__(self
, title
= "wxPython: stdout/stderr"):
7595 self
.pos
= wx
.DefaultPosition
7596 self
.size
= (450, 300)
7599 def SetParent(self
, parent
):
7600 """Set the window to be used as the popup Frame's parent."""
7601 self
.parent
= parent
7604 def CreateOutputWindow(self
, st
):
7605 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7606 style
=wx
.DEFAULT_FRAME_STYLE
)
7607 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7608 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7609 self
.text
.AppendText(st
)
7610 self
.frame
.Show(True)
7611 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7614 def OnCloseWindow(self
, event
):
7615 if self
.frame
is not None:
7616 self
.frame
.Destroy()
7621 # These methods provide the file-like output behaviour.
7622 def write(self
, text
):
7624 Create the output window if needed and write the string to it.
7625 If not called in the context of the gui thread then uses
7626 CallAfter to do the work there.
7628 if self
.frame
is None:
7629 if not wx
.Thread_IsMain():
7630 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7632 self
.CreateOutputWindow(text
)
7634 if not wx
.Thread_IsMain():
7635 wx
.CallAfter(self
.text
.AppendText
, text
)
7637 self
.text
.AppendText(text
)
7641 if self
.frame
is not None:
7642 wx
.CallAfter(self
.frame
.Close
)
7650 #----------------------------------------------------------------------
7652 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7654 class App(wx
.PyApp
):
7656 The ``wx.App`` class represents the application and is used to:
7658 * bootstrap the wxPython system and initialize the underlying
7660 * set and get application-wide properties
7661 * implement the windowing system main message or event loop,
7662 and to dispatch events to window instances
7665 Every application must have a ``wx.App`` instance, and all
7666 creation of UI objects should be delayed until after the
7667 ``wx.App`` object has been created in order to ensure that the gui
7668 platform and wxWidgets have been fully initialized.
7670 Normally you would derive from this class and implement an
7671 ``OnInit`` method that creates a frame and then calls
7672 ``self.SetTopWindow(frame)``.
7674 :see: `wx.PySimpleApp` for a simpler app class that can be used
7678 outputWindowClass
= PyOnDemandOutputWindow
7680 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7681 useBestVisual
=False, clearSigInt
=True):
7683 Construct a ``wx.App`` object.
7685 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7686 redirected? Defaults to True on Windows and Mac, False
7687 otherwise. If `filename` is None then output will be
7688 redirected to a window that pops up as needed. (You can
7689 control what kind of window is created for the output by
7690 resetting the class variable ``outputWindowClass`` to a
7691 class of your choosing.)
7693 :param filename: The name of a file to redirect output to, if
7696 :param useBestVisual: Should the app try to use the best
7697 available visual provided by the system (only relevant on
7698 systems that have more than one visual.) This parameter
7699 must be used instead of calling `SetUseBestVisual` later
7700 on because it must be set before the underlying GUI
7701 toolkit is initialized.
7703 :param clearSigInt: Should SIGINT be cleared? This allows the
7704 app to terminate upon a Ctrl-C in the console like other
7707 :note: You should override OnInit to do applicaition
7708 initialization to ensure that the system, toolkit and
7709 wxWidgets are fully initialized.
7712 wx
.PyApp
.__init
__(self
)
7714 # make sure we can create a GUI
7715 if not self
.IsDisplayAvailable():
7717 if wx
.Platform
== "__WXMAC__":
7718 msg
= """This program needs access to the screen.
7719 Please run with 'pythonw', not 'python', and only when you are logged
7720 in on the main display of your Mac."""
7722 elif wx
.Platform
== "__WXGTK__":
7723 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7726 msg
= "Unable to create GUI"
7727 # TODO: more description is needed for wxMSW...
7729 raise SystemExit(msg
)
7731 # This has to be done before OnInit
7732 self
.SetUseBestVisual(useBestVisual
)
7734 # Set the default handler for SIGINT. This fixes a problem
7735 # where if Ctrl-C is pressed in the console that started this
7736 # app then it will not appear to do anything, (not even send
7737 # KeyboardInterrupt???) but will later segfault on exit. By
7738 # setting the default handler then the app will exit, as
7739 # expected (depending on platform.)
7743 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7747 # Save and redirect the stdio to a window?
7748 self
.stdioWin
= None
7749 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7751 self
.RedirectStdio(filename
)
7753 # Use Python's install prefix as the default
7754 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7756 # This finishes the initialization of wxWindows and then calls
7757 # the OnInit that should be present in the derived class
7758 self
._BootstrapApp
()
7761 def OnPreInit(self
):
7763 Things that must be done after _BootstrapApp has done its
7764 thing, but would be nice if they were already done by the time
7765 that OnInit is called.
7767 wx
.StockGDI
._initStockObjects
()
7770 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7771 self
.RestoreStdio() # Just in case the MainLoop was overridden
7775 self
.this
.own(False)
7776 wx
.PyApp
.Destroy(self
)
7778 def SetTopWindow(self
, frame
):
7779 """Set the \"main\" top level window"""
7781 self
.stdioWin
.SetParent(frame
)
7782 wx
.PyApp
.SetTopWindow(self
, frame
)
7786 """Execute the main GUI event loop"""
7787 wx
.PyApp
.MainLoop(self
)
7791 def RedirectStdio(self
, filename
=None):
7792 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7794 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7796 self
.stdioWin
= self
.outputWindowClass()
7797 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7800 def RestoreStdio(self
):
7802 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7807 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7809 Set the title, position and/or size of the output window if
7810 the stdio has been redirected. This should be called before
7811 any output would cause the output window to be created.
7814 if title
is not None:
7815 self
.stdioWin
.title
= title
7817 self
.stdioWin
.pos
= pos
7818 if size
is not None:
7819 self
.stdioWin
.size
= size
7824 # change from wx.PyApp_XX to wx.App_XX
7825 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7826 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7827 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7828 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7829 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7830 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7831 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7832 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7833 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7834 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7835 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7837 #----------------------------------------------------------------------------
7839 class PySimpleApp(wx
.App
):
7841 A simple application class. You can just create one of these and
7842 then then make your top level windows later, and not have to worry
7843 about OnInit. For example::
7845 app = wx.PySimpleApp()
7846 frame = wx.Frame(None, title='Hello World')
7853 def __init__(self
, redirect
=False, filename
=None,
7854 useBestVisual
=False, clearSigInt
=True):
7856 :see: `wx.App.__init__`
7858 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7865 # Is anybody using this one?
7866 class PyWidgetTester(wx
.App
):
7867 def __init__(self
, size
= (250, 100)):
7869 wx
.App
.__init
__(self
, 0)
7872 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7873 self
.SetTopWindow(self
.frame
)
7876 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7877 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7878 self
.frame
.Show(True)
7880 #----------------------------------------------------------------------------
7881 # DO NOT hold any other references to this object. This is how we
7882 # know when to cleanup system resources that wxWidgets is holding. When
7883 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7884 # goes to zero and it calls the wx.App_CleanUp function.
7886 class __wxPyCleanup
:
7888 self
.cleanup
= _core_
.App_CleanUp
7892 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7894 ## # another possible solution, but it gets called too early...
7896 ## atexit.register(_core_.wxApp_CleanUp)
7899 #----------------------------------------------------------------------------
7901 #---------------------------------------------------------------------------
7903 class EventLoop(object):
7904 """Proxy of C++ EventLoop class"""
7905 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7906 __repr__
= _swig_repr
7907 def __init__(self
, *args
, **kwargs
):
7908 """__init__(self) -> EventLoop"""
7909 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7910 __swig_destroy__
= _core_
.delete_EventLoop
7911 __del__
= lambda self
: None;
7912 def Run(*args
, **kwargs
):
7913 """Run(self) -> int"""
7914 return _core_
.EventLoop_Run(*args
, **kwargs
)
7916 def Exit(*args
, **kwargs
):
7917 """Exit(self, int rc=0)"""
7918 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7920 def Pending(*args
, **kwargs
):
7921 """Pending(self) -> bool"""
7922 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7924 def Dispatch(*args
, **kwargs
):
7925 """Dispatch(self) -> bool"""
7926 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7928 def IsRunning(*args
, **kwargs
):
7929 """IsRunning(self) -> bool"""
7930 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7932 def GetActive(*args
, **kwargs
):
7933 """GetActive() -> EventLoop"""
7934 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7936 GetActive
= staticmethod(GetActive
)
7937 def SetActive(*args
, **kwargs
):
7938 """SetActive(EventLoop loop)"""
7939 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7941 SetActive
= staticmethod(SetActive
)
7942 _core_
.EventLoop_swigregister(EventLoop
)
7944 def EventLoop_GetActive(*args
):
7945 """EventLoop_GetActive() -> EventLoop"""
7946 return _core_
.EventLoop_GetActive(*args
)
7948 def EventLoop_SetActive(*args
, **kwargs
):
7949 """EventLoop_SetActive(EventLoop loop)"""
7950 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7952 class EventLoopActivator(object):
7953 """Proxy of C++ EventLoopActivator class"""
7954 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7955 __repr__
= _swig_repr
7956 def __init__(self
, *args
, **kwargs
):
7957 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7958 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7959 __swig_destroy__
= _core_
.delete_EventLoopActivator
7960 __del__
= lambda self
: None;
7961 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7963 #---------------------------------------------------------------------------
7965 ACCEL_ALT
= _core_
.ACCEL_ALT
7966 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7967 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7968 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7969 ACCEL_CMD
= _core_
.ACCEL_CMD
7970 class AcceleratorEntry(object):
7972 A class used to define items in an `wx.AcceleratorTable`. wxPython
7973 programs can choose to use wx.AcceleratorEntry objects, but using a
7974 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7975 as well. See `__init__` for of the tuple values.
7977 :see: `wx.AcceleratorTable`
7979 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7980 __repr__
= _swig_repr
7981 def __init__(self
, *args
, **kwargs
):
7983 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7985 Construct a wx.AcceleratorEntry.
7987 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7988 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7989 __del__
= lambda self
: None;
7990 def Set(*args
, **kwargs
):
7992 Set(self, int flags, int keyCode, int cmd)
7994 (Re)set the attributes of a wx.AcceleratorEntry.
7997 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7999 def Create(*args
, **kwargs
):
8001 Create(String str) -> AcceleratorEntry
8003 Create accelerator corresponding to the specified string, or None if
8004 it coulnd't be parsed.
8006 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8008 Create
= staticmethod(Create
)
8009 def GetFlags(*args
, **kwargs
):
8011 GetFlags(self) -> int
8013 Get the AcceleratorEntry's flags.
8015 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
8017 def GetKeyCode(*args
, **kwargs
):
8019 GetKeyCode(self) -> int
8021 Get the AcceleratorEntry's keycode.
8023 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8025 def GetCommand(*args
, **kwargs
):
8027 GetCommand(self) -> int
8029 Get the AcceleratorEntry's command ID.
8031 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8033 def IsOk(*args
, **kwargs
):
8034 """IsOk(self) -> bool"""
8035 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
8037 def ToString(*args
, **kwargs
):
8039 ToString(self) -> String
8041 Returns a string representation for the this accelerator. The string
8042 is formatted using the <flags>-<keycode> format where <flags> maybe a
8043 hyphen-separed list of "shift|alt|ctrl"
8046 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
8048 def FromString(*args
, **kwargs
):
8050 FromString(self, String str) -> bool
8052 Returns true if the given string correctly initialized this object.
8054 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
8056 Command
= property(GetCommand
,doc
="See `GetCommand`")
8057 Flags
= property(GetFlags
,doc
="See `GetFlags`")
8058 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
8059 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
8061 def AcceleratorEntry_Create(*args
, **kwargs
):
8063 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8065 Create accelerator corresponding to the specified string, or None if
8066 it coulnd't be parsed.
8068 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8070 class AcceleratorTable(Object
):
8072 An accelerator table allows the application to specify a table of
8073 keyboard shortcuts for menus or other commands. On Windows, menu or
8074 button commands are supported; on GTK, only menu commands are
8077 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8078 __repr__
= _swig_repr
8079 def __init__(self
, *args
, **kwargs
):
8081 __init__(entries) -> AcceleratorTable
8083 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8084 items or or of 3-tuples (flags, keyCode, cmdID)
8086 :see: `wx.AcceleratorEntry`
8088 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
8089 __swig_destroy__
= _core_
.delete_AcceleratorTable
8090 __del__
= lambda self
: None;
8091 def IsOk(*args
, **kwargs
):
8092 """IsOk(self) -> bool"""
8093 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
8096 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
8099 def GetAccelFromString(*args
, **kwargs
):
8100 """GetAccelFromString(String label) -> AcceleratorEntry"""
8101 return _core_
.GetAccelFromString(*args
, **kwargs
)
8102 #---------------------------------------------------------------------------
8104 class VisualAttributes(object):
8105 """struct containing all the visual attributes of a control"""
8106 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8107 __repr__
= _swig_repr
8108 def __init__(self
, *args
, **kwargs
):
8110 __init__(self) -> VisualAttributes
8112 struct containing all the visual attributes of a control
8114 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
8115 __swig_destroy__
= _core_
.delete_VisualAttributes
8116 __del__
= lambda self
: None;
8117 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
8118 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
8119 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
8120 _core_
.VisualAttributes_swigregister(VisualAttributes
)
8121 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8122 PanelNameStr
= cvar
.PanelNameStr
8124 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8125 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8126 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8127 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8128 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8129 class Window(EvtHandler
):
8131 wx.Window is the base class for all windows and represents any visible
8132 object on the screen. All controls, top level windows and so on are
8133 wx.Windows. Sizers and device contexts are not however, as they don't
8134 appear on screen themselves.
8137 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8138 __repr__
= _swig_repr
8139 def __init__(self
, *args
, **kwargs
):
8141 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8144 Construct and show a generic Window.
8146 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
8147 self
._setOORInfo
(self
)
8149 def Create(*args
, **kwargs
):
8151 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8152 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8154 Create the GUI part of the Window for 2-phase creation mode.
8156 return _core_
.Window_Create(*args
, **kwargs
)
8158 def Close(*args
, **kwargs
):
8160 Close(self, bool force=False) -> bool
8162 This function simply generates a EVT_CLOSE event whose handler usually
8163 tries to close the window. It doesn't close the window itself,
8164 however. If force is False (the default) then the window's close
8165 handler will be allowed to veto the destruction of the window.
8167 return _core_
.Window_Close(*args
, **kwargs
)
8169 def Destroy(*args
, **kwargs
):
8171 Destroy(self) -> bool
8173 Destroys the window safely. Frames and dialogs are not destroyed
8174 immediately when this function is called -- they are added to a list
8175 of windows to be deleted on idle time, when all the window's events
8176 have been processed. This prevents problems with events being sent to
8177 non-existent windows.
8179 Returns True if the window has either been successfully deleted, or it
8180 has been added to the list of windows pending real deletion.
8182 args
[0].this
.own(False)
8183 return _core_
.Window_Destroy(*args
, **kwargs
)
8185 def DestroyChildren(*args
, **kwargs
):
8187 DestroyChildren(self) -> bool
8189 Destroys all children of a window. Called automatically by the
8192 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8194 def IsBeingDeleted(*args
, **kwargs
):
8196 IsBeingDeleted(self) -> bool
8198 Is the window in the process of being deleted?
8200 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8202 def SetLabel(*args
, **kwargs
):
8204 SetLabel(self, String label)
8206 Set the text which the window shows in its label if applicable.
8208 return _core_
.Window_SetLabel(*args
, **kwargs
)
8210 def GetLabel(*args
, **kwargs
):
8212 GetLabel(self) -> String
8214 Generic way of getting a label from any window, for identification
8215 purposes. The interpretation of this function differs from class to
8216 class. For frames and dialogs, the value returned is the title. For
8217 buttons or static text controls, it is the button text. This function
8218 can be useful for meta-programs such as testing tools or special-needs
8219 access programs)which need to identify windows by name.
8221 return _core_
.Window_GetLabel(*args
, **kwargs
)
8223 def SetName(*args
, **kwargs
):
8225 SetName(self, String name)
8227 Sets the window's name. The window name is used for ressource setting
8228 in X, it is not the same as the window title/label
8230 return _core_
.Window_SetName(*args
, **kwargs
)
8232 def GetName(*args
, **kwargs
):
8234 GetName(self) -> String
8236 Returns the windows name. This name is not guaranteed to be unique;
8237 it is up to the programmer to supply an appropriate name in the window
8238 constructor or via wx.Window.SetName.
8240 return _core_
.Window_GetName(*args
, **kwargs
)
8242 def SetWindowVariant(*args
, **kwargs
):
8244 SetWindowVariant(self, int variant)
8246 Sets the variant of the window/font size to use for this window, if
8247 the platform supports variants, for example, wxMac.
8249 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8251 def GetWindowVariant(*args
, **kwargs
):
8252 """GetWindowVariant(self) -> int"""
8253 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8255 def SetId(*args
, **kwargs
):
8257 SetId(self, int winid)
8259 Sets the identifier of the window. Each window has an integer
8260 identifier. If the application has not provided one, an identifier
8261 will be generated. Normally, the identifier should be provided on
8262 creation and should not be modified subsequently.
8264 return _core_
.Window_SetId(*args
, **kwargs
)
8266 def GetId(*args
, **kwargs
):
8270 Returns the identifier of the window. Each window has an integer
8271 identifier. If the application has not provided one (or the default Id
8272 -1 is used) then an unique identifier with a negative value will be
8275 return _core_
.Window_GetId(*args
, **kwargs
)
8277 def NewControlId(*args
, **kwargs
):
8279 NewControlId() -> int
8281 Generate a control id for the controls which were not given one.
8283 return _core_
.Window_NewControlId(*args
, **kwargs
)
8285 NewControlId
= staticmethod(NewControlId
)
8286 def NextControlId(*args
, **kwargs
):
8288 NextControlId(int winid) -> int
8290 Get the id of the control following the one with the given
8293 return _core_
.Window_NextControlId(*args
, **kwargs
)
8295 NextControlId
= staticmethod(NextControlId
)
8296 def PrevControlId(*args
, **kwargs
):
8298 PrevControlId(int winid) -> int
8300 Get the id of the control preceding the one with the given
8303 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8305 PrevControlId
= staticmethod(PrevControlId
)
8306 def GetLayoutDirection(*args
, **kwargs
):
8308 GetLayoutDirection(self) -> int
8310 Get the layout direction (LTR or RTL) for this window. Returns
8311 ``wx.Layout_Default`` if layout direction is not supported.
8313 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8315 def SetLayoutDirection(*args
, **kwargs
):
8317 SetLayoutDirection(self, int dir)
8319 Set the layout direction (LTR or RTL) for this window.
8321 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8323 def AdjustForLayoutDirection(*args
, **kwargs
):
8325 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8327 Mirror coordinates for RTL layout if this window uses it and if the
8328 mirroring is not done automatically like Win32.
8330 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8332 def SetSize(*args
, **kwargs
):
8334 SetSize(self, Size size)
8336 Sets the size of the window in pixels.
8338 return _core_
.Window_SetSize(*args
, **kwargs
)
8340 def SetDimensions(*args
, **kwargs
):
8342 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8344 Sets the position and size of the window in pixels. The sizeFlags
8345 parameter indicates the interpretation of the other params if they are
8348 ======================== ======================================
8349 wx.SIZE_AUTO A -1 indicates that a class-specific
8350 default should be used.
8351 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8352 -1 values are supplied.
8353 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8354 interpreted as real dimensions, not
8356 ======================== ======================================
8359 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8361 def SetRect(*args
, **kwargs
):
8363 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8365 Sets the position and size of the window in pixels using a wx.Rect.
8367 return _core_
.Window_SetRect(*args
, **kwargs
)
8369 def SetSizeWH(*args
, **kwargs
):
8371 SetSizeWH(self, int width, int height)
8373 Sets the size of the window in pixels.
8375 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8377 def Move(*args
, **kwargs
):
8379 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8381 Moves the window to the given position.
8383 return _core_
.Window_Move(*args
, **kwargs
)
8386 def MoveXY(*args
, **kwargs
):
8388 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8390 Moves the window to the given position.
8392 return _core_
.Window_MoveXY(*args
, **kwargs
)
8394 def SetInitialSize(*args
, **kwargs
):
8396 SetInitialSize(self, Size size=DefaultSize)
8398 A 'Smart' SetSize that will fill in default size components with the
8399 window's *best size* values. Also set's the minsize for use with sizers.
8401 return _core_
.Window_SetInitialSize(*args
, **kwargs
)
8403 SetBestFittingSize
= wx
._deprecated
(SetInitialSize
, 'Use `SetInitialSize`')
8404 def Raise(*args
, **kwargs
):
8408 Raises the window to the top of the window hierarchy. In current
8409 version of wxWidgets this works both for manage and child windows.
8411 return _core_
.Window_Raise(*args
, **kwargs
)
8413 def Lower(*args
, **kwargs
):
8417 Lowers the window to the bottom of the window hierarchy. In current
8418 version of wxWidgets this works both for manage and child windows.
8420 return _core_
.Window_Lower(*args
, **kwargs
)
8422 def SetClientSize(*args
, **kwargs
):
8424 SetClientSize(self, Size size)
8426 This sets the size of the window client area in pixels. Using this
8427 function to size a window tends to be more device-independent than
8428 wx.Window.SetSize, since the application need not worry about what
8429 dimensions the border or title bar have when trying to fit the window
8430 around panel items, for example.
8432 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8434 def SetClientSizeWH(*args
, **kwargs
):
8436 SetClientSizeWH(self, int width, int height)
8438 This sets the size of the window client area in pixels. Using this
8439 function to size a window tends to be more device-independent than
8440 wx.Window.SetSize, since the application need not worry about what
8441 dimensions the border or title bar have when trying to fit the window
8442 around panel items, for example.
8444 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8446 def SetClientRect(*args
, **kwargs
):
8448 SetClientRect(self, Rect rect)
8450 This sets the size of the window client area in pixels. Using this
8451 function to size a window tends to be more device-independent than
8452 wx.Window.SetSize, since the application need not worry about what
8453 dimensions the border or title bar have when trying to fit the window
8454 around panel items, for example.
8456 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8458 def GetPosition(*args
, **kwargs
):
8460 GetPosition(self) -> Point
8462 Get the window's position. Notice that the position is in client
8463 coordinates for child windows and screen coordinates for the top level
8464 ones, use `GetScreenPosition` if you need screen coordinates for all
8467 return _core_
.Window_GetPosition(*args
, **kwargs
)
8469 def GetPositionTuple(*args
, **kwargs
):
8471 GetPositionTuple() -> (x,y)
8473 Get the window's position. Notice that the position is in client
8474 coordinates for child windows and screen coordinates for the top level
8475 ones, use `GetScreenPosition` if you need screen coordinates for all
8478 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8480 def GetScreenPosition(*args
, **kwargs
):
8482 GetScreenPosition(self) -> Point
8484 Get the position of the window in screen coordinantes.
8486 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8488 def GetScreenPositionTuple(*args
, **kwargs
):
8490 GetScreenPositionTuple() -> (x,y)
8492 Get the position of the window in screen coordinantes.
8494 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8496 def GetScreenRect(*args
, **kwargs
):
8498 GetScreenRect(self) -> Rect
8500 Returns the size and position of the window in screen coordinantes as
8503 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8505 def GetSize(*args
, **kwargs
):
8507 GetSize(self) -> Size
8509 Get the window size.
8511 return _core_
.Window_GetSize(*args
, **kwargs
)
8513 def GetSizeTuple(*args
, **kwargs
):
8515 GetSizeTuple() -> (width, height)
8517 Get the window size.
8519 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8521 def GetRect(*args
, **kwargs
):
8523 GetRect(self) -> Rect
8525 Returns the size and position of the window as a `wx.Rect` object.
8527 return _core_
.Window_GetRect(*args
, **kwargs
)
8529 def GetClientSize(*args
, **kwargs
):
8531 GetClientSize(self) -> Size
8533 This gets the size of the window's 'client area' in pixels. The client
8534 area is the area which may be drawn on by the programmer, excluding
8535 title bar, border, scrollbars, etc.
8537 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8539 def GetClientSizeTuple(*args
, **kwargs
):
8541 GetClientSizeTuple() -> (width, height)
8543 This gets the size of the window's 'client area' in pixels. The client
8544 area is the area which may be drawn on by the programmer, excluding
8545 title bar, border, scrollbars, etc.
8547 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8549 def GetClientAreaOrigin(*args
, **kwargs
):
8551 GetClientAreaOrigin(self) -> Point
8553 Get the origin of the client area of the window relative to the
8554 window's top left corner (the client area may be shifted because of
8555 the borders, scrollbars, other decorations...)
8557 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8559 def GetClientRect(*args
, **kwargs
):
8561 GetClientRect(self) -> Rect
8563 Get the client area position and size as a `wx.Rect` object.
8565 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8567 def GetBestSize(*args
, **kwargs
):
8569 GetBestSize(self) -> Size
8571 This function returns the best acceptable minimal size for the
8572 window, if applicable. For example, for a static text control, it will
8573 be the minimal size such that the control label is not truncated. For
8574 windows containing subwindows (suzh aswx.Panel), the size returned by
8575 this function will be the same as the size the window would have had
8578 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8580 def GetBestSizeTuple(*args
, **kwargs
):
8582 GetBestSizeTuple() -> (width, height)
8584 This function returns the best acceptable minimal size for the
8585 window, if applicable. For example, for a static text control, it will
8586 be the minimal size such that the control label is not truncated. For
8587 windows containing subwindows (suzh aswx.Panel), the size returned by
8588 this function will be the same as the size the window would have had
8591 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8593 def InvalidateBestSize(*args
, **kwargs
):
8595 InvalidateBestSize(self)
8597 Reset the cached best size value so it will be recalculated the next
8600 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8602 def CacheBestSize(*args
, **kwargs
):
8604 CacheBestSize(self, Size size)
8606 Cache the best size so it doesn't need to be calculated again, (at least until
8607 some properties of the window change.)
8609 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8611 def GetEffectiveMinSize(*args
, **kwargs
):
8613 GetEffectiveMinSize(self) -> Size
8615 This function will merge the window's best size into the window's
8616 minimum size, giving priority to the min size components, and returns
8620 return _core_
.Window_GetEffectiveMinSize(*args
, **kwargs
)
8622 GetBestFittingSize
= wx
._deprecated
(GetEffectiveMinSize
, 'Use `GetEffectiveMinSize` instead.')
8623 def GetAdjustedBestSize(self
):
8624 s
= self
.GetBestSize()
8625 return wx
.Size(max(s
.width
, self
.GetMinWidth()),
8626 max(s
.height
, self
.GetMinHeight()))
8627 GetAdjustedBestSize
= wx
._deprecated
(GetAdjustedBestSize
, 'Use `GetEffectiveMinSize` instead.')
8629 def Center(*args
, **kwargs
):
8631 Center(self, int direction=BOTH)
8633 Centers the window. The parameter specifies the direction for
8634 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8635 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8636 on the entire screen and not on its parent window. If it is a
8637 top-level window and has no parent then it will always be centered
8638 relative to the screen.
8640 return _core_
.Window_Center(*args
, **kwargs
)
8643 def CenterOnParent(*args
, **kwargs
):
8645 CenterOnParent(self, int dir=BOTH)
8647 Center with respect to the the parent window
8649 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8651 CentreOnParent
= CenterOnParent
8652 def Fit(*args
, **kwargs
):
8656 Sizes the window so that it fits around its subwindows. This function
8657 won't do anything if there are no subwindows and will only really work
8658 correctly if sizers are used for the subwindows layout. Also, if the
8659 window has exactly one subwindow it is better (faster and the result
8660 is more precise as Fit adds some margin to account for fuzziness of
8661 its calculations) to call window.SetClientSize(child.GetSize())
8662 instead of calling Fit.
8664 return _core_
.Window_Fit(*args
, **kwargs
)
8666 def FitInside(*args
, **kwargs
):
8670 Similar to Fit, but sizes the interior (virtual) size of a
8671 window. Mainly useful with scrolled windows to reset scrollbars after
8672 sizing changes that do not trigger a size event, and/or scrolled
8673 windows without an interior sizer. This function similarly won't do
8674 anything if there are no subwindows.
8676 return _core_
.Window_FitInside(*args
, **kwargs
)
8678 def SetSizeHints(*args
, **kwargs
):
8680 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8683 Allows specification of minimum and maximum window sizes, and window
8684 size increments. If a pair of values is not set (or set to -1), the
8685 default values will be used. If this function is called, the user
8686 will not be able to size the window outside the given bounds (if it is
8687 a top-level window.) Sizers will also inspect the minimum window size
8688 and will use that value if set when calculating layout.
8690 The resizing increments are only significant under Motif or Xt.
8692 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8694 def SetSizeHintsSz(*args
, **kwargs
):
8696 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8698 Allows specification of minimum and maximum window sizes, and window
8699 size increments. If a pair of values is not set (or set to -1), the
8700 default values will be used. If this function is called, the user
8701 will not be able to size the window outside the given bounds (if it is
8702 a top-level window.) Sizers will also inspect the minimum window size
8703 and will use that value if set when calculating layout.
8705 The resizing increments are only significant under Motif or Xt.
8707 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8709 def SetVirtualSizeHints(*args
, **kwargs
):
8711 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8713 Allows specification of minimum and maximum virtual window sizes. If a
8714 pair of values is not set (or set to -1), the default values will be
8715 used. If this function is called, the user will not be able to size
8716 the virtual area of the window outside the given bounds.
8718 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8720 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8722 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8724 Allows specification of minimum and maximum virtual window sizes. If a
8725 pair of values is not set (or set to -1), the default values will be
8726 used. If this function is called, the user will not be able to size
8727 the virtual area of the window outside the given bounds.
8729 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8731 def GetMaxSize(*args
, **kwargs
):
8732 """GetMaxSize(self) -> Size"""
8733 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8735 def GetMinSize(*args
, **kwargs
):
8736 """GetMinSize(self) -> Size"""
8737 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8739 def SetMinSize(*args
, **kwargs
):
8741 SetMinSize(self, Size minSize)
8743 A more convenient method than `SetSizeHints` for setting just the
8746 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8748 def SetMaxSize(*args
, **kwargs
):
8750 SetMaxSize(self, Size maxSize)
8752 A more convenient method than `SetSizeHints` for setting just the
8755 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8757 def GetMinWidth(*args
, **kwargs
):
8758 """GetMinWidth(self) -> int"""
8759 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8761 def GetMinHeight(*args
, **kwargs
):
8762 """GetMinHeight(self) -> int"""
8763 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8765 def GetMaxWidth(*args
, **kwargs
):
8766 """GetMaxWidth(self) -> int"""
8767 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8769 def GetMaxHeight(*args
, **kwargs
):
8770 """GetMaxHeight(self) -> int"""
8771 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8773 def SetVirtualSize(*args
, **kwargs
):
8775 SetVirtualSize(self, Size size)
8777 Set the the virtual size of a window in pixels. For most windows this
8778 is just the client area of the window, but for some like scrolled
8779 windows it is more or less independent of the screen window size.
8781 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8783 def SetVirtualSizeWH(*args
, **kwargs
):
8785 SetVirtualSizeWH(self, int w, int h)
8787 Set the the virtual size of a window in pixels. For most windows this
8788 is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
8791 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8793 def GetVirtualSize(*args
, **kwargs
):
8795 GetVirtualSize(self) -> Size
8797 Get the the virtual size of the window in pixels. For most windows
8798 this is just the client area of the window, but for some like scrolled
8799 windows it is more or less independent of the screen window size.
8801 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8803 def GetVirtualSizeTuple(*args
, **kwargs
):
8805 GetVirtualSizeTuple() -> (width, height)
8807 Get the the virtual size of the window in pixels. For most windows
8808 this is just the client area of the window, but for some like scrolled
8809 windows it is more or less independent of the screen window size.
8811 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8813 def GetBestVirtualSize(*args
, **kwargs
):
8815 GetBestVirtualSize(self) -> Size
8817 Return the largest of ClientSize and BestSize (as determined by a
8818 sizer, interior children, or other means)
8820 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8822 def Show(*args
, **kwargs
):
8824 Show(self, bool show=True) -> bool
8826 Shows or hides the window. You may need to call Raise for a top level
8827 window if you want to bring it to top, although this is not needed if
8828 Show is called immediately after the frame creation. Returns True if
8829 the window has been shown or hidden or False if nothing was done
8830 because it already was in the requested state.
8832 return _core_
.Window_Show(*args
, **kwargs
)
8834 def Hide(*args
, **kwargs
):
8838 Equivalent to calling Show(False).
8840 return _core_
.Window_Hide(*args
, **kwargs
)
8842 def Enable(*args
, **kwargs
):
8844 Enable(self, bool enable=True) -> bool
8846 Enable or disable the window for user input. Note that when a parent
8847 window is disabled, all of its children are disabled as well and they
8848 are reenabled again when the parent is. Returns true if the window
8849 has been enabled or disabled, false if nothing was done, i.e. if the
8850 window had already been in the specified state.
8852 return _core_
.Window_Enable(*args
, **kwargs
)
8854 def Disable(*args
, **kwargs
):
8856 Disable(self) -> bool
8858 Disables the window, same as Enable(false).
8860 return _core_
.Window_Disable(*args
, **kwargs
)
8862 def IsShown(*args
, **kwargs
):
8864 IsShown(self) -> bool
8866 Returns true if the window is shown, false if it has been hidden.
8868 return _core_
.Window_IsShown(*args
, **kwargs
)
8870 def IsEnabled(*args
, **kwargs
):
8872 IsEnabled(self) -> bool
8874 Returns true if the window is enabled for input, false otherwise.
8876 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8878 def IsShownOnScreen(*args
, **kwargs
):
8880 IsShownOnScreen(self) -> bool
8882 Returns ``True`` if the window is physically visible on the screen,
8883 i.e. it is shown and all its parents up to the toplevel window are
8886 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8888 def SetWindowStyleFlag(*args
, **kwargs
):
8890 SetWindowStyleFlag(self, long style)
8892 Sets the style of the window. Please note that some styles cannot be
8893 changed after the window creation and that Refresh() might need to be
8894 called after changing the others for the change to take place
8897 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8899 def GetWindowStyleFlag(*args
, **kwargs
):
8901 GetWindowStyleFlag(self) -> long
8903 Gets the window style that was passed to the constructor or Create
8906 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8908 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8909 def HasFlag(*args
, **kwargs
):
8911 HasFlag(self, int flag) -> bool
8913 Test if the given style is set for this window.
8915 return _core_
.Window_HasFlag(*args
, **kwargs
)
8917 def IsRetained(*args
, **kwargs
):
8919 IsRetained(self) -> bool
8921 Returns true if the window is retained, false otherwise. Retained
8922 windows are only available on X platforms.
8924 return _core_
.Window_IsRetained(*args
, **kwargs
)
8926 def SetExtraStyle(*args
, **kwargs
):
8928 SetExtraStyle(self, long exStyle)
8930 Sets the extra style bits for the window. Extra styles are the less
8931 often used style bits which can't be set with the constructor or with
8932 SetWindowStyleFlag()
8934 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8936 def GetExtraStyle(*args
, **kwargs
):
8938 GetExtraStyle(self) -> long
8940 Returns the extra style bits for the window.
8942 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8944 def MakeModal(*args
, **kwargs
):
8946 MakeModal(self, bool modal=True)
8948 Disables all other windows in the application so that the user can
8949 only interact with this window. Passing False will reverse this
8952 return _core_
.Window_MakeModal(*args
, **kwargs
)
8954 def SetThemeEnabled(*args
, **kwargs
):
8956 SetThemeEnabled(self, bool enableTheme)
8958 This function tells a window if it should use the system's "theme"
8959 code to draw the windows' background instead if its own background
8960 drawing code. This will only have an effect on platforms that support
8961 the notion of themes in user defined windows. One such platform is
8962 GTK+ where windows can have (very colourful) backgrounds defined by a
8963 user's selected theme.
8965 Dialogs, notebook pages and the status bar have this flag set to true
8966 by default so that the default look and feel is simulated best.
8968 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8970 def GetThemeEnabled(*args
, **kwargs
):
8972 GetThemeEnabled(self) -> bool
8974 Return the themeEnabled flag.
8976 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8978 def SetFocus(*args
, **kwargs
):
8982 Set's the focus to this window, allowing it to receive keyboard input.
8984 return _core_
.Window_SetFocus(*args
, **kwargs
)
8986 def SetFocusFromKbd(*args
, **kwargs
):
8988 SetFocusFromKbd(self)
8990 Set focus to this window as the result of a keyboard action. Normally
8991 only called internally.
8993 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8995 def FindFocus(*args
, **kwargs
):
8997 FindFocus() -> Window
8999 Returns the window or control that currently has the keyboard focus,
9002 return _core_
.Window_FindFocus(*args
, **kwargs
)
9004 FindFocus
= staticmethod(FindFocus
)
9005 def AcceptsFocus(*args
, **kwargs
):
9007 AcceptsFocus(self) -> bool
9009 Can this window have focus?
9011 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
9013 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
9015 AcceptsFocusFromKeyboard(self) -> bool
9017 Can this window be given focus by keyboard navigation? if not, the
9018 only way to give it focus (provided it accepts it at all) is to click
9021 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
9023 def Navigate(*args
, **kwargs
):
9025 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9027 Does keyboard navigation from this window to another, by sending a
9028 `wx.NavigationKeyEvent`.
9030 return _core_
.Window_Navigate(*args
, **kwargs
)
9032 def MoveAfterInTabOrder(*args
, **kwargs
):
9034 MoveAfterInTabOrder(self, Window win)
9036 Moves this window in the tab navigation order after the specified
9037 sibling window. This means that when the user presses the TAB key on
9038 that other window, the focus switches to this window.
9040 The default tab order is the same as creation order. This function
9041 and `MoveBeforeInTabOrder` allow to change it after creating all the
9045 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
9047 def MoveBeforeInTabOrder(*args
, **kwargs
):
9049 MoveBeforeInTabOrder(self, Window win)
9051 Same as `MoveAfterInTabOrder` except that it inserts this window just
9052 before win instead of putting it right after it.
9054 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9056 def GetChildren(*args
, **kwargs
):
9058 GetChildren(self) -> PyObject
9060 Returns a list of the window's children. NOTE: Currently this is a
9061 copy of the child window list maintained by the window, so the return
9062 value of this function is only valid as long as the window's children
9065 return _core_
.Window_GetChildren(*args
, **kwargs
)
9067 def GetParent(*args
, **kwargs
):
9069 GetParent(self) -> Window
9071 Returns the parent window of this window, or None if there isn't one.
9073 return _core_
.Window_GetParent(*args
, **kwargs
)
9075 def GetGrandParent(*args
, **kwargs
):
9077 GetGrandParent(self) -> Window
9079 Returns the parent of the parent of this window, or None if there
9082 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9084 def IsTopLevel(*args
, **kwargs
):
9086 IsTopLevel(self) -> bool
9088 Returns true if the given window is a top-level one. Currently all
9089 frames and dialogs are always considered to be top-level windows (even
9090 if they have a parent window).
9092 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9094 def Reparent(*args
, **kwargs
):
9096 Reparent(self, Window newParent) -> bool
9098 Reparents the window, i.e the window will be removed from its current
9099 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9100 re-inserted into another. Available on Windows and GTK. Returns True
9101 if the parent was changed, False otherwise (error or newParent ==
9104 return _core_
.Window_Reparent(*args
, **kwargs
)
9106 def AddChild(*args
, **kwargs
):
9108 AddChild(self, Window child)
9110 Adds a child window. This is called automatically by window creation
9111 functions so should not be required by the application programmer.
9113 return _core_
.Window_AddChild(*args
, **kwargs
)
9115 def RemoveChild(*args
, **kwargs
):
9117 RemoveChild(self, Window child)
9119 Removes a child window. This is called automatically by window
9120 deletion functions so should not be required by the application
9123 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9125 def SetDoubleBuffered(*args
, **kwargs
):
9127 SetDoubleBuffered(self, bool on)
9129 Currently wxGTK2 only.
9131 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
9133 def FindWindowById(*args
, **kwargs
):
9135 FindWindowById(self, long winid) -> Window
9137 Find a chld of this window by window ID
9139 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9141 def FindWindowByName(*args
, **kwargs
):
9143 FindWindowByName(self, String name) -> Window
9145 Find a child of this window by name
9147 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9149 def GetEventHandler(*args
, **kwargs
):
9151 GetEventHandler(self) -> EvtHandler
9153 Returns the event handler for this window. By default, the window is
9154 its own event handler.
9156 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9158 def SetEventHandler(*args
, **kwargs
):
9160 SetEventHandler(self, EvtHandler handler)
9162 Sets the event handler for this window. An event handler is an object
9163 that is capable of processing the events sent to a window. (In other
9164 words, is able to dispatch the events to handler function.) By
9165 default, the window is its own event handler, but an application may
9166 wish to substitute another, for example to allow central
9167 implementation of event-handling for a variety of different window
9170 It is usually better to use `wx.Window.PushEventHandler` since this sets
9171 up a chain of event handlers, where an event not handled by one event
9172 handler is handed off to the next one in the chain.
9174 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9176 def PushEventHandler(*args
, **kwargs
):
9178 PushEventHandler(self, EvtHandler handler)
9180 Pushes this event handler onto the event handler stack for the window.
9181 An event handler is an object that is capable of processing the events
9182 sent to a window. (In other words, is able to dispatch the events to
9183 handler function.) By default, the window is its own event handler,
9184 but an application may wish to substitute another, for example to
9185 allow central implementation of event-handling for a variety of
9186 different window classes.
9188 wx.Window.PushEventHandler allows an application to set up a chain of
9189 event handlers, where an event not handled by one event handler is
9190 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9191 to remove the event handler. Ownership of the handler is *not* given
9192 to the window, so you should be sure to pop the handler before the
9193 window is destroyed and either let PopEventHandler destroy it, or call
9194 its Destroy method yourself.
9196 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9198 def PopEventHandler(*args
, **kwargs
):
9200 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9202 Removes and returns the top-most event handler on the event handler
9203 stack. If deleteHandler is True then the wx.EvtHandler object will be
9204 destroyed after it is popped, and ``None`` will be returned instead.
9206 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9208 def RemoveEventHandler(*args
, **kwargs
):
9210 RemoveEventHandler(self, EvtHandler handler) -> bool
9212 Find the given handler in the event handler chain and remove (but not
9213 delete) it from the event handler chain, returns True if it was found
9214 and False otherwise (this also results in an assert failure so this
9215 function should only be called when the handler is supposed to be
9218 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9220 def SetValidator(*args
, **kwargs
):
9222 SetValidator(self, Validator validator)
9224 Deletes the current validator (if any) and sets the window validator,
9225 having called wx.Validator.Clone to create a new validator of this
9228 return _core_
.Window_SetValidator(*args
, **kwargs
)
9230 def GetValidator(*args
, **kwargs
):
9232 GetValidator(self) -> Validator
9234 Returns a pointer to the current validator for the window, or None if
9237 return _core_
.Window_GetValidator(*args
, **kwargs
)
9239 def Validate(*args
, **kwargs
):
9241 Validate(self) -> bool
9243 Validates the current values of the child controls using their
9244 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9245 style flag set, the method will also call Validate() of all child
9246 windows. Returns false if any of the validations failed.
9248 return _core_
.Window_Validate(*args
, **kwargs
)
9250 def TransferDataToWindow(*args
, **kwargs
):
9252 TransferDataToWindow(self) -> bool
9254 Transfers values to child controls from data areas specified by their
9255 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9256 style flag set, the method will also call TransferDataToWindow() of
9259 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9261 def TransferDataFromWindow(*args
, **kwargs
):
9263 TransferDataFromWindow(self) -> bool
9265 Transfers values from child controls to data areas specified by their
9266 validators. Returns false if a transfer failed. If the window has
9267 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9268 also call TransferDataFromWindow() of all child windows.
9270 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9272 def InitDialog(*args
, **kwargs
):
9276 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9277 to the dialog via validators.
9279 return _core_
.Window_InitDialog(*args
, **kwargs
)
9281 def SetAcceleratorTable(*args
, **kwargs
):
9283 SetAcceleratorTable(self, AcceleratorTable accel)
9285 Sets the accelerator table for this window.
9287 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9289 def GetAcceleratorTable(*args
, **kwargs
):
9291 GetAcceleratorTable(self) -> AcceleratorTable
9293 Gets the accelerator table for this window.
9295 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9297 def RegisterHotKey(*args
, **kwargs
):
9299 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9301 Registers a system wide hotkey. Every time the user presses the hotkey
9302 registered here, this window will receive a hotkey event. It will
9303 receive the event even if the application is in the background and
9304 does not have the input focus because the user is working with some
9305 other application. To bind an event handler function to this hotkey
9306 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9307 hotkey was registered successfully.
9309 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9311 def UnregisterHotKey(*args
, **kwargs
):
9313 UnregisterHotKey(self, int hotkeyId) -> bool
9315 Unregisters a system wide hotkey.
9317 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9319 def ConvertDialogPointToPixels(*args
, **kwargs
):
9321 ConvertDialogPointToPixels(self, Point pt) -> Point
9323 Converts a point or size from dialog units to pixels. Dialog units
9324 are used for maintaining a dialog's proportions even if the font
9325 changes. For the x dimension, the dialog units are multiplied by the
9326 average character width and then divided by 4. For the y dimension,
9327 the dialog units are multiplied by the average character height and
9330 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9332 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9334 ConvertDialogSizeToPixels(self, Size sz) -> Size
9336 Converts a point or size from dialog units to pixels. Dialog units
9337 are used for maintaining a dialog's proportions even if the font
9338 changes. For the x dimension, the dialog units are multiplied by the
9339 average character width and then divided by 4. For the y dimension,
9340 the dialog units are multiplied by the average character height and
9343 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9345 def DLG_PNT(*args
, **kwargs
):
9347 DLG_PNT(self, Point pt) -> Point
9349 Converts a point or size from dialog units to pixels. Dialog units
9350 are used for maintaining a dialog's proportions even if the font
9351 changes. For the x dimension, the dialog units are multiplied by the
9352 average character width and then divided by 4. For the y dimension,
9353 the dialog units are multiplied by the average character height and
9356 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9358 def DLG_SZE(*args
, **kwargs
):
9360 DLG_SZE(self, Size sz) -> Size
9362 Converts a point or size from dialog units to pixels. Dialog units
9363 are used for maintaining a dialog's proportions even if the font
9364 changes. For the x dimension, the dialog units are multiplied by the
9365 average character width and then divided by 4. For the y dimension,
9366 the dialog units are multiplied by the average character height and
9369 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9371 def ConvertPixelPointToDialog(*args
, **kwargs
):
9372 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9373 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9375 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9376 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9377 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9379 def WarpPointer(*args
, **kwargs
):
9381 WarpPointer(self, int x, int y)
9383 Moves the pointer to the given position on the window.
9385 NOTE: This function is not supported under Mac because Apple Human
9386 Interface Guidelines forbid moving the mouse cursor programmatically.
9388 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9390 def CaptureMouse(*args
, **kwargs
):
9394 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9395 release the capture.
9397 Note that wxWindows maintains the stack of windows having captured the
9398 mouse and when the mouse is released the capture returns to the window
9399 which had had captured it previously and it is only really released if
9400 there were no previous window. In particular, this means that you must
9401 release the mouse as many times as you capture it, unless the window
9402 receives the `wx.MouseCaptureLostEvent` event.
9404 Any application which captures the mouse in the beginning of some
9405 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9406 operation when it receives the event. The event handler must not
9409 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9411 def ReleaseMouse(*args
, **kwargs
):
9415 Releases mouse input captured with wx.Window.CaptureMouse.
9417 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9419 def GetCapture(*args
, **kwargs
):
9421 GetCapture() -> Window
9423 Returns the window which currently captures the mouse or None
9425 return _core_
.Window_GetCapture(*args
, **kwargs
)
9427 GetCapture
= staticmethod(GetCapture
)
9428 def HasCapture(*args
, **kwargs
):
9430 HasCapture(self) -> bool
9432 Returns true if this window has the current mouse capture.
9434 return _core_
.Window_HasCapture(*args
, **kwargs
)
9436 def Refresh(*args
, **kwargs
):
9438 Refresh(self, bool eraseBackground=True, Rect rect=None)
9440 Mark the specified rectangle (or the whole window) as "dirty" so it
9441 will be repainted. Causes an EVT_PAINT event to be generated and sent
9444 return _core_
.Window_Refresh(*args
, **kwargs
)
9446 def RefreshRect(*args
, **kwargs
):
9448 RefreshRect(self, Rect rect, bool eraseBackground=True)
9450 Redraws the contents of the given rectangle: the area inside it will
9451 be repainted. This is the same as Refresh but has a nicer syntax.
9453 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9455 def Update(*args
, **kwargs
):
9459 Calling this method immediately repaints the invalidated area of the
9460 window instead of waiting for the EVT_PAINT event to happen, (normally
9461 this would usually only happen when the flow of control returns to the
9462 event loop.) Notice that this function doesn't refresh the window and
9463 does nothing if the window has been already repainted. Use `Refresh`
9464 first if you want to immediately redraw the window (or some portion of
9465 it) unconditionally.
9467 return _core_
.Window_Update(*args
, **kwargs
)
9469 def ClearBackground(*args
, **kwargs
):
9471 ClearBackground(self)
9473 Clears the window by filling it with the current background
9474 colour. Does not cause an erase background event to be generated.
9476 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9478 def Freeze(*args
, **kwargs
):
9482 Freezes the window or, in other words, prevents any updates from
9483 taking place on screen, the window is not redrawn at all. Thaw must be
9484 called to reenable window redrawing. Calls to Freeze/Thaw may be
9485 nested, with the actual Thaw being delayed until all the nesting has
9488 This method is useful for visual appearance optimization (for example,
9489 it is a good idea to use it before inserting large amount of text into
9490 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9491 for all controls so it is mostly just a hint to wxWindows and not a
9492 mandatory directive.
9494 return _core_
.Window_Freeze(*args
, **kwargs
)
9496 def IsFrozen(*args
, **kwargs
):
9498 IsFrozen(self) -> bool
9500 Returns ``True`` if the window has been frozen and not thawed yet.
9502 :see: `Freeze` and `Thaw`
9504 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9506 def Thaw(*args
, **kwargs
):
9510 Reenables window updating after a previous call to Freeze. Calls to
9511 Freeze/Thaw may be nested, so Thaw must be called the same number of
9512 times that Freeze was before the window will be updated.
9514 return _core_
.Window_Thaw(*args
, **kwargs
)
9516 def PrepareDC(*args
, **kwargs
):
9518 PrepareDC(self, DC dc)
9520 Call this function to prepare the device context for drawing a
9521 scrolled image. It sets the device origin according to the current
9524 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9526 def IsDoubleBuffered(*args
, **kwargs
):
9528 IsDoubleBuffered(self) -> bool
9530 Returns ``True`` if the window contents is double-buffered by the
9531 system, i.e. if any drawing done on the window is really done on a
9532 temporary backing surface and transferred to the screen all at once
9535 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9537 def GetUpdateRegion(*args
, **kwargs
):
9539 GetUpdateRegion(self) -> Region
9541 Returns the region specifying which parts of the window have been
9542 damaged. Should only be called within an EVT_PAINT handler.
9544 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9546 def GetUpdateClientRect(*args
, **kwargs
):
9548 GetUpdateClientRect(self) -> Rect
9550 Get the update rectangle region bounding box in client coords.
9552 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9554 def IsExposed(*args
, **kwargs
):
9556 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9558 Returns true if the given point or rectangle area has been exposed
9559 since the last repaint. Call this in an paint event handler to
9560 optimize redrawing by only redrawing those areas, which have been
9563 return _core_
.Window_IsExposed(*args
, **kwargs
)
9565 def IsExposedPoint(*args
, **kwargs
):
9567 IsExposedPoint(self, Point pt) -> bool
9569 Returns true if the given point or rectangle area has been exposed
9570 since the last repaint. Call this in an paint event handler to
9571 optimize redrawing by only redrawing those areas, which have been
9574 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9576 def IsExposedRect(*args
, **kwargs
):
9578 IsExposedRect(self, Rect rect) -> bool
9580 Returns true if the given point or rectangle area has been exposed
9581 since the last repaint. Call this in an paint event handler to
9582 optimize redrawing by only redrawing those areas, which have been
9585 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9587 def GetDefaultAttributes(*args
, **kwargs
):
9589 GetDefaultAttributes(self) -> VisualAttributes
9591 Get the default attributes for an instance of this class. This is
9592 useful if you want to use the same font or colour in your own control
9593 as in a standard control -- which is a much better idea than hard
9594 coding specific colours or fonts which might look completely out of
9595 place on the user's system, especially if it uses themes.
9597 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9599 def GetClassDefaultAttributes(*args
, **kwargs
):
9601 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9603 Get the default attributes for this class. This is useful if you want
9604 to use the same font or colour in your own control as in a standard
9605 control -- which is a much better idea than hard coding specific
9606 colours or fonts which might look completely out of place on the
9607 user's system, especially if it uses themes.
9609 The variant parameter is only relevant under Mac currently and is
9610 ignore under other platforms. Under Mac, it will change the size of
9611 the returned font. See `wx.Window.SetWindowVariant` for more about
9614 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9616 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9617 def SetBackgroundColour(*args
, **kwargs
):
9619 SetBackgroundColour(self, Colour colour) -> bool
9621 Sets the background colour of the window. Returns True if the colour
9622 was changed. The background colour is usually painted by the default
9623 EVT_ERASE_BACKGROUND event handler function under Windows and
9624 automatically under GTK. Using `wx.NullColour` will reset the window
9625 to the default background colour.
9627 Note that setting the background colour may not cause an immediate
9628 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9629 calling this function.
9631 Using this function will disable attempts to use themes for this
9632 window, if the system supports them. Use with care since usually the
9633 themes represent the appearance chosen by the user to be used for all
9634 applications on the system.
9636 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9638 def SetOwnBackgroundColour(*args
, **kwargs
):
9639 """SetOwnBackgroundColour(self, Colour colour)"""
9640 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9642 def SetForegroundColour(*args
, **kwargs
):
9644 SetForegroundColour(self, Colour colour) -> bool
9646 Sets the foreground colour of the window. Returns True is the colour
9647 was changed. The interpretation of foreground colour is dependent on
9648 the window class; it may be the text colour or other colour, or it may
9651 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9653 def SetOwnForegroundColour(*args
, **kwargs
):
9654 """SetOwnForegroundColour(self, Colour colour)"""
9655 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9657 def GetBackgroundColour(*args
, **kwargs
):
9659 GetBackgroundColour(self) -> Colour
9661 Returns the background colour of the window.
9663 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9665 def GetForegroundColour(*args
, **kwargs
):
9667 GetForegroundColour(self) -> Colour
9669 Returns the foreground colour of the window. The interpretation of
9670 foreground colour is dependent on the window class; it may be the text
9671 colour or other colour, or it may not be used at all.
9673 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9675 def InheritsBackgroundColour(*args
, **kwargs
):
9676 """InheritsBackgroundColour(self) -> bool"""
9677 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9679 def UseBgCol(*args
, **kwargs
):
9680 """UseBgCol(self) -> bool"""
9681 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9683 def SetBackgroundStyle(*args
, **kwargs
):
9685 SetBackgroundStyle(self, int style) -> bool
9687 Returns the background style of the window. The background style
9688 indicates how the background of the window is drawn.
9690 ====================== ========================================
9691 wx.BG_STYLE_SYSTEM The background colour or pattern should
9692 be determined by the system
9693 wx.BG_STYLE_COLOUR The background should be a solid colour
9694 wx.BG_STYLE_CUSTOM The background will be implemented by the
9696 ====================== ========================================
9698 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9699 a custom background, such as a tiled bitmap. Currently the style has
9700 no effect on other platforms.
9702 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9704 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9706 def GetBackgroundStyle(*args
, **kwargs
):
9708 GetBackgroundStyle(self) -> int
9710 Returns the background style of the window.
9712 :see: `SetBackgroundStyle`
9714 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9716 def HasTransparentBackground(*args
, **kwargs
):
9718 HasTransparentBackground(self) -> bool
9720 Returns True if this window's background is transparent (as, for
9721 example, for `wx.StaticText`) and should show the parent window's
9724 This method is mostly used internally by the library itself and you
9725 normally shouldn't have to call it. You may, however, have to override
9726 it in your custom control classes to ensure that background is painted
9729 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9731 def SetCursor(*args
, **kwargs
):
9733 SetCursor(self, Cursor cursor) -> bool
9735 Sets the window's cursor. Notice that the window cursor also sets it
9736 for the children of the window implicitly.
9738 The cursor may be wx.NullCursor in which case the window cursor will
9739 be reset back to default.
9741 return _core_
.Window_SetCursor(*args
, **kwargs
)
9743 def GetCursor(*args
, **kwargs
):
9745 GetCursor(self) -> Cursor
9747 Return the cursor associated with this window.
9749 return _core_
.Window_GetCursor(*args
, **kwargs
)
9751 def SetFont(*args
, **kwargs
):
9753 SetFont(self, Font font) -> bool
9755 Sets the font for this window.
9757 return _core_
.Window_SetFont(*args
, **kwargs
)
9759 def SetOwnFont(*args
, **kwargs
):
9760 """SetOwnFont(self, Font font)"""
9761 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9763 def GetFont(*args
, **kwargs
):
9765 GetFont(self) -> Font
9767 Returns the default font used for this window.
9769 return _core_
.Window_GetFont(*args
, **kwargs
)
9771 def SetCaret(*args
, **kwargs
):
9773 SetCaret(self, Caret caret)
9775 Sets the caret associated with the window.
9777 return _core_
.Window_SetCaret(*args
, **kwargs
)
9779 def GetCaret(*args
, **kwargs
):
9781 GetCaret(self) -> Caret
9783 Returns the caret associated with the window.
9785 return _core_
.Window_GetCaret(*args
, **kwargs
)
9787 def GetCharHeight(*args
, **kwargs
):
9789 GetCharHeight(self) -> int
9791 Get the (average) character size for the current font.
9793 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9795 def GetCharWidth(*args
, **kwargs
):
9797 GetCharWidth(self) -> int
9799 Get the (average) character size for the current font.
9801 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9803 def GetTextExtent(*args
, **kwargs
):
9805 GetTextExtent(String string) -> (width, height)
9807 Get the width and height of the text using the current font.
9809 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9811 def GetFullTextExtent(*args
, **kwargs
):
9813 GetFullTextExtent(String string, Font font=None) ->
9814 (width, height, descent, externalLeading)
9816 Get the width, height, decent and leading of the text using the
9817 current or specified font.
9819 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9821 def ClientToScreenXY(*args
, **kwargs
):
9823 ClientToScreenXY(int x, int y) -> (x,y)
9825 Converts to screen coordinates from coordinates relative to this window.
9827 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9829 def ScreenToClientXY(*args
, **kwargs
):
9831 ScreenToClientXY(int x, int y) -> (x,y)
9833 Converts from screen to client window coordinates.
9835 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9837 def ClientToScreen(*args
, **kwargs
):
9839 ClientToScreen(self, Point pt) -> Point
9841 Converts to screen coordinates from coordinates relative to this window.
9843 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9845 def ScreenToClient(*args
, **kwargs
):
9847 ScreenToClient(self, Point pt) -> Point
9849 Converts from screen to client window coordinates.
9851 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9853 def HitTestXY(*args
, **kwargs
):
9855 HitTestXY(self, int x, int y) -> int
9857 Test where the given (in client coords) point lies
9859 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9861 def HitTest(*args
, **kwargs
):
9863 HitTest(self, Point pt) -> int
9865 Test where the given (in client coords) point lies
9867 return _core_
.Window_HitTest(*args
, **kwargs
)
9869 def GetBorder(*args
):
9871 GetBorder(self, long flags) -> int
9872 GetBorder(self) -> int
9874 Get border for the flags of this window
9876 return _core_
.Window_GetBorder(*args
)
9878 def UpdateWindowUI(*args
, **kwargs
):
9880 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9882 This function sends EVT_UPDATE_UI events to the window. The particular
9883 implementation depends on the window; for example a wx.ToolBar will
9884 send an update UI event for each toolbar button, and a wx.Frame will
9885 send an update UI event for each menubar menu item. You can call this
9886 function from your application to ensure that your UI is up-to-date at
9887 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9888 concerned). This may be necessary if you have called
9889 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9890 limit the overhead that wxWindows incurs by sending update UI events
9893 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9895 def PopupMenuXY(*args
, **kwargs
):
9897 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9899 Pops up the given menu at the specified coordinates, relative to this window,
9900 and returns control when the user has dismissed the menu. If a menu item is
9901 selected, the corresponding menu event is generated and will be processed as
9902 usual. If the default position is given then the current position of the
9903 mouse cursor will be used.
9905 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9907 def PopupMenu(*args
, **kwargs
):
9909 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9911 Pops up the given menu at the specified coordinates, relative to this window,
9912 and returns control when the user has dismissed the menu. If a menu item is
9913 selected, the corresponding menu event is generated and will be processed as
9914 usual. If the default position is given then the current position of the
9915 mouse cursor will be used.
9917 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9919 def HasMultiplePages(*args
, **kwargs
):
9920 """HasMultiplePages(self) -> bool"""
9921 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9923 def GetHandle(*args
, **kwargs
):
9925 GetHandle(self) -> long
9927 Returns the platform-specific handle (as a long integer) of the
9928 physical window. Currently on wxMac it returns the handle of the
9929 toplevel parent of the window.
9931 return _core_
.Window_GetHandle(*args
, **kwargs
)
9933 def AssociateHandle(*args
, **kwargs
):
9935 AssociateHandle(self, long handle)
9937 Associate the window with a new native handle
9939 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9941 def DissociateHandle(*args
, **kwargs
):
9943 DissociateHandle(self)
9945 Dissociate the current native handle from the window
9947 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9949 def HasScrollbar(*args
, **kwargs
):
9951 HasScrollbar(self, int orient) -> bool
9953 Does the window have the scrollbar for this orientation?
9955 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9957 def SetScrollbar(*args
, **kwargs
):
9959 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9962 Sets the scrollbar properties of a built-in scrollbar.
9964 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9966 def SetScrollPos(*args
, **kwargs
):
9968 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9970 Sets the position of one of the built-in scrollbars.
9972 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9974 def GetScrollPos(*args
, **kwargs
):
9976 GetScrollPos(self, int orientation) -> int
9978 Returns the built-in scrollbar position.
9980 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9982 def GetScrollThumb(*args
, **kwargs
):
9984 GetScrollThumb(self, int orientation) -> int
9986 Returns the built-in scrollbar thumb size.
9988 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9990 def GetScrollRange(*args
, **kwargs
):
9992 GetScrollRange(self, int orientation) -> int
9994 Returns the built-in scrollbar range.
9996 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9998 def ScrollWindow(*args
, **kwargs
):
10000 ScrollWindow(self, int dx, int dy, Rect rect=None)
10002 Physically scrolls the pixels in the window and move child windows
10003 accordingly. Use this function to optimise your scrolling
10004 implementations, to minimise the area that must be redrawn. Note that
10005 it is rarely required to call this function from a user program.
10007 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
10009 def ScrollLines(*args
, **kwargs
):
10011 ScrollLines(self, int lines) -> bool
10013 If the platform and window class supports it, scrolls the window by
10014 the given number of lines down, if lines is positive, or up if lines
10015 is negative. Returns True if the window was scrolled, False if it was
10016 already on top/bottom and nothing was done.
10018 return _core_
.Window_ScrollLines(*args
, **kwargs
)
10020 def ScrollPages(*args
, **kwargs
):
10022 ScrollPages(self, int pages) -> bool
10024 If the platform and window class supports it, scrolls the window by
10025 the given number of pages down, if pages is positive, or up if pages
10026 is negative. Returns True if the window was scrolled, False if it was
10027 already on top/bottom and nothing was done.
10029 return _core_
.Window_ScrollPages(*args
, **kwargs
)
10031 def LineUp(*args
, **kwargs
):
10033 LineUp(self) -> bool
10035 This is just a wrapper for ScrollLines(-1).
10037 return _core_
.Window_LineUp(*args
, **kwargs
)
10039 def LineDown(*args
, **kwargs
):
10041 LineDown(self) -> bool
10043 This is just a wrapper for ScrollLines(1).
10045 return _core_
.Window_LineDown(*args
, **kwargs
)
10047 def PageUp(*args
, **kwargs
):
10049 PageUp(self) -> bool
10051 This is just a wrapper for ScrollPages(-1).
10053 return _core_
.Window_PageUp(*args
, **kwargs
)
10055 def PageDown(*args
, **kwargs
):
10057 PageDown(self) -> bool
10059 This is just a wrapper for ScrollPages(1).
10061 return _core_
.Window_PageDown(*args
, **kwargs
)
10063 def SetHelpText(*args
, **kwargs
):
10065 SetHelpText(self, String text)
10067 Sets the help text to be used as context-sensitive help for this
10068 window. Note that the text is actually stored by the current
10069 `wx.HelpProvider` implementation, and not in the window object itself.
10071 return _core_
.Window_SetHelpText(*args
, **kwargs
)
10073 def SetHelpTextForId(*args
, **kwargs
):
10075 SetHelpTextForId(self, String text)
10077 Associate this help text with all windows with the same id as this
10080 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
10082 def GetHelpTextAtPoint(*args
, **kwargs
):
10084 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10086 Get the help string associated with the given position in this window.
10088 Notice that pt may be invalid if event origin is keyboard or unknown
10089 and this method should return the global window help text then
10092 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
10094 def GetHelpText(*args
, **kwargs
):
10096 GetHelpText(self) -> String
10098 Gets the help text to be used as context-sensitive help for this
10099 window. Note that the text is actually stored by the current
10100 `wx.HelpProvider` implementation, and not in the window object itself.
10102 return _core_
.Window_GetHelpText(*args
, **kwargs
)
10104 def SetToolTipString(*args
, **kwargs
):
10106 SetToolTipString(self, String tip)
10108 Attach a tooltip to the window.
10110 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10112 def SetToolTip(*args
, **kwargs
):
10114 SetToolTip(self, ToolTip tip)
10116 Attach a tooltip to the window.
10118 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10120 def GetToolTip(*args
, **kwargs
):
10122 GetToolTip(self) -> ToolTip
10124 get the associated tooltip or None if none
10126 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10128 def SetDropTarget(*args
, **kwargs
):
10130 SetDropTarget(self, DropTarget dropTarget)
10132 Associates a drop target with this window. If the window already has
10133 a drop target, it is deleted.
10135 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10137 def GetDropTarget(*args
, **kwargs
):
10139 GetDropTarget(self) -> DropTarget
10141 Returns the associated drop target, which may be None.
10143 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10145 def DragAcceptFiles(*args
, **kwargs
):
10147 DragAcceptFiles(self, bool accept)
10149 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10150 Only functional on Windows.
10152 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10154 def SetConstraints(*args
, **kwargs
):
10156 SetConstraints(self, LayoutConstraints constraints)
10158 Sets the window to have the given layout constraints. If an existing
10159 layout constraints object is already owned by the window, it will be
10160 deleted. Pass None to disassociate and delete the window's current
10163 You must call SetAutoLayout to tell a window to use the constraints
10164 automatically in its default EVT_SIZE handler; otherwise, you must
10165 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10166 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10169 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10171 def GetConstraints(*args
, **kwargs
):
10173 GetConstraints(self) -> LayoutConstraints
10175 Returns a pointer to the window's layout constraints, or None if there
10178 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10180 def SetAutoLayout(*args
, **kwargs
):
10182 SetAutoLayout(self, bool autoLayout)
10184 Determines whether the Layout function will be called automatically
10185 when the window is resized. lease note that this only happens for the
10186 windows usually used to contain children, namely `wx.Panel` and
10187 `wx.TopLevelWindow` (and the classes deriving from them).
10189 This method is called implicitly by `SetSizer` but if you use
10190 `SetConstraints` you should call it manually or otherwise the window
10191 layout won't be correctly updated when its size changes.
10193 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10195 def GetAutoLayout(*args
, **kwargs
):
10197 GetAutoLayout(self) -> bool
10199 Returns the current autoLayout setting
10201 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10203 def Layout(*args
, **kwargs
):
10205 Layout(self) -> bool
10207 Invokes the constraint-based layout algorithm or the sizer-based
10208 algorithm for this window. See SetAutoLayout: when auto layout is on,
10209 this function gets called automatically by the default EVT_SIZE
10210 handler when the window is resized.
10212 return _core_
.Window_Layout(*args
, **kwargs
)
10214 def SetSizer(*args
, **kwargs
):
10216 SetSizer(self, Sizer sizer, bool deleteOld=True)
10218 Sets the window to have the given layout sizer. The window will then
10219 own the object, and will take care of its deletion. If an existing
10220 layout sizer object is already owned by the window, it will be deleted
10221 if the deleteOld parameter is true. Note that this function will also
10222 call SetAutoLayout implicitly with a True parameter if the sizer is
10223 non-None, and False otherwise.
10225 return _core_
.Window_SetSizer(*args
, **kwargs
)
10227 def SetSizerAndFit(*args
, **kwargs
):
10229 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10231 The same as SetSizer, except it also sets the size hints for the
10232 window based on the sizer's minimum size.
10234 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10236 def GetSizer(*args
, **kwargs
):
10238 GetSizer(self) -> Sizer
10240 Return the sizer associated with the window by a previous call to
10241 SetSizer or None if there isn't one.
10243 return _core_
.Window_GetSizer(*args
, **kwargs
)
10245 def SetContainingSizer(*args
, **kwargs
):
10247 SetContainingSizer(self, Sizer sizer)
10249 This normally does not need to be called by application code. It is
10250 called internally when a window is added to a sizer, and is used so
10251 the window can remove itself from the sizer when it is destroyed.
10253 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10255 def GetContainingSizer(*args
, **kwargs
):
10257 GetContainingSizer(self) -> Sizer
10259 Return the sizer that this window is a member of, if any, otherwise None.
10261 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10263 def InheritAttributes(*args
, **kwargs
):
10265 InheritAttributes(self)
10267 This function is (or should be, in case of custom controls) called
10268 during window creation to intelligently set up the window visual
10269 attributes, that is the font and the foreground and background
10272 By 'intelligently' the following is meant: by default, all windows use
10273 their own default attributes. However if some of the parent's
10274 attributes are explicitly changed (that is, using SetFont and not
10275 SetOwnFont) and if the corresponding attribute hadn't been
10276 explicitly set for this window itself, then this window takes the same
10277 value as used by the parent. In addition, if the window overrides
10278 ShouldInheritColours to return false, the colours will not be changed
10279 no matter what and only the font might.
10281 This rather complicated logic is necessary in order to accommodate the
10282 different usage scenarios. The most common one is when all default
10283 attributes are used and in this case, nothing should be inherited as
10284 in modern GUIs different controls use different fonts (and colours)
10285 than their siblings so they can't inherit the same value from the
10286 parent. However it was also deemed desirable to allow to simply change
10287 the attributes of all children at once by just changing the font or
10288 colour of their common parent, hence in this case we do inherit the
10289 parents attributes.
10292 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10294 def ShouldInheritColours(*args
, **kwargs
):
10296 ShouldInheritColours(self) -> bool
10298 Return true from here to allow the colours of this window to be
10299 changed by InheritAttributes, returning false forbids inheriting them
10300 from the parent window.
10302 The base class version returns false, but this method is overridden in
10303 wxControl where it returns true.
10305 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10307 def CanSetTransparent(*args
, **kwargs
):
10309 CanSetTransparent(self) -> bool
10311 Returns ``True`` if the platform supports setting the transparency for
10312 this window. Note that this method will err on the side of caution,
10313 so it is possible that this will return ``False`` when it is in fact
10314 possible to set the transparency.
10316 NOTE: On X-windows systems the X server must have the composite
10317 extension loaded, and there must be a composite manager program (such
10318 as xcompmgr) running.
10320 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10322 def SetTransparent(*args
, **kwargs
):
10324 SetTransparent(self, byte alpha) -> bool
10326 Attempt to set the transparency of this window to the ``alpha`` value,
10327 returns True on success. The ``alpha`` value is an integer in the
10328 range of 0 to 255, where 0 is fully transparent and 255 is fully
10331 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10333 def PostCreate(self
, pre
):
10335 Phase 3 of the 2-phase create <wink!>
10336 Call this method after precreating the window with the 2-phase create method.
10338 self
.this
= pre
.this
10339 self
.thisown
= pre
.thisown
10341 if hasattr(self
, '_setOORInfo'):
10342 self
._setOORInfo
(self
)
10343 if hasattr(self
, '_setCallbackInfo'):
10344 self
._setCallbackInfo
(self
, self
.__class
__)
10346 def SendSizeEvent(self
):
10347 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10349 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10350 AdjustedBestSize
= property(GetAdjustedBestSize
,doc
="See `GetAdjustedBestSize`")
10351 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10352 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10353 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10354 EffectiveMinSize
= property(GetEffectiveMinSize
,doc
="See `GetEffectiveMinSize`")
10355 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10356 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10357 Border
= property(GetBorder
,doc
="See `GetBorder`")
10358 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10359 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10360 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10361 Children
= property(GetChildren
,doc
="See `GetChildren`")
10362 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10363 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10364 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10365 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10366 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10367 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10368 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10369 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10370 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10371 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10372 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10373 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10374 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10375 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10376 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10377 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10378 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10379 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10380 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10381 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10382 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10383 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10384 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10385 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10386 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10387 Parent
= property(GetParent
,doc
="See `GetParent`")
10388 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10389 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10390 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10391 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10392 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10393 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10394 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10395 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10396 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10397 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10398 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10399 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10400 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10401 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10402 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10403 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10404 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10405 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10406 _core_
.Window_swigregister(Window
)
10408 def PreWindow(*args
, **kwargs
):
10410 PreWindow() -> Window
10412 Precreate a Window for 2-phase creation.
10414 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10417 def Window_NewControlId(*args
):
10419 Window_NewControlId() -> int
10421 Generate a control id for the controls which were not given one.
10423 return _core_
.Window_NewControlId(*args
)
10425 def Window_NextControlId(*args
, **kwargs
):
10427 Window_NextControlId(int winid) -> int
10429 Get the id of the control following the one with the given
10432 return _core_
.Window_NextControlId(*args
, **kwargs
)
10434 def Window_PrevControlId(*args
, **kwargs
):
10436 Window_PrevControlId(int winid) -> int
10438 Get the id of the control preceding the one with the given
10441 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10443 def Window_FindFocus(*args
):
10445 Window_FindFocus() -> Window
10447 Returns the window or control that currently has the keyboard focus,
10450 return _core_
.Window_FindFocus(*args
)
10452 def Window_GetCapture(*args
):
10454 Window_GetCapture() -> Window
10456 Returns the window which currently captures the mouse or None
10458 return _core_
.Window_GetCapture(*args
)
10460 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10462 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10464 Get the default attributes for this class. This is useful if you want
10465 to use the same font or colour in your own control as in a standard
10466 control -- which is a much better idea than hard coding specific
10467 colours or fonts which might look completely out of place on the
10468 user's system, especially if it uses themes.
10470 The variant parameter is only relevant under Mac currently and is
10471 ignore under other platforms. Under Mac, it will change the size of
10472 the returned font. See `wx.Window.SetWindowVariant` for more about
10475 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10477 def DLG_PNT(win
, point_or_x
, y
=None):
10479 Convenience function for converting a Point or (x,y) in
10480 dialog units to pixel units.
10483 return win
.ConvertDialogPointToPixels(point_or_x
)
10485 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10487 def DLG_SZE(win
, size_width
, height
=None):
10489 Convenience function for converting a Size or (w,h) in
10490 dialog units to pixel units.
10493 return win
.ConvertDialogSizeToPixels(size_width
)
10495 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10498 def FindWindowById(*args
, **kwargs
):
10500 FindWindowById(long id, Window parent=None) -> Window
10502 Find the first window in the application with the given id. If parent
10503 is None, the search will start from all top-level frames and dialog
10504 boxes; if non-None, the search will be limited to the given window
10505 hierarchy. The search is recursive in both cases.
10507 return _core_
.FindWindowById(*args
, **kwargs
)
10509 def FindWindowByName(*args
, **kwargs
):
10511 FindWindowByName(String name, Window parent=None) -> Window
10513 Find a window by its name (as given in a window constructor or Create
10514 function call). If parent is None, the search will start from all
10515 top-level frames and dialog boxes; if non-None, the search will be
10516 limited to the given window hierarchy. The search is recursive in both
10519 If no window with such name is found, wx.FindWindowByLabel is called.
10521 return _core_
.FindWindowByName(*args
, **kwargs
)
10523 def FindWindowByLabel(*args
, **kwargs
):
10525 FindWindowByLabel(String label, Window parent=None) -> Window
10527 Find a window by its label. Depending on the type of window, the label
10528 may be a window title or panel item label. If parent is None, the
10529 search will start from all top-level frames and dialog boxes; if
10530 non-None, the search will be limited to the given window
10531 hierarchy. The search is recursive in both cases.
10533 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10535 def Window_FromHWND(*args
, **kwargs
):
10536 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10537 return _core_
.Window_FromHWND(*args
, **kwargs
)
10539 def GetTopLevelWindows(*args
):
10541 GetTopLevelWindows() -> PyObject
10543 Returns a list of the the application's top-level windows, (frames,
10544 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10545 by wxWidgets, and so it is only valid as long as no top-level windows
10546 are closed or new top-level windows are created.
10549 return _core_
.GetTopLevelWindows(*args
)
10550 #---------------------------------------------------------------------------
10552 class Validator(EvtHandler
):
10553 """Proxy of C++ Validator class"""
10554 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10555 __repr__
= _swig_repr
10556 def __init__(self
, *args
, **kwargs
):
10557 """__init__(self) -> Validator"""
10558 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10559 self
._setOORInfo
(self
)
10561 def Clone(*args
, **kwargs
):
10562 """Clone(self) -> Validator"""
10563 return _core_
.Validator_Clone(*args
, **kwargs
)
10565 def Validate(*args
, **kwargs
):
10566 """Validate(self, Window parent) -> bool"""
10567 return _core_
.Validator_Validate(*args
, **kwargs
)
10569 def TransferToWindow(*args
, **kwargs
):
10570 """TransferToWindow(self) -> bool"""
10571 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10573 def TransferFromWindow(*args
, **kwargs
):
10574 """TransferFromWindow(self) -> bool"""
10575 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10577 def GetWindow(*args
, **kwargs
):
10578 """GetWindow(self) -> Window"""
10579 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10581 def SetWindow(*args
, **kwargs
):
10582 """SetWindow(self, Window window)"""
10583 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10585 def IsSilent(*args
, **kwargs
):
10586 """IsSilent() -> bool"""
10587 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10589 IsSilent
= staticmethod(IsSilent
)
10590 def SetBellOnError(*args
, **kwargs
):
10591 """SetBellOnError(int doIt=True)"""
10592 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10594 SetBellOnError
= staticmethod(SetBellOnError
)
10595 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10596 _core_
.Validator_swigregister(Validator
)
10598 def Validator_IsSilent(*args
):
10599 """Validator_IsSilent() -> bool"""
10600 return _core_
.Validator_IsSilent(*args
)
10602 def Validator_SetBellOnError(*args
, **kwargs
):
10603 """Validator_SetBellOnError(int doIt=True)"""
10604 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10606 class PyValidator(Validator
):
10607 """Proxy of C++ PyValidator class"""
10608 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10609 __repr__
= _swig_repr
10610 def __init__(self
, *args
, **kwargs
):
10611 """__init__(self) -> PyValidator"""
10612 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10614 self
._setCallbackInfo
(self
, PyValidator
, 1)
10615 self
._setOORInfo
(self
)
10617 def _setCallbackInfo(*args
, **kwargs
):
10618 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10619 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10621 _core_
.PyValidator_swigregister(PyValidator
)
10623 #---------------------------------------------------------------------------
10625 class Menu(EvtHandler
):
10626 """Proxy of C++ Menu class"""
10627 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10628 __repr__
= _swig_repr
10629 def __init__(self
, *args
, **kwargs
):
10630 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10631 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10632 self
._setOORInfo
(self
)
10634 def Append(*args
, **kwargs
):
10636 Append(self, int id, String text=EmptyString, String help=EmptyString,
10637 int kind=ITEM_NORMAL) -> MenuItem
10639 return _core_
.Menu_Append(*args
, **kwargs
)
10641 def AppendSeparator(*args
, **kwargs
):
10642 """AppendSeparator(self) -> MenuItem"""
10643 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10645 def AppendCheckItem(*args
, **kwargs
):
10646 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10647 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10649 def AppendRadioItem(*args
, **kwargs
):
10650 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10651 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10653 def AppendMenu(*args
, **kwargs
):
10654 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10655 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10657 def AppendSubMenu(*args
, **kwargs
):
10658 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10659 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10661 def AppendItem(*args
, **kwargs
):
10662 """AppendItem(self, MenuItem item) -> MenuItem"""
10663 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10665 def InsertItem(*args
, **kwargs
):
10666 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10667 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10669 def PrependItem(*args
, **kwargs
):
10670 """PrependItem(self, MenuItem item) -> MenuItem"""
10671 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10673 def Break(*args
, **kwargs
):
10675 return _core_
.Menu_Break(*args
, **kwargs
)
10677 def Insert(*args
, **kwargs
):
10679 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10680 int kind=ITEM_NORMAL) -> MenuItem
10682 return _core_
.Menu_Insert(*args
, **kwargs
)
10684 def InsertSeparator(*args
, **kwargs
):
10685 """InsertSeparator(self, size_t pos) -> MenuItem"""
10686 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10688 def InsertCheckItem(*args
, **kwargs
):
10689 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10690 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10692 def InsertRadioItem(*args
, **kwargs
):
10693 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10694 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10696 def InsertMenu(*args
, **kwargs
):
10697 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10698 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10700 def Prepend(*args
, **kwargs
):
10702 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10703 int kind=ITEM_NORMAL) -> MenuItem
10705 return _core_
.Menu_Prepend(*args
, **kwargs
)
10707 def PrependSeparator(*args
, **kwargs
):
10708 """PrependSeparator(self) -> MenuItem"""
10709 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10711 def PrependCheckItem(*args
, **kwargs
):
10712 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10713 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10715 def PrependRadioItem(*args
, **kwargs
):
10716 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10717 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10719 def PrependMenu(*args
, **kwargs
):
10720 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10721 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10723 def Remove(*args
, **kwargs
):
10724 """Remove(self, int id) -> MenuItem"""
10725 return _core_
.Menu_Remove(*args
, **kwargs
)
10727 def RemoveItem(*args
, **kwargs
):
10728 """RemoveItem(self, MenuItem item) -> MenuItem"""
10729 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10731 def Delete(*args
, **kwargs
):
10732 """Delete(self, int id) -> bool"""
10733 return _core_
.Menu_Delete(*args
, **kwargs
)
10735 def DeleteItem(*args
, **kwargs
):
10736 """DeleteItem(self, MenuItem item) -> bool"""
10737 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10739 def Destroy(*args
, **kwargs
):
10743 Deletes the C++ object this Python object is a proxy for.
10745 args
[0].this
.own(False)
10746 return _core_
.Menu_Destroy(*args
, **kwargs
)
10748 def DestroyId(*args
, **kwargs
):
10749 """DestroyId(self, int id) -> bool"""
10750 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10752 def DestroyItem(*args
, **kwargs
):
10753 """DestroyItem(self, MenuItem item) -> bool"""
10754 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10756 def GetMenuItemCount(*args
, **kwargs
):
10757 """GetMenuItemCount(self) -> size_t"""
10758 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10760 def GetMenuItems(*args
, **kwargs
):
10761 """GetMenuItems(self) -> PyObject"""
10762 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10764 def FindItem(*args
, **kwargs
):
10765 """FindItem(self, String item) -> int"""
10766 return _core_
.Menu_FindItem(*args
, **kwargs
)
10768 def FindItemById(*args
, **kwargs
):
10769 """FindItemById(self, int id) -> MenuItem"""
10770 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10772 def FindItemByPosition(*args
, **kwargs
):
10773 """FindItemByPosition(self, size_t position) -> MenuItem"""
10774 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10776 def Enable(*args
, **kwargs
):
10777 """Enable(self, int id, bool enable)"""
10778 return _core_
.Menu_Enable(*args
, **kwargs
)
10780 def IsEnabled(*args
, **kwargs
):
10781 """IsEnabled(self, int id) -> bool"""
10782 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10784 def Check(*args
, **kwargs
):
10785 """Check(self, int id, bool check)"""
10786 return _core_
.Menu_Check(*args
, **kwargs
)
10788 def IsChecked(*args
, **kwargs
):
10789 """IsChecked(self, int id) -> bool"""
10790 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10792 def SetLabel(*args
, **kwargs
):
10793 """SetLabel(self, int id, String label)"""
10794 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10796 def GetLabel(*args
, **kwargs
):
10797 """GetLabel(self, int id) -> String"""
10798 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10800 def SetHelpString(*args
, **kwargs
):
10801 """SetHelpString(self, int id, String helpString)"""
10802 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10804 def GetHelpString(*args
, **kwargs
):
10805 """GetHelpString(self, int id) -> String"""
10806 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10808 def SetTitle(*args
, **kwargs
):
10809 """SetTitle(self, String title)"""
10810 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10812 def GetTitle(*args
, **kwargs
):
10813 """GetTitle(self) -> String"""
10814 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10816 def SetEventHandler(*args
, **kwargs
):
10817 """SetEventHandler(self, EvtHandler handler)"""
10818 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10820 def GetEventHandler(*args
, **kwargs
):
10821 """GetEventHandler(self) -> EvtHandler"""
10822 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10824 def SetInvokingWindow(*args
, **kwargs
):
10825 """SetInvokingWindow(self, Window win)"""
10826 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10828 def GetInvokingWindow(*args
, **kwargs
):
10829 """GetInvokingWindow(self) -> Window"""
10830 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10832 def GetStyle(*args
, **kwargs
):
10833 """GetStyle(self) -> long"""
10834 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10836 def UpdateUI(*args
, **kwargs
):
10837 """UpdateUI(self, EvtHandler source=None)"""
10838 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10840 def GetMenuBar(*args
, **kwargs
):
10841 """GetMenuBar(self) -> MenuBar"""
10842 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10844 def Attach(*args
, **kwargs
):
10845 """Attach(self, wxMenuBarBase menubar)"""
10846 return _core_
.Menu_Attach(*args
, **kwargs
)
10848 def Detach(*args
, **kwargs
):
10850 return _core_
.Menu_Detach(*args
, **kwargs
)
10852 def IsAttached(*args
, **kwargs
):
10853 """IsAttached(self) -> bool"""
10854 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10856 def SetParent(*args
, **kwargs
):
10857 """SetParent(self, Menu parent)"""
10858 return _core_
.Menu_SetParent(*args
, **kwargs
)
10860 def GetParent(*args
, **kwargs
):
10861 """GetParent(self) -> Menu"""
10862 return _core_
.Menu_GetParent(*args
, **kwargs
)
10864 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10865 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10866 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10867 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10868 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10869 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10870 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10871 Style
= property(GetStyle
,doc
="See `GetStyle`")
10872 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10873 _core_
.Menu_swigregister(Menu
)
10874 DefaultValidator
= cvar
.DefaultValidator
10876 #---------------------------------------------------------------------------
10878 class MenuBar(Window
):
10879 """Proxy of C++ MenuBar class"""
10880 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10881 __repr__
= _swig_repr
10882 def __init__(self
, *args
, **kwargs
):
10883 """__init__(self, long style=0) -> MenuBar"""
10884 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10885 self
._setOORInfo
(self
)
10887 def Append(*args
, **kwargs
):
10888 """Append(self, Menu menu, String title) -> bool"""
10889 return _core_
.MenuBar_Append(*args
, **kwargs
)
10891 def Insert(*args
, **kwargs
):
10892 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10893 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10895 def GetMenuCount(*args
, **kwargs
):
10896 """GetMenuCount(self) -> size_t"""
10897 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10899 def GetMenu(*args
, **kwargs
):
10900 """GetMenu(self, size_t pos) -> Menu"""
10901 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10903 def Replace(*args
, **kwargs
):
10904 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10905 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10907 def Remove(*args
, **kwargs
):
10908 """Remove(self, size_t pos) -> Menu"""
10909 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10911 def EnableTop(*args
, **kwargs
):
10912 """EnableTop(self, size_t pos, bool enable)"""
10913 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10915 def IsEnabledTop(*args
, **kwargs
):
10916 """IsEnabledTop(self, size_t pos) -> bool"""
10917 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10919 def SetLabelTop(*args
, **kwargs
):
10920 """SetLabelTop(self, size_t pos, String label)"""
10921 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10923 def GetLabelTop(*args
, **kwargs
):
10924 """GetLabelTop(self, size_t pos) -> String"""
10925 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10927 def FindMenuItem(*args
, **kwargs
):
10928 """FindMenuItem(self, String menu, String item) -> int"""
10929 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10931 def FindItemById(*args
, **kwargs
):
10932 """FindItemById(self, int id) -> MenuItem"""
10933 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10935 def FindMenu(*args
, **kwargs
):
10936 """FindMenu(self, String title) -> int"""
10937 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10939 def Enable(*args
, **kwargs
):
10940 """Enable(self, int id, bool enable)"""
10941 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10943 def Check(*args
, **kwargs
):
10944 """Check(self, int id, bool check)"""
10945 return _core_
.MenuBar_Check(*args
, **kwargs
)
10947 def IsChecked(*args
, **kwargs
):
10948 """IsChecked(self, int id) -> bool"""
10949 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10951 def IsEnabled(*args
, **kwargs
):
10952 """IsEnabled(self, int id) -> bool"""
10953 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10955 def SetLabel(*args
, **kwargs
):
10956 """SetLabel(self, int id, String label)"""
10957 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10959 def GetLabel(*args
, **kwargs
):
10960 """GetLabel(self, int id) -> String"""
10961 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10963 def SetHelpString(*args
, **kwargs
):
10964 """SetHelpString(self, int id, String helpString)"""
10965 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10967 def GetHelpString(*args
, **kwargs
):
10968 """GetHelpString(self, int id) -> String"""
10969 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10971 def GetFrame(*args
, **kwargs
):
10972 """GetFrame(self) -> wxFrame"""
10973 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10975 def IsAttached(*args
, **kwargs
):
10976 """IsAttached(self) -> bool"""
10977 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10979 def Attach(*args
, **kwargs
):
10980 """Attach(self, wxFrame frame)"""
10981 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10983 def Detach(*args
, **kwargs
):
10985 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10987 def UpdateMenus(*args
, **kwargs
):
10988 """UpdateMenus(self)"""
10989 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10991 def SetAutoWindowMenu(*args
, **kwargs
):
10992 """SetAutoWindowMenu(bool enable)"""
10993 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10995 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10996 def GetAutoWindowMenu(*args
, **kwargs
):
10997 """GetAutoWindowMenu() -> bool"""
10998 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
11000 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
11001 def GetMenus(self
):
11002 """Return a list of (menu, label) items for the menus in the MenuBar. """
11003 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
11004 for i
in range(self
.GetMenuCount())]
11006 def SetMenus(self
, items
):
11007 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11008 for i
in range(self
.GetMenuCount()-1, -1, -1):
11013 Frame
= property(GetFrame
,doc
="See `GetFrame`")
11014 Menu
= property(GetMenu
,doc
="See `GetMenu`")
11015 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
11016 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
11017 _core_
.MenuBar_swigregister(MenuBar
)
11019 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
11020 """MenuBar_SetAutoWindowMenu(bool enable)"""
11021 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11023 def MenuBar_GetAutoWindowMenu(*args
):
11024 """MenuBar_GetAutoWindowMenu() -> bool"""
11025 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
11027 #---------------------------------------------------------------------------
11029 class MenuItem(Object
):
11030 """Proxy of C++ MenuItem class"""
11031 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11032 __repr__
= _swig_repr
11033 def __init__(self
, *args
, **kwargs
):
11035 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11036 String help=EmptyString, int kind=ITEM_NORMAL,
11037 Menu subMenu=None) -> MenuItem
11039 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
11040 __swig_destroy__
= _core_
.delete_MenuItem
11041 __del__
= lambda self
: None;
11042 def GetMenu(*args
, **kwargs
):
11043 """GetMenu(self) -> Menu"""
11044 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
11046 def SetMenu(*args
, **kwargs
):
11047 """SetMenu(self, Menu menu)"""
11048 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
11050 def SetId(*args
, **kwargs
):
11051 """SetId(self, int id)"""
11052 return _core_
.MenuItem_SetId(*args
, **kwargs
)
11054 def GetId(*args
, **kwargs
):
11055 """GetId(self) -> int"""
11056 return _core_
.MenuItem_GetId(*args
, **kwargs
)
11058 def IsSeparator(*args
, **kwargs
):
11059 """IsSeparator(self) -> bool"""
11060 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
11062 def SetText(*args
, **kwargs
):
11063 """SetText(self, String str)"""
11064 return _core_
.MenuItem_SetText(*args
, **kwargs
)
11066 def GetLabel(*args
, **kwargs
):
11067 """GetLabel(self) -> String"""
11068 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
11070 def GetText(*args
, **kwargs
):
11071 """GetText(self) -> String"""
11072 return _core_
.MenuItem_GetText(*args
, **kwargs
)
11074 def GetLabelFromText(*args
, **kwargs
):
11075 """GetLabelFromText(String text) -> String"""
11076 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11078 GetLabelFromText
= staticmethod(GetLabelFromText
)
11079 def GetKind(*args
, **kwargs
):
11080 """GetKind(self) -> int"""
11081 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
11083 def SetKind(*args
, **kwargs
):
11084 """SetKind(self, int kind)"""
11085 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
11087 def SetCheckable(*args
, **kwargs
):
11088 """SetCheckable(self, bool checkable)"""
11089 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
11091 def IsCheckable(*args
, **kwargs
):
11092 """IsCheckable(self) -> bool"""
11093 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
11095 def IsSubMenu(*args
, **kwargs
):
11096 """IsSubMenu(self) -> bool"""
11097 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
11099 def SetSubMenu(*args
, **kwargs
):
11100 """SetSubMenu(self, Menu menu)"""
11101 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
11103 def GetSubMenu(*args
, **kwargs
):
11104 """GetSubMenu(self) -> Menu"""
11105 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
11107 def Enable(*args
, **kwargs
):
11108 """Enable(self, bool enable=True)"""
11109 return _core_
.MenuItem_Enable(*args
, **kwargs
)
11111 def IsEnabled(*args
, **kwargs
):
11112 """IsEnabled(self) -> bool"""
11113 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
11115 def Check(*args
, **kwargs
):
11116 """Check(self, bool check=True)"""
11117 return _core_
.MenuItem_Check(*args
, **kwargs
)
11119 def IsChecked(*args
, **kwargs
):
11120 """IsChecked(self) -> bool"""
11121 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
11123 def Toggle(*args
, **kwargs
):
11125 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
11127 def SetHelp(*args
, **kwargs
):
11128 """SetHelp(self, String str)"""
11129 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
11131 def GetHelp(*args
, **kwargs
):
11132 """GetHelp(self) -> String"""
11133 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
11135 def GetAccel(*args
, **kwargs
):
11136 """GetAccel(self) -> AcceleratorEntry"""
11137 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
11139 def SetAccel(*args
, **kwargs
):
11140 """SetAccel(self, AcceleratorEntry accel)"""
11141 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
11143 def SetBitmap(*args
, **kwargs
):
11144 """SetBitmap(self, Bitmap bitmap)"""
11145 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
11147 def GetBitmap(*args
, **kwargs
):
11148 """GetBitmap(self) -> Bitmap"""
11149 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
11151 def SetFont(*args
, **kwargs
):
11152 """SetFont(self, Font font)"""
11153 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
11155 def GetFont(*args
, **kwargs
):
11156 """GetFont(self) -> Font"""
11157 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
11159 def SetTextColour(*args
, **kwargs
):
11160 """SetTextColour(self, Colour colText)"""
11161 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
11163 def GetTextColour(*args
, **kwargs
):
11164 """GetTextColour(self) -> Colour"""
11165 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
11167 def SetBackgroundColour(*args
, **kwargs
):
11168 """SetBackgroundColour(self, Colour colBack)"""
11169 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
11171 def GetBackgroundColour(*args
, **kwargs
):
11172 """GetBackgroundColour(self) -> Colour"""
11173 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11175 def SetBitmaps(*args
, **kwargs
):
11176 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11177 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11179 def SetDisabledBitmap(*args
, **kwargs
):
11180 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11181 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11183 def GetDisabledBitmap(*args
, **kwargs
):
11184 """GetDisabledBitmap(self) -> Bitmap"""
11185 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11187 def SetMarginWidth(*args
, **kwargs
):
11188 """SetMarginWidth(self, int nWidth)"""
11189 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11191 def GetMarginWidth(*args
, **kwargs
):
11192 """GetMarginWidth(self) -> int"""
11193 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11195 def GetDefaultMarginWidth(*args
, **kwargs
):
11196 """GetDefaultMarginWidth() -> int"""
11197 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11199 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11200 def IsOwnerDrawn(*args
, **kwargs
):
11201 """IsOwnerDrawn(self) -> bool"""
11202 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11204 def SetOwnerDrawn(*args
, **kwargs
):
11205 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11206 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11208 def ResetOwnerDrawn(*args
, **kwargs
):
11209 """ResetOwnerDrawn(self)"""
11210 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11212 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
11213 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
11214 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
11215 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11216 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
11217 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
11218 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
11219 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
11220 Label
= property(GetLabel
,doc
="See `GetLabel`")
11221 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
11222 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
11223 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
11224 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
11225 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
11226 _core_
.MenuItem_swigregister(MenuItem
)
11228 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11229 """MenuItem_GetLabelFromText(String text) -> String"""
11230 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11232 def MenuItem_GetDefaultMarginWidth(*args
):
11233 """MenuItem_GetDefaultMarginWidth() -> int"""
11234 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
11236 #---------------------------------------------------------------------------
11238 class Control(Window
):
11240 This is the base class for a control or 'widget'.
11242 A control is generally a small window which processes user input
11243 and/or displays one or more item of data.
11245 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11246 __repr__
= _swig_repr
11247 def __init__(self
, *args
, **kwargs
):
11249 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11250 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11251 String name=ControlNameStr) -> Control
11253 Create a Control. Normally you should only call this from a subclass'
11254 __init__ as a plain old wx.Control is not very useful.
11256 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
11257 self
._setOORInfo
(self
)
11259 def Create(*args
, **kwargs
):
11261 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11262 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11263 String name=ControlNameStr) -> bool
11265 Do the 2nd phase and create the GUI control.
11267 return _core_
.Control_Create(*args
, **kwargs
)
11269 def GetAlignment(*args
, **kwargs
):
11271 GetAlignment(self) -> int
11273 Get the control alignment (left/right/centre, top/bottom/centre)
11275 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11277 def GetLabelText(*args
, **kwargs
):
11279 GetLabelText(self) -> String
11281 Get just the text of the label, without mnemonic characters ('&')
11283 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11285 def Command(*args
, **kwargs
):
11287 Command(self, CommandEvent event)
11289 Simulates the effect of the user issuing a command to the item.
11291 :see: `wx.CommandEvent`
11294 return _core_
.Control_Command(*args
, **kwargs
)
11296 def GetClassDefaultAttributes(*args
, **kwargs
):
11298 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11300 Get the default attributes for this class. This is useful if you want
11301 to use the same font or colour in your own control as in a standard
11302 control -- which is a much better idea than hard coding specific
11303 colours or fonts which might look completely out of place on the
11304 user's system, especially if it uses themes.
11306 The variant parameter is only relevant under Mac currently and is
11307 ignore under other platforms. Under Mac, it will change the size of
11308 the returned font. See `wx.Window.SetWindowVariant` for more about
11311 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11313 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11314 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11315 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11316 _core_
.Control_swigregister(Control
)
11317 ControlNameStr
= cvar
.ControlNameStr
11319 def PreControl(*args
, **kwargs
):
11321 PreControl() -> Control
11323 Precreate a Control control for 2-phase creation
11325 val
= _core_
.new_PreControl(*args
, **kwargs
)
11328 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11330 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11332 Get the default attributes for this class. This is useful if you want
11333 to use the same font or colour in your own control as in a standard
11334 control -- which is a much better idea than hard coding specific
11335 colours or fonts which might look completely out of place on the
11336 user's system, especially if it uses themes.
11338 The variant parameter is only relevant under Mac currently and is
11339 ignore under other platforms. Under Mac, it will change the size of
11340 the returned font. See `wx.Window.SetWindowVariant` for more about
11343 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11345 #---------------------------------------------------------------------------
11347 class ItemContainer(object):
11349 The wx.ItemContainer class defines an interface which is implemented
11350 by all controls which have string subitems, each of which may be
11351 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11352 as `wx.ComboBox` which implements an extended interface deriving from
11355 It defines the methods for accessing the control's items and although
11356 each of the derived classes implements them differently, they still
11357 all conform to the same interface.
11359 The items in a wx.ItemContainer have (non empty) string labels and,
11360 optionally, client data associated with them.
11363 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11364 def __init__(self
): raise AttributeError, "No constructor defined"
11365 __repr__
= _swig_repr
11366 def Append(*args
, **kwargs
):
11368 Append(self, String item, PyObject clientData=None) -> int
11370 Adds the item to the control, associating the given data with the item
11371 if not None. The return value is the index of the newly added item
11372 which may be different from the last one if the control is sorted (e.g.
11373 has wx.LB_SORT or wx.CB_SORT style).
11375 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11377 def AppendItems(*args
, **kwargs
):
11379 AppendItems(self, List strings)
11381 Apend several items at once to the control. Notice that calling this
11382 method may be much faster than appending the items one by one if you
11383 need to add a lot of items.
11385 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11387 def Insert(*args
, **kwargs
):
11389 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11391 Insert an item into the control before the item at the ``pos`` index,
11392 optionally associating some data object with the item.
11394 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11396 def Clear(*args
, **kwargs
):
11400 Removes all items from the control.
11402 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11404 def Delete(*args
, **kwargs
):
11406 Delete(self, unsigned int n)
11408 Deletes the item at the zero-based index 'n' from the control. Note
11409 that it is an error (signalled by a `wx.PyAssertionError` exception if
11410 enabled) to remove an item with the index negative or greater or equal
11411 than the number of items in the control.
11413 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11415 def GetClientData(*args
, **kwargs
):
11417 GetClientData(self, unsigned int n) -> PyObject
11419 Returns the client data associated with the given item, (if any.)
11421 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11423 def SetClientData(*args
, **kwargs
):
11425 SetClientData(self, unsigned int n, PyObject clientData)
11427 Associate the given client data with the item at position n.
11429 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11431 def GetCount(*args
, **kwargs
):
11433 GetCount(self) -> unsigned int
11435 Returns the number of items in the control.
11437 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11439 def IsEmpty(*args
, **kwargs
):
11441 IsEmpty(self) -> bool
11443 Returns True if the control is empty or False if it has some items.
11445 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11447 def GetString(*args
, **kwargs
):
11449 GetString(self, unsigned int n) -> String
11451 Returns the label of the item with the given index.
11453 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11455 def GetStrings(*args
, **kwargs
):
11456 """GetStrings(self) -> wxArrayString"""
11457 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11459 def SetString(*args
, **kwargs
):
11461 SetString(self, unsigned int n, String s)
11463 Sets the label for the given item.
11465 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11467 def FindString(*args
, **kwargs
):
11469 FindString(self, String s) -> int
11471 Finds an item whose label matches the given string. Returns the
11472 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11475 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11477 def SetSelection(*args
, **kwargs
):
11479 SetSelection(self, int n)
11481 Sets the item at index 'n' to be the selected item.
11483 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11485 def GetSelection(*args
, **kwargs
):
11487 GetSelection(self) -> int
11489 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11492 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11494 def SetStringSelection(*args
, **kwargs
):
11495 """SetStringSelection(self, String s) -> bool"""
11496 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11498 def GetStringSelection(*args
, **kwargs
):
11500 GetStringSelection(self) -> String
11502 Returns the label of the selected item or an empty string if no item
11505 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11507 def Select(*args
, **kwargs
):
11509 Select(self, int n)
11511 This is the same as `SetSelection` and exists only because it is
11512 slightly more natural for controls which support multiple selection.
11514 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11516 def GetItems(self
):
11517 """Return a list of the strings in the control"""
11518 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11520 def SetItems(self
, items
):
11521 """Clear and set the strings in the control from a list"""
11526 Count
= property(GetCount
,doc
="See `GetCount`")
11527 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11528 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11529 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11530 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11531 _core_
.ItemContainer_swigregister(ItemContainer
)
11533 #---------------------------------------------------------------------------
11535 class ControlWithItems(Control
,ItemContainer
):
11537 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11538 wx.Control class, and is used for the base class of various controls
11541 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11542 def __init__(self
): raise AttributeError, "No constructor defined"
11543 __repr__
= _swig_repr
11544 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11546 #---------------------------------------------------------------------------
11548 class SizerItem(Object
):
11550 The wx.SizerItem class is used to track the position, size and other
11551 attributes of each item managed by a `wx.Sizer`. It is not usually
11552 necessary to use this class because the sizer elements can also be
11553 identified by their positions or window or sizer references but
11554 sometimes it may be more convenient to use wx.SizerItem directly.
11555 Also, custom classes derived from `wx.PySizer` will probably need to
11556 use the collection of wx.SizerItems held by wx.Sizer when calculating
11559 :see: `wx.Sizer`, `wx.GBSizerItem`
11561 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11562 __repr__
= _swig_repr
11563 def __init__(self
, *args
, **kwargs
):
11565 __init__(self) -> SizerItem
11567 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11568 size will need to be set before this item can be used in a Sizer.
11570 You will probably never need to create a wx.SizerItem directly as they
11571 are created automatically when the sizer's Add, Insert or Prepend
11572 methods are called.
11574 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11576 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11577 __swig_destroy__
= _core_
.delete_SizerItem
11578 __del__
= lambda self
: None;
11579 def DeleteWindows(*args
, **kwargs
):
11581 DeleteWindows(self)
11583 Destroy the window or the windows in a subsizer, depending on the type
11586 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11588 def DetachSizer(*args
, **kwargs
):
11592 Enable deleting the SizerItem without destroying the contained sizer.
11594 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11596 def GetSize(*args
, **kwargs
):
11598 GetSize(self) -> Size
11600 Get the current size of the item, as set in the last Layout.
11602 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11604 def CalcMin(*args
, **kwargs
):
11606 CalcMin(self) -> Size
11608 Calculates the minimum desired size for the item, including any space
11611 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11613 def SetDimension(*args
, **kwargs
):
11615 SetDimension(self, Point pos, Size size)
11617 Set the position and size of the space allocated for this item by the
11618 sizer, and adjust the position and size of the item (window or
11619 subsizer) to be within that space taking alignment and borders into
11622 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11624 def GetMinSize(*args
, **kwargs
):
11626 GetMinSize(self) -> Size
11628 Get the minimum size needed for the item.
11630 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11632 def GetMinSizeWithBorder(*args
, **kwargs
):
11634 GetMinSizeWithBorder(self) -> Size
11636 Get the minimum size needed for the item with space for the borders
11639 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11641 def SetInitSize(*args
, **kwargs
):
11642 """SetInitSize(self, int x, int y)"""
11643 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11645 def SetRatioWH(*args
, **kwargs
):
11647 SetRatioWH(self, int width, int height)
11649 Set the ratio item attribute.
11651 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11653 def SetRatioSize(*args
, **kwargs
):
11655 SetRatioSize(self, Size size)
11657 Set the ratio item attribute.
11659 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11661 def SetRatio(*args
, **kwargs
):
11663 SetRatio(self, float ratio)
11665 Set the ratio item attribute.
11667 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11669 def GetRatio(*args
, **kwargs
):
11671 GetRatio(self) -> float
11673 Set the ratio item attribute.
11675 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11677 def GetRect(*args
, **kwargs
):
11679 GetRect(self) -> Rect
11681 Returns the rectangle that the sizer item should occupy
11683 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11685 def IsWindow(*args
, **kwargs
):
11687 IsWindow(self) -> bool
11689 Is this sizer item a window?
11691 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11693 def IsSizer(*args
, **kwargs
):
11695 IsSizer(self) -> bool
11697 Is this sizer item a subsizer?
11699 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11701 def IsSpacer(*args
, **kwargs
):
11703 IsSpacer(self) -> bool
11705 Is this sizer item a spacer?
11707 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11709 def SetProportion(*args
, **kwargs
):
11711 SetProportion(self, int proportion)
11713 Set the proportion value for this item.
11715 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11717 def GetProportion(*args
, **kwargs
):
11719 GetProportion(self) -> int
11721 Get the proportion value for this item.
11723 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11725 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11726 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11727 def SetFlag(*args
, **kwargs
):
11729 SetFlag(self, int flag)
11731 Set the flag value for this item.
11733 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11735 def GetFlag(*args
, **kwargs
):
11737 GetFlag(self) -> int
11739 Get the flag value for this item.
11741 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11743 def SetBorder(*args
, **kwargs
):
11745 SetBorder(self, int border)
11747 Set the border value for this item.
11749 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11751 def GetBorder(*args
, **kwargs
):
11753 GetBorder(self) -> int
11755 Get the border value for this item.
11757 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11759 def GetWindow(*args
, **kwargs
):
11761 GetWindow(self) -> Window
11763 Get the window (if any) that is managed by this sizer item.
11765 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11767 def SetWindow(*args
, **kwargs
):
11769 SetWindow(self, Window window)
11771 Set the window to be managed by this sizer item.
11773 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11775 def GetSizer(*args
, **kwargs
):
11777 GetSizer(self) -> Sizer
11779 Get the subsizer (if any) that is managed by this sizer item.
11781 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11783 def SetSizer(*args
, **kwargs
):
11785 SetSizer(self, Sizer sizer)
11787 Set the subsizer to be managed by this sizer item.
11789 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11791 def GetSpacer(*args
, **kwargs
):
11793 GetSpacer(self) -> Size
11795 Get the size of the spacer managed by this sizer item.
11797 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11799 def SetSpacer(*args
, **kwargs
):
11801 SetSpacer(self, Size size)
11803 Set the size of the spacer to be managed by this sizer item.
11805 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11807 def Show(*args
, **kwargs
):
11809 Show(self, bool show)
11811 Set the show item attribute, which sizers use to determine if the item
11812 is to be made part of the layout or not. If the item is tracking a
11813 window then it is shown or hidden as needed.
11815 return _core_
.SizerItem_Show(*args
, **kwargs
)
11817 def IsShown(*args
, **kwargs
):
11819 IsShown(self) -> bool
11821 Is the item to be shown in the layout?
11823 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11825 def GetPosition(*args
, **kwargs
):
11827 GetPosition(self) -> Point
11829 Returns the current position of the item, as set in the last Layout.
11831 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11833 def GetUserData(*args
, **kwargs
):
11835 GetUserData(self) -> PyObject
11837 Returns the userData associated with this sizer item, or None if there
11840 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11842 def SetUserData(*args
, **kwargs
):
11844 SetUserData(self, PyObject userData)
11846 Associate a Python object with this sizer item.
11848 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11850 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11851 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11852 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11853 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11854 Position
= property(GetPosition
,doc
="See `GetPosition`")
11855 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11856 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11857 Rect
= property(GetRect
,doc
="See `GetRect`")
11858 Size
= property(GetSize
,doc
="See `GetSize`")
11859 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11860 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11861 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11862 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11863 _core_
.SizerItem_swigregister(SizerItem
)
11865 def SizerItemWindow(*args
, **kwargs
):
11867 SizerItemWindow(Window window, int proportion, int flag, int border,
11868 PyObject userData=None) -> SizerItem
11870 Constructs a `wx.SizerItem` for tracking a window.
11872 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11875 def SizerItemSpacer(*args
, **kwargs
):
11877 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11878 PyObject userData=None) -> SizerItem
11880 Constructs a `wx.SizerItem` for tracking a spacer.
11882 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11885 def SizerItemSizer(*args
, **kwargs
):
11887 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11888 PyObject userData=None) -> SizerItem
11890 Constructs a `wx.SizerItem` for tracking a subsizer
11892 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11895 class Sizer(Object
):
11897 wx.Sizer is the abstract base class used for laying out subwindows in
11898 a window. You cannot use wx.Sizer directly; instead, you will have to
11899 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11900 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11903 The concept implemented by sizers in wxWidgets is closely related to
11904 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11905 toolkit or the Qt toolkit. It is based upon the idea of the individual
11906 subwindows reporting their minimal required size and their ability to
11907 get stretched if the size of the parent window has changed. This will
11908 most often mean that the programmer does not set the original size of
11909 a dialog in the beginning, rather the dialog will assigned a sizer and
11910 this sizer will be queried about the recommended size. The sizer in
11911 turn will query its children, which can be normal windows or contorls,
11912 empty space or other sizers, so that a hierarchy of sizers can be
11913 constructed. Note that wxSizer does not derive from wxWindow and thus
11914 do not interfere with tab ordering and requires very little resources
11915 compared to a real window on screen.
11917 What makes sizers so well fitted for use in wxWidgets is the fact that
11918 every control reports its own minimal size and the algorithm can
11919 handle differences in font sizes or different window (dialog item)
11920 sizes on different platforms without problems. If for example the
11921 standard font as well as the overall design of Mac widgets requires
11922 more space than on Windows, then the initial size of a dialog using a
11923 sizer will automatically be bigger on Mac than on Windows.
11925 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11926 def __init__(self
): raise AttributeError, "No constructor defined"
11927 __repr__
= _swig_repr
11928 __swig_destroy__
= _core_
.delete_Sizer
11929 __del__
= lambda self
: None;
11930 def _setOORInfo(*args
, **kwargs
):
11931 """_setOORInfo(self, PyObject _self)"""
11932 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11934 def Add(*args
, **kwargs
):
11936 Add(self, item, int proportion=0, int flag=0, int border=0,
11937 PyObject userData=None) -> wx.SizerItem
11939 Appends a child item to the sizer.
11941 return _core_
.Sizer_Add(*args
, **kwargs
)
11943 def Insert(*args
, **kwargs
):
11945 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11946 PyObject userData=None) -> wx.SizerItem
11948 Inserts a new item into the list of items managed by this sizer before
11949 the item at index *before*. See `Add` for a description of the parameters.
11951 return _core_
.Sizer_Insert(*args
, **kwargs
)
11953 def Prepend(*args
, **kwargs
):
11955 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11956 PyObject userData=None) -> wx.SizerItem
11958 Adds a new item to the begining of the list of sizer items managed by
11959 this sizer. See `Add` for a description of the parameters.
11961 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11963 def Remove(*args
, **kwargs
):
11965 Remove(self, item) -> bool
11967 Removes an item from the sizer and destroys it. This method does not
11968 cause any layout or resizing to take place, call `Layout` to update
11969 the layout on screen after removing a child from the sizer. The
11970 *item* parameter can be either a window, a sizer, or the zero-based
11971 index of an item to remove. Returns True if the child item was found
11974 return _core_
.Sizer_Remove(*args
, **kwargs
)
11976 def Detach(*args
, **kwargs
):
11978 Detach(self, item) -> bool
11980 Detaches an item from the sizer without destroying it. This method
11981 does not cause any layout or resizing to take place, call `Layout` to
11982 do so. The *item* parameter can be either a window, a sizer, or the
11983 zero-based index of the item to be detached. Returns True if the child item
11984 was found and detached.
11986 return _core_
.Sizer_Detach(*args
, **kwargs
)
11988 def GetItem(*args
, **kwargs
):
11990 GetItem(self, item) -> wx.SizerItem
11992 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11993 parameter can be either a window, a sizer, or the zero-based index of
11994 the item to be found.
11996 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11998 def _SetItemMinSize(*args
, **kwargs
):
11999 """_SetItemMinSize(self, PyObject item, Size size)"""
12000 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
12002 def _ReplaceWin(*args
, **kwargs
):
12003 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12004 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
12006 def _ReplaceSizer(*args
, **kwargs
):
12007 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12008 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
12010 def _ReplaceItem(*args
, **kwargs
):
12011 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12012 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
12014 def Replace(self
, olditem
, item
, recursive
=False):
12016 Detaches the given ``olditem`` from the sizer and replaces it with
12017 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12018 detached child is destroyed only if it is not a window, (because
12019 windows are owned by their parent, not the sizer.) The
12020 ``recursive`` parameter can be used to search for the given
12021 element recursivly in subsizers.
12023 This method does not cause any layout or resizing to take place,
12024 call `Layout` to do so.
12026 Returns ``True`` if the child item was found and removed.
12028 if isinstance(olditem
, wx
.Window
):
12029 return self
._ReplaceWin
(olditem
, item
, recursive
)
12030 elif isinstnace(olditem
, wx
.Sizer
):
12031 return self
._ReplaceSizer
(olditem
, item
, recursive
)
12032 elif isinstnace(olditem
, int):
12033 return self
._ReplaceItem
(olditem
, item
)
12035 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12037 def SetContainingWindow(*args
, **kwargs
):
12039 SetContainingWindow(self, Window window)
12041 Set (or unset) the window this sizer is used in.
12043 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
12045 def GetContainingWindow(*args
, **kwargs
):
12047 GetContainingWindow(self) -> Window
12049 Get the window this sizer is used in.
12051 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
12053 def SetItemMinSize(self
, item
, *args
):
12055 SetItemMinSize(self, item, Size size)
12057 Sets the minimum size that will be allocated for an item in the sizer.
12058 The *item* parameter can be either a window, a sizer, or the
12059 zero-based index of the item. If a window or sizer is given then it
12060 will be searched for recursivly in subsizers if neccessary.
12063 # for backward compatibility accept separate width,height args too
12064 return self
._SetItemMinSize
(item
, args
)
12066 return self
._SetItemMinSize
(item
, args
[0])
12068 def AddItem(*args
, **kwargs
):
12070 AddItem(self, SizerItem item)
12072 Adds a `wx.SizerItem` to the sizer.
12074 return _core_
.Sizer_AddItem(*args
, **kwargs
)
12076 def InsertItem(*args
, **kwargs
):
12078 InsertItem(self, int index, SizerItem item)
12080 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12082 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
12084 def PrependItem(*args
, **kwargs
):
12086 PrependItem(self, SizerItem item)
12088 Prepends a `wx.SizerItem` to the sizer.
12090 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
12092 def AddMany(self
, items
):
12094 AddMany is a convenience method for adding several items
12095 to a sizer at one time. Simply pass it a list of tuples,
12096 where each tuple consists of the parameters that you
12097 would normally pass to the `Add` method.
12100 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
12104 def AddSpacer(self
, *args
, **kw
):
12105 """AddSpacer(int size) --> SizerItem
12107 Add a spacer that is (size,size) pixels.
12109 if args
and type(args
[0]) == int:
12110 return self
.Add( (args
[0],args
[0] ), 0)
12111 else: # otherwise stay compatible with old AddSpacer
12112 return self
.Add(*args
, **kw
)
12113 def PrependSpacer(self
, *args
, **kw
):
12114 """PrependSpacer(int size) --> SizerItem
12116 Prepend a spacer that is (size, size) pixels."""
12117 if args
and type(args
[0]) == int:
12118 return self
.Prepend( (args
[0],args
[0] ), 0)
12119 else: # otherwise stay compatible with old PrependSpacer
12120 return self
.Prepend(*args
, **kw
)
12121 def InsertSpacer(self
, index
, *args
, **kw
):
12122 """InsertSpacer(int index, int size) --> SizerItem
12124 Insert a spacer at position index that is (size, size) pixels."""
12125 if args
and type(args
[0]) == int:
12126 return self
.Insert( index
, (args
[0],args
[0] ), 0)
12127 else: # otherwise stay compatible with old InsertSpacer
12128 return self
.Insert(index
, *args
, **kw
)
12131 def AddStretchSpacer(self
, prop
=1):
12132 """AddStretchSpacer(int prop=1) --> SizerItem
12134 Add a stretchable spacer."""
12135 return self
.Add((0,0), prop
)
12136 def PrependStretchSpacer(self
, prop
=1):
12137 """PrependStretchSpacer(int prop=1) --> SizerItem
12139 Prepend a stretchable spacer."""
12140 return self
.Prepend((0,0), prop
)
12141 def InsertStretchSpacer(self
, index
, prop
=1):
12142 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12144 Insert a stretchable spacer."""
12145 return self
.Insert(index
, (0,0), prop
)
12148 # for backwards compatibility only, please do not use in new code
12149 def AddWindow(self
, *args
, **kw
):
12150 """Compatibility alias for `Add`."""
12151 return self
.Add(*args
, **kw
)
12152 def AddSizer(self
, *args
, **kw
):
12153 """Compatibility alias for `Add`."""
12154 return self
.Add(*args
, **kw
)
12156 def PrependWindow(self
, *args
, **kw
):
12157 """Compatibility alias for `Prepend`."""
12158 return self
.Prepend(*args
, **kw
)
12159 def PrependSizer(self
, *args
, **kw
):
12160 """Compatibility alias for `Prepend`."""
12161 return self
.Prepend(*args
, **kw
)
12163 def InsertWindow(self
, *args
, **kw
):
12164 """Compatibility alias for `Insert`."""
12165 return self
.Insert(*args
, **kw
)
12166 def InsertSizer(self
, *args
, **kw
):
12167 """Compatibility alias for `Insert`."""
12168 return self
.Insert(*args
, **kw
)
12170 def RemoveWindow(self
, *args
, **kw
):
12171 """Compatibility alias for `Remove`."""
12172 return self
.Remove(*args
, **kw
)
12173 def RemoveSizer(self
, *args
, **kw
):
12174 """Compatibility alias for `Remove`."""
12175 return self
.Remove(*args
, **kw
)
12176 def RemovePos(self
, *args
, **kw
):
12177 """Compatibility alias for `Remove`."""
12178 return self
.Remove(*args
, **kw
)
12181 def SetDimension(*args
, **kwargs
):
12183 SetDimension(self, int x, int y, int width, int height)
12185 Call this to force the sizer to take the given dimension and thus
12186 force the items owned by the sizer to resize themselves according to
12187 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12190 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
12192 def SetMinSize(*args
, **kwargs
):
12194 SetMinSize(self, Size size)
12196 Call this to give the sizer a minimal size. Normally, the sizer will
12197 calculate its minimal size based purely on how much space its children
12198 need. After calling this method `GetMinSize` will return either the
12199 minimal size as requested by its children or the minimal size set
12200 here, depending on which is bigger.
12202 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
12204 def GetSize(*args
, **kwargs
):
12206 GetSize(self) -> Size
12208 Returns the current size of the space managed by the sizer.
12210 return _core_
.Sizer_GetSize(*args
, **kwargs
)
12212 def GetPosition(*args
, **kwargs
):
12214 GetPosition(self) -> Point
12216 Returns the current position of the sizer's managed space.
12218 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
12220 def GetMinSize(*args
, **kwargs
):
12222 GetMinSize(self) -> Size
12224 Returns the minimal size of the sizer. This is either the combined
12225 minimal size of all the children and their borders or the minimal size
12226 set by SetMinSize, depending on which is bigger.
12228 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
12230 def GetSizeTuple(self
):
12231 return self
.GetSize().Get()
12232 def GetPositionTuple(self
):
12233 return self
.GetPosition().Get()
12234 def GetMinSizeTuple(self
):
12235 return self
.GetMinSize().Get()
12237 def RecalcSizes(*args
, **kwargs
):
12241 Using the sizes calculated by `CalcMin` reposition and resize all the
12242 items managed by this sizer. You should not need to call this directly as
12243 it is called by `Layout`.
12245 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
12247 def CalcMin(*args
, **kwargs
):
12249 CalcMin(self) -> Size
12251 This method is where the sizer will do the actual calculation of its
12252 children's minimal sizes. You should not need to call this directly as
12253 it is called by `Layout`.
12255 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
12257 def Layout(*args
, **kwargs
):
12261 This method will force the recalculation and layout of the items
12262 controlled by the sizer using the current space allocated to the
12263 sizer. Normally this is called automatically from the owning window's
12264 EVT_SIZE handler, but it is also useful to call it from user code when
12265 one of the items in a sizer change size, or items are added or
12268 return _core_
.Sizer_Layout(*args
, **kwargs
)
12270 def Fit(*args
, **kwargs
):
12272 Fit(self, Window window) -> Size
12274 Tell the sizer to resize the *window* to match the sizer's minimal
12275 size. This is commonly done in the constructor of the window itself in
12276 order to set its initial size to match the needs of the children as
12277 determined by the sizer. Returns the new size.
12279 For a top level window this is the total window size, not the client size.
12281 return _core_
.Sizer_Fit(*args
, **kwargs
)
12283 def FitInside(*args
, **kwargs
):
12285 FitInside(self, Window window)
12287 Tell the sizer to resize the *virtual size* of the *window* to match the
12288 sizer's minimal size. This will not alter the on screen size of the
12289 window, but may cause the addition/removal/alteration of scrollbars
12290 required to view the virtual area in windows which manage it.
12292 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12295 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12297 def SetSizeHints(*args
, **kwargs
):
12299 SetSizeHints(self, Window window)
12301 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12302 match the sizer's minimal size. This is commonly done in the
12303 constructor of the window itself if the window is resizable (as are
12304 many dialogs under Unix and frames on probably all platforms) in order
12305 to prevent the window from being sized smaller than the minimal size
12306 required by the sizer.
12308 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12310 def SetVirtualSizeHints(*args
, **kwargs
):
12312 SetVirtualSizeHints(self, Window window)
12314 Tell the sizer to set the minimal size of the window virtual area to
12315 match the sizer's minimal size. For windows with managed scrollbars
12316 this will set them appropriately.
12318 :see: `wx.ScrolledWindow.SetScrollbars`
12321 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12323 def Clear(*args
, **kwargs
):
12325 Clear(self, bool deleteWindows=False)
12327 Clear all items from the sizer, optionally destroying the window items
12330 return _core_
.Sizer_Clear(*args
, **kwargs
)
12332 def DeleteWindows(*args
, **kwargs
):
12334 DeleteWindows(self)
12336 Destroy all windows managed by the sizer.
12338 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12340 def GetChildren(*args
, **kwargs
):
12342 GetChildren(self) -> list
12344 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12346 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12348 def Show(*args
, **kwargs
):
12350 Show(self, item, bool show=True, bool recursive=false) -> bool
12352 Shows or hides an item managed by the sizer. To make a sizer item
12353 disappear or reappear, use Show followed by `Layout`. The *item*
12354 parameter can be either a window, a sizer, or the zero-based index of
12355 the item. Use the recursive parameter to show or hide an item in a
12356 subsizer. Returns True if the item was found.
12358 return _core_
.Sizer_Show(*args
, **kwargs
)
12360 def IsShown(*args
, **kwargs
):
12362 IsShown(self, item)
12364 Determines if the item is currently shown. To make a sizer
12365 item disappear or reappear, use Show followed by `Layout`. The *item*
12366 parameter can be either a window, a sizer, or the zero-based index of
12369 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12371 def Hide(self
, item
, recursive
=False):
12373 A convenience method for `Show` (item, False, recursive).
12375 return self
.Show(item
, False, recursive
)
12377 def ShowItems(*args
, **kwargs
):
12379 ShowItems(self, bool show)
12381 Recursively call `wx.SizerItem.Show` on all sizer items.
12383 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12385 Children
= property(GetChildren
,doc
="See `GetChildren`")
12386 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12387 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12388 Position
= property(GetPosition
,doc
="See `GetPosition`")
12389 Size
= property(GetSize
,doc
="See `GetSize`")
12390 _core_
.Sizer_swigregister(Sizer
)
12392 class PySizer(Sizer
):
12394 wx.PySizer is a special version of `wx.Sizer` that has been
12395 instrumented to allow the C++ virtual methods to be overloaded in
12396 Python derived classes. You would derive from this class if you are
12397 wanting to implement a custom sizer in Python code. Simply implement
12398 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12401 class MySizer(wx.PySizer):
12402 def __init__(self):
12403 wx.PySizer.__init__(self)
12406 for item in self.GetChildren():
12407 # calculate the total minimum width and height needed
12408 # by all items in the sizer according to this sizer's
12409 # layout algorithm.
12411 return wx.Size(width, height)
12413 def RecalcSizes(self):
12414 # find the space allotted to this sizer
12415 pos = self.GetPosition()
12416 size = self.GetSize()
12417 for item in self.GetChildren():
12418 # Recalculate (if necessary) the position and size of
12419 # each item and then call item.SetDimension to do the
12420 # actual positioning and sizing of the items within the
12421 # space alloted to this sizer.
12423 item.SetDimension(itemPos, itemSize)
12426 When `Layout` is called it first calls `CalcMin` followed by
12427 `RecalcSizes` so you can optimize a bit by saving the results of
12428 `CalcMin` and reusing them in `RecalcSizes`.
12430 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12434 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12435 __repr__
= _swig_repr
12436 def __init__(self
, *args
, **kwargs
):
12438 __init__(self) -> PySizer
12440 Creates a wx.PySizer. Must be called from the __init__ in the derived
12443 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12444 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12446 def _setCallbackInfo(*args
, **kwargs
):
12447 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12448 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12450 _core_
.PySizer_swigregister(PySizer
)
12452 #---------------------------------------------------------------------------
12454 class BoxSizer(Sizer
):
12456 The basic idea behind a box sizer is that windows will most often be
12457 laid out in rather simple basic geometry, typically in a row or a
12458 column or nested hierarchies of either. A wx.BoxSizer will lay out
12459 its items in a simple row or column, depending on the orientation
12460 parameter passed to the constructor.
12462 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12463 __repr__
= _swig_repr
12464 def __init__(self
, *args
, **kwargs
):
12466 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12468 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12469 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12472 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12473 self
._setOORInfo
(self
)
12475 def GetOrientation(*args
, **kwargs
):
12477 GetOrientation(self) -> int
12479 Returns the current orientation of the sizer.
12481 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12483 def SetOrientation(*args
, **kwargs
):
12485 SetOrientation(self, int orient)
12487 Resets the orientation of the sizer.
12489 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12491 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12492 _core_
.BoxSizer_swigregister(BoxSizer
)
12494 #---------------------------------------------------------------------------
12496 class StaticBoxSizer(BoxSizer
):
12498 wx.StaticBoxSizer derives from and functions identically to the
12499 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12500 manages. Note that this static box must be created separately and
12501 passed to the sizer constructor.
12503 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12504 __repr__
= _swig_repr
12505 def __init__(self
, *args
, **kwargs
):
12507 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12509 Constructor. It takes an associated static box and the orientation
12510 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12513 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12514 self
._setOORInfo
(self
)
12516 def GetStaticBox(*args
, **kwargs
):
12518 GetStaticBox(self) -> StaticBox
12520 Returns the static box associated with this sizer.
12522 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12524 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12525 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12527 #---------------------------------------------------------------------------
12529 class GridSizer(Sizer
):
12531 A grid sizer is a sizer which lays out its children in a
12532 two-dimensional table with all cells having the same size. In other
12533 words, the width of each cell within the grid is the width of the
12534 widest item added to the sizer and the height of each grid cell is the
12535 height of the tallest item. An optional vertical and/or horizontal
12536 gap between items can also be specified (in pixels.)
12538 Items are placed in the cells of the grid in the order they are added,
12539 in row-major order. In other words, the first row is filled first,
12540 then the second, and so on until all items have been added. (If
12541 neccessary, additional rows will be added as items are added.) If you
12542 need to have greater control over the cells that items are placed in
12543 then use the `wx.GridBagSizer`.
12546 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12547 __repr__
= _swig_repr
12548 def __init__(self
, *args
, **kwargs
):
12550 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12552 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12553 of columns and rows in the sizer - if either of the parameters is
12554 zero, it will be calculated to from the total number of children in
12555 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12556 define extra space between all children.
12558 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12559 self
._setOORInfo
(self
)
12561 def SetCols(*args
, **kwargs
):
12563 SetCols(self, int cols)
12565 Sets the number of columns in the sizer.
12567 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12569 def SetRows(*args
, **kwargs
):
12571 SetRows(self, int rows)
12573 Sets the number of rows in the sizer.
12575 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12577 def SetVGap(*args
, **kwargs
):
12579 SetVGap(self, int gap)
12581 Sets the vertical gap (in pixels) between the cells in the sizer.
12583 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12585 def SetHGap(*args
, **kwargs
):
12587 SetHGap(self, int gap)
12589 Sets the horizontal gap (in pixels) between cells in the sizer
12591 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12593 def GetCols(*args
, **kwargs
):
12595 GetCols(self) -> int
12597 Returns the number of columns in the sizer.
12599 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12601 def GetRows(*args
, **kwargs
):
12603 GetRows(self) -> int
12605 Returns the number of rows in the sizer.
12607 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12609 def GetVGap(*args
, **kwargs
):
12611 GetVGap(self) -> int
12613 Returns the vertical gap (in pixels) between the cells in the sizer.
12615 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12617 def GetHGap(*args
, **kwargs
):
12619 GetHGap(self) -> int
12621 Returns the horizontal gap (in pixels) between cells in the sizer.
12623 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12625 def CalcRowsCols(self
):
12627 CalcRowsCols() -> (rows, cols)
12629 Calculates how many rows and columns will be in the sizer based
12630 on the current number of items and also the rows, cols specified
12631 in the constructor.
12633 nitems
= len(self
.GetChildren())
12634 rows
= self
.GetRows()
12635 cols
= self
.GetCols()
12636 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12638 rows
= (nitems
+ cols
- 1) / cols
12640 cols
= (nitems
+ rows
- 1) / rows
12641 return (rows
, cols
)
12643 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12644 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12645 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12646 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12647 _core_
.GridSizer_swigregister(GridSizer
)
12649 #---------------------------------------------------------------------------
12651 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12652 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12653 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12654 class FlexGridSizer(GridSizer
):
12656 A flex grid sizer is a sizer which lays out its children in a
12657 two-dimensional table with all table cells in one row having the same
12658 height and all cells in one column having the same width, but all
12659 rows or all columns are not necessarily the same height or width as in
12660 the `wx.GridSizer`.
12662 wx.FlexGridSizer can also size items equally in one direction but
12663 unequally ("flexibly") in the other. If the sizer is only flexible
12664 in one direction (this can be changed using `SetFlexibleDirection`), it
12665 needs to be decided how the sizer should grow in the other ("non
12666 flexible") direction in order to fill the available space. The
12667 `SetNonFlexibleGrowMode` method serves this purpose.
12671 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12672 __repr__
= _swig_repr
12673 def __init__(self
, *args
, **kwargs
):
12675 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12677 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12678 number of columns and rows in the sizer - if either of the parameters
12679 is zero, it will be calculated to from the total number of children in
12680 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12681 define extra space between all children.
12683 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12684 self
._setOORInfo
(self
)
12686 def AddGrowableRow(*args
, **kwargs
):
12688 AddGrowableRow(self, size_t idx, int proportion=0)
12690 Specifies that row *idx* (starting from zero) should be grown if there
12691 is extra space available to the sizer.
12693 The *proportion* parameter has the same meaning as the stretch factor
12694 for the box sizers except that if all proportions are 0, then all
12695 columns are resized equally (instead of not being resized at all).
12697 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12699 def RemoveGrowableRow(*args
, **kwargs
):
12701 RemoveGrowableRow(self, size_t idx)
12703 Specifies that row *idx* is no longer growable.
12705 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12707 def AddGrowableCol(*args
, **kwargs
):
12709 AddGrowableCol(self, size_t idx, int proportion=0)
12711 Specifies that column *idx* (starting from zero) should be grown if
12712 there is extra space available to the sizer.
12714 The *proportion* parameter has the same meaning as the stretch factor
12715 for the box sizers except that if all proportions are 0, then all
12716 columns are resized equally (instead of not being resized at all).
12718 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12720 def RemoveGrowableCol(*args
, **kwargs
):
12722 RemoveGrowableCol(self, size_t idx)
12724 Specifies that column *idx* is no longer growable.
12726 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12728 def SetFlexibleDirection(*args
, **kwargs
):
12730 SetFlexibleDirection(self, int direction)
12732 Specifies whether the sizer should flexibly resize its columns, rows,
12733 or both. Argument *direction* can be one of the following values. Any
12734 other value is ignored.
12736 ============== =======================================
12737 wx.VERTICAL Rows are flexibly sized.
12738 wx.HORIZONTAL Columns are flexibly sized.
12739 wx.BOTH Both rows and columns are flexibly sized
12740 (this is the default value).
12741 ============== =======================================
12743 Note that this method does not trigger relayout.
12746 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12748 def GetFlexibleDirection(*args
, **kwargs
):
12750 GetFlexibleDirection(self) -> int
12752 Returns a value that specifies whether the sizer
12753 flexibly resizes its columns, rows, or both (default).
12755 :see: `SetFlexibleDirection`
12757 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12759 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12761 SetNonFlexibleGrowMode(self, int mode)
12763 Specifies how the sizer should grow in the non-flexible direction if
12764 there is one (so `SetFlexibleDirection` must have been called
12765 previously). Argument *mode* can be one of the following values:
12767 ========================== =================================================
12768 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12769 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12770 `AddGrowableCol` and `AddGrowableRow`. In this
12771 case equal sizing applies to minimum sizes of
12772 columns or rows (this is the default value).
12773 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12774 the non flexible direction, whether they are
12775 growable or not in the flexbile direction.
12776 ========================== =================================================
12778 Note that this method does not trigger relayout.
12780 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12782 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12784 GetNonFlexibleGrowMode(self) -> int
12786 Returns the value that specifies how the sizer grows in the
12787 non-flexible direction if there is one.
12789 :see: `SetNonFlexibleGrowMode`
12791 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12793 def GetRowHeights(*args
, **kwargs
):
12795 GetRowHeights(self) -> list
12797 Returns a list of integers representing the heights of each of the
12800 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12802 def GetColWidths(*args
, **kwargs
):
12804 GetColWidths(self) -> list
12806 Returns a list of integers representing the widths of each of the
12807 columns in the sizer.
12809 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12811 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12812 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12813 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12814 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12815 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12817 class StdDialogButtonSizer(BoxSizer
):
12819 A special sizer that knows how to order and position standard buttons
12820 in order to conform to the current platform's standards. You simply
12821 need to add each `wx.Button` to the sizer, and be sure to create the
12822 buttons using the standard ID's. Then call `Realize` and the sizer
12823 will take care of the rest.
12826 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12827 __repr__
= _swig_repr
12828 def __init__(self
, *args
, **kwargs
):
12829 """__init__(self) -> StdDialogButtonSizer"""
12830 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12831 def AddButton(*args
, **kwargs
):
12833 AddButton(self, wxButton button)
12835 Use this to add the buttons to this sizer. Do not use the `Add`
12836 method in the base class.
12838 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12840 def Realize(*args
, **kwargs
):
12844 This funciton needs to be called after all the buttons have been added
12845 to the sizer. It will reorder them and position them in a platform
12848 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12850 def SetAffirmativeButton(*args
, **kwargs
):
12851 """SetAffirmativeButton(self, wxButton button)"""
12852 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12854 def SetNegativeButton(*args
, **kwargs
):
12855 """SetNegativeButton(self, wxButton button)"""
12856 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12858 def SetCancelButton(*args
, **kwargs
):
12859 """SetCancelButton(self, wxButton button)"""
12860 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12862 def GetAffirmativeButton(*args
, **kwargs
):
12863 """GetAffirmativeButton(self) -> wxButton"""
12864 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12866 def GetApplyButton(*args
, **kwargs
):
12867 """GetApplyButton(self) -> wxButton"""
12868 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12870 def GetNegativeButton(*args
, **kwargs
):
12871 """GetNegativeButton(self) -> wxButton"""
12872 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12874 def GetCancelButton(*args
, **kwargs
):
12875 """GetCancelButton(self) -> wxButton"""
12876 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12878 def GetHelpButton(*args
, **kwargs
):
12879 """GetHelpButton(self) -> wxButton"""
12880 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12882 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12883 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12884 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12885 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12886 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12887 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12889 #---------------------------------------------------------------------------
12891 class GBPosition(object):
12893 This class represents the position of an item in a virtual grid of
12894 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12895 typemaps that will automatically convert from a 2-element sequence of
12896 integers to a wx.GBPosition, so you can use the more pythonic
12897 representation of the position nearly transparently in Python code.
12899 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12900 __repr__
= _swig_repr
12901 def __init__(self
, *args
, **kwargs
):
12903 __init__(self, int row=0, int col=0) -> GBPosition
12905 This class represents the position of an item in a virtual grid of
12906 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12907 typemaps that will automatically convert from a 2-element sequence of
12908 integers to a wx.GBPosition, so you can use the more pythonic
12909 representation of the position nearly transparently in Python code.
12911 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12912 __swig_destroy__
= _core_
.delete_GBPosition
12913 __del__
= lambda self
: None;
12914 def GetRow(*args
, **kwargs
):
12915 """GetRow(self) -> int"""
12916 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12918 def GetCol(*args
, **kwargs
):
12919 """GetCol(self) -> int"""
12920 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12922 def SetRow(*args
, **kwargs
):
12923 """SetRow(self, int row)"""
12924 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12926 def SetCol(*args
, **kwargs
):
12927 """SetCol(self, int col)"""
12928 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12930 def __eq__(*args
, **kwargs
):
12932 __eq__(self, PyObject other) -> bool
12934 Compare GBPosition for equality.
12936 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12938 def __ne__(*args
, **kwargs
):
12940 __ne__(self, PyObject other) -> bool
12942 Compare GBPosition for inequality.
12944 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12946 def Set(*args
, **kwargs
):
12947 """Set(self, int row=0, int col=0)"""
12948 return _core_
.GBPosition_Set(*args
, **kwargs
)
12950 def Get(*args
, **kwargs
):
12951 """Get(self) -> PyObject"""
12952 return _core_
.GBPosition_Get(*args
, **kwargs
)
12954 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12955 def __str__(self
): return str(self
.Get())
12956 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12957 def __len__(self
): return len(self
.Get())
12958 def __getitem__(self
, index
): return self
.Get()[index
]
12959 def __setitem__(self
, index
, val
):
12960 if index
== 0: self
.SetRow(val
)
12961 elif index
== 1: self
.SetCol(val
)
12962 else: raise IndexError
12963 def __nonzero__(self
): return self
.Get() != (0,0)
12964 __safe_for_unpickling__
= True
12965 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12967 row
= property(GetRow
, SetRow
)
12968 col
= property(GetCol
, SetCol
)
12970 _core_
.GBPosition_swigregister(GBPosition
)
12972 class GBSpan(object):
12974 This class is used to hold the row and column spanning attributes of
12975 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12976 automatically convert from a 2-element sequence of integers to a
12977 wx.GBSpan, so you can use the more pythonic representation of the span
12978 nearly transparently in Python code.
12981 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12982 __repr__
= _swig_repr
12983 def __init__(self
, *args
, **kwargs
):
12985 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12987 Construct a new wxGBSpan, optionally setting the rowspan and
12988 colspan. The default is (1,1). (Meaning that the item occupies one
12989 cell in each direction.
12991 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12992 __swig_destroy__
= _core_
.delete_GBSpan
12993 __del__
= lambda self
: None;
12994 def GetRowspan(*args
, **kwargs
):
12995 """GetRowspan(self) -> int"""
12996 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12998 def GetColspan(*args
, **kwargs
):
12999 """GetColspan(self) -> int"""
13000 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
13002 def SetRowspan(*args
, **kwargs
):
13003 """SetRowspan(self, int rowspan)"""
13004 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
13006 def SetColspan(*args
, **kwargs
):
13007 """SetColspan(self, int colspan)"""
13008 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
13010 def __eq__(*args
, **kwargs
):
13012 __eq__(self, PyObject other) -> bool
13014 Compare wxGBSpan for equality.
13016 return _core_
.GBSpan___eq__(*args
, **kwargs
)
13018 def __ne__(*args
, **kwargs
):
13020 __ne__(self, PyObject other) -> bool
13022 Compare GBSpan for inequality.
13024 return _core_
.GBSpan___ne__(*args
, **kwargs
)
13026 def Set(*args
, **kwargs
):
13027 """Set(self, int rowspan=1, int colspan=1)"""
13028 return _core_
.GBSpan_Set(*args
, **kwargs
)
13030 def Get(*args
, **kwargs
):
13031 """Get(self) -> PyObject"""
13032 return _core_
.GBSpan_Get(*args
, **kwargs
)
13034 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13035 def __str__(self
): return str(self
.Get())
13036 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
13037 def __len__(self
): return len(self
.Get())
13038 def __getitem__(self
, index
): return self
.Get()[index
]
13039 def __setitem__(self
, index
, val
):
13040 if index
== 0: self
.SetRowspan(val
)
13041 elif index
== 1: self
.SetColspan(val
)
13042 else: raise IndexError
13043 def __nonzero__(self
): return self
.Get() != (0,0)
13044 __safe_for_unpickling__
= True
13045 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
13047 rowspan
= property(GetRowspan
, SetRowspan
)
13048 colspan
= property(GetColspan
, SetColspan
)
13050 _core_
.GBSpan_swigregister(GBSpan
)
13052 class GBSizerItem(SizerItem
):
13054 The wx.GBSizerItem class is used to track the additional data about
13055 items in a `wx.GridBagSizer` such as the item's position in the grid
13056 and how many rows or columns it spans.
13059 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13060 __repr__
= _swig_repr
13061 def __init__(self
, *args
, **kwargs
):
13063 __init__(self) -> GBSizerItem
13065 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13066 size will need to be set, as well as a position and span before this
13067 item can be used in a Sizer.
13069 You will probably never need to create a wx.GBSizerItem directly as they
13070 are created automatically when the sizer's Add method is called.
13072 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
13073 __swig_destroy__
= _core_
.delete_GBSizerItem
13074 __del__
= lambda self
: None;
13075 def GetPos(*args
, **kwargs
):
13077 GetPos(self) -> GBPosition
13079 Get the grid position of the item
13081 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
13083 def GetPosTuple(self
): return self
.GetPos().Get()
13084 def GetSpan(*args
, **kwargs
):
13086 GetSpan(self) -> GBSpan
13088 Get the row and column spanning of the item
13090 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
13092 def GetSpanTuple(self
): return self
.GetSpan().Get()
13093 def SetPos(*args
, **kwargs
):
13095 SetPos(self, GBPosition pos) -> bool
13097 If the item is already a member of a sizer then first ensure that
13098 there is no other item that would intersect with this one at the new
13099 position, then set the new position. Returns True if the change is
13100 successful and after the next Layout() the item will be moved.
13102 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
13104 def SetSpan(*args
, **kwargs
):
13106 SetSpan(self, GBSpan span) -> bool
13108 If the item is already a member of a sizer then first ensure that
13109 there is no other item that would intersect with this one with its new
13110 spanning size, then set the new spanning. Returns True if the change
13111 is successful and after the next Layout() the item will be resized.
13114 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
13116 def Intersects(*args
, **kwargs
):
13118 Intersects(self, GBSizerItem other) -> bool
13120 Returns True if this item and the other item instersect.
13122 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
13124 def IntersectsPos(*args
, **kwargs
):
13126 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13128 Returns True if the given pos/span would intersect with this item.
13130 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
13132 def GetEndPos(*args
, **kwargs
):
13134 GetEndPos(self) -> GBPosition
13136 Get the row and column of the endpoint of this item.
13138 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
13140 def GetGBSizer(*args
, **kwargs
):
13142 GetGBSizer(self) -> GridBagSizer
13144 Get the sizer this item is a member of.
13146 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
13148 def SetGBSizer(*args
, **kwargs
):
13150 SetGBSizer(self, GridBagSizer sizer)
13152 Set the sizer this item is a member of.
13154 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
13156 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
13157 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
13158 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
13159 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
13160 _core_
.GBSizerItem_swigregister(GBSizerItem
)
13161 DefaultSpan
= cvar
.DefaultSpan
13163 def GBSizerItemWindow(*args
, **kwargs
):
13165 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13166 int border, PyObject userData=None) -> GBSizerItem
13168 Construct a `wx.GBSizerItem` for a window.
13170 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
13173 def GBSizerItemSizer(*args
, **kwargs
):
13175 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13176 int border, PyObject userData=None) -> GBSizerItem
13178 Construct a `wx.GBSizerItem` for a sizer
13180 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
13183 def GBSizerItemSpacer(*args
, **kwargs
):
13185 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13186 int flag, int border, PyObject userData=None) -> GBSizerItem
13188 Construct a `wx.GBSizerItem` for a spacer.
13190 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
13193 class GridBagSizer(FlexGridSizer
):
13195 A `wx.Sizer` that can lay out items in a virtual grid like a
13196 `wx.FlexGridSizer` but in this case explicit positioning of the items
13197 is allowed using `wx.GBPosition`, and items can optionally span more
13198 than one row and/or column using `wx.GBSpan`. The total size of the
13199 virtual grid is determined by the largest row and column that items are
13200 positioned at, adjusted for spanning.
13203 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13204 __repr__
= _swig_repr
13205 def __init__(self
, *args
, **kwargs
):
13207 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13209 Constructor, with optional parameters to specify the gap between the
13212 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
13213 self
._setOORInfo
(self
)
13215 def Add(*args
, **kwargs
):
13217 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13218 int border=0, userData=None) -> wx.GBSizerItem
13220 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13221 more than one row or column as specified with *span*. The remaining
13222 args behave similarly to `wx.Sizer.Add`.
13224 Returns True if the item was successfully placed at the given cell
13225 position, False if something was already there.
13228 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13230 def AddItem(*args
, **kwargs
):
13232 Add(self, GBSizerItem item) -> wx.GBSizerItem
13234 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13235 the item was successfully placed at its given cell position, False if
13236 something was already there.
13238 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13240 def GetCellSize(*args
, **kwargs
):
13242 GetCellSize(self, int row, int col) -> Size
13244 Get the size of the specified cell, including hgap and
13245 vgap. Only valid after a Layout.
13247 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13249 def GetEmptyCellSize(*args
, **kwargs
):
13251 GetEmptyCellSize(self) -> Size
13253 Get the size used for cells in the grid with no item.
13255 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13257 def SetEmptyCellSize(*args
, **kwargs
):
13259 SetEmptyCellSize(self, Size sz)
13261 Set the size used for cells in the grid with no item.
13263 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13265 def GetItemPosition(*args
):
13267 GetItemPosition(self, item) -> GBPosition
13269 Get the grid position of the specified *item* where *item* is either a
13270 window or subsizer that is a member of this sizer, or a zero-based
13273 return _core_
.GridBagSizer_GetItemPosition(*args
)
13275 def SetItemPosition(*args
):
13277 SetItemPosition(self, item, GBPosition pos) -> bool
13279 Set the grid position of the specified *item* where *item* is either a
13280 window or subsizer that is a member of this sizer, or a zero-based
13281 index of an item. Returns True on success. If the move is not
13282 allowed (because an item is already there) then False is returned.
13285 return _core_
.GridBagSizer_SetItemPosition(*args
)
13287 def GetItemSpan(*args
):
13289 GetItemSpan(self, item) -> GBSpan
13291 Get the row/col spanning of the specified *item* where *item* is
13292 either a window or subsizer that is a member of this sizer, or a
13293 zero-based index of an item.
13295 return _core_
.GridBagSizer_GetItemSpan(*args
)
13297 def SetItemSpan(*args
):
13299 SetItemSpan(self, item, GBSpan span) -> bool
13301 Set the row/col spanning of the specified *item* where *item* is
13302 either a window or subsizer that is a member of this sizer, or a
13303 zero-based index of an item. Returns True on success. If the move is
13304 not allowed (because an item is already there) then False is returned.
13306 return _core_
.GridBagSizer_SetItemSpan(*args
)
13308 def FindItem(*args
):
13310 FindItem(self, item) -> GBSizerItem
13312 Find the sizer item for the given window or subsizer, returns None if
13313 not found. (non-recursive)
13315 return _core_
.GridBagSizer_FindItem(*args
)
13317 def FindItemAtPosition(*args
, **kwargs
):
13319 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13321 Return the sizer item for the given grid cell, or None if there is no
13322 item at that position. (non-recursive)
13324 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13326 def FindItemAtPoint(*args
, **kwargs
):
13328 FindItemAtPoint(self, Point pt) -> GBSizerItem
13330 Return the sizer item located at the point given in *pt*, or None if
13331 there is no item at that point. The (x,y) coordinates in pt correspond
13332 to the client coordinates of the window using the sizer for
13333 layout. (non-recursive)
13335 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13337 def CheckForIntersection(*args
, **kwargs
):
13339 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13341 Look at all items and see if any intersect (or would overlap) the
13342 given *item*. Returns True if so, False if there would be no overlap.
13343 If an *excludeItem* is given then it will not be checked for
13344 intersection, for example it may be the item we are checking the
13348 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13350 def CheckForIntersectionPos(*args
, **kwargs
):
13352 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13354 Look at all items and see if any intersect (or would overlap) the
13355 given position and span. Returns True if so, False if there would be
13356 no overlap. If an *excludeItem* is given then it will not be checked
13357 for intersection, for example it may be the item we are checking the
13360 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13362 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13364 #---------------------------------------------------------------------------
13368 Right
= _core_
.Right
13369 Bottom
= _core_
.Bottom
13370 Width
= _core_
.Width
13371 Height
= _core_
.Height
13372 Centre
= _core_
.Centre
13373 Center
= _core_
.Center
13374 CentreX
= _core_
.CentreX
13375 CentreY
= _core_
.CentreY
13376 Unconstrained
= _core_
.Unconstrained
13378 PercentOf
= _core_
.PercentOf
13379 Above
= _core_
.Above
13380 Below
= _core_
.Below
13381 LeftOf
= _core_
.LeftOf
13382 RightOf
= _core_
.RightOf
13383 SameAs
= _core_
.SameAs
13384 Absolute
= _core_
.Absolute
13385 class IndividualLayoutConstraint(Object
):
13387 Objects of this class are stored in the `wx.LayoutConstraints` class as
13388 one of eight possible constraints that a window can be involved in.
13389 You will never need to create an instance of
13390 wx.IndividualLayoutConstraint, rather you should create a
13391 `wx.LayoutConstraints` instance and use the individual contstraints
13394 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13395 def __init__(self
): raise AttributeError, "No constructor defined"
13396 __repr__
= _swig_repr
13397 def Set(*args
, **kwargs
):
13399 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13401 Sets the properties of the constraint. Normally called by one of the
13402 convenience functions such as Above, RightOf, SameAs.
13404 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13406 def LeftOf(*args
, **kwargs
):
13408 LeftOf(self, Window sibling, int marg=0)
13410 Constrains this edge to be to the left of the given window, with an
13411 optional margin. Implicitly, this is relative to the left edge of the
13414 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13416 def RightOf(*args
, **kwargs
):
13418 RightOf(self, Window sibling, int marg=0)
13420 Constrains this edge to be to the right of the given window, with an
13421 optional margin. Implicitly, this is relative to the right edge of the
13424 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13426 def Above(*args
, **kwargs
):
13428 Above(self, Window sibling, int marg=0)
13430 Constrains this edge to be above the given window, with an optional
13431 margin. Implicitly, this is relative to the top edge of the other
13434 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13436 def Below(*args
, **kwargs
):
13438 Below(self, Window sibling, int marg=0)
13440 Constrains this edge to be below the given window, with an optional
13441 margin. Implicitly, this is relative to the bottom edge of the other
13444 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13446 def SameAs(*args
, **kwargs
):
13448 SameAs(self, Window otherW, int edge, int marg=0)
13450 Constrains this edge or dimension to be to the same as the edge of the
13451 given window, with an optional margin.
13453 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13455 def PercentOf(*args
, **kwargs
):
13457 PercentOf(self, Window otherW, int wh, int per)
13459 Constrains this edge or dimension to be to a percentage of the given
13460 window, with an optional margin.
13462 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13464 def Absolute(*args
, **kwargs
):
13466 Absolute(self, int val)
13468 Constrains this edge or dimension to be the given absolute value.
13470 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13472 def Unconstrained(*args
, **kwargs
):
13474 Unconstrained(self)
13476 Sets this edge or dimension to be unconstrained, that is, dependent on
13477 other edges and dimensions from which this value can be deduced.
13479 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13481 def AsIs(*args
, **kwargs
):
13485 Sets this edge or constraint to be whatever the window's value is at
13486 the moment. If either of the width and height constraints are *as is*,
13487 the window will not be resized, but moved instead. This is important
13488 when considering panel items which are intended to have a default
13489 size, such as a button, which may take its size from the size of the
13492 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13494 def GetOtherWindow(*args
, **kwargs
):
13495 """GetOtherWindow(self) -> Window"""
13496 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13498 def GetMyEdge(*args
, **kwargs
):
13499 """GetMyEdge(self) -> int"""
13500 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13502 def SetEdge(*args
, **kwargs
):
13503 """SetEdge(self, int which)"""
13504 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13506 def SetValue(*args
, **kwargs
):
13507 """SetValue(self, int v)"""
13508 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13510 def GetMargin(*args
, **kwargs
):
13511 """GetMargin(self) -> int"""
13512 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13514 def SetMargin(*args
, **kwargs
):
13515 """SetMargin(self, int m)"""
13516 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13518 def GetValue(*args
, **kwargs
):
13519 """GetValue(self) -> int"""
13520 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13522 def GetPercent(*args
, **kwargs
):
13523 """GetPercent(self) -> int"""
13524 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13526 def GetOtherEdge(*args
, **kwargs
):
13527 """GetOtherEdge(self) -> int"""
13528 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13530 def GetDone(*args
, **kwargs
):
13531 """GetDone(self) -> bool"""
13532 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13534 def SetDone(*args
, **kwargs
):
13535 """SetDone(self, bool d)"""
13536 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13538 def GetRelationship(*args
, **kwargs
):
13539 """GetRelationship(self) -> int"""
13540 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13542 def SetRelationship(*args
, **kwargs
):
13543 """SetRelationship(self, int r)"""
13544 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13546 def ResetIfWin(*args
, **kwargs
):
13548 ResetIfWin(self, Window otherW) -> bool
13550 Reset constraint if it mentions otherWin
13552 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13554 def SatisfyConstraint(*args
, **kwargs
):
13556 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13558 Try to satisfy constraint
13560 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13562 def GetEdge(*args
, **kwargs
):
13564 GetEdge(self, int which, Window thisWin, Window other) -> int
13566 Get the value of this edge or dimension, or if this
13567 is not determinable, -1.
13569 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13571 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13572 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13573 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13574 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13575 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13576 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13577 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13578 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13579 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13581 class LayoutConstraints(Object
):
13583 **Note:** constraints are now deprecated and you should use sizers
13586 Objects of this class can be associated with a window to define its
13587 layout constraints, with respect to siblings or its parent.
13589 The class consists of the following eight constraints of class
13590 wx.IndividualLayoutConstraint, some or all of which should be accessed
13591 directly to set the appropriate constraints.
13593 * left: represents the left hand edge of the window
13594 * right: represents the right hand edge of the window
13595 * top: represents the top edge of the window
13596 * bottom: represents the bottom edge of the window
13597 * width: represents the width of the window
13598 * height: represents the height of the window
13599 * centreX: represents the horizontal centre point of the window
13600 * centreY: represents the vertical centre point of the window
13602 Most constraints are initially set to have the relationship
13603 wxUnconstrained, which means that their values should be calculated by
13604 looking at known constraints. The exceptions are width and height,
13605 which are set to wxAsIs to ensure that if the user does not specify a
13606 constraint, the existing width and height will be used, to be
13607 compatible with panel items which often have take a default size. If
13608 the constraint is ``wx.AsIs``, the dimension will not be changed.
13610 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13613 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13614 __repr__
= _swig_repr
13615 left
= property(_core_
.LayoutConstraints_left_get
)
13616 top
= property(_core_
.LayoutConstraints_top_get
)
13617 right
= property(_core_
.LayoutConstraints_right_get
)
13618 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13619 width
= property(_core_
.LayoutConstraints_width_get
)
13620 height
= property(_core_
.LayoutConstraints_height_get
)
13621 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13622 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13623 def __init__(self
, *args
, **kwargs
):
13624 """__init__(self) -> LayoutConstraints"""
13625 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13626 __swig_destroy__
= _core_
.delete_LayoutConstraints
13627 __del__
= lambda self
: None;
13628 def SatisfyConstraints(*args
, **kwargs
):
13629 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13630 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13632 def AreSatisfied(*args
, **kwargs
):
13633 """AreSatisfied(self) -> bool"""
13634 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13636 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13638 #----------------------------------------------------------------------------
13640 # Use Python's bool constants if available, make some if not
13644 __builtins__
.True = 1==1
13645 __builtins__
.False = 1==0
13646 def bool(value
): return not not value
13647 __builtins__
.bool = bool
13651 # workarounds for bad wxRTTI names
13652 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13653 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13654 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13657 #----------------------------------------------------------------------------
13658 # Load version numbers from __version__... Ensure that major and minor
13659 # versions are the same for both wxPython and wxWidgets.
13661 from __version__
import *
13662 __version__
= VERSION_STRING
13664 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13665 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13666 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13668 warnings
.warn("wxPython/wxWidgets release number mismatch")
13670 #----------------------------------------------------------------------------
13672 # Set wxPython's default string<-->unicode conversion encoding from
13673 # the locale, but only if Python's default hasn't been changed. (We
13674 # assume that if the user has customized it already then that is the
13675 # encoding we need to use as well.)
13677 # The encoding selected here is used when string or unicode objects
13678 # need to be converted in order to pass them to wxWidgets. Please be
13679 # aware that the default encoding within the same locale may be
13680 # slightly different on different platforms. For example, please see
13681 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13682 # between the common latin/roman encodings.
13684 default
= _sys
.getdefaultencoding()
13685 if default
== 'ascii':
13689 default
= locale
.getdefaultlocale()[1]
13690 codecs
.lookup(default
)
13691 except (ValueError, LookupError, TypeError):
13692 default
= _sys
.getdefaultencoding()
13696 wx
.SetDefaultPyEncoding(default
)
13699 #----------------------------------------------------------------------------
13701 class PyDeadObjectError(AttributeError):
13704 class _wxPyDeadObject(object):
13706 Instances of wx objects that are OOR capable will have their __class__
13707 changed to this class when the C++ object is deleted. This should help
13708 prevent crashes due to referencing a bogus C++ pointer.
13710 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13711 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13713 def __repr__(self
):
13714 if not hasattr(self
, "_name"):
13715 self
._name
= "[unknown]"
13716 return self
.reprStr
% self
._name
13718 def __getattr__(self
, *args
):
13719 if not hasattr(self
, "_name"):
13720 self
._name
= "[unknown]"
13721 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13723 def __nonzero__(self
):
13728 class PyUnbornObjectError(AttributeError):
13731 class _wxPyUnbornObject(object):
13733 Some stock objects are created when the wx._core module is
13734 imported, but their C++ instance is not created until the wx.App
13735 object is created and initialized. These object instances will
13736 temporarily have their __class__ changed to this class so an
13737 exception will be raised if they are used before the C++ instance
13741 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13742 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13744 def __repr__(self
):
13745 #if not hasattr(self, "_name"):
13746 # self._name = "[unknown]"
13747 return self
.reprStr
#% self._name
13749 def __getattr__(self
, *args
):
13750 #if not hasattr(self, "_name"):
13751 # self._name = "[unknown]"
13752 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13754 def __nonzero__(self
):
13758 #----------------------------------------------------------------------------
13760 def CallAfter(callable, *args
, **kw
):
13762 Call the specified function after the current and pending event
13763 handlers have been completed. This is also good for making GUI
13764 method calls from non-GUI threads. Any extra positional or
13765 keyword args are passed on to the callable when it is called.
13767 :see: `wx.CallLater`
13770 assert app
is not None, 'No wx.App created yet'
13772 if not hasattr(app
, "_CallAfterId"):
13773 app
._CallAfterId
= wx
.NewEventType()
13774 app
.Connect(-1, -1, app
._CallAfterId
,
13775 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13777 evt
.SetEventType(app
._CallAfterId
)
13778 evt
.callable = callable
13781 wx
.PostEvent(app
, evt
)
13783 #----------------------------------------------------------------------------
13788 A convenience class for `wx.Timer`, that calls the given callable
13789 object once after the given amount of milliseconds, passing any
13790 positional or keyword args. The return value of the callable is
13791 availbale after it has been run with the `GetResult` method.
13793 If you don't need to get the return value or restart the timer
13794 then there is no need to hold a reference to this object. It will
13795 hold a reference to itself while the timer is running (the timer
13796 has a reference to self.Notify) but the cycle will be broken when
13797 the timer completes, automatically cleaning up the wx.CallLater
13800 :see: `wx.CallAfter`
13802 def __init__(self
, millis
, callable, *args
, **kwargs
):
13803 self
.millis
= millis
13804 self
.callable = callable
13805 self
.SetArgs(*args
, **kwargs
)
13807 self
.running
= False
13808 self
.hasRun
= False
13817 def Start(self
, millis
=None, *args
, **kwargs
):
13819 (Re)start the timer
13821 self
.hasRun
= False
13822 if millis
is not None:
13823 self
.millis
= millis
13825 self
.SetArgs(*args
, **kwargs
)
13827 self
.timer
= wx
.PyTimer(self
.Notify
)
13828 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13829 self
.running
= True
13835 Stop and destroy the timer.
13837 if self
.timer
is not None:
13842 def GetInterval(self
):
13843 if self
.timer
is not None:
13844 return self
.timer
.GetInterval()
13849 def IsRunning(self
):
13850 return self
.timer
is not None and self
.timer
.IsRunning()
13853 def SetArgs(self
, *args
, **kwargs
):
13855 (Re)set the args passed to the callable object. This is
13856 useful in conjunction with Restart if you want to schedule a
13857 new call to the same callable object but with different
13861 self
.kwargs
= kwargs
13867 def GetResult(self
):
13872 The timer has expired so call the callable.
13874 if self
.callable and getattr(self
.callable, 'im_self', True):
13876 self
.running
= False
13877 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13879 if not self
.running
:
13880 # if it wasn't restarted, then cleanup
13881 wx
.CallAfter(self
.Stop
)
13883 Interval
= property(GetInterval
)
13884 Result
= property(GetResult
)
13887 class FutureCall(CallLater
):
13888 """A compatibility alias for `CallLater`."""
13890 #----------------------------------------------------------------------------
13891 # Control which items in this module should be documented by epydoc.
13892 # We allow only classes and functions, which will help reduce the size
13893 # of the docs by filtering out the zillions of constants, EVT objects,
13894 # and etc that don't make much sense by themselves, but are instead
13895 # documented (or will be) as part of the classes/functions/methods
13896 # where they should be used.
13900 A filter for epydoc that only allows non-Ptr classes and
13901 functions, in order to reduce the clutter in the API docs.
13903 def __init__(self
, globals):
13904 self
._globals
= globals
13906 def __call__(self
, name
):
13908 obj
= self
._globals
.get(name
, None)
13910 # only document classes and function
13911 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13914 # skip other things that are private or will be documented as part of somethign else
13915 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13918 # skip functions that are duplicates of static functions in a class
13919 if name
.find('_') != -1:
13920 cls
= self
._globals
.get(name
.split('_')[0], None)
13921 methname
= name
.split('_')[1]
13922 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13927 #----------------------------------------------------------------------------
13928 #----------------------------------------------------------------------------
13930 # Import other modules in this package that should show up in the
13931 # "core" wx namespace
13933 from _windows
import *
13934 from _controls
import *
13935 from _misc
import *
13937 #----------------------------------------------------------------------------
13938 #----------------------------------------------------------------------------