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 val
= _core_
.Object_Destroy(*args
, **kwargs
)
712 ClassName
= property(GetClassName
,doc
="See `GetClassName`")
713 _core_
.Object_swigregister(Object
)
714 _wxPySetDictionary
= _core_
._wxPySetDictionary
716 EmptyString
= cvar
.EmptyString
718 #---------------------------------------------------------------------------
720 BITMAP_TYPE_INVALID
= _core_
.BITMAP_TYPE_INVALID
721 BITMAP_TYPE_BMP
= _core_
.BITMAP_TYPE_BMP
722 BITMAP_TYPE_ICO
= _core_
.BITMAP_TYPE_ICO
723 BITMAP_TYPE_CUR
= _core_
.BITMAP_TYPE_CUR
724 BITMAP_TYPE_XBM
= _core_
.BITMAP_TYPE_XBM
725 BITMAP_TYPE_XBM_DATA
= _core_
.BITMAP_TYPE_XBM_DATA
726 BITMAP_TYPE_XPM
= _core_
.BITMAP_TYPE_XPM
727 BITMAP_TYPE_XPM_DATA
= _core_
.BITMAP_TYPE_XPM_DATA
728 BITMAP_TYPE_TIF
= _core_
.BITMAP_TYPE_TIF
729 BITMAP_TYPE_GIF
= _core_
.BITMAP_TYPE_GIF
730 BITMAP_TYPE_PNG
= _core_
.BITMAP_TYPE_PNG
731 BITMAP_TYPE_JPEG
= _core_
.BITMAP_TYPE_JPEG
732 BITMAP_TYPE_PNM
= _core_
.BITMAP_TYPE_PNM
733 BITMAP_TYPE_PCX
= _core_
.BITMAP_TYPE_PCX
734 BITMAP_TYPE_PICT
= _core_
.BITMAP_TYPE_PICT
735 BITMAP_TYPE_ICON
= _core_
.BITMAP_TYPE_ICON
736 BITMAP_TYPE_ANI
= _core_
.BITMAP_TYPE_ANI
737 BITMAP_TYPE_IFF
= _core_
.BITMAP_TYPE_IFF
738 BITMAP_TYPE_MACCURSOR
= _core_
.BITMAP_TYPE_MACCURSOR
739 BITMAP_TYPE_ANY
= _core_
.BITMAP_TYPE_ANY
740 CURSOR_NONE
= _core_
.CURSOR_NONE
741 CURSOR_ARROW
= _core_
.CURSOR_ARROW
742 CURSOR_RIGHT_ARROW
= _core_
.CURSOR_RIGHT_ARROW
743 CURSOR_BULLSEYE
= _core_
.CURSOR_BULLSEYE
744 CURSOR_CHAR
= _core_
.CURSOR_CHAR
745 CURSOR_CROSS
= _core_
.CURSOR_CROSS
746 CURSOR_HAND
= _core_
.CURSOR_HAND
747 CURSOR_IBEAM
= _core_
.CURSOR_IBEAM
748 CURSOR_LEFT_BUTTON
= _core_
.CURSOR_LEFT_BUTTON
749 CURSOR_MAGNIFIER
= _core_
.CURSOR_MAGNIFIER
750 CURSOR_MIDDLE_BUTTON
= _core_
.CURSOR_MIDDLE_BUTTON
751 CURSOR_NO_ENTRY
= _core_
.CURSOR_NO_ENTRY
752 CURSOR_PAINT_BRUSH
= _core_
.CURSOR_PAINT_BRUSH
753 CURSOR_PENCIL
= _core_
.CURSOR_PENCIL
754 CURSOR_POINT_LEFT
= _core_
.CURSOR_POINT_LEFT
755 CURSOR_POINT_RIGHT
= _core_
.CURSOR_POINT_RIGHT
756 CURSOR_QUESTION_ARROW
= _core_
.CURSOR_QUESTION_ARROW
757 CURSOR_RIGHT_BUTTON
= _core_
.CURSOR_RIGHT_BUTTON
758 CURSOR_SIZENESW
= _core_
.CURSOR_SIZENESW
759 CURSOR_SIZENS
= _core_
.CURSOR_SIZENS
760 CURSOR_SIZENWSE
= _core_
.CURSOR_SIZENWSE
761 CURSOR_SIZEWE
= _core_
.CURSOR_SIZEWE
762 CURSOR_SIZING
= _core_
.CURSOR_SIZING
763 CURSOR_SPRAYCAN
= _core_
.CURSOR_SPRAYCAN
764 CURSOR_WAIT
= _core_
.CURSOR_WAIT
765 CURSOR_WATCH
= _core_
.CURSOR_WATCH
766 CURSOR_BLANK
= _core_
.CURSOR_BLANK
767 CURSOR_DEFAULT
= _core_
.CURSOR_DEFAULT
768 CURSOR_COPY_ARROW
= _core_
.CURSOR_COPY_ARROW
769 CURSOR_ARROWWAIT
= _core_
.CURSOR_ARROWWAIT
770 CURSOR_MAX
= _core_
.CURSOR_MAX
771 #---------------------------------------------------------------------------
775 wx.Size is a useful data structure used to represent the size of
776 something. It simply contains integer width and height
777 properties. In most places in wxPython where a wx.Size is
778 expected a (width, height) tuple can be used instead.
780 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
781 __repr__
= _swig_repr
782 width
= property(_core_
.Size_width_get
, _core_
.Size_width_set
)
783 height
= property(_core_
.Size_height_get
, _core_
.Size_height_set
)
784 x
= width
; y
= height
785 def __init__(self
, *args
, **kwargs
):
787 __init__(self, int w=0, int h=0) -> Size
789 Creates a size object.
791 _core_
.Size_swiginit(self
,_core_
.new_Size(*args
, **kwargs
))
792 __swig_destroy__
= _core_
.delete_Size
793 __del__
= lambda self
: None;
794 def __eq__(*args
, **kwargs
):
796 __eq__(self, PyObject other) -> bool
798 Test for equality of wx.Size objects.
800 return _core_
.Size___eq__(*args
, **kwargs
)
802 def __ne__(*args
, **kwargs
):
804 __ne__(self, PyObject other) -> bool
806 Test for inequality of wx.Size objects.
808 return _core_
.Size___ne__(*args
, **kwargs
)
810 def __add__(*args
, **kwargs
):
812 __add__(self, Size sz) -> Size
814 Add sz's proprties to this and return the result.
816 return _core_
.Size___add__(*args
, **kwargs
)
818 def __sub__(*args
, **kwargs
):
820 __sub__(self, Size sz) -> Size
822 Subtract sz's properties from this and return the result.
824 return _core_
.Size___sub__(*args
, **kwargs
)
826 def IncTo(*args
, **kwargs
):
830 Increments this object so that both of its dimensions are not less
831 than the corresponding dimensions of the size.
833 return _core_
.Size_IncTo(*args
, **kwargs
)
835 def DecTo(*args
, **kwargs
):
839 Decrements this object so that both of its dimensions are not greater
840 than the corresponding dimensions of the size.
842 return _core_
.Size_DecTo(*args
, **kwargs
)
844 def Scale(*args
, **kwargs
):
846 Scale(self, float xscale, float yscale)
848 Scales the dimensions of this object by the given factors.
850 return _core_
.Size_Scale(*args
, **kwargs
)
852 def Set(*args
, **kwargs
):
854 Set(self, int w, int h)
856 Set both width and height.
858 return _core_
.Size_Set(*args
, **kwargs
)
860 def SetWidth(*args
, **kwargs
):
861 """SetWidth(self, int w)"""
862 return _core_
.Size_SetWidth(*args
, **kwargs
)
864 def SetHeight(*args
, **kwargs
):
865 """SetHeight(self, int h)"""
866 return _core_
.Size_SetHeight(*args
, **kwargs
)
868 def GetWidth(*args
, **kwargs
):
869 """GetWidth(self) -> int"""
870 return _core_
.Size_GetWidth(*args
, **kwargs
)
872 def GetHeight(*args
, **kwargs
):
873 """GetHeight(self) -> int"""
874 return _core_
.Size_GetHeight(*args
, **kwargs
)
876 def IsFullySpecified(*args
, **kwargs
):
878 IsFullySpecified(self) -> bool
880 Returns True if both components of the size are non-default values.
882 return _core_
.Size_IsFullySpecified(*args
, **kwargs
)
884 def SetDefaults(*args
, **kwargs
):
886 SetDefaults(self, Size size)
888 Combine this size with the other one replacing the default components
889 of this object (i.e. equal to -1) with those of the other.
891 return _core_
.Size_SetDefaults(*args
, **kwargs
)
893 def Get(*args
, **kwargs
):
895 Get() -> (width,height)
897 Returns the width and height properties as a tuple.
899 return _core_
.Size_Get(*args
, **kwargs
)
901 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
902 def __str__(self
): return str(self
.Get())
903 def __repr__(self
): return 'wx.Size'+str(self
.Get())
904 def __len__(self
): return len(self
.Get())
905 def __getitem__(self
, index
): return self
.Get()[index
]
906 def __setitem__(self
, index
, val
):
907 if index
== 0: self
.width
= val
908 elif index
== 1: self
.height
= val
909 else: raise IndexError
910 def __nonzero__(self
): return self
.Get() != (0,0)
911 __safe_for_unpickling__
= True
912 def __reduce__(self
): return (wx
.Size
, self
.Get())
914 _core_
.Size_swigregister(Size
)
916 #---------------------------------------------------------------------------
918 class RealPoint(object):
920 A data structure for representing a point or position with floating
921 point x and y properties. In wxPython most places that expect a
922 wx.RealPoint can also accept a (x,y) tuple.
924 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
925 __repr__
= _swig_repr
926 x
= property(_core_
.RealPoint_x_get
, _core_
.RealPoint_x_set
)
927 y
= property(_core_
.RealPoint_y_get
, _core_
.RealPoint_y_set
)
928 def __init__(self
, *args
, **kwargs
):
930 __init__(self, double x=0.0, double y=0.0) -> RealPoint
932 Create a wx.RealPoint object
934 _core_
.RealPoint_swiginit(self
,_core_
.new_RealPoint(*args
, **kwargs
))
935 __swig_destroy__
= _core_
.delete_RealPoint
936 __del__
= lambda self
: None;
937 def __eq__(*args
, **kwargs
):
939 __eq__(self, PyObject other) -> bool
941 Test for equality of wx.RealPoint objects.
943 return _core_
.RealPoint___eq__(*args
, **kwargs
)
945 def __ne__(*args
, **kwargs
):
947 __ne__(self, PyObject other) -> bool
949 Test for inequality of wx.RealPoint objects.
951 return _core_
.RealPoint___ne__(*args
, **kwargs
)
953 def __add__(*args
, **kwargs
):
955 __add__(self, RealPoint pt) -> RealPoint
957 Add pt's proprties to this and return the result.
959 return _core_
.RealPoint___add__(*args
, **kwargs
)
961 def __sub__(*args
, **kwargs
):
963 __sub__(self, RealPoint pt) -> RealPoint
965 Subtract pt's proprties from this and return the result
967 return _core_
.RealPoint___sub__(*args
, **kwargs
)
969 def Set(*args
, **kwargs
):
971 Set(self, double x, double y)
973 Set both the x and y properties
975 return _core_
.RealPoint_Set(*args
, **kwargs
)
977 def Get(*args
, **kwargs
):
981 Return the x and y properties as a tuple.
983 return _core_
.RealPoint_Get(*args
, **kwargs
)
985 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
986 def __str__(self
): return str(self
.Get())
987 def __repr__(self
): return 'wx.RealPoint'+str(self
.Get())
988 def __len__(self
): return len(self
.Get())
989 def __getitem__(self
, index
): return self
.Get()[index
]
990 def __setitem__(self
, index
, val
):
991 if index
== 0: self
.x
= val
992 elif index
== 1: self
.y
= val
993 else: raise IndexError
994 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
995 __safe_for_unpickling__
= True
996 def __reduce__(self
): return (wx
.RealPoint
, self
.Get())
998 _core_
.RealPoint_swigregister(RealPoint
)
1000 #---------------------------------------------------------------------------
1002 class Point(object):
1004 A data structure for representing a point or position with integer x
1005 and y properties. Most places in wxPython that expect a wx.Point can
1006 also accept a (x,y) tuple.
1008 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1009 __repr__
= _swig_repr
1010 x
= property(_core_
.Point_x_get
, _core_
.Point_x_set
)
1011 y
= property(_core_
.Point_y_get
, _core_
.Point_y_set
)
1012 def __init__(self
, *args
, **kwargs
):
1014 __init__(self, int x=0, int y=0) -> Point
1016 Create a wx.Point object
1018 _core_
.Point_swiginit(self
,_core_
.new_Point(*args
, **kwargs
))
1019 __swig_destroy__
= _core_
.delete_Point
1020 __del__
= lambda self
: None;
1021 def __eq__(*args
, **kwargs
):
1023 __eq__(self, PyObject other) -> bool
1025 Test for equality of wx.Point objects.
1027 return _core_
.Point___eq__(*args
, **kwargs
)
1029 def __ne__(*args
, **kwargs
):
1031 __ne__(self, PyObject other) -> bool
1033 Test for inequality of wx.Point objects.
1035 return _core_
.Point___ne__(*args
, **kwargs
)
1037 def __add__(*args
, **kwargs
):
1039 __add__(self, Point pt) -> Point
1041 Add pt's proprties to this and return the result.
1043 return _core_
.Point___add__(*args
, **kwargs
)
1045 def __sub__(*args
, **kwargs
):
1047 __sub__(self, Point pt) -> Point
1049 Subtract pt's proprties from this and return the result
1051 return _core_
.Point___sub__(*args
, **kwargs
)
1053 def __iadd__(*args
, **kwargs
):
1055 __iadd__(self, Point pt) -> Point
1057 Add pt to this object.
1059 return _core_
.Point___iadd__(*args
, **kwargs
)
1061 def __isub__(*args
, **kwargs
):
1063 __isub__(self, Point pt) -> Point
1065 Subtract pt from this object.
1067 return _core_
.Point___isub__(*args
, **kwargs
)
1069 def Set(*args
, **kwargs
):
1071 Set(self, long x, long y)
1073 Set both the x and y properties
1075 return _core_
.Point_Set(*args
, **kwargs
)
1077 def Get(*args
, **kwargs
):
1081 Return the x and y properties as a tuple.
1083 return _core_
.Point_Get(*args
, **kwargs
)
1085 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1086 def __str__(self
): return str(self
.Get())
1087 def __repr__(self
): return 'wx.Point'+str(self
.Get())
1088 def __len__(self
): return len(self
.Get())
1089 def __getitem__(self
, index
): return self
.Get()[index
]
1090 def __setitem__(self
, index
, val
):
1091 if index
== 0: self
.x
= val
1092 elif index
== 1: self
.y
= val
1093 else: raise IndexError
1094 def __nonzero__(self
): return self
.Get() != (0,0)
1095 __safe_for_unpickling__
= True
1096 def __reduce__(self
): return (wx
.Point
, self
.Get())
1098 _core_
.Point_swigregister(Point
)
1100 #---------------------------------------------------------------------------
1104 A class for representing and manipulating rectangles. It has x, y,
1105 width and height properties. In wxPython most palces that expect a
1106 wx.Rect can also accept a (x,y,width,height) tuple.
1108 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1109 __repr__
= _swig_repr
1110 def __init__(self
, *args
, **kwargs
):
1112 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1114 Create a new Rect object.
1116 _core_
.Rect_swiginit(self
,_core_
.new_Rect(*args
, **kwargs
))
1117 __swig_destroy__
= _core_
.delete_Rect
1118 __del__
= lambda self
: None;
1119 def GetX(*args
, **kwargs
):
1120 """GetX(self) -> int"""
1121 return _core_
.Rect_GetX(*args
, **kwargs
)
1123 def SetX(*args
, **kwargs
):
1124 """SetX(self, int x)"""
1125 return _core_
.Rect_SetX(*args
, **kwargs
)
1127 def GetY(*args
, **kwargs
):
1128 """GetY(self) -> int"""
1129 return _core_
.Rect_GetY(*args
, **kwargs
)
1131 def SetY(*args
, **kwargs
):
1132 """SetY(self, int y)"""
1133 return _core_
.Rect_SetY(*args
, **kwargs
)
1135 def GetWidth(*args
, **kwargs
):
1136 """GetWidth(self) -> int"""
1137 return _core_
.Rect_GetWidth(*args
, **kwargs
)
1139 def SetWidth(*args
, **kwargs
):
1140 """SetWidth(self, int w)"""
1141 return _core_
.Rect_SetWidth(*args
, **kwargs
)
1143 def GetHeight(*args
, **kwargs
):
1144 """GetHeight(self) -> int"""
1145 return _core_
.Rect_GetHeight(*args
, **kwargs
)
1147 def SetHeight(*args
, **kwargs
):
1148 """SetHeight(self, int h)"""
1149 return _core_
.Rect_SetHeight(*args
, **kwargs
)
1151 def GetPosition(*args
, **kwargs
):
1152 """GetPosition(self) -> Point"""
1153 return _core_
.Rect_GetPosition(*args
, **kwargs
)
1155 def SetPosition(*args
, **kwargs
):
1156 """SetPosition(self, Point p)"""
1157 return _core_
.Rect_SetPosition(*args
, **kwargs
)
1159 def GetSize(*args
, **kwargs
):
1160 """GetSize(self) -> Size"""
1161 return _core_
.Rect_GetSize(*args
, **kwargs
)
1163 def SetSize(*args
, **kwargs
):
1164 """SetSize(self, Size s)"""
1165 return _core_
.Rect_SetSize(*args
, **kwargs
)
1167 def IsEmpty(*args
, **kwargs
):
1168 """IsEmpty(self) -> bool"""
1169 return _core_
.Rect_IsEmpty(*args
, **kwargs
)
1171 def GetTopLeft(*args
, **kwargs
):
1172 """GetTopLeft(self) -> Point"""
1173 return _core_
.Rect_GetTopLeft(*args
, **kwargs
)
1175 def SetTopLeft(*args
, **kwargs
):
1176 """SetTopLeft(self, Point p)"""
1177 return _core_
.Rect_SetTopLeft(*args
, **kwargs
)
1179 def GetBottomRight(*args
, **kwargs
):
1180 """GetBottomRight(self) -> Point"""
1181 return _core_
.Rect_GetBottomRight(*args
, **kwargs
)
1183 def SetBottomRight(*args
, **kwargs
):
1184 """SetBottomRight(self, Point p)"""
1185 return _core_
.Rect_SetBottomRight(*args
, **kwargs
)
1187 def GetLeft(*args
, **kwargs
):
1188 """GetLeft(self) -> int"""
1189 return _core_
.Rect_GetLeft(*args
, **kwargs
)
1191 def GetTop(*args
, **kwargs
):
1192 """GetTop(self) -> int"""
1193 return _core_
.Rect_GetTop(*args
, **kwargs
)
1195 def GetBottom(*args
, **kwargs
):
1196 """GetBottom(self) -> int"""
1197 return _core_
.Rect_GetBottom(*args
, **kwargs
)
1199 def GetRight(*args
, **kwargs
):
1200 """GetRight(self) -> int"""
1201 return _core_
.Rect_GetRight(*args
, **kwargs
)
1203 def SetLeft(*args
, **kwargs
):
1204 """SetLeft(self, int left)"""
1205 return _core_
.Rect_SetLeft(*args
, **kwargs
)
1207 def SetRight(*args
, **kwargs
):
1208 """SetRight(self, int right)"""
1209 return _core_
.Rect_SetRight(*args
, **kwargs
)
1211 def SetTop(*args
, **kwargs
):
1212 """SetTop(self, int top)"""
1213 return _core_
.Rect_SetTop(*args
, **kwargs
)
1215 def SetBottom(*args
, **kwargs
):
1216 """SetBottom(self, int bottom)"""
1217 return _core_
.Rect_SetBottom(*args
, **kwargs
)
1219 position
= property(GetPosition
, SetPosition
)
1220 size
= property(GetSize
, SetSize
)
1221 left
= property(GetLeft
, SetLeft
)
1222 right
= property(GetRight
, SetRight
)
1223 top
= property(GetTop
, SetTop
)
1224 bottom
= property(GetBottom
, SetBottom
)
1226 def Inflate(*args
, **kwargs
):
1228 Inflate(self, int dx, int dy) -> Rect
1230 Increases the size of the rectangle.
1232 The left border is moved farther left and the right border is moved
1233 farther right by ``dx``. The upper border is moved farther up and the
1234 bottom border is moved farther down by ``dy``. (Note the the width and
1235 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1236 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1237 opposite happens: the rectangle size decreases in the respective
1240 The change is made to the rectangle inplace, if instead you need a
1241 copy that is inflated, preserving the original then make the copy
1244 copy = wx.Rect(*original)
1249 return _core_
.Rect_Inflate(*args
, **kwargs
)
1251 def Deflate(*args
, **kwargs
):
1253 Deflate(self, int dx, int dy) -> Rect
1255 Decrease the rectangle size. This method is the opposite of `Inflate`
1256 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1257 `Inflate` for a full description.
1259 return _core_
.Rect_Deflate(*args
, **kwargs
)
1261 def OffsetXY(*args
, **kwargs
):
1263 OffsetXY(self, int dx, int dy)
1265 Moves the rectangle by the specified offset. If dx is positive, the
1266 rectangle is moved to the right, if dy is positive, it is moved to the
1267 bottom, otherwise it is moved to the left or top respectively.
1269 return _core_
.Rect_OffsetXY(*args
, **kwargs
)
1271 def Offset(*args
, **kwargs
):
1273 Offset(self, Point pt)
1275 Same as `OffsetXY` but uses dx,dy from Point
1277 return _core_
.Rect_Offset(*args
, **kwargs
)
1279 def Intersect(*args
, **kwargs
):
1281 Intersect(self, Rect rect) -> Rect
1283 Returns the intersectsion of this rectangle and rect.
1285 return _core_
.Rect_Intersect(*args
, **kwargs
)
1287 def Union(*args
, **kwargs
):
1289 Union(self, Rect rect) -> Rect
1291 Returns the union of this rectangle and rect.
1293 return _core_
.Rect_Union(*args
, **kwargs
)
1295 def __add__(*args
, **kwargs
):
1297 __add__(self, Rect rect) -> Rect
1299 Add the properties of rect to this rectangle and return the result.
1301 return _core_
.Rect___add__(*args
, **kwargs
)
1303 def __iadd__(*args
, **kwargs
):
1305 __iadd__(self, Rect rect) -> Rect
1307 Add the properties of rect to this rectangle, updating this rectangle.
1309 return _core_
.Rect___iadd__(*args
, **kwargs
)
1311 def __eq__(*args
, **kwargs
):
1313 __eq__(self, PyObject other) -> bool
1315 Test for equality of wx.Rect objects.
1317 return _core_
.Rect___eq__(*args
, **kwargs
)
1319 def __ne__(*args
, **kwargs
):
1321 __ne__(self, PyObject other) -> bool
1323 Test for inequality of wx.Rect objects.
1325 return _core_
.Rect___ne__(*args
, **kwargs
)
1327 def ContainsXY(*args
, **kwargs
):
1329 ContainsXY(self, int x, int y) -> bool
1331 Return True if the point is inside the rect.
1333 return _core_
.Rect_ContainsXY(*args
, **kwargs
)
1335 def Contains(*args
, **kwargs
):
1337 Contains(self, Point pt) -> bool
1339 Return True if the point is inside the rect.
1341 return _core_
.Rect_Contains(*args
, **kwargs
)
1343 def ContainsRect(*args
, **kwargs
):
1345 ContainsRect(self, Rect rect) -> bool
1347 Returns ``True`` if the given rectangle is completely inside this
1348 rectangle or touches its boundary.
1350 return _core_
.Rect_ContainsRect(*args
, **kwargs
)
1352 Inside
= wx
._deprecated
(Contains
, "Use `Contains` instead.")
1353 InsideXY
= wx
._deprecated
(ContainsXY
, "Use `ContainsXY` instead.")
1354 InsideRect
= wx
._deprecated
(ContainsRect
, "Use `ContainsRect` instead.")
1356 def Intersects(*args
, **kwargs
):
1358 Intersects(self, Rect rect) -> bool
1360 Returns True if the rectangles have a non empty intersection.
1362 return _core_
.Rect_Intersects(*args
, **kwargs
)
1364 def CenterIn(*args
, **kwargs
):
1366 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1368 Center this rectangle within the one passed to the method, which is
1369 usually, but not necessarily, the larger one.
1371 return _core_
.Rect_CenterIn(*args
, **kwargs
)
1374 x
= property(_core_
.Rect_x_get
, _core_
.Rect_x_set
)
1375 y
= property(_core_
.Rect_y_get
, _core_
.Rect_y_set
)
1376 width
= property(_core_
.Rect_width_get
, _core_
.Rect_width_set
)
1377 height
= property(_core_
.Rect_height_get
, _core_
.Rect_height_set
)
1378 def Set(*args
, **kwargs
):
1380 Set(self, int x=0, int y=0, int width=0, int height=0)
1382 Set all rectangle properties.
1384 return _core_
.Rect_Set(*args
, **kwargs
)
1386 def Get(*args
, **kwargs
):
1388 Get() -> (x,y,width,height)
1390 Return the rectangle properties as a tuple.
1392 return _core_
.Rect_Get(*args
, **kwargs
)
1394 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1395 def __str__(self
): return str(self
.Get())
1396 def __repr__(self
): return 'wx.Rect'+str(self
.Get())
1397 def __len__(self
): return len(self
.Get())
1398 def __getitem__(self
, index
): return self
.Get()[index
]
1399 def __setitem__(self
, index
, val
):
1400 if index
== 0: self
.x
= val
1401 elif index
== 1: self
.y
= val
1402 elif index
== 2: self
.width
= val
1403 elif index
== 3: self
.height
= val
1404 else: raise IndexError
1405 def __nonzero__(self
): return self
.Get() != (0,0,0,0)
1406 __safe_for_unpickling__
= True
1407 def __reduce__(self
): return (wx
.Rect
, self
.Get())
1409 Bottom
= property(GetBottom
,SetBottom
,doc
="See `GetBottom` and `SetBottom`")
1410 BottomRight
= property(GetBottomRight
,SetBottomRight
,doc
="See `GetBottomRight` and `SetBottomRight`")
1411 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1412 Left
= property(GetLeft
,SetLeft
,doc
="See `GetLeft` and `SetLeft`")
1413 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
1414 Right
= property(GetRight
,SetRight
,doc
="See `GetRight` and `SetRight`")
1415 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
1416 Top
= property(GetTop
,SetTop
,doc
="See `GetTop` and `SetTop`")
1417 TopLeft
= property(GetTopLeft
,SetTopLeft
,doc
="See `GetTopLeft` and `SetTopLeft`")
1418 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1419 X
= property(GetX
,SetX
,doc
="See `GetX` and `SetX`")
1420 Y
= property(GetY
,SetY
,doc
="See `GetY` and `SetY`")
1421 Empty
= property(IsEmpty
,doc
="See `IsEmpty`")
1422 _core_
.Rect_swigregister(Rect
)
1424 def RectPP(*args
, **kwargs
):
1426 RectPP(Point topLeft, Point bottomRight) -> Rect
1428 Create a new Rect object from Points representing two corners.
1430 val
= _core_
.new_RectPP(*args
, **kwargs
)
1433 def RectPS(*args
, **kwargs
):
1435 RectPS(Point pos, Size size) -> Rect
1437 Create a new Rect from a position and size.
1439 val
= _core_
.new_RectPS(*args
, **kwargs
)
1442 def RectS(*args
, **kwargs
):
1444 RectS(Size size) -> Rect
1446 Create a new Rect from a size only.
1448 val
= _core_
.new_RectS(*args
, **kwargs
)
1452 def IntersectRect(*args
, **kwargs
):
1454 IntersectRect(Rect r1, Rect r2) -> Rect
1456 Calculate and return the intersection of r1 and r2.
1458 return _core_
.IntersectRect(*args
, **kwargs
)
1459 #---------------------------------------------------------------------------
1461 class Point2D(object):
1463 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1464 with floating point values.
1466 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1467 __repr__
= _swig_repr
1468 def __init__(self
, *args
, **kwargs
):
1470 __init__(self, double x=0.0, double y=0.0) -> Point2D
1472 Create a w.Point2D object.
1474 _core_
.Point2D_swiginit(self
,_core_
.new_Point2D(*args
, **kwargs
))
1475 def GetFloor(*args
, **kwargs
):
1481 return _core_
.Point2D_GetFloor(*args
, **kwargs
)
1483 def GetRounded(*args
, **kwargs
):
1485 GetRounded() -> (x,y)
1489 return _core_
.Point2D_GetRounded(*args
, **kwargs
)
1491 def GetVectorLength(*args
, **kwargs
):
1492 """GetVectorLength(self) -> double"""
1493 return _core_
.Point2D_GetVectorLength(*args
, **kwargs
)
1495 def GetVectorAngle(*args
, **kwargs
):
1496 """GetVectorAngle(self) -> double"""
1497 return _core_
.Point2D_GetVectorAngle(*args
, **kwargs
)
1499 def SetVectorLength(*args
, **kwargs
):
1500 """SetVectorLength(self, double length)"""
1501 return _core_
.Point2D_SetVectorLength(*args
, **kwargs
)
1503 def SetVectorAngle(*args
, **kwargs
):
1504 """SetVectorAngle(self, double degrees)"""
1505 return _core_
.Point2D_SetVectorAngle(*args
, **kwargs
)
1507 def SetPolarCoordinates(self
, angle
, length
):
1508 self
.SetVectorLength(length
)
1509 self
.SetVectorAngle(angle
)
1510 def Normalize(self
):
1511 self
.SetVectorLength(1.0)
1513 def GetDistance(*args
, **kwargs
):
1514 """GetDistance(self, Point2D pt) -> double"""
1515 return _core_
.Point2D_GetDistance(*args
, **kwargs
)
1517 def GetDistanceSquare(*args
, **kwargs
):
1518 """GetDistanceSquare(self, Point2D pt) -> double"""
1519 return _core_
.Point2D_GetDistanceSquare(*args
, **kwargs
)
1521 def GetDotProduct(*args
, **kwargs
):
1522 """GetDotProduct(self, Point2D vec) -> double"""
1523 return _core_
.Point2D_GetDotProduct(*args
, **kwargs
)
1525 def GetCrossProduct(*args
, **kwargs
):
1526 """GetCrossProduct(self, Point2D vec) -> double"""
1527 return _core_
.Point2D_GetCrossProduct(*args
, **kwargs
)
1529 def __neg__(*args
, **kwargs
):
1531 __neg__(self) -> Point2D
1533 the reflection of this point
1535 return _core_
.Point2D___neg__(*args
, **kwargs
)
1537 def __iadd__(*args
, **kwargs
):
1538 """__iadd__(self, Point2D pt) -> Point2D"""
1539 return _core_
.Point2D___iadd__(*args
, **kwargs
)
1541 def __isub__(*args
, **kwargs
):
1542 """__isub__(self, Point2D pt) -> Point2D"""
1543 return _core_
.Point2D___isub__(*args
, **kwargs
)
1545 def __imul__(*args
, **kwargs
):
1546 """__imul__(self, Point2D pt) -> Point2D"""
1547 return _core_
.Point2D___imul__(*args
, **kwargs
)
1549 def __idiv__(*args
, **kwargs
):
1550 """__idiv__(self, Point2D pt) -> Point2D"""
1551 return _core_
.Point2D___idiv__(*args
, **kwargs
)
1553 def __eq__(*args
, **kwargs
):
1555 __eq__(self, PyObject other) -> bool
1557 Test for equality of wx.Point2D objects.
1559 return _core_
.Point2D___eq__(*args
, **kwargs
)
1561 def __ne__(*args
, **kwargs
):
1563 __ne__(self, PyObject other) -> bool
1565 Test for inequality of wx.Point2D objects.
1567 return _core_
.Point2D___ne__(*args
, **kwargs
)
1569 x
= property(_core_
.Point2D_x_get
, _core_
.Point2D_x_set
)
1570 y
= property(_core_
.Point2D_y_get
, _core_
.Point2D_y_set
)
1571 def Set(*args
, **kwargs
):
1572 """Set(self, double x=0, double y=0)"""
1573 return _core_
.Point2D_Set(*args
, **kwargs
)
1575 def Get(*args
, **kwargs
):
1579 Return x and y properties as a tuple.
1581 return _core_
.Point2D_Get(*args
, **kwargs
)
1583 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
1584 def __str__(self
): return str(self
.Get())
1585 def __repr__(self
): return 'wx.Point2D'+str(self
.Get())
1586 def __len__(self
): return len(self
.Get())
1587 def __getitem__(self
, index
): return self
.Get()[index
]
1588 def __setitem__(self
, index
, val
):
1589 if index
== 0: self
.x
= val
1590 elif index
== 1: self
.y
= val
1591 else: raise IndexError
1592 def __nonzero__(self
): return self
.Get() != (0.0, 0.0)
1593 __safe_for_unpickling__
= True
1594 def __reduce__(self
): return (wx
.Point2D
, self
.Get())
1596 Floor
= property(GetFloor
,doc
="See `GetFloor`")
1597 Rounded
= property(GetRounded
,doc
="See `GetRounded`")
1598 VectorAngle
= property(GetVectorAngle
,SetVectorAngle
,doc
="See `GetVectorAngle` and `SetVectorAngle`")
1599 VectorLength
= property(GetVectorLength
,SetVectorLength
,doc
="See `GetVectorLength` and `SetVectorLength`")
1600 _core_
.Point2D_swigregister(Point2D
)
1602 def Point2DCopy(*args
, **kwargs
):
1604 Point2DCopy(Point2D pt) -> Point2D
1606 Create a w.Point2D object.
1608 val
= _core_
.new_Point2DCopy(*args
, **kwargs
)
1611 def Point2DFromPoint(*args
, **kwargs
):
1613 Point2DFromPoint(Point pt) -> Point2D
1615 Create a w.Point2D object.
1617 val
= _core_
.new_Point2DFromPoint(*args
, **kwargs
)
1620 #---------------------------------------------------------------------------
1622 FromStart
= _core_
.FromStart
1623 FromCurrent
= _core_
.FromCurrent
1624 FromEnd
= _core_
.FromEnd
1625 class InputStream(object):
1626 """Proxy of C++ InputStream class"""
1627 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1628 __repr__
= _swig_repr
1629 def __init__(self
, *args
, **kwargs
):
1630 """__init__(self, PyObject p) -> InputStream"""
1631 _core_
.InputStream_swiginit(self
,_core_
.new_InputStream(*args
, **kwargs
))
1632 __swig_destroy__
= _core_
.delete_InputStream
1633 __del__
= lambda self
: None;
1634 def close(*args
, **kwargs
):
1636 return _core_
.InputStream_close(*args
, **kwargs
)
1638 def flush(*args
, **kwargs
):
1640 return _core_
.InputStream_flush(*args
, **kwargs
)
1642 def eof(*args
, **kwargs
):
1643 """eof(self) -> bool"""
1644 return _core_
.InputStream_eof(*args
, **kwargs
)
1646 def read(*args
, **kwargs
):
1647 """read(self, int size=-1) -> PyObject"""
1648 return _core_
.InputStream_read(*args
, **kwargs
)
1650 def readline(*args
, **kwargs
):
1651 """readline(self, int size=-1) -> PyObject"""
1652 return _core_
.InputStream_readline(*args
, **kwargs
)
1654 def readlines(*args
, **kwargs
):
1655 """readlines(self, int sizehint=-1) -> PyObject"""
1656 return _core_
.InputStream_readlines(*args
, **kwargs
)
1658 def seek(*args
, **kwargs
):
1659 """seek(self, int offset, int whence=0)"""
1660 return _core_
.InputStream_seek(*args
, **kwargs
)
1662 def tell(*args
, **kwargs
):
1663 """tell(self) -> int"""
1664 return _core_
.InputStream_tell(*args
, **kwargs
)
1666 def Peek(*args
, **kwargs
):
1667 """Peek(self) -> char"""
1668 return _core_
.InputStream_Peek(*args
, **kwargs
)
1670 def GetC(*args
, **kwargs
):
1671 """GetC(self) -> char"""
1672 return _core_
.InputStream_GetC(*args
, **kwargs
)
1674 def LastRead(*args
, **kwargs
):
1675 """LastRead(self) -> size_t"""
1676 return _core_
.InputStream_LastRead(*args
, **kwargs
)
1678 def CanRead(*args
, **kwargs
):
1679 """CanRead(self) -> bool"""
1680 return _core_
.InputStream_CanRead(*args
, **kwargs
)
1682 def Eof(*args
, **kwargs
):
1683 """Eof(self) -> bool"""
1684 return _core_
.InputStream_Eof(*args
, **kwargs
)
1686 def Ungetch(*args
, **kwargs
):
1687 """Ungetch(self, char c) -> bool"""
1688 return _core_
.InputStream_Ungetch(*args
, **kwargs
)
1690 def SeekI(*args
, **kwargs
):
1691 """SeekI(self, long pos, int mode=FromStart) -> long"""
1692 return _core_
.InputStream_SeekI(*args
, **kwargs
)
1694 def TellI(*args
, **kwargs
):
1695 """TellI(self) -> long"""
1696 return _core_
.InputStream_TellI(*args
, **kwargs
)
1698 _core_
.InputStream_swigregister(InputStream
)
1699 DefaultPosition
= cvar
.DefaultPosition
1700 DefaultSize
= cvar
.DefaultSize
1702 class OutputStream(object):
1703 """Proxy of C++ OutputStream class"""
1704 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1705 def __init__(self
): raise AttributeError, "No constructor defined"
1706 __repr__
= _swig_repr
1707 def write(*args
, **kwargs
):
1708 """write(self, PyObject obj)"""
1709 return _core_
.OutputStream_write(*args
, **kwargs
)
1711 def LastWrite(*args
, **kwargs
):
1712 """LastWrite(self) -> size_t"""
1713 return _core_
.OutputStream_LastWrite(*args
, **kwargs
)
1715 _core_
.OutputStream_swigregister(OutputStream
)
1717 #---------------------------------------------------------------------------
1719 class FSFile(Object
):
1720 """Proxy of C++ FSFile class"""
1721 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1722 __repr__
= _swig_repr
1723 def __init__(self
, *args
, **kwargs
):
1725 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1726 DateTime modif) -> FSFile
1728 _core_
.FSFile_swiginit(self
,_core_
.new_FSFile(*args
, **kwargs
))
1729 __swig_destroy__
= _core_
.delete_FSFile
1730 __del__
= lambda self
: None;
1731 def GetStream(*args
, **kwargs
):
1732 """GetStream(self) -> InputStream"""
1733 return _core_
.FSFile_GetStream(*args
, **kwargs
)
1735 def DetachStream(*args
, **kwargs
):
1736 """DetachStream(self)"""
1737 return _core_
.FSFile_DetachStream(*args
, **kwargs
)
1739 def GetMimeType(*args
, **kwargs
):
1740 """GetMimeType(self) -> String"""
1741 return _core_
.FSFile_GetMimeType(*args
, **kwargs
)
1743 def GetLocation(*args
, **kwargs
):
1744 """GetLocation(self) -> String"""
1745 return _core_
.FSFile_GetLocation(*args
, **kwargs
)
1747 def GetAnchor(*args
, **kwargs
):
1748 """GetAnchor(self) -> String"""
1749 return _core_
.FSFile_GetAnchor(*args
, **kwargs
)
1751 def GetModificationTime(*args
, **kwargs
):
1752 """GetModificationTime(self) -> DateTime"""
1753 return _core_
.FSFile_GetModificationTime(*args
, **kwargs
)
1755 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
1756 Location
= property(GetLocation
,doc
="See `GetLocation`")
1757 MimeType
= property(GetMimeType
,doc
="See `GetMimeType`")
1758 ModificationTime
= property(GetModificationTime
,doc
="See `GetModificationTime`")
1759 Stream
= property(GetStream
,doc
="See `GetStream`")
1760 _core_
.FSFile_swigregister(FSFile
)
1762 class CPPFileSystemHandler(object):
1763 """Proxy of C++ CPPFileSystemHandler class"""
1764 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1765 def __init__(self
): raise AttributeError, "No constructor defined"
1766 __repr__
= _swig_repr
1767 __swig_destroy__
= _core_
.delete_CPPFileSystemHandler
1768 __del__
= lambda self
: None;
1769 _core_
.CPPFileSystemHandler_swigregister(CPPFileSystemHandler
)
1771 class FileSystemHandler(CPPFileSystemHandler
):
1772 """Proxy of C++ FileSystemHandler class"""
1773 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1774 __repr__
= _swig_repr
1775 def __init__(self
, *args
, **kwargs
):
1776 """__init__(self) -> FileSystemHandler"""
1777 _core_
.FileSystemHandler_swiginit(self
,_core_
.new_FileSystemHandler(*args
, **kwargs
))
1778 self
._setCallbackInfo
(self
, FileSystemHandler
)
1780 def _setCallbackInfo(*args
, **kwargs
):
1781 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1782 return _core_
.FileSystemHandler__setCallbackInfo(*args
, **kwargs
)
1784 def CanOpen(*args
, **kwargs
):
1785 """CanOpen(self, String location) -> bool"""
1786 return _core_
.FileSystemHandler_CanOpen(*args
, **kwargs
)
1788 def OpenFile(*args
, **kwargs
):
1789 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1790 return _core_
.FileSystemHandler_OpenFile(*args
, **kwargs
)
1792 def FindFirst(*args
, **kwargs
):
1793 """FindFirst(self, String spec, int flags=0) -> String"""
1794 return _core_
.FileSystemHandler_FindFirst(*args
, **kwargs
)
1796 def FindNext(*args
, **kwargs
):
1797 """FindNext(self) -> String"""
1798 return _core_
.FileSystemHandler_FindNext(*args
, **kwargs
)
1800 def GetProtocol(*args
, **kwargs
):
1801 """GetProtocol(self, String location) -> String"""
1802 return _core_
.FileSystemHandler_GetProtocol(*args
, **kwargs
)
1804 def GetLeftLocation(*args
, **kwargs
):
1805 """GetLeftLocation(self, String location) -> String"""
1806 return _core_
.FileSystemHandler_GetLeftLocation(*args
, **kwargs
)
1808 def GetAnchor(*args
, **kwargs
):
1809 """GetAnchor(self, String location) -> String"""
1810 return _core_
.FileSystemHandler_GetAnchor(*args
, **kwargs
)
1812 def GetRightLocation(*args
, **kwargs
):
1813 """GetRightLocation(self, String location) -> String"""
1814 return _core_
.FileSystemHandler_GetRightLocation(*args
, **kwargs
)
1816 def GetMimeTypeFromExt(*args
, **kwargs
):
1817 """GetMimeTypeFromExt(self, String location) -> String"""
1818 return _core_
.FileSystemHandler_GetMimeTypeFromExt(*args
, **kwargs
)
1820 Anchor
= property(GetAnchor
,doc
="See `GetAnchor`")
1821 LeftLocation
= property(GetLeftLocation
,doc
="See `GetLeftLocation`")
1822 MimeTypeFromExt
= property(GetMimeTypeFromExt
,doc
="See `GetMimeTypeFromExt`")
1823 Protocol
= property(GetProtocol
,doc
="See `GetProtocol`")
1824 RightLocation
= property(GetRightLocation
,doc
="See `GetRightLocation`")
1825 _core_
.FileSystemHandler_swigregister(FileSystemHandler
)
1827 class FileSystem(Object
):
1828 """Proxy of C++ FileSystem class"""
1829 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1830 __repr__
= _swig_repr
1831 def __init__(self
, *args
, **kwargs
):
1832 """__init__(self) -> FileSystem"""
1833 _core_
.FileSystem_swiginit(self
,_core_
.new_FileSystem(*args
, **kwargs
))
1834 __swig_destroy__
= _core_
.delete_FileSystem
1835 __del__
= lambda self
: None;
1836 def ChangePathTo(*args
, **kwargs
):
1837 """ChangePathTo(self, String location, bool is_dir=False)"""
1838 return _core_
.FileSystem_ChangePathTo(*args
, **kwargs
)
1840 def GetPath(*args
, **kwargs
):
1841 """GetPath(self) -> String"""
1842 return _core_
.FileSystem_GetPath(*args
, **kwargs
)
1844 def OpenFile(*args
, **kwargs
):
1845 """OpenFile(self, String location) -> FSFile"""
1846 return _core_
.FileSystem_OpenFile(*args
, **kwargs
)
1848 def FindFirst(*args
, **kwargs
):
1849 """FindFirst(self, String spec, int flags=0) -> String"""
1850 return _core_
.FileSystem_FindFirst(*args
, **kwargs
)
1852 def FindNext(*args
, **kwargs
):
1853 """FindNext(self) -> String"""
1854 return _core_
.FileSystem_FindNext(*args
, **kwargs
)
1856 def AddHandler(*args
, **kwargs
):
1857 """AddHandler(CPPFileSystemHandler handler)"""
1858 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1860 AddHandler
= staticmethod(AddHandler
)
1861 def RemoveHandler(*args
, **kwargs
):
1862 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1863 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
1865 RemoveHandler
= staticmethod(RemoveHandler
)
1866 def CleanUpHandlers(*args
, **kwargs
):
1867 """CleanUpHandlers()"""
1868 return _core_
.FileSystem_CleanUpHandlers(*args
, **kwargs
)
1870 CleanUpHandlers
= staticmethod(CleanUpHandlers
)
1871 def FileNameToURL(*args
, **kwargs
):
1872 """FileNameToURL(String filename) -> String"""
1873 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1875 FileNameToURL
= staticmethod(FileNameToURL
)
1876 def URLToFileName(*args
, **kwargs
):
1877 """URLToFileName(String url) -> String"""
1878 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1880 URLToFileName
= staticmethod(URLToFileName
)
1881 Path
= property(GetPath
,doc
="See `GetPath`")
1882 _core_
.FileSystem_swigregister(FileSystem
)
1884 def FileSystem_AddHandler(*args
, **kwargs
):
1885 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1886 return _core_
.FileSystem_AddHandler(*args
, **kwargs
)
1888 def FileSystem_RemoveHandler(*args
, **kwargs
):
1889 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1890 return _core_
.FileSystem_RemoveHandler(*args
, **kwargs
)
1892 def FileSystem_CleanUpHandlers(*args
):
1893 """FileSystem_CleanUpHandlers()"""
1894 return _core_
.FileSystem_CleanUpHandlers(*args
)
1896 def FileSystem_FileNameToURL(*args
, **kwargs
):
1897 """FileSystem_FileNameToURL(String filename) -> String"""
1898 return _core_
.FileSystem_FileNameToURL(*args
, **kwargs
)
1900 def FileSystem_URLToFileName(*args
, **kwargs
):
1901 """FileSystem_URLToFileName(String url) -> String"""
1902 return _core_
.FileSystem_URLToFileName(*args
, **kwargs
)
1904 class InternetFSHandler(CPPFileSystemHandler
):
1905 """Proxy of C++ InternetFSHandler class"""
1906 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1907 __repr__
= _swig_repr
1908 def __init__(self
, *args
, **kwargs
):
1909 """__init__(self) -> InternetFSHandler"""
1910 _core_
.InternetFSHandler_swiginit(self
,_core_
.new_InternetFSHandler(*args
, **kwargs
))
1911 def CanOpen(*args
, **kwargs
):
1912 """CanOpen(self, String location) -> bool"""
1913 return _core_
.InternetFSHandler_CanOpen(*args
, **kwargs
)
1915 def OpenFile(*args
, **kwargs
):
1916 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1917 return _core_
.InternetFSHandler_OpenFile(*args
, **kwargs
)
1919 _core_
.InternetFSHandler_swigregister(InternetFSHandler
)
1921 class ZipFSHandler(CPPFileSystemHandler
):
1922 """Proxy of C++ ZipFSHandler class"""
1923 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1924 __repr__
= _swig_repr
1925 def __init__(self
, *args
, **kwargs
):
1926 """__init__(self) -> ZipFSHandler"""
1927 _core_
.ZipFSHandler_swiginit(self
,_core_
.new_ZipFSHandler(*args
, **kwargs
))
1928 def CanOpen(*args
, **kwargs
):
1929 """CanOpen(self, String location) -> bool"""
1930 return _core_
.ZipFSHandler_CanOpen(*args
, **kwargs
)
1932 def OpenFile(*args
, **kwargs
):
1933 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1934 return _core_
.ZipFSHandler_OpenFile(*args
, **kwargs
)
1936 def FindFirst(*args
, **kwargs
):
1937 """FindFirst(self, String spec, int flags=0) -> String"""
1938 return _core_
.ZipFSHandler_FindFirst(*args
, **kwargs
)
1940 def FindNext(*args
, **kwargs
):
1941 """FindNext(self) -> String"""
1942 return _core_
.ZipFSHandler_FindNext(*args
, **kwargs
)
1944 _core_
.ZipFSHandler_swigregister(ZipFSHandler
)
1947 def __wxMemoryFSHandler_AddFile_wxImage(*args
, **kwargs
):
1948 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1949 return _core_
.__wxMemoryFSHandler
_AddFile
_wxImage
(*args
, **kwargs
)
1951 def __wxMemoryFSHandler_AddFile_wxBitmap(*args
, **kwargs
):
1952 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1953 return _core_
.__wxMemoryFSHandler
_AddFile
_wxBitmap
(*args
, **kwargs
)
1955 def __wxMemoryFSHandler_AddFile_Data(*args
, **kwargs
):
1956 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1957 return _core_
.__wxMemoryFSHandler
_AddFile
_Data
(*args
, **kwargs
)
1958 def MemoryFSHandler_AddFile(filename
, dataItem
, imgType
=-1):
1960 Add 'file' to the memory filesystem. The dataItem parameter can
1961 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1962 arbitrary data. If a bitmap or image is used then the imgType
1963 parameter should specify what kind of image file it should be
1964 written as, wx.BITMAP_TYPE_PNG, etc.
1966 if isinstance(dataItem
, wx
.Image
):
1967 __wxMemoryFSHandler_AddFile_wxImage(filename
, dataItem
, imgType
)
1968 elif isinstance(dataItem
, wx
.Bitmap
):
1969 __wxMemoryFSHandler_AddFile_wxBitmap(filename
, dataItem
, imgType
)
1970 elif type(dataItem
) == str:
1971 __wxMemoryFSHandler_AddFile_Data(filename
, dataItem
)
1973 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1975 class MemoryFSHandler(CPPFileSystemHandler
):
1976 """Proxy of C++ MemoryFSHandler class"""
1977 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1978 __repr__
= _swig_repr
1979 def __init__(self
, *args
, **kwargs
):
1980 """__init__(self) -> MemoryFSHandler"""
1981 _core_
.MemoryFSHandler_swiginit(self
,_core_
.new_MemoryFSHandler(*args
, **kwargs
))
1982 def RemoveFile(*args
, **kwargs
):
1983 """RemoveFile(String filename)"""
1984 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
1986 RemoveFile
= staticmethod(RemoveFile
)
1987 AddFile
= staticmethod(MemoryFSHandler_AddFile
)
1988 def CanOpen(*args
, **kwargs
):
1989 """CanOpen(self, String location) -> bool"""
1990 return _core_
.MemoryFSHandler_CanOpen(*args
, **kwargs
)
1992 def OpenFile(*args
, **kwargs
):
1993 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1994 return _core_
.MemoryFSHandler_OpenFile(*args
, **kwargs
)
1996 def FindFirst(*args
, **kwargs
):
1997 """FindFirst(self, String spec, int flags=0) -> String"""
1998 return _core_
.MemoryFSHandler_FindFirst(*args
, **kwargs
)
2000 def FindNext(*args
, **kwargs
):
2001 """FindNext(self) -> String"""
2002 return _core_
.MemoryFSHandler_FindNext(*args
, **kwargs
)
2004 _core_
.MemoryFSHandler_swigregister(MemoryFSHandler
)
2006 def MemoryFSHandler_RemoveFile(*args
, **kwargs
):
2007 """MemoryFSHandler_RemoveFile(String filename)"""
2008 return _core_
.MemoryFSHandler_RemoveFile(*args
, **kwargs
)
2010 IMAGE_ALPHA_TRANSPARENT
= _core_
.IMAGE_ALPHA_TRANSPARENT
2011 IMAGE_ALPHA_THRESHOLD
= _core_
.IMAGE_ALPHA_THRESHOLD
2012 IMAGE_ALPHA_OPAQUE
= _core_
.IMAGE_ALPHA_OPAQUE
2013 #---------------------------------------------------------------------------
2015 class ImageHandler(Object
):
2017 This is the base class for implementing image file loading/saving, and
2018 image creation from data. It is used within `wx.Image` and is not
2019 normally seen by the application.
2021 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2022 def __init__(self
): raise AttributeError, "No constructor defined"
2023 __repr__
= _swig_repr
2024 def GetName(*args
, **kwargs
):
2025 """GetName(self) -> String"""
2026 return _core_
.ImageHandler_GetName(*args
, **kwargs
)
2028 def GetExtension(*args
, **kwargs
):
2029 """GetExtension(self) -> String"""
2030 return _core_
.ImageHandler_GetExtension(*args
, **kwargs
)
2032 def GetType(*args
, **kwargs
):
2033 """GetType(self) -> long"""
2034 return _core_
.ImageHandler_GetType(*args
, **kwargs
)
2036 def GetMimeType(*args
, **kwargs
):
2037 """GetMimeType(self) -> String"""
2038 return _core_
.ImageHandler_GetMimeType(*args
, **kwargs
)
2040 def CanRead(*args
, **kwargs
):
2041 """CanRead(self, String name) -> bool"""
2042 return _core_
.ImageHandler_CanRead(*args
, **kwargs
)
2044 def CanReadStream(*args
, **kwargs
):
2045 """CanReadStream(self, InputStream stream) -> bool"""
2046 return _core_
.ImageHandler_CanReadStream(*args
, **kwargs
)
2048 def SetName(*args
, **kwargs
):
2049 """SetName(self, String name)"""
2050 return _core_
.ImageHandler_SetName(*args
, **kwargs
)
2052 def SetExtension(*args
, **kwargs
):
2053 """SetExtension(self, String extension)"""
2054 return _core_
.ImageHandler_SetExtension(*args
, **kwargs
)
2056 def SetType(*args
, **kwargs
):
2057 """SetType(self, long type)"""
2058 return _core_
.ImageHandler_SetType(*args
, **kwargs
)
2060 def SetMimeType(*args
, **kwargs
):
2061 """SetMimeType(self, String mimetype)"""
2062 return _core_
.ImageHandler_SetMimeType(*args
, **kwargs
)
2064 Extension
= property(GetExtension
,SetExtension
,doc
="See `GetExtension` and `SetExtension`")
2065 MimeType
= property(GetMimeType
,SetMimeType
,doc
="See `GetMimeType` and `SetMimeType`")
2066 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
2067 Type
= property(GetType
,SetType
,doc
="See `GetType` and `SetType`")
2068 _core_
.ImageHandler_swigregister(ImageHandler
)
2070 class PyImageHandler(ImageHandler
):
2072 This is the base class for implementing image file loading/saving, and
2073 image creation from data, all written in Python. To create a custom
2074 image handler derive a new class from wx.PyImageHandler and provide
2075 the following methods::
2077 def DoCanRead(self, stream) --> bool
2078 '''Check if this handler can read the image on the stream'''
2080 def LoadFile(self, image, stream, verbose, index) --> bool
2081 '''Load image data from the stream and load it into image.'''
2083 def SaveFile(self, image, stream, verbose) --> bool
2084 '''Save the iamge data in image to the stream using
2085 this handler's image file format.'''
2087 def GetImageCount(self, stream) --> int
2088 '''If this image format can hold more than one image,
2089 how many does the image on the stream have?'''
2091 To activate your handler create an instance of it and pass it to
2092 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2093 `SetExtension` from your constructor.
2096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2097 __repr__
= _swig_repr
2098 def __init__(self
, *args
, **kwargs
):
2100 __init__(self) -> PyImageHandler
2102 This is the base class for implementing image file loading/saving, and
2103 image creation from data, all written in Python. To create a custom
2104 image handler derive a new class from wx.PyImageHandler and provide
2105 the following methods::
2107 def DoCanRead(self, stream) --> bool
2108 '''Check if this handler can read the image on the stream'''
2110 def LoadFile(self, image, stream, verbose, index) --> bool
2111 '''Load image data from the stream and load it into image.'''
2113 def SaveFile(self, image, stream, verbose) --> bool
2114 '''Save the iamge data in image to the stream using
2115 this handler's image file format.'''
2117 def GetImageCount(self, stream) --> int
2118 '''If this image format can hold more than one image,
2119 how many does the image on the stream have?'''
2121 To activate your handler create an instance of it and pass it to
2122 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2123 `SetExtension` from your constructor.
2126 _core_
.PyImageHandler_swiginit(self
,_core_
.new_PyImageHandler(*args
, **kwargs
))
2129 def _SetSelf(*args
, **kwargs
):
2130 """_SetSelf(self, PyObject self)"""
2131 return _core_
.PyImageHandler__SetSelf(*args
, **kwargs
)
2133 _core_
.PyImageHandler_swigregister(PyImageHandler
)
2135 class ImageHistogram(object):
2136 """Proxy of C++ ImageHistogram class"""
2137 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2138 __repr__
= _swig_repr
2139 def __init__(self
, *args
, **kwargs
):
2140 """__init__(self) -> ImageHistogram"""
2141 _core_
.ImageHistogram_swiginit(self
,_core_
.new_ImageHistogram(*args
, **kwargs
))
2142 def MakeKey(*args
, **kwargs
):
2144 MakeKey(byte r, byte g, byte b) -> unsigned long
2146 Get the key in the histogram for the given RGB values
2148 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2150 MakeKey
= staticmethod(MakeKey
)
2151 def FindFirstUnusedColour(*args
, **kwargs
):
2153 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2155 Find first colour that is not used in the image and has higher RGB
2156 values than startR, startG, startB. Returns a tuple consisting of a
2157 success flag and rgb values.
2159 return _core_
.ImageHistogram_FindFirstUnusedColour(*args
, **kwargs
)
2161 def GetCount(*args
, **kwargs
):
2163 GetCount(self, unsigned long key) -> unsigned long
2165 Returns the pixel count for the given key. Use `MakeKey` to create a
2166 key value from a RGB tripple.
2168 return _core_
.ImageHistogram_GetCount(*args
, **kwargs
)
2170 def GetCountRGB(*args
, **kwargs
):
2172 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2174 Returns the pixel count for the given RGB values.
2176 return _core_
.ImageHistogram_GetCountRGB(*args
, **kwargs
)
2178 def GetCountColour(*args
, **kwargs
):
2180 GetCountColour(self, Colour colour) -> unsigned long
2182 Returns the pixel count for the given `wx.Colour` value.
2184 return _core_
.ImageHistogram_GetCountColour(*args
, **kwargs
)
2186 _core_
.ImageHistogram_swigregister(ImageHistogram
)
2188 def ImageHistogram_MakeKey(*args
, **kwargs
):
2190 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2192 Get the key in the histogram for the given RGB values
2194 return _core_
.ImageHistogram_MakeKey(*args
, **kwargs
)
2196 class Image_RGBValue(object):
2198 An object that contains values for red, green and blue which represent
2199 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2200 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2203 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2204 __repr__
= _swig_repr
2205 def __init__(self
, *args
, **kwargs
):
2207 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2211 _core_
.Image_RGBValue_swiginit(self
,_core_
.new_Image_RGBValue(*args
, **kwargs
))
2212 red
= property(_core_
.Image_RGBValue_red_get
, _core_
.Image_RGBValue_red_set
)
2213 green
= property(_core_
.Image_RGBValue_green_get
, _core_
.Image_RGBValue_green_set
)
2214 blue
= property(_core_
.Image_RGBValue_blue_get
, _core_
.Image_RGBValue_blue_set
)
2215 _core_
.Image_RGBValue_swigregister(Image_RGBValue
)
2217 class Image_HSVValue(object):
2219 An object that contains values for hue, saturation and value which
2220 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2221 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2224 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2225 __repr__
= _swig_repr
2226 def __init__(self
, *args
, **kwargs
):
2228 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2232 _core_
.Image_HSVValue_swiginit(self
,_core_
.new_Image_HSVValue(*args
, **kwargs
))
2233 hue
= property(_core_
.Image_HSVValue_hue_get
, _core_
.Image_HSVValue_hue_set
)
2234 saturation
= property(_core_
.Image_HSVValue_saturation_get
, _core_
.Image_HSVValue_saturation_set
)
2235 value
= property(_core_
.Image_HSVValue_value_get
, _core_
.Image_HSVValue_value_set
)
2236 _core_
.Image_HSVValue_swigregister(Image_HSVValue
)
2238 class Image(Object
):
2240 A platform-independent image class. An image can be created from
2241 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2242 variety of formats. Functions are available to set and get image
2243 bits, so it can be used for basic image manipulation.
2245 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2246 platform-specific `wx.Bitmap` object must be created from it using the
2247 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2248 device context, using `wx.DC.DrawBitmap`.
2250 One colour value of the image may be used as a mask colour which will
2251 lead to the automatic creation of a `wx.Mask` object associated to the
2254 wx.Image supports alpha channel data, that is in addition to a byte
2255 for the red, green and blue colour components for each pixel it also
2256 stores a byte representing the pixel opacity. An alpha value of 0
2257 corresponds to a transparent pixel (null opacity) while a value of 255
2258 means that the pixel is 100% opaque.
2260 Unlike RGB data, not all images have an alpha channel and before using
2261 `GetAlpha` you should check if this image contains an alpha channel
2262 with `HasAlpha`. Note that currently only images loaded from PNG files
2263 with transparency information will have an alpha channel.
2265 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2266 __repr__
= _swig_repr
2267 def __init__(self
, *args
, **kwargs
):
2269 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2271 Loads an image from a file.
2273 _core_
.Image_swiginit(self
,_core_
.new_Image(*args
, **kwargs
))
2274 __swig_destroy__
= _core_
.delete_Image
2275 __del__
= lambda self
: None;
2276 def Create(*args
, **kwargs
):
2278 Create(self, int width, int height, bool clear=True)
2280 Creates a fresh image. If clear is ``True``, the new image will be
2281 initialized to black. Otherwise, the image data will be uninitialized.
2283 return _core_
.Image_Create(*args
, **kwargs
)
2285 def Destroy(*args
, **kwargs
):
2289 Destroys the image data.
2291 val
= _core_
.Image_Destroy(*args
, **kwargs
)
2295 def Scale(*args
, **kwargs
):
2297 Scale(self, int width, int height) -> Image
2299 Returns a scaled version of the image. This is also useful for scaling
2300 bitmaps in general as the only other way to scale bitmaps is to blit a
2301 `wx.MemoryDC` into another `wx.MemoryDC`.
2303 return _core_
.Image_Scale(*args
, **kwargs
)
2305 def ShrinkBy(*args
, **kwargs
):
2307 ShrinkBy(self, int xFactor, int yFactor) -> Image
2309 Return a version of the image scaled smaller by the given factors.
2311 return _core_
.Image_ShrinkBy(*args
, **kwargs
)
2313 def Rescale(*args
, **kwargs
):
2315 Rescale(self, int width, int height) -> Image
2317 Changes the size of the image in-place by scaling it: after a call to
2318 this function, the image will have the given width and height.
2320 Returns the (modified) image itself.
2322 return _core_
.Image_Rescale(*args
, **kwargs
)
2324 def Resize(*args
, **kwargs
):
2326 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2328 Changes the size of the image in-place without scaling it, by adding
2329 either a border with the given colour or cropping as necessary. The
2330 image is pasted into a new image with the given size and background
2331 colour at the position pos relative to the upper left of the new
2332 image. If red = green = blue = -1 then use either the current mask
2333 colour if set or find, use, and set a suitable mask colour for any
2334 newly exposed areas.
2336 Returns the (modified) image itself.
2338 return _core_
.Image_Resize(*args
, **kwargs
)
2340 def SetRGB(*args
, **kwargs
):
2342 SetRGB(self, int x, int y, byte r, byte g, byte b)
2344 Sets the pixel at the given coordinate. This routine performs
2345 bounds-checks for the coordinate so it can be considered a safe way to
2346 manipulate the data, but in some cases this might be too slow so that
2347 the data will have to be set directly. In that case you will have to
2348 get access to the image data using the `GetData` method.
2350 return _core_
.Image_SetRGB(*args
, **kwargs
)
2352 def SetRGBRect(*args
, **kwargs
):
2354 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2356 Sets the colour of the pixels within the given rectangle. This routine
2357 performs bounds-checks for the rectangle so it can be considered a
2358 safe way to manipulate the data.
2360 return _core_
.Image_SetRGBRect(*args
, **kwargs
)
2362 def GetRed(*args
, **kwargs
):
2364 GetRed(self, int x, int y) -> byte
2366 Returns the red intensity at the given coordinate.
2368 return _core_
.Image_GetRed(*args
, **kwargs
)
2370 def GetGreen(*args
, **kwargs
):
2372 GetGreen(self, int x, int y) -> byte
2374 Returns the green intensity at the given coordinate.
2376 return _core_
.Image_GetGreen(*args
, **kwargs
)
2378 def GetBlue(*args
, **kwargs
):
2380 GetBlue(self, int x, int y) -> byte
2382 Returns the blue intensity at the given coordinate.
2384 return _core_
.Image_GetBlue(*args
, **kwargs
)
2386 def SetAlpha(*args
, **kwargs
):
2388 SetAlpha(self, int x, int y, byte alpha)
2390 Sets the alpha value for the given pixel. This function should only be
2391 called if the image has alpha channel data, use `HasAlpha` to check
2394 return _core_
.Image_SetAlpha(*args
, **kwargs
)
2396 def GetAlpha(*args
, **kwargs
):
2398 GetAlpha(self, int x, int y) -> byte
2400 Returns the alpha value for the given pixel. This function may only be
2401 called for the images with alpha channel, use `HasAlpha` to check for
2404 The returned value is the *opacity* of the image, i.e. the value of 0
2405 corresponds to the fully transparent pixels while the value of 255 to
2406 the fully opaque pixels.
2408 return _core_
.Image_GetAlpha(*args
, **kwargs
)
2410 def HasAlpha(*args
, **kwargs
):
2412 HasAlpha(self) -> bool
2414 Returns true if this image has alpha channel, false otherwise.
2416 return _core_
.Image_HasAlpha(*args
, **kwargs
)
2418 def InitAlpha(*args
, **kwargs
):
2422 Initializes the image alpha channel data. It is an error to call it if
2423 the image already has alpha data. If it doesn't, alpha data will be by
2424 default initialized to all pixels being fully opaque. But if the image
2425 has a a mask colour, all mask pixels will be completely transparent.
2427 return _core_
.Image_InitAlpha(*args
, **kwargs
)
2429 def IsTransparent(*args
, **kwargs
):
2431 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2433 Returns ``True`` if this pixel is masked or has an alpha value less
2434 than the spcified threshold.
2436 return _core_
.Image_IsTransparent(*args
, **kwargs
)
2438 def FindFirstUnusedColour(*args
, **kwargs
):
2440 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2442 Find first colour that is not used in the image and has higher RGB
2443 values than startR, startG, startB. Returns a tuple consisting of a
2444 success flag and rgb values.
2446 return _core_
.Image_FindFirstUnusedColour(*args
, **kwargs
)
2448 def ConvertAlphaToMask(*args
, **kwargs
):
2450 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2452 If the image has alpha channel, this method converts it to mask. All
2453 pixels with alpha value less than ``threshold`` are replaced with the
2454 mask colour and the alpha channel is removed. The mask colour is
2455 chosen automatically using `FindFirstUnusedColour`.
2457 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2460 return _core_
.Image_ConvertAlphaToMask(*args
, **kwargs
)
2462 def ConvertColourToAlpha(*args
, **kwargs
):
2464 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2466 This method converts an image where the original alpha information is
2467 only available as a shades of a colour (actually shades of grey)
2468 typically when you draw anti-aliased text into a bitmap. The DC
2469 drawing routines draw grey values on the black background although
2470 they actually mean to draw white with differnt alpha values. This
2471 method reverses it, assuming a black (!) background and white text.
2472 The method will then fill up the whole image with the colour given.
2474 return _core_
.Image_ConvertColourToAlpha(*args
, **kwargs
)
2476 def SetMaskFromImage(*args
, **kwargs
):
2478 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2480 Sets the image's mask so that the pixels that have RGB value of
2481 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2482 by first finding an unused colour in the image, setting this colour as
2483 the mask colour and then using this colour to draw all pixels in the
2484 image who corresponding pixel in mask has given RGB value.
2486 Returns ``False`` if ``mask`` does not have same dimensions as the
2487 image or if there is no unused colour left. Returns ``True`` if the
2488 mask was successfully applied.
2490 Note that this method involves computing the histogram, which is
2491 computationally intensive operation.
2493 return _core_
.Image_SetMaskFromImage(*args
, **kwargs
)
2495 def CanRead(*args
, **kwargs
):
2497 CanRead(String filename) -> bool
2499 Returns True if the image handlers can read this file.
2501 return _core_
.Image_CanRead(*args
, **kwargs
)
2503 CanRead
= staticmethod(CanRead
)
2504 def GetImageCount(*args
, **kwargs
):
2506 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2508 If the image file contains more than one image and the image handler
2509 is capable of retrieving these individually, this function will return
2510 the number of available images.
2512 return _core_
.Image_GetImageCount(*args
, **kwargs
)
2514 GetImageCount
= staticmethod(GetImageCount
)
2515 def LoadFile(*args
, **kwargs
):
2517 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2519 Loads an image from a file. If no handler type is provided, the
2520 library will try to autodetect the format.
2522 return _core_
.Image_LoadFile(*args
, **kwargs
)
2524 def LoadMimeFile(*args
, **kwargs
):
2526 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2528 Loads an image from a file, specifying the image type with a MIME type
2531 return _core_
.Image_LoadMimeFile(*args
, **kwargs
)
2533 def SaveFile(*args
, **kwargs
):
2535 SaveFile(self, String name, int type) -> bool
2537 Saves an image in the named file.
2539 return _core_
.Image_SaveFile(*args
, **kwargs
)
2541 def SaveMimeFile(*args
, **kwargs
):
2543 SaveMimeFile(self, String name, String mimetype) -> bool
2545 Saves an image in the named file.
2547 return _core_
.Image_SaveMimeFile(*args
, **kwargs
)
2549 def CanReadStream(*args
, **kwargs
):
2551 CanReadStream(InputStream stream) -> bool
2553 Returns True if the image handlers can read an image file from the
2554 data currently on the input stream, or a readable Python file-like
2557 return _core_
.Image_CanReadStream(*args
, **kwargs
)
2559 CanReadStream
= staticmethod(CanReadStream
)
2560 def LoadStream(*args
, **kwargs
):
2562 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2564 Loads an image from an input stream or a readable Python file-like
2565 object. If no handler type is provided, the library will try to
2566 autodetect the format.
2568 return _core_
.Image_LoadStream(*args
, **kwargs
)
2570 def LoadMimeStream(*args
, **kwargs
):
2572 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2574 Loads an image from an input stream or a readable Python file-like
2575 object, using a MIME type string to specify the image file format.
2577 return _core_
.Image_LoadMimeStream(*args
, **kwargs
)
2579 def Ok(*args
, **kwargs
):
2583 Returns true if image data is present.
2585 return _core_
.Image_Ok(*args
, **kwargs
)
2587 def GetWidth(*args
, **kwargs
):
2589 GetWidth(self) -> int
2591 Gets the width of the image in pixels.
2593 return _core_
.Image_GetWidth(*args
, **kwargs
)
2595 def GetHeight(*args
, **kwargs
):
2597 GetHeight(self) -> int
2599 Gets the height of the image in pixels.
2601 return _core_
.Image_GetHeight(*args
, **kwargs
)
2603 def GetSize(*args
, **kwargs
):
2605 GetSize(self) -> Size
2607 Returns the size of the image in pixels.
2609 return _core_
.Image_GetSize(*args
, **kwargs
)
2611 def GetSubImage(*args
, **kwargs
):
2613 GetSubImage(self, Rect rect) -> Image
2615 Returns a sub image of the current one as long as the rect belongs
2616 entirely to the image.
2618 return _core_
.Image_GetSubImage(*args
, **kwargs
)
2620 def Size(*args
, **kwargs
):
2622 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2624 Returns a resized version of this image without scaling it by adding
2625 either a border with the given colour or cropping as necessary. The
2626 image is pasted into a new image with the given size and background
2627 colour at the position ``pos`` relative to the upper left of the new
2628 image. If red = green = blue = -1 then use either the current mask
2629 colour if set or find, use, and set a suitable mask colour for any
2630 newly exposed areas.
2632 return _core_
.Image_Size(*args
, **kwargs
)
2634 def Copy(*args
, **kwargs
):
2638 Returns an identical copy of the image.
2640 return _core_
.Image_Copy(*args
, **kwargs
)
2642 def Paste(*args
, **kwargs
):
2644 Paste(self, Image image, int x, int y)
2646 Pastes ``image`` into this instance and takes care of the mask colour
2647 and any out of bounds problems.
2649 return _core_
.Image_Paste(*args
, **kwargs
)
2651 def GetData(*args
, **kwargs
):
2653 GetData(self) -> PyObject
2655 Returns a string containing a copy of the RGB bytes of the image.
2657 return _core_
.Image_GetData(*args
, **kwargs
)
2659 def SetData(*args
, **kwargs
):
2661 SetData(self, buffer data)
2663 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2664 either a string or a buffer object holding the data and the length of
2665 the data must be width*height*3.
2667 return _core_
.Image_SetData(*args
, **kwargs
)
2669 def GetDataBuffer(*args
, **kwargs
):
2671 GetDataBuffer(self) -> PyObject
2673 Returns a writable Python buffer object that is pointing at the RGB
2674 image data buffer inside the wx.Image. You need to ensure that you do
2675 not use this buffer object after the image has been destroyed.
2677 return _core_
.Image_GetDataBuffer(*args
, **kwargs
)
2679 def SetDataBuffer(*args
, **kwargs
):
2681 SetDataBuffer(self, buffer data)
2683 Sets the internal image data pointer to point at a Python buffer
2684 object. This can save making an extra copy of the data but you must
2685 ensure that the buffer object lives longer than the wx.Image does.
2687 return _core_
.Image_SetDataBuffer(*args
, **kwargs
)
2689 def GetAlphaData(*args
, **kwargs
):
2691 GetAlphaData(self) -> PyObject
2693 Returns a string containing a copy of the alpha bytes of the image.
2695 return _core_
.Image_GetAlphaData(*args
, **kwargs
)
2697 def SetAlphaData(*args
, **kwargs
):
2699 SetAlphaData(self, buffer alpha)
2701 Resets the Image's alpha data from a buffer of bytes. Accepts either
2702 a string or a buffer object holding the data and the length of the
2703 data must be width*height.
2705 return _core_
.Image_SetAlphaData(*args
, **kwargs
)
2707 def GetAlphaBuffer(*args
, **kwargs
):
2709 GetAlphaBuffer(self) -> PyObject
2711 Returns a writable Python buffer object that is pointing at the Alpha
2712 data buffer inside the wx.Image. You need to ensure that you do not
2713 use this buffer object after the image has been destroyed.
2715 return _core_
.Image_GetAlphaBuffer(*args
, **kwargs
)
2717 def SetAlphaBuffer(*args
, **kwargs
):
2719 SetAlphaBuffer(self, buffer alpha)
2721 Sets the internal image alpha pointer to point at a Python buffer
2722 object. This can save making an extra copy of the data but you must
2723 ensure that the buffer object lives as long as the wx.Image does.
2725 return _core_
.Image_SetAlphaBuffer(*args
, **kwargs
)
2727 def SetMaskColour(*args
, **kwargs
):
2729 SetMaskColour(self, byte r, byte g, byte b)
2731 Sets the mask colour for this image (and tells the image to use the
2734 return _core_
.Image_SetMaskColour(*args
, **kwargs
)
2736 def GetOrFindMaskColour(*args
, **kwargs
):
2738 GetOrFindMaskColour() -> (r,g,b)
2740 Get the current mask colour or find a suitable colour.
2742 return _core_
.Image_GetOrFindMaskColour(*args
, **kwargs
)
2744 def GetMaskRed(*args
, **kwargs
):
2746 GetMaskRed(self) -> byte
2748 Gets the red component of the mask colour.
2750 return _core_
.Image_GetMaskRed(*args
, **kwargs
)
2752 def GetMaskGreen(*args
, **kwargs
):
2754 GetMaskGreen(self) -> byte
2756 Gets the green component of the mask colour.
2758 return _core_
.Image_GetMaskGreen(*args
, **kwargs
)
2760 def GetMaskBlue(*args
, **kwargs
):
2762 GetMaskBlue(self) -> byte
2764 Gets the blue component of the mask colour.
2766 return _core_
.Image_GetMaskBlue(*args
, **kwargs
)
2768 def SetMask(*args
, **kwargs
):
2770 SetMask(self, bool mask=True)
2772 Specifies whether there is a mask or not. The area of the mask is
2773 determined by the current mask colour.
2775 return _core_
.Image_SetMask(*args
, **kwargs
)
2777 def HasMask(*args
, **kwargs
):
2779 HasMask(self) -> bool
2781 Returns ``True`` if there is a mask active, ``False`` otherwise.
2783 return _core_
.Image_HasMask(*args
, **kwargs
)
2785 def Rotate(*args
, **kwargs
):
2787 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2788 Point offset_after_rotation=None) -> Image
2790 Rotates the image about the given point, by ``angle`` radians. Passing
2791 ``True`` to ``interpolating`` results in better image quality, but is
2792 slower. If the image has a mask, then the mask colour is used for the
2793 uncovered pixels in the rotated image background. Otherwise, black
2794 will be used as the fill colour.
2796 Returns the rotated image, leaving this image intact.
2798 return _core_
.Image_Rotate(*args
, **kwargs
)
2800 def Rotate90(*args
, **kwargs
):
2802 Rotate90(self, bool clockwise=True) -> Image
2804 Returns a copy of the image rotated 90 degrees in the direction
2805 indicated by ``clockwise``.
2807 return _core_
.Image_Rotate90(*args
, **kwargs
)
2809 def Mirror(*args
, **kwargs
):
2811 Mirror(self, bool horizontally=True) -> Image
2813 Returns a mirrored copy of the image. The parameter ``horizontally``
2814 indicates the orientation.
2816 return _core_
.Image_Mirror(*args
, **kwargs
)
2818 def Replace(*args
, **kwargs
):
2820 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2822 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2825 return _core_
.Image_Replace(*args
, **kwargs
)
2827 def ConvertToGreyscale(*args
, **kwargs
):
2829 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2831 Convert to greyscale image. Uses the luminance component (Y) of the
2832 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2833 defaults to ITU-T BT.601
2835 return _core_
.Image_ConvertToGreyscale(*args
, **kwargs
)
2837 def ConvertToMono(*args
, **kwargs
):
2839 ConvertToMono(self, byte r, byte g, byte b) -> Image
2841 Returns monochromatic version of the image. The returned image has
2842 white colour where the original has ``(r,g,b)`` colour and black
2843 colour everywhere else.
2845 return _core_
.Image_ConvertToMono(*args
, **kwargs
)
2847 def SetOption(*args
, **kwargs
):
2849 SetOption(self, String name, String value)
2851 Sets an image handler defined option. For example, when saving as a
2852 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2853 number between 0 and 100 (0 is terrible, 100 is very good).
2855 return _core_
.Image_SetOption(*args
, **kwargs
)
2857 def SetOptionInt(*args
, **kwargs
):
2859 SetOptionInt(self, String name, int value)
2861 Sets an image option as an integer.
2863 return _core_
.Image_SetOptionInt(*args
, **kwargs
)
2865 def GetOption(*args
, **kwargs
):
2867 GetOption(self, String name) -> String
2869 Gets the value of an image handler option.
2871 return _core_
.Image_GetOption(*args
, **kwargs
)
2873 def GetOptionInt(*args
, **kwargs
):
2875 GetOptionInt(self, String name) -> int
2877 Gets the value of an image handler option as an integer. If the given
2878 option is not present, the function returns 0.
2880 return _core_
.Image_GetOptionInt(*args
, **kwargs
)
2882 def HasOption(*args
, **kwargs
):
2884 HasOption(self, String name) -> bool
2886 Returns true if the given option is present.
2888 return _core_
.Image_HasOption(*args
, **kwargs
)
2890 def CountColours(*args
, **kwargs
):
2891 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2892 return _core_
.Image_CountColours(*args
, **kwargs
)
2894 def ComputeHistogram(*args
, **kwargs
):
2895 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2896 return _core_
.Image_ComputeHistogram(*args
, **kwargs
)
2898 def AddHandler(*args
, **kwargs
):
2899 """AddHandler(ImageHandler handler)"""
2900 return _core_
.Image_AddHandler(*args
, **kwargs
)
2902 AddHandler
= staticmethod(AddHandler
)
2903 def InsertHandler(*args
, **kwargs
):
2904 """InsertHandler(ImageHandler handler)"""
2905 return _core_
.Image_InsertHandler(*args
, **kwargs
)
2907 InsertHandler
= staticmethod(InsertHandler
)
2908 def RemoveHandler(*args
, **kwargs
):
2909 """RemoveHandler(String name) -> bool"""
2910 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
2912 RemoveHandler
= staticmethod(RemoveHandler
)
2913 def GetHandlers(*args
, **kwargs
):
2914 """GetHandlers() -> PyObject"""
2915 return _core_
.Image_GetHandlers(*args
, **kwargs
)
2917 GetHandlers
= staticmethod(GetHandlers
)
2918 def GetImageExtWildcard(*args
, **kwargs
):
2920 GetImageExtWildcard() -> String
2922 Iterates all registered wxImageHandler objects, and returns a string
2923 containing file extension masks suitable for passing to file open/save
2926 return _core_
.Image_GetImageExtWildcard(*args
, **kwargs
)
2928 GetImageExtWildcard
= staticmethod(GetImageExtWildcard
)
2929 def ConvertToBitmap(*args
, **kwargs
):
2930 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
2931 return _core_
.Image_ConvertToBitmap(*args
, **kwargs
)
2933 def ConvertToMonoBitmap(*args
, **kwargs
):
2934 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
2935 return _core_
.Image_ConvertToMonoBitmap(*args
, **kwargs
)
2937 def RotateHue(*args
, **kwargs
):
2939 RotateHue(self, double angle)
2941 Rotates the hue of each pixel of the image. Hue is a double in the
2942 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2944 return _core_
.Image_RotateHue(*args
, **kwargs
)
2946 def RGBtoHSV(*args
, **kwargs
):
2948 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2950 Converts a color in RGB color space to HSV color space.
2952 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
2954 RGBtoHSV
= staticmethod(RGBtoHSV
)
2955 def HSVtoRGB(*args
, **kwargs
):
2957 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2959 Converts a color in HSV color space to RGB color space.
2961 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
2963 HSVtoRGB
= staticmethod(HSVtoRGB
)
2964 def __nonzero__(self
): return self
.Ok()
2965 AlphaBuffer
= property(GetAlphaBuffer
,SetAlphaBuffer
,doc
="See `GetAlphaBuffer` and `SetAlphaBuffer`")
2966 AlphaData
= property(GetAlphaData
,SetAlphaData
,doc
="See `GetAlphaData` and `SetAlphaData`")
2967 Data
= property(GetData
,SetData
,doc
="See `GetData` and `SetData`")
2968 DataBuffer
= property(GetDataBuffer
,SetDataBuffer
,doc
="See `GetDataBuffer` and `SetDataBuffer`")
2969 Height
= property(GetHeight
,doc
="See `GetHeight`")
2970 MaskBlue
= property(GetMaskBlue
,doc
="See `GetMaskBlue`")
2971 MaskGreen
= property(GetMaskGreen
,doc
="See `GetMaskGreen`")
2972 MaskRed
= property(GetMaskRed
,doc
="See `GetMaskRed`")
2973 Size
= property(GetSize
,doc
="See `GetSize`")
2974 Width
= property(GetWidth
,doc
="See `GetWidth`")
2975 _core_
.Image_swigregister(Image
)
2977 def ImageFromMime(*args
, **kwargs
):
2979 ImageFromMime(String name, String mimetype, int index=-1) -> Image
2981 Loads an image from a file, using a MIME type string (such as
2982 'image/jpeg') to specify image type.
2984 val
= _core_
.new_ImageFromMime(*args
, **kwargs
)
2987 def ImageFromStream(*args
, **kwargs
):
2989 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2991 Loads an image from an input stream, or any readable Python file-like
2994 val
= _core_
.new_ImageFromStream(*args
, **kwargs
)
2997 def ImageFromStreamMime(*args
, **kwargs
):
2999 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3001 Loads an image from an input stream, or any readable Python file-like
3002 object, specifying the image format with a MIME type string.
3004 val
= _core_
.new_ImageFromStreamMime(*args
, **kwargs
)
3007 def EmptyImage(*args
, **kwargs
):
3009 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3011 Construct an empty image of a given size, optionally setting all
3014 val
= _core_
.new_EmptyImage(*args
, **kwargs
)
3017 def ImageFromBitmap(*args
, **kwargs
):
3019 ImageFromBitmap(Bitmap bitmap) -> Image
3021 Construct an Image from a `wx.Bitmap`.
3023 val
= _core_
.new_ImageFromBitmap(*args
, **kwargs
)
3026 def ImageFromData(*args
, **kwargs
):
3028 ImageFromData(int width, int height, buffer data) -> Image
3030 Construct an Image from a buffer of RGB bytes. Accepts either a
3031 string or a buffer object holding the data and the length of the data
3032 must be width*height*3.
3034 val
= _core_
.new_ImageFromData(*args
, **kwargs
)
3037 def ImageFromDataWithAlpha(*args
, **kwargs
):
3039 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3041 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3042 Accepts either a string or a buffer object holding the data and the
3043 length of the data must be width*height*3 bytes, and the length of the
3044 alpha data must be width*height bytes.
3046 val
= _core_
.new_ImageFromDataWithAlpha(*args
, **kwargs
)
3049 def Image_CanRead(*args
, **kwargs
):
3051 Image_CanRead(String filename) -> bool
3053 Returns True if the image handlers can read this file.
3055 return _core_
.Image_CanRead(*args
, **kwargs
)
3057 def Image_GetImageCount(*args
, **kwargs
):
3059 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3061 If the image file contains more than one image and the image handler
3062 is capable of retrieving these individually, this function will return
3063 the number of available images.
3065 return _core_
.Image_GetImageCount(*args
, **kwargs
)
3067 def Image_CanReadStream(*args
, **kwargs
):
3069 Image_CanReadStream(InputStream stream) -> bool
3071 Returns True if the image handlers can read an image file from the
3072 data currently on the input stream, or a readable Python file-like
3075 return _core_
.Image_CanReadStream(*args
, **kwargs
)
3077 def Image_AddHandler(*args
, **kwargs
):
3078 """Image_AddHandler(ImageHandler handler)"""
3079 return _core_
.Image_AddHandler(*args
, **kwargs
)
3081 def Image_InsertHandler(*args
, **kwargs
):
3082 """Image_InsertHandler(ImageHandler handler)"""
3083 return _core_
.Image_InsertHandler(*args
, **kwargs
)
3085 def Image_RemoveHandler(*args
, **kwargs
):
3086 """Image_RemoveHandler(String name) -> bool"""
3087 return _core_
.Image_RemoveHandler(*args
, **kwargs
)
3089 def Image_GetHandlers(*args
):
3090 """Image_GetHandlers() -> PyObject"""
3091 return _core_
.Image_GetHandlers(*args
)
3093 def Image_GetImageExtWildcard(*args
):
3095 Image_GetImageExtWildcard() -> String
3097 Iterates all registered wxImageHandler objects, and returns a string
3098 containing file extension masks suitable for passing to file open/save
3101 return _core_
.Image_GetImageExtWildcard(*args
)
3103 def Image_RGBtoHSV(*args
, **kwargs
):
3105 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3107 Converts a color in RGB color space to HSV color space.
3109 return _core_
.Image_RGBtoHSV(*args
, **kwargs
)
3111 def Image_HSVtoRGB(*args
, **kwargs
):
3113 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3115 Converts a color in HSV color space to RGB color space.
3117 return _core_
.Image_HSVtoRGB(*args
, **kwargs
)
3120 def _ImageFromBuffer(*args
, **kwargs
):
3121 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3122 return _core_
._ImageFromBuffer
(*args
, **kwargs
)
3123 def ImageFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
3125 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3126 parameter must be a Python object that implements the buffer interface,
3127 such as a string, array, etc. The dataBuffer object is expected to
3128 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3129 object can optionally be supplied for the image's alpha channel data, and
3130 it is expected to be width*height bytes long.
3132 The wx.Image will be created with its data and alpha pointers initialized
3133 to the memory address pointed to by the buffer objects, thus saving the
3134 time needed to copy the image data from the buffer object to the wx.Image.
3135 While this has advantages, it also has the shoot-yourself-in-the-foot
3136 risks associated with sharing a C pointer between two objects.
3138 To help alleviate the risk a reference to the data and alpha buffer
3139 objects are kept with the wx.Image, so that they won't get deleted until
3140 after the wx.Image is deleted. However please be aware that it is not
3141 guaranteed that an object won't move its memory buffer to a new location
3142 when it needs to resize its contents. If that happens then the wx.Image
3143 will end up referring to an invalid memory location and could cause the
3144 application to crash. Therefore care should be taken to not manipulate
3145 the objects used for the data and alpha buffers in a way that would cause
3146 them to change size.
3148 image
= _core_
._ImageFromBuffer
(width
, height
, dataBuffer
, alphaBuffer
)
3149 image
._buffer
= dataBuffer
3150 image
._alpha
= alphaBuffer
3153 def InitAllImageHandlers():
3155 The former functionality of InitAllImageHanders is now done internal to
3156 the _core_ extension module and so this function has become a simple NOP.
3160 IMAGE_RESOLUTION_INCHES
= _core_
.IMAGE_RESOLUTION_INCHES
3161 IMAGE_RESOLUTION_CM
= _core_
.IMAGE_RESOLUTION_CM
3162 PNG_TYPE_COLOUR
= _core_
.PNG_TYPE_COLOUR
3163 PNG_TYPE_GREY
= _core_
.PNG_TYPE_GREY
3164 PNG_TYPE_GREY_RED
= _core_
.PNG_TYPE_GREY_RED
3165 BMP_24BPP
= _core_
.BMP_24BPP
3166 BMP_8BPP
= _core_
.BMP_8BPP
3167 BMP_8BPP_GREY
= _core_
.BMP_8BPP_GREY
3168 BMP_8BPP_GRAY
= _core_
.BMP_8BPP_GRAY
3169 BMP_8BPP_RED
= _core_
.BMP_8BPP_RED
3170 BMP_8BPP_PALETTE
= _core_
.BMP_8BPP_PALETTE
3171 BMP_4BPP
= _core_
.BMP_4BPP
3172 BMP_1BPP
= _core_
.BMP_1BPP
3173 BMP_1BPP_BW
= _core_
.BMP_1BPP_BW
3174 class BMPHandler(ImageHandler
):
3175 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3176 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3177 __repr__
= _swig_repr
3178 def __init__(self
, *args
, **kwargs
):
3180 __init__(self) -> BMPHandler
3182 A `wx.ImageHandler` for \*.bmp bitmap files.
3184 _core_
.BMPHandler_swiginit(self
,_core_
.new_BMPHandler(*args
, **kwargs
))
3185 _core_
.BMPHandler_swigregister(BMPHandler
)
3186 NullImage
= cvar
.NullImage
3187 IMAGE_OPTION_FILENAME
= cvar
.IMAGE_OPTION_FILENAME
3188 IMAGE_OPTION_BMP_FORMAT
= cvar
.IMAGE_OPTION_BMP_FORMAT
3189 IMAGE_OPTION_CUR_HOTSPOT_X
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_X
3190 IMAGE_OPTION_CUR_HOTSPOT_Y
= cvar
.IMAGE_OPTION_CUR_HOTSPOT_Y
3191 IMAGE_OPTION_RESOLUTION
= cvar
.IMAGE_OPTION_RESOLUTION
3192 IMAGE_OPTION_RESOLUTIONX
= cvar
.IMAGE_OPTION_RESOLUTIONX
3193 IMAGE_OPTION_RESOLUTIONY
= cvar
.IMAGE_OPTION_RESOLUTIONY
3194 IMAGE_OPTION_RESOLUTIONUNIT
= cvar
.IMAGE_OPTION_RESOLUTIONUNIT
3195 IMAGE_OPTION_QUALITY
= cvar
.IMAGE_OPTION_QUALITY
3196 IMAGE_OPTION_BITSPERSAMPLE
= cvar
.IMAGE_OPTION_BITSPERSAMPLE
3197 IMAGE_OPTION_SAMPLESPERPIXEL
= cvar
.IMAGE_OPTION_SAMPLESPERPIXEL
3198 IMAGE_OPTION_COMPRESSION
= cvar
.IMAGE_OPTION_COMPRESSION
3199 IMAGE_OPTION_IMAGEDESCRIPTOR
= cvar
.IMAGE_OPTION_IMAGEDESCRIPTOR
3200 IMAGE_OPTION_PNG_FORMAT
= cvar
.IMAGE_OPTION_PNG_FORMAT
3201 IMAGE_OPTION_PNG_BITDEPTH
= cvar
.IMAGE_OPTION_PNG_BITDEPTH
3203 class ICOHandler(BMPHandler
):
3204 """A `wx.ImageHandler` for \*.ico icon files."""
3205 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3206 __repr__
= _swig_repr
3207 def __init__(self
, *args
, **kwargs
):
3209 __init__(self) -> ICOHandler
3211 A `wx.ImageHandler` for \*.ico icon files.
3213 _core_
.ICOHandler_swiginit(self
,_core_
.new_ICOHandler(*args
, **kwargs
))
3214 _core_
.ICOHandler_swigregister(ICOHandler
)
3216 class CURHandler(ICOHandler
):
3217 """A `wx.ImageHandler` for \*.cur cursor files."""
3218 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3219 __repr__
= _swig_repr
3220 def __init__(self
, *args
, **kwargs
):
3222 __init__(self) -> CURHandler
3224 A `wx.ImageHandler` for \*.cur cursor files.
3226 _core_
.CURHandler_swiginit(self
,_core_
.new_CURHandler(*args
, **kwargs
))
3227 _core_
.CURHandler_swigregister(CURHandler
)
3229 class ANIHandler(CURHandler
):
3230 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3231 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3232 __repr__
= _swig_repr
3233 def __init__(self
, *args
, **kwargs
):
3235 __init__(self) -> ANIHandler
3237 A `wx.ImageHandler` for \*.ani animated cursor files.
3239 _core_
.ANIHandler_swiginit(self
,_core_
.new_ANIHandler(*args
, **kwargs
))
3240 _core_
.ANIHandler_swigregister(ANIHandler
)
3242 class PNGHandler(ImageHandler
):
3243 """A `wx.ImageHandler` for PNG image files."""
3244 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3245 __repr__
= _swig_repr
3246 def __init__(self
, *args
, **kwargs
):
3248 __init__(self) -> PNGHandler
3250 A `wx.ImageHandler` for PNG image files.
3252 _core_
.PNGHandler_swiginit(self
,_core_
.new_PNGHandler(*args
, **kwargs
))
3253 _core_
.PNGHandler_swigregister(PNGHandler
)
3255 class GIFHandler(ImageHandler
):
3256 """A `wx.ImageHandler` for GIF image files."""
3257 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3258 __repr__
= _swig_repr
3259 def __init__(self
, *args
, **kwargs
):
3261 __init__(self) -> GIFHandler
3263 A `wx.ImageHandler` for GIF image files.
3265 _core_
.GIFHandler_swiginit(self
,_core_
.new_GIFHandler(*args
, **kwargs
))
3266 _core_
.GIFHandler_swigregister(GIFHandler
)
3268 class PCXHandler(ImageHandler
):
3269 """A `wx.ImageHandler` for PCX imager files."""
3270 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3271 __repr__
= _swig_repr
3272 def __init__(self
, *args
, **kwargs
):
3274 __init__(self) -> PCXHandler
3276 A `wx.ImageHandler` for PCX imager files.
3278 _core_
.PCXHandler_swiginit(self
,_core_
.new_PCXHandler(*args
, **kwargs
))
3279 _core_
.PCXHandler_swigregister(PCXHandler
)
3281 class JPEGHandler(ImageHandler
):
3282 """A `wx.ImageHandler` for JPEG/JPG image files."""
3283 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3284 __repr__
= _swig_repr
3285 def __init__(self
, *args
, **kwargs
):
3287 __init__(self) -> JPEGHandler
3289 A `wx.ImageHandler` for JPEG/JPG image files.
3291 _core_
.JPEGHandler_swiginit(self
,_core_
.new_JPEGHandler(*args
, **kwargs
))
3292 _core_
.JPEGHandler_swigregister(JPEGHandler
)
3294 class PNMHandler(ImageHandler
):
3295 """A `wx.ImageHandler` for PNM image files."""
3296 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3297 __repr__
= _swig_repr
3298 def __init__(self
, *args
, **kwargs
):
3300 __init__(self) -> PNMHandler
3302 A `wx.ImageHandler` for PNM image files.
3304 _core_
.PNMHandler_swiginit(self
,_core_
.new_PNMHandler(*args
, **kwargs
))
3305 _core_
.PNMHandler_swigregister(PNMHandler
)
3307 class XPMHandler(ImageHandler
):
3308 """A `wx.ImageHandler` for XPM image."""
3309 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3310 __repr__
= _swig_repr
3311 def __init__(self
, *args
, **kwargs
):
3313 __init__(self) -> XPMHandler
3315 A `wx.ImageHandler` for XPM image.
3317 _core_
.XPMHandler_swiginit(self
,_core_
.new_XPMHandler(*args
, **kwargs
))
3318 _core_
.XPMHandler_swigregister(XPMHandler
)
3320 class TIFFHandler(ImageHandler
):
3321 """A `wx.ImageHandler` for TIFF image files."""
3322 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3323 __repr__
= _swig_repr
3324 def __init__(self
, *args
, **kwargs
):
3326 __init__(self) -> TIFFHandler
3328 A `wx.ImageHandler` for TIFF image files.
3330 _core_
.TIFFHandler_swiginit(self
,_core_
.new_TIFFHandler(*args
, **kwargs
))
3331 _core_
.TIFFHandler_swigregister(TIFFHandler
)
3333 QUANTIZE_INCLUDE_WINDOWS_COLOURS
= _core_
.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3334 QUANTIZE_FILL_DESTINATION_IMAGE
= _core_
.QUANTIZE_FILL_DESTINATION_IMAGE
3335 class Quantize(object):
3336 """Performs quantization, or colour reduction, on a wxImage."""
3337 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3338 def __init__(self
): raise AttributeError, "No constructor defined"
3339 __repr__
= _swig_repr
3340 def Quantize(*args
, **kwargs
):
3342 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3344 Reduce the colours in the source image and put the result into the
3345 destination image, setting the palette in the destination if
3346 needed. Both images may be the same, to overwrite the source image.
3348 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3350 Quantize
= staticmethod(Quantize
)
3351 _core_
.Quantize_swigregister(Quantize
)
3353 def Quantize_Quantize(*args
, **kwargs
):
3355 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3357 Reduce the colours in the source image and put the result into the
3358 destination image, setting the palette in the destination if
3359 needed. Both images may be the same, to overwrite the source image.
3361 return _core_
.Quantize_Quantize(*args
, **kwargs
)
3363 #---------------------------------------------------------------------------
3365 class EvtHandler(Object
):
3366 """Proxy of C++ EvtHandler class"""
3367 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3368 __repr__
= _swig_repr
3369 def __init__(self
, *args
, **kwargs
):
3370 """__init__(self) -> EvtHandler"""
3371 _core_
.EvtHandler_swiginit(self
,_core_
.new_EvtHandler(*args
, **kwargs
))
3372 self
._setOORInfo
(self
)
3374 def GetNextHandler(*args
, **kwargs
):
3375 """GetNextHandler(self) -> EvtHandler"""
3376 return _core_
.EvtHandler_GetNextHandler(*args
, **kwargs
)
3378 def GetPreviousHandler(*args
, **kwargs
):
3379 """GetPreviousHandler(self) -> EvtHandler"""
3380 return _core_
.EvtHandler_GetPreviousHandler(*args
, **kwargs
)
3382 def SetNextHandler(*args
, **kwargs
):
3383 """SetNextHandler(self, EvtHandler handler)"""
3384 return _core_
.EvtHandler_SetNextHandler(*args
, **kwargs
)
3386 def SetPreviousHandler(*args
, **kwargs
):
3387 """SetPreviousHandler(self, EvtHandler handler)"""
3388 return _core_
.EvtHandler_SetPreviousHandler(*args
, **kwargs
)
3390 def GetEvtHandlerEnabled(*args
, **kwargs
):
3391 """GetEvtHandlerEnabled(self) -> bool"""
3392 return _core_
.EvtHandler_GetEvtHandlerEnabled(*args
, **kwargs
)
3394 def SetEvtHandlerEnabled(*args
, **kwargs
):
3395 """SetEvtHandlerEnabled(self, bool enabled)"""
3396 return _core_
.EvtHandler_SetEvtHandlerEnabled(*args
, **kwargs
)
3398 def ProcessEvent(*args
, **kwargs
):
3399 """ProcessEvent(self, Event event) -> bool"""
3400 return _core_
.EvtHandler_ProcessEvent(*args
, **kwargs
)
3402 def AddPendingEvent(*args
, **kwargs
):
3403 """AddPendingEvent(self, Event event)"""
3404 return _core_
.EvtHandler_AddPendingEvent(*args
, **kwargs
)
3406 def ProcessPendingEvents(*args
, **kwargs
):
3407 """ProcessPendingEvents(self)"""
3408 return _core_
.EvtHandler_ProcessPendingEvents(*args
, **kwargs
)
3410 def Connect(*args
, **kwargs
):
3411 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3412 return _core_
.EvtHandler_Connect(*args
, **kwargs
)
3414 def Disconnect(*args
, **kwargs
):
3415 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3416 return _core_
.EvtHandler_Disconnect(*args
, **kwargs
)
3418 def _setOORInfo(*args
, **kwargs
):
3419 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3420 val
= _core_
.EvtHandler__setOORInfo(*args
, **kwargs
)
3424 def Bind(self
, event
, handler
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3426 Bind an event to an event handler.
3428 :param event: One of the EVT_* objects that specifies the
3429 type of event to bind,
3431 :param handler: A callable object to be invoked when the
3432 event is delivered to self. Pass None to
3433 disconnect an event handler.
3435 :param source: Sometimes the event originates from a
3436 different window than self, but you still
3437 want to catch it in self. (For example, a
3438 button event delivered to a frame.) By
3439 passing the source of the event, the event
3440 handling system is able to differentiate
3441 between the same event type from different
3444 :param id: Used to spcify the event source by ID instead
3447 :param id2: Used when it is desirable to bind a handler
3448 to a range of IDs, such as with EVT_MENU_RANGE.
3450 if source
is not None:
3452 event
.Bind(self
, id, id2
, handler
)
3454 def Unbind(self
, event
, source
=None, id=wx
.ID_ANY
, id2
=wx
.ID_ANY
):
3456 Disconencts the event handler binding for event from self.
3457 Returns True if successful.
3459 if source
is not None:
3461 return event
.Unbind(self
, id, id2
)
3463 EvtHandlerEnabled
= property(GetEvtHandlerEnabled
,SetEvtHandlerEnabled
,doc
="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3464 NextHandler
= property(GetNextHandler
,SetNextHandler
,doc
="See `GetNextHandler` and `SetNextHandler`")
3465 PreviousHandler
= property(GetPreviousHandler
,SetPreviousHandler
,doc
="See `GetPreviousHandler` and `SetPreviousHandler`")
3466 _core_
.EvtHandler_swigregister(EvtHandler
)
3468 #---------------------------------------------------------------------------
3470 class PyEventBinder(object):
3472 Instances of this class are used to bind specific events to event
3475 def __init__(self
, evtType
, expectedIDs
=0):
3476 if expectedIDs
not in [0, 1, 2]:
3477 raise ValueError, "Invalid number of expectedIDs"
3478 self
.expectedIDs
= expectedIDs
3480 if type(evtType
) == list or type(evtType
) == tuple:
3481 self
.evtType
= evtType
3483 self
.evtType
= [evtType
]
3486 def Bind(self
, target
, id1
, id2
, function
):
3487 """Bind this set of event types to target."""
3488 for et
in self
.evtType
:
3489 target
.Connect(id1
, id2
, et
, function
)
3492 def Unbind(self
, target
, id1
, id2
):
3493 """Remove an event binding."""
3495 for et
in self
.evtType
:
3496 success
+= target
.Disconnect(id1
, id2
, et
)
3500 def __call__(self
, *args
):
3502 For backwards compatibility with the old EVT_* functions.
3503 Should be called with either (window, func), (window, ID,
3504 func) or (window, ID1, ID2, func) parameters depending on the
3507 assert len(args
) == 2 + self
.expectedIDs
3511 if self
.expectedIDs
== 0:
3513 elif self
.expectedIDs
== 1:
3516 elif self
.expectedIDs
== 2:
3521 raise ValueError, "Unexpected number of IDs"
3523 self
.Bind(target
, id1
, id2
, func
)
3526 # These two are square pegs that don't fit the PyEventBinder hole...
3527 def EVT_COMMAND(win
, id, cmd
, func
):
3528 win
.Connect(id, -1, cmd
, func
)
3529 def EVT_COMMAND_RANGE(win
, id1
, id2
, cmd
, func
):
3530 win
.Connect(id1
, id2
, cmd
, func
)
3533 #---------------------------------------------------------------------------
3535 #---------------------------------------------------------------------------
3537 EVENT_PROPAGATE_NONE
= _core_
.EVENT_PROPAGATE_NONE
3538 EVENT_PROPAGATE_MAX
= _core_
.EVENT_PROPAGATE_MAX
3540 def NewEventType(*args
):
3541 """NewEventType() -> EventType"""
3542 return _core_
.NewEventType(*args
)
3543 wxEVT_NULL
= _core_
.wxEVT_NULL
3544 wxEVT_FIRST
= _core_
.wxEVT_FIRST
3545 wxEVT_USER_FIRST
= _core_
.wxEVT_USER_FIRST
3546 wxEVT_COMMAND_BUTTON_CLICKED
= _core_
.wxEVT_COMMAND_BUTTON_CLICKED
3547 wxEVT_COMMAND_CHECKBOX_CLICKED
= _core_
.wxEVT_COMMAND_CHECKBOX_CLICKED
3548 wxEVT_COMMAND_CHOICE_SELECTED
= _core_
.wxEVT_COMMAND_CHOICE_SELECTED
3549 wxEVT_COMMAND_LISTBOX_SELECTED
= _core_
.wxEVT_COMMAND_LISTBOX_SELECTED
3550 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
= _core_
.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3551 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
= _core_
.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3552 wxEVT_COMMAND_MENU_SELECTED
= _core_
.wxEVT_COMMAND_MENU_SELECTED
3553 wxEVT_COMMAND_TOOL_CLICKED
= _core_
.wxEVT_COMMAND_TOOL_CLICKED
3554 wxEVT_COMMAND_SLIDER_UPDATED
= _core_
.wxEVT_COMMAND_SLIDER_UPDATED
3555 wxEVT_COMMAND_RADIOBOX_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBOX_SELECTED
3556 wxEVT_COMMAND_RADIOBUTTON_SELECTED
= _core_
.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3557 wxEVT_COMMAND_SCROLLBAR_UPDATED
= _core_
.wxEVT_COMMAND_SCROLLBAR_UPDATED
3558 wxEVT_COMMAND_VLBOX_SELECTED
= _core_
.wxEVT_COMMAND_VLBOX_SELECTED
3559 wxEVT_COMMAND_COMBOBOX_SELECTED
= _core_
.wxEVT_COMMAND_COMBOBOX_SELECTED
3560 wxEVT_COMMAND_TOOL_RCLICKED
= _core_
.wxEVT_COMMAND_TOOL_RCLICKED
3561 wxEVT_COMMAND_TOOL_ENTER
= _core_
.wxEVT_COMMAND_TOOL_ENTER
3562 wxEVT_LEFT_DOWN
= _core_
.wxEVT_LEFT_DOWN
3563 wxEVT_LEFT_UP
= _core_
.wxEVT_LEFT_UP
3564 wxEVT_MIDDLE_DOWN
= _core_
.wxEVT_MIDDLE_DOWN
3565 wxEVT_MIDDLE_UP
= _core_
.wxEVT_MIDDLE_UP
3566 wxEVT_RIGHT_DOWN
= _core_
.wxEVT_RIGHT_DOWN
3567 wxEVT_RIGHT_UP
= _core_
.wxEVT_RIGHT_UP
3568 wxEVT_MOTION
= _core_
.wxEVT_MOTION
3569 wxEVT_ENTER_WINDOW
= _core_
.wxEVT_ENTER_WINDOW
3570 wxEVT_LEAVE_WINDOW
= _core_
.wxEVT_LEAVE_WINDOW
3571 wxEVT_LEFT_DCLICK
= _core_
.wxEVT_LEFT_DCLICK
3572 wxEVT_MIDDLE_DCLICK
= _core_
.wxEVT_MIDDLE_DCLICK
3573 wxEVT_RIGHT_DCLICK
= _core_
.wxEVT_RIGHT_DCLICK
3574 wxEVT_SET_FOCUS
= _core_
.wxEVT_SET_FOCUS
3575 wxEVT_KILL_FOCUS
= _core_
.wxEVT_KILL_FOCUS
3576 wxEVT_CHILD_FOCUS
= _core_
.wxEVT_CHILD_FOCUS
3577 wxEVT_MOUSEWHEEL
= _core_
.wxEVT_MOUSEWHEEL
3578 wxEVT_NC_LEFT_DOWN
= _core_
.wxEVT_NC_LEFT_DOWN
3579 wxEVT_NC_LEFT_UP
= _core_
.wxEVT_NC_LEFT_UP
3580 wxEVT_NC_MIDDLE_DOWN
= _core_
.wxEVT_NC_MIDDLE_DOWN
3581 wxEVT_NC_MIDDLE_UP
= _core_
.wxEVT_NC_MIDDLE_UP
3582 wxEVT_NC_RIGHT_DOWN
= _core_
.wxEVT_NC_RIGHT_DOWN
3583 wxEVT_NC_RIGHT_UP
= _core_
.wxEVT_NC_RIGHT_UP
3584 wxEVT_NC_MOTION
= _core_
.wxEVT_NC_MOTION
3585 wxEVT_NC_ENTER_WINDOW
= _core_
.wxEVT_NC_ENTER_WINDOW
3586 wxEVT_NC_LEAVE_WINDOW
= _core_
.wxEVT_NC_LEAVE_WINDOW
3587 wxEVT_NC_LEFT_DCLICK
= _core_
.wxEVT_NC_LEFT_DCLICK
3588 wxEVT_NC_MIDDLE_DCLICK
= _core_
.wxEVT_NC_MIDDLE_DCLICK
3589 wxEVT_NC_RIGHT_DCLICK
= _core_
.wxEVT_NC_RIGHT_DCLICK
3590 wxEVT_CHAR
= _core_
.wxEVT_CHAR
3591 wxEVT_CHAR_HOOK
= _core_
.wxEVT_CHAR_HOOK
3592 wxEVT_NAVIGATION_KEY
= _core_
.wxEVT_NAVIGATION_KEY
3593 wxEVT_KEY_DOWN
= _core_
.wxEVT_KEY_DOWN
3594 wxEVT_KEY_UP
= _core_
.wxEVT_KEY_UP
3595 wxEVT_HOTKEY
= _core_
.wxEVT_HOTKEY
3596 wxEVT_SET_CURSOR
= _core_
.wxEVT_SET_CURSOR
3597 wxEVT_SCROLL_TOP
= _core_
.wxEVT_SCROLL_TOP
3598 wxEVT_SCROLL_BOTTOM
= _core_
.wxEVT_SCROLL_BOTTOM
3599 wxEVT_SCROLL_LINEUP
= _core_
.wxEVT_SCROLL_LINEUP
3600 wxEVT_SCROLL_LINEDOWN
= _core_
.wxEVT_SCROLL_LINEDOWN
3601 wxEVT_SCROLL_PAGEUP
= _core_
.wxEVT_SCROLL_PAGEUP
3602 wxEVT_SCROLL_PAGEDOWN
= _core_
.wxEVT_SCROLL_PAGEDOWN
3603 wxEVT_SCROLL_THUMBTRACK
= _core_
.wxEVT_SCROLL_THUMBTRACK
3604 wxEVT_SCROLL_THUMBRELEASE
= _core_
.wxEVT_SCROLL_THUMBRELEASE
3605 wxEVT_SCROLL_CHANGED
= _core_
.wxEVT_SCROLL_CHANGED
3606 wxEVT_SCROLL_ENDSCROLL
= wxEVT_SCROLL_CHANGED
3607 wxEVT_SCROLLWIN_TOP
= _core_
.wxEVT_SCROLLWIN_TOP
3608 wxEVT_SCROLLWIN_BOTTOM
= _core_
.wxEVT_SCROLLWIN_BOTTOM
3609 wxEVT_SCROLLWIN_LINEUP
= _core_
.wxEVT_SCROLLWIN_LINEUP
3610 wxEVT_SCROLLWIN_LINEDOWN
= _core_
.wxEVT_SCROLLWIN_LINEDOWN
3611 wxEVT_SCROLLWIN_PAGEUP
= _core_
.wxEVT_SCROLLWIN_PAGEUP
3612 wxEVT_SCROLLWIN_PAGEDOWN
= _core_
.wxEVT_SCROLLWIN_PAGEDOWN
3613 wxEVT_SCROLLWIN_THUMBTRACK
= _core_
.wxEVT_SCROLLWIN_THUMBTRACK
3614 wxEVT_SCROLLWIN_THUMBRELEASE
= _core_
.wxEVT_SCROLLWIN_THUMBRELEASE
3615 wxEVT_SIZE
= _core_
.wxEVT_SIZE
3616 wxEVT_MOVE
= _core_
.wxEVT_MOVE
3617 wxEVT_CLOSE_WINDOW
= _core_
.wxEVT_CLOSE_WINDOW
3618 wxEVT_END_SESSION
= _core_
.wxEVT_END_SESSION
3619 wxEVT_QUERY_END_SESSION
= _core_
.wxEVT_QUERY_END_SESSION
3620 wxEVT_ACTIVATE_APP
= _core_
.wxEVT_ACTIVATE_APP
3621 wxEVT_ACTIVATE
= _core_
.wxEVT_ACTIVATE
3622 wxEVT_CREATE
= _core_
.wxEVT_CREATE
3623 wxEVT_DESTROY
= _core_
.wxEVT_DESTROY
3624 wxEVT_SHOW
= _core_
.wxEVT_SHOW
3625 wxEVT_ICONIZE
= _core_
.wxEVT_ICONIZE
3626 wxEVT_MAXIMIZE
= _core_
.wxEVT_MAXIMIZE
3627 wxEVT_MOUSE_CAPTURE_CHANGED
= _core_
.wxEVT_MOUSE_CAPTURE_CHANGED
3628 wxEVT_MOUSE_CAPTURE_LOST
= _core_
.wxEVT_MOUSE_CAPTURE_LOST
3629 wxEVT_PAINT
= _core_
.wxEVT_PAINT
3630 wxEVT_ERASE_BACKGROUND
= _core_
.wxEVT_ERASE_BACKGROUND
3631 wxEVT_NC_PAINT
= _core_
.wxEVT_NC_PAINT
3632 wxEVT_PAINT_ICON
= _core_
.wxEVT_PAINT_ICON
3633 wxEVT_MENU_OPEN
= _core_
.wxEVT_MENU_OPEN
3634 wxEVT_MENU_CLOSE
= _core_
.wxEVT_MENU_CLOSE
3635 wxEVT_MENU_HIGHLIGHT
= _core_
.wxEVT_MENU_HIGHLIGHT
3636 wxEVT_CONTEXT_MENU
= _core_
.wxEVT_CONTEXT_MENU
3637 wxEVT_SYS_COLOUR_CHANGED
= _core_
.wxEVT_SYS_COLOUR_CHANGED
3638 wxEVT_DISPLAY_CHANGED
= _core_
.wxEVT_DISPLAY_CHANGED
3639 wxEVT_SETTING_CHANGED
= _core_
.wxEVT_SETTING_CHANGED
3640 wxEVT_QUERY_NEW_PALETTE
= _core_
.wxEVT_QUERY_NEW_PALETTE
3641 wxEVT_PALETTE_CHANGED
= _core_
.wxEVT_PALETTE_CHANGED
3642 wxEVT_DROP_FILES
= _core_
.wxEVT_DROP_FILES
3643 wxEVT_DRAW_ITEM
= _core_
.wxEVT_DRAW_ITEM
3644 wxEVT_MEASURE_ITEM
= _core_
.wxEVT_MEASURE_ITEM
3645 wxEVT_COMPARE_ITEM
= _core_
.wxEVT_COMPARE_ITEM
3646 wxEVT_INIT_DIALOG
= _core_
.wxEVT_INIT_DIALOG
3647 wxEVT_IDLE
= _core_
.wxEVT_IDLE
3648 wxEVT_UPDATE_UI
= _core_
.wxEVT_UPDATE_UI
3649 wxEVT_SIZING
= _core_
.wxEVT_SIZING
3650 wxEVT_MOVING
= _core_
.wxEVT_MOVING
3651 wxEVT_HIBERNATE
= _core_
.wxEVT_HIBERNATE
3652 wxEVT_COMMAND_TEXT_COPY
= _core_
.wxEVT_COMMAND_TEXT_COPY
3653 wxEVT_COMMAND_TEXT_CUT
= _core_
.wxEVT_COMMAND_TEXT_CUT
3654 wxEVT_COMMAND_TEXT_PASTE
= _core_
.wxEVT_COMMAND_TEXT_PASTE
3655 wxEVT_COMMAND_LEFT_CLICK
= _core_
.wxEVT_COMMAND_LEFT_CLICK
3656 wxEVT_COMMAND_LEFT_DCLICK
= _core_
.wxEVT_COMMAND_LEFT_DCLICK
3657 wxEVT_COMMAND_RIGHT_CLICK
= _core_
.wxEVT_COMMAND_RIGHT_CLICK
3658 wxEVT_COMMAND_RIGHT_DCLICK
= _core_
.wxEVT_COMMAND_RIGHT_DCLICK
3659 wxEVT_COMMAND_SET_FOCUS
= _core_
.wxEVT_COMMAND_SET_FOCUS
3660 wxEVT_COMMAND_KILL_FOCUS
= _core_
.wxEVT_COMMAND_KILL_FOCUS
3661 wxEVT_COMMAND_ENTER
= _core_
.wxEVT_COMMAND_ENTER
3663 # Create some event binders
3664 EVT_SIZE
= wx
.PyEventBinder( wxEVT_SIZE
)
3665 EVT_SIZING
= wx
.PyEventBinder( wxEVT_SIZING
)
3666 EVT_MOVE
= wx
.PyEventBinder( wxEVT_MOVE
)
3667 EVT_MOVING
= wx
.PyEventBinder( wxEVT_MOVING
)
3668 EVT_CLOSE
= wx
.PyEventBinder( wxEVT_CLOSE_WINDOW
)
3669 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3670 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3671 EVT_PAINT
= wx
.PyEventBinder( wxEVT_PAINT
)
3672 EVT_NC_PAINT
= wx
.PyEventBinder( wxEVT_NC_PAINT
)
3673 EVT_ERASE_BACKGROUND
= wx
.PyEventBinder( wxEVT_ERASE_BACKGROUND
)
3674 EVT_CHAR
= wx
.PyEventBinder( wxEVT_CHAR
)
3675 EVT_KEY_DOWN
= wx
.PyEventBinder( wxEVT_KEY_DOWN
)
3676 EVT_KEY_UP
= wx
.PyEventBinder( wxEVT_KEY_UP
)
3677 EVT_HOTKEY
= wx
.PyEventBinder( wxEVT_HOTKEY
, 1)
3678 EVT_CHAR_HOOK
= wx
.PyEventBinder( wxEVT_CHAR_HOOK
)
3679 EVT_MENU_OPEN
= wx
.PyEventBinder( wxEVT_MENU_OPEN
)
3680 EVT_MENU_CLOSE
= wx
.PyEventBinder( wxEVT_MENU_CLOSE
)
3681 EVT_MENU_HIGHLIGHT
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
, 1)
3682 EVT_MENU_HIGHLIGHT_ALL
= wx
.PyEventBinder( wxEVT_MENU_HIGHLIGHT
)
3683 EVT_SET_FOCUS
= wx
.PyEventBinder( wxEVT_SET_FOCUS
)
3684 EVT_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_KILL_FOCUS
)
3685 EVT_CHILD_FOCUS
= wx
.PyEventBinder( wxEVT_CHILD_FOCUS
)
3686 EVT_ACTIVATE
= wx
.PyEventBinder( wxEVT_ACTIVATE
)
3687 EVT_ACTIVATE_APP
= wx
.PyEventBinder( wxEVT_ACTIVATE_APP
)
3688 EVT_HIBERNATE
= wx
.PyEventBinder( wxEVT_HIBERNATE
)
3689 EVT_END_SESSION
= wx
.PyEventBinder( wxEVT_END_SESSION
)
3690 EVT_QUERY_END_SESSION
= wx
.PyEventBinder( wxEVT_QUERY_END_SESSION
)
3691 EVT_DROP_FILES
= wx
.PyEventBinder( wxEVT_DROP_FILES
)
3692 EVT_INIT_DIALOG
= wx
.PyEventBinder( wxEVT_INIT_DIALOG
)
3693 EVT_SYS_COLOUR_CHANGED
= wx
.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED
)
3694 EVT_DISPLAY_CHANGED
= wx
.PyEventBinder( wxEVT_DISPLAY_CHANGED
)
3695 EVT_SHOW
= wx
.PyEventBinder( wxEVT_SHOW
)
3696 EVT_MAXIMIZE
= wx
.PyEventBinder( wxEVT_MAXIMIZE
)
3697 EVT_ICONIZE
= wx
.PyEventBinder( wxEVT_ICONIZE
)
3698 EVT_NAVIGATION_KEY
= wx
.PyEventBinder( wxEVT_NAVIGATION_KEY
)
3699 EVT_PALETTE_CHANGED
= wx
.PyEventBinder( wxEVT_PALETTE_CHANGED
)
3700 EVT_QUERY_NEW_PALETTE
= wx
.PyEventBinder( wxEVT_QUERY_NEW_PALETTE
)
3701 EVT_WINDOW_CREATE
= wx
.PyEventBinder( wxEVT_CREATE
)
3702 EVT_WINDOW_DESTROY
= wx
.PyEventBinder( wxEVT_DESTROY
)
3703 EVT_SET_CURSOR
= wx
.PyEventBinder( wxEVT_SET_CURSOR
)
3704 EVT_MOUSE_CAPTURE_CHANGED
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED
)
3705 EVT_MOUSE_CAPTURE_LOST
= wx
.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST
)
3707 EVT_LEFT_DOWN
= wx
.PyEventBinder( wxEVT_LEFT_DOWN
)
3708 EVT_LEFT_UP
= wx
.PyEventBinder( wxEVT_LEFT_UP
)
3709 EVT_MIDDLE_DOWN
= wx
.PyEventBinder( wxEVT_MIDDLE_DOWN
)
3710 EVT_MIDDLE_UP
= wx
.PyEventBinder( wxEVT_MIDDLE_UP
)
3711 EVT_RIGHT_DOWN
= wx
.PyEventBinder( wxEVT_RIGHT_DOWN
)
3712 EVT_RIGHT_UP
= wx
.PyEventBinder( wxEVT_RIGHT_UP
)
3713 EVT_MOTION
= wx
.PyEventBinder( wxEVT_MOTION
)
3714 EVT_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_LEFT_DCLICK
)
3715 EVT_MIDDLE_DCLICK
= wx
.PyEventBinder( wxEVT_MIDDLE_DCLICK
)
3716 EVT_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_RIGHT_DCLICK
)
3717 EVT_LEAVE_WINDOW
= wx
.PyEventBinder( wxEVT_LEAVE_WINDOW
)
3718 EVT_ENTER_WINDOW
= wx
.PyEventBinder( wxEVT_ENTER_WINDOW
)
3719 EVT_MOUSEWHEEL
= wx
.PyEventBinder( wxEVT_MOUSEWHEEL
)
3721 EVT_MOUSE_EVENTS
= wx
.PyEventBinder([ wxEVT_LEFT_DOWN
,
3729 wxEVT_MIDDLE_DCLICK
,
3737 # Scrolling from wxWindow (sent to wxScrolledWindow)
3738 EVT_SCROLLWIN
= wx
.PyEventBinder([ wxEVT_SCROLLWIN_TOP
,
3739 wxEVT_SCROLLWIN_BOTTOM
,
3740 wxEVT_SCROLLWIN_LINEUP
,
3741 wxEVT_SCROLLWIN_LINEDOWN
,
3742 wxEVT_SCROLLWIN_PAGEUP
,
3743 wxEVT_SCROLLWIN_PAGEDOWN
,
3744 wxEVT_SCROLLWIN_THUMBTRACK
,
3745 wxEVT_SCROLLWIN_THUMBRELEASE
,
3748 EVT_SCROLLWIN_TOP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_TOP
)
3749 EVT_SCROLLWIN_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM
)
3750 EVT_SCROLLWIN_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEUP
)
3751 EVT_SCROLLWIN_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN
)
3752 EVT_SCROLLWIN_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP
)
3753 EVT_SCROLLWIN_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN
)
3754 EVT_SCROLLWIN_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK
)
3755 EVT_SCROLLWIN_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE
)
3757 # Scrolling from wx.Slider and wx.ScrollBar
3758 EVT_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3759 wxEVT_SCROLL_BOTTOM
,
3760 wxEVT_SCROLL_LINEUP
,
3761 wxEVT_SCROLL_LINEDOWN
,
3762 wxEVT_SCROLL_PAGEUP
,
3763 wxEVT_SCROLL_PAGEDOWN
,
3764 wxEVT_SCROLL_THUMBTRACK
,
3765 wxEVT_SCROLL_THUMBRELEASE
,
3766 wxEVT_SCROLL_CHANGED
,
3769 EVT_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
)
3770 EVT_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
)
3771 EVT_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
)
3772 EVT_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
)
3773 EVT_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
)
3774 EVT_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
)
3775 EVT_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
)
3776 EVT_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
)
3777 EVT_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
)
3778 EVT_SCROLL_ENDSCROLL
= EVT_SCROLL_CHANGED
3780 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3781 EVT_COMMAND_SCROLL
= wx
.PyEventBinder([ wxEVT_SCROLL_TOP
,
3782 wxEVT_SCROLL_BOTTOM
,
3783 wxEVT_SCROLL_LINEUP
,
3784 wxEVT_SCROLL_LINEDOWN
,
3785 wxEVT_SCROLL_PAGEUP
,
3786 wxEVT_SCROLL_PAGEDOWN
,
3787 wxEVT_SCROLL_THUMBTRACK
,
3788 wxEVT_SCROLL_THUMBRELEASE
,
3789 wxEVT_SCROLL_CHANGED
,
3792 EVT_COMMAND_SCROLL_TOP
= wx
.PyEventBinder( wxEVT_SCROLL_TOP
, 1)
3793 EVT_COMMAND_SCROLL_BOTTOM
= wx
.PyEventBinder( wxEVT_SCROLL_BOTTOM
, 1)
3794 EVT_COMMAND_SCROLL_LINEUP
= wx
.PyEventBinder( wxEVT_SCROLL_LINEUP
, 1)
3795 EVT_COMMAND_SCROLL_LINEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_LINEDOWN
, 1)
3796 EVT_COMMAND_SCROLL_PAGEUP
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEUP
, 1)
3797 EVT_COMMAND_SCROLL_PAGEDOWN
= wx
.PyEventBinder( wxEVT_SCROLL_PAGEDOWN
, 1)
3798 EVT_COMMAND_SCROLL_THUMBTRACK
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBTRACK
, 1)
3799 EVT_COMMAND_SCROLL_THUMBRELEASE
= wx
.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE
, 1)
3800 EVT_COMMAND_SCROLL_CHANGED
= wx
.PyEventBinder( wxEVT_SCROLL_CHANGED
, 1)
3801 EVT_COMMAND_SCROLL_ENDSCROLL
= EVT_COMMAND_SCROLL_CHANGED
3803 EVT_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED
, 1)
3804 EVT_CHECKBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED
, 1)
3805 EVT_CHOICE
= wx
.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED
, 1)
3806 EVT_LISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED
, 1)
3807 EVT_LISTBOX_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, 1)
3808 EVT_MENU
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 1)
3809 EVT_MENU_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED
, 2)
3810 EVT_SLIDER
= wx
.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED
, 1)
3811 EVT_RADIOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED
, 1)
3812 EVT_RADIOBUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, 1)
3814 EVT_SCROLLBAR
= wx
.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED
, 1)
3815 EVT_VLBOX
= wx
.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED
, 1)
3816 EVT_COMBOBOX
= wx
.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED
, 1)
3817 EVT_TOOL
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 1)
3818 EVT_TOOL_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED
, 2)
3819 EVT_TOOL_RCLICKED
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 1)
3820 EVT_TOOL_RCLICKED_RANGE
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED
, 2)
3821 EVT_TOOL_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER
, 1)
3822 EVT_CHECKLISTBOX
= wx
.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, 1)
3825 EVT_COMMAND_LEFT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK
, 1)
3826 EVT_COMMAND_LEFT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK
, 1)
3827 EVT_COMMAND_RIGHT_CLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK
, 1)
3828 EVT_COMMAND_RIGHT_DCLICK
= wx
.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK
, 1)
3829 EVT_COMMAND_SET_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_SET_FOCUS
, 1)
3830 EVT_COMMAND_KILL_FOCUS
= wx
.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS
, 1)
3831 EVT_COMMAND_ENTER
= wx
.PyEventBinder( wxEVT_COMMAND_ENTER
, 1)
3833 EVT_IDLE
= wx
.PyEventBinder( wxEVT_IDLE
)
3835 EVT_UPDATE_UI
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 1)
3836 EVT_UPDATE_UI_RANGE
= wx
.PyEventBinder( wxEVT_UPDATE_UI
, 2)
3838 EVT_CONTEXT_MENU
= wx
.PyEventBinder( wxEVT_CONTEXT_MENU
)
3840 EVT_TEXT_CUT
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_CUT
)
3841 EVT_TEXT_COPY
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_COPY
)
3842 EVT_TEXT_PASTE
= wx
.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE
)
3845 #---------------------------------------------------------------------------
3847 class Event(Object
):
3849 An event is a structure holding information about an event passed to a
3850 callback or member function. wx.Event is an abstract base class for
3853 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3854 def __init__(self
): raise AttributeError, "No constructor defined"
3855 __repr__
= _swig_repr
3856 __swig_destroy__
= _core_
.delete_Event
3857 __del__
= lambda self
: None;
3858 def SetEventType(*args
, **kwargs
):
3860 SetEventType(self, EventType typ)
3862 Sets the specific type of the event.
3864 return _core_
.Event_SetEventType(*args
, **kwargs
)
3866 def GetEventType(*args
, **kwargs
):
3868 GetEventType(self) -> EventType
3870 Returns the identifier of the given event type, such as
3871 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3873 return _core_
.Event_GetEventType(*args
, **kwargs
)
3875 def GetEventObject(*args
, **kwargs
):
3877 GetEventObject(self) -> Object
3879 Returns the object (usually a window) associated with the event, if
3882 return _core_
.Event_GetEventObject(*args
, **kwargs
)
3884 def SetEventObject(*args
, **kwargs
):
3886 SetEventObject(self, Object obj)
3888 Sets the originating object, or in other words, obj is normally the
3889 object that is sending the event.
3891 return _core_
.Event_SetEventObject(*args
, **kwargs
)
3893 def GetTimestamp(*args
, **kwargs
):
3894 """GetTimestamp(self) -> long"""
3895 return _core_
.Event_GetTimestamp(*args
, **kwargs
)
3897 def SetTimestamp(*args
, **kwargs
):
3898 """SetTimestamp(self, long ts=0)"""
3899 return _core_
.Event_SetTimestamp(*args
, **kwargs
)
3901 def GetId(*args
, **kwargs
):
3905 Returns the identifier associated with this event, such as a button
3908 return _core_
.Event_GetId(*args
, **kwargs
)
3910 def SetId(*args
, **kwargs
):
3914 Set's the ID for the event. This is usually the ID of the window that
3915 is sending the event, but it can also be a command id from a menu
3918 return _core_
.Event_SetId(*args
, **kwargs
)
3920 def IsCommandEvent(*args
, **kwargs
):
3922 IsCommandEvent(self) -> bool
3924 Returns true if the event is or is derived from `wx.CommandEvent` else
3925 it returns false. Note: Exists only for optimization purposes.
3927 return _core_
.Event_IsCommandEvent(*args
, **kwargs
)
3929 def Skip(*args
, **kwargs
):
3931 Skip(self, bool skip=True)
3933 Called by an event handler, it controls whether additional event
3934 handlers bound to this event will be called after the current event
3935 handler returns. Skip(false) (the default setting) will prevent
3936 additional event handlers from being called and control will be
3937 returned to the sender of the event immediately after the current
3938 handler has finished. Skip(True) will cause the event processing
3939 system to continue searching for a handler function for this event.
3942 return _core_
.Event_Skip(*args
, **kwargs
)
3944 def GetSkipped(*args
, **kwargs
):
3946 GetSkipped(self) -> bool
3948 Returns true if the event handler should be skipped, false otherwise.
3951 return _core_
.Event_GetSkipped(*args
, **kwargs
)
3953 def ShouldPropagate(*args
, **kwargs
):
3955 ShouldPropagate(self) -> bool
3957 Test if this event should be propagated to the parent window or not,
3958 i.e. if the propagation level is currently greater than 0.
3960 return _core_
.Event_ShouldPropagate(*args
, **kwargs
)
3962 def StopPropagation(*args
, **kwargs
):
3964 StopPropagation(self) -> int
3966 Stop the event from propagating to its parent window. Returns the old
3967 propagation level value which may be later passed to
3968 `ResumePropagation` to allow propagating the event again.
3970 return _core_
.Event_StopPropagation(*args
, **kwargs
)
3972 def ResumePropagation(*args
, **kwargs
):
3974 ResumePropagation(self, int propagationLevel)
3976 Resume the event propagation by restoring the propagation level. (For
3977 example, you can use the value returned by an earlier call to
3981 return _core_
.Event_ResumePropagation(*args
, **kwargs
)
3983 def Clone(*args
, **kwargs
):
3984 """Clone(self) -> Event"""
3985 return _core_
.Event_Clone(*args
, **kwargs
)
3987 EventObject
= property(GetEventObject
,SetEventObject
,doc
="See `GetEventObject` and `SetEventObject`")
3988 EventType
= property(GetEventType
,SetEventType
,doc
="See `GetEventType` and `SetEventType`")
3989 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
3990 Skipped
= property(GetSkipped
,doc
="See `GetSkipped`")
3991 Timestamp
= property(GetTimestamp
,SetTimestamp
,doc
="See `GetTimestamp` and `SetTimestamp`")
3992 _core_
.Event_swigregister(Event
)
3994 #---------------------------------------------------------------------------
3996 class PropagationDisabler(object):
3998 Helper class to temporarily change an event not to propagate. Simply
3999 create an instance of this class and then whe it is destroyed the
4000 propogation of the event will be restored.
4002 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4003 __repr__
= _swig_repr
4004 def __init__(self
, *args
, **kwargs
):
4006 __init__(self, Event event) -> PropagationDisabler
4008 Helper class to temporarily change an event not to propagate. Simply
4009 create an instance of this class and then whe it is destroyed the
4010 propogation of the event will be restored.
4012 _core_
.PropagationDisabler_swiginit(self
,_core_
.new_PropagationDisabler(*args
, **kwargs
))
4013 __swig_destroy__
= _core_
.delete_PropagationDisabler
4014 __del__
= lambda self
: None;
4015 _core_
.PropagationDisabler_swigregister(PropagationDisabler
)
4017 class PropagateOnce(object):
4019 A helper class that will temporarily lower propagation level of an
4020 event. Simply create an instance of this class and then whe it is
4021 destroyed the propogation of the event will be restored.
4023 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4024 __repr__
= _swig_repr
4025 def __init__(self
, *args
, **kwargs
):
4027 __init__(self, Event event) -> PropagateOnce
4029 A helper class that will temporarily lower propagation level of an
4030 event. Simply create an instance of this class and then whe it is
4031 destroyed the propogation of the event will be restored.
4033 _core_
.PropagateOnce_swiginit(self
,_core_
.new_PropagateOnce(*args
, **kwargs
))
4034 __swig_destroy__
= _core_
.delete_PropagateOnce
4035 __del__
= lambda self
: None;
4036 _core_
.PropagateOnce_swigregister(PropagateOnce
)
4038 #---------------------------------------------------------------------------
4040 class CommandEvent(Event
):
4042 This event class contains information about command events, which
4043 originate from a variety of simple controls, as well as menus and
4046 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4047 __repr__
= _swig_repr
4048 def __init__(self
, *args
, **kwargs
):
4050 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4052 This event class contains information about command events, which
4053 originate from a variety of simple controls, as well as menus and
4056 _core_
.CommandEvent_swiginit(self
,_core_
.new_CommandEvent(*args
, **kwargs
))
4057 def GetSelection(*args
, **kwargs
):
4059 GetSelection(self) -> int
4061 Returns item index for a listbox or choice selection event (not valid
4064 return _core_
.CommandEvent_GetSelection(*args
, **kwargs
)
4066 def SetString(*args
, **kwargs
):
4067 """SetString(self, String s)"""
4068 return _core_
.CommandEvent_SetString(*args
, **kwargs
)
4070 def GetString(*args
, **kwargs
):
4072 GetString(self) -> String
4074 Returns item string for a listbox or choice selection event (not valid
4077 return _core_
.CommandEvent_GetString(*args
, **kwargs
)
4079 def IsChecked(*args
, **kwargs
):
4081 IsChecked(self) -> bool
4083 This method can be used with checkbox and menu events: for the
4084 checkboxes, the method returns true for a selection event and false
4085 for a deselection one. For the menu events, this method indicates if
4086 the menu item just has become checked or unchecked (and thus only
4087 makes sense for checkable menu items).
4089 return _core_
.CommandEvent_IsChecked(*args
, **kwargs
)
4092 def IsSelection(*args
, **kwargs
):
4094 IsSelection(self) -> bool
4096 For a listbox or similar event, returns true if it is a selection,
4097 false if it is a deselection.
4099 return _core_
.CommandEvent_IsSelection(*args
, **kwargs
)
4101 def SetExtraLong(*args
, **kwargs
):
4102 """SetExtraLong(self, long extraLong)"""
4103 return _core_
.CommandEvent_SetExtraLong(*args
, **kwargs
)
4105 def GetExtraLong(*args
, **kwargs
):
4107 GetExtraLong(self) -> long
4109 Returns extra information dependant on the event objects type. If the
4110 event comes from a listbox selection, it is a boolean determining
4111 whether the event was a selection (true) or a deselection (false). A
4112 listbox deselection only occurs for multiple-selection boxes, and in
4113 this case the index and string values are indeterminate and the
4114 listbox must be examined by the application.
4116 return _core_
.CommandEvent_GetExtraLong(*args
, **kwargs
)
4118 def SetInt(*args
, **kwargs
):
4119 """SetInt(self, int i)"""
4120 return _core_
.CommandEvent_SetInt(*args
, **kwargs
)
4122 def GetInt(*args
, **kwargs
):
4126 Returns the integer identifier corresponding to a listbox, choice or
4127 radiobox selection (only if the event was a selection, not a
4128 deselection), or a boolean value representing the value of a checkbox.
4130 return _core_
.CommandEvent_GetInt(*args
, **kwargs
)
4132 def GetClientData(*args
, **kwargs
):
4134 GetClientData(self) -> PyObject
4136 Returns the client data object for a listbox or choice selection event, (if any.)
4138 return _core_
.CommandEvent_GetClientData(*args
, **kwargs
)
4140 def SetClientData(*args
, **kwargs
):
4142 SetClientData(self, PyObject clientData)
4144 Associate the given client data with the item at position n.
4146 return _core_
.CommandEvent_SetClientData(*args
, **kwargs
)
4148 GetClientObject
= GetClientData
4149 SetClientObject
= SetClientData
4151 def Clone(*args
, **kwargs
):
4152 """Clone(self) -> Event"""
4153 return _core_
.CommandEvent_Clone(*args
, **kwargs
)
4155 ClientData
= property(GetClientData
,SetClientData
,doc
="See `GetClientData` and `SetClientData`")
4156 ClientObject
= property(GetClientObject
,SetClientObject
,doc
="See `GetClientObject` and `SetClientObject`")
4157 ExtraLong
= property(GetExtraLong
,SetExtraLong
,doc
="See `GetExtraLong` and `SetExtraLong`")
4158 Int
= property(GetInt
,SetInt
,doc
="See `GetInt` and `SetInt`")
4159 Selection
= property(GetSelection
,doc
="See `GetSelection`")
4160 String
= property(GetString
,SetString
,doc
="See `GetString` and `SetString`")
4161 _core_
.CommandEvent_swigregister(CommandEvent
)
4163 #---------------------------------------------------------------------------
4165 class NotifyEvent(CommandEvent
):
4167 An instance of this class (or one of its derived classes) is sent from
4168 a control when the control's state is being changed and the control
4169 allows that change to be prevented from happening. The event handler
4170 can call `Veto` or `Allow` to tell the control what to do.
4172 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4173 __repr__
= _swig_repr
4174 def __init__(self
, *args
, **kwargs
):
4176 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4178 An instance of this class (or one of its derived classes) is sent from
4179 a control when the control's state is being changed and the control
4180 allows that change to be prevented from happening. The event handler
4181 can call `Veto` or `Allow` to tell the control what to do.
4183 _core_
.NotifyEvent_swiginit(self
,_core_
.new_NotifyEvent(*args
, **kwargs
))
4184 def Veto(*args
, **kwargs
):
4188 Prevents the change announced by this event from happening.
4190 It is in general a good idea to notify the user about the reasons for
4191 vetoing the change because otherwise the applications behaviour (which
4192 just refuses to do what the user wants) might be quite surprising.
4194 return _core_
.NotifyEvent_Veto(*args
, **kwargs
)
4196 def Allow(*args
, **kwargs
):
4200 This is the opposite of `Veto`: it explicitly allows the event to be
4201 processed. For most events it is not necessary to call this method as
4202 the events are allowed anyhow but some are forbidden by default (this
4203 will be mentioned in the corresponding event description).
4205 return _core_
.NotifyEvent_Allow(*args
, **kwargs
)
4207 def IsAllowed(*args
, **kwargs
):
4209 IsAllowed(self) -> bool
4211 Returns true if the change is allowed (`Veto` hasn't been called) or
4212 false otherwise (if it was).
4214 return _core_
.NotifyEvent_IsAllowed(*args
, **kwargs
)
4216 _core_
.NotifyEvent_swigregister(NotifyEvent
)
4218 #---------------------------------------------------------------------------
4220 class ScrollEvent(CommandEvent
):
4222 A scroll event holds information about events sent from stand-alone
4223 scrollbars and sliders. Note that scrolled windows do not send
4224 instnaces of this event class, but send the `wx.ScrollWinEvent`
4227 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4228 __repr__
= _swig_repr
4229 def __init__(self
, *args
, **kwargs
):
4231 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4232 int orient=0) -> ScrollEvent
4234 _core_
.ScrollEvent_swiginit(self
,_core_
.new_ScrollEvent(*args
, **kwargs
))
4235 def GetOrientation(*args
, **kwargs
):
4237 GetOrientation(self) -> int
4239 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4242 return _core_
.ScrollEvent_GetOrientation(*args
, **kwargs
)
4244 def GetPosition(*args
, **kwargs
):
4246 GetPosition(self) -> int
4248 Returns the position of the scrollbar.
4250 return _core_
.ScrollEvent_GetPosition(*args
, **kwargs
)
4252 def SetOrientation(*args
, **kwargs
):
4253 """SetOrientation(self, int orient)"""
4254 return _core_
.ScrollEvent_SetOrientation(*args
, **kwargs
)
4256 def SetPosition(*args
, **kwargs
):
4257 """SetPosition(self, int pos)"""
4258 return _core_
.ScrollEvent_SetPosition(*args
, **kwargs
)
4260 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4261 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4262 _core_
.ScrollEvent_swigregister(ScrollEvent
)
4264 #---------------------------------------------------------------------------
4266 class ScrollWinEvent(Event
):
4268 A wx.ScrollWinEvent holds information about scrolling and is sent from
4271 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4272 __repr__
= _swig_repr
4273 def __init__(self
, *args
, **kwargs
):
4275 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4277 A wx.ScrollWinEvent holds information about scrolling and is sent from
4280 _core_
.ScrollWinEvent_swiginit(self
,_core_
.new_ScrollWinEvent(*args
, **kwargs
))
4281 def GetOrientation(*args
, **kwargs
):
4283 GetOrientation(self) -> int
4285 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4288 return _core_
.ScrollWinEvent_GetOrientation(*args
, **kwargs
)
4290 def GetPosition(*args
, **kwargs
):
4292 GetPosition(self) -> int
4294 Returns the position of the scrollbar for the thumb track and release
4295 events. Note that this field can't be used for the other events, you
4296 need to query the window itself for the current position in that case.
4298 return _core_
.ScrollWinEvent_GetPosition(*args
, **kwargs
)
4300 def SetOrientation(*args
, **kwargs
):
4301 """SetOrientation(self, int orient)"""
4302 return _core_
.ScrollWinEvent_SetOrientation(*args
, **kwargs
)
4304 def SetPosition(*args
, **kwargs
):
4305 """SetPosition(self, int pos)"""
4306 return _core_
.ScrollWinEvent_SetPosition(*args
, **kwargs
)
4308 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
4309 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
4310 _core_
.ScrollWinEvent_swigregister(ScrollWinEvent
)
4312 #---------------------------------------------------------------------------
4314 MOUSE_BTN_ANY
= _core_
.MOUSE_BTN_ANY
4315 MOUSE_BTN_NONE
= _core_
.MOUSE_BTN_NONE
4316 MOUSE_BTN_LEFT
= _core_
.MOUSE_BTN_LEFT
4317 MOUSE_BTN_MIDDLE
= _core_
.MOUSE_BTN_MIDDLE
4318 MOUSE_BTN_RIGHT
= _core_
.MOUSE_BTN_RIGHT
4319 class MouseEvent(Event
):
4321 This event class contains information about the events generated by
4322 the mouse: they include mouse buttons press and release events and
4325 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4326 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4327 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4328 a middle button so a portable application should avoid relying on the
4331 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4332 the former returns true when the event corresponds to the left mouse
4333 button click while the latter returns true if the left mouse button is
4334 currently being pressed. For example, when the user is dragging the
4335 mouse you can use `LeftIsDown` to test whether the left mouse button
4336 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4337 `LeftIsDown` will also return true in wxWidgets whatever the
4338 underlying GUI behaviour is (which is platform-dependent). The same
4339 applies, of course, to other mouse buttons as well.
4341 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4342 __repr__
= _swig_repr
4343 def __init__(self
, *args
, **kwargs
):
4345 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4347 Constructs a wx.MouseEvent. Valid event types are:
4349 * wxEVT_ENTER_WINDOW
4350 * wxEVT_LEAVE_WINDOW
4356 * wxEVT_MIDDLE_DCLICK
4359 * wxEVT_RIGHT_DCLICK
4363 _core_
.MouseEvent_swiginit(self
,_core_
.new_MouseEvent(*args
, **kwargs
))
4364 def IsButton(*args
, **kwargs
):
4366 IsButton(self) -> bool
4368 Returns true if the event was a mouse button event (not necessarily a
4369 button down event - that may be tested using `ButtonDown`).
4371 return _core_
.MouseEvent_IsButton(*args
, **kwargs
)
4373 def ButtonDown(*args
, **kwargs
):
4375 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4377 If the argument is omitted, this returns true if the event was any
4378 mouse button down event. Otherwise the argument specifies which
4379 button-down event shold be checked for (see `Button` for the possible
4382 return _core_
.MouseEvent_ButtonDown(*args
, **kwargs
)
4384 def ButtonDClick(*args
, **kwargs
):
4386 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4388 If the argument is omitted, this returns true if the event was any
4389 mouse double click event. Otherwise the argument specifies which
4390 double click event to check for (see `Button` for the possible
4393 return _core_
.MouseEvent_ButtonDClick(*args
, **kwargs
)
4395 def ButtonUp(*args
, **kwargs
):
4397 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4399 If the argument is omitted, this returns true if the event was any
4400 mouse button up event. Otherwise the argument specifies which button
4401 up event to check for (see `Button` for the possible values).
4403 return _core_
.MouseEvent_ButtonUp(*args
, **kwargs
)
4405 def Button(*args
, **kwargs
):
4407 Button(self, int button) -> bool
4409 Returns true if the identified mouse button is changing state. Valid
4410 values of button are:
4412 ==================== =====================================
4413 wx.MOUSE_BTN_LEFT check if left button was pressed
4414 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4415 wx.MOUSE_BTN_RIGHT check if right button was pressed
4416 wx.MOUSE_BTN_ANY check if any button was pressed
4417 ==================== =====================================
4420 return _core_
.MouseEvent_Button(*args
, **kwargs
)
4422 def ButtonIsDown(*args
, **kwargs
):
4423 """ButtonIsDown(self, int but) -> bool"""
4424 return _core_
.MouseEvent_ButtonIsDown(*args
, **kwargs
)
4426 def GetButton(*args
, **kwargs
):
4428 GetButton(self) -> int
4430 Returns the mouse button which generated this event or
4431 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4432 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4433 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4434 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4435 right buttons respectively.
4437 return _core_
.MouseEvent_GetButton(*args
, **kwargs
)
4439 def ControlDown(*args
, **kwargs
):
4441 ControlDown(self) -> bool
4443 Returns true if the control key was down at the time of the event.
4445 return _core_
.MouseEvent_ControlDown(*args
, **kwargs
)
4447 def MetaDown(*args
, **kwargs
):
4449 MetaDown(self) -> bool
4451 Returns true if the Meta key was down at the time of the event.
4453 return _core_
.MouseEvent_MetaDown(*args
, **kwargs
)
4455 def AltDown(*args
, **kwargs
):
4457 AltDown(self) -> bool
4459 Returns true if the Alt key was down at the time of the event.
4461 return _core_
.MouseEvent_AltDown(*args
, **kwargs
)
4463 def ShiftDown(*args
, **kwargs
):
4465 ShiftDown(self) -> bool
4467 Returns true if the Shift key was down at the time of the event.
4469 return _core_
.MouseEvent_ShiftDown(*args
, **kwargs
)
4471 def CmdDown(*args
, **kwargs
):
4473 CmdDown(self) -> bool
4475 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4476 platforms but the special "Apple" (a.k.a as "Command") key on
4477 Macs. It often makes sense to use it instead of, say, `ControlDown`
4478 because Cmd key is used for the same thing under Mac as Ctrl
4479 elsewhere. The Ctrl key still exists, it's just not used for this
4480 purpose. So for non-Mac platforms this is the same as `ControlDown`
4481 and Macs this is the same as `MetaDown`.
4483 return _core_
.MouseEvent_CmdDown(*args
, **kwargs
)
4485 def LeftDown(*args
, **kwargs
):
4487 LeftDown(self) -> bool
4489 Returns true if the left mouse button state changed to down.
4491 return _core_
.MouseEvent_LeftDown(*args
, **kwargs
)
4493 def MiddleDown(*args
, **kwargs
):
4495 MiddleDown(self) -> bool
4497 Returns true if the middle mouse button state changed to down.
4499 return _core_
.MouseEvent_MiddleDown(*args
, **kwargs
)
4501 def RightDown(*args
, **kwargs
):
4503 RightDown(self) -> bool
4505 Returns true if the right mouse button state changed to down.
4507 return _core_
.MouseEvent_RightDown(*args
, **kwargs
)
4509 def LeftUp(*args
, **kwargs
):
4511 LeftUp(self) -> bool
4513 Returns true if the left mouse button state changed to up.
4515 return _core_
.MouseEvent_LeftUp(*args
, **kwargs
)
4517 def MiddleUp(*args
, **kwargs
):
4519 MiddleUp(self) -> bool
4521 Returns true if the middle mouse button state changed to up.
4523 return _core_
.MouseEvent_MiddleUp(*args
, **kwargs
)
4525 def RightUp(*args
, **kwargs
):
4527 RightUp(self) -> bool
4529 Returns true if the right mouse button state changed to up.
4531 return _core_
.MouseEvent_RightUp(*args
, **kwargs
)
4533 def LeftDClick(*args
, **kwargs
):
4535 LeftDClick(self) -> bool
4537 Returns true if the event was a left button double click.
4539 return _core_
.MouseEvent_LeftDClick(*args
, **kwargs
)
4541 def MiddleDClick(*args
, **kwargs
):
4543 MiddleDClick(self) -> bool
4545 Returns true if the event was a middle button double click.
4547 return _core_
.MouseEvent_MiddleDClick(*args
, **kwargs
)
4549 def RightDClick(*args
, **kwargs
):
4551 RightDClick(self) -> bool
4553 Returns true if the event was a right button double click.
4555 return _core_
.MouseEvent_RightDClick(*args
, **kwargs
)
4557 def LeftIsDown(*args
, **kwargs
):
4559 LeftIsDown(self) -> bool
4561 Returns true if the left mouse button is currently down, independent
4562 of the current event type.
4564 Please notice that it is not the same as LeftDown which returns true
4565 if the left mouse button was just pressed. Rather, it describes the
4566 state of the mouse button before the event happened.
4568 This event is usually used in the mouse event handlers which process
4569 "move mouse" messages to determine whether the user is (still)
4572 return _core_
.MouseEvent_LeftIsDown(*args
, **kwargs
)
4574 def MiddleIsDown(*args
, **kwargs
):
4576 MiddleIsDown(self) -> bool
4578 Returns true if the middle mouse button is currently down, independent
4579 of the current event type.
4581 return _core_
.MouseEvent_MiddleIsDown(*args
, **kwargs
)
4583 def RightIsDown(*args
, **kwargs
):
4585 RightIsDown(self) -> bool
4587 Returns true if the right mouse button is currently down, independent
4588 of the current event type.
4590 return _core_
.MouseEvent_RightIsDown(*args
, **kwargs
)
4592 def Dragging(*args
, **kwargs
):
4594 Dragging(self) -> bool
4596 Returns true if this was a dragging event (motion while a button is
4599 return _core_
.MouseEvent_Dragging(*args
, **kwargs
)
4601 def Moving(*args
, **kwargs
):
4603 Moving(self) -> bool
4605 Returns true if this was a motion event and no mouse buttons were
4606 pressed. If any mouse button is held pressed, then this method returns
4607 false and Dragging returns true.
4609 return _core_
.MouseEvent_Moving(*args
, **kwargs
)
4611 def Entering(*args
, **kwargs
):
4613 Entering(self) -> bool
4615 Returns true if the mouse was entering the window.
4617 return _core_
.MouseEvent_Entering(*args
, **kwargs
)
4619 def Leaving(*args
, **kwargs
):
4621 Leaving(self) -> bool
4623 Returns true if the mouse was leaving the window.
4625 return _core_
.MouseEvent_Leaving(*args
, **kwargs
)
4627 def GetPosition(*args
, **kwargs
):
4629 GetPosition(self) -> Point
4631 Returns the pixel position of the mouse in window coordinates when the
4634 return _core_
.MouseEvent_GetPosition(*args
, **kwargs
)
4636 def GetPositionTuple(*args
, **kwargs
):
4638 GetPositionTuple() -> (x,y)
4640 Returns the pixel position of the mouse in window coordinates when the
4643 return _core_
.MouseEvent_GetPositionTuple(*args
, **kwargs
)
4645 def GetLogicalPosition(*args
, **kwargs
):
4647 GetLogicalPosition(self, DC dc) -> Point
4649 Returns the logical mouse position in pixels (i.e. translated
4650 according to the translation set for the DC, which usually indicates
4651 that the window has been scrolled).
4653 return _core_
.MouseEvent_GetLogicalPosition(*args
, **kwargs
)
4655 def GetX(*args
, **kwargs
):
4659 Returns X coordinate of the physical mouse event position.
4661 return _core_
.MouseEvent_GetX(*args
, **kwargs
)
4663 def GetY(*args
, **kwargs
):
4667 Returns Y coordinate of the physical mouse event position.
4669 return _core_
.MouseEvent_GetY(*args
, **kwargs
)
4671 def GetWheelRotation(*args
, **kwargs
):
4673 GetWheelRotation(self) -> int
4675 Get wheel rotation, positive or negative indicates direction of
4676 rotation. Current devices all send an event when rotation is equal to
4677 +/-WheelDelta, but this allows for finer resolution devices to be
4678 created in the future. Because of this you shouldn't assume that one
4679 event is equal to 1 line or whatever, but you should be able to either
4680 do partial line scrolling or wait until +/-WheelDelta rotation values
4681 have been accumulated before scrolling.
4683 return _core_
.MouseEvent_GetWheelRotation(*args
, **kwargs
)
4685 def GetWheelDelta(*args
, **kwargs
):
4687 GetWheelDelta(self) -> int
4689 Get wheel delta, normally 120. This is the threshold for action to be
4690 taken, and one such action (for example, scrolling one increment)
4691 should occur for each delta.
4693 return _core_
.MouseEvent_GetWheelDelta(*args
, **kwargs
)
4695 def GetLinesPerAction(*args
, **kwargs
):
4697 GetLinesPerAction(self) -> int
4699 Returns the configured number of lines (or whatever) to be scrolled
4700 per wheel action. Defaults to three.
4702 return _core_
.MouseEvent_GetLinesPerAction(*args
, **kwargs
)
4704 def IsPageScroll(*args
, **kwargs
):
4706 IsPageScroll(self) -> bool
4708 Returns true if the system has been setup to do page scrolling with
4709 the mouse wheel instead of line scrolling.
4711 return _core_
.MouseEvent_IsPageScroll(*args
, **kwargs
)
4713 m_x
= property(_core_
.MouseEvent_m_x_get
, _core_
.MouseEvent_m_x_set
)
4714 m_y
= property(_core_
.MouseEvent_m_y_get
, _core_
.MouseEvent_m_y_set
)
4715 m_leftDown
= property(_core_
.MouseEvent_m_leftDown_get
, _core_
.MouseEvent_m_leftDown_set
)
4716 m_middleDown
= property(_core_
.MouseEvent_m_middleDown_get
, _core_
.MouseEvent_m_middleDown_set
)
4717 m_rightDown
= property(_core_
.MouseEvent_m_rightDown_get
, _core_
.MouseEvent_m_rightDown_set
)
4718 m_controlDown
= property(_core_
.MouseEvent_m_controlDown_get
, _core_
.MouseEvent_m_controlDown_set
)
4719 m_shiftDown
= property(_core_
.MouseEvent_m_shiftDown_get
, _core_
.MouseEvent_m_shiftDown_set
)
4720 m_altDown
= property(_core_
.MouseEvent_m_altDown_get
, _core_
.MouseEvent_m_altDown_set
)
4721 m_metaDown
= property(_core_
.MouseEvent_m_metaDown_get
, _core_
.MouseEvent_m_metaDown_set
)
4722 m_wheelRotation
= property(_core_
.MouseEvent_m_wheelRotation_get
, _core_
.MouseEvent_m_wheelRotation_set
)
4723 m_wheelDelta
= property(_core_
.MouseEvent_m_wheelDelta_get
, _core_
.MouseEvent_m_wheelDelta_set
)
4724 m_linesPerAction
= property(_core_
.MouseEvent_m_linesPerAction_get
, _core_
.MouseEvent_m_linesPerAction_set
)
4725 Button
= property(GetButton
,doc
="See `GetButton`")
4726 LinesPerAction
= property(GetLinesPerAction
,doc
="See `GetLinesPerAction`")
4727 LogicalPosition
= property(GetLogicalPosition
,doc
="See `GetLogicalPosition`")
4728 Position
= property(GetPosition
,doc
="See `GetPosition`")
4729 WheelDelta
= property(GetWheelDelta
,doc
="See `GetWheelDelta`")
4730 WheelRotation
= property(GetWheelRotation
,doc
="See `GetWheelRotation`")
4731 X
= property(GetX
,doc
="See `GetX`")
4732 Y
= property(GetY
,doc
="See `GetY`")
4733 _core_
.MouseEvent_swigregister(MouseEvent
)
4735 #---------------------------------------------------------------------------
4737 class SetCursorEvent(Event
):
4739 A SetCursorEvent is generated when the mouse cursor is about to be set
4740 as a result of mouse motion. This event gives the application the
4741 chance to perform specific mouse cursor processing based on the
4742 current position of the mouse within the window. Use the `SetCursor`
4743 method to specify the cursor you want to be displayed.
4745 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4746 __repr__
= _swig_repr
4747 def __init__(self
, *args
, **kwargs
):
4749 __init__(self, int x=0, int y=0) -> SetCursorEvent
4751 Construct a new `wx.SetCursorEvent`.
4753 _core_
.SetCursorEvent_swiginit(self
,_core_
.new_SetCursorEvent(*args
, **kwargs
))
4754 def GetX(*args
, **kwargs
):
4758 Returns the X coordinate of the mouse in client coordinates.
4760 return _core_
.SetCursorEvent_GetX(*args
, **kwargs
)
4762 def GetY(*args
, **kwargs
):
4766 Returns the Y coordinate of the mouse in client coordinates.
4768 return _core_
.SetCursorEvent_GetY(*args
, **kwargs
)
4770 def SetCursor(*args
, **kwargs
):
4772 SetCursor(self, Cursor cursor)
4774 Sets the cursor associated with this event.
4776 return _core_
.SetCursorEvent_SetCursor(*args
, **kwargs
)
4778 def GetCursor(*args
, **kwargs
):
4780 GetCursor(self) -> Cursor
4782 Returns a reference to the cursor specified by this event.
4784 return _core_
.SetCursorEvent_GetCursor(*args
, **kwargs
)
4786 def HasCursor(*args
, **kwargs
):
4788 HasCursor(self) -> bool
4790 Returns true if the cursor specified by this event is a valid cursor.
4792 return _core_
.SetCursorEvent_HasCursor(*args
, **kwargs
)
4794 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
4795 X
= property(GetX
,doc
="See `GetX`")
4796 Y
= property(GetY
,doc
="See `GetY`")
4797 _core_
.SetCursorEvent_swigregister(SetCursorEvent
)
4799 #---------------------------------------------------------------------------
4801 class KeyEvent(Event
):
4803 This event class contains information about keypress and character
4804 events. These events are only sent to the widget that currently has
4807 Notice that there are three different kinds of keyboard events in
4808 wxWidgets: key down and up events and char events. The difference
4809 between the first two is clear - the first corresponds to a key press
4810 and the second to a key release - otherwise they are identical. Just
4811 note that if the key is maintained in a pressed state you will
4812 typically get a lot of (automatically generated) down events but only
4813 one up so it is wrong to assume that there is one up event
4814 corresponding to each down one.
4816 Both key events provide untranslated key codes while the char event
4817 carries the translated one. The untranslated code for alphanumeric
4818 keys is always an upper case value. For the other keys it is one of
4819 WXK_XXX values from the keycodes table. The translated key is, in
4820 general, the character the user expects to appear as the result of the
4821 key combination when typing the text into a text entry zone, for
4824 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4825 and the standard US keyboard): when the 'A' key is pressed, the key
4826 down event key code is equal to ASCII A == 65. But the char event key
4827 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4828 'A' keys simultaneously , the key code in key down event will still be
4829 just 'A' while the char event key code parameter will now be 'A' as
4832 Although in this simple case it is clear that the correct key code
4833 could be found in the key down event handler by checking the value
4834 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4835 as for non alphanumeric keys or non-US keyboard layouts the
4836 translation is keyboard-layout dependent and can only be done properly
4837 by the system itself.
4839 Another kind of translation is done when the control key is pressed:
4840 for example, for CTRL-A key press the key down event still carries the
4841 same key code 'A' as usual but the char event will have key code of 1,
4842 the ASCII value of this key combination.
4844 You may discover how the other keys on your system behave
4845 interactively by running the KeyEvents sample in the wxPython demo and
4846 pressing some keys while the blue box at the top has the keyboard
4849 **Note**: If a key down event is caught and the event handler does not
4850 call event.Skip() then the coresponding char event will not
4851 happen. This is by design and enables the programs that handle both
4852 types of events to be a bit simpler.
4854 **Note for Windows programmers**: The key and char events in wxWidgets
4855 are similar to but slightly different from Windows WM_KEYDOWN and
4856 WM_CHAR events. In particular, Alt-x combination will generate a char
4857 event in wxWidgets (unless it is used as an accelerator).
4859 **Tip**: be sure to call event.Skip() for events that you don't
4860 process in key event function, otherwise menu shortcuts may cease to
4864 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4865 __repr__
= _swig_repr
4866 def __init__(self
, *args
, **kwargs
):
4868 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4870 Construct a new `wx.KeyEvent`. Valid event types are:
4873 _core_
.KeyEvent_swiginit(self
,_core_
.new_KeyEvent(*args
, **kwargs
))
4874 def GetModifiers(*args
, **kwargs
):
4876 GetModifiers(self) -> int
4878 Returns a bitmask of the current modifier settings. Can be used to
4879 check if the key event has exactly the given modifiers without having
4880 to explicitly check that the other modifiers are not down. For
4883 if event.GetModifers() == wx.MOD_CONTROL:
4887 return _core_
.KeyEvent_GetModifiers(*args
, **kwargs
)
4889 def ControlDown(*args
, **kwargs
):
4891 ControlDown(self) -> bool
4893 Returns ``True`` if the Control key was down at the time of the event.
4895 return _core_
.KeyEvent_ControlDown(*args
, **kwargs
)
4897 def MetaDown(*args
, **kwargs
):
4899 MetaDown(self) -> bool
4901 Returns ``True`` if the Meta key was down at the time of the event.
4903 return _core_
.KeyEvent_MetaDown(*args
, **kwargs
)
4905 def AltDown(*args
, **kwargs
):
4907 AltDown(self) -> bool
4909 Returns ``True`` if the Alt key was down at the time of the event.
4911 return _core_
.KeyEvent_AltDown(*args
, **kwargs
)
4913 def ShiftDown(*args
, **kwargs
):
4915 ShiftDown(self) -> bool
4917 Returns ``True`` if the Shift key was down at the time of the event.
4919 return _core_
.KeyEvent_ShiftDown(*args
, **kwargs
)
4921 def CmdDown(*args
, **kwargs
):
4923 CmdDown(self) -> bool
4925 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4926 platforms but the special "Apple" (a.k.a as "Command") key on
4927 Macs. It makes often sense to use it instead of, say, `ControlDown`
4928 because Cmd key is used for the same thing under Mac as Ctrl
4929 elsewhere. The Ctrl still exists, it's just not used for this
4930 purpose. So for non-Mac platforms this is the same as `ControlDown`
4931 and Macs this is the same as `MetaDown`.
4933 return _core_
.KeyEvent_CmdDown(*args
, **kwargs
)
4935 def HasModifiers(*args
, **kwargs
):
4937 HasModifiers(self) -> bool
4939 Returns true if either CTRL or ALT keys was down at the time of the
4940 key event. Note that this function does not take into account neither
4941 SHIFT nor META key states (the reason for ignoring the latter is that
4942 it is common for NUMLOCK key to be configured as META under X but the
4943 key presses even while NUMLOCK is on should be still processed
4946 return _core_
.KeyEvent_HasModifiers(*args
, **kwargs
)
4948 def GetKeyCode(*args
, **kwargs
):
4950 GetKeyCode(self) -> int
4952 Returns the virtual key code. ASCII events return normal ASCII values,
4953 while non-ASCII events return values such as WXK_LEFT for the left
4954 cursor key. See `wx.KeyEvent` for a full list of the virtual key
4957 Note that in Unicode build, the returned value is meaningful only if
4958 the user entered a character that can be represented in current
4959 locale's default charset. You can obtain the corresponding Unicode
4960 character using `GetUnicodeKey`.
4962 return _core_
.KeyEvent_GetKeyCode(*args
, **kwargs
)
4964 def GetUnicodeKey(*args
, **kwargs
):
4966 GetUnicodeKey(self) -> int
4968 Returns the Unicode character corresponding to this key event. This
4969 function is only meaningfule in a Unicode build of wxPython.
4971 return _core_
.KeyEvent_GetUnicodeKey(*args
, **kwargs
)
4973 GetUniChar
= GetUnicodeKey
4974 def SetUnicodeKey(*args
, **kwargs
):
4976 SetUnicodeKey(self, int uniChar)
4978 Set the Unicode value of the key event, but only if this is a Unicode
4981 return _core_
.KeyEvent_SetUnicodeKey(*args
, **kwargs
)
4983 def GetRawKeyCode(*args
, **kwargs
):
4985 GetRawKeyCode(self) -> unsigned int
4987 Returns the raw key code for this event. This is a platform-dependent
4988 scan code which should only be used in advanced
4989 applications. Currently the raw key codes are not supported by all
4992 return _core_
.KeyEvent_GetRawKeyCode(*args
, **kwargs
)
4994 def GetRawKeyFlags(*args
, **kwargs
):
4996 GetRawKeyFlags(self) -> unsigned int
4998 Returns the low level key flags for this event. The flags are
4999 platform-dependent and should only be used in advanced applications.
5000 Currently the raw key flags are not supported by all ports.
5002 return _core_
.KeyEvent_GetRawKeyFlags(*args
, **kwargs
)
5004 def GetPosition(*args
, **kwargs
):
5006 GetPosition(self) -> Point
5008 Find the position of the event, if applicable.
5010 return _core_
.KeyEvent_GetPosition(*args
, **kwargs
)
5012 def GetPositionTuple(*args
, **kwargs
):
5014 GetPositionTuple() -> (x,y)
5016 Find the position of the event, if applicable.
5018 return _core_
.KeyEvent_GetPositionTuple(*args
, **kwargs
)
5020 def GetX(*args
, **kwargs
):
5024 Returns the X position (in client coordinates) of the event, if
5027 return _core_
.KeyEvent_GetX(*args
, **kwargs
)
5029 def GetY(*args
, **kwargs
):
5033 Returns the Y position (in client coordinates) of the event, if
5036 return _core_
.KeyEvent_GetY(*args
, **kwargs
)
5038 m_x
= property(_core_
.KeyEvent_m_x_get
, _core_
.KeyEvent_m_x_set
)
5039 m_y
= property(_core_
.KeyEvent_m_y_get
, _core_
.KeyEvent_m_y_set
)
5040 m_keyCode
= property(_core_
.KeyEvent_m_keyCode_get
, _core_
.KeyEvent_m_keyCode_set
)
5041 m_controlDown
= property(_core_
.KeyEvent_m_controlDown_get
, _core_
.KeyEvent_m_controlDown_set
)
5042 m_shiftDown
= property(_core_
.KeyEvent_m_shiftDown_get
, _core_
.KeyEvent_m_shiftDown_set
)
5043 m_altDown
= property(_core_
.KeyEvent_m_altDown_get
, _core_
.KeyEvent_m_altDown_set
)
5044 m_metaDown
= property(_core_
.KeyEvent_m_metaDown_get
, _core_
.KeyEvent_m_metaDown_set
)
5045 m_scanCode
= property(_core_
.KeyEvent_m_scanCode_get
, _core_
.KeyEvent_m_scanCode_set
)
5046 m_rawCode
= property(_core_
.KeyEvent_m_rawCode_get
, _core_
.KeyEvent_m_rawCode_set
)
5047 m_rawFlags
= property(_core_
.KeyEvent_m_rawFlags_get
, _core_
.KeyEvent_m_rawFlags_set
)
5048 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
5049 Modifiers
= property(GetModifiers
,doc
="See `GetModifiers`")
5050 Position
= property(GetPosition
,doc
="See `GetPosition`")
5051 RawKeyCode
= property(GetRawKeyCode
,doc
="See `GetRawKeyCode`")
5052 RawKeyFlags
= property(GetRawKeyFlags
,doc
="See `GetRawKeyFlags`")
5053 UnicodeKey
= property(GetUnicodeKey
,SetUnicodeKey
,doc
="See `GetUnicodeKey` and `SetUnicodeKey`")
5054 X
= property(GetX
,doc
="See `GetX`")
5055 Y
= property(GetY
,doc
="See `GetY`")
5056 _core_
.KeyEvent_swigregister(KeyEvent
)
5058 #---------------------------------------------------------------------------
5060 class SizeEvent(Event
):
5062 A size event holds information about size change events. The EVT_SIZE
5063 handler function will be called when the window it is bound to has
5066 Note that the size passed is of the whole window: call
5067 `wx.Window.GetClientSize` for the area which may be used by the
5070 When a window is resized, usually only a small part of the window is
5071 damaged and and that area is all that is in the update region for the
5072 next paint event. However, if your drawing depends on the size of the
5073 window, you may need to clear the DC explicitly and repaint the whole
5074 window. In which case, you may need to call `wx.Window.Refresh` to
5075 invalidate the entire window.
5078 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5079 __repr__
= _swig_repr
5080 def __init__(self
, *args
, **kwargs
):
5082 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5084 Construct a new ``wx.SizeEvent``.
5086 _core_
.SizeEvent_swiginit(self
,_core_
.new_SizeEvent(*args
, **kwargs
))
5087 def GetSize(*args
, **kwargs
):
5089 GetSize(self) -> Size
5091 Returns the entire size of the window generating the size change
5094 return _core_
.SizeEvent_GetSize(*args
, **kwargs
)
5096 def GetRect(*args
, **kwargs
):
5097 """GetRect(self) -> Rect"""
5098 return _core_
.SizeEvent_GetRect(*args
, **kwargs
)
5100 def SetRect(*args
, **kwargs
):
5101 """SetRect(self, Rect rect)"""
5102 return _core_
.SizeEvent_SetRect(*args
, **kwargs
)
5104 def SetSize(*args
, **kwargs
):
5105 """SetSize(self, Size size)"""
5106 return _core_
.SizeEvent_SetSize(*args
, **kwargs
)
5108 m_size
= property(_core_
.SizeEvent_m_size_get
, _core_
.SizeEvent_m_size_set
)
5109 m_rect
= property(_core_
.SizeEvent_m_rect_get
, _core_
.SizeEvent_m_rect_set
)
5110 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5111 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
5112 _core_
.SizeEvent_swigregister(SizeEvent
)
5114 #---------------------------------------------------------------------------
5116 class MoveEvent(Event
):
5118 This event object is sent for EVT_MOVE event bindings when a window is
5119 moved to a new position.
5121 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5122 __repr__
= _swig_repr
5123 def __init__(self
, *args
, **kwargs
):
5125 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5129 _core_
.MoveEvent_swiginit(self
,_core_
.new_MoveEvent(*args
, **kwargs
))
5130 def GetPosition(*args
, **kwargs
):
5132 GetPosition(self) -> Point
5134 Returns the position of the window generating the move change event.
5136 return _core_
.MoveEvent_GetPosition(*args
, **kwargs
)
5138 def GetRect(*args
, **kwargs
):
5139 """GetRect(self) -> Rect"""
5140 return _core_
.MoveEvent_GetRect(*args
, **kwargs
)
5142 def SetRect(*args
, **kwargs
):
5143 """SetRect(self, Rect rect)"""
5144 return _core_
.MoveEvent_SetRect(*args
, **kwargs
)
5146 def SetPosition(*args
, **kwargs
):
5147 """SetPosition(self, Point pos)"""
5148 return _core_
.MoveEvent_SetPosition(*args
, **kwargs
)
5150 m_pos
= property(GetPosition
, SetPosition
)
5151 m_rect
= property(GetRect
, SetRect
)
5153 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
5154 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
5155 _core_
.MoveEvent_swigregister(MoveEvent
)
5157 #---------------------------------------------------------------------------
5159 class PaintEvent(Event
):
5161 A paint event is sent when a window's contents needs to be repainted.
5162 Note that in an EVT_PAINT handler the application must *always* create
5163 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5164 Windows assumes that the window has not been painted yet and will send
5165 the event again, causing endless refreshes.
5167 You can optimize painting by retrieving the rectangles that have been
5168 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5169 and only repainting these rectangles. The rectangles are in terms of
5170 the client area, and are unscrolled, so you will need to do some
5171 calculations using the current view position to obtain logical,
5175 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5176 __repr__
= _swig_repr
5177 def __init__(self
, *args
, **kwargs
):
5178 """__init__(self, int Id=0) -> PaintEvent"""
5179 _core_
.PaintEvent_swiginit(self
,_core_
.new_PaintEvent(*args
, **kwargs
))
5180 _core_
.PaintEvent_swigregister(PaintEvent
)
5182 class NcPaintEvent(Event
):
5183 """Proxy of C++ NcPaintEvent class"""
5184 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5185 __repr__
= _swig_repr
5186 def __init__(self
, *args
, **kwargs
):
5187 """__init__(self, int winid=0) -> NcPaintEvent"""
5188 _core_
.NcPaintEvent_swiginit(self
,_core_
.new_NcPaintEvent(*args
, **kwargs
))
5189 _core_
.NcPaintEvent_swigregister(NcPaintEvent
)
5191 #---------------------------------------------------------------------------
5193 class EraseEvent(Event
):
5195 An erase event is sent whenever the background of a window needs to be
5196 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5197 binder. On some platforms, such as GTK+, this event is simulated
5198 (simply generated just before the paint event) and may cause flicker.
5200 To paint a custom background use the `GetDC` method and use the returned
5201 device context if it is not ``None``, otherwise create a temporary
5202 `wx.ClientDC` and draw on that.
5205 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5206 __repr__
= _swig_repr
5207 def __init__(self
, *args
, **kwargs
):
5209 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5213 _core_
.EraseEvent_swiginit(self
,_core_
.new_EraseEvent(*args
, **kwargs
))
5214 def GetDC(*args
, **kwargs
):
5218 Returns the device context the event handler should draw upon. If
5219 ``None`` is returned then create a temporary `wx.ClientDC` and use
5222 return _core_
.EraseEvent_GetDC(*args
, **kwargs
)
5224 DC
= property(GetDC
,doc
="See `GetDC`")
5225 _core_
.EraseEvent_swigregister(EraseEvent
)
5227 #---------------------------------------------------------------------------
5229 class FocusEvent(Event
):
5231 A focus event is sent when a window's focus changes. The window losing
5232 focus receives an EVT_KILL_FOCUS event while the window gaining it
5233 gets an EVT_SET_FOCUS event.
5235 Notice that the set focus event happens both when the user gives focus
5236 to the window (whether using the mouse or keyboard) and when it is
5237 done from the program itself using `wx.Window.SetFocus`.
5240 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5241 __repr__
= _swig_repr
5242 def __init__(self
, *args
, **kwargs
):
5244 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5248 _core_
.FocusEvent_swiginit(self
,_core_
.new_FocusEvent(*args
, **kwargs
))
5249 def GetWindow(*args
, **kwargs
):
5251 GetWindow(self) -> Window
5253 Returns the other window associated with this event, that is the
5254 window which had the focus before for the EVT_SET_FOCUS event and the
5255 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5257 Warning: the window returned may be None!
5259 return _core_
.FocusEvent_GetWindow(*args
, **kwargs
)
5261 def SetWindow(*args
, **kwargs
):
5262 """SetWindow(self, Window win)"""
5263 return _core_
.FocusEvent_SetWindow(*args
, **kwargs
)
5265 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
5266 _core_
.FocusEvent_swigregister(FocusEvent
)
5268 #---------------------------------------------------------------------------
5270 class ChildFocusEvent(CommandEvent
):
5272 A child focus event is sent to a (parent-)window when one of its child
5273 windows gains focus, so that the window could restore the focus back
5274 to its corresponding child if it loses it now and regains later.
5276 Notice that child window is the direct child of the window receiving
5277 the event, and so may not be the actual widget recieving focus if it
5278 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5279 to get the widget that is actually receiving focus.
5281 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5282 __repr__
= _swig_repr
5283 def __init__(self
, *args
, **kwargs
):
5285 __init__(self, Window win=None) -> ChildFocusEvent
5289 _core_
.ChildFocusEvent_swiginit(self
,_core_
.new_ChildFocusEvent(*args
, **kwargs
))
5290 def GetWindow(*args
, **kwargs
):
5292 GetWindow(self) -> Window
5294 The window, or (grand)parent of the window which has just received the
5297 return _core_
.ChildFocusEvent_GetWindow(*args
, **kwargs
)
5299 Window
= property(GetWindow
,doc
="See `GetWindow`")
5300 _core_
.ChildFocusEvent_swigregister(ChildFocusEvent
)
5302 #---------------------------------------------------------------------------
5304 class ActivateEvent(Event
):
5306 An activate event is sent when a top-level window or the entire
5307 application is being activated or deactivated.
5309 A top-level window (a dialog or frame) receives an activate event when
5310 is being activated or deactivated. This is indicated visually by the
5311 title bar changing colour, and a subwindow gaining the keyboard focus.
5312 An application is activated or deactivated when one of its frames
5313 becomes activated, or a frame becomes inactivate resulting in all
5314 application frames being inactive.
5316 Please note that usually you should call event.Skip() in your handlers
5317 for these events so the default handlers will still be called, as not
5318 doing so can result in strange effects.
5321 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5322 __repr__
= _swig_repr
5323 def __init__(self
, *args
, **kwargs
):
5325 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5329 _core_
.ActivateEvent_swiginit(self
,_core_
.new_ActivateEvent(*args
, **kwargs
))
5330 def GetActive(*args
, **kwargs
):
5332 GetActive(self) -> bool
5334 Returns true if the application or window is being activated, false
5337 return _core_
.ActivateEvent_GetActive(*args
, **kwargs
)
5339 Active
= property(GetActive
,doc
="See `GetActive`")
5340 _core_
.ActivateEvent_swigregister(ActivateEvent
)
5342 #---------------------------------------------------------------------------
5344 class InitDialogEvent(Event
):
5346 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5347 any window when `wx.Window.InitDialog` is called. Handlers for this
5348 event can transfer data to the window, or anything else that should be
5349 done before the user begins editing the form. The default handler
5350 calls `wx.Window.TransferDataToWindow`.
5352 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5353 __repr__
= _swig_repr
5354 def __init__(self
, *args
, **kwargs
):
5356 __init__(self, int Id=0) -> InitDialogEvent
5360 _core_
.InitDialogEvent_swiginit(self
,_core_
.new_InitDialogEvent(*args
, **kwargs
))
5361 _core_
.InitDialogEvent_swigregister(InitDialogEvent
)
5363 #---------------------------------------------------------------------------
5365 class MenuEvent(Event
):
5367 This class is used for a variety of menu-related events. Note that
5368 these do not include menu command events, which are handled by sending
5369 `wx.CommandEvent` objects.
5371 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5372 text in the first field of the status bar.
5374 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5375 __repr__
= _swig_repr
5376 def __init__(self
, *args
, **kwargs
):
5378 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5382 _core_
.MenuEvent_swiginit(self
,_core_
.new_MenuEvent(*args
, **kwargs
))
5383 def GetMenuId(*args
, **kwargs
):
5385 GetMenuId(self) -> int
5387 Returns the menu identifier associated with the event. This method
5388 should be only used with the HIGHLIGHT events.
5390 return _core_
.MenuEvent_GetMenuId(*args
, **kwargs
)
5392 def IsPopup(*args
, **kwargs
):
5394 IsPopup(self) -> bool
5396 Returns ``True`` if the menu which is being opened or closed is a
5397 popup menu, ``False`` if it is a normal one. This method should only
5398 be used with the OPEN and CLOSE events.
5400 return _core_
.MenuEvent_IsPopup(*args
, **kwargs
)
5402 def GetMenu(*args
, **kwargs
):
5404 GetMenu(self) -> Menu
5406 Returns the menu which is being opened or closed. This method should
5407 only be used with the OPEN and CLOSE events.
5409 return _core_
.MenuEvent_GetMenu(*args
, **kwargs
)
5411 Menu
= property(GetMenu
,doc
="See `GetMenu`")
5412 MenuId
= property(GetMenuId
,doc
="See `GetMenuId`")
5413 _core_
.MenuEvent_swigregister(MenuEvent
)
5415 #---------------------------------------------------------------------------
5417 class CloseEvent(Event
):
5419 This event class contains information about window and session close
5422 The handler function for EVT_CLOSE is called when the user has tried
5423 to close a a frame or dialog box using the window manager controls or
5424 the system menu. It can also be invoked by the application itself
5425 programmatically, for example by calling the `wx.Window.Close`
5428 You should check whether the application is forcing the deletion of
5429 the window using `CanVeto`. If it returns ``False``, you must destroy
5430 the window using `wx.Window.Destroy`. If the return value is ``True``,
5431 it is up to you whether you respond by destroying the window or not.
5432 For example you may wish to display a message dialog prompting to save
5433 files or to cancel the close.
5435 If you don't destroy the window, you should call `Veto` to let the
5436 calling code know that you did not destroy the window. This allows the
5437 `wx.Window.Close` function to return ``True`` or ``False`` depending
5438 on whether the close instruction was honored or not.
5440 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5441 __repr__
= _swig_repr
5442 def __init__(self
, *args
, **kwargs
):
5444 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5448 _core_
.CloseEvent_swiginit(self
,_core_
.new_CloseEvent(*args
, **kwargs
))
5449 def SetLoggingOff(*args
, **kwargs
):
5451 SetLoggingOff(self, bool logOff)
5453 Sets the 'logging off' flag.
5455 return _core_
.CloseEvent_SetLoggingOff(*args
, **kwargs
)
5457 def GetLoggingOff(*args
, **kwargs
):
5459 GetLoggingOff(self) -> bool
5461 Returns ``True`` if the user is logging off or ``False`` if the
5462 system is shutting down. This method can only be called for end
5463 session and query end session events, it doesn't make sense for close
5466 return _core_
.CloseEvent_GetLoggingOff(*args
, **kwargs
)
5468 def Veto(*args
, **kwargs
):
5470 Veto(self, bool veto=True)
5472 Call this from your event handler to veto a system shutdown or to
5473 signal to the calling application that a window close did not happen.
5475 You can only veto a shutdown or close if `CanVeto` returns true.
5477 return _core_
.CloseEvent_Veto(*args
, **kwargs
)
5479 def GetVeto(*args
, **kwargs
):
5480 """GetVeto(self) -> bool"""
5481 return _core_
.CloseEvent_GetVeto(*args
, **kwargs
)
5483 def SetCanVeto(*args
, **kwargs
):
5485 SetCanVeto(self, bool canVeto)
5487 Sets the 'can veto' flag.
5489 return _core_
.CloseEvent_SetCanVeto(*args
, **kwargs
)
5491 def CanVeto(*args
, **kwargs
):
5493 CanVeto(self) -> bool
5495 Returns true if you can veto a system shutdown or a window close
5496 event. Vetoing a window close event is not possible if the calling
5497 code wishes to force the application to exit, and so this function
5498 must be called to check this.
5500 return _core_
.CloseEvent_CanVeto(*args
, **kwargs
)
5502 LoggingOff
= property(GetLoggingOff
,SetLoggingOff
,doc
="See `GetLoggingOff` and `SetLoggingOff`")
5503 _core_
.CloseEvent_swigregister(CloseEvent
)
5505 #---------------------------------------------------------------------------
5507 class ShowEvent(Event
):
5508 """An EVT_SHOW event is sent when a window is shown or hidden."""
5509 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5510 __repr__
= _swig_repr
5511 def __init__(self
, *args
, **kwargs
):
5513 __init__(self, int winid=0, bool show=False) -> ShowEvent
5515 An EVT_SHOW event is sent when a window is shown or hidden.
5517 _core_
.ShowEvent_swiginit(self
,_core_
.new_ShowEvent(*args
, **kwargs
))
5518 def SetShow(*args
, **kwargs
):
5519 """SetShow(self, bool show)"""
5520 return _core_
.ShowEvent_SetShow(*args
, **kwargs
)
5522 def GetShow(*args
, **kwargs
):
5523 """GetShow(self) -> bool"""
5524 return _core_
.ShowEvent_GetShow(*args
, **kwargs
)
5526 Show
= property(GetShow
,SetShow
,doc
="See `GetShow` and `SetShow`")
5527 _core_
.ShowEvent_swigregister(ShowEvent
)
5529 #---------------------------------------------------------------------------
5531 class IconizeEvent(Event
):
5533 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5536 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5537 __repr__
= _swig_repr
5538 def __init__(self
, *args
, **kwargs
):
5540 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5542 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5545 _core_
.IconizeEvent_swiginit(self
,_core_
.new_IconizeEvent(*args
, **kwargs
))
5546 def Iconized(*args
, **kwargs
):
5548 Iconized(self) -> bool
5550 Returns ``True`` if the frame has been iconized, ``False`` if it has
5553 return _core_
.IconizeEvent_Iconized(*args
, **kwargs
)
5555 _core_
.IconizeEvent_swigregister(IconizeEvent
)
5557 #---------------------------------------------------------------------------
5559 class MaximizeEvent(Event
):
5560 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5561 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5562 __repr__
= _swig_repr
5563 def __init__(self
, *args
, **kwargs
):
5565 __init__(self, int id=0) -> MaximizeEvent
5567 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5569 _core_
.MaximizeEvent_swiginit(self
,_core_
.new_MaximizeEvent(*args
, **kwargs
))
5570 _core_
.MaximizeEvent_swigregister(MaximizeEvent
)
5572 #---------------------------------------------------------------------------
5574 class DropFilesEvent(Event
):
5576 This class is used for drop files events, that is, when files have
5577 been dropped onto the window. This functionality is only available
5578 under Windows. The window must have previously been enabled for
5579 dropping by calling `wx.Window.DragAcceptFiles`.
5581 Important note: this is a separate implementation to the more general
5582 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5583 implementation uses the older, Windows message-based approach of
5586 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5590 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5591 def __init__(self
): raise AttributeError, "No constructor defined"
5592 __repr__
= _swig_repr
5593 def GetPosition(*args
, **kwargs
):
5595 GetPosition(self) -> Point
5597 Returns the position at which the files were dropped.
5599 return _core_
.DropFilesEvent_GetPosition(*args
, **kwargs
)
5601 def GetNumberOfFiles(*args
, **kwargs
):
5603 GetNumberOfFiles(self) -> int
5605 Returns the number of files dropped.
5607 return _core_
.DropFilesEvent_GetNumberOfFiles(*args
, **kwargs
)
5609 def GetFiles(*args
, **kwargs
):
5611 GetFiles(self) -> PyObject
5613 Returns a list of the filenames that were dropped.
5615 return _core_
.DropFilesEvent_GetFiles(*args
, **kwargs
)
5617 Files
= property(GetFiles
,doc
="See `GetFiles`")
5618 NumberOfFiles
= property(GetNumberOfFiles
,doc
="See `GetNumberOfFiles`")
5619 Position
= property(GetPosition
,doc
="See `GetPosition`")
5620 _core_
.DropFilesEvent_swigregister(DropFilesEvent
)
5622 #---------------------------------------------------------------------------
5624 UPDATE_UI_PROCESS_ALL
= _core_
.UPDATE_UI_PROCESS_ALL
5625 UPDATE_UI_PROCESS_SPECIFIED
= _core_
.UPDATE_UI_PROCESS_SPECIFIED
5626 class UpdateUIEvent(CommandEvent
):
5628 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5629 wxWidgets to give an application the chance to update various user
5632 Without update UI events, an application has to work hard to
5633 check/uncheck, enable/disable, and set the text for elements such as
5634 menu items and toolbar buttons. The code for doing this has to be
5635 mixed up with the code that is invoked when an action is invoked for a
5636 menu item or button.
5638 With update UI events, you define an event handler to look at the
5639 state of the application and change UI elements accordingly. wxWidgets
5640 will call your handler functions in idle time, so you don't have to
5641 worry where to call this code. In addition to being a clearer and more
5642 declarative method, it also means you don't have to worry whether
5643 you're updating a toolbar or menubar identifier. The same handler can
5644 update a menu item and toolbar button, if the ID values are the same.
5646 Instead of directly manipulating the menu or button, you call
5647 functions in the event object, such as `Check`. wxWidgets will
5648 determine whether such a call has been made, and which UI element to
5651 These events will work for popup menus as well as menubars. Just
5652 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5653 any UI events for the window that owns the menu.
5655 If you find that the overhead of UI update processing is affecting
5656 your application, you can do one or both of the following:
5658 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5659 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5660 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5661 receive update events. No other windows will receive update
5664 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5665 value to set the delay between updates. You may need to call
5666 `wx.Window.UpdateWindowUI` at critical points, for example when
5667 a dialog is about to be shown, in case the user sees a slight
5668 delay before windows are updated.
5670 Note that although events are sent in idle time, defining a EVT_IDLE
5671 handler for a window does not affect this because the events are sent
5672 from an internal idle handler.
5674 wxWidgets tries to optimize update events on some platforms. On
5675 Windows and GTK+, events for menubar items are only sent when the menu
5676 is about to be shown, and not in idle time.
5679 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5680 __repr__
= _swig_repr
5681 def __init__(self
, *args
, **kwargs
):
5683 __init__(self, int commandId=0) -> UpdateUIEvent
5687 _core_
.UpdateUIEvent_swiginit(self
,_core_
.new_UpdateUIEvent(*args
, **kwargs
))
5688 def GetChecked(*args
, **kwargs
):
5690 GetChecked(self) -> bool
5692 Returns ``True`` if the UI element should be checked.
5694 return _core_
.UpdateUIEvent_GetChecked(*args
, **kwargs
)
5696 def GetEnabled(*args
, **kwargs
):
5698 GetEnabled(self) -> bool
5700 Returns ``True`` if the UI element should be enabled.
5702 return _core_
.UpdateUIEvent_GetEnabled(*args
, **kwargs
)
5704 def GetShown(*args
, **kwargs
):
5706 GetShown(self) -> bool
5708 Returns ``True`` if the UI element should be shown.
5710 return _core_
.UpdateUIEvent_GetShown(*args
, **kwargs
)
5712 def GetText(*args
, **kwargs
):
5714 GetText(self) -> String
5716 Returns the text that should be set for the UI element.
5718 return _core_
.UpdateUIEvent_GetText(*args
, **kwargs
)
5720 def GetSetText(*args
, **kwargs
):
5722 GetSetText(self) -> bool
5724 Returns ``True`` if the application has called `SetText`. For
5725 wxWidgets internal use only.
5727 return _core_
.UpdateUIEvent_GetSetText(*args
, **kwargs
)
5729 def GetSetChecked(*args
, **kwargs
):
5731 GetSetChecked(self) -> bool
5733 Returns ``True`` if the application has called `Check`. For wxWidgets
5736 return _core_
.UpdateUIEvent_GetSetChecked(*args
, **kwargs
)
5738 def GetSetEnabled(*args
, **kwargs
):
5740 GetSetEnabled(self) -> bool
5742 Returns ``True`` if the application has called `Enable`. For wxWidgets
5745 return _core_
.UpdateUIEvent_GetSetEnabled(*args
, **kwargs
)
5747 def GetSetShown(*args
, **kwargs
):
5749 GetSetShown(self) -> bool
5751 Returns ``True`` if the application has called `Show`. For wxWidgets
5754 return _core_
.UpdateUIEvent_GetSetShown(*args
, **kwargs
)
5756 def Check(*args
, **kwargs
):
5758 Check(self, bool check)
5760 Check or uncheck the UI element.
5762 return _core_
.UpdateUIEvent_Check(*args
, **kwargs
)
5764 def Enable(*args
, **kwargs
):
5766 Enable(self, bool enable)
5768 Enable or disable the UI element.
5770 return _core_
.UpdateUIEvent_Enable(*args
, **kwargs
)
5772 def Show(*args
, **kwargs
):
5774 Show(self, bool show)
5776 Show or hide the UI element.
5778 return _core_
.UpdateUIEvent_Show(*args
, **kwargs
)
5780 def SetText(*args
, **kwargs
):
5782 SetText(self, String text)
5784 Sets the text for this UI element.
5786 return _core_
.UpdateUIEvent_SetText(*args
, **kwargs
)
5788 def SetUpdateInterval(*args
, **kwargs
):
5790 SetUpdateInterval(long updateInterval)
5792 Sets the interval between updates in milliseconds. Set to -1 to
5793 disable updates, or to 0 to update as frequently as possible. The
5796 Use this to reduce the overhead of UI update events if your
5797 application has a lot of windows. If you set the value to -1 or
5798 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5799 at appropriate points in your application, such as when a dialog is
5802 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5804 SetUpdateInterval
= staticmethod(SetUpdateInterval
)
5805 def GetUpdateInterval(*args
, **kwargs
):
5807 GetUpdateInterval() -> long
5809 Returns the current interval between updates in milliseconds. -1
5810 disables updates, 0 updates as frequently as possible.
5812 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
, **kwargs
)
5814 GetUpdateInterval
= staticmethod(GetUpdateInterval
)
5815 def CanUpdate(*args
, **kwargs
):
5817 CanUpdate(Window win) -> bool
5819 Returns ``True`` if it is appropriate to update (send UI update events
5822 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5823 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5824 events were last sent in idle time, and the update interval, to
5825 determine whether events should be sent to this window now. By default
5826 this will always return true because the update mode is initially
5827 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5828 events will be sent as often as possible. You can reduce the frequency
5829 that events are sent by changing the mode and/or setting an update
5833 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
5835 CanUpdate
= staticmethod(CanUpdate
)
5836 def ResetUpdateTime(*args
, **kwargs
):
5840 Used internally to reset the last-updated time to the current time. It
5841 is assumed that update events are normally sent in idle time, so this
5842 is called at the end of idle processing.
5844 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
, **kwargs
)
5846 ResetUpdateTime
= staticmethod(ResetUpdateTime
)
5847 def SetMode(*args
, **kwargs
):
5851 Specify how wxWidgets will send update events: to all windows, or only
5852 to those which specify that they will process the events.
5854 The mode may be one of the following values:
5856 ============================= ==========================================
5857 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5858 is the default setting.
5859 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5860 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5862 ============================= ==========================================
5865 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
5867 SetMode
= staticmethod(SetMode
)
5868 def GetMode(*args
, **kwargs
):
5872 Returns a value specifying how wxWidgets will send update events: to
5873 all windows, or only to those which specify that they will process the
5876 return _core_
.UpdateUIEvent_GetMode(*args
, **kwargs
)
5878 GetMode
= staticmethod(GetMode
)
5879 Checked
= property(GetChecked
,Check
,doc
="See `GetChecked`")
5880 Enabled
= property(GetEnabled
,Enable
,doc
="See `GetEnabled`")
5881 Shown
= property(GetShown
,Show
,doc
="See `GetShown`")
5882 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
5883 _core_
.UpdateUIEvent_swigregister(UpdateUIEvent
)
5885 def UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
):
5887 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5889 Sets the interval between updates in milliseconds. Set to -1 to
5890 disable updates, or to 0 to update as frequently as possible. The
5893 Use this to reduce the overhead of UI update events if your
5894 application has a lot of windows. If you set the value to -1 or
5895 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5896 at appropriate points in your application, such as when a dialog is
5899 return _core_
.UpdateUIEvent_SetUpdateInterval(*args
, **kwargs
)
5901 def UpdateUIEvent_GetUpdateInterval(*args
):
5903 UpdateUIEvent_GetUpdateInterval() -> long
5905 Returns the current interval between updates in milliseconds. -1
5906 disables updates, 0 updates as frequently as possible.
5908 return _core_
.UpdateUIEvent_GetUpdateInterval(*args
)
5910 def UpdateUIEvent_CanUpdate(*args
, **kwargs
):
5912 UpdateUIEvent_CanUpdate(Window win) -> bool
5914 Returns ``True`` if it is appropriate to update (send UI update events
5917 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5918 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5919 events were last sent in idle time, and the update interval, to
5920 determine whether events should be sent to this window now. By default
5921 this will always return true because the update mode is initially
5922 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5923 events will be sent as often as possible. You can reduce the frequency
5924 that events are sent by changing the mode and/or setting an update
5928 return _core_
.UpdateUIEvent_CanUpdate(*args
, **kwargs
)
5930 def UpdateUIEvent_ResetUpdateTime(*args
):
5932 UpdateUIEvent_ResetUpdateTime()
5934 Used internally to reset the last-updated time to the current time. It
5935 is assumed that update events are normally sent in idle time, so this
5936 is called at the end of idle processing.
5938 return _core_
.UpdateUIEvent_ResetUpdateTime(*args
)
5940 def UpdateUIEvent_SetMode(*args
, **kwargs
):
5942 UpdateUIEvent_SetMode(int mode)
5944 Specify how wxWidgets will send update events: to all windows, or only
5945 to those which specify that they will process the events.
5947 The mode may be one of the following values:
5949 ============================= ==========================================
5950 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5951 is the default setting.
5952 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5953 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5955 ============================= ==========================================
5958 return _core_
.UpdateUIEvent_SetMode(*args
, **kwargs
)
5960 def UpdateUIEvent_GetMode(*args
):
5962 UpdateUIEvent_GetMode() -> int
5964 Returns a value specifying how wxWidgets will send update events: to
5965 all windows, or only to those which specify that they will process the
5968 return _core_
.UpdateUIEvent_GetMode(*args
)
5970 #---------------------------------------------------------------------------
5972 class SysColourChangedEvent(Event
):
5974 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5975 when the user changes the colour settings using the control
5976 panel. This is only applicable under Windows.
5978 The default event handler for this event propagates the event to child
5979 windows, since Windows only sends the events to top-level windows. If
5980 intercepting this event for a top-level window, remember to call
5981 `Skip` so the the base class handler will still be executed, or to
5982 pass the event on to the window's children explicitly.
5985 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5986 __repr__
= _swig_repr
5987 def __init__(self
, *args
, **kwargs
):
5989 __init__(self) -> SysColourChangedEvent
5993 _core_
.SysColourChangedEvent_swiginit(self
,_core_
.new_SysColourChangedEvent(*args
, **kwargs
))
5994 _core_
.SysColourChangedEvent_swigregister(SysColourChangedEvent
)
5996 #---------------------------------------------------------------------------
5998 class MouseCaptureChangedEvent(Event
):
6000 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6001 a window that loses its mouse capture. This is called even if
6002 `wx.Window.ReleaseMouse` was called by the application code. Handling
6003 this event allows an application to cater for unexpected capture
6004 releases which might otherwise confuse mouse handling code.
6006 This event is implemented under Windows only.
6008 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6009 __repr__
= _swig_repr
6010 def __init__(self
, *args
, **kwargs
):
6012 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6016 _core_
.MouseCaptureChangedEvent_swiginit(self
,_core_
.new_MouseCaptureChangedEvent(*args
, **kwargs
))
6017 def GetCapturedWindow(*args
, **kwargs
):
6019 GetCapturedWindow(self) -> Window
6021 Returns the window that gained the capture, or ``None`` if it was a
6022 non-wxWidgets window.
6024 return _core_
.MouseCaptureChangedEvent_GetCapturedWindow(*args
, **kwargs
)
6026 CapturedWindow
= property(GetCapturedWindow
,doc
="See `GetCapturedWindow`")
6027 _core_
.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent
)
6029 #---------------------------------------------------------------------------
6031 class MouseCaptureLostEvent(Event
):
6033 A mouse capture lost event is sent to a window that obtained mouse
6034 capture, which was subsequently loss due to "external" event, for
6035 example when a dialog box is shown or if another application captures
6038 If this happens, this event is sent to all windows that are on the
6039 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6040 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6041 if the capture changes because of a call to CaptureMouse or
6044 This event is currently emitted under Windows only.
6047 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6048 __repr__
= _swig_repr
6049 def __init__(self
, *args
, **kwargs
):
6051 __init__(self, int winid=0) -> MouseCaptureLostEvent
6053 A mouse capture lost event is sent to a window that obtained mouse
6054 capture, which was subsequently loss due to "external" event, for
6055 example when a dialog box is shown or if another application captures
6058 If this happens, this event is sent to all windows that are on the
6059 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6060 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6061 if the capture changes because of a call to CaptureMouse or
6064 This event is currently emitted under Windows only.
6067 _core_
.MouseCaptureLostEvent_swiginit(self
,_core_
.new_MouseCaptureLostEvent(*args
, **kwargs
))
6068 _core_
.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent
)
6070 #---------------------------------------------------------------------------
6072 class DisplayChangedEvent(Event
):
6074 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6075 resolution has changed.
6077 This event is implemented under Windows only.
6079 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6080 __repr__
= _swig_repr
6081 def __init__(self
, *args
, **kwargs
):
6082 """__init__(self) -> DisplayChangedEvent"""
6083 _core_
.DisplayChangedEvent_swiginit(self
,_core_
.new_DisplayChangedEvent(*args
, **kwargs
))
6084 _core_
.DisplayChangedEvent_swigregister(DisplayChangedEvent
)
6086 #---------------------------------------------------------------------------
6088 class PaletteChangedEvent(Event
):
6090 An EVT_PALETTE_CHANGED event is sent when the system palette has
6091 changed, thereby giving each window a chance to redo their own to
6094 This event is implemented under Windows only.
6096 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6097 __repr__
= _swig_repr
6098 def __init__(self
, *args
, **kwargs
):
6100 __init__(self, int id=0) -> PaletteChangedEvent
6102 An EVT_PALETTE_CHANGED event is sent when the system palette has
6103 changed, thereby giving each window a chance to redo their own to
6106 This event is implemented under Windows only.
6108 _core_
.PaletteChangedEvent_swiginit(self
,_core_
.new_PaletteChangedEvent(*args
, **kwargs
))
6109 def SetChangedWindow(*args
, **kwargs
):
6110 """SetChangedWindow(self, Window win)"""
6111 return _core_
.PaletteChangedEvent_SetChangedWindow(*args
, **kwargs
)
6113 def GetChangedWindow(*args
, **kwargs
):
6114 """GetChangedWindow(self) -> Window"""
6115 return _core_
.PaletteChangedEvent_GetChangedWindow(*args
, **kwargs
)
6117 ChangedWindow
= property(GetChangedWindow
,SetChangedWindow
,doc
="See `GetChangedWindow` and `SetChangedWindow`")
6118 _core_
.PaletteChangedEvent_swigregister(PaletteChangedEvent
)
6120 #---------------------------------------------------------------------------
6122 class QueryNewPaletteEvent(Event
):
6124 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6125 focus and should re-do its palette.
6127 This event is implemented under Windows only.
6129 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6130 __repr__
= _swig_repr
6131 def __init__(self
, *args
, **kwargs
):
6133 __init__(self, int winid=0) -> QueryNewPaletteEvent
6137 _core_
.QueryNewPaletteEvent_swiginit(self
,_core_
.new_QueryNewPaletteEvent(*args
, **kwargs
))
6138 def SetPaletteRealized(*args
, **kwargs
):
6140 SetPaletteRealized(self, bool realized)
6142 App should set this if it changes the palette.
6144 return _core_
.QueryNewPaletteEvent_SetPaletteRealized(*args
, **kwargs
)
6146 def GetPaletteRealized(*args
, **kwargs
):
6147 """GetPaletteRealized(self) -> bool"""
6148 return _core_
.QueryNewPaletteEvent_GetPaletteRealized(*args
, **kwargs
)
6150 PaletteRealized
= property(GetPaletteRealized
,SetPaletteRealized
,doc
="See `GetPaletteRealized` and `SetPaletteRealized`")
6151 _core_
.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent
)
6153 #---------------------------------------------------------------------------
6155 class NavigationKeyEvent(Event
):
6157 EVT_NAVIGATION_KEY events are used to control moving the focus between
6158 widgets, otherwise known as tab-traversal. You woudl normally not
6159 catch navigation events in applications as there are already
6160 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6161 it useful to send navigation events in certain situations to change
6162 the focus in certain ways, although it's probably easier to just call
6163 `wx.Window.Navigate`.
6165 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6166 __repr__
= _swig_repr
6167 def __init__(self
, *args
, **kwargs
):
6168 """__init__(self) -> NavigationKeyEvent"""
6169 _core_
.NavigationKeyEvent_swiginit(self
,_core_
.new_NavigationKeyEvent(*args
, **kwargs
))
6170 def GetDirection(*args
, **kwargs
):
6172 GetDirection(self) -> bool
6174 Returns ``True`` if the direction is forward, ``False`` otherwise.
6176 return _core_
.NavigationKeyEvent_GetDirection(*args
, **kwargs
)
6178 def SetDirection(*args
, **kwargs
):
6180 SetDirection(self, bool forward)
6182 Specify the direction that the navigation should take. Usually the
6183 difference between using Tab and Shift-Tab.
6185 return _core_
.NavigationKeyEvent_SetDirection(*args
, **kwargs
)
6187 def IsWindowChange(*args
, **kwargs
):
6189 IsWindowChange(self) -> bool
6191 Returns ``True`` if window change is allowed.
6193 return _core_
.NavigationKeyEvent_IsWindowChange(*args
, **kwargs
)
6195 def SetWindowChange(*args
, **kwargs
):
6197 SetWindowChange(self, bool ischange)
6199 Specify if the navigation should be able to change parent windows.
6200 For example, changing notebook pages, etc. This is usually implemented
6201 by using Control-Tab.
6203 return _core_
.NavigationKeyEvent_SetWindowChange(*args
, **kwargs
)
6205 def IsFromTab(*args
, **kwargs
):
6207 IsFromTab(self) -> bool
6209 Returns ``True`` if the navigation event is originated from the Tab
6212 return _core_
.NavigationKeyEvent_IsFromTab(*args
, **kwargs
)
6214 def SetFromTab(*args
, **kwargs
):
6216 SetFromTab(self, bool bIs)
6218 Set to true under MSW if the event was generated using the tab key.
6219 This is required for proper navogation over radio buttons.
6221 return _core_
.NavigationKeyEvent_SetFromTab(*args
, **kwargs
)
6223 def SetFlags(*args
, **kwargs
):
6225 SetFlags(self, long flags)
6227 Set the navigation flags to a combination of the following:
6229 * wx.NavigationKeyEvent.IsBackward
6230 * wx.NavigationKeyEvent.IsForward
6231 * wx.NavigationKeyEvent.WinChange
6232 * wx.NavigationKeyEvent.FromTab
6235 return _core_
.NavigationKeyEvent_SetFlags(*args
, **kwargs
)
6237 def GetCurrentFocus(*args
, **kwargs
):
6239 GetCurrentFocus(self) -> Window
6241 Returns the child window which currenty has the focus. May be
6244 return _core_
.NavigationKeyEvent_GetCurrentFocus(*args
, **kwargs
)
6246 def SetCurrentFocus(*args
, **kwargs
):
6248 SetCurrentFocus(self, Window win)
6250 Set the window that has the focus.
6252 return _core_
.NavigationKeyEvent_SetCurrentFocus(*args
, **kwargs
)
6254 IsBackward
= _core_
.NavigationKeyEvent_IsBackward
6255 IsForward
= _core_
.NavigationKeyEvent_IsForward
6256 WinChange
= _core_
.NavigationKeyEvent_WinChange
6257 FromTab
= _core_
.NavigationKeyEvent_FromTab
6258 CurrentFocus
= property(GetCurrentFocus
,SetCurrentFocus
,doc
="See `GetCurrentFocus` and `SetCurrentFocus`")
6259 Direction
= property(GetDirection
,SetDirection
,doc
="See `GetDirection` and `SetDirection`")
6260 _core_
.NavigationKeyEvent_swigregister(NavigationKeyEvent
)
6262 #---------------------------------------------------------------------------
6264 class WindowCreateEvent(CommandEvent
):
6266 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6267 underlying GUI object) exists.
6269 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6270 __repr__
= _swig_repr
6271 def __init__(self
, *args
, **kwargs
):
6273 __init__(self, Window win=None) -> WindowCreateEvent
6275 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6276 underlying GUI object) exists.
6278 _core_
.WindowCreateEvent_swiginit(self
,_core_
.new_WindowCreateEvent(*args
, **kwargs
))
6279 def GetWindow(*args
, **kwargs
):
6281 GetWindow(self) -> Window
6283 Returns the window that this event refers to.
6285 return _core_
.WindowCreateEvent_GetWindow(*args
, **kwargs
)
6287 Window
= property(GetWindow
,doc
="See `GetWindow`")
6288 _core_
.WindowCreateEvent_swigregister(WindowCreateEvent
)
6290 class WindowDestroyEvent(CommandEvent
):
6292 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6293 when the GUI window is destroyed.
6295 When a class derived from `wx.Window` is destroyed its destructor will
6296 have already run by the time this event is sent. Therefore this event
6297 will not usually be received at all by the window itself. Since it is
6298 received after the destructor has run, an object should not try to
6299 handle its own wx.WindowDestroyEvent, but it can be used to get
6300 notification of the destruction of another window.
6302 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6303 __repr__
= _swig_repr
6304 def __init__(self
, *args
, **kwargs
):
6306 __init__(self, Window win=None) -> WindowDestroyEvent
6308 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6309 when the GUI window is destroyed.
6311 When a class derived from `wx.Window` is destroyed its destructor will
6312 have already run by the time this event is sent. Therefore this event
6313 will not usually be received at all by the window itself. Since it is
6314 received after the destructor has run, an object should not try to
6315 handle its own wx.WindowDestroyEvent, but it can be used to get
6316 notification of the destruction of another window.
6318 _core_
.WindowDestroyEvent_swiginit(self
,_core_
.new_WindowDestroyEvent(*args
, **kwargs
))
6319 def GetWindow(*args
, **kwargs
):
6321 GetWindow(self) -> Window
6323 Returns the window that this event refers to.
6325 return _core_
.WindowDestroyEvent_GetWindow(*args
, **kwargs
)
6327 Window
= property(GetWindow
,doc
="See `GetWindow`")
6328 _core_
.WindowDestroyEvent_swigregister(WindowDestroyEvent
)
6330 #---------------------------------------------------------------------------
6332 class ContextMenuEvent(CommandEvent
):
6334 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6335 give the application a chance to show a context (popup) menu.
6337 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6338 __repr__
= _swig_repr
6339 def __init__(self
, *args
, **kwargs
):
6341 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6345 _core_
.ContextMenuEvent_swiginit(self
,_core_
.new_ContextMenuEvent(*args
, **kwargs
))
6346 def GetPosition(*args
, **kwargs
):
6348 GetPosition(self) -> Point
6350 Returns the position (in screen coordinants) at which the menu should
6353 return _core_
.ContextMenuEvent_GetPosition(*args
, **kwargs
)
6355 def SetPosition(*args
, **kwargs
):
6357 SetPosition(self, Point pos)
6359 Sets the position at which the menu should be shown.
6361 return _core_
.ContextMenuEvent_SetPosition(*args
, **kwargs
)
6363 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
6364 _core_
.ContextMenuEvent_swigregister(ContextMenuEvent
)
6366 #---------------------------------------------------------------------------
6368 IDLE_PROCESS_ALL
= _core_
.IDLE_PROCESS_ALL
6369 IDLE_PROCESS_SPECIFIED
= _core_
.IDLE_PROCESS_SPECIFIED
6370 class IdleEvent(Event
):
6372 This class is used for EVT_IDLE events, which are generated and sent
6373 when the application *becomes* idle. In other words, the when the
6374 event queue becomes empty then idle events are sent to all windows (by
6375 default) and as long as none of them call `RequestMore` then there are
6376 no more idle events until after the system event queue has some normal
6377 events and then becomes empty again.
6379 By default, idle events are sent to all windows. If this is causing a
6380 significant overhead in your application, you can call
6381 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6382 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6383 which should receive idle events. Then idle events will only be sent
6384 to those windows and not to any others.
6386 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6387 __repr__
= _swig_repr
6388 def __init__(self
, *args
, **kwargs
):
6390 __init__(self) -> IdleEvent
6394 _core_
.IdleEvent_swiginit(self
,_core_
.new_IdleEvent(*args
, **kwargs
))
6395 def RequestMore(*args
, **kwargs
):
6397 RequestMore(self, bool needMore=True)
6399 Tells wxWidgets that more processing is required. This function can be
6400 called by an EVT_IDLE handler for a window to indicate that the
6401 application should forward the EVT_IDLE event once more to the
6402 application windows. If no window calls this function during its
6403 EVT_IDLE handler, then the application will remain in a passive event
6404 loop until a new event is posted to the application by the windowing
6407 return _core_
.IdleEvent_RequestMore(*args
, **kwargs
)
6409 def MoreRequested(*args
, **kwargs
):
6411 MoreRequested(self) -> bool
6413 Returns ``True`` if the OnIdle function processing this event
6414 requested more processing time.
6416 return _core_
.IdleEvent_MoreRequested(*args
, **kwargs
)
6418 def SetMode(*args
, **kwargs
):
6422 Static method for specifying how wxWidgets will send idle events: to
6423 all windows, or only to those which specify that they will process the
6426 The mode can be one of the following values:
6428 ========================= ========================================
6429 wx.IDLE_PROCESS_ALL Send idle events to all windows
6430 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6431 the wx.WS_EX_PROCESS_IDLE extra style
6433 ========================= ========================================
6436 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6438 SetMode
= staticmethod(SetMode
)
6439 def GetMode(*args
, **kwargs
):
6443 Static method returning a value specifying how wxWidgets will send
6444 idle events: to all windows, or only to those which specify that they
6445 will process the events.
6447 return _core_
.IdleEvent_GetMode(*args
, **kwargs
)
6449 GetMode
= staticmethod(GetMode
)
6450 def CanSend(*args
, **kwargs
):
6452 CanSend(Window win) -> bool
6454 Returns ``True`` if it is appropriate to send idle events to this
6457 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6458 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6459 events should be sent to this window now. By default this will always
6460 return ``True`` because the update mode is initially
6461 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6462 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6464 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6466 CanSend
= staticmethod(CanSend
)
6467 _core_
.IdleEvent_swigregister(IdleEvent
)
6469 def IdleEvent_SetMode(*args
, **kwargs
):
6471 IdleEvent_SetMode(int mode)
6473 Static method for specifying how wxWidgets will send idle events: to
6474 all windows, or only to those which specify that they will process the
6477 The mode can be one of the following values:
6479 ========================= ========================================
6480 wx.IDLE_PROCESS_ALL Send idle events to all windows
6481 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6482 the wx.WS_EX_PROCESS_IDLE extra style
6484 ========================= ========================================
6487 return _core_
.IdleEvent_SetMode(*args
, **kwargs
)
6489 def IdleEvent_GetMode(*args
):
6491 IdleEvent_GetMode() -> int
6493 Static method returning a value specifying how wxWidgets will send
6494 idle events: to all windows, or only to those which specify that they
6495 will process the events.
6497 return _core_
.IdleEvent_GetMode(*args
)
6499 def IdleEvent_CanSend(*args
, **kwargs
):
6501 IdleEvent_CanSend(Window win) -> bool
6503 Returns ``True`` if it is appropriate to send idle events to this
6506 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6507 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6508 events should be sent to this window now. By default this will always
6509 return ``True`` because the update mode is initially
6510 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6511 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6513 return _core_
.IdleEvent_CanSend(*args
, **kwargs
)
6515 #---------------------------------------------------------------------------
6517 class ClipboardTextEvent(CommandEvent
):
6519 A Clipboard Text event is sent when a window intercepts a text
6520 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6521 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6522 popup menu command, etc. NOTE : under windows these events are *NOT*
6523 generated automatically for a Rich Edit text control.
6525 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6526 __repr__
= _swig_repr
6527 def __init__(self
, *args
, **kwargs
):
6529 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6531 A Clipboard Text event is sent when a window intercepts a text
6532 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6533 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6534 popup menu command, etc. NOTE : under windows these events are *NOT*
6535 generated automatically for a Rich Edit text control.
6537 _core_
.ClipboardTextEvent_swiginit(self
,_core_
.new_ClipboardTextEvent(*args
, **kwargs
))
6538 _core_
.ClipboardTextEvent_swigregister(ClipboardTextEvent
)
6540 #---------------------------------------------------------------------------
6542 class PyEvent(Event
):
6544 wx.PyEvent can be used as a base class for implementing custom event
6545 types in Python. You should derived from this class instead of
6546 `wx.Event` because this class is Python-aware and is able to transport
6547 its Python bits safely through the wxWidgets event system and have
6548 them still be there when the event handler is invoked.
6550 :see: `wx.PyCommandEvent`
6553 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6554 __repr__
= _swig_repr
6555 def __init__(self
, *args
, **kwargs
):
6556 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6557 _core_
.PyEvent_swiginit(self
,_core_
.new_PyEvent(*args
, **kwargs
))
6560 __swig_destroy__
= _core_
.delete_PyEvent
6561 __del__
= lambda self
: None;
6562 def _SetSelf(*args
, **kwargs
):
6563 """_SetSelf(self, PyObject self)"""
6564 return _core_
.PyEvent__SetSelf(*args
, **kwargs
)
6566 def _GetSelf(*args
, **kwargs
):
6567 """_GetSelf(self) -> PyObject"""
6568 return _core_
.PyEvent__GetSelf(*args
, **kwargs
)
6570 _core_
.PyEvent_swigregister(PyEvent
)
6572 class PyCommandEvent(CommandEvent
):
6574 wx.PyCommandEvent can be used as a base class for implementing custom
6575 event types in Python, where the event shoudl travel up to parent
6576 windows looking for a handler. You should derived from this class
6577 instead of `wx.CommandEvent` because this class is Python-aware and is
6578 able to transport its Python bits safely through the wxWidgets event
6579 system and have them still be there when the event handler is invoked.
6584 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6585 __repr__
= _swig_repr
6586 def __init__(self
, *args
, **kwargs
):
6587 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6588 _core_
.PyCommandEvent_swiginit(self
,_core_
.new_PyCommandEvent(*args
, **kwargs
))
6591 __swig_destroy__
= _core_
.delete_PyCommandEvent
6592 __del__
= lambda self
: None;
6593 def _SetSelf(*args
, **kwargs
):
6594 """_SetSelf(self, PyObject self)"""
6595 return _core_
.PyCommandEvent__SetSelf(*args
, **kwargs
)
6597 def _GetSelf(*args
, **kwargs
):
6598 """_GetSelf(self) -> PyObject"""
6599 return _core_
.PyCommandEvent__GetSelf(*args
, **kwargs
)
6601 _core_
.PyCommandEvent_swigregister(PyCommandEvent
)
6603 class DateEvent(CommandEvent
):
6605 This event class holds information about a date change event and is
6606 used together with `wx.DatePickerCtrl`. It also serves as a base class
6607 for `wx.calendar.CalendarEvent`. Bind these event types with
6610 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6611 __repr__
= _swig_repr
6612 def __init__(self
, *args
, **kwargs
):
6613 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6614 _core_
.DateEvent_swiginit(self
,_core_
.new_DateEvent(*args
, **kwargs
))
6615 def GetDate(*args
, **kwargs
):
6617 GetDate(self) -> DateTime
6621 return _core_
.DateEvent_GetDate(*args
, **kwargs
)
6623 def SetDate(*args
, **kwargs
):
6625 SetDate(self, DateTime date)
6627 Sets the date carried by the event, normally only used by the library
6630 return _core_
.DateEvent_SetDate(*args
, **kwargs
)
6632 Date
= property(GetDate
,SetDate
,doc
="See `GetDate` and `SetDate`")
6633 _core_
.DateEvent_swigregister(DateEvent
)
6635 wxEVT_DATE_CHANGED
= _core_
.wxEVT_DATE_CHANGED
6636 EVT_DATE_CHANGED
= wx
.PyEventBinder( wxEVT_DATE_CHANGED
, 1 )
6638 #---------------------------------------------------------------------------
6640 PYAPP_ASSERT_SUPPRESS
= _core_
.PYAPP_ASSERT_SUPPRESS
6641 PYAPP_ASSERT_EXCEPTION
= _core_
.PYAPP_ASSERT_EXCEPTION
6642 PYAPP_ASSERT_DIALOG
= _core_
.PYAPP_ASSERT_DIALOG
6643 PYAPP_ASSERT_LOG
= _core_
.PYAPP_ASSERT_LOG
6644 PRINT_WINDOWS
= _core_
.PRINT_WINDOWS
6645 PRINT_POSTSCRIPT
= _core_
.PRINT_POSTSCRIPT
6646 class PyApp(EvtHandler
):
6648 The ``wx.PyApp`` class is an *implementation detail*, please use the
6649 `wx.App` class (or some other derived class) instead.
6651 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
6652 __repr__
= _swig_repr
6653 def __init__(self
, *args
, **kwargs
):
6655 __init__(self) -> PyApp
6657 Create a new application object, starting the bootstrap process.
6659 _core_
.PyApp_swiginit(self
,_core_
.new_PyApp(*args
, **kwargs
))
6660 self
._setCallbackInfo
(self
, PyApp
, False)
6661 self
._setOORInfo
(self
, False)
6663 __swig_destroy__
= _core_
.delete_PyApp
6664 __del__
= lambda self
: None;
6665 def _setCallbackInfo(*args
, **kwargs
):
6666 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6667 return _core_
.PyApp__setCallbackInfo(*args
, **kwargs
)
6669 def GetAppName(*args
, **kwargs
):
6671 GetAppName(self) -> String
6673 Get the application name.
6675 return _core_
.PyApp_GetAppName(*args
, **kwargs
)
6677 def SetAppName(*args
, **kwargs
):
6679 SetAppName(self, String name)
6681 Set the application name. This value may be used automatically by
6682 `wx.Config` and such.
6684 return _core_
.PyApp_SetAppName(*args
, **kwargs
)
6686 def GetClassName(*args
, **kwargs
):
6688 GetClassName(self) -> String
6690 Get the application's class name.
6692 return _core_
.PyApp_GetClassName(*args
, **kwargs
)
6694 def SetClassName(*args
, **kwargs
):
6696 SetClassName(self, String name)
6698 Set the application's class name. This value may be used for
6699 X-resources if applicable for the platform
6701 return _core_
.PyApp_SetClassName(*args
, **kwargs
)
6703 def GetVendorName(*args
, **kwargs
):
6705 GetVendorName(self) -> String
6707 Get the application's vendor name.
6709 return _core_
.PyApp_GetVendorName(*args
, **kwargs
)
6711 def SetVendorName(*args
, **kwargs
):
6713 SetVendorName(self, String name)
6715 Set the application's vendor name. This value may be used
6716 automatically by `wx.Config` and such.
6718 return _core_
.PyApp_SetVendorName(*args
, **kwargs
)
6720 def GetTraits(*args
, **kwargs
):
6722 GetTraits(self) -> wxAppTraits
6724 Return (and create if necessary) the app traits object to which we
6725 delegate for everything which either should be configurable by the
6726 user (then he can change the default behaviour simply by overriding
6727 CreateTraits() and returning his own traits object) or which is
6728 GUI/console dependent as then wx.AppTraits allows us to abstract the
6729 differences behind the common facade.
6731 :todo: Add support for overriding CreateAppTraits in wxPython.
6733 return _core_
.PyApp_GetTraits(*args
, **kwargs
)
6735 def ProcessPendingEvents(*args
, **kwargs
):
6737 ProcessPendingEvents(self)
6739 Process all events in the Pending Events list -- it is necessary to
6740 call this function to process posted events. This normally happens
6741 during each event loop iteration.
6743 return _core_
.PyApp_ProcessPendingEvents(*args
, **kwargs
)
6745 def Yield(*args
, **kwargs
):
6747 Yield(self, bool onlyIfNeeded=False) -> bool
6749 Process all currently pending events right now, instead of waiting
6750 until return to the event loop. It is an error to call ``Yield``
6751 recursively unless the value of ``onlyIfNeeded`` is True.
6753 :warning: This function is dangerous as it can lead to unexpected
6754 reentrancies (i.e. when called from an event handler it may
6755 result in calling the same event handler again), use with
6756 extreme care or, better, don't use at all!
6758 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6761 return _core_
.PyApp_Yield(*args
, **kwargs
)
6763 def WakeUpIdle(*args
, **kwargs
):
6767 Make sure that idle events are sent again.
6768 :see: `wx.WakeUpIdle`
6770 return _core_
.PyApp_WakeUpIdle(*args
, **kwargs
)
6772 def IsMainLoopRunning(*args
, **kwargs
):
6774 IsMainLoopRunning() -> bool
6776 Returns True if we're running the main loop, i.e. if the events can
6777 currently be dispatched.
6779 return _core_
.PyApp_IsMainLoopRunning(*args
, **kwargs
)
6781 IsMainLoopRunning
= staticmethod(IsMainLoopRunning
)
6782 def MainLoop(*args
, **kwargs
):
6784 MainLoop(self) -> int
6786 Execute the main GUI loop, the function doesn't normally return until
6787 all top level windows have been closed and destroyed.
6789 return _core_
.PyApp_MainLoop(*args
, **kwargs
)
6791 def Exit(*args
, **kwargs
):
6795 Exit the main loop thus terminating the application.
6798 return _core_
.PyApp_Exit(*args
, **kwargs
)
6800 def GetLayoutDirection(*args
, **kwargs
):
6802 GetLayoutDirection(self) -> int
6804 Return the layout direction for the current locale.
6806 return _core_
.PyApp_GetLayoutDirection(*args
, **kwargs
)
6808 def ExitMainLoop(*args
, **kwargs
):
6812 Exit the main GUI loop during the next iteration of the main
6813 loop, (i.e. it does not stop the program immediately!)
6815 return _core_
.PyApp_ExitMainLoop(*args
, **kwargs
)
6817 def Pending(*args
, **kwargs
):
6819 Pending(self) -> bool
6821 Returns True if there are unprocessed events in the event queue.
6823 return _core_
.PyApp_Pending(*args
, **kwargs
)
6825 def Dispatch(*args
, **kwargs
):
6827 Dispatch(self) -> bool
6829 Process the first event in the event queue (blocks until an event
6830 appears if there are none currently)
6832 return _core_
.PyApp_Dispatch(*args
, **kwargs
)
6834 def ProcessIdle(*args
, **kwargs
):
6836 ProcessIdle(self) -> bool
6838 Called from the MainLoop when the application becomes idle (there are
6839 no pending events) and sends a `wx.IdleEvent` to all interested
6840 parties. Returns True if more idle events are needed, False if not.
6842 return _core_
.PyApp_ProcessIdle(*args
, **kwargs
)
6844 def SendIdleEvents(*args
, **kwargs
):
6846 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6848 Send idle event to window and all subwindows. Returns True if more
6849 idle time is requested.
6851 return _core_
.PyApp_SendIdleEvents(*args
, **kwargs
)
6853 def IsActive(*args
, **kwargs
):
6855 IsActive(self) -> bool
6857 Return True if our app has focus.
6859 return _core_
.PyApp_IsActive(*args
, **kwargs
)
6861 def SetTopWindow(*args
, **kwargs
):
6863 SetTopWindow(self, Window win)
6865 Set the *main* top level window
6867 return _core_
.PyApp_SetTopWindow(*args
, **kwargs
)
6869 def GetTopWindow(*args
, **kwargs
):
6871 GetTopWindow(self) -> Window
6873 Return the *main* top level window (if it hadn't been set previously
6874 with SetTopWindow(), will return just some top level window and, if
6875 there not any, will return None)
6877 return _core_
.PyApp_GetTopWindow(*args
, **kwargs
)
6879 def SetExitOnFrameDelete(*args
, **kwargs
):
6881 SetExitOnFrameDelete(self, bool flag)
6883 Control the exit behaviour: by default, the program will exit the main
6884 loop (and so, usually, terminate) when the last top-level program
6885 window is deleted. Beware that if you disable this behaviour (with
6886 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6887 explicitly from somewhere.
6889 return _core_
.PyApp_SetExitOnFrameDelete(*args
, **kwargs
)
6891 def GetExitOnFrameDelete(*args
, **kwargs
):
6893 GetExitOnFrameDelete(self) -> bool
6895 Get the current exit behaviour setting.
6897 return _core_
.PyApp_GetExitOnFrameDelete(*args
, **kwargs
)
6899 def SetUseBestVisual(*args
, **kwargs
):
6901 SetUseBestVisual(self, bool flag)
6903 Set whether the app should try to use the best available visual on
6904 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6906 return _core_
.PyApp_SetUseBestVisual(*args
, **kwargs
)
6908 def GetUseBestVisual(*args
, **kwargs
):
6910 GetUseBestVisual(self) -> bool
6912 Get current UseBestVisual setting.
6914 return _core_
.PyApp_GetUseBestVisual(*args
, **kwargs
)
6916 def SetPrintMode(*args
, **kwargs
):
6917 """SetPrintMode(self, int mode)"""
6918 return _core_
.PyApp_SetPrintMode(*args
, **kwargs
)
6920 def GetPrintMode(*args
, **kwargs
):
6921 """GetPrintMode(self) -> int"""
6922 return _core_
.PyApp_GetPrintMode(*args
, **kwargs
)
6924 def SetAssertMode(*args
, **kwargs
):
6926 SetAssertMode(self, int mode)
6928 Set the OnAssert behaviour for debug and hybrid builds.
6930 return _core_
.PyApp_SetAssertMode(*args
, **kwargs
)
6932 def GetAssertMode(*args
, **kwargs
):
6934 GetAssertMode(self) -> int
6936 Get the current OnAssert behaviour setting.
6938 return _core_
.PyApp_GetAssertMode(*args
, **kwargs
)
6940 def GetMacSupportPCMenuShortcuts(*args
, **kwargs
):
6941 """GetMacSupportPCMenuShortcuts() -> bool"""
6942 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
, **kwargs
)
6944 GetMacSupportPCMenuShortcuts
= staticmethod(GetMacSupportPCMenuShortcuts
)
6945 def GetMacAboutMenuItemId(*args
, **kwargs
):
6946 """GetMacAboutMenuItemId() -> long"""
6947 return _core_
.PyApp_GetMacAboutMenuItemId(*args
, **kwargs
)
6949 GetMacAboutMenuItemId
= staticmethod(GetMacAboutMenuItemId
)
6950 def GetMacPreferencesMenuItemId(*args
, **kwargs
):
6951 """GetMacPreferencesMenuItemId() -> long"""
6952 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
, **kwargs
)
6954 GetMacPreferencesMenuItemId
= staticmethod(GetMacPreferencesMenuItemId
)
6955 def GetMacExitMenuItemId(*args
, **kwargs
):
6956 """GetMacExitMenuItemId() -> long"""
6957 return _core_
.PyApp_GetMacExitMenuItemId(*args
, **kwargs
)
6959 GetMacExitMenuItemId
= staticmethod(GetMacExitMenuItemId
)
6960 def GetMacHelpMenuTitleName(*args
, **kwargs
):
6961 """GetMacHelpMenuTitleName() -> String"""
6962 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
, **kwargs
)
6964 GetMacHelpMenuTitleName
= staticmethod(GetMacHelpMenuTitleName
)
6965 def SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
6966 """SetMacSupportPCMenuShortcuts(bool val)"""
6967 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
6969 SetMacSupportPCMenuShortcuts
= staticmethod(SetMacSupportPCMenuShortcuts
)
6970 def SetMacAboutMenuItemId(*args
, **kwargs
):
6971 """SetMacAboutMenuItemId(long val)"""
6972 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
6974 SetMacAboutMenuItemId
= staticmethod(SetMacAboutMenuItemId
)
6975 def SetMacPreferencesMenuItemId(*args
, **kwargs
):
6976 """SetMacPreferencesMenuItemId(long val)"""
6977 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
6979 SetMacPreferencesMenuItemId
= staticmethod(SetMacPreferencesMenuItemId
)
6980 def SetMacExitMenuItemId(*args
, **kwargs
):
6981 """SetMacExitMenuItemId(long val)"""
6982 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
6984 SetMacExitMenuItemId
= staticmethod(SetMacExitMenuItemId
)
6985 def SetMacHelpMenuTitleName(*args
, **kwargs
):
6986 """SetMacHelpMenuTitleName(String val)"""
6987 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
6989 SetMacHelpMenuTitleName
= staticmethod(SetMacHelpMenuTitleName
)
6990 def _BootstrapApp(*args
, **kwargs
):
6994 For internal use only
6996 return _core_
.PyApp__BootstrapApp(*args
, **kwargs
)
6998 def GetComCtl32Version(*args
, **kwargs
):
7000 GetComCtl32Version() -> int
7002 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7003 it wasn't found at all. Raises an exception on non-Windows platforms.
7005 return _core_
.PyApp_GetComCtl32Version(*args
, **kwargs
)
7007 GetComCtl32Version
= staticmethod(GetComCtl32Version
)
7008 def IsDisplayAvailable(*args
, **kwargs
):
7010 IsDisplayAvailable() -> bool
7012 Tests if it is possible to create a GUI in the current environment.
7013 This will mean different things on the different platforms.
7015 * On X Windows systems this function will return ``False`` if it is
7016 not able to open a connection to the X display, which can happen
7017 if $DISPLAY is not set, or is not set correctly.
7019 * On Mac OS X a ``False`` return value will mean that wx is not
7020 able to access the window manager, which can happen if logged in
7021 remotely or if running from the normal version of python instead
7022 of the framework version, (i.e., pythonw.)
7027 return _core_
.PyApp_IsDisplayAvailable(*args
, **kwargs
)
7029 IsDisplayAvailable
= staticmethod(IsDisplayAvailable
)
7030 AppName
= property(GetAppName
,SetAppName
,doc
="See `GetAppName` and `SetAppName`")
7031 AssertMode
= property(GetAssertMode
,SetAssertMode
,doc
="See `GetAssertMode` and `SetAssertMode`")
7032 ClassName
= property(GetClassName
,SetClassName
,doc
="See `GetClassName` and `SetClassName`")
7033 ExitOnFrameDelete
= property(GetExitOnFrameDelete
,SetExitOnFrameDelete
,doc
="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7034 LayoutDirection
= property(GetLayoutDirection
,doc
="See `GetLayoutDirection`")
7035 PrintMode
= property(GetPrintMode
,SetPrintMode
,doc
="See `GetPrintMode` and `SetPrintMode`")
7036 TopWindow
= property(GetTopWindow
,SetTopWindow
,doc
="See `GetTopWindow` and `SetTopWindow`")
7037 Traits
= property(GetTraits
,doc
="See `GetTraits`")
7038 UseBestVisual
= property(GetUseBestVisual
,SetUseBestVisual
,doc
="See `GetUseBestVisual` and `SetUseBestVisual`")
7039 VendorName
= property(GetVendorName
,SetVendorName
,doc
="See `GetVendorName` and `SetVendorName`")
7040 Active
= property(IsActive
)
7041 _core_
.PyApp_swigregister(PyApp
)
7043 def PyApp_IsMainLoopRunning(*args
):
7045 PyApp_IsMainLoopRunning() -> bool
7047 Returns True if we're running the main loop, i.e. if the events can
7048 currently be dispatched.
7050 return _core_
.PyApp_IsMainLoopRunning(*args
)
7052 def PyApp_GetMacSupportPCMenuShortcuts(*args
):
7053 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7054 return _core_
.PyApp_GetMacSupportPCMenuShortcuts(*args
)
7056 def PyApp_GetMacAboutMenuItemId(*args
):
7057 """PyApp_GetMacAboutMenuItemId() -> long"""
7058 return _core_
.PyApp_GetMacAboutMenuItemId(*args
)
7060 def PyApp_GetMacPreferencesMenuItemId(*args
):
7061 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7062 return _core_
.PyApp_GetMacPreferencesMenuItemId(*args
)
7064 def PyApp_GetMacExitMenuItemId(*args
):
7065 """PyApp_GetMacExitMenuItemId() -> long"""
7066 return _core_
.PyApp_GetMacExitMenuItemId(*args
)
7068 def PyApp_GetMacHelpMenuTitleName(*args
):
7069 """PyApp_GetMacHelpMenuTitleName() -> String"""
7070 return _core_
.PyApp_GetMacHelpMenuTitleName(*args
)
7072 def PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
):
7073 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7074 return _core_
.PyApp_SetMacSupportPCMenuShortcuts(*args
, **kwargs
)
7076 def PyApp_SetMacAboutMenuItemId(*args
, **kwargs
):
7077 """PyApp_SetMacAboutMenuItemId(long val)"""
7078 return _core_
.PyApp_SetMacAboutMenuItemId(*args
, **kwargs
)
7080 def PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
):
7081 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7082 return _core_
.PyApp_SetMacPreferencesMenuItemId(*args
, **kwargs
)
7084 def PyApp_SetMacExitMenuItemId(*args
, **kwargs
):
7085 """PyApp_SetMacExitMenuItemId(long val)"""
7086 return _core_
.PyApp_SetMacExitMenuItemId(*args
, **kwargs
)
7088 def PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
):
7089 """PyApp_SetMacHelpMenuTitleName(String val)"""
7090 return _core_
.PyApp_SetMacHelpMenuTitleName(*args
, **kwargs
)
7092 def PyApp_GetComCtl32Version(*args
):
7094 PyApp_GetComCtl32Version() -> int
7096 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7097 it wasn't found at all. Raises an exception on non-Windows platforms.
7099 return _core_
.PyApp_GetComCtl32Version(*args
)
7101 def PyApp_IsDisplayAvailable(*args
):
7103 PyApp_IsDisplayAvailable() -> bool
7105 Tests if it is possible to create a GUI in the current environment.
7106 This will mean different things on the different platforms.
7108 * On X Windows systems this function will return ``False`` if it is
7109 not able to open a connection to the X display, which can happen
7110 if $DISPLAY is not set, or is not set correctly.
7112 * On Mac OS X a ``False`` return value will mean that wx is not
7113 able to access the window manager, which can happen if logged in
7114 remotely or if running from the normal version of python instead
7115 of the framework version, (i.e., pythonw.)
7120 return _core_
.PyApp_IsDisplayAvailable(*args
)
7122 #---------------------------------------------------------------------------
7129 Force an exit of the application. Convenience for wx.GetApp().Exit()
7131 return _core_
.Exit(*args
)
7137 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7139 return _core_
.Yield(*args
)
7141 def YieldIfNeeded(*args
):
7143 YieldIfNeeded() -> bool
7145 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7147 return _core_
.YieldIfNeeded(*args
)
7149 def SafeYield(*args
, **kwargs
):
7151 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7153 This function is similar to `wx.Yield`, except that it disables the
7154 user input to all program windows before calling `wx.Yield` and
7155 re-enables it again afterwards. If ``win`` is not None, this window
7156 will remain enabled, allowing the implementation of some limited user
7159 :Returns: the result of the call to `wx.Yield`.
7161 return _core_
.SafeYield(*args
, **kwargs
)
7163 def WakeUpIdle(*args
):
7167 Cause the message queue to become empty again, so idle events will be
7170 return _core_
.WakeUpIdle(*args
)
7172 def PostEvent(*args
, **kwargs
):
7174 PostEvent(EvtHandler dest, Event event)
7176 Send an event to a window or other wx.EvtHandler to be processed
7179 return _core_
.PostEvent(*args
, **kwargs
)
7181 def App_CleanUp(*args
):
7185 For internal use only, it is used to cleanup after wxWidgets when
7188 return _core_
.App_CleanUp(*args
)
7194 Return a reference to the current wx.App object.
7196 return _core_
.GetApp(*args
)
7198 def SetDefaultPyEncoding(*args
, **kwargs
):
7200 SetDefaultPyEncoding(string encoding)
7202 Sets the encoding that wxPython will use when it needs to convert a
7203 Python string or unicode object to or from a wxString.
7205 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7206 but please be aware that the default encoding within the same locale
7207 may be slightly different on different platforms. For example, please
7208 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7209 between the common latin/roman encodings.
7211 return _core_
.SetDefaultPyEncoding(*args
, **kwargs
)
7213 def GetDefaultPyEncoding(*args
):
7215 GetDefaultPyEncoding() -> string
7217 Gets the current encoding that wxPython will use when it needs to
7218 convert a Python string or unicode object to or from a wxString.
7220 return _core_
.GetDefaultPyEncoding(*args
)
7221 #----------------------------------------------------------------------
7223 class PyOnDemandOutputWindow
:
7225 A class that can be used for redirecting Python's stdout and
7226 stderr streams. It will do nothing until something is wrriten to
7227 the stream at which point it will create a Frame with a text area
7228 and write the text there.
7230 def __init__(self
, title
= "wxPython: stdout/stderr"):
7233 self
.pos
= wx
.DefaultPosition
7234 self
.size
= (450, 300)
7237 def SetParent(self
, parent
):
7238 """Set the window to be used as the popup Frame's parent."""
7239 self
.parent
= parent
7242 def CreateOutputWindow(self
, st
):
7243 self
.frame
= wx
.Frame(self
.parent
, -1, self
.title
, self
.pos
, self
.size
,
7244 style
=wx
.DEFAULT_FRAME_STYLE
)
7245 self
.text
= wx
.TextCtrl(self
.frame
, -1, "",
7246 style
=wx
.TE_MULTILINE|wx
.TE_READONLY
)
7247 self
.text
.AppendText(st
)
7248 self
.frame
.Show(True)
7249 self
.frame
.Bind(wx
.EVT_CLOSE
, self
.OnCloseWindow
)
7252 def OnCloseWindow(self
, event
):
7253 if self
.frame
is not None:
7254 self
.frame
.Destroy()
7259 # These methods provide the file-like output behaviour.
7260 def write(self
, text
):
7262 Create the output window if needed and write the string to it.
7263 If not called in the context of the gui thread then uses
7264 CallAfter to do the work there.
7266 if self
.frame
is None:
7267 if not wx
.Thread_IsMain():
7268 wx
.CallAfter(self
.CreateOutputWindow
, text
)
7270 self
.CreateOutputWindow(text
)
7272 if not wx
.Thread_IsMain():
7273 wx
.CallAfter(self
.text
.AppendText
, text
)
7275 self
.text
.AppendText(text
)
7279 if self
.frame
is not None:
7280 wx
.CallAfter(self
.frame
.Close
)
7288 #----------------------------------------------------------------------
7290 _defRedirect
= (wx
.Platform
== '__WXMSW__' or wx
.Platform
== '__WXMAC__')
7292 class App(wx
.PyApp
):
7294 The ``wx.App`` class represents the application and is used to:
7296 * bootstrap the wxPython system and initialize the underlying
7298 * set and get application-wide properties
7299 * implement the windowing system main message or event loop,
7300 and to dispatch events to window instances
7303 Every application must have a ``wx.App`` instance, and all
7304 creation of UI objects should be delayed until after the
7305 ``wx.App`` object has been created in order to ensure that the gui
7306 platform and wxWidgets have been fully initialized.
7308 Normally you would derive from this class and implement an
7309 ``OnInit`` method that creates a frame and then calls
7310 ``self.SetTopWindow(frame)``.
7312 :see: `wx.PySimpleApp` for a simpler app class that can be used
7316 outputWindowClass
= PyOnDemandOutputWindow
7318 def __init__(self
, redirect
=_defRedirect
, filename
=None,
7319 useBestVisual
=False, clearSigInt
=True):
7321 Construct a ``wx.App`` object.
7323 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7324 redirected? Defaults to True on Windows and Mac, False
7325 otherwise. If `filename` is None then output will be
7326 redirected to a window that pops up as needed. (You can
7327 control what kind of window is created for the output by
7328 resetting the class variable ``outputWindowClass`` to a
7329 class of your choosing.)
7331 :param filename: The name of a file to redirect output to, if
7334 :param useBestVisual: Should the app try to use the best
7335 available visual provided by the system (only relevant on
7336 systems that have more than one visual.) This parameter
7337 must be used instead of calling `SetUseBestVisual` later
7338 on because it must be set before the underlying GUI
7339 toolkit is initialized.
7341 :param clearSigInt: Should SIGINT be cleared? This allows the
7342 app to terminate upon a Ctrl-C in the console like other
7345 :note: You should override OnInit to do applicaition
7346 initialization to ensure that the system, toolkit and
7347 wxWidgets are fully initialized.
7350 wx
.PyApp
.__init
__(self
)
7352 # make sure we can create a GUI
7353 if not self
.IsDisplayAvailable():
7355 if wx
.Platform
== "__WXMAC__":
7356 msg
= """This program needs access to the screen.
7357 Please run with 'pythonw', not 'python', and only when you are logged
7358 in on the main display of your Mac."""
7360 elif wx
.Platform
== "__WXGTK__":
7361 msg
="Unable to access the X Display, is $DISPLAY set properly?"
7364 msg
= "Unable to create GUI"
7365 # TODO: more description is needed for wxMSW...
7367 raise SystemExit(msg
)
7369 # This has to be done before OnInit
7370 self
.SetUseBestVisual(useBestVisual
)
7372 # Set the default handler for SIGINT. This fixes a problem
7373 # where if Ctrl-C is pressed in the console that started this
7374 # app then it will not appear to do anything, (not even send
7375 # KeyboardInterrupt???) but will later segfault on exit. By
7376 # setting the default handler then the app will exit, as
7377 # expected (depending on platform.)
7381 signal
.signal(signal
.SIGINT
, signal
.SIG_DFL
)
7385 # Save and redirect the stdio to a window?
7386 self
.stdioWin
= None
7387 self
.saveStdio
= (_sys
.stdout
, _sys
.stderr
)
7389 self
.RedirectStdio(filename
)
7391 # Use Python's install prefix as the default
7392 wx
.StandardPaths
.Get().SetInstallPrefix(_sys
.prefix
)
7394 # This finishes the initialization of wxWindows and then calls
7395 # the OnInit that should be present in the derived class
7396 self
._BootstrapApp
()
7399 def OnPreInit(self
):
7401 Things that must be done after _BootstrapApp has done its
7402 thing, but would be nice if they were already done by the time
7403 that OnInit is called.
7405 wx
.StockGDI
._initStockObjects
()
7408 def __del__(self
, destroy
=wx
.PyApp
.__del
__):
7409 self
.RestoreStdio() # Just in case the MainLoop was overridden
7413 wx
.PyApp
.Destroy(self
)
7416 def SetTopWindow(self
, frame
):
7417 """Set the \"main\" top level window"""
7419 self
.stdioWin
.SetParent(frame
)
7420 wx
.PyApp
.SetTopWindow(self
, frame
)
7424 """Execute the main GUI event loop"""
7425 wx
.PyApp
.MainLoop(self
)
7429 def RedirectStdio(self
, filename
=None):
7430 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7432 _sys
.stdout
= _sys
.stderr
= open(filename
, 'a')
7434 self
.stdioWin
= self
.outputWindowClass()
7435 _sys
.stdout
= _sys
.stderr
= self
.stdioWin
7438 def RestoreStdio(self
):
7440 _sys
.stdout
, _sys
.stderr
= self
.saveStdio
7445 def SetOutputWindowAttributes(self
, title
=None, pos
=None, size
=None):
7447 Set the title, position and/or size of the output window if
7448 the stdio has been redirected. This should be called before
7449 any output would cause the output window to be created.
7452 if title
is not None:
7453 self
.stdioWin
.title
= title
7455 self
.stdioWin
.pos
= pos
7456 if size
is not None:
7457 self
.stdioWin
.size
= size
7462 # change from wx.PyApp_XX to wx.App_XX
7463 App_GetMacSupportPCMenuShortcuts
= _core_
.PyApp_GetMacSupportPCMenuShortcuts
7464 App_GetMacAboutMenuItemId
= _core_
.PyApp_GetMacAboutMenuItemId
7465 App_GetMacPreferencesMenuItemId
= _core_
.PyApp_GetMacPreferencesMenuItemId
7466 App_GetMacExitMenuItemId
= _core_
.PyApp_GetMacExitMenuItemId
7467 App_GetMacHelpMenuTitleName
= _core_
.PyApp_GetMacHelpMenuTitleName
7468 App_SetMacSupportPCMenuShortcuts
= _core_
.PyApp_SetMacSupportPCMenuShortcuts
7469 App_SetMacAboutMenuItemId
= _core_
.PyApp_SetMacAboutMenuItemId
7470 App_SetMacPreferencesMenuItemId
= _core_
.PyApp_SetMacPreferencesMenuItemId
7471 App_SetMacExitMenuItemId
= _core_
.PyApp_SetMacExitMenuItemId
7472 App_SetMacHelpMenuTitleName
= _core_
.PyApp_SetMacHelpMenuTitleName
7473 App_GetComCtl32Version
= _core_
.PyApp_GetComCtl32Version
7475 #----------------------------------------------------------------------------
7477 class PySimpleApp(wx
.App
):
7479 A simple application class. You can just create one of these and
7480 then then make your top level windows later, and not have to worry
7481 about OnInit. For example::
7483 app = wx.PySimpleApp()
7484 frame = wx.Frame(None, title='Hello World')
7491 def __init__(self
, redirect
=False, filename
=None,
7492 useBestVisual
=False, clearSigInt
=True):
7494 :see: `wx.App.__init__`
7496 wx
.App
.__init
__(self
, redirect
, filename
, useBestVisual
, clearSigInt
)
7503 # Is anybody using this one?
7504 class PyWidgetTester(wx
.App
):
7505 def __init__(self
, size
= (250, 100)):
7507 wx
.App
.__init
__(self
, 0)
7510 self
.frame
= wx
.Frame(None, -1, "Widget Tester", pos
=(0,0), size
=self
.size
)
7511 self
.SetTopWindow(self
.frame
)
7514 def SetWidget(self
, widgetClass
, *args
, **kwargs
):
7515 w
= widgetClass(self
.frame
, *args
, **kwargs
)
7516 self
.frame
.Show(True)
7518 #----------------------------------------------------------------------------
7519 # DO NOT hold any other references to this object. This is how we
7520 # know when to cleanup system resources that wxWidgets is holding. When
7521 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7522 # goes to zero and it calls the wx.App_CleanUp function.
7524 class __wxPyCleanup
:
7526 self
.cleanup
= _core_
.App_CleanUp
7530 _sys
.__wxPythonCleanup
= __wxPyCleanup()
7532 ## # another possible solution, but it gets called too early...
7534 ## atexit.register(_core_.wxApp_CleanUp)
7537 #----------------------------------------------------------------------------
7539 #---------------------------------------------------------------------------
7541 class EventLoop(object):
7542 """Proxy of C++ EventLoop class"""
7543 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7544 __repr__
= _swig_repr
7545 def __init__(self
, *args
, **kwargs
):
7546 """__init__(self) -> EventLoop"""
7547 _core_
.EventLoop_swiginit(self
,_core_
.new_EventLoop(*args
, **kwargs
))
7548 __swig_destroy__
= _core_
.delete_EventLoop
7549 __del__
= lambda self
: None;
7550 def Run(*args
, **kwargs
):
7551 """Run(self) -> int"""
7552 return _core_
.EventLoop_Run(*args
, **kwargs
)
7554 def Exit(*args
, **kwargs
):
7555 """Exit(self, int rc=0)"""
7556 return _core_
.EventLoop_Exit(*args
, **kwargs
)
7558 def Pending(*args
, **kwargs
):
7559 """Pending(self) -> bool"""
7560 return _core_
.EventLoop_Pending(*args
, **kwargs
)
7562 def Dispatch(*args
, **kwargs
):
7563 """Dispatch(self) -> bool"""
7564 return _core_
.EventLoop_Dispatch(*args
, **kwargs
)
7566 def IsRunning(*args
, **kwargs
):
7567 """IsRunning(self) -> bool"""
7568 return _core_
.EventLoop_IsRunning(*args
, **kwargs
)
7570 def GetActive(*args
, **kwargs
):
7571 """GetActive() -> EventLoop"""
7572 return _core_
.EventLoop_GetActive(*args
, **kwargs
)
7574 GetActive
= staticmethod(GetActive
)
7575 def SetActive(*args
, **kwargs
):
7576 """SetActive(EventLoop loop)"""
7577 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7579 SetActive
= staticmethod(SetActive
)
7580 _core_
.EventLoop_swigregister(EventLoop
)
7582 def EventLoop_GetActive(*args
):
7583 """EventLoop_GetActive() -> EventLoop"""
7584 return _core_
.EventLoop_GetActive(*args
)
7586 def EventLoop_SetActive(*args
, **kwargs
):
7587 """EventLoop_SetActive(EventLoop loop)"""
7588 return _core_
.EventLoop_SetActive(*args
, **kwargs
)
7590 class EventLoopActivator(object):
7591 """Proxy of C++ EventLoopActivator class"""
7592 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7593 __repr__
= _swig_repr
7594 def __init__(self
, *args
, **kwargs
):
7595 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7596 _core_
.EventLoopActivator_swiginit(self
,_core_
.new_EventLoopActivator(*args
, **kwargs
))
7597 __swig_destroy__
= _core_
.delete_EventLoopActivator
7598 __del__
= lambda self
: None;
7599 _core_
.EventLoopActivator_swigregister(EventLoopActivator
)
7601 #---------------------------------------------------------------------------
7603 ACCEL_ALT
= _core_
.ACCEL_ALT
7604 ACCEL_CTRL
= _core_
.ACCEL_CTRL
7605 ACCEL_SHIFT
= _core_
.ACCEL_SHIFT
7606 ACCEL_NORMAL
= _core_
.ACCEL_NORMAL
7607 ACCEL_CMD
= _core_
.ACCEL_CMD
7608 class AcceleratorEntry(object):
7610 A class used to define items in an `wx.AcceleratorTable`. wxPython
7611 programs can choose to use wx.AcceleratorEntry objects, but using a
7612 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7613 as well. See `__init__` for of the tuple values.
7615 :see: `wx.AcceleratorTable`
7617 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7618 __repr__
= _swig_repr
7619 def __init__(self
, *args
, **kwargs
):
7621 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7623 Construct a wx.AcceleratorEntry.
7625 _core_
.AcceleratorEntry_swiginit(self
,_core_
.new_AcceleratorEntry(*args
, **kwargs
))
7626 __swig_destroy__
= _core_
.delete_AcceleratorEntry
7627 __del__
= lambda self
: None;
7628 def Set(*args
, **kwargs
):
7630 Set(self, int flags, int keyCode, int cmd)
7632 (Re)set the attributes of a wx.AcceleratorEntry.
7635 return _core_
.AcceleratorEntry_Set(*args
, **kwargs
)
7637 def Create(*args
, **kwargs
):
7639 Create(String str) -> AcceleratorEntry
7641 Create accelerator corresponding to the specified string, or None if
7642 it coulnd't be parsed.
7644 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7646 Create
= staticmethod(Create
)
7647 def GetFlags(*args
, **kwargs
):
7649 GetFlags(self) -> int
7651 Get the AcceleratorEntry's flags.
7653 return _core_
.AcceleratorEntry_GetFlags(*args
, **kwargs
)
7655 def GetKeyCode(*args
, **kwargs
):
7657 GetKeyCode(self) -> int
7659 Get the AcceleratorEntry's keycode.
7661 return _core_
.AcceleratorEntry_GetKeyCode(*args
, **kwargs
)
7663 def GetCommand(*args
, **kwargs
):
7665 GetCommand(self) -> int
7667 Get the AcceleratorEntry's command ID.
7669 return _core_
.AcceleratorEntry_GetCommand(*args
, **kwargs
)
7671 def IsOk(*args
, **kwargs
):
7672 """IsOk(self) -> bool"""
7673 return _core_
.AcceleratorEntry_IsOk(*args
, **kwargs
)
7675 def ToString(*args
, **kwargs
):
7677 ToString(self) -> String
7679 Returns a string representation for the this accelerator. The string
7680 is formatted using the <flags>-<keycode> format where <flags> maybe a
7681 hyphen-separed list of "shift|alt|ctrl"
7684 return _core_
.AcceleratorEntry_ToString(*args
, **kwargs
)
7686 def FromString(*args
, **kwargs
):
7688 FromString(self, String str) -> bool
7690 Returns true if the given string correctly initialized this object.
7692 return _core_
.AcceleratorEntry_FromString(*args
, **kwargs
)
7694 Command
= property(GetCommand
,doc
="See `GetCommand`")
7695 Flags
= property(GetFlags
,doc
="See `GetFlags`")
7696 KeyCode
= property(GetKeyCode
,doc
="See `GetKeyCode`")
7697 _core_
.AcceleratorEntry_swigregister(AcceleratorEntry
)
7699 def AcceleratorEntry_Create(*args
, **kwargs
):
7701 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7703 Create accelerator corresponding to the specified string, or None if
7704 it coulnd't be parsed.
7706 return _core_
.AcceleratorEntry_Create(*args
, **kwargs
)
7708 class AcceleratorTable(Object
):
7710 An accelerator table allows the application to specify a table of
7711 keyboard shortcuts for menus or other commands. On Windows, menu or
7712 button commands are supported; on GTK, only menu commands are
7715 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7716 __repr__
= _swig_repr
7717 def __init__(self
, *args
, **kwargs
):
7719 __init__(entries) -> AcceleratorTable
7721 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7722 items or or of 3-tuples (flags, keyCode, cmdID)
7724 :see: `wx.AcceleratorEntry`
7726 _core_
.AcceleratorTable_swiginit(self
,_core_
.new_AcceleratorTable(*args
, **kwargs
))
7727 __swig_destroy__
= _core_
.delete_AcceleratorTable
7728 __del__
= lambda self
: None;
7729 def Ok(*args
, **kwargs
):
7730 """Ok(self) -> bool"""
7731 return _core_
.AcceleratorTable_Ok(*args
, **kwargs
)
7733 _core_
.AcceleratorTable_swigregister(AcceleratorTable
)
7736 def GetAccelFromString(*args
, **kwargs
):
7737 """GetAccelFromString(String label) -> AcceleratorEntry"""
7738 return _core_
.GetAccelFromString(*args
, **kwargs
)
7739 #---------------------------------------------------------------------------
7741 class VisualAttributes(object):
7742 """struct containing all the visual attributes of a control"""
7743 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7744 __repr__
= _swig_repr
7745 def __init__(self
, *args
, **kwargs
):
7747 __init__(self) -> VisualAttributes
7749 struct containing all the visual attributes of a control
7751 _core_
.VisualAttributes_swiginit(self
,_core_
.new_VisualAttributes(*args
, **kwargs
))
7752 __swig_destroy__
= _core_
.delete_VisualAttributes
7753 __del__
= lambda self
: None;
7754 font
= property(_core_
.VisualAttributes_font_get
, _core_
.VisualAttributes_font_set
)
7755 colFg
= property(_core_
.VisualAttributes_colFg_get
, _core_
.VisualAttributes_colFg_set
)
7756 colBg
= property(_core_
.VisualAttributes_colBg_get
, _core_
.VisualAttributes_colBg_set
)
7757 _core_
.VisualAttributes_swigregister(VisualAttributes
)
7758 NullAcceleratorTable
= cvar
.NullAcceleratorTable
7759 PanelNameStr
= cvar
.PanelNameStr
7761 WINDOW_VARIANT_NORMAL
= _core_
.WINDOW_VARIANT_NORMAL
7762 WINDOW_VARIANT_SMALL
= _core_
.WINDOW_VARIANT_SMALL
7763 WINDOW_VARIANT_MINI
= _core_
.WINDOW_VARIANT_MINI
7764 WINDOW_VARIANT_LARGE
= _core_
.WINDOW_VARIANT_LARGE
7765 WINDOW_VARIANT_MAX
= _core_
.WINDOW_VARIANT_MAX
7766 class Window(EvtHandler
):
7768 wx.Window is the base class for all windows and represents any visible
7769 object on the screen. All controls, top level windows and so on are
7770 wx.Windows. Sizers and device contexts are not however, as they don't
7771 appear on screen themselves.
7774 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
7775 __repr__
= _swig_repr
7776 def __init__(self
, *args
, **kwargs
):
7778 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7779 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7781 Construct and show a generic Window.
7783 _core_
.Window_swiginit(self
,_core_
.new_Window(*args
, **kwargs
))
7784 self
._setOORInfo
(self
)
7786 def Create(*args
, **kwargs
):
7788 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7789 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7791 Create the GUI part of the Window for 2-phase creation mode.
7793 return _core_
.Window_Create(*args
, **kwargs
)
7795 def Close(*args
, **kwargs
):
7797 Close(self, bool force=False) -> bool
7799 This function simply generates a EVT_CLOSE event whose handler usually
7800 tries to close the window. It doesn't close the window itself,
7801 however. If force is False (the default) then the window's close
7802 handler will be allowed to veto the destruction of the window.
7804 return _core_
.Window_Close(*args
, **kwargs
)
7806 def Destroy(*args
, **kwargs
):
7808 Destroy(self) -> bool
7810 Destroys the window safely. Frames and dialogs are not destroyed
7811 immediately when this function is called -- they are added to a list
7812 of windows to be deleted on idle time, when all the window's events
7813 have been processed. This prevents problems with events being sent to
7814 non-existent windows.
7816 Returns True if the window has either been successfully deleted, or it
7817 has been added to the list of windows pending real deletion.
7819 val
= _core_
.Window_Destroy(*args
, **kwargs
)
7823 def DestroyChildren(*args
, **kwargs
):
7825 DestroyChildren(self) -> bool
7827 Destroys all children of a window. Called automatically by the
7830 return _core_
.Window_DestroyChildren(*args
, **kwargs
)
7832 def IsBeingDeleted(*args
, **kwargs
):
7834 IsBeingDeleted(self) -> bool
7836 Is the window in the process of being deleted?
7838 return _core_
.Window_IsBeingDeleted(*args
, **kwargs
)
7840 def SetLabel(*args
, **kwargs
):
7842 SetLabel(self, String label)
7844 Set the text which the window shows in its label if applicable.
7846 return _core_
.Window_SetLabel(*args
, **kwargs
)
7848 def GetLabel(*args
, **kwargs
):
7850 GetLabel(self) -> String
7852 Generic way of getting a label from any window, for identification
7853 purposes. The interpretation of this function differs from class to
7854 class. For frames and dialogs, the value returned is the title. For
7855 buttons or static text controls, it is the button text. This function
7856 can be useful for meta-programs such as testing tools or special-needs
7857 access programs)which need to identify windows by name.
7859 return _core_
.Window_GetLabel(*args
, **kwargs
)
7861 def SetName(*args
, **kwargs
):
7863 SetName(self, String name)
7865 Sets the window's name. The window name is used for ressource setting
7866 in X, it is not the same as the window title/label
7868 return _core_
.Window_SetName(*args
, **kwargs
)
7870 def GetName(*args
, **kwargs
):
7872 GetName(self) -> String
7874 Returns the windows name. This name is not guaranteed to be unique;
7875 it is up to the programmer to supply an appropriate name in the window
7876 constructor or via wx.Window.SetName.
7878 return _core_
.Window_GetName(*args
, **kwargs
)
7880 def SetWindowVariant(*args
, **kwargs
):
7882 SetWindowVariant(self, int variant)
7884 Sets the variant of the window/font size to use for this window, if
7885 the platform supports variants, for example, wxMac.
7887 return _core_
.Window_SetWindowVariant(*args
, **kwargs
)
7889 def GetWindowVariant(*args
, **kwargs
):
7890 """GetWindowVariant(self) -> int"""
7891 return _core_
.Window_GetWindowVariant(*args
, **kwargs
)
7893 def SetId(*args
, **kwargs
):
7895 SetId(self, int winid)
7897 Sets the identifier of the window. Each window has an integer
7898 identifier. If the application has not provided one, an identifier
7899 will be generated. Normally, the identifier should be provided on
7900 creation and should not be modified subsequently.
7902 return _core_
.Window_SetId(*args
, **kwargs
)
7904 def GetId(*args
, **kwargs
):
7908 Returns the identifier of the window. Each window has an integer
7909 identifier. If the application has not provided one (or the default Id
7910 -1 is used) then an unique identifier with a negative value will be
7913 return _core_
.Window_GetId(*args
, **kwargs
)
7915 def NewControlId(*args
, **kwargs
):
7917 NewControlId() -> int
7919 Generate a control id for the controls which were not given one.
7921 return _core_
.Window_NewControlId(*args
, **kwargs
)
7923 NewControlId
= staticmethod(NewControlId
)
7924 def NextControlId(*args
, **kwargs
):
7926 NextControlId(int winid) -> int
7928 Get the id of the control following the one with the given
7931 return _core_
.Window_NextControlId(*args
, **kwargs
)
7933 NextControlId
= staticmethod(NextControlId
)
7934 def PrevControlId(*args
, **kwargs
):
7936 PrevControlId(int winid) -> int
7938 Get the id of the control preceding the one with the given
7941 return _core_
.Window_PrevControlId(*args
, **kwargs
)
7943 PrevControlId
= staticmethod(PrevControlId
)
7944 def GetLayoutDirection(*args
, **kwargs
):
7946 GetLayoutDirection(self) -> int
7948 Get the layout direction (LTR or RTL) for this window. Returns
7949 ``wx.Layout_Default`` if layout direction is not supported.
7951 return _core_
.Window_GetLayoutDirection(*args
, **kwargs
)
7953 def SetLayoutDirection(*args
, **kwargs
):
7955 SetLayoutDirection(self, int dir)
7957 Set the layout direction (LTR or RTL) for this window.
7959 return _core_
.Window_SetLayoutDirection(*args
, **kwargs
)
7961 def AdjustForLayoutDirection(*args
, **kwargs
):
7963 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
7965 Mirror coordinates for RTL layout if this window uses it and if the
7966 mirroring is not done automatically like Win32.
7968 return _core_
.Window_AdjustForLayoutDirection(*args
, **kwargs
)
7970 def SetSize(*args
, **kwargs
):
7972 SetSize(self, Size size)
7974 Sets the size of the window in pixels.
7976 return _core_
.Window_SetSize(*args
, **kwargs
)
7978 def SetDimensions(*args
, **kwargs
):
7980 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7982 Sets the position and size of the window in pixels. The sizeFlags
7983 parameter indicates the interpretation of the other params if they are
7986 ======================== ======================================
7987 wx.SIZE_AUTO A -1 indicates that a class-specific
7988 default should be used.
7989 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
7990 -1 values are supplied.
7991 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
7992 interpreted as real dimensions, not
7994 ======================== ======================================
7997 return _core_
.Window_SetDimensions(*args
, **kwargs
)
7999 def SetRect(*args
, **kwargs
):
8001 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8003 Sets the position and size of the window in pixels using a wx.Rect.
8005 return _core_
.Window_SetRect(*args
, **kwargs
)
8007 def SetSizeWH(*args
, **kwargs
):
8009 SetSizeWH(self, int width, int height)
8011 Sets the size of the window in pixels.
8013 return _core_
.Window_SetSizeWH(*args
, **kwargs
)
8015 def Move(*args
, **kwargs
):
8017 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8019 Moves the window to the given position.
8021 return _core_
.Window_Move(*args
, **kwargs
)
8024 def MoveXY(*args
, **kwargs
):
8026 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8028 Moves the window to the given position.
8030 return _core_
.Window_MoveXY(*args
, **kwargs
)
8032 def SetBestFittingSize(*args
, **kwargs
):
8034 SetBestFittingSize(self, Size size=DefaultSize)
8036 A 'Smart' SetSize that will fill in default size components with the
8037 window's *best size* values. Also set's the minsize for use with sizers.
8039 return _core_
.Window_SetBestFittingSize(*args
, **kwargs
)
8041 def Raise(*args
, **kwargs
):
8045 Raises the window to the top of the window hierarchy. In current
8046 version of wxWidgets this works both for manage and child windows.
8048 return _core_
.Window_Raise(*args
, **kwargs
)
8050 def Lower(*args
, **kwargs
):
8054 Lowers the window to the bottom of the window hierarchy. In current
8055 version of wxWidgets this works both for manage and child windows.
8057 return _core_
.Window_Lower(*args
, **kwargs
)
8059 def SetClientSize(*args
, **kwargs
):
8061 SetClientSize(self, Size size)
8063 This sets the size of the window client area in pixels. Using this
8064 function to size a window tends to be more device-independent than
8065 wx.Window.SetSize, since the application need not worry about what
8066 dimensions the border or title bar have when trying to fit the window
8067 around panel items, for example.
8069 return _core_
.Window_SetClientSize(*args
, **kwargs
)
8071 def SetClientSizeWH(*args
, **kwargs
):
8073 SetClientSizeWH(self, int width, int height)
8075 This sets the size of the window client area in pixels. Using this
8076 function to size a window tends to be more device-independent than
8077 wx.Window.SetSize, since the application need not worry about what
8078 dimensions the border or title bar have when trying to fit the window
8079 around panel items, for example.
8081 return _core_
.Window_SetClientSizeWH(*args
, **kwargs
)
8083 def SetClientRect(*args
, **kwargs
):
8085 SetClientRect(self, Rect rect)
8087 This sets the size of the window client area in pixels. Using this
8088 function to size a window tends to be more device-independent than
8089 wx.Window.SetSize, since the application need not worry about what
8090 dimensions the border or title bar have when trying to fit the window
8091 around panel items, for example.
8093 return _core_
.Window_SetClientRect(*args
, **kwargs
)
8095 def GetPosition(*args
, **kwargs
):
8097 GetPosition(self) -> Point
8099 Get the window's position. Notice that the position is in client
8100 coordinates for child windows and screen coordinates for the top level
8101 ones, use `GetScreenPosition` if you need screen coordinates for all
8104 return _core_
.Window_GetPosition(*args
, **kwargs
)
8106 def GetPositionTuple(*args
, **kwargs
):
8108 GetPositionTuple() -> (x,y)
8110 Get the window's position. Notice that the position is in client
8111 coordinates for child windows and screen coordinates for the top level
8112 ones, use `GetScreenPosition` if you need screen coordinates for all
8115 return _core_
.Window_GetPositionTuple(*args
, **kwargs
)
8117 def GetScreenPosition(*args
, **kwargs
):
8119 GetScreenPosition(self) -> Point
8121 Get the position of the window in screen coordinantes.
8123 return _core_
.Window_GetScreenPosition(*args
, **kwargs
)
8125 def GetScreenPositionTuple(*args
, **kwargs
):
8127 GetScreenPositionTuple() -> (x,y)
8129 Get the position of the window in screen coordinantes.
8131 return _core_
.Window_GetScreenPositionTuple(*args
, **kwargs
)
8133 def GetScreenRect(*args
, **kwargs
):
8135 GetScreenRect(self) -> Rect
8137 Returns the size and position of the window in screen coordinantes as
8140 return _core_
.Window_GetScreenRect(*args
, **kwargs
)
8142 def GetSize(*args
, **kwargs
):
8144 GetSize(self) -> Size
8146 Get the window size.
8148 return _core_
.Window_GetSize(*args
, **kwargs
)
8150 def GetSizeTuple(*args
, **kwargs
):
8152 GetSizeTuple() -> (width, height)
8154 Get the window size.
8156 return _core_
.Window_GetSizeTuple(*args
, **kwargs
)
8158 def GetRect(*args
, **kwargs
):
8160 GetRect(self) -> Rect
8162 Returns the size and position of the window as a `wx.Rect` object.
8164 return _core_
.Window_GetRect(*args
, **kwargs
)
8166 def GetClientSize(*args
, **kwargs
):
8168 GetClientSize(self) -> Size
8170 This gets the size of the window's 'client area' in pixels. The client
8171 area is the area which may be drawn on by the programmer, excluding
8172 title bar, border, scrollbars, etc.
8174 return _core_
.Window_GetClientSize(*args
, **kwargs
)
8176 def GetClientSizeTuple(*args
, **kwargs
):
8178 GetClientSizeTuple() -> (width, height)
8180 This gets the size of the window's 'client area' in pixels. The client
8181 area is the area which may be drawn on by the programmer, excluding
8182 title bar, border, scrollbars, etc.
8184 return _core_
.Window_GetClientSizeTuple(*args
, **kwargs
)
8186 def GetClientAreaOrigin(*args
, **kwargs
):
8188 GetClientAreaOrigin(self) -> Point
8190 Get the origin of the client area of the window relative to the
8191 window's top left corner (the client area may be shifted because of
8192 the borders, scrollbars, other decorations...)
8194 return _core_
.Window_GetClientAreaOrigin(*args
, **kwargs
)
8196 def GetClientRect(*args
, **kwargs
):
8198 GetClientRect(self) -> Rect
8200 Get the client area position and size as a `wx.Rect` object.
8202 return _core_
.Window_GetClientRect(*args
, **kwargs
)
8204 def GetBestSize(*args
, **kwargs
):
8206 GetBestSize(self) -> Size
8208 This function returns the best acceptable minimal size for the
8209 window, if applicable. For example, for a static text control, it will
8210 be the minimal size such that the control label is not truncated. For
8211 windows containing subwindows (suzh aswx.Panel), the size returned by
8212 this function will be the same as the size the window would have had
8215 return _core_
.Window_GetBestSize(*args
, **kwargs
)
8217 def GetBestSizeTuple(*args
, **kwargs
):
8219 GetBestSizeTuple() -> (width, height)
8221 This function returns the best acceptable minimal size for the
8222 window, if applicable. For example, for a static text control, it will
8223 be the minimal size such that the control label is not truncated. For
8224 windows containing subwindows (suzh aswx.Panel), the size returned by
8225 this function will be the same as the size the window would have had
8228 return _core_
.Window_GetBestSizeTuple(*args
, **kwargs
)
8230 def InvalidateBestSize(*args
, **kwargs
):
8232 InvalidateBestSize(self)
8234 Reset the cached best size value so it will be recalculated the next
8237 return _core_
.Window_InvalidateBestSize(*args
, **kwargs
)
8239 def CacheBestSize(*args
, **kwargs
):
8241 CacheBestSize(self, Size size)
8243 Cache the best size so it doesn't need to be calculated again, (at least until
8244 some properties of the window change.)
8246 return _core_
.Window_CacheBestSize(*args
, **kwargs
)
8248 def GetBestFittingSize(*args
, **kwargs
):
8250 GetBestFittingSize(self) -> Size
8252 This function will merge the window's best size into the window's
8253 minimum size, giving priority to the min size components, and returns
8257 return _core_
.Window_GetBestFittingSize(*args
, **kwargs
)
8259 def GetAdjustedBestSize(*args
, **kwargs
):
8261 GetAdjustedBestSize(self) -> Size
8263 This method is similar to GetBestSize, except in one
8264 thing. GetBestSize should return the minimum untruncated size of the
8265 window, while this method will return the largest of BestSize and any
8266 user specified minimum size. ie. it is the minimum size the window
8267 should currently be drawn at, not the minimal size it can possibly
8270 return _core_
.Window_GetAdjustedBestSize(*args
, **kwargs
)
8272 def Center(*args
, **kwargs
):
8274 Center(self, int direction=BOTH)
8276 Centers the window. The parameter specifies the direction for
8277 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8278 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8279 on the entire screen and not on its parent window. If it is a
8280 top-level window and has no parent then it will always be centered
8281 relative to the screen.
8283 return _core_
.Window_Center(*args
, **kwargs
)
8286 def CenterOnParent(*args
, **kwargs
):
8288 CenterOnParent(self, int dir=BOTH)
8290 Center with respect to the the parent window
8292 return _core_
.Window_CenterOnParent(*args
, **kwargs
)
8294 CentreOnParent
= CenterOnParent
8295 def Fit(*args
, **kwargs
):
8299 Sizes the window so that it fits around its subwindows. This function
8300 won't do anything if there are no subwindows and will only really work
8301 correctly if sizers are used for the subwindows layout. Also, if the
8302 window has exactly one subwindow it is better (faster and the result
8303 is more precise as Fit adds some margin to account for fuzziness of
8304 its calculations) to call window.SetClientSize(child.GetSize())
8305 instead of calling Fit.
8307 return _core_
.Window_Fit(*args
, **kwargs
)
8309 def FitInside(*args
, **kwargs
):
8313 Similar to Fit, but sizes the interior (virtual) size of a
8314 window. Mainly useful with scrolled windows to reset scrollbars after
8315 sizing changes that do not trigger a size event, and/or scrolled
8316 windows without an interior sizer. This function similarly won't do
8317 anything if there are no subwindows.
8319 return _core_
.Window_FitInside(*args
, **kwargs
)
8321 def SetSizeHints(*args
, **kwargs
):
8323 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8326 Allows specification of minimum and maximum window sizes, and window
8327 size increments. If a pair of values is not set (or set to -1), the
8328 default values will be used. If this function is called, the user
8329 will not be able to size the window outside the given bounds (if it is
8330 a top-level window.) Sizers will also inspect the minimum window size
8331 and will use that value if set when calculating layout.
8333 The resizing increments are only significant under Motif or Xt.
8335 return _core_
.Window_SetSizeHints(*args
, **kwargs
)
8337 def SetSizeHintsSz(*args
, **kwargs
):
8339 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8341 Allows specification of minimum and maximum window sizes, and window
8342 size increments. If a pair of values is not set (or set to -1), the
8343 default values will be used. If this function is called, the user
8344 will not be able to size the window outside the given bounds (if it is
8345 a top-level window.) Sizers will also inspect the minimum window size
8346 and will use that value if set when calculating layout.
8348 The resizing increments are only significant under Motif or Xt.
8350 return _core_
.Window_SetSizeHintsSz(*args
, **kwargs
)
8352 def SetVirtualSizeHints(*args
, **kwargs
):
8354 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8356 Allows specification of minimum and maximum virtual window sizes. If a
8357 pair of values is not set (or set to -1), the default values will be
8358 used. If this function is called, the user will not be able to size
8359 the virtual area of the window outside the given bounds.
8361 return _core_
.Window_SetVirtualSizeHints(*args
, **kwargs
)
8363 def SetVirtualSizeHintsSz(*args
, **kwargs
):
8365 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8367 Allows specification of minimum and maximum virtual window sizes. If a
8368 pair of values is not set (or set to -1), the default values will be
8369 used. If this function is called, the user will not be able to size
8370 the virtual area of the window outside the given bounds.
8372 return _core_
.Window_SetVirtualSizeHintsSz(*args
, **kwargs
)
8374 def GetMaxSize(*args
, **kwargs
):
8375 """GetMaxSize(self) -> Size"""
8376 return _core_
.Window_GetMaxSize(*args
, **kwargs
)
8378 def GetMinSize(*args
, **kwargs
):
8379 """GetMinSize(self) -> Size"""
8380 return _core_
.Window_GetMinSize(*args
, **kwargs
)
8382 def SetMinSize(*args
, **kwargs
):
8384 SetMinSize(self, Size minSize)
8386 A more convenient method than `SetSizeHints` for setting just the
8389 return _core_
.Window_SetMinSize(*args
, **kwargs
)
8391 def SetMaxSize(*args
, **kwargs
):
8393 SetMaxSize(self, Size maxSize)
8395 A more convenient method than `SetSizeHints` for setting just the
8398 return _core_
.Window_SetMaxSize(*args
, **kwargs
)
8400 def GetMinWidth(*args
, **kwargs
):
8401 """GetMinWidth(self) -> int"""
8402 return _core_
.Window_GetMinWidth(*args
, **kwargs
)
8404 def GetMinHeight(*args
, **kwargs
):
8405 """GetMinHeight(self) -> int"""
8406 return _core_
.Window_GetMinHeight(*args
, **kwargs
)
8408 def GetMaxWidth(*args
, **kwargs
):
8409 """GetMaxWidth(self) -> int"""
8410 return _core_
.Window_GetMaxWidth(*args
, **kwargs
)
8412 def GetMaxHeight(*args
, **kwargs
):
8413 """GetMaxHeight(self) -> int"""
8414 return _core_
.Window_GetMaxHeight(*args
, **kwargs
)
8416 def SetVirtualSize(*args
, **kwargs
):
8418 SetVirtualSize(self, Size size)
8420 Set the the virtual size of a window in pixels. For most windows this
8421 is just the client area of the window, but for some like scrolled
8422 windows it is more or less independent of the screen window size.
8424 return _core_
.Window_SetVirtualSize(*args
, **kwargs
)
8426 def SetVirtualSizeWH(*args
, **kwargs
):
8428 SetVirtualSizeWH(self, int w, int h)
8430 Set the the virtual size of a window in pixels. For most windows this
8431 is just the client area of the window, but for some like scrolled
8432 windows it is more or less independent of the screen window size.
8434 return _core_
.Window_SetVirtualSizeWH(*args
, **kwargs
)
8436 def GetVirtualSize(*args
, **kwargs
):
8438 GetVirtualSize(self) -> Size
8440 Get the the virtual size of the window in pixels. For most windows
8441 this is just the client area of the window, but for some like scrolled
8442 windows it is more or less independent of the screen window size.
8444 return _core_
.Window_GetVirtualSize(*args
, **kwargs
)
8446 def GetVirtualSizeTuple(*args
, **kwargs
):
8448 GetVirtualSizeTuple() -> (width, height)
8450 Get the the virtual size of the window in pixels. For most windows
8451 this is just the client area of the window, but for some like scrolled
8452 windows it is more or less independent of the screen window size.
8454 return _core_
.Window_GetVirtualSizeTuple(*args
, **kwargs
)
8456 def GetBestVirtualSize(*args
, **kwargs
):
8458 GetBestVirtualSize(self) -> Size
8460 Return the largest of ClientSize and BestSize (as determined by a
8461 sizer, interior children, or other means)
8463 return _core_
.Window_GetBestVirtualSize(*args
, **kwargs
)
8465 def Show(*args
, **kwargs
):
8467 Show(self, bool show=True) -> bool
8469 Shows or hides the window. You may need to call Raise for a top level
8470 window if you want to bring it to top, although this is not needed if
8471 Show is called immediately after the frame creation. Returns True if
8472 the window has been shown or hidden or False if nothing was done
8473 because it already was in the requested state.
8475 return _core_
.Window_Show(*args
, **kwargs
)
8477 def Hide(*args
, **kwargs
):
8481 Equivalent to calling Show(False).
8483 return _core_
.Window_Hide(*args
, **kwargs
)
8485 def Enable(*args
, **kwargs
):
8487 Enable(self, bool enable=True) -> bool
8489 Enable or disable the window for user input. Note that when a parent
8490 window is disabled, all of its children are disabled as well and they
8491 are reenabled again when the parent is. Returns true if the window
8492 has been enabled or disabled, false if nothing was done, i.e. if the
8493 window had already been in the specified state.
8495 return _core_
.Window_Enable(*args
, **kwargs
)
8497 def Disable(*args
, **kwargs
):
8499 Disable(self) -> bool
8501 Disables the window, same as Enable(false).
8503 return _core_
.Window_Disable(*args
, **kwargs
)
8505 def IsShown(*args
, **kwargs
):
8507 IsShown(self) -> bool
8509 Returns true if the window is shown, false if it has been hidden.
8511 return _core_
.Window_IsShown(*args
, **kwargs
)
8513 def IsEnabled(*args
, **kwargs
):
8515 IsEnabled(self) -> bool
8517 Returns true if the window is enabled for input, false otherwise.
8519 return _core_
.Window_IsEnabled(*args
, **kwargs
)
8521 def IsShownOnScreen(*args
, **kwargs
):
8523 IsShownOnScreen(self) -> bool
8525 Returns ``True`` if the window is physically visible on the screen,
8526 i.e. it is shown and all its parents up to the toplevel window are
8529 return _core_
.Window_IsShownOnScreen(*args
, **kwargs
)
8531 def SetWindowStyleFlag(*args
, **kwargs
):
8533 SetWindowStyleFlag(self, long style)
8535 Sets the style of the window. Please note that some styles cannot be
8536 changed after the window creation and that Refresh() might need to be
8537 called after changing the others for the change to take place
8540 return _core_
.Window_SetWindowStyleFlag(*args
, **kwargs
)
8542 def GetWindowStyleFlag(*args
, **kwargs
):
8544 GetWindowStyleFlag(self) -> long
8546 Gets the window style that was passed to the constructor or Create
8549 return _core_
.Window_GetWindowStyleFlag(*args
, **kwargs
)
8551 SetWindowStyle
= SetWindowStyleFlag
; GetWindowStyle
= GetWindowStyleFlag
8552 def HasFlag(*args
, **kwargs
):
8554 HasFlag(self, int flag) -> bool
8556 Test if the given style is set for this window.
8558 return _core_
.Window_HasFlag(*args
, **kwargs
)
8560 def IsRetained(*args
, **kwargs
):
8562 IsRetained(self) -> bool
8564 Returns true if the window is retained, false otherwise. Retained
8565 windows are only available on X platforms.
8567 return _core_
.Window_IsRetained(*args
, **kwargs
)
8569 def SetExtraStyle(*args
, **kwargs
):
8571 SetExtraStyle(self, long exStyle)
8573 Sets the extra style bits for the window. Extra styles are the less
8574 often used style bits which can't be set with the constructor or with
8575 SetWindowStyleFlag()
8577 return _core_
.Window_SetExtraStyle(*args
, **kwargs
)
8579 def GetExtraStyle(*args
, **kwargs
):
8581 GetExtraStyle(self) -> long
8583 Returns the extra style bits for the window.
8585 return _core_
.Window_GetExtraStyle(*args
, **kwargs
)
8587 def MakeModal(*args
, **kwargs
):
8589 MakeModal(self, bool modal=True)
8591 Disables all other windows in the application so that the user can
8592 only interact with this window. Passing False will reverse this
8595 return _core_
.Window_MakeModal(*args
, **kwargs
)
8597 def SetThemeEnabled(*args
, **kwargs
):
8599 SetThemeEnabled(self, bool enableTheme)
8601 This function tells a window if it should use the system's "theme"
8602 code to draw the windows' background instead if its own background
8603 drawing code. This will only have an effect on platforms that support
8604 the notion of themes in user defined windows. One such platform is
8605 GTK+ where windows can have (very colourful) backgrounds defined by a
8606 user's selected theme.
8608 Dialogs, notebook pages and the status bar have this flag set to true
8609 by default so that the default look and feel is simulated best.
8611 return _core_
.Window_SetThemeEnabled(*args
, **kwargs
)
8613 def GetThemeEnabled(*args
, **kwargs
):
8615 GetThemeEnabled(self) -> bool
8617 Return the themeEnabled flag.
8619 return _core_
.Window_GetThemeEnabled(*args
, **kwargs
)
8621 def SetFocus(*args
, **kwargs
):
8625 Set's the focus to this window, allowing it to receive keyboard input.
8627 return _core_
.Window_SetFocus(*args
, **kwargs
)
8629 def SetFocusFromKbd(*args
, **kwargs
):
8631 SetFocusFromKbd(self)
8633 Set focus to this window as the result of a keyboard action. Normally
8634 only called internally.
8636 return _core_
.Window_SetFocusFromKbd(*args
, **kwargs
)
8638 def FindFocus(*args
, **kwargs
):
8640 FindFocus() -> Window
8642 Returns the window or control that currently has the keyboard focus,
8645 return _core_
.Window_FindFocus(*args
, **kwargs
)
8647 FindFocus
= staticmethod(FindFocus
)
8648 def AcceptsFocus(*args
, **kwargs
):
8650 AcceptsFocus(self) -> bool
8652 Can this window have focus?
8654 return _core_
.Window_AcceptsFocus(*args
, **kwargs
)
8656 def AcceptsFocusFromKeyboard(*args
, **kwargs
):
8658 AcceptsFocusFromKeyboard(self) -> bool
8660 Can this window be given focus by keyboard navigation? if not, the
8661 only way to give it focus (provided it accepts it at all) is to click
8664 return _core_
.Window_AcceptsFocusFromKeyboard(*args
, **kwargs
)
8666 def Navigate(*args
, **kwargs
):
8668 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8670 Does keyboard navigation from this window to another, by sending a
8671 `wx.NavigationKeyEvent`.
8673 return _core_
.Window_Navigate(*args
, **kwargs
)
8675 def MoveAfterInTabOrder(*args
, **kwargs
):
8677 MoveAfterInTabOrder(self, Window win)
8679 Moves this window in the tab navigation order after the specified
8680 sibling window. This means that when the user presses the TAB key on
8681 that other window, the focus switches to this window.
8683 The default tab order is the same as creation order. This function
8684 and `MoveBeforeInTabOrder` allow to change it after creating all the
8688 return _core_
.Window_MoveAfterInTabOrder(*args
, **kwargs
)
8690 def MoveBeforeInTabOrder(*args
, **kwargs
):
8692 MoveBeforeInTabOrder(self, Window win)
8694 Same as `MoveAfterInTabOrder` except that it inserts this window just
8695 before win instead of putting it right after it.
8697 return _core_
.Window_MoveBeforeInTabOrder(*args
, **kwargs
)
8699 def GetChildren(*args
, **kwargs
):
8701 GetChildren(self) -> PyObject
8703 Returns a list of the window's children. NOTE: Currently this is a
8704 copy of the child window list maintained by the window, so the return
8705 value of this function is only valid as long as the window's children
8708 return _core_
.Window_GetChildren(*args
, **kwargs
)
8710 def GetParent(*args
, **kwargs
):
8712 GetParent(self) -> Window
8714 Returns the parent window of this window, or None if there isn't one.
8716 return _core_
.Window_GetParent(*args
, **kwargs
)
8718 def GetGrandParent(*args
, **kwargs
):
8720 GetGrandParent(self) -> Window
8722 Returns the parent of the parent of this window, or None if there
8725 return _core_
.Window_GetGrandParent(*args
, **kwargs
)
8727 def IsTopLevel(*args
, **kwargs
):
8729 IsTopLevel(self) -> bool
8731 Returns true if the given window is a top-level one. Currently all
8732 frames and dialogs are always considered to be top-level windows (even
8733 if they have a parent window).
8735 return _core_
.Window_IsTopLevel(*args
, **kwargs
)
8737 def Reparent(*args
, **kwargs
):
8739 Reparent(self, Window newParent) -> bool
8741 Reparents the window, i.e the window will be removed from its current
8742 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8743 re-inserted into another. Available on Windows and GTK. Returns True
8744 if the parent was changed, False otherwise (error or newParent ==
8747 return _core_
.Window_Reparent(*args
, **kwargs
)
8749 def AddChild(*args
, **kwargs
):
8751 AddChild(self, Window child)
8753 Adds a child window. This is called automatically by window creation
8754 functions so should not be required by the application programmer.
8756 return _core_
.Window_AddChild(*args
, **kwargs
)
8758 def RemoveChild(*args
, **kwargs
):
8760 RemoveChild(self, Window child)
8762 Removes a child window. This is called automatically by window
8763 deletion functions so should not be required by the application
8766 return _core_
.Window_RemoveChild(*args
, **kwargs
)
8768 def SetDoubleBuffered(*args
, **kwargs
):
8770 SetDoubleBuffered(self, bool on)
8772 Currently wxGTK2 only.
8774 return _core_
.Window_SetDoubleBuffered(*args
, **kwargs
)
8776 def FindWindowById(*args
, **kwargs
):
8778 FindWindowById(self, long winid) -> Window
8780 Find a chld of this window by window ID
8782 return _core_
.Window_FindWindowById(*args
, **kwargs
)
8784 def FindWindowByName(*args
, **kwargs
):
8786 FindWindowByName(self, String name) -> Window
8788 Find a child of this window by name
8790 return _core_
.Window_FindWindowByName(*args
, **kwargs
)
8792 def GetEventHandler(*args
, **kwargs
):
8794 GetEventHandler(self) -> EvtHandler
8796 Returns the event handler for this window. By default, the window is
8797 its own event handler.
8799 return _core_
.Window_GetEventHandler(*args
, **kwargs
)
8801 def SetEventHandler(*args
, **kwargs
):
8803 SetEventHandler(self, EvtHandler handler)
8805 Sets the event handler for this window. An event handler is an object
8806 that is capable of processing the events sent to a window. (In other
8807 words, is able to dispatch the events to handler function.) By
8808 default, the window is its own event handler, but an application may
8809 wish to substitute another, for example to allow central
8810 implementation of event-handling for a variety of different window
8813 It is usually better to use `wx.Window.PushEventHandler` since this sets
8814 up a chain of event handlers, where an event not handled by one event
8815 handler is handed off to the next one in the chain.
8817 return _core_
.Window_SetEventHandler(*args
, **kwargs
)
8819 def PushEventHandler(*args
, **kwargs
):
8821 PushEventHandler(self, EvtHandler handler)
8823 Pushes this event handler onto the event handler stack for the window.
8824 An event handler is an object that is capable of processing the events
8825 sent to a window. (In other words, is able to dispatch the events to
8826 handler function.) By default, the window is its own event handler,
8827 but an application may wish to substitute another, for example to
8828 allow central implementation of event-handling for a variety of
8829 different window classes.
8831 wx.Window.PushEventHandler allows an application to set up a chain of
8832 event handlers, where an event not handled by one event handler is
8833 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
8834 to remove the event handler. Ownership of the handler is *not* given
8835 to the window, so you should be sure to pop the handler before the
8836 window is destroyed and either let PopEventHandler destroy it, or call
8837 its Destroy method yourself.
8839 return _core_
.Window_PushEventHandler(*args
, **kwargs
)
8841 def PopEventHandler(*args
, **kwargs
):
8843 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8845 Removes and returns the top-most event handler on the event handler
8846 stack. If deleteHandler is True then the wx.EvtHandler object will be
8847 destroyed after it is popped, and ``None`` will be returned instead.
8849 return _core_
.Window_PopEventHandler(*args
, **kwargs
)
8851 def RemoveEventHandler(*args
, **kwargs
):
8853 RemoveEventHandler(self, EvtHandler handler) -> bool
8855 Find the given handler in the event handler chain and remove (but not
8856 delete) it from the event handler chain, returns True if it was found
8857 and False otherwise (this also results in an assert failure so this
8858 function should only be called when the handler is supposed to be
8861 return _core_
.Window_RemoveEventHandler(*args
, **kwargs
)
8863 def SetValidator(*args
, **kwargs
):
8865 SetValidator(self, Validator validator)
8867 Deletes the current validator (if any) and sets the window validator,
8868 having called wx.Validator.Clone to create a new validator of this
8871 return _core_
.Window_SetValidator(*args
, **kwargs
)
8873 def GetValidator(*args
, **kwargs
):
8875 GetValidator(self) -> Validator
8877 Returns a pointer to the current validator for the window, or None if
8880 return _core_
.Window_GetValidator(*args
, **kwargs
)
8882 def Validate(*args
, **kwargs
):
8884 Validate(self) -> bool
8886 Validates the current values of the child controls using their
8887 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8888 style flag set, the method will also call Validate() of all child
8889 windows. Returns false if any of the validations failed.
8891 return _core_
.Window_Validate(*args
, **kwargs
)
8893 def TransferDataToWindow(*args
, **kwargs
):
8895 TransferDataToWindow(self) -> bool
8897 Transfers values to child controls from data areas specified by their
8898 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8899 style flag set, the method will also call TransferDataToWindow() of
8902 return _core_
.Window_TransferDataToWindow(*args
, **kwargs
)
8904 def TransferDataFromWindow(*args
, **kwargs
):
8906 TransferDataFromWindow(self) -> bool
8908 Transfers values from child controls to data areas specified by their
8909 validators. Returns false if a transfer failed. If the window has
8910 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8911 also call TransferDataFromWindow() of all child windows.
8913 return _core_
.Window_TransferDataFromWindow(*args
, **kwargs
)
8915 def InitDialog(*args
, **kwargs
):
8919 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8920 to the dialog via validators.
8922 return _core_
.Window_InitDialog(*args
, **kwargs
)
8924 def SetAcceleratorTable(*args
, **kwargs
):
8926 SetAcceleratorTable(self, AcceleratorTable accel)
8928 Sets the accelerator table for this window.
8930 return _core_
.Window_SetAcceleratorTable(*args
, **kwargs
)
8932 def GetAcceleratorTable(*args
, **kwargs
):
8934 GetAcceleratorTable(self) -> AcceleratorTable
8936 Gets the accelerator table for this window.
8938 return _core_
.Window_GetAcceleratorTable(*args
, **kwargs
)
8940 def RegisterHotKey(*args
, **kwargs
):
8942 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8944 Registers a system wide hotkey. Every time the user presses the hotkey
8945 registered here, this window will receive a hotkey event. It will
8946 receive the event even if the application is in the background and
8947 does not have the input focus because the user is working with some
8948 other application. To bind an event handler function to this hotkey
8949 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
8950 hotkey was registered successfully.
8952 return _core_
.Window_RegisterHotKey(*args
, **kwargs
)
8954 def UnregisterHotKey(*args
, **kwargs
):
8956 UnregisterHotKey(self, int hotkeyId) -> bool
8958 Unregisters a system wide hotkey.
8960 return _core_
.Window_UnregisterHotKey(*args
, **kwargs
)
8962 def ConvertDialogPointToPixels(*args
, **kwargs
):
8964 ConvertDialogPointToPixels(self, Point pt) -> Point
8966 Converts a point or size from dialog units to pixels. Dialog units
8967 are used for maintaining a dialog's proportions even if the font
8968 changes. For the x dimension, the dialog units are multiplied by the
8969 average character width and then divided by 4. For the y dimension,
8970 the dialog units are multiplied by the average character height and
8973 return _core_
.Window_ConvertDialogPointToPixels(*args
, **kwargs
)
8975 def ConvertDialogSizeToPixels(*args
, **kwargs
):
8977 ConvertDialogSizeToPixels(self, Size sz) -> Size
8979 Converts a point or size from dialog units to pixels. Dialog units
8980 are used for maintaining a dialog's proportions even if the font
8981 changes. For the x dimension, the dialog units are multiplied by the
8982 average character width and then divided by 4. For the y dimension,
8983 the dialog units are multiplied by the average character height and
8986 return _core_
.Window_ConvertDialogSizeToPixels(*args
, **kwargs
)
8988 def DLG_PNT(*args
, **kwargs
):
8990 DLG_PNT(self, Point pt) -> Point
8992 Converts a point or size from dialog units to pixels. Dialog units
8993 are used for maintaining a dialog's proportions even if the font
8994 changes. For the x dimension, the dialog units are multiplied by the
8995 average character width and then divided by 4. For the y dimension,
8996 the dialog units are multiplied by the average character height and
8999 return _core_
.Window_DLG_PNT(*args
, **kwargs
)
9001 def DLG_SZE(*args
, **kwargs
):
9003 DLG_SZE(self, Size sz) -> Size
9005 Converts a point or size from dialog units to pixels. Dialog units
9006 are used for maintaining a dialog's proportions even if the font
9007 changes. For the x dimension, the dialog units are multiplied by the
9008 average character width and then divided by 4. For the y dimension,
9009 the dialog units are multiplied by the average character height and
9012 return _core_
.Window_DLG_SZE(*args
, **kwargs
)
9014 def ConvertPixelPointToDialog(*args
, **kwargs
):
9015 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9016 return _core_
.Window_ConvertPixelPointToDialog(*args
, **kwargs
)
9018 def ConvertPixelSizeToDialog(*args
, **kwargs
):
9019 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9020 return _core_
.Window_ConvertPixelSizeToDialog(*args
, **kwargs
)
9022 def WarpPointer(*args
, **kwargs
):
9024 WarpPointer(self, int x, int y)
9026 Moves the pointer to the given position on the window.
9028 NOTE: This function is not supported under Mac because Apple Human
9029 Interface Guidelines forbid moving the mouse cursor programmatically.
9031 return _core_
.Window_WarpPointer(*args
, **kwargs
)
9033 def CaptureMouse(*args
, **kwargs
):
9037 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9038 release the capture.
9040 Note that wxWindows maintains the stack of windows having captured the
9041 mouse and when the mouse is released the capture returns to the window
9042 which had had captured it previously and it is only really released if
9043 there were no previous window. In particular, this means that you must
9044 release the mouse as many times as you capture it, unless the window
9045 receives the `wx.MouseCaptureLostEvent` event.
9047 Any application which captures the mouse in the beginning of some
9048 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9049 operation when it receives the event. The event handler must not
9052 return _core_
.Window_CaptureMouse(*args
, **kwargs
)
9054 def ReleaseMouse(*args
, **kwargs
):
9058 Releases mouse input captured with wx.Window.CaptureMouse.
9060 return _core_
.Window_ReleaseMouse(*args
, **kwargs
)
9062 def GetCapture(*args
, **kwargs
):
9064 GetCapture() -> Window
9066 Returns the window which currently captures the mouse or None
9068 return _core_
.Window_GetCapture(*args
, **kwargs
)
9070 GetCapture
= staticmethod(GetCapture
)
9071 def HasCapture(*args
, **kwargs
):
9073 HasCapture(self) -> bool
9075 Returns true if this window has the current mouse capture.
9077 return _core_
.Window_HasCapture(*args
, **kwargs
)
9079 def Refresh(*args
, **kwargs
):
9081 Refresh(self, bool eraseBackground=True, Rect rect=None)
9083 Mark the specified rectangle (or the whole window) as "dirty" so it
9084 will be repainted. Causes an EVT_PAINT event to be generated and sent
9087 return _core_
.Window_Refresh(*args
, **kwargs
)
9089 def RefreshRect(*args
, **kwargs
):
9091 RefreshRect(self, Rect rect, bool eraseBackground=True)
9093 Redraws the contents of the given rectangle: the area inside it will
9094 be repainted. This is the same as Refresh but has a nicer syntax.
9096 return _core_
.Window_RefreshRect(*args
, **kwargs
)
9098 def Update(*args
, **kwargs
):
9102 Calling this method immediately repaints the invalidated area of the
9103 window instead of waiting for the EVT_PAINT event to happen, (normally
9104 this would usually only happen when the flow of control returns to the
9105 event loop.) Notice that this function doesn't refresh the window and
9106 does nothing if the window has been already repainted. Use Refresh
9107 first if you want to immediately redraw the window (or some portion of
9108 it) unconditionally.
9110 return _core_
.Window_Update(*args
, **kwargs
)
9112 def ClearBackground(*args
, **kwargs
):
9114 ClearBackground(self)
9116 Clears the window by filling it with the current background
9117 colour. Does not cause an erase background event to be generated.
9119 return _core_
.Window_ClearBackground(*args
, **kwargs
)
9121 def Freeze(*args
, **kwargs
):
9125 Freezes the window or, in other words, prevents any updates from
9126 taking place on screen, the window is not redrawn at all. Thaw must be
9127 called to reenable window redrawing. Calls to Freeze/Thaw may be
9128 nested, with the actual Thaw being delayed until all the nesting has
9131 This method is useful for visual appearance optimization (for example,
9132 it is a good idea to use it before inserting large amount of text into
9133 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9134 for all controls so it is mostly just a hint to wxWindows and not a
9135 mandatory directive.
9137 return _core_
.Window_Freeze(*args
, **kwargs
)
9139 def IsFrozen(*args
, **kwargs
):
9141 IsFrozen(self) -> bool
9143 Returns ``True`` if the window has been frozen and not thawed yet.
9145 :see: `Freeze` and `Thaw`
9147 return _core_
.Window_IsFrozen(*args
, **kwargs
)
9149 def Thaw(*args
, **kwargs
):
9153 Reenables window updating after a previous call to Freeze. Calls to
9154 Freeze/Thaw may be nested, so Thaw must be called the same number of
9155 times that Freeze was before the window will be updated.
9157 return _core_
.Window_Thaw(*args
, **kwargs
)
9159 def PrepareDC(*args
, **kwargs
):
9161 PrepareDC(self, DC dc)
9163 Call this function to prepare the device context for drawing a
9164 scrolled image. It sets the device origin according to the current
9167 return _core_
.Window_PrepareDC(*args
, **kwargs
)
9169 def GetUpdateRegion(*args
, **kwargs
):
9171 GetUpdateRegion(self) -> Region
9173 Returns the region specifying which parts of the window have been
9174 damaged. Should only be called within an EVT_PAINT handler.
9176 return _core_
.Window_GetUpdateRegion(*args
, **kwargs
)
9178 def GetUpdateClientRect(*args
, **kwargs
):
9180 GetUpdateClientRect(self) -> Rect
9182 Get the update rectangle region bounding box in client coords.
9184 return _core_
.Window_GetUpdateClientRect(*args
, **kwargs
)
9186 def IsExposed(*args
, **kwargs
):
9188 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9190 Returns true if the given point or rectangle area has been exposed
9191 since the last repaint. Call this in an paint event handler to
9192 optimize redrawing by only redrawing those areas, which have been
9195 return _core_
.Window_IsExposed(*args
, **kwargs
)
9197 def IsExposedPoint(*args
, **kwargs
):
9199 IsExposedPoint(self, Point pt) -> bool
9201 Returns true if the given point or rectangle area has been exposed
9202 since the last repaint. Call this in an paint event handler to
9203 optimize redrawing by only redrawing those areas, which have been
9206 return _core_
.Window_IsExposedPoint(*args
, **kwargs
)
9208 def IsExposedRect(*args
, **kwargs
):
9210 IsExposedRect(self, Rect rect) -> bool
9212 Returns true if the given point or rectangle area has been exposed
9213 since the last repaint. Call this in an paint event handler to
9214 optimize redrawing by only redrawing those areas, which have been
9217 return _core_
.Window_IsExposedRect(*args
, **kwargs
)
9219 def GetDefaultAttributes(*args
, **kwargs
):
9221 GetDefaultAttributes(self) -> VisualAttributes
9223 Get the default attributes for an instance of this class. This is
9224 useful if you want to use the same font or colour in your own control
9225 as in a standard control -- which is a much better idea than hard
9226 coding specific colours or fonts which might look completely out of
9227 place on the user's system, especially if it uses themes.
9229 return _core_
.Window_GetDefaultAttributes(*args
, **kwargs
)
9231 def GetClassDefaultAttributes(*args
, **kwargs
):
9233 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9235 Get the default attributes for this class. This is useful if you want
9236 to use the same font or colour in your own control as in a standard
9237 control -- which is a much better idea than hard coding specific
9238 colours or fonts which might look completely out of place on the
9239 user's system, especially if it uses themes.
9241 The variant parameter is only relevant under Mac currently and is
9242 ignore under other platforms. Under Mac, it will change the size of
9243 the returned font. See `wx.Window.SetWindowVariant` for more about
9246 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
9248 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
9249 def SetBackgroundColour(*args
, **kwargs
):
9251 SetBackgroundColour(self, Colour colour) -> bool
9253 Sets the background colour of the window. Returns True if the colour
9254 was changed. The background colour is usually painted by the default
9255 EVT_ERASE_BACKGROUND event handler function under Windows and
9256 automatically under GTK. Using `wx.NullColour` will reset the window
9257 to the default background colour.
9259 Note that setting the background colour may not cause an immediate
9260 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9261 calling this function.
9263 Using this function will disable attempts to use themes for this
9264 window, if the system supports them. Use with care since usually the
9265 themes represent the appearance chosen by the user to be used for all
9266 applications on the system.
9268 return _core_
.Window_SetBackgroundColour(*args
, **kwargs
)
9270 def SetOwnBackgroundColour(*args
, **kwargs
):
9271 """SetOwnBackgroundColour(self, Colour colour)"""
9272 return _core_
.Window_SetOwnBackgroundColour(*args
, **kwargs
)
9274 def SetForegroundColour(*args
, **kwargs
):
9276 SetForegroundColour(self, Colour colour) -> bool
9278 Sets the foreground colour of the window. Returns True is the colour
9279 was changed. The interpretation of foreground colour is dependent on
9280 the window class; it may be the text colour or other colour, or it may
9283 return _core_
.Window_SetForegroundColour(*args
, **kwargs
)
9285 def SetOwnForegroundColour(*args
, **kwargs
):
9286 """SetOwnForegroundColour(self, Colour colour)"""
9287 return _core_
.Window_SetOwnForegroundColour(*args
, **kwargs
)
9289 def GetBackgroundColour(*args
, **kwargs
):
9291 GetBackgroundColour(self) -> Colour
9293 Returns the background colour of the window.
9295 return _core_
.Window_GetBackgroundColour(*args
, **kwargs
)
9297 def GetForegroundColour(*args
, **kwargs
):
9299 GetForegroundColour(self) -> Colour
9301 Returns the foreground colour of the window. The interpretation of
9302 foreground colour is dependent on the window class; it may be the text
9303 colour or other colour, or it may not be used at all.
9305 return _core_
.Window_GetForegroundColour(*args
, **kwargs
)
9307 def InheritsBackgroundColour(*args
, **kwargs
):
9308 """InheritsBackgroundColour(self) -> bool"""
9309 return _core_
.Window_InheritsBackgroundColour(*args
, **kwargs
)
9311 def UseBgCol(*args
, **kwargs
):
9312 """UseBgCol(self) -> bool"""
9313 return _core_
.Window_UseBgCol(*args
, **kwargs
)
9315 def SetBackgroundStyle(*args
, **kwargs
):
9317 SetBackgroundStyle(self, int style) -> bool
9319 Returns the background style of the window. The background style
9320 indicates how the background of the window is drawn.
9322 ====================== ========================================
9323 wx.BG_STYLE_SYSTEM The background colour or pattern should
9324 be determined by the system
9325 wx.BG_STYLE_COLOUR The background should be a solid colour
9326 wx.BG_STYLE_CUSTOM The background will be implemented by the
9328 ====================== ========================================
9330 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9331 a custom background, such as a tiled bitmap. Currently the style has
9332 no effect on other platforms.
9334 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9336 return _core_
.Window_SetBackgroundStyle(*args
, **kwargs
)
9338 def GetBackgroundStyle(*args
, **kwargs
):
9340 GetBackgroundStyle(self) -> int
9342 Returns the background style of the window.
9344 :see: `SetBackgroundStyle`
9346 return _core_
.Window_GetBackgroundStyle(*args
, **kwargs
)
9348 def HasTransparentBackground(*args
, **kwargs
):
9350 HasTransparentBackground(self) -> bool
9352 Returns True if this window's background is transparent (as, for
9353 example, for `wx.StaticText`) and should show the parent window's
9356 This method is mostly used internally by the library itself and you
9357 normally shouldn't have to call it. You may, however, have to override
9358 it in your custom control classes to ensure that background is painted
9361 return _core_
.Window_HasTransparentBackground(*args
, **kwargs
)
9363 def SetCursor(*args
, **kwargs
):
9365 SetCursor(self, Cursor cursor) -> bool
9367 Sets the window's cursor. Notice that the window cursor also sets it
9368 for the children of the window implicitly.
9370 The cursor may be wx.NullCursor in which case the window cursor will
9371 be reset back to default.
9373 return _core_
.Window_SetCursor(*args
, **kwargs
)
9375 def GetCursor(*args
, **kwargs
):
9377 GetCursor(self) -> Cursor
9379 Return the cursor associated with this window.
9381 return _core_
.Window_GetCursor(*args
, **kwargs
)
9383 def SetFont(*args
, **kwargs
):
9385 SetFont(self, Font font) -> bool
9387 Sets the font for this window.
9389 return _core_
.Window_SetFont(*args
, **kwargs
)
9391 def SetOwnFont(*args
, **kwargs
):
9392 """SetOwnFont(self, Font font)"""
9393 return _core_
.Window_SetOwnFont(*args
, **kwargs
)
9395 def GetFont(*args
, **kwargs
):
9397 GetFont(self) -> Font
9399 Returns the default font used for this window.
9401 return _core_
.Window_GetFont(*args
, **kwargs
)
9403 def SetCaret(*args
, **kwargs
):
9405 SetCaret(self, Caret caret)
9407 Sets the caret associated with the window.
9409 return _core_
.Window_SetCaret(*args
, **kwargs
)
9411 def GetCaret(*args
, **kwargs
):
9413 GetCaret(self) -> Caret
9415 Returns the caret associated with the window.
9417 return _core_
.Window_GetCaret(*args
, **kwargs
)
9419 def GetCharHeight(*args
, **kwargs
):
9421 GetCharHeight(self) -> int
9423 Get the (average) character size for the current font.
9425 return _core_
.Window_GetCharHeight(*args
, **kwargs
)
9427 def GetCharWidth(*args
, **kwargs
):
9429 GetCharWidth(self) -> int
9431 Get the (average) character size for the current font.
9433 return _core_
.Window_GetCharWidth(*args
, **kwargs
)
9435 def GetTextExtent(*args
, **kwargs
):
9437 GetTextExtent(String string) -> (width, height)
9439 Get the width and height of the text using the current font.
9441 return _core_
.Window_GetTextExtent(*args
, **kwargs
)
9443 def GetFullTextExtent(*args
, **kwargs
):
9445 GetFullTextExtent(String string, Font font=None) ->
9446 (width, height, descent, externalLeading)
9448 Get the width, height, decent and leading of the text using the
9449 current or specified font.
9451 return _core_
.Window_GetFullTextExtent(*args
, **kwargs
)
9453 def ClientToScreenXY(*args
, **kwargs
):
9455 ClientToScreenXY(int x, int y) -> (x,y)
9457 Converts to screen coordinates from coordinates relative to this window.
9459 return _core_
.Window_ClientToScreenXY(*args
, **kwargs
)
9461 def ScreenToClientXY(*args
, **kwargs
):
9463 ScreenToClientXY(int x, int y) -> (x,y)
9465 Converts from screen to client window coordinates.
9467 return _core_
.Window_ScreenToClientXY(*args
, **kwargs
)
9469 def ClientToScreen(*args
, **kwargs
):
9471 ClientToScreen(self, Point pt) -> Point
9473 Converts to screen coordinates from coordinates relative to this window.
9475 return _core_
.Window_ClientToScreen(*args
, **kwargs
)
9477 def ScreenToClient(*args
, **kwargs
):
9479 ScreenToClient(self, Point pt) -> Point
9481 Converts from screen to client window coordinates.
9483 return _core_
.Window_ScreenToClient(*args
, **kwargs
)
9485 def HitTestXY(*args
, **kwargs
):
9487 HitTestXY(self, int x, int y) -> int
9489 Test where the given (in client coords) point lies
9491 return _core_
.Window_HitTestXY(*args
, **kwargs
)
9493 def HitTest(*args
, **kwargs
):
9495 HitTest(self, Point pt) -> int
9497 Test where the given (in client coords) point lies
9499 return _core_
.Window_HitTest(*args
, **kwargs
)
9501 def GetBorder(*args
):
9503 GetBorder(self, long flags) -> int
9504 GetBorder(self) -> int
9506 Get border for the flags of this window
9508 return _core_
.Window_GetBorder(*args
)
9510 def UpdateWindowUI(*args
, **kwargs
):
9512 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9514 This function sends EVT_UPDATE_UI events to the window. The particular
9515 implementation depends on the window; for example a wx.ToolBar will
9516 send an update UI event for each toolbar button, and a wx.Frame will
9517 send an update UI event for each menubar menu item. You can call this
9518 function from your application to ensure that your UI is up-to-date at
9519 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9520 concerned). This may be necessary if you have called
9521 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9522 limit the overhead that wxWindows incurs by sending update UI events
9525 return _core_
.Window_UpdateWindowUI(*args
, **kwargs
)
9527 def PopupMenuXY(*args
, **kwargs
):
9529 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9531 Pops up the given menu at the specified coordinates, relative to this window,
9532 and returns control when the user has dismissed the menu. If a menu item is
9533 selected, the corresponding menu event is generated and will be processed as
9534 usual. If the default position is given then the current position of the
9535 mouse cursor will be used.
9537 return _core_
.Window_PopupMenuXY(*args
, **kwargs
)
9539 def PopupMenu(*args
, **kwargs
):
9541 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9543 Pops up the given menu at the specified coordinates, relative to this window,
9544 and returns control when the user has dismissed the menu. If a menu item is
9545 selected, the corresponding menu event is generated and will be processed as
9546 usual. If the default position is given then the current position of the
9547 mouse cursor will be used.
9549 return _core_
.Window_PopupMenu(*args
, **kwargs
)
9551 def HasMultiplePages(*args
, **kwargs
):
9552 """HasMultiplePages(self) -> bool"""
9553 return _core_
.Window_HasMultiplePages(*args
, **kwargs
)
9555 def GetHandle(*args
, **kwargs
):
9557 GetHandle(self) -> long
9559 Returns the platform-specific handle (as a long integer) of the
9560 physical window. Currently on wxMac it returns the handle of the
9561 toplevel parent of the window.
9563 return _core_
.Window_GetHandle(*args
, **kwargs
)
9565 def AssociateHandle(*args
, **kwargs
):
9567 AssociateHandle(self, long handle)
9569 Associate the window with a new native handle
9571 return _core_
.Window_AssociateHandle(*args
, **kwargs
)
9573 def DissociateHandle(*args
, **kwargs
):
9575 DissociateHandle(self)
9577 Dissociate the current native handle from the window
9579 return _core_
.Window_DissociateHandle(*args
, **kwargs
)
9581 def HasScrollbar(*args
, **kwargs
):
9583 HasScrollbar(self, int orient) -> bool
9585 Does the window have the scrollbar for this orientation?
9587 return _core_
.Window_HasScrollbar(*args
, **kwargs
)
9589 def SetScrollbar(*args
, **kwargs
):
9591 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9594 Sets the scrollbar properties of a built-in scrollbar.
9596 return _core_
.Window_SetScrollbar(*args
, **kwargs
)
9598 def SetScrollPos(*args
, **kwargs
):
9600 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9602 Sets the position of one of the built-in scrollbars.
9604 return _core_
.Window_SetScrollPos(*args
, **kwargs
)
9606 def GetScrollPos(*args
, **kwargs
):
9608 GetScrollPos(self, int orientation) -> int
9610 Returns the built-in scrollbar position.
9612 return _core_
.Window_GetScrollPos(*args
, **kwargs
)
9614 def GetScrollThumb(*args
, **kwargs
):
9616 GetScrollThumb(self, int orientation) -> int
9618 Returns the built-in scrollbar thumb size.
9620 return _core_
.Window_GetScrollThumb(*args
, **kwargs
)
9622 def GetScrollRange(*args
, **kwargs
):
9624 GetScrollRange(self, int orientation) -> int
9626 Returns the built-in scrollbar range.
9628 return _core_
.Window_GetScrollRange(*args
, **kwargs
)
9630 def ScrollWindow(*args
, **kwargs
):
9632 ScrollWindow(self, int dx, int dy, Rect rect=None)
9634 Physically scrolls the pixels in the window and move child windows
9635 accordingly. Use this function to optimise your scrolling
9636 implementations, to minimise the area that must be redrawn. Note that
9637 it is rarely required to call this function from a user program.
9639 return _core_
.Window_ScrollWindow(*args
, **kwargs
)
9641 def ScrollLines(*args
, **kwargs
):
9643 ScrollLines(self, int lines) -> bool
9645 If the platform and window class supports it, scrolls the window by
9646 the given number of lines down, if lines is positive, or up if lines
9647 is negative. Returns True if the window was scrolled, False if it was
9648 already on top/bottom and nothing was done.
9650 return _core_
.Window_ScrollLines(*args
, **kwargs
)
9652 def ScrollPages(*args
, **kwargs
):
9654 ScrollPages(self, int pages) -> bool
9656 If the platform and window class supports it, scrolls the window by
9657 the given number of pages down, if pages is positive, or up if pages
9658 is negative. Returns True if the window was scrolled, False if it was
9659 already on top/bottom and nothing was done.
9661 return _core_
.Window_ScrollPages(*args
, **kwargs
)
9663 def LineUp(*args
, **kwargs
):
9665 LineUp(self) -> bool
9667 This is just a wrapper for ScrollLines(-1).
9669 return _core_
.Window_LineUp(*args
, **kwargs
)
9671 def LineDown(*args
, **kwargs
):
9673 LineDown(self) -> bool
9675 This is just a wrapper for ScrollLines(1).
9677 return _core_
.Window_LineDown(*args
, **kwargs
)
9679 def PageUp(*args
, **kwargs
):
9681 PageUp(self) -> bool
9683 This is just a wrapper for ScrollPages(-1).
9685 return _core_
.Window_PageUp(*args
, **kwargs
)
9687 def PageDown(*args
, **kwargs
):
9689 PageDown(self) -> bool
9691 This is just a wrapper for ScrollPages(1).
9693 return _core_
.Window_PageDown(*args
, **kwargs
)
9695 def SetHelpText(*args
, **kwargs
):
9697 SetHelpText(self, String text)
9699 Sets the help text to be used as context-sensitive help for this
9700 window. Note that the text is actually stored by the current
9701 `wx.HelpProvider` implementation, and not in the window object itself.
9703 return _core_
.Window_SetHelpText(*args
, **kwargs
)
9705 def SetHelpTextForId(*args
, **kwargs
):
9707 SetHelpTextForId(self, String text)
9709 Associate this help text with all windows with the same id as this
9712 return _core_
.Window_SetHelpTextForId(*args
, **kwargs
)
9714 def GetHelpTextAtPoint(*args
, **kwargs
):
9716 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9718 Get the help string associated with the given position in this window.
9720 Notice that pt may be invalid if event origin is keyboard or unknown
9721 and this method should return the global window help text then
9724 return _core_
.Window_GetHelpTextAtPoint(*args
, **kwargs
)
9726 def GetHelpText(*args
, **kwargs
):
9728 GetHelpText(self) -> String
9730 Gets the help text to be used as context-sensitive help for this
9731 window. Note that the text is actually stored by the current
9732 `wx.HelpProvider` implementation, and not in the window object itself.
9734 return _core_
.Window_GetHelpText(*args
, **kwargs
)
9736 def SetToolTipString(*args
, **kwargs
):
9738 SetToolTipString(self, String tip)
9740 Attach a tooltip to the window.
9742 return _core_
.Window_SetToolTipString(*args
, **kwargs
)
9744 def SetToolTip(*args
, **kwargs
):
9746 SetToolTip(self, ToolTip tip)
9748 Attach a tooltip to the window.
9750 return _core_
.Window_SetToolTip(*args
, **kwargs
)
9752 def GetToolTip(*args
, **kwargs
):
9754 GetToolTip(self) -> ToolTip
9756 get the associated tooltip or None if none
9758 return _core_
.Window_GetToolTip(*args
, **kwargs
)
9760 def SetDropTarget(*args
, **kwargs
):
9762 SetDropTarget(self, DropTarget dropTarget)
9764 Associates a drop target with this window. If the window already has
9765 a drop target, it is deleted.
9767 return _core_
.Window_SetDropTarget(*args
, **kwargs
)
9769 def GetDropTarget(*args
, **kwargs
):
9771 GetDropTarget(self) -> DropTarget
9773 Returns the associated drop target, which may be None.
9775 return _core_
.Window_GetDropTarget(*args
, **kwargs
)
9777 def DragAcceptFiles(*args
, **kwargs
):
9779 DragAcceptFiles(self, bool accept)
9781 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9782 Only functional on Windows.
9784 return _core_
.Window_DragAcceptFiles(*args
, **kwargs
)
9786 def SetConstraints(*args
, **kwargs
):
9788 SetConstraints(self, LayoutConstraints constraints)
9790 Sets the window to have the given layout constraints. If an existing
9791 layout constraints object is already owned by the window, it will be
9792 deleted. Pass None to disassociate and delete the window's current
9795 You must call SetAutoLayout to tell a window to use the constraints
9796 automatically in its default EVT_SIZE handler; otherwise, you must
9797 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9798 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9801 return _core_
.Window_SetConstraints(*args
, **kwargs
)
9803 def GetConstraints(*args
, **kwargs
):
9805 GetConstraints(self) -> LayoutConstraints
9807 Returns a pointer to the window's layout constraints, or None if there
9810 return _core_
.Window_GetConstraints(*args
, **kwargs
)
9812 def SetAutoLayout(*args
, **kwargs
):
9814 SetAutoLayout(self, bool autoLayout)
9816 Determines whether the Layout function will be called automatically
9817 when the window is resized. lease note that this only happens for the
9818 windows usually used to contain children, namely `wx.Panel` and
9819 `wx.TopLevelWindow` (and the classes deriving from them).
9821 This method is called implicitly by `SetSizer` but if you use
9822 `SetConstraints` you should call it manually or otherwise the window
9823 layout won't be correctly updated when its size changes.
9825 return _core_
.Window_SetAutoLayout(*args
, **kwargs
)
9827 def GetAutoLayout(*args
, **kwargs
):
9829 GetAutoLayout(self) -> bool
9831 Returns the current autoLayout setting
9833 return _core_
.Window_GetAutoLayout(*args
, **kwargs
)
9835 def Layout(*args
, **kwargs
):
9837 Layout(self) -> bool
9839 Invokes the constraint-based layout algorithm or the sizer-based
9840 algorithm for this window. See SetAutoLayout: when auto layout is on,
9841 this function gets called automatically by the default EVT_SIZE
9842 handler when the window is resized.
9844 return _core_
.Window_Layout(*args
, **kwargs
)
9846 def SetSizer(*args
, **kwargs
):
9848 SetSizer(self, Sizer sizer, bool deleteOld=True)
9850 Sets the window to have the given layout sizer. The window will then
9851 own the object, and will take care of its deletion. If an existing
9852 layout sizer object is already owned by the window, it will be deleted
9853 if the deleteOld parameter is true. Note that this function will also
9854 call SetAutoLayout implicitly with a True parameter if the sizer is
9855 non-None, and False otherwise.
9857 return _core_
.Window_SetSizer(*args
, **kwargs
)
9859 def SetSizerAndFit(*args
, **kwargs
):
9861 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9863 The same as SetSizer, except it also sets the size hints for the
9864 window based on the sizer's minimum size.
9866 return _core_
.Window_SetSizerAndFit(*args
, **kwargs
)
9868 def GetSizer(*args
, **kwargs
):
9870 GetSizer(self) -> Sizer
9872 Return the sizer associated with the window by a previous call to
9873 SetSizer or None if there isn't one.
9875 return _core_
.Window_GetSizer(*args
, **kwargs
)
9877 def SetContainingSizer(*args
, **kwargs
):
9879 SetContainingSizer(self, Sizer sizer)
9881 This normally does not need to be called by application code. It is
9882 called internally when a window is added to a sizer, and is used so
9883 the window can remove itself from the sizer when it is destroyed.
9885 return _core_
.Window_SetContainingSizer(*args
, **kwargs
)
9887 def GetContainingSizer(*args
, **kwargs
):
9889 GetContainingSizer(self) -> Sizer
9891 Return the sizer that this window is a member of, if any, otherwise None.
9893 return _core_
.Window_GetContainingSizer(*args
, **kwargs
)
9895 def InheritAttributes(*args
, **kwargs
):
9897 InheritAttributes(self)
9899 This function is (or should be, in case of custom controls) called
9900 during window creation to intelligently set up the window visual
9901 attributes, that is the font and the foreground and background
9904 By 'intelligently' the following is meant: by default, all windows use
9905 their own default attributes. However if some of the parent's
9906 attributes are explicitly changed (that is, using SetFont and not
9907 SetOwnFont) and if the corresponding attribute hadn't been
9908 explicitly set for this window itself, then this window takes the same
9909 value as used by the parent. In addition, if the window overrides
9910 ShouldInheritColours to return false, the colours will not be changed
9911 no matter what and only the font might.
9913 This rather complicated logic is necessary in order to accommodate the
9914 different usage scenarios. The most common one is when all default
9915 attributes are used and in this case, nothing should be inherited as
9916 in modern GUIs different controls use different fonts (and colours)
9917 than their siblings so they can't inherit the same value from the
9918 parent. However it was also deemed desirable to allow to simply change
9919 the attributes of all children at once by just changing the font or
9920 colour of their common parent, hence in this case we do inherit the
9924 return _core_
.Window_InheritAttributes(*args
, **kwargs
)
9926 def ShouldInheritColours(*args
, **kwargs
):
9928 ShouldInheritColours(self) -> bool
9930 Return true from here to allow the colours of this window to be
9931 changed by InheritAttributes, returning false forbids inheriting them
9932 from the parent window.
9934 The base class version returns false, but this method is overridden in
9935 wxControl where it returns true.
9937 return _core_
.Window_ShouldInheritColours(*args
, **kwargs
)
9939 def CanSetTransparent(*args
, **kwargs
):
9941 CanSetTransparent(self) -> bool
9943 Returns ``True`` if the platform supports setting the transparency for
9944 this window. Note that this method will err on the side of caution,
9945 so it is possible that this will return ``False`` when it is in fact
9946 possible to set the transparency.
9948 NOTE: On X-windows systems the X server must have the composite
9949 extension loaded, and there must be a composite manager program (such
9950 as xcompmgr) running.
9952 return _core_
.Window_CanSetTransparent(*args
, **kwargs
)
9954 def SetTransparent(*args
, **kwargs
):
9956 SetTransparent(self, byte alpha) -> bool
9958 Attempt to set the transparency of this window to the ``alpha`` value,
9959 returns True on success. The ``alpha`` value is an integer in the
9960 range of 0 to 255, where 0 is fully transparent and 255 is fully
9963 return _core_
.Window_SetTransparent(*args
, **kwargs
)
9965 def PostCreate(self
, pre
):
9967 Phase 3 of the 2-phase create <wink!>
9968 Call this method after precreating the window with the 2-phase create method.
9970 self
.this
= pre
.this
9971 self
.thisown
= pre
.thisown
9973 if hasattr(self
, '_setOORInfo'):
9974 self
._setOORInfo
(self
)
9975 if hasattr(self
, '_setCallbackInfo'):
9976 self
._setCallbackInfo
(self
, self
.__class
__)
9978 def SendSizeEvent(self
):
9979 self
.GetEventHandler().ProcessEvent(wx
.SizeEvent((-1,-1)))
9981 AcceleratorTable
= property(GetAcceleratorTable
,SetAcceleratorTable
,doc
="See `GetAcceleratorTable` and `SetAcceleratorTable`")
9982 AdjustedBestSize
= property(GetAdjustedBestSize
,doc
="See `GetAdjustedBestSize`")
9983 AutoLayout
= property(GetAutoLayout
,SetAutoLayout
,doc
="See `GetAutoLayout` and `SetAutoLayout`")
9984 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
9985 BackgroundStyle
= property(GetBackgroundStyle
,SetBackgroundStyle
,doc
="See `GetBackgroundStyle` and `SetBackgroundStyle`")
9986 BestFittingSize
= property(GetBestFittingSize
,SetBestFittingSize
,doc
="See `GetBestFittingSize` and `SetBestFittingSize`")
9987 BestSize
= property(GetBestSize
,doc
="See `GetBestSize`")
9988 BestVirtualSize
= property(GetBestVirtualSize
,doc
="See `GetBestVirtualSize`")
9989 Border
= property(GetBorder
,doc
="See `GetBorder`")
9990 Caret
= property(GetCaret
,SetCaret
,doc
="See `GetCaret` and `SetCaret`")
9991 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
9992 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
9993 Children
= property(GetChildren
,doc
="See `GetChildren`")
9994 ClientAreaOrigin
= property(GetClientAreaOrigin
,doc
="See `GetClientAreaOrigin`")
9995 ClientRect
= property(GetClientRect
,SetClientRect
,doc
="See `GetClientRect` and `SetClientRect`")
9996 ClientSize
= property(GetClientSize
,SetClientSize
,doc
="See `GetClientSize` and `SetClientSize`")
9997 Constraints
= property(GetConstraints
,SetConstraints
,doc
="See `GetConstraints` and `SetConstraints`")
9998 ContainingSizer
= property(GetContainingSizer
,SetContainingSizer
,doc
="See `GetContainingSizer` and `SetContainingSizer`")
9999 Cursor
= property(GetCursor
,SetCursor
,doc
="See `GetCursor` and `SetCursor`")
10000 DefaultAttributes
= property(GetDefaultAttributes
,doc
="See `GetDefaultAttributes`")
10001 DropTarget
= property(GetDropTarget
,SetDropTarget
,doc
="See `GetDropTarget` and `SetDropTarget`")
10002 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10003 ExtraStyle
= property(GetExtraStyle
,SetExtraStyle
,doc
="See `GetExtraStyle` and `SetExtraStyle`")
10004 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10005 ForegroundColour
= property(GetForegroundColour
,SetForegroundColour
,doc
="See `GetForegroundColour` and `SetForegroundColour`")
10006 GrandParent
= property(GetGrandParent
,doc
="See `GetGrandParent`")
10007 Handle
= property(GetHandle
,doc
="See `GetHandle`")
10008 HelpText
= property(GetHelpText
,SetHelpText
,doc
="See `GetHelpText` and `SetHelpText`")
10009 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10010 Label
= property(GetLabel
,SetLabel
,doc
="See `GetLabel` and `SetLabel`")
10011 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
,doc
="See `GetLayoutDirection` and `SetLayoutDirection`")
10012 MaxHeight
= property(GetMaxHeight
,doc
="See `GetMaxHeight`")
10013 MaxSize
= property(GetMaxSize
,SetMaxSize
,doc
="See `GetMaxSize` and `SetMaxSize`")
10014 MaxWidth
= property(GetMaxWidth
,doc
="See `GetMaxWidth`")
10015 MinHeight
= property(GetMinHeight
,doc
="See `GetMinHeight`")
10016 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
10017 MinWidth
= property(GetMinWidth
,doc
="See `GetMinWidth`")
10018 Name
= property(GetName
,SetName
,doc
="See `GetName` and `SetName`")
10019 Parent
= property(GetParent
,doc
="See `GetParent`")
10020 Position
= property(GetPosition
,SetPosition
,doc
="See `GetPosition` and `SetPosition`")
10021 Rect
= property(GetRect
,SetRect
,doc
="See `GetRect` and `SetRect`")
10022 ScreenPosition
= property(GetScreenPosition
,doc
="See `GetScreenPosition`")
10023 ScreenRect
= property(GetScreenRect
,doc
="See `GetScreenRect`")
10024 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
10025 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
10026 ThemeEnabled
= property(GetThemeEnabled
,SetThemeEnabled
,doc
="See `GetThemeEnabled` and `SetThemeEnabled`")
10027 ToolTip
= property(GetToolTip
,SetToolTip
,doc
="See `GetToolTip` and `SetToolTip`")
10028 UpdateClientRect
= property(GetUpdateClientRect
,doc
="See `GetUpdateClientRect`")
10029 UpdateRegion
= property(GetUpdateRegion
,doc
="See `GetUpdateRegion`")
10030 Validator
= property(GetValidator
,SetValidator
,doc
="See `GetValidator` and `SetValidator`")
10031 VirtualSize
= property(GetVirtualSize
,SetVirtualSize
,doc
="See `GetVirtualSize` and `SetVirtualSize`")
10032 WindowStyle
= property(GetWindowStyle
,SetWindowStyle
,doc
="See `GetWindowStyle` and `SetWindowStyle`")
10033 WindowStyleFlag
= property(GetWindowStyleFlag
,SetWindowStyleFlag
,doc
="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10034 WindowVariant
= property(GetWindowVariant
,SetWindowVariant
,doc
="See `GetWindowVariant` and `SetWindowVariant`")
10035 Shown
= property(IsShown
,Show
,doc
="See `IsShown` and `Show`")
10036 Enabled
= property(IsEnabled
,Enable
,doc
="See `IsEnabled` and `Enable`")
10037 TopLevel
= property(IsTopLevel
,doc
="See `IsTopLevel`")
10038 _core_
.Window_swigregister(Window
)
10040 def PreWindow(*args
, **kwargs
):
10042 PreWindow() -> Window
10044 Precreate a Window for 2-phase creation.
10046 val
= _core_
.new_PreWindow(*args
, **kwargs
)
10049 def Window_NewControlId(*args
):
10051 Window_NewControlId() -> int
10053 Generate a control id for the controls which were not given one.
10055 return _core_
.Window_NewControlId(*args
)
10057 def Window_NextControlId(*args
, **kwargs
):
10059 Window_NextControlId(int winid) -> int
10061 Get the id of the control following the one with the given
10064 return _core_
.Window_NextControlId(*args
, **kwargs
)
10066 def Window_PrevControlId(*args
, **kwargs
):
10068 Window_PrevControlId(int winid) -> int
10070 Get the id of the control preceding the one with the given
10073 return _core_
.Window_PrevControlId(*args
, **kwargs
)
10075 def Window_FindFocus(*args
):
10077 Window_FindFocus() -> Window
10079 Returns the window or control that currently has the keyboard focus,
10082 return _core_
.Window_FindFocus(*args
)
10084 def Window_GetCapture(*args
):
10086 Window_GetCapture() -> Window
10088 Returns the window which currently captures the mouse or None
10090 return _core_
.Window_GetCapture(*args
)
10092 def Window_GetClassDefaultAttributes(*args
, **kwargs
):
10094 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10096 Get the default attributes for this class. This is useful if you want
10097 to use the same font or colour in your own control as in a standard
10098 control -- which is a much better idea than hard coding specific
10099 colours or fonts which might look completely out of place on the
10100 user's system, especially if it uses themes.
10102 The variant parameter is only relevant under Mac currently and is
10103 ignore under other platforms. Under Mac, it will change the size of
10104 the returned font. See `wx.Window.SetWindowVariant` for more about
10107 return _core_
.Window_GetClassDefaultAttributes(*args
, **kwargs
)
10109 def DLG_PNT(win
, point_or_x
, y
=None):
10111 Convenience function for converting a Point or (x,y) in
10112 dialog units to pixel units.
10115 return win
.ConvertDialogPointToPixels(point_or_x
)
10117 return win
.ConvertDialogPointToPixels(wx
.Point(point_or_x
, y
))
10119 def DLG_SZE(win
, size_width
, height
=None):
10121 Convenience function for converting a Size or (w,h) in
10122 dialog units to pixel units.
10125 return win
.ConvertDialogSizeToPixels(size_width
)
10127 return win
.ConvertDialogSizeToPixels(wx
.Size(size_width
, height
))
10130 def FindWindowById(*args
, **kwargs
):
10132 FindWindowById(long id, Window parent=None) -> Window
10134 Find the first window in the application with the given id. If parent
10135 is None, the search will start from all top-level frames and dialog
10136 boxes; if non-None, the search will be limited to the given window
10137 hierarchy. The search is recursive in both cases.
10139 return _core_
.FindWindowById(*args
, **kwargs
)
10141 def FindWindowByName(*args
, **kwargs
):
10143 FindWindowByName(String name, Window parent=None) -> Window
10145 Find a window by its name (as given in a window constructor or Create
10146 function call). If parent is None, the search will start from all
10147 top-level frames and dialog boxes; if non-None, the search will be
10148 limited to the given window hierarchy. The search is recursive in both
10151 If no window with such name is found, wx.FindWindowByLabel is called.
10153 return _core_
.FindWindowByName(*args
, **kwargs
)
10155 def FindWindowByLabel(*args
, **kwargs
):
10157 FindWindowByLabel(String label, Window parent=None) -> Window
10159 Find a window by its label. Depending on the type of window, the label
10160 may be a window title or panel item label. If parent is None, the
10161 search will start from all top-level frames and dialog boxes; if
10162 non-None, the search will be limited to the given window
10163 hierarchy. The search is recursive in both cases.
10165 return _core_
.FindWindowByLabel(*args
, **kwargs
)
10167 def Window_FromHWND(*args
, **kwargs
):
10168 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10169 return _core_
.Window_FromHWND(*args
, **kwargs
)
10171 def GetTopLevelWindows(*args
):
10173 GetTopLevelWindows() -> PyObject
10175 Returns a list of the the application's top-level windows, (frames,
10176 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10177 by wxWidgets, and so it is only valid as long as no top-level windows
10178 are closed or new top-level windows are created.
10181 return _core_
.GetTopLevelWindows(*args
)
10182 #---------------------------------------------------------------------------
10184 class Validator(EvtHandler
):
10185 """Proxy of C++ Validator class"""
10186 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10187 __repr__
= _swig_repr
10188 def __init__(self
, *args
, **kwargs
):
10189 """__init__(self) -> Validator"""
10190 _core_
.Validator_swiginit(self
,_core_
.new_Validator(*args
, **kwargs
))
10191 self
._setOORInfo
(self
)
10193 def Clone(*args
, **kwargs
):
10194 """Clone(self) -> Validator"""
10195 return _core_
.Validator_Clone(*args
, **kwargs
)
10197 def Validate(*args
, **kwargs
):
10198 """Validate(self, Window parent) -> bool"""
10199 return _core_
.Validator_Validate(*args
, **kwargs
)
10201 def TransferToWindow(*args
, **kwargs
):
10202 """TransferToWindow(self) -> bool"""
10203 return _core_
.Validator_TransferToWindow(*args
, **kwargs
)
10205 def TransferFromWindow(*args
, **kwargs
):
10206 """TransferFromWindow(self) -> bool"""
10207 return _core_
.Validator_TransferFromWindow(*args
, **kwargs
)
10209 def GetWindow(*args
, **kwargs
):
10210 """GetWindow(self) -> Window"""
10211 return _core_
.Validator_GetWindow(*args
, **kwargs
)
10213 def SetWindow(*args
, **kwargs
):
10214 """SetWindow(self, Window window)"""
10215 return _core_
.Validator_SetWindow(*args
, **kwargs
)
10217 def IsSilent(*args
, **kwargs
):
10218 """IsSilent() -> bool"""
10219 return _core_
.Validator_IsSilent(*args
, **kwargs
)
10221 IsSilent
= staticmethod(IsSilent
)
10222 def SetBellOnError(*args
, **kwargs
):
10223 """SetBellOnError(int doIt=True)"""
10224 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10226 SetBellOnError
= staticmethod(SetBellOnError
)
10227 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
10228 _core_
.Validator_swigregister(Validator
)
10230 def Validator_IsSilent(*args
):
10231 """Validator_IsSilent() -> bool"""
10232 return _core_
.Validator_IsSilent(*args
)
10234 def Validator_SetBellOnError(*args
, **kwargs
):
10235 """Validator_SetBellOnError(int doIt=True)"""
10236 return _core_
.Validator_SetBellOnError(*args
, **kwargs
)
10238 class PyValidator(Validator
):
10239 """Proxy of C++ PyValidator class"""
10240 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10241 __repr__
= _swig_repr
10242 def __init__(self
, *args
, **kwargs
):
10243 """__init__(self) -> PyValidator"""
10244 _core_
.PyValidator_swiginit(self
,_core_
.new_PyValidator(*args
, **kwargs
))
10246 self
._setCallbackInfo
(self
, PyValidator
, 1)
10247 self
._setOORInfo
(self
)
10249 def _setCallbackInfo(*args
, **kwargs
):
10250 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10251 return _core_
.PyValidator__setCallbackInfo(*args
, **kwargs
)
10253 _core_
.PyValidator_swigregister(PyValidator
)
10255 #---------------------------------------------------------------------------
10257 class Menu(EvtHandler
):
10258 """Proxy of C++ Menu class"""
10259 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10260 __repr__
= _swig_repr
10261 def __init__(self
, *args
, **kwargs
):
10262 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10263 _core_
.Menu_swiginit(self
,_core_
.new_Menu(*args
, **kwargs
))
10264 self
._setOORInfo
(self
)
10266 def Append(*args
, **kwargs
):
10268 Append(self, int id, String text=EmptyString, String help=EmptyString,
10269 int kind=ITEM_NORMAL) -> MenuItem
10271 return _core_
.Menu_Append(*args
, **kwargs
)
10273 def AppendSeparator(*args
, **kwargs
):
10274 """AppendSeparator(self) -> MenuItem"""
10275 return _core_
.Menu_AppendSeparator(*args
, **kwargs
)
10277 def AppendCheckItem(*args
, **kwargs
):
10278 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10279 return _core_
.Menu_AppendCheckItem(*args
, **kwargs
)
10281 def AppendRadioItem(*args
, **kwargs
):
10282 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10283 return _core_
.Menu_AppendRadioItem(*args
, **kwargs
)
10285 def AppendMenu(*args
, **kwargs
):
10286 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10287 return _core_
.Menu_AppendMenu(*args
, **kwargs
)
10289 def AppendSubMenu(*args
, **kwargs
):
10290 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10291 return _core_
.Menu_AppendSubMenu(*args
, **kwargs
)
10293 def AppendItem(*args
, **kwargs
):
10294 """AppendItem(self, MenuItem item) -> MenuItem"""
10295 return _core_
.Menu_AppendItem(*args
, **kwargs
)
10297 def InsertItem(*args
, **kwargs
):
10298 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10299 return _core_
.Menu_InsertItem(*args
, **kwargs
)
10301 def PrependItem(*args
, **kwargs
):
10302 """PrependItem(self, MenuItem item) -> MenuItem"""
10303 return _core_
.Menu_PrependItem(*args
, **kwargs
)
10305 def Break(*args
, **kwargs
):
10307 return _core_
.Menu_Break(*args
, **kwargs
)
10309 def Insert(*args
, **kwargs
):
10311 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10312 int kind=ITEM_NORMAL) -> MenuItem
10314 return _core_
.Menu_Insert(*args
, **kwargs
)
10316 def InsertSeparator(*args
, **kwargs
):
10317 """InsertSeparator(self, size_t pos) -> MenuItem"""
10318 return _core_
.Menu_InsertSeparator(*args
, **kwargs
)
10320 def InsertCheckItem(*args
, **kwargs
):
10321 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10322 return _core_
.Menu_InsertCheckItem(*args
, **kwargs
)
10324 def InsertRadioItem(*args
, **kwargs
):
10325 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10326 return _core_
.Menu_InsertRadioItem(*args
, **kwargs
)
10328 def InsertMenu(*args
, **kwargs
):
10329 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10330 return _core_
.Menu_InsertMenu(*args
, **kwargs
)
10332 def Prepend(*args
, **kwargs
):
10334 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10335 int kind=ITEM_NORMAL) -> MenuItem
10337 return _core_
.Menu_Prepend(*args
, **kwargs
)
10339 def PrependSeparator(*args
, **kwargs
):
10340 """PrependSeparator(self) -> MenuItem"""
10341 return _core_
.Menu_PrependSeparator(*args
, **kwargs
)
10343 def PrependCheckItem(*args
, **kwargs
):
10344 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10345 return _core_
.Menu_PrependCheckItem(*args
, **kwargs
)
10347 def PrependRadioItem(*args
, **kwargs
):
10348 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10349 return _core_
.Menu_PrependRadioItem(*args
, **kwargs
)
10351 def PrependMenu(*args
, **kwargs
):
10352 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10353 return _core_
.Menu_PrependMenu(*args
, **kwargs
)
10355 def Remove(*args
, **kwargs
):
10356 """Remove(self, int id) -> MenuItem"""
10357 return _core_
.Menu_Remove(*args
, **kwargs
)
10359 def RemoveItem(*args
, **kwargs
):
10360 """RemoveItem(self, MenuItem item) -> MenuItem"""
10361 return _core_
.Menu_RemoveItem(*args
, **kwargs
)
10363 def Delete(*args
, **kwargs
):
10364 """Delete(self, int id) -> bool"""
10365 return _core_
.Menu_Delete(*args
, **kwargs
)
10367 def DeleteItem(*args
, **kwargs
):
10368 """DeleteItem(self, MenuItem item) -> bool"""
10369 return _core_
.Menu_DeleteItem(*args
, **kwargs
)
10371 def Destroy(*args
, **kwargs
):
10375 Deletes the C++ object this Python object is a proxy for.
10377 val
= _core_
.Menu_Destroy(*args
, **kwargs
)
10378 args
[0].thisown
= 0
10381 def DestroyId(*args
, **kwargs
):
10383 DestroyId(self, int id) -> bool
10385 Deletes the C++ object this Python object is a proxy for.
10387 val
= _core_
.Menu_DestroyId(*args
, **kwargs
)
10388 args
[0].thisown
= 0
10391 def DestroyItem(*args
, **kwargs
):
10393 DestroyItem(self, MenuItem item) -> bool
10395 Deletes the C++ object this Python object is a proxy for.
10397 val
= _core_
.Menu_DestroyItem(*args
, **kwargs
)
10398 args
[0].thisown
= 0
10401 def GetMenuItemCount(*args
, **kwargs
):
10402 """GetMenuItemCount(self) -> size_t"""
10403 return _core_
.Menu_GetMenuItemCount(*args
, **kwargs
)
10405 def GetMenuItems(*args
, **kwargs
):
10406 """GetMenuItems(self) -> PyObject"""
10407 return _core_
.Menu_GetMenuItems(*args
, **kwargs
)
10409 def FindItem(*args
, **kwargs
):
10410 """FindItem(self, String item) -> int"""
10411 return _core_
.Menu_FindItem(*args
, **kwargs
)
10413 def FindItemById(*args
, **kwargs
):
10414 """FindItemById(self, int id) -> MenuItem"""
10415 return _core_
.Menu_FindItemById(*args
, **kwargs
)
10417 def FindItemByPosition(*args
, **kwargs
):
10418 """FindItemByPosition(self, size_t position) -> MenuItem"""
10419 return _core_
.Menu_FindItemByPosition(*args
, **kwargs
)
10421 def Enable(*args
, **kwargs
):
10422 """Enable(self, int id, bool enable)"""
10423 return _core_
.Menu_Enable(*args
, **kwargs
)
10425 def IsEnabled(*args
, **kwargs
):
10426 """IsEnabled(self, int id) -> bool"""
10427 return _core_
.Menu_IsEnabled(*args
, **kwargs
)
10429 def Check(*args
, **kwargs
):
10430 """Check(self, int id, bool check)"""
10431 return _core_
.Menu_Check(*args
, **kwargs
)
10433 def IsChecked(*args
, **kwargs
):
10434 """IsChecked(self, int id) -> bool"""
10435 return _core_
.Menu_IsChecked(*args
, **kwargs
)
10437 def SetLabel(*args
, **kwargs
):
10438 """SetLabel(self, int id, String label)"""
10439 return _core_
.Menu_SetLabel(*args
, **kwargs
)
10441 def GetLabel(*args
, **kwargs
):
10442 """GetLabel(self, int id) -> String"""
10443 return _core_
.Menu_GetLabel(*args
, **kwargs
)
10445 def SetHelpString(*args
, **kwargs
):
10446 """SetHelpString(self, int id, String helpString)"""
10447 return _core_
.Menu_SetHelpString(*args
, **kwargs
)
10449 def GetHelpString(*args
, **kwargs
):
10450 """GetHelpString(self, int id) -> String"""
10451 return _core_
.Menu_GetHelpString(*args
, **kwargs
)
10453 def SetTitle(*args
, **kwargs
):
10454 """SetTitle(self, String title)"""
10455 return _core_
.Menu_SetTitle(*args
, **kwargs
)
10457 def GetTitle(*args
, **kwargs
):
10458 """GetTitle(self) -> String"""
10459 return _core_
.Menu_GetTitle(*args
, **kwargs
)
10461 def SetEventHandler(*args
, **kwargs
):
10462 """SetEventHandler(self, EvtHandler handler)"""
10463 return _core_
.Menu_SetEventHandler(*args
, **kwargs
)
10465 def GetEventHandler(*args
, **kwargs
):
10466 """GetEventHandler(self) -> EvtHandler"""
10467 return _core_
.Menu_GetEventHandler(*args
, **kwargs
)
10469 def SetInvokingWindow(*args
, **kwargs
):
10470 """SetInvokingWindow(self, Window win)"""
10471 return _core_
.Menu_SetInvokingWindow(*args
, **kwargs
)
10473 def GetInvokingWindow(*args
, **kwargs
):
10474 """GetInvokingWindow(self) -> Window"""
10475 return _core_
.Menu_GetInvokingWindow(*args
, **kwargs
)
10477 def GetStyle(*args
, **kwargs
):
10478 """GetStyle(self) -> long"""
10479 return _core_
.Menu_GetStyle(*args
, **kwargs
)
10481 def UpdateUI(*args
, **kwargs
):
10482 """UpdateUI(self, EvtHandler source=None)"""
10483 return _core_
.Menu_UpdateUI(*args
, **kwargs
)
10485 def GetMenuBar(*args
, **kwargs
):
10486 """GetMenuBar(self) -> MenuBar"""
10487 return _core_
.Menu_GetMenuBar(*args
, **kwargs
)
10489 def Attach(*args
, **kwargs
):
10490 """Attach(self, wxMenuBarBase menubar)"""
10491 return _core_
.Menu_Attach(*args
, **kwargs
)
10493 def Detach(*args
, **kwargs
):
10495 return _core_
.Menu_Detach(*args
, **kwargs
)
10497 def IsAttached(*args
, **kwargs
):
10498 """IsAttached(self) -> bool"""
10499 return _core_
.Menu_IsAttached(*args
, **kwargs
)
10501 def SetParent(*args
, **kwargs
):
10502 """SetParent(self, Menu parent)"""
10503 return _core_
.Menu_SetParent(*args
, **kwargs
)
10505 def GetParent(*args
, **kwargs
):
10506 """GetParent(self) -> Menu"""
10507 return _core_
.Menu_GetParent(*args
, **kwargs
)
10509 EventHandler
= property(GetEventHandler
,SetEventHandler
,doc
="See `GetEventHandler` and `SetEventHandler`")
10510 HelpString
= property(GetHelpString
,SetHelpString
,doc
="See `GetHelpString` and `SetHelpString`")
10511 InvokingWindow
= property(GetInvokingWindow
,SetInvokingWindow
,doc
="See `GetInvokingWindow` and `SetInvokingWindow`")
10512 MenuBar
= property(GetMenuBar
,doc
="See `GetMenuBar`")
10513 MenuItemCount
= property(GetMenuItemCount
,doc
="See `GetMenuItemCount`")
10514 MenuItems
= property(GetMenuItems
,doc
="See `GetMenuItems`")
10515 Parent
= property(GetParent
,SetParent
,doc
="See `GetParent` and `SetParent`")
10516 Style
= property(GetStyle
,doc
="See `GetStyle`")
10517 Title
= property(GetTitle
,SetTitle
,doc
="See `GetTitle` and `SetTitle`")
10518 _core_
.Menu_swigregister(Menu
)
10519 DefaultValidator
= cvar
.DefaultValidator
10521 #---------------------------------------------------------------------------
10523 class MenuBar(Window
):
10524 """Proxy of C++ MenuBar class"""
10525 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10526 __repr__
= _swig_repr
10527 def __init__(self
, *args
, **kwargs
):
10528 """__init__(self, long style=0) -> MenuBar"""
10529 _core_
.MenuBar_swiginit(self
,_core_
.new_MenuBar(*args
, **kwargs
))
10530 self
._setOORInfo
(self
)
10532 def Append(*args
, **kwargs
):
10533 """Append(self, Menu menu, String title) -> bool"""
10534 return _core_
.MenuBar_Append(*args
, **kwargs
)
10536 def Insert(*args
, **kwargs
):
10537 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10538 return _core_
.MenuBar_Insert(*args
, **kwargs
)
10540 def GetMenuCount(*args
, **kwargs
):
10541 """GetMenuCount(self) -> size_t"""
10542 return _core_
.MenuBar_GetMenuCount(*args
, **kwargs
)
10544 def GetMenu(*args
, **kwargs
):
10545 """GetMenu(self, size_t pos) -> Menu"""
10546 return _core_
.MenuBar_GetMenu(*args
, **kwargs
)
10548 def Replace(*args
, **kwargs
):
10549 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10550 return _core_
.MenuBar_Replace(*args
, **kwargs
)
10552 def Remove(*args
, **kwargs
):
10553 """Remove(self, size_t pos) -> Menu"""
10554 return _core_
.MenuBar_Remove(*args
, **kwargs
)
10556 def EnableTop(*args
, **kwargs
):
10557 """EnableTop(self, size_t pos, bool enable)"""
10558 return _core_
.MenuBar_EnableTop(*args
, **kwargs
)
10560 def IsEnabledTop(*args
, **kwargs
):
10561 """IsEnabledTop(self, size_t pos) -> bool"""
10562 return _core_
.MenuBar_IsEnabledTop(*args
, **kwargs
)
10564 def SetLabelTop(*args
, **kwargs
):
10565 """SetLabelTop(self, size_t pos, String label)"""
10566 return _core_
.MenuBar_SetLabelTop(*args
, **kwargs
)
10568 def GetLabelTop(*args
, **kwargs
):
10569 """GetLabelTop(self, size_t pos) -> String"""
10570 return _core_
.MenuBar_GetLabelTop(*args
, **kwargs
)
10572 def FindMenuItem(*args
, **kwargs
):
10573 """FindMenuItem(self, String menu, String item) -> int"""
10574 return _core_
.MenuBar_FindMenuItem(*args
, **kwargs
)
10576 def FindItemById(*args
, **kwargs
):
10577 """FindItemById(self, int id) -> MenuItem"""
10578 return _core_
.MenuBar_FindItemById(*args
, **kwargs
)
10580 def FindMenu(*args
, **kwargs
):
10581 """FindMenu(self, String title) -> int"""
10582 return _core_
.MenuBar_FindMenu(*args
, **kwargs
)
10584 def Enable(*args
, **kwargs
):
10585 """Enable(self, int id, bool enable)"""
10586 return _core_
.MenuBar_Enable(*args
, **kwargs
)
10588 def Check(*args
, **kwargs
):
10589 """Check(self, int id, bool check)"""
10590 return _core_
.MenuBar_Check(*args
, **kwargs
)
10592 def IsChecked(*args
, **kwargs
):
10593 """IsChecked(self, int id) -> bool"""
10594 return _core_
.MenuBar_IsChecked(*args
, **kwargs
)
10596 def IsEnabled(*args
, **kwargs
):
10597 """IsEnabled(self, int id) -> bool"""
10598 return _core_
.MenuBar_IsEnabled(*args
, **kwargs
)
10600 def SetLabel(*args
, **kwargs
):
10601 """SetLabel(self, int id, String label)"""
10602 return _core_
.MenuBar_SetLabel(*args
, **kwargs
)
10604 def GetLabel(*args
, **kwargs
):
10605 """GetLabel(self, int id) -> String"""
10606 return _core_
.MenuBar_GetLabel(*args
, **kwargs
)
10608 def SetHelpString(*args
, **kwargs
):
10609 """SetHelpString(self, int id, String helpString)"""
10610 return _core_
.MenuBar_SetHelpString(*args
, **kwargs
)
10612 def GetHelpString(*args
, **kwargs
):
10613 """GetHelpString(self, int id) -> String"""
10614 return _core_
.MenuBar_GetHelpString(*args
, **kwargs
)
10616 def GetFrame(*args
, **kwargs
):
10617 """GetFrame(self) -> wxFrame"""
10618 return _core_
.MenuBar_GetFrame(*args
, **kwargs
)
10620 def IsAttached(*args
, **kwargs
):
10621 """IsAttached(self) -> bool"""
10622 return _core_
.MenuBar_IsAttached(*args
, **kwargs
)
10624 def Attach(*args
, **kwargs
):
10625 """Attach(self, wxFrame frame)"""
10626 return _core_
.MenuBar_Attach(*args
, **kwargs
)
10628 def Detach(*args
, **kwargs
):
10630 return _core_
.MenuBar_Detach(*args
, **kwargs
)
10632 def UpdateMenus(*args
, **kwargs
):
10633 """UpdateMenus(self)"""
10634 return _core_
.MenuBar_UpdateMenus(*args
, **kwargs
)
10636 def SetAutoWindowMenu(*args
, **kwargs
):
10637 """SetAutoWindowMenu(bool enable)"""
10638 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10640 SetAutoWindowMenu
= staticmethod(SetAutoWindowMenu
)
10641 def GetAutoWindowMenu(*args
, **kwargs
):
10642 """GetAutoWindowMenu() -> bool"""
10643 return _core_
.MenuBar_GetAutoWindowMenu(*args
, **kwargs
)
10645 GetAutoWindowMenu
= staticmethod(GetAutoWindowMenu
)
10646 def GetMenus(self
):
10647 """Return a list of (menu, label) items for the menus in the MenuBar. """
10648 return [(self
.GetMenu(i
), self
.GetLabelTop(i
))
10649 for i
in range(self
.GetMenuCount())]
10651 def SetMenus(self
, items
):
10652 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10653 for i
in range(self
.GetMenuCount()-1, -1, -1):
10658 Frame
= property(GetFrame
,doc
="See `GetFrame`")
10659 Menu
= property(GetMenu
,doc
="See `GetMenu`")
10660 MenuCount
= property(GetMenuCount
,doc
="See `GetMenuCount`")
10661 Menus
= property(GetMenus
,SetMenus
,doc
="See `GetMenus` and `SetMenus`")
10662 _core_
.MenuBar_swigregister(MenuBar
)
10664 def MenuBar_SetAutoWindowMenu(*args
, **kwargs
):
10665 """MenuBar_SetAutoWindowMenu(bool enable)"""
10666 return _core_
.MenuBar_SetAutoWindowMenu(*args
, **kwargs
)
10668 def MenuBar_GetAutoWindowMenu(*args
):
10669 """MenuBar_GetAutoWindowMenu() -> bool"""
10670 return _core_
.MenuBar_GetAutoWindowMenu(*args
)
10672 #---------------------------------------------------------------------------
10674 class MenuItem(Object
):
10675 """Proxy of C++ MenuItem class"""
10676 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10677 __repr__
= _swig_repr
10678 def __init__(self
, *args
, **kwargs
):
10680 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10681 String help=EmptyString, int kind=ITEM_NORMAL,
10682 Menu subMenu=None) -> MenuItem
10684 _core_
.MenuItem_swiginit(self
,_core_
.new_MenuItem(*args
, **kwargs
))
10685 __swig_destroy__
= _core_
.delete_MenuItem
10686 __del__
= lambda self
: None;
10687 def GetMenu(*args
, **kwargs
):
10688 """GetMenu(self) -> Menu"""
10689 return _core_
.MenuItem_GetMenu(*args
, **kwargs
)
10691 def SetMenu(*args
, **kwargs
):
10692 """SetMenu(self, Menu menu)"""
10693 return _core_
.MenuItem_SetMenu(*args
, **kwargs
)
10695 def SetId(*args
, **kwargs
):
10696 """SetId(self, int id)"""
10697 return _core_
.MenuItem_SetId(*args
, **kwargs
)
10699 def GetId(*args
, **kwargs
):
10700 """GetId(self) -> int"""
10701 return _core_
.MenuItem_GetId(*args
, **kwargs
)
10703 def IsSeparator(*args
, **kwargs
):
10704 """IsSeparator(self) -> bool"""
10705 return _core_
.MenuItem_IsSeparator(*args
, **kwargs
)
10707 def SetText(*args
, **kwargs
):
10708 """SetText(self, String str)"""
10709 return _core_
.MenuItem_SetText(*args
, **kwargs
)
10711 def GetLabel(*args
, **kwargs
):
10712 """GetLabel(self) -> String"""
10713 return _core_
.MenuItem_GetLabel(*args
, **kwargs
)
10715 def GetText(*args
, **kwargs
):
10716 """GetText(self) -> String"""
10717 return _core_
.MenuItem_GetText(*args
, **kwargs
)
10719 def GetLabelFromText(*args
, **kwargs
):
10720 """GetLabelFromText(String text) -> String"""
10721 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10723 GetLabelFromText
= staticmethod(GetLabelFromText
)
10724 def GetKind(*args
, **kwargs
):
10725 """GetKind(self) -> int"""
10726 return _core_
.MenuItem_GetKind(*args
, **kwargs
)
10728 def SetKind(*args
, **kwargs
):
10729 """SetKind(self, int kind)"""
10730 return _core_
.MenuItem_SetKind(*args
, **kwargs
)
10732 def SetCheckable(*args
, **kwargs
):
10733 """SetCheckable(self, bool checkable)"""
10734 return _core_
.MenuItem_SetCheckable(*args
, **kwargs
)
10736 def IsCheckable(*args
, **kwargs
):
10737 """IsCheckable(self) -> bool"""
10738 return _core_
.MenuItem_IsCheckable(*args
, **kwargs
)
10740 def IsSubMenu(*args
, **kwargs
):
10741 """IsSubMenu(self) -> bool"""
10742 return _core_
.MenuItem_IsSubMenu(*args
, **kwargs
)
10744 def SetSubMenu(*args
, **kwargs
):
10745 """SetSubMenu(self, Menu menu)"""
10746 return _core_
.MenuItem_SetSubMenu(*args
, **kwargs
)
10748 def GetSubMenu(*args
, **kwargs
):
10749 """GetSubMenu(self) -> Menu"""
10750 return _core_
.MenuItem_GetSubMenu(*args
, **kwargs
)
10752 def Enable(*args
, **kwargs
):
10753 """Enable(self, bool enable=True)"""
10754 return _core_
.MenuItem_Enable(*args
, **kwargs
)
10756 def IsEnabled(*args
, **kwargs
):
10757 """IsEnabled(self) -> bool"""
10758 return _core_
.MenuItem_IsEnabled(*args
, **kwargs
)
10760 def Check(*args
, **kwargs
):
10761 """Check(self, bool check=True)"""
10762 return _core_
.MenuItem_Check(*args
, **kwargs
)
10764 def IsChecked(*args
, **kwargs
):
10765 """IsChecked(self) -> bool"""
10766 return _core_
.MenuItem_IsChecked(*args
, **kwargs
)
10768 def Toggle(*args
, **kwargs
):
10770 return _core_
.MenuItem_Toggle(*args
, **kwargs
)
10772 def SetHelp(*args
, **kwargs
):
10773 """SetHelp(self, String str)"""
10774 return _core_
.MenuItem_SetHelp(*args
, **kwargs
)
10776 def GetHelp(*args
, **kwargs
):
10777 """GetHelp(self) -> String"""
10778 return _core_
.MenuItem_GetHelp(*args
, **kwargs
)
10780 def GetAccel(*args
, **kwargs
):
10781 """GetAccel(self) -> AcceleratorEntry"""
10782 return _core_
.MenuItem_GetAccel(*args
, **kwargs
)
10784 def SetAccel(*args
, **kwargs
):
10785 """SetAccel(self, AcceleratorEntry accel)"""
10786 return _core_
.MenuItem_SetAccel(*args
, **kwargs
)
10788 def SetBitmap(*args
, **kwargs
):
10789 """SetBitmap(self, Bitmap bitmap)"""
10790 return _core_
.MenuItem_SetBitmap(*args
, **kwargs
)
10792 def GetBitmap(*args
, **kwargs
):
10793 """GetBitmap(self) -> Bitmap"""
10794 return _core_
.MenuItem_GetBitmap(*args
, **kwargs
)
10796 def SetFont(*args
, **kwargs
):
10797 """SetFont(self, Font font)"""
10798 return _core_
.MenuItem_SetFont(*args
, **kwargs
)
10800 def GetFont(*args
, **kwargs
):
10801 """GetFont(self) -> Font"""
10802 return _core_
.MenuItem_GetFont(*args
, **kwargs
)
10804 def SetTextColour(*args
, **kwargs
):
10805 """SetTextColour(self, Colour colText)"""
10806 return _core_
.MenuItem_SetTextColour(*args
, **kwargs
)
10808 def GetTextColour(*args
, **kwargs
):
10809 """GetTextColour(self) -> Colour"""
10810 return _core_
.MenuItem_GetTextColour(*args
, **kwargs
)
10812 def SetBackgroundColour(*args
, **kwargs
):
10813 """SetBackgroundColour(self, Colour colBack)"""
10814 return _core_
.MenuItem_SetBackgroundColour(*args
, **kwargs
)
10816 def GetBackgroundColour(*args
, **kwargs
):
10817 """GetBackgroundColour(self) -> Colour"""
10818 return _core_
.MenuItem_GetBackgroundColour(*args
, **kwargs
)
10820 def SetBitmaps(*args
, **kwargs
):
10821 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10822 return _core_
.MenuItem_SetBitmaps(*args
, **kwargs
)
10824 def SetDisabledBitmap(*args
, **kwargs
):
10825 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10826 return _core_
.MenuItem_SetDisabledBitmap(*args
, **kwargs
)
10828 def GetDisabledBitmap(*args
, **kwargs
):
10829 """GetDisabledBitmap(self) -> Bitmap"""
10830 return _core_
.MenuItem_GetDisabledBitmap(*args
, **kwargs
)
10832 def SetMarginWidth(*args
, **kwargs
):
10833 """SetMarginWidth(self, int nWidth)"""
10834 return _core_
.MenuItem_SetMarginWidth(*args
, **kwargs
)
10836 def GetMarginWidth(*args
, **kwargs
):
10837 """GetMarginWidth(self) -> int"""
10838 return _core_
.MenuItem_GetMarginWidth(*args
, **kwargs
)
10840 def GetDefaultMarginWidth(*args
, **kwargs
):
10841 """GetDefaultMarginWidth() -> int"""
10842 return _core_
.MenuItem_GetDefaultMarginWidth(*args
, **kwargs
)
10844 GetDefaultMarginWidth
= staticmethod(GetDefaultMarginWidth
)
10845 def IsOwnerDrawn(*args
, **kwargs
):
10846 """IsOwnerDrawn(self) -> bool"""
10847 return _core_
.MenuItem_IsOwnerDrawn(*args
, **kwargs
)
10849 def SetOwnerDrawn(*args
, **kwargs
):
10850 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10851 return _core_
.MenuItem_SetOwnerDrawn(*args
, **kwargs
)
10853 def ResetOwnerDrawn(*args
, **kwargs
):
10854 """ResetOwnerDrawn(self)"""
10855 return _core_
.MenuItem_ResetOwnerDrawn(*args
, **kwargs
)
10857 Accel
= property(GetAccel
,SetAccel
,doc
="See `GetAccel` and `SetAccel`")
10858 BackgroundColour
= property(GetBackgroundColour
,SetBackgroundColour
,doc
="See `GetBackgroundColour` and `SetBackgroundColour`")
10859 Bitmap
= property(GetBitmap
,SetBitmap
,doc
="See `GetBitmap` and `SetBitmap`")
10860 DisabledBitmap
= property(GetDisabledBitmap
,SetDisabledBitmap
,doc
="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10861 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
10862 Help
= property(GetHelp
,SetHelp
,doc
="See `GetHelp` and `SetHelp`")
10863 Id
= property(GetId
,SetId
,doc
="See `GetId` and `SetId`")
10864 Kind
= property(GetKind
,SetKind
,doc
="See `GetKind` and `SetKind`")
10865 Label
= property(GetLabel
,doc
="See `GetLabel`")
10866 MarginWidth
= property(GetMarginWidth
,SetMarginWidth
,doc
="See `GetMarginWidth` and `SetMarginWidth`")
10867 Menu
= property(GetMenu
,SetMenu
,doc
="See `GetMenu` and `SetMenu`")
10868 SubMenu
= property(GetSubMenu
,SetSubMenu
,doc
="See `GetSubMenu` and `SetSubMenu`")
10869 Text
= property(GetText
,SetText
,doc
="See `GetText` and `SetText`")
10870 TextColour
= property(GetTextColour
,SetTextColour
,doc
="See `GetTextColour` and `SetTextColour`")
10871 _core_
.MenuItem_swigregister(MenuItem
)
10873 def MenuItem_GetLabelFromText(*args
, **kwargs
):
10874 """MenuItem_GetLabelFromText(String text) -> String"""
10875 return _core_
.MenuItem_GetLabelFromText(*args
, **kwargs
)
10877 def MenuItem_GetDefaultMarginWidth(*args
):
10878 """MenuItem_GetDefaultMarginWidth() -> int"""
10879 return _core_
.MenuItem_GetDefaultMarginWidth(*args
)
10881 #---------------------------------------------------------------------------
10883 class Control(Window
):
10885 This is the base class for a control or 'widget'.
10887 A control is generally a small window which processes user input
10888 and/or displays one or more item of data.
10890 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
10891 __repr__
= _swig_repr
10892 def __init__(self
, *args
, **kwargs
):
10894 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10895 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10896 String name=ControlNameStr) -> Control
10898 Create a Control. Normally you should only call this from a subclass'
10899 __init__ as a plain old wx.Control is not very useful.
10901 _core_
.Control_swiginit(self
,_core_
.new_Control(*args
, **kwargs
))
10902 self
._setOORInfo
(self
)
10904 def Create(*args
, **kwargs
):
10906 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10907 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10908 String name=ControlNameStr) -> bool
10910 Do the 2nd phase and create the GUI control.
10912 return _core_
.Control_Create(*args
, **kwargs
)
10914 def GetAlignment(*args
, **kwargs
):
10916 GetAlignment(self) -> int
10918 Get the control alignment (left/right/centre, top/bottom/centre)
10920 return _core_
.Control_GetAlignment(*args
, **kwargs
)
10922 def GetLabelText(*args
, **kwargs
):
10924 GetLabelText(self) -> String
10926 Get just the text of the label, without mnemonic characters ('&')
10928 return _core_
.Control_GetLabelText(*args
, **kwargs
)
10930 def Command(*args
, **kwargs
):
10932 Command(self, CommandEvent event)
10934 Simulates the effect of the user issuing a command to the item.
10936 :see: `wx.CommandEvent`
10939 return _core_
.Control_Command(*args
, **kwargs
)
10941 def GetLabel(*args
, **kwargs
):
10943 GetLabel(self) -> String
10945 Return a control's text.
10947 return _core_
.Control_GetLabel(*args
, **kwargs
)
10949 def GetClassDefaultAttributes(*args
, **kwargs
):
10951 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10953 Get the default attributes for this class. This is useful if you want
10954 to use the same font or colour in your own control as in a standard
10955 control -- which is a much better idea than hard coding specific
10956 colours or fonts which might look completely out of place on the
10957 user's system, especially if it uses themes.
10959 The variant parameter is only relevant under Mac currently and is
10960 ignore under other platforms. Under Mac, it will change the size of
10961 the returned font. See `wx.Window.SetWindowVariant` for more about
10964 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
10966 GetClassDefaultAttributes
= staticmethod(GetClassDefaultAttributes
)
10967 Alignment
= property(GetAlignment
,doc
="See `GetAlignment`")
10968 Label
= property(GetLabel
,doc
="See `GetLabel`")
10969 LabelText
= property(GetLabelText
,doc
="See `GetLabelText`")
10970 _core_
.Control_swigregister(Control
)
10971 ControlNameStr
= cvar
.ControlNameStr
10973 def PreControl(*args
, **kwargs
):
10975 PreControl() -> Control
10977 Precreate a Control control for 2-phase creation
10979 val
= _core_
.new_PreControl(*args
, **kwargs
)
10982 def Control_GetClassDefaultAttributes(*args
, **kwargs
):
10984 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10986 Get the default attributes for this class. This is useful if you want
10987 to use the same font or colour in your own control as in a standard
10988 control -- which is a much better idea than hard coding specific
10989 colours or fonts which might look completely out of place on the
10990 user's system, especially if it uses themes.
10992 The variant parameter is only relevant under Mac currently and is
10993 ignore under other platforms. Under Mac, it will change the size of
10994 the returned font. See `wx.Window.SetWindowVariant` for more about
10997 return _core_
.Control_GetClassDefaultAttributes(*args
, **kwargs
)
10999 #---------------------------------------------------------------------------
11001 class ItemContainer(object):
11003 The wx.ItemContainer class defines an interface which is implemented
11004 by all controls which have string subitems, each of which may be
11005 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11006 as `wx.ComboBox` which implements an extended interface deriving from
11009 It defines the methods for accessing the control's items and although
11010 each of the derived classes implements them differently, they still
11011 all conform to the same interface.
11013 The items in a wx.ItemContainer have (non empty) string labels and,
11014 optionally, client data associated with them.
11017 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11018 def __init__(self
): raise AttributeError, "No constructor defined"
11019 __repr__
= _swig_repr
11020 def Append(*args
, **kwargs
):
11022 Append(self, String item, PyObject clientData=None) -> int
11024 Adds the item to the control, associating the given data with the item
11025 if not None. The return value is the index of the newly added item
11026 which may be different from the last one if the control is sorted (e.g.
11027 has wx.LB_SORT or wx.CB_SORT style).
11029 return _core_
.ItemContainer_Append(*args
, **kwargs
)
11031 def AppendItems(*args
, **kwargs
):
11033 AppendItems(self, List strings)
11035 Apend several items at once to the control. Notice that calling this
11036 method may be much faster than appending the items one by one if you
11037 need to add a lot of items.
11039 return _core_
.ItemContainer_AppendItems(*args
, **kwargs
)
11041 def Insert(*args
, **kwargs
):
11043 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11045 Insert an item into the control before the item at the ``pos`` index,
11046 optionally associating some data object with the item.
11048 return _core_
.ItemContainer_Insert(*args
, **kwargs
)
11050 def Clear(*args
, **kwargs
):
11054 Removes all items from the control.
11056 return _core_
.ItemContainer_Clear(*args
, **kwargs
)
11058 def Delete(*args
, **kwargs
):
11060 Delete(self, unsigned int n)
11062 Deletes the item at the zero-based index 'n' from the control. Note
11063 that it is an error (signalled by a `wx.PyAssertionError` exception if
11064 enabled) to remove an item with the index negative or greater or equal
11065 than the number of items in the control.
11067 return _core_
.ItemContainer_Delete(*args
, **kwargs
)
11069 def GetClientData(*args
, **kwargs
):
11071 GetClientData(self, unsigned int n) -> PyObject
11073 Returns the client data associated with the given item, (if any.)
11075 return _core_
.ItemContainer_GetClientData(*args
, **kwargs
)
11077 def SetClientData(*args
, **kwargs
):
11079 SetClientData(self, unsigned int n, PyObject clientData)
11081 Associate the given client data with the item at position n.
11083 return _core_
.ItemContainer_SetClientData(*args
, **kwargs
)
11085 def GetCount(*args
, **kwargs
):
11087 GetCount(self) -> unsigned int
11089 Returns the number of items in the control.
11091 return _core_
.ItemContainer_GetCount(*args
, **kwargs
)
11093 def IsEmpty(*args
, **kwargs
):
11095 IsEmpty(self) -> bool
11097 Returns True if the control is empty or False if it has some items.
11099 return _core_
.ItemContainer_IsEmpty(*args
, **kwargs
)
11101 def GetString(*args
, **kwargs
):
11103 GetString(self, unsigned int n) -> String
11105 Returns the label of the item with the given index.
11107 return _core_
.ItemContainer_GetString(*args
, **kwargs
)
11109 def GetStrings(*args
, **kwargs
):
11110 """GetStrings(self) -> wxArrayString"""
11111 return _core_
.ItemContainer_GetStrings(*args
, **kwargs
)
11113 def SetString(*args
, **kwargs
):
11115 SetString(self, unsigned int n, String s)
11117 Sets the label for the given item.
11119 return _core_
.ItemContainer_SetString(*args
, **kwargs
)
11121 def FindString(*args
, **kwargs
):
11123 FindString(self, String s) -> int
11125 Finds an item whose label matches the given string. Returns the
11126 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11129 return _core_
.ItemContainer_FindString(*args
, **kwargs
)
11131 def SetSelection(*args
, **kwargs
):
11133 SetSelection(self, int n)
11135 Sets the item at index 'n' to be the selected item.
11137 return _core_
.ItemContainer_SetSelection(*args
, **kwargs
)
11139 def GetSelection(*args
, **kwargs
):
11141 GetSelection(self) -> int
11143 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11146 return _core_
.ItemContainer_GetSelection(*args
, **kwargs
)
11148 def SetStringSelection(*args
, **kwargs
):
11149 """SetStringSelection(self, String s) -> bool"""
11150 return _core_
.ItemContainer_SetStringSelection(*args
, **kwargs
)
11152 def GetStringSelection(*args
, **kwargs
):
11154 GetStringSelection(self) -> String
11156 Returns the label of the selected item or an empty string if no item
11159 return _core_
.ItemContainer_GetStringSelection(*args
, **kwargs
)
11161 def Select(*args
, **kwargs
):
11163 Select(self, int n)
11165 This is the same as `SetSelection` and exists only because it is
11166 slightly more natural for controls which support multiple selection.
11168 return _core_
.ItemContainer_Select(*args
, **kwargs
)
11170 def GetItems(self
):
11171 """Return a list of the strings in the control"""
11172 return [self
.GetString(i
) for i
in xrange(self
.GetCount())]
11174 def SetItems(self
, items
):
11175 """Clear and set the strings in the control from a list"""
11180 Count
= property(GetCount
,doc
="See `GetCount`")
11181 Items
= property(GetItems
,SetItems
,doc
="See `GetItems` and `SetItems`")
11182 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
11183 StringSelection
= property(GetStringSelection
,SetStringSelection
,doc
="See `GetStringSelection` and `SetStringSelection`")
11184 Strings
= property(GetStrings
,doc
="See `GetStrings`")
11185 _core_
.ItemContainer_swigregister(ItemContainer
)
11187 #---------------------------------------------------------------------------
11189 class ControlWithItems(Control
,ItemContainer
):
11191 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11192 wx.Control class, and is used for the base class of various controls
11195 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11196 def __init__(self
): raise AttributeError, "No constructor defined"
11197 __repr__
= _swig_repr
11198 _core_
.ControlWithItems_swigregister(ControlWithItems
)
11200 #---------------------------------------------------------------------------
11202 class SizerItem(Object
):
11204 The wx.SizerItem class is used to track the position, size and other
11205 attributes of each item managed by a `wx.Sizer`. It is not usually
11206 necessary to use this class because the sizer elements can also be
11207 identified by their positions or window or sizer references but
11208 sometimes it may be more convenient to use wx.SizerItem directly.
11209 Also, custom classes derived from `wx.PySizer` will probably need to
11210 use the collection of wx.SizerItems held by wx.Sizer when calculating
11213 :see: `wx.Sizer`, `wx.GBSizerItem`
11215 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11216 __repr__
= _swig_repr
11217 def __init__(self
, *args
, **kwargs
):
11219 __init__(self) -> SizerItem
11221 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11222 size will need to be set before this item can be used in a Sizer.
11224 You will probably never need to create a wx.SizerItem directly as they
11225 are created automatically when the sizer's Add, Insert or Prepend
11226 methods are called.
11228 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11230 _core_
.SizerItem_swiginit(self
,_core_
.new_SizerItem(*args
, **kwargs
))
11231 __swig_destroy__
= _core_
.delete_SizerItem
11232 __del__
= lambda self
: None;
11233 def DeleteWindows(*args
, **kwargs
):
11235 DeleteWindows(self)
11237 Destroy the window or the windows in a subsizer, depending on the type
11240 return _core_
.SizerItem_DeleteWindows(*args
, **kwargs
)
11242 def DetachSizer(*args
, **kwargs
):
11246 Enable deleting the SizerItem without destroying the contained sizer.
11248 return _core_
.SizerItem_DetachSizer(*args
, **kwargs
)
11250 def GetSize(*args
, **kwargs
):
11252 GetSize(self) -> Size
11254 Get the current size of the item, as set in the last Layout.
11256 return _core_
.SizerItem_GetSize(*args
, **kwargs
)
11258 def CalcMin(*args
, **kwargs
):
11260 CalcMin(self) -> Size
11262 Calculates the minimum desired size for the item, including any space
11265 return _core_
.SizerItem_CalcMin(*args
, **kwargs
)
11267 def SetDimension(*args
, **kwargs
):
11269 SetDimension(self, Point pos, Size size)
11271 Set the position and size of the space allocated for this item by the
11272 sizer, and adjust the position and size of the item (window or
11273 subsizer) to be within that space taking alignment and borders into
11276 return _core_
.SizerItem_SetDimension(*args
, **kwargs
)
11278 def GetMinSize(*args
, **kwargs
):
11280 GetMinSize(self) -> Size
11282 Get the minimum size needed for the item.
11284 return _core_
.SizerItem_GetMinSize(*args
, **kwargs
)
11286 def GetMinSizeWithBorder(*args
, **kwargs
):
11288 GetMinSizeWithBorder(self) -> Size
11290 Get the minimum size needed for the item with space for the borders
11293 return _core_
.SizerItem_GetMinSizeWithBorder(*args
, **kwargs
)
11295 def SetInitSize(*args
, **kwargs
):
11296 """SetInitSize(self, int x, int y)"""
11297 return _core_
.SizerItem_SetInitSize(*args
, **kwargs
)
11299 def SetRatioWH(*args
, **kwargs
):
11301 SetRatioWH(self, int width, int height)
11303 Set the ratio item attribute.
11305 return _core_
.SizerItem_SetRatioWH(*args
, **kwargs
)
11307 def SetRatioSize(*args
, **kwargs
):
11309 SetRatioSize(self, Size size)
11311 Set the ratio item attribute.
11313 return _core_
.SizerItem_SetRatioSize(*args
, **kwargs
)
11315 def SetRatio(*args
, **kwargs
):
11317 SetRatio(self, float ratio)
11319 Set the ratio item attribute.
11321 return _core_
.SizerItem_SetRatio(*args
, **kwargs
)
11323 def GetRatio(*args
, **kwargs
):
11325 GetRatio(self) -> float
11327 Set the ratio item attribute.
11329 return _core_
.SizerItem_GetRatio(*args
, **kwargs
)
11331 def GetRect(*args
, **kwargs
):
11333 GetRect(self) -> Rect
11335 Returns the rectangle that the sizer item should occupy
11337 return _core_
.SizerItem_GetRect(*args
, **kwargs
)
11339 def IsWindow(*args
, **kwargs
):
11341 IsWindow(self) -> bool
11343 Is this sizer item a window?
11345 return _core_
.SizerItem_IsWindow(*args
, **kwargs
)
11347 def IsSizer(*args
, **kwargs
):
11349 IsSizer(self) -> bool
11351 Is this sizer item a subsizer?
11353 return _core_
.SizerItem_IsSizer(*args
, **kwargs
)
11355 def IsSpacer(*args
, **kwargs
):
11357 IsSpacer(self) -> bool
11359 Is this sizer item a spacer?
11361 return _core_
.SizerItem_IsSpacer(*args
, **kwargs
)
11363 def SetProportion(*args
, **kwargs
):
11365 SetProportion(self, int proportion)
11367 Set the proportion value for this item.
11369 return _core_
.SizerItem_SetProportion(*args
, **kwargs
)
11371 def GetProportion(*args
, **kwargs
):
11373 GetProportion(self) -> int
11375 Get the proportion value for this item.
11377 return _core_
.SizerItem_GetProportion(*args
, **kwargs
)
11379 SetOption
= wx
._deprecated
(SetProportion
, "Please use `SetProportion` instead.")
11380 GetOption
= wx
._deprecated
(GetProportion
, "Please use `GetProportion` instead.")
11381 def SetFlag(*args
, **kwargs
):
11383 SetFlag(self, int flag)
11385 Set the flag value for this item.
11387 return _core_
.SizerItem_SetFlag(*args
, **kwargs
)
11389 def GetFlag(*args
, **kwargs
):
11391 GetFlag(self) -> int
11393 Get the flag value for this item.
11395 return _core_
.SizerItem_GetFlag(*args
, **kwargs
)
11397 def SetBorder(*args
, **kwargs
):
11399 SetBorder(self, int border)
11401 Set the border value for this item.
11403 return _core_
.SizerItem_SetBorder(*args
, **kwargs
)
11405 def GetBorder(*args
, **kwargs
):
11407 GetBorder(self) -> int
11409 Get the border value for this item.
11411 return _core_
.SizerItem_GetBorder(*args
, **kwargs
)
11413 def GetWindow(*args
, **kwargs
):
11415 GetWindow(self) -> Window
11417 Get the window (if any) that is managed by this sizer item.
11419 return _core_
.SizerItem_GetWindow(*args
, **kwargs
)
11421 def SetWindow(*args
, **kwargs
):
11423 SetWindow(self, Window window)
11425 Set the window to be managed by this sizer item.
11427 return _core_
.SizerItem_SetWindow(*args
, **kwargs
)
11429 def GetSizer(*args
, **kwargs
):
11431 GetSizer(self) -> Sizer
11433 Get the subsizer (if any) that is managed by this sizer item.
11435 return _core_
.SizerItem_GetSizer(*args
, **kwargs
)
11437 def SetSizer(*args
, **kwargs
):
11439 SetSizer(self, Sizer sizer)
11441 Set the subsizer to be managed by this sizer item.
11443 return _core_
.SizerItem_SetSizer(*args
, **kwargs
)
11445 def GetSpacer(*args
, **kwargs
):
11447 GetSpacer(self) -> Size
11449 Get the size of the spacer managed by this sizer item.
11451 return _core_
.SizerItem_GetSpacer(*args
, **kwargs
)
11453 def SetSpacer(*args
, **kwargs
):
11455 SetSpacer(self, Size size)
11457 Set the size of the spacer to be managed by this sizer item.
11459 return _core_
.SizerItem_SetSpacer(*args
, **kwargs
)
11461 def Show(*args
, **kwargs
):
11463 Show(self, bool show)
11465 Set the show item attribute, which sizers use to determine if the item
11466 is to be made part of the layout or not. If the item is tracking a
11467 window then it is shown or hidden as needed.
11469 return _core_
.SizerItem_Show(*args
, **kwargs
)
11471 def IsShown(*args
, **kwargs
):
11473 IsShown(self) -> bool
11475 Is the item to be shown in the layout?
11477 return _core_
.SizerItem_IsShown(*args
, **kwargs
)
11479 def GetPosition(*args
, **kwargs
):
11481 GetPosition(self) -> Point
11483 Returns the current position of the item, as set in the last Layout.
11485 return _core_
.SizerItem_GetPosition(*args
, **kwargs
)
11487 def GetUserData(*args
, **kwargs
):
11489 GetUserData(self) -> PyObject
11491 Returns the userData associated with this sizer item, or None if there
11494 return _core_
.SizerItem_GetUserData(*args
, **kwargs
)
11496 def SetUserData(*args
, **kwargs
):
11498 SetUserData(self, PyObject userData)
11500 Associate a Python object with this sizer item.
11502 return _core_
.SizerItem_SetUserData(*args
, **kwargs
)
11504 Border
= property(GetBorder
,SetBorder
,doc
="See `GetBorder` and `SetBorder`")
11505 Flag
= property(GetFlag
,SetFlag
,doc
="See `GetFlag` and `SetFlag`")
11506 MinSize
= property(GetMinSize
,doc
="See `GetMinSize`")
11507 MinSizeWithBorder
= property(GetMinSizeWithBorder
,doc
="See `GetMinSizeWithBorder`")
11508 Position
= property(GetPosition
,doc
="See `GetPosition`")
11509 Proportion
= property(GetProportion
,SetProportion
,doc
="See `GetProportion` and `SetProportion`")
11510 Ratio
= property(GetRatio
,SetRatio
,doc
="See `GetRatio` and `SetRatio`")
11511 Rect
= property(GetRect
,doc
="See `GetRect`")
11512 Size
= property(GetSize
,doc
="See `GetSize`")
11513 Sizer
= property(GetSizer
,SetSizer
,doc
="See `GetSizer` and `SetSizer`")
11514 Spacer
= property(GetSpacer
,SetSpacer
,doc
="See `GetSpacer` and `SetSpacer`")
11515 UserData
= property(GetUserData
,SetUserData
,doc
="See `GetUserData` and `SetUserData`")
11516 Window
= property(GetWindow
,SetWindow
,doc
="See `GetWindow` and `SetWindow`")
11517 _core_
.SizerItem_swigregister(SizerItem
)
11519 def SizerItemWindow(*args
, **kwargs
):
11521 SizerItemWindow(Window window, int proportion, int flag, int border,
11522 PyObject userData=None) -> SizerItem
11524 Constructs a `wx.SizerItem` for tracking a window.
11526 val
= _core_
.new_SizerItemWindow(*args
, **kwargs
)
11529 def SizerItemSpacer(*args
, **kwargs
):
11531 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11532 PyObject userData=None) -> SizerItem
11534 Constructs a `wx.SizerItem` for tracking a spacer.
11536 val
= _core_
.new_SizerItemSpacer(*args
, **kwargs
)
11539 def SizerItemSizer(*args
, **kwargs
):
11541 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11542 PyObject userData=None) -> SizerItem
11544 Constructs a `wx.SizerItem` for tracking a subsizer
11546 val
= _core_
.new_SizerItemSizer(*args
, **kwargs
)
11549 class Sizer(Object
):
11551 wx.Sizer is the abstract base class used for laying out subwindows in
11552 a window. You cannot use wx.Sizer directly; instead, you will have to
11553 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11554 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11557 The concept implemented by sizers in wxWidgets is closely related to
11558 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11559 toolkit or the Qt toolkit. It is based upon the idea of the individual
11560 subwindows reporting their minimal required size and their ability to
11561 get stretched if the size of the parent window has changed. This will
11562 most often mean that the programmer does not set the original size of
11563 a dialog in the beginning, rather the dialog will assigned a sizer and
11564 this sizer will be queried about the recommended size. The sizer in
11565 turn will query its children, which can be normal windows or contorls,
11566 empty space or other sizers, so that a hierarchy of sizers can be
11567 constructed. Note that wxSizer does not derive from wxWindow and thus
11568 do not interfere with tab ordering and requires very little resources
11569 compared to a real window on screen.
11571 What makes sizers so well fitted for use in wxWidgets is the fact that
11572 every control reports its own minimal size and the algorithm can
11573 handle differences in font sizes or different window (dialog item)
11574 sizes on different platforms without problems. If for example the
11575 standard font as well as the overall design of Mac widgets requires
11576 more space than on Windows, then the initial size of a dialog using a
11577 sizer will automatically be bigger on Mac than on Windows.
11579 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
11580 def __init__(self
): raise AttributeError, "No constructor defined"
11581 __repr__
= _swig_repr
11582 __swig_destroy__
= _core_
.delete_Sizer
11583 __del__
= lambda self
: None;
11584 def _setOORInfo(*args
, **kwargs
):
11585 """_setOORInfo(self, PyObject _self)"""
11586 return _core_
.Sizer__setOORInfo(*args
, **kwargs
)
11588 def Add(*args
, **kwargs
):
11590 Add(self, item, int proportion=0, int flag=0, int border=0,
11591 PyObject userData=None) -> wx.SizerItem
11593 Appends a child item to the sizer.
11595 return _core_
.Sizer_Add(*args
, **kwargs
)
11597 def Insert(*args
, **kwargs
):
11599 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11600 PyObject userData=None) -> wx.SizerItem
11602 Inserts a new item into the list of items managed by this sizer before
11603 the item at index *before*. See `Add` for a description of the parameters.
11605 return _core_
.Sizer_Insert(*args
, **kwargs
)
11607 def Prepend(*args
, **kwargs
):
11609 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11610 PyObject userData=None) -> wx.SizerItem
11612 Adds a new item to the begining of the list of sizer items managed by
11613 this sizer. See `Add` for a description of the parameters.
11615 return _core_
.Sizer_Prepend(*args
, **kwargs
)
11617 def Remove(*args
, **kwargs
):
11619 Remove(self, item) -> bool
11621 Removes an item from the sizer and destroys it. This method does not
11622 cause any layout or resizing to take place, call `Layout` to update
11623 the layout on screen after removing a child from the sizer. The
11624 *item* parameter can be either a window, a sizer, or the zero-based
11625 index of an item to remove. Returns True if the child item was found
11628 return _core_
.Sizer_Remove(*args
, **kwargs
)
11630 def Detach(*args
, **kwargs
):
11632 Detach(self, item) -> bool
11634 Detaches an item from the sizer without destroying it. This method
11635 does not cause any layout or resizing to take place, call `Layout` to
11636 do so. The *item* parameter can be either a window, a sizer, or the
11637 zero-based index of the item to be detached. Returns True if the child item
11638 was found and detached.
11640 return _core_
.Sizer_Detach(*args
, **kwargs
)
11642 def GetItem(*args
, **kwargs
):
11644 GetItem(self, item) -> wx.SizerItem
11646 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11647 parameter can be either a window, a sizer, or the zero-based index of
11648 the item to be found.
11650 return _core_
.Sizer_GetItem(*args
, **kwargs
)
11652 def _SetItemMinSize(*args
, **kwargs
):
11653 """_SetItemMinSize(self, PyObject item, Size size)"""
11654 return _core_
.Sizer__SetItemMinSize(*args
, **kwargs
)
11656 def _ReplaceWin(*args
, **kwargs
):
11657 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11658 return _core_
.Sizer__ReplaceWin(*args
, **kwargs
)
11660 def _ReplaceSizer(*args
, **kwargs
):
11661 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11662 return _core_
.Sizer__ReplaceSizer(*args
, **kwargs
)
11664 def _ReplaceItem(*args
, **kwargs
):
11665 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11666 return _core_
.Sizer__ReplaceItem(*args
, **kwargs
)
11668 def Replace(self
, olditem
, item
, recursive
=False):
11670 Detaches the given ``olditem`` from the sizer and replaces it with
11671 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11672 detached child is destroyed only if it is not a window, (because
11673 windows are owned by their parent, not the sizer.) The
11674 ``recursive`` parameter can be used to search for the given
11675 element recursivly in subsizers.
11677 This method does not cause any layout or resizing to take place,
11678 call `Layout` to do so.
11680 Returns ``True`` if the child item was found and removed.
11682 if isinstance(olditem
, wx
.Window
):
11683 return self
._ReplaceWin
(olditem
, item
, recursive
)
11684 elif isinstnace(olditem
, wx
.Sizer
):
11685 return self
._ReplaceSizer
(olditem
, item
, recursive
)
11686 elif isinstnace(olditem
, int):
11687 return self
._ReplaceItem
(olditem
, item
)
11689 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11691 def SetContainingWindow(*args
, **kwargs
):
11693 SetContainingWindow(self, Window window)
11695 Set (or unset) the window this sizer is used in.
11697 return _core_
.Sizer_SetContainingWindow(*args
, **kwargs
)
11699 def GetContainingWindow(*args
, **kwargs
):
11701 GetContainingWindow(self) -> Window
11703 Get the window this sizer is used in.
11705 return _core_
.Sizer_GetContainingWindow(*args
, **kwargs
)
11707 def SetItemMinSize(self
, item
, *args
):
11709 SetItemMinSize(self, item, Size size)
11711 Sets the minimum size that will be allocated for an item in the sizer.
11712 The *item* parameter can be either a window, a sizer, or the
11713 zero-based index of the item. If a window or sizer is given then it
11714 will be searched for recursivly in subsizers if neccessary.
11717 # for backward compatibility accept separate width,height args too
11718 return self
._SetItemMinSize
(item
, args
)
11720 return self
._SetItemMinSize
(item
, args
[0])
11722 def AddItem(*args
, **kwargs
):
11724 AddItem(self, SizerItem item)
11726 Adds a `wx.SizerItem` to the sizer.
11728 return _core_
.Sizer_AddItem(*args
, **kwargs
)
11730 def InsertItem(*args
, **kwargs
):
11732 InsertItem(self, int index, SizerItem item)
11734 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11736 return _core_
.Sizer_InsertItem(*args
, **kwargs
)
11738 def PrependItem(*args
, **kwargs
):
11740 PrependItem(self, SizerItem item)
11742 Prepends a `wx.SizerItem` to the sizer.
11744 return _core_
.Sizer_PrependItem(*args
, **kwargs
)
11746 def AddMany(self
, items
):
11748 AddMany is a convenience method for adding several items
11749 to a sizer at one time. Simply pass it a list of tuples,
11750 where each tuple consists of the parameters that you
11751 would normally pass to the `Add` method.
11754 if type(item
) != type(()) or (len(item
) == 2 and type(item
[0]) == type(1)):
11758 def AddSpacer(self
, *args
, **kw
):
11759 """AddSpacer(int size) --> SizerItem
11761 Add a spacer that is (size,size) pixels.
11763 if args
and type(args
[0]) == int:
11764 return self
.Add( (args
[0],args
[0] ), 0)
11765 else: # otherwise stay compatible with old AddSpacer
11766 return self
.Add(*args
, **kw
)
11767 def PrependSpacer(self
, *args
, **kw
):
11768 """PrependSpacer(int size) --> SizerItem
11770 Prepend a spacer that is (size, size) pixels."""
11771 if args
and type(args
[0]) == int:
11772 return self
.Prepend( (args
[0],args
[0] ), 0)
11773 else: # otherwise stay compatible with old PrependSpacer
11774 return self
.Prepend(*args
, **kw
)
11775 def InsertSpacer(self
, index
, *args
, **kw
):
11776 """InsertSpacer(int index, int size) --> SizerItem
11778 Insert a spacer at position index that is (size, size) pixels."""
11779 if args
and type(args
[0]) == int:
11780 return self
.Insert( index
, (args
[0],args
[0] ), 0)
11781 else: # otherwise stay compatible with old InsertSpacer
11782 return self
.Insert(index
, *args
, **kw
)
11785 def AddStretchSpacer(self
, prop
=1):
11786 """AddStretchSpacer(int prop=1) --> SizerItem
11788 Add a stretchable spacer."""
11789 return self
.Add((0,0), prop
)
11790 def PrependStretchSpacer(self
, prop
=1):
11791 """PrependStretchSpacer(int prop=1) --> SizerItem
11793 Prepend a stretchable spacer."""
11794 return self
.Prepend((0,0), prop
)
11795 def InsertStretchSpacer(self
, index
, prop
=1):
11796 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11798 Insert a stretchable spacer."""
11799 return self
.Insert(index
, (0,0), prop
)
11802 # for backwards compatibility only, please do not use in new code
11803 def AddWindow(self
, *args
, **kw
):
11804 """Compatibility alias for `Add`."""
11805 return self
.Add(*args
, **kw
)
11806 def AddSizer(self
, *args
, **kw
):
11807 """Compatibility alias for `Add`."""
11808 return self
.Add(*args
, **kw
)
11810 def PrependWindow(self
, *args
, **kw
):
11811 """Compatibility alias for `Prepend`."""
11812 return self
.Prepend(*args
, **kw
)
11813 def PrependSizer(self
, *args
, **kw
):
11814 """Compatibility alias for `Prepend`."""
11815 return self
.Prepend(*args
, **kw
)
11817 def InsertWindow(self
, *args
, **kw
):
11818 """Compatibility alias for `Insert`."""
11819 return self
.Insert(*args
, **kw
)
11820 def InsertSizer(self
, *args
, **kw
):
11821 """Compatibility alias for `Insert`."""
11822 return self
.Insert(*args
, **kw
)
11824 def RemoveWindow(self
, *args
, **kw
):
11825 """Compatibility alias for `Remove`."""
11826 return self
.Remove(*args
, **kw
)
11827 def RemoveSizer(self
, *args
, **kw
):
11828 """Compatibility alias for `Remove`."""
11829 return self
.Remove(*args
, **kw
)
11830 def RemovePos(self
, *args
, **kw
):
11831 """Compatibility alias for `Remove`."""
11832 return self
.Remove(*args
, **kw
)
11835 def SetDimension(*args
, **kwargs
):
11837 SetDimension(self, int x, int y, int width, int height)
11839 Call this to force the sizer to take the given dimension and thus
11840 force the items owned by the sizer to resize themselves according to
11841 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11844 return _core_
.Sizer_SetDimension(*args
, **kwargs
)
11846 def SetMinSize(*args
, **kwargs
):
11848 SetMinSize(self, Size size)
11850 Call this to give the sizer a minimal size. Normally, the sizer will
11851 calculate its minimal size based purely on how much space its children
11852 need. After calling this method `GetMinSize` will return either the
11853 minimal size as requested by its children or the minimal size set
11854 here, depending on which is bigger.
11856 return _core_
.Sizer_SetMinSize(*args
, **kwargs
)
11858 def GetSize(*args
, **kwargs
):
11860 GetSize(self) -> Size
11862 Returns the current size of the space managed by the sizer.
11864 return _core_
.Sizer_GetSize(*args
, **kwargs
)
11866 def GetPosition(*args
, **kwargs
):
11868 GetPosition(self) -> Point
11870 Returns the current position of the sizer's managed space.
11872 return _core_
.Sizer_GetPosition(*args
, **kwargs
)
11874 def GetMinSize(*args
, **kwargs
):
11876 GetMinSize(self) -> Size
11878 Returns the minimal size of the sizer. This is either the combined
11879 minimal size of all the children and their borders or the minimal size
11880 set by SetMinSize, depending on which is bigger.
11882 return _core_
.Sizer_GetMinSize(*args
, **kwargs
)
11884 def GetSizeTuple(self
):
11885 return self
.GetSize().Get()
11886 def GetPositionTuple(self
):
11887 return self
.GetPosition().Get()
11888 def GetMinSizeTuple(self
):
11889 return self
.GetMinSize().Get()
11891 def RecalcSizes(*args
, **kwargs
):
11895 Using the sizes calculated by `CalcMin` reposition and resize all the
11896 items managed by this sizer. You should not need to call this directly as
11897 it is called by `Layout`.
11899 return _core_
.Sizer_RecalcSizes(*args
, **kwargs
)
11901 def CalcMin(*args
, **kwargs
):
11903 CalcMin(self) -> Size
11905 This method is where the sizer will do the actual calculation of its
11906 children's minimal sizes. You should not need to call this directly as
11907 it is called by `Layout`.
11909 return _core_
.Sizer_CalcMin(*args
, **kwargs
)
11911 def Layout(*args
, **kwargs
):
11915 This method will force the recalculation and layout of the items
11916 controlled by the sizer using the current space allocated to the
11917 sizer. Normally this is called automatically from the owning window's
11918 EVT_SIZE handler, but it is also useful to call it from user code when
11919 one of the items in a sizer change size, or items are added or
11922 return _core_
.Sizer_Layout(*args
, **kwargs
)
11924 def Fit(*args
, **kwargs
):
11926 Fit(self, Window window) -> Size
11928 Tell the sizer to resize the *window* to match the sizer's minimal
11929 size. This is commonly done in the constructor of the window itself in
11930 order to set its initial size to match the needs of the children as
11931 determined by the sizer. Returns the new size.
11933 For a top level window this is the total window size, not the client size.
11935 return _core_
.Sizer_Fit(*args
, **kwargs
)
11937 def FitInside(*args
, **kwargs
):
11939 FitInside(self, Window window)
11941 Tell the sizer to resize the *virtual size* of the *window* to match the
11942 sizer's minimal size. This will not alter the on screen size of the
11943 window, but may cause the addition/removal/alteration of scrollbars
11944 required to view the virtual area in windows which manage it.
11946 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11949 return _core_
.Sizer_FitInside(*args
, **kwargs
)
11951 def SetSizeHints(*args
, **kwargs
):
11953 SetSizeHints(self, Window window)
11955 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11956 match the sizer's minimal size. This is commonly done in the
11957 constructor of the window itself if the window is resizable (as are
11958 many dialogs under Unix and frames on probably all platforms) in order
11959 to prevent the window from being sized smaller than the minimal size
11960 required by the sizer.
11962 return _core_
.Sizer_SetSizeHints(*args
, **kwargs
)
11964 def SetVirtualSizeHints(*args
, **kwargs
):
11966 SetVirtualSizeHints(self, Window window)
11968 Tell the sizer to set the minimal size of the window virtual area to
11969 match the sizer's minimal size. For windows with managed scrollbars
11970 this will set them appropriately.
11972 :see: `wx.ScrolledWindow.SetScrollbars`
11975 return _core_
.Sizer_SetVirtualSizeHints(*args
, **kwargs
)
11977 def Clear(*args
, **kwargs
):
11979 Clear(self, bool deleteWindows=False)
11981 Clear all items from the sizer, optionally destroying the window items
11984 return _core_
.Sizer_Clear(*args
, **kwargs
)
11986 def DeleteWindows(*args
, **kwargs
):
11988 DeleteWindows(self)
11990 Destroy all windows managed by the sizer.
11992 return _core_
.Sizer_DeleteWindows(*args
, **kwargs
)
11994 def GetChildren(*args
, **kwargs
):
11996 GetChildren(self) -> list
11998 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12000 return _core_
.Sizer_GetChildren(*args
, **kwargs
)
12002 def Show(*args
, **kwargs
):
12004 Show(self, item, bool show=True, bool recursive=false) -> bool
12006 Shows or hides an item managed by the sizer. To make a sizer item
12007 disappear or reappear, use Show followed by `Layout`. The *item*
12008 parameter can be either a window, a sizer, or the zero-based index of
12009 the item. Use the recursive parameter to show or hide an item in a
12010 subsizer. Returns True if the item was found.
12012 return _core_
.Sizer_Show(*args
, **kwargs
)
12014 def IsShown(*args
, **kwargs
):
12016 IsShown(self, item)
12018 Determines if the item is currently shown. To make a sizer
12019 item disappear or reappear, use Show followed by `Layout`. The *item*
12020 parameter can be either a window, a sizer, or the zero-based index of
12023 return _core_
.Sizer_IsShown(*args
, **kwargs
)
12025 def Hide(self
, item
, recursive
=False):
12027 A convenience method for `Show` (item, False, recursive).
12029 return self
.Show(item
, False, recursive
)
12031 def ShowItems(*args
, **kwargs
):
12033 ShowItems(self, bool show)
12035 Recursively call `wx.SizerItem.Show` on all sizer items.
12037 return _core_
.Sizer_ShowItems(*args
, **kwargs
)
12039 Children
= property(GetChildren
,doc
="See `GetChildren`")
12040 ContainingWindow
= property(GetContainingWindow
,SetContainingWindow
,doc
="See `GetContainingWindow` and `SetContainingWindow`")
12041 MinSize
= property(GetMinSize
,SetMinSize
,doc
="See `GetMinSize` and `SetMinSize`")
12042 Position
= property(GetPosition
,doc
="See `GetPosition`")
12043 Size
= property(GetSize
,doc
="See `GetSize`")
12044 _core_
.Sizer_swigregister(Sizer
)
12046 class PySizer(Sizer
):
12048 wx.PySizer is a special version of `wx.Sizer` that has been
12049 instrumented to allow the C++ virtual methods to be overloaded in
12050 Python derived classes. You would derive from this class if you are
12051 wanting to implement a custom sizer in Python code. Simply implement
12052 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12055 class MySizer(wx.PySizer):
12056 def __init__(self):
12057 wx.PySizer.__init__(self)
12060 for item in self.GetChildren():
12061 # calculate the total minimum width and height needed
12062 # by all items in the sizer according to this sizer's
12063 # layout algorithm.
12065 return wx.Size(width, height)
12067 def RecalcSizes(self):
12068 # find the space allotted to this sizer
12069 pos = self.GetPosition()
12070 size = self.GetSize()
12071 for item in self.GetChildren():
12072 # Recalculate (if necessary) the position and size of
12073 # each item and then call item.SetDimension to do the
12074 # actual positioning and sizing of the items within the
12075 # space alloted to this sizer.
12077 item.SetDimension(itemPos, itemSize)
12080 When `Layout` is called it first calls `CalcMin` followed by
12081 `RecalcSizes` so you can optimize a bit by saving the results of
12082 `CalcMin` and reusing them in `RecalcSizes`.
12084 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12088 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12089 __repr__
= _swig_repr
12090 def __init__(self
, *args
, **kwargs
):
12092 __init__(self) -> PySizer
12094 Creates a wx.PySizer. Must be called from the __init__ in the derived
12097 _core_
.PySizer_swiginit(self
,_core_
.new_PySizer(*args
, **kwargs
))
12098 self
._setCallbackInfo
(self
, PySizer
);self
._setOORInfo
(self
)
12100 def _setCallbackInfo(*args
, **kwargs
):
12101 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12102 return _core_
.PySizer__setCallbackInfo(*args
, **kwargs
)
12104 _core_
.PySizer_swigregister(PySizer
)
12106 #---------------------------------------------------------------------------
12108 class BoxSizer(Sizer
):
12110 The basic idea behind a box sizer is that windows will most often be
12111 laid out in rather simple basic geometry, typically in a row or a
12112 column or nested hierarchies of either. A wx.BoxSizer will lay out
12113 its items in a simple row or column, depending on the orientation
12114 parameter passed to the constructor.
12116 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12117 __repr__
= _swig_repr
12118 def __init__(self
, *args
, **kwargs
):
12120 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12122 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12123 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12126 _core_
.BoxSizer_swiginit(self
,_core_
.new_BoxSizer(*args
, **kwargs
))
12127 self
._setOORInfo
(self
)
12129 def GetOrientation(*args
, **kwargs
):
12131 GetOrientation(self) -> int
12133 Returns the current orientation of the sizer.
12135 return _core_
.BoxSizer_GetOrientation(*args
, **kwargs
)
12137 def SetOrientation(*args
, **kwargs
):
12139 SetOrientation(self, int orient)
12141 Resets the orientation of the sizer.
12143 return _core_
.BoxSizer_SetOrientation(*args
, **kwargs
)
12145 Orientation
= property(GetOrientation
,SetOrientation
,doc
="See `GetOrientation` and `SetOrientation`")
12146 _core_
.BoxSizer_swigregister(BoxSizer
)
12148 #---------------------------------------------------------------------------
12150 class StaticBoxSizer(BoxSizer
):
12152 wx.StaticBoxSizer derives from and functions identically to the
12153 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12154 manages. Note that this static box must be created separately and
12155 passed to the sizer constructor.
12157 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12158 __repr__
= _swig_repr
12159 def __init__(self
, *args
, **kwargs
):
12161 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12163 Constructor. It takes an associated static box and the orientation
12164 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12167 _core_
.StaticBoxSizer_swiginit(self
,_core_
.new_StaticBoxSizer(*args
, **kwargs
))
12168 self
._setOORInfo
(self
)
12170 def GetStaticBox(*args
, **kwargs
):
12172 GetStaticBox(self) -> StaticBox
12174 Returns the static box associated with this sizer.
12176 return _core_
.StaticBoxSizer_GetStaticBox(*args
, **kwargs
)
12178 StaticBox
= property(GetStaticBox
,doc
="See `GetStaticBox`")
12179 _core_
.StaticBoxSizer_swigregister(StaticBoxSizer
)
12181 #---------------------------------------------------------------------------
12183 class GridSizer(Sizer
):
12185 A grid sizer is a sizer which lays out its children in a
12186 two-dimensional table with all cells having the same size. In other
12187 words, the width of each cell within the grid is the width of the
12188 widest item added to the sizer and the height of each grid cell is the
12189 height of the tallest item. An optional vertical and/or horizontal
12190 gap between items can also be specified (in pixels.)
12192 Items are placed in the cells of the grid in the order they are added,
12193 in row-major order. In other words, the first row is filled first,
12194 then the second, and so on until all items have been added. (If
12195 neccessary, additional rows will be added as items are added.) If you
12196 need to have greater control over the cells that items are placed in
12197 then use the `wx.GridBagSizer`.
12200 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12201 __repr__
= _swig_repr
12202 def __init__(self
, *args
, **kwargs
):
12204 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12206 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12207 of columns and rows in the sizer - if either of the parameters is
12208 zero, it will be calculated to from the total number of children in
12209 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12210 define extra space between all children.
12212 _core_
.GridSizer_swiginit(self
,_core_
.new_GridSizer(*args
, **kwargs
))
12213 self
._setOORInfo
(self
)
12215 def SetCols(*args
, **kwargs
):
12217 SetCols(self, int cols)
12219 Sets the number of columns in the sizer.
12221 return _core_
.GridSizer_SetCols(*args
, **kwargs
)
12223 def SetRows(*args
, **kwargs
):
12225 SetRows(self, int rows)
12227 Sets the number of rows in the sizer.
12229 return _core_
.GridSizer_SetRows(*args
, **kwargs
)
12231 def SetVGap(*args
, **kwargs
):
12233 SetVGap(self, int gap)
12235 Sets the vertical gap (in pixels) between the cells in the sizer.
12237 return _core_
.GridSizer_SetVGap(*args
, **kwargs
)
12239 def SetHGap(*args
, **kwargs
):
12241 SetHGap(self, int gap)
12243 Sets the horizontal gap (in pixels) between cells in the sizer
12245 return _core_
.GridSizer_SetHGap(*args
, **kwargs
)
12247 def GetCols(*args
, **kwargs
):
12249 GetCols(self) -> int
12251 Returns the number of columns in the sizer.
12253 return _core_
.GridSizer_GetCols(*args
, **kwargs
)
12255 def GetRows(*args
, **kwargs
):
12257 GetRows(self) -> int
12259 Returns the number of rows in the sizer.
12261 return _core_
.GridSizer_GetRows(*args
, **kwargs
)
12263 def GetVGap(*args
, **kwargs
):
12265 GetVGap(self) -> int
12267 Returns the vertical gap (in pixels) between the cells in the sizer.
12269 return _core_
.GridSizer_GetVGap(*args
, **kwargs
)
12271 def GetHGap(*args
, **kwargs
):
12273 GetHGap(self) -> int
12275 Returns the horizontal gap (in pixels) between cells in the sizer.
12277 return _core_
.GridSizer_GetHGap(*args
, **kwargs
)
12279 def CalcRowsCols(self
):
12281 CalcRowsCols() -> (rows, cols)
12283 Calculates how many rows and columns will be in the sizer based
12284 on the current number of items and also the rows, cols specified
12285 in the constructor.
12287 nitems
= len(self
.GetChildren())
12288 rows
= self
.GetRows()
12289 cols
= self
.GetCols()
12290 assert rows
!= 0 or cols
!= 0, "Grid sizer must have either rows or columns fixed"
12292 rows
= (nitems
+ cols
- 1) / cols
12294 cols
= (nitems
+ rows
- 1) / rows
12295 return (rows
, cols
)
12297 Cols
= property(GetCols
,SetCols
,doc
="See `GetCols` and `SetCols`")
12298 HGap
= property(GetHGap
,SetHGap
,doc
="See `GetHGap` and `SetHGap`")
12299 Rows
= property(GetRows
,SetRows
,doc
="See `GetRows` and `SetRows`")
12300 VGap
= property(GetVGap
,SetVGap
,doc
="See `GetVGap` and `SetVGap`")
12301 _core_
.GridSizer_swigregister(GridSizer
)
12303 #---------------------------------------------------------------------------
12305 FLEX_GROWMODE_NONE
= _core_
.FLEX_GROWMODE_NONE
12306 FLEX_GROWMODE_SPECIFIED
= _core_
.FLEX_GROWMODE_SPECIFIED
12307 FLEX_GROWMODE_ALL
= _core_
.FLEX_GROWMODE_ALL
12308 class FlexGridSizer(GridSizer
):
12310 A flex grid sizer is a sizer which lays out its children in a
12311 two-dimensional table with all table cells in one row having the same
12312 height and all cells in one column having the same width, but all
12313 rows or all columns are not necessarily the same height or width as in
12314 the `wx.GridSizer`.
12316 wx.FlexGridSizer can also size items equally in one direction but
12317 unequally ("flexibly") in the other. If the sizer is only flexible
12318 in one direction (this can be changed using `SetFlexibleDirection`), it
12319 needs to be decided how the sizer should grow in the other ("non
12320 flexible") direction in order to fill the available space. The
12321 `SetNonFlexibleGrowMode` method serves this purpose.
12325 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12326 __repr__
= _swig_repr
12327 def __init__(self
, *args
, **kwargs
):
12329 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12331 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12332 number of columns and rows in the sizer - if either of the parameters
12333 is zero, it will be calculated to from the total number of children in
12334 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12335 define extra space between all children.
12337 _core_
.FlexGridSizer_swiginit(self
,_core_
.new_FlexGridSizer(*args
, **kwargs
))
12338 self
._setOORInfo
(self
)
12340 def AddGrowableRow(*args
, **kwargs
):
12342 AddGrowableRow(self, size_t idx, int proportion=0)
12344 Specifies that row *idx* (starting from zero) should be grown if there
12345 is extra space available to the sizer.
12347 The *proportion* parameter has the same meaning as the stretch factor
12348 for the box sizers except that if all proportions are 0, then all
12349 columns are resized equally (instead of not being resized at all).
12351 return _core_
.FlexGridSizer_AddGrowableRow(*args
, **kwargs
)
12353 def RemoveGrowableRow(*args
, **kwargs
):
12355 RemoveGrowableRow(self, size_t idx)
12357 Specifies that row *idx* is no longer growable.
12359 return _core_
.FlexGridSizer_RemoveGrowableRow(*args
, **kwargs
)
12361 def AddGrowableCol(*args
, **kwargs
):
12363 AddGrowableCol(self, size_t idx, int proportion=0)
12365 Specifies that column *idx* (starting from zero) should be grown if
12366 there is extra space available to the sizer.
12368 The *proportion* parameter has the same meaning as the stretch factor
12369 for the box sizers except that if all proportions are 0, then all
12370 columns are resized equally (instead of not being resized at all).
12372 return _core_
.FlexGridSizer_AddGrowableCol(*args
, **kwargs
)
12374 def RemoveGrowableCol(*args
, **kwargs
):
12376 RemoveGrowableCol(self, size_t idx)
12378 Specifies that column *idx* is no longer growable.
12380 return _core_
.FlexGridSizer_RemoveGrowableCol(*args
, **kwargs
)
12382 def SetFlexibleDirection(*args
, **kwargs
):
12384 SetFlexibleDirection(self, int direction)
12386 Specifies whether the sizer should flexibly resize its columns, rows,
12387 or both. Argument *direction* can be one of the following values. Any
12388 other value is ignored.
12390 ============== =======================================
12391 wx.VERTICAL Rows are flexibly sized.
12392 wx.HORIZONTAL Columns are flexibly sized.
12393 wx.BOTH Both rows and columns are flexibly sized
12394 (this is the default value).
12395 ============== =======================================
12397 Note that this method does not trigger relayout.
12400 return _core_
.FlexGridSizer_SetFlexibleDirection(*args
, **kwargs
)
12402 def GetFlexibleDirection(*args
, **kwargs
):
12404 GetFlexibleDirection(self) -> int
12406 Returns a value that specifies whether the sizer
12407 flexibly resizes its columns, rows, or both (default).
12409 :see: `SetFlexibleDirection`
12411 return _core_
.FlexGridSizer_GetFlexibleDirection(*args
, **kwargs
)
12413 def SetNonFlexibleGrowMode(*args
, **kwargs
):
12415 SetNonFlexibleGrowMode(self, int mode)
12417 Specifies how the sizer should grow in the non-flexible direction if
12418 there is one (so `SetFlexibleDirection` must have been called
12419 previously). Argument *mode* can be one of the following values:
12421 ========================== =================================================
12422 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12423 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12424 `AddGrowableCol` and `AddGrowableRow`. In this
12425 case equal sizing applies to minimum sizes of
12426 columns or rows (this is the default value).
12427 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12428 the non flexible direction, whether they are
12429 growable or not in the flexbile direction.
12430 ========================== =================================================
12432 Note that this method does not trigger relayout.
12434 return _core_
.FlexGridSizer_SetNonFlexibleGrowMode(*args
, **kwargs
)
12436 def GetNonFlexibleGrowMode(*args
, **kwargs
):
12438 GetNonFlexibleGrowMode(self) -> int
12440 Returns the value that specifies how the sizer grows in the
12441 non-flexible direction if there is one.
12443 :see: `SetNonFlexibleGrowMode`
12445 return _core_
.FlexGridSizer_GetNonFlexibleGrowMode(*args
, **kwargs
)
12447 def GetRowHeights(*args
, **kwargs
):
12449 GetRowHeights(self) -> list
12451 Returns a list of integers representing the heights of each of the
12454 return _core_
.FlexGridSizer_GetRowHeights(*args
, **kwargs
)
12456 def GetColWidths(*args
, **kwargs
):
12458 GetColWidths(self) -> list
12460 Returns a list of integers representing the widths of each of the
12461 columns in the sizer.
12463 return _core_
.FlexGridSizer_GetColWidths(*args
, **kwargs
)
12465 ColWidths
= property(GetColWidths
,doc
="See `GetColWidths`")
12466 FlexibleDirection
= property(GetFlexibleDirection
,SetFlexibleDirection
,doc
="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12467 NonFlexibleGrowMode
= property(GetNonFlexibleGrowMode
,SetNonFlexibleGrowMode
,doc
="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12468 RowHeights
= property(GetRowHeights
,doc
="See `GetRowHeights`")
12469 _core_
.FlexGridSizer_swigregister(FlexGridSizer
)
12471 class StdDialogButtonSizer(BoxSizer
):
12473 A special sizer that knows how to order and position standard buttons
12474 in order to conform to the current platform's standards. You simply
12475 need to add each `wx.Button` to the sizer, and be sure to create the
12476 buttons using the standard ID's. Then call `Realize` and the sizer
12477 will take care of the rest.
12480 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12481 __repr__
= _swig_repr
12482 def __init__(self
, *args
, **kwargs
):
12483 """__init__(self) -> StdDialogButtonSizer"""
12484 _core_
.StdDialogButtonSizer_swiginit(self
,_core_
.new_StdDialogButtonSizer(*args
, **kwargs
))
12485 def AddButton(*args
, **kwargs
):
12487 AddButton(self, wxButton button)
12489 Use this to add the buttons to this sizer. Do not use the `Add`
12490 method in the base class.
12492 return _core_
.StdDialogButtonSizer_AddButton(*args
, **kwargs
)
12494 def Realize(*args
, **kwargs
):
12498 This funciton needs to be called after all the buttons have been added
12499 to the sizer. It will reorder them and position them in a platform
12502 return _core_
.StdDialogButtonSizer_Realize(*args
, **kwargs
)
12504 def SetAffirmativeButton(*args
, **kwargs
):
12505 """SetAffirmativeButton(self, wxButton button)"""
12506 return _core_
.StdDialogButtonSizer_SetAffirmativeButton(*args
, **kwargs
)
12508 def SetNegativeButton(*args
, **kwargs
):
12509 """SetNegativeButton(self, wxButton button)"""
12510 return _core_
.StdDialogButtonSizer_SetNegativeButton(*args
, **kwargs
)
12512 def SetCancelButton(*args
, **kwargs
):
12513 """SetCancelButton(self, wxButton button)"""
12514 return _core_
.StdDialogButtonSizer_SetCancelButton(*args
, **kwargs
)
12516 def GetAffirmativeButton(*args
, **kwargs
):
12517 """GetAffirmativeButton(self) -> wxButton"""
12518 return _core_
.StdDialogButtonSizer_GetAffirmativeButton(*args
, **kwargs
)
12520 def GetApplyButton(*args
, **kwargs
):
12521 """GetApplyButton(self) -> wxButton"""
12522 return _core_
.StdDialogButtonSizer_GetApplyButton(*args
, **kwargs
)
12524 def GetNegativeButton(*args
, **kwargs
):
12525 """GetNegativeButton(self) -> wxButton"""
12526 return _core_
.StdDialogButtonSizer_GetNegativeButton(*args
, **kwargs
)
12528 def GetCancelButton(*args
, **kwargs
):
12529 """GetCancelButton(self) -> wxButton"""
12530 return _core_
.StdDialogButtonSizer_GetCancelButton(*args
, **kwargs
)
12532 def GetHelpButton(*args
, **kwargs
):
12533 """GetHelpButton(self) -> wxButton"""
12534 return _core_
.StdDialogButtonSizer_GetHelpButton(*args
, **kwargs
)
12536 AffirmativeButton
= property(GetAffirmativeButton
,SetAffirmativeButton
,doc
="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12537 ApplyButton
= property(GetApplyButton
,doc
="See `GetApplyButton`")
12538 CancelButton
= property(GetCancelButton
,SetCancelButton
,doc
="See `GetCancelButton` and `SetCancelButton`")
12539 HelpButton
= property(GetHelpButton
,doc
="See `GetHelpButton`")
12540 NegativeButton
= property(GetNegativeButton
,SetNegativeButton
,doc
="See `GetNegativeButton` and `SetNegativeButton`")
12541 _core_
.StdDialogButtonSizer_swigregister(StdDialogButtonSizer
)
12543 #---------------------------------------------------------------------------
12545 class GBPosition(object):
12547 This class represents the position of an item in a virtual grid of
12548 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12549 typemaps that will automatically convert from a 2-element sequence of
12550 integers to a wx.GBPosition, so you can use the more pythonic
12551 representation of the position nearly transparently in Python code.
12553 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12554 __repr__
= _swig_repr
12555 def __init__(self
, *args
, **kwargs
):
12557 __init__(self, int row=0, int col=0) -> GBPosition
12559 This class represents the position of an item in a virtual grid of
12560 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12561 typemaps that will automatically convert from a 2-element sequence of
12562 integers to a wx.GBPosition, so you can use the more pythonic
12563 representation of the position nearly transparently in Python code.
12565 _core_
.GBPosition_swiginit(self
,_core_
.new_GBPosition(*args
, **kwargs
))
12566 __swig_destroy__
= _core_
.delete_GBPosition
12567 __del__
= lambda self
: None;
12568 def GetRow(*args
, **kwargs
):
12569 """GetRow(self) -> int"""
12570 return _core_
.GBPosition_GetRow(*args
, **kwargs
)
12572 def GetCol(*args
, **kwargs
):
12573 """GetCol(self) -> int"""
12574 return _core_
.GBPosition_GetCol(*args
, **kwargs
)
12576 def SetRow(*args
, **kwargs
):
12577 """SetRow(self, int row)"""
12578 return _core_
.GBPosition_SetRow(*args
, **kwargs
)
12580 def SetCol(*args
, **kwargs
):
12581 """SetCol(self, int col)"""
12582 return _core_
.GBPosition_SetCol(*args
, **kwargs
)
12584 def __eq__(*args
, **kwargs
):
12586 __eq__(self, PyObject other) -> bool
12588 Compare GBPosition for equality.
12590 return _core_
.GBPosition___eq__(*args
, **kwargs
)
12592 def __ne__(*args
, **kwargs
):
12594 __ne__(self, PyObject other) -> bool
12596 Compare GBPosition for inequality.
12598 return _core_
.GBPosition___ne__(*args
, **kwargs
)
12600 def Set(*args
, **kwargs
):
12601 """Set(self, int row=0, int col=0)"""
12602 return _core_
.GBPosition_Set(*args
, **kwargs
)
12604 def Get(*args
, **kwargs
):
12605 """Get(self) -> PyObject"""
12606 return _core_
.GBPosition_Get(*args
, **kwargs
)
12608 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12609 def __str__(self
): return str(self
.Get())
12610 def __repr__(self
): return 'wx.GBPosition'+str(self
.Get())
12611 def __len__(self
): return len(self
.Get())
12612 def __getitem__(self
, index
): return self
.Get()[index
]
12613 def __setitem__(self
, index
, val
):
12614 if index
== 0: self
.SetRow(val
)
12615 elif index
== 1: self
.SetCol(val
)
12616 else: raise IndexError
12617 def __nonzero__(self
): return self
.Get() != (0,0)
12618 __safe_for_unpickling__
= True
12619 def __reduce__(self
): return (wx
.GBPosition
, self
.Get())
12621 row
= property(GetRow
, SetRow
)
12622 col
= property(GetCol
, SetCol
)
12624 _core_
.GBPosition_swigregister(GBPosition
)
12626 class GBSpan(object):
12628 This class is used to hold the row and column spanning attributes of
12629 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12630 automatically convert from a 2-element sequence of integers to a
12631 wx.GBSpan, so you can use the more pythonic representation of the span
12632 nearly transparently in Python code.
12635 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12636 __repr__
= _swig_repr
12637 def __init__(self
, *args
, **kwargs
):
12639 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12641 Construct a new wxGBSpan, optionally setting the rowspan and
12642 colspan. The default is (1,1). (Meaning that the item occupies one
12643 cell in each direction.
12645 _core_
.GBSpan_swiginit(self
,_core_
.new_GBSpan(*args
, **kwargs
))
12646 __swig_destroy__
= _core_
.delete_GBSpan
12647 __del__
= lambda self
: None;
12648 def GetRowspan(*args
, **kwargs
):
12649 """GetRowspan(self) -> int"""
12650 return _core_
.GBSpan_GetRowspan(*args
, **kwargs
)
12652 def GetColspan(*args
, **kwargs
):
12653 """GetColspan(self) -> int"""
12654 return _core_
.GBSpan_GetColspan(*args
, **kwargs
)
12656 def SetRowspan(*args
, **kwargs
):
12657 """SetRowspan(self, int rowspan)"""
12658 return _core_
.GBSpan_SetRowspan(*args
, **kwargs
)
12660 def SetColspan(*args
, **kwargs
):
12661 """SetColspan(self, int colspan)"""
12662 return _core_
.GBSpan_SetColspan(*args
, **kwargs
)
12664 def __eq__(*args
, **kwargs
):
12666 __eq__(self, PyObject other) -> bool
12668 Compare wxGBSpan for equality.
12670 return _core_
.GBSpan___eq__(*args
, **kwargs
)
12672 def __ne__(*args
, **kwargs
):
12674 __ne__(self, PyObject other) -> bool
12676 Compare GBSpan for inequality.
12678 return _core_
.GBSpan___ne__(*args
, **kwargs
)
12680 def Set(*args
, **kwargs
):
12681 """Set(self, int rowspan=1, int colspan=1)"""
12682 return _core_
.GBSpan_Set(*args
, **kwargs
)
12684 def Get(*args
, **kwargs
):
12685 """Get(self) -> PyObject"""
12686 return _core_
.GBSpan_Get(*args
, **kwargs
)
12688 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
12689 def __str__(self
): return str(self
.Get())
12690 def __repr__(self
): return 'wx.GBSpan'+str(self
.Get())
12691 def __len__(self
): return len(self
.Get())
12692 def __getitem__(self
, index
): return self
.Get()[index
]
12693 def __setitem__(self
, index
, val
):
12694 if index
== 0: self
.SetRowspan(val
)
12695 elif index
== 1: self
.SetColspan(val
)
12696 else: raise IndexError
12697 def __nonzero__(self
): return self
.Get() != (0,0)
12698 __safe_for_unpickling__
= True
12699 def __reduce__(self
): return (wx
.GBSpan
, self
.Get())
12701 rowspan
= property(GetRowspan
, SetRowspan
)
12702 colspan
= property(GetColspan
, SetColspan
)
12704 _core_
.GBSpan_swigregister(GBSpan
)
12706 class GBSizerItem(SizerItem
):
12708 The wx.GBSizerItem class is used to track the additional data about
12709 items in a `wx.GridBagSizer` such as the item's position in the grid
12710 and how many rows or columns it spans.
12713 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12714 __repr__
= _swig_repr
12715 def __init__(self
, *args
, **kwargs
):
12717 __init__(self) -> GBSizerItem
12719 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12720 size will need to be set, as well as a position and span before this
12721 item can be used in a Sizer.
12723 You will probably never need to create a wx.GBSizerItem directly as they
12724 are created automatically when the sizer's Add method is called.
12726 _core_
.GBSizerItem_swiginit(self
,_core_
.new_GBSizerItem(*args
, **kwargs
))
12727 __swig_destroy__
= _core_
.delete_GBSizerItem
12728 __del__
= lambda self
: None;
12729 def GetPos(*args
, **kwargs
):
12731 GetPos(self) -> GBPosition
12733 Get the grid position of the item
12735 return _core_
.GBSizerItem_GetPos(*args
, **kwargs
)
12737 def GetPosTuple(self
): return self
.GetPos().Get()
12738 def GetSpan(*args
, **kwargs
):
12740 GetSpan(self) -> GBSpan
12742 Get the row and column spanning of the item
12744 return _core_
.GBSizerItem_GetSpan(*args
, **kwargs
)
12746 def GetSpanTuple(self
): return self
.GetSpan().Get()
12747 def SetPos(*args
, **kwargs
):
12749 SetPos(self, GBPosition pos) -> bool
12751 If the item is already a member of a sizer then first ensure that
12752 there is no other item that would intersect with this one at the new
12753 position, then set the new position. Returns True if the change is
12754 successful and after the next Layout() the item will be moved.
12756 return _core_
.GBSizerItem_SetPos(*args
, **kwargs
)
12758 def SetSpan(*args
, **kwargs
):
12760 SetSpan(self, GBSpan span) -> bool
12762 If the item is already a member of a sizer then first ensure that
12763 there is no other item that would intersect with this one with its new
12764 spanning size, then set the new spanning. Returns True if the change
12765 is successful and after the next Layout() the item will be resized.
12768 return _core_
.GBSizerItem_SetSpan(*args
, **kwargs
)
12770 def Intersects(*args
, **kwargs
):
12772 Intersects(self, GBSizerItem other) -> bool
12774 Returns True if this item and the other item instersect.
12776 return _core_
.GBSizerItem_Intersects(*args
, **kwargs
)
12778 def IntersectsPos(*args
, **kwargs
):
12780 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12782 Returns True if the given pos/span would intersect with this item.
12784 return _core_
.GBSizerItem_IntersectsPos(*args
, **kwargs
)
12786 def GetEndPos(*args
, **kwargs
):
12788 GetEndPos(self) -> GBPosition
12790 Get the row and column of the endpoint of this item.
12792 return _core_
.GBSizerItem_GetEndPos(*args
, **kwargs
)
12794 def GetGBSizer(*args
, **kwargs
):
12796 GetGBSizer(self) -> GridBagSizer
12798 Get the sizer this item is a member of.
12800 return _core_
.GBSizerItem_GetGBSizer(*args
, **kwargs
)
12802 def SetGBSizer(*args
, **kwargs
):
12804 SetGBSizer(self, GridBagSizer sizer)
12806 Set the sizer this item is a member of.
12808 return _core_
.GBSizerItem_SetGBSizer(*args
, **kwargs
)
12810 EndPos
= property(GetEndPos
,doc
="See `GetEndPos`")
12811 GBSizer
= property(GetGBSizer
,SetGBSizer
,doc
="See `GetGBSizer` and `SetGBSizer`")
12812 Pos
= property(GetPos
,SetPos
,doc
="See `GetPos` and `SetPos`")
12813 Span
= property(GetSpan
,SetSpan
,doc
="See `GetSpan` and `SetSpan`")
12814 _core_
.GBSizerItem_swigregister(GBSizerItem
)
12815 DefaultSpan
= cvar
.DefaultSpan
12817 def GBSizerItemWindow(*args
, **kwargs
):
12819 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12820 int border, PyObject userData=None) -> GBSizerItem
12822 Construct a `wx.GBSizerItem` for a window.
12824 val
= _core_
.new_GBSizerItemWindow(*args
, **kwargs
)
12827 def GBSizerItemSizer(*args
, **kwargs
):
12829 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12830 int border, PyObject userData=None) -> GBSizerItem
12832 Construct a `wx.GBSizerItem` for a sizer
12834 val
= _core_
.new_GBSizerItemSizer(*args
, **kwargs
)
12837 def GBSizerItemSpacer(*args
, **kwargs
):
12839 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12840 int flag, int border, PyObject userData=None) -> GBSizerItem
12842 Construct a `wx.GBSizerItem` for a spacer.
12844 val
= _core_
.new_GBSizerItemSpacer(*args
, **kwargs
)
12847 class GridBagSizer(FlexGridSizer
):
12849 A `wx.Sizer` that can lay out items in a virtual grid like a
12850 `wx.FlexGridSizer` but in this case explicit positioning of the items
12851 is allowed using `wx.GBPosition`, and items can optionally span more
12852 than one row and/or column using `wx.GBSpan`. The total size of the
12853 virtual grid is determined by the largest row and column that items are
12854 positioned at, adjusted for spanning.
12857 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
12858 __repr__
= _swig_repr
12859 def __init__(self
, *args
, **kwargs
):
12861 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12863 Constructor, with optional parameters to specify the gap between the
12866 _core_
.GridBagSizer_swiginit(self
,_core_
.new_GridBagSizer(*args
, **kwargs
))
12867 self
._setOORInfo
(self
)
12869 def Add(*args
, **kwargs
):
12871 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12872 int border=0, userData=None) -> wx.GBSizerItem
12874 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12875 more than one row or column as specified with *span*. The remaining
12876 args behave similarly to `wx.Sizer.Add`.
12878 Returns True if the item was successfully placed at the given cell
12879 position, False if something was already there.
12882 return _core_
.GridBagSizer_Add(*args
, **kwargs
)
12884 def AddItem(*args
, **kwargs
):
12886 Add(self, GBSizerItem item) -> wx.GBSizerItem
12888 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12889 the item was successfully placed at its given cell position, False if
12890 something was already there.
12892 return _core_
.GridBagSizer_AddItem(*args
, **kwargs
)
12894 def GetCellSize(*args
, **kwargs
):
12896 GetCellSize(self, int row, int col) -> Size
12898 Get the size of the specified cell, including hgap and
12899 vgap. Only valid after a Layout.
12901 return _core_
.GridBagSizer_GetCellSize(*args
, **kwargs
)
12903 def GetEmptyCellSize(*args
, **kwargs
):
12905 GetEmptyCellSize(self) -> Size
12907 Get the size used for cells in the grid with no item.
12909 return _core_
.GridBagSizer_GetEmptyCellSize(*args
, **kwargs
)
12911 def SetEmptyCellSize(*args
, **kwargs
):
12913 SetEmptyCellSize(self, Size sz)
12915 Set the size used for cells in the grid with no item.
12917 return _core_
.GridBagSizer_SetEmptyCellSize(*args
, **kwargs
)
12919 def GetItemPosition(*args
):
12921 GetItemPosition(self, item) -> GBPosition
12923 Get the grid position of the specified *item* where *item* is either a
12924 window or subsizer that is a member of this sizer, or a zero-based
12927 return _core_
.GridBagSizer_GetItemPosition(*args
)
12929 def SetItemPosition(*args
):
12931 SetItemPosition(self, item, GBPosition pos) -> bool
12933 Set the grid position of the specified *item* where *item* is either a
12934 window or subsizer that is a member of this sizer, or a zero-based
12935 index of an item. Returns True on success. If the move is not
12936 allowed (because an item is already there) then False is returned.
12939 return _core_
.GridBagSizer_SetItemPosition(*args
)
12941 def GetItemSpan(*args
):
12943 GetItemSpan(self, item) -> GBSpan
12945 Get the row/col spanning of the specified *item* where *item* is
12946 either a window or subsizer that is a member of this sizer, or a
12947 zero-based index of an item.
12949 return _core_
.GridBagSizer_GetItemSpan(*args
)
12951 def SetItemSpan(*args
):
12953 SetItemSpan(self, item, GBSpan span) -> bool
12955 Set the row/col spanning of the specified *item* where *item* is
12956 either a window or subsizer that is a member of this sizer, or a
12957 zero-based index of an item. Returns True on success. If the move is
12958 not allowed (because an item is already there) then False is returned.
12960 return _core_
.GridBagSizer_SetItemSpan(*args
)
12962 def FindItem(*args
):
12964 FindItem(self, item) -> GBSizerItem
12966 Find the sizer item for the given window or subsizer, returns None if
12967 not found. (non-recursive)
12969 return _core_
.GridBagSizer_FindItem(*args
)
12971 def FindItemAtPosition(*args
, **kwargs
):
12973 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12975 Return the sizer item for the given grid cell, or None if there is no
12976 item at that position. (non-recursive)
12978 return _core_
.GridBagSizer_FindItemAtPosition(*args
, **kwargs
)
12980 def FindItemAtPoint(*args
, **kwargs
):
12982 FindItemAtPoint(self, Point pt) -> GBSizerItem
12984 Return the sizer item located at the point given in *pt*, or None if
12985 there is no item at that point. The (x,y) coordinates in pt correspond
12986 to the client coordinates of the window using the sizer for
12987 layout. (non-recursive)
12989 return _core_
.GridBagSizer_FindItemAtPoint(*args
, **kwargs
)
12991 def CheckForIntersection(*args
, **kwargs
):
12993 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
12995 Look at all items and see if any intersect (or would overlap) the
12996 given *item*. Returns True if so, False if there would be no overlap.
12997 If an *excludeItem* is given then it will not be checked for
12998 intersection, for example it may be the item we are checking the
13002 return _core_
.GridBagSizer_CheckForIntersection(*args
, **kwargs
)
13004 def CheckForIntersectionPos(*args
, **kwargs
):
13006 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13008 Look at all items and see if any intersect (or would overlap) the
13009 given position and span. Returns True if so, False if there would be
13010 no overlap. If an *excludeItem* is given then it will not be checked
13011 for intersection, for example it may be the item we are checking the
13014 return _core_
.GridBagSizer_CheckForIntersectionPos(*args
, **kwargs
)
13016 _core_
.GridBagSizer_swigregister(GridBagSizer
)
13018 #---------------------------------------------------------------------------
13022 Right
= _core_
.Right
13023 Bottom
= _core_
.Bottom
13024 Width
= _core_
.Width
13025 Height
= _core_
.Height
13026 Centre
= _core_
.Centre
13027 Center
= _core_
.Center
13028 CentreX
= _core_
.CentreX
13029 CentreY
= _core_
.CentreY
13030 Unconstrained
= _core_
.Unconstrained
13032 PercentOf
= _core_
.PercentOf
13033 Above
= _core_
.Above
13034 Below
= _core_
.Below
13035 LeftOf
= _core_
.LeftOf
13036 RightOf
= _core_
.RightOf
13037 SameAs
= _core_
.SameAs
13038 Absolute
= _core_
.Absolute
13039 class IndividualLayoutConstraint(Object
):
13041 Objects of this class are stored in the `wx.LayoutConstraints` class as
13042 one of eight possible constraints that a window can be involved in.
13043 You will never need to create an instance of
13044 wx.IndividualLayoutConstraint, rather you should create a
13045 `wx.LayoutConstraints` instance and use the individual contstraints
13048 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13049 def __init__(self
): raise AttributeError, "No constructor defined"
13050 __repr__
= _swig_repr
13051 def Set(*args
, **kwargs
):
13053 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13055 Sets the properties of the constraint. Normally called by one of the
13056 convenience functions such as Above, RightOf, SameAs.
13058 return _core_
.IndividualLayoutConstraint_Set(*args
, **kwargs
)
13060 def LeftOf(*args
, **kwargs
):
13062 LeftOf(self, Window sibling, int marg=0)
13064 Constrains this edge to be to the left of the given window, with an
13065 optional margin. Implicitly, this is relative to the left edge of the
13068 return _core_
.IndividualLayoutConstraint_LeftOf(*args
, **kwargs
)
13070 def RightOf(*args
, **kwargs
):
13072 RightOf(self, Window sibling, int marg=0)
13074 Constrains this edge to be to the right of the given window, with an
13075 optional margin. Implicitly, this is relative to the right edge of the
13078 return _core_
.IndividualLayoutConstraint_RightOf(*args
, **kwargs
)
13080 def Above(*args
, **kwargs
):
13082 Above(self, Window sibling, int marg=0)
13084 Constrains this edge to be above the given window, with an optional
13085 margin. Implicitly, this is relative to the top edge of the other
13088 return _core_
.IndividualLayoutConstraint_Above(*args
, **kwargs
)
13090 def Below(*args
, **kwargs
):
13092 Below(self, Window sibling, int marg=0)
13094 Constrains this edge to be below the given window, with an optional
13095 margin. Implicitly, this is relative to the bottom edge of the other
13098 return _core_
.IndividualLayoutConstraint_Below(*args
, **kwargs
)
13100 def SameAs(*args
, **kwargs
):
13102 SameAs(self, Window otherW, int edge, int marg=0)
13104 Constrains this edge or dimension to be to the same as the edge of the
13105 given window, with an optional margin.
13107 return _core_
.IndividualLayoutConstraint_SameAs(*args
, **kwargs
)
13109 def PercentOf(*args
, **kwargs
):
13111 PercentOf(self, Window otherW, int wh, int per)
13113 Constrains this edge or dimension to be to a percentage of the given
13114 window, with an optional margin.
13116 return _core_
.IndividualLayoutConstraint_PercentOf(*args
, **kwargs
)
13118 def Absolute(*args
, **kwargs
):
13120 Absolute(self, int val)
13122 Constrains this edge or dimension to be the given absolute value.
13124 return _core_
.IndividualLayoutConstraint_Absolute(*args
, **kwargs
)
13126 def Unconstrained(*args
, **kwargs
):
13128 Unconstrained(self)
13130 Sets this edge or dimension to be unconstrained, that is, dependent on
13131 other edges and dimensions from which this value can be deduced.
13133 return _core_
.IndividualLayoutConstraint_Unconstrained(*args
, **kwargs
)
13135 def AsIs(*args
, **kwargs
):
13139 Sets this edge or constraint to be whatever the window's value is at
13140 the moment. If either of the width and height constraints are *as is*,
13141 the window will not be resized, but moved instead. This is important
13142 when considering panel items which are intended to have a default
13143 size, such as a button, which may take its size from the size of the
13146 return _core_
.IndividualLayoutConstraint_AsIs(*args
, **kwargs
)
13148 def GetOtherWindow(*args
, **kwargs
):
13149 """GetOtherWindow(self) -> Window"""
13150 return _core_
.IndividualLayoutConstraint_GetOtherWindow(*args
, **kwargs
)
13152 def GetMyEdge(*args
, **kwargs
):
13153 """GetMyEdge(self) -> int"""
13154 return _core_
.IndividualLayoutConstraint_GetMyEdge(*args
, **kwargs
)
13156 def SetEdge(*args
, **kwargs
):
13157 """SetEdge(self, int which)"""
13158 return _core_
.IndividualLayoutConstraint_SetEdge(*args
, **kwargs
)
13160 def SetValue(*args
, **kwargs
):
13161 """SetValue(self, int v)"""
13162 return _core_
.IndividualLayoutConstraint_SetValue(*args
, **kwargs
)
13164 def GetMargin(*args
, **kwargs
):
13165 """GetMargin(self) -> int"""
13166 return _core_
.IndividualLayoutConstraint_GetMargin(*args
, **kwargs
)
13168 def SetMargin(*args
, **kwargs
):
13169 """SetMargin(self, int m)"""
13170 return _core_
.IndividualLayoutConstraint_SetMargin(*args
, **kwargs
)
13172 def GetValue(*args
, **kwargs
):
13173 """GetValue(self) -> int"""
13174 return _core_
.IndividualLayoutConstraint_GetValue(*args
, **kwargs
)
13176 def GetPercent(*args
, **kwargs
):
13177 """GetPercent(self) -> int"""
13178 return _core_
.IndividualLayoutConstraint_GetPercent(*args
, **kwargs
)
13180 def GetOtherEdge(*args
, **kwargs
):
13181 """GetOtherEdge(self) -> int"""
13182 return _core_
.IndividualLayoutConstraint_GetOtherEdge(*args
, **kwargs
)
13184 def GetDone(*args
, **kwargs
):
13185 """GetDone(self) -> bool"""
13186 return _core_
.IndividualLayoutConstraint_GetDone(*args
, **kwargs
)
13188 def SetDone(*args
, **kwargs
):
13189 """SetDone(self, bool d)"""
13190 return _core_
.IndividualLayoutConstraint_SetDone(*args
, **kwargs
)
13192 def GetRelationship(*args
, **kwargs
):
13193 """GetRelationship(self) -> int"""
13194 return _core_
.IndividualLayoutConstraint_GetRelationship(*args
, **kwargs
)
13196 def SetRelationship(*args
, **kwargs
):
13197 """SetRelationship(self, int r)"""
13198 return _core_
.IndividualLayoutConstraint_SetRelationship(*args
, **kwargs
)
13200 def ResetIfWin(*args
, **kwargs
):
13202 ResetIfWin(self, Window otherW) -> bool
13204 Reset constraint if it mentions otherWin
13206 return _core_
.IndividualLayoutConstraint_ResetIfWin(*args
, **kwargs
)
13208 def SatisfyConstraint(*args
, **kwargs
):
13210 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13212 Try to satisfy constraint
13214 return _core_
.IndividualLayoutConstraint_SatisfyConstraint(*args
, **kwargs
)
13216 def GetEdge(*args
, **kwargs
):
13218 GetEdge(self, int which, Window thisWin, Window other) -> int
13220 Get the value of this edge or dimension, or if this
13221 is not determinable, -1.
13223 return _core_
.IndividualLayoutConstraint_GetEdge(*args
, **kwargs
)
13225 Done
= property(GetDone
,SetDone
,doc
="See `GetDone` and `SetDone`")
13226 Margin
= property(GetMargin
,SetMargin
,doc
="See `GetMargin` and `SetMargin`")
13227 MyEdge
= property(GetMyEdge
,doc
="See `GetMyEdge`")
13228 OtherEdge
= property(GetOtherEdge
,doc
="See `GetOtherEdge`")
13229 OtherWindow
= property(GetOtherWindow
,doc
="See `GetOtherWindow`")
13230 Percent
= property(GetPercent
,doc
="See `GetPercent`")
13231 Relationship
= property(GetRelationship
,SetRelationship
,doc
="See `GetRelationship` and `SetRelationship`")
13232 Value
= property(GetValue
,SetValue
,doc
="See `GetValue` and `SetValue`")
13233 _core_
.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint
)
13235 class LayoutConstraints(Object
):
13237 **Note:** constraints are now deprecated and you should use sizers
13240 Objects of this class can be associated with a window to define its
13241 layout constraints, with respect to siblings or its parent.
13243 The class consists of the following eight constraints of class
13244 wx.IndividualLayoutConstraint, some or all of which should be accessed
13245 directly to set the appropriate constraints.
13247 * left: represents the left hand edge of the window
13248 * right: represents the right hand edge of the window
13249 * top: represents the top edge of the window
13250 * bottom: represents the bottom edge of the window
13251 * width: represents the width of the window
13252 * height: represents the height of the window
13253 * centreX: represents the horizontal centre point of the window
13254 * centreY: represents the vertical centre point of the window
13256 Most constraints are initially set to have the relationship
13257 wxUnconstrained, which means that their values should be calculated by
13258 looking at known constraints. The exceptions are width and height,
13259 which are set to wxAsIs to ensure that if the user does not specify a
13260 constraint, the existing width and height will be used, to be
13261 compatible with panel items which often have take a default size. If
13262 the constraint is ``wx.AsIs``, the dimension will not be changed.
13264 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13267 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
13268 __repr__
= _swig_repr
13269 left
= property(_core_
.LayoutConstraints_left_get
)
13270 top
= property(_core_
.LayoutConstraints_top_get
)
13271 right
= property(_core_
.LayoutConstraints_right_get
)
13272 bottom
= property(_core_
.LayoutConstraints_bottom_get
)
13273 width
= property(_core_
.LayoutConstraints_width_get
)
13274 height
= property(_core_
.LayoutConstraints_height_get
)
13275 centreX
= property(_core_
.LayoutConstraints_centreX_get
)
13276 centreY
= property(_core_
.LayoutConstraints_centreY_get
)
13277 def __init__(self
, *args
, **kwargs
):
13278 """__init__(self) -> LayoutConstraints"""
13279 _core_
.LayoutConstraints_swiginit(self
,_core_
.new_LayoutConstraints(*args
, **kwargs
))
13280 __swig_destroy__
= _core_
.delete_LayoutConstraints
13281 __del__
= lambda self
: None;
13282 def SatisfyConstraints(*args
, **kwargs
):
13283 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13284 return _core_
.LayoutConstraints_SatisfyConstraints(*args
, **kwargs
)
13286 def AreSatisfied(*args
, **kwargs
):
13287 """AreSatisfied(self) -> bool"""
13288 return _core_
.LayoutConstraints_AreSatisfied(*args
, **kwargs
)
13290 _core_
.LayoutConstraints_swigregister(LayoutConstraints
)
13292 #----------------------------------------------------------------------------
13294 # Use Python's bool constants if available, make some if not
13298 __builtins__
.True = 1==1
13299 __builtins__
.False = 1==0
13300 def bool(value
): return not not value
13301 __builtins__
.bool = bool
13305 # workarounds for bad wxRTTI names
13306 __wxPyPtrTypeMap
['wxGauge95'] = 'wxGauge'
13307 __wxPyPtrTypeMap
['wxSlider95'] = 'wxSlider'
13308 __wxPyPtrTypeMap
['wxStatusBar95'] = 'wxStatusBar'
13311 #----------------------------------------------------------------------------
13312 # Load version numbers from __version__... Ensure that major and minor
13313 # versions are the same for both wxPython and wxWidgets.
13315 from __version__
import *
13316 __version__
= VERSION_STRING
13318 assert MAJOR_VERSION
== _core_
.MAJOR_VERSION
, "wxPython/wxWidgets version mismatch"
13319 assert MINOR_VERSION
== _core_
.MINOR_VERSION
, "wxPython/wxWidgets version mismatch"
13320 if RELEASE_VERSION
!= _core_
.RELEASE_VERSION
:
13322 warnings
.warn("wxPython/wxWidgets release number mismatch")
13324 #----------------------------------------------------------------------------
13326 # Set wxPython's default string<-->unicode conversion encoding from
13327 # the locale, but only if Python's default hasn't been changed. (We
13328 # assume that if the user has customized it already then that is the
13329 # encoding we need to use as well.)
13331 # The encoding selected here is used when string or unicode objects
13332 # need to be converted in order to pass them to wxWidgets. Please be
13333 # aware that the default encoding within the same locale may be
13334 # slightly different on different platforms. For example, please see
13335 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13336 # between the common latin/roman encodings.
13338 default
= _sys
.getdefaultencoding()
13339 if default
== 'ascii':
13343 default
= locale
.getdefaultlocale()[1]
13344 codecs
.lookup(default
)
13345 except (ValueError, LookupError, TypeError):
13346 default
= _sys
.getdefaultencoding()
13350 wx
.SetDefaultPyEncoding(default
)
13353 #----------------------------------------------------------------------------
13355 class PyDeadObjectError(AttributeError):
13358 class _wxPyDeadObject(object):
13360 Instances of wx objects that are OOR capable will have their __class__
13361 changed to this class when the C++ object is deleted. This should help
13362 prevent crashes due to referencing a bogus C++ pointer.
13364 reprStr
= "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13365 attrStr
= "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13367 def __repr__(self
):
13368 if not hasattr(self
, "_name"):
13369 self
._name
= "[unknown]"
13370 return self
.reprStr
% self
._name
13372 def __getattr__(self
, *args
):
13373 if not hasattr(self
, "_name"):
13374 self
._name
= "[unknown]"
13375 raise PyDeadObjectError(self
.attrStr
% self
._name
)
13377 def __nonzero__(self
):
13382 class PyUnbornObjectError(AttributeError):
13385 class _wxPyUnbornObject(object):
13387 Some stock objects are created when the wx._core module is
13388 imported, but their C++ instance is not created until the wx.App
13389 object is created and initialized. These object instances will
13390 temporarily have their __class__ changed to this class so an
13391 exception will be raised if they are used before the C++ instance
13395 reprStr
= "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13396 attrStr
= "The C++ part of this object has not been initialized, attribute access not allowed."
13398 def __repr__(self
):
13399 #if not hasattr(self, "_name"):
13400 # self._name = "[unknown]"
13401 return self
.reprStr
#% self._name
13403 def __getattr__(self
, *args
):
13404 #if not hasattr(self, "_name"):
13405 # self._name = "[unknown]"
13406 raise PyUnbornObjectError(self
.attrStr
) # % self._name )
13408 def __nonzero__(self
):
13412 #----------------------------------------------------------------------------
13414 def CallAfter(callable, *args
, **kw
):
13416 Call the specified function after the current and pending event
13417 handlers have been completed. This is also good for making GUI
13418 method calls from non-GUI threads. Any extra positional or
13419 keyword args are passed on to the callable when it is called.
13421 :see: `wx.FutureCall`
13424 assert app
is not None, 'No wx.App created yet'
13426 if not hasattr(app
, "_CallAfterId"):
13427 app
._CallAfterId
= wx
.NewEventType()
13428 app
.Connect(-1, -1, app
._CallAfterId
,
13429 lambda event
: event
.callable(*event
.args
, **event
.kw
) )
13431 evt
.SetEventType(app
._CallAfterId
)
13432 evt
.callable = callable
13435 wx
.PostEvent(app
, evt
)
13437 #----------------------------------------------------------------------------
13442 A convenience class for `wx.Timer`, that calls the given callable
13443 object once after the given amount of milliseconds, passing any
13444 positional or keyword args. The return value of the callable is
13445 availbale after it has been run with the `GetResult` method.
13447 If you don't need to get the return value or restart the timer
13448 then there is no need to hold a reference to this object. It will
13449 hold a reference to itself while the timer is running (the timer
13450 has a reference to self.Notify) but the cycle will be broken when
13451 the timer completes, automatically cleaning up the wx.FutureCall
13454 :see: `wx.CallAfter`
13456 def __init__(self
, millis
, callable, *args
, **kwargs
):
13457 self
.millis
= millis
13458 self
.callable = callable
13459 self
.SetArgs(*args
, **kwargs
)
13461 self
.running
= False
13462 self
.hasRun
= False
13471 def Start(self
, millis
=None, *args
, **kwargs
):
13473 (Re)start the timer
13475 self
.hasRun
= False
13476 if millis
is not None:
13477 self
.millis
= millis
13479 self
.SetArgs(*args
, **kwargs
)
13481 self
.timer
= wx
.PyTimer(self
.Notify
)
13482 self
.timer
.Start(self
.millis
, wx
.TIMER_ONE_SHOT
)
13483 self
.running
= True
13489 Stop and destroy the timer.
13491 if self
.timer
is not None:
13496 def GetInterval(self
):
13497 if self
.timer
is not None:
13498 return self
.timer
.GetInterval()
13503 def IsRunning(self
):
13504 return self
.timer
is not None and self
.timer
.IsRunning()
13507 def SetArgs(self
, *args
, **kwargs
):
13509 (Re)set the args passed to the callable object. This is
13510 useful in conjunction with Restart if you want to schedule a
13511 new call to the same callable object but with different
13515 self
.kwargs
= kwargs
13521 def GetResult(self
):
13526 The timer has expired so call the callable.
13528 if self
.callable and getattr(self
.callable, 'im_self', True):
13530 self
.running
= False
13531 self
.result
= self
.callable(*self
.args
, **self
.kwargs
)
13533 if not self
.running
:
13534 # if it wasn't restarted, then cleanup
13535 wx
.CallAfter(self
.Stop
)
13537 Interval
= property(GetInterval
)
13538 Result
= property(GetResult
)
13541 #----------------------------------------------------------------------------
13542 # Control which items in this module should be documented by epydoc.
13543 # We allow only classes and functions, which will help reduce the size
13544 # of the docs by filtering out the zillions of constants, EVT objects,
13545 # and etc that don't make much sense by themselves, but are instead
13546 # documented (or will be) as part of the classes/functions/methods
13547 # where they should be used.
13551 A filter for epydoc that only allows non-Ptr classes and
13552 functions, in order to reduce the clutter in the API docs.
13554 def __init__(self
, globals):
13555 self
._globals
= globals
13557 def __call__(self
, name
):
13559 obj
= self
._globals
.get(name
, None)
13561 # only document classes and function
13562 if type(obj
) not in [type, types
.ClassType
, types
.FunctionType
, types
.BuiltinFunctionType
]:
13565 # skip other things that are private or will be documented as part of somethign else
13566 if name
.startswith('_') or name
.startswith('EVT') or name
.endswith('_swigregister') or name
.endswith('Ptr') :
13569 # skip functions that are duplicates of static functions in a class
13570 if name
.find('_') != -1:
13571 cls
= self
._globals
.get(name
.split('_')[0], None)
13572 methname
= name
.split('_')[1]
13573 if hasattr(cls
, methname
) and type(getattr(cls
, methname
)) is types
.FunctionType
:
13578 #----------------------------------------------------------------------------
13579 #----------------------------------------------------------------------------
13581 # Import other modules in this package that should show up in the
13582 # "core" wx namespace
13584 from _windows
import *
13585 from _controls
import *
13586 from _misc
import *
13588 #----------------------------------------------------------------------------
13589 #----------------------------------------------------------------------------