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 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3672 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3673 class Quantize(object):
3674 """Performs quantization, or colour reduction, on a wxImage."""
3675 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3676 def __init__(self
): raise AttributeError, "No constructor defined"
3677 __repr__
= _swig_repr
3678 def Quantize(*args
, **kwargs
):
3680 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3682 Reduce the colours in the source image and put the result into the
3683 destination image, setting the palette in the destination if
3684 needed. Both images may be the same, to overwrite the source image.
3686 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3688 Quantize
= staticmethod(Quantize
)
3689 _core_
.Quantize_swigregister(Quantize
)
3691 def Quantize_Quantize(*args
, **kwargs
):
3693 Quantize_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 #---------------------------------------------------------------------------
3703 class EvtHandler(Object
):
3704 """Proxy of C++ EvtHandler class"""
3705 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3706 __repr__
= _swig_repr
3707 def __init__(self
, *args
, **kwargs
):
3708 """__init__(self) -> EvtHandler"""
3709 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3710 self
._setOORInfo
(self
)
3712 def GetNextHandler(*args
, **kwargs
):
3713 """GetNextHandler(self) -> EvtHandler"""
3714 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3716 def GetPreviousHandler(*args
, **kwargs
):
3717 """GetPreviousHandler(self) -> EvtHandler"""
3718 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3720 def SetNextHandler(*args
, **kwargs
):
3721 """SetNextHandler(self, EvtHandler handler)"""
3722 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3724 def SetPreviousHandler(*args
, **kwargs
):
3725 """SetPreviousHandler(self, EvtHandler handler)"""
3726 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3728 def GetEvtHandlerEnabled(*args
, **kwargs
):
3729 """GetEvtHandlerEnabled(self) -> bool"""
3730 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3732 def SetEvtHandlerEnabled(*args
, **kwargs
):
3733 """SetEvtHandlerEnabled(self, bool enabled)"""
3734 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3736 def ProcessEvent(*args
, **kwargs
):
3737 """ProcessEvent(self, Event event) -> bool"""
3738 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3740 def AddPendingEvent(*args
, **kwargs
):
3741 """AddPendingEvent(self, Event event)"""
3742 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3744 def ProcessPendingEvents(*args
, **kwargs
):
3745 """ProcessPendingEvents(self)"""
3746 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3748 def AllowReentrance(*args
, **kwargs
):
3749 """AllowReentrance(self, bool allow=True)"""
3750 return _core_
.EvtHandler_AllowReentrance(*args
, **kwargs
)
3752 def IsReentranceAllowed(*args
, **kwargs
):
3753 """IsReentranceAllowed(self) -> bool"""
3754 return _core_
.EvtHandler_IsReentranceAllowed(*args
, **kwargs
)
3756 def IsEventHandlingInProgress(*args
, **kwargs
):
3757 """IsEventHandlingInProgress(self) -> bool"""
3758 return _core_
.EvtHandler_IsEventHandlingInProgress(*args
, **kwargs
)
3760 def Connect(*args
, **kwargs
):
3761 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3762 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3764 def Disconnect(*args
, **kwargs
):
3765 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3766 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3768 def _setOORInfo(*args
, **kwargs
):
3769 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3770 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3774 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3776 Bind an event to an event handler.
3778 :param event: One of the EVT_* objects that specifies the
3779 type of event to bind,
3781 :param handler: A callable object to be invoked when the
3782 event is delivered to self. Pass None to
3783 disconnect an event handler.
3785 :param source: Sometimes the event originates from a
3786 different window than self, but you still
3787 want to catch it in self. (For example, a
3788 button event delivered to a frame.) By
3789 passing the source of the event, the event
3790 handling system is able to differentiate
3791 between the same event type from different
3794 :param id: Used to spcify the event source by ID instead
3797 :param id2: Used when it is desirable to bind a handler
3798 to a range of IDs, such as with EVT_MENU_RANGE.
3800 if source
is not None:
3802 event
.Bind(self
, id, id2
, handler
)
3804 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3806 Disconencts the event handler binding for event from self.
3807 Returns True if successful.
3809 if source
is not None:
3811 return event
.Unbind(self
, id, id2
)
3813 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3814 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3815 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3816 _core_
.EvtHandler_swigregister(EvtHandler
)
3818 #---------------------------------------------------------------------------
3820 class PyEventBinder(object):
3822 Instances of this class are used to bind specific events to event
3825 def __init__(self
, evtType
, expectedIDs
=0):
3826 if expectedIDs
not in [0, 1, 2]:
3827 raise ValueError, "Invalid number of expectedIDs"
3828 self
.expectedIDs
= expectedIDs
3830 if type(evtType
) == list or type(evtType
) == tuple:
3831 self
.evtType
= evtType
3833 self
.evtType
= [evtType
]
3836 def Bind(self
, target
, id1
, id2
, function
):
3837 """Bind this set of event types to target."""
3838 for et
in self
.evtType
:
3839 target
.Connect(id1
, id2
, et
, function
)
3842 def Unbind(self
, target
, id1
, id2
):
3843 """Remove an event binding."""
3845 for et
in self
.evtType
:
3846 success
+= target
.Disconnect(id1
, id2
, et
)
3850 def __call__(self
, *args
):
3852 For backwards compatibility with the old EVT_* functions.
3853 Should be called with either (window, func), (window, ID,
3854 func) or (window, ID1, ID2, func) parameters depending on the
3857 assert len(args
) == 2 + self
.expectedIDs
3861 if self
.expectedIDs
== 0:
3863 elif self
.expectedIDs
== 1:
3866 elif self
.expectedIDs
== 2:
3871 raise ValueError, "Unexpected number of IDs"
3873 self
.Bind(target
, id1
, id2
, func
)
3876 # These two are square pegs that don't fit the PyEventBinder hole...
3877 def EVT_COMMAND(win
, id, cmd
, func
):
3878 win
.Connect(id, -1, cmd
, func
)
3879 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3880 win
.Connect(id1
, id2
, cmd
, func
)
3883 #---------------------------------------------------------------------------
3885 #---------------------------------------------------------------------------
3887 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3888 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3890 def NewEventType(*args
):
3891 """NewEventType() -> EventType"""
3892 return _core_
.NewEventType(*args
)
3893 wxEVT_NULL
= _core_
.wxEVT_NULL
3894 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3895 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3896 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3897 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3898 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3899 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3900 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3901 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3902 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3903 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3904 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3905 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3906 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3907 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3908 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3909 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3910 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3911 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3912 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3913 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3914 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3915 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3916 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3917 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3918 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3919 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3920 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3921 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3922 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3923 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3924 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3925 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3926 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3927 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3928 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3929 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3930 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3931 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3932 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3933 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3934 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3935 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3936 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3937 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3938 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3939 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3940 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3941 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3942 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3943 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3944 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3945 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3946 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3947 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3948 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3949 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3950 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3951 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3952 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3953 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3954 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3955 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3956 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3957 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3958 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3959 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3960 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3961 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3962 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3963 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3964 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3965 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3966 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3967 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3968 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3969 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3970 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3971 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3972 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3973 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3974 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3975 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3976 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3977 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3978 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3979 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3980 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3981 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3982 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3983 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3984 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3985 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3986 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3987 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3988 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3989 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3990 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3991 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3992 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3993 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3994 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3995 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3996 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3997 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3998 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3999 wxEVT_SIZING
= _core_
.wxEVT_SIZING
4000 wxEVT_MOVING
= _core_
.wxEVT_MOVING
4001 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
4002 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
4003 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
4004 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
4005 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
4006 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
4007 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
4008 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
4009 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
4010 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
4011 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
4013 # Create some event binders
4014 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
4015 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
4016 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
4017 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
4018 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
4019 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4020 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4021 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
4022 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
4023 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
4024 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
4025 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
4026 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
4027 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
4028 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
4029 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
4030 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
4031 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
4032 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
4033 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
4034 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
4035 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
4036 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
4037 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
4038 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
4039 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4040 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4041 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
4042 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
4043 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
4044 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
4045 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
4046 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
4047 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
4048 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
4049 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
4050 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
4051 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
4052 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
4053 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
4054 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
4055 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
4057 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
4058 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
4059 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
4060 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
4061 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
4062 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
4063 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
4064 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
4065 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
4066 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
4067 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
4068 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
4069 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
4071 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
4079 wxEVT_MIDDLE_DCLICK
,
4087 # Scrolling from wxWindow (sent to wxScrolledWindow)
4088 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
4089 wxEVT_SCROLLWIN_BOTTOM
,
4090 wxEVT_SCROLLWIN_LINEUP
,
4091 wxEVT_SCROLLWIN_LINEDOWN
,
4092 wxEVT_SCROLLWIN_PAGEUP
,
4093 wxEVT_SCROLLWIN_PAGEDOWN
,
4094 wxEVT_SCROLLWIN_THUMBTRACK
,
4095 wxEVT_SCROLLWIN_THUMBRELEASE
,
4098 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
4099 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
4100 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
4101 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
4102 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
4103 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
4104 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
4105 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
4107 # Scrolling from wx.Slider and wx.ScrollBar
4108 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4109 wxEVT_SCROLL_BOTTOM
,
4110 wxEVT_SCROLL_LINEUP
,
4111 wxEVT_SCROLL_LINEDOWN
,
4112 wxEVT_SCROLL_PAGEUP
,
4113 wxEVT_SCROLL_PAGEDOWN
,
4114 wxEVT_SCROLL_THUMBTRACK
,
4115 wxEVT_SCROLL_THUMBRELEASE
,
4116 wxEVT_SCROLL_CHANGED
,
4119 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
4120 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
4121 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
4122 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
4123 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
4124 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
4125 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
4126 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
4127 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
4128 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
4130 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4131 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4132 wxEVT_SCROLL_BOTTOM
,
4133 wxEVT_SCROLL_LINEUP
,
4134 wxEVT_SCROLL_LINEDOWN
,
4135 wxEVT_SCROLL_PAGEUP
,
4136 wxEVT_SCROLL_PAGEDOWN
,
4137 wxEVT_SCROLL_THUMBTRACK
,
4138 wxEVT_SCROLL_THUMBRELEASE
,
4139 wxEVT_SCROLL_CHANGED
,
4142 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
4143 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
4144 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
4145 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
4146 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
4147 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
4148 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
4149 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
4150 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
4151 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
4153 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
4154 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
4155 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
4156 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
4157 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4158 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4159 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4160 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4161 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4162 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4164 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4165 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4166 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4167 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4168 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4169 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4170 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4171 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4172 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4175 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4176 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4177 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4178 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4179 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4180 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4181 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4183 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4185 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4186 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4188 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4190 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
4191 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
4192 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
4195 #---------------------------------------------------------------------------
4197 class Event(Object
):
4199 An event is a structure holding information about an event passed to a
4200 callback or member function. wx.Event is an abstract base class for
4203 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4204 def __init__(self
): raise AttributeError, "No constructor defined"
4205 __repr__
= _swig_repr
4206 __swig_destroy__
= _core_
.delete_Event
4207 __del__
= lambda self
: None;
4208 def SetEventType(*args
, **kwargs
):
4210 SetEventType(self, EventType typ)
4212 Sets the specific type of the event.
4214 return _core_
.Event_SetEventType(*args
, **kwargs
)
4216 def GetEventType(*args
, **kwargs
):
4218 GetEventType(self) -> EventType
4220 Returns the identifier of the given event type, such as
4221 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4223 return _core_
.Event_GetEventType(*args
, **kwargs
)
4225 def GetEventObject(*args
, **kwargs
):
4227 GetEventObject(self) -> Object
4229 Returns the object (usually a window) associated with the event, if
4232 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4234 def SetEventObject(*args
, **kwargs
):
4236 SetEventObject(self, Object obj)
4238 Sets the originating object, or in other words, obj is normally the
4239 object that is sending the event.
4241 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4243 def GetTimestamp(*args
, **kwargs
):
4244 """GetTimestamp(self) -> long"""
4245 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4247 def SetTimestamp(*args
, **kwargs
):
4248 """SetTimestamp(self, long ts=0)"""
4249 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4251 def GetId(*args
, **kwargs
):
4255 Returns the identifier associated with this event, such as a button
4258 return _core_
.Event_GetId(*args
, **kwargs
)
4260 def SetId(*args
, **kwargs
):
4264 Set's the ID for the event. This is usually the ID of the window that
4265 is sending the event, but it can also be a command id from a menu
4268 return _core_
.Event_SetId(*args
, **kwargs
)
4270 def IsCommandEvent(*args
, **kwargs
):
4272 IsCommandEvent(self) -> bool
4274 Returns true if the event is or is derived from `wx.CommandEvent` else
4275 it returns false. Note: Exists only for optimization purposes.
4277 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4279 def Skip(*args
, **kwargs
):
4281 Skip(self, bool skip=True)
4283 This method can be used inside an event handler to control whether
4284 further event handlers bound to this event will be called after the
4285 current one returns. Without Skip() (or equivalently if Skip(False) is
4286 used), the event will not be processed any more. If Skip(True) is
4287 called, the event processing system continues searching for a further
4288 handler function for this event, even though it has been processed
4289 already in the current handler.
4291 return _core_
.Event_Skip(*args
, **kwargs
)
4293 def GetSkipped(*args
, **kwargs
):
4295 GetSkipped(self) -> bool
4297 Returns true if the event handler should be skipped, false otherwise.
4300 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4302 def ShouldPropagate(*args
, **kwargs
):
4304 ShouldPropagate(self) -> bool
4306 Test if this event should be propagated to the parent window or not,
4307 i.e. if the propagation level is currently greater than 0.
4309 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4311 def StopPropagation(*args
, **kwargs
):
4313 StopPropagation(self) -> int
4315 Stop the event from propagating to its parent window. Returns the old
4316 propagation level value which may be later passed to
4317 `ResumePropagation` to allow propagating the event again.
4319 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4321 def ResumePropagation(*args
, **kwargs
):
4323 ResumePropagation(self, int propagationLevel)
4325 Resume the event propagation by restoring the propagation level. (For
4326 example, you can use the value returned by an earlier call to
4330 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4332 def Clone(*args
, **kwargs
):
4333 """Clone(self) -> Event"""
4334 return _core_
.Event_Clone(*args
, **kwargs
)
4336 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4337 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4338 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4339 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4340 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4341 _core_
.Event_swigregister(Event
)
4343 #---------------------------------------------------------------------------
4345 class PropagationDisabler(object):
4347 Helper class to temporarily change an event not to propagate. Simply
4348 create an instance of this class and then whe it is destroyed the
4349 propogation of the event will be restored.
4351 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4352 __repr__
= _swig_repr
4353 def __init__(self
, *args
, **kwargs
):
4355 __init__(self, Event event) -> PropagationDisabler
4357 Helper class to temporarily change an event not to propagate. Simply
4358 create an instance of this class and then whe it is destroyed the
4359 propogation of the event will be restored.
4361 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4362 __swig_destroy__
= _core_
.delete_PropagationDisabler
4363 __del__
= lambda self
: None;
4364 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4366 class PropagateOnce(object):
4368 A helper class that will temporarily lower propagation level of an
4369 event. Simply create an instance of this class and then whe it is
4370 destroyed the propogation of the event will be restored.
4372 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4373 __repr__
= _swig_repr
4374 def __init__(self
, *args
, **kwargs
):
4376 __init__(self, Event event) -> PropagateOnce
4378 A helper class that will temporarily lower propagation level of an
4379 event. Simply create an instance of this class and then whe it is
4380 destroyed the propogation of the event will be restored.
4382 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4383 __swig_destroy__
= _core_
.delete_PropagateOnce
4384 __del__
= lambda self
: None;
4385 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4387 #---------------------------------------------------------------------------
4389 class CommandEvent(Event
):
4391 This event class contains information about command events, which
4392 originate from a variety of simple controls, as well as menus and
4395 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4396 __repr__
= _swig_repr
4397 def __init__(self
, *args
, **kwargs
):
4399 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4401 This event class contains information about command events, which
4402 originate from a variety of simple controls, as well as menus and
4405 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4406 def GetSelection(*args
, **kwargs
):
4408 GetSelection(self) -> int
4410 Returns item index for a listbox or choice selection event (not valid
4413 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4415 def SetString(*args
, **kwargs
):
4416 """SetString(self, String s)"""
4417 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4419 def GetString(*args
, **kwargs
):
4421 GetString(self) -> String
4423 Returns item string for a listbox or choice selection event (not valid
4426 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4428 def IsChecked(*args
, **kwargs
):
4430 IsChecked(self) -> bool
4432 This method can be used with checkbox and menu events: for the
4433 checkboxes, the method returns true for a selection event and false
4434 for a deselection one. For the menu events, this method indicates if
4435 the menu item just has become checked or unchecked (and thus only
4436 makes sense for checkable menu items).
4438 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4441 def IsSelection(*args
, **kwargs
):
4443 IsSelection(self) -> bool
4445 For a listbox or similar event, returns true if it is a selection,
4446 false if it is a deselection.
4448 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4450 def SetExtraLong(*args
, **kwargs
):
4451 """SetExtraLong(self, long extraLong)"""
4452 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4454 def GetExtraLong(*args
, **kwargs
):
4456 GetExtraLong(self) -> long
4458 Returns extra information dependant on the event objects type. If the
4459 event comes from a listbox selection, it is a boolean determining
4460 whether the event was a selection (true) or a deselection (false). A
4461 listbox deselection only occurs for multiple-selection boxes, and in
4462 this case the index and string values are indeterminate and the
4463 listbox must be examined by the application.
4465 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4467 def SetInt(*args
, **kwargs
):
4468 """SetInt(self, int i)"""
4469 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4471 def GetInt(*args
, **kwargs
):
4475 Returns the integer identifier corresponding to a listbox, choice or
4476 radiobox selection (only if the event was a selection, not a
4477 deselection), or a boolean value representing the value of a checkbox.
4479 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4481 def GetClientData(*args
, **kwargs
):
4483 GetClientData(self) -> PyObject
4485 Returns the client data object for a listbox or choice selection event, (if any.)
4487 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4489 def SetClientData(*args
, **kwargs
):
4491 SetClientData(self, PyObject clientData)
4493 Associate the given client data with the item at position n.
4495 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4497 GetClientObject
= GetClientData
4498 SetClientObject
= SetClientData
4500 def Clone(*args
, **kwargs
):
4501 """Clone(self) -> Event"""
4502 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4504 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4505 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4506 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4507 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4508 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4509 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4510 _core_
.CommandEvent_swigregister(CommandEvent
)
4512 #---------------------------------------------------------------------------
4514 class NotifyEvent(CommandEvent
):
4516 An instance of this class (or one of its derived classes) is sent from
4517 a control when the control's state is being changed and the control
4518 allows that change to be prevented from happening. The event handler
4519 can call `Veto` or `Allow` to tell the control what to do.
4521 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4522 __repr__
= _swig_repr
4523 def __init__(self
, *args
, **kwargs
):
4525 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4527 An instance of this class (or one of its derived classes) is sent from
4528 a control when the control's state is being changed and the control
4529 allows that change to be prevented from happening. The event handler
4530 can call `Veto` or `Allow` to tell the control what to do.
4532 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4533 def Veto(*args
, **kwargs
):
4537 Prevents the change announced by this event from happening.
4539 It is in general a good idea to notify the user about the reasons for
4540 vetoing the change because otherwise the applications behaviour (which
4541 just refuses to do what the user wants) might be quite surprising.
4543 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4545 def Allow(*args
, **kwargs
):
4549 This is the opposite of `Veto`: it explicitly allows the event to be
4550 processed. For most events it is not necessary to call this method as
4551 the events are allowed anyhow but some are forbidden by default (this
4552 will be mentioned in the corresponding event description).
4554 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4556 def IsAllowed(*args
, **kwargs
):
4558 IsAllowed(self) -> bool
4560 Returns true if the change is allowed (`Veto` hasn't been called) or
4561 false otherwise (if it was).
4563 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4565 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4567 #---------------------------------------------------------------------------
4569 class ScrollEvent(CommandEvent
):
4571 A scroll event holds information about events sent from stand-alone
4572 scrollbars and sliders. Note that scrolled windows do not send
4573 instnaces of this event class, but send the `wx.ScrollWinEvent`
4576 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4577 __repr__
= _swig_repr
4578 def __init__(self
, *args
, **kwargs
):
4580 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4581 int orient=0) -> ScrollEvent
4583 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4584 def GetOrientation(*args
, **kwargs
):
4586 GetOrientation(self) -> int
4588 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4591 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4593 def GetPosition(*args
, **kwargs
):
4595 GetPosition(self) -> int
4597 Returns the position of the scrollbar.
4599 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4601 def SetOrientation(*args
, **kwargs
):
4602 """SetOrientation(self, int orient)"""
4603 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4605 def SetPosition(*args
, **kwargs
):
4606 """SetPosition(self, int pos)"""
4607 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4609 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4610 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4611 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4613 #---------------------------------------------------------------------------
4615 class ScrollWinEvent(Event
):
4617 A wx.ScrollWinEvent holds information about scrolling and is sent from
4620 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4621 __repr__
= _swig_repr
4622 def __init__(self
, *args
, **kwargs
):
4624 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4626 A wx.ScrollWinEvent holds information about scrolling and is sent from
4629 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4630 def GetOrientation(*args
, **kwargs
):
4632 GetOrientation(self) -> int
4634 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4637 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4639 def GetPosition(*args
, **kwargs
):
4641 GetPosition(self) -> int
4643 Returns the position of the scrollbar for the thumb track and release
4644 events. Note that this field can't be used for the other events, you
4645 need to query the window itself for the current position in that case.
4647 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4649 def SetOrientation(*args
, **kwargs
):
4650 """SetOrientation(self, int orient)"""
4651 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4653 def SetPosition(*args
, **kwargs
):
4654 """SetPosition(self, int pos)"""
4655 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4657 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4658 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4659 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4661 #---------------------------------------------------------------------------
4663 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4664 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4665 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4666 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4667 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4668 class MouseEvent(Event
):
4670 This event class contains information about the events generated by
4671 the mouse: they include mouse buttons press and release events and
4674 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4675 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4676 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4677 a middle button so a portable application should avoid relying on the
4680 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4681 the former returns true when the event corresponds to the left mouse
4682 button click while the latter returns true if the left mouse button is
4683 currently being pressed. For example, when the user is dragging the
4684 mouse you can use `LeftIsDown` to test whether the left mouse button
4685 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4686 `LeftIsDown` will also return true in wxWidgets whatever the
4687 underlying GUI behaviour is (which is platform-dependent). The same
4688 applies, of course, to other mouse buttons as well.
4690 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4691 __repr__
= _swig_repr
4692 def __init__(self
, *args
, **kwargs
):
4694 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4696 Constructs a wx.MouseEvent. Valid event types are:
4698 * wxEVT_ENTER_WINDOW
4699 * wxEVT_LEAVE_WINDOW
4705 * wxEVT_MIDDLE_DCLICK
4708 * wxEVT_RIGHT_DCLICK
4712 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4713 def IsButton(*args
, **kwargs
):
4715 IsButton(self) -> bool
4717 Returns true if the event was a mouse button event (not necessarily a
4718 button down event - that may be tested using `ButtonDown`).
4720 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4722 def ButtonDown(*args
, **kwargs
):
4724 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4726 If the argument is omitted, this returns true if the event was any
4727 mouse button down event. Otherwise the argument specifies which
4728 button-down event shold be checked for (see `Button` for the possible
4731 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4733 def ButtonDClick(*args
, **kwargs
):
4735 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4737 If the argument is omitted, this returns true if the event was any
4738 mouse double click event. Otherwise the argument specifies which
4739 double click event to check for (see `Button` for the possible
4742 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4744 def ButtonUp(*args
, **kwargs
):
4746 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4748 If the argument is omitted, this returns true if the event was any
4749 mouse button up event. Otherwise the argument specifies which button
4750 up event to check for (see `Button` for the possible values).
4752 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4754 def Button(*args
, **kwargs
):
4756 Button(self, int button) -> bool
4758 Returns true if the identified mouse button is changing state. Valid
4759 values of button are:
4761 ==================== =====================================
4762 wx.MOUSE_BTN_LEFT check if left button was pressed
4763 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4764 wx.MOUSE_BTN_RIGHT check if right button was pressed
4765 wx.MOUSE_BTN_ANY check if any button was pressed
4766 ==================== =====================================
4769 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4771 def ButtonIsDown(*args
, **kwargs
):
4772 """ButtonIsDown(self, int but) -> bool"""
4773 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4775 def GetButton(*args
, **kwargs
):
4777 GetButton(self) -> int
4779 Returns the mouse button which generated this event or
4780 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4781 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4782 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4783 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4784 right buttons respectively.
4786 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4788 def ControlDown(*args
, **kwargs
):
4790 ControlDown(self) -> bool
4792 Returns true if the control key was down at the time of the event.
4794 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4796 def MetaDown(*args
, **kwargs
):
4798 MetaDown(self) -> bool
4800 Returns true if the Meta key was down at the time of the event.
4802 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4804 def AltDown(*args
, **kwargs
):
4806 AltDown(self) -> bool
4808 Returns true if the Alt key was down at the time of the event.
4810 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4812 def ShiftDown(*args
, **kwargs
):
4814 ShiftDown(self) -> bool
4816 Returns true if the Shift key was down at the time of the event.
4818 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4820 def CmdDown(*args
, **kwargs
):
4822 CmdDown(self) -> bool
4824 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4825 platforms but the special "Apple" (a.k.a as "Command") key on
4826 Macs. It often makes sense to use it instead of, say, `ControlDown`
4827 because Cmd key is used for the same thing under Mac as Ctrl
4828 elsewhere. The Ctrl key still exists, it's just not used for this
4829 purpose. So for non-Mac platforms this is the same as `ControlDown`
4830 and Macs this is the same as `MetaDown`.
4832 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4834 def LeftDown(*args
, **kwargs
):
4836 LeftDown(self) -> bool
4838 Returns true if the left mouse button state changed to down.
4840 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4842 def MiddleDown(*args
, **kwargs
):
4844 MiddleDown(self) -> bool
4846 Returns true if the middle mouse button state changed to down.
4848 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4850 def RightDown(*args
, **kwargs
):
4852 RightDown(self) -> bool
4854 Returns true if the right mouse button state changed to down.
4856 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4858 def LeftUp(*args
, **kwargs
):
4860 LeftUp(self) -> bool
4862 Returns true if the left mouse button state changed to up.
4864 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4866 def MiddleUp(*args
, **kwargs
):
4868 MiddleUp(self) -> bool
4870 Returns true if the middle mouse button state changed to up.
4872 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4874 def RightUp(*args
, **kwargs
):
4876 RightUp(self) -> bool
4878 Returns true if the right mouse button state changed to up.
4880 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4882 def LeftDClick(*args
, **kwargs
):
4884 LeftDClick(self) -> bool
4886 Returns true if the event was a left button double click.
4888 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4890 def MiddleDClick(*args
, **kwargs
):
4892 MiddleDClick(self) -> bool
4894 Returns true if the event was a middle button double click.
4896 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4898 def RightDClick(*args
, **kwargs
):
4900 RightDClick(self) -> bool
4902 Returns true if the event was a right button double click.
4904 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4906 def LeftIsDown(*args
, **kwargs
):
4908 LeftIsDown(self) -> bool
4910 Returns true if the left mouse button is currently down, independent
4911 of the current event type.
4913 Please notice that it is not the same as LeftDown which returns true
4914 if the left mouse button was just pressed. Rather, it describes the
4915 state of the mouse button before the event happened.
4917 This event is usually used in the mouse event handlers which process
4918 "move mouse" messages to determine whether the user is (still)
4921 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4923 def MiddleIsDown(*args
, **kwargs
):
4925 MiddleIsDown(self) -> bool
4927 Returns true if the middle mouse button is currently down, independent
4928 of the current event type.
4930 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4932 def RightIsDown(*args
, **kwargs
):
4934 RightIsDown(self) -> bool
4936 Returns true if the right mouse button is currently down, independent
4937 of the current event type.
4939 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4941 def Dragging(*args
, **kwargs
):
4943 Dragging(self) -> bool
4945 Returns true if this was a dragging event (motion while a button is
4948 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4950 def Moving(*args
, **kwargs
):
4952 Moving(self) -> bool
4954 Returns true if this was a motion event and no mouse buttons were
4955 pressed. If any mouse button is held pressed, then this method returns
4956 false and Dragging returns true.
4958 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4960 def Entering(*args
, **kwargs
):
4962 Entering(self) -> bool
4964 Returns true if the mouse was entering the window.
4966 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4968 def Leaving(*args
, **kwargs
):
4970 Leaving(self) -> bool
4972 Returns true if the mouse was leaving the window.
4974 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4976 def GetPosition(*args
, **kwargs
):
4978 GetPosition(self) -> Point
4980 Returns the pixel position of the mouse in window coordinates when the
4983 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4985 def GetPositionTuple(*args
, **kwargs
):
4987 GetPositionTuple() -> (x,y)
4989 Returns the pixel position of the mouse in window coordinates when the
4992 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4994 def GetLogicalPosition(*args
, **kwargs
):
4996 GetLogicalPosition(self, DC dc) -> Point
4998 Returns the logical mouse position in pixels (i.e. translated
4999 according to the translation set for the DC, which usually indicates
5000 that the window has been scrolled).
5002 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
5004 def GetX(*args
, **kwargs
):
5008 Returns X coordinate of the physical mouse event position.
5010 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
5012 def GetY(*args
, **kwargs
):
5016 Returns Y coordinate of the physical mouse event position.
5018 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
5020 def GetWheelRotation(*args
, **kwargs
):
5022 GetWheelRotation(self) -> int
5024 Get wheel rotation, positive or negative indicates direction of
5025 rotation. Current devices all send an event when rotation is equal to
5026 +/-WheelDelta, but this allows for finer resolution devices to be
5027 created in the future. Because of this you shouldn't assume that one
5028 event is equal to 1 line or whatever, but you should be able to either
5029 do partial line scrolling or wait until +/-WheelDelta rotation values
5030 have been accumulated before scrolling.
5032 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
5034 def GetWheelDelta(*args
, **kwargs
):
5036 GetWheelDelta(self) -> int
5038 Get wheel delta, normally 120. This is the threshold for action to be
5039 taken, and one such action (for example, scrolling one increment)
5040 should occur for each delta.
5042 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
5044 def GetLinesPerAction(*args
, **kwargs
):
5046 GetLinesPerAction(self) -> int
5048 Returns the configured number of lines (or whatever) to be scrolled
5049 per wheel action. Defaults to three.
5051 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
5053 def IsPageScroll(*args
, **kwargs
):
5055 IsPageScroll(self) -> bool
5057 Returns true if the system has been setup to do page scrolling with
5058 the mouse wheel instead of line scrolling.
5060 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
5062 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
5063 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
5064 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
5065 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
5066 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
5067 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
5068 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
5069 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
5070 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
5071 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
5072 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
5073 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
5074 Button
= property(GetButton
,doc
="See `GetButton`")
5075 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
5076 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
5077 Position
= property(GetPosition
,doc
="See `GetPosition`")
5078 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
5079 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
5080 X
= property(GetX
,doc
="See `GetX`")
5081 Y
= property(GetY
,doc
="See `GetY`")
5082 _core_
.MouseEvent_swigregister(MouseEvent
)
5084 #---------------------------------------------------------------------------
5086 class SetCursorEvent(Event
):
5088 A SetCursorEvent is generated when the mouse cursor is about to be set
5089 as a result of mouse motion. This event gives the application the
5090 chance to perform specific mouse cursor processing based on the
5091 current position of the mouse within the window. Use the `SetCursor`
5092 method to specify the cursor you want to be displayed.
5094 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5095 __repr__
= _swig_repr
5096 def __init__(self
, *args
, **kwargs
):
5098 __init__(self, int x=0, int y=0) -> SetCursorEvent
5100 Construct a new `wx.SetCursorEvent`.
5102 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
5103 def GetX(*args
, **kwargs
):
5107 Returns the X coordinate of the mouse in client coordinates.
5109 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
5111 def GetY(*args
, **kwargs
):
5115 Returns the Y coordinate of the mouse in client coordinates.
5117 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5119 def SetCursor(*args
, **kwargs
):
5121 SetCursor(self, Cursor cursor)
5123 Sets the cursor associated with this event.
5125 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5127 def GetCursor(*args
, **kwargs
):
5129 GetCursor(self) -> Cursor
5131 Returns a reference to the cursor specified by this event.
5133 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5135 def HasCursor(*args
, **kwargs
):
5137 HasCursor(self) -> bool
5139 Returns true if the cursor specified by this event is a valid cursor.
5141 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5143 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
5144 X
= property(GetX
,doc
="See `GetX`")
5145 Y
= property(GetY
,doc
="See `GetY`")
5146 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
5148 #---------------------------------------------------------------------------
5150 class KeyEvent(Event
):
5152 This event class contains information about keypress and character
5153 events. These events are only sent to the widget that currently has
5156 Notice that there are three different kinds of keyboard events in
5157 wxWidgets: key down and up events and char events. The difference
5158 between the first two is clear - the first corresponds to a key press
5159 and the second to a key release - otherwise they are identical. Just
5160 note that if the key is maintained in a pressed state you will
5161 typically get a lot of (automatically generated) down events but only
5162 one up so it is wrong to assume that there is one up event
5163 corresponding to each down one.
5165 Both key events provide untranslated key codes while the char event
5166 carries the translated one. The untranslated code for alphanumeric
5167 keys is always an upper case value. For the other keys it is one of
5168 WXK_XXX values from the keycodes table. The translated key is, in
5169 general, the character the user expects to appear as the result of the
5170 key combination when typing the text into a text entry zone, for
5173 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5174 and the standard US keyboard): when the 'A' key is pressed, the key
5175 down event key code is equal to ASCII A == 65. But the char event key
5176 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5177 'A' keys simultaneously , the key code in key down event will still be
5178 just 'A' while the char event key code parameter will now be 'A' as
5181 Although in this simple case it is clear that the correct key code
5182 could be found in the key down event handler by checking the value
5183 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5184 as for non alphanumeric keys or non-US keyboard layouts the
5185 translation is keyboard-layout dependent and can only be done properly
5186 by the system itself.
5188 Another kind of translation is done when the control key is pressed:
5189 for example, for CTRL-A key press the key down event still carries the
5190 same key code 'A' as usual but the char event will have key code of 1,
5191 the ASCII value of this key combination.
5193 You may discover how the other keys on your system behave
5194 interactively by running the KeyEvents sample in the wxPython demo and
5195 pressing some keys while the blue box at the top has the keyboard
5198 **Note**: If a key down event is caught and the event handler does not
5199 call event.Skip() then the coresponding char event will not
5200 happen. This is by design and enables the programs that handle both
5201 types of events to be a bit simpler.
5203 **Note for Windows programmers**: The key and char events in wxWidgets
5204 are similar to but slightly different from Windows WM_KEYDOWN and
5205 WM_CHAR events. In particular, Alt-x combination will generate a char
5206 event in wxWidgets (unless it is used as an accelerator).
5208 **Tip**: be sure to call event.Skip() for events that you don't
5209 process in key event function, otherwise menu shortcuts may cease to
5213 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5214 __repr__
= _swig_repr
5215 def __init__(self
, *args
, **kwargs
):
5217 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5219 Construct a new `wx.KeyEvent`. Valid event types are:
5222 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
5223 def GetModifiers(*args
, **kwargs
):
5225 GetModifiers(self) -> int
5227 Returns a bitmask of the current modifier settings. Can be used to
5228 check if the key event has exactly the given modifiers without having
5229 to explicitly check that the other modifiers are not down. For
5232 if event.GetModifers() == wx.MOD_CONTROL:
5236 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5238 def ControlDown(*args
, **kwargs
):
5240 ControlDown(self) -> bool
5242 Returns ``True`` if the Control key was down at the time of the event.
5244 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5246 def MetaDown(*args
, **kwargs
):
5248 MetaDown(self) -> bool
5250 Returns ``True`` if the Meta key was down at the time of the event.
5252 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5254 def AltDown(*args
, **kwargs
):
5256 AltDown(self) -> bool
5258 Returns ``True`` if the Alt key was down at the time of the event.
5260 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5262 def ShiftDown(*args
, **kwargs
):
5264 ShiftDown(self) -> bool
5266 Returns ``True`` if the Shift key was down at the time of the event.
5268 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5270 def CmdDown(*args
, **kwargs
):
5272 CmdDown(self) -> bool
5274 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5275 platforms but the special "Apple" (a.k.a as "Command") key on
5276 Macs. It makes often sense to use it instead of, say, `ControlDown`
5277 because Cmd key is used for the same thing under Mac as Ctrl
5278 elsewhere. The Ctrl still exists, it's just not used for this
5279 purpose. So for non-Mac platforms this is the same as `ControlDown`
5280 and Macs this is the same as `MetaDown`.
5282 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5284 def HasModifiers(*args
, **kwargs
):
5286 HasModifiers(self) -> bool
5288 Returns true if either CTRL or ALT keys was down at the time of the
5289 key event. Note that this function does not take into account neither
5290 SHIFT nor META key states (the reason for ignoring the latter is that
5291 it is common for NUMLOCK key to be configured as META under X but the
5292 key presses even while NUMLOCK is on should be still processed
5295 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5297 def GetKeyCode(*args
, **kwargs
):
5299 GetKeyCode(self) -> int
5301 Returns the virtual key code. ASCII events return normal ASCII values,
5302 while non-ASCII events return values such as WXK_LEFT for the left
5303 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5306 Note that in Unicode build, the returned value is meaningful only if
5307 the user entered a character that can be represented in current
5308 locale's default charset. You can obtain the corresponding Unicode
5309 character using `GetUnicodeKey`.
5311 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5313 def GetUnicodeKey(*args
, **kwargs
):
5315 GetUnicodeKey(self) -> int
5317 Returns the Unicode character corresponding to this key event. This
5318 function is only meaningfule in a Unicode build of wxPython.
5320 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5322 GetUniChar
= GetUnicodeKey
5323 def SetUnicodeKey(*args
, **kwargs
):
5325 SetUnicodeKey(self, int uniChar)
5327 Set the Unicode value of the key event, but only if this is a Unicode
5330 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5332 def GetRawKeyCode(*args
, **kwargs
):
5334 GetRawKeyCode(self) -> unsigned int
5336 Returns the raw key code for this event. This is a platform-dependent
5337 scan code which should only be used in advanced
5338 applications. Currently the raw key codes are not supported by all
5341 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5343 def GetRawKeyFlags(*args
, **kwargs
):
5345 GetRawKeyFlags(self) -> unsigned int
5347 Returns the low level key flags for this event. The flags are
5348 platform-dependent and should only be used in advanced applications.
5349 Currently the raw key flags are not supported by all ports.
5351 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5353 def GetPosition(*args
, **kwargs
):
5355 GetPosition(self) -> Point
5357 Find the position of the event, if applicable.
5359 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5361 def GetPositionTuple(*args
, **kwargs
):
5363 GetPositionTuple() -> (x,y)
5365 Find the position of the event, if applicable.
5367 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5369 def GetX(*args
, **kwargs
):
5373 Returns the X position (in client coordinates) of the event, if
5376 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5378 def GetY(*args
, **kwargs
):
5382 Returns the Y position (in client coordinates) of the event, if
5385 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5387 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5388 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5389 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5390 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5391 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5392 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5393 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5394 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5395 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5396 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5397 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5398 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5399 Position
= property(GetPosition
,doc
="See `GetPosition`")
5400 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5401 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5402 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5403 X
= property(GetX
,doc
="See `GetX`")
5404 Y
= property(GetY
,doc
="See `GetY`")
5405 _core_
.KeyEvent_swigregister(KeyEvent
)
5407 #---------------------------------------------------------------------------
5409 class SizeEvent(Event
):
5411 A size event holds information about size change events. The EVT_SIZE
5412 handler function will be called when the window it is bound to has
5415 Note that the size passed is of the whole window: call
5416 `wx.Window.GetClientSize` for the area which may be used by the
5419 When a window is resized, usually only a small part of the window is
5420 damaged and and that area is all that is in the update region for the
5421 next paint event. However, if your drawing depends on the size of the
5422 window, you may need to clear the DC explicitly and repaint the whole
5423 window. In which case, you may need to call `wx.Window.Refresh` to
5424 invalidate the entire window.
5427 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5428 __repr__
= _swig_repr
5429 def __init__(self
, *args
, **kwargs
):
5431 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5433 Construct a new ``wx.SizeEvent``.
5435 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5436 def GetSize(*args
, **kwargs
):
5438 GetSize(self) -> Size
5440 Returns the entire size of the window generating the size change
5443 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5445 def GetRect(*args
, **kwargs
):
5446 """GetRect(self) -> Rect"""
5447 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5449 def SetRect(*args
, **kwargs
):
5450 """SetRect(self, Rect rect)"""
5451 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5453 def SetSize(*args
, **kwargs
):
5454 """SetSize(self, Size size)"""
5455 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5457 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5458 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5459 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5460 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5461 _core_
.SizeEvent_swigregister(SizeEvent
)
5463 #---------------------------------------------------------------------------
5465 class MoveEvent(Event
):
5467 This event object is sent for EVT_MOVE event bindings when a window is
5468 moved to a new position.
5470 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5471 __repr__
= _swig_repr
5472 def __init__(self
, *args
, **kwargs
):
5474 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5478 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5479 def GetPosition(*args
, **kwargs
):
5481 GetPosition(self) -> Point
5483 Returns the position of the window generating the move change event.
5485 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5487 def GetRect(*args
, **kwargs
):
5488 """GetRect(self) -> Rect"""
5489 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5491 def SetRect(*args
, **kwargs
):
5492 """SetRect(self, Rect rect)"""
5493 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5495 def SetPosition(*args
, **kwargs
):
5496 """SetPosition(self, Point pos)"""
5497 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5499 m_pos
= property(GetPosition
, SetPosition
)
5500 m_rect
= property(GetRect
, SetRect
)
5502 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5503 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5504 _core_
.MoveEvent_swigregister(MoveEvent
)
5506 #---------------------------------------------------------------------------
5508 class PaintEvent(Event
):
5510 A paint event is sent when a window's contents needs to be repainted.
5511 Note that in an EVT_PAINT handler the application must *always* create
5512 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5513 Windows assumes that the window has not been painted yet and will send
5514 the event again, causing endless refreshes.
5516 You can optimize painting by retrieving the rectangles that have been
5517 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5518 and only repainting these rectangles. The rectangles are in terms of
5519 the client area, and are unscrolled, so you will need to do some
5520 calculations using the current view position to obtain logical,
5524 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5525 __repr__
= _swig_repr
5526 def __init__(self
, *args
, **kwargs
):
5527 """__init__(self, int Id=0) -> PaintEvent"""
5528 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5529 _core_
.PaintEvent_swigregister(PaintEvent
)
5531 class NcPaintEvent(Event
):
5532 """Proxy of C++ NcPaintEvent class"""
5533 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5534 __repr__
= _swig_repr
5535 def __init__(self
, *args
, **kwargs
):
5536 """__init__(self, int winid=0) -> NcPaintEvent"""
5537 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5538 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5540 #---------------------------------------------------------------------------
5542 class EraseEvent(Event
):
5544 An erase event is sent whenever the background of a window needs to be
5545 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5546 binder. On some platforms, such as GTK+, this event is simulated
5547 (simply generated just before the paint event) and may cause flicker.
5549 To paint a custom background use the `GetDC` method and use the returned
5550 device context if it is not ``None``, otherwise create a temporary
5551 `wx.ClientDC` and draw on that.
5554 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5555 __repr__
= _swig_repr
5556 def __init__(self
, *args
, **kwargs
):
5558 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5562 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5563 def GetDC(*args
, **kwargs
):
5567 Returns the device context the event handler should draw upon. If
5568 ``None`` is returned then create a temporary `wx.ClientDC` and use
5571 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5573 DC
= property(GetDC
,doc
="See `GetDC`")
5574 _core_
.EraseEvent_swigregister(EraseEvent
)
5576 #---------------------------------------------------------------------------
5578 class FocusEvent(Event
):
5580 A focus event is sent when a window's focus changes. The window losing
5581 focus receives an EVT_KILL_FOCUS event while the window gaining it
5582 gets an EVT_SET_FOCUS event.
5584 Notice that the set focus event happens both when the user gives focus
5585 to the window (whether using the mouse or keyboard) and when it is
5586 done from the program itself using `wx.Window.SetFocus`.
5589 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5590 __repr__
= _swig_repr
5591 def __init__(self
, *args
, **kwargs
):
5593 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5597 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5598 def GetWindow(*args
, **kwargs
):
5600 GetWindow(self) -> Window
5602 Returns the other window associated with this event, that is the
5603 window which had the focus before for the EVT_SET_FOCUS event and the
5604 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5606 Warning: the window returned may be None!
5608 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5610 def SetWindow(*args
, **kwargs
):
5611 """SetWindow(self, Window win)"""
5612 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5614 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5615 _core_
.FocusEvent_swigregister(FocusEvent
)
5617 #---------------------------------------------------------------------------
5619 class ChildFocusEvent(CommandEvent
):
5621 A child focus event is sent to a (parent-)window when one of its child
5622 windows gains focus, so that the window could restore the focus back
5623 to its corresponding child if it loses it now and regains later.
5625 Notice that child window is the direct child of the window receiving
5626 the event, and so may not be the actual widget recieving focus if it
5627 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5628 to get the widget that is actually receiving focus.
5630 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5631 __repr__
= _swig_repr
5632 def __init__(self
, *args
, **kwargs
):
5634 __init__(self, Window win=None) -> ChildFocusEvent
5638 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5639 def GetWindow(*args
, **kwargs
):
5641 GetWindow(self) -> Window
5643 The window, or (grand)parent of the window which has just received the
5646 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5648 Window
= property(GetWindow
,doc
="See `GetWindow`")
5649 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5651 #---------------------------------------------------------------------------
5653 class ActivateEvent(Event
):
5655 An activate event is sent when a top-level window or the entire
5656 application is being activated or deactivated.
5658 A top-level window (a dialog or frame) receives an activate event when
5659 is being activated or deactivated. This is indicated visually by the
5660 title bar changing colour, and a subwindow gaining the keyboard focus.
5661 An application is activated or deactivated when one of its frames
5662 becomes activated, or a frame becomes inactivate resulting in all
5663 application frames being inactive.
5665 Please note that usually you should call event.Skip() in your handlers
5666 for these events so the default handlers will still be called, as not
5667 doing so can result in strange effects.
5670 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5671 __repr__
= _swig_repr
5672 def __init__(self
, *args
, **kwargs
):
5674 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5678 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5679 def GetActive(*args
, **kwargs
):
5681 GetActive(self) -> bool
5683 Returns true if the application or window is being activated, false
5686 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5688 Active
= property(GetActive
,doc
="See `GetActive`")
5689 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5691 #---------------------------------------------------------------------------
5693 class InitDialogEvent(Event
):
5695 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5696 any window when `wx.Window.InitDialog` is called. Handlers for this
5697 event can transfer data to the window, or anything else that should be
5698 done before the user begins editing the form. The default handler
5699 calls `wx.Window.TransferDataToWindow`.
5701 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5702 __repr__
= _swig_repr
5703 def __init__(self
, *args
, **kwargs
):
5705 __init__(self, int Id=0) -> InitDialogEvent
5709 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5710 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5712 #---------------------------------------------------------------------------
5714 class MenuEvent(Event
):
5716 This class is used for a variety of menu-related events. Note that
5717 these do not include menu command events, which are handled by sending
5718 `wx.CommandEvent` objects.
5720 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5721 text in the first field of the status bar.
5723 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5724 __repr__
= _swig_repr
5725 def __init__(self
, *args
, **kwargs
):
5727 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5731 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5732 def GetMenuId(*args
, **kwargs
):
5734 GetMenuId(self) -> int
5736 Returns the menu identifier associated with the event. This method
5737 should be only used with the HIGHLIGHT events.
5739 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5741 def IsPopup(*args
, **kwargs
):
5743 IsPopup(self) -> bool
5745 Returns ``True`` if the menu which is being opened or closed is a
5746 popup menu, ``False`` if it is a normal one. This method should only
5747 be used with the OPEN and CLOSE events.
5749 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5751 def GetMenu(*args
, **kwargs
):
5753 GetMenu(self) -> Menu
5755 Returns the menu which is being opened or closed. This method should
5756 only be used with the OPEN and CLOSE events.
5758 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5760 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5761 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5762 _core_
.MenuEvent_swigregister(MenuEvent
)
5764 #---------------------------------------------------------------------------
5766 class CloseEvent(Event
):
5768 This event class contains information about window and session close
5771 The handler function for EVT_CLOSE is called when the user has tried
5772 to close a a frame or dialog box using the window manager controls or
5773 the system menu. It can also be invoked by the application itself
5774 programmatically, for example by calling the `wx.Window.Close`
5777 You should check whether the application is forcing the deletion of
5778 the window using `CanVeto`. If it returns ``False``, you must destroy
5779 the window using `wx.Window.Destroy`. If the return value is ``True``,
5780 it is up to you whether you respond by destroying the window or not.
5781 For example you may wish to display a message dialog prompting to save
5782 files or to cancel the close.
5784 If you don't destroy the window, you should call `Veto` to let the
5785 calling code know that you did not destroy the window. This allows the
5786 `wx.Window.Close` function to return ``True`` or ``False`` depending
5787 on whether the close instruction was honored or not.
5789 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5790 __repr__
= _swig_repr
5791 def __init__(self
, *args
, **kwargs
):
5793 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5797 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5798 def SetLoggingOff(*args
, **kwargs
):
5800 SetLoggingOff(self, bool logOff)
5802 Sets the 'logging off' flag.
5804 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5806 def GetLoggingOff(*args
, **kwargs
):
5808 GetLoggingOff(self) -> bool
5810 Returns ``True`` if the user is logging off or ``False`` if the
5811 system is shutting down. This method can only be called for end
5812 session and query end session events, it doesn't make sense for close
5815 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5817 def Veto(*args
, **kwargs
):
5819 Veto(self, bool veto=True)
5821 Call this from your event handler to veto a system shutdown or to
5822 signal to the calling application that a window close did not happen.
5824 You can only veto a shutdown or close if `CanVeto` returns true.
5826 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5828 def GetVeto(*args
, **kwargs
):
5829 """GetVeto(self) -> bool"""
5830 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5832 def SetCanVeto(*args
, **kwargs
):
5834 SetCanVeto(self, bool canVeto)
5836 Sets the 'can veto' flag.
5838 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5840 def CanVeto(*args
, **kwargs
):
5842 CanVeto(self) -> bool
5844 Returns true if you can veto a system shutdown or a window close
5845 event. Vetoing a window close event is not possible if the calling
5846 code wishes to force the application to exit, and so this function
5847 must be called to check this.
5849 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5851 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5852 _core_
.CloseEvent_swigregister(CloseEvent
)
5854 #---------------------------------------------------------------------------
5856 class ShowEvent(Event
):
5857 """An EVT_SHOW event is sent when a window is shown or hidden."""
5858 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5859 __repr__
= _swig_repr
5860 def __init__(self
, *args
, **kwargs
):
5862 __init__(self, int winid=0, bool show=False) -> ShowEvent
5864 An EVT_SHOW event is sent when a window is shown or hidden.
5866 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5867 def SetShow(*args
, **kwargs
):
5868 """SetShow(self, bool show)"""
5869 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5871 def GetShow(*args
, **kwargs
):
5872 """GetShow(self) -> bool"""
5873 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5875 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5876 _core_
.ShowEvent_swigregister(ShowEvent
)
5878 #---------------------------------------------------------------------------
5880 class IconizeEvent(Event
):
5882 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5885 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5886 __repr__
= _swig_repr
5887 def __init__(self
, *args
, **kwargs
):
5889 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5891 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5894 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5895 def Iconized(*args
, **kwargs
):
5897 Iconized(self) -> bool
5899 Returns ``True`` if the frame has been iconized, ``False`` if it has
5902 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5904 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5906 #---------------------------------------------------------------------------
5908 class MaximizeEvent(Event
):
5909 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5910 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5911 __repr__
= _swig_repr
5912 def __init__(self
, *args
, **kwargs
):
5914 __init__(self, int id=0) -> MaximizeEvent
5916 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5918 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5919 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5921 #---------------------------------------------------------------------------
5923 class DropFilesEvent(Event
):
5925 This class is used for drop files events, that is, when files have
5926 been dropped onto the window. This functionality is only available
5927 under Windows. The window must have previously been enabled for
5928 dropping by calling `wx.Window.DragAcceptFiles`.
5930 Important note: this is a separate implementation to the more general
5931 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5932 implementation uses the older, Windows message-based approach of
5935 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5939 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5940 def __init__(self
): raise AttributeError, "No constructor defined"
5941 __repr__
= _swig_repr
5942 def GetPosition(*args
, **kwargs
):
5944 GetPosition(self) -> Point
5946 Returns the position at which the files were dropped.
5948 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5950 def GetNumberOfFiles(*args
, **kwargs
):
5952 GetNumberOfFiles(self) -> int
5954 Returns the number of files dropped.
5956 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5958 def GetFiles(*args
, **kwargs
):
5960 GetFiles(self) -> PyObject
5962 Returns a list of the filenames that were dropped.
5964 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5966 Files
= property(GetFiles
,doc
="See `GetFiles`")
5967 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5968 Position
= property(GetPosition
,doc
="See `GetPosition`")
5969 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5971 #---------------------------------------------------------------------------
5973 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5974 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5975 class UpdateUIEvent(CommandEvent
):
5977 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5978 wxWidgets to give an application the chance to update various user
5981 Without update UI events, an application has to work hard to
5982 check/uncheck, enable/disable, and set the text for elements such as
5983 menu items and toolbar buttons. The code for doing this has to be
5984 mixed up with the code that is invoked when an action is invoked for a
5985 menu item or button.
5987 With update UI events, you define an event handler to look at the
5988 state of the application and change UI elements accordingly. wxWidgets
5989 will call your handler functions in idle time, so you don't have to
5990 worry where to call this code. In addition to being a clearer and more
5991 declarative method, it also means you don't have to worry whether
5992 you're updating a toolbar or menubar identifier. The same handler can
5993 update a menu item and toolbar button, if the ID values are the same.
5995 Instead of directly manipulating the menu or button, you call
5996 functions in the event object, such as `Check`. wxWidgets will
5997 determine whether such a call has been made, and which UI element to
6000 These events will work for popup menus as well as menubars. Just
6001 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6002 any UI events for the window that owns the menu.
6004 If you find that the overhead of UI update processing is affecting
6005 your application, you can do one or both of the following:
6007 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6008 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6009 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6010 receive update events. No other windows will receive update
6013 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6014 value to set the delay between updates. You may need to call
6015 `wx.Window.UpdateWindowUI` at critical points, for example when
6016 a dialog is about to be shown, in case the user sees a slight
6017 delay before windows are updated.
6019 Note that although events are sent in idle time, defining a EVT_IDLE
6020 handler for a window does not affect this because the events are sent
6021 from an internal idle handler.
6023 wxWidgets tries to optimize update events on some platforms. On
6024 Windows and GTK+, events for menubar items are only sent when the menu
6025 is about to be shown, and not in idle time.
6028 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6029 __repr__
= _swig_repr
6030 def __init__(self
, *args
, **kwargs
):
6032 __init__(self, int commandId=0) -> UpdateUIEvent
6036 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
6037 def GetChecked(*args
, **kwargs
):
6039 GetChecked(self) -> bool
6041 Returns ``True`` if the UI element should be checked.
6043 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6045 def GetEnabled(*args
, **kwargs
):
6047 GetEnabled(self) -> bool
6049 Returns ``True`` if the UI element should be enabled.
6051 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6053 def GetShown(*args
, **kwargs
):
6055 GetShown(self) -> bool
6057 Returns ``True`` if the UI element should be shown.
6059 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6061 def GetText(*args
, **kwargs
):
6063 GetText(self) -> String
6065 Returns the text that should be set for the UI element.
6067 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6069 def GetSetText(*args
, **kwargs
):
6071 GetSetText(self) -> bool
6073 Returns ``True`` if the application has called `SetText`. For
6074 wxWidgets internal use only.
6076 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6078 def GetSetChecked(*args
, **kwargs
):
6080 GetSetChecked(self) -> bool
6082 Returns ``True`` if the application has called `Check`. For wxWidgets
6085 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6087 def GetSetEnabled(*args
, **kwargs
):
6089 GetSetEnabled(self) -> bool
6091 Returns ``True`` if the application has called `Enable`. For wxWidgets
6094 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6096 def GetSetShown(*args
, **kwargs
):
6098 GetSetShown(self) -> bool
6100 Returns ``True`` if the application has called `Show`. For wxWidgets
6103 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6105 def Check(*args
, **kwargs
):
6107 Check(self, bool check)
6109 Check or uncheck the UI element.
6111 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6113 def Enable(*args
, **kwargs
):
6115 Enable(self, bool enable)
6117 Enable or disable the UI element.
6119 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6121 def Show(*args
, **kwargs
):
6123 Show(self, bool show)
6125 Show or hide the UI element.
6127 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6129 def SetText(*args
, **kwargs
):
6131 SetText(self, String text)
6133 Sets the text for this UI element.
6135 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6137 def SetUpdateInterval(*args
, **kwargs
):
6139 SetUpdateInterval(long updateInterval)
6141 Sets the interval between updates in milliseconds. Set to -1 to
6142 disable updates, or to 0 to update as frequently as possible. The
6145 Use this to reduce the overhead of UI update events if your
6146 application has a lot of windows. If you set the value to -1 or
6147 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6148 at appropriate points in your application, such as when a dialog is
6151 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6153 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6154 def GetUpdateInterval(*args
, **kwargs
):
6156 GetUpdateInterval() -> long
6158 Returns the current interval between updates in milliseconds. -1
6159 disables updates, 0 updates as frequently as possible.
6161 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6163 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6164 def CanUpdate(*args
, **kwargs
):
6166 CanUpdate(Window win) -> bool
6168 Returns ``True`` if it is appropriate to update (send UI update events
6171 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6172 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6173 events were last sent in idle time, and the update interval, to
6174 determine whether events should be sent to this window now. By default
6175 this will always return true because the update mode is initially
6176 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6177 events will be sent as often as possible. You can reduce the frequency
6178 that events are sent by changing the mode and/or setting an update
6182 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6184 CanUpdate
= staticmethod(CanUpdate
)
6185 def ResetUpdateTime(*args
, **kwargs
):
6189 Used internally to reset the last-updated time to the current time. It
6190 is assumed that update events are normally sent in idle time, so this
6191 is called at the end of idle processing.
6193 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6195 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6196 def SetMode(*args
, **kwargs
):
6200 Specify how wxWidgets will send update events: to all windows, or only
6201 to those which specify that they will process the events.
6203 The mode may be one of the following values:
6205 ============================= ==========================================
6206 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6207 is the default setting.
6208 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6209 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6211 ============================= ==========================================
6214 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6216 SetMode
= staticmethod(SetMode
)
6217 def GetMode(*args
, **kwargs
):
6221 Returns a value specifying how wxWidgets will send update events: to
6222 all windows, or only to those which specify that they will process the
6225 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6227 GetMode
= staticmethod(GetMode
)
6228 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
6229 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
6230 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
6231 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
6232 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
6234 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6236 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6238 Sets the interval between updates in milliseconds. Set to -1 to
6239 disable updates, or to 0 to update as frequently as possible. The
6242 Use this to reduce the overhead of UI update events if your
6243 application has a lot of windows. If you set the value to -1 or
6244 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6245 at appropriate points in your application, such as when a dialog is
6248 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6250 def UpdateUIEvent_GetUpdateInterval(*args
):
6252 UpdateUIEvent_GetUpdateInterval() -> long
6254 Returns the current interval between updates in milliseconds. -1
6255 disables updates, 0 updates as frequently as possible.
6257 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
6259 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6261 UpdateUIEvent_CanUpdate(Window win) -> bool
6263 Returns ``True`` if it is appropriate to update (send UI update events
6266 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6267 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6268 events were last sent in idle time, and the update interval, to
6269 determine whether events should be sent to this window now. By default
6270 this will always return true because the update mode is initially
6271 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6272 events will be sent as often as possible. You can reduce the frequency
6273 that events are sent by changing the mode and/or setting an update
6277 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6279 def UpdateUIEvent_ResetUpdateTime(*args
):
6281 UpdateUIEvent_ResetUpdateTime()
6283 Used internally to reset the last-updated time to the current time. It
6284 is assumed that update events are normally sent in idle time, so this
6285 is called at the end of idle processing.
6287 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6289 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6291 UpdateUIEvent_SetMode(int mode)
6293 Specify how wxWidgets will send update events: to all windows, or only
6294 to those which specify that they will process the events.
6296 The mode may be one of the following values:
6298 ============================= ==========================================
6299 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6300 is the default setting.
6301 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6302 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6304 ============================= ==========================================
6307 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6309 def UpdateUIEvent_GetMode(*args
):
6311 UpdateUIEvent_GetMode() -> int
6313 Returns a value specifying how wxWidgets will send update events: to
6314 all windows, or only to those which specify that they will process the
6317 return _core_
.UpdateUIEvent_GetMode(*args
)
6319 #---------------------------------------------------------------------------
6321 class SysColourChangedEvent(Event
):
6323 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6324 when the user changes the colour settings using the control
6325 panel. This is only applicable under Windows.
6327 The default event handler for this event propagates the event to child
6328 windows, since Windows only sends the events to top-level windows. If
6329 intercepting this event for a top-level window, remember to call
6330 `Skip` so the the base class handler will still be executed, or to
6331 pass the event on to the window's children explicitly.
6334 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6335 __repr__
= _swig_repr
6336 def __init__(self
, *args
, **kwargs
):
6338 __init__(self) -> SysColourChangedEvent
6342 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6343 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6345 #---------------------------------------------------------------------------
6347 class MouseCaptureChangedEvent(Event
):
6349 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6350 a window that loses its mouse capture. This is called even if
6351 `wx.Window.ReleaseMouse` was called by the application code. Handling
6352 this event allows an application to cater for unexpected capture
6353 releases which might otherwise confuse mouse handling code.
6355 This event is implemented under Windows only.
6357 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6358 __repr__
= _swig_repr
6359 def __init__(self
, *args
, **kwargs
):
6361 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6365 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6366 def GetCapturedWindow(*args
, **kwargs
):
6368 GetCapturedWindow(self) -> Window
6370 Returns the window that gained the capture, or ``None`` if it was a
6371 non-wxWidgets window.
6373 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6375 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6376 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6378 #---------------------------------------------------------------------------
6380 class MouseCaptureLostEvent(Event
):
6382 A mouse capture lost event is sent to a window that obtained mouse
6383 capture, which was subsequently loss due to "external" event, for
6384 example when a dialog box is shown or if another application captures
6387 If this happens, this event is sent to all windows that are on the
6388 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6389 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6390 if the capture changes because of a call to CaptureMouse or
6393 This event is currently emitted under Windows only.
6396 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6397 __repr__
= _swig_repr
6398 def __init__(self
, *args
, **kwargs
):
6400 __init__(self, int winid=0) -> MouseCaptureLostEvent
6402 A mouse capture lost event is sent to a window that obtained mouse
6403 capture, which was subsequently loss due to "external" event, for
6404 example when a dialog box is shown or if another application captures
6407 If this happens, this event is sent to all windows that are on the
6408 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6409 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6410 if the capture changes because of a call to CaptureMouse or
6413 This event is currently emitted under Windows only.
6416 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6417 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6419 #---------------------------------------------------------------------------
6421 class DisplayChangedEvent(Event
):
6423 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6424 resolution has changed.
6426 This event is implemented under Windows only.
6428 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6429 __repr__
= _swig_repr
6430 def __init__(self
, *args
, **kwargs
):
6431 """__init__(self) -> DisplayChangedEvent"""
6432 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6433 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6435 #---------------------------------------------------------------------------
6437 class PaletteChangedEvent(Event
):
6439 An EVT_PALETTE_CHANGED event is sent when the system palette has
6440 changed, thereby giving each window a chance to redo their own to
6443 This event is implemented under Windows only.
6445 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6446 __repr__
= _swig_repr
6447 def __init__(self
, *args
, **kwargs
):
6449 __init__(self, int id=0) -> PaletteChangedEvent
6451 An EVT_PALETTE_CHANGED event is sent when the system palette has
6452 changed, thereby giving each window a chance to redo their own to
6455 This event is implemented under Windows only.
6457 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6458 def SetChangedWindow(*args
, **kwargs
):
6459 """SetChangedWindow(self, Window win)"""
6460 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6462 def GetChangedWindow(*args
, **kwargs
):
6463 """GetChangedWindow(self) -> Window"""
6464 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6466 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6467 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6469 #---------------------------------------------------------------------------
6471 class QueryNewPaletteEvent(Event
):
6473 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6474 focus and should re-do its palette.
6476 This event is implemented under Windows only.
6478 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6479 __repr__
= _swig_repr
6480 def __init__(self
, *args
, **kwargs
):
6482 __init__(self, int winid=0) -> QueryNewPaletteEvent
6486 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6487 def SetPaletteRealized(*args
, **kwargs
):
6489 SetPaletteRealized(self, bool realized)
6491 App should set this if it changes the palette.
6493 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6495 def GetPaletteRealized(*args
, **kwargs
):
6496 """GetPaletteRealized(self) -> bool"""
6497 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6499 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6500 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6502 #---------------------------------------------------------------------------
6504 class NavigationKeyEvent(Event
):
6506 EVT_NAVIGATION_KEY events are used to control moving the focus between
6507 widgets, otherwise known as tab-traversal. You woudl normally not
6508 catch navigation events in applications as there are already
6509 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6510 it useful to send navigation events in certain situations to change
6511 the focus in certain ways, although it's probably easier to just call
6512 `wx.Window.Navigate`.
6514 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6515 __repr__
= _swig_repr
6516 def __init__(self
, *args
, **kwargs
):
6517 """__init__(self) -> NavigationKeyEvent"""
6518 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6519 def GetDirection(*args
, **kwargs
):
6521 GetDirection(self) -> bool
6523 Returns ``True`` if the direction is forward, ``False`` otherwise.
6525 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6527 def SetDirection(*args
, **kwargs
):
6529 SetDirection(self, bool forward)
6531 Specify the direction that the navigation should take. Usually the
6532 difference between using Tab and Shift-Tab.
6534 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6536 def IsWindowChange(*args
, **kwargs
):
6538 IsWindowChange(self) -> bool
6540 Returns ``True`` if window change is allowed.
6542 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6544 def SetWindowChange(*args
, **kwargs
):
6546 SetWindowChange(self, bool ischange)
6548 Specify if the navigation should be able to change parent windows.
6549 For example, changing notebook pages, etc. This is usually implemented
6550 by using Control-Tab.
6552 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6554 def IsFromTab(*args
, **kwargs
):
6556 IsFromTab(self) -> bool
6558 Returns ``True`` if the navigation event is originated from the Tab
6561 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6563 def SetFromTab(*args
, **kwargs
):
6565 SetFromTab(self, bool bIs)
6567 Set to true under MSW if the event was generated using the tab key.
6568 This is required for proper navogation over radio buttons.
6570 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6572 def SetFlags(*args
, **kwargs
):
6574 SetFlags(self, long flags)
6576 Set the navigation flags to a combination of the following:
6578 * wx.NavigationKeyEvent.IsBackward
6579 * wx.NavigationKeyEvent.IsForward
6580 * wx.NavigationKeyEvent.WinChange
6581 * wx.NavigationKeyEvent.FromTab
6584 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6586 def GetCurrentFocus(*args
, **kwargs
):
6588 GetCurrentFocus(self) -> Window
6590 Returns the child window which currenty has the focus. May be
6593 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6595 def SetCurrentFocus(*args
, **kwargs
):
6597 SetCurrentFocus(self, Window win)
6599 Set the window that has the focus.
6601 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6603 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6604 IsForward
= _core_
.NavigationKeyEvent_IsForward
6605 WinChange
= _core_
.NavigationKeyEvent_WinChange
6606 FromTab
= _core_
.NavigationKeyEvent_FromTab
6607 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6608 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6609 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6611 #---------------------------------------------------------------------------
6613 class WindowCreateEvent(CommandEvent
):
6615 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6616 underlying GUI object) exists.
6618 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6619 __repr__
= _swig_repr
6620 def __init__(self
, *args
, **kwargs
):
6622 __init__(self, Window win=None) -> WindowCreateEvent
6624 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6625 underlying GUI object) exists.
6627 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6628 def GetWindow(*args
, **kwargs
):
6630 GetWindow(self) -> Window
6632 Returns the window that this event refers to.
6634 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6636 Window
= property(GetWindow
,doc
="See `GetWindow`")
6637 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6639 class WindowDestroyEvent(CommandEvent
):
6641 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6642 when the GUI window is destroyed.
6644 When a class derived from `wx.Window` is destroyed its destructor will
6645 have already run by the time this event is sent. Therefore this event
6646 will not usually be received at all by the window itself. Since it is
6647 received after the destructor has run, an object should not try to
6648 handle its own wx.WindowDestroyEvent, but it can be used to get
6649 notification of the destruction of another window.
6651 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6652 __repr__
= _swig_repr
6653 def __init__(self
, *args
, **kwargs
):
6655 __init__(self, Window win=None) -> WindowDestroyEvent
6657 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6658 when the GUI window is destroyed.
6660 When a class derived from `wx.Window` is destroyed its destructor will
6661 have already run by the time this event is sent. Therefore this event
6662 will not usually be received at all by the window itself. Since it is
6663 received after the destructor has run, an object should not try to
6664 handle its own wx.WindowDestroyEvent, but it can be used to get
6665 notification of the destruction of another window.
6667 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6668 def GetWindow(*args
, **kwargs
):
6670 GetWindow(self) -> Window
6672 Returns the window that this event refers to.
6674 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6676 Window
= property(GetWindow
,doc
="See `GetWindow`")
6677 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6679 #---------------------------------------------------------------------------
6681 class ContextMenuEvent(CommandEvent
):
6683 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6684 give the application a chance to show a context (popup) menu.
6686 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6687 __repr__
= _swig_repr
6688 def __init__(self
, *args
, **kwargs
):
6690 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6694 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6695 def GetPosition(*args
, **kwargs
):
6697 GetPosition(self) -> Point
6699 Returns the position (in screen coordinants) at which the menu should
6702 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6704 def SetPosition(*args
, **kwargs
):
6706 SetPosition(self, Point pos)
6708 Sets the position at which the menu should be shown.
6710 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6712 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6713 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6715 #---------------------------------------------------------------------------
6717 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6718 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6719 class IdleEvent(Event
):
6721 This class is used for EVT_IDLE events, which are generated and sent
6722 when the application *becomes* idle. In other words, the when the
6723 event queue becomes empty then idle events are sent to all windows (by
6724 default) and as long as none of them call `RequestMore` then there are
6725 no more idle events until after the system event queue has some normal
6726 events and then becomes empty again.
6728 By default, idle events are sent to all windows. If this is causing a
6729 significant overhead in your application, you can call
6730 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6731 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6732 which should receive idle events. Then idle events will only be sent
6733 to those windows and not to any others.
6735 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6736 __repr__
= _swig_repr
6737 def __init__(self
, *args
, **kwargs
):
6739 __init__(self) -> IdleEvent
6743 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6744 def RequestMore(*args
, **kwargs
):
6746 RequestMore(self, bool needMore=True)
6748 Tells wxWidgets that more processing is required. This function can be
6749 called by an EVT_IDLE handler for a window to indicate that the
6750 application should forward the EVT_IDLE event once more to the
6751 application windows. If no window calls this function during its
6752 EVT_IDLE handler, then the application will remain in a passive event
6753 loop until a new event is posted to the application by the windowing
6756 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6758 def MoreRequested(*args
, **kwargs
):
6760 MoreRequested(self) -> bool
6762 Returns ``True`` if the OnIdle function processing this event
6763 requested more processing time.
6765 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6767 def SetMode(*args
, **kwargs
):
6771 Static method for specifying how wxWidgets will send idle events: to
6772 all windows, or only to those which specify that they will process the
6775 The mode can be one of the following values:
6777 ========================= ========================================
6778 wx.IDLE_PROCESS_ALL Send idle events to all windows
6779 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6780 the wx.WS_EX_PROCESS_IDLE extra style
6782 ========================= ========================================
6785 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6787 SetMode
= staticmethod(SetMode
)
6788 def GetMode(*args
, **kwargs
):
6792 Static method returning a value specifying how wxWidgets will send
6793 idle events: to all windows, or only to those which specify that they
6794 will process the events.
6796 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6798 GetMode
= staticmethod(GetMode
)
6799 def CanSend(*args
, **kwargs
):
6801 CanSend(Window win) -> bool
6803 Returns ``True`` if it is appropriate to send idle events to this
6806 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6807 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6808 events should be sent to this window now. By default this will always
6809 return ``True`` because the update mode is initially
6810 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6811 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6813 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6815 CanSend
= staticmethod(CanSend
)
6816 _core_
.IdleEvent_swigregister(IdleEvent
)
6818 def IdleEvent_SetMode(*args
, **kwargs
):
6820 IdleEvent_SetMode(int mode)
6822 Static method for specifying how wxWidgets will send idle events: to
6823 all windows, or only to those which specify that they will process the
6826 The mode can be one of the following values:
6828 ========================= ========================================
6829 wx.IDLE_PROCESS_ALL Send idle events to all windows
6830 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6831 the wx.WS_EX_PROCESS_IDLE extra style
6833 ========================= ========================================
6836 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6838 def IdleEvent_GetMode(*args
):
6840 IdleEvent_GetMode() -> int
6842 Static method returning a value specifying how wxWidgets will send
6843 idle events: to all windows, or only to those which specify that they
6844 will process the events.
6846 return _core_
.IdleEvent_GetMode(*args
)
6848 def IdleEvent_CanSend(*args
, **kwargs
):
6850 IdleEvent_CanSend(Window win) -> bool
6852 Returns ``True`` if it is appropriate to send idle events to this
6855 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6856 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6857 events should be sent to this window now. By default this will always
6858 return ``True`` because the update mode is initially
6859 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6860 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6862 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6864 #---------------------------------------------------------------------------
6866 class ClipboardTextEvent(CommandEvent
):
6868 A Clipboard Text event is sent when a window intercepts a text
6869 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6870 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6871 popup menu command, etc. NOTE : under windows these events are *NOT*
6872 generated automatically for a Rich Edit text control.
6874 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6875 __repr__
= _swig_repr
6876 def __init__(self
, *args
, **kwargs
):
6878 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6880 A Clipboard Text event is sent when a window intercepts a text
6881 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6882 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6883 popup menu command, etc. NOTE : under windows these events are *NOT*
6884 generated automatically for a Rich Edit text control.
6886 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6887 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6889 #---------------------------------------------------------------------------
6891 class PyEvent(Event
):
6893 wx.PyEvent can be used as a base class for implementing custom event
6894 types in Python. You should derived from this class instead of
6895 `wx.Event` because this class is Python-aware and is able to transport
6896 its Python bits safely through the wxWidgets event system and have
6897 them still be there when the event handler is invoked.
6899 :see: `wx.PyCommandEvent`
6902 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6903 __repr__
= _swig_repr
6904 def __init__(self
, *args
, **kwargs
):
6905 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6906 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6909 __swig_destroy__
= _core_
.delete_PyEvent
6910 __del__
= lambda self
: None;
6911 def _SetSelf(*args
, **kwargs
):
6912 """_SetSelf(self, PyObject self)"""
6913 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6915 def _GetSelf(*args
, **kwargs
):
6916 """_GetSelf(self) -> PyObject"""
6917 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6919 _core_
.PyEvent_swigregister(PyEvent
)
6921 class PyCommandEvent(CommandEvent
):
6923 wx.PyCommandEvent can be used as a base class for implementing custom
6924 event types in Python, where the event shoudl travel up to parent
6925 windows looking for a handler. You should derived from this class
6926 instead of `wx.CommandEvent` because this class is Python-aware and is
6927 able to transport its Python bits safely through the wxWidgets event
6928 system and have them still be there when the event handler is invoked.
6933 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6934 __repr__
= _swig_repr
6935 def __init__(self
, *args
, **kwargs
):
6936 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6937 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6940 __swig_destroy__
= _core_
.delete_PyCommandEvent
6941 __del__
= lambda self
: None;
6942 def _SetSelf(*args
, **kwargs
):
6943 """_SetSelf(self, PyObject self)"""
6944 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6946 def _GetSelf(*args
, **kwargs
):
6947 """_GetSelf(self) -> PyObject"""
6948 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6950 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6952 class DateEvent(CommandEvent
):
6954 This event class holds information about a date change event and is
6955 used together with `wx.DatePickerCtrl`. It also serves as a base class
6956 for `wx.calendar.CalendarEvent`. Bind these event types with
6959 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6960 __repr__
= _swig_repr
6961 def __init__(self
, *args
, **kwargs
):
6962 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6963 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6964 def GetDate(*args
, **kwargs
):
6966 GetDate(self) -> DateTime
6970 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6972 def SetDate(*args
, **kwargs
):
6974 SetDate(self, DateTime date)
6976 Sets the date carried by the event, normally only used by the library
6979 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6981 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6982 _core_
.DateEvent_swigregister(DateEvent
)
6984 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6985 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6987 #---------------------------------------------------------------------------
6989 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6990 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6991 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6992 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6993 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6994 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6995 class PyApp(EvtHandler
):
6997 The ``wx.PyApp`` class is an *implementation detail*, please use the
6998 `wx.App` class (or some other derived class) instead.
7000 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7001 __repr__
= _swig_repr
7002 def __init__(self
, *args
, **kwargs
):
7004 __init__(self) -> PyApp
7006 Create a new application object, starting the bootstrap process.
7008 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
7009 self
._setCallbackInfo
(self
, PyApp
, False)
7010 self
._setOORInfo
(self
, False)
7012 __swig_destroy__
= _core_
.delete_PyApp
7013 __del__
= lambda self
: None;
7014 def _setCallbackInfo(*args
, **kwargs
):
7015 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
7016 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
7018 def GetAppName(*args
, **kwargs
):
7020 GetAppName(self) -> String
7022 Get the application name.
7024 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
7026 def SetAppName(*args
, **kwargs
):
7028 SetAppName(self, String name)
7030 Set the application name. This value may be used automatically by
7031 `wx.Config` and such.
7033 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
7035 def GetClassName(*args
, **kwargs
):
7037 GetClassName(self) -> String
7039 Get the application's class name.
7041 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
7043 def SetClassName(*args
, **kwargs
):
7045 SetClassName(self, String name)
7047 Set the application's class name. This value may be used for
7048 X-resources if applicable for the platform
7050 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
7052 def GetVendorName(*args
, **kwargs
):
7054 GetVendorName(self) -> String
7056 Get the application's vendor name.
7058 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
7060 def SetVendorName(*args
, **kwargs
):
7062 SetVendorName(self, String name)
7064 Set the application's vendor name. This value may be used
7065 automatically by `wx.Config` and such.
7067 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
7069 def GetTraits(*args
, **kwargs
):
7071 GetTraits(self) -> wxAppTraits
7073 Return (and create if necessary) the app traits object to which we
7074 delegate for everything which either should be configurable by the
7075 user (then he can change the default behaviour simply by overriding
7076 CreateTraits() and returning his own traits object) or which is
7077 GUI/console dependent as then wx.AppTraits allows us to abstract the
7078 differences behind the common facade.
7080 :todo: Add support for overriding CreateAppTraits in wxPython.
7082 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
7084 def ProcessPendingEvents(*args
, **kwargs
):
7086 ProcessPendingEvents(self)
7088 Process all events in the Pending Events list -- it is necessary to
7089 call this function to process posted events. This normally happens
7090 during each event loop iteration.
7092 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
7094 def Yield(*args
, **kwargs
):
7096 Yield(self, bool onlyIfNeeded=False) -> bool
7098 Process all currently pending events right now, instead of waiting
7099 until return to the event loop. It is an error to call ``Yield``
7100 recursively unless the value of ``onlyIfNeeded`` is True.
7102 :warning: This function is dangerous as it can lead to unexpected
7103 reentrancies (i.e. when called from an event handler it may
7104 result in calling the same event handler again), use with
7105 extreme care or, better, don't use at all!
7107 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7110 return _core_
.PyApp_Yield(*args
, **kwargs
)
7112 def WakeUpIdle(*args
, **kwargs
):
7116 Make sure that idle events are sent again.
7117 :see: `wx.WakeUpIdle`
7119 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
7121 def IsMainLoopRunning(*args
, **kwargs
):
7123 IsMainLoopRunning() -> bool
7125 Returns True if we're running the main loop, i.e. if the events can
7126 currently be dispatched.
7128 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
7130 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
7131 def MainLoop(*args
, **kwargs
):
7133 MainLoop(self) -> int
7135 Execute the main GUI loop, the function doesn't normally return until
7136 all top level windows have been closed and destroyed.
7138 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
7140 def Exit(*args
, **kwargs
):
7144 Exit the main loop thus terminating the application.
7147 return _core_
.PyApp_Exit(*args
, **kwargs
)
7149 def GetLayoutDirection(*args
, **kwargs
):
7151 GetLayoutDirection(self) -> int
7153 Return the layout direction for the current locale.
7155 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
7157 def ExitMainLoop(*args
, **kwargs
):
7161 Exit the main GUI loop during the next iteration of the main
7162 loop, (i.e. it does not stop the program immediately!)
7164 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
7166 def Pending(*args
, **kwargs
):
7168 Pending(self) -> bool
7170 Returns True if there are unprocessed events in the event queue.
7172 return _core_
.PyApp_Pending(*args
, **kwargs
)
7174 def Dispatch(*args
, **kwargs
):
7176 Dispatch(self) -> bool
7178 Process the first event in the event queue (blocks until an event
7179 appears if there are none currently)
7181 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
7183 def ProcessIdle(*args
, **kwargs
):
7185 ProcessIdle(self) -> bool
7187 Called from the MainLoop when the application becomes idle (there are
7188 no pending events) and sends a `wx.IdleEvent` to all interested
7189 parties. Returns True if more idle events are needed, False if not.
7191 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
7193 def SendIdleEvents(*args
, **kwargs
):
7195 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7197 Send idle event to window and all subwindows. Returns True if more
7198 idle time is requested.
7200 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
7202 def IsActive(*args
, **kwargs
):
7204 IsActive(self) -> bool
7206 Return True if our app has focus.
7208 return _core_
.PyApp_IsActive(*args
, **kwargs
)
7210 def SetTopWindow(*args
, **kwargs
):
7212 SetTopWindow(self, Window win)
7214 Set the *main* top level window
7216 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
7218 def GetTopWindow(*args
, **kwargs
):
7220 GetTopWindow(self) -> Window
7222 Return the *main* top level window (if it hadn't been set previously
7223 with SetTopWindow(), will return just some top level window and, if
7224 there not any, will return None)
7226 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
7228 def SetExitOnFrameDelete(*args
, **kwargs
):
7230 SetExitOnFrameDelete(self, bool flag)
7232 Control the exit behaviour: by default, the program will exit the main
7233 loop (and so, usually, terminate) when the last top-level program
7234 window is deleted. Beware that if you disable this behaviour (with
7235 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7236 explicitly from somewhere.
7238 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
7240 def GetExitOnFrameDelete(*args
, **kwargs
):
7242 GetExitOnFrameDelete(self) -> bool
7244 Get the current exit behaviour setting.
7246 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
7248 def SetUseBestVisual(*args
, **kwargs
):
7250 SetUseBestVisual(self, bool flag)
7252 Set whether the app should try to use the best available visual on
7253 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7255 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
7257 def GetUseBestVisual(*args
, **kwargs
):
7259 GetUseBestVisual(self) -> bool
7261 Get current UseBestVisual setting.
7263 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
7265 def SetPrintMode(*args
, **kwargs
):
7266 """SetPrintMode(self, int mode)"""
7267 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
7269 def GetPrintMode(*args
, **kwargs
):
7270 """GetPrintMode(self) -> int"""
7271 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
7273 def SetAssertMode(*args
, **kwargs
):
7275 SetAssertMode(self, int mode)
7277 Set the OnAssert behaviour for debug and hybrid builds.
7279 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
7281 def GetAssertMode(*args
, **kwargs
):
7283 GetAssertMode(self) -> int
7285 Get the current OnAssert behaviour setting.
7287 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
7289 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7290 """GetMacSupportPCMenuShortcuts() -> bool"""
7291 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7293 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
7294 def GetMacAboutMenuItemId(*args
, **kwargs
):
7295 """GetMacAboutMenuItemId() -> long"""
7296 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
7298 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
7299 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
7300 """GetMacPreferencesMenuItemId() -> long"""
7301 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
7303 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
7304 def GetMacExitMenuItemId(*args
, **kwargs
):
7305 """GetMacExitMenuItemId() -> long"""
7306 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
7308 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
7309 def GetMacHelpMenuTitleName(*args
, **kwargs
):
7310 """GetMacHelpMenuTitleName() -> String"""
7311 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
7313 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
7314 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7315 """SetMacSupportPCMenuShortcuts(bool val)"""
7316 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7318 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
7319 def SetMacAboutMenuItemId(*args
, **kwargs
):
7320 """SetMacAboutMenuItemId(long val)"""
7321 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7323 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
7324 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
7325 """SetMacPreferencesMenuItemId(long val)"""
7326 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7328 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
7329 def SetMacExitMenuItemId(*args
, **kwargs
):
7330 """SetMacExitMenuItemId(long val)"""
7331 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7333 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
7334 def SetMacHelpMenuTitleName(*args
, **kwargs
):
7335 """SetMacHelpMenuTitleName(String val)"""
7336 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7338 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
7339 def _BootstrapApp(*args
, **kwargs
):
7343 For internal use only
7345 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
7347 def GetComCtl32Version(*args
, **kwargs
):
7349 GetComCtl32Version() -> int
7351 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7352 it wasn't found at all. Raises an exception on non-Windows platforms.
7354 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7356 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7357 def IsDisplayAvailable(*args
, **kwargs
):
7359 IsDisplayAvailable() -> bool
7361 Tests if it is possible to create a GUI in the current environment.
7362 This will mean different things on the different platforms.
7364 * On X Windows systems this function will return ``False`` if it is
7365 not able to open a connection to the X display, which can happen
7366 if $DISPLAY is not set, or is not set correctly.
7368 * On Mac OS X a ``False`` return value will mean that wx is not
7369 able to access the window manager, which can happen if logged in
7370 remotely or if running from the normal version of python instead
7371 of the framework version, (i.e., pythonw.)
7376 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7378 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7379 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7380 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7381 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7382 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7383 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7384 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7385 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7386 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7387 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7388 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7389 Active
= property(IsActive
)
7390 _core_
.PyApp_swigregister(PyApp
)
7392 def PyApp_IsMainLoopRunning(*args
):
7394 PyApp_IsMainLoopRunning() -> bool
7396 Returns True if we're running the main loop, i.e. if the events can
7397 currently be dispatched.
7399 return _core_
.PyApp_IsMainLoopRunning(*args
)
7401 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7402 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7403 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7405 def PyApp_GetMacAboutMenuItemId(*args
):
7406 """PyApp_GetMacAboutMenuItemId() -> long"""
7407 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7409 def PyApp_GetMacPreferencesMenuItemId(*args
):
7410 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7411 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7413 def PyApp_GetMacExitMenuItemId(*args
):
7414 """PyApp_GetMacExitMenuItemId() -> long"""
7415 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7417 def PyApp_GetMacHelpMenuTitleName(*args
):
7418 """PyApp_GetMacHelpMenuTitleName() -> String"""
7419 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7421 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7422 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7423 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7425 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7426 """PyApp_SetMacAboutMenuItemId(long val)"""
7427 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7429 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7430 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7431 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7433 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7434 """PyApp_SetMacExitMenuItemId(long val)"""
7435 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7437 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7438 """PyApp_SetMacHelpMenuTitleName(String val)"""
7439 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7441 def PyApp_GetComCtl32Version(*args
):
7443 PyApp_GetComCtl32Version() -> int
7445 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7446 it wasn't found at all. Raises an exception on non-Windows platforms.
7448 return _core_
.PyApp_GetComCtl32Version(*args
)
7450 def PyApp_IsDisplayAvailable(*args
):
7452 PyApp_IsDisplayAvailable() -> bool
7454 Tests if it is possible to create a GUI in the current environment.
7455 This will mean different things on the different platforms.
7457 * On X Windows systems this function will return ``False`` if it is
7458 not able to open a connection to the X display, which can happen
7459 if $DISPLAY is not set, or is not set correctly.
7461 * On Mac OS X a ``False`` return value will mean that wx is not
7462 able to access the window manager, which can happen if logged in
7463 remotely or if running from the normal version of python instead
7464 of the framework version, (i.e., pythonw.)
7469 return _core_
.PyApp_IsDisplayAvailable(*args
)
7471 #---------------------------------------------------------------------------
7478 Force an exit of the application. Convenience for wx.GetApp().Exit()
7480 return _core_
.Exit(*args
)
7486 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7488 return _core_
.Yield(*args
)
7490 def YieldIfNeeded(*args
):
7492 YieldIfNeeded() -> bool
7494 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7496 return _core_
.YieldIfNeeded(*args
)
7498 def SafeYield(*args
, **kwargs
):
7500 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7502 This function is similar to `wx.Yield`, except that it disables the
7503 user input to all program windows before calling `wx.Yield` and
7504 re-enables it again afterwards. If ``win`` is not None, this window
7505 will remain enabled, allowing the implementation of some limited user
7508 :Returns: the result of the call to `wx.Yield`.
7510 return _core_
.SafeYield(*args
, **kwargs
)
7512 def WakeUpIdle(*args
):
7516 Cause the message queue to become empty again, so idle events will be
7519 return _core_
.WakeUpIdle(*args
)
7521 def PostEvent(*args
, **kwargs
):
7523 PostEvent(EvtHandler dest, Event event)
7525 Send an event to a window or other wx.EvtHandler to be processed
7528 return _core_
.PostEvent(*args
, **kwargs
)
7530 def App_CleanUp(*args
):
7534 For internal use only, it is used to cleanup after wxWidgets when
7537 return _core_
.App_CleanUp(*args
)
7543 Return a reference to the current wx.App object.
7545 return _core_
.GetApp(*args
)
7547 def SetDefaultPyEncoding(*args
, **kwargs
):
7549 SetDefaultPyEncoding(string encoding)
7551 Sets the encoding that wxPython will use when it needs to convert a
7552 Python string or unicode object to or from a wxString.
7554 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7555 but please be aware that the default encoding within the same locale
7556 may be slightly different on different platforms. For example, please
7557 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7558 between the common latin/roman encodings.
7560 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7562 def GetDefaultPyEncoding(*args
):
7564 GetDefaultPyEncoding() -> string
7566 Gets the current encoding that wxPython will use when it needs to
7567 convert a Python string or unicode object to or from a wxString.
7569 return _core_
.GetDefaultPyEncoding(*args
)
7570 #----------------------------------------------------------------------
7572 class PyOnDemandOutputWindow
:
7574 A class that can be used for redirecting Python's stdout and
7575 stderr streams. It will do nothing until something is wrriten to
7576 the stream at which point it will create a Frame with a text area
7577 and write the text there.
7579 def __init__(self
, title
= "wxPython: stdout/stderr"):
7582 self
.pos
= wx
.DefaultPosition
7583 self
.size
= (450, 300)
7586 def SetParent(self
, parent
):
7587 """Set the window to be used as the popup Frame's parent."""
7588 self
.parent
= parent
7591 def CreateOutputWindow(self
, st
):
7592 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7593 style
=wx
.DEFAULT_FRAME_STYLE
)
7594 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7595 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7596 self
.text
.AppendText(st
)
7597 self
.frame
.Show(True)
7598 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7601 def OnCloseWindow(self
, event
):
7602 if self
.frame
is not None:
7603 self
.frame
.Destroy()
7608 # These methods provide the file-like output behaviour.
7609 def write(self
, text
):
7611 Create the output window if needed and write the string to it.
7612 If not called in the context of the gui thread then uses
7613 CallAfter to do the work there.
7615 if self
.frame
is None:
7616 if not wx
.Thread_IsMain():
7617 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7619 self
.CreateOutputWindow(text
)
7621 if not wx
.Thread_IsMain():
7622 wx
.CallAfter(self
.text
.AppendText
, text
)
7624 self
.text
.AppendText(text
)
7628 if self
.frame
is not None:
7629 wx
.CallAfter(self
.frame
.Close
)
7637 #----------------------------------------------------------------------
7639 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7641 class App(wx
.PyApp
):
7643 The ``wx.App`` class represents the application and is used to:
7645 * bootstrap the wxPython system and initialize the underlying
7647 * set and get application-wide properties
7648 * implement the windowing system main message or event loop,
7649 and to dispatch events to window instances
7652 Every application must have a ``wx.App`` instance, and all
7653 creation of UI objects should be delayed until after the
7654 ``wx.App`` object has been created in order to ensure that the gui
7655 platform and wxWidgets have been fully initialized.
7657 Normally you would derive from this class and implement an
7658 ``OnInit`` method that creates a frame and then calls
7659 ``self.SetTopWindow(frame)``.
7661 :see: `wx.PySimpleApp` for a simpler app class that can be used
7665 outputWindowClass
= PyOnDemandOutputWindow
7667 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7668 useBestVisual
=False, clearSigInt
=True):
7670 Construct a ``wx.App`` object.
7672 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7673 redirected? Defaults to True on Windows and Mac, False
7674 otherwise. If `filename` is None then output will be
7675 redirected to a window that pops up as needed. (You can
7676 control what kind of window is created for the output by
7677 resetting the class variable ``outputWindowClass`` to a
7678 class of your choosing.)
7680 :param filename: The name of a file to redirect output to, if
7683 :param useBestVisual: Should the app try to use the best
7684 available visual provided by the system (only relevant on
7685 systems that have more than one visual.) This parameter
7686 must be used instead of calling `SetUseBestVisual` later
7687 on because it must be set before the underlying GUI
7688 toolkit is initialized.
7690 :param clearSigInt: Should SIGINT be cleared? This allows the
7691 app to terminate upon a Ctrl-C in the console like other
7694 :note: You should override OnInit to do applicaition
7695 initialization to ensure that the system, toolkit and
7696 wxWidgets are fully initialized.
7699 wx
.PyApp
.__init
__(self
)
7701 # make sure we can create a GUI
7702 if not self
.IsDisplayAvailable():
7704 if wx
.Platform
== "__WXMAC__":
7705 msg
= """This program needs access to the screen.
7706 Please run with 'pythonw', not 'python', and only when you are logged
7707 in on the main display of your Mac."""
7709 elif wx
.Platform
== "__WXGTK__":
7710 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7713 msg
= "Unable to create GUI"
7714 # TODO: more description is needed for wxMSW...
7716 raise SystemExit(msg
)
7718 # This has to be done before OnInit
7719 self
.SetUseBestVisual(useBestVisual
)
7721 # Set the default handler for SIGINT. This fixes a problem
7722 # where if Ctrl-C is pressed in the console that started this
7723 # app then it will not appear to do anything, (not even send
7724 # KeyboardInterrupt???) but will later segfault on exit. By
7725 # setting the default handler then the app will exit, as
7726 # expected (depending on platform.)
7730 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7734 # Save and redirect the stdio to a window?
7735 self
.stdioWin
= None
7736 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7738 self
.RedirectStdio(filename
)
7740 # Use Python's install prefix as the default
7741 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7743 # This finishes the initialization of wxWindows and then calls
7744 # the OnInit that should be present in the derived class
7745 self
._BootstrapApp
()
7748 def OnPreInit(self
):
7750 Things that must be done after _BootstrapApp has done its
7751 thing, but would be nice if they were already done by the time
7752 that OnInit is called.
7754 wx
.StockGDI
._initStockObjects
()
7757 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7758 self
.RestoreStdio() # Just in case the MainLoop was overridden
7762 self
.this
.own(False)
7763 wx
.PyApp
.Destroy(self
)
7765 def SetTopWindow(self
, frame
):
7766 """Set the \"main\" top level window"""
7768 self
.stdioWin
.SetParent(frame
)
7769 wx
.PyApp
.SetTopWindow(self
, frame
)
7773 """Execute the main GUI event loop"""
7774 wx
.PyApp
.MainLoop(self
)
7778 def RedirectStdio(self
, filename
=None):
7779 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7781 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7783 self
.stdioWin
= self
.outputWindowClass()
7784 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7787 def RestoreStdio(self
):
7789 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7794 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7796 Set the title, position and/or size of the output window if
7797 the stdio has been redirected. This should be called before
7798 any output would cause the output window to be created.
7801 if title
is not None:
7802 self
.stdioWin
.title
= title
7804 self
.stdioWin
.pos
= pos
7805 if size
is not None:
7806 self
.stdioWin
.size
= size
7811 # change from wx.PyApp_XX to wx.App_XX
7812 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7813 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7814 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7815 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7816 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7817 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7818 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7819 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7820 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7821 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7822 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7824 #----------------------------------------------------------------------------
7826 class PySimpleApp(wx
.App
):
7828 A simple application class. You can just create one of these and
7829 then then make your top level windows later, and not have to worry
7830 about OnInit. For example::
7832 app = wx.PySimpleApp()
7833 frame = wx.Frame(None, title='Hello World')
7840 def __init__(self
, redirect
=False, filename
=None,
7841 useBestVisual
=False, clearSigInt
=True):
7843 :see: `wx.App.__init__`
7845 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7852 # Is anybody using this one?
7853 class PyWidgetTester(wx
.App
):
7854 def __init__(self
, size
= (250, 100)):
7856 wx
.App
.__init
__(self
, 0)
7859 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7860 self
.SetTopWindow(self
.frame
)
7863 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7864 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7865 self
.frame
.Show(True)
7867 #----------------------------------------------------------------------------
7868 # DO NOT hold any other references to this object. This is how we
7869 # know when to cleanup system resources that wxWidgets is holding. When
7870 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7871 # goes to zero and it calls the wx.App_CleanUp function.
7873 class __wxPyCleanup
:
7875 self
.cleanup
= _core_
.App_CleanUp
7879 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7881 ## # another possible solution, but it gets called too early...
7883 ## atexit.register(_core_.wxApp_CleanUp)
7886 #----------------------------------------------------------------------------
7888 #---------------------------------------------------------------------------
7890 class EventLoop(object):
7891 """Proxy of C++ EventLoop class"""
7892 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7893 __repr__
= _swig_repr
7894 def __init__(self
, *args
, **kwargs
):
7895 """__init__(self) -> EventLoop"""
7896 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7897 __swig_destroy__
= _core_
.delete_EventLoop
7898 __del__
= lambda self
: None;
7899 def Run(*args
, **kwargs
):
7900 """Run(self) -> int"""
7901 return _core_
.EventLoop_Run(*args
, **kwargs
)
7903 def Exit(*args
, **kwargs
):
7904 """Exit(self, int rc=0)"""
7905 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7907 def Pending(*args
, **kwargs
):
7908 """Pending(self) -> bool"""
7909 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7911 def Dispatch(*args
, **kwargs
):
7912 """Dispatch(self) -> bool"""
7913 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7915 def IsRunning(*args
, **kwargs
):
7916 """IsRunning(self) -> bool"""
7917 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7919 def GetActive(*args
, **kwargs
):
7920 """GetActive() -> EventLoop"""
7921 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7923 GetActive
= staticmethod(GetActive
)
7924 def SetActive(*args
, **kwargs
):
7925 """SetActive(EventLoop loop)"""
7926 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7928 SetActive
= staticmethod(SetActive
)
7929 _core_
.EventLoop_swigregister(EventLoop
)
7931 def EventLoop_GetActive(*args
):
7932 """EventLoop_GetActive() -> EventLoop"""
7933 return _core_
.EventLoop_GetActive(*args
)
7935 def EventLoop_SetActive(*args
, **kwargs
):
7936 """EventLoop_SetActive(EventLoop loop)"""
7937 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7939 class EventLoopActivator(object):
7940 """Proxy of C++ EventLoopActivator class"""
7941 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7942 __repr__
= _swig_repr
7943 def __init__(self
, *args
, **kwargs
):
7944 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7945 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7946 __swig_destroy__
= _core_
.delete_EventLoopActivator
7947 __del__
= lambda self
: None;
7948 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7950 #---------------------------------------------------------------------------
7952 ACCEL_ALT
= _core_
.ACCEL_ALT
7953 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7954 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7955 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7956 ACCEL_CMD
= _core_
.ACCEL_CMD
7957 class AcceleratorEntry(object):
7959 A class used to define items in an `wx.AcceleratorTable`. wxPython
7960 programs can choose to use wx.AcceleratorEntry objects, but using a
7961 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7962 as well. See `__init__` for of the tuple values.
7964 :see: `wx.AcceleratorTable`
7966 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7967 __repr__
= _swig_repr
7968 def __init__(self
, *args
, **kwargs
):
7970 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7972 Construct a wx.AcceleratorEntry.
7974 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7975 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7976 __del__
= lambda self
: None;
7977 def Set(*args
, **kwargs
):
7979 Set(self, int flags, int keyCode, int cmd)
7981 (Re)set the attributes of a wx.AcceleratorEntry.
7984 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7986 def Create(*args
, **kwargs
):
7988 Create(String str) -> AcceleratorEntry
7990 Create accelerator corresponding to the specified string, or None if
7991 it coulnd't be parsed.
7993 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7995 Create
= staticmethod(Create
)
7996 def GetFlags(*args
, **kwargs
):
7998 GetFlags(self) -> int
8000 Get the AcceleratorEntry's flags.
8002 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
8004 def GetKeyCode(*args
, **kwargs
):
8006 GetKeyCode(self) -> int
8008 Get the AcceleratorEntry's keycode.
8010 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8012 def GetCommand(*args
, **kwargs
):
8014 GetCommand(self) -> int
8016 Get the AcceleratorEntry's command ID.
8018 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8020 def IsOk(*args
, **kwargs
):
8021 """IsOk(self) -> bool"""
8022 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
8024 def ToString(*args
, **kwargs
):
8026 ToString(self) -> String
8028 Returns a string representation for the this accelerator. The string
8029 is formatted using the <flags>-<keycode> format where <flags> maybe a
8030 hyphen-separed list of "shift|alt|ctrl"
8033 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
8035 def FromString(*args
, **kwargs
):
8037 FromString(self, String str) -> bool
8039 Returns true if the given string correctly initialized this object.
8041 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
8043 Command
= property(GetCommand
,doc
="See `GetCommand`")
8044 Flags
= property(GetFlags
,doc
="See `GetFlags`")
8045 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
8046 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
8048 def AcceleratorEntry_Create(*args
, **kwargs
):
8050 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8052 Create accelerator corresponding to the specified string, or None if
8053 it coulnd't be parsed.
8055 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8057 class AcceleratorTable(Object
):
8059 An accelerator table allows the application to specify a table of
8060 keyboard shortcuts for menus or other commands. On Windows, menu or
8061 button commands are supported; on GTK, only menu commands are
8064 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8065 __repr__
= _swig_repr
8066 def __init__(self
, *args
, **kwargs
):
8068 __init__(entries) -> AcceleratorTable
8070 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8071 items or or of 3-tuples (flags, keyCode, cmdID)
8073 :see: `wx.AcceleratorEntry`
8075 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
8076 __swig_destroy__
= _core_
.delete_AcceleratorTable
8077 __del__
= lambda self
: None;
8078 def IsOk(*args
, **kwargs
):
8079 """IsOk(self) -> bool"""
8080 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
8083 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
8086 def GetAccelFromString(*args
, **kwargs
):
8087 """GetAccelFromString(String label) -> AcceleratorEntry"""
8088 return _core_
.GetAccelFromString(*args
, **kwargs
)
8089 #---------------------------------------------------------------------------
8091 class VisualAttributes(object):
8092 """struct containing all the visual attributes of a control"""
8093 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8094 __repr__
= _swig_repr
8095 def __init__(self
, *args
, **kwargs
):
8097 __init__(self) -> VisualAttributes
8099 struct containing all the visual attributes of a control
8101 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
8102 __swig_destroy__
= _core_
.delete_VisualAttributes
8103 __del__
= lambda self
: None;
8104 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
8105 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
8106 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
8107 _core_
.VisualAttributes_swigregister(VisualAttributes
)
8108 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8109 PanelNameStr
= cvar
.PanelNameStr
8111 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8112 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8113 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8114 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8115 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8116 class Window(EvtHandler
):
8118 wx.Window is the base class for all windows and represents any visible
8119 object on the screen. All controls, top level windows and so on are
8120 wx.Windows. Sizers and device contexts are not however, as they don't
8121 appear on screen themselves.
8124 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8125 __repr__
= _swig_repr
8126 def __init__(self
, *args
, **kwargs
):
8128 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8129 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8131 Construct and show a generic Window.
8133 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
8134 self
._setOORInfo
(self
)
8136 def Create(*args
, **kwargs
):
8138 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8139 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8141 Create the GUI part of the Window for 2-phase creation mode.
8143 return _core_
.Window_Create(*args
, **kwargs
)
8145 def Close(*args
, **kwargs
):
8147 Close(self, bool force=False) -> bool
8149 This function simply generates a EVT_CLOSE event whose handler usually
8150 tries to close the window. It doesn't close the window itself,
8151 however. If force is False (the default) then the window's close
8152 handler will be allowed to veto the destruction of the window.
8154 return _core_
.Window_Close(*args
, **kwargs
)
8156 def Destroy(*args
, **kwargs
):
8158 Destroy(self) -> bool
8160 Destroys the window safely. Frames and dialogs are not destroyed
8161 immediately when this function is called -- they are added to a list
8162 of windows to be deleted on idle time, when all the window's events
8163 have been processed. This prevents problems with events being sent to
8164 non-existent windows.
8166 Returns True if the window has either been successfully deleted, or it
8167 has been added to the list of windows pending real deletion.
8169 args
[0].this
.own(False)
8170 return _core_
.Window_Destroy(*args
, **kwargs
)
8172 def DestroyChildren(*args
, **kwargs
):
8174 DestroyChildren(self) -> bool
8176 Destroys all children of a window. Called automatically by the
8179 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8181 def IsBeingDeleted(*args
, **kwargs
):
8183 IsBeingDeleted(self) -> bool
8185 Is the window in the process of being deleted?
8187 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8189 def SetLabel(*args
, **kwargs
):
8191 SetLabel(self, String label)
8193 Set the text which the window shows in its label if applicable.
8195 return _core_
.Window_SetLabel(*args
, **kwargs
)
8197 def GetLabel(*args
, **kwargs
):
8199 GetLabel(self) -> String
8201 Generic way of getting a label from any window, for identification
8202 purposes. The interpretation of this function differs from class to
8203 class. For frames and dialogs, the value returned is the title. For
8204 buttons or static text controls, it is the button text. This function
8205 can be useful for meta-programs such as testing tools or special-needs
8206 access programs)which need to identify windows by name.
8208 return _core_
.Window_GetLabel(*args
, **kwargs
)
8210 def SetName(*args
, **kwargs
):
8212 SetName(self, String name)
8214 Sets the window's name. The window name is used for ressource setting
8215 in X, it is not the same as the window title/label
8217 return _core_
.Window_SetName(*args
, **kwargs
)
8219 def GetName(*args
, **kwargs
):
8221 GetName(self) -> String
8223 Returns the windows name. This name is not guaranteed to be unique;
8224 it is up to the programmer to supply an appropriate name in the window
8225 constructor or via wx.Window.SetName.
8227 return _core_
.Window_GetName(*args
, **kwargs
)
8229 def SetWindowVariant(*args
, **kwargs
):
8231 SetWindowVariant(self, int variant)
8233 Sets the variant of the window/font size to use for this window, if
8234 the platform supports variants, for example, wxMac.
8236 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8238 def GetWindowVariant(*args
, **kwargs
):
8239 """GetWindowVariant(self) -> int"""
8240 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8242 def SetId(*args
, **kwargs
):
8244 SetId(self, int winid)
8246 Sets the identifier of the window. Each window has an integer
8247 identifier. If the application has not provided one, an identifier
8248 will be generated. Normally, the identifier should be provided on
8249 creation and should not be modified subsequently.
8251 return _core_
.Window_SetId(*args
, **kwargs
)
8253 def GetId(*args
, **kwargs
):
8257 Returns the identifier of the window. Each window has an integer
8258 identifier. If the application has not provided one (or the default Id
8259 -1 is used) then an unique identifier with a negative value will be
8262 return _core_
.Window_GetId(*args
, **kwargs
)
8264 def NewControlId(*args
, **kwargs
):
8266 NewControlId() -> int
8268 Generate a control id for the controls which were not given one.
8270 return _core_
.Window_NewControlId(*args
, **kwargs
)
8272 NewControlId
= staticmethod(NewControlId
)
8273 def NextControlId(*args
, **kwargs
):
8275 NextControlId(int winid) -> int
8277 Get the id of the control following the one with the given
8280 return _core_
.Window_NextControlId(*args
, **kwargs
)
8282 NextControlId
= staticmethod(NextControlId
)
8283 def PrevControlId(*args
, **kwargs
):
8285 PrevControlId(int winid) -> int
8287 Get the id of the control preceding the one with the given
8290 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8292 PrevControlId
= staticmethod(PrevControlId
)
8293 def GetLayoutDirection(*args
, **kwargs
):
8295 GetLayoutDirection(self) -> int
8297 Get the layout direction (LTR or RTL) for this window. Returns
8298 ``wx.Layout_Default`` if layout direction is not supported.
8300 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8302 def SetLayoutDirection(*args
, **kwargs
):
8304 SetLayoutDirection(self, int dir)
8306 Set the layout direction (LTR or RTL) for this window.
8308 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8310 def AdjustForLayoutDirection(*args
, **kwargs
):
8312 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8314 Mirror coordinates for RTL layout if this window uses it and if the
8315 mirroring is not done automatically like Win32.
8317 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8319 def SetSize(*args
, **kwargs
):
8321 SetSize(self, Size size)
8323 Sets the size of the window in pixels.
8325 return _core_
.Window_SetSize(*args
, **kwargs
)
8327 def SetDimensions(*args
, **kwargs
):
8329 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8331 Sets the position and size of the window in pixels. The sizeFlags
8332 parameter indicates the interpretation of the other params if they are
8335 ======================== ======================================
8336 wx.SIZE_AUTO A -1 indicates that a class-specific
8337 default should be used.
8338 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8339 -1 values are supplied.
8340 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8341 interpreted as real dimensions, not
8343 ======================== ======================================
8346 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8348 def SetRect(*args
, **kwargs
):
8350 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8352 Sets the position and size of the window in pixels using a wx.Rect.
8354 return _core_
.Window_SetRect(*args
, **kwargs
)
8356 def SetSizeWH(*args
, **kwargs
):
8358 SetSizeWH(self, int width, int height)
8360 Sets the size of the window in pixels.
8362 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8364 def Move(*args
, **kwargs
):
8366 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8368 Moves the window to the given position.
8370 return _core_
.Window_Move(*args
, **kwargs
)
8373 def MoveXY(*args
, **kwargs
):
8375 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8377 Moves the window to the given position.
8379 return _core_
.Window_MoveXY(*args
, **kwargs
)
8381 def SetBestFittingSize(*args
, **kwargs
):
8383 SetBestFittingSize(self, Size size=DefaultSize)
8385 A 'Smart' SetSize that will fill in default size components with the
8386 window's *best size* values. Also set's the minsize for use with sizers.
8388 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
8390 def Raise(*args
, **kwargs
):
8394 Raises the window to the top of the window hierarchy. In current
8395 version of wxWidgets this works both for manage and child windows.
8397 return _core_
.Window_Raise(*args
, **kwargs
)
8399 def Lower(*args
, **kwargs
):
8403 Lowers the window to the bottom of the window hierarchy. In current
8404 version of wxWidgets this works both for manage and child windows.
8406 return _core_
.Window_Lower(*args
, **kwargs
)
8408 def SetClientSize(*args
, **kwargs
):
8410 SetClientSize(self, Size size)
8412 This sets the size of the window client area in pixels. Using this
8413 function to size a window tends to be more device-independent than
8414 wx.Window.SetSize, since the application need not worry about what
8415 dimensions the border or title bar have when trying to fit the window
8416 around panel items, for example.
8418 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8420 def SetClientSizeWH(*args
, **kwargs
):
8422 SetClientSizeWH(self, int width, int height)
8424 This sets the size of the window client area in pixels. Using this
8425 function to size a window tends to be more device-independent than
8426 wx.Window.SetSize, since the application need not worry about what
8427 dimensions the border or title bar have when trying to fit the window
8428 around panel items, for example.
8430 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8432 def SetClientRect(*args
, **kwargs
):
8434 SetClientRect(self, Rect rect)
8436 This sets the size of the window client area in pixels. Using this
8437 function to size a window tends to be more device-independent than
8438 wx.Window.SetSize, since the application need not worry about what
8439 dimensions the border or title bar have when trying to fit the window
8440 around panel items, for example.
8442 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8444 def GetPosition(*args
, **kwargs
):
8446 GetPosition(self) -> Point
8448 Get the window's position. Notice that the position is in client
8449 coordinates for child windows and screen coordinates for the top level
8450 ones, use `GetScreenPosition` if you need screen coordinates for all
8453 return _core_
.Window_GetPosition(*args
, **kwargs
)
8455 def GetPositionTuple(*args
, **kwargs
):
8457 GetPositionTuple() -> (x,y)
8459 Get the window's position. Notice that the position is in client
8460 coordinates for child windows and screen coordinates for the top level
8461 ones, use `GetScreenPosition` if you need screen coordinates for all
8464 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8466 def GetScreenPosition(*args
, **kwargs
):
8468 GetScreenPosition(self) -> Point
8470 Get the position of the window in screen coordinantes.
8472 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8474 def GetScreenPositionTuple(*args
, **kwargs
):
8476 GetScreenPositionTuple() -> (x,y)
8478 Get the position of the window in screen coordinantes.
8480 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8482 def GetScreenRect(*args
, **kwargs
):
8484 GetScreenRect(self) -> Rect
8486 Returns the size and position of the window in screen coordinantes as
8489 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8491 def GetSize(*args
, **kwargs
):
8493 GetSize(self) -> Size
8495 Get the window size.
8497 return _core_
.Window_GetSize(*args
, **kwargs
)
8499 def GetSizeTuple(*args
, **kwargs
):
8501 GetSizeTuple() -> (width, height)
8503 Get the window size.
8505 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8507 def GetRect(*args
, **kwargs
):
8509 GetRect(self) -> Rect
8511 Returns the size and position of the window as a `wx.Rect` object.
8513 return _core_
.Window_GetRect(*args
, **kwargs
)
8515 def GetClientSize(*args
, **kwargs
):
8517 GetClientSize(self) -> Size
8519 This gets the size of the window's 'client area' in pixels. The client
8520 area is the area which may be drawn on by the programmer, excluding
8521 title bar, border, scrollbars, etc.
8523 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8525 def GetClientSizeTuple(*args
, **kwargs
):
8527 GetClientSizeTuple() -> (width, height)
8529 This gets the size of the window's 'client area' in pixels. The client
8530 area is the area which may be drawn on by the programmer, excluding
8531 title bar, border, scrollbars, etc.
8533 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8535 def GetClientAreaOrigin(*args
, **kwargs
):
8537 GetClientAreaOrigin(self) -> Point
8539 Get the origin of the client area of the window relative to the
8540 window's top left corner (the client area may be shifted because of
8541 the borders, scrollbars, other decorations...)
8543 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8545 def GetClientRect(*args
, **kwargs
):
8547 GetClientRect(self) -> Rect
8549 Get the client area position and size as a `wx.Rect` object.
8551 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8553 def GetBestSize(*args
, **kwargs
):
8555 GetBestSize(self) -> Size
8557 This function returns the best acceptable minimal size for the
8558 window, if applicable. For example, for a static text control, it will
8559 be the minimal size such that the control label is not truncated. For
8560 windows containing subwindows (suzh aswx.Panel), the size returned by
8561 this function will be the same as the size the window would have had
8564 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8566 def GetBestSizeTuple(*args
, **kwargs
):
8568 GetBestSizeTuple() -> (width, height)
8570 This function returns the best acceptable minimal size for the
8571 window, if applicable. For example, for a static text control, it will
8572 be the minimal size such that the control label is not truncated. For
8573 windows containing subwindows (suzh aswx.Panel), the size returned by
8574 this function will be the same as the size the window would have had
8577 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8579 def InvalidateBestSize(*args
, **kwargs
):
8581 InvalidateBestSize(self)
8583 Reset the cached best size value so it will be recalculated the next
8586 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8588 def CacheBestSize(*args
, **kwargs
):
8590 CacheBestSize(self, Size size)
8592 Cache the best size so it doesn't need to be calculated again, (at least until
8593 some properties of the window change.)
8595 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8597 def GetBestFittingSize(*args
, **kwargs
):
8599 GetBestFittingSize(self) -> Size
8601 This function will merge the window's best size into the window's
8602 minimum size, giving priority to the min size components, and returns
8606 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
8608 def GetAdjustedBestSize(self
):
8609 s
= self
.GetBestSize()
8610 return wx
.Size(max(s
.width
, self
.GetMinWidth()),
8611 max(s
.height
, self
.GetMinHeight()))
8612 GetAdjustedBestSize
= wx
._deprecated
(GetAdjustedBestSize
, 'Use `GetBestFittingSize` instead.')
8614 def Center(*args
, **kwargs
):
8616 Center(self, int direction=BOTH)
8618 Centers the window. The parameter specifies the direction for
8619 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8620 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8621 on the entire screen and not on its parent window. If it is a
8622 top-level window and has no parent then it will always be centered
8623 relative to the screen.
8625 return _core_
.Window_Center(*args
, **kwargs
)
8628 def CenterOnParent(*args
, **kwargs
):
8630 CenterOnParent(self, int dir=BOTH)
8632 Center with respect to the the parent window
8634 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8636 CentreOnParent
= CenterOnParent
8637 def Fit(*args
, **kwargs
):
8641 Sizes the window so that it fits around its subwindows. This function
8642 won't do anything if there are no subwindows and will only really work
8643 correctly if sizers are used for the subwindows layout. Also, if the
8644 window has exactly one subwindow it is better (faster and the result
8645 is more precise as Fit adds some margin to account for fuzziness of
8646 its calculations) to call window.SetClientSize(child.GetSize())
8647 instead of calling Fit.
8649 return _core_
.Window_Fit(*args
, **kwargs
)
8651 def FitInside(*args
, **kwargs
):
8655 Similar to Fit, but sizes the interior (virtual) size of a
8656 window. Mainly useful with scrolled windows to reset scrollbars after
8657 sizing changes that do not trigger a size event, and/or scrolled
8658 windows without an interior sizer. This function similarly won't do
8659 anything if there are no subwindows.
8661 return _core_
.Window_FitInside(*args
, **kwargs
)
8663 def SetSizeHints(*args
, **kwargs
):
8665 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8668 Allows specification of minimum and maximum window sizes, and window
8669 size increments. If a pair of values is not set (or set to -1), the
8670 default values will be used. If this function is called, the user
8671 will not be able to size the window outside the given bounds (if it is
8672 a top-level window.) Sizers will also inspect the minimum window size
8673 and will use that value if set when calculating layout.
8675 The resizing increments are only significant under Motif or Xt.
8677 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8679 def SetSizeHintsSz(*args
, **kwargs
):
8681 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
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_SetSizeHintsSz(*args
, **kwargs
)
8694 def SetVirtualSizeHints(*args
, **kwargs
):
8696 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8698 Allows specification of minimum and maximum virtual window sizes. If a
8699 pair of values is not set (or set to -1), the default values will be
8700 used. If this function is called, the user will not be able to size
8701 the virtual area of the window outside the given bounds.
8703 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8705 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8707 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8709 Allows specification of minimum and maximum virtual window sizes. If a
8710 pair of values is not set (or set to -1), the default values will be
8711 used. If this function is called, the user will not be able to size
8712 the virtual area of the window outside the given bounds.
8714 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8716 def GetMaxSize(*args
, **kwargs
):
8717 """GetMaxSize(self) -> Size"""
8718 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8720 def GetMinSize(*args
, **kwargs
):
8721 """GetMinSize(self) -> Size"""
8722 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8724 def SetMinSize(*args
, **kwargs
):
8726 SetMinSize(self, Size minSize)
8728 A more convenient method than `SetSizeHints` for setting just the
8731 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8733 def SetMaxSize(*args
, **kwargs
):
8735 SetMaxSize(self, Size maxSize)
8737 A more convenient method than `SetSizeHints` for setting just the
8740 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8742 def GetMinWidth(*args
, **kwargs
):
8743 """GetMinWidth(self) -> int"""
8744 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8746 def GetMinHeight(*args
, **kwargs
):
8747 """GetMinHeight(self) -> int"""
8748 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8750 def GetMaxWidth(*args
, **kwargs
):
8751 """GetMaxWidth(self) -> int"""
8752 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8754 def GetMaxHeight(*args
, **kwargs
):
8755 """GetMaxHeight(self) -> int"""
8756 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8758 def SetVirtualSize(*args
, **kwargs
):
8760 SetVirtualSize(self, Size size)
8762 Set the the virtual size of a window in pixels. For most windows this
8763 is just the client area of the window, but for some like scrolled
8764 windows it is more or less independent of the screen window size.
8766 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8768 def SetVirtualSizeWH(*args
, **kwargs
):
8770 SetVirtualSizeWH(self, int w, int h)
8772 Set the the virtual size of a window in pixels. For most windows this
8773 is just the client area of the window, but for some like scrolled
8774 windows it is more or less independent of the screen window size.
8776 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8778 def GetVirtualSize(*args
, **kwargs
):
8780 GetVirtualSize(self) -> Size
8782 Get the the virtual size of the window in pixels. For most windows
8783 this is just the client area of the window, but for some like scrolled
8784 windows it is more or less independent of the screen window size.
8786 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8788 def GetVirtualSizeTuple(*args
, **kwargs
):
8790 GetVirtualSizeTuple() -> (width, height)
8792 Get the the virtual size of the window in pixels. For most windows
8793 this is just the client area of the window, but for some like scrolled
8794 windows it is more or less independent of the screen window size.
8796 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8798 def GetBestVirtualSize(*args
, **kwargs
):
8800 GetBestVirtualSize(self) -> Size
8802 Return the largest of ClientSize and BestSize (as determined by a
8803 sizer, interior children, or other means)
8805 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8807 def Show(*args
, **kwargs
):
8809 Show(self, bool show=True) -> bool
8811 Shows or hides the window. You may need to call Raise for a top level
8812 window if you want to bring it to top, although this is not needed if
8813 Show is called immediately after the frame creation. Returns True if
8814 the window has been shown or hidden or False if nothing was done
8815 because it already was in the requested state.
8817 return _core_
.Window_Show(*args
, **kwargs
)
8819 def Hide(*args
, **kwargs
):
8823 Equivalent to calling Show(False).
8825 return _core_
.Window_Hide(*args
, **kwargs
)
8827 def Enable(*args
, **kwargs
):
8829 Enable(self, bool enable=True) -> bool
8831 Enable or disable the window for user input. Note that when a parent
8832 window is disabled, all of its children are disabled as well and they
8833 are reenabled again when the parent is. Returns true if the window
8834 has been enabled or disabled, false if nothing was done, i.e. if the
8835 window had already been in the specified state.
8837 return _core_
.Window_Enable(*args
, **kwargs
)
8839 def Disable(*args
, **kwargs
):
8841 Disable(self) -> bool
8843 Disables the window, same as Enable(false).
8845 return _core_
.Window_Disable(*args
, **kwargs
)
8847 def IsShown(*args
, **kwargs
):
8849 IsShown(self) -> bool
8851 Returns true if the window is shown, false if it has been hidden.
8853 return _core_
.Window_IsShown(*args
, **kwargs
)
8855 def IsEnabled(*args
, **kwargs
):
8857 IsEnabled(self) -> bool
8859 Returns true if the window is enabled for input, false otherwise.
8861 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8863 def IsShownOnScreen(*args
, **kwargs
):
8865 IsShownOnScreen(self) -> bool
8867 Returns ``True`` if the window is physically visible on the screen,
8868 i.e. it is shown and all its parents up to the toplevel window are
8871 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8873 def SetWindowStyleFlag(*args
, **kwargs
):
8875 SetWindowStyleFlag(self, long style)
8877 Sets the style of the window. Please note that some styles cannot be
8878 changed after the window creation and that Refresh() might need to be
8879 called after changing the others for the change to take place
8882 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8884 def GetWindowStyleFlag(*args
, **kwargs
):
8886 GetWindowStyleFlag(self) -> long
8888 Gets the window style that was passed to the constructor or Create
8891 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8893 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8894 def HasFlag(*args
, **kwargs
):
8896 HasFlag(self, int flag) -> bool
8898 Test if the given style is set for this window.
8900 return _core_
.Window_HasFlag(*args
, **kwargs
)
8902 def IsRetained(*args
, **kwargs
):
8904 IsRetained(self) -> bool
8906 Returns true if the window is retained, false otherwise. Retained
8907 windows are only available on X platforms.
8909 return _core_
.Window_IsRetained(*args
, **kwargs
)
8911 def SetExtraStyle(*args
, **kwargs
):
8913 SetExtraStyle(self, long exStyle)
8915 Sets the extra style bits for the window. Extra styles are the less
8916 often used style bits which can't be set with the constructor or with
8917 SetWindowStyleFlag()
8919 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8921 def GetExtraStyle(*args
, **kwargs
):
8923 GetExtraStyle(self) -> long
8925 Returns the extra style bits for the window.
8927 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8929 def MakeModal(*args
, **kwargs
):
8931 MakeModal(self, bool modal=True)
8933 Disables all other windows in the application so that the user can
8934 only interact with this window. Passing False will reverse this
8937 return _core_
.Window_MakeModal(*args
, **kwargs
)
8939 def SetThemeEnabled(*args
, **kwargs
):
8941 SetThemeEnabled(self, bool enableTheme)
8943 This function tells a window if it should use the system's "theme"
8944 code to draw the windows' background instead if its own background
8945 drawing code. This will only have an effect on platforms that support
8946 the notion of themes in user defined windows. One such platform is
8947 GTK+ where windows can have (very colourful) backgrounds defined by a
8948 user's selected theme.
8950 Dialogs, notebook pages and the status bar have this flag set to true
8951 by default so that the default look and feel is simulated best.
8953 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8955 def GetThemeEnabled(*args
, **kwargs
):
8957 GetThemeEnabled(self) -> bool
8959 Return the themeEnabled flag.
8961 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8963 def SetFocus(*args
, **kwargs
):
8967 Set's the focus to this window, allowing it to receive keyboard input.
8969 return _core_
.Window_SetFocus(*args
, **kwargs
)
8971 def SetFocusFromKbd(*args
, **kwargs
):
8973 SetFocusFromKbd(self)
8975 Set focus to this window as the result of a keyboard action. Normally
8976 only called internally.
8978 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8980 def FindFocus(*args
, **kwargs
):
8982 FindFocus() -> Window
8984 Returns the window or control that currently has the keyboard focus,
8987 return _core_
.Window_FindFocus(*args
, **kwargs
)
8989 FindFocus
= staticmethod(FindFocus
)
8990 def AcceptsFocus(*args
, **kwargs
):
8992 AcceptsFocus(self) -> bool
8994 Can this window have focus?
8996 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8998 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
9000 AcceptsFocusFromKeyboard(self) -> bool
9002 Can this window be given focus by keyboard navigation? if not, the
9003 only way to give it focus (provided it accepts it at all) is to click
9006 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
9008 def Navigate(*args
, **kwargs
):
9010 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9012 Does keyboard navigation from this window to another, by sending a
9013 `wx.NavigationKeyEvent`.
9015 return _core_
.Window_Navigate(*args
, **kwargs
)
9017 def MoveAfterInTabOrder(*args
, **kwargs
):
9019 MoveAfterInTabOrder(self, Window win)
9021 Moves this window in the tab navigation order after the specified
9022 sibling window. This means that when the user presses the TAB key on
9023 that other window, the focus switches to this window.
9025 The default tab order is the same as creation order. This function
9026 and `MoveBeforeInTabOrder` allow to change it after creating all the
9030 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
9032 def MoveBeforeInTabOrder(*args
, **kwargs
):
9034 MoveBeforeInTabOrder(self, Window win)
9036 Same as `MoveAfterInTabOrder` except that it inserts this window just
9037 before win instead of putting it right after it.
9039 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9041 def GetChildren(*args
, **kwargs
):
9043 GetChildren(self) -> PyObject
9045 Returns a list of the window's children. NOTE: Currently this is a
9046 copy of the child window list maintained by the window, so the return
9047 value of this function is only valid as long as the window's children
9050 return _core_
.Window_GetChildren(*args
, **kwargs
)
9052 def GetParent(*args
, **kwargs
):
9054 GetParent(self) -> Window
9056 Returns the parent window of this window, or None if there isn't one.
9058 return _core_
.Window_GetParent(*args
, **kwargs
)
9060 def GetGrandParent(*args
, **kwargs
):
9062 GetGrandParent(self) -> Window
9064 Returns the parent of the parent of this window, or None if there
9067 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9069 def IsTopLevel(*args
, **kwargs
):
9071 IsTopLevel(self) -> bool
9073 Returns true if the given window is a top-level one. Currently all
9074 frames and dialogs are always considered to be top-level windows (even
9075 if they have a parent window).
9077 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9079 def Reparent(*args
, **kwargs
):
9081 Reparent(self, Window newParent) -> bool
9083 Reparents the window, i.e the window will be removed from its current
9084 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9085 re-inserted into another. Available on Windows and GTK. Returns True
9086 if the parent was changed, False otherwise (error or newParent ==
9089 return _core_
.Window_Reparent(*args
, **kwargs
)
9091 def AddChild(*args
, **kwargs
):
9093 AddChild(self, Window child)
9095 Adds a child window. This is called automatically by window creation
9096 functions so should not be required by the application programmer.
9098 return _core_
.Window_AddChild(*args
, **kwargs
)
9100 def RemoveChild(*args
, **kwargs
):
9102 RemoveChild(self, Window child)
9104 Removes a child window. This is called automatically by window
9105 deletion functions so should not be required by the application
9108 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9110 def SetDoubleBuffered(*args
, **kwargs
):
9112 SetDoubleBuffered(self, bool on)
9114 Currently wxGTK2 only.
9116 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
9118 def FindWindowById(*args
, **kwargs
):
9120 FindWindowById(self, long winid) -> Window
9122 Find a chld of this window by window ID
9124 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9126 def FindWindowByName(*args
, **kwargs
):
9128 FindWindowByName(self, String name) -> Window
9130 Find a child of this window by name
9132 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9134 def GetEventHandler(*args
, **kwargs
):
9136 GetEventHandler(self) -> EvtHandler
9138 Returns the event handler for this window. By default, the window is
9139 its own event handler.
9141 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9143 def SetEventHandler(*args
, **kwargs
):
9145 SetEventHandler(self, EvtHandler handler)
9147 Sets the event handler for this window. An event handler is an object
9148 that is capable of processing the events sent to a window. (In other
9149 words, is able to dispatch the events to handler function.) By
9150 default, the window is its own event handler, but an application may
9151 wish to substitute another, for example to allow central
9152 implementation of event-handling for a variety of different window
9155 It is usually better to use `wx.Window.PushEventHandler` since this sets
9156 up a chain of event handlers, where an event not handled by one event
9157 handler is handed off to the next one in the chain.
9159 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9161 def PushEventHandler(*args
, **kwargs
):
9163 PushEventHandler(self, EvtHandler handler)
9165 Pushes this event handler onto the event handler stack for the window.
9166 An event handler is an object that is capable of processing the events
9167 sent to a window. (In other words, is able to dispatch the events to
9168 handler function.) By default, the window is its own event handler,
9169 but an application may wish to substitute another, for example to
9170 allow central implementation of event-handling for a variety of
9171 different window classes.
9173 wx.Window.PushEventHandler allows an application to set up a chain of
9174 event handlers, where an event not handled by one event handler is
9175 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9176 to remove the event handler. Ownership of the handler is *not* given
9177 to the window, so you should be sure to pop the handler before the
9178 window is destroyed and either let PopEventHandler destroy it, or call
9179 its Destroy method yourself.
9181 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9183 def PopEventHandler(*args
, **kwargs
):
9185 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9187 Removes and returns the top-most event handler on the event handler
9188 stack. If deleteHandler is True then the wx.EvtHandler object will be
9189 destroyed after it is popped, and ``None`` will be returned instead.
9191 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9193 def RemoveEventHandler(*args
, **kwargs
):
9195 RemoveEventHandler(self, EvtHandler handler) -> bool
9197 Find the given handler in the event handler chain and remove (but not
9198 delete) it from the event handler chain, returns True if it was found
9199 and False otherwise (this also results in an assert failure so this
9200 function should only be called when the handler is supposed to be
9203 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9205 def SetValidator(*args
, **kwargs
):
9207 SetValidator(self, Validator validator)
9209 Deletes the current validator (if any) and sets the window validator,
9210 having called wx.Validator.Clone to create a new validator of this
9213 return _core_
.Window_SetValidator(*args
, **kwargs
)
9215 def GetValidator(*args
, **kwargs
):
9217 GetValidator(self) -> Validator
9219 Returns a pointer to the current validator for the window, or None if
9222 return _core_
.Window_GetValidator(*args
, **kwargs
)
9224 def Validate(*args
, **kwargs
):
9226 Validate(self) -> bool
9228 Validates the current values of the child controls using their
9229 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9230 style flag set, the method will also call Validate() of all child
9231 windows. Returns false if any of the validations failed.
9233 return _core_
.Window_Validate(*args
, **kwargs
)
9235 def TransferDataToWindow(*args
, **kwargs
):
9237 TransferDataToWindow(self) -> bool
9239 Transfers values to child controls from data areas specified by their
9240 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9241 style flag set, the method will also call TransferDataToWindow() of
9244 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9246 def TransferDataFromWindow(*args
, **kwargs
):
9248 TransferDataFromWindow(self) -> bool
9250 Transfers values from child controls to data areas specified by their
9251 validators. Returns false if a transfer failed. If the window has
9252 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9253 also call TransferDataFromWindow() of all child windows.
9255 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9257 def InitDialog(*args
, **kwargs
):
9261 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9262 to the dialog via validators.
9264 return _core_
.Window_InitDialog(*args
, **kwargs
)
9266 def SetAcceleratorTable(*args
, **kwargs
):
9268 SetAcceleratorTable(self, AcceleratorTable accel)
9270 Sets the accelerator table for this window.
9272 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9274 def GetAcceleratorTable(*args
, **kwargs
):
9276 GetAcceleratorTable(self) -> AcceleratorTable
9278 Gets the accelerator table for this window.
9280 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9282 def RegisterHotKey(*args
, **kwargs
):
9284 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9286 Registers a system wide hotkey. Every time the user presses the hotkey
9287 registered here, this window will receive a hotkey event. It will
9288 receive the event even if the application is in the background and
9289 does not have the input focus because the user is working with some
9290 other application. To bind an event handler function to this hotkey
9291 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9292 hotkey was registered successfully.
9294 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9296 def UnregisterHotKey(*args
, **kwargs
):
9298 UnregisterHotKey(self, int hotkeyId) -> bool
9300 Unregisters a system wide hotkey.
9302 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9304 def ConvertDialogPointToPixels(*args
, **kwargs
):
9306 ConvertDialogPointToPixels(self, Point pt) -> Point
9308 Converts a point or size from dialog units to pixels. Dialog units
9309 are used for maintaining a dialog's proportions even if the font
9310 changes. For the x dimension, the dialog units are multiplied by the
9311 average character width and then divided by 4. For the y dimension,
9312 the dialog units are multiplied by the average character height and
9315 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9317 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9319 ConvertDialogSizeToPixels(self, Size sz) -> Size
9321 Converts a point or size from dialog units to pixels. Dialog units
9322 are used for maintaining a dialog's proportions even if the font
9323 changes. For the x dimension, the dialog units are multiplied by the
9324 average character width and then divided by 4. For the y dimension,
9325 the dialog units are multiplied by the average character height and
9328 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9330 def DLG_PNT(*args
, **kwargs
):
9332 DLG_PNT(self, Point pt) -> Point
9334 Converts a point or size from dialog units to pixels. Dialog units
9335 are used for maintaining a dialog's proportions even if the font
9336 changes. For the x dimension, the dialog units are multiplied by the
9337 average character width and then divided by 4. For the y dimension,
9338 the dialog units are multiplied by the average character height and
9341 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9343 def DLG_SZE(*args
, **kwargs
):
9345 DLG_SZE(self, Size sz) -> Size
9347 Converts a point or size from dialog units to pixels. Dialog units
9348 are used for maintaining a dialog's proportions even if the font
9349 changes. For the x dimension, the dialog units are multiplied by the
9350 average character width and then divided by 4. For the y dimension,
9351 the dialog units are multiplied by the average character height and
9354 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9356 def ConvertPixelPointToDialog(*args
, **kwargs
):
9357 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9358 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9360 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9361 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9362 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9364 def WarpPointer(*args
, **kwargs
):
9366 WarpPointer(self, int x, int y)
9368 Moves the pointer to the given position on the window.
9370 NOTE: This function is not supported under Mac because Apple Human
9371 Interface Guidelines forbid moving the mouse cursor programmatically.
9373 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9375 def CaptureMouse(*args
, **kwargs
):
9379 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9380 release the capture.
9382 Note that wxWindows maintains the stack of windows having captured the
9383 mouse and when the mouse is released the capture returns to the window
9384 which had had captured it previously and it is only really released if
9385 there were no previous window. In particular, this means that you must
9386 release the mouse as many times as you capture it, unless the window
9387 receives the `wx.MouseCaptureLostEvent` event.
9389 Any application which captures the mouse in the beginning of some
9390 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9391 operation when it receives the event. The event handler must not
9394 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9396 def ReleaseMouse(*args
, **kwargs
):
9400 Releases mouse input captured with wx.Window.CaptureMouse.
9402 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9404 def GetCapture(*args
, **kwargs
):
9406 GetCapture() -> Window
9408 Returns the window which currently captures the mouse or None
9410 return _core_
.Window_GetCapture(*args
, **kwargs
)
9412 GetCapture
= staticmethod(GetCapture
)
9413 def HasCapture(*args
, **kwargs
):
9415 HasCapture(self) -> bool
9417 Returns true if this window has the current mouse capture.
9419 return _core_
.Window_HasCapture(*args
, **kwargs
)
9421 def Refresh(*args
, **kwargs
):
9423 Refresh(self, bool eraseBackground=True, Rect rect=None)
9425 Mark the specified rectangle (or the whole window) as "dirty" so it
9426 will be repainted. Causes an EVT_PAINT event to be generated and sent
9429 return _core_
.Window_Refresh(*args
, **kwargs
)
9431 def RefreshRect(*args
, **kwargs
):
9433 RefreshRect(self, Rect rect, bool eraseBackground=True)
9435 Redraws the contents of the given rectangle: the area inside it will
9436 be repainted. This is the same as Refresh but has a nicer syntax.
9438 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9440 def Update(*args
, **kwargs
):
9444 Calling this method immediately repaints the invalidated area of the
9445 window instead of waiting for the EVT_PAINT event to happen, (normally
9446 this would usually only happen when the flow of control returns to the
9447 event loop.) Notice that this function doesn't refresh the window and
9448 does nothing if the window has been already repainted. Use `Refresh`
9449 first if you want to immediately redraw the window (or some portion of
9450 it) unconditionally.
9452 return _core_
.Window_Update(*args
, **kwargs
)
9454 def ClearBackground(*args
, **kwargs
):
9456 ClearBackground(self)
9458 Clears the window by filling it with the current background
9459 colour. Does not cause an erase background event to be generated.
9461 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9463 def Freeze(*args
, **kwargs
):
9467 Freezes the window or, in other words, prevents any updates from
9468 taking place on screen, the window is not redrawn at all. Thaw must be
9469 called to reenable window redrawing. Calls to Freeze/Thaw may be
9470 nested, with the actual Thaw being delayed until all the nesting has
9473 This method is useful for visual appearance optimization (for example,
9474 it is a good idea to use it before inserting large amount of text into
9475 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9476 for all controls so it is mostly just a hint to wxWindows and not a
9477 mandatory directive.
9479 return _core_
.Window_Freeze(*args
, **kwargs
)
9481 def IsFrozen(*args
, **kwargs
):
9483 IsFrozen(self) -> bool
9485 Returns ``True`` if the window has been frozen and not thawed yet.
9487 :see: `Freeze` and `Thaw`
9489 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9491 def Thaw(*args
, **kwargs
):
9495 Reenables window updating after a previous call to Freeze. Calls to
9496 Freeze/Thaw may be nested, so Thaw must be called the same number of
9497 times that Freeze was before the window will be updated.
9499 return _core_
.Window_Thaw(*args
, **kwargs
)
9501 def PrepareDC(*args
, **kwargs
):
9503 PrepareDC(self, DC dc)
9505 Call this function to prepare the device context for drawing a
9506 scrolled image. It sets the device origin according to the current
9509 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9511 def IsDoubleBuffered(*args
, **kwargs
):
9513 IsDoubleBuffered(self) -> bool
9515 Returns ``True`` if the window contents is double-buffered by the
9516 system, i.e. if any drawing done on the window is really done on a
9517 temporary backing surface and transferred to the screen all at once
9520 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9522 def GetUpdateRegion(*args
, **kwargs
):
9524 GetUpdateRegion(self) -> Region
9526 Returns the region specifying which parts of the window have been
9527 damaged. Should only be called within an EVT_PAINT handler.
9529 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9531 def GetUpdateClientRect(*args
, **kwargs
):
9533 GetUpdateClientRect(self) -> Rect
9535 Get the update rectangle region bounding box in client coords.
9537 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9539 def IsExposed(*args
, **kwargs
):
9541 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9543 Returns true if the given point or rectangle area has been exposed
9544 since the last repaint. Call this in an paint event handler to
9545 optimize redrawing by only redrawing those areas, which have been
9548 return _core_
.Window_IsExposed(*args
, **kwargs
)
9550 def IsExposedPoint(*args
, **kwargs
):
9552 IsExposedPoint(self, Point pt) -> bool
9554 Returns true if the given point or rectangle area has been exposed
9555 since the last repaint. Call this in an paint event handler to
9556 optimize redrawing by only redrawing those areas, which have been
9559 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9561 def IsExposedRect(*args
, **kwargs
):
9563 IsExposedRect(self, Rect rect) -> bool
9565 Returns true if the given point or rectangle area has been exposed
9566 since the last repaint. Call this in an paint event handler to
9567 optimize redrawing by only redrawing those areas, which have been
9570 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9572 def GetDefaultAttributes(*args
, **kwargs
):
9574 GetDefaultAttributes(self) -> VisualAttributes
9576 Get the default attributes for an instance of this class. This is
9577 useful if you want to use the same font or colour in your own control
9578 as in a standard control -- which is a much better idea than hard
9579 coding specific colours or fonts which might look completely out of
9580 place on the user's system, especially if it uses themes.
9582 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9584 def GetClassDefaultAttributes(*args
, **kwargs
):
9586 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9588 Get the default attributes for this class. This is useful if you want
9589 to use the same font or colour in your own control as in a standard
9590 control -- which is a much better idea than hard coding specific
9591 colours or fonts which might look completely out of place on the
9592 user's system, especially if it uses themes.
9594 The variant parameter is only relevant under Mac currently and is
9595 ignore under other platforms. Under Mac, it will change the size of
9596 the returned font. See `wx.Window.SetWindowVariant` for more about
9599 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9601 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9602 def SetBackgroundColour(*args
, **kwargs
):
9604 SetBackgroundColour(self, Colour colour) -> bool
9606 Sets the background colour of the window. Returns True if the colour
9607 was changed. The background colour is usually painted by the default
9608 EVT_ERASE_BACKGROUND event handler function under Windows and
9609 automatically under GTK. Using `wx.NullColour` will reset the window
9610 to the default background colour.
9612 Note that setting the background colour may not cause an immediate
9613 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9614 calling this function.
9616 Using this function will disable attempts to use themes for this
9617 window, if the system supports them. Use with care since usually the
9618 themes represent the appearance chosen by the user to be used for all
9619 applications on the system.
9621 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9623 def SetOwnBackgroundColour(*args
, **kwargs
):
9624 """SetOwnBackgroundColour(self, Colour colour)"""
9625 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9627 def SetForegroundColour(*args
, **kwargs
):
9629 SetForegroundColour(self, Colour colour) -> bool
9631 Sets the foreground colour of the window. Returns True is the colour
9632 was changed. The interpretation of foreground colour is dependent on
9633 the window class; it may be the text colour or other colour, or it may
9636 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9638 def SetOwnForegroundColour(*args
, **kwargs
):
9639 """SetOwnForegroundColour(self, Colour colour)"""
9640 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9642 def GetBackgroundColour(*args
, **kwargs
):
9644 GetBackgroundColour(self) -> Colour
9646 Returns the background colour of the window.
9648 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9650 def GetForegroundColour(*args
, **kwargs
):
9652 GetForegroundColour(self) -> Colour
9654 Returns the foreground colour of the window. The interpretation of
9655 foreground colour is dependent on the window class; it may be the text
9656 colour or other colour, or it may not be used at all.
9658 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9660 def InheritsBackgroundColour(*args
, **kwargs
):
9661 """InheritsBackgroundColour(self) -> bool"""
9662 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9664 def UseBgCol(*args
, **kwargs
):
9665 """UseBgCol(self) -> bool"""
9666 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9668 def SetBackgroundStyle(*args
, **kwargs
):
9670 SetBackgroundStyle(self, int style) -> bool
9672 Returns the background style of the window. The background style
9673 indicates how the background of the window is drawn.
9675 ====================== ========================================
9676 wx.BG_STYLE_SYSTEM The background colour or pattern should
9677 be determined by the system
9678 wx.BG_STYLE_COLOUR The background should be a solid colour
9679 wx.BG_STYLE_CUSTOM The background will be implemented by the
9681 ====================== ========================================
9683 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9684 a custom background, such as a tiled bitmap. Currently the style has
9685 no effect on other platforms.
9687 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9689 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9691 def GetBackgroundStyle(*args
, **kwargs
):
9693 GetBackgroundStyle(self) -> int
9695 Returns the background style of the window.
9697 :see: `SetBackgroundStyle`
9699 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9701 def HasTransparentBackground(*args
, **kwargs
):
9703 HasTransparentBackground(self) -> bool
9705 Returns True if this window's background is transparent (as, for
9706 example, for `wx.StaticText`) and should show the parent window's
9709 This method is mostly used internally by the library itself and you
9710 normally shouldn't have to call it. You may, however, have to override
9711 it in your custom control classes to ensure that background is painted
9714 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9716 def SetCursor(*args
, **kwargs
):
9718 SetCursor(self, Cursor cursor) -> bool
9720 Sets the window's cursor. Notice that the window cursor also sets it
9721 for the children of the window implicitly.
9723 The cursor may be wx.NullCursor in which case the window cursor will
9724 be reset back to default.
9726 return _core_
.Window_SetCursor(*args
, **kwargs
)
9728 def GetCursor(*args
, **kwargs
):
9730 GetCursor(self) -> Cursor
9732 Return the cursor associated with this window.
9734 return _core_
.Window_GetCursor(*args
, **kwargs
)
9736 def SetFont(*args
, **kwargs
):
9738 SetFont(self, Font font) -> bool
9740 Sets the font for this window.
9742 return _core_
.Window_SetFont(*args
, **kwargs
)
9744 def SetOwnFont(*args
, **kwargs
):
9745 """SetOwnFont(self, Font font)"""
9746 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9748 def GetFont(*args
, **kwargs
):
9750 GetFont(self) -> Font
9752 Returns the default font used for this window.
9754 return _core_
.Window_GetFont(*args
, **kwargs
)
9756 def SetCaret(*args
, **kwargs
):
9758 SetCaret(self, Caret caret)
9760 Sets the caret associated with the window.
9762 return _core_
.Window_SetCaret(*args
, **kwargs
)
9764 def GetCaret(*args
, **kwargs
):
9766 GetCaret(self) -> Caret
9768 Returns the caret associated with the window.
9770 return _core_
.Window_GetCaret(*args
, **kwargs
)
9772 def GetCharHeight(*args
, **kwargs
):
9774 GetCharHeight(self) -> int
9776 Get the (average) character size for the current font.
9778 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9780 def GetCharWidth(*args
, **kwargs
):
9782 GetCharWidth(self) -> int
9784 Get the (average) character size for the current font.
9786 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9788 def GetTextExtent(*args
, **kwargs
):
9790 GetTextExtent(String string) -> (width, height)
9792 Get the width and height of the text using the current font.
9794 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9796 def GetFullTextExtent(*args
, **kwargs
):
9798 GetFullTextExtent(String string, Font font=None) ->
9799 (width, height, descent, externalLeading)
9801 Get the width, height, decent and leading of the text using the
9802 current or specified font.
9804 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9806 def ClientToScreenXY(*args
, **kwargs
):
9808 ClientToScreenXY(int x, int y) -> (x,y)
9810 Converts to screen coordinates from coordinates relative to this window.
9812 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9814 def ScreenToClientXY(*args
, **kwargs
):
9816 ScreenToClientXY(int x, int y) -> (x,y)
9818 Converts from screen to client window coordinates.
9820 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9822 def ClientToScreen(*args
, **kwargs
):
9824 ClientToScreen(self, Point pt) -> Point
9826 Converts to screen coordinates from coordinates relative to this window.
9828 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9830 def ScreenToClient(*args
, **kwargs
):
9832 ScreenToClient(self, Point pt) -> Point
9834 Converts from screen to client window coordinates.
9836 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9838 def HitTestXY(*args
, **kwargs
):
9840 HitTestXY(self, int x, int y) -> int
9842 Test where the given (in client coords) point lies
9844 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9846 def HitTest(*args
, **kwargs
):
9848 HitTest(self, Point pt) -> int
9850 Test where the given (in client coords) point lies
9852 return _core_
.Window_HitTest(*args
, **kwargs
)
9854 def GetBorder(*args
):
9856 GetBorder(self, long flags) -> int
9857 GetBorder(self) -> int
9859 Get border for the flags of this window
9861 return _core_
.Window_GetBorder(*args
)
9863 def UpdateWindowUI(*args
, **kwargs
):
9865 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9867 This function sends EVT_UPDATE_UI events to the window. The particular
9868 implementation depends on the window; for example a wx.ToolBar will
9869 send an update UI event for each toolbar button, and a wx.Frame will
9870 send an update UI event for each menubar menu item. You can call this
9871 function from your application to ensure that your UI is up-to-date at
9872 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9873 concerned). This may be necessary if you have called
9874 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9875 limit the overhead that wxWindows incurs by sending update UI events
9878 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9880 def PopupMenuXY(*args
, **kwargs
):
9882 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9884 Pops up the given menu at the specified coordinates, relative to this window,
9885 and returns control when the user has dismissed the menu. If a menu item is
9886 selected, the corresponding menu event is generated and will be processed as
9887 usual. If the default position is given then the current position of the
9888 mouse cursor will be used.
9890 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9892 def PopupMenu(*args
, **kwargs
):
9894 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9896 Pops up the given menu at the specified coordinates, relative to this window,
9897 and returns control when the user has dismissed the menu. If a menu item is
9898 selected, the corresponding menu event is generated and will be processed as
9899 usual. If the default position is given then the current position of the
9900 mouse cursor will be used.
9902 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9904 def HasMultiplePages(*args
, **kwargs
):
9905 """HasMultiplePages(self) -> bool"""
9906 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9908 def GetHandle(*args
, **kwargs
):
9910 GetHandle(self) -> long
9912 Returns the platform-specific handle (as a long integer) of the
9913 physical window. Currently on wxMac it returns the handle of the
9914 toplevel parent of the window.
9916 return _core_
.Window_GetHandle(*args
, **kwargs
)
9918 def AssociateHandle(*args
, **kwargs
):
9920 AssociateHandle(self, long handle)
9922 Associate the window with a new native handle
9924 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9926 def DissociateHandle(*args
, **kwargs
):
9928 DissociateHandle(self)
9930 Dissociate the current native handle from the window
9932 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9934 def HasScrollbar(*args
, **kwargs
):
9936 HasScrollbar(self, int orient) -> bool
9938 Does the window have the scrollbar for this orientation?
9940 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9942 def SetScrollbar(*args
, **kwargs
):
9944 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9947 Sets the scrollbar properties of a built-in scrollbar.
9949 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9951 def SetScrollPos(*args
, **kwargs
):
9953 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9955 Sets the position of one of the built-in scrollbars.
9957 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9959 def GetScrollPos(*args
, **kwargs
):
9961 GetScrollPos(self, int orientation) -> int
9963 Returns the built-in scrollbar position.
9965 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9967 def GetScrollThumb(*args
, **kwargs
):
9969 GetScrollThumb(self, int orientation) -> int
9971 Returns the built-in scrollbar thumb size.
9973 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9975 def GetScrollRange(*args
, **kwargs
):
9977 GetScrollRange(self, int orientation) -> int
9979 Returns the built-in scrollbar range.
9981 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9983 def ScrollWindow(*args
, **kwargs
):
9985 ScrollWindow(self, int dx, int dy, Rect rect=None)
9987 Physically scrolls the pixels in the window and move child windows
9988 accordingly. Use this function to optimise your scrolling
9989 implementations, to minimise the area that must be redrawn. Note that
9990 it is rarely required to call this function from a user program.
9992 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9994 def ScrollLines(*args
, **kwargs
):
9996 ScrollLines(self, int lines) -> bool
9998 If the platform and window class supports it, scrolls the window by
9999 the given number of lines down, if lines is positive, or up if lines
10000 is negative. Returns True if the window was scrolled, False if it was
10001 already on top/bottom and nothing was done.
10003 return _core_
.Window_ScrollLines(*args
, **kwargs
)
10005 def ScrollPages(*args
, **kwargs
):
10007 ScrollPages(self, int pages) -> bool
10009 If the platform and window class supports it, scrolls the window by
10010 the given number of pages down, if pages is positive, or up if pages
10011 is negative. Returns True if the window was scrolled, False if it was
10012 already on top/bottom and nothing was done.
10014 return _core_
.Window_ScrollPages(*args
, **kwargs
)
10016 def LineUp(*args
, **kwargs
):
10018 LineUp(self) -> bool
10020 This is just a wrapper for ScrollLines(-1).
10022 return _core_
.Window_LineUp(*args
, **kwargs
)
10024 def LineDown(*args
, **kwargs
):
10026 LineDown(self) -> bool
10028 This is just a wrapper for ScrollLines(1).
10030 return _core_
.Window_LineDown(*args
, **kwargs
)
10032 def PageUp(*args
, **kwargs
):
10034 PageUp(self) -> bool
10036 This is just a wrapper for ScrollPages(-1).
10038 return _core_
.Window_PageUp(*args
, **kwargs
)
10040 def PageDown(*args
, **kwargs
):
10042 PageDown(self) -> bool
10044 This is just a wrapper for ScrollPages(1).
10046 return _core_
.Window_PageDown(*args
, **kwargs
)
10048 def SetHelpText(*args
, **kwargs
):
10050 SetHelpText(self, String text)
10052 Sets the help text to be used as context-sensitive help for this
10053 window. Note that the text is actually stored by the current
10054 `wx.HelpProvider` implementation, and not in the window object itself.
10056 return _core_
.Window_SetHelpText(*args
, **kwargs
)
10058 def SetHelpTextForId(*args
, **kwargs
):
10060 SetHelpTextForId(self, String text)
10062 Associate this help text with all windows with the same id as this
10065 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
10067 def GetHelpTextAtPoint(*args
, **kwargs
):
10069 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10071 Get the help string associated with the given position in this window.
10073 Notice that pt may be invalid if event origin is keyboard or unknown
10074 and this method should return the global window help text then
10077 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
10079 def GetHelpText(*args
, **kwargs
):
10081 GetHelpText(self) -> String
10083 Gets the help text to be used as context-sensitive help for this
10084 window. Note that the text is actually stored by the current
10085 `wx.HelpProvider` implementation, and not in the window object itself.
10087 return _core_
.Window_GetHelpText(*args
, **kwargs
)
10089 def SetToolTipString(*args
, **kwargs
):
10091 SetToolTipString(self, String tip)
10093 Attach a tooltip to the window.
10095 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10097 def SetToolTip(*args
, **kwargs
):
10099 SetToolTip(self, ToolTip tip)
10101 Attach a tooltip to the window.
10103 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10105 def GetToolTip(*args
, **kwargs
):
10107 GetToolTip(self) -> ToolTip
10109 get the associated tooltip or None if none
10111 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10113 def SetDropTarget(*args
, **kwargs
):
10115 SetDropTarget(self, DropTarget dropTarget)
10117 Associates a drop target with this window. If the window already has
10118 a drop target, it is deleted.
10120 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10122 def GetDropTarget(*args
, **kwargs
):
10124 GetDropTarget(self) -> DropTarget
10126 Returns the associated drop target, which may be None.
10128 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10130 def DragAcceptFiles(*args
, **kwargs
):
10132 DragAcceptFiles(self, bool accept)
10134 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10135 Only functional on Windows.
10137 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10139 def SetConstraints(*args
, **kwargs
):
10141 SetConstraints(self, LayoutConstraints constraints)
10143 Sets the window to have the given layout constraints. If an existing
10144 layout constraints object is already owned by the window, it will be
10145 deleted. Pass None to disassociate and delete the window's current
10148 You must call SetAutoLayout to tell a window to use the constraints
10149 automatically in its default EVT_SIZE handler; otherwise, you must
10150 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10151 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10154 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10156 def GetConstraints(*args
, **kwargs
):
10158 GetConstraints(self) -> LayoutConstraints
10160 Returns a pointer to the window's layout constraints, or None if there
10163 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10165 def SetAutoLayout(*args
, **kwargs
):
10167 SetAutoLayout(self, bool autoLayout)
10169 Determines whether the Layout function will be called automatically
10170 when the window is resized. lease note that this only happens for the
10171 windows usually used to contain children, namely `wx.Panel` and
10172 `wx.TopLevelWindow` (and the classes deriving from them).
10174 This method is called implicitly by `SetSizer` but if you use
10175 `SetConstraints` you should call it manually or otherwise the window
10176 layout won't be correctly updated when its size changes.
10178 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10180 def GetAutoLayout(*args
, **kwargs
):
10182 GetAutoLayout(self) -> bool
10184 Returns the current autoLayout setting
10186 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10188 def Layout(*args
, **kwargs
):
10190 Layout(self) -> bool
10192 Invokes the constraint-based layout algorithm or the sizer-based
10193 algorithm for this window. See SetAutoLayout: when auto layout is on,
10194 this function gets called automatically by the default EVT_SIZE
10195 handler when the window is resized.
10197 return _core_
.Window_Layout(*args
, **kwargs
)
10199 def SetSizer(*args
, **kwargs
):
10201 SetSizer(self, Sizer sizer, bool deleteOld=True)
10203 Sets the window to have the given layout sizer. The window will then
10204 own the object, and will take care of its deletion. If an existing
10205 layout sizer object is already owned by the window, it will be deleted
10206 if the deleteOld parameter is true. Note that this function will also
10207 call SetAutoLayout implicitly with a True parameter if the sizer is
10208 non-None, and False otherwise.
10210 return _core_
.Window_SetSizer(*args
, **kwargs
)
10212 def SetSizerAndFit(*args
, **kwargs
):
10214 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10216 The same as SetSizer, except it also sets the size hints for the
10217 window based on the sizer's minimum size.
10219 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10221 def GetSizer(*args
, **kwargs
):
10223 GetSizer(self) -> Sizer
10225 Return the sizer associated with the window by a previous call to
10226 SetSizer or None if there isn't one.
10228 return _core_
.Window_GetSizer(*args
, **kwargs
)
10230 def SetContainingSizer(*args
, **kwargs
):
10232 SetContainingSizer(self, Sizer sizer)
10234 This normally does not need to be called by application code. It is
10235 called internally when a window is added to a sizer, and is used so
10236 the window can remove itself from the sizer when it is destroyed.
10238 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10240 def GetContainingSizer(*args
, **kwargs
):
10242 GetContainingSizer(self) -> Sizer
10244 Return the sizer that this window is a member of, if any, otherwise None.
10246 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10248 def InheritAttributes(*args
, **kwargs
):
10250 InheritAttributes(self)
10252 This function is (or should be, in case of custom controls) called
10253 during window creation to intelligently set up the window visual
10254 attributes, that is the font and the foreground and background
10257 By 'intelligently' the following is meant: by default, all windows use
10258 their own default attributes. However if some of the parent's
10259 attributes are explicitly changed (that is, using SetFont and not
10260 SetOwnFont) and if the corresponding attribute hadn't been
10261 explicitly set for this window itself, then this window takes the same
10262 value as used by the parent. In addition, if the window overrides
10263 ShouldInheritColours to return false, the colours will not be changed
10264 no matter what and only the font might.
10266 This rather complicated logic is necessary in order to accommodate the
10267 different usage scenarios. The most common one is when all default
10268 attributes are used and in this case, nothing should be inherited as
10269 in modern GUIs different controls use different fonts (and colours)
10270 than their siblings so they can't inherit the same value from the
10271 parent. However it was also deemed desirable to allow to simply change
10272 the attributes of all children at once by just changing the font or
10273 colour of their common parent, hence in this case we do inherit the
10274 parents attributes.
10277 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10279 def ShouldInheritColours(*args
, **kwargs
):
10281 ShouldInheritColours(self) -> bool
10283 Return true from here to allow the colours of this window to be
10284 changed by InheritAttributes, returning false forbids inheriting them
10285 from the parent window.
10287 The base class version returns false, but this method is overridden in
10288 wxControl where it returns true.
10290 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10292 def CanSetTransparent(*args
, **kwargs
):
10294 CanSetTransparent(self) -> bool
10296 Returns ``True`` if the platform supports setting the transparency for
10297 this window. Note that this method will err on the side of caution,
10298 so it is possible that this will return ``False`` when it is in fact
10299 possible to set the transparency.
10301 NOTE: On X-windows systems the X server must have the composite
10302 extension loaded, and there must be a composite manager program (such
10303 as xcompmgr) running.
10305 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10307 def SetTransparent(*args
, **kwargs
):
10309 SetTransparent(self, byte alpha) -> bool
10311 Attempt to set the transparency of this window to the ``alpha`` value,
10312 returns True on success. The ``alpha`` value is an integer in the
10313 range of 0 to 255, where 0 is fully transparent and 255 is fully
10316 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10318 def PostCreate(self
, pre
):
10320 Phase 3 of the 2-phase create <wink!>
10321 Call this method after precreating the window with the 2-phase create method.
10323 self
.this
= pre
.this
10324 self
.thisown
= pre
.thisown
10326 if hasattr(self
, '_setOORInfo'):
10327 self
._setOORInfo
(self
)
10328 if hasattr(self
, '_setCallbackInfo'):
10329 self
._setCallbackInfo
(self
, self
.__class
__)
10331 def SendSizeEvent(self
):
10332 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10334 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10335 AdjustedBestSize
= property(GetAdjustedBestSize
,doc
="See `GetAdjustedBestSize`")
10336 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10337 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10338 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10339 BestFittingSize
= property(GetBestFittingSize
,SetBestFittingSize
,doc
="See `GetBestFittingSize` and `SetBestFittingSize`")
10340 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10341 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10342 Border
= property(GetBorder
,doc
="See `GetBorder`")
10343 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10344 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10345 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10346 Children
= property(GetChildren
,doc
="See `GetChildren`")
10347 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10348 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10349 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10350 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10351 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10352 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10353 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10354 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10355 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10356 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10357 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10358 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10359 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10360 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10361 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10362 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10363 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10364 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10365 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10366 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10367 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10368 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10369 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10370 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10371 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10372 Parent
= property(GetParent
,doc
="See `GetParent`")
10373 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10374 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10375 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10376 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10377 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10378 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10379 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10380 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10381 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10382 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10383 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10384 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10385 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10386 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10387 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10388 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10389 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10390 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10391 _core_
.Window_swigregister(Window
)
10393 def PreWindow(*args
, **kwargs
):
10395 PreWindow() -> Window
10397 Precreate a Window for 2-phase creation.
10399 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10402 def Window_NewControlId(*args
):
10404 Window_NewControlId() -> int
10406 Generate a control id for the controls which were not given one.
10408 return _core_
.Window_NewControlId(*args
)
10410 def Window_NextControlId(*args
, **kwargs
):
10412 Window_NextControlId(int winid) -> int
10414 Get the id of the control following the one with the given
10417 return _core_
.Window_NextControlId(*args
, **kwargs
)
10419 def Window_PrevControlId(*args
, **kwargs
):
10421 Window_PrevControlId(int winid) -> int
10423 Get the id of the control preceding the one with the given
10426 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10428 def Window_FindFocus(*args
):
10430 Window_FindFocus() -> Window
10432 Returns the window or control that currently has the keyboard focus,
10435 return _core_
.Window_FindFocus(*args
)
10437 def Window_GetCapture(*args
):
10439 Window_GetCapture() -> Window
10441 Returns the window which currently captures the mouse or None
10443 return _core_
.Window_GetCapture(*args
)
10445 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10447 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10449 Get the default attributes for this class. This is useful if you want
10450 to use the same font or colour in your own control as in a standard
10451 control -- which is a much better idea than hard coding specific
10452 colours or fonts which might look completely out of place on the
10453 user's system, especially if it uses themes.
10455 The variant parameter is only relevant under Mac currently and is
10456 ignore under other platforms. Under Mac, it will change the size of
10457 the returned font. See `wx.Window.SetWindowVariant` for more about
10460 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10462 def DLG_PNT(win
, point_or_x
, y
=None):
10464 Convenience function for converting a Point or (x,y) in
10465 dialog units to pixel units.
10468 return win
.ConvertDialogPointToPixels(point_or_x
)
10470 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10472 def DLG_SZE(win
, size_width
, height
=None):
10474 Convenience function for converting a Size or (w,h) in
10475 dialog units to pixel units.
10478 return win
.ConvertDialogSizeToPixels(size_width
)
10480 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10483 def FindWindowById(*args
, **kwargs
):
10485 FindWindowById(long id, Window parent=None) -> Window
10487 Find the first window in the application with the given id. If parent
10488 is None, the search will start from all top-level frames and dialog
10489 boxes; if non-None, the search will be limited to the given window
10490 hierarchy. The search is recursive in both cases.
10492 return _core_
.FindWindowById(*args
, **kwargs
)
10494 def FindWindowByName(*args
, **kwargs
):
10496 FindWindowByName(String name, Window parent=None) -> Window
10498 Find a window by its name (as given in a window constructor or Create
10499 function call). If parent is None, the search will start from all
10500 top-level frames and dialog boxes; if non-None, the search will be
10501 limited to the given window hierarchy. The search is recursive in both
10504 If no window with such name is found, wx.FindWindowByLabel is called.
10506 return _core_
.FindWindowByName(*args
, **kwargs
)
10508 def FindWindowByLabel(*args
, **kwargs
):
10510 FindWindowByLabel(String label, Window parent=None) -> Window
10512 Find a window by its label. Depending on the type of window, the label
10513 may be a window title or panel item label. If parent is None, the
10514 search will start from all top-level frames and dialog boxes; if
10515 non-None, the search will be limited to the given window
10516 hierarchy. The search is recursive in both cases.
10518 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10520 def Window_FromHWND(*args
, **kwargs
):
10521 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10522 return _core_
.Window_FromHWND(*args
, **kwargs
)
10524 def GetTopLevelWindows(*args
):
10526 GetTopLevelWindows() -> PyObject
10528 Returns a list of the the application's top-level windows, (frames,
10529 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10530 by wxWidgets, and so it is only valid as long as no top-level windows
10531 are closed or new top-level windows are created.
10534 return _core_
.GetTopLevelWindows(*args
)
10535 #---------------------------------------------------------------------------
10537 class Validator(EvtHandler
):
10538 """Proxy of C++ Validator class"""
10539 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10540 __repr__
= _swig_repr
10541 def __init__(self
, *args
, **kwargs
):
10542 """__init__(self) -> Validator"""
10543 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10544 self
._setOORInfo
(self
)
10546 def Clone(*args
, **kwargs
):
10547 """Clone(self) -> Validator"""
10548 return _core_
.Validator_Clone(*args
, **kwargs
)
10550 def Validate(*args
, **kwargs
):
10551 """Validate(self, Window parent) -> bool"""
10552 return _core_
.Validator_Validate(*args
, **kwargs
)
10554 def TransferToWindow(*args
, **kwargs
):
10555 """TransferToWindow(self) -> bool"""
10556 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10558 def TransferFromWindow(*args
, **kwargs
):
10559 """TransferFromWindow(self) -> bool"""
10560 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10562 def GetWindow(*args
, **kwargs
):
10563 """GetWindow(self) -> Window"""
10564 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10566 def SetWindow(*args
, **kwargs
):
10567 """SetWindow(self, Window window)"""
10568 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10570 def IsSilent(*args
, **kwargs
):
10571 """IsSilent() -> bool"""
10572 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10574 IsSilent
= staticmethod(IsSilent
)
10575 def SetBellOnError(*args
, **kwargs
):
10576 """SetBellOnError(int doIt=True)"""
10577 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10579 SetBellOnError
= staticmethod(SetBellOnError
)
10580 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10581 _core_
.Validator_swigregister(Validator
)
10583 def Validator_IsSilent(*args
):
10584 """Validator_IsSilent() -> bool"""
10585 return _core_
.Validator_IsSilent(*args
)
10587 def Validator_SetBellOnError(*args
, **kwargs
):
10588 """Validator_SetBellOnError(int doIt=True)"""
10589 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10591 class PyValidator(Validator
):
10592 """Proxy of C++ PyValidator class"""
10593 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10594 __repr__
= _swig_repr
10595 def __init__(self
, *args
, **kwargs
):
10596 """__init__(self) -> PyValidator"""
10597 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10599 self
._setCallbackInfo
(self
, PyValidator
, 1)
10600 self
._setOORInfo
(self
)
10602 def _setCallbackInfo(*args
, **kwargs
):
10603 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10604 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10606 _core_
.PyValidator_swigregister(PyValidator
)
10608 #---------------------------------------------------------------------------
10610 class Menu(EvtHandler
):
10611 """Proxy of C++ Menu class"""
10612 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10613 __repr__
= _swig_repr
10614 def __init__(self
, *args
, **kwargs
):
10615 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10616 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10617 self
._setOORInfo
(self
)
10619 def Append(*args
, **kwargs
):
10621 Append(self, int id, String text=EmptyString, String help=EmptyString,
10622 int kind=ITEM_NORMAL) -> MenuItem
10624 return _core_
.Menu_Append(*args
, **kwargs
)
10626 def AppendSeparator(*args
, **kwargs
):
10627 """AppendSeparator(self) -> MenuItem"""
10628 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10630 def AppendCheckItem(*args
, **kwargs
):
10631 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10632 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10634 def AppendRadioItem(*args
, **kwargs
):
10635 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10636 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10638 def AppendMenu(*args
, **kwargs
):
10639 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10640 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10642 def AppendSubMenu(*args
, **kwargs
):
10643 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10644 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10646 def AppendItem(*args
, **kwargs
):
10647 """AppendItem(self, MenuItem item) -> MenuItem"""
10648 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10650 def InsertItem(*args
, **kwargs
):
10651 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10652 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10654 def PrependItem(*args
, **kwargs
):
10655 """PrependItem(self, MenuItem item) -> MenuItem"""
10656 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10658 def Break(*args
, **kwargs
):
10660 return _core_
.Menu_Break(*args
, **kwargs
)
10662 def Insert(*args
, **kwargs
):
10664 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10665 int kind=ITEM_NORMAL) -> MenuItem
10667 return _core_
.Menu_Insert(*args
, **kwargs
)
10669 def InsertSeparator(*args
, **kwargs
):
10670 """InsertSeparator(self, size_t pos) -> MenuItem"""
10671 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10673 def InsertCheckItem(*args
, **kwargs
):
10674 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10675 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10677 def InsertRadioItem(*args
, **kwargs
):
10678 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10679 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10681 def InsertMenu(*args
, **kwargs
):
10682 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10683 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10685 def Prepend(*args
, **kwargs
):
10687 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10688 int kind=ITEM_NORMAL) -> MenuItem
10690 return _core_
.Menu_Prepend(*args
, **kwargs
)
10692 def PrependSeparator(*args
, **kwargs
):
10693 """PrependSeparator(self) -> MenuItem"""
10694 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10696 def PrependCheckItem(*args
, **kwargs
):
10697 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10698 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10700 def PrependRadioItem(*args
, **kwargs
):
10701 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10702 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10704 def PrependMenu(*args
, **kwargs
):
10705 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10706 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10708 def Remove(*args
, **kwargs
):
10709 """Remove(self, int id) -> MenuItem"""
10710 return _core_
.Menu_Remove(*args
, **kwargs
)
10712 def RemoveItem(*args
, **kwargs
):
10713 """RemoveItem(self, MenuItem item) -> MenuItem"""
10714 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10716 def Delete(*args
, **kwargs
):
10717 """Delete(self, int id) -> bool"""
10718 return _core_
.Menu_Delete(*args
, **kwargs
)
10720 def DeleteItem(*args
, **kwargs
):
10721 """DeleteItem(self, MenuItem item) -> bool"""
10722 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10724 def Destroy(*args
, **kwargs
):
10728 Deletes the C++ object this Python object is a proxy for.
10730 args
[0].this
.own(False)
10731 return _core_
.Menu_Destroy(*args
, **kwargs
)
10733 def DestroyId(*args
, **kwargs
):
10734 """DestroyId(self, int id) -> bool"""
10735 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10737 def DestroyItem(*args
, **kwargs
):
10738 """DestroyItem(self, MenuItem item) -> bool"""
10739 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10741 def GetMenuItemCount(*args
, **kwargs
):
10742 """GetMenuItemCount(self) -> size_t"""
10743 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10745 def GetMenuItems(*args
, **kwargs
):
10746 """GetMenuItems(self) -> PyObject"""
10747 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10749 def FindItem(*args
, **kwargs
):
10750 """FindItem(self, String item) -> int"""
10751 return _core_
.Menu_FindItem(*args
, **kwargs
)
10753 def FindItemById(*args
, **kwargs
):
10754 """FindItemById(self, int id) -> MenuItem"""
10755 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10757 def FindItemByPosition(*args
, **kwargs
):
10758 """FindItemByPosition(self, size_t position) -> MenuItem"""
10759 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10761 def Enable(*args
, **kwargs
):
10762 """Enable(self, int id, bool enable)"""
10763 return _core_
.Menu_Enable(*args
, **kwargs
)
10765 def IsEnabled(*args
, **kwargs
):
10766 """IsEnabled(self, int id) -> bool"""
10767 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10769 def Check(*args
, **kwargs
):
10770 """Check(self, int id, bool check)"""
10771 return _core_
.Menu_Check(*args
, **kwargs
)
10773 def IsChecked(*args
, **kwargs
):
10774 """IsChecked(self, int id) -> bool"""
10775 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10777 def SetLabel(*args
, **kwargs
):
10778 """SetLabel(self, int id, String label)"""
10779 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10781 def GetLabel(*args
, **kwargs
):
10782 """GetLabel(self, int id) -> String"""
10783 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10785 def SetHelpString(*args
, **kwargs
):
10786 """SetHelpString(self, int id, String helpString)"""
10787 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10789 def GetHelpString(*args
, **kwargs
):
10790 """GetHelpString(self, int id) -> String"""
10791 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10793 def SetTitle(*args
, **kwargs
):
10794 """SetTitle(self, String title)"""
10795 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10797 def GetTitle(*args
, **kwargs
):
10798 """GetTitle(self) -> String"""
10799 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10801 def SetEventHandler(*args
, **kwargs
):
10802 """SetEventHandler(self, EvtHandler handler)"""
10803 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10805 def GetEventHandler(*args
, **kwargs
):
10806 """GetEventHandler(self) -> EvtHandler"""
10807 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10809 def SetInvokingWindow(*args
, **kwargs
):
10810 """SetInvokingWindow(self, Window win)"""
10811 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10813 def GetInvokingWindow(*args
, **kwargs
):
10814 """GetInvokingWindow(self) -> Window"""
10815 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10817 def GetStyle(*args
, **kwargs
):
10818 """GetStyle(self) -> long"""
10819 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10821 def UpdateUI(*args
, **kwargs
):
10822 """UpdateUI(self, EvtHandler source=None)"""
10823 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10825 def GetMenuBar(*args
, **kwargs
):
10826 """GetMenuBar(self) -> MenuBar"""
10827 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10829 def Attach(*args
, **kwargs
):
10830 """Attach(self, wxMenuBarBase menubar)"""
10831 return _core_
.Menu_Attach(*args
, **kwargs
)
10833 def Detach(*args
, **kwargs
):
10835 return _core_
.Menu_Detach(*args
, **kwargs
)
10837 def IsAttached(*args
, **kwargs
):
10838 """IsAttached(self) -> bool"""
10839 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10841 def SetParent(*args
, **kwargs
):
10842 """SetParent(self, Menu parent)"""
10843 return _core_
.Menu_SetParent(*args
, **kwargs
)
10845 def GetParent(*args
, **kwargs
):
10846 """GetParent(self) -> Menu"""
10847 return _core_
.Menu_GetParent(*args
, **kwargs
)
10849 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10850 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10851 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10852 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10853 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10854 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10855 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10856 Style
= property(GetStyle
,doc
="See `GetStyle`")
10857 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10858 _core_
.Menu_swigregister(Menu
)
10859 DefaultValidator
= cvar
.DefaultValidator
10861 #---------------------------------------------------------------------------
10863 class MenuBar(Window
):
10864 """Proxy of C++ MenuBar class"""
10865 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10866 __repr__
= _swig_repr
10867 def __init__(self
, *args
, **kwargs
):
10868 """__init__(self, long style=0) -> MenuBar"""
10869 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10870 self
._setOORInfo
(self
)
10872 def Append(*args
, **kwargs
):
10873 """Append(self, Menu menu, String title) -> bool"""
10874 return _core_
.MenuBar_Append(*args
, **kwargs
)
10876 def Insert(*args
, **kwargs
):
10877 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10878 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10880 def GetMenuCount(*args
, **kwargs
):
10881 """GetMenuCount(self) -> size_t"""
10882 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10884 def GetMenu(*args
, **kwargs
):
10885 """GetMenu(self, size_t pos) -> Menu"""
10886 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10888 def Replace(*args
, **kwargs
):
10889 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10890 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10892 def Remove(*args
, **kwargs
):
10893 """Remove(self, size_t pos) -> Menu"""
10894 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10896 def EnableTop(*args
, **kwargs
):
10897 """EnableTop(self, size_t pos, bool enable)"""
10898 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10900 def IsEnabledTop(*args
, **kwargs
):
10901 """IsEnabledTop(self, size_t pos) -> bool"""
10902 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10904 def SetLabelTop(*args
, **kwargs
):
10905 """SetLabelTop(self, size_t pos, String label)"""
10906 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10908 def GetLabelTop(*args
, **kwargs
):
10909 """GetLabelTop(self, size_t pos) -> String"""
10910 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10912 def FindMenuItem(*args
, **kwargs
):
10913 """FindMenuItem(self, String menu, String item) -> int"""
10914 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10916 def FindItemById(*args
, **kwargs
):
10917 """FindItemById(self, int id) -> MenuItem"""
10918 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10920 def FindMenu(*args
, **kwargs
):
10921 """FindMenu(self, String title) -> int"""
10922 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10924 def Enable(*args
, **kwargs
):
10925 """Enable(self, int id, bool enable)"""
10926 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10928 def Check(*args
, **kwargs
):
10929 """Check(self, int id, bool check)"""
10930 return _core_
.MenuBar_Check(*args
, **kwargs
)
10932 def IsChecked(*args
, **kwargs
):
10933 """IsChecked(self, int id) -> bool"""
10934 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10936 def IsEnabled(*args
, **kwargs
):
10937 """IsEnabled(self, int id) -> bool"""
10938 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10940 def SetLabel(*args
, **kwargs
):
10941 """SetLabel(self, int id, String label)"""
10942 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10944 def GetLabel(*args
, **kwargs
):
10945 """GetLabel(self, int id) -> String"""
10946 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10948 def SetHelpString(*args
, **kwargs
):
10949 """SetHelpString(self, int id, String helpString)"""
10950 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10952 def GetHelpString(*args
, **kwargs
):
10953 """GetHelpString(self, int id) -> String"""
10954 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10956 def GetFrame(*args
, **kwargs
):
10957 """GetFrame(self) -> wxFrame"""
10958 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10960 def IsAttached(*args
, **kwargs
):
10961 """IsAttached(self) -> bool"""
10962 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10964 def Attach(*args
, **kwargs
):
10965 """Attach(self, wxFrame frame)"""
10966 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10968 def Detach(*args
, **kwargs
):
10970 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10972 def UpdateMenus(*args
, **kwargs
):
10973 """UpdateMenus(self)"""
10974 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10976 def SetAutoWindowMenu(*args
, **kwargs
):
10977 """SetAutoWindowMenu(bool enable)"""
10978 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10980 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10981 def GetAutoWindowMenu(*args
, **kwargs
):
10982 """GetAutoWindowMenu() -> bool"""
10983 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10985 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10986 def GetMenus(self
):
10987 """Return a list of (menu, label) items for the menus in the MenuBar. """
10988 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
10989 for i
in range(self
.GetMenuCount())]
10991 def SetMenus(self
, items
):
10992 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10993 for i
in range(self
.GetMenuCount()-1, -1, -1):
10998 Frame
= property(GetFrame
,doc
="See `GetFrame`")
10999 Menu
= property(GetMenu
,doc
="See `GetMenu`")
11000 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
11001 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
11002 _core_
.MenuBar_swigregister(MenuBar
)
11004 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
11005 """MenuBar_SetAutoWindowMenu(bool enable)"""
11006 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11008 def MenuBar_GetAutoWindowMenu(*args
):
11009 """MenuBar_GetAutoWindowMenu() -> bool"""
11010 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
11012 #---------------------------------------------------------------------------
11014 class MenuItem(Object
):
11015 """Proxy of C++ MenuItem class"""
11016 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11017 __repr__
= _swig_repr
11018 def __init__(self
, *args
, **kwargs
):
11020 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11021 String help=EmptyString, int kind=ITEM_NORMAL,
11022 Menu subMenu=None) -> MenuItem
11024 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
11025 __swig_destroy__
= _core_
.delete_MenuItem
11026 __del__
= lambda self
: None;
11027 def GetMenu(*args
, **kwargs
):
11028 """GetMenu(self) -> Menu"""
11029 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
11031 def SetMenu(*args
, **kwargs
):
11032 """SetMenu(self, Menu menu)"""
11033 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
11035 def SetId(*args
, **kwargs
):
11036 """SetId(self, int id)"""
11037 return _core_
.MenuItem_SetId(*args
, **kwargs
)
11039 def GetId(*args
, **kwargs
):
11040 """GetId(self) -> int"""
11041 return _core_
.MenuItem_GetId(*args
, **kwargs
)
11043 def IsSeparator(*args
, **kwargs
):
11044 """IsSeparator(self) -> bool"""
11045 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
11047 def SetText(*args
, **kwargs
):
11048 """SetText(self, String str)"""
11049 return _core_
.MenuItem_SetText(*args
, **kwargs
)
11051 def GetLabel(*args
, **kwargs
):
11052 """GetLabel(self) -> String"""
11053 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
11055 def GetText(*args
, **kwargs
):
11056 """GetText(self) -> String"""
11057 return _core_
.MenuItem_GetText(*args
, **kwargs
)
11059 def GetLabelFromText(*args
, **kwargs
):
11060 """GetLabelFromText(String text) -> String"""
11061 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11063 GetLabelFromText
= staticmethod(GetLabelFromText
)
11064 def GetKind(*args
, **kwargs
):
11065 """GetKind(self) -> int"""
11066 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
11068 def SetKind(*args
, **kwargs
):
11069 """SetKind(self, int kind)"""
11070 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
11072 def SetCheckable(*args
, **kwargs
):
11073 """SetCheckable(self, bool checkable)"""
11074 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
11076 def IsCheckable(*args
, **kwargs
):
11077 """IsCheckable(self) -> bool"""
11078 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
11080 def IsSubMenu(*args
, **kwargs
):
11081 """IsSubMenu(self) -> bool"""
11082 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
11084 def SetSubMenu(*args
, **kwargs
):
11085 """SetSubMenu(self, Menu menu)"""
11086 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
11088 def GetSubMenu(*args
, **kwargs
):
11089 """GetSubMenu(self) -> Menu"""
11090 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
11092 def Enable(*args
, **kwargs
):
11093 """Enable(self, bool enable=True)"""
11094 return _core_
.MenuItem_Enable(*args
, **kwargs
)
11096 def IsEnabled(*args
, **kwargs
):
11097 """IsEnabled(self) -> bool"""
11098 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
11100 def Check(*args
, **kwargs
):
11101 """Check(self, bool check=True)"""
11102 return _core_
.MenuItem_Check(*args
, **kwargs
)
11104 def IsChecked(*args
, **kwargs
):
11105 """IsChecked(self) -> bool"""
11106 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
11108 def Toggle(*args
, **kwargs
):
11110 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
11112 def SetHelp(*args
, **kwargs
):
11113 """SetHelp(self, String str)"""
11114 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
11116 def GetHelp(*args
, **kwargs
):
11117 """GetHelp(self) -> String"""
11118 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
11120 def GetAccel(*args
, **kwargs
):
11121 """GetAccel(self) -> AcceleratorEntry"""
11122 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
11124 def SetAccel(*args
, **kwargs
):
11125 """SetAccel(self, AcceleratorEntry accel)"""
11126 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
11128 def SetBitmap(*args
, **kwargs
):
11129 """SetBitmap(self, Bitmap bitmap)"""
11130 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
11132 def GetBitmap(*args
, **kwargs
):
11133 """GetBitmap(self) -> Bitmap"""
11134 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
11136 def SetFont(*args
, **kwargs
):
11137 """SetFont(self, Font font)"""
11138 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
11140 def GetFont(*args
, **kwargs
):
11141 """GetFont(self) -> Font"""
11142 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
11144 def SetTextColour(*args
, **kwargs
):
11145 """SetTextColour(self, Colour colText)"""
11146 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
11148 def GetTextColour(*args
, **kwargs
):
11149 """GetTextColour(self) -> Colour"""
11150 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
11152 def SetBackgroundColour(*args
, **kwargs
):
11153 """SetBackgroundColour(self, Colour colBack)"""
11154 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
11156 def GetBackgroundColour(*args
, **kwargs
):
11157 """GetBackgroundColour(self) -> Colour"""
11158 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11160 def SetBitmaps(*args
, **kwargs
):
11161 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11162 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11164 def SetDisabledBitmap(*args
, **kwargs
):
11165 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11166 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11168 def GetDisabledBitmap(*args
, **kwargs
):
11169 """GetDisabledBitmap(self) -> Bitmap"""
11170 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11172 def SetMarginWidth(*args
, **kwargs
):
11173 """SetMarginWidth(self, int nWidth)"""
11174 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11176 def GetMarginWidth(*args
, **kwargs
):
11177 """GetMarginWidth(self) -> int"""
11178 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11180 def GetDefaultMarginWidth(*args
, **kwargs
):
11181 """GetDefaultMarginWidth() -> int"""
11182 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11184 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11185 def IsOwnerDrawn(*args
, **kwargs
):
11186 """IsOwnerDrawn(self) -> bool"""
11187 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11189 def SetOwnerDrawn(*args
, **kwargs
):
11190 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11191 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11193 def ResetOwnerDrawn(*args
, **kwargs
):
11194 """ResetOwnerDrawn(self)"""
11195 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11197 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
11198 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
11199 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
11200 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11201 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
11202 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
11203 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
11204 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
11205 Label
= property(GetLabel
,doc
="See `GetLabel`")
11206 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
11207 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
11208 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
11209 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
11210 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
11211 _core_
.MenuItem_swigregister(MenuItem
)
11213 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11214 """MenuItem_GetLabelFromText(String text) -> String"""
11215 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11217 def MenuItem_GetDefaultMarginWidth(*args
):
11218 """MenuItem_GetDefaultMarginWidth() -> int"""
11219 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
11221 #---------------------------------------------------------------------------
11223 class Control(Window
):
11225 This is the base class for a control or 'widget'.
11227 A control is generally a small window which processes user input
11228 and/or displays one or more item of data.
11230 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11231 __repr__
= _swig_repr
11232 def __init__(self
, *args
, **kwargs
):
11234 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11235 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11236 String name=ControlNameStr) -> Control
11238 Create a Control. Normally you should only call this from a subclass'
11239 __init__ as a plain old wx.Control is not very useful.
11241 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
11242 self
._setOORInfo
(self
)
11244 def Create(*args
, **kwargs
):
11246 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11247 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11248 String name=ControlNameStr) -> bool
11250 Do the 2nd phase and create the GUI control.
11252 return _core_
.Control_Create(*args
, **kwargs
)
11254 def GetAlignment(*args
, **kwargs
):
11256 GetAlignment(self) -> int
11258 Get the control alignment (left/right/centre, top/bottom/centre)
11260 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11262 def GetLabelText(*args
, **kwargs
):
11264 GetLabelText(self) -> String
11266 Get just the text of the label, without mnemonic characters ('&')
11268 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11270 def Command(*args
, **kwargs
):
11272 Command(self, CommandEvent event)
11274 Simulates the effect of the user issuing a command to the item.
11276 :see: `wx.CommandEvent`
11279 return _core_
.Control_Command(*args
, **kwargs
)
11281 def GetClassDefaultAttributes(*args
, **kwargs
):
11283 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11285 Get the default attributes for this class. This is useful if you want
11286 to use the same font or colour in your own control as in a standard
11287 control -- which is a much better idea than hard coding specific
11288 colours or fonts which might look completely out of place on the
11289 user's system, especially if it uses themes.
11291 The variant parameter is only relevant under Mac currently and is
11292 ignore under other platforms. Under Mac, it will change the size of
11293 the returned font. See `wx.Window.SetWindowVariant` for more about
11296 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11298 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11299 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11300 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11301 _core_
.Control_swigregister(Control
)
11302 ControlNameStr
= cvar
.ControlNameStr
11304 def PreControl(*args
, **kwargs
):
11306 PreControl() -> Control
11308 Precreate a Control control for 2-phase creation
11310 val
= _core_
.new_PreControl(*args
, **kwargs
)
11313 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11315 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11317 Get the default attributes for this class. This is useful if you want
11318 to use the same font or colour in your own control as in a standard
11319 control -- which is a much better idea than hard coding specific
11320 colours or fonts which might look completely out of place on the
11321 user's system, especially if it uses themes.
11323 The variant parameter is only relevant under Mac currently and is
11324 ignore under other platforms. Under Mac, it will change the size of
11325 the returned font. See `wx.Window.SetWindowVariant` for more about
11328 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11330 #---------------------------------------------------------------------------
11332 class ItemContainer(object):
11334 The wx.ItemContainer class defines an interface which is implemented
11335 by all controls which have string subitems, each of which may be
11336 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11337 as `wx.ComboBox` which implements an extended interface deriving from
11340 It defines the methods for accessing the control's items and although
11341 each of the derived classes implements them differently, they still
11342 all conform to the same interface.
11344 The items in a wx.ItemContainer have (non empty) string labels and,
11345 optionally, client data associated with them.
11348 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11349 def __init__(self
): raise AttributeError, "No constructor defined"
11350 __repr__
= _swig_repr
11351 def Append(*args
, **kwargs
):
11353 Append(self, String item, PyObject clientData=None) -> int
11355 Adds the item to the control, associating the given data with the item
11356 if not None. The return value is the index of the newly added item
11357 which may be different from the last one if the control is sorted (e.g.
11358 has wx.LB_SORT or wx.CB_SORT style).
11360 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11362 def AppendItems(*args
, **kwargs
):
11364 AppendItems(self, List strings)
11366 Apend several items at once to the control. Notice that calling this
11367 method may be much faster than appending the items one by one if you
11368 need to add a lot of items.
11370 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11372 def Insert(*args
, **kwargs
):
11374 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11376 Insert an item into the control before the item at the ``pos`` index,
11377 optionally associating some data object with the item.
11379 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11381 def Clear(*args
, **kwargs
):
11385 Removes all items from the control.
11387 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11389 def Delete(*args
, **kwargs
):
11391 Delete(self, unsigned int n)
11393 Deletes the item at the zero-based index 'n' from the control. Note
11394 that it is an error (signalled by a `wx.PyAssertionError` exception if
11395 enabled) to remove an item with the index negative or greater or equal
11396 than the number of items in the control.
11398 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11400 def GetClientData(*args
, **kwargs
):
11402 GetClientData(self, unsigned int n) -> PyObject
11404 Returns the client data associated with the given item, (if any.)
11406 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11408 def SetClientData(*args
, **kwargs
):
11410 SetClientData(self, unsigned int n, PyObject clientData)
11412 Associate the given client data with the item at position n.
11414 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11416 def GetCount(*args
, **kwargs
):
11418 GetCount(self) -> unsigned int
11420 Returns the number of items in the control.
11422 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11424 def IsEmpty(*args
, **kwargs
):
11426 IsEmpty(self) -> bool
11428 Returns True if the control is empty or False if it has some items.
11430 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11432 def GetString(*args
, **kwargs
):
11434 GetString(self, unsigned int n) -> String
11436 Returns the label of the item with the given index.
11438 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11440 def GetStrings(*args
, **kwargs
):
11441 """GetStrings(self) -> wxArrayString"""
11442 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11444 def SetString(*args
, **kwargs
):
11446 SetString(self, unsigned int n, String s)
11448 Sets the label for the given item.
11450 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11452 def FindString(*args
, **kwargs
):
11454 FindString(self, String s) -> int
11456 Finds an item whose label matches the given string. Returns the
11457 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11460 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11462 def SetSelection(*args
, **kwargs
):
11464 SetSelection(self, int n)
11466 Sets the item at index 'n' to be the selected item.
11468 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11470 def GetSelection(*args
, **kwargs
):
11472 GetSelection(self) -> int
11474 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11477 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11479 def SetStringSelection(*args
, **kwargs
):
11480 """SetStringSelection(self, String s) -> bool"""
11481 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11483 def GetStringSelection(*args
, **kwargs
):
11485 GetStringSelection(self) -> String
11487 Returns the label of the selected item or an empty string if no item
11490 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11492 def Select(*args
, **kwargs
):
11494 Select(self, int n)
11496 This is the same as `SetSelection` and exists only because it is
11497 slightly more natural for controls which support multiple selection.
11499 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11501 def GetItems(self
):
11502 """Return a list of the strings in the control"""
11503 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11505 def SetItems(self
, items
):
11506 """Clear and set the strings in the control from a list"""
11511 Count
= property(GetCount
,doc
="See `GetCount`")
11512 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11513 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11514 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11515 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11516 _core_
.ItemContainer_swigregister(ItemContainer
)
11518 #---------------------------------------------------------------------------
11520 class ControlWithItems(Control
,ItemContainer
):
11522 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11523 wx.Control class, and is used for the base class of various controls
11526 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11527 def __init__(self
): raise AttributeError, "No constructor defined"
11528 __repr__
= _swig_repr
11529 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11531 #---------------------------------------------------------------------------
11533 class SizerItem(Object
):
11535 The wx.SizerItem class is used to track the position, size and other
11536 attributes of each item managed by a `wx.Sizer`. It is not usually
11537 necessary to use this class because the sizer elements can also be
11538 identified by their positions or window or sizer references but
11539 sometimes it may be more convenient to use wx.SizerItem directly.
11540 Also, custom classes derived from `wx.PySizer` will probably need to
11541 use the collection of wx.SizerItems held by wx.Sizer when calculating
11544 :see: `wx.Sizer`, `wx.GBSizerItem`
11546 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11547 __repr__
= _swig_repr
11548 def __init__(self
, *args
, **kwargs
):
11550 __init__(self) -> SizerItem
11552 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11553 size will need to be set before this item can be used in a Sizer.
11555 You will probably never need to create a wx.SizerItem directly as they
11556 are created automatically when the sizer's Add, Insert or Prepend
11557 methods are called.
11559 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11561 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11562 __swig_destroy__
= _core_
.delete_SizerItem
11563 __del__
= lambda self
: None;
11564 def DeleteWindows(*args
, **kwargs
):
11566 DeleteWindows(self)
11568 Destroy the window or the windows in a subsizer, depending on the type
11571 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11573 def DetachSizer(*args
, **kwargs
):
11577 Enable deleting the SizerItem without destroying the contained sizer.
11579 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11581 def GetSize(*args
, **kwargs
):
11583 GetSize(self) -> Size
11585 Get the current size of the item, as set in the last Layout.
11587 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11589 def CalcMin(*args
, **kwargs
):
11591 CalcMin(self) -> Size
11593 Calculates the minimum desired size for the item, including any space
11596 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11598 def SetDimension(*args
, **kwargs
):
11600 SetDimension(self, Point pos, Size size)
11602 Set the position and size of the space allocated for this item by the
11603 sizer, and adjust the position and size of the item (window or
11604 subsizer) to be within that space taking alignment and borders into
11607 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11609 def GetMinSize(*args
, **kwargs
):
11611 GetMinSize(self) -> Size
11613 Get the minimum size needed for the item.
11615 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11617 def GetMinSizeWithBorder(*args
, **kwargs
):
11619 GetMinSizeWithBorder(self) -> Size
11621 Get the minimum size needed for the item with space for the borders
11624 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11626 def SetInitSize(*args
, **kwargs
):
11627 """SetInitSize(self, int x, int y)"""
11628 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11630 def SetRatioWH(*args
, **kwargs
):
11632 SetRatioWH(self, int width, int height)
11634 Set the ratio item attribute.
11636 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11638 def SetRatioSize(*args
, **kwargs
):
11640 SetRatioSize(self, Size size)
11642 Set the ratio item attribute.
11644 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11646 def SetRatio(*args
, **kwargs
):
11648 SetRatio(self, float ratio)
11650 Set the ratio item attribute.
11652 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11654 def GetRatio(*args
, **kwargs
):
11656 GetRatio(self) -> float
11658 Set the ratio item attribute.
11660 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11662 def GetRect(*args
, **kwargs
):
11664 GetRect(self) -> Rect
11666 Returns the rectangle that the sizer item should occupy
11668 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11670 def IsWindow(*args
, **kwargs
):
11672 IsWindow(self) -> bool
11674 Is this sizer item a window?
11676 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11678 def IsSizer(*args
, **kwargs
):
11680 IsSizer(self) -> bool
11682 Is this sizer item a subsizer?
11684 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11686 def IsSpacer(*args
, **kwargs
):
11688 IsSpacer(self) -> bool
11690 Is this sizer item a spacer?
11692 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11694 def SetProportion(*args
, **kwargs
):
11696 SetProportion(self, int proportion)
11698 Set the proportion value for this item.
11700 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11702 def GetProportion(*args
, **kwargs
):
11704 GetProportion(self) -> int
11706 Get the proportion value for this item.
11708 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11710 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11711 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11712 def SetFlag(*args
, **kwargs
):
11714 SetFlag(self, int flag)
11716 Set the flag value for this item.
11718 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11720 def GetFlag(*args
, **kwargs
):
11722 GetFlag(self) -> int
11724 Get the flag value for this item.
11726 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11728 def SetBorder(*args
, **kwargs
):
11730 SetBorder(self, int border)
11732 Set the border value for this item.
11734 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11736 def GetBorder(*args
, **kwargs
):
11738 GetBorder(self) -> int
11740 Get the border value for this item.
11742 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11744 def GetWindow(*args
, **kwargs
):
11746 GetWindow(self) -> Window
11748 Get the window (if any) that is managed by this sizer item.
11750 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11752 def SetWindow(*args
, **kwargs
):
11754 SetWindow(self, Window window)
11756 Set the window to be managed by this sizer item.
11758 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11760 def GetSizer(*args
, **kwargs
):
11762 GetSizer(self) -> Sizer
11764 Get the subsizer (if any) that is managed by this sizer item.
11766 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11768 def SetSizer(*args
, **kwargs
):
11770 SetSizer(self, Sizer sizer)
11772 Set the subsizer to be managed by this sizer item.
11774 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11776 def GetSpacer(*args
, **kwargs
):
11778 GetSpacer(self) -> Size
11780 Get the size of the spacer managed by this sizer item.
11782 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11784 def SetSpacer(*args
, **kwargs
):
11786 SetSpacer(self, Size size)
11788 Set the size of the spacer to be managed by this sizer item.
11790 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11792 def Show(*args
, **kwargs
):
11794 Show(self, bool show)
11796 Set the show item attribute, which sizers use to determine if the item
11797 is to be made part of the layout or not. If the item is tracking a
11798 window then it is shown or hidden as needed.
11800 return _core_
.SizerItem_Show(*args
, **kwargs
)
11802 def IsShown(*args
, **kwargs
):
11804 IsShown(self) -> bool
11806 Is the item to be shown in the layout?
11808 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11810 def GetPosition(*args
, **kwargs
):
11812 GetPosition(self) -> Point
11814 Returns the current position of the item, as set in the last Layout.
11816 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11818 def GetUserData(*args
, **kwargs
):
11820 GetUserData(self) -> PyObject
11822 Returns the userData associated with this sizer item, or None if there
11825 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11827 def SetUserData(*args
, **kwargs
):
11829 SetUserData(self, PyObject userData)
11831 Associate a Python object with this sizer item.
11833 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11835 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11836 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11837 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11838 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11839 Position
= property(GetPosition
,doc
="See `GetPosition`")
11840 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11841 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11842 Rect
= property(GetRect
,doc
="See `GetRect`")
11843 Size
= property(GetSize
,doc
="See `GetSize`")
11844 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11845 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11846 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11847 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11848 _core_
.SizerItem_swigregister(SizerItem
)
11850 def SizerItemWindow(*args
, **kwargs
):
11852 SizerItemWindow(Window window, int proportion, int flag, int border,
11853 PyObject userData=None) -> SizerItem
11855 Constructs a `wx.SizerItem` for tracking a window.
11857 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11860 def SizerItemSpacer(*args
, **kwargs
):
11862 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11863 PyObject userData=None) -> SizerItem
11865 Constructs a `wx.SizerItem` for tracking a spacer.
11867 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11870 def SizerItemSizer(*args
, **kwargs
):
11872 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11873 PyObject userData=None) -> SizerItem
11875 Constructs a `wx.SizerItem` for tracking a subsizer
11877 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11880 class Sizer(Object
):
11882 wx.Sizer is the abstract base class used for laying out subwindows in
11883 a window. You cannot use wx.Sizer directly; instead, you will have to
11884 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11885 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11888 The concept implemented by sizers in wxWidgets is closely related to
11889 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11890 toolkit or the Qt toolkit. It is based upon the idea of the individual
11891 subwindows reporting their minimal required size and their ability to
11892 get stretched if the size of the parent window has changed. This will
11893 most often mean that the programmer does not set the original size of
11894 a dialog in the beginning, rather the dialog will assigned a sizer and
11895 this sizer will be queried about the recommended size. The sizer in
11896 turn will query its children, which can be normal windows or contorls,
11897 empty space or other sizers, so that a hierarchy of sizers can be
11898 constructed. Note that wxSizer does not derive from wxWindow and thus
11899 do not interfere with tab ordering and requires very little resources
11900 compared to a real window on screen.
11902 What makes sizers so well fitted for use in wxWidgets is the fact that
11903 every control reports its own minimal size and the algorithm can
11904 handle differences in font sizes or different window (dialog item)
11905 sizes on different platforms without problems. If for example the
11906 standard font as well as the overall design of Mac widgets requires
11907 more space than on Windows, then the initial size of a dialog using a
11908 sizer will automatically be bigger on Mac than on Windows.
11910 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11911 def __init__(self
): raise AttributeError, "No constructor defined"
11912 __repr__
= _swig_repr
11913 __swig_destroy__
= _core_
.delete_Sizer
11914 __del__
= lambda self
: None;
11915 def _setOORInfo(*args
, **kwargs
):
11916 """_setOORInfo(self, PyObject _self)"""
11917 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11919 def Add(*args
, **kwargs
):
11921 Add(self, item, int proportion=0, int flag=0, int border=0,
11922 PyObject userData=None) -> wx.SizerItem
11924 Appends a child item to the sizer.
11926 return _core_
.Sizer_Add(*args
, **kwargs
)
11928 def Insert(*args
, **kwargs
):
11930 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11931 PyObject userData=None) -> wx.SizerItem
11933 Inserts a new item into the list of items managed by this sizer before
11934 the item at index *before*. See `Add` for a description of the parameters.
11936 return _core_
.Sizer_Insert(*args
, **kwargs
)
11938 def Prepend(*args
, **kwargs
):
11940 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11941 PyObject userData=None) -> wx.SizerItem
11943 Adds a new item to the begining of the list of sizer items managed by
11944 this sizer. See `Add` for a description of the parameters.
11946 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11948 def Remove(*args
, **kwargs
):
11950 Remove(self, item) -> bool
11952 Removes an item from the sizer and destroys it. This method does not
11953 cause any layout or resizing to take place, call `Layout` to update
11954 the layout on screen after removing a child from the sizer. The
11955 *item* parameter can be either a window, a sizer, or the zero-based
11956 index of an item to remove. Returns True if the child item was found
11959 return _core_
.Sizer_Remove(*args
, **kwargs
)
11961 def Detach(*args
, **kwargs
):
11963 Detach(self, item) -> bool
11965 Detaches an item from the sizer without destroying it. This method
11966 does not cause any layout or resizing to take place, call `Layout` to
11967 do so. The *item* parameter can be either a window, a sizer, or the
11968 zero-based index of the item to be detached. Returns True if the child item
11969 was found and detached.
11971 return _core_
.Sizer_Detach(*args
, **kwargs
)
11973 def GetItem(*args
, **kwargs
):
11975 GetItem(self, item) -> wx.SizerItem
11977 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11978 parameter can be either a window, a sizer, or the zero-based index of
11979 the item to be found.
11981 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11983 def _SetItemMinSize(*args
, **kwargs
):
11984 """_SetItemMinSize(self, PyObject item, Size size)"""
11985 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11987 def _ReplaceWin(*args
, **kwargs
):
11988 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11989 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
11991 def _ReplaceSizer(*args
, **kwargs
):
11992 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11993 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
11995 def _ReplaceItem(*args
, **kwargs
):
11996 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11997 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
11999 def Replace(self
, olditem
, item
, recursive
=False):
12001 Detaches the given ``olditem`` from the sizer and replaces it with
12002 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12003 detached child is destroyed only if it is not a window, (because
12004 windows are owned by their parent, not the sizer.) The
12005 ``recursive`` parameter can be used to search for the given
12006 element recursivly in subsizers.
12008 This method does not cause any layout or resizing to take place,
12009 call `Layout` to do so.
12011 Returns ``True`` if the child item was found and removed.
12013 if isinstance(olditem
, wx
.Window
):
12014 return self
._ReplaceWin
(olditem
, item
, recursive
)
12015 elif isinstnace(olditem
, wx
.Sizer
):
12016 return self
._ReplaceSizer
(olditem
, item
, recursive
)
12017 elif isinstnace(olditem
, int):
12018 return self
._ReplaceItem
(olditem
, item
)
12020 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12022 def SetContainingWindow(*args
, **kwargs
):
12024 SetContainingWindow(self, Window window)
12026 Set (or unset) the window this sizer is used in.
12028 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
12030 def GetContainingWindow(*args
, **kwargs
):
12032 GetContainingWindow(self) -> Window
12034 Get the window this sizer is used in.
12036 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
12038 def SetItemMinSize(self
, item
, *args
):
12040 SetItemMinSize(self, item, Size size)
12042 Sets the minimum size that will be allocated for an item in the sizer.
12043 The *item* parameter can be either a window, a sizer, or the
12044 zero-based index of the item. If a window or sizer is given then it
12045 will be searched for recursivly in subsizers if neccessary.
12048 # for backward compatibility accept separate width,height args too
12049 return self
._SetItemMinSize
(item
, args
)
12051 return self
._SetItemMinSize
(item
, args
[0])
12053 def AddItem(*args
, **kwargs
):
12055 AddItem(self, SizerItem item)
12057 Adds a `wx.SizerItem` to the sizer.
12059 return _core_
.Sizer_AddItem(*args
, **kwargs
)
12061 def InsertItem(*args
, **kwargs
):
12063 InsertItem(self, int index, SizerItem item)
12065 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12067 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
12069 def PrependItem(*args
, **kwargs
):
12071 PrependItem(self, SizerItem item)
12073 Prepends a `wx.SizerItem` to the sizer.
12075 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
12077 def AddMany(self
, items
):
12079 AddMany is a convenience method for adding several items
12080 to a sizer at one time. Simply pass it a list of tuples,
12081 where each tuple consists of the parameters that you
12082 would normally pass to the `Add` method.
12085 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
12089 def AddSpacer(self
, *args
, **kw
):
12090 """AddSpacer(int size) --> SizerItem
12092 Add a spacer that is (size,size) pixels.
12094 if args
and type(args
[0]) == int:
12095 return self
.Add( (args
[0],args
[0] ), 0)
12096 else: # otherwise stay compatible with old AddSpacer
12097 return self
.Add(*args
, **kw
)
12098 def PrependSpacer(self
, *args
, **kw
):
12099 """PrependSpacer(int size) --> SizerItem
12101 Prepend a spacer that is (size, size) pixels."""
12102 if args
and type(args
[0]) == int:
12103 return self
.Prepend( (args
[0],args
[0] ), 0)
12104 else: # otherwise stay compatible with old PrependSpacer
12105 return self
.Prepend(*args
, **kw
)
12106 def InsertSpacer(self
, index
, *args
, **kw
):
12107 """InsertSpacer(int index, int size) --> SizerItem
12109 Insert a spacer at position index that is (size, size) pixels."""
12110 if args
and type(args
[0]) == int:
12111 return self
.Insert( index
, (args
[0],args
[0] ), 0)
12112 else: # otherwise stay compatible with old InsertSpacer
12113 return self
.Insert(index
, *args
, **kw
)
12116 def AddStretchSpacer(self
, prop
=1):
12117 """AddStretchSpacer(int prop=1) --> SizerItem
12119 Add a stretchable spacer."""
12120 return self
.Add((0,0), prop
)
12121 def PrependStretchSpacer(self
, prop
=1):
12122 """PrependStretchSpacer(int prop=1) --> SizerItem
12124 Prepend a stretchable spacer."""
12125 return self
.Prepend((0,0), prop
)
12126 def InsertStretchSpacer(self
, index
, prop
=1):
12127 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12129 Insert a stretchable spacer."""
12130 return self
.Insert(index
, (0,0), prop
)
12133 # for backwards compatibility only, please do not use in new code
12134 def AddWindow(self
, *args
, **kw
):
12135 """Compatibility alias for `Add`."""
12136 return self
.Add(*args
, **kw
)
12137 def AddSizer(self
, *args
, **kw
):
12138 """Compatibility alias for `Add`."""
12139 return self
.Add(*args
, **kw
)
12141 def PrependWindow(self
, *args
, **kw
):
12142 """Compatibility alias for `Prepend`."""
12143 return self
.Prepend(*args
, **kw
)
12144 def PrependSizer(self
, *args
, **kw
):
12145 """Compatibility alias for `Prepend`."""
12146 return self
.Prepend(*args
, **kw
)
12148 def InsertWindow(self
, *args
, **kw
):
12149 """Compatibility alias for `Insert`."""
12150 return self
.Insert(*args
, **kw
)
12151 def InsertSizer(self
, *args
, **kw
):
12152 """Compatibility alias for `Insert`."""
12153 return self
.Insert(*args
, **kw
)
12155 def RemoveWindow(self
, *args
, **kw
):
12156 """Compatibility alias for `Remove`."""
12157 return self
.Remove(*args
, **kw
)
12158 def RemoveSizer(self
, *args
, **kw
):
12159 """Compatibility alias for `Remove`."""
12160 return self
.Remove(*args
, **kw
)
12161 def RemovePos(self
, *args
, **kw
):
12162 """Compatibility alias for `Remove`."""
12163 return self
.Remove(*args
, **kw
)
12166 def SetDimension(*args
, **kwargs
):
12168 SetDimension(self, int x, int y, int width, int height)
12170 Call this to force the sizer to take the given dimension and thus
12171 force the items owned by the sizer to resize themselves according to
12172 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12175 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
12177 def SetMinSize(*args
, **kwargs
):
12179 SetMinSize(self, Size size)
12181 Call this to give the sizer a minimal size. Normally, the sizer will
12182 calculate its minimal size based purely on how much space its children
12183 need. After calling this method `GetMinSize` will return either the
12184 minimal size as requested by its children or the minimal size set
12185 here, depending on which is bigger.
12187 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
12189 def GetSize(*args
, **kwargs
):
12191 GetSize(self) -> Size
12193 Returns the current size of the space managed by the sizer.
12195 return _core_
.Sizer_GetSize(*args
, **kwargs
)
12197 def GetPosition(*args
, **kwargs
):
12199 GetPosition(self) -> Point
12201 Returns the current position of the sizer's managed space.
12203 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
12205 def GetMinSize(*args
, **kwargs
):
12207 GetMinSize(self) -> Size
12209 Returns the minimal size of the sizer. This is either the combined
12210 minimal size of all the children and their borders or the minimal size
12211 set by SetMinSize, depending on which is bigger.
12213 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
12215 def GetSizeTuple(self
):
12216 return self
.GetSize().Get()
12217 def GetPositionTuple(self
):
12218 return self
.GetPosition().Get()
12219 def GetMinSizeTuple(self
):
12220 return self
.GetMinSize().Get()
12222 def RecalcSizes(*args
, **kwargs
):
12226 Using the sizes calculated by `CalcMin` reposition and resize all the
12227 items managed by this sizer. You should not need to call this directly as
12228 it is called by `Layout`.
12230 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
12232 def CalcMin(*args
, **kwargs
):
12234 CalcMin(self) -> Size
12236 This method is where the sizer will do the actual calculation of its
12237 children's minimal sizes. You should not need to call this directly as
12238 it is called by `Layout`.
12240 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
12242 def Layout(*args
, **kwargs
):
12246 This method will force the recalculation and layout of the items
12247 controlled by the sizer using the current space allocated to the
12248 sizer. Normally this is called automatically from the owning window's
12249 EVT_SIZE handler, but it is also useful to call it from user code when
12250 one of the items in a sizer change size, or items are added or
12253 return _core_
.Sizer_Layout(*args
, **kwargs
)
12255 def Fit(*args
, **kwargs
):
12257 Fit(self, Window window) -> Size
12259 Tell the sizer to resize the *window* to match the sizer's minimal
12260 size. This is commonly done in the constructor of the window itself in
12261 order to set its initial size to match the needs of the children as
12262 determined by the sizer. Returns the new size.
12264 For a top level window this is the total window size, not the client size.
12266 return _core_
.Sizer_Fit(*args
, **kwargs
)
12268 def FitInside(*args
, **kwargs
):
12270 FitInside(self, Window window)
12272 Tell the sizer to resize the *virtual size* of the *window* to match the
12273 sizer's minimal size. This will not alter the on screen size of the
12274 window, but may cause the addition/removal/alteration of scrollbars
12275 required to view the virtual area in windows which manage it.
12277 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12280 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12282 def SetSizeHints(*args
, **kwargs
):
12284 SetSizeHints(self, Window window)
12286 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12287 match the sizer's minimal size. This is commonly done in the
12288 constructor of the window itself if the window is resizable (as are
12289 many dialogs under Unix and frames on probably all platforms) in order
12290 to prevent the window from being sized smaller than the minimal size
12291 required by the sizer.
12293 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12295 def SetVirtualSizeHints(*args
, **kwargs
):
12297 SetVirtualSizeHints(self, Window window)
12299 Tell the sizer to set the minimal size of the window virtual area to
12300 match the sizer's minimal size. For windows with managed scrollbars
12301 this will set them appropriately.
12303 :see: `wx.ScrolledWindow.SetScrollbars`
12306 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12308 def Clear(*args
, **kwargs
):
12310 Clear(self, bool deleteWindows=False)
12312 Clear all items from the sizer, optionally destroying the window items
12315 return _core_
.Sizer_Clear(*args
, **kwargs
)
12317 def DeleteWindows(*args
, **kwargs
):
12319 DeleteWindows(self)
12321 Destroy all windows managed by the sizer.
12323 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12325 def GetChildren(*args
, **kwargs
):
12327 GetChildren(self) -> list
12329 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12331 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12333 def Show(*args
, **kwargs
):
12335 Show(self, item, bool show=True, bool recursive=false) -> bool
12337 Shows or hides an item managed by the sizer. To make a sizer item
12338 disappear or reappear, use Show followed by `Layout`. The *item*
12339 parameter can be either a window, a sizer, or the zero-based index of
12340 the item. Use the recursive parameter to show or hide an item in a
12341 subsizer. Returns True if the item was found.
12343 return _core_
.Sizer_Show(*args
, **kwargs
)
12345 def IsShown(*args
, **kwargs
):
12347 IsShown(self, item)
12349 Determines if the item is currently shown. To make a sizer
12350 item disappear or reappear, use Show followed by `Layout`. The *item*
12351 parameter can be either a window, a sizer, or the zero-based index of
12354 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12356 def Hide(self
, item
, recursive
=False):
12358 A convenience method for `Show` (item, False, recursive).
12360 return self
.Show(item
, False, recursive
)
12362 def ShowItems(*args
, **kwargs
):
12364 ShowItems(self, bool show)
12366 Recursively call `wx.SizerItem.Show` on all sizer items.
12368 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12370 Children
= property(GetChildren
,doc
="See `GetChildren`")
12371 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12372 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12373 Position
= property(GetPosition
,doc
="See `GetPosition`")
12374 Size
= property(GetSize
,doc
="See `GetSize`")
12375 _core_
.Sizer_swigregister(Sizer
)
12377 class PySizer(Sizer
):
12379 wx.PySizer is a special version of `wx.Sizer` that has been
12380 instrumented to allow the C++ virtual methods to be overloaded in
12381 Python derived classes. You would derive from this class if you are
12382 wanting to implement a custom sizer in Python code. Simply implement
12383 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12386 class MySizer(wx.PySizer):
12387 def __init__(self):
12388 wx.PySizer.__init__(self)
12391 for item in self.GetChildren():
12392 # calculate the total minimum width and height needed
12393 # by all items in the sizer according to this sizer's
12394 # layout algorithm.
12396 return wx.Size(width, height)
12398 def RecalcSizes(self):
12399 # find the space allotted to this sizer
12400 pos = self.GetPosition()
12401 size = self.GetSize()
12402 for item in self.GetChildren():
12403 # Recalculate (if necessary) the position and size of
12404 # each item and then call item.SetDimension to do the
12405 # actual positioning and sizing of the items within the
12406 # space alloted to this sizer.
12408 item.SetDimension(itemPos, itemSize)
12411 When `Layout` is called it first calls `CalcMin` followed by
12412 `RecalcSizes` so you can optimize a bit by saving the results of
12413 `CalcMin` and reusing them in `RecalcSizes`.
12415 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12419 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12420 __repr__
= _swig_repr
12421 def __init__(self
, *args
, **kwargs
):
12423 __init__(self) -> PySizer
12425 Creates a wx.PySizer. Must be called from the __init__ in the derived
12428 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12429 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12431 def _setCallbackInfo(*args
, **kwargs
):
12432 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12433 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12435 _core_
.PySizer_swigregister(PySizer
)
12437 #---------------------------------------------------------------------------
12439 class BoxSizer(Sizer
):
12441 The basic idea behind a box sizer is that windows will most often be
12442 laid out in rather simple basic geometry, typically in a row or a
12443 column or nested hierarchies of either. A wx.BoxSizer will lay out
12444 its items in a simple row or column, depending on the orientation
12445 parameter passed to the constructor.
12447 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12448 __repr__
= _swig_repr
12449 def __init__(self
, *args
, **kwargs
):
12451 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12453 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12454 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12457 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12458 self
._setOORInfo
(self
)
12460 def GetOrientation(*args
, **kwargs
):
12462 GetOrientation(self) -> int
12464 Returns the current orientation of the sizer.
12466 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12468 def SetOrientation(*args
, **kwargs
):
12470 SetOrientation(self, int orient)
12472 Resets the orientation of the sizer.
12474 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12476 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12477 _core_
.BoxSizer_swigregister(BoxSizer
)
12479 #---------------------------------------------------------------------------
12481 class StaticBoxSizer(BoxSizer
):
12483 wx.StaticBoxSizer derives from and functions identically to the
12484 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12485 manages. Note that this static box must be created separately and
12486 passed to the sizer constructor.
12488 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12489 __repr__
= _swig_repr
12490 def __init__(self
, *args
, **kwargs
):
12492 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12494 Constructor. It takes an associated static box and the orientation
12495 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12498 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12499 self
._setOORInfo
(self
)
12501 def GetStaticBox(*args
, **kwargs
):
12503 GetStaticBox(self) -> StaticBox
12505 Returns the static box associated with this sizer.
12507 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12509 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12510 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12512 #---------------------------------------------------------------------------
12514 class GridSizer(Sizer
):
12516 A grid sizer is a sizer which lays out its children in a
12517 two-dimensional table with all cells having the same size. In other
12518 words, the width of each cell within the grid is the width of the
12519 widest item added to the sizer and the height of each grid cell is the
12520 height of the tallest item. An optional vertical and/or horizontal
12521 gap between items can also be specified (in pixels.)
12523 Items are placed in the cells of the grid in the order they are added,
12524 in row-major order. In other words, the first row is filled first,
12525 then the second, and so on until all items have been added. (If
12526 neccessary, additional rows will be added as items are added.) If you
12527 need to have greater control over the cells that items are placed in
12528 then use the `wx.GridBagSizer`.
12531 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12532 __repr__
= _swig_repr
12533 def __init__(self
, *args
, **kwargs
):
12535 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12537 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12538 of columns and rows in the sizer - if either of the parameters is
12539 zero, it will be calculated to from the total number of children in
12540 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12541 define extra space between all children.
12543 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12544 self
._setOORInfo
(self
)
12546 def SetCols(*args
, **kwargs
):
12548 SetCols(self, int cols)
12550 Sets the number of columns in the sizer.
12552 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12554 def SetRows(*args
, **kwargs
):
12556 SetRows(self, int rows)
12558 Sets the number of rows in the sizer.
12560 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12562 def SetVGap(*args
, **kwargs
):
12564 SetVGap(self, int gap)
12566 Sets the vertical gap (in pixels) between the cells in the sizer.
12568 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12570 def SetHGap(*args
, **kwargs
):
12572 SetHGap(self, int gap)
12574 Sets the horizontal gap (in pixels) between cells in the sizer
12576 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12578 def GetCols(*args
, **kwargs
):
12580 GetCols(self) -> int
12582 Returns the number of columns in the sizer.
12584 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12586 def GetRows(*args
, **kwargs
):
12588 GetRows(self) -> int
12590 Returns the number of rows in the sizer.
12592 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12594 def GetVGap(*args
, **kwargs
):
12596 GetVGap(self) -> int
12598 Returns the vertical gap (in pixels) between the cells in the sizer.
12600 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12602 def GetHGap(*args
, **kwargs
):
12604 GetHGap(self) -> int
12606 Returns the horizontal gap (in pixels) between cells in the sizer.
12608 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12610 def CalcRowsCols(self
):
12612 CalcRowsCols() -> (rows, cols)
12614 Calculates how many rows and columns will be in the sizer based
12615 on the current number of items and also the rows, cols specified
12616 in the constructor.
12618 nitems
= len(self
.GetChildren())
12619 rows
= self
.GetRows()
12620 cols
= self
.GetCols()
12621 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12623 rows
= (nitems
+ cols
- 1) / cols
12625 cols
= (nitems
+ rows
- 1) / rows
12626 return (rows
, cols
)
12628 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12629 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12630 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12631 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12632 _core_
.GridSizer_swigregister(GridSizer
)
12634 #---------------------------------------------------------------------------
12636 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12637 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12638 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12639 class FlexGridSizer(GridSizer
):
12641 A flex grid sizer is a sizer which lays out its children in a
12642 two-dimensional table with all table cells in one row having the same
12643 height and all cells in one column having the same width, but all
12644 rows or all columns are not necessarily the same height or width as in
12645 the `wx.GridSizer`.
12647 wx.FlexGridSizer can also size items equally in one direction but
12648 unequally ("flexibly") in the other. If the sizer is only flexible
12649 in one direction (this can be changed using `SetFlexibleDirection`), it
12650 needs to be decided how the sizer should grow in the other ("non
12651 flexible") direction in order to fill the available space. The
12652 `SetNonFlexibleGrowMode` method serves this purpose.
12656 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12657 __repr__
= _swig_repr
12658 def __init__(self
, *args
, **kwargs
):
12660 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12662 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12663 number of columns and rows in the sizer - if either of the parameters
12664 is zero, it will be calculated to from the total number of children in
12665 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12666 define extra space between all children.
12668 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12669 self
._setOORInfo
(self
)
12671 def AddGrowableRow(*args
, **kwargs
):
12673 AddGrowableRow(self, size_t idx, int proportion=0)
12675 Specifies that row *idx* (starting from zero) should be grown if there
12676 is extra space available to the sizer.
12678 The *proportion* parameter has the same meaning as the stretch factor
12679 for the box sizers except that if all proportions are 0, then all
12680 columns are resized equally (instead of not being resized at all).
12682 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12684 def RemoveGrowableRow(*args
, **kwargs
):
12686 RemoveGrowableRow(self, size_t idx)
12688 Specifies that row *idx* is no longer growable.
12690 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12692 def AddGrowableCol(*args
, **kwargs
):
12694 AddGrowableCol(self, size_t idx, int proportion=0)
12696 Specifies that column *idx* (starting from zero) should be grown if
12697 there is extra space available to the sizer.
12699 The *proportion* parameter has the same meaning as the stretch factor
12700 for the box sizers except that if all proportions are 0, then all
12701 columns are resized equally (instead of not being resized at all).
12703 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12705 def RemoveGrowableCol(*args
, **kwargs
):
12707 RemoveGrowableCol(self, size_t idx)
12709 Specifies that column *idx* is no longer growable.
12711 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12713 def SetFlexibleDirection(*args
, **kwargs
):
12715 SetFlexibleDirection(self, int direction)
12717 Specifies whether the sizer should flexibly resize its columns, rows,
12718 or both. Argument *direction* can be one of the following values. Any
12719 other value is ignored.
12721 ============== =======================================
12722 wx.VERTICAL Rows are flexibly sized.
12723 wx.HORIZONTAL Columns are flexibly sized.
12724 wx.BOTH Both rows and columns are flexibly sized
12725 (this is the default value).
12726 ============== =======================================
12728 Note that this method does not trigger relayout.
12731 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12733 def GetFlexibleDirection(*args
, **kwargs
):
12735 GetFlexibleDirection(self) -> int
12737 Returns a value that specifies whether the sizer
12738 flexibly resizes its columns, rows, or both (default).
12740 :see: `SetFlexibleDirection`
12742 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12744 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12746 SetNonFlexibleGrowMode(self, int mode)
12748 Specifies how the sizer should grow in the non-flexible direction if
12749 there is one (so `SetFlexibleDirection` must have been called
12750 previously). Argument *mode* can be one of the following values:
12752 ========================== =================================================
12753 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12754 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12755 `AddGrowableCol` and `AddGrowableRow`. In this
12756 case equal sizing applies to minimum sizes of
12757 columns or rows (this is the default value).
12758 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12759 the non flexible direction, whether they are
12760 growable or not in the flexbile direction.
12761 ========================== =================================================
12763 Note that this method does not trigger relayout.
12765 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12767 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12769 GetNonFlexibleGrowMode(self) -> int
12771 Returns the value that specifies how the sizer grows in the
12772 non-flexible direction if there is one.
12774 :see: `SetNonFlexibleGrowMode`
12776 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12778 def GetRowHeights(*args
, **kwargs
):
12780 GetRowHeights(self) -> list
12782 Returns a list of integers representing the heights of each of the
12785 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12787 def GetColWidths(*args
, **kwargs
):
12789 GetColWidths(self) -> list
12791 Returns a list of integers representing the widths of each of the
12792 columns in the sizer.
12794 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12796 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12797 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12798 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12799 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12800 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12802 class StdDialogButtonSizer(BoxSizer
):
12804 A special sizer that knows how to order and position standard buttons
12805 in order to conform to the current platform's standards. You simply
12806 need to add each `wx.Button` to the sizer, and be sure to create the
12807 buttons using the standard ID's. Then call `Realize` and the sizer
12808 will take care of the rest.
12811 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12812 __repr__
= _swig_repr
12813 def __init__(self
, *args
, **kwargs
):
12814 """__init__(self) -> StdDialogButtonSizer"""
12815 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12816 def AddButton(*args
, **kwargs
):
12818 AddButton(self, wxButton button)
12820 Use this to add the buttons to this sizer. Do not use the `Add`
12821 method in the base class.
12823 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12825 def Realize(*args
, **kwargs
):
12829 This funciton needs to be called after all the buttons have been added
12830 to the sizer. It will reorder them and position them in a platform
12833 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12835 def SetAffirmativeButton(*args
, **kwargs
):
12836 """SetAffirmativeButton(self, wxButton button)"""
12837 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12839 def SetNegativeButton(*args
, **kwargs
):
12840 """SetNegativeButton(self, wxButton button)"""
12841 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12843 def SetCancelButton(*args
, **kwargs
):
12844 """SetCancelButton(self, wxButton button)"""
12845 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12847 def GetAffirmativeButton(*args
, **kwargs
):
12848 """GetAffirmativeButton(self) -> wxButton"""
12849 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12851 def GetApplyButton(*args
, **kwargs
):
12852 """GetApplyButton(self) -> wxButton"""
12853 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12855 def GetNegativeButton(*args
, **kwargs
):
12856 """GetNegativeButton(self) -> wxButton"""
12857 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12859 def GetCancelButton(*args
, **kwargs
):
12860 """GetCancelButton(self) -> wxButton"""
12861 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12863 def GetHelpButton(*args
, **kwargs
):
12864 """GetHelpButton(self) -> wxButton"""
12865 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12867 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12868 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12869 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12870 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12871 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12872 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12874 #---------------------------------------------------------------------------
12876 class GBPosition(object):
12878 This class represents the position of an item in a virtual grid of
12879 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12880 typemaps that will automatically convert from a 2-element sequence of
12881 integers to a wx.GBPosition, so you can use the more pythonic
12882 representation of the position nearly transparently in Python code.
12884 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12885 __repr__
= _swig_repr
12886 def __init__(self
, *args
, **kwargs
):
12888 __init__(self, int row=0, int col=0) -> GBPosition
12890 This class represents the position of an item in a virtual grid of
12891 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12892 typemaps that will automatically convert from a 2-element sequence of
12893 integers to a wx.GBPosition, so you can use the more pythonic
12894 representation of the position nearly transparently in Python code.
12896 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12897 __swig_destroy__
= _core_
.delete_GBPosition
12898 __del__
= lambda self
: None;
12899 def GetRow(*args
, **kwargs
):
12900 """GetRow(self) -> int"""
12901 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12903 def GetCol(*args
, **kwargs
):
12904 """GetCol(self) -> int"""
12905 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12907 def SetRow(*args
, **kwargs
):
12908 """SetRow(self, int row)"""
12909 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12911 def SetCol(*args
, **kwargs
):
12912 """SetCol(self, int col)"""
12913 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12915 def __eq__(*args
, **kwargs
):
12917 __eq__(self, PyObject other) -> bool
12919 Compare GBPosition for equality.
12921 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12923 def __ne__(*args
, **kwargs
):
12925 __ne__(self, PyObject other) -> bool
12927 Compare GBPosition for inequality.
12929 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12931 def Set(*args
, **kwargs
):
12932 """Set(self, int row=0, int col=0)"""
12933 return _core_
.GBPosition_Set(*args
, **kwargs
)
12935 def Get(*args
, **kwargs
):
12936 """Get(self) -> PyObject"""
12937 return _core_
.GBPosition_Get(*args
, **kwargs
)
12939 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12940 def __str__(self
): return str(self
.Get())
12941 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12942 def __len__(self
): return len(self
.Get())
12943 def __getitem__(self
, index
): return self
.Get()[index
]
12944 def __setitem__(self
, index
, val
):
12945 if index
== 0: self
.SetRow(val
)
12946 elif index
== 1: self
.SetCol(val
)
12947 else: raise IndexError
12948 def __nonzero__(self
): return self
.Get() != (0,0)
12949 __safe_for_unpickling__
= True
12950 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12952 row
= property(GetRow
, SetRow
)
12953 col
= property(GetCol
, SetCol
)
12955 _core_
.GBPosition_swigregister(GBPosition
)
12957 class GBSpan(object):
12959 This class is used to hold the row and column spanning attributes of
12960 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12961 automatically convert from a 2-element sequence of integers to a
12962 wx.GBSpan, so you can use the more pythonic representation of the span
12963 nearly transparently in Python code.
12966 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12967 __repr__
= _swig_repr
12968 def __init__(self
, *args
, **kwargs
):
12970 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12972 Construct a new wxGBSpan, optionally setting the rowspan and
12973 colspan. The default is (1,1). (Meaning that the item occupies one
12974 cell in each direction.
12976 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12977 __swig_destroy__
= _core_
.delete_GBSpan
12978 __del__
= lambda self
: None;
12979 def GetRowspan(*args
, **kwargs
):
12980 """GetRowspan(self) -> int"""
12981 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12983 def GetColspan(*args
, **kwargs
):
12984 """GetColspan(self) -> int"""
12985 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12987 def SetRowspan(*args
, **kwargs
):
12988 """SetRowspan(self, int rowspan)"""
12989 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12991 def SetColspan(*args
, **kwargs
):
12992 """SetColspan(self, int colspan)"""
12993 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12995 def __eq__(*args
, **kwargs
):
12997 __eq__(self, PyObject other) -> bool
12999 Compare wxGBSpan for equality.
13001 return _core_
.GBSpan___eq__(*args
, **kwargs
)
13003 def __ne__(*args
, **kwargs
):
13005 __ne__(self, PyObject other) -> bool
13007 Compare GBSpan for inequality.
13009 return _core_
.GBSpan___ne__(*args
, **kwargs
)
13011 def Set(*args
, **kwargs
):
13012 """Set(self, int rowspan=1, int colspan=1)"""
13013 return _core_
.GBSpan_Set(*args
, **kwargs
)
13015 def Get(*args
, **kwargs
):
13016 """Get(self) -> PyObject"""
13017 return _core_
.GBSpan_Get(*args
, **kwargs
)
13019 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13020 def __str__(self
): return str(self
.Get())
13021 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
13022 def __len__(self
): return len(self
.Get())
13023 def __getitem__(self
, index
): return self
.Get()[index
]
13024 def __setitem__(self
, index
, val
):
13025 if index
== 0: self
.SetRowspan(val
)
13026 elif index
== 1: self
.SetColspan(val
)
13027 else: raise IndexError
13028 def __nonzero__(self
): return self
.Get() != (0,0)
13029 __safe_for_unpickling__
= True
13030 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
13032 rowspan
= property(GetRowspan
, SetRowspan
)
13033 colspan
= property(GetColspan
, SetColspan
)
13035 _core_
.GBSpan_swigregister(GBSpan
)
13037 class GBSizerItem(SizerItem
):
13039 The wx.GBSizerItem class is used to track the additional data about
13040 items in a `wx.GridBagSizer` such as the item's position in the grid
13041 and how many rows or columns it spans.
13044 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13045 __repr__
= _swig_repr
13046 def __init__(self
, *args
, **kwargs
):
13048 __init__(self) -> GBSizerItem
13050 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13051 size will need to be set, as well as a position and span before this
13052 item can be used in a Sizer.
13054 You will probably never need to create a wx.GBSizerItem directly as they
13055 are created automatically when the sizer's Add method is called.
13057 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
13058 __swig_destroy__
= _core_
.delete_GBSizerItem
13059 __del__
= lambda self
: None;
13060 def GetPos(*args
, **kwargs
):
13062 GetPos(self) -> GBPosition
13064 Get the grid position of the item
13066 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
13068 def GetPosTuple(self
): return self
.GetPos().Get()
13069 def GetSpan(*args
, **kwargs
):
13071 GetSpan(self) -> GBSpan
13073 Get the row and column spanning of the item
13075 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
13077 def GetSpanTuple(self
): return self
.GetSpan().Get()
13078 def SetPos(*args
, **kwargs
):
13080 SetPos(self, GBPosition pos) -> bool
13082 If the item is already a member of a sizer then first ensure that
13083 there is no other item that would intersect with this one at the new
13084 position, then set the new position. Returns True if the change is
13085 successful and after the next Layout() the item will be moved.
13087 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
13089 def SetSpan(*args
, **kwargs
):
13091 SetSpan(self, GBSpan span) -> bool
13093 If the item is already a member of a sizer then first ensure that
13094 there is no other item that would intersect with this one with its new
13095 spanning size, then set the new spanning. Returns True if the change
13096 is successful and after the next Layout() the item will be resized.
13099 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
13101 def Intersects(*args
, **kwargs
):
13103 Intersects(self, GBSizerItem other) -> bool
13105 Returns True if this item and the other item instersect.
13107 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
13109 def IntersectsPos(*args
, **kwargs
):
13111 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13113 Returns True if the given pos/span would intersect with this item.
13115 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
13117 def GetEndPos(*args
, **kwargs
):
13119 GetEndPos(self) -> GBPosition
13121 Get the row and column of the endpoint of this item.
13123 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
13125 def GetGBSizer(*args
, **kwargs
):
13127 GetGBSizer(self) -> GridBagSizer
13129 Get the sizer this item is a member of.
13131 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
13133 def SetGBSizer(*args
, **kwargs
):
13135 SetGBSizer(self, GridBagSizer sizer)
13137 Set the sizer this item is a member of.
13139 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
13141 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
13142 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
13143 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
13144 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
13145 _core_
.GBSizerItem_swigregister(GBSizerItem
)
13146 DefaultSpan
= cvar
.DefaultSpan
13148 def GBSizerItemWindow(*args
, **kwargs
):
13150 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13151 int border, PyObject userData=None) -> GBSizerItem
13153 Construct a `wx.GBSizerItem` for a window.
13155 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
13158 def GBSizerItemSizer(*args
, **kwargs
):
13160 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13161 int border, PyObject userData=None) -> GBSizerItem
13163 Construct a `wx.GBSizerItem` for a sizer
13165 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
13168 def GBSizerItemSpacer(*args
, **kwargs
):
13170 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13171 int flag, int border, PyObject userData=None) -> GBSizerItem
13173 Construct a `wx.GBSizerItem` for a spacer.
13175 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
13178 class GridBagSizer(FlexGridSizer
):
13180 A `wx.Sizer` that can lay out items in a virtual grid like a
13181 `wx.FlexGridSizer` but in this case explicit positioning of the items
13182 is allowed using `wx.GBPosition`, and items can optionally span more
13183 than one row and/or column using `wx.GBSpan`. The total size of the
13184 virtual grid is determined by the largest row and column that items are
13185 positioned at, adjusted for spanning.
13188 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13189 __repr__
= _swig_repr
13190 def __init__(self
, *args
, **kwargs
):
13192 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13194 Constructor, with optional parameters to specify the gap between the
13197 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
13198 self
._setOORInfo
(self
)
13200 def Add(*args
, **kwargs
):
13202 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13203 int border=0, userData=None) -> wx.GBSizerItem
13205 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13206 more than one row or column as specified with *span*. The remaining
13207 args behave similarly to `wx.Sizer.Add`.
13209 Returns True if the item was successfully placed at the given cell
13210 position, False if something was already there.
13213 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13215 def AddItem(*args
, **kwargs
):
13217 Add(self, GBSizerItem item) -> wx.GBSizerItem
13219 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13220 the item was successfully placed at its given cell position, False if
13221 something was already there.
13223 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13225 def GetCellSize(*args
, **kwargs
):
13227 GetCellSize(self, int row, int col) -> Size
13229 Get the size of the specified cell, including hgap and
13230 vgap. Only valid after a Layout.
13232 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13234 def GetEmptyCellSize(*args
, **kwargs
):
13236 GetEmptyCellSize(self) -> Size
13238 Get the size used for cells in the grid with no item.
13240 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13242 def SetEmptyCellSize(*args
, **kwargs
):
13244 SetEmptyCellSize(self, Size sz)
13246 Set the size used for cells in the grid with no item.
13248 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13250 def GetItemPosition(*args
):
13252 GetItemPosition(self, item) -> GBPosition
13254 Get the grid position of the specified *item* where *item* is either a
13255 window or subsizer that is a member of this sizer, or a zero-based
13258 return _core_
.GridBagSizer_GetItemPosition(*args
)
13260 def SetItemPosition(*args
):
13262 SetItemPosition(self, item, GBPosition pos) -> bool
13264 Set the grid position of the specified *item* where *item* is either a
13265 window or subsizer that is a member of this sizer, or a zero-based
13266 index of an item. Returns True on success. If the move is not
13267 allowed (because an item is already there) then False is returned.
13270 return _core_
.GridBagSizer_SetItemPosition(*args
)
13272 def GetItemSpan(*args
):
13274 GetItemSpan(self, item) -> GBSpan
13276 Get the row/col spanning of the specified *item* where *item* is
13277 either a window or subsizer that is a member of this sizer, or a
13278 zero-based index of an item.
13280 return _core_
.GridBagSizer_GetItemSpan(*args
)
13282 def SetItemSpan(*args
):
13284 SetItemSpan(self, item, GBSpan span) -> bool
13286 Set the row/col spanning of the specified *item* where *item* is
13287 either a window or subsizer that is a member of this sizer, or a
13288 zero-based index of an item. Returns True on success. If the move is
13289 not allowed (because an item is already there) then False is returned.
13291 return _core_
.GridBagSizer_SetItemSpan(*args
)
13293 def FindItem(*args
):
13295 FindItem(self, item) -> GBSizerItem
13297 Find the sizer item for the given window or subsizer, returns None if
13298 not found. (non-recursive)
13300 return _core_
.GridBagSizer_FindItem(*args
)
13302 def FindItemAtPosition(*args
, **kwargs
):
13304 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13306 Return the sizer item for the given grid cell, or None if there is no
13307 item at that position. (non-recursive)
13309 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13311 def FindItemAtPoint(*args
, **kwargs
):
13313 FindItemAtPoint(self, Point pt) -> GBSizerItem
13315 Return the sizer item located at the point given in *pt*, or None if
13316 there is no item at that point. The (x,y) coordinates in pt correspond
13317 to the client coordinates of the window using the sizer for
13318 layout. (non-recursive)
13320 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13322 def CheckForIntersection(*args
, **kwargs
):
13324 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13326 Look at all items and see if any intersect (or would overlap) the
13327 given *item*. Returns True if so, False if there would be no overlap.
13328 If an *excludeItem* is given then it will not be checked for
13329 intersection, for example it may be the item we are checking the
13333 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13335 def CheckForIntersectionPos(*args
, **kwargs
):
13337 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13339 Look at all items and see if any intersect (or would overlap) the
13340 given position and span. Returns True if so, False if there would be
13341 no overlap. If an *excludeItem* is given then it will not be checked
13342 for intersection, for example it may be the item we are checking the
13345 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13347 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13349 #---------------------------------------------------------------------------
13353 Right
= _core_
.Right
13354 Bottom
= _core_
.Bottom
13355 Width
= _core_
.Width
13356 Height
= _core_
.Height
13357 Centre
= _core_
.Centre
13358 Center
= _core_
.Center
13359 CentreX
= _core_
.CentreX
13360 CentreY
= _core_
.CentreY
13361 Unconstrained
= _core_
.Unconstrained
13363 PercentOf
= _core_
.PercentOf
13364 Above
= _core_
.Above
13365 Below
= _core_
.Below
13366 LeftOf
= _core_
.LeftOf
13367 RightOf
= _core_
.RightOf
13368 SameAs
= _core_
.SameAs
13369 Absolute
= _core_
.Absolute
13370 class IndividualLayoutConstraint(Object
):
13372 Objects of this class are stored in the `wx.LayoutConstraints` class as
13373 one of eight possible constraints that a window can be involved in.
13374 You will never need to create an instance of
13375 wx.IndividualLayoutConstraint, rather you should create a
13376 `wx.LayoutConstraints` instance and use the individual contstraints
13379 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13380 def __init__(self
): raise AttributeError, "No constructor defined"
13381 __repr__
= _swig_repr
13382 def Set(*args
, **kwargs
):
13384 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13386 Sets the properties of the constraint. Normally called by one of the
13387 convenience functions such as Above, RightOf, SameAs.
13389 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13391 def LeftOf(*args
, **kwargs
):
13393 LeftOf(self, Window sibling, int marg=0)
13395 Constrains this edge to be to the left of the given window, with an
13396 optional margin. Implicitly, this is relative to the left edge of the
13399 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13401 def RightOf(*args
, **kwargs
):
13403 RightOf(self, Window sibling, int marg=0)
13405 Constrains this edge to be to the right of the given window, with an
13406 optional margin. Implicitly, this is relative to the right edge of the
13409 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13411 def Above(*args
, **kwargs
):
13413 Above(self, Window sibling, int marg=0)
13415 Constrains this edge to be above the given window, with an optional
13416 margin. Implicitly, this is relative to the top edge of the other
13419 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13421 def Below(*args
, **kwargs
):
13423 Below(self, Window sibling, int marg=0)
13425 Constrains this edge to be below the given window, with an optional
13426 margin. Implicitly, this is relative to the bottom edge of the other
13429 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13431 def SameAs(*args
, **kwargs
):
13433 SameAs(self, Window otherW, int edge, int marg=0)
13435 Constrains this edge or dimension to be to the same as the edge of the
13436 given window, with an optional margin.
13438 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13440 def PercentOf(*args
, **kwargs
):
13442 PercentOf(self, Window otherW, int wh, int per)
13444 Constrains this edge or dimension to be to a percentage of the given
13445 window, with an optional margin.
13447 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13449 def Absolute(*args
, **kwargs
):
13451 Absolute(self, int val)
13453 Constrains this edge or dimension to be the given absolute value.
13455 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13457 def Unconstrained(*args
, **kwargs
):
13459 Unconstrained(self)
13461 Sets this edge or dimension to be unconstrained, that is, dependent on
13462 other edges and dimensions from which this value can be deduced.
13464 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13466 def AsIs(*args
, **kwargs
):
13470 Sets this edge or constraint to be whatever the window's value is at
13471 the moment. If either of the width and height constraints are *as is*,
13472 the window will not be resized, but moved instead. This is important
13473 when considering panel items which are intended to have a default
13474 size, such as a button, which may take its size from the size of the
13477 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13479 def GetOtherWindow(*args
, **kwargs
):
13480 """GetOtherWindow(self) -> Window"""
13481 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13483 def GetMyEdge(*args
, **kwargs
):
13484 """GetMyEdge(self) -> int"""
13485 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13487 def SetEdge(*args
, **kwargs
):
13488 """SetEdge(self, int which)"""
13489 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13491 def SetValue(*args
, **kwargs
):
13492 """SetValue(self, int v)"""
13493 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13495 def GetMargin(*args
, **kwargs
):
13496 """GetMargin(self) -> int"""
13497 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13499 def SetMargin(*args
, **kwargs
):
13500 """SetMargin(self, int m)"""
13501 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13503 def GetValue(*args
, **kwargs
):
13504 """GetValue(self) -> int"""
13505 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13507 def GetPercent(*args
, **kwargs
):
13508 """GetPercent(self) -> int"""
13509 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13511 def GetOtherEdge(*args
, **kwargs
):
13512 """GetOtherEdge(self) -> int"""
13513 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13515 def GetDone(*args
, **kwargs
):
13516 """GetDone(self) -> bool"""
13517 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13519 def SetDone(*args
, **kwargs
):
13520 """SetDone(self, bool d)"""
13521 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13523 def GetRelationship(*args
, **kwargs
):
13524 """GetRelationship(self) -> int"""
13525 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13527 def SetRelationship(*args
, **kwargs
):
13528 """SetRelationship(self, int r)"""
13529 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13531 def ResetIfWin(*args
, **kwargs
):
13533 ResetIfWin(self, Window otherW) -> bool
13535 Reset constraint if it mentions otherWin
13537 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13539 def SatisfyConstraint(*args
, **kwargs
):
13541 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13543 Try to satisfy constraint
13545 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13547 def GetEdge(*args
, **kwargs
):
13549 GetEdge(self, int which, Window thisWin, Window other) -> int
13551 Get the value of this edge or dimension, or if this
13552 is not determinable, -1.
13554 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13556 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13557 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13558 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13559 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13560 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13561 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13562 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13563 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13564 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13566 class LayoutConstraints(Object
):
13568 **Note:** constraints are now deprecated and you should use sizers
13571 Objects of this class can be associated with a window to define its
13572 layout constraints, with respect to siblings or its parent.
13574 The class consists of the following eight constraints of class
13575 wx.IndividualLayoutConstraint, some or all of which should be accessed
13576 directly to set the appropriate constraints.
13578 * left: represents the left hand edge of the window
13579 * right: represents the right hand edge of the window
13580 * top: represents the top edge of the window
13581 * bottom: represents the bottom edge of the window
13582 * width: represents the width of the window
13583 * height: represents the height of the window
13584 * centreX: represents the horizontal centre point of the window
13585 * centreY: represents the vertical centre point of the window
13587 Most constraints are initially set to have the relationship
13588 wxUnconstrained, which means that their values should be calculated by
13589 looking at known constraints. The exceptions are width and height,
13590 which are set to wxAsIs to ensure that if the user does not specify a
13591 constraint, the existing width and height will be used, to be
13592 compatible with panel items which often have take a default size. If
13593 the constraint is ``wx.AsIs``, the dimension will not be changed.
13595 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13598 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13599 __repr__
= _swig_repr
13600 left
= property(_core_
.LayoutConstraints_left_get
)
13601 top
= property(_core_
.LayoutConstraints_top_get
)
13602 right
= property(_core_
.LayoutConstraints_right_get
)
13603 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13604 width
= property(_core_
.LayoutConstraints_width_get
)
13605 height
= property(_core_
.LayoutConstraints_height_get
)
13606 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13607 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13608 def __init__(self
, *args
, **kwargs
):
13609 """__init__(self) -> LayoutConstraints"""
13610 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13611 __swig_destroy__
= _core_
.delete_LayoutConstraints
13612 __del__
= lambda self
: None;
13613 def SatisfyConstraints(*args
, **kwargs
):
13614 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13615 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13617 def AreSatisfied(*args
, **kwargs
):
13618 """AreSatisfied(self) -> bool"""
13619 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13621 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13623 #----------------------------------------------------------------------------
13625 # Use Python's bool constants if available, make some if not
13629 __builtins__
.True = 1==1
13630 __builtins__
.False = 1==0
13631 def bool(value
): return not not value
13632 __builtins__
.bool = bool
13636 # workarounds for bad wxRTTI names
13637 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13638 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13639 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13642 #----------------------------------------------------------------------------
13643 # Load version numbers from __version__... Ensure that major and minor
13644 # versions are the same for both wxPython and wxWidgets.
13646 from __version__
import *
13647 __version__
= VERSION_STRING
13649 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13650 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13651 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13653 warnings
.warn("wxPython/wxWidgets release number mismatch")
13655 #----------------------------------------------------------------------------
13657 # Set wxPython's default string<-->unicode conversion encoding from
13658 # the locale, but only if Python's default hasn't been changed. (We
13659 # assume that if the user has customized it already then that is the
13660 # encoding we need to use as well.)
13662 # The encoding selected here is used when string or unicode objects
13663 # need to be converted in order to pass them to wxWidgets. Please be
13664 # aware that the default encoding within the same locale may be
13665 # slightly different on different platforms. For example, please see
13666 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13667 # between the common latin/roman encodings.
13669 default
= _sys
.getdefaultencoding()
13670 if default
== 'ascii':
13674 default
= locale
.getdefaultlocale()[1]
13675 codecs
.lookup(default
)
13676 except (ValueError, LookupError, TypeError):
13677 default
= _sys
.getdefaultencoding()
13681 wx
.SetDefaultPyEncoding(default
)
13684 #----------------------------------------------------------------------------
13686 class PyDeadObjectError(AttributeError):
13689 class _wxPyDeadObject(object):
13691 Instances of wx objects that are OOR capable will have their __class__
13692 changed to this class when the C++ object is deleted. This should help
13693 prevent crashes due to referencing a bogus C++ pointer.
13695 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13696 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13698 def __repr__(self
):
13699 if not hasattr(self
, "_name"):
13700 self
._name
= "[unknown]"
13701 return self
.reprStr
% self
._name
13703 def __getattr__(self
, *args
):
13704 if not hasattr(self
, "_name"):
13705 self
._name
= "[unknown]"
13706 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13708 def __nonzero__(self
):
13713 class PyUnbornObjectError(AttributeError):
13716 class _wxPyUnbornObject(object):
13718 Some stock objects are created when the wx._core module is
13719 imported, but their C++ instance is not created until the wx.App
13720 object is created and initialized. These object instances will
13721 temporarily have their __class__ changed to this class so an
13722 exception will be raised if they are used before the C++ instance
13726 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13727 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13729 def __repr__(self
):
13730 #if not hasattr(self, "_name"):
13731 # self._name = "[unknown]"
13732 return self
.reprStr
#% self._name
13734 def __getattr__(self
, *args
):
13735 #if not hasattr(self, "_name"):
13736 # self._name = "[unknown]"
13737 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13739 def __nonzero__(self
):
13743 #----------------------------------------------------------------------------
13745 def CallAfter(callable, *args
, **kw
):
13747 Call the specified function after the current and pending event
13748 handlers have been completed. This is also good for making GUI
13749 method calls from non-GUI threads. Any extra positional or
13750 keyword args are passed on to the callable when it is called.
13752 :see: `wx.CallLater`
13755 assert app
is not None, 'No wx.App created yet'
13757 if not hasattr(app
, "_CallAfterId"):
13758 app
._CallAfterId
= wx
.NewEventType()
13759 app
.Connect(-1, -1, app
._CallAfterId
,
13760 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13762 evt
.SetEventType(app
._CallAfterId
)
13763 evt
.callable = callable
13766 wx
.PostEvent(app
, evt
)
13768 #----------------------------------------------------------------------------
13773 A convenience class for `wx.Timer`, that calls the given callable
13774 object once after the given amount of milliseconds, passing any
13775 positional or keyword args. The return value of the callable is
13776 availbale after it has been run with the `GetResult` method.
13778 If you don't need to get the return value or restart the timer
13779 then there is no need to hold a reference to this object. It will
13780 hold a reference to itself while the timer is running (the timer
13781 has a reference to self.Notify) but the cycle will be broken when
13782 the timer completes, automatically cleaning up the wx.CallLater
13785 :see: `wx.CallAfter`
13787 def __init__(self
, millis
, callable, *args
, **kwargs
):
13788 self
.millis
= millis
13789 self
.callable = callable
13790 self
.SetArgs(*args
, **kwargs
)
13792 self
.running
= False
13793 self
.hasRun
= False
13802 def Start(self
, millis
=None, *args
, **kwargs
):
13804 (Re)start the timer
13806 self
.hasRun
= False
13807 if millis
is not None:
13808 self
.millis
= millis
13810 self
.SetArgs(*args
, **kwargs
)
13812 self
.timer
= wx
.PyTimer(self
.Notify
)
13813 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13814 self
.running
= True
13820 Stop and destroy the timer.
13822 if self
.timer
is not None:
13827 def GetInterval(self
):
13828 if self
.timer
is not None:
13829 return self
.timer
.GetInterval()
13834 def IsRunning(self
):
13835 return self
.timer
is not None and self
.timer
.IsRunning()
13838 def SetArgs(self
, *args
, **kwargs
):
13840 (Re)set the args passed to the callable object. This is
13841 useful in conjunction with Restart if you want to schedule a
13842 new call to the same callable object but with different
13846 self
.kwargs
= kwargs
13852 def GetResult(self
):
13857 The timer has expired so call the callable.
13859 if self
.callable and getattr(self
.callable, 'im_self', True):
13861 self
.running
= False
13862 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13864 if not self
.running
:
13865 # if it wasn't restarted, then cleanup
13866 wx
.CallAfter(self
.Stop
)
13868 Interval
= property(GetInterval
)
13869 Result
= property(GetResult
)
13872 class FutureCall(CallLater
):
13873 """A compatibility alias for `CallLater`."""
13875 #----------------------------------------------------------------------------
13876 # Control which items in this module should be documented by epydoc.
13877 # We allow only classes and functions, which will help reduce the size
13878 # of the docs by filtering out the zillions of constants, EVT objects,
13879 # and etc that don't make much sense by themselves, but are instead
13880 # documented (or will be) as part of the classes/functions/methods
13881 # where they should be used.
13885 A filter for epydoc that only allows non-Ptr classes and
13886 functions, in order to reduce the clutter in the API docs.
13888 def __init__(self
, globals):
13889 self
._globals
= globals
13891 def __call__(self
, name
):
13893 obj
= self
._globals
.get(name
, None)
13895 # only document classes and function
13896 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13899 # skip other things that are private or will be documented as part of somethign else
13900 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13903 # skip functions that are duplicates of static functions in a class
13904 if name
.find('_') != -1:
13905 cls
= self
._globals
.get(name
.split('_')[0], None)
13906 methname
= name
.split('_')[1]
13907 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13912 #----------------------------------------------------------------------------
13913 #----------------------------------------------------------------------------
13915 # Import other modules in this package that should show up in the
13916 # "core" wx namespace
13918 from _windows
import *
13919 from _controls
import *
13920 from _misc
import *
13922 #----------------------------------------------------------------------------
13923 #----------------------------------------------------------------------------