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 FileSystemHandler
._setCallbackInfo
(self
, self
, FileSystemHandler
)
2075 def _setCallbackInfo(*args
, **kwargs
):
2076 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2077 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
2079 def CanOpen(*args
, **kwargs
):
2080 """CanOpen(self, String location) -> bool"""
2081 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
2083 def OpenFile(*args
, **kwargs
):
2084 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2085 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
2087 def FindFirst(*args
, **kwargs
):
2088 """FindFirst(self, String spec, int flags=0) -> String"""
2089 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
2091 def FindNext(*args
, **kwargs
):
2092 """FindNext(self) -> String"""
2093 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
2095 def GetProtocol(*args
, **kwargs
):
2096 """GetProtocol(self, String location) -> String"""
2097 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
2099 def GetLeftLocation(*args
, **kwargs
):
2100 """GetLeftLocation(self, String location) -> String"""
2101 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
2103 def GetAnchor(*args
, **kwargs
):
2104 """GetAnchor(self, String location) -> String"""
2105 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
2107 def GetRightLocation(*args
, **kwargs
):
2108 """GetRightLocation(self, String location) -> String"""
2109 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
2111 def GetMimeTypeFromExt(*args
, **kwargs
):
2112 """GetMimeTypeFromExt(self, String location) -> String"""
2113 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
2115 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
2116 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
2117 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
2118 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
2119 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
2120 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
2122 class FileSystem(Object
):
2123 """Proxy of C++ FileSystem class"""
2124 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2125 __repr__
= _swig_repr
2126 def __init__(self
, *args
, **kwargs
):
2127 """__init__(self) -> FileSystem"""
2128 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
2129 __swig_destroy__
= _core_
.delete_FileSystem
2130 __del__
= lambda self
: None;
2131 def ChangePathTo(*args
, **kwargs
):
2132 """ChangePathTo(self, String location, bool is_dir=False)"""
2133 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
2135 def GetPath(*args
, **kwargs
):
2136 """GetPath(self) -> String"""
2137 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
2139 def OpenFile(*args
, **kwargs
):
2140 """OpenFile(self, String location) -> FSFile"""
2141 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
2143 def FindFirst(*args
, **kwargs
):
2144 """FindFirst(self, String spec, int flags=0) -> String"""
2145 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
2147 def FindNext(*args
, **kwargs
):
2148 """FindNext(self) -> String"""
2149 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
2151 def AddHandler(*args
, **kwargs
):
2152 """AddHandler(CPPFileSystemHandler handler)"""
2153 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2155 AddHandler
= staticmethod(AddHandler
)
2156 def RemoveHandler(*args
, **kwargs
):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2160 RemoveHandler
= staticmethod(RemoveHandler
)
2161 def CleanUpHandlers(*args
, **kwargs
):
2162 """CleanUpHandlers()"""
2163 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
2165 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
2166 def FileNameToURL(*args
, **kwargs
):
2167 """FileNameToURL(String filename) -> String"""
2168 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2170 FileNameToURL
= staticmethod(FileNameToURL
)
2171 def URLToFileName(*args
, **kwargs
):
2172 """URLToFileName(String url) -> String"""
2173 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2175 URLToFileName
= staticmethod(URLToFileName
)
2176 Path
= property(GetPath
,doc
="See `GetPath`")
2177 _core_
.FileSystem_swigregister(FileSystem
)
2179 def FileSystem_AddHandler(*args
, **kwargs
):
2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
2183 def FileSystem_RemoveHandler(*args
, **kwargs
):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
2187 def FileSystem_CleanUpHandlers(*args
):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_
.FileSystem_CleanUpHandlers(*args
)
2191 def FileSystem_FileNameToURL(*args
, **kwargs
):
2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
2195 def FileSystem_URLToFileName(*args
, **kwargs
):
2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
2199 class InternetFSHandler(CPPFileSystemHandler
):
2200 """Proxy of C++ InternetFSHandler class"""
2201 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2202 __repr__
= _swig_repr
2203 def __init__(self
, *args
, **kwargs
):
2204 """__init__(self) -> InternetFSHandler"""
2205 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
2206 def CanOpen(*args
, **kwargs
):
2207 """CanOpen(self, String location) -> bool"""
2208 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
2210 def OpenFile(*args
, **kwargs
):
2211 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2212 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
2214 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
2216 class ZipFSHandler(CPPFileSystemHandler
):
2217 """Proxy of C++ ZipFSHandler class"""
2218 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2219 __repr__
= _swig_repr
2220 def __init__(self
, *args
, **kwargs
):
2221 """__init__(self) -> ZipFSHandler"""
2222 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
2223 def CanOpen(*args
, **kwargs
):
2224 """CanOpen(self, String location) -> bool"""
2225 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
2227 def OpenFile(*args
, **kwargs
):
2228 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2229 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
2231 def FindFirst(*args
, **kwargs
):
2232 """FindFirst(self, String spec, int flags=0) -> String"""
2233 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
2235 def FindNext(*args
, **kwargs
):
2236 """FindNext(self) -> String"""
2237 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
2239 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
2242 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
2246 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
2250 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
2253 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
2255 Add 'file' to the memory filesystem. The dataItem parameter can
2256 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257 arbitrary data. If a bitmap or image is used then the imgType
2258 parameter should specify what kind of image file it should be
2259 written as, wx.BITMAP_TYPE_PNG, etc.
2261 if isinstance(dataItem
, wx
.Image
):
2262 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
2263 elif isinstance(dataItem
, wx
.Bitmap
):
2264 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
2265 elif type(dataItem
) == str:
2266 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
2268 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2270 class MemoryFSHandler(CPPFileSystemHandler
):
2271 """Proxy of C++ MemoryFSHandler class"""
2272 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2273 __repr__
= _swig_repr
2274 def __init__(self
, *args
, **kwargs
):
2275 """__init__(self) -> MemoryFSHandler"""
2276 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
2277 def RemoveFile(*args
, **kwargs
):
2278 """RemoveFile(String filename)"""
2279 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2281 RemoveFile
= staticmethod(RemoveFile
)
2282 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
2283 def CanOpen(*args
, **kwargs
):
2284 """CanOpen(self, String location) -> bool"""
2285 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
2287 def OpenFile(*args
, **kwargs
):
2288 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2289 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
2291 def FindFirst(*args
, **kwargs
):
2292 """FindFirst(self, String spec, int flags=0) -> String"""
2293 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2295 def FindNext(*args
, **kwargs
):
2296 """FindNext(self) -> String"""
2297 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2299 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2301 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2305 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2306 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2307 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2308 IMAGE_QUALITY_NORMAL
= _core_
.IMAGE_QUALITY_NORMAL
2309 IMAGE_QUALITY_HIGH
= _core_
.IMAGE_QUALITY_HIGH
2310 #---------------------------------------------------------------------------
2312 class ImageHandler(Object
):
2314 This is the base class for implementing image file loading/saving, and
2315 image creation from data. It is used within `wx.Image` and is not
2316 normally seen by the application.
2318 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2319 def __init__(self
): raise AttributeError, "No constructor defined"
2320 __repr__
= _swig_repr
2321 def GetName(*args
, **kwargs
):
2322 """GetName(self) -> String"""
2323 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2325 def GetExtension(*args
, **kwargs
):
2326 """GetExtension(self) -> String"""
2327 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2329 def GetType(*args
, **kwargs
):
2330 """GetType(self) -> long"""
2331 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2333 def GetMimeType(*args
, **kwargs
):
2334 """GetMimeType(self) -> String"""
2335 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2337 def CanRead(*args
, **kwargs
):
2338 """CanRead(self, String name) -> bool"""
2339 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2341 def CanReadStream(*args
, **kwargs
):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2345 def SetName(*args
, **kwargs
):
2346 """SetName(self, String name)"""
2347 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2349 def SetExtension(*args
, **kwargs
):
2350 """SetExtension(self, String extension)"""
2351 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2353 def SetType(*args
, **kwargs
):
2354 """SetType(self, long type)"""
2355 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2357 def SetMimeType(*args
, **kwargs
):
2358 """SetMimeType(self, String mimetype)"""
2359 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2361 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2362 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2363 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2364 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2365 _core_
.ImageHandler_swigregister(ImageHandler
)
2367 class PyImageHandler(ImageHandler
):
2369 This is the base class for implementing image file loading/saving, and
2370 image creation from data, all written in Python. To create a custom
2371 image handler derive a new class from wx.PyImageHandler and provide
2372 the following methods::
2374 def DoCanRead(self, stream) --> bool
2375 '''Check if this handler can read the image on the stream'''
2377 def LoadFile(self, image, stream, verbose, index) --> bool
2378 '''Load image data from the stream and load it into image.'''
2380 def SaveFile(self, image, stream, verbose) --> bool
2381 '''Save the iamge data in image to the stream using
2382 this handler's image file format.'''
2384 def GetImageCount(self, stream) --> int
2385 '''If this image format can hold more than one image,
2386 how many does the image on the stream have?'''
2388 To activate your handler create an instance of it and pass it to
2389 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2390 `SetExtension` from your constructor.
2393 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2394 __repr__
= _swig_repr
2395 def __init__(self
, *args
, **kwargs
):
2397 __init__(self) -> PyImageHandler
2399 This is the base class for implementing image file loading/saving, and
2400 image creation from data, all written in Python. To create a custom
2401 image handler derive a new class from wx.PyImageHandler and provide
2402 the following methods::
2404 def DoCanRead(self, stream) --> bool
2405 '''Check if this handler can read the image on the stream'''
2407 def LoadFile(self, image, stream, verbose, index) --> bool
2408 '''Load image data from the stream and load it into image.'''
2410 def SaveFile(self, image, stream, verbose) --> bool
2411 '''Save the iamge data in image to the stream using
2412 this handler's image file format.'''
2414 def GetImageCount(self, stream) --> int
2415 '''If this image format can hold more than one image,
2416 how many does the image on the stream have?'''
2418 To activate your handler create an instance of it and pass it to
2419 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2420 `SetExtension` from your constructor.
2423 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2426 def _SetSelf(*args
, **kwargs
):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2430 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2432 class ImageHistogram(object):
2433 """Proxy of C++ ImageHistogram class"""
2434 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2435 __repr__
= _swig_repr
2436 def __init__(self
, *args
, **kwargs
):
2437 """__init__(self) -> ImageHistogram"""
2438 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2439 def MakeKey(*args
, **kwargs
):
2441 MakeKey(byte r, byte g, byte b) -> unsigned long
2443 Get the key in the histogram for the given RGB values
2445 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2447 MakeKey
= staticmethod(MakeKey
)
2448 def FindFirstUnusedColour(*args
, **kwargs
):
2450 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2452 Find first colour that is not used in the image and has higher RGB
2453 values than startR, startG, startB. Returns a tuple consisting of a
2454 success flag and rgb values.
2456 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2458 def GetCount(*args
, **kwargs
):
2460 GetCount(self, unsigned long key) -> unsigned long
2462 Returns the pixel count for the given key. Use `MakeKey` to create a
2463 key value from a RGB tripple.
2465 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2467 def GetCountRGB(*args
, **kwargs
):
2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2471 Returns the pixel count for the given RGB values.
2473 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2475 def GetCountColour(*args
, **kwargs
):
2477 GetCountColour(self, Colour colour) -> unsigned long
2479 Returns the pixel count for the given `wx.Colour` value.
2481 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2483 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2485 def ImageHistogram_MakeKey(*args
, **kwargs
):
2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2489 Get the key in the histogram for the given RGB values
2491 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2493 class Image_RGBValue(object):
2495 An object that contains values for red, green and blue which represent
2496 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2500 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2501 __repr__
= _swig_repr
2502 def __init__(self
, *args
, **kwargs
):
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2508 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2509 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2510 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2511 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2512 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2514 class Image_HSVValue(object):
2516 An object that contains values for hue, saturation and value which
2517 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2518 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2521 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2522 __repr__
= _swig_repr
2523 def __init__(self
, *args
, **kwargs
):
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2529 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2530 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2531 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2532 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2533 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2535 class Image(Object
):
2537 A platform-independent image class. An image can be created from
2538 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539 variety of formats. Functions are available to set and get image
2540 bits, so it can be used for basic image manipulation.
2542 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2543 platform-specific `wx.Bitmap` object must be created from it using the
2544 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545 device context, using `wx.DC.DrawBitmap`.
2547 One colour value of the image may be used as a mask colour which will
2548 lead to the automatic creation of a `wx.Mask` object associated to the
2551 wx.Image supports alpha channel data, that is in addition to a byte
2552 for the red, green and blue colour components for each pixel it also
2553 stores a byte representing the pixel opacity. An alpha value of 0
2554 corresponds to a transparent pixel (null opacity) while a value of 255
2555 means that the pixel is 100% opaque.
2557 Unlike RGB data, not all images have an alpha channel and before using
2558 `GetAlpha` you should check if this image contains an alpha channel
2559 with `HasAlpha`. Note that currently only images loaded from PNG files
2560 with transparency information will have an alpha channel.
2562 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2563 __repr__
= _swig_repr
2564 def __init__(self
, *args
, **kwargs
):
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2568 Loads an image from a file.
2570 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2571 __swig_destroy__
= _core_
.delete_Image
2572 __del__
= lambda self
: None;
2573 def Create(*args
, **kwargs
):
2575 Create(self, int width, int height, bool clear=True)
2577 Creates a fresh image. If clear is ``True``, the new image will be
2578 initialized to black. Otherwise, the image data will be uninitialized.
2580 return _core_
.Image_Create(*args
, **kwargs
)
2582 def Destroy(*args
, **kwargs
):
2586 Destroys the image data.
2588 args
[0].this
.own(False)
2589 return _core_
.Image_Destroy(*args
, **kwargs
)
2591 def Scale(*args
, **kwargs
):
2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2595 Returns a scaled version of the image. This is also useful for scaling
2596 bitmaps in general as the only other way to scale bitmaps is to blit a
2597 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2598 specifies what method to use for resampling the image. It can be
2599 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601 bicubic and box averaging resampling methods for upsampling and
2602 downsampling respectively.
2604 return _core_
.Image_Scale(*args
, **kwargs
)
2606 def ResampleBox(*args
, **kwargs
):
2607 """ResampleBox(self, int width, int height) -> Image"""
2608 return _core_
.Image_ResampleBox(*args
, **kwargs
)
2610 def ResampleBicubic(*args
, **kwargs
):
2611 """ResampleBicubic(self, int width, int height) -> Image"""
2612 return _core_
.Image_ResampleBicubic(*args
, **kwargs
)
2614 def Blur(*args
, **kwargs
):
2616 Blur(self, int radius) -> Image
2618 Blurs the image in both horizontal and vertical directions by the
2619 specified pixel ``radius``. This should not be used when using a
2620 single mask colour for transparency.
2622 return _core_
.Image_Blur(*args
, **kwargs
)
2624 def BlurHorizontal(*args
, **kwargs
):
2626 BlurHorizontal(self, int radius) -> Image
2628 Blurs the image in the horizontal direction only. This should not be
2629 used when using a single mask colour for transparency.
2632 return _core_
.Image_BlurHorizontal(*args
, **kwargs
)
2634 def BlurVertical(*args
, **kwargs
):
2636 BlurVertical(self, int radius) -> Image
2638 Blurs the image in the vertical direction only. This should not be
2639 used when using a single mask colour for transparency.
2641 return _core_
.Image_BlurVertical(*args
, **kwargs
)
2643 def ShrinkBy(*args
, **kwargs
):
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2647 Return a version of the image scaled smaller by the given factors.
2649 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2651 def Rescale(*args
, **kwargs
):
2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2655 Changes the size of the image in-place by scaling it: after a call to
2656 this function, the image will have the given width and height.
2658 Returns the (modified) image itself.
2660 return _core_
.Image_Rescale(*args
, **kwargs
)
2662 def Resize(*args
, **kwargs
):
2664 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2666 Changes the size of the image in-place without scaling it, by adding
2667 either a border with the given colour or cropping as necessary. The
2668 image is pasted into a new image with the given size and background
2669 colour at the position pos relative to the upper left of the new
2670 image. If red = green = blue = -1 then use either the current mask
2671 colour if set or find, use, and set a suitable mask colour for any
2672 newly exposed areas.
2674 Returns the (modified) image itself.
2676 return _core_
.Image_Resize(*args
, **kwargs
)
2678 def SetRGB(*args
, **kwargs
):
2680 SetRGB(self, int x, int y, byte r, byte g, byte b)
2682 Sets the pixel at the given coordinate. This routine performs
2683 bounds-checks for the coordinate so it can be considered a safe way to
2684 manipulate the data, but in some cases this might be too slow so that
2685 the data will have to be set directly. In that case you will have to
2686 get access to the image data using the `GetData` method.
2688 return _core_
.Image_SetRGB(*args
, **kwargs
)
2690 def SetRGBRect(*args
, **kwargs
):
2692 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2694 Sets the colour of the pixels within the given rectangle. This routine
2695 performs bounds-checks for the rectangle so it can be considered a
2696 safe way to manipulate the data.
2698 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2700 def GetRed(*args
, **kwargs
):
2702 GetRed(self, int x, int y) -> byte
2704 Returns the red intensity at the given coordinate.
2706 return _core_
.Image_GetRed(*args
, **kwargs
)
2708 def GetGreen(*args
, **kwargs
):
2710 GetGreen(self, int x, int y) -> byte
2712 Returns the green intensity at the given coordinate.
2714 return _core_
.Image_GetGreen(*args
, **kwargs
)
2716 def GetBlue(*args
, **kwargs
):
2718 GetBlue(self, int x, int y) -> byte
2720 Returns the blue intensity at the given coordinate.
2722 return _core_
.Image_GetBlue(*args
, **kwargs
)
2724 def SetAlpha(*args
, **kwargs
):
2726 SetAlpha(self, int x, int y, byte alpha)
2728 Sets the alpha value for the given pixel. This function should only be
2729 called if the image has alpha channel data, use `HasAlpha` to check
2732 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2734 def GetAlpha(*args
, **kwargs
):
2736 GetAlpha(self, int x, int y) -> byte
2738 Returns the alpha value for the given pixel. This function may only be
2739 called for the images with alpha channel, use `HasAlpha` to check for
2742 The returned value is the *opacity* of the image, i.e. the value of 0
2743 corresponds to the fully transparent pixels while the value of 255 to
2744 the fully opaque pixels.
2746 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2748 def HasAlpha(*args
, **kwargs
):
2750 HasAlpha(self) -> bool
2752 Returns true if this image has alpha channel, false otherwise.
2754 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2756 def InitAlpha(*args
, **kwargs
):
2760 Initializes the image alpha channel data. It is an error to call it if
2761 the image already has alpha data. If it doesn't, alpha data will be by
2762 default initialized to all pixels being fully opaque. But if the image
2763 has a a mask colour, all mask pixels will be completely transparent.
2765 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2767 def IsTransparent(*args
, **kwargs
):
2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
2774 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2776 def FindFirstUnusedColour(*args
, **kwargs
):
2778 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2780 Find first colour that is not used in the image and has higher RGB
2781 values than startR, startG, startB. Returns a tuple consisting of a
2782 success flag and rgb values.
2784 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2786 def ConvertAlphaToMask(*args
, **kwargs
):
2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2790 If the image has alpha channel, this method converts it to mask. All
2791 pixels with alpha value less than ``threshold`` are replaced with the
2792 mask colour and the alpha channel is removed. The mask colour is
2793 chosen automatically using `FindFirstUnusedColour`.
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2798 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2800 def ConvertColourToAlpha(*args
, **kwargs
):
2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2804 This method converts an image where the original alpha information is
2805 only available as a shades of a colour (actually shades of grey)
2806 typically when you draw anti-aliased text into a bitmap. The DC
2807 drawing routines draw grey values on the black background although
2808 they actually mean to draw white with differnt alpha values. This
2809 method reverses it, assuming a black (!) background and white text.
2810 The method will then fill up the whole image with the colour given.
2812 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2814 def SetMaskFromImage(*args
, **kwargs
):
2816 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2818 Sets the image's mask so that the pixels that have RGB value of
2819 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820 by first finding an unused colour in the image, setting this colour as
2821 the mask colour and then using this colour to draw all pixels in the
2822 image who corresponding pixel in mask has given RGB value.
2824 Returns ``False`` if ``mask`` does not have same dimensions as the
2825 image or if there is no unused colour left. Returns ``True`` if the
2826 mask was successfully applied.
2828 Note that this method involves computing the histogram, which is
2829 computationally intensive operation.
2831 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2833 def CanRead(*args
, **kwargs
):
2835 CanRead(String filename) -> bool
2837 Returns True if the image handlers can read this file.
2839 return _core_
.Image_CanRead(*args
, **kwargs
)
2841 CanRead
= staticmethod(CanRead
)
2842 def GetImageCount(*args
, **kwargs
):
2844 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2846 If the image file contains more than one image and the image handler
2847 is capable of retrieving these individually, this function will return
2848 the number of available images.
2850 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2852 GetImageCount
= staticmethod(GetImageCount
)
2853 def LoadFile(*args
, **kwargs
):
2855 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2857 Loads an image from a file. If no handler type is provided, the
2858 library will try to autodetect the format.
2860 return _core_
.Image_LoadFile(*args
, **kwargs
)
2862 def LoadMimeFile(*args
, **kwargs
):
2864 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2866 Loads an image from a file, specifying the image type with a MIME type
2869 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2871 def SaveFile(*args
, **kwargs
):
2873 SaveFile(self, String name, int type) -> bool
2875 Saves an image in the named file.
2877 return _core_
.Image_SaveFile(*args
, **kwargs
)
2879 def SaveMimeFile(*args
, **kwargs
):
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2883 Saves an image in the named file.
2885 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2887 def CanReadStream(*args
, **kwargs
):
2889 CanReadStream(InputStream stream) -> bool
2891 Returns True if the image handlers can read an image file from the
2892 data currently on the input stream, or a readable Python file-like
2895 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2897 CanReadStream
= staticmethod(CanReadStream
)
2898 def LoadStream(*args
, **kwargs
):
2900 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2902 Loads an image from an input stream or a readable Python file-like
2903 object. If no handler type is provided, the library will try to
2904 autodetect the format.
2906 return _core_
.Image_LoadStream(*args
, **kwargs
)
2908 def LoadMimeStream(*args
, **kwargs
):
2910 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2912 Loads an image from an input stream or a readable Python file-like
2913 object, using a MIME type string to specify the image file format.
2915 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2917 def IsOk(*args
, **kwargs
):
2921 Returns true if image data is present.
2923 return _core_
.Image_IsOk(*args
, **kwargs
)
2926 def GetWidth(*args
, **kwargs
):
2928 GetWidth(self) -> int
2930 Gets the width of the image in pixels.
2932 return _core_
.Image_GetWidth(*args
, **kwargs
)
2934 def GetHeight(*args
, **kwargs
):
2936 GetHeight(self) -> int
2938 Gets the height of the image in pixels.
2940 return _core_
.Image_GetHeight(*args
, **kwargs
)
2942 def GetSize(*args
, **kwargs
):
2944 GetSize(self) -> Size
2946 Returns the size of the image in pixels.
2948 return _core_
.Image_GetSize(*args
, **kwargs
)
2950 def GetSubImage(*args
, **kwargs
):
2952 GetSubImage(self, Rect rect) -> Image
2954 Returns a sub image of the current one as long as the rect belongs
2955 entirely to the image.
2957 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2959 def Size(*args
, **kwargs
):
2961 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2963 Returns a resized version of this image without scaling it by adding
2964 either a border with the given colour or cropping as necessary. The
2965 image is pasted into a new image with the given size and background
2966 colour at the position ``pos`` relative to the upper left of the new
2967 image. If red = green = blue = -1 then use either the current mask
2968 colour if set or find, use, and set a suitable mask colour for any
2969 newly exposed areas.
2971 return _core_
.Image_Size(*args
, **kwargs
)
2973 def Copy(*args
, **kwargs
):
2977 Returns an identical copy of the image.
2979 return _core_
.Image_Copy(*args
, **kwargs
)
2981 def Paste(*args
, **kwargs
):
2983 Paste(self, Image image, int x, int y)
2985 Pastes ``image`` into this instance and takes care of the mask colour
2986 and any out of bounds problems.
2988 return _core_
.Image_Paste(*args
, **kwargs
)
2990 def GetData(*args
, **kwargs
):
2992 GetData(self) -> PyObject
2994 Returns a string containing a copy of the RGB bytes of the image.
2996 return _core_
.Image_GetData(*args
, **kwargs
)
2998 def SetData(*args
, **kwargs
):
3000 SetData(self, buffer data)
3002 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3003 either a string or a buffer object holding the data and the length of
3004 the data must be width*height*3.
3006 return _core_
.Image_SetData(*args
, **kwargs
)
3008 def GetDataBuffer(*args
, **kwargs
):
3010 GetDataBuffer(self) -> PyObject
3012 Returns a writable Python buffer object that is pointing at the RGB
3013 image data buffer inside the wx.Image. You need to ensure that you do
3014 not use this buffer object after the image has been destroyed.
3016 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
3018 def SetDataBuffer(*args
, **kwargs
):
3020 SetDataBuffer(self, buffer data)
3022 Sets the internal image data pointer to point at a Python buffer
3023 object. This can save making an extra copy of the data but you must
3024 ensure that the buffer object lives longer than the wx.Image does.
3026 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
3028 def GetAlphaData(*args
, **kwargs
):
3030 GetAlphaData(self) -> PyObject
3032 Returns a string containing a copy of the alpha bytes of the image.
3034 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
3036 def SetAlphaData(*args
, **kwargs
):
3038 SetAlphaData(self, buffer alpha)
3040 Resets the Image's alpha data from a buffer of bytes. Accepts either
3041 a string or a buffer object holding the data and the length of the
3042 data must be width*height.
3044 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
3046 def GetAlphaBuffer(*args
, **kwargs
):
3048 GetAlphaBuffer(self) -> PyObject
3050 Returns a writable Python buffer object that is pointing at the Alpha
3051 data buffer inside the wx.Image. You need to ensure that you do not
3052 use this buffer object after the image has been destroyed.
3054 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
3056 def SetAlphaBuffer(*args
, **kwargs
):
3058 SetAlphaBuffer(self, buffer alpha)
3060 Sets the internal image alpha pointer to point at a Python buffer
3061 object. This can save making an extra copy of the data but you must
3062 ensure that the buffer object lives as long as the wx.Image does.
3064 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
3066 def SetMaskColour(*args
, **kwargs
):
3068 SetMaskColour(self, byte r, byte g, byte b)
3070 Sets the mask colour for this image (and tells the image to use the
3073 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
3075 def GetOrFindMaskColour(*args
, **kwargs
):
3077 GetOrFindMaskColour() -> (r,g,b)
3079 Get the current mask colour or find a suitable colour.
3081 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
3083 def GetMaskRed(*args
, **kwargs
):
3085 GetMaskRed(self) -> byte
3087 Gets the red component of the mask colour.
3089 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
3091 def GetMaskGreen(*args
, **kwargs
):
3093 GetMaskGreen(self) -> byte
3095 Gets the green component of the mask colour.
3097 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
3099 def GetMaskBlue(*args
, **kwargs
):
3101 GetMaskBlue(self) -> byte
3103 Gets the blue component of the mask colour.
3105 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
3107 def SetMask(*args
, **kwargs
):
3109 SetMask(self, bool mask=True)
3111 Specifies whether there is a mask or not. The area of the mask is
3112 determined by the current mask colour.
3114 return _core_
.Image_SetMask(*args
, **kwargs
)
3116 def HasMask(*args
, **kwargs
):
3118 HasMask(self) -> bool
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3122 return _core_
.Image_HasMask(*args
, **kwargs
)
3124 def Rotate(*args
, **kwargs
):
3126 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3127 Point offset_after_rotation=None) -> Image
3129 Rotates the image about the given point, by ``angle`` radians. Passing
3130 ``True`` to ``interpolating`` results in better image quality, but is
3131 slower. If the image has a mask, then the mask colour is used for the
3132 uncovered pixels in the rotated image background. Otherwise, black
3133 will be used as the fill colour.
3135 Returns the rotated image, leaving this image intact.
3137 return _core_
.Image_Rotate(*args
, **kwargs
)
3139 def Rotate90(*args
, **kwargs
):
3141 Rotate90(self, bool clockwise=True) -> Image
3143 Returns a copy of the image rotated 90 degrees in the direction
3144 indicated by ``clockwise``.
3146 return _core_
.Image_Rotate90(*args
, **kwargs
)
3148 def Mirror(*args
, **kwargs
):
3150 Mirror(self, bool horizontally=True) -> Image
3152 Returns a mirrored copy of the image. The parameter ``horizontally``
3153 indicates the orientation.
3155 return _core_
.Image_Mirror(*args
, **kwargs
)
3157 def Replace(*args
, **kwargs
):
3159 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3161 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3164 return _core_
.Image_Replace(*args
, **kwargs
)
3166 def ConvertToGreyscale(*args
, **kwargs
):
3168 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3170 Convert to greyscale image. Uses the luminance component (Y) of the
3171 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172 defaults to ITU-T BT.601
3174 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
3176 def ConvertToMono(*args
, **kwargs
):
3178 ConvertToMono(self, byte r, byte g, byte b) -> Image
3180 Returns monochromatic version of the image. The returned image has
3181 white colour where the original has ``(r,g,b)`` colour and black
3182 colour everywhere else.
3184 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
3186 def SetOption(*args
, **kwargs
):
3188 SetOption(self, String name, String value)
3190 Sets an image handler defined option. For example, when saving as a
3191 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192 number between 0 and 100 (0 is terrible, 100 is very good).
3194 return _core_
.Image_SetOption(*args
, **kwargs
)
3196 def SetOptionInt(*args
, **kwargs
):
3198 SetOptionInt(self, String name, int value)
3200 Sets an image option as an integer.
3202 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
3204 def GetOption(*args
, **kwargs
):
3206 GetOption(self, String name) -> String
3208 Gets the value of an image handler option.
3210 return _core_
.Image_GetOption(*args
, **kwargs
)
3212 def GetOptionInt(*args
, **kwargs
):
3214 GetOptionInt(self, String name) -> int
3216 Gets the value of an image handler option as an integer. If the given
3217 option is not present, the function returns 0.
3219 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
3221 def HasOption(*args
, **kwargs
):
3223 HasOption(self, String name) -> bool
3225 Returns true if the given option is present.
3227 return _core_
.Image_HasOption(*args
, **kwargs
)
3229 def CountColours(*args
, **kwargs
):
3230 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3231 return _core_
.Image_CountColours(*args
, **kwargs
)
3233 def ComputeHistogram(*args
, **kwargs
):
3234 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3235 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
3237 def AddHandler(*args
, **kwargs
):
3238 """AddHandler(ImageHandler handler)"""
3239 return _core_
.Image_AddHandler(*args
, **kwargs
)
3241 AddHandler
= staticmethod(AddHandler
)
3242 def InsertHandler(*args
, **kwargs
):
3243 """InsertHandler(ImageHandler handler)"""
3244 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3246 InsertHandler
= staticmethod(InsertHandler
)
3247 def RemoveHandler(*args
, **kwargs
):
3248 """RemoveHandler(String name) -> bool"""
3249 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3251 RemoveHandler
= staticmethod(RemoveHandler
)
3252 def GetHandlers(*args
, **kwargs
):
3253 """GetHandlers() -> PyObject"""
3254 return _core_
.Image_GetHandlers(*args
, **kwargs
)
3256 GetHandlers
= staticmethod(GetHandlers
)
3257 def GetImageExtWildcard(*args
, **kwargs
):
3259 GetImageExtWildcard() -> String
3261 Iterates all registered wxImageHandler objects, and returns a string
3262 containing file extension masks suitable for passing to file open/save
3265 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
3267 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
3268 def ConvertToBitmap(*args
, **kwargs
):
3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3270 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
3272 def ConvertToMonoBitmap(*args
, **kwargs
):
3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3274 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
3276 def RotateHue(*args
, **kwargs
):
3278 RotateHue(self, double angle)
3280 Rotates the hue of each pixel of the image. Hue is a double in the
3281 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3283 return _core_
.Image_RotateHue(*args
, **kwargs
)
3285 def RGBtoHSV(*args
, **kwargs
):
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3289 Converts a color in RGB color space to HSV color space.
3291 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3293 RGBtoHSV
= staticmethod(RGBtoHSV
)
3294 def HSVtoRGB(*args
, **kwargs
):
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3298 Converts a color in HSV color space to RGB color space.
3300 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3302 HSVtoRGB
= staticmethod(HSVtoRGB
)
3303 def __nonzero__(self
): return self
.IsOk()
3304 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
3306 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
3307 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
3308 Height
= property(GetHeight
,doc
="See `GetHeight`")
3309 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
3310 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
3311 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
3312 Width
= property(GetWidth
,doc
="See `GetWidth`")
3313 _core_
.Image_swigregister(Image
)
3315 def ImageFromMime(*args
, **kwargs
):
3317 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3319 Loads an image from a file, using a MIME type string (such as
3320 'image/jpeg') to specify image type.
3322 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
3325 def ImageFromStream(*args
, **kwargs
):
3327 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3329 Loads an image from an input stream, or any readable Python file-like
3332 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
3335 def ImageFromStreamMime(*args
, **kwargs
):
3337 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3339 Loads an image from an input stream, or any readable Python file-like
3340 object, specifying the image format with a MIME type string.
3342 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3345 def EmptyImage(*args
, **kwargs
):
3347 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3349 Construct an empty image of a given size, optionally setting all
3352 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3355 def ImageFromBitmap(*args
, **kwargs
):
3357 ImageFromBitmap(Bitmap bitmap) -> Image
3359 Construct an Image from a `wx.Bitmap`.
3361 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3364 def ImageFromData(*args
, **kwargs
):
3366 ImageFromData(int width, int height, buffer data) -> Image
3368 Construct an Image from a buffer of RGB bytes. Accepts either a
3369 string or a buffer object holding the data and the length of the data
3370 must be width*height*3.
3372 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3375 def ImageFromDataWithAlpha(*args
, **kwargs
):
3377 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3379 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380 Accepts either a string or a buffer object holding the data and the
3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
3384 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3387 def Image_CanRead(*args
, **kwargs
):
3389 Image_CanRead(String filename) -> bool
3391 Returns True if the image handlers can read this file.
3393 return _core_
.Image_CanRead(*args
, **kwargs
)
3395 def Image_GetImageCount(*args
, **kwargs
):
3397 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3399 If the image file contains more than one image and the image handler
3400 is capable of retrieving these individually, this function will return
3401 the number of available images.
3403 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3405 def Image_CanReadStream(*args
, **kwargs
):
3407 Image_CanReadStream(InputStream stream) -> bool
3409 Returns True if the image handlers can read an image file from the
3410 data currently on the input stream, or a readable Python file-like
3413 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3415 def Image_AddHandler(*args
, **kwargs
):
3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_
.Image_AddHandler(*args
, **kwargs
)
3419 def Image_InsertHandler(*args
, **kwargs
):
3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3423 def Image_RemoveHandler(*args
, **kwargs
):
3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3427 def Image_GetHandlers(*args
):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_
.Image_GetHandlers(*args
)
3431 def Image_GetImageExtWildcard(*args
):
3433 Image_GetImageExtWildcard() -> String
3435 Iterates all registered wxImageHandler objects, and returns a string
3436 containing file extension masks suitable for passing to file open/save
3439 return _core_
.Image_GetImageExtWildcard(*args
)
3441 def Image_RGBtoHSV(*args
, **kwargs
):
3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3445 Converts a color in RGB color space to HSV color space.
3447 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3449 def Image_HSVtoRGB(*args
, **kwargs
):
3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3453 Converts a color in HSV color space to RGB color space.
3455 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3458 def _ImageFromBuffer(*args
, **kwargs
):
3459 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3461 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3463 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3464 parameter must be a Python object that implements the buffer interface,
3465 such as a string, array, etc. The dataBuffer object is expected to
3466 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3467 object can optionally be supplied for the image's alpha channel data, and
3468 it is expected to be width*height bytes long.
3470 The wx.Image will be created with its data and alpha pointers initialized
3471 to the memory address pointed to by the buffer objects, thus saving the
3472 time needed to copy the image data from the buffer object to the wx.Image.
3473 While this has advantages, it also has the shoot-yourself-in-the-foot
3474 risks associated with sharing a C pointer between two objects.
3476 To help alleviate the risk a reference to the data and alpha buffer
3477 objects are kept with the wx.Image, so that they won't get deleted until
3478 after the wx.Image is deleted. However please be aware that it is not
3479 guaranteed that an object won't move its memory buffer to a new location
3480 when it needs to resize its contents. If that happens then the wx.Image
3481 will end up referring to an invalid memory location and could cause the
3482 application to crash. Therefore care should be taken to not manipulate
3483 the objects used for the data and alpha buffers in a way that would cause
3484 them to change size.
3486 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3487 image
._buffer
= dataBuffer
3488 image
._alpha
= alphaBuffer
3491 def InitAllImageHandlers():
3493 The former functionality of InitAllImageHanders is now done internal to
3494 the _core_ extension module and so this function has become a simple NOP.
3498 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3499 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3500 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3501 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3502 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3503 BMP_24BPP
= _core_
.BMP_24BPP
3504 BMP_8BPP
= _core_
.BMP_8BPP
3505 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3506 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3507 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3508 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3509 BMP_4BPP
= _core_
.BMP_4BPP
3510 BMP_1BPP
= _core_
.BMP_1BPP
3511 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3512 class BMPHandler(ImageHandler
):
3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3514 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3515 __repr__
= _swig_repr
3516 def __init__(self
, *args
, **kwargs
):
3518 __init__(self) -> BMPHandler
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3522 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3523 _core_
.BMPHandler_swigregister(BMPHandler
)
3524 NullImage
= cvar
.NullImage
3525 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3526 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3527 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3528 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3529 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3530 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3531 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3532 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3533 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3534 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3535 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3536 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3537 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3538 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3539 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3541 class ICOHandler(BMPHandler
):
3542 """A `wx.ImageHandler` for \*.ico icon files."""
3543 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3544 __repr__
= _swig_repr
3545 def __init__(self
, *args
, **kwargs
):
3547 __init__(self) -> ICOHandler
3549 A `wx.ImageHandler` for \*.ico icon files.
3551 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3552 _core_
.ICOHandler_swigregister(ICOHandler
)
3554 class CURHandler(ICOHandler
):
3555 """A `wx.ImageHandler` for \*.cur cursor files."""
3556 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3557 __repr__
= _swig_repr
3558 def __init__(self
, *args
, **kwargs
):
3560 __init__(self) -> CURHandler
3562 A `wx.ImageHandler` for \*.cur cursor files.
3564 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3565 _core_
.CURHandler_swigregister(CURHandler
)
3567 class ANIHandler(CURHandler
):
3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3569 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3570 __repr__
= _swig_repr
3571 def __init__(self
, *args
, **kwargs
):
3573 __init__(self) -> ANIHandler
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3577 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3578 _core_
.ANIHandler_swigregister(ANIHandler
)
3580 class PNGHandler(ImageHandler
):
3581 """A `wx.ImageHandler` for PNG image files."""
3582 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3583 __repr__
= _swig_repr
3584 def __init__(self
, *args
, **kwargs
):
3586 __init__(self) -> PNGHandler
3588 A `wx.ImageHandler` for PNG image files.
3590 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3591 _core_
.PNGHandler_swigregister(PNGHandler
)
3593 class GIFHandler(ImageHandler
):
3594 """A `wx.ImageHandler` for GIF image files."""
3595 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3596 __repr__
= _swig_repr
3597 def __init__(self
, *args
, **kwargs
):
3599 __init__(self) -> GIFHandler
3601 A `wx.ImageHandler` for GIF image files.
3603 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3604 _core_
.GIFHandler_swigregister(GIFHandler
)
3606 class PCXHandler(ImageHandler
):
3607 """A `wx.ImageHandler` for PCX imager files."""
3608 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3609 __repr__
= _swig_repr
3610 def __init__(self
, *args
, **kwargs
):
3612 __init__(self) -> PCXHandler
3614 A `wx.ImageHandler` for PCX imager files.
3616 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3617 _core_
.PCXHandler_swigregister(PCXHandler
)
3619 class JPEGHandler(ImageHandler
):
3620 """A `wx.ImageHandler` for JPEG/JPG image files."""
3621 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3622 __repr__
= _swig_repr
3623 def __init__(self
, *args
, **kwargs
):
3625 __init__(self) -> JPEGHandler
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3629 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3630 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3632 class PNMHandler(ImageHandler
):
3633 """A `wx.ImageHandler` for PNM image files."""
3634 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3635 __repr__
= _swig_repr
3636 def __init__(self
, *args
, **kwargs
):
3638 __init__(self) -> PNMHandler
3640 A `wx.ImageHandler` for PNM image files.
3642 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3643 _core_
.PNMHandler_swigregister(PNMHandler
)
3645 class XPMHandler(ImageHandler
):
3646 """A `wx.ImageHandler` for XPM image."""
3647 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3648 __repr__
= _swig_repr
3649 def __init__(self
, *args
, **kwargs
):
3651 __init__(self) -> XPMHandler
3653 A `wx.ImageHandler` for XPM image.
3655 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3656 _core_
.XPMHandler_swigregister(XPMHandler
)
3658 class TIFFHandler(ImageHandler
):
3659 """A `wx.ImageHandler` for TIFF image files."""
3660 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3661 __repr__
= _swig_repr
3662 def __init__(self
, *args
, **kwargs
):
3664 __init__(self) -> TIFFHandler
3666 A `wx.ImageHandler` for TIFF image files.
3668 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3669 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3671 class TGAHandler(ImageHandler
):
3672 """A `wx.ImageHandler` for TGA image files."""
3673 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3674 __repr__
= _swig_repr
3675 def __init__(self
, *args
, **kwargs
):
3677 __init__(self) -> TGAHandler
3679 A `wx.ImageHandler` for TGA image files.
3681 _core_
.TGAHandler_swiginit(self
,_core_
.new_TGAHandler(*args
, **kwargs
))
3682 _core_
.TGAHandler_swigregister(TGAHandler
)
3684 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3686 class Quantize(object):
3687 """Performs quantization, or colour reduction, on a wxImage."""
3688 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3689 def __init__(self
): raise AttributeError, "No constructor defined"
3690 __repr__
= _swig_repr
3691 def Quantize(*args
, **kwargs
):
3693 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3695 Reduce the colours in the source image and put the result into the
3696 destination image, setting the palette in the destination if
3697 needed. Both images may be the same, to overwrite the source image.
3699 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3701 Quantize
= staticmethod(Quantize
)
3702 _core_
.Quantize_swigregister(Quantize
)
3704 def Quantize_Quantize(*args
, **kwargs
):
3706 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3708 Reduce the colours in the source image and put the result into the
3709 destination image, setting the palette in the destination if
3710 needed. Both images may be the same, to overwrite the source image.
3712 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3714 #---------------------------------------------------------------------------
3716 class EvtHandler(Object
):
3717 """Proxy of C++ EvtHandler class"""
3718 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3719 __repr__
= _swig_repr
3720 def __init__(self
, *args
, **kwargs
):
3721 """__init__(self) -> EvtHandler"""
3722 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3723 self
._setOORInfo
(self
)
3725 def GetNextHandler(*args
, **kwargs
):
3726 """GetNextHandler(self) -> EvtHandler"""
3727 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3729 def GetPreviousHandler(*args
, **kwargs
):
3730 """GetPreviousHandler(self) -> EvtHandler"""
3731 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3733 def SetNextHandler(*args
, **kwargs
):
3734 """SetNextHandler(self, EvtHandler handler)"""
3735 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3737 def SetPreviousHandler(*args
, **kwargs
):
3738 """SetPreviousHandler(self, EvtHandler handler)"""
3739 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3741 def GetEvtHandlerEnabled(*args
, **kwargs
):
3742 """GetEvtHandlerEnabled(self) -> bool"""
3743 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3745 def SetEvtHandlerEnabled(*args
, **kwargs
):
3746 """SetEvtHandlerEnabled(self, bool enabled)"""
3747 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3749 def ProcessEvent(*args
, **kwargs
):
3750 """ProcessEvent(self, Event event) -> bool"""
3751 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3753 def AddPendingEvent(*args
, **kwargs
):
3754 """AddPendingEvent(self, Event event)"""
3755 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3757 def ProcessPendingEvents(*args
, **kwargs
):
3758 """ProcessPendingEvents(self)"""
3759 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3761 def Connect(*args
, **kwargs
):
3762 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3763 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3765 def Disconnect(*args
, **kwargs
):
3766 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3767 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3769 def _setOORInfo(*args
, **kwargs
):
3770 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3771 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3772 args
[0].this
.own(False)
3775 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3777 Bind an event to an event handler.
3779 :param event: One of the EVT_* objects that specifies the
3780 type of event to bind,
3782 :param handler: A callable object to be invoked when the
3783 event is delivered to self. Pass None to
3784 disconnect an event handler.
3786 :param source: Sometimes the event originates from a
3787 different window than self, but you still
3788 want to catch it in self. (For example, a
3789 button event delivered to a frame.) By
3790 passing the source of the event, the event
3791 handling system is able to differentiate
3792 between the same event type from different
3795 :param id: Used to spcify the event source by ID instead
3798 :param id2: Used when it is desirable to bind a handler
3799 to a range of IDs, such as with EVT_MENU_RANGE.
3801 if source
is not None:
3803 event
.Bind(self
, id, id2
, handler
)
3805 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3807 Disconencts the event handler binding for event from self.
3808 Returns True if successful.
3810 if source
is not None:
3812 return event
.Unbind(self
, id, id2
)
3814 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3815 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3816 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3817 _core_
.EvtHandler_swigregister(EvtHandler
)
3819 #---------------------------------------------------------------------------
3821 class PyEventBinder(object):
3823 Instances of this class are used to bind specific events to event
3826 def __init__(self
, evtType
, expectedIDs
=0):
3827 if expectedIDs
not in [0, 1, 2]:
3828 raise ValueError, "Invalid number of expectedIDs"
3829 self
.expectedIDs
= expectedIDs
3831 if type(evtType
) == list or type(evtType
) == tuple:
3832 self
.evtType
= evtType
3834 self
.evtType
= [evtType
]
3837 def Bind(self
, target
, id1
, id2
, function
):
3838 """Bind this set of event types to target."""
3839 for et
in self
.evtType
:
3840 target
.Connect(id1
, id2
, et
, function
)
3843 def Unbind(self
, target
, id1
, id2
):
3844 """Remove an event binding."""
3846 for et
in self
.evtType
:
3847 success
+= target
.Disconnect(id1
, id2
, et
)
3851 def __call__(self
, *args
):
3853 For backwards compatibility with the old EVT_* functions.
3854 Should be called with either (window, func), (window, ID,
3855 func) or (window, ID1, ID2, func) parameters depending on the
3858 assert len(args
) == 2 + self
.expectedIDs
3862 if self
.expectedIDs
== 0:
3864 elif self
.expectedIDs
== 1:
3867 elif self
.expectedIDs
== 2:
3872 raise ValueError, "Unexpected number of IDs"
3874 self
.Bind(target
, id1
, id2
, func
)
3877 # These two are square pegs that don't fit the PyEventBinder hole...
3878 def EVT_COMMAND(win
, id, cmd
, func
):
3879 win
.Connect(id, -1, cmd
, func
)
3880 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3881 win
.Connect(id1
, id2
, cmd
, func
)
3884 #---------------------------------------------------------------------------
3886 #---------------------------------------------------------------------------
3888 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3889 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3891 def NewEventType(*args
):
3892 """NewEventType() -> EventType"""
3893 return _core_
.NewEventType(*args
)
3894 wxEVT_NULL
= _core_
.wxEVT_NULL
3895 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3896 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3897 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3898 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3899 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3900 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3901 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3902 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3903 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3904 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3905 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3906 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3907 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3908 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3909 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3910 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3911 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3912 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3913 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3914 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3915 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3916 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3917 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3918 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3919 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3920 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3921 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3922 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3923 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3924 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3925 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3926 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3927 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3928 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3929 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3930 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3931 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3932 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3933 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3934 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3935 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3936 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3937 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3938 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3939 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3940 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3941 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3942 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3943 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3944 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3945 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3946 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3947 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3948 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3949 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3950 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3951 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3952 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3953 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3954 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3955 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3956 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3957 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3958 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3959 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3960 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3961 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3962 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3963 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3964 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3965 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3966 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3967 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3968 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3969 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3970 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3971 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3972 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3973 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3974 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3975 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3976 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3977 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3978 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3979 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3980 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3981 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3982 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3983 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3984 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3985 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3986 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3987 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3988 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3989 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3990 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3991 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3992 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3993 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3994 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3995 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3996 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3997 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3998 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3999 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
4000 wxEVT_SIZING
= _core_
.wxEVT_SIZING
4001 wxEVT_MOVING
= _core_
.wxEVT_MOVING
4002 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
4003 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
4004 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
4005 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
4006 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
4007 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
4008 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
4009 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
4010 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
4011 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
4012 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
4014 # Create some event binders
4015 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
4016 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
4017 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
4018 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
4019 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
4020 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4021 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4022 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
4023 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
4024 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
4025 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
4026 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
4027 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
4028 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
4029 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
4030 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
4031 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
4032 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
4033 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
4034 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
4035 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
4036 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
4037 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
4038 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
4039 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
4040 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
4041 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
4042 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
4043 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
4044 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
4045 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
4046 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
4047 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
4048 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
4049 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
4050 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
4051 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
4052 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
4053 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
4054 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
4055 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
4056 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
4058 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
4059 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
4060 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
4061 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
4062 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
4063 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
4064 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
4065 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
4066 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
4067 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
4068 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
4069 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
4070 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
4072 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
4080 wxEVT_MIDDLE_DCLICK
,
4088 # Scrolling from wxWindow (sent to wxScrolledWindow)
4089 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
4090 wxEVT_SCROLLWIN_BOTTOM
,
4091 wxEVT_SCROLLWIN_LINEUP
,
4092 wxEVT_SCROLLWIN_LINEDOWN
,
4093 wxEVT_SCROLLWIN_PAGEUP
,
4094 wxEVT_SCROLLWIN_PAGEDOWN
,
4095 wxEVT_SCROLLWIN_THUMBTRACK
,
4096 wxEVT_SCROLLWIN_THUMBRELEASE
,
4099 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
4100 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
4101 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
4102 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
4103 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
4104 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
4105 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
4106 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
4108 # Scrolling from wx.Slider and wx.ScrollBar
4109 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4110 wxEVT_SCROLL_BOTTOM
,
4111 wxEVT_SCROLL_LINEUP
,
4112 wxEVT_SCROLL_LINEDOWN
,
4113 wxEVT_SCROLL_PAGEUP
,
4114 wxEVT_SCROLL_PAGEDOWN
,
4115 wxEVT_SCROLL_THUMBTRACK
,
4116 wxEVT_SCROLL_THUMBRELEASE
,
4117 wxEVT_SCROLL_CHANGED
,
4120 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
4121 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
4122 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
4123 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
4124 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
4125 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
4126 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
4127 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
4128 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
4129 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
4131 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4132 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
4133 wxEVT_SCROLL_BOTTOM
,
4134 wxEVT_SCROLL_LINEUP
,
4135 wxEVT_SCROLL_LINEDOWN
,
4136 wxEVT_SCROLL_PAGEUP
,
4137 wxEVT_SCROLL_PAGEDOWN
,
4138 wxEVT_SCROLL_THUMBTRACK
,
4139 wxEVT_SCROLL_THUMBRELEASE
,
4140 wxEVT_SCROLL_CHANGED
,
4143 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
4144 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
4145 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
4146 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
4147 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
4148 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
4149 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
4150 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
4151 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
4152 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
4154 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
4155 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
4156 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
4157 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
4158 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
4159 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
4160 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
4161 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
4162 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
4163 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
4165 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
4166 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
4167 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
4168 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
4169 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
4170 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
4171 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
4172 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
4173 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
4176 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
4177 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
4178 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
4179 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
4180 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
4181 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
4182 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
4184 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
4186 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
4187 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
4189 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
4191 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
4192 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
4193 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
4196 #---------------------------------------------------------------------------
4198 class Event(Object
):
4200 An event is a structure holding information about an event passed to a
4201 callback or member function. wx.Event is an abstract base class for
4204 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4205 def __init__(self
): raise AttributeError, "No constructor defined"
4206 __repr__
= _swig_repr
4207 __swig_destroy__
= _core_
.delete_Event
4208 __del__
= lambda self
: None;
4209 def SetEventType(*args
, **kwargs
):
4211 SetEventType(self, EventType typ)
4213 Sets the specific type of the event.
4215 return _core_
.Event_SetEventType(*args
, **kwargs
)
4217 def GetEventType(*args
, **kwargs
):
4219 GetEventType(self) -> EventType
4221 Returns the identifier of the given event type, such as
4222 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4224 return _core_
.Event_GetEventType(*args
, **kwargs
)
4226 def GetEventObject(*args
, **kwargs
):
4228 GetEventObject(self) -> Object
4230 Returns the object (usually a window) associated with the event, if
4233 return _core_
.Event_GetEventObject(*args
, **kwargs
)
4235 def SetEventObject(*args
, **kwargs
):
4237 SetEventObject(self, Object obj)
4239 Sets the originating object, or in other words, obj is normally the
4240 object that is sending the event.
4242 return _core_
.Event_SetEventObject(*args
, **kwargs
)
4244 def GetTimestamp(*args
, **kwargs
):
4245 """GetTimestamp(self) -> long"""
4246 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
4248 def SetTimestamp(*args
, **kwargs
):
4249 """SetTimestamp(self, long ts=0)"""
4250 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
4252 def GetId(*args
, **kwargs
):
4256 Returns the identifier associated with this event, such as a button
4259 return _core_
.Event_GetId(*args
, **kwargs
)
4261 def SetId(*args
, **kwargs
):
4265 Set's the ID for the event. This is usually the ID of the window that
4266 is sending the event, but it can also be a command id from a menu
4269 return _core_
.Event_SetId(*args
, **kwargs
)
4271 def IsCommandEvent(*args
, **kwargs
):
4273 IsCommandEvent(self) -> bool
4275 Returns true if the event is or is derived from `wx.CommandEvent` else
4276 it returns false. Note: Exists only for optimization purposes.
4278 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
4280 def Skip(*args
, **kwargs
):
4282 Skip(self, bool skip=True)
4284 This method can be used inside an event handler to control whether
4285 further event handlers bound to this event will be called after the
4286 current one returns. Without Skip() (or equivalently if Skip(False) is
4287 used), the event will not be processed any more. If Skip(True) is
4288 called, the event processing system continues searching for a further
4289 handler function for this event, even though it has been processed
4290 already in the current handler.
4292 return _core_
.Event_Skip(*args
, **kwargs
)
4294 def GetSkipped(*args
, **kwargs
):
4296 GetSkipped(self) -> bool
4298 Returns true if the event handler should be skipped, false otherwise.
4301 return _core_
.Event_GetSkipped(*args
, **kwargs
)
4303 def ShouldPropagate(*args
, **kwargs
):
4305 ShouldPropagate(self) -> bool
4307 Test if this event should be propagated to the parent window or not,
4308 i.e. if the propagation level is currently greater than 0.
4310 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
4312 def StopPropagation(*args
, **kwargs
):
4314 StopPropagation(self) -> int
4316 Stop the event from propagating to its parent window. Returns the old
4317 propagation level value which may be later passed to
4318 `ResumePropagation` to allow propagating the event again.
4320 return _core_
.Event_StopPropagation(*args
, **kwargs
)
4322 def ResumePropagation(*args
, **kwargs
):
4324 ResumePropagation(self, int propagationLevel)
4326 Resume the event propagation by restoring the propagation level. (For
4327 example, you can use the value returned by an earlier call to
4331 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
4333 def Clone(*args
, **kwargs
):
4334 """Clone(self) -> Event"""
4335 return _core_
.Event_Clone(*args
, **kwargs
)
4337 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
4338 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
4339 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
4340 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
4341 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
4342 _core_
.Event_swigregister(Event
)
4344 #---------------------------------------------------------------------------
4346 class PropagationDisabler(object):
4348 Helper class to temporarily change an event not to propagate. Simply
4349 create an instance of this class and then whe it is destroyed the
4350 propogation of the event will be restored.
4352 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4353 __repr__
= _swig_repr
4354 def __init__(self
, *args
, **kwargs
):
4356 __init__(self, Event event) -> PropagationDisabler
4358 Helper class to temporarily change an event not to propagate. Simply
4359 create an instance of this class and then whe it is destroyed the
4360 propogation of the event will be restored.
4362 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4363 __swig_destroy__
= _core_
.delete_PropagationDisabler
4364 __del__
= lambda self
: None;
4365 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4367 class PropagateOnce(object):
4369 A helper class that will temporarily lower propagation level of an
4370 event. Simply create an instance of this class and then whe it is
4371 destroyed the propogation of the event will be restored.
4373 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4374 __repr__
= _swig_repr
4375 def __init__(self
, *args
, **kwargs
):
4377 __init__(self, Event event) -> PropagateOnce
4379 A helper class that will temporarily lower propagation level of an
4380 event. Simply create an instance of this class and then whe it is
4381 destroyed the propogation of the event will be restored.
4383 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4384 __swig_destroy__
= _core_
.delete_PropagateOnce
4385 __del__
= lambda self
: None;
4386 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4388 #---------------------------------------------------------------------------
4390 class CommandEvent(Event
):
4392 This event class contains information about command events, which
4393 originate from a variety of simple controls, as well as menus and
4396 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4397 __repr__
= _swig_repr
4398 def __init__(self
, *args
, **kwargs
):
4400 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4402 This event class contains information about command events, which
4403 originate from a variety of simple controls, as well as menus and
4406 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4407 def GetSelection(*args
, **kwargs
):
4409 GetSelection(self) -> int
4411 Returns item index for a listbox or choice selection event (not valid
4414 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4416 def SetString(*args
, **kwargs
):
4417 """SetString(self, String s)"""
4418 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4420 def GetString(*args
, **kwargs
):
4422 GetString(self) -> String
4424 Returns item string for a listbox or choice selection event (not valid
4427 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4429 def IsChecked(*args
, **kwargs
):
4431 IsChecked(self) -> bool
4433 This method can be used with checkbox and menu events: for the
4434 checkboxes, the method returns true for a selection event and false
4435 for a deselection one. For the menu events, this method indicates if
4436 the menu item just has become checked or unchecked (and thus only
4437 makes sense for checkable menu items).
4439 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4442 def IsSelection(*args
, **kwargs
):
4444 IsSelection(self) -> bool
4446 For a listbox or similar event, returns true if it is a selection,
4447 false if it is a deselection.
4449 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4451 def SetExtraLong(*args
, **kwargs
):
4452 """SetExtraLong(self, long extraLong)"""
4453 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4455 def GetExtraLong(*args
, **kwargs
):
4457 GetExtraLong(self) -> long
4459 Returns extra information dependant on the event objects type. If the
4460 event comes from a listbox selection, it is a boolean determining
4461 whether the event was a selection (true) or a deselection (false). A
4462 listbox deselection only occurs for multiple-selection boxes, and in
4463 this case the index and string values are indeterminate and the
4464 listbox must be examined by the application.
4466 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4468 def SetInt(*args
, **kwargs
):
4469 """SetInt(self, int i)"""
4470 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4472 def GetInt(*args
, **kwargs
):
4476 Returns the integer identifier corresponding to a listbox, choice or
4477 radiobox selection (only if the event was a selection, not a
4478 deselection), or a boolean value representing the value of a checkbox.
4480 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4482 def GetClientData(*args
, **kwargs
):
4484 GetClientData(self) -> PyObject
4486 Returns the client data object for a listbox or choice selection event, (if any.)
4488 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4490 def SetClientData(*args
, **kwargs
):
4492 SetClientData(self, PyObject clientData)
4494 Associate the given client data with the item at position n.
4496 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4498 GetClientObject
= GetClientData
4499 SetClientObject
= SetClientData
4501 def Clone(*args
, **kwargs
):
4502 """Clone(self) -> Event"""
4503 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4505 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4506 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4507 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4508 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4509 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4510 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4511 _core_
.CommandEvent_swigregister(CommandEvent
)
4513 #---------------------------------------------------------------------------
4515 class NotifyEvent(CommandEvent
):
4517 An instance of this class (or one of its derived classes) is sent from
4518 a control when the control's state is being changed and the control
4519 allows that change to be prevented from happening. The event handler
4520 can call `Veto` or `Allow` to tell the control what to do.
4522 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4523 __repr__
= _swig_repr
4524 def __init__(self
, *args
, **kwargs
):
4526 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4528 An instance of this class (or one of its derived classes) is sent from
4529 a control when the control's state is being changed and the control
4530 allows that change to be prevented from happening. The event handler
4531 can call `Veto` or `Allow` to tell the control what to do.
4533 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4534 def Veto(*args
, **kwargs
):
4538 Prevents the change announced by this event from happening.
4540 It is in general a good idea to notify the user about the reasons for
4541 vetoing the change because otherwise the applications behaviour (which
4542 just refuses to do what the user wants) might be quite surprising.
4544 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4546 def Allow(*args
, **kwargs
):
4550 This is the opposite of `Veto`: it explicitly allows the event to be
4551 processed. For most events it is not necessary to call this method as
4552 the events are allowed anyhow but some are forbidden by default (this
4553 will be mentioned in the corresponding event description).
4555 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4557 def IsAllowed(*args
, **kwargs
):
4559 IsAllowed(self) -> bool
4561 Returns true if the change is allowed (`Veto` hasn't been called) or
4562 false otherwise (if it was).
4564 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4566 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4568 #---------------------------------------------------------------------------
4570 class ScrollEvent(CommandEvent
):
4572 A scroll event holds information about events sent from stand-alone
4573 scrollbars and sliders. Note that scrolled windows do not send
4574 instnaces of this event class, but send the `wx.ScrollWinEvent`
4577 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4578 __repr__
= _swig_repr
4579 def __init__(self
, *args
, **kwargs
):
4581 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4582 int orient=0) -> ScrollEvent
4584 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4585 def GetOrientation(*args
, **kwargs
):
4587 GetOrientation(self) -> int
4589 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4592 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4594 def GetPosition(*args
, **kwargs
):
4596 GetPosition(self) -> int
4598 Returns the position of the scrollbar.
4600 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4602 def SetOrientation(*args
, **kwargs
):
4603 """SetOrientation(self, int orient)"""
4604 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4606 def SetPosition(*args
, **kwargs
):
4607 """SetPosition(self, int pos)"""
4608 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4610 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4611 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4612 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4614 #---------------------------------------------------------------------------
4616 class ScrollWinEvent(Event
):
4618 A wx.ScrollWinEvent holds information about scrolling and is sent from
4621 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4622 __repr__
= _swig_repr
4623 def __init__(self
, *args
, **kwargs
):
4625 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4627 A wx.ScrollWinEvent holds information about scrolling and is sent from
4630 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4631 def GetOrientation(*args
, **kwargs
):
4633 GetOrientation(self) -> int
4635 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4638 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4640 def GetPosition(*args
, **kwargs
):
4642 GetPosition(self) -> int
4644 Returns the position of the scrollbar for the thumb track and release
4645 events. Note that this field can't be used for the other events, you
4646 need to query the window itself for the current position in that case.
4648 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4650 def SetOrientation(*args
, **kwargs
):
4651 """SetOrientation(self, int orient)"""
4652 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4654 def SetPosition(*args
, **kwargs
):
4655 """SetPosition(self, int pos)"""
4656 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4658 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4659 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4660 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4662 #---------------------------------------------------------------------------
4664 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4665 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4666 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4667 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4668 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4669 class MouseEvent(Event
):
4671 This event class contains information about the events generated by
4672 the mouse: they include mouse buttons press and release events and
4675 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4676 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4677 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4678 a middle button so a portable application should avoid relying on the
4681 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4682 the former returns true when the event corresponds to the left mouse
4683 button click while the latter returns true if the left mouse button is
4684 currently being pressed. For example, when the user is dragging the
4685 mouse you can use `LeftIsDown` to test whether the left mouse button
4686 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4687 `LeftIsDown` will also return true in wxWidgets whatever the
4688 underlying GUI behaviour is (which is platform-dependent). The same
4689 applies, of course, to other mouse buttons as well.
4691 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4692 __repr__
= _swig_repr
4693 def __init__(self
, *args
, **kwargs
):
4695 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4697 Constructs a wx.MouseEvent. Valid event types are:
4699 * wxEVT_ENTER_WINDOW
4700 * wxEVT_LEAVE_WINDOW
4706 * wxEVT_MIDDLE_DCLICK
4709 * wxEVT_RIGHT_DCLICK
4713 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4714 def IsButton(*args
, **kwargs
):
4716 IsButton(self) -> bool
4718 Returns true if the event was a mouse button event (not necessarily a
4719 button down event - that may be tested using `ButtonDown`).
4721 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4723 def ButtonDown(*args
, **kwargs
):
4725 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4727 If the argument is omitted, this returns true if the event was any
4728 mouse button down event. Otherwise the argument specifies which
4729 button-down event shold be checked for (see `Button` for the possible
4732 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4734 def ButtonDClick(*args
, **kwargs
):
4736 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4738 If the argument is omitted, this returns true if the event was any
4739 mouse double click event. Otherwise the argument specifies which
4740 double click event to check for (see `Button` for the possible
4743 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4745 def ButtonUp(*args
, **kwargs
):
4747 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4749 If the argument is omitted, this returns true if the event was any
4750 mouse button up event. Otherwise the argument specifies which button
4751 up event to check for (see `Button` for the possible values).
4753 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4755 def Button(*args
, **kwargs
):
4757 Button(self, int button) -> bool
4759 Returns true if the identified mouse button is changing state. Valid
4760 values of button are:
4762 ==================== =====================================
4763 wx.MOUSE_BTN_LEFT check if left button was pressed
4764 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4765 wx.MOUSE_BTN_RIGHT check if right button was pressed
4766 wx.MOUSE_BTN_ANY check if any button was pressed
4767 ==================== =====================================
4770 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4772 def ButtonIsDown(*args
, **kwargs
):
4773 """ButtonIsDown(self, int but) -> bool"""
4774 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4776 def GetButton(*args
, **kwargs
):
4778 GetButton(self) -> int
4780 Returns the mouse button which generated this event or
4781 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4782 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4783 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4784 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4785 right buttons respectively.
4787 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4789 def ControlDown(*args
, **kwargs
):
4791 ControlDown(self) -> bool
4793 Returns true if the control key was down at the time of the event.
4795 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4797 def MetaDown(*args
, **kwargs
):
4799 MetaDown(self) -> bool
4801 Returns true if the Meta key was down at the time of the event.
4803 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4805 def AltDown(*args
, **kwargs
):
4807 AltDown(self) -> bool
4809 Returns true if the Alt key was down at the time of the event.
4811 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4813 def ShiftDown(*args
, **kwargs
):
4815 ShiftDown(self) -> bool
4817 Returns true if the Shift key was down at the time of the event.
4819 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4821 def CmdDown(*args
, **kwargs
):
4823 CmdDown(self) -> bool
4825 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4826 platforms but the special "Apple" (a.k.a as "Command") key on
4827 Macs. It often makes sense to use it instead of, say, `ControlDown`
4828 because Cmd key is used for the same thing under Mac as Ctrl
4829 elsewhere. The Ctrl key still exists, it's just not used for this
4830 purpose. So for non-Mac platforms this is the same as `ControlDown`
4831 and Macs this is the same as `MetaDown`.
4833 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4835 def LeftDown(*args
, **kwargs
):
4837 LeftDown(self) -> bool
4839 Returns true if the left mouse button state changed to down.
4841 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4843 def MiddleDown(*args
, **kwargs
):
4845 MiddleDown(self) -> bool
4847 Returns true if the middle mouse button state changed to down.
4849 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4851 def RightDown(*args
, **kwargs
):
4853 RightDown(self) -> bool
4855 Returns true if the right mouse button state changed to down.
4857 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4859 def LeftUp(*args
, **kwargs
):
4861 LeftUp(self) -> bool
4863 Returns true if the left mouse button state changed to up.
4865 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4867 def MiddleUp(*args
, **kwargs
):
4869 MiddleUp(self) -> bool
4871 Returns true if the middle mouse button state changed to up.
4873 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4875 def RightUp(*args
, **kwargs
):
4877 RightUp(self) -> bool
4879 Returns true if the right mouse button state changed to up.
4881 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4883 def LeftDClick(*args
, **kwargs
):
4885 LeftDClick(self) -> bool
4887 Returns true if the event was a left button double click.
4889 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4891 def MiddleDClick(*args
, **kwargs
):
4893 MiddleDClick(self) -> bool
4895 Returns true if the event was a middle button double click.
4897 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4899 def RightDClick(*args
, **kwargs
):
4901 RightDClick(self) -> bool
4903 Returns true if the event was a right button double click.
4905 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4907 def LeftIsDown(*args
, **kwargs
):
4909 LeftIsDown(self) -> bool
4911 Returns true if the left mouse button is currently down, independent
4912 of the current event type.
4914 Please notice that it is not the same as LeftDown which returns true
4915 if the left mouse button was just pressed. Rather, it describes the
4916 state of the mouse button before the event happened.
4918 This event is usually used in the mouse event handlers which process
4919 "move mouse" messages to determine whether the user is (still)
4922 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4924 def MiddleIsDown(*args
, **kwargs
):
4926 MiddleIsDown(self) -> bool
4928 Returns true if the middle mouse button is currently down, independent
4929 of the current event type.
4931 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4933 def RightIsDown(*args
, **kwargs
):
4935 RightIsDown(self) -> bool
4937 Returns true if the right mouse button is currently down, independent
4938 of the current event type.
4940 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4942 def Dragging(*args
, **kwargs
):
4944 Dragging(self) -> bool
4946 Returns true if this was a dragging event (motion while a button is
4949 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4951 def Moving(*args
, **kwargs
):
4953 Moving(self) -> bool
4955 Returns true if this was a motion event and no mouse buttons were
4956 pressed. If any mouse button is held pressed, then this method returns
4957 false and Dragging returns true.
4959 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4961 def Entering(*args
, **kwargs
):
4963 Entering(self) -> bool
4965 Returns true if the mouse was entering the window.
4967 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4969 def Leaving(*args
, **kwargs
):
4971 Leaving(self) -> bool
4973 Returns true if the mouse was leaving the window.
4975 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4977 def GetPosition(*args
, **kwargs
):
4979 GetPosition(self) -> Point
4981 Returns the pixel position of the mouse in window coordinates when the
4984 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4986 def GetPositionTuple(*args
, **kwargs
):
4988 GetPositionTuple() -> (x,y)
4990 Returns the pixel position of the mouse in window coordinates when the
4993 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4995 def GetLogicalPosition(*args
, **kwargs
):
4997 GetLogicalPosition(self, DC dc) -> Point
4999 Returns the logical mouse position in pixels (i.e. translated
5000 according to the translation set for the DC, which usually indicates
5001 that the window has been scrolled).
5003 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
5005 def GetX(*args
, **kwargs
):
5009 Returns X coordinate of the physical mouse event position.
5011 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
5013 def GetY(*args
, **kwargs
):
5017 Returns Y coordinate of the physical mouse event position.
5019 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
5021 def GetWheelRotation(*args
, **kwargs
):
5023 GetWheelRotation(self) -> int
5025 Get wheel rotation, positive or negative indicates direction of
5026 rotation. Current devices all send an event when rotation is equal to
5027 +/-WheelDelta, but this allows for finer resolution devices to be
5028 created in the future. Because of this you shouldn't assume that one
5029 event is equal to 1 line or whatever, but you should be able to either
5030 do partial line scrolling or wait until +/-WheelDelta rotation values
5031 have been accumulated before scrolling.
5033 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
5035 def GetWheelDelta(*args
, **kwargs
):
5037 GetWheelDelta(self) -> int
5039 Get wheel delta, normally 120. This is the threshold for action to be
5040 taken, and one such action (for example, scrolling one increment)
5041 should occur for each delta.
5043 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
5045 def GetLinesPerAction(*args
, **kwargs
):
5047 GetLinesPerAction(self) -> int
5049 Returns the configured number of lines (or whatever) to be scrolled
5050 per wheel action. Defaults to three.
5052 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
5054 def IsPageScroll(*args
, **kwargs
):
5056 IsPageScroll(self) -> bool
5058 Returns true if the system has been setup to do page scrolling with
5059 the mouse wheel instead of line scrolling.
5061 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
5063 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
5064 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
5065 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
5066 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
5067 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
5068 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
5069 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
5070 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
5071 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
5072 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
5073 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
5074 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
5075 Button
= property(GetButton
,doc
="See `GetButton`")
5076 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
5077 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
5078 Position
= property(GetPosition
,doc
="See `GetPosition`")
5079 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
5080 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
5081 X
= property(GetX
,doc
="See `GetX`")
5082 Y
= property(GetY
,doc
="See `GetY`")
5083 _core_
.MouseEvent_swigregister(MouseEvent
)
5085 #---------------------------------------------------------------------------
5087 class SetCursorEvent(Event
):
5089 A SetCursorEvent is generated when the mouse cursor is about to be set
5090 as a result of mouse motion. This event gives the application the
5091 chance to perform specific mouse cursor processing based on the
5092 current position of the mouse within the window. Use the `SetCursor`
5093 method to specify the cursor you want to be displayed.
5095 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5096 __repr__
= _swig_repr
5097 def __init__(self
, *args
, **kwargs
):
5099 __init__(self, int x=0, int y=0) -> SetCursorEvent
5101 Construct a new `wx.SetCursorEvent`.
5103 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
5104 def GetX(*args
, **kwargs
):
5108 Returns the X coordinate of the mouse in client coordinates.
5110 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
5112 def GetY(*args
, **kwargs
):
5116 Returns the Y coordinate of the mouse in client coordinates.
5118 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
5120 def SetCursor(*args
, **kwargs
):
5122 SetCursor(self, Cursor cursor)
5124 Sets the cursor associated with this event.
5126 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
5128 def GetCursor(*args
, **kwargs
):
5130 GetCursor(self) -> Cursor
5132 Returns a reference to the cursor specified by this event.
5134 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
5136 def HasCursor(*args
, **kwargs
):
5138 HasCursor(self) -> bool
5140 Returns true if the cursor specified by this event is a valid cursor.
5142 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
5144 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
5145 X
= property(GetX
,doc
="See `GetX`")
5146 Y
= property(GetY
,doc
="See `GetY`")
5147 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
5149 #---------------------------------------------------------------------------
5151 class KeyEvent(Event
):
5153 This event class contains information about keypress and character
5154 events. These events are only sent to the widget that currently has
5157 Notice that there are three different kinds of keyboard events in
5158 wxWidgets: key down and up events and char events. The difference
5159 between the first two is clear - the first corresponds to a key press
5160 and the second to a key release - otherwise they are identical. Just
5161 note that if the key is maintained in a pressed state you will
5162 typically get a lot of (automatically generated) down events but only
5163 one up so it is wrong to assume that there is one up event
5164 corresponding to each down one.
5166 Both key events provide untranslated key codes while the char event
5167 carries the translated one. The untranslated code for alphanumeric
5168 keys is always an upper case value. For the other keys it is one of
5169 WXK_XXX values from the keycodes table. The translated key is, in
5170 general, the character the user expects to appear as the result of the
5171 key combination when typing the text into a text entry zone, for
5174 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5175 and the standard US keyboard): when the 'A' key is pressed, the key
5176 down event key code is equal to ASCII A == 65. But the char event key
5177 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5178 'A' keys simultaneously , the key code in key down event will still be
5179 just 'A' while the char event key code parameter will now be 'A' as
5182 Although in this simple case it is clear that the correct key code
5183 could be found in the key down event handler by checking the value
5184 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5185 as for non alphanumeric keys or non-US keyboard layouts the
5186 translation is keyboard-layout dependent and can only be done properly
5187 by the system itself.
5189 Another kind of translation is done when the control key is pressed:
5190 for example, for CTRL-A key press the key down event still carries the
5191 same key code 'A' as usual but the char event will have key code of 1,
5192 the ASCII value of this key combination.
5194 You may discover how the other keys on your system behave
5195 interactively by running the KeyEvents sample in the wxPython demo and
5196 pressing some keys while the blue box at the top has the keyboard
5199 **Note**: If a key down event is caught and the event handler does not
5200 call event.Skip() then the coresponding char event will not
5201 happen. This is by design and enables the programs that handle both
5202 types of events to be a bit simpler.
5204 **Note for Windows programmers**: The key and char events in wxWidgets
5205 are similar to but slightly different from Windows WM_KEYDOWN and
5206 WM_CHAR events. In particular, Alt-x combination will generate a char
5207 event in wxWidgets (unless it is used as an accelerator).
5209 **Tip**: be sure to call event.Skip() for events that you don't
5210 process in key event function, otherwise menu shortcuts may cease to
5214 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5215 __repr__
= _swig_repr
5216 def __init__(self
, *args
, **kwargs
):
5218 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5220 Construct a new `wx.KeyEvent`. Valid event types are:
5223 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
5224 def GetModifiers(*args
, **kwargs
):
5226 GetModifiers(self) -> int
5228 Returns a bitmask of the current modifier settings. Can be used to
5229 check if the key event has exactly the given modifiers without having
5230 to explicitly check that the other modifiers are not down. For
5233 if event.GetModifers() == wx.MOD_CONTROL:
5237 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
5239 def ControlDown(*args
, **kwargs
):
5241 ControlDown(self) -> bool
5243 Returns ``True`` if the Control key was down at the time of the event.
5245 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
5247 def MetaDown(*args
, **kwargs
):
5249 MetaDown(self) -> bool
5251 Returns ``True`` if the Meta key was down at the time of the event.
5253 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
5255 def AltDown(*args
, **kwargs
):
5257 AltDown(self) -> bool
5259 Returns ``True`` if the Alt key was down at the time of the event.
5261 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
5263 def ShiftDown(*args
, **kwargs
):
5265 ShiftDown(self) -> bool
5267 Returns ``True`` if the Shift key was down at the time of the event.
5269 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
5271 def CmdDown(*args
, **kwargs
):
5273 CmdDown(self) -> bool
5275 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5276 platforms but the special "Apple" (a.k.a as "Command") key on
5277 Macs. It makes often sense to use it instead of, say, `ControlDown`
5278 because Cmd key is used for the same thing under Mac as Ctrl
5279 elsewhere. The Ctrl still exists, it's just not used for this
5280 purpose. So for non-Mac platforms this is the same as `ControlDown`
5281 and Macs this is the same as `MetaDown`.
5283 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
5285 def HasModifiers(*args
, **kwargs
):
5287 HasModifiers(self) -> bool
5289 Returns true if either CTRL or ALT keys was down at the time of the
5290 key event. Note that this function does not take into account neither
5291 SHIFT nor META key states (the reason for ignoring the latter is that
5292 it is common for NUMLOCK key to be configured as META under X but the
5293 key presses even while NUMLOCK is on should be still processed
5296 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
5298 def GetKeyCode(*args
, **kwargs
):
5300 GetKeyCode(self) -> int
5302 Returns the virtual key code. ASCII events return normal ASCII values,
5303 while non-ASCII events return values such as WXK_LEFT for the left
5304 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5307 Note that in Unicode build, the returned value is meaningful only if
5308 the user entered a character that can be represented in current
5309 locale's default charset. You can obtain the corresponding Unicode
5310 character using `GetUnicodeKey`.
5312 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
5314 def GetUnicodeKey(*args
, **kwargs
):
5316 GetUnicodeKey(self) -> int
5318 Returns the Unicode character corresponding to this key event. This
5319 function is only meaningfule in a Unicode build of wxPython.
5321 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
5323 GetUniChar
= GetUnicodeKey
5324 def SetUnicodeKey(*args
, **kwargs
):
5326 SetUnicodeKey(self, int uniChar)
5328 Set the Unicode value of the key event, but only if this is a Unicode
5331 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
5333 def GetRawKeyCode(*args
, **kwargs
):
5335 GetRawKeyCode(self) -> unsigned int
5337 Returns the raw key code for this event. This is a platform-dependent
5338 scan code which should only be used in advanced
5339 applications. Currently the raw key codes are not supported by all
5342 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
5344 def GetRawKeyFlags(*args
, **kwargs
):
5346 GetRawKeyFlags(self) -> unsigned int
5348 Returns the low level key flags for this event. The flags are
5349 platform-dependent and should only be used in advanced applications.
5350 Currently the raw key flags are not supported by all ports.
5352 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5354 def GetPosition(*args
, **kwargs
):
5356 GetPosition(self) -> Point
5358 Find the position of the event, if applicable.
5360 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5362 def GetPositionTuple(*args
, **kwargs
):
5364 GetPositionTuple() -> (x,y)
5366 Find the position of the event, if applicable.
5368 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5370 def GetX(*args
, **kwargs
):
5374 Returns the X position (in client coordinates) of the event, if
5377 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5379 def GetY(*args
, **kwargs
):
5383 Returns the Y position (in client coordinates) of the event, if
5386 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5388 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5389 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5390 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5391 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5392 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5393 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5394 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5395 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5396 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5397 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5398 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5399 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5400 Position
= property(GetPosition
,doc
="See `GetPosition`")
5401 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5402 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5403 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5404 X
= property(GetX
,doc
="See `GetX`")
5405 Y
= property(GetY
,doc
="See `GetY`")
5406 _core_
.KeyEvent_swigregister(KeyEvent
)
5408 #---------------------------------------------------------------------------
5410 class SizeEvent(Event
):
5412 A size event holds information about size change events. The EVT_SIZE
5413 handler function will be called when the window it is bound to has
5416 Note that the size passed is of the whole window: call
5417 `wx.Window.GetClientSize` for the area which may be used by the
5420 When a window is resized, usually only a small part of the window is
5421 damaged and and that area is all that is in the update region for the
5422 next paint event. However, if your drawing depends on the size of the
5423 window, you may need to clear the DC explicitly and repaint the whole
5424 window. In which case, you may need to call `wx.Window.Refresh` to
5425 invalidate the entire window.
5428 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5429 __repr__
= _swig_repr
5430 def __init__(self
, *args
, **kwargs
):
5432 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5434 Construct a new ``wx.SizeEvent``.
5436 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5437 def GetSize(*args
, **kwargs
):
5439 GetSize(self) -> Size
5441 Returns the entire size of the window generating the size change
5444 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5446 def GetRect(*args
, **kwargs
):
5447 """GetRect(self) -> Rect"""
5448 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5450 def SetRect(*args
, **kwargs
):
5451 """SetRect(self, Rect rect)"""
5452 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5454 def SetSize(*args
, **kwargs
):
5455 """SetSize(self, Size size)"""
5456 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5458 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5459 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5460 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5461 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5462 _core_
.SizeEvent_swigregister(SizeEvent
)
5464 #---------------------------------------------------------------------------
5466 class MoveEvent(Event
):
5468 This event object is sent for EVT_MOVE event bindings when a window is
5469 moved to a new position.
5471 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5472 __repr__
= _swig_repr
5473 def __init__(self
, *args
, **kwargs
):
5475 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5479 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5480 def GetPosition(*args
, **kwargs
):
5482 GetPosition(self) -> Point
5484 Returns the position of the window generating the move change event.
5486 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5488 def GetRect(*args
, **kwargs
):
5489 """GetRect(self) -> Rect"""
5490 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5492 def SetRect(*args
, **kwargs
):
5493 """SetRect(self, Rect rect)"""
5494 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5496 def SetPosition(*args
, **kwargs
):
5497 """SetPosition(self, Point pos)"""
5498 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5500 m_pos
= property(GetPosition
, SetPosition
)
5501 m_rect
= property(GetRect
, SetRect
)
5503 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5504 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5505 _core_
.MoveEvent_swigregister(MoveEvent
)
5507 #---------------------------------------------------------------------------
5509 class PaintEvent(Event
):
5511 A paint event is sent when a window's contents needs to be repainted.
5512 Note that in an EVT_PAINT handler the application must *always* create
5513 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5514 Windows assumes that the window has not been painted yet and will send
5515 the event again, causing endless refreshes.
5517 You can optimize painting by retrieving the rectangles that have been
5518 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5519 and only repainting these rectangles. The rectangles are in terms of
5520 the client area, and are unscrolled, so you will need to do some
5521 calculations using the current view position to obtain logical,
5525 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5526 __repr__
= _swig_repr
5527 def __init__(self
, *args
, **kwargs
):
5528 """__init__(self, int Id=0) -> PaintEvent"""
5529 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5530 _core_
.PaintEvent_swigregister(PaintEvent
)
5532 class NcPaintEvent(Event
):
5533 """Proxy of C++ NcPaintEvent class"""
5534 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5535 __repr__
= _swig_repr
5536 def __init__(self
, *args
, **kwargs
):
5537 """__init__(self, int winid=0) -> NcPaintEvent"""
5538 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5539 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5541 #---------------------------------------------------------------------------
5543 class EraseEvent(Event
):
5545 An erase event is sent whenever the background of a window needs to be
5546 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5547 binder. On some platforms, such as GTK+, this event is simulated
5548 (simply generated just before the paint event) and may cause flicker.
5550 To paint a custom background use the `GetDC` method and use the returned
5551 device context if it is not ``None``, otherwise create a temporary
5552 `wx.ClientDC` and draw on that.
5555 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5556 __repr__
= _swig_repr
5557 def __init__(self
, *args
, **kwargs
):
5559 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5563 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5564 def GetDC(*args
, **kwargs
):
5568 Returns the device context the event handler should draw upon. If
5569 ``None`` is returned then create a temporary `wx.ClientDC` and use
5572 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5574 DC
= property(GetDC
,doc
="See `GetDC`")
5575 _core_
.EraseEvent_swigregister(EraseEvent
)
5577 #---------------------------------------------------------------------------
5579 class FocusEvent(Event
):
5581 A focus event is sent when a window's focus changes. The window losing
5582 focus receives an EVT_KILL_FOCUS event while the window gaining it
5583 gets an EVT_SET_FOCUS event.
5585 Notice that the set focus event happens both when the user gives focus
5586 to the window (whether using the mouse or keyboard) and when it is
5587 done from the program itself using `wx.Window.SetFocus`.
5590 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5591 __repr__
= _swig_repr
5592 def __init__(self
, *args
, **kwargs
):
5594 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5598 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5599 def GetWindow(*args
, **kwargs
):
5601 GetWindow(self) -> Window
5603 Returns the other window associated with this event, that is the
5604 window which had the focus before for the EVT_SET_FOCUS event and the
5605 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5607 Warning: the window returned may be None!
5609 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5611 def SetWindow(*args
, **kwargs
):
5612 """SetWindow(self, Window win)"""
5613 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5615 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5616 _core_
.FocusEvent_swigregister(FocusEvent
)
5618 #---------------------------------------------------------------------------
5620 class ChildFocusEvent(CommandEvent
):
5622 A child focus event is sent to a (parent-)window when one of its child
5623 windows gains focus, so that the window could restore the focus back
5624 to its corresponding child if it loses it now and regains later.
5626 Notice that child window is the direct child of the window receiving
5627 the event, and so may not be the actual widget recieving focus if it
5628 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5629 to get the widget that is actually receiving focus.
5631 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5632 __repr__
= _swig_repr
5633 def __init__(self
, *args
, **kwargs
):
5635 __init__(self, Window win=None) -> ChildFocusEvent
5639 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5640 def GetWindow(*args
, **kwargs
):
5642 GetWindow(self) -> Window
5644 The window, or (grand)parent of the window which has just received the
5647 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5649 Window
= property(GetWindow
,doc
="See `GetWindow`")
5650 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5652 #---------------------------------------------------------------------------
5654 class ActivateEvent(Event
):
5656 An activate event is sent when a top-level window or the entire
5657 application is being activated or deactivated.
5659 A top-level window (a dialog or frame) receives an activate event when
5660 is being activated or deactivated. This is indicated visually by the
5661 title bar changing colour, and a subwindow gaining the keyboard focus.
5662 An application is activated or deactivated when one of its frames
5663 becomes activated, or a frame becomes inactivate resulting in all
5664 application frames being inactive.
5666 Please note that usually you should call event.Skip() in your handlers
5667 for these events so the default handlers will still be called, as not
5668 doing so can result in strange effects.
5671 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5672 __repr__
= _swig_repr
5673 def __init__(self
, *args
, **kwargs
):
5675 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5679 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5680 def GetActive(*args
, **kwargs
):
5682 GetActive(self) -> bool
5684 Returns true if the application or window is being activated, false
5687 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5689 Active
= property(GetActive
,doc
="See `GetActive`")
5690 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5692 #---------------------------------------------------------------------------
5694 class InitDialogEvent(Event
):
5696 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5697 any window when `wx.Window.InitDialog` is called. Handlers for this
5698 event can transfer data to the window, or anything else that should be
5699 done before the user begins editing the form. The default handler
5700 calls `wx.Window.TransferDataToWindow`.
5702 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5703 __repr__
= _swig_repr
5704 def __init__(self
, *args
, **kwargs
):
5706 __init__(self, int Id=0) -> InitDialogEvent
5710 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5711 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5713 #---------------------------------------------------------------------------
5715 class MenuEvent(Event
):
5717 This class is used for a variety of menu-related events. Note that
5718 these do not include menu command events, which are handled by sending
5719 `wx.CommandEvent` objects.
5721 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5722 text in the first field of the status bar.
5724 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5725 __repr__
= _swig_repr
5726 def __init__(self
, *args
, **kwargs
):
5728 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5732 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5733 def GetMenuId(*args
, **kwargs
):
5735 GetMenuId(self) -> int
5737 Returns the menu identifier associated with the event. This method
5738 should be only used with the HIGHLIGHT events.
5740 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5742 def IsPopup(*args
, **kwargs
):
5744 IsPopup(self) -> bool
5746 Returns ``True`` if the menu which is being opened or closed is a
5747 popup menu, ``False`` if it is a normal one. This method should only
5748 be used with the OPEN and CLOSE events.
5750 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5752 def GetMenu(*args
, **kwargs
):
5754 GetMenu(self) -> Menu
5756 Returns the menu which is being opened or closed. This method should
5757 only be used with the OPEN and CLOSE events.
5759 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5761 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5762 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5763 _core_
.MenuEvent_swigregister(MenuEvent
)
5765 #---------------------------------------------------------------------------
5767 class CloseEvent(Event
):
5769 This event class contains information about window and session close
5772 The handler function for EVT_CLOSE is called when the user has tried
5773 to close a a frame or dialog box using the window manager controls or
5774 the system menu. It can also be invoked by the application itself
5775 programmatically, for example by calling the `wx.Window.Close`
5778 You should check whether the application is forcing the deletion of
5779 the window using `CanVeto`. If it returns ``False``, you must destroy
5780 the window using `wx.Window.Destroy`. If the return value is ``True``,
5781 it is up to you whether you respond by destroying the window or not.
5782 For example you may wish to display a message dialog prompting to save
5783 files or to cancel the close.
5785 If you don't destroy the window, you should call `Veto` to let the
5786 calling code know that you did not destroy the window. This allows the
5787 `wx.Window.Close` function to return ``True`` or ``False`` depending
5788 on whether the close instruction was honored or not.
5790 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5791 __repr__
= _swig_repr
5792 def __init__(self
, *args
, **kwargs
):
5794 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5798 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5799 def SetLoggingOff(*args
, **kwargs
):
5801 SetLoggingOff(self, bool logOff)
5803 Sets the 'logging off' flag.
5805 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5807 def GetLoggingOff(*args
, **kwargs
):
5809 GetLoggingOff(self) -> bool
5811 Returns ``True`` if the user is logging off or ``False`` if the
5812 system is shutting down. This method can only be called for end
5813 session and query end session events, it doesn't make sense for close
5816 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5818 def Veto(*args
, **kwargs
):
5820 Veto(self, bool veto=True)
5822 Call this from your event handler to veto a system shutdown or to
5823 signal to the calling application that a window close did not happen.
5825 You can only veto a shutdown or close if `CanVeto` returns true.
5827 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5829 def GetVeto(*args
, **kwargs
):
5830 """GetVeto(self) -> bool"""
5831 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5833 def SetCanVeto(*args
, **kwargs
):
5835 SetCanVeto(self, bool canVeto)
5837 Sets the 'can veto' flag.
5839 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5841 def CanVeto(*args
, **kwargs
):
5843 CanVeto(self) -> bool
5845 Returns true if you can veto a system shutdown or a window close
5846 event. Vetoing a window close event is not possible if the calling
5847 code wishes to force the application to exit, and so this function
5848 must be called to check this.
5850 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5852 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5853 _core_
.CloseEvent_swigregister(CloseEvent
)
5855 #---------------------------------------------------------------------------
5857 class ShowEvent(Event
):
5858 """An EVT_SHOW event is sent when a window is shown or hidden."""
5859 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5860 __repr__
= _swig_repr
5861 def __init__(self
, *args
, **kwargs
):
5863 __init__(self, int winid=0, bool show=False) -> ShowEvent
5865 An EVT_SHOW event is sent when a window is shown or hidden.
5867 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5868 def SetShow(*args
, **kwargs
):
5869 """SetShow(self, bool show)"""
5870 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5872 def GetShow(*args
, **kwargs
):
5873 """GetShow(self) -> bool"""
5874 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5876 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5877 _core_
.ShowEvent_swigregister(ShowEvent
)
5879 #---------------------------------------------------------------------------
5881 class IconizeEvent(Event
):
5883 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5886 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5887 __repr__
= _swig_repr
5888 def __init__(self
, *args
, **kwargs
):
5890 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5892 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5895 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5896 def Iconized(*args
, **kwargs
):
5898 Iconized(self) -> bool
5900 Returns ``True`` if the frame has been iconized, ``False`` if it has
5903 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5905 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5907 #---------------------------------------------------------------------------
5909 class MaximizeEvent(Event
):
5910 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5911 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5912 __repr__
= _swig_repr
5913 def __init__(self
, *args
, **kwargs
):
5915 __init__(self, int id=0) -> MaximizeEvent
5917 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5919 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5920 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5922 #---------------------------------------------------------------------------
5924 class DropFilesEvent(Event
):
5926 This class is used for drop files events, that is, when files have
5927 been dropped onto the window. This functionality is only available
5928 under Windows. The window must have previously been enabled for
5929 dropping by calling `wx.Window.DragAcceptFiles`.
5931 Important note: this is a separate implementation to the more general
5932 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5933 implementation uses the older, Windows message-based approach of
5936 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5940 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5941 def __init__(self
): raise AttributeError, "No constructor defined"
5942 __repr__
= _swig_repr
5943 def GetPosition(*args
, **kwargs
):
5945 GetPosition(self) -> Point
5947 Returns the position at which the files were dropped.
5949 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5951 def GetNumberOfFiles(*args
, **kwargs
):
5953 GetNumberOfFiles(self) -> int
5955 Returns the number of files dropped.
5957 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5959 def GetFiles(*args
, **kwargs
):
5961 GetFiles(self) -> PyObject
5963 Returns a list of the filenames that were dropped.
5965 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5967 Files
= property(GetFiles
,doc
="See `GetFiles`")
5968 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5969 Position
= property(GetPosition
,doc
="See `GetPosition`")
5970 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5972 #---------------------------------------------------------------------------
5974 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5975 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5976 class UpdateUIEvent(CommandEvent
):
5978 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5979 wxWidgets to give an application the chance to update various user
5982 Without update UI events, an application has to work hard to
5983 check/uncheck, enable/disable, and set the text for elements such as
5984 menu items and toolbar buttons. The code for doing this has to be
5985 mixed up with the code that is invoked when an action is invoked for a
5986 menu item or button.
5988 With update UI events, you define an event handler to look at the
5989 state of the application and change UI elements accordingly. wxWidgets
5990 will call your handler functions in idle time, so you don't have to
5991 worry where to call this code. In addition to being a clearer and more
5992 declarative method, it also means you don't have to worry whether
5993 you're updating a toolbar or menubar identifier. The same handler can
5994 update a menu item and toolbar button, if the ID values are the same.
5996 Instead of directly manipulating the menu or button, you call
5997 functions in the event object, such as `Check`. wxWidgets will
5998 determine whether such a call has been made, and which UI element to
6001 These events will work for popup menus as well as menubars. Just
6002 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6003 any UI events for the window that owns the menu.
6005 If you find that the overhead of UI update processing is affecting
6006 your application, you can do one or both of the following:
6008 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6009 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6010 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6011 receive update events. No other windows will receive update
6014 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6015 value to set the delay between updates. You may need to call
6016 `wx.Window.UpdateWindowUI` at critical points, for example when
6017 a dialog is about to be shown, in case the user sees a slight
6018 delay before windows are updated.
6020 Note that although events are sent in idle time, defining a EVT_IDLE
6021 handler for a window does not affect this because the events are sent
6022 from an internal idle handler.
6024 wxWidgets tries to optimize update events on some platforms. On
6025 Windows and GTK+, events for menubar items are only sent when the menu
6026 is about to be shown, and not in idle time.
6029 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6030 __repr__
= _swig_repr
6031 def __init__(self
, *args
, **kwargs
):
6033 __init__(self, int commandId=0) -> UpdateUIEvent
6037 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
6038 def GetChecked(*args
, **kwargs
):
6040 GetChecked(self) -> bool
6042 Returns ``True`` if the UI element should be checked.
6044 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
6046 def GetEnabled(*args
, **kwargs
):
6048 GetEnabled(self) -> bool
6050 Returns ``True`` if the UI element should be enabled.
6052 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
6054 def GetShown(*args
, **kwargs
):
6056 GetShown(self) -> bool
6058 Returns ``True`` if the UI element should be shown.
6060 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
6062 def GetText(*args
, **kwargs
):
6064 GetText(self) -> String
6066 Returns the text that should be set for the UI element.
6068 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
6070 def GetSetText(*args
, **kwargs
):
6072 GetSetText(self) -> bool
6074 Returns ``True`` if the application has called `SetText`. For
6075 wxWidgets internal use only.
6077 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
6079 def GetSetChecked(*args
, **kwargs
):
6081 GetSetChecked(self) -> bool
6083 Returns ``True`` if the application has called `Check`. For wxWidgets
6086 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
6088 def GetSetEnabled(*args
, **kwargs
):
6090 GetSetEnabled(self) -> bool
6092 Returns ``True`` if the application has called `Enable`. For wxWidgets
6095 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
6097 def GetSetShown(*args
, **kwargs
):
6099 GetSetShown(self) -> bool
6101 Returns ``True`` if the application has called `Show`. For wxWidgets
6104 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
6106 def Check(*args
, **kwargs
):
6108 Check(self, bool check)
6110 Check or uncheck the UI element.
6112 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
6114 def Enable(*args
, **kwargs
):
6116 Enable(self, bool enable)
6118 Enable or disable the UI element.
6120 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
6122 def Show(*args
, **kwargs
):
6124 Show(self, bool show)
6126 Show or hide the UI element.
6128 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
6130 def SetText(*args
, **kwargs
):
6132 SetText(self, String text)
6134 Sets the text for this UI element.
6136 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
6138 def SetUpdateInterval(*args
, **kwargs
):
6140 SetUpdateInterval(long updateInterval)
6142 Sets the interval between updates in milliseconds. Set to -1 to
6143 disable updates, or to 0 to update as frequently as possible. The
6146 Use this to reduce the overhead of UI update events if your
6147 application has a lot of windows. If you set the value to -1 or
6148 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6149 at appropriate points in your application, such as when a dialog is
6152 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6154 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
6155 def GetUpdateInterval(*args
, **kwargs
):
6157 GetUpdateInterval() -> long
6159 Returns the current interval between updates in milliseconds. -1
6160 disables updates, 0 updates as frequently as possible.
6162 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
6164 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
6165 def CanUpdate(*args
, **kwargs
):
6167 CanUpdate(Window win) -> bool
6169 Returns ``True`` if it is appropriate to update (send UI update events
6172 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6173 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6174 events were last sent in idle time, and the update interval, to
6175 determine whether events should be sent to this window now. By default
6176 this will always return true because the update mode is initially
6177 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6178 events will be sent as often as possible. You can reduce the frequency
6179 that events are sent by changing the mode and/or setting an update
6183 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6185 CanUpdate
= staticmethod(CanUpdate
)
6186 def ResetUpdateTime(*args
, **kwargs
):
6190 Used internally to reset the last-updated time to the current time. It
6191 is assumed that update events are normally sent in idle time, so this
6192 is called at the end of idle processing.
6194 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
6196 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
6197 def SetMode(*args
, **kwargs
):
6201 Specify how wxWidgets will send update events: to all windows, or only
6202 to those which specify that they will process the events.
6204 The mode may be one of the following values:
6206 ============================= ==========================================
6207 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6208 is the default setting.
6209 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6210 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6212 ============================= ==========================================
6215 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6217 SetMode
= staticmethod(SetMode
)
6218 def GetMode(*args
, **kwargs
):
6222 Returns a value specifying how wxWidgets will send update events: to
6223 all windows, or only to those which specify that they will process the
6226 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
6228 GetMode
= staticmethod(GetMode
)
6229 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
6230 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
6231 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
6232 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
6233 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
6235 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
6237 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6239 Sets the interval between updates in milliseconds. Set to -1 to
6240 disable updates, or to 0 to update as frequently as possible. The
6243 Use this to reduce the overhead of UI update events if your
6244 application has a lot of windows. If you set the value to -1 or
6245 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6246 at appropriate points in your application, such as when a dialog is
6249 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
6251 def UpdateUIEvent_GetUpdateInterval(*args
):
6253 UpdateUIEvent_GetUpdateInterval() -> long
6255 Returns the current interval between updates in milliseconds. -1
6256 disables updates, 0 updates as frequently as possible.
6258 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
6260 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
6262 UpdateUIEvent_CanUpdate(Window win) -> bool
6264 Returns ``True`` if it is appropriate to update (send UI update events
6267 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6268 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6269 events were last sent in idle time, and the update interval, to
6270 determine whether events should be sent to this window now. By default
6271 this will always return true because the update mode is initially
6272 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6273 events will be sent as often as possible. You can reduce the frequency
6274 that events are sent by changing the mode and/or setting an update
6278 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
6280 def UpdateUIEvent_ResetUpdateTime(*args
):
6282 UpdateUIEvent_ResetUpdateTime()
6284 Used internally to reset the last-updated time to the current time. It
6285 is assumed that update events are normally sent in idle time, so this
6286 is called at the end of idle processing.
6288 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
6290 def UpdateUIEvent_SetMode(*args
, **kwargs
):
6292 UpdateUIEvent_SetMode(int mode)
6294 Specify how wxWidgets will send update events: to all windows, or only
6295 to those which specify that they will process the events.
6297 The mode may be one of the following values:
6299 ============================= ==========================================
6300 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6301 is the default setting.
6302 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6303 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6305 ============================= ==========================================
6308 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
6310 def UpdateUIEvent_GetMode(*args
):
6312 UpdateUIEvent_GetMode() -> int
6314 Returns a value specifying how wxWidgets will send update events: to
6315 all windows, or only to those which specify that they will process the
6318 return _core_
.UpdateUIEvent_GetMode(*args
)
6320 #---------------------------------------------------------------------------
6322 class SysColourChangedEvent(Event
):
6324 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6325 when the user changes the colour settings using the control
6326 panel. This is only applicable under Windows.
6328 The default event handler for this event propagates the event to child
6329 windows, since Windows only sends the events to top-level windows. If
6330 intercepting this event for a top-level window, remember to call
6331 `Skip` so the the base class handler will still be executed, or to
6332 pass the event on to the window's children explicitly.
6335 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6336 __repr__
= _swig_repr
6337 def __init__(self
, *args
, **kwargs
):
6339 __init__(self) -> SysColourChangedEvent
6343 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
6344 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
6346 #---------------------------------------------------------------------------
6348 class MouseCaptureChangedEvent(Event
):
6350 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6351 a window that loses its mouse capture. This is called even if
6352 `wx.Window.ReleaseMouse` was called by the application code. Handling
6353 this event allows an application to cater for unexpected capture
6354 releases which might otherwise confuse mouse handling code.
6356 This event is implemented under Windows only.
6358 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6359 __repr__
= _swig_repr
6360 def __init__(self
, *args
, **kwargs
):
6362 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6366 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6367 def GetCapturedWindow(*args
, **kwargs
):
6369 GetCapturedWindow(self) -> Window
6371 Returns the window that gained the capture, or ``None`` if it was a
6372 non-wxWidgets window.
6374 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6376 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6377 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6379 #---------------------------------------------------------------------------
6381 class MouseCaptureLostEvent(Event
):
6383 A mouse capture lost event is sent to a window that obtained mouse
6384 capture, which was subsequently loss due to "external" event, for
6385 example when a dialog box is shown or if another application captures
6388 If this happens, this event is sent to all windows that are on the
6389 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6390 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6391 if the capture changes because of a call to CaptureMouse or
6394 This event is currently emitted under Windows only.
6397 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6398 __repr__
= _swig_repr
6399 def __init__(self
, *args
, **kwargs
):
6401 __init__(self, int winid=0) -> MouseCaptureLostEvent
6403 A mouse capture lost event is sent to a window that obtained mouse
6404 capture, which was subsequently loss due to "external" event, for
6405 example when a dialog box is shown or if another application captures
6408 If this happens, this event is sent to all windows that are on the
6409 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6410 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6411 if the capture changes because of a call to CaptureMouse or
6414 This event is currently emitted under Windows only.
6417 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6418 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6420 #---------------------------------------------------------------------------
6422 class DisplayChangedEvent(Event
):
6424 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6425 resolution has changed.
6427 This event is implemented under Windows only.
6429 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6430 __repr__
= _swig_repr
6431 def __init__(self
, *args
, **kwargs
):
6432 """__init__(self) -> DisplayChangedEvent"""
6433 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6434 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6436 #---------------------------------------------------------------------------
6438 class PaletteChangedEvent(Event
):
6440 An EVT_PALETTE_CHANGED event is sent when the system palette has
6441 changed, thereby giving each window a chance to redo their own to
6444 This event is implemented under Windows only.
6446 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6447 __repr__
= _swig_repr
6448 def __init__(self
, *args
, **kwargs
):
6450 __init__(self, int id=0) -> PaletteChangedEvent
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6456 This event is implemented under Windows only.
6458 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6459 def SetChangedWindow(*args
, **kwargs
):
6460 """SetChangedWindow(self, Window win)"""
6461 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6463 def GetChangedWindow(*args
, **kwargs
):
6464 """GetChangedWindow(self) -> Window"""
6465 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6467 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6468 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6470 #---------------------------------------------------------------------------
6472 class QueryNewPaletteEvent(Event
):
6474 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6475 focus and should re-do its palette.
6477 This event is implemented under Windows only.
6479 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6480 __repr__
= _swig_repr
6481 def __init__(self
, *args
, **kwargs
):
6483 __init__(self, int winid=0) -> QueryNewPaletteEvent
6487 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6488 def SetPaletteRealized(*args
, **kwargs
):
6490 SetPaletteRealized(self, bool realized)
6492 App should set this if it changes the palette.
6494 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6496 def GetPaletteRealized(*args
, **kwargs
):
6497 """GetPaletteRealized(self) -> bool"""
6498 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6500 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6501 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6503 #---------------------------------------------------------------------------
6505 class NavigationKeyEvent(Event
):
6507 EVT_NAVIGATION_KEY events are used to control moving the focus between
6508 widgets, otherwise known as tab-traversal. You woudl normally not
6509 catch navigation events in applications as there are already
6510 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6511 it useful to send navigation events in certain situations to change
6512 the focus in certain ways, although it's probably easier to just call
6513 `wx.Window.Navigate`.
6515 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6516 __repr__
= _swig_repr
6517 def __init__(self
, *args
, **kwargs
):
6518 """__init__(self) -> NavigationKeyEvent"""
6519 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6520 def GetDirection(*args
, **kwargs
):
6522 GetDirection(self) -> bool
6524 Returns ``True`` if the direction is forward, ``False`` otherwise.
6526 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6528 def SetDirection(*args
, **kwargs
):
6530 SetDirection(self, bool forward)
6532 Specify the direction that the navigation should take. Usually the
6533 difference between using Tab and Shift-Tab.
6535 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6537 def IsWindowChange(*args
, **kwargs
):
6539 IsWindowChange(self) -> bool
6541 Returns ``True`` if window change is allowed.
6543 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6545 def SetWindowChange(*args
, **kwargs
):
6547 SetWindowChange(self, bool ischange)
6549 Specify if the navigation should be able to change parent windows.
6550 For example, changing notebook pages, etc. This is usually implemented
6551 by using Control-Tab.
6553 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6555 def IsFromTab(*args
, **kwargs
):
6557 IsFromTab(self) -> bool
6559 Returns ``True`` if the navigation event is originated from the Tab
6562 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6564 def SetFromTab(*args
, **kwargs
):
6566 SetFromTab(self, bool bIs)
6568 Set to true under MSW if the event was generated using the tab key.
6569 This is required for proper navogation over radio buttons.
6571 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6573 def SetFlags(*args
, **kwargs
):
6575 SetFlags(self, long flags)
6577 Set the navigation flags to a combination of the following:
6579 * wx.NavigationKeyEvent.IsBackward
6580 * wx.NavigationKeyEvent.IsForward
6581 * wx.NavigationKeyEvent.WinChange
6582 * wx.NavigationKeyEvent.FromTab
6585 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6587 def GetCurrentFocus(*args
, **kwargs
):
6589 GetCurrentFocus(self) -> Window
6591 Returns the child window which currenty has the focus. May be
6594 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6596 def SetCurrentFocus(*args
, **kwargs
):
6598 SetCurrentFocus(self, Window win)
6600 Set the window that has the focus.
6602 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6604 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6605 IsForward
= _core_
.NavigationKeyEvent_IsForward
6606 WinChange
= _core_
.NavigationKeyEvent_WinChange
6607 FromTab
= _core_
.NavigationKeyEvent_FromTab
6608 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6609 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6610 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6612 #---------------------------------------------------------------------------
6614 class WindowCreateEvent(CommandEvent
):
6616 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6617 underlying GUI object) exists.
6619 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6620 __repr__
= _swig_repr
6621 def __init__(self
, *args
, **kwargs
):
6623 __init__(self, Window win=None) -> WindowCreateEvent
6625 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6626 underlying GUI object) exists.
6628 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6629 def GetWindow(*args
, **kwargs
):
6631 GetWindow(self) -> Window
6633 Returns the window that this event refers to.
6635 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6637 Window
= property(GetWindow
,doc
="See `GetWindow`")
6638 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6640 class WindowDestroyEvent(CommandEvent
):
6642 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6643 when the GUI window is destroyed.
6645 When a class derived from `wx.Window` is destroyed its destructor will
6646 have already run by the time this event is sent. Therefore this event
6647 will not usually be received at all by the window itself. Since it is
6648 received after the destructor has run, an object should not try to
6649 handle its own wx.WindowDestroyEvent, but it can be used to get
6650 notification of the destruction of another window.
6652 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6653 __repr__
= _swig_repr
6654 def __init__(self
, *args
, **kwargs
):
6656 __init__(self, Window win=None) -> WindowDestroyEvent
6658 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6659 when the GUI window is destroyed.
6661 When a class derived from `wx.Window` is destroyed its destructor will
6662 have already run by the time this event is sent. Therefore this event
6663 will not usually be received at all by the window itself. Since it is
6664 received after the destructor has run, an object should not try to
6665 handle its own wx.WindowDestroyEvent, but it can be used to get
6666 notification of the destruction of another window.
6668 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6669 def GetWindow(*args
, **kwargs
):
6671 GetWindow(self) -> Window
6673 Returns the window that this event refers to.
6675 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6677 Window
= property(GetWindow
,doc
="See `GetWindow`")
6678 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6680 #---------------------------------------------------------------------------
6682 class ContextMenuEvent(CommandEvent
):
6684 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6685 give the application a chance to show a context (popup) menu.
6687 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6688 __repr__
= _swig_repr
6689 def __init__(self
, *args
, **kwargs
):
6691 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6695 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6696 def GetPosition(*args
, **kwargs
):
6698 GetPosition(self) -> Point
6700 Returns the position (in screen coordinants) at which the menu should
6703 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6705 def SetPosition(*args
, **kwargs
):
6707 SetPosition(self, Point pos)
6709 Sets the position at which the menu should be shown.
6711 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6713 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6714 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6716 #---------------------------------------------------------------------------
6718 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6719 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6720 class IdleEvent(Event
):
6722 This class is used for EVT_IDLE events, which are generated and sent
6723 when the application *becomes* idle. In other words, the when the
6724 event queue becomes empty then idle events are sent to all windows (by
6725 default) and as long as none of them call `RequestMore` then there are
6726 no more idle events until after the system event queue has some normal
6727 events and then becomes empty again.
6729 By default, idle events are sent to all windows. If this is causing a
6730 significant overhead in your application, you can call
6731 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6732 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6733 which should receive idle events. Then idle events will only be sent
6734 to those windows and not to any others.
6736 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6737 __repr__
= _swig_repr
6738 def __init__(self
, *args
, **kwargs
):
6740 __init__(self) -> IdleEvent
6744 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6745 def RequestMore(*args
, **kwargs
):
6747 RequestMore(self, bool needMore=True)
6749 Tells wxWidgets that more processing is required. This function can be
6750 called by an EVT_IDLE handler for a window to indicate that the
6751 application should forward the EVT_IDLE event once more to the
6752 application windows. If no window calls this function during its
6753 EVT_IDLE handler, then the application will remain in a passive event
6754 loop until a new event is posted to the application by the windowing
6757 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6759 def MoreRequested(*args
, **kwargs
):
6761 MoreRequested(self) -> bool
6763 Returns ``True`` if the OnIdle function processing this event
6764 requested more processing time.
6766 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6768 def SetMode(*args
, **kwargs
):
6772 Static method for specifying how wxWidgets will send idle events: to
6773 all windows, or only to those which specify that they will process the
6776 The mode can be one of the following values:
6778 ========================= ========================================
6779 wx.IDLE_PROCESS_ALL Send idle events to all windows
6780 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6781 the wx.WS_EX_PROCESS_IDLE extra style
6783 ========================= ========================================
6786 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6788 SetMode
= staticmethod(SetMode
)
6789 def GetMode(*args
, **kwargs
):
6793 Static method returning a value specifying how wxWidgets will send
6794 idle events: to all windows, or only to those which specify that they
6795 will process the events.
6797 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6799 GetMode
= staticmethod(GetMode
)
6800 def CanSend(*args
, **kwargs
):
6802 CanSend(Window win) -> bool
6804 Returns ``True`` if it is appropriate to send idle events to this
6807 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6808 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6809 events should be sent to this window now. By default this will always
6810 return ``True`` because the update mode is initially
6811 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6812 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6814 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6816 CanSend
= staticmethod(CanSend
)
6817 _core_
.IdleEvent_swigregister(IdleEvent
)
6819 def IdleEvent_SetMode(*args
, **kwargs
):
6821 IdleEvent_SetMode(int mode)
6823 Static method for specifying how wxWidgets will send idle events: to
6824 all windows, or only to those which specify that they will process the
6827 The mode can be one of the following values:
6829 ========================= ========================================
6830 wx.IDLE_PROCESS_ALL Send idle events to all windows
6831 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6832 the wx.WS_EX_PROCESS_IDLE extra style
6834 ========================= ========================================
6837 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6839 def IdleEvent_GetMode(*args
):
6841 IdleEvent_GetMode() -> int
6843 Static method returning a value specifying how wxWidgets will send
6844 idle events: to all windows, or only to those which specify that they
6845 will process the events.
6847 return _core_
.IdleEvent_GetMode(*args
)
6849 def IdleEvent_CanSend(*args
, **kwargs
):
6851 IdleEvent_CanSend(Window win) -> bool
6853 Returns ``True`` if it is appropriate to send idle events to this
6856 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6857 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6858 events should be sent to this window now. By default this will always
6859 return ``True`` because the update mode is initially
6860 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6861 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6863 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6865 #---------------------------------------------------------------------------
6867 class ClipboardTextEvent(CommandEvent
):
6869 A Clipboard Text event is sent when a window intercepts a text
6870 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6871 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6872 popup menu command, etc. NOTE : under windows these events are *NOT*
6873 generated automatically for a Rich Edit text control.
6875 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6876 __repr__
= _swig_repr
6877 def __init__(self
, *args
, **kwargs
):
6879 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6887 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6888 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6890 #---------------------------------------------------------------------------
6892 class PyEvent(Event
):
6894 wx.PyEvent can be used as a base class for implementing custom event
6895 types in Python. You should derived from this class instead of
6896 `wx.Event` because this class is Python-aware and is able to transport
6897 its Python bits safely through the wxWidgets event system and have
6898 them still be there when the event handler is invoked.
6900 :see: `wx.PyCommandEvent`
6903 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6904 __repr__
= _swig_repr
6905 def __init__(self
, *args
, **kwargs
):
6906 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6907 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6910 __swig_destroy__
= _core_
.delete_PyEvent
6911 __del__
= lambda self
: None;
6912 def _SetSelf(*args
, **kwargs
):
6913 """_SetSelf(self, PyObject self)"""
6914 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6916 def _GetSelf(*args
, **kwargs
):
6917 """_GetSelf(self) -> PyObject"""
6918 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6920 _core_
.PyEvent_swigregister(PyEvent
)
6922 class PyCommandEvent(CommandEvent
):
6924 wx.PyCommandEvent can be used as a base class for implementing custom
6925 event types in Python, where the event shoudl travel up to parent
6926 windows looking for a handler. You should derived from this class
6927 instead of `wx.CommandEvent` because this class is Python-aware and is
6928 able to transport its Python bits safely through the wxWidgets event
6929 system and have them still be there when the event handler is invoked.
6934 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6935 __repr__
= _swig_repr
6936 def __init__(self
, *args
, **kwargs
):
6937 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6938 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6941 __swig_destroy__
= _core_
.delete_PyCommandEvent
6942 __del__
= lambda self
: None;
6943 def _SetSelf(*args
, **kwargs
):
6944 """_SetSelf(self, PyObject self)"""
6945 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6947 def _GetSelf(*args
, **kwargs
):
6948 """_GetSelf(self) -> PyObject"""
6949 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6951 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6953 class DateEvent(CommandEvent
):
6955 This event class holds information about a date change event and is
6956 used together with `wx.DatePickerCtrl`. It also serves as a base class
6957 for `wx.calendar.CalendarEvent`. Bind these event types with
6960 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6961 __repr__
= _swig_repr
6962 def __init__(self
, *args
, **kwargs
):
6963 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6964 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6965 def GetDate(*args
, **kwargs
):
6967 GetDate(self) -> DateTime
6971 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6973 def SetDate(*args
, **kwargs
):
6975 SetDate(self, DateTime date)
6977 Sets the date carried by the event, normally only used by the library
6980 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6982 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6983 _core_
.DateEvent_swigregister(DateEvent
)
6985 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6986 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6988 #---------------------------------------------------------------------------
6990 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6991 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6992 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6993 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6994 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6995 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6996 class PyApp(EvtHandler
):
6998 The ``wx.PyApp`` class is an *implementation detail*, please use the
6999 `wx.App` class (or some other derived class) instead.
7001 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7002 __repr__
= _swig_repr
7003 def __init__(self
, *args
, **kwargs
):
7005 __init__(self) -> PyApp
7007 Create a new application object, starting the bootstrap process.
7009 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
7010 self
._setOORInfo
(self
, False);PyApp
._setCallbackInfo
(self
, self
, PyApp
)
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=False)"""
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, bool forceTrueColour=False)
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 # Until the new native control for wxMac is up to par, still use the generic one.
7744 wx
.SystemOptions
.SetOptionInt("mac.listctrl.always_use_generic", 1)
7746 # This finishes the initialization of wxWindows and then calls
7747 # the OnInit that should be present in the derived class
7748 self
._BootstrapApp
()
7751 def OnPreInit(self
):
7753 Things that must be done after _BootstrapApp has done its
7754 thing, but would be nice if they were already done by the time
7755 that OnInit is called.
7757 wx
.StockGDI
._initStockObjects
()
7760 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7761 self
.RestoreStdio() # Just in case the MainLoop was overridden
7765 self
.this
.own(False)
7766 wx
.PyApp
.Destroy(self
)
7768 def SetTopWindow(self
, frame
):
7769 """Set the \"main\" top level window"""
7771 self
.stdioWin
.SetParent(frame
)
7772 wx
.PyApp
.SetTopWindow(self
, frame
)
7776 """Execute the main GUI event loop"""
7777 wx
.PyApp
.MainLoop(self
)
7781 def RedirectStdio(self
, filename
=None):
7782 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7784 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7786 self
.stdioWin
= self
.outputWindowClass()
7787 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7790 def RestoreStdio(self
):
7792 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7797 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7799 Set the title, position and/or size of the output window if
7800 the stdio has been redirected. This should be called before
7801 any output would cause the output window to be created.
7804 if title
is not None:
7805 self
.stdioWin
.title
= title
7807 self
.stdioWin
.pos
= pos
7808 if size
is not None:
7809 self
.stdioWin
.size
= size
7814 # change from wx.PyApp_XX to wx.App_XX
7815 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7816 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7817 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7818 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7819 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7820 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7821 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7822 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7823 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7824 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7825 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7827 #----------------------------------------------------------------------------
7829 class PySimpleApp(wx
.App
):
7831 A simple application class. You can just create one of these and
7832 then then make your top level windows later, and not have to worry
7833 about OnInit. For example::
7835 app = wx.PySimpleApp()
7836 frame = wx.Frame(None, title='Hello World')
7843 def __init__(self
, redirect
=False, filename
=None,
7844 useBestVisual
=False, clearSigInt
=True):
7846 :see: `wx.App.__init__`
7848 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7855 # Is anybody using this one?
7856 class PyWidgetTester(wx
.App
):
7857 def __init__(self
, size
= (250, 100)):
7859 wx
.App
.__init
__(self
, 0)
7862 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7863 self
.SetTopWindow(self
.frame
)
7866 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7867 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7868 self
.frame
.Show(True)
7870 #----------------------------------------------------------------------------
7871 # DO NOT hold any other references to this object. This is how we
7872 # know when to cleanup system resources that wxWidgets is holding. When
7873 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7874 # goes to zero and it calls the wx.App_CleanUp function.
7876 class __wxPyCleanup
:
7878 self
.cleanup
= _core_
.App_CleanUp
7882 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7884 ## # another possible solution, but it gets called too early...
7886 ## atexit.register(_core_.wxApp_CleanUp)
7889 #----------------------------------------------------------------------------
7891 #---------------------------------------------------------------------------
7893 class EventLoop(object):
7894 """Proxy of C++ EventLoop class"""
7895 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7896 __repr__
= _swig_repr
7897 def __init__(self
, *args
, **kwargs
):
7898 """__init__(self) -> EventLoop"""
7899 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7900 __swig_destroy__
= _core_
.delete_EventLoop
7901 __del__
= lambda self
: None;
7902 def Run(*args
, **kwargs
):
7903 """Run(self) -> int"""
7904 return _core_
.EventLoop_Run(*args
, **kwargs
)
7906 def Exit(*args
, **kwargs
):
7907 """Exit(self, int rc=0)"""
7908 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7910 def Pending(*args
, **kwargs
):
7911 """Pending(self) -> bool"""
7912 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7914 def Dispatch(*args
, **kwargs
):
7915 """Dispatch(self) -> bool"""
7916 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7918 def IsRunning(*args
, **kwargs
):
7919 """IsRunning(self) -> bool"""
7920 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7922 def GetActive(*args
, **kwargs
):
7923 """GetActive() -> EventLoop"""
7924 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7926 GetActive
= staticmethod(GetActive
)
7927 def SetActive(*args
, **kwargs
):
7928 """SetActive(EventLoop loop)"""
7929 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7931 SetActive
= staticmethod(SetActive
)
7932 _core_
.EventLoop_swigregister(EventLoop
)
7934 def EventLoop_GetActive(*args
):
7935 """EventLoop_GetActive() -> EventLoop"""
7936 return _core_
.EventLoop_GetActive(*args
)
7938 def EventLoop_SetActive(*args
, **kwargs
):
7939 """EventLoop_SetActive(EventLoop loop)"""
7940 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7942 class EventLoopActivator(object):
7943 """Proxy of C++ EventLoopActivator class"""
7944 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7945 __repr__
= _swig_repr
7946 def __init__(self
, *args
, **kwargs
):
7947 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7948 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7949 __swig_destroy__
= _core_
.delete_EventLoopActivator
7950 __del__
= lambda self
: None;
7951 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7953 #---------------------------------------------------------------------------
7955 ACCEL_ALT
= _core_
.ACCEL_ALT
7956 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7957 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7958 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7959 ACCEL_CMD
= _core_
.ACCEL_CMD
7960 class AcceleratorEntry(object):
7962 A class used to define items in an `wx.AcceleratorTable`. wxPython
7963 programs can choose to use wx.AcceleratorEntry objects, but using a
7964 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7965 as well. See `__init__` for of the tuple values.
7967 :see: `wx.AcceleratorTable`
7969 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7970 __repr__
= _swig_repr
7971 def __init__(self
, *args
, **kwargs
):
7973 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7975 Construct a wx.AcceleratorEntry.
7977 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7978 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7979 __del__
= lambda self
: None;
7980 def Set(*args
, **kwargs
):
7982 Set(self, int flags, int keyCode, int cmd)
7984 (Re)set the attributes of a wx.AcceleratorEntry.
7987 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7989 def Create(*args
, **kwargs
):
7991 Create(String str) -> AcceleratorEntry
7993 Create accelerator corresponding to the specified string, or None if
7994 it coulnd't be parsed.
7996 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7998 Create
= staticmethod(Create
)
7999 def GetFlags(*args
, **kwargs
):
8001 GetFlags(self) -> int
8003 Get the AcceleratorEntry's flags.
8005 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
8007 def GetKeyCode(*args
, **kwargs
):
8009 GetKeyCode(self) -> int
8011 Get the AcceleratorEntry's keycode.
8013 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
8015 def GetCommand(*args
, **kwargs
):
8017 GetCommand(self) -> int
8019 Get the AcceleratorEntry's command ID.
8021 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
8023 def IsOk(*args
, **kwargs
):
8024 """IsOk(self) -> bool"""
8025 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
8027 def ToString(*args
, **kwargs
):
8029 ToString(self) -> String
8031 Returns a string representation for the this accelerator. The string
8032 is formatted using the <flags>-<keycode> format where <flags> maybe a
8033 hyphen-separed list of "shift|alt|ctrl"
8036 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
8038 def FromString(*args
, **kwargs
):
8040 FromString(self, String str) -> bool
8042 Returns true if the given string correctly initialized this object.
8044 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
8046 Command
= property(GetCommand
,doc
="See `GetCommand`")
8047 Flags
= property(GetFlags
,doc
="See `GetFlags`")
8048 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
8049 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
8051 def AcceleratorEntry_Create(*args
, **kwargs
):
8053 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8055 Create accelerator corresponding to the specified string, or None if
8056 it coulnd't be parsed.
8058 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
8060 class AcceleratorTable(Object
):
8062 An accelerator table allows the application to specify a table of
8063 keyboard shortcuts for menus or other commands. On Windows, menu or
8064 button commands are supported; on GTK, only menu commands are
8067 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8068 __repr__
= _swig_repr
8069 def __init__(self
, *args
, **kwargs
):
8071 __init__(entries) -> AcceleratorTable
8073 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8074 items or or of 3-tuples (flags, keyCode, cmdID)
8076 :see: `wx.AcceleratorEntry`
8078 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
8079 __swig_destroy__
= _core_
.delete_AcceleratorTable
8080 __del__
= lambda self
: None;
8081 def IsOk(*args
, **kwargs
):
8082 """IsOk(self) -> bool"""
8083 return _core_
.AcceleratorTable_IsOk(*args
, **kwargs
)
8086 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
8089 def GetAccelFromString(*args
, **kwargs
):
8090 """GetAccelFromString(String label) -> AcceleratorEntry"""
8091 return _core_
.GetAccelFromString(*args
, **kwargs
)
8092 #---------------------------------------------------------------------------
8094 class VisualAttributes(object):
8095 """struct containing all the visual attributes of a control"""
8096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8097 __repr__
= _swig_repr
8098 def __init__(self
, *args
, **kwargs
):
8100 __init__(self) -> VisualAttributes
8102 struct containing all the visual attributes of a control
8104 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
8105 __swig_destroy__
= _core_
.delete_VisualAttributes
8106 __del__
= lambda self
: None;
8107 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
8108 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
8109 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
8110 _core_
.VisualAttributes_swigregister(VisualAttributes
)
8111 NullAcceleratorTable
= cvar
.NullAcceleratorTable
8112 PanelNameStr
= cvar
.PanelNameStr
8114 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
8115 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
8116 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
8117 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
8118 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
8119 class Window(EvtHandler
):
8121 wx.Window is the base class for all windows and represents any visible
8122 object on the screen. All controls, top level windows and so on are
8123 wx.Windows. Sizers and device contexts are not however, as they don't
8124 appear on screen themselves.
8127 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
8128 __repr__
= _swig_repr
8129 def __init__(self
, *args
, **kwargs
):
8131 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8132 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8134 Construct and show a generic Window.
8136 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
8137 self
._setOORInfo
(self
)
8139 def Create(*args
, **kwargs
):
8141 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8144 Create the GUI part of the Window for 2-phase creation mode.
8146 return _core_
.Window_Create(*args
, **kwargs
)
8148 def Close(*args
, **kwargs
):
8150 Close(self, bool force=False) -> bool
8152 This function simply generates a EVT_CLOSE event whose handler usually
8153 tries to close the window. It doesn't close the window itself,
8154 however. If force is False (the default) then the window's close
8155 handler will be allowed to veto the destruction of the window.
8157 return _core_
.Window_Close(*args
, **kwargs
)
8159 def Destroy(*args
, **kwargs
):
8161 Destroy(self) -> bool
8163 Destroys the window safely. Frames and dialogs are not destroyed
8164 immediately when this function is called -- they are added to a list
8165 of windows to be deleted on idle time, when all the window's events
8166 have been processed. This prevents problems with events being sent to
8167 non-existent windows.
8169 Returns True if the window has either been successfully deleted, or it
8170 has been added to the list of windows pending real deletion.
8172 args
[0].this
.own(False)
8173 return _core_
.Window_Destroy(*args
, **kwargs
)
8175 def DestroyChildren(*args
, **kwargs
):
8177 DestroyChildren(self) -> bool
8179 Destroys all children of a window. Called automatically by the
8182 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
8184 def IsBeingDeleted(*args
, **kwargs
):
8186 IsBeingDeleted(self) -> bool
8188 Is the window in the process of being deleted?
8190 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
8192 def SetLabel(*args
, **kwargs
):
8194 SetLabel(self, String label)
8196 Set the text which the window shows in its label if applicable.
8198 return _core_
.Window_SetLabel(*args
, **kwargs
)
8200 def GetLabel(*args
, **kwargs
):
8202 GetLabel(self) -> String
8204 Generic way of getting a label from any window, for identification
8205 purposes. The interpretation of this function differs from class to
8206 class. For frames and dialogs, the value returned is the title. For
8207 buttons or static text controls, it is the button text. This function
8208 can be useful for meta-programs such as testing tools or special-needs
8209 access programs)which need to identify windows by name.
8211 return _core_
.Window_GetLabel(*args
, **kwargs
)
8213 def SetName(*args
, **kwargs
):
8215 SetName(self, String name)
8217 Sets the window's name. The window name is used for ressource setting
8218 in X, it is not the same as the window title/label
8220 return _core_
.Window_SetName(*args
, **kwargs
)
8222 def GetName(*args
, **kwargs
):
8224 GetName(self) -> String
8226 Returns the windows name. This name is not guaranteed to be unique;
8227 it is up to the programmer to supply an appropriate name in the window
8228 constructor or via wx.Window.SetName.
8230 return _core_
.Window_GetName(*args
, **kwargs
)
8232 def SetWindowVariant(*args
, **kwargs
):
8234 SetWindowVariant(self, int variant)
8236 Sets the variant of the window/font size to use for this window, if
8237 the platform supports variants, for example, wxMac.
8239 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
8241 def GetWindowVariant(*args
, **kwargs
):
8242 """GetWindowVariant(self) -> int"""
8243 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
8245 def SetId(*args
, **kwargs
):
8247 SetId(self, int winid)
8249 Sets the identifier of the window. Each window has an integer
8250 identifier. If the application has not provided one, an identifier
8251 will be generated. Normally, the identifier should be provided on
8252 creation and should not be modified subsequently.
8254 return _core_
.Window_SetId(*args
, **kwargs
)
8256 def GetId(*args
, **kwargs
):
8260 Returns the identifier of the window. Each window has an integer
8261 identifier. If the application has not provided one (or the default Id
8262 -1 is used) then an unique identifier with a negative value will be
8265 return _core_
.Window_GetId(*args
, **kwargs
)
8267 def NewControlId(*args
, **kwargs
):
8269 NewControlId() -> int
8271 Generate a control id for the controls which were not given one.
8273 return _core_
.Window_NewControlId(*args
, **kwargs
)
8275 NewControlId
= staticmethod(NewControlId
)
8276 def NextControlId(*args
, **kwargs
):
8278 NextControlId(int winid) -> int
8280 Get the id of the control following the one with the given
8283 return _core_
.Window_NextControlId(*args
, **kwargs
)
8285 NextControlId
= staticmethod(NextControlId
)
8286 def PrevControlId(*args
, **kwargs
):
8288 PrevControlId(int winid) -> int
8290 Get the id of the control preceding the one with the given
8293 return _core_
.Window_PrevControlId(*args
, **kwargs
)
8295 PrevControlId
= staticmethod(PrevControlId
)
8296 def GetLayoutDirection(*args
, **kwargs
):
8298 GetLayoutDirection(self) -> int
8300 Get the layout direction (LTR or RTL) for this window. Returns
8301 ``wx.Layout_Default`` if layout direction is not supported.
8303 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
8305 def SetLayoutDirection(*args
, **kwargs
):
8307 SetLayoutDirection(self, int dir)
8309 Set the layout direction (LTR or RTL) for this window.
8311 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
8313 def AdjustForLayoutDirection(*args
, **kwargs
):
8315 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8317 Mirror coordinates for RTL layout if this window uses it and if the
8318 mirroring is not done automatically like Win32.
8320 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
8322 def SetSize(*args
, **kwargs
):
8324 SetSize(self, Size size)
8326 Sets the size of the window in pixels.
8328 return _core_
.Window_SetSize(*args
, **kwargs
)
8330 def SetDimensions(*args
, **kwargs
):
8332 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8334 Sets the position and size of the window in pixels. The sizeFlags
8335 parameter indicates the interpretation of the other params if they are
8338 ======================== ======================================
8339 wx.SIZE_AUTO A -1 indicates that a class-specific
8340 default should be used.
8341 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8342 -1 values are supplied.
8343 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8344 interpreted as real dimensions, not
8346 ======================== ======================================
8349 return _core_
.Window_SetDimensions(*args
, **kwargs
)
8351 def SetRect(*args
, **kwargs
):
8353 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8355 Sets the position and size of the window in pixels using a wx.Rect.
8357 return _core_
.Window_SetRect(*args
, **kwargs
)
8359 def SetSizeWH(*args
, **kwargs
):
8361 SetSizeWH(self, int width, int height)
8363 Sets the size of the window in pixels.
8365 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8367 def Move(*args
, **kwargs
):
8369 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8371 Moves the window to the given position.
8373 return _core_
.Window_Move(*args
, **kwargs
)
8376 def MoveXY(*args
, **kwargs
):
8378 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8380 Moves the window to the given position.
8382 return _core_
.Window_MoveXY(*args
, **kwargs
)
8384 def SetInitialSize(*args
, **kwargs
):
8386 SetInitialSize(self, Size size=DefaultSize)
8388 A 'Smart' SetSize that will fill in default size components with the
8389 window's *best size* values. Also set's the minsize for use with sizers.
8391 return _core_
.Window_SetInitialSize(*args
, **kwargs
)
8393 SetBestFittingSize
= wx
._deprecated
(SetInitialSize
, 'Use `SetInitialSize`')
8394 def Raise(*args
, **kwargs
):
8398 Raises the window to the top of the window hierarchy. In current
8399 version of wxWidgets this works both for managed and child windows.
8401 return _core_
.Window_Raise(*args
, **kwargs
)
8403 def Lower(*args
, **kwargs
):
8407 Lowers the window to the bottom of the window hierarchy. In current
8408 version of wxWidgets this works both for managed and child windows.
8410 return _core_
.Window_Lower(*args
, **kwargs
)
8412 def SetClientSize(*args
, **kwargs
):
8414 SetClientSize(self, Size size)
8416 This sets the size of the window client area in pixels. Using this
8417 function to size a window tends to be more device-independent than
8418 wx.Window.SetSize, since the application need not worry about what
8419 dimensions the border or title bar have when trying to fit the window
8420 around panel items, for example.
8422 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8424 def SetClientSizeWH(*args
, **kwargs
):
8426 SetClientSizeWH(self, int width, int height)
8428 This sets the size of the window client area in pixels. Using this
8429 function to size a window tends to be more device-independent than
8430 wx.Window.SetSize, since the application need not worry about what
8431 dimensions the border or title bar have when trying to fit the window
8432 around panel items, for example.
8434 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8436 def SetClientRect(*args
, **kwargs
):
8438 SetClientRect(self, Rect rect)
8440 This sets the size of the window client area in pixels. Using this
8441 function to size a window tends to be more device-independent than
8442 wx.Window.SetSize, since the application need not worry about what
8443 dimensions the border or title bar have when trying to fit the window
8444 around panel items, for example.
8446 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8448 def GetPosition(*args
, **kwargs
):
8450 GetPosition(self) -> Point
8452 Get the window's position. Notice that the position is in client
8453 coordinates for child windows and screen coordinates for the top level
8454 ones, use `GetScreenPosition` if you need screen coordinates for all
8457 return _core_
.Window_GetPosition(*args
, **kwargs
)
8459 def GetPositionTuple(*args
, **kwargs
):
8461 GetPositionTuple() -> (x,y)
8463 Get the window's position. Notice that the position is in client
8464 coordinates for child windows and screen coordinates for the top level
8465 ones, use `GetScreenPosition` if you need screen coordinates for all
8468 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8470 def GetScreenPosition(*args
, **kwargs
):
8472 GetScreenPosition(self) -> Point
8474 Get the position of the window in screen coordinantes.
8476 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8478 def GetScreenPositionTuple(*args
, **kwargs
):
8480 GetScreenPositionTuple() -> (x,y)
8482 Get the position of the window in screen coordinantes.
8484 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8486 def GetScreenRect(*args
, **kwargs
):
8488 GetScreenRect(self) -> Rect
8490 Returns the size and position of the window in screen coordinantes as
8493 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8495 def GetSize(*args
, **kwargs
):
8497 GetSize(self) -> Size
8499 Get the window size.
8501 return _core_
.Window_GetSize(*args
, **kwargs
)
8503 def GetSizeTuple(*args
, **kwargs
):
8505 GetSizeTuple() -> (width, height)
8507 Get the window size.
8509 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8511 def GetRect(*args
, **kwargs
):
8513 GetRect(self) -> Rect
8515 Returns the size and position of the window as a `wx.Rect` object.
8517 return _core_
.Window_GetRect(*args
, **kwargs
)
8519 def GetClientSize(*args
, **kwargs
):
8521 GetClientSize(self) -> Size
8523 This gets the size of the window's 'client area' in pixels. The client
8524 area is the area which may be drawn on by the programmer, excluding
8525 title bar, border, scrollbars, etc.
8527 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8529 def GetClientSizeTuple(*args
, **kwargs
):
8531 GetClientSizeTuple() -> (width, height)
8533 This gets the size of the window's 'client area' in pixels. The client
8534 area is the area which may be drawn on by the programmer, excluding
8535 title bar, border, scrollbars, etc.
8537 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8539 def GetClientAreaOrigin(*args
, **kwargs
):
8541 GetClientAreaOrigin(self) -> Point
8543 Get the origin of the client area of the window relative to the
8544 window's top left corner (the client area may be shifted because of
8545 the borders, scrollbars, other decorations...)
8547 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8549 def GetClientRect(*args
, **kwargs
):
8551 GetClientRect(self) -> Rect
8553 Get the client area position and size as a `wx.Rect` object.
8555 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8557 def GetBestSize(*args
, **kwargs
):
8559 GetBestSize(self) -> Size
8561 This function returns the best acceptable minimal size for the
8562 window, if applicable. For example, for a static text control, it will
8563 be the minimal size such that the control label is not truncated. For
8564 windows containing subwindows (suzh aswx.Panel), the size returned by
8565 this function will be the same as the size the window would have had
8568 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8570 def GetBestSizeTuple(*args
, **kwargs
):
8572 GetBestSizeTuple() -> (width, height)
8574 This function returns the best acceptable minimal size for the
8575 window, if applicable. For example, for a static text control, it will
8576 be the minimal size such that the control label is not truncated. For
8577 windows containing subwindows (suzh aswx.Panel), the size returned by
8578 this function will be the same as the size the window would have had
8581 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8583 def InvalidateBestSize(*args
, **kwargs
):
8585 InvalidateBestSize(self)
8587 Reset the cached best size value so it will be recalculated the next
8590 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8592 def CacheBestSize(*args
, **kwargs
):
8594 CacheBestSize(self, Size size)
8596 Cache the best size so it doesn't need to be calculated again, (at least until
8597 some properties of the window change.)
8599 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8601 def GetEffectiveMinSize(*args
, **kwargs
):
8603 GetEffectiveMinSize(self) -> Size
8605 This function will merge the window's best size into the window's
8606 minimum size, giving priority to the min size components, and returns
8610 return _core_
.Window_GetEffectiveMinSize(*args
, **kwargs
)
8612 GetBestFittingSize
= wx
._deprecated
(GetEffectiveMinSize
, 'Use `GetEffectiveMinSize` instead.')
8613 def GetAdjustedBestSize(self
):
8614 s
= self
.GetBestSize()
8615 return wx
.Size(max(s
.width
, self
.GetMinWidth()),
8616 max(s
.height
, self
.GetMinHeight()))
8617 GetAdjustedBestSize
= wx
._deprecated
(GetAdjustedBestSize
, 'Use `GetEffectiveMinSize` instead.')
8619 def Center(*args
, **kwargs
):
8621 Center(self, int direction=BOTH)
8623 Centers the window. The parameter specifies the direction for
8624 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8625 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8626 on the entire screen and not on its parent window. If it is a
8627 top-level window and has no parent then it will always be centered
8628 relative to the screen.
8630 return _core_
.Window_Center(*args
, **kwargs
)
8633 def CenterOnParent(*args
, **kwargs
):
8635 CenterOnParent(self, int dir=BOTH)
8637 Center with respect to the the parent window
8639 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8641 CentreOnParent
= CenterOnParent
8642 def Fit(*args
, **kwargs
):
8646 Sizes the window so that it fits around its subwindows. This function
8647 won't do anything if there are no subwindows and will only really work
8648 correctly if sizers are used for the subwindows layout. Also, if the
8649 window has exactly one subwindow it is better (faster and the result
8650 is more precise as Fit adds some margin to account for fuzziness of
8651 its calculations) to call window.SetClientSize(child.GetSize())
8652 instead of calling Fit.
8654 return _core_
.Window_Fit(*args
, **kwargs
)
8656 def FitInside(*args
, **kwargs
):
8660 Similar to Fit, but sizes the interior (virtual) size of a
8661 window. Mainly useful with scrolled windows to reset scrollbars after
8662 sizing changes that do not trigger a size event, and/or scrolled
8663 windows without an interior sizer. This function similarly won't do
8664 anything if there are no subwindows.
8666 return _core_
.Window_FitInside(*args
, **kwargs
)
8668 def SetSizeHints(*args
, **kwargs
):
8670 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8673 Allows specification of minimum and maximum window sizes, and window
8674 size increments. If a pair of values is not set (or set to -1), the
8675 default values will be used. If this function is called, the user
8676 will not be able to size the window outside the given bounds (if it is
8677 a top-level window.) Sizers will also inspect the minimum window size
8678 and will use that value if set when calculating layout.
8680 The resizing increments are only significant under Motif or Xt.
8682 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8684 def SetSizeHintsSz(*args
, **kwargs
):
8686 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8688 Allows specification of minimum and maximum window sizes, and window
8689 size increments. If a pair of values is not set (or set to -1), the
8690 default values will be used. If this function is called, the user
8691 will not be able to size the window outside the given bounds (if it is
8692 a top-level window.) Sizers will also inspect the minimum window size
8693 and will use that value if set when calculating layout.
8695 The resizing increments are only significant under Motif or Xt.
8697 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8699 def SetVirtualSizeHints(*args
, **kwargs
):
8701 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8703 Allows specification of minimum and maximum virtual window sizes. If a
8704 pair of values is not set (or set to -1), the default values will be
8705 used. If this function is called, the user will not be able to size
8706 the virtual area of the window outside the given bounds.
8708 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8710 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8712 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8714 Allows specification of minimum and maximum virtual window sizes. If a
8715 pair of values is not set (or set to -1), the default values will be
8716 used. If this function is called, the user will not be able to size
8717 the virtual area of the window outside the given bounds.
8719 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8721 def GetMaxSize(*args
, **kwargs
):
8722 """GetMaxSize(self) -> Size"""
8723 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8725 def GetMinSize(*args
, **kwargs
):
8726 """GetMinSize(self) -> Size"""
8727 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8729 def SetMinSize(*args
, **kwargs
):
8731 SetMinSize(self, Size minSize)
8733 A more convenient method than `SetSizeHints` for setting just the
8736 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8738 def SetMaxSize(*args
, **kwargs
):
8740 SetMaxSize(self, Size maxSize)
8742 A more convenient method than `SetSizeHints` for setting just the
8745 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8747 def GetMinWidth(*args
, **kwargs
):
8748 """GetMinWidth(self) -> int"""
8749 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8751 def GetMinHeight(*args
, **kwargs
):
8752 """GetMinHeight(self) -> int"""
8753 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8755 def GetMaxWidth(*args
, **kwargs
):
8756 """GetMaxWidth(self) -> int"""
8757 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8759 def GetMaxHeight(*args
, **kwargs
):
8760 """GetMaxHeight(self) -> int"""
8761 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8763 def SetVirtualSize(*args
, **kwargs
):
8765 SetVirtualSize(self, Size size)
8767 Set the the virtual size of a window in pixels. For most windows this
8768 is just the client area of the window, but for some like scrolled
8769 windows it is more or less independent of the screen window size.
8771 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8773 def SetVirtualSizeWH(*args
, **kwargs
):
8775 SetVirtualSizeWH(self, int w, int h)
8777 Set the the virtual size of a window in pixels. For most windows this
8778 is just the client area of the window, but for some like scrolled
8779 windows it is more or less independent of the screen window size.
8781 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8783 def GetVirtualSize(*args
, **kwargs
):
8785 GetVirtualSize(self) -> Size
8787 Get the the virtual size of the window in pixels. For most windows
8788 this is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
8791 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8793 def GetVirtualSizeTuple(*args
, **kwargs
):
8795 GetVirtualSizeTuple() -> (width, height)
8797 Get the the virtual size of the window in pixels. For most windows
8798 this is just the client area of the window, but for some like scrolled
8799 windows it is more or less independent of the screen window size.
8801 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8803 def GetWindowBorderSize(*args
, **kwargs
):
8805 GetWindowBorderSize(self) -> Size
8807 Return the size of the left/right and top/bottom borders.
8809 return _core_
.Window_GetWindowBorderSize(*args
, **kwargs
)
8811 def GetBestVirtualSize(*args
, **kwargs
):
8813 GetBestVirtualSize(self) -> Size
8815 Return the largest of ClientSize and BestSize (as determined by a
8816 sizer, interior children, or other means)
8818 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8820 def Show(*args
, **kwargs
):
8822 Show(self, bool show=True) -> bool
8824 Shows or hides the window. You may need to call Raise for a top level
8825 window if you want to bring it to top, although this is not needed if
8826 Show is called immediately after the frame creation. Returns True if
8827 the window has been shown or hidden or False if nothing was done
8828 because it already was in the requested state.
8830 return _core_
.Window_Show(*args
, **kwargs
)
8832 def Hide(*args
, **kwargs
):
8836 Equivalent to calling Show(False).
8838 return _core_
.Window_Hide(*args
, **kwargs
)
8840 def Enable(*args
, **kwargs
):
8842 Enable(self, bool enable=True) -> bool
8844 Enable or disable the window for user input. Note that when a parent
8845 window is disabled, all of its children are disabled as well and they
8846 are reenabled again when the parent is. Returns true if the window
8847 has been enabled or disabled, false if nothing was done, i.e. if the
8848 window had already been in the specified state.
8850 return _core_
.Window_Enable(*args
, **kwargs
)
8852 def Disable(*args
, **kwargs
):
8854 Disable(self) -> bool
8856 Disables the window, same as Enable(false).
8858 return _core_
.Window_Disable(*args
, **kwargs
)
8860 def IsShown(*args
, **kwargs
):
8862 IsShown(self) -> bool
8864 Returns true if the window is shown, false if it has been hidden.
8866 return _core_
.Window_IsShown(*args
, **kwargs
)
8868 def IsEnabled(*args
, **kwargs
):
8870 IsEnabled(self) -> bool
8872 Returns true if the window is enabled for input, false otherwise.
8874 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8876 def IsShownOnScreen(*args
, **kwargs
):
8878 IsShownOnScreen(self) -> bool
8880 Returns ``True`` if the window is physically visible on the screen,
8881 i.e. it is shown and all its parents up to the toplevel window are
8884 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8886 def SetWindowStyleFlag(*args
, **kwargs
):
8888 SetWindowStyleFlag(self, long style)
8890 Sets the style of the window. Please note that some styles cannot be
8891 changed after the window creation and that Refresh() might need to be
8892 called after changing the others for the change to take place
8895 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8897 def GetWindowStyleFlag(*args
, **kwargs
):
8899 GetWindowStyleFlag(self) -> long
8901 Gets the window style that was passed to the constructor or Create
8904 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8906 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8907 def HasFlag(*args
, **kwargs
):
8909 HasFlag(self, int flag) -> bool
8911 Test if the given style is set for this window.
8913 return _core_
.Window_HasFlag(*args
, **kwargs
)
8915 def IsRetained(*args
, **kwargs
):
8917 IsRetained(self) -> bool
8919 Returns true if the window is retained, false otherwise. Retained
8920 windows are only available on X platforms.
8922 return _core_
.Window_IsRetained(*args
, **kwargs
)
8924 def ToggleWindowStyle(*args
, **kwargs
):
8926 ToggleWindowStyle(self, int flag) -> bool
8928 Turn the flag on if it had been turned off before and vice versa,
8929 returns True if the flag is turned on by this function call.
8931 return _core_
.Window_ToggleWindowStyle(*args
, **kwargs
)
8933 def SetExtraStyle(*args
, **kwargs
):
8935 SetExtraStyle(self, long exStyle)
8937 Sets the extra style bits for the window. Extra styles are the less
8938 often used style bits which can't be set with the constructor or with
8939 SetWindowStyleFlag()
8941 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8943 def GetExtraStyle(*args
, **kwargs
):
8945 GetExtraStyle(self) -> long
8947 Returns the extra style bits for the window.
8949 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8951 def MakeModal(*args
, **kwargs
):
8953 MakeModal(self, bool modal=True)
8955 Disables all other windows in the application so that the user can
8956 only interact with this window. Passing False will reverse this
8959 return _core_
.Window_MakeModal(*args
, **kwargs
)
8961 def SetThemeEnabled(*args
, **kwargs
):
8963 SetThemeEnabled(self, bool enableTheme)
8965 This function tells a window if it should use the system's "theme"
8966 code to draw the windows' background instead if its own background
8967 drawing code. This will only have an effect on platforms that support
8968 the notion of themes in user defined windows. One such platform is
8969 GTK+ where windows can have (very colourful) backgrounds defined by a
8970 user's selected theme.
8972 Dialogs, notebook pages and the status bar have this flag set to true
8973 by default so that the default look and feel is simulated best.
8975 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8977 def GetThemeEnabled(*args
, **kwargs
):
8979 GetThemeEnabled(self) -> bool
8981 Return the themeEnabled flag.
8983 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8985 def SetFocus(*args
, **kwargs
):
8989 Set's the focus to this window, allowing it to receive keyboard input.
8991 return _core_
.Window_SetFocus(*args
, **kwargs
)
8993 def SetFocusFromKbd(*args
, **kwargs
):
8995 SetFocusFromKbd(self)
8997 Set focus to this window as the result of a keyboard action. Normally
8998 only called internally.
9000 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
9002 def FindFocus(*args
, **kwargs
):
9004 FindFocus() -> Window
9006 Returns the window or control that currently has the keyboard focus,
9009 return _core_
.Window_FindFocus(*args
, **kwargs
)
9011 FindFocus
= staticmethod(FindFocus
)
9012 def AcceptsFocus(*args
, **kwargs
):
9014 AcceptsFocus(self) -> bool
9016 Can this window have focus?
9018 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
9020 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
9022 AcceptsFocusFromKeyboard(self) -> bool
9024 Can this window be given focus by keyboard navigation? if not, the
9025 only way to give it focus (provided it accepts it at all) is to click
9028 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
9030 def Navigate(*args
, **kwargs
):
9032 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9034 Does keyboard navigation from this window to another, by sending a
9035 `wx.NavigationKeyEvent`.
9037 return _core_
.Window_Navigate(*args
, **kwargs
)
9039 def MoveAfterInTabOrder(*args
, **kwargs
):
9041 MoveAfterInTabOrder(self, Window win)
9043 Moves this window in the tab navigation order after the specified
9044 sibling window. This means that when the user presses the TAB key on
9045 that other window, the focus switches to this window.
9047 The default tab order is the same as creation order. This function
9048 and `MoveBeforeInTabOrder` allow to change it after creating all the
9052 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
9054 def MoveBeforeInTabOrder(*args
, **kwargs
):
9056 MoveBeforeInTabOrder(self, Window win)
9058 Same as `MoveAfterInTabOrder` except that it inserts this window just
9059 before win instead of putting it right after it.
9061 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
9063 def GetChildren(*args
, **kwargs
):
9065 GetChildren(self) -> PyObject
9067 Returns a list of the window's children. NOTE: Currently this is a
9068 copy of the child window list maintained by the window, so the return
9069 value of this function is only valid as long as the window's children
9072 return _core_
.Window_GetChildren(*args
, **kwargs
)
9074 def GetParent(*args
, **kwargs
):
9076 GetParent(self) -> Window
9078 Returns the parent window of this window, or None if there isn't one.
9080 return _core_
.Window_GetParent(*args
, **kwargs
)
9082 def GetGrandParent(*args
, **kwargs
):
9084 GetGrandParent(self) -> Window
9086 Returns the parent of the parent of this window, or None if there
9089 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
9091 def IsTopLevel(*args
, **kwargs
):
9093 IsTopLevel(self) -> bool
9095 Returns true if the given window is a top-level one. Currently all
9096 frames and dialogs are always considered to be top-level windows (even
9097 if they have a parent window).
9099 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
9101 def Reparent(*args
, **kwargs
):
9103 Reparent(self, Window newParent) -> bool
9105 Reparents the window, i.e the window will be removed from its current
9106 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9107 re-inserted into another. Available on Windows and GTK. Returns True
9108 if the parent was changed, False otherwise (error or newParent ==
9111 return _core_
.Window_Reparent(*args
, **kwargs
)
9113 def AddChild(*args
, **kwargs
):
9115 AddChild(self, Window child)
9117 Adds a child window. This is called automatically by window creation
9118 functions so should not be required by the application programmer.
9120 return _core_
.Window_AddChild(*args
, **kwargs
)
9122 def RemoveChild(*args
, **kwargs
):
9124 RemoveChild(self, Window child)
9126 Removes a child window. This is called automatically by window
9127 deletion functions so should not be required by the application
9130 return _core_
.Window_RemoveChild(*args
, **kwargs
)
9132 def SetDoubleBuffered(*args
, **kwargs
):
9134 SetDoubleBuffered(self, bool on)
9136 Currently wxGTK2 only.
9138 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
9140 def FindWindowById(*args
, **kwargs
):
9142 FindWindowById(self, long winid) -> Window
9144 Find a chld of this window by window ID
9146 return _core_
.Window_FindWindowById(*args
, **kwargs
)
9148 def FindWindowByName(*args
, **kwargs
):
9150 FindWindowByName(self, String name) -> Window
9152 Find a child of this window by name
9154 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
9156 def GetEventHandler(*args
, **kwargs
):
9158 GetEventHandler(self) -> EvtHandler
9160 Returns the event handler for this window. By default, the window is
9161 its own event handler.
9163 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
9165 def SetEventHandler(*args
, **kwargs
):
9167 SetEventHandler(self, EvtHandler handler)
9169 Sets the event handler for this window. An event handler is an object
9170 that is capable of processing the events sent to a window. (In other
9171 words, is able to dispatch the events to handler function.) By
9172 default, the window is its own event handler, but an application may
9173 wish to substitute another, for example to allow central
9174 implementation of event-handling for a variety of different window
9177 It is usually better to use `wx.Window.PushEventHandler` since this sets
9178 up a chain of event handlers, where an event not handled by one event
9179 handler is handed off to the next one in the chain.
9181 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
9183 def PushEventHandler(*args
, **kwargs
):
9185 PushEventHandler(self, EvtHandler handler)
9187 Pushes this event handler onto the event handler stack for the window.
9188 An event handler is an object that is capable of processing the events
9189 sent to a window. (In other words, is able to dispatch the events to
9190 handler function.) By default, the window is its own event handler,
9191 but an application may wish to substitute another, for example to
9192 allow central implementation of event-handling for a variety of
9193 different window classes.
9195 wx.Window.PushEventHandler allows an application to set up a chain of
9196 event handlers, where an event not handled by one event handler is
9197 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9198 to remove the event handler. Ownership of the handler is *not* given
9199 to the window, so you should be sure to pop the handler before the
9200 window is destroyed and either let PopEventHandler destroy it, or call
9201 its Destroy method yourself.
9203 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
9205 def PopEventHandler(*args
, **kwargs
):
9207 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9209 Removes and returns the top-most event handler on the event handler
9210 stack. If deleteHandler is True then the wx.EvtHandler object will be
9211 destroyed after it is popped, and ``None`` will be returned instead.
9213 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
9215 def RemoveEventHandler(*args
, **kwargs
):
9217 RemoveEventHandler(self, EvtHandler handler) -> bool
9219 Find the given handler in the event handler chain and remove (but not
9220 delete) it from the event handler chain, returns True if it was found
9221 and False otherwise (this also results in an assert failure so this
9222 function should only be called when the handler is supposed to be
9225 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
9227 def SetValidator(*args
, **kwargs
):
9229 SetValidator(self, Validator validator)
9231 Deletes the current validator (if any) and sets the window validator,
9232 having called wx.Validator.Clone to create a new validator of this
9235 return _core_
.Window_SetValidator(*args
, **kwargs
)
9237 def GetValidator(*args
, **kwargs
):
9239 GetValidator(self) -> Validator
9241 Returns a pointer to the current validator for the window, or None if
9244 return _core_
.Window_GetValidator(*args
, **kwargs
)
9246 def Validate(*args
, **kwargs
):
9248 Validate(self) -> bool
9250 Validates the current values of the child controls using their
9251 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9252 style flag set, the method will also call Validate() of all child
9253 windows. Returns false if any of the validations failed.
9255 return _core_
.Window_Validate(*args
, **kwargs
)
9257 def TransferDataToWindow(*args
, **kwargs
):
9259 TransferDataToWindow(self) -> bool
9261 Transfers values to child controls from data areas specified by their
9262 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9263 style flag set, the method will also call TransferDataToWindow() of
9266 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
9268 def TransferDataFromWindow(*args
, **kwargs
):
9270 TransferDataFromWindow(self) -> bool
9272 Transfers values from child controls to data areas specified by their
9273 validators. Returns false if a transfer failed. If the window has
9274 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9275 also call TransferDataFromWindow() of all child windows.
9277 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
9279 def InitDialog(*args
, **kwargs
):
9283 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9284 to the dialog via validators.
9286 return _core_
.Window_InitDialog(*args
, **kwargs
)
9288 def SetAcceleratorTable(*args
, **kwargs
):
9290 SetAcceleratorTable(self, AcceleratorTable accel)
9292 Sets the accelerator table for this window.
9294 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
9296 def GetAcceleratorTable(*args
, **kwargs
):
9298 GetAcceleratorTable(self) -> AcceleratorTable
9300 Gets the accelerator table for this window.
9302 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
9304 def RegisterHotKey(*args
, **kwargs
):
9306 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9308 Registers a system wide hotkey. Every time the user presses the hotkey
9309 registered here, this window will receive a hotkey event. It will
9310 receive the event even if the application is in the background and
9311 does not have the input focus because the user is working with some
9312 other application. To bind an event handler function to this hotkey
9313 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9314 hotkey was registered successfully.
9316 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
9318 def UnregisterHotKey(*args
, **kwargs
):
9320 UnregisterHotKey(self, int hotkeyId) -> bool
9322 Unregisters a system wide hotkey.
9324 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
9326 def ConvertDialogPointToPixels(*args
, **kwargs
):
9328 ConvertDialogPointToPixels(self, Point pt) -> Point
9330 Converts a point or size from dialog units to pixels. Dialog units
9331 are used for maintaining a dialog's proportions even if the font
9332 changes. For the x dimension, the dialog units are multiplied by the
9333 average character width and then divided by 4. For the y dimension,
9334 the dialog units are multiplied by the average character height and
9337 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
9339 def ConvertDialogSizeToPixels(*args
, **kwargs
):
9341 ConvertDialogSizeToPixels(self, Size sz) -> Size
9343 Converts a point or size from dialog units to pixels. Dialog units
9344 are used for maintaining a dialog's proportions even if the font
9345 changes. For the x dimension, the dialog units are multiplied by the
9346 average character width and then divided by 4. For the y dimension,
9347 the dialog units are multiplied by the average character height and
9350 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
9352 def DLG_PNT(*args
, **kwargs
):
9354 DLG_PNT(self, Point pt) -> Point
9356 Converts a point or size from dialog units to pixels. Dialog units
9357 are used for maintaining a dialog's proportions even if the font
9358 changes. For the x dimension, the dialog units are multiplied by the
9359 average character width and then divided by 4. For the y dimension,
9360 the dialog units are multiplied by the average character height and
9363 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9365 def DLG_SZE(*args
, **kwargs
):
9367 DLG_SZE(self, Size sz) -> Size
9369 Converts a point or size from dialog units to pixels. Dialog units
9370 are used for maintaining a dialog's proportions even if the font
9371 changes. For the x dimension, the dialog units are multiplied by the
9372 average character width and then divided by 4. For the y dimension,
9373 the dialog units are multiplied by the average character height and
9376 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9378 def ConvertPixelPointToDialog(*args
, **kwargs
):
9379 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9380 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9382 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9383 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9384 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9386 def WarpPointer(*args
, **kwargs
):
9388 WarpPointer(self, int x, int y)
9390 Moves the pointer to the given position on the window.
9392 NOTE: This function is not supported under Mac because Apple Human
9393 Interface Guidelines forbid moving the mouse cursor programmatically.
9395 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9397 def CaptureMouse(*args
, **kwargs
):
9401 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9402 release the capture.
9404 Note that wxWindows maintains the stack of windows having captured the
9405 mouse and when the mouse is released the capture returns to the window
9406 which had had captured it previously and it is only really released if
9407 there were no previous window. In particular, this means that you must
9408 release the mouse as many times as you capture it, unless the window
9409 receives the `wx.MouseCaptureLostEvent` event.
9411 Any application which captures the mouse in the beginning of some
9412 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9413 operation when it receives the event. The event handler must not
9416 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9418 def ReleaseMouse(*args
, **kwargs
):
9422 Releases mouse input captured with wx.Window.CaptureMouse.
9424 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9426 def GetCapture(*args
, **kwargs
):
9428 GetCapture() -> Window
9430 Returns the window which currently captures the mouse or None
9432 return _core_
.Window_GetCapture(*args
, **kwargs
)
9434 GetCapture
= staticmethod(GetCapture
)
9435 def HasCapture(*args
, **kwargs
):
9437 HasCapture(self) -> bool
9439 Returns true if this window has the current mouse capture.
9441 return _core_
.Window_HasCapture(*args
, **kwargs
)
9443 def Refresh(*args
, **kwargs
):
9445 Refresh(self, bool eraseBackground=True, Rect rect=None)
9447 Mark the specified rectangle (or the whole window) as "dirty" so it
9448 will be repainted. Causes an EVT_PAINT event to be generated and sent
9451 return _core_
.Window_Refresh(*args
, **kwargs
)
9453 def RefreshRect(*args
, **kwargs
):
9455 RefreshRect(self, Rect rect, bool eraseBackground=True)
9457 Redraws the contents of the given rectangle: the area inside it will
9458 be repainted. This is the same as Refresh but has a nicer syntax.
9460 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9462 def Update(*args
, **kwargs
):
9466 Calling this method immediately repaints the invalidated area of the
9467 window instead of waiting for the EVT_PAINT event to happen, (normally
9468 this would usually only happen when the flow of control returns to the
9469 event loop.) Notice that this function doesn't refresh the window and
9470 does nothing if the window has been already repainted. Use `Refresh`
9471 first if you want to immediately redraw the window (or some portion of
9472 it) unconditionally.
9474 return _core_
.Window_Update(*args
, **kwargs
)
9476 def ClearBackground(*args
, **kwargs
):
9478 ClearBackground(self)
9480 Clears the window by filling it with the current background
9481 colour. Does not cause an erase background event to be generated.
9483 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9485 def Freeze(*args
, **kwargs
):
9489 Freezes the window or, in other words, prevents any updates from
9490 taking place on screen, the window is not redrawn at all. Thaw must be
9491 called to reenable window redrawing. Calls to Freeze/Thaw may be
9492 nested, with the actual Thaw being delayed until all the nesting has
9495 This method is useful for visual appearance optimization (for example,
9496 it is a good idea to use it before inserting large amount of text into
9497 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9498 for all controls so it is mostly just a hint to wxWindows and not a
9499 mandatory directive.
9501 return _core_
.Window_Freeze(*args
, **kwargs
)
9503 def IsFrozen(*args
, **kwargs
):
9505 IsFrozen(self) -> bool
9507 Returns ``True`` if the window has been frozen and not thawed yet.
9509 :see: `Freeze` and `Thaw`
9511 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9513 def Thaw(*args
, **kwargs
):
9517 Reenables window updating after a previous call to Freeze. Calls to
9518 Freeze/Thaw may be nested, so Thaw must be called the same number of
9519 times that Freeze was before the window will be updated.
9521 return _core_
.Window_Thaw(*args
, **kwargs
)
9523 def PrepareDC(*args
, **kwargs
):
9525 PrepareDC(self, DC dc)
9527 Call this function to prepare the device context for drawing a
9528 scrolled image. It sets the device origin according to the current
9531 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9533 def IsDoubleBuffered(*args
, **kwargs
):
9535 IsDoubleBuffered(self) -> bool
9537 Returns ``True`` if the window contents is double-buffered by the
9538 system, i.e. if any drawing done on the window is really done on a
9539 temporary backing surface and transferred to the screen all at once
9542 return _core_
.Window_IsDoubleBuffered(*args
, **kwargs
)
9544 def GetUpdateRegion(*args
, **kwargs
):
9546 GetUpdateRegion(self) -> Region
9548 Returns the region specifying which parts of the window have been
9549 damaged. Should only be called within an EVT_PAINT handler.
9551 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9553 def GetUpdateClientRect(*args
, **kwargs
):
9555 GetUpdateClientRect(self) -> Rect
9557 Get the update rectangle region bounding box in client coords.
9559 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9561 def IsExposed(*args
, **kwargs
):
9563 IsExposed(self, int x, int y, int w=1, int h=1) -> 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_IsExposed(*args
, **kwargs
)
9572 def IsExposedPoint(*args
, **kwargs
):
9574 IsExposedPoint(self, Point pt) -> bool
9576 Returns true if the given point or rectangle area has been exposed
9577 since the last repaint. Call this in an paint event handler to
9578 optimize redrawing by only redrawing those areas, which have been
9581 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9583 def IsExposedRect(*args
, **kwargs
):
9585 IsExposedRect(self, Rect rect) -> bool
9587 Returns true if the given point or rectangle area has been exposed
9588 since the last repaint. Call this in an paint event handler to
9589 optimize redrawing by only redrawing those areas, which have been
9592 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9594 def GetDefaultAttributes(*args
, **kwargs
):
9596 GetDefaultAttributes(self) -> VisualAttributes
9598 Get the default attributes for an instance of this class. This is
9599 useful if you want to use the same font or colour in your own control
9600 as in a standard control -- which is a much better idea than hard
9601 coding specific colours or fonts which might look completely out of
9602 place on the user's system, especially if it uses themes.
9604 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9606 def GetClassDefaultAttributes(*args
, **kwargs
):
9608 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9610 Get the default attributes for this class. This is useful if you want
9611 to use the same font or colour in your own control as in a standard
9612 control -- which is a much better idea than hard coding specific
9613 colours or fonts which might look completely out of place on the
9614 user's system, especially if it uses themes.
9616 The variant parameter is only relevant under Mac currently and is
9617 ignore under other platforms. Under Mac, it will change the size of
9618 the returned font. See `wx.Window.SetWindowVariant` for more about
9621 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9623 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9624 def SetBackgroundColour(*args
, **kwargs
):
9626 SetBackgroundColour(self, Colour colour) -> bool
9628 Sets the background colour of the window. Returns True if the colour
9629 was changed. The background colour is usually painted by the default
9630 EVT_ERASE_BACKGROUND event handler function under Windows and
9631 automatically under GTK. Using `wx.NullColour` will reset the window
9632 to the default background colour.
9634 Note that setting the background colour may not cause an immediate
9635 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9636 calling this function.
9638 Using this function will disable attempts to use themes for this
9639 window, if the system supports them. Use with care since usually the
9640 themes represent the appearance chosen by the user to be used for all
9641 applications on the system.
9643 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9645 def SetOwnBackgroundColour(*args
, **kwargs
):
9646 """SetOwnBackgroundColour(self, Colour colour)"""
9647 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9649 def SetForegroundColour(*args
, **kwargs
):
9651 SetForegroundColour(self, Colour colour) -> bool
9653 Sets the foreground colour of the window. Returns True is the colour
9654 was changed. The interpretation of foreground colour is dependent on
9655 the window class; it may be the text colour or other colour, or it may
9658 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9660 def SetOwnForegroundColour(*args
, **kwargs
):
9661 """SetOwnForegroundColour(self, Colour colour)"""
9662 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9664 def GetBackgroundColour(*args
, **kwargs
):
9666 GetBackgroundColour(self) -> Colour
9668 Returns the background colour of the window.
9670 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9672 def GetForegroundColour(*args
, **kwargs
):
9674 GetForegroundColour(self) -> Colour
9676 Returns the foreground colour of the window. The interpretation of
9677 foreground colour is dependent on the window class; it may be the text
9678 colour or other colour, or it may not be used at all.
9680 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9682 def InheritsBackgroundColour(*args
, **kwargs
):
9683 """InheritsBackgroundColour(self) -> bool"""
9684 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9686 def UseBgCol(*args
, **kwargs
):
9687 """UseBgCol(self) -> bool"""
9688 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9690 def SetBackgroundStyle(*args
, **kwargs
):
9692 SetBackgroundStyle(self, int style) -> bool
9694 Returns the background style of the window. The background style
9695 indicates how the background of the window is drawn.
9697 ====================== ========================================
9698 wx.BG_STYLE_SYSTEM The background colour or pattern should
9699 be determined by the system
9700 wx.BG_STYLE_COLOUR The background should be a solid colour
9701 wx.BG_STYLE_CUSTOM The background will be implemented by the
9703 ====================== ========================================
9705 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9706 a custom background, such as a tiled bitmap. Currently the style has
9707 no effect on other platforms.
9709 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9711 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9713 def GetBackgroundStyle(*args
, **kwargs
):
9715 GetBackgroundStyle(self) -> int
9717 Returns the background style of the window.
9719 :see: `SetBackgroundStyle`
9721 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9723 def HasTransparentBackground(*args
, **kwargs
):
9725 HasTransparentBackground(self) -> bool
9727 Returns True if this window's background is transparent (as, for
9728 example, for `wx.StaticText`) and should show the parent window's
9731 This method is mostly used internally by the library itself and you
9732 normally shouldn't have to call it. You may, however, have to override
9733 it in your custom control classes to ensure that background is painted
9736 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9738 def SetCursor(*args
, **kwargs
):
9740 SetCursor(self, Cursor cursor) -> bool
9742 Sets the window's cursor. Notice that the window cursor also sets it
9743 for the children of the window implicitly.
9745 The cursor may be wx.NullCursor in which case the window cursor will
9746 be reset back to default.
9748 return _core_
.Window_SetCursor(*args
, **kwargs
)
9750 def GetCursor(*args
, **kwargs
):
9752 GetCursor(self) -> Cursor
9754 Return the cursor associated with this window.
9756 return _core_
.Window_GetCursor(*args
, **kwargs
)
9758 def SetFont(*args
, **kwargs
):
9760 SetFont(self, Font font) -> bool
9762 Sets the font for this window.
9764 return _core_
.Window_SetFont(*args
, **kwargs
)
9766 def SetOwnFont(*args
, **kwargs
):
9767 """SetOwnFont(self, Font font)"""
9768 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9770 def GetFont(*args
, **kwargs
):
9772 GetFont(self) -> Font
9774 Returns the default font used for this window.
9776 return _core_
.Window_GetFont(*args
, **kwargs
)
9778 def SetCaret(*args
, **kwargs
):
9780 SetCaret(self, Caret caret)
9782 Sets the caret associated with the window.
9784 return _core_
.Window_SetCaret(*args
, **kwargs
)
9786 def GetCaret(*args
, **kwargs
):
9788 GetCaret(self) -> Caret
9790 Returns the caret associated with the window.
9792 return _core_
.Window_GetCaret(*args
, **kwargs
)
9794 def GetCharHeight(*args
, **kwargs
):
9796 GetCharHeight(self) -> int
9798 Get the (average) character size for the current font.
9800 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9802 def GetCharWidth(*args
, **kwargs
):
9804 GetCharWidth(self) -> int
9806 Get the (average) character size for the current font.
9808 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9810 def GetTextExtent(*args
, **kwargs
):
9812 GetTextExtent(String string) -> (width, height)
9814 Get the width and height of the text using the current font.
9816 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9818 def GetFullTextExtent(*args
, **kwargs
):
9820 GetFullTextExtent(String string, Font font=None) ->
9821 (width, height, descent, externalLeading)
9823 Get the width, height, decent and leading of the text using the
9824 current or specified font.
9826 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9828 def ClientToScreenXY(*args
, **kwargs
):
9830 ClientToScreenXY(int x, int y) -> (x,y)
9832 Converts to screen coordinates from coordinates relative to this window.
9834 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9836 def ScreenToClientXY(*args
, **kwargs
):
9838 ScreenToClientXY(int x, int y) -> (x,y)
9840 Converts from screen to client window coordinates.
9842 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9844 def ClientToScreen(*args
, **kwargs
):
9846 ClientToScreen(self, Point pt) -> Point
9848 Converts to screen coordinates from coordinates relative to this window.
9850 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9852 def ScreenToClient(*args
, **kwargs
):
9854 ScreenToClient(self, Point pt) -> Point
9856 Converts from screen to client window coordinates.
9858 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9860 def HitTestXY(*args
, **kwargs
):
9862 HitTestXY(self, int x, int y) -> int
9864 Test where the given (in client coords) point lies
9866 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9868 def HitTest(*args
, **kwargs
):
9870 HitTest(self, Point pt) -> int
9872 Test where the given (in client coords) point lies
9874 return _core_
.Window_HitTest(*args
, **kwargs
)
9876 def GetBorder(*args
):
9878 GetBorder(self, long flags) -> int
9879 GetBorder(self) -> int
9881 Get border for the flags of this window
9883 return _core_
.Window_GetBorder(*args
)
9885 def UpdateWindowUI(*args
, **kwargs
):
9887 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9889 This function sends EVT_UPDATE_UI events to the window. The particular
9890 implementation depends on the window; for example a wx.ToolBar will
9891 send an update UI event for each toolbar button, and a wx.Frame will
9892 send an update UI event for each menubar menu item. You can call this
9893 function from your application to ensure that your UI is up-to-date at
9894 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9895 concerned). This may be necessary if you have called
9896 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9897 limit the overhead that wxWindows incurs by sending update UI events
9900 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9902 def PopupMenuXY(*args
, **kwargs
):
9904 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9906 Pops up the given menu at the specified coordinates, relative to this window,
9907 and returns control when the user has dismissed the menu. If a menu item is
9908 selected, the corresponding menu event is generated and will be processed as
9909 usual. If the default position is given then the current position of the
9910 mouse cursor will be used.
9912 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9914 def PopupMenu(*args
, **kwargs
):
9916 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9918 Pops up the given menu at the specified coordinates, relative to this window,
9919 and returns control when the user has dismissed the menu. If a menu item is
9920 selected, the corresponding menu event is generated and will be processed as
9921 usual. If the default position is given then the current position of the
9922 mouse cursor will be used.
9924 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9926 def HasMultiplePages(*args
, **kwargs
):
9927 """HasMultiplePages(self) -> bool"""
9928 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9930 def GetHandle(*args
, **kwargs
):
9932 GetHandle(self) -> long
9934 Returns the platform-specific handle (as a long integer) of the
9935 physical window. Currently on wxMac it returns the handle of the
9936 toplevel parent of the window.
9938 return _core_
.Window_GetHandle(*args
, **kwargs
)
9940 def AssociateHandle(*args
, **kwargs
):
9942 AssociateHandle(self, long handle)
9944 Associate the window with a new native handle
9946 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9948 def DissociateHandle(*args
, **kwargs
):
9950 DissociateHandle(self)
9952 Dissociate the current native handle from the window
9954 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9956 def HasScrollbar(*args
, **kwargs
):
9958 HasScrollbar(self, int orient) -> bool
9960 Does the window have the scrollbar for this orientation?
9962 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9964 def SetScrollbar(*args
, **kwargs
):
9966 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9969 Sets the scrollbar properties of a built-in scrollbar.
9971 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9973 def SetScrollPos(*args
, **kwargs
):
9975 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9977 Sets the position of one of the built-in scrollbars.
9979 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9981 def GetScrollPos(*args
, **kwargs
):
9983 GetScrollPos(self, int orientation) -> int
9985 Returns the built-in scrollbar position.
9987 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9989 def GetScrollThumb(*args
, **kwargs
):
9991 GetScrollThumb(self, int orientation) -> int
9993 Returns the built-in scrollbar thumb size.
9995 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9997 def GetScrollRange(*args
, **kwargs
):
9999 GetScrollRange(self, int orientation) -> int
10001 Returns the built-in scrollbar range.
10003 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
10005 def ScrollWindow(*args
, **kwargs
):
10007 ScrollWindow(self, int dx, int dy, Rect rect=None)
10009 Physically scrolls the pixels in the window and move child windows
10010 accordingly. Use this function to optimise your scrolling
10011 implementations, to minimise the area that must be redrawn. Note that
10012 it is rarely required to call this function from a user program.
10014 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
10016 def ScrollLines(*args
, **kwargs
):
10018 ScrollLines(self, int lines) -> bool
10020 If the platform and window class supports it, scrolls the window by
10021 the given number of lines down, if lines is positive, or up if lines
10022 is negative. Returns True if the window was scrolled, False if it was
10023 already on top/bottom and nothing was done.
10025 return _core_
.Window_ScrollLines(*args
, **kwargs
)
10027 def ScrollPages(*args
, **kwargs
):
10029 ScrollPages(self, int pages) -> bool
10031 If the platform and window class supports it, scrolls the window by
10032 the given number of pages down, if pages is positive, or up if pages
10033 is negative. Returns True if the window was scrolled, False if it was
10034 already on top/bottom and nothing was done.
10036 return _core_
.Window_ScrollPages(*args
, **kwargs
)
10038 def LineUp(*args
, **kwargs
):
10040 LineUp(self) -> bool
10042 This is just a wrapper for ScrollLines(-1).
10044 return _core_
.Window_LineUp(*args
, **kwargs
)
10046 def LineDown(*args
, **kwargs
):
10048 LineDown(self) -> bool
10050 This is just a wrapper for ScrollLines(1).
10052 return _core_
.Window_LineDown(*args
, **kwargs
)
10054 def PageUp(*args
, **kwargs
):
10056 PageUp(self) -> bool
10058 This is just a wrapper for ScrollPages(-1).
10060 return _core_
.Window_PageUp(*args
, **kwargs
)
10062 def PageDown(*args
, **kwargs
):
10064 PageDown(self) -> bool
10066 This is just a wrapper for ScrollPages(1).
10068 return _core_
.Window_PageDown(*args
, **kwargs
)
10070 def SetHelpText(*args
, **kwargs
):
10072 SetHelpText(self, String text)
10074 Sets the help text to be used as context-sensitive help for this
10075 window. Note that the text is actually stored by the current
10076 `wx.HelpProvider` implementation, and not in the window object itself.
10078 return _core_
.Window_SetHelpText(*args
, **kwargs
)
10080 def SetHelpTextForId(*args
, **kwargs
):
10082 SetHelpTextForId(self, String text)
10084 Associate this help text with all windows with the same id as this
10087 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
10089 def GetHelpTextAtPoint(*args
, **kwargs
):
10091 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10093 Get the help string associated with the given position in this window.
10095 Notice that pt may be invalid if event origin is keyboard or unknown
10096 and this method should return the global window help text then
10099 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
10101 def GetHelpText(*args
, **kwargs
):
10103 GetHelpText(self) -> String
10105 Gets the help text to be used as context-sensitive help for this
10106 window. Note that the text is actually stored by the current
10107 `wx.HelpProvider` implementation, and not in the window object itself.
10109 return _core_
.Window_GetHelpText(*args
, **kwargs
)
10111 def SetToolTipString(*args
, **kwargs
):
10113 SetToolTipString(self, String tip)
10115 Attach a tooltip to the window.
10117 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
10119 def SetToolTip(*args
, **kwargs
):
10121 SetToolTip(self, ToolTip tip)
10123 Attach a tooltip to the window.
10125 return _core_
.Window_SetToolTip(*args
, **kwargs
)
10127 def GetToolTip(*args
, **kwargs
):
10129 GetToolTip(self) -> ToolTip
10131 get the associated tooltip or None if none
10133 return _core_
.Window_GetToolTip(*args
, **kwargs
)
10135 def SetDropTarget(*args
, **kwargs
):
10137 SetDropTarget(self, DropTarget dropTarget)
10139 Associates a drop target with this window. If the window already has
10140 a drop target, it is deleted.
10142 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
10144 def GetDropTarget(*args
, **kwargs
):
10146 GetDropTarget(self) -> DropTarget
10148 Returns the associated drop target, which may be None.
10150 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
10152 def DragAcceptFiles(*args
, **kwargs
):
10154 DragAcceptFiles(self, bool accept)
10156 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10157 Only functional on Windows.
10159 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
10161 def SetConstraints(*args
, **kwargs
):
10163 SetConstraints(self, LayoutConstraints constraints)
10165 Sets the window to have the given layout constraints. If an existing
10166 layout constraints object is already owned by the window, it will be
10167 deleted. Pass None to disassociate and delete the window's current
10170 You must call SetAutoLayout to tell a window to use the constraints
10171 automatically in its default EVT_SIZE handler; otherwise, you must
10172 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10173 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10176 return _core_
.Window_SetConstraints(*args
, **kwargs
)
10178 def GetConstraints(*args
, **kwargs
):
10180 GetConstraints(self) -> LayoutConstraints
10182 Returns a pointer to the window's layout constraints, or None if there
10185 return _core_
.Window_GetConstraints(*args
, **kwargs
)
10187 def SetAutoLayout(*args
, **kwargs
):
10189 SetAutoLayout(self, bool autoLayout)
10191 Determines whether the Layout function will be called automatically
10192 when the window is resized. lease note that this only happens for the
10193 windows usually used to contain children, namely `wx.Panel` and
10194 `wx.TopLevelWindow` (and the classes deriving from them).
10196 This method is called implicitly by `SetSizer` but if you use
10197 `SetConstraints` you should call it manually or otherwise the window
10198 layout won't be correctly updated when its size changes.
10200 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
10202 def GetAutoLayout(*args
, **kwargs
):
10204 GetAutoLayout(self) -> bool
10206 Returns the current autoLayout setting
10208 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
10210 def Layout(*args
, **kwargs
):
10212 Layout(self) -> bool
10214 Invokes the constraint-based layout algorithm or the sizer-based
10215 algorithm for this window. See SetAutoLayout: when auto layout is on,
10216 this function gets called automatically by the default EVT_SIZE
10217 handler when the window is resized.
10219 return _core_
.Window_Layout(*args
, **kwargs
)
10221 def SetSizer(*args
, **kwargs
):
10223 SetSizer(self, Sizer sizer, bool deleteOld=True)
10225 Sets the window to have the given layout sizer. The window will then
10226 own the object, and will take care of its deletion. If an existing
10227 layout sizer object is already owned by the window, it will be deleted
10228 if the deleteOld parameter is true. Note that this function will also
10229 call SetAutoLayout implicitly with a True parameter if the sizer is
10230 non-None, and False otherwise.
10232 return _core_
.Window_SetSizer(*args
, **kwargs
)
10234 def SetSizerAndFit(*args
, **kwargs
):
10236 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10238 The same as SetSizer, except it also sets the size hints for the
10239 window based on the sizer's minimum size.
10241 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
10243 def GetSizer(*args
, **kwargs
):
10245 GetSizer(self) -> Sizer
10247 Return the sizer associated with the window by a previous call to
10248 SetSizer or None if there isn't one.
10250 return _core_
.Window_GetSizer(*args
, **kwargs
)
10252 def SetContainingSizer(*args
, **kwargs
):
10254 SetContainingSizer(self, Sizer sizer)
10256 This normally does not need to be called by application code. It is
10257 called internally when a window is added to a sizer, and is used so
10258 the window can remove itself from the sizer when it is destroyed.
10260 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
10262 def GetContainingSizer(*args
, **kwargs
):
10264 GetContainingSizer(self) -> Sizer
10266 Return the sizer that this window is a member of, if any, otherwise None.
10268 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
10270 def InheritAttributes(*args
, **kwargs
):
10272 InheritAttributes(self)
10274 This function is (or should be, in case of custom controls) called
10275 during window creation to intelligently set up the window visual
10276 attributes, that is the font and the foreground and background
10279 By 'intelligently' the following is meant: by default, all windows use
10280 their own default attributes. However if some of the parent's
10281 attributes are explicitly changed (that is, using SetFont and not
10282 SetOwnFont) and if the corresponding attribute hadn't been
10283 explicitly set for this window itself, then this window takes the same
10284 value as used by the parent. In addition, if the window overrides
10285 ShouldInheritColours to return false, the colours will not be changed
10286 no matter what and only the font might.
10288 This rather complicated logic is necessary in order to accommodate the
10289 different usage scenarios. The most common one is when all default
10290 attributes are used and in this case, nothing should be inherited as
10291 in modern GUIs different controls use different fonts (and colours)
10292 than their siblings so they can't inherit the same value from the
10293 parent. However it was also deemed desirable to allow to simply change
10294 the attributes of all children at once by just changing the font or
10295 colour of their common parent, hence in this case we do inherit the
10296 parents attributes.
10299 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
10301 def ShouldInheritColours(*args
, **kwargs
):
10303 ShouldInheritColours(self) -> bool
10305 Return true from here to allow the colours of this window to be
10306 changed by InheritAttributes, returning false forbids inheriting them
10307 from the parent window.
10309 The base class version returns false, but this method is overridden in
10310 wxControl where it returns true.
10312 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
10314 def CanSetTransparent(*args
, **kwargs
):
10316 CanSetTransparent(self) -> bool
10318 Returns ``True`` if the platform supports setting the transparency for
10319 this window. Note that this method will err on the side of caution,
10320 so it is possible that this will return ``False`` when it is in fact
10321 possible to set the transparency.
10323 NOTE: On X-windows systems the X server must have the composite
10324 extension loaded, and there must be a composite manager program (such
10325 as xcompmgr) running.
10327 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
10329 def SetTransparent(*args
, **kwargs
):
10331 SetTransparent(self, byte alpha) -> bool
10333 Attempt to set the transparency of this window to the ``alpha`` value,
10334 returns True on success. The ``alpha`` value is an integer in the
10335 range of 0 to 255, where 0 is fully transparent and 255 is fully
10338 return _core_
.Window_SetTransparent(*args
, **kwargs
)
10340 def PostCreate(self
, pre
):
10342 Phase 3 of the 2-phase create <wink!>
10343 Call this method after precreating the window with the 2-phase create method.
10345 self
.this
= pre
.this
10346 self
.thisown
= pre
.thisown
10348 if hasattr(self
, '_setOORInfo'):
10349 self
._setOORInfo
(self
)
10350 if hasattr(self
, '_setCallbackInfo'):
10351 self
._setCallbackInfo
(self
, pre
.__class
__)
10353 def SendSizeEvent(self
):
10354 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
10356 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10357 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
10358 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10359 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10360 EffectiveMinSize
= property(GetEffectiveMinSize
,doc
="See `GetEffectiveMinSize`")
10361 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
10362 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
10363 Border
= property(GetBorder
,doc
="See `GetBorder`")
10364 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
10365 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
10366 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
10367 Children
= property(GetChildren
,doc
="See `GetChildren`")
10368 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
10369 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
10370 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
10371 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
10372 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
10373 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10374 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10375 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10376 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10377 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10378 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10379 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10380 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10381 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10382 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10383 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10384 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10385 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10386 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10387 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10388 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10389 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10390 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10391 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10392 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10393 Parent
= property(GetParent
,doc
="See `GetParent`")
10394 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10395 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10396 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10397 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10398 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10399 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10400 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10401 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10402 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10403 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10404 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10405 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10406 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10407 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10408 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10409 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10410 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10411 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10412 _core_
.Window_swigregister(Window
)
10414 def PreWindow(*args
, **kwargs
):
10416 PreWindow() -> Window
10418 Precreate a Window for 2-phase creation.
10420 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10423 def Window_NewControlId(*args
):
10425 Window_NewControlId() -> int
10427 Generate a control id for the controls which were not given one.
10429 return _core_
.Window_NewControlId(*args
)
10431 def Window_NextControlId(*args
, **kwargs
):
10433 Window_NextControlId(int winid) -> int
10435 Get the id of the control following the one with the given
10438 return _core_
.Window_NextControlId(*args
, **kwargs
)
10440 def Window_PrevControlId(*args
, **kwargs
):
10442 Window_PrevControlId(int winid) -> int
10444 Get the id of the control preceding the one with the given
10447 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10449 def Window_FindFocus(*args
):
10451 Window_FindFocus() -> Window
10453 Returns the window or control that currently has the keyboard focus,
10456 return _core_
.Window_FindFocus(*args
)
10458 def Window_GetCapture(*args
):
10460 Window_GetCapture() -> Window
10462 Returns the window which currently captures the mouse or None
10464 return _core_
.Window_GetCapture(*args
)
10466 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10468 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10470 Get the default attributes for this class. This is useful if you want
10471 to use the same font or colour in your own control as in a standard
10472 control -- which is a much better idea than hard coding specific
10473 colours or fonts which might look completely out of place on the
10474 user's system, especially if it uses themes.
10476 The variant parameter is only relevant under Mac currently and is
10477 ignore under other platforms. Under Mac, it will change the size of
10478 the returned font. See `wx.Window.SetWindowVariant` for more about
10481 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10483 def DLG_PNT(win
, point_or_x
, y
=None):
10485 Convenience function for converting a Point or (x,y) in
10486 dialog units to pixel units.
10489 return win
.ConvertDialogPointToPixels(point_or_x
)
10491 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10493 def DLG_SZE(win
, size_width
, height
=None):
10495 Convenience function for converting a Size or (w,h) in
10496 dialog units to pixel units.
10499 return win
.ConvertDialogSizeToPixels(size_width
)
10501 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10504 def FindWindowById(*args
, **kwargs
):
10506 FindWindowById(long id, Window parent=None) -> Window
10508 Find the first window in the application with the given id. If parent
10509 is None, the search will start from all top-level frames and dialog
10510 boxes; if non-None, the search will be limited to the given window
10511 hierarchy. The search is recursive in both cases.
10513 return _core_
.FindWindowById(*args
, **kwargs
)
10515 def FindWindowByName(*args
, **kwargs
):
10517 FindWindowByName(String name, Window parent=None) -> Window
10519 Find a window by its name (as given in a window constructor or Create
10520 function call). If parent is None, the search will start from all
10521 top-level frames and dialog boxes; if non-None, the search will be
10522 limited to the given window hierarchy. The search is recursive in both
10525 If no window with such name is found, wx.FindWindowByLabel is called.
10527 return _core_
.FindWindowByName(*args
, **kwargs
)
10529 def FindWindowByLabel(*args
, **kwargs
):
10531 FindWindowByLabel(String label, Window parent=None) -> Window
10533 Find a window by its label. Depending on the type of window, the label
10534 may be a window title or panel item label. If parent is None, the
10535 search will start from all top-level frames and dialog boxes; if
10536 non-None, the search will be limited to the given window
10537 hierarchy. The search is recursive in both cases.
10539 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10541 def Window_FromHWND(*args
, **kwargs
):
10542 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10543 return _core_
.Window_FromHWND(*args
, **kwargs
)
10545 def GetTopLevelWindows(*args
):
10547 GetTopLevelWindows() -> PyObject
10549 Returns a list of the the application's top-level windows, (frames,
10550 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10551 by wxWidgets, and so it is only valid as long as no top-level windows
10552 are closed or new top-level windows are created.
10555 return _core_
.GetTopLevelWindows(*args
)
10556 #---------------------------------------------------------------------------
10558 class Validator(EvtHandler
):
10559 """Proxy of C++ Validator class"""
10560 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10561 __repr__
= _swig_repr
10562 def __init__(self
, *args
, **kwargs
):
10563 """__init__(self) -> Validator"""
10564 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10565 self
._setOORInfo
(self
)
10567 def Clone(*args
, **kwargs
):
10568 """Clone(self) -> Validator"""
10569 return _core_
.Validator_Clone(*args
, **kwargs
)
10571 def Validate(*args
, **kwargs
):
10572 """Validate(self, Window parent) -> bool"""
10573 return _core_
.Validator_Validate(*args
, **kwargs
)
10575 def TransferToWindow(*args
, **kwargs
):
10576 """TransferToWindow(self) -> bool"""
10577 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10579 def TransferFromWindow(*args
, **kwargs
):
10580 """TransferFromWindow(self) -> bool"""
10581 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10583 def GetWindow(*args
, **kwargs
):
10584 """GetWindow(self) -> Window"""
10585 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10587 def SetWindow(*args
, **kwargs
):
10588 """SetWindow(self, Window window)"""
10589 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10591 def IsSilent(*args
, **kwargs
):
10592 """IsSilent() -> bool"""
10593 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10595 IsSilent
= staticmethod(IsSilent
)
10596 def SetBellOnError(*args
, **kwargs
):
10597 """SetBellOnError(int doIt=True)"""
10598 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10600 SetBellOnError
= staticmethod(SetBellOnError
)
10601 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10602 _core_
.Validator_swigregister(Validator
)
10604 def Validator_IsSilent(*args
):
10605 """Validator_IsSilent() -> bool"""
10606 return _core_
.Validator_IsSilent(*args
)
10608 def Validator_SetBellOnError(*args
, **kwargs
):
10609 """Validator_SetBellOnError(int doIt=True)"""
10610 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10612 class PyValidator(Validator
):
10613 """Proxy of C++ PyValidator class"""
10614 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10615 __repr__
= _swig_repr
10616 def __init__(self
, *args
, **kwargs
):
10617 """__init__(self) -> PyValidator"""
10618 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10619 self
._setOORInfo
(self
);PyValidator
._setCallbackInfo
(self
, self
, PyValidator
)
10621 def _setCallbackInfo(*args
, **kwargs
):
10622 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
10623 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10625 _core_
.PyValidator_swigregister(PyValidator
)
10627 #---------------------------------------------------------------------------
10629 class Menu(EvtHandler
):
10630 """Proxy of C++ Menu class"""
10631 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10632 __repr__
= _swig_repr
10633 def __init__(self
, *args
, **kwargs
):
10634 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10635 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10636 self
._setOORInfo
(self
)
10638 def Append(*args
, **kwargs
):
10640 Append(self, int id, String text=EmptyString, String help=EmptyString,
10641 int kind=ITEM_NORMAL) -> MenuItem
10643 return _core_
.Menu_Append(*args
, **kwargs
)
10645 def AppendSeparator(*args
, **kwargs
):
10646 """AppendSeparator(self) -> MenuItem"""
10647 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10649 def AppendCheckItem(*args
, **kwargs
):
10650 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10651 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10653 def AppendRadioItem(*args
, **kwargs
):
10654 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10655 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10657 def AppendMenu(*args
, **kwargs
):
10658 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10659 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10661 def AppendSubMenu(*args
, **kwargs
):
10662 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10663 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10665 def AppendItem(*args
, **kwargs
):
10666 """AppendItem(self, MenuItem item) -> MenuItem"""
10667 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10669 def InsertItem(*args
, **kwargs
):
10670 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10671 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10673 def PrependItem(*args
, **kwargs
):
10674 """PrependItem(self, MenuItem item) -> MenuItem"""
10675 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10677 def Break(*args
, **kwargs
):
10679 return _core_
.Menu_Break(*args
, **kwargs
)
10681 def Insert(*args
, **kwargs
):
10683 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10684 int kind=ITEM_NORMAL) -> MenuItem
10686 return _core_
.Menu_Insert(*args
, **kwargs
)
10688 def InsertSeparator(*args
, **kwargs
):
10689 """InsertSeparator(self, size_t pos) -> MenuItem"""
10690 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10692 def InsertCheckItem(*args
, **kwargs
):
10693 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10694 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10696 def InsertRadioItem(*args
, **kwargs
):
10697 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10698 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10700 def InsertMenu(*args
, **kwargs
):
10701 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10702 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10704 def Prepend(*args
, **kwargs
):
10706 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10707 int kind=ITEM_NORMAL) -> MenuItem
10709 return _core_
.Menu_Prepend(*args
, **kwargs
)
10711 def PrependSeparator(*args
, **kwargs
):
10712 """PrependSeparator(self) -> MenuItem"""
10713 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10715 def PrependCheckItem(*args
, **kwargs
):
10716 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10717 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10719 def PrependRadioItem(*args
, **kwargs
):
10720 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10721 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10723 def PrependMenu(*args
, **kwargs
):
10724 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10725 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10727 def Remove(*args
, **kwargs
):
10728 """Remove(self, int id) -> MenuItem"""
10729 return _core_
.Menu_Remove(*args
, **kwargs
)
10731 def RemoveItem(*args
, **kwargs
):
10732 """RemoveItem(self, MenuItem item) -> MenuItem"""
10733 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10735 def Delete(*args
, **kwargs
):
10736 """Delete(self, int id) -> bool"""
10737 return _core_
.Menu_Delete(*args
, **kwargs
)
10739 def DeleteItem(*args
, **kwargs
):
10740 """DeleteItem(self, MenuItem item) -> bool"""
10741 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10743 def Destroy(*args
, **kwargs
):
10747 Deletes the C++ object this Python object is a proxy for.
10749 args
[0].this
.own(False)
10750 return _core_
.Menu_Destroy(*args
, **kwargs
)
10752 def DestroyId(*args
, **kwargs
):
10753 """DestroyId(self, int id) -> bool"""
10754 return _core_
.Menu_DestroyId(*args
, **kwargs
)
10756 def DestroyItem(*args
, **kwargs
):
10757 """DestroyItem(self, MenuItem item) -> bool"""
10758 return _core_
.Menu_DestroyItem(*args
, **kwargs
)
10760 def GetMenuItemCount(*args
, **kwargs
):
10761 """GetMenuItemCount(self) -> size_t"""
10762 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10764 def GetMenuItems(*args
, **kwargs
):
10765 """GetMenuItems(self) -> PyObject"""
10766 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10768 def FindItem(*args
, **kwargs
):
10769 """FindItem(self, String item) -> int"""
10770 return _core_
.Menu_FindItem(*args
, **kwargs
)
10772 def FindItemById(*args
, **kwargs
):
10773 """FindItemById(self, int id) -> MenuItem"""
10774 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10776 def FindItemByPosition(*args
, **kwargs
):
10777 """FindItemByPosition(self, size_t position) -> MenuItem"""
10778 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10780 def Enable(*args
, **kwargs
):
10781 """Enable(self, int id, bool enable)"""
10782 return _core_
.Menu_Enable(*args
, **kwargs
)
10784 def IsEnabled(*args
, **kwargs
):
10785 """IsEnabled(self, int id) -> bool"""
10786 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10788 def Check(*args
, **kwargs
):
10789 """Check(self, int id, bool check)"""
10790 return _core_
.Menu_Check(*args
, **kwargs
)
10792 def IsChecked(*args
, **kwargs
):
10793 """IsChecked(self, int id) -> bool"""
10794 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10796 def SetLabel(*args
, **kwargs
):
10797 """SetLabel(self, int id, String label)"""
10798 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10800 def GetLabel(*args
, **kwargs
):
10801 """GetLabel(self, int id) -> String"""
10802 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10804 def SetHelpString(*args
, **kwargs
):
10805 """SetHelpString(self, int id, String helpString)"""
10806 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10808 def GetHelpString(*args
, **kwargs
):
10809 """GetHelpString(self, int id) -> String"""
10810 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10812 def SetTitle(*args
, **kwargs
):
10813 """SetTitle(self, String title)"""
10814 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10816 def GetTitle(*args
, **kwargs
):
10817 """GetTitle(self) -> String"""
10818 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10820 def SetEventHandler(*args
, **kwargs
):
10821 """SetEventHandler(self, EvtHandler handler)"""
10822 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10824 def GetEventHandler(*args
, **kwargs
):
10825 """GetEventHandler(self) -> EvtHandler"""
10826 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10828 def SetInvokingWindow(*args
, **kwargs
):
10829 """SetInvokingWindow(self, Window win)"""
10830 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10832 def GetInvokingWindow(*args
, **kwargs
):
10833 """GetInvokingWindow(self) -> Window"""
10834 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10836 def GetStyle(*args
, **kwargs
):
10837 """GetStyle(self) -> long"""
10838 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10840 def UpdateUI(*args
, **kwargs
):
10841 """UpdateUI(self, EvtHandler source=None)"""
10842 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10844 def GetMenuBar(*args
, **kwargs
):
10845 """GetMenuBar(self) -> MenuBar"""
10846 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10848 def Attach(*args
, **kwargs
):
10849 """Attach(self, wxMenuBarBase menubar)"""
10850 return _core_
.Menu_Attach(*args
, **kwargs
)
10852 def Detach(*args
, **kwargs
):
10854 return _core_
.Menu_Detach(*args
, **kwargs
)
10856 def IsAttached(*args
, **kwargs
):
10857 """IsAttached(self) -> bool"""
10858 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10860 def SetParent(*args
, **kwargs
):
10861 """SetParent(self, Menu parent)"""
10862 return _core_
.Menu_SetParent(*args
, **kwargs
)
10864 def GetParent(*args
, **kwargs
):
10865 """GetParent(self) -> Menu"""
10866 return _core_
.Menu_GetParent(*args
, **kwargs
)
10868 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10869 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10870 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10871 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10872 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10873 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10874 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10875 Style
= property(GetStyle
,doc
="See `GetStyle`")
10876 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10877 _core_
.Menu_swigregister(Menu
)
10878 DefaultValidator
= cvar
.DefaultValidator
10880 #---------------------------------------------------------------------------
10882 class MenuBar(Window
):
10883 """Proxy of C++ MenuBar class"""
10884 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10885 __repr__
= _swig_repr
10886 def __init__(self
, *args
, **kwargs
):
10887 """__init__(self, long style=0) -> MenuBar"""
10888 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10889 self
._setOORInfo
(self
)
10891 def Append(*args
, **kwargs
):
10892 """Append(self, Menu menu, String title) -> bool"""
10893 return _core_
.MenuBar_Append(*args
, **kwargs
)
10895 def Insert(*args
, **kwargs
):
10896 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10897 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10899 def GetMenuCount(*args
, **kwargs
):
10900 """GetMenuCount(self) -> size_t"""
10901 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10903 def GetMenu(*args
, **kwargs
):
10904 """GetMenu(self, size_t pos) -> Menu"""
10905 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10907 def Replace(*args
, **kwargs
):
10908 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10909 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10911 def Remove(*args
, **kwargs
):
10912 """Remove(self, size_t pos) -> Menu"""
10913 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10915 def EnableTop(*args
, **kwargs
):
10916 """EnableTop(self, size_t pos, bool enable)"""
10917 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10919 def IsEnabledTop(*args
, **kwargs
):
10920 """IsEnabledTop(self, size_t pos) -> bool"""
10921 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10923 def SetLabelTop(*args
, **kwargs
):
10924 """SetLabelTop(self, size_t pos, String label)"""
10925 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10927 def GetLabelTop(*args
, **kwargs
):
10928 """GetLabelTop(self, size_t pos) -> String"""
10929 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10931 def FindMenuItem(*args
, **kwargs
):
10932 """FindMenuItem(self, String menu, String item) -> int"""
10933 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10935 def FindItemById(*args
, **kwargs
):
10936 """FindItemById(self, int id) -> MenuItem"""
10937 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10939 def FindMenu(*args
, **kwargs
):
10940 """FindMenu(self, String title) -> int"""
10941 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10943 def Enable(*args
, **kwargs
):
10944 """Enable(self, int id, bool enable)"""
10945 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10947 def Check(*args
, **kwargs
):
10948 """Check(self, int id, bool check)"""
10949 return _core_
.MenuBar_Check(*args
, **kwargs
)
10951 def IsChecked(*args
, **kwargs
):
10952 """IsChecked(self, int id) -> bool"""
10953 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10955 def IsEnabled(*args
, **kwargs
):
10956 """IsEnabled(self, int id) -> bool"""
10957 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10959 def SetLabel(*args
, **kwargs
):
10960 """SetLabel(self, int id, String label)"""
10961 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10963 def GetLabel(*args
, **kwargs
):
10964 """GetLabel(self, int id) -> String"""
10965 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10967 def SetHelpString(*args
, **kwargs
):
10968 """SetHelpString(self, int id, String helpString)"""
10969 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10971 def GetHelpString(*args
, **kwargs
):
10972 """GetHelpString(self, int id) -> String"""
10973 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10975 def GetFrame(*args
, **kwargs
):
10976 """GetFrame(self) -> wxFrame"""
10977 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10979 def IsAttached(*args
, **kwargs
):
10980 """IsAttached(self) -> bool"""
10981 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10983 def Attach(*args
, **kwargs
):
10984 """Attach(self, wxFrame frame)"""
10985 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10987 def Detach(*args
, **kwargs
):
10989 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10991 def UpdateMenus(*args
, **kwargs
):
10992 """UpdateMenus(self)"""
10993 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10995 def SetAutoWindowMenu(*args
, **kwargs
):
10996 """SetAutoWindowMenu(bool enable)"""
10997 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10999 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
11000 def GetAutoWindowMenu(*args
, **kwargs
):
11001 """GetAutoWindowMenu() -> bool"""
11002 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
11004 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
11005 def GetMenus(self
):
11006 """Return a list of (menu, label) items for the menus in the MenuBar. """
11007 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
11008 for i
in range(self
.GetMenuCount())]
11010 def SetMenus(self
, items
):
11011 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11012 for i
in range(self
.GetMenuCount()-1, -1, -1):
11017 Frame
= property(GetFrame
,doc
="See `GetFrame`")
11018 Menu
= property(GetMenu
,doc
="See `GetMenu`")
11019 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
11020 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
11021 _core_
.MenuBar_swigregister(MenuBar
)
11023 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
11024 """MenuBar_SetAutoWindowMenu(bool enable)"""
11025 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
11027 def MenuBar_GetAutoWindowMenu(*args
):
11028 """MenuBar_GetAutoWindowMenu() -> bool"""
11029 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
11031 #---------------------------------------------------------------------------
11033 class MenuItem(Object
):
11034 """Proxy of C++ MenuItem class"""
11035 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11036 __repr__
= _swig_repr
11037 def __init__(self
, *args
, **kwargs
):
11039 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11040 String help=EmptyString, int kind=ITEM_NORMAL,
11041 Menu subMenu=None) -> MenuItem
11043 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
11044 __swig_destroy__
= _core_
.delete_MenuItem
11045 __del__
= lambda self
: None;
11046 def GetMenu(*args
, **kwargs
):
11047 """GetMenu(self) -> Menu"""
11048 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
11050 def SetMenu(*args
, **kwargs
):
11051 """SetMenu(self, Menu menu)"""
11052 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
11054 def SetId(*args
, **kwargs
):
11055 """SetId(self, int id)"""
11056 return _core_
.MenuItem_SetId(*args
, **kwargs
)
11058 def GetId(*args
, **kwargs
):
11059 """GetId(self) -> int"""
11060 return _core_
.MenuItem_GetId(*args
, **kwargs
)
11062 def IsSeparator(*args
, **kwargs
):
11063 """IsSeparator(self) -> bool"""
11064 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
11066 def SetText(*args
, **kwargs
):
11067 """SetText(self, String str)"""
11068 return _core_
.MenuItem_SetText(*args
, **kwargs
)
11070 def GetLabel(*args
, **kwargs
):
11071 """GetLabel(self) -> String"""
11072 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
11074 def GetText(*args
, **kwargs
):
11075 """GetText(self) -> String"""
11076 return _core_
.MenuItem_GetText(*args
, **kwargs
)
11078 def GetLabelFromText(*args
, **kwargs
):
11079 """GetLabelFromText(String text) -> String"""
11080 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11082 GetLabelFromText
= staticmethod(GetLabelFromText
)
11083 def GetKind(*args
, **kwargs
):
11084 """GetKind(self) -> int"""
11085 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
11087 def SetKind(*args
, **kwargs
):
11088 """SetKind(self, int kind)"""
11089 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
11091 def SetCheckable(*args
, **kwargs
):
11092 """SetCheckable(self, bool checkable)"""
11093 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
11095 def IsCheckable(*args
, **kwargs
):
11096 """IsCheckable(self) -> bool"""
11097 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
11099 def IsSubMenu(*args
, **kwargs
):
11100 """IsSubMenu(self) -> bool"""
11101 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
11103 def SetSubMenu(*args
, **kwargs
):
11104 """SetSubMenu(self, Menu menu)"""
11105 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
11107 def GetSubMenu(*args
, **kwargs
):
11108 """GetSubMenu(self) -> Menu"""
11109 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
11111 def Enable(*args
, **kwargs
):
11112 """Enable(self, bool enable=True)"""
11113 return _core_
.MenuItem_Enable(*args
, **kwargs
)
11115 def IsEnabled(*args
, **kwargs
):
11116 """IsEnabled(self) -> bool"""
11117 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
11119 def Check(*args
, **kwargs
):
11120 """Check(self, bool check=True)"""
11121 return _core_
.MenuItem_Check(*args
, **kwargs
)
11123 def IsChecked(*args
, **kwargs
):
11124 """IsChecked(self) -> bool"""
11125 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
11127 def Toggle(*args
, **kwargs
):
11129 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
11131 def SetHelp(*args
, **kwargs
):
11132 """SetHelp(self, String str)"""
11133 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
11135 def GetHelp(*args
, **kwargs
):
11136 """GetHelp(self) -> String"""
11137 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
11139 def GetAccel(*args
, **kwargs
):
11140 """GetAccel(self) -> AcceleratorEntry"""
11141 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
11143 def SetAccel(*args
, **kwargs
):
11144 """SetAccel(self, AcceleratorEntry accel)"""
11145 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
11147 def SetBitmap(*args
, **kwargs
):
11148 """SetBitmap(self, Bitmap bitmap)"""
11149 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
11151 def GetBitmap(*args
, **kwargs
):
11152 """GetBitmap(self) -> Bitmap"""
11153 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
11155 def SetFont(*args
, **kwargs
):
11156 """SetFont(self, Font font)"""
11157 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
11159 def GetFont(*args
, **kwargs
):
11160 """GetFont(self) -> Font"""
11161 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
11163 def SetTextColour(*args
, **kwargs
):
11164 """SetTextColour(self, Colour colText)"""
11165 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
11167 def GetTextColour(*args
, **kwargs
):
11168 """GetTextColour(self) -> Colour"""
11169 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
11171 def SetBackgroundColour(*args
, **kwargs
):
11172 """SetBackgroundColour(self, Colour colBack)"""
11173 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
11175 def GetBackgroundColour(*args
, **kwargs
):
11176 """GetBackgroundColour(self) -> Colour"""
11177 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
11179 def SetBitmaps(*args
, **kwargs
):
11180 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11181 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
11183 def SetDisabledBitmap(*args
, **kwargs
):
11184 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11185 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
11187 def GetDisabledBitmap(*args
, **kwargs
):
11188 """GetDisabledBitmap(self) -> Bitmap"""
11189 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
11191 def SetMarginWidth(*args
, **kwargs
):
11192 """SetMarginWidth(self, int nWidth)"""
11193 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
11195 def GetMarginWidth(*args
, **kwargs
):
11196 """GetMarginWidth(self) -> int"""
11197 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
11199 def GetDefaultMarginWidth(*args
, **kwargs
):
11200 """GetDefaultMarginWidth() -> int"""
11201 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
11203 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
11204 def IsOwnerDrawn(*args
, **kwargs
):
11205 """IsOwnerDrawn(self) -> bool"""
11206 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
11208 def SetOwnerDrawn(*args
, **kwargs
):
11209 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11210 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
11212 def ResetOwnerDrawn(*args
, **kwargs
):
11213 """ResetOwnerDrawn(self)"""
11214 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
11216 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
11217 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
11218 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
11219 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11220 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
11221 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
11222 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
11223 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
11224 Label
= property(GetLabel
,doc
="See `GetLabel`")
11225 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
11226 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
11227 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
11228 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
11229 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
11230 _core_
.MenuItem_swigregister(MenuItem
)
11232 def MenuItem_GetLabelFromText(*args
, **kwargs
):
11233 """MenuItem_GetLabelFromText(String text) -> String"""
11234 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
11236 def MenuItem_GetDefaultMarginWidth(*args
):
11237 """MenuItem_GetDefaultMarginWidth() -> int"""
11238 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
11240 #---------------------------------------------------------------------------
11242 class Control(Window
):
11244 This is the base class for a control or 'widget'.
11246 A control is generally a small window which processes user input
11247 and/or displays one or more item of data.
11249 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11250 __repr__
= _swig_repr
11251 def __init__(self
, *args
, **kwargs
):
11253 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11254 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11255 String name=ControlNameStr) -> Control
11257 Create a Control. Normally you should only call this from a subclass'
11258 __init__ as a plain old wx.Control is not very useful.
11260 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
11261 self
._setOORInfo
(self
)
11263 def Create(*args
, **kwargs
):
11265 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11266 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11267 String name=ControlNameStr) -> bool
11269 Do the 2nd phase and create the GUI control.
11271 return _core_
.Control_Create(*args
, **kwargs
)
11273 def GetAlignment(*args
, **kwargs
):
11275 GetAlignment(self) -> int
11277 Get the control alignment (left/right/centre, top/bottom/centre)
11279 return _core_
.Control_GetAlignment(*args
, **kwargs
)
11281 def GetLabelText(*args
, **kwargs
):
11283 GetLabelText(self) -> String
11285 Get just the text of the label, without mnemonic characters ('&')
11287 return _core_
.Control_GetLabelText(*args
, **kwargs
)
11289 def Command(*args
, **kwargs
):
11291 Command(self, CommandEvent event)
11293 Simulates the effect of the user issuing a command to the item.
11295 :see: `wx.CommandEvent`
11298 return _core_
.Control_Command(*args
, **kwargs
)
11300 def GetClassDefaultAttributes(*args
, **kwargs
):
11302 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11304 Get the default attributes for this class. This is useful if you want
11305 to use the same font or colour in your own control as in a standard
11306 control -- which is a much better idea than hard coding specific
11307 colours or fonts which might look completely out of place on the
11308 user's system, especially if it uses themes.
11310 The variant parameter is only relevant under Mac currently and is
11311 ignore under other platforms. Under Mac, it will change the size of
11312 the returned font. See `wx.Window.SetWindowVariant` for more about
11315 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11317 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
11318 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
11319 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
11320 _core_
.Control_swigregister(Control
)
11321 ControlNameStr
= cvar
.ControlNameStr
11323 def PreControl(*args
, **kwargs
):
11325 PreControl() -> Control
11327 Precreate a Control control for 2-phase creation
11329 val
= _core_
.new_PreControl(*args
, **kwargs
)
11332 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
11334 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11336 Get the default attributes for this class. This is useful if you want
11337 to use the same font or colour in your own control as in a standard
11338 control -- which is a much better idea than hard coding specific
11339 colours or fonts which might look completely out of place on the
11340 user's system, especially if it uses themes.
11342 The variant parameter is only relevant under Mac currently and is
11343 ignore under other platforms. Under Mac, it will change the size of
11344 the returned font. See `wx.Window.SetWindowVariant` for more about
11347 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
11349 #---------------------------------------------------------------------------
11351 class ItemContainer(object):
11353 The wx.ItemContainer class defines an interface which is implemented
11354 by all controls which have string subitems, each of which may be
11355 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11356 as `wx.ComboBox` which implements an extended interface deriving from
11359 It defines the methods for accessing the control's items and although
11360 each of the derived classes implements them differently, they still
11361 all conform to the same interface.
11363 The items in a wx.ItemContainer have (non empty) string labels and,
11364 optionally, client data associated with them.
11367 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11368 def __init__(self
): raise AttributeError, "No constructor defined"
11369 __repr__
= _swig_repr
11370 def Append(*args
, **kwargs
):
11372 Append(self, String item, PyObject clientData=None) -> int
11374 Adds the item to the control, associating the given data with the item
11375 if not None. The return value is the index of the newly added item
11376 which may be different from the last one if the control is sorted (e.g.
11377 has wx.LB_SORT or wx.CB_SORT style).
11379 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11381 def AppendItems(*args
, **kwargs
):
11383 AppendItems(self, List strings)
11385 Apend several items at once to the control. Notice that calling this
11386 method may be much faster than appending the items one by one if you
11387 need to add a lot of items.
11389 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11391 def Insert(*args
, **kwargs
):
11393 Insert(self, String item, int pos, PyObject clientData=None) -> int
11395 Insert an item into the control before the item at the ``pos`` index,
11396 optionally associating some data object with the item.
11398 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11400 def Clear(*args
, **kwargs
):
11404 Removes all items from the control.
11406 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11408 def Delete(*args
, **kwargs
):
11410 Delete(self, int n)
11412 Deletes the item at the zero-based index 'n' from the control. Note
11413 that it is an error (signalled by a `wx.PyAssertionError` exception if
11414 enabled) to remove an item with the index negative or greater or equal
11415 than the number of items in the control.
11417 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11419 def GetClientData(*args
, **kwargs
):
11421 GetClientData(self, int n) -> PyObject
11423 Returns the client data associated with the given item, (if any.)
11425 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11427 def SetClientData(*args
, **kwargs
):
11429 SetClientData(self, int n, PyObject clientData)
11431 Associate the given client data with the item at position n.
11433 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11435 def GetCount(*args
, **kwargs
):
11437 GetCount(self) -> int
11439 Returns the number of items in the control.
11441 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11443 def IsEmpty(*args
, **kwargs
):
11445 IsEmpty(self) -> bool
11447 Returns True if the control is empty or False if it has some items.
11449 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11451 def GetString(*args
, **kwargs
):
11453 GetString(self, int n) -> String
11455 Returns the label of the item with the given index.
11457 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11459 def GetStrings(*args
, **kwargs
):
11460 """GetStrings(self) -> wxArrayString"""
11461 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11463 def SetString(*args
, **kwargs
):
11465 SetString(self, int n, String s)
11467 Sets the label for the given item.
11469 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11471 def FindString(*args
, **kwargs
):
11473 FindString(self, String s) -> int
11475 Finds an item whose label matches the given string. Returns the
11476 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11479 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11481 def SetSelection(*args
, **kwargs
):
11483 SetSelection(self, int n)
11485 Sets the item at index 'n' to be the selected item.
11487 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11489 def GetSelection(*args
, **kwargs
):
11491 GetSelection(self) -> int
11493 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11496 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11498 def SetStringSelection(*args
, **kwargs
):
11499 """SetStringSelection(self, String s) -> bool"""
11500 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11502 def GetStringSelection(*args
, **kwargs
):
11504 GetStringSelection(self) -> String
11506 Returns the label of the selected item or an empty string if no item
11509 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11511 def Select(*args
, **kwargs
):
11513 Select(self, int n)
11515 This is the same as `SetSelection` and exists only because it is
11516 slightly more natural for controls which support multiple selection.
11518 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11520 def GetItems(self
):
11521 """Return a list of the strings in the control"""
11522 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11524 def SetItems(self
, items
):
11525 """Clear and set the strings in the control from a list"""
11530 Count
= property(GetCount
,doc
="See `GetCount`")
11531 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11532 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11533 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11534 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11535 _core_
.ItemContainer_swigregister(ItemContainer
)
11537 #---------------------------------------------------------------------------
11539 class ControlWithItems(Control
,ItemContainer
):
11541 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11542 wx.Control class, and is used for the base class of various controls
11545 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11546 def __init__(self
): raise AttributeError, "No constructor defined"
11547 __repr__
= _swig_repr
11548 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11550 #---------------------------------------------------------------------------
11552 class SizerItem(Object
):
11554 The wx.SizerItem class is used to track the position, size and other
11555 attributes of each item managed by a `wx.Sizer`. It is not usually
11556 necessary to use this class because the sizer elements can also be
11557 identified by their positions or window or sizer references but
11558 sometimes it may be more convenient to use wx.SizerItem directly.
11559 Also, custom classes derived from `wx.PySizer` will probably need to
11560 use the collection of wx.SizerItems held by wx.Sizer when calculating
11563 :see: `wx.Sizer`, `wx.GBSizerItem`
11565 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11566 __repr__
= _swig_repr
11567 def __init__(self
, *args
, **kwargs
):
11569 __init__(self) -> SizerItem
11571 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11572 size will need to be set before this item can be used in a Sizer.
11574 You will probably never need to create a wx.SizerItem directly as they
11575 are created automatically when the sizer's Add, Insert or Prepend
11576 methods are called.
11578 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11580 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11581 __swig_destroy__
= _core_
.delete_SizerItem
11582 __del__
= lambda self
: None;
11583 def DeleteWindows(*args
, **kwargs
):
11585 DeleteWindows(self)
11587 Destroy the window or the windows in a subsizer, depending on the type
11590 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11592 def DetachSizer(*args
, **kwargs
):
11596 Enable deleting the SizerItem without destroying the contained sizer.
11598 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11600 def GetSize(*args
, **kwargs
):
11602 GetSize(self) -> Size
11604 Get the current size of the item, as set in the last Layout.
11606 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11608 def CalcMin(*args
, **kwargs
):
11610 CalcMin(self) -> Size
11612 Calculates the minimum desired size for the item, including any space
11615 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11617 def SetDimension(*args
, **kwargs
):
11619 SetDimension(self, Point pos, Size size)
11621 Set the position and size of the space allocated for this item by the
11622 sizer, and adjust the position and size of the item (window or
11623 subsizer) to be within that space taking alignment and borders into
11626 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11628 def GetMinSize(*args
, **kwargs
):
11630 GetMinSize(self) -> Size
11632 Get the minimum size needed for the item.
11634 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11636 def GetMinSizeWithBorder(*args
, **kwargs
):
11638 GetMinSizeWithBorder(self) -> Size
11640 Get the minimum size needed for the item with space for the borders
11643 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11645 def SetInitSize(*args
, **kwargs
):
11646 """SetInitSize(self, int x, int y)"""
11647 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11649 def SetRatioWH(*args
, **kwargs
):
11651 SetRatioWH(self, int width, int height)
11653 Set the ratio item attribute.
11655 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11657 def SetRatioSize(*args
, **kwargs
):
11659 SetRatioSize(self, Size size)
11661 Set the ratio item attribute.
11663 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11665 def SetRatio(*args
, **kwargs
):
11667 SetRatio(self, float ratio)
11669 Set the ratio item attribute.
11671 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11673 def GetRatio(*args
, **kwargs
):
11675 GetRatio(self) -> float
11677 Set the ratio item attribute.
11679 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11681 def GetRect(*args
, **kwargs
):
11683 GetRect(self) -> Rect
11685 Returns the rectangle that the sizer item should occupy
11687 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11689 def IsWindow(*args
, **kwargs
):
11691 IsWindow(self) -> bool
11693 Is this sizer item a window?
11695 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11697 def IsSizer(*args
, **kwargs
):
11699 IsSizer(self) -> bool
11701 Is this sizer item a subsizer?
11703 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11705 def IsSpacer(*args
, **kwargs
):
11707 IsSpacer(self) -> bool
11709 Is this sizer item a spacer?
11711 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11713 def SetProportion(*args
, **kwargs
):
11715 SetProportion(self, int proportion)
11717 Set the proportion value for this item.
11719 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11721 def GetProportion(*args
, **kwargs
):
11723 GetProportion(self) -> int
11725 Get the proportion value for this item.
11727 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11729 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11730 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11731 def SetFlag(*args
, **kwargs
):
11733 SetFlag(self, int flag)
11735 Set the flag value for this item.
11737 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11739 def GetFlag(*args
, **kwargs
):
11741 GetFlag(self) -> int
11743 Get the flag value for this item.
11745 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11747 def SetBorder(*args
, **kwargs
):
11749 SetBorder(self, int border)
11751 Set the border value for this item.
11753 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11755 def GetBorder(*args
, **kwargs
):
11757 GetBorder(self) -> int
11759 Get the border value for this item.
11761 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11763 def GetWindow(*args
, **kwargs
):
11765 GetWindow(self) -> Window
11767 Get the window (if any) that is managed by this sizer item.
11769 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11771 def SetWindow(*args
, **kwargs
):
11773 SetWindow(self, Window window)
11775 Set the window to be managed by this sizer item.
11777 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11779 def GetSizer(*args
, **kwargs
):
11781 GetSizer(self) -> Sizer
11783 Get the subsizer (if any) that is managed by this sizer item.
11785 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11787 def SetSizer(*args
, **kwargs
):
11789 SetSizer(self, Sizer sizer)
11791 Set the subsizer to be managed by this sizer item.
11793 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11795 def GetSpacer(*args
, **kwargs
):
11797 GetSpacer(self) -> Size
11799 Get the size of the spacer managed by this sizer item.
11801 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11803 def SetSpacer(*args
, **kwargs
):
11805 SetSpacer(self, Size size)
11807 Set the size of the spacer to be managed by this sizer item.
11809 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11811 def Show(*args
, **kwargs
):
11813 Show(self, bool show)
11815 Set the show item attribute, which sizers use to determine if the item
11816 is to be made part of the layout or not. If the item is tracking a
11817 window then it is shown or hidden as needed.
11819 return _core_
.SizerItem_Show(*args
, **kwargs
)
11821 def IsShown(*args
, **kwargs
):
11823 IsShown(self) -> bool
11825 Is the item to be shown in the layout?
11827 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11829 def GetPosition(*args
, **kwargs
):
11831 GetPosition(self) -> Point
11833 Returns the current position of the item, as set in the last Layout.
11835 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11837 def GetUserData(*args
, **kwargs
):
11839 GetUserData(self) -> PyObject
11841 Returns the userData associated with this sizer item, or None if there
11844 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11846 def SetUserData(*args
, **kwargs
):
11848 SetUserData(self, PyObject userData)
11850 Associate a Python object with this sizer item.
11852 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11854 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11855 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11856 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11857 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11858 Position
= property(GetPosition
,doc
="See `GetPosition`")
11859 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11860 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11861 Rect
= property(GetRect
,doc
="See `GetRect`")
11862 Size
= property(GetSize
,doc
="See `GetSize`")
11863 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11864 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11865 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11866 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11867 _core_
.SizerItem_swigregister(SizerItem
)
11869 def SizerItemWindow(*args
, **kwargs
):
11871 SizerItemWindow(Window window, int proportion, int flag, int border,
11872 PyObject userData=None) -> SizerItem
11874 Constructs a `wx.SizerItem` for tracking a window.
11876 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11879 def SizerItemSpacer(*args
, **kwargs
):
11881 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11882 PyObject userData=None) -> SizerItem
11884 Constructs a `wx.SizerItem` for tracking a spacer.
11886 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11889 def SizerItemSizer(*args
, **kwargs
):
11891 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11892 PyObject userData=None) -> SizerItem
11894 Constructs a `wx.SizerItem` for tracking a subsizer
11896 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11899 class Sizer(Object
):
11901 wx.Sizer is the abstract base class used for laying out subwindows in
11902 a window. You cannot use wx.Sizer directly; instead, you will have to
11903 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11904 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11907 The concept implemented by sizers in wxWidgets is closely related to
11908 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11909 toolkit or the Qt toolkit. It is based upon the idea of the individual
11910 subwindows reporting their minimal required size and their ability to
11911 get stretched if the size of the parent window has changed. This will
11912 most often mean that the programmer does not set the original size of
11913 a dialog in the beginning, rather the dialog will assigned a sizer and
11914 this sizer will be queried about the recommended size. The sizer in
11915 turn will query its children, which can be normal windows or contorls,
11916 empty space or other sizers, so that a hierarchy of sizers can be
11917 constructed. Note that wxSizer does not derive from wxWindow and thus
11918 do not interfere with tab ordering and requires very little resources
11919 compared to a real window on screen.
11921 What makes sizers so well fitted for use in wxWidgets is the fact that
11922 every control reports its own minimal size and the algorithm can
11923 handle differences in font sizes or different window (dialog item)
11924 sizes on different platforms without problems. If for example the
11925 standard font as well as the overall design of Mac widgets requires
11926 more space than on Windows, then the initial size of a dialog using a
11927 sizer will automatically be bigger on Mac than on Windows.
11929 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11930 def __init__(self
): raise AttributeError, "No constructor defined"
11931 __repr__
= _swig_repr
11932 __swig_destroy__
= _core_
.delete_Sizer
11933 __del__
= lambda self
: None;
11934 def _setOORInfo(*args
, **kwargs
):
11935 """_setOORInfo(self, PyObject _self)"""
11936 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11938 def Add(*args
, **kwargs
):
11940 Add(self, item, int proportion=0, int flag=0, int border=0,
11941 PyObject userData=None) -> wx.SizerItem
11943 Appends a child item to the sizer.
11945 return _core_
.Sizer_Add(*args
, **kwargs
)
11947 def Insert(*args
, **kwargs
):
11949 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11950 PyObject userData=None) -> wx.SizerItem
11952 Inserts a new item into the list of items managed by this sizer before
11953 the item at index *before*. See `Add` for a description of the parameters.
11955 return _core_
.Sizer_Insert(*args
, **kwargs
)
11957 def Prepend(*args
, **kwargs
):
11959 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11960 PyObject userData=None) -> wx.SizerItem
11962 Adds a new item to the begining of the list of sizer items managed by
11963 this sizer. See `Add` for a description of the parameters.
11965 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11967 def Remove(*args
, **kwargs
):
11969 Remove(self, item) -> bool
11971 Removes an item from the sizer and destroys it. This method does not
11972 cause any layout or resizing to take place, call `Layout` to update
11973 the layout on screen after removing a child from the sizer. The
11974 *item* parameter can be either a window, a sizer, or the zero-based
11975 index of an item to remove. Returns True if the child item was found
11978 return _core_
.Sizer_Remove(*args
, **kwargs
)
11980 def Detach(*args
, **kwargs
):
11982 Detach(self, item) -> bool
11984 Detaches an item from the sizer without destroying it. This method
11985 does not cause any layout or resizing to take place, call `Layout` to
11986 do so. The *item* parameter can be either a window, a sizer, or the
11987 zero-based index of the item to be detached. Returns True if the child item
11988 was found and detached.
11990 return _core_
.Sizer_Detach(*args
, **kwargs
)
11992 def GetItem(*args
, **kwargs
):
11994 GetItem(self, item) -> wx.SizerItem
11996 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11997 parameter can be either a window, a sizer, or the zero-based index of
11998 the item to be found.
12000 return _core_
.Sizer_GetItem(*args
, **kwargs
)
12002 def _SetItemMinSize(*args
, **kwargs
):
12003 """_SetItemMinSize(self, PyObject item, Size size)"""
12004 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
12006 def _ReplaceWin(*args
, **kwargs
):
12007 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12008 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
12010 def _ReplaceSizer(*args
, **kwargs
):
12011 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12012 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
12014 def _ReplaceItem(*args
, **kwargs
):
12015 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12016 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
12018 def Replace(self
, olditem
, item
, recursive
=False):
12020 Detaches the given ``olditem`` from the sizer and replaces it with
12021 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12022 detached child is destroyed only if it is not a window, (because
12023 windows are owned by their parent, not the sizer.) The
12024 ``recursive`` parameter can be used to search for the given
12025 element recursivly in subsizers.
12027 This method does not cause any layout or resizing to take place,
12028 call `Layout` to do so.
12030 Returns ``True`` if the child item was found and removed.
12032 if isinstance(olditem
, wx
.Window
):
12033 return self
._ReplaceWin
(olditem
, item
, recursive
)
12034 elif isinstnace(olditem
, wx
.Sizer
):
12035 return self
._ReplaceSizer
(olditem
, item
, recursive
)
12036 elif isinstnace(olditem
, int):
12037 return self
._ReplaceItem
(olditem
, item
)
12039 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12041 def SetContainingWindow(*args
, **kwargs
):
12043 SetContainingWindow(self, Window window)
12045 Set (or unset) the window this sizer is used in.
12047 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
12049 def GetContainingWindow(*args
, **kwargs
):
12051 GetContainingWindow(self) -> Window
12053 Get the window this sizer is used in.
12055 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
12057 def SetItemMinSize(self
, item
, *args
):
12059 SetItemMinSize(self, item, Size size)
12061 Sets the minimum size that will be allocated for an item in the sizer.
12062 The *item* parameter can be either a window, a sizer, or the
12063 zero-based index of the item. If a window or sizer is given then it
12064 will be searched for recursivly in subsizers if neccessary.
12067 # for backward compatibility accept separate width,height args too
12068 return self
._SetItemMinSize
(item
, args
)
12070 return self
._SetItemMinSize
(item
, args
[0])
12072 def AddItem(*args
, **kwargs
):
12074 AddItem(self, SizerItem item)
12076 Adds a `wx.SizerItem` to the sizer.
12078 return _core_
.Sizer_AddItem(*args
, **kwargs
)
12080 def InsertItem(*args
, **kwargs
):
12082 InsertItem(self, int index, SizerItem item)
12084 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12086 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
12088 def PrependItem(*args
, **kwargs
):
12090 PrependItem(self, SizerItem item)
12092 Prepends a `wx.SizerItem` to the sizer.
12094 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
12096 def AddMany(self
, items
):
12098 AddMany is a convenience method for adding several items
12099 to a sizer at one time. Simply pass it a list of tuples,
12100 where each tuple consists of the parameters that you
12101 would normally pass to the `Add` method.
12104 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
12108 def AddSpacer(self
, *args
, **kw
):
12109 """AddSpacer(int size) --> SizerItem
12111 Add a spacer that is (size,size) pixels.
12113 if args
and type(args
[0]) == int:
12114 return self
.Add( (args
[0],args
[0] ), 0)
12115 else: # otherwise stay compatible with old AddSpacer
12116 return self
.Add(*args
, **kw
)
12117 def PrependSpacer(self
, *args
, **kw
):
12118 """PrependSpacer(int size) --> SizerItem
12120 Prepend a spacer that is (size, size) pixels."""
12121 if args
and type(args
[0]) == int:
12122 return self
.Prepend( (args
[0],args
[0] ), 0)
12123 else: # otherwise stay compatible with old PrependSpacer
12124 return self
.Prepend(*args
, **kw
)
12125 def InsertSpacer(self
, index
, *args
, **kw
):
12126 """InsertSpacer(int index, int size) --> SizerItem
12128 Insert a spacer at position index that is (size, size) pixels."""
12129 if args
and type(args
[0]) == int:
12130 return self
.Insert( index
, (args
[0],args
[0] ), 0)
12131 else: # otherwise stay compatible with old InsertSpacer
12132 return self
.Insert(index
, *args
, **kw
)
12135 def AddStretchSpacer(self
, prop
=1):
12136 """AddStretchSpacer(int prop=1) --> SizerItem
12138 Add a stretchable spacer."""
12139 return self
.Add((0,0), prop
)
12140 def PrependStretchSpacer(self
, prop
=1):
12141 """PrependStretchSpacer(int prop=1) --> SizerItem
12143 Prepend a stretchable spacer."""
12144 return self
.Prepend((0,0), prop
)
12145 def InsertStretchSpacer(self
, index
, prop
=1):
12146 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12148 Insert a stretchable spacer."""
12149 return self
.Insert(index
, (0,0), prop
)
12152 # for backwards compatibility only, please do not use in new code
12153 def AddWindow(self
, *args
, **kw
):
12154 """Compatibility alias for `Add`."""
12155 return self
.Add(*args
, **kw
)
12156 def AddSizer(self
, *args
, **kw
):
12157 """Compatibility alias for `Add`."""
12158 return self
.Add(*args
, **kw
)
12160 def PrependWindow(self
, *args
, **kw
):
12161 """Compatibility alias for `Prepend`."""
12162 return self
.Prepend(*args
, **kw
)
12163 def PrependSizer(self
, *args
, **kw
):
12164 """Compatibility alias for `Prepend`."""
12165 return self
.Prepend(*args
, **kw
)
12167 def InsertWindow(self
, *args
, **kw
):
12168 """Compatibility alias for `Insert`."""
12169 return self
.Insert(*args
, **kw
)
12170 def InsertSizer(self
, *args
, **kw
):
12171 """Compatibility alias for `Insert`."""
12172 return self
.Insert(*args
, **kw
)
12174 def RemoveWindow(self
, *args
, **kw
):
12175 """Compatibility alias for `Remove`."""
12176 return self
.Remove(*args
, **kw
)
12177 def RemoveSizer(self
, *args
, **kw
):
12178 """Compatibility alias for `Remove`."""
12179 return self
.Remove(*args
, **kw
)
12180 def RemovePos(self
, *args
, **kw
):
12181 """Compatibility alias for `Remove`."""
12182 return self
.Remove(*args
, **kw
)
12185 def SetDimension(*args
, **kwargs
):
12187 SetDimension(self, int x, int y, int width, int height)
12189 Call this to force the sizer to take the given dimension and thus
12190 force the items owned by the sizer to resize themselves according to
12191 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12194 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
12196 def SetMinSize(*args
, **kwargs
):
12198 SetMinSize(self, Size size)
12200 Call this to give the sizer a minimal size. Normally, the sizer will
12201 calculate its minimal size based purely on how much space its children
12202 need. After calling this method `GetMinSize` will return either the
12203 minimal size as requested by its children or the minimal size set
12204 here, depending on which is bigger.
12206 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
12208 def GetSize(*args
, **kwargs
):
12210 GetSize(self) -> Size
12212 Returns the current size of the space managed by the sizer.
12214 return _core_
.Sizer_GetSize(*args
, **kwargs
)
12216 def GetPosition(*args
, **kwargs
):
12218 GetPosition(self) -> Point
12220 Returns the current position of the sizer's managed space.
12222 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
12224 def GetMinSize(*args
, **kwargs
):
12226 GetMinSize(self) -> Size
12228 Returns the minimal size of the sizer. This is either the combined
12229 minimal size of all the children and their borders or the minimal size
12230 set by SetMinSize, depending on which is bigger.
12232 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
12234 def GetSizeTuple(self
):
12235 return self
.GetSize().Get()
12236 def GetPositionTuple(self
):
12237 return self
.GetPosition().Get()
12238 def GetMinSizeTuple(self
):
12239 return self
.GetMinSize().Get()
12241 def RecalcSizes(*args
, **kwargs
):
12245 Using the sizes calculated by `CalcMin` reposition and resize all the
12246 items managed by this sizer. You should not need to call this directly as
12247 it is called by `Layout`.
12249 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
12251 def CalcMin(*args
, **kwargs
):
12253 CalcMin(self) -> Size
12255 This method is where the sizer will do the actual calculation of its
12256 children's minimal sizes. You should not need to call this directly as
12257 it is called by `Layout`.
12259 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
12261 def Layout(*args
, **kwargs
):
12265 This method will force the recalculation and layout of the items
12266 controlled by the sizer using the current space allocated to the
12267 sizer. Normally this is called automatically from the owning window's
12268 EVT_SIZE handler, but it is also useful to call it from user code when
12269 one of the items in a sizer change size, or items are added or
12272 return _core_
.Sizer_Layout(*args
, **kwargs
)
12274 def Fit(*args
, **kwargs
):
12276 Fit(self, Window window) -> Size
12278 Tell the sizer to resize the *window* to match the sizer's minimal
12279 size. This is commonly done in the constructor of the window itself in
12280 order to set its initial size to match the needs of the children as
12281 determined by the sizer. Returns the new size.
12283 For a top level window this is the total window size, not the client size.
12285 return _core_
.Sizer_Fit(*args
, **kwargs
)
12287 def FitInside(*args
, **kwargs
):
12289 FitInside(self, Window window)
12291 Tell the sizer to resize the *virtual size* of the *window* to match the
12292 sizer's minimal size. This will not alter the on screen size of the
12293 window, but may cause the addition/removal/alteration of scrollbars
12294 required to view the virtual area in windows which manage it.
12296 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12299 return _core_
.Sizer_FitInside(*args
, **kwargs
)
12301 def SetSizeHints(*args
, **kwargs
):
12303 SetSizeHints(self, Window window)
12305 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12306 match the sizer's minimal size. This is commonly done in the
12307 constructor of the window itself if the window is resizable (as are
12308 many dialogs under Unix and frames on probably all platforms) in order
12309 to prevent the window from being sized smaller than the minimal size
12310 required by the sizer.
12312 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
12314 def SetVirtualSizeHints(*args
, **kwargs
):
12316 SetVirtualSizeHints(self, Window window)
12318 Tell the sizer to set the minimal size of the window virtual area to
12319 match the sizer's minimal size. For windows with managed scrollbars
12320 this will set them appropriately.
12322 :see: `wx.ScrolledWindow.SetScrollbars`
12325 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
12327 def Clear(*args
, **kwargs
):
12329 Clear(self, bool deleteWindows=False)
12331 Clear all items from the sizer, optionally destroying the window items
12334 return _core_
.Sizer_Clear(*args
, **kwargs
)
12336 def DeleteWindows(*args
, **kwargs
):
12338 DeleteWindows(self)
12340 Destroy all windows managed by the sizer.
12342 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
12344 def GetChildren(*args
, **kwargs
):
12346 GetChildren(self) -> list
12348 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12350 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12352 def Show(*args
, **kwargs
):
12354 Show(self, item, bool show=True, bool recursive=false) -> bool
12356 Shows or hides an item managed by the sizer. To make a sizer item
12357 disappear or reappear, use Show followed by `Layout`. The *item*
12358 parameter can be either a window, a sizer, or the zero-based index of
12359 the item. Use the recursive parameter to show or hide an item in a
12360 subsizer. Returns True if the item was found.
12362 return _core_
.Sizer_Show(*args
, **kwargs
)
12364 def IsShown(*args
, **kwargs
):
12366 IsShown(self, item)
12368 Determines if the item is currently shown. To make a sizer
12369 item disappear or reappear, use Show followed by `Layout`. The *item*
12370 parameter can be either a window, a sizer, or the zero-based index of
12373 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12375 def Hide(self
, item
, recursive
=False):
12377 A convenience method for `Show` (item, False, recursive).
12379 return self
.Show(item
, False, recursive
)
12381 def ShowItems(*args
, **kwargs
):
12383 ShowItems(self, bool show)
12385 Recursively call `wx.SizerItem.Show` on all sizer items.
12387 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12389 Children
= property(GetChildren
,doc
="See `GetChildren`")
12390 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12391 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12392 Position
= property(GetPosition
,doc
="See `GetPosition`")
12393 Size
= property(GetSize
,doc
="See `GetSize`")
12394 _core_
.Sizer_swigregister(Sizer
)
12396 class PySizer(Sizer
):
12398 wx.PySizer is a special version of `wx.Sizer` that has been
12399 instrumented to allow the C++ virtual methods to be overloaded in
12400 Python derived classes. You would derive from this class if you are
12401 wanting to implement a custom sizer in Python code. Simply implement
12402 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12405 class MySizer(wx.PySizer):
12406 def __init__(self):
12407 wx.PySizer.__init__(self)
12410 for item in self.GetChildren():
12411 # calculate the total minimum width and height needed
12412 # by all items in the sizer according to this sizer's
12413 # layout algorithm.
12415 return wx.Size(width, height)
12417 def RecalcSizes(self):
12418 # find the space allotted to this sizer
12419 pos = self.GetPosition()
12420 size = self.GetSize()
12421 for item in self.GetChildren():
12422 # Recalculate (if necessary) the position and size of
12423 # each item and then call item.SetDimension to do the
12424 # actual positioning and sizing of the items within the
12425 # space alloted to this sizer.
12427 item.SetDimension(itemPos, itemSize)
12430 When `Layout` is called it first calls `CalcMin` followed by
12431 `RecalcSizes` so you can optimize a bit by saving the results of
12432 `CalcMin` and reusing them in `RecalcSizes`.
12434 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12438 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12439 __repr__
= _swig_repr
12440 def __init__(self
, *args
, **kwargs
):
12442 __init__(self) -> PySizer
12444 Creates a wx.PySizer. Must be called from the __init__ in the derived
12447 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12448 self
._setOORInfo
(self
);PySizer
._setCallbackInfo
(self
, self
, PySizer
)
12450 def _setCallbackInfo(*args
, **kwargs
):
12451 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12452 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12454 _core_
.PySizer_swigregister(PySizer
)
12456 #---------------------------------------------------------------------------
12458 class BoxSizer(Sizer
):
12460 The basic idea behind a box sizer is that windows will most often be
12461 laid out in rather simple basic geometry, typically in a row or a
12462 column or nested hierarchies of either. A wx.BoxSizer will lay out
12463 its items in a simple row or column, depending on the orientation
12464 parameter passed to the constructor.
12466 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12467 __repr__
= _swig_repr
12468 def __init__(self
, *args
, **kwargs
):
12470 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12472 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12473 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12476 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12477 self
._setOORInfo
(self
)
12479 def GetOrientation(*args
, **kwargs
):
12481 GetOrientation(self) -> int
12483 Returns the current orientation of the sizer.
12485 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12487 def SetOrientation(*args
, **kwargs
):
12489 SetOrientation(self, int orient)
12491 Resets the orientation of the sizer.
12493 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12495 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12496 _core_
.BoxSizer_swigregister(BoxSizer
)
12498 #---------------------------------------------------------------------------
12500 class StaticBoxSizer(BoxSizer
):
12502 wx.StaticBoxSizer derives from and functions identically to the
12503 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12504 manages. Note that this static box must be created separately and
12505 passed to the sizer constructor.
12507 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12508 __repr__
= _swig_repr
12509 def __init__(self
, *args
, **kwargs
):
12511 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12513 Constructor. It takes an associated static box and the orientation
12514 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12517 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12518 self
._setOORInfo
(self
)
12520 def GetStaticBox(*args
, **kwargs
):
12522 GetStaticBox(self) -> StaticBox
12524 Returns the static box associated with this sizer.
12526 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12528 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12529 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12531 #---------------------------------------------------------------------------
12533 class GridSizer(Sizer
):
12535 A grid sizer is a sizer which lays out its children in a
12536 two-dimensional table with all cells having the same size. In other
12537 words, the width of each cell within the grid is the width of the
12538 widest item added to the sizer and the height of each grid cell is the
12539 height of the tallest item. An optional vertical and/or horizontal
12540 gap between items can also be specified (in pixels.)
12542 Items are placed in the cells of the grid in the order they are added,
12543 in row-major order. In other words, the first row is filled first,
12544 then the second, and so on until all items have been added. (If
12545 neccessary, additional rows will be added as items are added.) If you
12546 need to have greater control over the cells that items are placed in
12547 then use the `wx.GridBagSizer`.
12550 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12551 __repr__
= _swig_repr
12552 def __init__(self
, *args
, **kwargs
):
12554 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12556 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12557 of columns and rows in the sizer - if either of the parameters is
12558 zero, it will be calculated to from the total number of children in
12559 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12560 define extra space between all children.
12562 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12563 self
._setOORInfo
(self
)
12565 def SetCols(*args
, **kwargs
):
12567 SetCols(self, int cols)
12569 Sets the number of columns in the sizer.
12571 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12573 def SetRows(*args
, **kwargs
):
12575 SetRows(self, int rows)
12577 Sets the number of rows in the sizer.
12579 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12581 def SetVGap(*args
, **kwargs
):
12583 SetVGap(self, int gap)
12585 Sets the vertical gap (in pixels) between the cells in the sizer.
12587 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12589 def SetHGap(*args
, **kwargs
):
12591 SetHGap(self, int gap)
12593 Sets the horizontal gap (in pixels) between cells in the sizer
12595 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12597 def GetCols(*args
, **kwargs
):
12599 GetCols(self) -> int
12601 Returns the number of columns in the sizer.
12603 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12605 def GetRows(*args
, **kwargs
):
12607 GetRows(self) -> int
12609 Returns the number of rows in the sizer.
12611 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12613 def GetVGap(*args
, **kwargs
):
12615 GetVGap(self) -> int
12617 Returns the vertical gap (in pixels) between the cells in the sizer.
12619 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12621 def GetHGap(*args
, **kwargs
):
12623 GetHGap(self) -> int
12625 Returns the horizontal gap (in pixels) between cells in the sizer.
12627 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12629 def CalcRowsCols(self
):
12631 CalcRowsCols() -> (rows, cols)
12633 Calculates how many rows and columns will be in the sizer based
12634 on the current number of items and also the rows, cols specified
12635 in the constructor.
12637 nitems
= len(self
.GetChildren())
12638 rows
= self
.GetRows()
12639 cols
= self
.GetCols()
12640 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12642 rows
= (nitems
+ cols
- 1) / cols
12644 cols
= (nitems
+ rows
- 1) / rows
12645 return (rows
, cols
)
12647 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12648 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12649 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12650 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12651 _core_
.GridSizer_swigregister(GridSizer
)
12653 #---------------------------------------------------------------------------
12655 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12656 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12657 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12658 class FlexGridSizer(GridSizer
):
12660 A flex grid sizer is a sizer which lays out its children in a
12661 two-dimensional table with all table cells in one row having the same
12662 height and all cells in one column having the same width, but all
12663 rows or all columns are not necessarily the same height or width as in
12664 the `wx.GridSizer`.
12666 wx.FlexGridSizer can also size items equally in one direction but
12667 unequally ("flexibly") in the other. If the sizer is only flexible
12668 in one direction (this can be changed using `SetFlexibleDirection`), it
12669 needs to be decided how the sizer should grow in the other ("non
12670 flexible") direction in order to fill the available space. The
12671 `SetNonFlexibleGrowMode` method serves this purpose.
12675 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12676 __repr__
= _swig_repr
12677 def __init__(self
, *args
, **kwargs
):
12679 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12681 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12682 number of columns and rows in the sizer - if either of the parameters
12683 is zero, it will be calculated to from the total number of children in
12684 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12685 define extra space between all children.
12687 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12688 self
._setOORInfo
(self
)
12690 def AddGrowableRow(*args
, **kwargs
):
12692 AddGrowableRow(self, size_t idx, int proportion=0)
12694 Specifies that row *idx* (starting from zero) should be grown if there
12695 is extra space available to the sizer.
12697 The *proportion* parameter has the same meaning as the stretch factor
12698 for the box sizers except that if all proportions are 0, then all
12699 columns are resized equally (instead of not being resized at all).
12701 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12703 def RemoveGrowableRow(*args
, **kwargs
):
12705 RemoveGrowableRow(self, size_t idx)
12707 Specifies that row *idx* is no longer growable.
12709 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12711 def AddGrowableCol(*args
, **kwargs
):
12713 AddGrowableCol(self, size_t idx, int proportion=0)
12715 Specifies that column *idx* (starting from zero) should be grown if
12716 there is extra space available to the sizer.
12718 The *proportion* parameter has the same meaning as the stretch factor
12719 for the box sizers except that if all proportions are 0, then all
12720 columns are resized equally (instead of not being resized at all).
12722 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12724 def RemoveGrowableCol(*args
, **kwargs
):
12726 RemoveGrowableCol(self, size_t idx)
12728 Specifies that column *idx* is no longer growable.
12730 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12732 def SetFlexibleDirection(*args
, **kwargs
):
12734 SetFlexibleDirection(self, int direction)
12736 Specifies whether the sizer should flexibly resize its columns, rows,
12737 or both. Argument *direction* can be one of the following values. Any
12738 other value is ignored.
12740 ============== =======================================
12741 wx.VERTICAL Rows are flexibly sized.
12742 wx.HORIZONTAL Columns are flexibly sized.
12743 wx.BOTH Both rows and columns are flexibly sized
12744 (this is the default value).
12745 ============== =======================================
12747 Note that this method does not trigger relayout.
12750 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12752 def GetFlexibleDirection(*args
, **kwargs
):
12754 GetFlexibleDirection(self) -> int
12756 Returns a value that specifies whether the sizer
12757 flexibly resizes its columns, rows, or both (default).
12759 :see: `SetFlexibleDirection`
12761 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12763 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12765 SetNonFlexibleGrowMode(self, int mode)
12767 Specifies how the sizer should grow in the non-flexible direction if
12768 there is one (so `SetFlexibleDirection` must have been called
12769 previously). Argument *mode* can be one of the following values:
12771 ========================== =================================================
12772 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12773 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12774 `AddGrowableCol` and `AddGrowableRow`. In this
12775 case equal sizing applies to minimum sizes of
12776 columns or rows (this is the default value).
12777 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12778 the non flexible direction, whether they are
12779 growable or not in the flexbile direction.
12780 ========================== =================================================
12782 Note that this method does not trigger relayout.
12784 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12786 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12788 GetNonFlexibleGrowMode(self) -> int
12790 Returns the value that specifies how the sizer grows in the
12791 non-flexible direction if there is one.
12793 :see: `SetNonFlexibleGrowMode`
12795 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12797 def GetRowHeights(*args
, **kwargs
):
12799 GetRowHeights(self) -> list
12801 Returns a list of integers representing the heights of each of the
12804 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12806 def GetColWidths(*args
, **kwargs
):
12808 GetColWidths(self) -> list
12810 Returns a list of integers representing the widths of each of the
12811 columns in the sizer.
12813 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12815 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12816 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12817 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12818 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12819 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12821 class StdDialogButtonSizer(BoxSizer
):
12823 A special sizer that knows how to order and position standard buttons
12824 in order to conform to the current platform's standards. You simply
12825 need to add each `wx.Button` to the sizer, and be sure to create the
12826 buttons using the standard ID's. Then call `Realize` and the sizer
12827 will take care of the rest.
12830 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12831 __repr__
= _swig_repr
12832 def __init__(self
, *args
, **kwargs
):
12833 """__init__(self) -> StdDialogButtonSizer"""
12834 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12835 def AddButton(*args
, **kwargs
):
12837 AddButton(self, wxButton button)
12839 Use this to add the buttons to this sizer. Do not use the `Add`
12840 method in the base class.
12842 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12844 def Realize(*args
, **kwargs
):
12848 This funciton needs to be called after all the buttons have been added
12849 to the sizer. It will reorder them and position them in a platform
12852 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12854 def SetAffirmativeButton(*args
, **kwargs
):
12855 """SetAffirmativeButton(self, wxButton button)"""
12856 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12858 def SetNegativeButton(*args
, **kwargs
):
12859 """SetNegativeButton(self, wxButton button)"""
12860 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12862 def SetCancelButton(*args
, **kwargs
):
12863 """SetCancelButton(self, wxButton button)"""
12864 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12866 def GetAffirmativeButton(*args
, **kwargs
):
12867 """GetAffirmativeButton(self) -> wxButton"""
12868 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12870 def GetApplyButton(*args
, **kwargs
):
12871 """GetApplyButton(self) -> wxButton"""
12872 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12874 def GetNegativeButton(*args
, **kwargs
):
12875 """GetNegativeButton(self) -> wxButton"""
12876 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12878 def GetCancelButton(*args
, **kwargs
):
12879 """GetCancelButton(self) -> wxButton"""
12880 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12882 def GetHelpButton(*args
, **kwargs
):
12883 """GetHelpButton(self) -> wxButton"""
12884 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12886 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12887 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12888 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12889 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12890 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12891 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12893 #---------------------------------------------------------------------------
12895 class GBPosition(object):
12897 This class represents the position of an item in a virtual grid of
12898 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12899 typemaps that will automatically convert from a 2-element sequence of
12900 integers to a wx.GBPosition, so you can use the more pythonic
12901 representation of the position nearly transparently in Python code.
12903 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12904 __repr__
= _swig_repr
12905 def __init__(self
, *args
, **kwargs
):
12907 __init__(self, int row=0, int col=0) -> GBPosition
12909 This class represents the position of an item in a virtual grid of
12910 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12911 typemaps that will automatically convert from a 2-element sequence of
12912 integers to a wx.GBPosition, so you can use the more pythonic
12913 representation of the position nearly transparently in Python code.
12915 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12916 __swig_destroy__
= _core_
.delete_GBPosition
12917 __del__
= lambda self
: None;
12918 def GetRow(*args
, **kwargs
):
12919 """GetRow(self) -> int"""
12920 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12922 def GetCol(*args
, **kwargs
):
12923 """GetCol(self) -> int"""
12924 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12926 def SetRow(*args
, **kwargs
):
12927 """SetRow(self, int row)"""
12928 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12930 def SetCol(*args
, **kwargs
):
12931 """SetCol(self, int col)"""
12932 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12934 def __eq__(*args
, **kwargs
):
12936 __eq__(self, PyObject other) -> bool
12938 Compare GBPosition for equality.
12940 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12942 def __ne__(*args
, **kwargs
):
12944 __ne__(self, PyObject other) -> bool
12946 Compare GBPosition for inequality.
12948 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12950 def Set(*args
, **kwargs
):
12951 """Set(self, int row=0, int col=0)"""
12952 return _core_
.GBPosition_Set(*args
, **kwargs
)
12954 def Get(*args
, **kwargs
):
12955 """Get(self) -> PyObject"""
12956 return _core_
.GBPosition_Get(*args
, **kwargs
)
12958 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12959 def __str__(self
): return str(self
.Get())
12960 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12961 def __len__(self
): return len(self
.Get())
12962 def __getitem__(self
, index
): return self
.Get()[index
]
12963 def __setitem__(self
, index
, val
):
12964 if index
== 0: self
.SetRow(val
)
12965 elif index
== 1: self
.SetCol(val
)
12966 else: raise IndexError
12967 def __nonzero__(self
): return self
.Get() != (0,0)
12968 __safe_for_unpickling__
= True
12969 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12971 row
= property(GetRow
, SetRow
)
12972 col
= property(GetCol
, SetCol
)
12974 _core_
.GBPosition_swigregister(GBPosition
)
12976 class GBSpan(object):
12978 This class is used to hold the row and column spanning attributes of
12979 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12980 automatically convert from a 2-element sequence of integers to a
12981 wx.GBSpan, so you can use the more pythonic representation of the span
12982 nearly transparently in Python code.
12985 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12986 __repr__
= _swig_repr
12987 def __init__(self
, *args
, **kwargs
):
12989 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12991 Construct a new wxGBSpan, optionally setting the rowspan and
12992 colspan. The default is (1,1). (Meaning that the item occupies one
12993 cell in each direction.
12995 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12996 __swig_destroy__
= _core_
.delete_GBSpan
12997 __del__
= lambda self
: None;
12998 def GetRowspan(*args
, **kwargs
):
12999 """GetRowspan(self) -> int"""
13000 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
13002 def GetColspan(*args
, **kwargs
):
13003 """GetColspan(self) -> int"""
13004 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
13006 def SetRowspan(*args
, **kwargs
):
13007 """SetRowspan(self, int rowspan)"""
13008 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
13010 def SetColspan(*args
, **kwargs
):
13011 """SetColspan(self, int colspan)"""
13012 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
13014 def __eq__(*args
, **kwargs
):
13016 __eq__(self, PyObject other) -> bool
13018 Compare wxGBSpan for equality.
13020 return _core_
.GBSpan___eq__(*args
, **kwargs
)
13022 def __ne__(*args
, **kwargs
):
13024 __ne__(self, PyObject other) -> bool
13026 Compare GBSpan for inequality.
13028 return _core_
.GBSpan___ne__(*args
, **kwargs
)
13030 def Set(*args
, **kwargs
):
13031 """Set(self, int rowspan=1, int colspan=1)"""
13032 return _core_
.GBSpan_Set(*args
, **kwargs
)
13034 def Get(*args
, **kwargs
):
13035 """Get(self) -> PyObject"""
13036 return _core_
.GBSpan_Get(*args
, **kwargs
)
13038 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
13039 def __str__(self
): return str(self
.Get())
13040 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
13041 def __len__(self
): return len(self
.Get())
13042 def __getitem__(self
, index
): return self
.Get()[index
]
13043 def __setitem__(self
, index
, val
):
13044 if index
== 0: self
.SetRowspan(val
)
13045 elif index
== 1: self
.SetColspan(val
)
13046 else: raise IndexError
13047 def __nonzero__(self
): return self
.Get() != (0,0)
13048 __safe_for_unpickling__
= True
13049 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
13051 rowspan
= property(GetRowspan
, SetRowspan
)
13052 colspan
= property(GetColspan
, SetColspan
)
13054 _core_
.GBSpan_swigregister(GBSpan
)
13056 class GBSizerItem(SizerItem
):
13058 The wx.GBSizerItem class is used to track the additional data about
13059 items in a `wx.GridBagSizer` such as the item's position in the grid
13060 and how many rows or columns it spans.
13063 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13064 __repr__
= _swig_repr
13065 def __init__(self
, *args
, **kwargs
):
13067 __init__(self) -> GBSizerItem
13069 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13070 size will need to be set, as well as a position and span before this
13071 item can be used in a Sizer.
13073 You will probably never need to create a wx.GBSizerItem directly as they
13074 are created automatically when the sizer's Add method is called.
13076 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
13077 __swig_destroy__
= _core_
.delete_GBSizerItem
13078 __del__
= lambda self
: None;
13079 def GetPos(*args
, **kwargs
):
13081 GetPos(self) -> GBPosition
13083 Get the grid position of the item
13085 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
13087 def GetPosTuple(self
): return self
.GetPos().Get()
13088 def GetSpan(*args
, **kwargs
):
13090 GetSpan(self) -> GBSpan
13092 Get the row and column spanning of the item
13094 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
13096 def GetSpanTuple(self
): return self
.GetSpan().Get()
13097 def SetPos(*args
, **kwargs
):
13099 SetPos(self, GBPosition pos) -> bool
13101 If the item is already a member of a sizer then first ensure that
13102 there is no other item that would intersect with this one at the new
13103 position, then set the new position. Returns True if the change is
13104 successful and after the next Layout() the item will be moved.
13106 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
13108 def SetSpan(*args
, **kwargs
):
13110 SetSpan(self, GBSpan span) -> bool
13112 If the item is already a member of a sizer then first ensure that
13113 there is no other item that would intersect with this one with its new
13114 spanning size, then set the new spanning. Returns True if the change
13115 is successful and after the next Layout() the item will be resized.
13118 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
13120 def Intersects(*args
, **kwargs
):
13122 Intersects(self, GBSizerItem other) -> bool
13124 Returns True if this item and the other item instersect.
13126 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
13128 def IntersectsPos(*args
, **kwargs
):
13130 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13132 Returns True if the given pos/span would intersect with this item.
13134 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
13136 def GetEndPos(*args
, **kwargs
):
13138 GetEndPos(self) -> GBPosition
13140 Get the row and column of the endpoint of this item.
13142 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
13144 def GetGBSizer(*args
, **kwargs
):
13146 GetGBSizer(self) -> GridBagSizer
13148 Get the sizer this item is a member of.
13150 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
13152 def SetGBSizer(*args
, **kwargs
):
13154 SetGBSizer(self, GridBagSizer sizer)
13156 Set the sizer this item is a member of.
13158 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
13160 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
13161 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
13162 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
13163 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
13164 _core_
.GBSizerItem_swigregister(GBSizerItem
)
13165 DefaultSpan
= cvar
.DefaultSpan
13167 def GBSizerItemWindow(*args
, **kwargs
):
13169 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13170 int border, PyObject userData=None) -> GBSizerItem
13172 Construct a `wx.GBSizerItem` for a window.
13174 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
13177 def GBSizerItemSizer(*args
, **kwargs
):
13179 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13180 int border, PyObject userData=None) -> GBSizerItem
13182 Construct a `wx.GBSizerItem` for a sizer
13184 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
13187 def GBSizerItemSpacer(*args
, **kwargs
):
13189 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13190 int flag, int border, PyObject userData=None) -> GBSizerItem
13192 Construct a `wx.GBSizerItem` for a spacer.
13194 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
13197 class GridBagSizer(FlexGridSizer
):
13199 A `wx.Sizer` that can lay out items in a virtual grid like a
13200 `wx.FlexGridSizer` but in this case explicit positioning of the items
13201 is allowed using `wx.GBPosition`, and items can optionally span more
13202 than one row and/or column using `wx.GBSpan`. The total size of the
13203 virtual grid is determined by the largest row and column that items are
13204 positioned at, adjusted for spanning.
13207 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13208 __repr__
= _swig_repr
13209 def __init__(self
, *args
, **kwargs
):
13211 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13213 Constructor, with optional parameters to specify the gap between the
13216 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
13217 self
._setOORInfo
(self
)
13219 def Add(*args
, **kwargs
):
13221 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13222 int border=0, userData=None) -> wx.GBSizerItem
13224 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13225 more than one row or column as specified with *span*. The remaining
13226 args behave similarly to `wx.Sizer.Add`.
13228 Returns True if the item was successfully placed at the given cell
13229 position, False if something was already there.
13232 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
13234 def AddItem(*args
, **kwargs
):
13236 Add(self, GBSizerItem item) -> wx.GBSizerItem
13238 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13239 the item was successfully placed at its given cell position, False if
13240 something was already there.
13242 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
13244 def GetCellSize(*args
, **kwargs
):
13246 GetCellSize(self, int row, int col) -> Size
13248 Get the size of the specified cell, including hgap and
13249 vgap. Only valid after a Layout.
13251 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
13253 def GetEmptyCellSize(*args
, **kwargs
):
13255 GetEmptyCellSize(self) -> Size
13257 Get the size used for cells in the grid with no item.
13259 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
13261 def SetEmptyCellSize(*args
, **kwargs
):
13263 SetEmptyCellSize(self, Size sz)
13265 Set the size used for cells in the grid with no item.
13267 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
13269 def GetItemPosition(*args
):
13271 GetItemPosition(self, item) -> GBPosition
13273 Get the grid position of the specified *item* where *item* is either a
13274 window or subsizer that is a member of this sizer, or a zero-based
13277 return _core_
.GridBagSizer_GetItemPosition(*args
)
13279 def SetItemPosition(*args
):
13281 SetItemPosition(self, item, GBPosition pos) -> bool
13283 Set the grid position of the specified *item* where *item* is either a
13284 window or subsizer that is a member of this sizer, or a zero-based
13285 index of an item. Returns True on success. If the move is not
13286 allowed (because an item is already there) then False is returned.
13289 return _core_
.GridBagSizer_SetItemPosition(*args
)
13291 def GetItemSpan(*args
):
13293 GetItemSpan(self, item) -> GBSpan
13295 Get the row/col spanning of the specified *item* where *item* is
13296 either a window or subsizer that is a member of this sizer, or a
13297 zero-based index of an item.
13299 return _core_
.GridBagSizer_GetItemSpan(*args
)
13301 def SetItemSpan(*args
):
13303 SetItemSpan(self, item, GBSpan span) -> bool
13305 Set the row/col spanning of the specified *item* where *item* is
13306 either a window or subsizer that is a member of this sizer, or a
13307 zero-based index of an item. Returns True on success. If the move is
13308 not allowed (because an item is already there) then False is returned.
13310 return _core_
.GridBagSizer_SetItemSpan(*args
)
13312 def FindItem(*args
):
13314 FindItem(self, item) -> GBSizerItem
13316 Find the sizer item for the given window or subsizer, returns None if
13317 not found. (non-recursive)
13319 return _core_
.GridBagSizer_FindItem(*args
)
13321 def FindItemAtPosition(*args
, **kwargs
):
13323 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13325 Return the sizer item for the given grid cell, or None if there is no
13326 item at that position. (non-recursive)
13328 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
13330 def FindItemAtPoint(*args
, **kwargs
):
13332 FindItemAtPoint(self, Point pt) -> GBSizerItem
13334 Return the sizer item located at the point given in *pt*, or None if
13335 there is no item at that point. The (x,y) coordinates in pt correspond
13336 to the client coordinates of the window using the sizer for
13337 layout. (non-recursive)
13339 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
13341 def CheckForIntersection(*args
, **kwargs
):
13343 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13345 Look at all items and see if any intersect (or would overlap) the
13346 given *item*. Returns True if so, False if there would be no overlap.
13347 If an *excludeItem* is given then it will not be checked for
13348 intersection, for example it may be the item we are checking the
13352 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13354 def CheckForIntersectionPos(*args
, **kwargs
):
13356 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13358 Look at all items and see if any intersect (or would overlap) the
13359 given position and span. Returns True if so, False if there would be
13360 no overlap. If an *excludeItem* is given then it will not be checked
13361 for intersection, for example it may be the item we are checking the
13364 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13366 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13368 #---------------------------------------------------------------------------
13372 Right
= _core_
.Right
13373 Bottom
= _core_
.Bottom
13374 Width
= _core_
.Width
13375 Height
= _core_
.Height
13376 Centre
= _core_
.Centre
13377 Center
= _core_
.Center
13378 CentreX
= _core_
.CentreX
13379 CentreY
= _core_
.CentreY
13380 Unconstrained
= _core_
.Unconstrained
13382 PercentOf
= _core_
.PercentOf
13383 Above
= _core_
.Above
13384 Below
= _core_
.Below
13385 LeftOf
= _core_
.LeftOf
13386 RightOf
= _core_
.RightOf
13387 SameAs
= _core_
.SameAs
13388 Absolute
= _core_
.Absolute
13389 class IndividualLayoutConstraint(Object
):
13391 Objects of this class are stored in the `wx.LayoutConstraints` class as
13392 one of eight possible constraints that a window can be involved in.
13393 You will never need to create an instance of
13394 wx.IndividualLayoutConstraint, rather you should create a
13395 `wx.LayoutConstraints` instance and use the individual contstraints
13398 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13399 def __init__(self
): raise AttributeError, "No constructor defined"
13400 __repr__
= _swig_repr
13401 def Set(*args
, **kwargs
):
13403 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13405 Sets the properties of the constraint. Normally called by one of the
13406 convenience functions such as Above, RightOf, SameAs.
13408 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13410 def LeftOf(*args
, **kwargs
):
13412 LeftOf(self, Window sibling, int marg=0)
13414 Constrains this edge to be to the left of the given window, with an
13415 optional margin. Implicitly, this is relative to the left edge of the
13418 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13420 def RightOf(*args
, **kwargs
):
13422 RightOf(self, Window sibling, int marg=0)
13424 Constrains this edge to be to the right of the given window, with an
13425 optional margin. Implicitly, this is relative to the right edge of the
13428 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13430 def Above(*args
, **kwargs
):
13432 Above(self, Window sibling, int marg=0)
13434 Constrains this edge to be above the given window, with an optional
13435 margin. Implicitly, this is relative to the top edge of the other
13438 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13440 def Below(*args
, **kwargs
):
13442 Below(self, Window sibling, int marg=0)
13444 Constrains this edge to be below the given window, with an optional
13445 margin. Implicitly, this is relative to the bottom edge of the other
13448 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13450 def SameAs(*args
, **kwargs
):
13452 SameAs(self, Window otherW, int edge, int marg=0)
13454 Constrains this edge or dimension to be to the same as the edge of the
13455 given window, with an optional margin.
13457 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13459 def PercentOf(*args
, **kwargs
):
13461 PercentOf(self, Window otherW, int wh, int per)
13463 Constrains this edge or dimension to be to a percentage of the given
13464 window, with an optional margin.
13466 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13468 def Absolute(*args
, **kwargs
):
13470 Absolute(self, int val)
13472 Constrains this edge or dimension to be the given absolute value.
13474 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13476 def Unconstrained(*args
, **kwargs
):
13478 Unconstrained(self)
13480 Sets this edge or dimension to be unconstrained, that is, dependent on
13481 other edges and dimensions from which this value can be deduced.
13483 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13485 def AsIs(*args
, **kwargs
):
13489 Sets this edge or constraint to be whatever the window's value is at
13490 the moment. If either of the width and height constraints are *as is*,
13491 the window will not be resized, but moved instead. This is important
13492 when considering panel items which are intended to have a default
13493 size, such as a button, which may take its size from the size of the
13496 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13498 def GetOtherWindow(*args
, **kwargs
):
13499 """GetOtherWindow(self) -> Window"""
13500 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13502 def GetMyEdge(*args
, **kwargs
):
13503 """GetMyEdge(self) -> int"""
13504 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13506 def SetEdge(*args
, **kwargs
):
13507 """SetEdge(self, int which)"""
13508 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13510 def SetValue(*args
, **kwargs
):
13511 """SetValue(self, int v)"""
13512 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13514 def GetMargin(*args
, **kwargs
):
13515 """GetMargin(self) -> int"""
13516 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13518 def SetMargin(*args
, **kwargs
):
13519 """SetMargin(self, int m)"""
13520 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13522 def GetValue(*args
, **kwargs
):
13523 """GetValue(self) -> int"""
13524 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13526 def GetPercent(*args
, **kwargs
):
13527 """GetPercent(self) -> int"""
13528 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13530 def GetOtherEdge(*args
, **kwargs
):
13531 """GetOtherEdge(self) -> int"""
13532 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13534 def GetDone(*args
, **kwargs
):
13535 """GetDone(self) -> bool"""
13536 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13538 def SetDone(*args
, **kwargs
):
13539 """SetDone(self, bool d)"""
13540 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13542 def GetRelationship(*args
, **kwargs
):
13543 """GetRelationship(self) -> int"""
13544 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13546 def SetRelationship(*args
, **kwargs
):
13547 """SetRelationship(self, int r)"""
13548 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13550 def ResetIfWin(*args
, **kwargs
):
13552 ResetIfWin(self, Window otherW) -> bool
13554 Reset constraint if it mentions otherWin
13556 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13558 def SatisfyConstraint(*args
, **kwargs
):
13560 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13562 Try to satisfy constraint
13564 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13566 def GetEdge(*args
, **kwargs
):
13568 GetEdge(self, int which, Window thisWin, Window other) -> int
13570 Get the value of this edge or dimension, or if this
13571 is not determinable, -1.
13573 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13575 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13576 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13577 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13578 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13579 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13580 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13581 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13582 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13583 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13585 class LayoutConstraints(Object
):
13587 **Note:** constraints are now deprecated and you should use sizers
13590 Objects of this class can be associated with a window to define its
13591 layout constraints, with respect to siblings or its parent.
13593 The class consists of the following eight constraints of class
13594 wx.IndividualLayoutConstraint, some or all of which should be accessed
13595 directly to set the appropriate constraints.
13597 * left: represents the left hand edge of the window
13598 * right: represents the right hand edge of the window
13599 * top: represents the top edge of the window
13600 * bottom: represents the bottom edge of the window
13601 * width: represents the width of the window
13602 * height: represents the height of the window
13603 * centreX: represents the horizontal centre point of the window
13604 * centreY: represents the vertical centre point of the window
13606 Most constraints are initially set to have the relationship
13607 wxUnconstrained, which means that their values should be calculated by
13608 looking at known constraints. The exceptions are width and height,
13609 which are set to wxAsIs to ensure that if the user does not specify a
13610 constraint, the existing width and height will be used, to be
13611 compatible with panel items which often have take a default size. If
13612 the constraint is ``wx.AsIs``, the dimension will not be changed.
13614 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13617 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13618 __repr__
= _swig_repr
13619 left
= property(_core_
.LayoutConstraints_left_get
)
13620 top
= property(_core_
.LayoutConstraints_top_get
)
13621 right
= property(_core_
.LayoutConstraints_right_get
)
13622 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13623 width
= property(_core_
.LayoutConstraints_width_get
)
13624 height
= property(_core_
.LayoutConstraints_height_get
)
13625 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13626 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13627 def __init__(self
, *args
, **kwargs
):
13628 """__init__(self) -> LayoutConstraints"""
13629 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13630 __swig_destroy__
= _core_
.delete_LayoutConstraints
13631 __del__
= lambda self
: None;
13632 def SatisfyConstraints(*args
, **kwargs
):
13633 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13634 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13636 def AreSatisfied(*args
, **kwargs
):
13637 """AreSatisfied(self) -> bool"""
13638 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13640 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13642 #----------------------------------------------------------------------------
13644 # Use Python's bool constants if available, make some if not
13648 __builtins__
.True = 1==1
13649 __builtins__
.False = 1==0
13650 def bool(value
): return not not value
13651 __builtins__
.bool = bool
13655 # workarounds for bad wxRTTI names
13656 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13657 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13658 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13661 #----------------------------------------------------------------------------
13662 # Load version numbers from __version__... Ensure that major and minor
13663 # versions are the same for both wxPython and wxWidgets.
13665 from __version__
import *
13666 __version__
= VERSION_STRING
13668 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13669 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13670 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13672 warnings
.warn("wxPython/wxWidgets release number mismatch")
13676 """Returns a string containing version and port info"""
13677 ctype
= wx
.USE_UNICODE
and 'unicode' or 'ansi'
13678 if wx
.Platform
== '__WXMSW__':
13680 elif wx
.Platform
== '__WXMAC__':
13682 elif wx
.Platform
== '__WXGTK__':
13684 if 'gtk2' in wx
.PlatformInfo
:
13689 return "%s (%s-%s)" % (wx
.VERSION_STRING
, port
, ctype
)
13692 #----------------------------------------------------------------------------
13694 # Set wxPython's default string<-->unicode conversion encoding from
13695 # the locale, but only if Python's default hasn't been changed. (We
13696 # assume that if the user has customized it already then that is the
13697 # encoding we need to use as well.)
13699 # The encoding selected here is used when string or unicode objects
13700 # need to be converted in order to pass them to wxWidgets. Please be
13701 # aware that the default encoding within the same locale may be
13702 # slightly different on different platforms. For example, please see
13703 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13704 # between the common latin/roman encodings.
13706 default
= _sys
.getdefaultencoding()
13707 if default
== 'ascii':
13711 if hasattr(locale
, 'getpreferredencoding'):
13712 default
= locale
.getpreferredencoding()
13714 default
= locale
.getdefaultlocale()[1]
13715 codecs
.lookup(default
)
13716 except (ValueError, LookupError, TypeError):
13717 default
= _sys
.getdefaultencoding()
13721 wx
.SetDefaultPyEncoding(default
)
13724 #----------------------------------------------------------------------------
13726 class PyDeadObjectError(AttributeError):
13729 class _wxPyDeadObject(object):
13731 Instances of wx objects that are OOR capable will have their __class__
13732 changed to this class when the C++ object is deleted. This should help
13733 prevent crashes due to referencing a bogus C++ pointer.
13735 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13736 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13738 def __repr__(self
):
13739 if not hasattr(self
, "_name"):
13740 self
._name
= "[unknown]"
13741 return self
.reprStr
% self
._name
13743 def __getattr__(self
, *args
):
13744 if not hasattr(self
, "_name"):
13745 self
._name
= "[unknown]"
13746 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13748 def __nonzero__(self
):
13753 class PyUnbornObjectError(AttributeError):
13756 class _wxPyUnbornObject(object):
13758 Some stock objects are created when the wx._core module is
13759 imported, but their C++ instance is not created until the wx.App
13760 object is created and initialized. These object instances will
13761 temporarily have their __class__ changed to this class so an
13762 exception will be raised if they are used before the C++ instance
13766 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13767 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13769 def __repr__(self
):
13770 #if not hasattr(self, "_name"):
13771 # self._name = "[unknown]"
13772 return self
.reprStr
#% self._name
13774 def __getattr__(self
, *args
):
13775 #if not hasattr(self, "_name"):
13776 # self._name = "[unknown]"
13777 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13779 def __nonzero__(self
):
13783 #----------------------------------------------------------------------------
13785 def CallAfter(callable, *args
, **kw
):
13787 Call the specified function after the current and pending event
13788 handlers have been completed. This is also good for making GUI
13789 method calls from non-GUI threads. Any extra positional or
13790 keyword args are passed on to the callable when it is called.
13792 :see: `wx.CallLater`
13795 assert app
is not None, 'No wx.App created yet'
13797 if not hasattr(app
, "_CallAfterId"):
13798 app
._CallAfterId
= wx
.NewEventType()
13799 app
.Connect(-1, -1, app
._CallAfterId
,
13800 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13802 evt
.SetEventType(app
._CallAfterId
)
13803 evt
.callable = callable
13806 wx
.PostEvent(app
, evt
)
13808 #----------------------------------------------------------------------------
13813 A convenience class for `wx.Timer`, that calls the given callable
13814 object once after the given amount of milliseconds, passing any
13815 positional or keyword args. The return value of the callable is
13816 availbale after it has been run with the `GetResult` method.
13818 If you don't need to get the return value or restart the timer
13819 then there is no need to hold a reference to this object. It will
13820 hold a reference to itself while the timer is running (the timer
13821 has a reference to self.Notify) but the cycle will be broken when
13822 the timer completes, automatically cleaning up the wx.CallLater
13825 :see: `wx.CallAfter`
13827 def __init__(self
, millis
, callable, *args
, **kwargs
):
13828 self
.millis
= millis
13829 self
.callable = callable
13830 self
.SetArgs(*args
, **kwargs
)
13832 self
.running
= False
13833 self
.hasRun
= False
13842 def Start(self
, millis
=None, *args
, **kwargs
):
13844 (Re)start the timer
13846 self
.hasRun
= False
13847 if millis
is not None:
13848 self
.millis
= millis
13850 self
.SetArgs(*args
, **kwargs
)
13852 self
.timer
= wx
.PyTimer(self
.Notify
)
13853 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13854 self
.running
= True
13860 Stop and destroy the timer.
13862 if self
.timer
is not None:
13867 def GetInterval(self
):
13868 if self
.timer
is not None:
13869 return self
.timer
.GetInterval()
13874 def IsRunning(self
):
13875 return self
.timer
is not None and self
.timer
.IsRunning()
13878 def SetArgs(self
, *args
, **kwargs
):
13880 (Re)set the args passed to the callable object. This is
13881 useful in conjunction with Restart if you want to schedule a
13882 new call to the same callable object but with different
13886 self
.kwargs
= kwargs
13892 def GetResult(self
):
13897 The timer has expired so call the callable.
13899 if self
.callable and getattr(self
.callable, 'im_self', True):
13901 self
.running
= False
13902 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13904 if not self
.running
:
13905 # if it wasn't restarted, then cleanup
13906 wx
.CallAfter(self
.Stop
)
13908 Interval
= property(GetInterval
)
13909 Result
= property(GetResult
)
13912 class FutureCall(CallLater
):
13913 """A compatibility alias for `CallLater`."""
13915 #----------------------------------------------------------------------------
13916 # Control which items in this module should be documented by epydoc.
13917 # We allow only classes and functions, which will help reduce the size
13918 # of the docs by filtering out the zillions of constants, EVT objects,
13919 # and etc that don't make much sense by themselves, but are instead
13920 # documented (or will be) as part of the classes/functions/methods
13921 # where they should be used.
13925 A filter for epydoc that only allows non-Ptr classes and
13926 functions, in order to reduce the clutter in the API docs.
13928 def __init__(self
, globals):
13929 self
._globals
= globals
13931 def __call__(self
, name
):
13933 obj
= self
._globals
.get(name
, None)
13935 # only document classes and function
13936 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13939 # skip other things that are private or will be documented as part of somethign else
13940 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13943 # skip functions that are duplicates of static functions in a class
13944 if name
.find('_') != -1:
13945 cls
= self
._globals
.get(name
.split('_')[0], None)
13946 methname
= name
.split('_')[1]
13947 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13952 #----------------------------------------------------------------------------
13953 #----------------------------------------------------------------------------
13955 # Import other modules in this package that should show up in the
13956 # "core" wx namespace
13958 from _windows
import *
13959 from _controls
import *
13960 from _misc
import *
13962 #----------------------------------------------------------------------------
13963 #----------------------------------------------------------------------------