]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/mac/_core.py
16eddcca17bca31a971eefd7c0ee7e0a4e7659dd
[wxWidgets.git] / wxPython / src / mac / _core.py
1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
3
4 import _core_
5 import new
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)
9 if (name == "this"):
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
12 return
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
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20 def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
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
28
29 def _swig_repr(self):
30 try: strthis = "proxy of " + self.this.__repr__()
31 except: strthis = ""
32 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
33
34 import types
35 try:
36 _object = types.ObjectType
37 _newclass = 1
38 except AttributeError:
39 class _object : pass
40 _newclass = 0
41 del types
42
43
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"):
48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
54 #// Give a reference to the dictionary of this module to the C++ extension
55 #// code.
56 _core_._wxPySetDictionary(vars())
57
58 #// A little trick to make 'wx' be a reference to this module so wx.Names can
59 #// be used here.
60 import sys as _sys
61 wx = _sys.modules[__name__]
62
63
64 #----------------------------------------------------------------------------
65
66 def _deprecated(callable, msg=None):
67 """
68 Create a wrapper function that will raise a DeprecationWarning
69 before calling the callable.
70 """
71 if msg is None:
72 msg = "%s is deprecated" % callable
73 def deprecatedWrapper(*args, **kwargs):
74 import warnings
75 warnings.warn(msg, DeprecationWarning, stacklevel=2)
76 return callable(*args, **kwargs)
77 deprecatedWrapper.__doc__ = msg
78 return deprecatedWrapper
79
80
81 #----------------------------------------------------------------------------
82
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
147 OK = _core_.OK
148 YES_NO = _core_.YES_NO
149 CANCEL = _core_.CANCEL
150 YES = _core_.YES
151 NO = _core_.NO
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
165 RESET = _core_.RESET
166 HELP = _core_.HELP
167 MORE = _core_.MORE
168 SETUP = _core_.SETUP
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_PREVIEW = _core_.ID_PREVIEW
198 ID_ABOUT = _core_.ID_ABOUT
199 ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
200 ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
201 ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
202 ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
203 ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
204 ID_PREFERENCES = _core_.ID_PREFERENCES
205 ID_CUT = _core_.ID_CUT
206 ID_COPY = _core_.ID_COPY
207 ID_PASTE = _core_.ID_PASTE
208 ID_CLEAR = _core_.ID_CLEAR
209 ID_FIND = _core_.ID_FIND
210 ID_DUPLICATE = _core_.ID_DUPLICATE
211 ID_SELECTALL = _core_.ID_SELECTALL
212 ID_DELETE = _core_.ID_DELETE
213 ID_REPLACE = _core_.ID_REPLACE
214 ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
215 ID_PROPERTIES = _core_.ID_PROPERTIES
216 ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
217 ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
218 ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
219 ID_VIEW_LIST = _core_.ID_VIEW_LIST
220 ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
221 ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
222 ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
223 ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
224 ID_FILE1 = _core_.ID_FILE1
225 ID_FILE2 = _core_.ID_FILE2
226 ID_FILE3 = _core_.ID_FILE3
227 ID_FILE4 = _core_.ID_FILE4
228 ID_FILE5 = _core_.ID_FILE5
229 ID_FILE6 = _core_.ID_FILE6
230 ID_FILE7 = _core_.ID_FILE7
231 ID_FILE8 = _core_.ID_FILE8
232 ID_FILE9 = _core_.ID_FILE9
233 ID_OK = _core_.ID_OK
234 ID_CANCEL = _core_.ID_CANCEL
235 ID_APPLY = _core_.ID_APPLY
236 ID_YES = _core_.ID_YES
237 ID_NO = _core_.ID_NO
238 ID_STATIC = _core_.ID_STATIC
239 ID_FORWARD = _core_.ID_FORWARD
240 ID_BACKWARD = _core_.ID_BACKWARD
241 ID_DEFAULT = _core_.ID_DEFAULT
242 ID_MORE = _core_.ID_MORE
243 ID_SETUP = _core_.ID_SETUP
244 ID_RESET = _core_.ID_RESET
245 ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
246 ID_YESTOALL = _core_.ID_YESTOALL
247 ID_NOTOALL = _core_.ID_NOTOALL
248 ID_ABORT = _core_.ID_ABORT
249 ID_RETRY = _core_.ID_RETRY
250 ID_IGNORE = _core_.ID_IGNORE
251 ID_ADD = _core_.ID_ADD
252 ID_REMOVE = _core_.ID_REMOVE
253 ID_UP = _core_.ID_UP
254 ID_DOWN = _core_.ID_DOWN
255 ID_HOME = _core_.ID_HOME
256 ID_REFRESH = _core_.ID_REFRESH
257 ID_STOP = _core_.ID_STOP
258 ID_INDEX = _core_.ID_INDEX
259 ID_BOLD = _core_.ID_BOLD
260 ID_ITALIC = _core_.ID_ITALIC
261 ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
262 ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
263 ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
264 ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
265 ID_UNDERLINE = _core_.ID_UNDERLINE
266 ID_INDENT = _core_.ID_INDENT
267 ID_UNINDENT = _core_.ID_UNINDENT
268 ID_ZOOM_100 = _core_.ID_ZOOM_100
269 ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
270 ID_ZOOM_IN = _core_.ID_ZOOM_IN
271 ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
272 ID_UNDELETE = _core_.ID_UNDELETE
273 ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
274 ID_HIGHEST = _core_.ID_HIGHEST
275 ACCEL_ALT = _core_.ACCEL_ALT
276 ACCEL_CTRL = _core_.ACCEL_CTRL
277 ACCEL_SHIFT = _core_.ACCEL_SHIFT
278 ACCEL_NORMAL = _core_.ACCEL_NORMAL
279 PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
280 PD_APP_MODAL = _core_.PD_APP_MODAL
281 PD_CAN_ABORT = _core_.PD_CAN_ABORT
282 PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
283 PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
284 PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
285 PD_SMOOTH = _core_.PD_SMOOTH
286 PD_CAN_SKIP = _core_.PD_CAN_SKIP
287 MENU_TEAROFF = _core_.MENU_TEAROFF
288 MB_DOCKABLE = _core_.MB_DOCKABLE
289 NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
290 FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
291 LI_HORIZONTAL = _core_.LI_HORIZONTAL
292 LI_VERTICAL = _core_.LI_VERTICAL
293 WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
294 WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
295 WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
296 WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
297 WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
298 WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
299 MM_TEXT = _core_.MM_TEXT
300 MM_LOMETRIC = _core_.MM_LOMETRIC
301 MM_HIMETRIC = _core_.MM_HIMETRIC
302 MM_LOENGLISH = _core_.MM_LOENGLISH
303 MM_HIENGLISH = _core_.MM_HIENGLISH
304 MM_TWIPS = _core_.MM_TWIPS
305 MM_ISOTROPIC = _core_.MM_ISOTROPIC
306 MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
307 MM_POINTS = _core_.MM_POINTS
308 MM_METRIC = _core_.MM_METRIC
309 CENTRE = _core_.CENTRE
310 CENTER = _core_.CENTER
311 HORIZONTAL = _core_.HORIZONTAL
312 VERTICAL = _core_.VERTICAL
313 BOTH = _core_.BOTH
314 LEFT = _core_.LEFT
315 RIGHT = _core_.RIGHT
316 UP = _core_.UP
317 DOWN = _core_.DOWN
318 TOP = _core_.TOP
319 BOTTOM = _core_.BOTTOM
320 NORTH = _core_.NORTH
321 SOUTH = _core_.SOUTH
322 WEST = _core_.WEST
323 EAST = _core_.EAST
324 ALL = _core_.ALL
325 ALIGN_NOT = _core_.ALIGN_NOT
326 ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
327 ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
328 ALIGN_LEFT = _core_.ALIGN_LEFT
329 ALIGN_TOP = _core_.ALIGN_TOP
330 ALIGN_RIGHT = _core_.ALIGN_RIGHT
331 ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
332 ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
333 ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
334 ALIGN_CENTER = _core_.ALIGN_CENTER
335 ALIGN_CENTRE = _core_.ALIGN_CENTRE
336 ALIGN_MASK = _core_.ALIGN_MASK
337 STRETCH_NOT = _core_.STRETCH_NOT
338 SHRINK = _core_.SHRINK
339 GROW = _core_.GROW
340 EXPAND = _core_.EXPAND
341 SHAPED = _core_.SHAPED
342 FIXED_MINSIZE = _core_.FIXED_MINSIZE
343 TILE = _core_.TILE
344 ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
345 BORDER_DEFAULT = _core_.BORDER_DEFAULT
346 BORDER_NONE = _core_.BORDER_NONE
347 BORDER_STATIC = _core_.BORDER_STATIC
348 BORDER_SIMPLE = _core_.BORDER_SIMPLE
349 BORDER_RAISED = _core_.BORDER_RAISED
350 BORDER_SUNKEN = _core_.BORDER_SUNKEN
351 BORDER_DOUBLE = _core_.BORDER_DOUBLE
352 BORDER_MASK = _core_.BORDER_MASK
353 BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
354 BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
355 BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
356 DEFAULT = _core_.DEFAULT
357 DECORATIVE = _core_.DECORATIVE
358 ROMAN = _core_.ROMAN
359 SCRIPT = _core_.SCRIPT
360 SWISS = _core_.SWISS
361 MODERN = _core_.MODERN
362 TELETYPE = _core_.TELETYPE
363 VARIABLE = _core_.VARIABLE
364 FIXED = _core_.FIXED
365 NORMAL = _core_.NORMAL
366 LIGHT = _core_.LIGHT
367 BOLD = _core_.BOLD
368 ITALIC = _core_.ITALIC
369 SLANT = _core_.SLANT
370 SOLID = _core_.SOLID
371 DOT = _core_.DOT
372 LONG_DASH = _core_.LONG_DASH
373 SHORT_DASH = _core_.SHORT_DASH
374 DOT_DASH = _core_.DOT_DASH
375 USER_DASH = _core_.USER_DASH
376 TRANSPARENT = _core_.TRANSPARENT
377 STIPPLE = _core_.STIPPLE
378 STIPPLE_MASK = _core_.STIPPLE_MASK
379 STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
380 BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
381 CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
382 FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
383 CROSS_HATCH = _core_.CROSS_HATCH
384 HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
385 VERTICAL_HATCH = _core_.VERTICAL_HATCH
386 JOIN_BEVEL = _core_.JOIN_BEVEL
387 JOIN_MITER = _core_.JOIN_MITER
388 JOIN_ROUND = _core_.JOIN_ROUND
389 CAP_ROUND = _core_.CAP_ROUND
390 CAP_PROJECTING = _core_.CAP_PROJECTING
391 CAP_BUTT = _core_.CAP_BUTT
392 CLEAR = _core_.CLEAR
393 XOR = _core_.XOR
394 INVERT = _core_.INVERT
395 OR_REVERSE = _core_.OR_REVERSE
396 AND_REVERSE = _core_.AND_REVERSE
397 COPY = _core_.COPY
398 AND = _core_.AND
399 AND_INVERT = _core_.AND_INVERT
400 NO_OP = _core_.NO_OP
401 NOR = _core_.NOR
402 EQUIV = _core_.EQUIV
403 SRC_INVERT = _core_.SRC_INVERT
404 OR_INVERT = _core_.OR_INVERT
405 NAND = _core_.NAND
406 OR = _core_.OR
407 SET = _core_.SET
408 WXK_BACK = _core_.WXK_BACK
409 WXK_TAB = _core_.WXK_TAB
410 WXK_RETURN = _core_.WXK_RETURN
411 WXK_ESCAPE = _core_.WXK_ESCAPE
412 WXK_SPACE = _core_.WXK_SPACE
413 WXK_DELETE = _core_.WXK_DELETE
414 WXK_START = _core_.WXK_START
415 WXK_LBUTTON = _core_.WXK_LBUTTON
416 WXK_RBUTTON = _core_.WXK_RBUTTON
417 WXK_CANCEL = _core_.WXK_CANCEL
418 WXK_MBUTTON = _core_.WXK_MBUTTON
419 WXK_CLEAR = _core_.WXK_CLEAR
420 WXK_SHIFT = _core_.WXK_SHIFT
421 WXK_ALT = _core_.WXK_ALT
422 WXK_CONTROL = _core_.WXK_CONTROL
423 WXK_MENU = _core_.WXK_MENU
424 WXK_PAUSE = _core_.WXK_PAUSE
425 WXK_CAPITAL = _core_.WXK_CAPITAL
426 WXK_PRIOR = _core_.WXK_PRIOR
427 WXK_NEXT = _core_.WXK_NEXT
428 WXK_END = _core_.WXK_END
429 WXK_HOME = _core_.WXK_HOME
430 WXK_LEFT = _core_.WXK_LEFT
431 WXK_UP = _core_.WXK_UP
432 WXK_RIGHT = _core_.WXK_RIGHT
433 WXK_DOWN = _core_.WXK_DOWN
434 WXK_SELECT = _core_.WXK_SELECT
435 WXK_PRINT = _core_.WXK_PRINT
436 WXK_EXECUTE = _core_.WXK_EXECUTE
437 WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
438 WXK_INSERT = _core_.WXK_INSERT
439 WXK_HELP = _core_.WXK_HELP
440 WXK_NUMPAD0 = _core_.WXK_NUMPAD0
441 WXK_NUMPAD1 = _core_.WXK_NUMPAD1
442 WXK_NUMPAD2 = _core_.WXK_NUMPAD2
443 WXK_NUMPAD3 = _core_.WXK_NUMPAD3
444 WXK_NUMPAD4 = _core_.WXK_NUMPAD4
445 WXK_NUMPAD5 = _core_.WXK_NUMPAD5
446 WXK_NUMPAD6 = _core_.WXK_NUMPAD6
447 WXK_NUMPAD7 = _core_.WXK_NUMPAD7
448 WXK_NUMPAD8 = _core_.WXK_NUMPAD8
449 WXK_NUMPAD9 = _core_.WXK_NUMPAD9
450 WXK_MULTIPLY = _core_.WXK_MULTIPLY
451 WXK_ADD = _core_.WXK_ADD
452 WXK_SEPARATOR = _core_.WXK_SEPARATOR
453 WXK_SUBTRACT = _core_.WXK_SUBTRACT
454 WXK_DECIMAL = _core_.WXK_DECIMAL
455 WXK_DIVIDE = _core_.WXK_DIVIDE
456 WXK_F1 = _core_.WXK_F1
457 WXK_F2 = _core_.WXK_F2
458 WXK_F3 = _core_.WXK_F3
459 WXK_F4 = _core_.WXK_F4
460 WXK_F5 = _core_.WXK_F5
461 WXK_F6 = _core_.WXK_F6
462 WXK_F7 = _core_.WXK_F7
463 WXK_F8 = _core_.WXK_F8
464 WXK_F9 = _core_.WXK_F9
465 WXK_F10 = _core_.WXK_F10
466 WXK_F11 = _core_.WXK_F11
467 WXK_F12 = _core_.WXK_F12
468 WXK_F13 = _core_.WXK_F13
469 WXK_F14 = _core_.WXK_F14
470 WXK_F15 = _core_.WXK_F15
471 WXK_F16 = _core_.WXK_F16
472 WXK_F17 = _core_.WXK_F17
473 WXK_F18 = _core_.WXK_F18
474 WXK_F19 = _core_.WXK_F19
475 WXK_F20 = _core_.WXK_F20
476 WXK_F21 = _core_.WXK_F21
477 WXK_F22 = _core_.WXK_F22
478 WXK_F23 = _core_.WXK_F23
479 WXK_F24 = _core_.WXK_F24
480 WXK_NUMLOCK = _core_.WXK_NUMLOCK
481 WXK_SCROLL = _core_.WXK_SCROLL
482 WXK_PAGEUP = _core_.WXK_PAGEUP
483 WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
484 WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
485 WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
486 WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
487 WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
488 WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
489 WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
490 WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
491 WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
492 WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
493 WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
494 WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
495 WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
496 WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
497 WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
498 WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
499 WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
500 WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
501 WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
502 WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
503 WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
504 WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
505 WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
506 WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
507 WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
508 WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
509 WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
510 WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
511 WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
512 WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
513 WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
514 WXK_COMMAND = _core_.WXK_COMMAND
515 WXK_SPECIAL1 = _core_.WXK_SPECIAL1
516 WXK_SPECIAL2 = _core_.WXK_SPECIAL2
517 WXK_SPECIAL3 = _core_.WXK_SPECIAL3
518 WXK_SPECIAL4 = _core_.WXK_SPECIAL4
519 WXK_SPECIAL5 = _core_.WXK_SPECIAL5
520 WXK_SPECIAL6 = _core_.WXK_SPECIAL6
521 WXK_SPECIAL7 = _core_.WXK_SPECIAL7
522 WXK_SPECIAL8 = _core_.WXK_SPECIAL8
523 WXK_SPECIAL9 = _core_.WXK_SPECIAL9
524 WXK_SPECIAL10 = _core_.WXK_SPECIAL10
525 WXK_SPECIAL11 = _core_.WXK_SPECIAL11
526 WXK_SPECIAL12 = _core_.WXK_SPECIAL12
527 WXK_SPECIAL13 = _core_.WXK_SPECIAL13
528 WXK_SPECIAL14 = _core_.WXK_SPECIAL14
529 WXK_SPECIAL15 = _core_.WXK_SPECIAL15
530 WXK_SPECIAL16 = _core_.WXK_SPECIAL16
531 WXK_SPECIAL17 = _core_.WXK_SPECIAL17
532 WXK_SPECIAL18 = _core_.WXK_SPECIAL18
533 WXK_SPECIAL19 = _core_.WXK_SPECIAL19
534 WXK_SPECIAL20 = _core_.WXK_SPECIAL20
535 PAPER_NONE = _core_.PAPER_NONE
536 PAPER_LETTER = _core_.PAPER_LETTER
537 PAPER_LEGAL = _core_.PAPER_LEGAL
538 PAPER_A4 = _core_.PAPER_A4
539 PAPER_CSHEET = _core_.PAPER_CSHEET
540 PAPER_DSHEET = _core_.PAPER_DSHEET
541 PAPER_ESHEET = _core_.PAPER_ESHEET
542 PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
543 PAPER_TABLOID = _core_.PAPER_TABLOID
544 PAPER_LEDGER = _core_.PAPER_LEDGER
545 PAPER_STATEMENT = _core_.PAPER_STATEMENT
546 PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
547 PAPER_A3 = _core_.PAPER_A3
548 PAPER_A4SMALL = _core_.PAPER_A4SMALL
549 PAPER_A5 = _core_.PAPER_A5
550 PAPER_B4 = _core_.PAPER_B4
551 PAPER_B5 = _core_.PAPER_B5
552 PAPER_FOLIO = _core_.PAPER_FOLIO
553 PAPER_QUARTO = _core_.PAPER_QUARTO
554 PAPER_10X14 = _core_.PAPER_10X14
555 PAPER_11X17 = _core_.PAPER_11X17
556 PAPER_NOTE = _core_.PAPER_NOTE
557 PAPER_ENV_9 = _core_.PAPER_ENV_9
558 PAPER_ENV_10 = _core_.PAPER_ENV_10
559 PAPER_ENV_11 = _core_.PAPER_ENV_11
560 PAPER_ENV_12 = _core_.PAPER_ENV_12
561 PAPER_ENV_14 = _core_.PAPER_ENV_14
562 PAPER_ENV_DL = _core_.PAPER_ENV_DL
563 PAPER_ENV_C5 = _core_.PAPER_ENV_C5
564 PAPER_ENV_C3 = _core_.PAPER_ENV_C3
565 PAPER_ENV_C4 = _core_.PAPER_ENV_C4
566 PAPER_ENV_C6 = _core_.PAPER_ENV_C6
567 PAPER_ENV_C65 = _core_.PAPER_ENV_C65
568 PAPER_ENV_B4 = _core_.PAPER_ENV_B4
569 PAPER_ENV_B5 = _core_.PAPER_ENV_B5
570 PAPER_ENV_B6 = _core_.PAPER_ENV_B6
571 PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
572 PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
573 PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
574 PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
575 PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
576 PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
577 PAPER_ISO_B4 = _core_.PAPER_ISO_B4
578 PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
579 PAPER_9X11 = _core_.PAPER_9X11
580 PAPER_10X11 = _core_.PAPER_10X11
581 PAPER_15X11 = _core_.PAPER_15X11
582 PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
583 PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
584 PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
585 PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
586 PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
587 PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
588 PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
589 PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
590 PAPER_A_PLUS = _core_.PAPER_A_PLUS
591 PAPER_B_PLUS = _core_.PAPER_B_PLUS
592 PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
593 PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
594 PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
595 PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
596 PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
597 PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
598 PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
599 PAPER_A2 = _core_.PAPER_A2
600 PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
601 PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
602 PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
603 PAPER_A6 = _core_.PAPER_A6
604 PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
605 PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
606 PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
607 PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
608 PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
609 PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
610 PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
611 PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
612 PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
613 PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
614 PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
615 PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
616 PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
617 PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
618 PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
619 PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
620 PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
621 PAPER_B6_JIS = _core_.PAPER_B6_JIS
622 PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
623 PAPER_12X11 = _core_.PAPER_12X11
624 PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
625 PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
626 PAPER_P16K = _core_.PAPER_P16K
627 PAPER_P32K = _core_.PAPER_P32K
628 PAPER_P32KBIG = _core_.PAPER_P32KBIG
629 PAPER_PENV_1 = _core_.PAPER_PENV_1
630 PAPER_PENV_2 = _core_.PAPER_PENV_2
631 PAPER_PENV_3 = _core_.PAPER_PENV_3
632 PAPER_PENV_4 = _core_.PAPER_PENV_4
633 PAPER_PENV_5 = _core_.PAPER_PENV_5
634 PAPER_PENV_6 = _core_.PAPER_PENV_6
635 PAPER_PENV_7 = _core_.PAPER_PENV_7
636 PAPER_PENV_8 = _core_.PAPER_PENV_8
637 PAPER_PENV_9 = _core_.PAPER_PENV_9
638 PAPER_PENV_10 = _core_.PAPER_PENV_10
639 PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
640 PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
641 PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
642 PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
643 PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
644 PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
645 PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
646 PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
647 PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
648 PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
649 PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
650 PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
651 PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
652 DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
653 DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
654 DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
655 ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
656 ITEM_NORMAL = _core_.ITEM_NORMAL
657 ITEM_CHECK = _core_.ITEM_CHECK
658 ITEM_RADIO = _core_.ITEM_RADIO
659 ITEM_MAX = _core_.ITEM_MAX
660 HT_NOWHERE = _core_.HT_NOWHERE
661 HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
662 HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
663 HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
664 HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
665 HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
666 HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
667 HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
668 HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
669 HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
670 HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
671 HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
672 HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
673 HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
674 HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
675 HT_MAX = _core_.HT_MAX
676 MOD_NONE = _core_.MOD_NONE
677 MOD_ALT = _core_.MOD_ALT
678 MOD_CONTROL = _core_.MOD_CONTROL
679 MOD_ALTGR = _core_.MOD_ALTGR
680 MOD_SHIFT = _core_.MOD_SHIFT
681 MOD_META = _core_.MOD_META
682 MOD_WIN = _core_.MOD_WIN
683 MOD_CMD = _core_.MOD_CMD
684 MOD_ALL = _core_.MOD_ALL
685 UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
686 UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
687 UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
688 #---------------------------------------------------------------------------
689
690 class Object(object):
691 """
692 The base class for most wx objects, although in wxPython not
693 much functionality is needed nor exposed.
694 """
695 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
696 def __init__(self): raise AttributeError, "No constructor defined"
697 __repr__ = _swig_repr
698 def GetClassName(*args, **kwargs):
699 """
700 GetClassName(self) -> String
701
702 Returns the class name of the C++ class using wxRTTI.
703 """
704 return _core_.Object_GetClassName(*args, **kwargs)
705
706 def Destroy(*args, **kwargs):
707 """
708 Destroy(self)
709
710 Deletes the C++ object this Python object is a proxy for.
711 """
712 val = _core_.Object_Destroy(*args, **kwargs)
713 args[0].thisown = 0
714 return val
715
716 _core_.Object_swigregister(Object)
717 _wxPySetDictionary = _core_._wxPySetDictionary
718 cvar = _core_.cvar
719 EmptyString = cvar.EmptyString
720
721 #---------------------------------------------------------------------------
722
723 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
724 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
725 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
726 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
727 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
728 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
729 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
730 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
731 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
732 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
733 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
734 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
735 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
736 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
737 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
738 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
739 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
740 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
741 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
742 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
743 CURSOR_NONE = _core_.CURSOR_NONE
744 CURSOR_ARROW = _core_.CURSOR_ARROW
745 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
746 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
747 CURSOR_CHAR = _core_.CURSOR_CHAR
748 CURSOR_CROSS = _core_.CURSOR_CROSS
749 CURSOR_HAND = _core_.CURSOR_HAND
750 CURSOR_IBEAM = _core_.CURSOR_IBEAM
751 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
752 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
753 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
754 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
755 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
756 CURSOR_PENCIL = _core_.CURSOR_PENCIL
757 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
758 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
759 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
760 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
761 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
762 CURSOR_SIZENS = _core_.CURSOR_SIZENS
763 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
764 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
765 CURSOR_SIZING = _core_.CURSOR_SIZING
766 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
767 CURSOR_WAIT = _core_.CURSOR_WAIT
768 CURSOR_WATCH = _core_.CURSOR_WATCH
769 CURSOR_BLANK = _core_.CURSOR_BLANK
770 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
771 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
772 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
773 CURSOR_MAX = _core_.CURSOR_MAX
774 #---------------------------------------------------------------------------
775
776 class Size(object):
777 """
778 wx.Size is a useful data structure used to represent the size of
779 something. It simply contains integer width and height
780 properties. In most places in wxPython where a wx.Size is
781 expected a (width, height) tuple can be used instead.
782 """
783 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
784 __repr__ = _swig_repr
785 width = property(_core_.Size_width_get, _core_.Size_width_set)
786 height = property(_core_.Size_height_get, _core_.Size_height_set)
787 x = width; y = height
788 def __init__(self, *args, **kwargs):
789 """
790 __init__(self, int w=0, int h=0) -> Size
791
792 Creates a size object.
793 """
794 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
795 __swig_destroy__ = _core_.delete_Size
796 __del__ = lambda self : None;
797 def __eq__(*args, **kwargs):
798 """
799 __eq__(self, PyObject other) -> bool
800
801 Test for equality of wx.Size objects.
802 """
803 return _core_.Size___eq__(*args, **kwargs)
804
805 def __ne__(*args, **kwargs):
806 """
807 __ne__(self, PyObject other) -> bool
808
809 Test for inequality of wx.Size objects.
810 """
811 return _core_.Size___ne__(*args, **kwargs)
812
813 def __add__(*args, **kwargs):
814 """
815 __add__(self, Size sz) -> Size
816
817 Add sz's proprties to this and return the result.
818 """
819 return _core_.Size___add__(*args, **kwargs)
820
821 def __sub__(*args, **kwargs):
822 """
823 __sub__(self, Size sz) -> Size
824
825 Subtract sz's properties from this and return the result.
826 """
827 return _core_.Size___sub__(*args, **kwargs)
828
829 def IncTo(*args, **kwargs):
830 """
831 IncTo(self, Size sz)
832
833 Increments this object so that both of its dimensions are not less
834 than the corresponding dimensions of the size.
835 """
836 return _core_.Size_IncTo(*args, **kwargs)
837
838 def DecTo(*args, **kwargs):
839 """
840 DecTo(self, Size sz)
841
842 Decrements this object so that both of its dimensions are not greater
843 than the corresponding dimensions of the size.
844 """
845 return _core_.Size_DecTo(*args, **kwargs)
846
847 def Set(*args, **kwargs):
848 """
849 Set(self, int w, int h)
850
851 Set both width and height.
852 """
853 return _core_.Size_Set(*args, **kwargs)
854
855 def SetWidth(*args, **kwargs):
856 """SetWidth(self, int w)"""
857 return _core_.Size_SetWidth(*args, **kwargs)
858
859 def SetHeight(*args, **kwargs):
860 """SetHeight(self, int h)"""
861 return _core_.Size_SetHeight(*args, **kwargs)
862
863 def GetWidth(*args, **kwargs):
864 """GetWidth(self) -> int"""
865 return _core_.Size_GetWidth(*args, **kwargs)
866
867 def GetHeight(*args, **kwargs):
868 """GetHeight(self) -> int"""
869 return _core_.Size_GetHeight(*args, **kwargs)
870
871 def IsFullySpecified(*args, **kwargs):
872 """
873 IsFullySpecified(self) -> bool
874
875 Returns True if both components of the size are non-default values.
876 """
877 return _core_.Size_IsFullySpecified(*args, **kwargs)
878
879 def SetDefaults(*args, **kwargs):
880 """
881 SetDefaults(self, Size size)
882
883 Combine this size with the other one replacing the default components
884 of this object (i.e. equal to -1) with those of the other.
885 """
886 return _core_.Size_SetDefaults(*args, **kwargs)
887
888 def Get(*args, **kwargs):
889 """
890 Get() -> (width,height)
891
892 Returns the width and height properties as a tuple.
893 """
894 return _core_.Size_Get(*args, **kwargs)
895
896 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
897 def __str__(self): return str(self.Get())
898 def __repr__(self): return 'wx.Size'+str(self.Get())
899 def __len__(self): return len(self.Get())
900 def __getitem__(self, index): return self.Get()[index]
901 def __setitem__(self, index, val):
902 if index == 0: self.width = val
903 elif index == 1: self.height = val
904 else: raise IndexError
905 def __nonzero__(self): return self.Get() != (0,0)
906 __safe_for_unpickling__ = True
907 def __reduce__(self): return (wx.Size, self.Get())
908
909 _core_.Size_swigregister(Size)
910
911 #---------------------------------------------------------------------------
912
913 class RealPoint(object):
914 """
915 A data structure for representing a point or position with floating
916 point x and y properties. In wxPython most places that expect a
917 wx.RealPoint can also accept a (x,y) tuple.
918 """
919 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
920 __repr__ = _swig_repr
921 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
922 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
923 def __init__(self, *args, **kwargs):
924 """
925 __init__(self, double x=0.0, double y=0.0) -> RealPoint
926
927 Create a wx.RealPoint object
928 """
929 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
930 __swig_destroy__ = _core_.delete_RealPoint
931 __del__ = lambda self : None;
932 def __eq__(*args, **kwargs):
933 """
934 __eq__(self, PyObject other) -> bool
935
936 Test for equality of wx.RealPoint objects.
937 """
938 return _core_.RealPoint___eq__(*args, **kwargs)
939
940 def __ne__(*args, **kwargs):
941 """
942 __ne__(self, PyObject other) -> bool
943
944 Test for inequality of wx.RealPoint objects.
945 """
946 return _core_.RealPoint___ne__(*args, **kwargs)
947
948 def __add__(*args, **kwargs):
949 """
950 __add__(self, RealPoint pt) -> RealPoint
951
952 Add pt's proprties to this and return the result.
953 """
954 return _core_.RealPoint___add__(*args, **kwargs)
955
956 def __sub__(*args, **kwargs):
957 """
958 __sub__(self, RealPoint pt) -> RealPoint
959
960 Subtract pt's proprties from this and return the result
961 """
962 return _core_.RealPoint___sub__(*args, **kwargs)
963
964 def Set(*args, **kwargs):
965 """
966 Set(self, double x, double y)
967
968 Set both the x and y properties
969 """
970 return _core_.RealPoint_Set(*args, **kwargs)
971
972 def Get(*args, **kwargs):
973 """
974 Get() -> (x,y)
975
976 Return the x and y properties as a tuple.
977 """
978 return _core_.RealPoint_Get(*args, **kwargs)
979
980 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
981 def __str__(self): return str(self.Get())
982 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
983 def __len__(self): return len(self.Get())
984 def __getitem__(self, index): return self.Get()[index]
985 def __setitem__(self, index, val):
986 if index == 0: self.x = val
987 elif index == 1: self.y = val
988 else: raise IndexError
989 def __nonzero__(self): return self.Get() != (0.0, 0.0)
990 __safe_for_unpickling__ = True
991 def __reduce__(self): return (wx.RealPoint, self.Get())
992
993 _core_.RealPoint_swigregister(RealPoint)
994
995 #---------------------------------------------------------------------------
996
997 class Point(object):
998 """
999 A data structure for representing a point or position with integer x
1000 and y properties. Most places in wxPython that expect a wx.Point can
1001 also accept a (x,y) tuple.
1002 """
1003 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1004 __repr__ = _swig_repr
1005 x = property(_core_.Point_x_get, _core_.Point_x_set)
1006 y = property(_core_.Point_y_get, _core_.Point_y_set)
1007 def __init__(self, *args, **kwargs):
1008 """
1009 __init__(self, int x=0, int y=0) -> Point
1010
1011 Create a wx.Point object
1012 """
1013 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1014 __swig_destroy__ = _core_.delete_Point
1015 __del__ = lambda self : None;
1016 def __eq__(*args, **kwargs):
1017 """
1018 __eq__(self, PyObject other) -> bool
1019
1020 Test for equality of wx.Point objects.
1021 """
1022 return _core_.Point___eq__(*args, **kwargs)
1023
1024 def __ne__(*args, **kwargs):
1025 """
1026 __ne__(self, PyObject other) -> bool
1027
1028 Test for inequality of wx.Point objects.
1029 """
1030 return _core_.Point___ne__(*args, **kwargs)
1031
1032 def __add__(*args, **kwargs):
1033 """
1034 __add__(self, Point pt) -> Point
1035
1036 Add pt's proprties to this and return the result.
1037 """
1038 return _core_.Point___add__(*args, **kwargs)
1039
1040 def __sub__(*args, **kwargs):
1041 """
1042 __sub__(self, Point pt) -> Point
1043
1044 Subtract pt's proprties from this and return the result
1045 """
1046 return _core_.Point___sub__(*args, **kwargs)
1047
1048 def __iadd__(*args, **kwargs):
1049 """
1050 __iadd__(self, Point pt) -> Point
1051
1052 Add pt to this object.
1053 """
1054 return _core_.Point___iadd__(*args, **kwargs)
1055
1056 def __isub__(*args, **kwargs):
1057 """
1058 __isub__(self, Point pt) -> Point
1059
1060 Subtract pt from this object.
1061 """
1062 return _core_.Point___isub__(*args, **kwargs)
1063
1064 def Set(*args, **kwargs):
1065 """
1066 Set(self, long x, long y)
1067
1068 Set both the x and y properties
1069 """
1070 return _core_.Point_Set(*args, **kwargs)
1071
1072 def Get(*args, **kwargs):
1073 """
1074 Get() -> (x,y)
1075
1076 Return the x and y properties as a tuple.
1077 """
1078 return _core_.Point_Get(*args, **kwargs)
1079
1080 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1081 def __str__(self): return str(self.Get())
1082 def __repr__(self): return 'wx.Point'+str(self.Get())
1083 def __len__(self): return len(self.Get())
1084 def __getitem__(self, index): return self.Get()[index]
1085 def __setitem__(self, index, val):
1086 if index == 0: self.x = val
1087 elif index == 1: self.y = val
1088 else: raise IndexError
1089 def __nonzero__(self): return self.Get() != (0,0)
1090 __safe_for_unpickling__ = True
1091 def __reduce__(self): return (wx.Point, self.Get())
1092
1093 _core_.Point_swigregister(Point)
1094
1095 #---------------------------------------------------------------------------
1096
1097 class Rect(object):
1098 """
1099 A class for representing and manipulating rectangles. It has x, y,
1100 width and height properties. In wxPython most palces that expect a
1101 wx.Rect can also accept a (x,y,width,height) tuple.
1102 """
1103 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1104 __repr__ = _swig_repr
1105 def __init__(self, *args, **kwargs):
1106 """
1107 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1108
1109 Create a new Rect object.
1110 """
1111 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1112 __swig_destroy__ = _core_.delete_Rect
1113 __del__ = lambda self : None;
1114 def GetX(*args, **kwargs):
1115 """GetX(self) -> int"""
1116 return _core_.Rect_GetX(*args, **kwargs)
1117
1118 def SetX(*args, **kwargs):
1119 """SetX(self, int x)"""
1120 return _core_.Rect_SetX(*args, **kwargs)
1121
1122 def GetY(*args, **kwargs):
1123 """GetY(self) -> int"""
1124 return _core_.Rect_GetY(*args, **kwargs)
1125
1126 def SetY(*args, **kwargs):
1127 """SetY(self, int y)"""
1128 return _core_.Rect_SetY(*args, **kwargs)
1129
1130 def GetWidth(*args, **kwargs):
1131 """GetWidth(self) -> int"""
1132 return _core_.Rect_GetWidth(*args, **kwargs)
1133
1134 def SetWidth(*args, **kwargs):
1135 """SetWidth(self, int w)"""
1136 return _core_.Rect_SetWidth(*args, **kwargs)
1137
1138 def GetHeight(*args, **kwargs):
1139 """GetHeight(self) -> int"""
1140 return _core_.Rect_GetHeight(*args, **kwargs)
1141
1142 def SetHeight(*args, **kwargs):
1143 """SetHeight(self, int h)"""
1144 return _core_.Rect_SetHeight(*args, **kwargs)
1145
1146 def GetPosition(*args, **kwargs):
1147 """GetPosition(self) -> Point"""
1148 return _core_.Rect_GetPosition(*args, **kwargs)
1149
1150 def SetPosition(*args, **kwargs):
1151 """SetPosition(self, Point p)"""
1152 return _core_.Rect_SetPosition(*args, **kwargs)
1153
1154 def GetSize(*args, **kwargs):
1155 """GetSize(self) -> Size"""
1156 return _core_.Rect_GetSize(*args, **kwargs)
1157
1158 def SetSize(*args, **kwargs):
1159 """SetSize(self, Size s)"""
1160 return _core_.Rect_SetSize(*args, **kwargs)
1161
1162 def IsEmpty(*args, **kwargs):
1163 """IsEmpty(self) -> bool"""
1164 return _core_.Rect_IsEmpty(*args, **kwargs)
1165
1166 def GetTopLeft(*args, **kwargs):
1167 """GetTopLeft(self) -> Point"""
1168 return _core_.Rect_GetTopLeft(*args, **kwargs)
1169
1170 def SetTopLeft(*args, **kwargs):
1171 """SetTopLeft(self, Point p)"""
1172 return _core_.Rect_SetTopLeft(*args, **kwargs)
1173
1174 def GetBottomRight(*args, **kwargs):
1175 """GetBottomRight(self) -> Point"""
1176 return _core_.Rect_GetBottomRight(*args, **kwargs)
1177
1178 def SetBottomRight(*args, **kwargs):
1179 """SetBottomRight(self, Point p)"""
1180 return _core_.Rect_SetBottomRight(*args, **kwargs)
1181
1182 def GetLeft(*args, **kwargs):
1183 """GetLeft(self) -> int"""
1184 return _core_.Rect_GetLeft(*args, **kwargs)
1185
1186 def GetTop(*args, **kwargs):
1187 """GetTop(self) -> int"""
1188 return _core_.Rect_GetTop(*args, **kwargs)
1189
1190 def GetBottom(*args, **kwargs):
1191 """GetBottom(self) -> int"""
1192 return _core_.Rect_GetBottom(*args, **kwargs)
1193
1194 def GetRight(*args, **kwargs):
1195 """GetRight(self) -> int"""
1196 return _core_.Rect_GetRight(*args, **kwargs)
1197
1198 def SetLeft(*args, **kwargs):
1199 """SetLeft(self, int left)"""
1200 return _core_.Rect_SetLeft(*args, **kwargs)
1201
1202 def SetRight(*args, **kwargs):
1203 """SetRight(self, int right)"""
1204 return _core_.Rect_SetRight(*args, **kwargs)
1205
1206 def SetTop(*args, **kwargs):
1207 """SetTop(self, int top)"""
1208 return _core_.Rect_SetTop(*args, **kwargs)
1209
1210 def SetBottom(*args, **kwargs):
1211 """SetBottom(self, int bottom)"""
1212 return _core_.Rect_SetBottom(*args, **kwargs)
1213
1214 position = property(GetPosition, SetPosition)
1215 size = property(GetSize, SetSize)
1216 left = property(GetLeft, SetLeft)
1217 right = property(GetRight, SetRight)
1218 top = property(GetTop, SetTop)
1219 bottom = property(GetBottom, SetBottom)
1220
1221 def Inflate(*args, **kwargs):
1222 """
1223 Inflate(self, int dx, int dy) -> Rect
1224
1225 Increases the size of the rectangle.
1226
1227 The left border is moved farther left and the right border is moved
1228 farther right by ``dx``. The upper border is moved farther up and the
1229 bottom border is moved farther down by ``dy``. (Note the the width and
1230 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1231 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1232 opposite happens: the rectangle size decreases in the respective
1233 direction.
1234
1235 The change is made to the rectangle inplace, if instead you need a
1236 copy that is inflated, preserving the original then make the copy
1237 first::
1238
1239 copy = wx.Rect(*original)
1240 copy.Inflate(10,15)
1241
1242
1243 """
1244 return _core_.Rect_Inflate(*args, **kwargs)
1245
1246 def Deflate(*args, **kwargs):
1247 """
1248 Deflate(self, int dx, int dy) -> Rect
1249
1250 Decrease the rectangle size. This method is the opposite of `Inflate`
1251 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1252 `Inflate` for a full description.
1253 """
1254 return _core_.Rect_Deflate(*args, **kwargs)
1255
1256 def OffsetXY(*args, **kwargs):
1257 """
1258 OffsetXY(self, int dx, int dy)
1259
1260 Moves the rectangle by the specified offset. If dx is positive, the
1261 rectangle is moved to the right, if dy is positive, it is moved to the
1262 bottom, otherwise it is moved to the left or top respectively.
1263 """
1264 return _core_.Rect_OffsetXY(*args, **kwargs)
1265
1266 def Offset(*args, **kwargs):
1267 """
1268 Offset(self, Point pt)
1269
1270 Same as `OffsetXY` but uses dx,dy from Point
1271 """
1272 return _core_.Rect_Offset(*args, **kwargs)
1273
1274 def Intersect(*args, **kwargs):
1275 """
1276 Intersect(self, Rect rect) -> Rect
1277
1278 Returns the intersectsion of this rectangle and rect.
1279 """
1280 return _core_.Rect_Intersect(*args, **kwargs)
1281
1282 def Union(*args, **kwargs):
1283 """
1284 Union(self, Rect rect) -> Rect
1285
1286 Returns the union of this rectangle and rect.
1287 """
1288 return _core_.Rect_Union(*args, **kwargs)
1289
1290 def __add__(*args, **kwargs):
1291 """
1292 __add__(self, Rect rect) -> Rect
1293
1294 Add the properties of rect to this rectangle and return the result.
1295 """
1296 return _core_.Rect___add__(*args, **kwargs)
1297
1298 def __iadd__(*args, **kwargs):
1299 """
1300 __iadd__(self, Rect rect) -> Rect
1301
1302 Add the properties of rect to this rectangle, updating this rectangle.
1303 """
1304 return _core_.Rect___iadd__(*args, **kwargs)
1305
1306 def __eq__(*args, **kwargs):
1307 """
1308 __eq__(self, PyObject other) -> bool
1309
1310 Test for equality of wx.Rect objects.
1311 """
1312 return _core_.Rect___eq__(*args, **kwargs)
1313
1314 def __ne__(*args, **kwargs):
1315 """
1316 __ne__(self, PyObject other) -> bool
1317
1318 Test for inequality of wx.Rect objects.
1319 """
1320 return _core_.Rect___ne__(*args, **kwargs)
1321
1322 def InsideXY(*args, **kwargs):
1323 """
1324 InsideXY(self, int x, int y) -> bool
1325
1326 Return True if the point is (not strcitly) inside the rect.
1327 """
1328 return _core_.Rect_InsideXY(*args, **kwargs)
1329
1330 def Inside(*args, **kwargs):
1331 """
1332 Inside(self, Point pt) -> bool
1333
1334 Return True if the point is (not strcitly) inside the rect.
1335 """
1336 return _core_.Rect_Inside(*args, **kwargs)
1337
1338 def Intersects(*args, **kwargs):
1339 """
1340 Intersects(self, Rect rect) -> bool
1341
1342 Returns True if the rectangles have a non empty intersection.
1343 """
1344 return _core_.Rect_Intersects(*args, **kwargs)
1345
1346 def CenterIn(*args, **kwargs):
1347 """
1348 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1349
1350 Center this rectangle within the one passed to the method, which is
1351 usually, but not necessarily, the larger one.
1352 """
1353 return _core_.Rect_CenterIn(*args, **kwargs)
1354
1355 CentreIn = CenterIn
1356 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1357 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1358 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1359 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1360 def Set(*args, **kwargs):
1361 """
1362 Set(self, int x=0, int y=0, int width=0, int height=0)
1363
1364 Set all rectangle properties.
1365 """
1366 return _core_.Rect_Set(*args, **kwargs)
1367
1368 def Get(*args, **kwargs):
1369 """
1370 Get() -> (x,y,width,height)
1371
1372 Return the rectangle properties as a tuple.
1373 """
1374 return _core_.Rect_Get(*args, **kwargs)
1375
1376 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1377 def __str__(self): return str(self.Get())
1378 def __repr__(self): return 'wx.Rect'+str(self.Get())
1379 def __len__(self): return len(self.Get())
1380 def __getitem__(self, index): return self.Get()[index]
1381 def __setitem__(self, index, val):
1382 if index == 0: self.x = val
1383 elif index == 1: self.y = val
1384 elif index == 2: self.width = val
1385 elif index == 3: self.height = val
1386 else: raise IndexError
1387 def __nonzero__(self): return self.Get() != (0,0,0,0)
1388 __safe_for_unpickling__ = True
1389 def __reduce__(self): return (wx.Rect, self.Get())
1390
1391 _core_.Rect_swigregister(Rect)
1392
1393 def RectPP(*args, **kwargs):
1394 """
1395 RectPP(Point topLeft, Point bottomRight) -> Rect
1396
1397 Create a new Rect object from Points representing two corners.
1398 """
1399 val = _core_.new_RectPP(*args, **kwargs)
1400 return val
1401
1402 def RectPS(*args, **kwargs):
1403 """
1404 RectPS(Point pos, Size size) -> Rect
1405
1406 Create a new Rect from a position and size.
1407 """
1408 val = _core_.new_RectPS(*args, **kwargs)
1409 return val
1410
1411 def RectS(*args, **kwargs):
1412 """
1413 RectS(Size size) -> Rect
1414
1415 Create a new Rect from a size only.
1416 """
1417 val = _core_.new_RectS(*args, **kwargs)
1418 return val
1419
1420
1421 def IntersectRect(*args, **kwargs):
1422 """
1423 IntersectRect(Rect r1, Rect r2) -> Rect
1424
1425 Calculate and return the intersection of r1 and r2.
1426 """
1427 return _core_.IntersectRect(*args, **kwargs)
1428 #---------------------------------------------------------------------------
1429
1430 class Point2D(object):
1431 """
1432 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1433 with floating point values.
1434 """
1435 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1436 __repr__ = _swig_repr
1437 def __init__(self, *args, **kwargs):
1438 """
1439 __init__(self, double x=0.0, double y=0.0) -> Point2D
1440
1441 Create a w.Point2D object.
1442 """
1443 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1444 def GetFloor(*args, **kwargs):
1445 """
1446 GetFloor() -> (x,y)
1447
1448 Convert to integer
1449 """
1450 return _core_.Point2D_GetFloor(*args, **kwargs)
1451
1452 def GetRounded(*args, **kwargs):
1453 """
1454 GetRounded() -> (x,y)
1455
1456 Convert to integer
1457 """
1458 return _core_.Point2D_GetRounded(*args, **kwargs)
1459
1460 def GetVectorLength(*args, **kwargs):
1461 """GetVectorLength(self) -> double"""
1462 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1463
1464 def GetVectorAngle(*args, **kwargs):
1465 """GetVectorAngle(self) -> double"""
1466 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1467
1468 def SetVectorLength(*args, **kwargs):
1469 """SetVectorLength(self, double length)"""
1470 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1471
1472 def SetVectorAngle(*args, **kwargs):
1473 """SetVectorAngle(self, double degrees)"""
1474 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1475
1476 def SetPolarCoordinates(self, angle, length):
1477 self.SetVectorLength(length)
1478 self.SetVectorAngle(angle)
1479 def Normalize(self):
1480 self.SetVectorLength(1.0)
1481
1482 def GetDistance(*args, **kwargs):
1483 """GetDistance(self, Point2D pt) -> double"""
1484 return _core_.Point2D_GetDistance(*args, **kwargs)
1485
1486 def GetDistanceSquare(*args, **kwargs):
1487 """GetDistanceSquare(self, Point2D pt) -> double"""
1488 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1489
1490 def GetDotProduct(*args, **kwargs):
1491 """GetDotProduct(self, Point2D vec) -> double"""
1492 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1493
1494 def GetCrossProduct(*args, **kwargs):
1495 """GetCrossProduct(self, Point2D vec) -> double"""
1496 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1497
1498 def __neg__(*args, **kwargs):
1499 """
1500 __neg__(self) -> Point2D
1501
1502 the reflection of this point
1503 """
1504 return _core_.Point2D___neg__(*args, **kwargs)
1505
1506 def __iadd__(*args, **kwargs):
1507 """__iadd__(self, Point2D pt) -> Point2D"""
1508 return _core_.Point2D___iadd__(*args, **kwargs)
1509
1510 def __isub__(*args, **kwargs):
1511 """__isub__(self, Point2D pt) -> Point2D"""
1512 return _core_.Point2D___isub__(*args, **kwargs)
1513
1514 def __imul__(*args, **kwargs):
1515 """__imul__(self, Point2D pt) -> Point2D"""
1516 return _core_.Point2D___imul__(*args, **kwargs)
1517
1518 def __idiv__(*args, **kwargs):
1519 """__idiv__(self, Point2D pt) -> Point2D"""
1520 return _core_.Point2D___idiv__(*args, **kwargs)
1521
1522 def __eq__(*args, **kwargs):
1523 """
1524 __eq__(self, PyObject other) -> bool
1525
1526 Test for equality of wx.Point2D objects.
1527 """
1528 return _core_.Point2D___eq__(*args, **kwargs)
1529
1530 def __ne__(*args, **kwargs):
1531 """
1532 __ne__(self, PyObject other) -> bool
1533
1534 Test for inequality of wx.Point2D objects.
1535 """
1536 return _core_.Point2D___ne__(*args, **kwargs)
1537
1538 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1539 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1540 def Set(*args, **kwargs):
1541 """Set(self, double x=0, double y=0)"""
1542 return _core_.Point2D_Set(*args, **kwargs)
1543
1544 def Get(*args, **kwargs):
1545 """
1546 Get() -> (x,y)
1547
1548 Return x and y properties as a tuple.
1549 """
1550 return _core_.Point2D_Get(*args, **kwargs)
1551
1552 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1553 def __str__(self): return str(self.Get())
1554 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1555 def __len__(self): return len(self.Get())
1556 def __getitem__(self, index): return self.Get()[index]
1557 def __setitem__(self, index, val):
1558 if index == 0: self.x = val
1559 elif index == 1: self.y = val
1560 else: raise IndexError
1561 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1562 __safe_for_unpickling__ = True
1563 def __reduce__(self): return (wx.Point2D, self.Get())
1564
1565 _core_.Point2D_swigregister(Point2D)
1566
1567 def Point2DCopy(*args, **kwargs):
1568 """
1569 Point2DCopy(Point2D pt) -> Point2D
1570
1571 Create a w.Point2D object.
1572 """
1573 val = _core_.new_Point2DCopy(*args, **kwargs)
1574 return val
1575
1576 def Point2DFromPoint(*args, **kwargs):
1577 """
1578 Point2DFromPoint(Point pt) -> Point2D
1579
1580 Create a w.Point2D object.
1581 """
1582 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1583 return val
1584
1585 #---------------------------------------------------------------------------
1586
1587 FromStart = _core_.FromStart
1588 FromCurrent = _core_.FromCurrent
1589 FromEnd = _core_.FromEnd
1590 class InputStream(object):
1591 """Proxy of C++ InputStream class"""
1592 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1593 __repr__ = _swig_repr
1594 def __init__(self, *args, **kwargs):
1595 """__init__(self, PyObject p) -> InputStream"""
1596 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1597 __swig_destroy__ = _core_.delete_InputStream
1598 __del__ = lambda self : None;
1599 def close(*args, **kwargs):
1600 """close(self)"""
1601 return _core_.InputStream_close(*args, **kwargs)
1602
1603 def flush(*args, **kwargs):
1604 """flush(self)"""
1605 return _core_.InputStream_flush(*args, **kwargs)
1606
1607 def eof(*args, **kwargs):
1608 """eof(self) -> bool"""
1609 return _core_.InputStream_eof(*args, **kwargs)
1610
1611 def read(*args, **kwargs):
1612 """read(self, int size=-1) -> PyObject"""
1613 return _core_.InputStream_read(*args, **kwargs)
1614
1615 def readline(*args, **kwargs):
1616 """readline(self, int size=-1) -> PyObject"""
1617 return _core_.InputStream_readline(*args, **kwargs)
1618
1619 def readlines(*args, **kwargs):
1620 """readlines(self, int sizehint=-1) -> PyObject"""
1621 return _core_.InputStream_readlines(*args, **kwargs)
1622
1623 def seek(*args, **kwargs):
1624 """seek(self, int offset, int whence=0)"""
1625 return _core_.InputStream_seek(*args, **kwargs)
1626
1627 def tell(*args, **kwargs):
1628 """tell(self) -> int"""
1629 return _core_.InputStream_tell(*args, **kwargs)
1630
1631 def Peek(*args, **kwargs):
1632 """Peek(self) -> char"""
1633 return _core_.InputStream_Peek(*args, **kwargs)
1634
1635 def GetC(*args, **kwargs):
1636 """GetC(self) -> char"""
1637 return _core_.InputStream_GetC(*args, **kwargs)
1638
1639 def LastRead(*args, **kwargs):
1640 """LastRead(self) -> size_t"""
1641 return _core_.InputStream_LastRead(*args, **kwargs)
1642
1643 def CanRead(*args, **kwargs):
1644 """CanRead(self) -> bool"""
1645 return _core_.InputStream_CanRead(*args, **kwargs)
1646
1647 def Eof(*args, **kwargs):
1648 """Eof(self) -> bool"""
1649 return _core_.InputStream_Eof(*args, **kwargs)
1650
1651 def Ungetch(*args, **kwargs):
1652 """Ungetch(self, char c) -> bool"""
1653 return _core_.InputStream_Ungetch(*args, **kwargs)
1654
1655 def SeekI(*args, **kwargs):
1656 """SeekI(self, long pos, int mode=FromStart) -> long"""
1657 return _core_.InputStream_SeekI(*args, **kwargs)
1658
1659 def TellI(*args, **kwargs):
1660 """TellI(self) -> long"""
1661 return _core_.InputStream_TellI(*args, **kwargs)
1662
1663 _core_.InputStream_swigregister(InputStream)
1664 DefaultPosition = cvar.DefaultPosition
1665 DefaultSize = cvar.DefaultSize
1666
1667 class OutputStream(object):
1668 """Proxy of C++ OutputStream class"""
1669 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1670 def __init__(self): raise AttributeError, "No constructor defined"
1671 __repr__ = _swig_repr
1672 def write(*args, **kwargs):
1673 """write(self, PyObject obj)"""
1674 return _core_.OutputStream_write(*args, **kwargs)
1675
1676 def LastWrite(*args, **kwargs):
1677 """LastWrite(self) -> size_t"""
1678 return _core_.OutputStream_LastWrite(*args, **kwargs)
1679
1680 _core_.OutputStream_swigregister(OutputStream)
1681
1682 #---------------------------------------------------------------------------
1683
1684 class FSFile(Object):
1685 """Proxy of C++ FSFile class"""
1686 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1687 __repr__ = _swig_repr
1688 def __init__(self, *args, **kwargs):
1689 """
1690 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1691 DateTime modif) -> FSFile
1692 """
1693 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1694 __swig_destroy__ = _core_.delete_FSFile
1695 __del__ = lambda self : None;
1696 def GetStream(*args, **kwargs):
1697 """GetStream(self) -> InputStream"""
1698 return _core_.FSFile_GetStream(*args, **kwargs)
1699
1700 def GetMimeType(*args, **kwargs):
1701 """GetMimeType(self) -> String"""
1702 return _core_.FSFile_GetMimeType(*args, **kwargs)
1703
1704 def GetLocation(*args, **kwargs):
1705 """GetLocation(self) -> String"""
1706 return _core_.FSFile_GetLocation(*args, **kwargs)
1707
1708 def GetAnchor(*args, **kwargs):
1709 """GetAnchor(self) -> String"""
1710 return _core_.FSFile_GetAnchor(*args, **kwargs)
1711
1712 def GetModificationTime(*args, **kwargs):
1713 """GetModificationTime(self) -> DateTime"""
1714 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1715
1716 _core_.FSFile_swigregister(FSFile)
1717
1718 class CPPFileSystemHandler(object):
1719 """Proxy of C++ CPPFileSystemHandler class"""
1720 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1721 def __init__(self): raise AttributeError, "No constructor defined"
1722 __repr__ = _swig_repr
1723 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1724 __del__ = lambda self : None;
1725 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
1726
1727 class FileSystemHandler(CPPFileSystemHandler):
1728 """Proxy of C++ FileSystemHandler class"""
1729 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1730 __repr__ = _swig_repr
1731 def __init__(self, *args, **kwargs):
1732 """__init__(self) -> FileSystemHandler"""
1733 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
1734 self._setCallbackInfo(self, FileSystemHandler)
1735
1736 def _setCallbackInfo(*args, **kwargs):
1737 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1738 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1739
1740 def CanOpen(*args, **kwargs):
1741 """CanOpen(self, String location) -> bool"""
1742 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1743
1744 def OpenFile(*args, **kwargs):
1745 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1746 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1747
1748 def FindFirst(*args, **kwargs):
1749 """FindFirst(self, String spec, int flags=0) -> String"""
1750 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1751
1752 def FindNext(*args, **kwargs):
1753 """FindNext(self) -> String"""
1754 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1755
1756 def GetProtocol(*args, **kwargs):
1757 """GetProtocol(self, String location) -> String"""
1758 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1759
1760 def GetLeftLocation(*args, **kwargs):
1761 """GetLeftLocation(self, String location) -> String"""
1762 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1763
1764 def GetAnchor(*args, **kwargs):
1765 """GetAnchor(self, String location) -> String"""
1766 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1767
1768 def GetRightLocation(*args, **kwargs):
1769 """GetRightLocation(self, String location) -> String"""
1770 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1771
1772 def GetMimeTypeFromExt(*args, **kwargs):
1773 """GetMimeTypeFromExt(self, String location) -> String"""
1774 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1775
1776 _core_.FileSystemHandler_swigregister(FileSystemHandler)
1777
1778 class FileSystem(Object):
1779 """Proxy of C++ FileSystem class"""
1780 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1781 __repr__ = _swig_repr
1782 def __init__(self, *args, **kwargs):
1783 """__init__(self) -> FileSystem"""
1784 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1785 __swig_destroy__ = _core_.delete_FileSystem
1786 __del__ = lambda self : None;
1787 def ChangePathTo(*args, **kwargs):
1788 """ChangePathTo(self, String location, bool is_dir=False)"""
1789 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1790
1791 def GetPath(*args, **kwargs):
1792 """GetPath(self) -> String"""
1793 return _core_.FileSystem_GetPath(*args, **kwargs)
1794
1795 def OpenFile(*args, **kwargs):
1796 """OpenFile(self, String location) -> FSFile"""
1797 return _core_.FileSystem_OpenFile(*args, **kwargs)
1798
1799 def FindFirst(*args, **kwargs):
1800 """FindFirst(self, String spec, int flags=0) -> String"""
1801 return _core_.FileSystem_FindFirst(*args, **kwargs)
1802
1803 def FindNext(*args, **kwargs):
1804 """FindNext(self) -> String"""
1805 return _core_.FileSystem_FindNext(*args, **kwargs)
1806
1807 def AddHandler(*args, **kwargs):
1808 """AddHandler(CPPFileSystemHandler handler)"""
1809 return _core_.FileSystem_AddHandler(*args, **kwargs)
1810
1811 AddHandler = staticmethod(AddHandler)
1812 def CleanUpHandlers(*args, **kwargs):
1813 """CleanUpHandlers()"""
1814 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1815
1816 CleanUpHandlers = staticmethod(CleanUpHandlers)
1817 def FileNameToURL(*args, **kwargs):
1818 """FileNameToURL(String filename) -> String"""
1819 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1820
1821 FileNameToURL = staticmethod(FileNameToURL)
1822 def URLToFileName(*args, **kwargs):
1823 """URLToFileName(String url) -> String"""
1824 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1825
1826 URLToFileName = staticmethod(URLToFileName)
1827 _core_.FileSystem_swigregister(FileSystem)
1828
1829 def FileSystem_AddHandler(*args, **kwargs):
1830 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1831 return _core_.FileSystem_AddHandler(*args, **kwargs)
1832
1833 def FileSystem_CleanUpHandlers(*args):
1834 """FileSystem_CleanUpHandlers()"""
1835 return _core_.FileSystem_CleanUpHandlers(*args)
1836
1837 def FileSystem_FileNameToURL(*args, **kwargs):
1838 """FileSystem_FileNameToURL(String filename) -> String"""
1839 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1840
1841 def FileSystem_URLToFileName(*args, **kwargs):
1842 """FileSystem_URLToFileName(String url) -> String"""
1843 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1844
1845 class InternetFSHandler(CPPFileSystemHandler):
1846 """Proxy of C++ InternetFSHandler class"""
1847 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1848 __repr__ = _swig_repr
1849 def __init__(self, *args, **kwargs):
1850 """__init__(self) -> InternetFSHandler"""
1851 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
1852 def CanOpen(*args, **kwargs):
1853 """CanOpen(self, String location) -> bool"""
1854 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1855
1856 def OpenFile(*args, **kwargs):
1857 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1858 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1859
1860 _core_.InternetFSHandler_swigregister(InternetFSHandler)
1861
1862 class ZipFSHandler(CPPFileSystemHandler):
1863 """Proxy of C++ ZipFSHandler class"""
1864 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1865 __repr__ = _swig_repr
1866 def __init__(self, *args, **kwargs):
1867 """__init__(self) -> ZipFSHandler"""
1868 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
1869 def CanOpen(*args, **kwargs):
1870 """CanOpen(self, String location) -> bool"""
1871 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1872
1873 def OpenFile(*args, **kwargs):
1874 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1875 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1876
1877 def FindFirst(*args, **kwargs):
1878 """FindFirst(self, String spec, int flags=0) -> String"""
1879 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1880
1881 def FindNext(*args, **kwargs):
1882 """FindNext(self) -> String"""
1883 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1884
1885 _core_.ZipFSHandler_swigregister(ZipFSHandler)
1886
1887
1888 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1889 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1890 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1891
1892 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1893 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1894 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1895
1896 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1897 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1898 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1899 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1900 """
1901 Add 'file' to the memory filesystem. The dataItem parameter can
1902 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1903 arbitrary data. If a bitmap or image is used then the imgType
1904 parameter should specify what kind of image file it should be
1905 written as, wx.BITMAP_TYPE_PNG, etc.
1906 """
1907 if isinstance(dataItem, wx.Image):
1908 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1909 elif isinstance(dataItem, wx.Bitmap):
1910 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1911 elif type(dataItem) == str:
1912 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1913 else:
1914 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1915
1916 class MemoryFSHandler(CPPFileSystemHandler):
1917 """Proxy of C++ MemoryFSHandler class"""
1918 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1919 __repr__ = _swig_repr
1920 def __init__(self, *args, **kwargs):
1921 """__init__(self) -> MemoryFSHandler"""
1922 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
1923 def RemoveFile(*args, **kwargs):
1924 """RemoveFile(String filename)"""
1925 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1926
1927 RemoveFile = staticmethod(RemoveFile)
1928 AddFile = staticmethod(MemoryFSHandler_AddFile)
1929 def CanOpen(*args, **kwargs):
1930 """CanOpen(self, String location) -> bool"""
1931 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1932
1933 def OpenFile(*args, **kwargs):
1934 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1935 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1936
1937 def FindFirst(*args, **kwargs):
1938 """FindFirst(self, String spec, int flags=0) -> String"""
1939 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1940
1941 def FindNext(*args, **kwargs):
1942 """FindNext(self) -> String"""
1943 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1944
1945 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
1946
1947 def MemoryFSHandler_RemoveFile(*args, **kwargs):
1948 """MemoryFSHandler_RemoveFile(String filename)"""
1949 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1950
1951 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
1952 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
1953 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
1954 #---------------------------------------------------------------------------
1955
1956 class ImageHandler(Object):
1957 """
1958 This is the base class for implementing image file loading/saving, and
1959 image creation from data. It is used within `wx.Image` and is not
1960 normally seen by the application.
1961 """
1962 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1963 def __init__(self): raise AttributeError, "No constructor defined"
1964 __repr__ = _swig_repr
1965 def GetName(*args, **kwargs):
1966 """GetName(self) -> String"""
1967 return _core_.ImageHandler_GetName(*args, **kwargs)
1968
1969 def GetExtension(*args, **kwargs):
1970 """GetExtension(self) -> String"""
1971 return _core_.ImageHandler_GetExtension(*args, **kwargs)
1972
1973 def GetType(*args, **kwargs):
1974 """GetType(self) -> long"""
1975 return _core_.ImageHandler_GetType(*args, **kwargs)
1976
1977 def GetMimeType(*args, **kwargs):
1978 """GetMimeType(self) -> String"""
1979 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
1980
1981 def CanRead(*args, **kwargs):
1982 """CanRead(self, String name) -> bool"""
1983 return _core_.ImageHandler_CanRead(*args, **kwargs)
1984
1985 def CanReadStream(*args, **kwargs):
1986 """CanReadStream(self, InputStream stream) -> bool"""
1987 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
1988
1989 def SetName(*args, **kwargs):
1990 """SetName(self, String name)"""
1991 return _core_.ImageHandler_SetName(*args, **kwargs)
1992
1993 def SetExtension(*args, **kwargs):
1994 """SetExtension(self, String extension)"""
1995 return _core_.ImageHandler_SetExtension(*args, **kwargs)
1996
1997 def SetType(*args, **kwargs):
1998 """SetType(self, long type)"""
1999 return _core_.ImageHandler_SetType(*args, **kwargs)
2000
2001 def SetMimeType(*args, **kwargs):
2002 """SetMimeType(self, String mimetype)"""
2003 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2004
2005 _core_.ImageHandler_swigregister(ImageHandler)
2006
2007 class PyImageHandler(ImageHandler):
2008 """
2009 This is the base class for implementing image file loading/saving, and
2010 image creation from data, all written in Python. To create a custom
2011 image handler derive a new class from wx.PyImageHandler and provide
2012 the following methods::
2013
2014 def DoCanRead(self, stream) --> bool
2015 '''Check if this handler can read the image on the stream'''
2016
2017 def LoadFile(self, image, stream, verbose, index) --> bool
2018 '''Load image data from the stream and load it into image.'''
2019
2020 def SaveFile(self, image, stream, verbose) --> bool
2021 '''Save the iamge data in image to the stream using
2022 this handler's image file format.'''
2023
2024 def GetImageCount(self, stream) --> int
2025 '''If this image format can hold more than one image,
2026 how many does the image on the stream have?'''
2027
2028 To activate your handler create an instance of it and pass it to
2029 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2030 `SetExtension` from your constructor.
2031
2032 """
2033 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2034 __repr__ = _swig_repr
2035 def __init__(self, *args, **kwargs):
2036 """
2037 __init__(self) -> PyImageHandler
2038
2039 This is the base class for implementing image file loading/saving, and
2040 image creation from data, all written in Python. To create a custom
2041 image handler derive a new class from wx.PyImageHandler and provide
2042 the following methods::
2043
2044 def DoCanRead(self, stream) --> bool
2045 '''Check if this handler can read the image on the stream'''
2046
2047 def LoadFile(self, image, stream, verbose, index) --> bool
2048 '''Load image data from the stream and load it into image.'''
2049
2050 def SaveFile(self, image, stream, verbose) --> bool
2051 '''Save the iamge data in image to the stream using
2052 this handler's image file format.'''
2053
2054 def GetImageCount(self, stream) --> int
2055 '''If this image format can hold more than one image,
2056 how many does the image on the stream have?'''
2057
2058 To activate your handler create an instance of it and pass it to
2059 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2060 `SetExtension` from your constructor.
2061
2062 """
2063 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2064 self._SetSelf(self)
2065
2066 def _SetSelf(*args, **kwargs):
2067 """_SetSelf(self, PyObject self)"""
2068 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2069
2070 _core_.PyImageHandler_swigregister(PyImageHandler)
2071
2072 class ImageHistogram(object):
2073 """Proxy of C++ ImageHistogram class"""
2074 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2075 __repr__ = _swig_repr
2076 def __init__(self, *args, **kwargs):
2077 """__init__(self) -> ImageHistogram"""
2078 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2079 def MakeKey(*args, **kwargs):
2080 """
2081 MakeKey(byte r, byte g, byte b) -> unsigned long
2082
2083 Get the key in the histogram for the given RGB values
2084 """
2085 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2086
2087 MakeKey = staticmethod(MakeKey)
2088 def FindFirstUnusedColour(*args, **kwargs):
2089 """
2090 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2091
2092 Find first colour that is not used in the image and has higher RGB
2093 values than startR, startG, startB. Returns a tuple consisting of a
2094 success flag and rgb values.
2095 """
2096 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2097
2098 def GetCount(*args, **kwargs):
2099 """
2100 GetCount(self, unsigned long key) -> unsigned long
2101
2102 Returns the pixel count for the given key. Use `MakeKey` to create a
2103 key value from a RGB tripple.
2104 """
2105 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2106
2107 def GetCountRGB(*args, **kwargs):
2108 """
2109 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2110
2111 Returns the pixel count for the given RGB values.
2112 """
2113 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2114
2115 def GetCountColour(*args, **kwargs):
2116 """
2117 GetCountColour(self, Colour colour) -> unsigned long
2118
2119 Returns the pixel count for the given `wx.Colour` value.
2120 """
2121 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2122
2123 _core_.ImageHistogram_swigregister(ImageHistogram)
2124
2125 def ImageHistogram_MakeKey(*args, **kwargs):
2126 """
2127 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2128
2129 Get the key in the histogram for the given RGB values
2130 """
2131 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2132
2133 class Image_RGBValue(object):
2134 """
2135 An object that contains values for red, green and blue which represent
2136 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2137 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2138 color space.
2139 """
2140 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2141 __repr__ = _swig_repr
2142 def __init__(self, *args, **kwargs):
2143 """
2144 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2145
2146 Constructor.
2147 """
2148 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2149 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2150 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2151 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2152 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2153
2154 class Image_HSVValue(object):
2155 """
2156 An object that contains values for hue, saturation and value which
2157 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2158 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2159 color space.
2160 """
2161 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2162 __repr__ = _swig_repr
2163 def __init__(self, *args, **kwargs):
2164 """
2165 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2166
2167 Constructor.
2168 """
2169 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2170 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2171 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2172 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2173 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2174
2175 class Image(Object):
2176 """
2177 A platform-independent image class. An image can be created from
2178 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2179 variety of formats. Functions are available to set and get image
2180 bits, so it can be used for basic image manipulation.
2181
2182 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2183 platform-specific `wx.Bitmap` object must be created from it using the
2184 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2185 device context, using `wx.DC.DrawBitmap`.
2186
2187 One colour value of the image may be used as a mask colour which will
2188 lead to the automatic creation of a `wx.Mask` object associated to the
2189 bitmap object.
2190
2191 wx.Image supports alpha channel data, that is in addition to a byte
2192 for the red, green and blue colour components for each pixel it also
2193 stores a byte representing the pixel opacity. An alpha value of 0
2194 corresponds to a transparent pixel (null opacity) while a value of 255
2195 means that the pixel is 100% opaque.
2196
2197 Unlike RGB data, not all images have an alpha channel and before using
2198 `GetAlpha` you should check if this image contains an alpha channel
2199 with `HasAlpha`. Note that currently only images loaded from PNG files
2200 with transparency information will have an alpha channel.
2201 """
2202 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2203 __repr__ = _swig_repr
2204 def __init__(self, *args, **kwargs):
2205 """
2206 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2207
2208 Loads an image from a file.
2209 """
2210 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2211 __swig_destroy__ = _core_.delete_Image
2212 __del__ = lambda self : None;
2213 def Create(*args, **kwargs):
2214 """
2215 Create(self, int width, int height, bool clear=True)
2216
2217 Creates a fresh image. If clear is ``True``, the new image will be
2218 initialized to black. Otherwise, the image data will be uninitialized.
2219 """
2220 return _core_.Image_Create(*args, **kwargs)
2221
2222 def Destroy(*args, **kwargs):
2223 """
2224 Destroy(self)
2225
2226 Destroys the image data.
2227 """
2228 val = _core_.Image_Destroy(*args, **kwargs)
2229 args[0].thisown = 0
2230 return val
2231
2232 def Scale(*args, **kwargs):
2233 """
2234 Scale(self, int width, int height) -> Image
2235
2236 Returns a scaled version of the image. This is also useful for scaling
2237 bitmaps in general as the only other way to scale bitmaps is to blit a
2238 `wx.MemoryDC` into another `wx.MemoryDC`.
2239 """
2240 return _core_.Image_Scale(*args, **kwargs)
2241
2242 def ShrinkBy(*args, **kwargs):
2243 """
2244 ShrinkBy(self, int xFactor, int yFactor) -> Image
2245
2246 Return a version of the image scaled smaller by the given factors.
2247 """
2248 return _core_.Image_ShrinkBy(*args, **kwargs)
2249
2250 def Rescale(*args, **kwargs):
2251 """
2252 Rescale(self, int width, int height) -> Image
2253
2254 Changes the size of the image in-place by scaling it: after a call to
2255 this function, the image will have the given width and height.
2256
2257 Returns the (modified) image itself.
2258 """
2259 return _core_.Image_Rescale(*args, **kwargs)
2260
2261 def Resize(*args, **kwargs):
2262 """
2263 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2264
2265 Changes the size of the image in-place without scaling it, by adding
2266 either a border with the given colour or cropping as necessary. The
2267 image is pasted into a new image with the given size and background
2268 colour at the position pos relative to the upper left of the new
2269 image. If red = green = blue = -1 then use either the current mask
2270 colour if set or find, use, and set a suitable mask colour for any
2271 newly exposed areas.
2272
2273 Returns the (modified) image itself.
2274 """
2275 return _core_.Image_Resize(*args, **kwargs)
2276
2277 def SetRGB(*args, **kwargs):
2278 """
2279 SetRGB(self, int x, int y, byte r, byte g, byte b)
2280
2281 Sets the pixel at the given coordinate. This routine performs
2282 bounds-checks for the coordinate so it can be considered a safe way to
2283 manipulate the data, but in some cases this might be too slow so that
2284 the data will have to be set directly. In that case you will have to
2285 get access to the image data using the `GetData` method.
2286 """
2287 return _core_.Image_SetRGB(*args, **kwargs)
2288
2289 def SetRGBRect(*args, **kwargs):
2290 """
2291 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2292
2293 Sets the colour of the pixels within the given rectangle. This routine
2294 performs bounds-checks for the rectangle so it can be considered a
2295 safe way to manipulate the data.
2296 """
2297 return _core_.Image_SetRGBRect(*args, **kwargs)
2298
2299 def GetRed(*args, **kwargs):
2300 """
2301 GetRed(self, int x, int y) -> byte
2302
2303 Returns the red intensity at the given coordinate.
2304 """
2305 return _core_.Image_GetRed(*args, **kwargs)
2306
2307 def GetGreen(*args, **kwargs):
2308 """
2309 GetGreen(self, int x, int y) -> byte
2310
2311 Returns the green intensity at the given coordinate.
2312 """
2313 return _core_.Image_GetGreen(*args, **kwargs)
2314
2315 def GetBlue(*args, **kwargs):
2316 """
2317 GetBlue(self, int x, int y) -> byte
2318
2319 Returns the blue intensity at the given coordinate.
2320 """
2321 return _core_.Image_GetBlue(*args, **kwargs)
2322
2323 def SetAlpha(*args, **kwargs):
2324 """
2325 SetAlpha(self, int x, int y, byte alpha)
2326
2327 Sets the alpha value for the given pixel. This function should only be
2328 called if the image has alpha channel data, use `HasAlpha` to check
2329 for this.
2330 """
2331 return _core_.Image_SetAlpha(*args, **kwargs)
2332
2333 def GetAlpha(*args, **kwargs):
2334 """
2335 GetAlpha(self, int x, int y) -> byte
2336
2337 Returns the alpha value for the given pixel. This function may only be
2338 called for the images with alpha channel, use `HasAlpha` to check for
2339 this.
2340
2341 The returned value is the *opacity* of the image, i.e. the value of 0
2342 corresponds to the fully transparent pixels while the value of 255 to
2343 the fully opaque pixels.
2344 """
2345 return _core_.Image_GetAlpha(*args, **kwargs)
2346
2347 def HasAlpha(*args, **kwargs):
2348 """
2349 HasAlpha(self) -> bool
2350
2351 Returns true if this image has alpha channel, false otherwise.
2352 """
2353 return _core_.Image_HasAlpha(*args, **kwargs)
2354
2355 def InitAlpha(*args, **kwargs):
2356 """
2357 InitAlpha(self)
2358
2359 Initializes the image alpha channel data. It is an error to call it if
2360 the image already has alpha data. If it doesn't, alpha data will be by
2361 default initialized to all pixels being fully opaque. But if the image
2362 has a a mask colour, all mask pixels will be completely transparent.
2363 """
2364 return _core_.Image_InitAlpha(*args, **kwargs)
2365
2366 def IsTransparent(*args, **kwargs):
2367 """
2368 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2369
2370 Returns ``True`` if this pixel is masked or has an alpha value less
2371 than the spcified threshold.
2372 """
2373 return _core_.Image_IsTransparent(*args, **kwargs)
2374
2375 def FindFirstUnusedColour(*args, **kwargs):
2376 """
2377 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2378
2379 Find first colour that is not used in the image and has higher RGB
2380 values than startR, startG, startB. Returns a tuple consisting of a
2381 success flag and rgb values.
2382 """
2383 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2384
2385 def ConvertAlphaToMask(*args, **kwargs):
2386 """
2387 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2388
2389 If the image has alpha channel, this method converts it to mask. All
2390 pixels with alpha value less than ``threshold`` are replaced with the
2391 mask colour and the alpha channel is removed. The mask colour is
2392 chosen automatically using `FindFirstUnusedColour`.
2393
2394 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2395 nothing.
2396 """
2397 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2398
2399 def ConvertColourToAlpha(*args, **kwargs):
2400 """
2401 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2402
2403 This method converts an image where the original alpha information is
2404 only available as a shades of a colour (actually shades of grey)
2405 typically when you draw anti-aliased text into a bitmap. The DC
2406 drawing routines draw grey values on the black background although
2407 they actually mean to draw white with differnt alpha values. This
2408 method reverses it, assuming a black (!) background and white text.
2409 The method will then fill up the whole image with the colour given.
2410 """
2411 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2412
2413 def SetMaskFromImage(*args, **kwargs):
2414 """
2415 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2416
2417 Sets the image's mask so that the pixels that have RGB value of
2418 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2419 by first finding an unused colour in the image, setting this colour as
2420 the mask colour and then using this colour to draw all pixels in the
2421 image who corresponding pixel in mask has given RGB value.
2422
2423 Returns ``False`` if ``mask`` does not have same dimensions as the
2424 image or if there is no unused colour left. Returns ``True`` if the
2425 mask was successfully applied.
2426
2427 Note that this method involves computing the histogram, which is
2428 computationally intensive operation.
2429 """
2430 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2431
2432 def CanRead(*args, **kwargs):
2433 """
2434 CanRead(String filename) -> bool
2435
2436 Returns True if the image handlers can read this file.
2437 """
2438 return _core_.Image_CanRead(*args, **kwargs)
2439
2440 CanRead = staticmethod(CanRead)
2441 def GetImageCount(*args, **kwargs):
2442 """
2443 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2444
2445 If the image file contains more than one image and the image handler
2446 is capable of retrieving these individually, this function will return
2447 the number of available images.
2448 """
2449 return _core_.Image_GetImageCount(*args, **kwargs)
2450
2451 GetImageCount = staticmethod(GetImageCount)
2452 def LoadFile(*args, **kwargs):
2453 """
2454 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2455
2456 Loads an image from a file. If no handler type is provided, the
2457 library will try to autodetect the format.
2458 """
2459 return _core_.Image_LoadFile(*args, **kwargs)
2460
2461 def LoadMimeFile(*args, **kwargs):
2462 """
2463 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2464
2465 Loads an image from a file, specifying the image type with a MIME type
2466 string.
2467 """
2468 return _core_.Image_LoadMimeFile(*args, **kwargs)
2469
2470 def SaveFile(*args, **kwargs):
2471 """
2472 SaveFile(self, String name, int type) -> bool
2473
2474 Saves an image in the named file.
2475 """
2476 return _core_.Image_SaveFile(*args, **kwargs)
2477
2478 def SaveMimeFile(*args, **kwargs):
2479 """
2480 SaveMimeFile(self, String name, String mimetype) -> bool
2481
2482 Saves an image in the named file.
2483 """
2484 return _core_.Image_SaveMimeFile(*args, **kwargs)
2485
2486 def CanReadStream(*args, **kwargs):
2487 """
2488 CanReadStream(InputStream stream) -> bool
2489
2490 Returns True if the image handlers can read an image file from the
2491 data currently on the input stream, or a readable Python file-like
2492 object.
2493 """
2494 return _core_.Image_CanReadStream(*args, **kwargs)
2495
2496 CanReadStream = staticmethod(CanReadStream)
2497 def LoadStream(*args, **kwargs):
2498 """
2499 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2500
2501 Loads an image from an input stream or a readable Python file-like
2502 object. If no handler type is provided, the library will try to
2503 autodetect the format.
2504 """
2505 return _core_.Image_LoadStream(*args, **kwargs)
2506
2507 def LoadMimeStream(*args, **kwargs):
2508 """
2509 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2510
2511 Loads an image from an input stream or a readable Python file-like
2512 object, using a MIME type string to specify the image file format.
2513 """
2514 return _core_.Image_LoadMimeStream(*args, **kwargs)
2515
2516 def Ok(*args, **kwargs):
2517 """
2518 Ok(self) -> bool
2519
2520 Returns true if image data is present.
2521 """
2522 return _core_.Image_Ok(*args, **kwargs)
2523
2524 def GetWidth(*args, **kwargs):
2525 """
2526 GetWidth(self) -> int
2527
2528 Gets the width of the image in pixels.
2529 """
2530 return _core_.Image_GetWidth(*args, **kwargs)
2531
2532 def GetHeight(*args, **kwargs):
2533 """
2534 GetHeight(self) -> int
2535
2536 Gets the height of the image in pixels.
2537 """
2538 return _core_.Image_GetHeight(*args, **kwargs)
2539
2540 def GetSize(*args, **kwargs):
2541 """
2542 GetSize(self) -> Size
2543
2544 Returns the size of the image in pixels.
2545 """
2546 return _core_.Image_GetSize(*args, **kwargs)
2547
2548 def GetSubImage(*args, **kwargs):
2549 """
2550 GetSubImage(self, Rect rect) -> Image
2551
2552 Returns a sub image of the current one as long as the rect belongs
2553 entirely to the image.
2554 """
2555 return _core_.Image_GetSubImage(*args, **kwargs)
2556
2557 def Size(*args, **kwargs):
2558 """
2559 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2560
2561 Returns a resized version of this image without scaling it by adding
2562 either a border with the given colour or cropping as necessary. The
2563 image is pasted into a new image with the given size and background
2564 colour at the position ``pos`` relative to the upper left of the new
2565 image. If red = green = blue = -1 then use either the current mask
2566 colour if set or find, use, and set a suitable mask colour for any
2567 newly exposed areas.
2568 """
2569 return _core_.Image_Size(*args, **kwargs)
2570
2571 def Copy(*args, **kwargs):
2572 """
2573 Copy(self) -> Image
2574
2575 Returns an identical copy of the image.
2576 """
2577 return _core_.Image_Copy(*args, **kwargs)
2578
2579 def Paste(*args, **kwargs):
2580 """
2581 Paste(self, Image image, int x, int y)
2582
2583 Pastes ``image`` into this instance and takes care of the mask colour
2584 and any out of bounds problems.
2585 """
2586 return _core_.Image_Paste(*args, **kwargs)
2587
2588 def GetData(*args, **kwargs):
2589 """
2590 GetData(self) -> PyObject
2591
2592 Returns a string containing a copy of the RGB bytes of the image.
2593 """
2594 return _core_.Image_GetData(*args, **kwargs)
2595
2596 def SetData(*args, **kwargs):
2597 """
2598 SetData(self, buffer data)
2599
2600 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2601 either a string or a buffer object holding the data and the length of
2602 the data must be width*height*3.
2603 """
2604 return _core_.Image_SetData(*args, **kwargs)
2605
2606 def GetDataBuffer(*args, **kwargs):
2607 """
2608 GetDataBuffer(self) -> PyObject
2609
2610 Returns a writable Python buffer object that is pointing at the RGB
2611 image data buffer inside the wx.Image. You need to ensure that you do
2612 not use this buffer object after the image has been destroyed.
2613 """
2614 return _core_.Image_GetDataBuffer(*args, **kwargs)
2615
2616 def SetDataBuffer(*args, **kwargs):
2617 """
2618 SetDataBuffer(self, buffer data)
2619
2620 Sets the internal image data pointer to point at a Python buffer
2621 object. This can save making an extra copy of the data but you must
2622 ensure that the buffer object lives longer than the wx.Image does.
2623 """
2624 return _core_.Image_SetDataBuffer(*args, **kwargs)
2625
2626 def GetAlphaData(*args, **kwargs):
2627 """
2628 GetAlphaData(self) -> PyObject
2629
2630 Returns a string containing a copy of the alpha bytes of the image.
2631 """
2632 return _core_.Image_GetAlphaData(*args, **kwargs)
2633
2634 def SetAlphaData(*args, **kwargs):
2635 """
2636 SetAlphaData(self, buffer alpha)
2637
2638 Resets the Image's alpha data from a buffer of bytes. Accepts either
2639 a string or a buffer object holding the data and the length of the
2640 data must be width*height.
2641 """
2642 return _core_.Image_SetAlphaData(*args, **kwargs)
2643
2644 def GetAlphaBuffer(*args, **kwargs):
2645 """GetAlphaBuffer(self) -> PyObject"""
2646 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2647
2648 def SetAlphaBuffer(*args, **kwargs):
2649 """SetAlphaBuffer(self, buffer alpha)"""
2650 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2651
2652 def SetMaskColour(*args, **kwargs):
2653 """
2654 SetMaskColour(self, byte r, byte g, byte b)
2655
2656 Sets the mask colour for this image (and tells the image to use the
2657 mask).
2658 """
2659 return _core_.Image_SetMaskColour(*args, **kwargs)
2660
2661 def GetOrFindMaskColour(*args, **kwargs):
2662 """
2663 GetOrFindMaskColour() -> (r,g,b)
2664
2665 Get the current mask colour or find a suitable colour.
2666 """
2667 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2668
2669 def GetMaskRed(*args, **kwargs):
2670 """
2671 GetMaskRed(self) -> byte
2672
2673 Gets the red component of the mask colour.
2674 """
2675 return _core_.Image_GetMaskRed(*args, **kwargs)
2676
2677 def GetMaskGreen(*args, **kwargs):
2678 """
2679 GetMaskGreen(self) -> byte
2680
2681 Gets the green component of the mask colour.
2682 """
2683 return _core_.Image_GetMaskGreen(*args, **kwargs)
2684
2685 def GetMaskBlue(*args, **kwargs):
2686 """
2687 GetMaskBlue(self) -> byte
2688
2689 Gets the blue component of the mask colour.
2690 """
2691 return _core_.Image_GetMaskBlue(*args, **kwargs)
2692
2693 def SetMask(*args, **kwargs):
2694 """
2695 SetMask(self, bool mask=True)
2696
2697 Specifies whether there is a mask or not. The area of the mask is
2698 determined by the current mask colour.
2699 """
2700 return _core_.Image_SetMask(*args, **kwargs)
2701
2702 def HasMask(*args, **kwargs):
2703 """
2704 HasMask(self) -> bool
2705
2706 Returns ``True`` if there is a mask active, ``False`` otherwise.
2707 """
2708 return _core_.Image_HasMask(*args, **kwargs)
2709
2710 def Rotate(*args, **kwargs):
2711 """
2712 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2713 Point offset_after_rotation=None) -> Image
2714
2715 Rotates the image about the given point, by ``angle`` radians. Passing
2716 ``True`` to ``interpolating`` results in better image quality, but is
2717 slower. If the image has a mask, then the mask colour is used for the
2718 uncovered pixels in the rotated image background. Otherwise, black
2719 will be used as the fill colour.
2720
2721 Returns the rotated image, leaving this image intact.
2722 """
2723 return _core_.Image_Rotate(*args, **kwargs)
2724
2725 def Rotate90(*args, **kwargs):
2726 """
2727 Rotate90(self, bool clockwise=True) -> Image
2728
2729 Returns a copy of the image rotated 90 degrees in the direction
2730 indicated by ``clockwise``.
2731 """
2732 return _core_.Image_Rotate90(*args, **kwargs)
2733
2734 def Mirror(*args, **kwargs):
2735 """
2736 Mirror(self, bool horizontally=True) -> Image
2737
2738 Returns a mirrored copy of the image. The parameter ``horizontally``
2739 indicates the orientation.
2740 """
2741 return _core_.Image_Mirror(*args, **kwargs)
2742
2743 def Replace(*args, **kwargs):
2744 """
2745 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2746
2747 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2748 ``(r2,g2,b2)``.
2749 """
2750 return _core_.Image_Replace(*args, **kwargs)
2751
2752 def ConvertToGreyscale(*args, **kwargs):
2753 """
2754 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2755
2756 Convert to greyscale image. Uses the luminance component (Y) of the
2757 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2758 defaults to ITU-T BT.601
2759 """
2760 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2761
2762 def ConvertToMono(*args, **kwargs):
2763 """
2764 ConvertToMono(self, byte r, byte g, byte b) -> Image
2765
2766 Returns monochromatic version of the image. The returned image has
2767 white colour where the original has ``(r,g,b)`` colour and black
2768 colour everywhere else.
2769 """
2770 return _core_.Image_ConvertToMono(*args, **kwargs)
2771
2772 def SetOption(*args, **kwargs):
2773 """
2774 SetOption(self, String name, String value)
2775
2776 Sets an image handler defined option. For example, when saving as a
2777 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2778 number between 0 and 100 (0 is terrible, 100 is very good).
2779 """
2780 return _core_.Image_SetOption(*args, **kwargs)
2781
2782 def SetOptionInt(*args, **kwargs):
2783 """
2784 SetOptionInt(self, String name, int value)
2785
2786 Sets an image option as an integer.
2787 """
2788 return _core_.Image_SetOptionInt(*args, **kwargs)
2789
2790 def GetOption(*args, **kwargs):
2791 """
2792 GetOption(self, String name) -> String
2793
2794 Gets the value of an image handler option.
2795 """
2796 return _core_.Image_GetOption(*args, **kwargs)
2797
2798 def GetOptionInt(*args, **kwargs):
2799 """
2800 GetOptionInt(self, String name) -> int
2801
2802 Gets the value of an image handler option as an integer. If the given
2803 option is not present, the function returns 0.
2804 """
2805 return _core_.Image_GetOptionInt(*args, **kwargs)
2806
2807 def HasOption(*args, **kwargs):
2808 """
2809 HasOption(self, String name) -> bool
2810
2811 Returns true if the given option is present.
2812 """
2813 return _core_.Image_HasOption(*args, **kwargs)
2814
2815 def CountColours(*args, **kwargs):
2816 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2817 return _core_.Image_CountColours(*args, **kwargs)
2818
2819 def ComputeHistogram(*args, **kwargs):
2820 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2821 return _core_.Image_ComputeHistogram(*args, **kwargs)
2822
2823 def AddHandler(*args, **kwargs):
2824 """AddHandler(ImageHandler handler)"""
2825 return _core_.Image_AddHandler(*args, **kwargs)
2826
2827 AddHandler = staticmethod(AddHandler)
2828 def InsertHandler(*args, **kwargs):
2829 """InsertHandler(ImageHandler handler)"""
2830 return _core_.Image_InsertHandler(*args, **kwargs)
2831
2832 InsertHandler = staticmethod(InsertHandler)
2833 def RemoveHandler(*args, **kwargs):
2834 """RemoveHandler(String name) -> bool"""
2835 return _core_.Image_RemoveHandler(*args, **kwargs)
2836
2837 RemoveHandler = staticmethod(RemoveHandler)
2838 def GetHandlers(*args, **kwargs):
2839 """GetHandlers() -> PyObject"""
2840 return _core_.Image_GetHandlers(*args, **kwargs)
2841
2842 GetHandlers = staticmethod(GetHandlers)
2843 def GetImageExtWildcard(*args, **kwargs):
2844 """
2845 GetImageExtWildcard() -> String
2846
2847 Iterates all registered wxImageHandler objects, and returns a string
2848 containing file extension masks suitable for passing to file open/save
2849 dialog boxes.
2850 """
2851 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2852
2853 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2854 def ConvertToBitmap(*args, **kwargs):
2855 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
2856 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2857
2858 def ConvertToMonoBitmap(*args, **kwargs):
2859 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
2860 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2861
2862 def RotateHue(*args, **kwargs):
2863 """
2864 RotateHue(self, double angle)
2865
2866 Rotates the hue of each pixel of the image. Hue is a double in the
2867 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2868 """
2869 return _core_.Image_RotateHue(*args, **kwargs)
2870
2871 def RGBtoHSV(*args, **kwargs):
2872 """
2873 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2874
2875 Converts a color in RGB color space to HSV color space.
2876 """
2877 return _core_.Image_RGBtoHSV(*args, **kwargs)
2878
2879 RGBtoHSV = staticmethod(RGBtoHSV)
2880 def HSVtoRGB(*args, **kwargs):
2881 """
2882 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2883
2884 Converts a color in HSV color space to RGB color space.
2885 """
2886 return _core_.Image_HSVtoRGB(*args, **kwargs)
2887
2888 HSVtoRGB = staticmethod(HSVtoRGB)
2889 def __nonzero__(self): return self.Ok()
2890 _core_.Image_swigregister(Image)
2891
2892 def ImageFromMime(*args, **kwargs):
2893 """
2894 ImageFromMime(String name, String mimetype, int index=-1) -> Image
2895
2896 Loads an image from a file, using a MIME type string (such as
2897 'image/jpeg') to specify image type.
2898 """
2899 val = _core_.new_ImageFromMime(*args, **kwargs)
2900 return val
2901
2902 def ImageFromStream(*args, **kwargs):
2903 """
2904 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2905
2906 Loads an image from an input stream, or any readable Python file-like
2907 object.
2908 """
2909 val = _core_.new_ImageFromStream(*args, **kwargs)
2910 return val
2911
2912 def ImageFromStreamMime(*args, **kwargs):
2913 """
2914 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
2915
2916 Loads an image from an input stream, or any readable Python file-like
2917 object, specifying the image format with a MIME type string.
2918 """
2919 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2920 return val
2921
2922 def EmptyImage(*args, **kwargs):
2923 """
2924 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
2925
2926 Construct an empty image of a given size, optionally setting all
2927 pixels to black.
2928 """
2929 val = _core_.new_EmptyImage(*args, **kwargs)
2930 return val
2931
2932 def ImageFromBitmap(*args, **kwargs):
2933 """
2934 ImageFromBitmap(Bitmap bitmap) -> Image
2935
2936 Construct an Image from a `wx.Bitmap`.
2937 """
2938 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2939 return val
2940
2941 def ImageFromData(*args, **kwargs):
2942 """
2943 ImageFromData(int width, int height, buffer data) -> Image
2944
2945 Construct an Image from a buffer of RGB bytes. Accepts either a
2946 string or a buffer object holding the data and the length of the data
2947 must be width*height*3.
2948 """
2949 val = _core_.new_ImageFromData(*args, **kwargs)
2950 return val
2951
2952 def ImageFromDataWithAlpha(*args, **kwargs):
2953 """
2954 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
2955
2956 Construct an Image from a buffer of RGB bytes with an Alpha channel.
2957 Accepts either a string or a buffer object holding the data and the
2958 length of the data must be width*height*3 bytes, and the length of the
2959 alpha data must be width*height bytes.
2960 """
2961 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2962 return val
2963
2964 def Image_CanRead(*args, **kwargs):
2965 """
2966 Image_CanRead(String filename) -> bool
2967
2968 Returns True if the image handlers can read this file.
2969 """
2970 return _core_.Image_CanRead(*args, **kwargs)
2971
2972 def Image_GetImageCount(*args, **kwargs):
2973 """
2974 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2975
2976 If the image file contains more than one image and the image handler
2977 is capable of retrieving these individually, this function will return
2978 the number of available images.
2979 """
2980 return _core_.Image_GetImageCount(*args, **kwargs)
2981
2982 def Image_CanReadStream(*args, **kwargs):
2983 """
2984 Image_CanReadStream(InputStream stream) -> bool
2985
2986 Returns True if the image handlers can read an image file from the
2987 data currently on the input stream, or a readable Python file-like
2988 object.
2989 """
2990 return _core_.Image_CanReadStream(*args, **kwargs)
2991
2992 def Image_AddHandler(*args, **kwargs):
2993 """Image_AddHandler(ImageHandler handler)"""
2994 return _core_.Image_AddHandler(*args, **kwargs)
2995
2996 def Image_InsertHandler(*args, **kwargs):
2997 """Image_InsertHandler(ImageHandler handler)"""
2998 return _core_.Image_InsertHandler(*args, **kwargs)
2999
3000 def Image_RemoveHandler(*args, **kwargs):
3001 """Image_RemoveHandler(String name) -> bool"""
3002 return _core_.Image_RemoveHandler(*args, **kwargs)
3003
3004 def Image_GetHandlers(*args):
3005 """Image_GetHandlers() -> PyObject"""
3006 return _core_.Image_GetHandlers(*args)
3007
3008 def Image_GetImageExtWildcard(*args):
3009 """
3010 Image_GetImageExtWildcard() -> String
3011
3012 Iterates all registered wxImageHandler objects, and returns a string
3013 containing file extension masks suitable for passing to file open/save
3014 dialog boxes.
3015 """
3016 return _core_.Image_GetImageExtWildcard(*args)
3017
3018 def Image_RGBtoHSV(*args, **kwargs):
3019 """
3020 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3021
3022 Converts a color in RGB color space to HSV color space.
3023 """
3024 return _core_.Image_RGBtoHSV(*args, **kwargs)
3025
3026 def Image_HSVtoRGB(*args, **kwargs):
3027 """
3028 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3029
3030 Converts a color in HSV color space to RGB color space.
3031 """
3032 return _core_.Image_HSVtoRGB(*args, **kwargs)
3033
3034 def InitAllImageHandlers():
3035 """
3036 The former functionality of InitAllImageHanders is now done internal to
3037 the _core_ extension module and so this function has become a simple NOP.
3038 """
3039 pass
3040
3041 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3042 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3043 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3044 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3045 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3046 BMP_24BPP = _core_.BMP_24BPP
3047 BMP_8BPP = _core_.BMP_8BPP
3048 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3049 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3050 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3051 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3052 BMP_4BPP = _core_.BMP_4BPP
3053 BMP_1BPP = _core_.BMP_1BPP
3054 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3055 class BMPHandler(ImageHandler):
3056 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3057 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3058 __repr__ = _swig_repr
3059 def __init__(self, *args, **kwargs):
3060 """
3061 __init__(self) -> BMPHandler
3062
3063 A `wx.ImageHandler` for \*.bmp bitmap files.
3064 """
3065 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3066 _core_.BMPHandler_swigregister(BMPHandler)
3067 NullImage = cvar.NullImage
3068 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3069 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3070 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3071 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3072 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3073 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3074 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3075 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3076 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3077 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3078 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3079 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3080 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3081 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3082 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3083
3084 class ICOHandler(BMPHandler):
3085 """A `wx.ImageHandler` for \*.ico icon files."""
3086 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3087 __repr__ = _swig_repr
3088 def __init__(self, *args, **kwargs):
3089 """
3090 __init__(self) -> ICOHandler
3091
3092 A `wx.ImageHandler` for \*.ico icon files.
3093 """
3094 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3095 _core_.ICOHandler_swigregister(ICOHandler)
3096
3097 class CURHandler(ICOHandler):
3098 """A `wx.ImageHandler` for \*.cur cursor files."""
3099 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3100 __repr__ = _swig_repr
3101 def __init__(self, *args, **kwargs):
3102 """
3103 __init__(self) -> CURHandler
3104
3105 A `wx.ImageHandler` for \*.cur cursor files.
3106 """
3107 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3108 _core_.CURHandler_swigregister(CURHandler)
3109
3110 class ANIHandler(CURHandler):
3111 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3112 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3113 __repr__ = _swig_repr
3114 def __init__(self, *args, **kwargs):
3115 """
3116 __init__(self) -> ANIHandler
3117
3118 A `wx.ImageHandler` for \*.ani animated cursor files.
3119 """
3120 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3121 _core_.ANIHandler_swigregister(ANIHandler)
3122
3123 class PNGHandler(ImageHandler):
3124 """A `wx.ImageHandler` for PNG image files."""
3125 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3126 __repr__ = _swig_repr
3127 def __init__(self, *args, **kwargs):
3128 """
3129 __init__(self) -> PNGHandler
3130
3131 A `wx.ImageHandler` for PNG image files.
3132 """
3133 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3134 _core_.PNGHandler_swigregister(PNGHandler)
3135
3136 class GIFHandler(ImageHandler):
3137 """A `wx.ImageHandler` for GIF image files."""
3138 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3139 __repr__ = _swig_repr
3140 def __init__(self, *args, **kwargs):
3141 """
3142 __init__(self) -> GIFHandler
3143
3144 A `wx.ImageHandler` for GIF image files.
3145 """
3146 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3147 _core_.GIFHandler_swigregister(GIFHandler)
3148
3149 class PCXHandler(ImageHandler):
3150 """A `wx.ImageHandler` for PCX imager files."""
3151 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3152 __repr__ = _swig_repr
3153 def __init__(self, *args, **kwargs):
3154 """
3155 __init__(self) -> PCXHandler
3156
3157 A `wx.ImageHandler` for PCX imager files.
3158 """
3159 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3160 _core_.PCXHandler_swigregister(PCXHandler)
3161
3162 class JPEGHandler(ImageHandler):
3163 """A `wx.ImageHandler` for JPEG/JPG image files."""
3164 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3165 __repr__ = _swig_repr
3166 def __init__(self, *args, **kwargs):
3167 """
3168 __init__(self) -> JPEGHandler
3169
3170 A `wx.ImageHandler` for JPEG/JPG image files.
3171 """
3172 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3173 _core_.JPEGHandler_swigregister(JPEGHandler)
3174
3175 class PNMHandler(ImageHandler):
3176 """A `wx.ImageHandler` for PNM image files."""
3177 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3178 __repr__ = _swig_repr
3179 def __init__(self, *args, **kwargs):
3180 """
3181 __init__(self) -> PNMHandler
3182
3183 A `wx.ImageHandler` for PNM image files.
3184 """
3185 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3186 _core_.PNMHandler_swigregister(PNMHandler)
3187
3188 class XPMHandler(ImageHandler):
3189 """A `wx.ImageHandler` for XPM image."""
3190 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3191 __repr__ = _swig_repr
3192 def __init__(self, *args, **kwargs):
3193 """
3194 __init__(self) -> XPMHandler
3195
3196 A `wx.ImageHandler` for XPM image.
3197 """
3198 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3199 _core_.XPMHandler_swigregister(XPMHandler)
3200
3201 class TIFFHandler(ImageHandler):
3202 """A `wx.ImageHandler` for TIFF image files."""
3203 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3204 __repr__ = _swig_repr
3205 def __init__(self, *args, **kwargs):
3206 """
3207 __init__(self) -> TIFFHandler
3208
3209 A `wx.ImageHandler` for TIFF image files.
3210 """
3211 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3212 _core_.TIFFHandler_swigregister(TIFFHandler)
3213
3214 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3215 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3216 class Quantize(object):
3217 """Performs quantization, or colour reduction, on a wxImage."""
3218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3219 def __init__(self): raise AttributeError, "No constructor defined"
3220 __repr__ = _swig_repr
3221 def Quantize(*args, **kwargs):
3222 """
3223 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3224
3225 Reduce the colours in the source image and put the result into the
3226 destination image, setting the palette in the destination if
3227 needed. Both images may be the same, to overwrite the source image.
3228 """
3229 return _core_.Quantize_Quantize(*args, **kwargs)
3230
3231 Quantize = staticmethod(Quantize)
3232 _core_.Quantize_swigregister(Quantize)
3233
3234 def Quantize_Quantize(*args, **kwargs):
3235 """
3236 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3237
3238 Reduce the colours in the source image and put the result into the
3239 destination image, setting the palette in the destination if
3240 needed. Both images may be the same, to overwrite the source image.
3241 """
3242 return _core_.Quantize_Quantize(*args, **kwargs)
3243
3244 #---------------------------------------------------------------------------
3245
3246 class EvtHandler(Object):
3247 """Proxy of C++ EvtHandler class"""
3248 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3249 __repr__ = _swig_repr
3250 def __init__(self, *args, **kwargs):
3251 """__init__(self) -> EvtHandler"""
3252 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3253 def GetNextHandler(*args, **kwargs):
3254 """GetNextHandler(self) -> EvtHandler"""
3255 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3256
3257 def GetPreviousHandler(*args, **kwargs):
3258 """GetPreviousHandler(self) -> EvtHandler"""
3259 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3260
3261 def SetNextHandler(*args, **kwargs):
3262 """SetNextHandler(self, EvtHandler handler)"""
3263 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3264
3265 def SetPreviousHandler(*args, **kwargs):
3266 """SetPreviousHandler(self, EvtHandler handler)"""
3267 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3268
3269 def GetEvtHandlerEnabled(*args, **kwargs):
3270 """GetEvtHandlerEnabled(self) -> bool"""
3271 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3272
3273 def SetEvtHandlerEnabled(*args, **kwargs):
3274 """SetEvtHandlerEnabled(self, bool enabled)"""
3275 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3276
3277 def ProcessEvent(*args, **kwargs):
3278 """ProcessEvent(self, Event event) -> bool"""
3279 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3280
3281 def AddPendingEvent(*args, **kwargs):
3282 """AddPendingEvent(self, Event event)"""
3283 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3284
3285 def ProcessPendingEvents(*args, **kwargs):
3286 """ProcessPendingEvents(self)"""
3287 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3288
3289 def Connect(*args, **kwargs):
3290 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3291 return _core_.EvtHandler_Connect(*args, **kwargs)
3292
3293 def Disconnect(*args, **kwargs):
3294 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3295 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3296
3297 def _setOORInfo(*args, **kwargs):
3298 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3299 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3300 args[0].thisown = 0
3301 return val
3302
3303 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3304 """
3305 Bind an event to an event handler.
3306
3307 :param event: One of the EVT_* objects that specifies the
3308 type of event to bind,
3309
3310 :param handler: A callable object to be invoked when the
3311 event is delivered to self. Pass None to
3312 disconnect an event handler.
3313
3314 :param source: Sometimes the event originates from a
3315 different window than self, but you still
3316 want to catch it in self. (For example, a
3317 button event delivered to a frame.) By
3318 passing the source of the event, the event
3319 handling system is able to differentiate
3320 between the same event type from different
3321 controls.
3322
3323 :param id: Used to spcify the event source by ID instead
3324 of instance.
3325
3326 :param id2: Used when it is desirable to bind a handler
3327 to a range of IDs, such as with EVT_MENU_RANGE.
3328 """
3329 if source is not None:
3330 id = source.GetId()
3331 event.Bind(self, id, id2, handler)
3332
3333 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3334 """
3335 Disconencts the event handler binding for event from self.
3336 Returns True if successful.
3337 """
3338 if source is not None:
3339 id = source.GetId()
3340 return event.Unbind(self, id, id2)
3341
3342 _core_.EvtHandler_swigregister(EvtHandler)
3343
3344 #---------------------------------------------------------------------------
3345
3346 class PyEventBinder(object):
3347 """
3348 Instances of this class are used to bind specific events to event
3349 handlers.
3350 """
3351 def __init__(self, evtType, expectedIDs=0):
3352 if expectedIDs not in [0, 1, 2]:
3353 raise ValueError, "Invalid number of expectedIDs"
3354 self.expectedIDs = expectedIDs
3355
3356 if type(evtType) == list or type(evtType) == tuple:
3357 self.evtType = evtType
3358 else:
3359 self.evtType = [evtType]
3360
3361
3362 def Bind(self, target, id1, id2, function):
3363 """Bind this set of event types to target."""
3364 for et in self.evtType:
3365 target.Connect(id1, id2, et, function)
3366
3367
3368 def Unbind(self, target, id1, id2):
3369 """Remove an event binding."""
3370 success = 0
3371 for et in self.evtType:
3372 success += target.Disconnect(id1, id2, et)
3373 return success != 0
3374
3375
3376 def __call__(self, *args):
3377 """
3378 For backwards compatibility with the old EVT_* functions.
3379 Should be called with either (window, func), (window, ID,
3380 func) or (window, ID1, ID2, func) parameters depending on the
3381 type of the event.
3382 """
3383 assert len(args) == 2 + self.expectedIDs
3384 id1 = wx.ID_ANY
3385 id2 = wx.ID_ANY
3386 target = args[0]
3387 if self.expectedIDs == 0:
3388 func = args[1]
3389 elif self.expectedIDs == 1:
3390 id1 = args[1]
3391 func = args[2]
3392 elif self.expectedIDs == 2:
3393 id1 = args[1]
3394 id2 = args[2]
3395 func = args[3]
3396 else:
3397 raise ValueError, "Unexpected number of IDs"
3398
3399 self.Bind(target, id1, id2, func)
3400
3401
3402 # These two are square pegs that don't fit the PyEventBinder hole...
3403 def EVT_COMMAND(win, id, cmd, func):
3404 win.Connect(id, -1, cmd, func)
3405 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3406 win.Connect(id1, id2, cmd, func)
3407
3408
3409 #---------------------------------------------------------------------------
3410
3411 #---------------------------------------------------------------------------
3412
3413 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3414 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3415
3416 def NewEventType(*args):
3417 """NewEventType() -> EventType"""
3418 return _core_.NewEventType(*args)
3419 wxEVT_NULL = _core_.wxEVT_NULL
3420 wxEVT_FIRST = _core_.wxEVT_FIRST
3421 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3422 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3423 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3424 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3425 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3426 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3427 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3428 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3429 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3430 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3431 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3432 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3433 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3434 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3435 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3436 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3437 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3438 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3439 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3440 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3441 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3442 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3443 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3444 wxEVT_MOTION = _core_.wxEVT_MOTION
3445 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3446 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3447 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3448 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3449 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3450 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3451 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3452 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3453 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3454 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3455 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3456 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3457 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3458 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3459 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3460 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3461 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3462 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3463 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3464 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3465 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3466 wxEVT_CHAR = _core_.wxEVT_CHAR
3467 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3468 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3469 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3470 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3471 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3472 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3473 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3474 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3475 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3476 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3477 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3478 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3479 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3480 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3481 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3482 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3483 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3484 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3485 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3486 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3487 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3488 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3489 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3490 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3491 wxEVT_SIZE = _core_.wxEVT_SIZE
3492 wxEVT_MOVE = _core_.wxEVT_MOVE
3493 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3494 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3495 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3496 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3497 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3498 wxEVT_CREATE = _core_.wxEVT_CREATE
3499 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3500 wxEVT_SHOW = _core_.wxEVT_SHOW
3501 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3502 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3503 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3504 wxEVT_PAINT = _core_.wxEVT_PAINT
3505 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3506 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3507 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3508 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3509 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3510 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3511 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3512 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3513 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3514 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3515 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3516 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3517 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3518 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3519 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3520 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3521 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3522 wxEVT_IDLE = _core_.wxEVT_IDLE
3523 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3524 wxEVT_SIZING = _core_.wxEVT_SIZING
3525 wxEVT_MOVING = _core_.wxEVT_MOVING
3526 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
3527 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3528 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3529 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
3530 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3531 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3532 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3533 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3534 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3535 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3536 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3537 #
3538 # Create some event binders
3539 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3540 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3541 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3542 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3543 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3544 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3545 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3546 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3547 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3548 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3549 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3550 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3551 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3552 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3553 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3554 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3555 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3556 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3557 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3558 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3559 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3560 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3561 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3562 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3563 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
3564 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3565 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3566 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3567 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3568 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3569 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3570 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3571 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3572 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3573 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3574 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3575 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3576 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3577 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3578 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3579 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3580
3581 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3582 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3583 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3584 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3585 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3586 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3587 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3588 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3589 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3590 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3591 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3592 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3593 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3594
3595 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3596 wxEVT_LEFT_UP,
3597 wxEVT_MIDDLE_DOWN,
3598 wxEVT_MIDDLE_UP,
3599 wxEVT_RIGHT_DOWN,
3600 wxEVT_RIGHT_UP,
3601 wxEVT_MOTION,
3602 wxEVT_LEFT_DCLICK,
3603 wxEVT_MIDDLE_DCLICK,
3604 wxEVT_RIGHT_DCLICK,
3605 wxEVT_ENTER_WINDOW,
3606 wxEVT_LEAVE_WINDOW,
3607 wxEVT_MOUSEWHEEL
3608 ])
3609
3610
3611 # Scrolling from wxWindow (sent to wxScrolledWindow)
3612 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3613 wxEVT_SCROLLWIN_BOTTOM,
3614 wxEVT_SCROLLWIN_LINEUP,
3615 wxEVT_SCROLLWIN_LINEDOWN,
3616 wxEVT_SCROLLWIN_PAGEUP,
3617 wxEVT_SCROLLWIN_PAGEDOWN,
3618 wxEVT_SCROLLWIN_THUMBTRACK,
3619 wxEVT_SCROLLWIN_THUMBRELEASE,
3620 ])
3621
3622 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3623 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3624 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3625 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3626 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3627 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3628 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3629 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3630
3631 # Scrolling from wx.Slider and wx.ScrollBar
3632 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3633 wxEVT_SCROLL_BOTTOM,
3634 wxEVT_SCROLL_LINEUP,
3635 wxEVT_SCROLL_LINEDOWN,
3636 wxEVT_SCROLL_PAGEUP,
3637 wxEVT_SCROLL_PAGEDOWN,
3638 wxEVT_SCROLL_THUMBTRACK,
3639 wxEVT_SCROLL_THUMBRELEASE,
3640 wxEVT_SCROLL_CHANGED,
3641 ])
3642
3643 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3644 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3645 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3646 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3647 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3648 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3649 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3650 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3651 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3652 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3653
3654 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3655 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3656 wxEVT_SCROLL_BOTTOM,
3657 wxEVT_SCROLL_LINEUP,
3658 wxEVT_SCROLL_LINEDOWN,
3659 wxEVT_SCROLL_PAGEUP,
3660 wxEVT_SCROLL_PAGEDOWN,
3661 wxEVT_SCROLL_THUMBTRACK,
3662 wxEVT_SCROLL_THUMBRELEASE,
3663 wxEVT_SCROLL_CHANGED,
3664 ], 1)
3665
3666 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3667 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3668 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3669 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3670 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3671 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3672 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3673 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3674 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3675 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
3676
3677 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3678 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3679 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3680 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3681 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3682 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3683 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3684 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3685 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3686 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3687
3688 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3689 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3690 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3691 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3692 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3693 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3694 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3695 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3696 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3697
3698
3699 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3700 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3701 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3702 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3703 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3704 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3705 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3706
3707 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3708
3709 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3710 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3711
3712 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3713
3714 EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3715 EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3716 EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
3717
3718
3719 #---------------------------------------------------------------------------
3720
3721 class Event(Object):
3722 """
3723 An event is a structure holding information about an event passed to a
3724 callback or member function. wx.Event is an abstract base class for
3725 other event classes
3726 """
3727 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3728 def __init__(self): raise AttributeError, "No constructor defined"
3729 __repr__ = _swig_repr
3730 __swig_destroy__ = _core_.delete_Event
3731 __del__ = lambda self : None;
3732 def SetEventType(*args, **kwargs):
3733 """
3734 SetEventType(self, EventType typ)
3735
3736 Sets the specific type of the event.
3737 """
3738 return _core_.Event_SetEventType(*args, **kwargs)
3739
3740 def GetEventType(*args, **kwargs):
3741 """
3742 GetEventType(self) -> EventType
3743
3744 Returns the identifier of the given event type, such as
3745 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3746 """
3747 return _core_.Event_GetEventType(*args, **kwargs)
3748
3749 def GetEventObject(*args, **kwargs):
3750 """
3751 GetEventObject(self) -> Object
3752
3753 Returns the object (usually a window) associated with the event, if
3754 any.
3755 """
3756 return _core_.Event_GetEventObject(*args, **kwargs)
3757
3758 def SetEventObject(*args, **kwargs):
3759 """
3760 SetEventObject(self, Object obj)
3761
3762 Sets the originating object, or in other words, obj is normally the
3763 object that is sending the event.
3764 """
3765 return _core_.Event_SetEventObject(*args, **kwargs)
3766
3767 def GetTimestamp(*args, **kwargs):
3768 """GetTimestamp(self) -> long"""
3769 return _core_.Event_GetTimestamp(*args, **kwargs)
3770
3771 def SetTimestamp(*args, **kwargs):
3772 """SetTimestamp(self, long ts=0)"""
3773 return _core_.Event_SetTimestamp(*args, **kwargs)
3774
3775 def GetId(*args, **kwargs):
3776 """
3777 GetId(self) -> int
3778
3779 Returns the identifier associated with this event, such as a button
3780 command id.
3781 """
3782 return _core_.Event_GetId(*args, **kwargs)
3783
3784 def SetId(*args, **kwargs):
3785 """
3786 SetId(self, int Id)
3787
3788 Set's the ID for the event. This is usually the ID of the window that
3789 is sending the event, but it can also be a command id from a menu
3790 item, etc.
3791 """
3792 return _core_.Event_SetId(*args, **kwargs)
3793
3794 def IsCommandEvent(*args, **kwargs):
3795 """
3796 IsCommandEvent(self) -> bool
3797
3798 Returns true if the event is or is derived from `wx.CommandEvent` else
3799 it returns false. Note: Exists only for optimization purposes.
3800 """
3801 return _core_.Event_IsCommandEvent(*args, **kwargs)
3802
3803 def Skip(*args, **kwargs):
3804 """
3805 Skip(self, bool skip=True)
3806
3807 Called by an event handler, it controls whether additional event
3808 handlers bound to this event will be called after the current event
3809 handler returns. Skip(false) (the default setting) will prevent
3810 additional event handlers from being called and control will be
3811 returned to the sender of the event immediately after the current
3812 handler has finished. Skip(True) will cause the event processing
3813 system to continue searching for a handler function for this event.
3814
3815 """
3816 return _core_.Event_Skip(*args, **kwargs)
3817
3818 def GetSkipped(*args, **kwargs):
3819 """
3820 GetSkipped(self) -> bool
3821
3822 Returns true if the event handler should be skipped, false otherwise.
3823 :see: `Skip`
3824 """
3825 return _core_.Event_GetSkipped(*args, **kwargs)
3826
3827 def ShouldPropagate(*args, **kwargs):
3828 """
3829 ShouldPropagate(self) -> bool
3830
3831 Test if this event should be propagated to the parent window or not,
3832 i.e. if the propagation level is currently greater than 0.
3833 """
3834 return _core_.Event_ShouldPropagate(*args, **kwargs)
3835
3836 def StopPropagation(*args, **kwargs):
3837 """
3838 StopPropagation(self) -> int
3839
3840 Stop the event from propagating to its parent window. Returns the old
3841 propagation level value which may be later passed to
3842 `ResumePropagation` to allow propagating the event again.
3843 """
3844 return _core_.Event_StopPropagation(*args, **kwargs)
3845
3846 def ResumePropagation(*args, **kwargs):
3847 """
3848 ResumePropagation(self, int propagationLevel)
3849
3850 Resume the event propagation by restoring the propagation level. (For
3851 example, you can use the value returned by an earlier call to
3852 `StopPropagation`.)
3853
3854 """
3855 return _core_.Event_ResumePropagation(*args, **kwargs)
3856
3857 def Clone(*args, **kwargs):
3858 """Clone(self) -> Event"""
3859 return _core_.Event_Clone(*args, **kwargs)
3860
3861 _core_.Event_swigregister(Event)
3862
3863 #---------------------------------------------------------------------------
3864
3865 class PropagationDisabler(object):
3866 """
3867 Helper class to temporarily change an event not to propagate. Simply
3868 create an instance of this class and then whe it is destroyed the
3869 propogation of the event will be restored.
3870 """
3871 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3872 __repr__ = _swig_repr
3873 def __init__(self, *args, **kwargs):
3874 """
3875 __init__(self, Event event) -> PropagationDisabler
3876
3877 Helper class to temporarily change an event not to propagate. Simply
3878 create an instance of this class and then whe it is destroyed the
3879 propogation of the event will be restored.
3880 """
3881 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
3882 __swig_destroy__ = _core_.delete_PropagationDisabler
3883 __del__ = lambda self : None;
3884 _core_.PropagationDisabler_swigregister(PropagationDisabler)
3885
3886 class PropagateOnce(object):
3887 """
3888 A helper class that will temporarily lower propagation level of an
3889 event. Simply create an instance of this class and then whe it is
3890 destroyed the propogation of the event will be restored.
3891 """
3892 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3893 __repr__ = _swig_repr
3894 def __init__(self, *args, **kwargs):
3895 """
3896 __init__(self, Event event) -> PropagateOnce
3897
3898 A helper class that will temporarily lower propagation level of an
3899 event. Simply create an instance of this class and then whe it is
3900 destroyed the propogation of the event will be restored.
3901 """
3902 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
3903 __swig_destroy__ = _core_.delete_PropagateOnce
3904 __del__ = lambda self : None;
3905 _core_.PropagateOnce_swigregister(PropagateOnce)
3906
3907 #---------------------------------------------------------------------------
3908
3909 class CommandEvent(Event):
3910 """
3911 This event class contains information about command events, which
3912 originate from a variety of simple controls, as well as menus and
3913 toolbars.
3914 """
3915 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3916 __repr__ = _swig_repr
3917 def __init__(self, *args, **kwargs):
3918 """
3919 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
3920
3921 This event class contains information about command events, which
3922 originate from a variety of simple controls, as well as menus and
3923 toolbars.
3924 """
3925 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
3926 def GetSelection(*args, **kwargs):
3927 """
3928 GetSelection(self) -> int
3929
3930 Returns item index for a listbox or choice selection event (not valid
3931 for a deselection).
3932 """
3933 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3934
3935 def SetString(*args, **kwargs):
3936 """SetString(self, String s)"""
3937 return _core_.CommandEvent_SetString(*args, **kwargs)
3938
3939 def GetString(*args, **kwargs):
3940 """
3941 GetString(self) -> String
3942
3943 Returns item string for a listbox or choice selection event (not valid
3944 for a deselection).
3945 """
3946 return _core_.CommandEvent_GetString(*args, **kwargs)
3947
3948 def IsChecked(*args, **kwargs):
3949 """
3950 IsChecked(self) -> bool
3951
3952 This method can be used with checkbox and menu events: for the
3953 checkboxes, the method returns true for a selection event and false
3954 for a deselection one. For the menu events, this method indicates if
3955 the menu item just has become checked or unchecked (and thus only
3956 makes sense for checkable menu items).
3957 """
3958 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3959
3960 Checked = IsChecked
3961 def IsSelection(*args, **kwargs):
3962 """
3963 IsSelection(self) -> bool
3964
3965 For a listbox or similar event, returns true if it is a selection,
3966 false if it is a deselection.
3967 """
3968 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3969
3970 def SetExtraLong(*args, **kwargs):
3971 """SetExtraLong(self, long extraLong)"""
3972 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3973
3974 def GetExtraLong(*args, **kwargs):
3975 """
3976 GetExtraLong(self) -> long
3977
3978 Returns extra information dependant on the event objects type. If the
3979 event comes from a listbox selection, it is a boolean determining
3980 whether the event was a selection (true) or a deselection (false). A
3981 listbox deselection only occurs for multiple-selection boxes, and in
3982 this case the index and string values are indeterminate and the
3983 listbox must be examined by the application.
3984 """
3985 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3986
3987 def SetInt(*args, **kwargs):
3988 """SetInt(self, int i)"""
3989 return _core_.CommandEvent_SetInt(*args, **kwargs)
3990
3991 def GetInt(*args, **kwargs):
3992 """
3993 GetInt(self) -> int
3994
3995 Returns the integer identifier corresponding to a listbox, choice or
3996 radiobox selection (only if the event was a selection, not a
3997 deselection), or a boolean value representing the value of a checkbox.
3998 """
3999 return _core_.CommandEvent_GetInt(*args, **kwargs)
4000
4001 def GetClientData(*args, **kwargs):
4002 """
4003 GetClientData(self) -> PyObject
4004
4005 Returns the client data object for a listbox or choice selection event, (if any.)
4006 """
4007 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4008
4009 def SetClientData(*args, **kwargs):
4010 """
4011 SetClientData(self, PyObject clientData)
4012
4013 Associate the given client data with the item at position n.
4014 """
4015 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4016
4017 GetClientObject = GetClientData
4018 SetClientObject = SetClientData
4019
4020 def Clone(*args, **kwargs):
4021 """Clone(self) -> Event"""
4022 return _core_.CommandEvent_Clone(*args, **kwargs)
4023
4024 _core_.CommandEvent_swigregister(CommandEvent)
4025
4026 #---------------------------------------------------------------------------
4027
4028 class NotifyEvent(CommandEvent):
4029 """
4030 An instance of this class (or one of its derived classes) is sent from
4031 a control when the control's state is being changed and the control
4032 allows that change to be prevented from happening. The event handler
4033 can call `Veto` or `Allow` to tell the control what to do.
4034 """
4035 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4036 __repr__ = _swig_repr
4037 def __init__(self, *args, **kwargs):
4038 """
4039 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4040
4041 An instance of this class (or one of its derived classes) is sent from
4042 a control when the control's state is being changed and the control
4043 allows that change to be prevented from happening. The event handler
4044 can call `Veto` or `Allow` to tell the control what to do.
4045 """
4046 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4047 def Veto(*args, **kwargs):
4048 """
4049 Veto(self)
4050
4051 Prevents the change announced by this event from happening.
4052
4053 It is in general a good idea to notify the user about the reasons for
4054 vetoing the change because otherwise the applications behaviour (which
4055 just refuses to do what the user wants) might be quite surprising.
4056 """
4057 return _core_.NotifyEvent_Veto(*args, **kwargs)
4058
4059 def Allow(*args, **kwargs):
4060 """
4061 Allow(self)
4062
4063 This is the opposite of `Veto`: it explicitly allows the event to be
4064 processed. For most events it is not necessary to call this method as
4065 the events are allowed anyhow but some are forbidden by default (this
4066 will be mentioned in the corresponding event description).
4067 """
4068 return _core_.NotifyEvent_Allow(*args, **kwargs)
4069
4070 def IsAllowed(*args, **kwargs):
4071 """
4072 IsAllowed(self) -> bool
4073
4074 Returns true if the change is allowed (`Veto` hasn't been called) or
4075 false otherwise (if it was).
4076 """
4077 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4078
4079 _core_.NotifyEvent_swigregister(NotifyEvent)
4080
4081 #---------------------------------------------------------------------------
4082
4083 class ScrollEvent(CommandEvent):
4084 """
4085 A scroll event holds information about events sent from stand-alone
4086 scrollbars and sliders. Note that scrolled windows do not send
4087 instnaces of this event class, but send the `wx.ScrollWinEvent`
4088 instead.
4089 """
4090 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4091 __repr__ = _swig_repr
4092 def __init__(self, *args, **kwargs):
4093 """
4094 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4095 int orient=0) -> ScrollEvent
4096 """
4097 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4098 def GetOrientation(*args, **kwargs):
4099 """
4100 GetOrientation(self) -> int
4101
4102 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4103 the scrollbar.
4104 """
4105 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4106
4107 def GetPosition(*args, **kwargs):
4108 """
4109 GetPosition(self) -> int
4110
4111 Returns the position of the scrollbar.
4112 """
4113 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4114
4115 def SetOrientation(*args, **kwargs):
4116 """SetOrientation(self, int orient)"""
4117 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4118
4119 def SetPosition(*args, **kwargs):
4120 """SetPosition(self, int pos)"""
4121 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4122
4123 _core_.ScrollEvent_swigregister(ScrollEvent)
4124
4125 #---------------------------------------------------------------------------
4126
4127 class ScrollWinEvent(Event):
4128 """
4129 A wx.ScrollWinEvent holds information about scrolling and is sent from
4130 scrolling windows.
4131 """
4132 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4133 __repr__ = _swig_repr
4134 def __init__(self, *args, **kwargs):
4135 """
4136 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4137
4138 A wx.ScrollWinEvent holds information about scrolling and is sent from
4139 scrolling windows.
4140 """
4141 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4142 def GetOrientation(*args, **kwargs):
4143 """
4144 GetOrientation(self) -> int
4145
4146 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4147 the scrollbar.
4148 """
4149 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4150
4151 def GetPosition(*args, **kwargs):
4152 """
4153 GetPosition(self) -> int
4154
4155 Returns the position of the scrollbar for the thumb track and release
4156 events. Note that this field can't be used for the other events, you
4157 need to query the window itself for the current position in that case.
4158 """
4159 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4160
4161 def SetOrientation(*args, **kwargs):
4162 """SetOrientation(self, int orient)"""
4163 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4164
4165 def SetPosition(*args, **kwargs):
4166 """SetPosition(self, int pos)"""
4167 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4168
4169 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4170
4171 #---------------------------------------------------------------------------
4172
4173 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4174 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4175 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4176 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4177 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4178 class MouseEvent(Event):
4179 """
4180 This event class contains information about the events generated by
4181 the mouse: they include mouse buttons press and release events and
4182 mouse move events.
4183
4184 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4185 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4186 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4187 a middle button so a portable application should avoid relying on the
4188 events from it.
4189
4190 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4191 the former returns true when the event corresponds to the left mouse
4192 button click while the latter returns true if the left mouse button is
4193 currently being pressed. For example, when the user is dragging the
4194 mouse you can use `LeftIsDown` to test whether the left mouse button
4195 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4196 `LeftIsDown` will also return true in wxWidgets whatever the
4197 underlying GUI behaviour is (which is platform-dependent). The same
4198 applies, of course, to other mouse buttons as well.
4199 """
4200 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4201 __repr__ = _swig_repr
4202 def __init__(self, *args, **kwargs):
4203 """
4204 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4205
4206 Constructs a wx.MouseEvent. Valid event types are:
4207
4208 * wxEVT_ENTER_WINDOW
4209 * wxEVT_LEAVE_WINDOW
4210 * wxEVT_LEFT_DOWN
4211 * wxEVT_LEFT_UP
4212 * wxEVT_LEFT_DCLICK
4213 * wxEVT_MIDDLE_DOWN
4214 * wxEVT_MIDDLE_UP
4215 * wxEVT_MIDDLE_DCLICK
4216 * wxEVT_RIGHT_DOWN
4217 * wxEVT_RIGHT_UP
4218 * wxEVT_RIGHT_DCLICK
4219 * wxEVT_MOTION
4220 * wxEVT_MOUSEWHEEL
4221 """
4222 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4223 def IsButton(*args, **kwargs):
4224 """
4225 IsButton(self) -> bool
4226
4227 Returns true if the event was a mouse button event (not necessarily a
4228 button down event - that may be tested using `ButtonDown`).
4229 """
4230 return _core_.MouseEvent_IsButton(*args, **kwargs)
4231
4232 def ButtonDown(*args, **kwargs):
4233 """
4234 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4235
4236 If the argument is omitted, this returns true if the event was any
4237 mouse button down event. Otherwise the argument specifies which
4238 button-down event shold be checked for (see `Button` for the possible
4239 values).
4240 """
4241 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4242
4243 def ButtonDClick(*args, **kwargs):
4244 """
4245 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4246
4247 If the argument is omitted, this returns true if the event was any
4248 mouse double click event. Otherwise the argument specifies which
4249 double click event to check for (see `Button` for the possible
4250 values).
4251 """
4252 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4253
4254 def ButtonUp(*args, **kwargs):
4255 """
4256 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4257
4258 If the argument is omitted, this returns true if the event was any
4259 mouse button up event. Otherwise the argument specifies which button
4260 up event to check for (see `Button` for the possible values).
4261 """
4262 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4263
4264 def Button(*args, **kwargs):
4265 """
4266 Button(self, int button) -> bool
4267
4268 Returns true if the identified mouse button is changing state. Valid
4269 values of button are:
4270
4271 ==================== =====================================
4272 wx.MOUSE_BTN_LEFT check if left button was pressed
4273 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4274 wx.MOUSE_BTN_RIGHT check if right button was pressed
4275 wx.MOUSE_BTN_ANY check if any button was pressed
4276 ==================== =====================================
4277
4278 """
4279 return _core_.MouseEvent_Button(*args, **kwargs)
4280
4281 def ButtonIsDown(*args, **kwargs):
4282 """ButtonIsDown(self, int but) -> bool"""
4283 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4284
4285 def GetButton(*args, **kwargs):
4286 """
4287 GetButton(self) -> int
4288
4289 Returns the mouse button which generated this event or
4290 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4291 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4292 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4293 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4294 right buttons respectively.
4295 """
4296 return _core_.MouseEvent_GetButton(*args, **kwargs)
4297
4298 def ControlDown(*args, **kwargs):
4299 """
4300 ControlDown(self) -> bool
4301
4302 Returns true if the control key was down at the time of the event.
4303 """
4304 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4305
4306 def MetaDown(*args, **kwargs):
4307 """
4308 MetaDown(self) -> bool
4309
4310 Returns true if the Meta key was down at the time of the event.
4311 """
4312 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4313
4314 def AltDown(*args, **kwargs):
4315 """
4316 AltDown(self) -> bool
4317
4318 Returns true if the Alt key was down at the time of the event.
4319 """
4320 return _core_.MouseEvent_AltDown(*args, **kwargs)
4321
4322 def ShiftDown(*args, **kwargs):
4323 """
4324 ShiftDown(self) -> bool
4325
4326 Returns true if the Shift key was down at the time of the event.
4327 """
4328 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4329
4330 def CmdDown(*args, **kwargs):
4331 """
4332 CmdDown(self) -> bool
4333
4334 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4335 platforms but the special "Apple" (a.k.a as "Command") key on
4336 Macs. It often makes sense to use it instead of, say, `ControlDown`
4337 because Cmd key is used for the same thing under Mac as Ctrl
4338 elsewhere. The Ctrl key still exists, it's just not used for this
4339 purpose. So for non-Mac platforms this is the same as `ControlDown`
4340 and Macs this is the same as `MetaDown`.
4341 """
4342 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4343
4344 def LeftDown(*args, **kwargs):
4345 """
4346 LeftDown(self) -> bool
4347
4348 Returns true if the left mouse button state changed to down.
4349 """
4350 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4351
4352 def MiddleDown(*args, **kwargs):
4353 """
4354 MiddleDown(self) -> bool
4355
4356 Returns true if the middle mouse button state changed to down.
4357 """
4358 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4359
4360 def RightDown(*args, **kwargs):
4361 """
4362 RightDown(self) -> bool
4363
4364 Returns true if the right mouse button state changed to down.
4365 """
4366 return _core_.MouseEvent_RightDown(*args, **kwargs)
4367
4368 def LeftUp(*args, **kwargs):
4369 """
4370 LeftUp(self) -> bool
4371
4372 Returns true if the left mouse button state changed to up.
4373 """
4374 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4375
4376 def MiddleUp(*args, **kwargs):
4377 """
4378 MiddleUp(self) -> bool
4379
4380 Returns true if the middle mouse button state changed to up.
4381 """
4382 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4383
4384 def RightUp(*args, **kwargs):
4385 """
4386 RightUp(self) -> bool
4387
4388 Returns true if the right mouse button state changed to up.
4389 """
4390 return _core_.MouseEvent_RightUp(*args, **kwargs)
4391
4392 def LeftDClick(*args, **kwargs):
4393 """
4394 LeftDClick(self) -> bool
4395
4396 Returns true if the event was a left button double click.
4397 """
4398 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4399
4400 def MiddleDClick(*args, **kwargs):
4401 """
4402 MiddleDClick(self) -> bool
4403
4404 Returns true if the event was a middle button double click.
4405 """
4406 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4407
4408 def RightDClick(*args, **kwargs):
4409 """
4410 RightDClick(self) -> bool
4411
4412 Returns true if the event was a right button double click.
4413 """
4414 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4415
4416 def LeftIsDown(*args, **kwargs):
4417 """
4418 LeftIsDown(self) -> bool
4419
4420 Returns true if the left mouse button is currently down, independent
4421 of the current event type.
4422
4423 Please notice that it is not the same as LeftDown which returns true
4424 if the left mouse button was just pressed. Rather, it describes the
4425 state of the mouse button before the event happened.
4426
4427 This event is usually used in the mouse event handlers which process
4428 "move mouse" messages to determine whether the user is (still)
4429 dragging the mouse.
4430 """
4431 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4432
4433 def MiddleIsDown(*args, **kwargs):
4434 """
4435 MiddleIsDown(self) -> bool
4436
4437 Returns true if the middle mouse button is currently down, independent
4438 of the current event type.
4439 """
4440 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4441
4442 def RightIsDown(*args, **kwargs):
4443 """
4444 RightIsDown(self) -> bool
4445
4446 Returns true if the right mouse button is currently down, independent
4447 of the current event type.
4448 """
4449 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4450
4451 def Dragging(*args, **kwargs):
4452 """
4453 Dragging(self) -> bool
4454
4455 Returns true if this was a dragging event (motion while a button is
4456 depressed).
4457 """
4458 return _core_.MouseEvent_Dragging(*args, **kwargs)
4459
4460 def Moving(*args, **kwargs):
4461 """
4462 Moving(self) -> bool
4463
4464 Returns true if this was a motion event and no mouse buttons were
4465 pressed. If any mouse button is held pressed, then this method returns
4466 false and Dragging returns true.
4467 """
4468 return _core_.MouseEvent_Moving(*args, **kwargs)
4469
4470 def Entering(*args, **kwargs):
4471 """
4472 Entering(self) -> bool
4473
4474 Returns true if the mouse was entering the window.
4475 """
4476 return _core_.MouseEvent_Entering(*args, **kwargs)
4477
4478 def Leaving(*args, **kwargs):
4479 """
4480 Leaving(self) -> bool
4481
4482 Returns true if the mouse was leaving the window.
4483 """
4484 return _core_.MouseEvent_Leaving(*args, **kwargs)
4485
4486 def GetPosition(*args, **kwargs):
4487 """
4488 GetPosition(self) -> Point
4489
4490 Returns the pixel position of the mouse in window coordinates when the
4491 event happened.
4492 """
4493 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4494
4495 def GetPositionTuple(*args, **kwargs):
4496 """
4497 GetPositionTuple() -> (x,y)
4498
4499 Returns the pixel position of the mouse in window coordinates when the
4500 event happened.
4501 """
4502 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4503
4504 def GetLogicalPosition(*args, **kwargs):
4505 """
4506 GetLogicalPosition(self, DC dc) -> Point
4507
4508 Returns the logical mouse position in pixels (i.e. translated
4509 according to the translation set for the DC, which usually indicates
4510 that the window has been scrolled).
4511 """
4512 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4513
4514 def GetX(*args, **kwargs):
4515 """
4516 GetX(self) -> int
4517
4518 Returns X coordinate of the physical mouse event position.
4519 """
4520 return _core_.MouseEvent_GetX(*args, **kwargs)
4521
4522 def GetY(*args, **kwargs):
4523 """
4524 GetY(self) -> int
4525
4526 Returns Y coordinate of the physical mouse event position.
4527 """
4528 return _core_.MouseEvent_GetY(*args, **kwargs)
4529
4530 def GetWheelRotation(*args, **kwargs):
4531 """
4532 GetWheelRotation(self) -> int
4533
4534 Get wheel rotation, positive or negative indicates direction of
4535 rotation. Current devices all send an event when rotation is equal to
4536 +/-WheelDelta, but this allows for finer resolution devices to be
4537 created in the future. Because of this you shouldn't assume that one
4538 event is equal to 1 line or whatever, but you should be able to either
4539 do partial line scrolling or wait until +/-WheelDelta rotation values
4540 have been accumulated before scrolling.
4541 """
4542 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4543
4544 def GetWheelDelta(*args, **kwargs):
4545 """
4546 GetWheelDelta(self) -> int
4547
4548 Get wheel delta, normally 120. This is the threshold for action to be
4549 taken, and one such action (for example, scrolling one increment)
4550 should occur for each delta.
4551 """
4552 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4553
4554 def GetLinesPerAction(*args, **kwargs):
4555 """
4556 GetLinesPerAction(self) -> int
4557
4558 Returns the configured number of lines (or whatever) to be scrolled
4559 per wheel action. Defaults to three.
4560 """
4561 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4562
4563 def IsPageScroll(*args, **kwargs):
4564 """
4565 IsPageScroll(self) -> bool
4566
4567 Returns true if the system has been setup to do page scrolling with
4568 the mouse wheel instead of line scrolling.
4569 """
4570 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4571
4572 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4573 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4574 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4575 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4576 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4577 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4578 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4579 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4580 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4581 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4582 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4583 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4584 _core_.MouseEvent_swigregister(MouseEvent)
4585
4586 #---------------------------------------------------------------------------
4587
4588 class SetCursorEvent(Event):
4589 """
4590 A SetCursorEvent is generated when the mouse cursor is about to be set
4591 as a result of mouse motion. This event gives the application the
4592 chance to perform specific mouse cursor processing based on the
4593 current position of the mouse within the window. Use the `SetCursor`
4594 method to specify the cursor you want to be displayed.
4595 """
4596 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4597 __repr__ = _swig_repr
4598 def __init__(self, *args, **kwargs):
4599 """
4600 __init__(self, int x=0, int y=0) -> SetCursorEvent
4601
4602 Construct a new `wx.SetCursorEvent`.
4603 """
4604 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
4605 def GetX(*args, **kwargs):
4606 """
4607 GetX(self) -> int
4608
4609 Returns the X coordinate of the mouse in client coordinates.
4610 """
4611 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4612
4613 def GetY(*args, **kwargs):
4614 """
4615 GetY(self) -> int
4616
4617 Returns the Y coordinate of the mouse in client coordinates.
4618 """
4619 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4620
4621 def SetCursor(*args, **kwargs):
4622 """
4623 SetCursor(self, Cursor cursor)
4624
4625 Sets the cursor associated with this event.
4626 """
4627 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4628
4629 def GetCursor(*args, **kwargs):
4630 """
4631 GetCursor(self) -> Cursor
4632
4633 Returns a reference to the cursor specified by this event.
4634 """
4635 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4636
4637 def HasCursor(*args, **kwargs):
4638 """
4639 HasCursor(self) -> bool
4640
4641 Returns true if the cursor specified by this event is a valid cursor.
4642 """
4643 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4644
4645 _core_.SetCursorEvent_swigregister(SetCursorEvent)
4646
4647 #---------------------------------------------------------------------------
4648
4649 class KeyEvent(Event):
4650 """
4651 This event class contains information about keypress and character
4652 events. These events are only sent to the widget that currently has
4653 the keyboard focus.
4654
4655 Notice that there are three different kinds of keyboard events in
4656 wxWidgets: key down and up events and char events. The difference
4657 between the first two is clear - the first corresponds to a key press
4658 and the second to a key release - otherwise they are identical. Just
4659 note that if the key is maintained in a pressed state you will
4660 typically get a lot of (automatically generated) down events but only
4661 one up so it is wrong to assume that there is one up event
4662 corresponding to each down one.
4663
4664 Both key events provide untranslated key codes while the char event
4665 carries the translated one. The untranslated code for alphanumeric
4666 keys is always an upper case value. For the other keys it is one of
4667 WXK_XXX values from the keycodes table. The translated key is, in
4668 general, the character the user expects to appear as the result of the
4669 key combination when typing the text into a text entry zone, for
4670 example.
4671
4672 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4673 and the standard US keyboard): when the 'A' key is pressed, the key
4674 down event key code is equal to ASCII A == 65. But the char event key
4675 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4676 'A' keys simultaneously , the key code in key down event will still be
4677 just 'A' while the char event key code parameter will now be 'A' as
4678 well.
4679
4680 Although in this simple case it is clear that the correct key code
4681 could be found in the key down event handler by checking the value
4682 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4683 as for non alphanumeric keys or non-US keyboard layouts the
4684 translation is keyboard-layout dependent and can only be done properly
4685 by the system itself.
4686
4687 Another kind of translation is done when the control key is pressed:
4688 for example, for CTRL-A key press the key down event still carries the
4689 same key code 'A' as usual but the char event will have key code of 1,
4690 the ASCII value of this key combination.
4691
4692 You may discover how the other keys on your system behave
4693 interactively by running the KeyEvents sample in the wxPython demo and
4694 pressing some keys while the blue box at the top has the keyboard
4695 focus.
4696
4697 **Note**: If a key down event is caught and the event handler does not
4698 call event.Skip() then the coresponding char event will not
4699 happen. This is by design and enables the programs that handle both
4700 types of events to be a bit simpler.
4701
4702 **Note for Windows programmers**: The key and char events in wxWidgets
4703 are similar to but slightly different from Windows WM_KEYDOWN and
4704 WM_CHAR events. In particular, Alt-x combination will generate a char
4705 event in wxWidgets (unless it is used as an accelerator).
4706
4707 **Tip**: be sure to call event.Skip() for events that you don't
4708 process in key event function, otherwise menu shortcuts may cease to
4709 work under Windows.
4710
4711 """
4712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4713 __repr__ = _swig_repr
4714 def __init__(self, *args, **kwargs):
4715 """
4716 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4717
4718 Construct a new `wx.KeyEvent`. Valid event types are:
4719 *
4720 """
4721 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
4722 def GetModifiers(*args, **kwargs):
4723 """
4724 GetModifiers(self) -> int
4725
4726 Returns a bitmask of the current modifier settings. Can be used to
4727 check if the key event has exactly the given modifiers without having
4728 to explicitly check that the other modifiers are not down. For
4729 example::
4730
4731 if event.GetModifers() == wx.MOD_CONTROL:
4732 DoSomething()
4733
4734 """
4735 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4736
4737 def ControlDown(*args, **kwargs):
4738 """
4739 ControlDown(self) -> bool
4740
4741 Returns ``True`` if the Control key was down at the time of the event.
4742 """
4743 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4744
4745 def MetaDown(*args, **kwargs):
4746 """
4747 MetaDown(self) -> bool
4748
4749 Returns ``True`` if the Meta key was down at the time of the event.
4750 """
4751 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4752
4753 def AltDown(*args, **kwargs):
4754 """
4755 AltDown(self) -> bool
4756
4757 Returns ``True`` if the Alt key was down at the time of the event.
4758 """
4759 return _core_.KeyEvent_AltDown(*args, **kwargs)
4760
4761 def ShiftDown(*args, **kwargs):
4762 """
4763 ShiftDown(self) -> bool
4764
4765 Returns ``True`` if the Shift key was down at the time of the event.
4766 """
4767 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
4768
4769 def CmdDown(*args, **kwargs):
4770 """
4771 CmdDown(self) -> bool
4772
4773 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4774 platforms but the special "Apple" (a.k.a as "Command") key on
4775 Macs. It makes often sense to use it instead of, say, `ControlDown`
4776 because Cmd key is used for the same thing under Mac as Ctrl
4777 elsewhere. The Ctrl still exists, it's just not used for this
4778 purpose. So for non-Mac platforms this is the same as `ControlDown`
4779 and Macs this is the same as `MetaDown`.
4780 """
4781 return _core_.KeyEvent_CmdDown(*args, **kwargs)
4782
4783 def HasModifiers(*args, **kwargs):
4784 """
4785 HasModifiers(self) -> bool
4786
4787 Returns true if either CTRL or ALT keys was down at the time of the
4788 key event. Note that this function does not take into account neither
4789 SHIFT nor META key states (the reason for ignoring the latter is that
4790 it is common for NUMLOCK key to be configured as META under X but the
4791 key presses even while NUMLOCK is on should be still processed
4792 normally).
4793 """
4794 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
4795
4796 def GetKeyCode(*args, **kwargs):
4797 """
4798 GetKeyCode(self) -> int
4799
4800 Returns the virtual key code. ASCII events return normal ASCII values,
4801 while non-ASCII events return values such as WXK_LEFT for the left
4802 cursor key. See `wx.KeyEvent` for a full list of the virtual key
4803 codes.
4804
4805 Note that in Unicode build, the returned value is meaningful only if
4806 the user entered a character that can be represented in current
4807 locale's default charset. You can obtain the corresponding Unicode
4808 character using `GetUnicodeKey`.
4809 """
4810 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
4811
4812 KeyCode = GetKeyCode
4813 def GetUnicodeKey(*args, **kwargs):
4814 """
4815 GetUnicodeKey(self) -> int
4816
4817 Returns the Unicode character corresponding to this key event. This
4818 function is only meaningfule in a Unicode build of wxPython.
4819 """
4820 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
4821
4822 GetUniChar = GetUnicodeKey
4823 def SetUnicodeKey(*args, **kwargs):
4824 """
4825 SetUnicodeKey(self, int uniChar)
4826
4827 Set the Unicode value of the key event, but only if this is a Unicode
4828 build of wxPython.
4829 """
4830 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
4831
4832 def GetRawKeyCode(*args, **kwargs):
4833 """
4834 GetRawKeyCode(self) -> unsigned int
4835
4836 Returns the raw key code for this event. This is a platform-dependent
4837 scan code which should only be used in advanced
4838 applications. Currently the raw key codes are not supported by all
4839 ports.
4840 """
4841 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
4842
4843 def GetRawKeyFlags(*args, **kwargs):
4844 """
4845 GetRawKeyFlags(self) -> unsigned int
4846
4847 Returns the low level key flags for this event. The flags are
4848 platform-dependent and should only be used in advanced applications.
4849 Currently the raw key flags are not supported by all ports.
4850 """
4851 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
4852
4853 def GetPosition(*args, **kwargs):
4854 """
4855 GetPosition(self) -> Point
4856
4857 Find the position of the event, if applicable.
4858 """
4859 return _core_.KeyEvent_GetPosition(*args, **kwargs)
4860
4861 def GetPositionTuple(*args, **kwargs):
4862 """
4863 GetPositionTuple() -> (x,y)
4864
4865 Find the position of the event, if applicable.
4866 """
4867 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
4868
4869 def GetX(*args, **kwargs):
4870 """
4871 GetX(self) -> int
4872
4873 Returns the X position (in client coordinates) of the event, if
4874 applicable.
4875 """
4876 return _core_.KeyEvent_GetX(*args, **kwargs)
4877
4878 def GetY(*args, **kwargs):
4879 """
4880 GetY(self) -> int
4881
4882 Returns the Y position (in client coordinates) of the event, if
4883 applicable.
4884 """
4885 return _core_.KeyEvent_GetY(*args, **kwargs)
4886
4887 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
4888 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
4889 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
4890 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
4891 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
4892 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
4893 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
4894 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
4895 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
4896 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
4897 _core_.KeyEvent_swigregister(KeyEvent)
4898
4899 #---------------------------------------------------------------------------
4900
4901 class SizeEvent(Event):
4902 """
4903 A size event holds information about size change events. The EVT_SIZE
4904 handler function will be called when the window it is bound to has
4905 been resized.
4906
4907 Note that the size passed is of the whole window: call
4908 `wx.Window.GetClientSize` for the area which may be used by the
4909 application.
4910
4911 When a window is resized, usually only a small part of the window is
4912 damaged and and that area is all that is in the update region for the
4913 next paint event. However, if your drawing depends on the size of the
4914 window, you may need to clear the DC explicitly and repaint the whole
4915 window. In which case, you may need to call `wx.Window.Refresh` to
4916 invalidate the entire window.
4917
4918 """
4919 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4920 __repr__ = _swig_repr
4921 def __init__(self, *args, **kwargs):
4922 """
4923 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
4924
4925 Construct a new ``wx.SizeEvent``.
4926 """
4927 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
4928 def GetSize(*args, **kwargs):
4929 """
4930 GetSize(self) -> Size
4931
4932 Returns the entire size of the window generating the size change
4933 event.
4934 """
4935 return _core_.SizeEvent_GetSize(*args, **kwargs)
4936
4937 def GetRect(*args, **kwargs):
4938 """GetRect(self) -> Rect"""
4939 return _core_.SizeEvent_GetRect(*args, **kwargs)
4940
4941 def SetRect(*args, **kwargs):
4942 """SetRect(self, Rect rect)"""
4943 return _core_.SizeEvent_SetRect(*args, **kwargs)
4944
4945 def SetSize(*args, **kwargs):
4946 """SetSize(self, Size size)"""
4947 return _core_.SizeEvent_SetSize(*args, **kwargs)
4948
4949 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
4950 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
4951 _core_.SizeEvent_swigregister(SizeEvent)
4952
4953 #---------------------------------------------------------------------------
4954
4955 class MoveEvent(Event):
4956 """
4957 This event object is sent for EVT_MOVE event bindings when a window is
4958 moved to a new position.
4959 """
4960 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4961 __repr__ = _swig_repr
4962 def __init__(self, *args, **kwargs):
4963 """
4964 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
4965
4966 Constructor.
4967 """
4968 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
4969 def GetPosition(*args, **kwargs):
4970 """
4971 GetPosition(self) -> Point
4972
4973 Returns the position of the window generating the move change event.
4974 """
4975 return _core_.MoveEvent_GetPosition(*args, **kwargs)
4976
4977 def GetRect(*args, **kwargs):
4978 """GetRect(self) -> Rect"""
4979 return _core_.MoveEvent_GetRect(*args, **kwargs)
4980
4981 def SetRect(*args, **kwargs):
4982 """SetRect(self, Rect rect)"""
4983 return _core_.MoveEvent_SetRect(*args, **kwargs)
4984
4985 def SetPosition(*args, **kwargs):
4986 """SetPosition(self, Point pos)"""
4987 return _core_.MoveEvent_SetPosition(*args, **kwargs)
4988
4989 m_pos = property(GetPosition, SetPosition)
4990 m_rect = property(GetRect, SetRect)
4991
4992 _core_.MoveEvent_swigregister(MoveEvent)
4993
4994 #---------------------------------------------------------------------------
4995
4996 class PaintEvent(Event):
4997 """
4998 A paint event is sent when a window's contents needs to be repainted.
4999 Note that in an EVT_PAINT handler the application must *always* create
5000 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5001 Windows assumes that the window has not been painted yet and will send
5002 the event again, causing endless refreshes.
5003
5004 You can optimize painting by retrieving the rectangles that have been
5005 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5006 and only repainting these rectangles. The rectangles are in terms of
5007 the client area, and are unscrolled, so you will need to do some
5008 calculations using the current view position to obtain logical,
5009 scrolled units.
5010
5011 """
5012 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5013 __repr__ = _swig_repr
5014 def __init__(self, *args, **kwargs):
5015 """__init__(self, int Id=0) -> PaintEvent"""
5016 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5017 _core_.PaintEvent_swigregister(PaintEvent)
5018
5019 class NcPaintEvent(Event):
5020 """Proxy of C++ NcPaintEvent class"""
5021 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5022 __repr__ = _swig_repr
5023 def __init__(self, *args, **kwargs):
5024 """__init__(self, int winid=0) -> NcPaintEvent"""
5025 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5026 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5027
5028 #---------------------------------------------------------------------------
5029
5030 class EraseEvent(Event):
5031 """
5032 An erase event is sent whenever the background of a window needs to be
5033 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5034 binder. On some platforms, such as GTK+, this event is simulated
5035 (simply generated just before the paint event) and may cause flicker.
5036
5037 To paint a custom background use the `GetDC` method and use the returned
5038 device context if it is not ``None``, otherwise create a temporary
5039 `wx.ClientDC` and draw on that.
5040
5041 """
5042 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5043 __repr__ = _swig_repr
5044 def __init__(self, *args, **kwargs):
5045 """
5046 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5047
5048 Constructor
5049 """
5050 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5051 def GetDC(*args, **kwargs):
5052 """
5053 GetDC(self) -> DC
5054
5055 Returns the device context the event handler should draw upon. If
5056 ``None`` is returned then create a temporary `wx.ClientDC` and use
5057 that instead.
5058 """
5059 return _core_.EraseEvent_GetDC(*args, **kwargs)
5060
5061 _core_.EraseEvent_swigregister(EraseEvent)
5062
5063 #---------------------------------------------------------------------------
5064
5065 class FocusEvent(Event):
5066 """
5067 A focus event is sent when a window's focus changes. The window losing
5068 focus receives an EVT_KILL_FOCUS event while the window gaining it
5069 gets an EVT_SET_FOCUS event.
5070
5071 Notice that the set focus event happens both when the user gives focus
5072 to the window (whether using the mouse or keyboard) and when it is
5073 done from the program itself using `wx.Window.SetFocus`.
5074
5075 """
5076 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5077 __repr__ = _swig_repr
5078 def __init__(self, *args, **kwargs):
5079 """
5080 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5081
5082 Constructor
5083 """
5084 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5085 def GetWindow(*args, **kwargs):
5086 """
5087 GetWindow(self) -> Window
5088
5089 Returns the other window associated with this event, that is the
5090 window which had the focus before for the EVT_SET_FOCUS event and the
5091 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5092
5093 Warning: the window returned may be None!
5094 """
5095 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5096
5097 def SetWindow(*args, **kwargs):
5098 """SetWindow(self, Window win)"""
5099 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5100
5101 _core_.FocusEvent_swigregister(FocusEvent)
5102
5103 #---------------------------------------------------------------------------
5104
5105 class ChildFocusEvent(CommandEvent):
5106 """
5107 wx.ChildFocusEvent notifies the parent that a child has received the
5108 focus. Unlike `wx.FocusEvent` it is propagated up the window
5109 heirarchy.
5110 """
5111 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5112 __repr__ = _swig_repr
5113 def __init__(self, *args, **kwargs):
5114 """
5115 __init__(self, Window win=None) -> ChildFocusEvent
5116
5117 Constructor
5118 """
5119 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5120 def GetWindow(*args, **kwargs):
5121 """
5122 GetWindow(self) -> Window
5123
5124 The window which has just received the focus.
5125 """
5126 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5127
5128 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5129
5130 #---------------------------------------------------------------------------
5131
5132 class ActivateEvent(Event):
5133 """
5134 An activate event is sent when a top-level window or the entire
5135 application is being activated or deactivated.
5136
5137 A top-level window (a dialog or frame) receives an activate event when
5138 is being activated or deactivated. This is indicated visually by the
5139 title bar changing colour, and a subwindow gaining the keyboard focus.
5140 An application is activated or deactivated when one of its frames
5141 becomes activated, or a frame becomes inactivate resulting in all
5142 application frames being inactive.
5143
5144 Please note that usually you should call event.Skip() in your handlers
5145 for these events so the default handlers will still be called, as not
5146 doing so can result in strange effects.
5147
5148 """
5149 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5150 __repr__ = _swig_repr
5151 def __init__(self, *args, **kwargs):
5152 """
5153 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5154
5155 Constructor
5156 """
5157 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5158 def GetActive(*args, **kwargs):
5159 """
5160 GetActive(self) -> bool
5161
5162 Returns true if the application or window is being activated, false
5163 otherwise.
5164 """
5165 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5166
5167 _core_.ActivateEvent_swigregister(ActivateEvent)
5168
5169 #---------------------------------------------------------------------------
5170
5171 class InitDialogEvent(Event):
5172 """
5173 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5174 any window when `wx.Window.InitDialog` is called. Handlers for this
5175 event can transfer data to the window, or anything else that should be
5176 done before the user begins editing the form. The default handler
5177 calls `wx.Window.TransferDataToWindow`.
5178 """
5179 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5180 __repr__ = _swig_repr
5181 def __init__(self, *args, **kwargs):
5182 """
5183 __init__(self, int Id=0) -> InitDialogEvent
5184
5185 Constructor
5186 """
5187 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5188 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5189
5190 #---------------------------------------------------------------------------
5191
5192 class MenuEvent(Event):
5193 """
5194 This class is used for a variety of menu-related events. Note that
5195 these do not include menu command events, which are handled by sending
5196 `wx.CommandEvent` objects.
5197
5198 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5199 text in the first field of the status bar.
5200 """
5201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5202 __repr__ = _swig_repr
5203 def __init__(self, *args, **kwargs):
5204 """
5205 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5206
5207 Constructor
5208 """
5209 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5210 def GetMenuId(*args, **kwargs):
5211 """
5212 GetMenuId(self) -> int
5213
5214 Returns the menu identifier associated with the event. This method
5215 should be only used with the HIGHLIGHT events.
5216 """
5217 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5218
5219 def IsPopup(*args, **kwargs):
5220 """
5221 IsPopup(self) -> bool
5222
5223 Returns ``True`` if the menu which is being opened or closed is a
5224 popup menu, ``False`` if it is a normal one. This method should only
5225 be used with the OPEN and CLOSE events.
5226 """
5227 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5228
5229 def GetMenu(*args, **kwargs):
5230 """
5231 GetMenu(self) -> Menu
5232
5233 Returns the menu which is being opened or closed. This method should
5234 only be used with the OPEN and CLOSE events.
5235 """
5236 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5237
5238 _core_.MenuEvent_swigregister(MenuEvent)
5239
5240 #---------------------------------------------------------------------------
5241
5242 class CloseEvent(Event):
5243 """
5244 This event class contains information about window and session close
5245 events.
5246
5247 The handler function for EVT_CLOSE is called when the user has tried
5248 to close a a frame or dialog box using the window manager controls or
5249 the system menu. It can also be invoked by the application itself
5250 programmatically, for example by calling the `wx.Window.Close`
5251 function.
5252
5253 You should check whether the application is forcing the deletion of
5254 the window using `CanVeto`. If it returns ``False``, you must destroy
5255 the window using `wx.Window.Destroy`. If the return value is ``True``,
5256 it is up to you whether you respond by destroying the window or not.
5257 For example you may wish to display a message dialog prompting to save
5258 files or to cancel the close.
5259
5260 If you don't destroy the window, you should call `Veto` to let the
5261 calling code know that you did not destroy the window. This allows the
5262 `wx.Window.Close` function to return ``True`` or ``False`` depending
5263 on whether the close instruction was honored or not.
5264 """
5265 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5266 __repr__ = _swig_repr
5267 def __init__(self, *args, **kwargs):
5268 """
5269 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5270
5271 Constructor.
5272 """
5273 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5274 def SetLoggingOff(*args, **kwargs):
5275 """
5276 SetLoggingOff(self, bool logOff)
5277
5278 Sets the 'logging off' flag.
5279 """
5280 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5281
5282 def GetLoggingOff(*args, **kwargs):
5283 """
5284 GetLoggingOff(self) -> bool
5285
5286 Returns ``True`` if the user is logging off or ``False`` if the
5287 system is shutting down. This method can only be called for end
5288 session and query end session events, it doesn't make sense for close
5289 window event.
5290 """
5291 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5292
5293 def Veto(*args, **kwargs):
5294 """
5295 Veto(self, bool veto=True)
5296
5297 Call this from your event handler to veto a system shutdown or to
5298 signal to the calling application that a window close did not happen.
5299
5300 You can only veto a shutdown or close if `CanVeto` returns true.
5301 """
5302 return _core_.CloseEvent_Veto(*args, **kwargs)
5303
5304 def GetVeto(*args, **kwargs):
5305 """GetVeto(self) -> bool"""
5306 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5307
5308 def SetCanVeto(*args, **kwargs):
5309 """
5310 SetCanVeto(self, bool canVeto)
5311
5312 Sets the 'can veto' flag.
5313 """
5314 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5315
5316 def CanVeto(*args, **kwargs):
5317 """
5318 CanVeto(self) -> bool
5319
5320 Returns true if you can veto a system shutdown or a window close
5321 event. Vetoing a window close event is not possible if the calling
5322 code wishes to force the application to exit, and so this function
5323 must be called to check this.
5324 """
5325 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5326
5327 _core_.CloseEvent_swigregister(CloseEvent)
5328
5329 #---------------------------------------------------------------------------
5330
5331 class ShowEvent(Event):
5332 """An EVT_SHOW event is sent when a window is shown or hidden."""
5333 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5334 __repr__ = _swig_repr
5335 def __init__(self, *args, **kwargs):
5336 """
5337 __init__(self, int winid=0, bool show=False) -> ShowEvent
5338
5339 An EVT_SHOW event is sent when a window is shown or hidden.
5340 """
5341 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5342 def SetShow(*args, **kwargs):
5343 """SetShow(self, bool show)"""
5344 return _core_.ShowEvent_SetShow(*args, **kwargs)
5345
5346 def GetShow(*args, **kwargs):
5347 """GetShow(self) -> bool"""
5348 return _core_.ShowEvent_GetShow(*args, **kwargs)
5349
5350 _core_.ShowEvent_swigregister(ShowEvent)
5351
5352 #---------------------------------------------------------------------------
5353
5354 class IconizeEvent(Event):
5355 """
5356 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5357 restored.
5358 """
5359 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5360 __repr__ = _swig_repr
5361 def __init__(self, *args, **kwargs):
5362 """
5363 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5364
5365 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5366 restored.
5367 """
5368 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5369 def Iconized(*args, **kwargs):
5370 """
5371 Iconized(self) -> bool
5372
5373 Returns ``True`` if the frame has been iconized, ``False`` if it has
5374 been restored.
5375 """
5376 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5377
5378 _core_.IconizeEvent_swigregister(IconizeEvent)
5379
5380 #---------------------------------------------------------------------------
5381
5382 class MaximizeEvent(Event):
5383 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5384 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5385 __repr__ = _swig_repr
5386 def __init__(self, *args, **kwargs):
5387 """
5388 __init__(self, int id=0) -> MaximizeEvent
5389
5390 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5391 """
5392 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5393 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5394
5395 #---------------------------------------------------------------------------
5396
5397 class DropFilesEvent(Event):
5398 """
5399 This class is used for drop files events, that is, when files have
5400 been dropped onto the window. This functionality is only available
5401 under Windows. The window must have previously been enabled for
5402 dropping by calling `wx.Window.DragAcceptFiles`.
5403
5404 Important note: this is a separate implementation to the more general
5405 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5406 implementation uses the older, Windows message-based approach of
5407 dropping files.
5408
5409 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5410 events.
5411
5412 """
5413 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5414 def __init__(self): raise AttributeError, "No constructor defined"
5415 __repr__ = _swig_repr
5416 def GetPosition(*args, **kwargs):
5417 """
5418 GetPosition(self) -> Point
5419
5420 Returns the position at which the files were dropped.
5421 """
5422 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5423
5424 def GetNumberOfFiles(*args, **kwargs):
5425 """
5426 GetNumberOfFiles(self) -> int
5427
5428 Returns the number of files dropped.
5429 """
5430 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5431
5432 def GetFiles(*args, **kwargs):
5433 """
5434 GetFiles(self) -> PyObject
5435
5436 Returns a list of the filenames that were dropped.
5437 """
5438 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5439
5440 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5441
5442 #---------------------------------------------------------------------------
5443
5444 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5445 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5446 class UpdateUIEvent(CommandEvent):
5447 """
5448 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5449 wxWidgets to give an application the chance to update various user
5450 interface elements.
5451
5452 Without update UI events, an application has to work hard to
5453 check/uncheck, enable/disable, and set the text for elements such as
5454 menu items and toolbar buttons. The code for doing this has to be
5455 mixed up with the code that is invoked when an action is invoked for a
5456 menu item or button.
5457
5458 With update UI events, you define an event handler to look at the
5459 state of the application and change UI elements accordingly. wxWidgets
5460 will call your handler functions in idle time, so you don't have to
5461 worry where to call this code. In addition to being a clearer and more
5462 declarative method, it also means you don't have to worry whether
5463 you're updating a toolbar or menubar identifier. The same handler can
5464 update a menu item and toolbar button, if the ID values are the same.
5465
5466 Instead of directly manipulating the menu or button, you call
5467 functions in the event object, such as `Check`. wxWidgets will
5468 determine whether such a call has been made, and which UI element to
5469 update.
5470
5471 These events will work for popup menus as well as menubars. Just
5472 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5473 any UI events for the window that owns the menu.
5474
5475 If you find that the overhead of UI update processing is affecting
5476 your application, you can do one or both of the following:
5477
5478 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5479 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5480 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5481 receive update events. No other windows will receive update
5482 events.
5483
5484 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5485 value to set the delay between updates. You may need to call
5486 `wx.Window.UpdateWindowUI` at critical points, for example when
5487 a dialog is about to be shown, in case the user sees a slight
5488 delay before windows are updated.
5489
5490 Note that although events are sent in idle time, defining a EVT_IDLE
5491 handler for a window does not affect this because the events are sent
5492 from an internal idle handler.
5493
5494 wxWidgets tries to optimize update events on some platforms. On
5495 Windows and GTK+, events for menubar items are only sent when the menu
5496 is about to be shown, and not in idle time.
5497
5498 """
5499 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5500 __repr__ = _swig_repr
5501 def __init__(self, *args, **kwargs):
5502 """
5503 __init__(self, int commandId=0) -> UpdateUIEvent
5504
5505 Constructor
5506 """
5507 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
5508 def GetChecked(*args, **kwargs):
5509 """
5510 GetChecked(self) -> bool
5511
5512 Returns ``True`` if the UI element should be checked.
5513 """
5514 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5515
5516 def GetEnabled(*args, **kwargs):
5517 """
5518 GetEnabled(self) -> bool
5519
5520 Returns ``True`` if the UI element should be enabled.
5521 """
5522 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5523
5524 def GetShown(*args, **kwargs):
5525 """
5526 GetShown(self) -> bool
5527
5528 Returns ``True`` if the UI element should be shown.
5529 """
5530 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5531
5532 def GetText(*args, **kwargs):
5533 """
5534 GetText(self) -> String
5535
5536 Returns the text that should be set for the UI element.
5537 """
5538 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5539
5540 def GetSetText(*args, **kwargs):
5541 """
5542 GetSetText(self) -> bool
5543
5544 Returns ``True`` if the application has called `SetText`. For
5545 wxWidgets internal use only.
5546 """
5547 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5548
5549 def GetSetChecked(*args, **kwargs):
5550 """
5551 GetSetChecked(self) -> bool
5552
5553 Returns ``True`` if the application has called `Check`. For wxWidgets
5554 internal use only.
5555 """
5556 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5557
5558 def GetSetEnabled(*args, **kwargs):
5559 """
5560 GetSetEnabled(self) -> bool
5561
5562 Returns ``True`` if the application has called `Enable`. For wxWidgets
5563 internal use only.
5564 """
5565 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5566
5567 def GetSetShown(*args, **kwargs):
5568 """
5569 GetSetShown(self) -> bool
5570
5571 Returns ``True`` if the application has called `Show`. For wxWidgets
5572 internal use only.
5573 """
5574 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5575
5576 def Check(*args, **kwargs):
5577 """
5578 Check(self, bool check)
5579
5580 Check or uncheck the UI element.
5581 """
5582 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5583
5584 def Enable(*args, **kwargs):
5585 """
5586 Enable(self, bool enable)
5587
5588 Enable or disable the UI element.
5589 """
5590 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5591
5592 def Show(*args, **kwargs):
5593 """
5594 Show(self, bool show)
5595
5596 Show or hide the UI element.
5597 """
5598 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5599
5600 def SetText(*args, **kwargs):
5601 """
5602 SetText(self, String text)
5603
5604 Sets the text for this UI element.
5605 """
5606 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5607
5608 def SetUpdateInterval(*args, **kwargs):
5609 """
5610 SetUpdateInterval(long updateInterval)
5611
5612 Sets the interval between updates in milliseconds. Set to -1 to
5613 disable updates, or to 0 to update as frequently as possible. The
5614 default is 0.
5615
5616 Use this to reduce the overhead of UI update events if your
5617 application has a lot of windows. If you set the value to -1 or
5618 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5619 at appropriate points in your application, such as when a dialog is
5620 about to be shown.
5621 """
5622 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5623
5624 SetUpdateInterval = staticmethod(SetUpdateInterval)
5625 def GetUpdateInterval(*args, **kwargs):
5626 """
5627 GetUpdateInterval() -> long
5628
5629 Returns the current interval between updates in milliseconds. -1
5630 disables updates, 0 updates as frequently as possible.
5631 """
5632 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5633
5634 GetUpdateInterval = staticmethod(GetUpdateInterval)
5635 def CanUpdate(*args, **kwargs):
5636 """
5637 CanUpdate(Window win) -> bool
5638
5639 Returns ``True`` if it is appropriate to update (send UI update events
5640 to) this window.
5641
5642 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5643 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5644 events were last sent in idle time, and the update interval, to
5645 determine whether events should be sent to this window now. By default
5646 this will always return true because the update mode is initially
5647 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5648 events will be sent as often as possible. You can reduce the frequency
5649 that events are sent by changing the mode and/or setting an update
5650 interval.
5651
5652 """
5653 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5654
5655 CanUpdate = staticmethod(CanUpdate)
5656 def ResetUpdateTime(*args, **kwargs):
5657 """
5658 ResetUpdateTime()
5659
5660 Used internally to reset the last-updated time to the current time. It
5661 is assumed that update events are normally sent in idle time, so this
5662 is called at the end of idle processing.
5663 """
5664 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5665
5666 ResetUpdateTime = staticmethod(ResetUpdateTime)
5667 def SetMode(*args, **kwargs):
5668 """
5669 SetMode(int mode)
5670
5671 Specify how wxWidgets will send update events: to all windows, or only
5672 to those which specify that they will process the events.
5673
5674 The mode may be one of the following values:
5675
5676 ============================= ==========================================
5677 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5678 is the default setting.
5679 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5680 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5681 style set.
5682 ============================= ==========================================
5683
5684 """
5685 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5686
5687 SetMode = staticmethod(SetMode)
5688 def GetMode(*args, **kwargs):
5689 """
5690 GetMode() -> int
5691
5692 Returns a value specifying how wxWidgets will send update events: to
5693 all windows, or only to those which specify that they will process the
5694 events.
5695 """
5696 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5697
5698 GetMode = staticmethod(GetMode)
5699 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
5700
5701 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5702 """
5703 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5704
5705 Sets the interval between updates in milliseconds. Set to -1 to
5706 disable updates, or to 0 to update as frequently as possible. The
5707 default is 0.
5708
5709 Use this to reduce the overhead of UI update events if your
5710 application has a lot of windows. If you set the value to -1 or
5711 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5712 at appropriate points in your application, such as when a dialog is
5713 about to be shown.
5714 """
5715 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5716
5717 def UpdateUIEvent_GetUpdateInterval(*args):
5718 """
5719 UpdateUIEvent_GetUpdateInterval() -> long
5720
5721 Returns the current interval between updates in milliseconds. -1
5722 disables updates, 0 updates as frequently as possible.
5723 """
5724 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
5725
5726 def UpdateUIEvent_CanUpdate(*args, **kwargs):
5727 """
5728 UpdateUIEvent_CanUpdate(Window win) -> bool
5729
5730 Returns ``True`` if it is appropriate to update (send UI update events
5731 to) this window.
5732
5733 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5734 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5735 events were last sent in idle time, and the update interval, to
5736 determine whether events should be sent to this window now. By default
5737 this will always return true because the update mode is initially
5738 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5739 events will be sent as often as possible. You can reduce the frequency
5740 that events are sent by changing the mode and/or setting an update
5741 interval.
5742
5743 """
5744 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5745
5746 def UpdateUIEvent_ResetUpdateTime(*args):
5747 """
5748 UpdateUIEvent_ResetUpdateTime()
5749
5750 Used internally to reset the last-updated time to the current time. It
5751 is assumed that update events are normally sent in idle time, so this
5752 is called at the end of idle processing.
5753 """
5754 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
5755
5756 def UpdateUIEvent_SetMode(*args, **kwargs):
5757 """
5758 UpdateUIEvent_SetMode(int mode)
5759
5760 Specify how wxWidgets will send update events: to all windows, or only
5761 to those which specify that they will process the events.
5762
5763 The mode may be one of the following values:
5764
5765 ============================= ==========================================
5766 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5767 is the default setting.
5768 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5769 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5770 style set.
5771 ============================= ==========================================
5772
5773 """
5774 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5775
5776 def UpdateUIEvent_GetMode(*args):
5777 """
5778 UpdateUIEvent_GetMode() -> int
5779
5780 Returns a value specifying how wxWidgets will send update events: to
5781 all windows, or only to those which specify that they will process the
5782 events.
5783 """
5784 return _core_.UpdateUIEvent_GetMode(*args)
5785
5786 #---------------------------------------------------------------------------
5787
5788 class SysColourChangedEvent(Event):
5789 """
5790 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5791 when the user changes the colour settings using the control
5792 panel. This is only applicable under Windows.
5793
5794 The default event handler for this event propagates the event to child
5795 windows, since Windows only sends the events to top-level windows. If
5796 intercepting this event for a top-level window, remember to call
5797 `Skip` so the the base class handler will still be executed, or to
5798 pass the event on to the window's children explicitly.
5799
5800 """
5801 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5802 __repr__ = _swig_repr
5803 def __init__(self, *args, **kwargs):
5804 """
5805 __init__(self) -> SysColourChangedEvent
5806
5807 Constructor
5808 """
5809 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
5810 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
5811
5812 #---------------------------------------------------------------------------
5813
5814 class MouseCaptureChangedEvent(Event):
5815 """
5816 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
5817 a window that loses its mouse capture. This is called even if
5818 `wx.Window.ReleaseMouse` was called by the application code. Handling
5819 this event allows an application to cater for unexpected capture
5820 releases which might otherwise confuse mouse handling code.
5821
5822 This event is implemented under Windows only.
5823 """
5824 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5825 __repr__ = _swig_repr
5826 def __init__(self, *args, **kwargs):
5827 """
5828 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
5829
5830 Constructor
5831 """
5832 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
5833 def GetCapturedWindow(*args, **kwargs):
5834 """
5835 GetCapturedWindow(self) -> Window
5836
5837 Returns the window that gained the capture, or ``None`` if it was a
5838 non-wxWidgets window.
5839 """
5840 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
5841
5842 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
5843
5844 #---------------------------------------------------------------------------
5845
5846 class DisplayChangedEvent(Event):
5847 """
5848 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
5849 resolution has changed.
5850
5851 This event is implemented under Windows only.
5852 """
5853 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5854 __repr__ = _swig_repr
5855 def __init__(self, *args, **kwargs):
5856 """__init__(self) -> DisplayChangedEvent"""
5857 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
5858 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
5859
5860 #---------------------------------------------------------------------------
5861
5862 class PaletteChangedEvent(Event):
5863 """
5864 An EVT_PALETTE_CHANGED event is sent when the system palette has
5865 changed, thereby giving each window a chance to redo their own to
5866 match.
5867
5868 This event is implemented under Windows only.
5869 """
5870 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5871 __repr__ = _swig_repr
5872 def __init__(self, *args, **kwargs):
5873 """
5874 __init__(self, int id=0) -> PaletteChangedEvent
5875
5876 An EVT_PALETTE_CHANGED event is sent when the system palette has
5877 changed, thereby giving each window a chance to redo their own to
5878 match.
5879
5880 This event is implemented under Windows only.
5881 """
5882 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
5883 def SetChangedWindow(*args, **kwargs):
5884 """SetChangedWindow(self, Window win)"""
5885 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
5886
5887 def GetChangedWindow(*args, **kwargs):
5888 """GetChangedWindow(self) -> Window"""
5889 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
5890
5891 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
5892
5893 #---------------------------------------------------------------------------
5894
5895 class QueryNewPaletteEvent(Event):
5896 """
5897 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
5898 focus and should re-do its palette.
5899
5900 This event is implemented under Windows only.
5901 """
5902 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5903 __repr__ = _swig_repr
5904 def __init__(self, *args, **kwargs):
5905 """
5906 __init__(self, int winid=0) -> QueryNewPaletteEvent
5907
5908 Constructor.
5909 """
5910 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
5911 def SetPaletteRealized(*args, **kwargs):
5912 """
5913 SetPaletteRealized(self, bool realized)
5914
5915 App should set this if it changes the palette.
5916 """
5917 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
5918
5919 def GetPaletteRealized(*args, **kwargs):
5920 """GetPaletteRealized(self) -> bool"""
5921 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
5922
5923 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
5924
5925 #---------------------------------------------------------------------------
5926
5927 class NavigationKeyEvent(Event):
5928 """
5929 EVT_NAVIGATION_KEY events are used to control moving the focus between
5930 widgets, otherwise known as tab-traversal. You woudl normally not
5931 catch navigation events in applications as there are already
5932 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
5933 it useful to send navigation events in certain situations to change
5934 the focus in certain ways, although it's probably easier to just call
5935 `wx.Window.Navigate`.
5936 """
5937 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5938 __repr__ = _swig_repr
5939 def __init__(self, *args, **kwargs):
5940 """__init__(self) -> NavigationKeyEvent"""
5941 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
5942 def GetDirection(*args, **kwargs):
5943 """
5944 GetDirection(self) -> bool
5945
5946 Returns ``True`` if the direction is forward, ``False`` otherwise.
5947 """
5948 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
5949
5950 def SetDirection(*args, **kwargs):
5951 """
5952 SetDirection(self, bool forward)
5953
5954 Specify the direction that the navigation should take. Usually the
5955 difference between using Tab and Shift-Tab.
5956 """
5957 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
5958
5959 def IsWindowChange(*args, **kwargs):
5960 """
5961 IsWindowChange(self) -> bool
5962
5963 Returns ``True`` if window change is allowed.
5964 """
5965 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
5966
5967 def SetWindowChange(*args, **kwargs):
5968 """
5969 SetWindowChange(self, bool ischange)
5970
5971 Specify if the navigation should be able to change parent windows.
5972 For example, changing notebook pages, etc. This is usually implemented
5973 by using Control-Tab.
5974 """
5975 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
5976
5977 def IsFromTab(*args, **kwargs):
5978 """
5979 IsFromTab(self) -> bool
5980
5981 Returns ``True`` if the navigation event is originated from the Tab
5982 key.
5983 """
5984 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
5985
5986 def SetFromTab(*args, **kwargs):
5987 """
5988 SetFromTab(self, bool bIs)
5989
5990 Set to true under MSW if the event was generated using the tab key.
5991 This is required for proper navogation over radio buttons.
5992 """
5993 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
5994
5995 def SetFlags(*args, **kwargs):
5996 """
5997 SetFlags(self, long flags)
5998
5999 Set the navigation flags to a combination of the following:
6000
6001 * wx.NavigationKeyEvent.IsBackward
6002 * wx.NavigationKeyEvent.IsForward
6003 * wx.NavigationKeyEvent.WinChange
6004 * wx.NavigationKeyEvent.FromTab
6005
6006 """
6007 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6008
6009 def GetCurrentFocus(*args, **kwargs):
6010 """
6011 GetCurrentFocus(self) -> Window
6012
6013 Returns the child window which currenty has the focus. May be
6014 ``None``.
6015 """
6016 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6017
6018 def SetCurrentFocus(*args, **kwargs):
6019 """
6020 SetCurrentFocus(self, Window win)
6021
6022 Set the window that has the focus.
6023 """
6024 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6025
6026 IsBackward = _core_.NavigationKeyEvent_IsBackward
6027 IsForward = _core_.NavigationKeyEvent_IsForward
6028 WinChange = _core_.NavigationKeyEvent_WinChange
6029 FromTab = _core_.NavigationKeyEvent_FromTab
6030 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6031
6032 #---------------------------------------------------------------------------
6033
6034 class WindowCreateEvent(CommandEvent):
6035 """
6036 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6037 underlying GUI object) exists.
6038 """
6039 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6040 __repr__ = _swig_repr
6041 def __init__(self, *args, **kwargs):
6042 """
6043 __init__(self, Window win=None) -> WindowCreateEvent
6044
6045 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6046 underlying GUI object) exists.
6047 """
6048 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6049 def GetWindow(*args, **kwargs):
6050 """
6051 GetWindow(self) -> Window
6052
6053 Returns the window that this event refers to.
6054 """
6055 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6056
6057 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6058
6059 class WindowDestroyEvent(CommandEvent):
6060 """
6061 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6062 when the GUI window is destroyed.
6063
6064 When a class derived from `wx.Window` is destroyed its destructor will
6065 have already run by the time this event is sent. Therefore this event
6066 will not usually be received at all by the window itself. Since it is
6067 received after the destructor has run, an object should not try to
6068 handle its own wx.WindowDestroyEvent, but it can be used to get
6069 notification of the destruction of another window.
6070 """
6071 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6072 __repr__ = _swig_repr
6073 def __init__(self, *args, **kwargs):
6074 """
6075 __init__(self, Window win=None) -> WindowDestroyEvent
6076
6077 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6078 when the GUI window is destroyed.
6079
6080 When a class derived from `wx.Window` is destroyed its destructor will
6081 have already run by the time this event is sent. Therefore this event
6082 will not usually be received at all by the window itself. Since it is
6083 received after the destructor has run, an object should not try to
6084 handle its own wx.WindowDestroyEvent, but it can be used to get
6085 notification of the destruction of another window.
6086 """
6087 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6088 def GetWindow(*args, **kwargs):
6089 """
6090 GetWindow(self) -> Window
6091
6092 Returns the window that this event refers to.
6093 """
6094 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6095
6096 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6097
6098 #---------------------------------------------------------------------------
6099
6100 class ContextMenuEvent(CommandEvent):
6101 """
6102 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6103 give the application a chance to show a context (popup) menu.
6104 """
6105 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6106 __repr__ = _swig_repr
6107 def __init__(self, *args, **kwargs):
6108 """
6109 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6110
6111 Constructor.
6112 """
6113 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6114 def GetPosition(*args, **kwargs):
6115 """
6116 GetPosition(self) -> Point
6117
6118 Returns the position (in screen coordinants) at which the menu should
6119 be shown.
6120 """
6121 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6122
6123 def SetPosition(*args, **kwargs):
6124 """
6125 SetPosition(self, Point pos)
6126
6127 Sets the position at which the menu should be shown.
6128 """
6129 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6130
6131 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6132
6133 #---------------------------------------------------------------------------
6134
6135 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6136 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6137 class IdleEvent(Event):
6138 """
6139 This class is used for EVT_IDLE events, which are generated and sent
6140 when the application *becomes* idle. In other words, the when the
6141 event queue becomes empty then idle events are sent to all windows (by
6142 default) and as long as none of them call `RequestMore` then there are
6143 no more idle events until after the system event queue has some normal
6144 events and then becomes empty again.
6145
6146 By default, idle events are sent to all windows. If this is causing a
6147 significant overhead in your application, you can call
6148 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6149 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6150 which should receive idle events. Then idle events will only be sent
6151 to those windows and not to any others.
6152 """
6153 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6154 __repr__ = _swig_repr
6155 def __init__(self, *args, **kwargs):
6156 """
6157 __init__(self) -> IdleEvent
6158
6159 Constructor
6160 """
6161 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6162 def RequestMore(*args, **kwargs):
6163 """
6164 RequestMore(self, bool needMore=True)
6165
6166 Tells wxWidgets that more processing is required. This function can be
6167 called by an EVT_IDLE handler for a window to indicate that the
6168 application should forward the EVT_IDLE event once more to the
6169 application windows. If no window calls this function during its
6170 EVT_IDLE handler, then the application will remain in a passive event
6171 loop until a new event is posted to the application by the windowing
6172 system.
6173 """
6174 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6175
6176 def MoreRequested(*args, **kwargs):
6177 """
6178 MoreRequested(self) -> bool
6179
6180 Returns ``True`` if the OnIdle function processing this event
6181 requested more processing time.
6182 """
6183 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6184
6185 def SetMode(*args, **kwargs):
6186 """
6187 SetMode(int mode)
6188
6189 Static method for specifying how wxWidgets will send idle events: to
6190 all windows, or only to those which specify that they will process the
6191 events.
6192
6193 The mode can be one of the following values:
6194
6195 ========================= ========================================
6196 wx.IDLE_PROCESS_ALL Send idle events to all windows
6197 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6198 the wx.WS_EX_PROCESS_IDLE extra style
6199 flag set.
6200 ========================= ========================================
6201
6202 """
6203 return _core_.IdleEvent_SetMode(*args, **kwargs)
6204
6205 SetMode = staticmethod(SetMode)
6206 def GetMode(*args, **kwargs):
6207 """
6208 GetMode() -> int
6209
6210 Static method returning a value specifying how wxWidgets will send
6211 idle events: to all windows, or only to those which specify that they
6212 will process the events.
6213 """
6214 return _core_.IdleEvent_GetMode(*args, **kwargs)
6215
6216 GetMode = staticmethod(GetMode)
6217 def CanSend(*args, **kwargs):
6218 """
6219 CanSend(Window win) -> bool
6220
6221 Returns ``True`` if it is appropriate to send idle events to this
6222 window.
6223
6224 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6225 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6226 events should be sent to this window now. By default this will always
6227 return ``True`` because the update mode is initially
6228 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6229 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6230 """
6231 return _core_.IdleEvent_CanSend(*args, **kwargs)
6232
6233 CanSend = staticmethod(CanSend)
6234 _core_.IdleEvent_swigregister(IdleEvent)
6235
6236 def IdleEvent_SetMode(*args, **kwargs):
6237 """
6238 IdleEvent_SetMode(int mode)
6239
6240 Static method for specifying how wxWidgets will send idle events: to
6241 all windows, or only to those which specify that they will process the
6242 events.
6243
6244 The mode can be one of the following values:
6245
6246 ========================= ========================================
6247 wx.IDLE_PROCESS_ALL Send idle events to all windows
6248 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6249 the wx.WS_EX_PROCESS_IDLE extra style
6250 flag set.
6251 ========================= ========================================
6252
6253 """
6254 return _core_.IdleEvent_SetMode(*args, **kwargs)
6255
6256 def IdleEvent_GetMode(*args):
6257 """
6258 IdleEvent_GetMode() -> int
6259
6260 Static method returning a value specifying how wxWidgets will send
6261 idle events: to all windows, or only to those which specify that they
6262 will process the events.
6263 """
6264 return _core_.IdleEvent_GetMode(*args)
6265
6266 def IdleEvent_CanSend(*args, **kwargs):
6267 """
6268 IdleEvent_CanSend(Window win) -> bool
6269
6270 Returns ``True`` if it is appropriate to send idle events to this
6271 window.
6272
6273 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6274 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6275 events should be sent to this window now. By default this will always
6276 return ``True`` because the update mode is initially
6277 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6278 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6279 """
6280 return _core_.IdleEvent_CanSend(*args, **kwargs)
6281
6282 #---------------------------------------------------------------------------
6283
6284 class ClipboardTextEvent(CommandEvent):
6285 """
6286 A Clipboard Text event is sent when a window intercepts a text
6287 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6288 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6289 popup menu command, etc. NOTE : under windows these events are *NOT*
6290 generated automatically for a Rich Edit text control.
6291 """
6292 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6293 __repr__ = _swig_repr
6294 def __init__(self, *args, **kwargs):
6295 """
6296 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6297
6298 A Clipboard Text event is sent when a window intercepts a text
6299 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6300 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6301 popup menu command, etc. NOTE : under windows these events are *NOT*
6302 generated automatically for a Rich Edit text control.
6303 """
6304 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6305 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6306
6307 #---------------------------------------------------------------------------
6308
6309 class PyEvent(Event):
6310 """
6311 wx.PyEvent can be used as a base class for implementing custom event
6312 types in Python. You should derived from this class instead of
6313 `wx.Event` because this class is Python-aware and is able to transport
6314 its Python bits safely through the wxWidgets event system and have
6315 them still be there when the event handler is invoked.
6316
6317 :see: `wx.PyCommandEvent`
6318
6319 """
6320 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6321 __repr__ = _swig_repr
6322 def __init__(self, *args, **kwargs):
6323 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6324 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6325 self._SetSelf(self)
6326
6327 __swig_destroy__ = _core_.delete_PyEvent
6328 __del__ = lambda self : None;
6329 def _SetSelf(*args, **kwargs):
6330 """_SetSelf(self, PyObject self)"""
6331 return _core_.PyEvent__SetSelf(*args, **kwargs)
6332
6333 def _GetSelf(*args, **kwargs):
6334 """_GetSelf(self) -> PyObject"""
6335 return _core_.PyEvent__GetSelf(*args, **kwargs)
6336
6337 _core_.PyEvent_swigregister(PyEvent)
6338
6339 class PyCommandEvent(CommandEvent):
6340 """
6341 wx.PyCommandEvent can be used as a base class for implementing custom
6342 event types in Python, where the event shoudl travel up to parent
6343 windows looking for a handler. You should derived from this class
6344 instead of `wx.CommandEvent` because this class is Python-aware and is
6345 able to transport its Python bits safely through the wxWidgets event
6346 system and have them still be there when the event handler is invoked.
6347
6348 :see: `wx.PyEvent`
6349
6350 """
6351 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6352 __repr__ = _swig_repr
6353 def __init__(self, *args, **kwargs):
6354 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6355 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6356 self._SetSelf(self)
6357
6358 __swig_destroy__ = _core_.delete_PyCommandEvent
6359 __del__ = lambda self : None;
6360 def _SetSelf(*args, **kwargs):
6361 """_SetSelf(self, PyObject self)"""
6362 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6363
6364 def _GetSelf(*args, **kwargs):
6365 """_GetSelf(self) -> PyObject"""
6366 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6367
6368 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6369
6370 class DateEvent(CommandEvent):
6371 """
6372 This event class holds information about a date change event and is
6373 used together with `wx.DatePickerCtrl`. It also serves as a base class
6374 for `wx.calendar.CalendarEvent`. Bind these event types with
6375 EVT_DATE_CHANGED.
6376 """
6377 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6378 __repr__ = _swig_repr
6379 def __init__(self, *args, **kwargs):
6380 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6381 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6382 def GetDate(*args, **kwargs):
6383 """
6384 GetDate(self) -> DateTime
6385
6386 Returns the date.
6387 """
6388 return _core_.DateEvent_GetDate(*args, **kwargs)
6389
6390 def SetDate(*args, **kwargs):
6391 """
6392 SetDate(self, DateTime date)
6393
6394 Sets the date carried by the event, normally only used by the library
6395 internally.
6396 """
6397 return _core_.DateEvent_SetDate(*args, **kwargs)
6398
6399 _core_.DateEvent_swigregister(DateEvent)
6400
6401 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6402 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6403
6404 #---------------------------------------------------------------------------
6405
6406 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6407 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6408 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6409 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6410 PRINT_WINDOWS = _core_.PRINT_WINDOWS
6411 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6412 class PyApp(EvtHandler):
6413 """
6414 The ``wx.PyApp`` class is an *implementation detail*, please use the
6415 `wx.App` class (or some other derived class) instead.
6416 """
6417 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6418 __repr__ = _swig_repr
6419 def __init__(self, *args, **kwargs):
6420 """
6421 __init__(self) -> PyApp
6422
6423 Create a new application object, starting the bootstrap process.
6424 """
6425 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
6426 self._setCallbackInfo(self, PyApp, False)
6427 self._setOORInfo(self, False)
6428
6429 __swig_destroy__ = _core_.delete_PyApp
6430 __del__ = lambda self : None;
6431 def _setCallbackInfo(*args, **kwargs):
6432 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6433 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6434
6435 def GetAppName(*args, **kwargs):
6436 """
6437 GetAppName(self) -> String
6438
6439 Get the application name.
6440 """
6441 return _core_.PyApp_GetAppName(*args, **kwargs)
6442
6443 def SetAppName(*args, **kwargs):
6444 """
6445 SetAppName(self, String name)
6446
6447 Set the application name. This value may be used automatically by
6448 `wx.Config` and such.
6449 """
6450 return _core_.PyApp_SetAppName(*args, **kwargs)
6451
6452 def GetClassName(*args, **kwargs):
6453 """
6454 GetClassName(self) -> String
6455
6456 Get the application's class name.
6457 """
6458 return _core_.PyApp_GetClassName(*args, **kwargs)
6459
6460 def SetClassName(*args, **kwargs):
6461 """
6462 SetClassName(self, String name)
6463
6464 Set the application's class name. This value may be used for
6465 X-resources if applicable for the platform
6466 """
6467 return _core_.PyApp_SetClassName(*args, **kwargs)
6468
6469 def GetVendorName(*args, **kwargs):
6470 """
6471 GetVendorName(self) -> String
6472
6473 Get the application's vendor name.
6474 """
6475 return _core_.PyApp_GetVendorName(*args, **kwargs)
6476
6477 def SetVendorName(*args, **kwargs):
6478 """
6479 SetVendorName(self, String name)
6480
6481 Set the application's vendor name. This value may be used
6482 automatically by `wx.Config` and such.
6483 """
6484 return _core_.PyApp_SetVendorName(*args, **kwargs)
6485
6486 def GetTraits(*args, **kwargs):
6487 """
6488 GetTraits(self) -> wxAppTraits
6489
6490 Return (and create if necessary) the app traits object to which we
6491 delegate for everything which either should be configurable by the
6492 user (then he can change the default behaviour simply by overriding
6493 CreateTraits() and returning his own traits object) or which is
6494 GUI/console dependent as then wx.AppTraits allows us to abstract the
6495 differences behind the common facade.
6496
6497 :todo: Add support for overriding CreateAppTraits in wxPython.
6498 """
6499 return _core_.PyApp_GetTraits(*args, **kwargs)
6500
6501 def ProcessPendingEvents(*args, **kwargs):
6502 """
6503 ProcessPendingEvents(self)
6504
6505 Process all events in the Pending Events list -- it is necessary to
6506 call this function to process posted events. This normally happens
6507 during each event loop iteration.
6508 """
6509 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6510
6511 def Yield(*args, **kwargs):
6512 """
6513 Yield(self, bool onlyIfNeeded=False) -> bool
6514
6515 Process all currently pending events right now, instead of waiting
6516 until return to the event loop. It is an error to call ``Yield``
6517 recursively unless the value of ``onlyIfNeeded`` is True.
6518
6519 :warning: This function is dangerous as it can lead to unexpected
6520 reentrancies (i.e. when called from an event handler it may
6521 result in calling the same event handler again), use with
6522 extreme care or, better, don't use at all!
6523
6524 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6525
6526 """
6527 return _core_.PyApp_Yield(*args, **kwargs)
6528
6529 def WakeUpIdle(*args, **kwargs):
6530 """
6531 WakeUpIdle(self)
6532
6533 Make sure that idle events are sent again.
6534 :see: `wx.WakeUpIdle`
6535 """
6536 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6537
6538 def IsMainLoopRunning(*args, **kwargs):
6539 """
6540 IsMainLoopRunning() -> bool
6541
6542 Returns True if we're running the main loop, i.e. if the events can
6543 currently be dispatched.
6544 """
6545 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6546
6547 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
6548 def MainLoop(*args, **kwargs):
6549 """
6550 MainLoop(self) -> int
6551
6552 Execute the main GUI loop, the function doesn't normally return until
6553 all top level windows have been closed and destroyed.
6554 """
6555 return _core_.PyApp_MainLoop(*args, **kwargs)
6556
6557 def Exit(*args, **kwargs):
6558 """
6559 Exit(self)
6560
6561 Exit the main loop thus terminating the application.
6562 :see: `wx.Exit`
6563 """
6564 return _core_.PyApp_Exit(*args, **kwargs)
6565
6566 def ExitMainLoop(*args, **kwargs):
6567 """
6568 ExitMainLoop(self)
6569
6570 Exit the main GUI loop during the next iteration of the main
6571 loop, (i.e. it does not stop the program immediately!)
6572 """
6573 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6574
6575 def Pending(*args, **kwargs):
6576 """
6577 Pending(self) -> bool
6578
6579 Returns True if there are unprocessed events in the event queue.
6580 """
6581 return _core_.PyApp_Pending(*args, **kwargs)
6582
6583 def Dispatch(*args, **kwargs):
6584 """
6585 Dispatch(self) -> bool
6586
6587 Process the first event in the event queue (blocks until an event
6588 appears if there are none currently)
6589 """
6590 return _core_.PyApp_Dispatch(*args, **kwargs)
6591
6592 def ProcessIdle(*args, **kwargs):
6593 """
6594 ProcessIdle(self) -> bool
6595
6596 Called from the MainLoop when the application becomes idle (there are
6597 no pending events) and sends a `wx.IdleEvent` to all interested
6598 parties. Returns True if more idle events are needed, False if not.
6599 """
6600 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6601
6602 def SendIdleEvents(*args, **kwargs):
6603 """
6604 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6605
6606 Send idle event to window and all subwindows. Returns True if more
6607 idle time is requested.
6608 """
6609 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6610
6611 def IsActive(*args, **kwargs):
6612 """
6613 IsActive(self) -> bool
6614
6615 Return True if our app has focus.
6616 """
6617 return _core_.PyApp_IsActive(*args, **kwargs)
6618
6619 def SetTopWindow(*args, **kwargs):
6620 """
6621 SetTopWindow(self, Window win)
6622
6623 Set the *main* top level window
6624 """
6625 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6626
6627 def GetTopWindow(*args, **kwargs):
6628 """
6629 GetTopWindow(self) -> Window
6630
6631 Return the *main* top level window (if it hadn't been set previously
6632 with SetTopWindow(), will return just some top level window and, if
6633 there not any, will return None)
6634 """
6635 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6636
6637 def SetExitOnFrameDelete(*args, **kwargs):
6638 """
6639 SetExitOnFrameDelete(self, bool flag)
6640
6641 Control the exit behaviour: by default, the program will exit the main
6642 loop (and so, usually, terminate) when the last top-level program
6643 window is deleted. Beware that if you disable this behaviour (with
6644 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6645 explicitly from somewhere.
6646 """
6647 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6648
6649 def GetExitOnFrameDelete(*args, **kwargs):
6650 """
6651 GetExitOnFrameDelete(self) -> bool
6652
6653 Get the current exit behaviour setting.
6654 """
6655 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6656
6657 def SetUseBestVisual(*args, **kwargs):
6658 """
6659 SetUseBestVisual(self, bool flag)
6660
6661 Set whether the app should try to use the best available visual on
6662 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6663 """
6664 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6665
6666 def GetUseBestVisual(*args, **kwargs):
6667 """
6668 GetUseBestVisual(self) -> bool
6669
6670 Get current UseBestVisual setting.
6671 """
6672 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6673
6674 def SetPrintMode(*args, **kwargs):
6675 """SetPrintMode(self, int mode)"""
6676 return _core_.PyApp_SetPrintMode(*args, **kwargs)
6677
6678 def GetPrintMode(*args, **kwargs):
6679 """GetPrintMode(self) -> int"""
6680 return _core_.PyApp_GetPrintMode(*args, **kwargs)
6681
6682 def SetAssertMode(*args, **kwargs):
6683 """
6684 SetAssertMode(self, int mode)
6685
6686 Set the OnAssert behaviour for debug and hybrid builds.
6687 """
6688 return _core_.PyApp_SetAssertMode(*args, **kwargs)
6689
6690 def GetAssertMode(*args, **kwargs):
6691 """
6692 GetAssertMode(self) -> int
6693
6694 Get the current OnAssert behaviour setting.
6695 """
6696 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6697
6698 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
6699 """GetMacSupportPCMenuShortcuts() -> bool"""
6700 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
6701
6702 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
6703 def GetMacAboutMenuItemId(*args, **kwargs):
6704 """GetMacAboutMenuItemId() -> long"""
6705 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
6706
6707 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
6708 def GetMacPreferencesMenuItemId(*args, **kwargs):
6709 """GetMacPreferencesMenuItemId() -> long"""
6710 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
6711
6712 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
6713 def GetMacExitMenuItemId(*args, **kwargs):
6714 """GetMacExitMenuItemId() -> long"""
6715 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
6716
6717 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
6718 def GetMacHelpMenuTitleName(*args, **kwargs):
6719 """GetMacHelpMenuTitleName() -> String"""
6720 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
6721
6722 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
6723 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
6724 """SetMacSupportPCMenuShortcuts(bool val)"""
6725 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6726
6727 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
6728 def SetMacAboutMenuItemId(*args, **kwargs):
6729 """SetMacAboutMenuItemId(long val)"""
6730 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6731
6732 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
6733 def SetMacPreferencesMenuItemId(*args, **kwargs):
6734 """SetMacPreferencesMenuItemId(long val)"""
6735 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6736
6737 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
6738 def SetMacExitMenuItemId(*args, **kwargs):
6739 """SetMacExitMenuItemId(long val)"""
6740 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6741
6742 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
6743 def SetMacHelpMenuTitleName(*args, **kwargs):
6744 """SetMacHelpMenuTitleName(String val)"""
6745 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6746
6747 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
6748 def _BootstrapApp(*args, **kwargs):
6749 """
6750 _BootstrapApp(self)
6751
6752 For internal use only
6753 """
6754 return _core_.PyApp__BootstrapApp(*args, **kwargs)
6755
6756 def GetComCtl32Version(*args, **kwargs):
6757 """
6758 GetComCtl32Version() -> int
6759
6760 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6761 it wasn't found at all. Raises an exception on non-Windows platforms.
6762 """
6763 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
6764
6765 GetComCtl32Version = staticmethod(GetComCtl32Version)
6766 _core_.PyApp_swigregister(PyApp)
6767
6768 def PyApp_IsMainLoopRunning(*args):
6769 """
6770 PyApp_IsMainLoopRunning() -> bool
6771
6772 Returns True if we're running the main loop, i.e. if the events can
6773 currently be dispatched.
6774 """
6775 return _core_.PyApp_IsMainLoopRunning(*args)
6776
6777 def PyApp_GetMacSupportPCMenuShortcuts(*args):
6778 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
6779 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
6780
6781 def PyApp_GetMacAboutMenuItemId(*args):
6782 """PyApp_GetMacAboutMenuItemId() -> long"""
6783 return _core_.PyApp_GetMacAboutMenuItemId(*args)
6784
6785 def PyApp_GetMacPreferencesMenuItemId(*args):
6786 """PyApp_GetMacPreferencesMenuItemId() -> long"""
6787 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
6788
6789 def PyApp_GetMacExitMenuItemId(*args):
6790 """PyApp_GetMacExitMenuItemId() -> long"""
6791 return _core_.PyApp_GetMacExitMenuItemId(*args)
6792
6793 def PyApp_GetMacHelpMenuTitleName(*args):
6794 """PyApp_GetMacHelpMenuTitleName() -> String"""
6795 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
6796
6797 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
6798 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
6799 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6800
6801 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
6802 """PyApp_SetMacAboutMenuItemId(long val)"""
6803 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6804
6805 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
6806 """PyApp_SetMacPreferencesMenuItemId(long val)"""
6807 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6808
6809 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
6810 """PyApp_SetMacExitMenuItemId(long val)"""
6811 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6812
6813 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
6814 """PyApp_SetMacHelpMenuTitleName(String val)"""
6815 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6816
6817 def PyApp_GetComCtl32Version(*args):
6818 """
6819 PyApp_GetComCtl32Version() -> int
6820
6821 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6822 it wasn't found at all. Raises an exception on non-Windows platforms.
6823 """
6824 return _core_.PyApp_GetComCtl32Version(*args)
6825
6826 #---------------------------------------------------------------------------
6827
6828
6829 def Exit(*args):
6830 """
6831 Exit()
6832
6833 Force an exit of the application. Convenience for wx.GetApp().Exit()
6834 """
6835 return _core_.Exit(*args)
6836
6837 def Yield(*args):
6838 """
6839 Yield() -> bool
6840
6841 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
6842 """
6843 return _core_.Yield(*args)
6844
6845 def YieldIfNeeded(*args):
6846 """
6847 YieldIfNeeded() -> bool
6848
6849 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
6850 """
6851 return _core_.YieldIfNeeded(*args)
6852
6853 def SafeYield(*args, **kwargs):
6854 """
6855 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6856
6857 This function is similar to `wx.Yield`, except that it disables the
6858 user input to all program windows before calling `wx.Yield` and
6859 re-enables it again afterwards. If ``win`` is not None, this window
6860 will remain enabled, allowing the implementation of some limited user
6861 interaction.
6862
6863 :Returns: the result of the call to `wx.Yield`.
6864 """
6865 return _core_.SafeYield(*args, **kwargs)
6866
6867 def WakeUpIdle(*args):
6868 """
6869 WakeUpIdle()
6870
6871 Cause the message queue to become empty again, so idle events will be
6872 sent.
6873 """
6874 return _core_.WakeUpIdle(*args)
6875
6876 def PostEvent(*args, **kwargs):
6877 """
6878 PostEvent(EvtHandler dest, Event event)
6879
6880 Send an event to a window or other wx.EvtHandler to be processed
6881 later.
6882 """
6883 return _core_.PostEvent(*args, **kwargs)
6884
6885 def App_CleanUp(*args):
6886 """
6887 App_CleanUp()
6888
6889 For internal use only, it is used to cleanup after wxWidgets when
6890 Python shuts down.
6891 """
6892 return _core_.App_CleanUp(*args)
6893
6894 def GetApp(*args):
6895 """
6896 GetApp() -> PyApp
6897
6898 Return a reference to the current wx.App object.
6899 """
6900 return _core_.GetApp(*args)
6901
6902 def SetDefaultPyEncoding(*args, **kwargs):
6903 """
6904 SetDefaultPyEncoding(string encoding)
6905
6906 Sets the encoding that wxPython will use when it needs to convert a
6907 Python string or unicode object to or from a wxString.
6908
6909 The default encoding is the value of ``locale.getdefaultlocale()[1]``
6910 but please be aware that the default encoding within the same locale
6911 may be slightly different on different platforms. For example, please
6912 see http://www.alanwood.net/demos/charsetdiffs.html for differences
6913 between the common latin/roman encodings.
6914 """
6915 return _core_.SetDefaultPyEncoding(*args, **kwargs)
6916
6917 def GetDefaultPyEncoding(*args):
6918 """
6919 GetDefaultPyEncoding() -> string
6920
6921 Gets the current encoding that wxPython will use when it needs to
6922 convert a Python string or unicode object to or from a wxString.
6923 """
6924 return _core_.GetDefaultPyEncoding(*args)
6925 #----------------------------------------------------------------------
6926
6927 class PyOnDemandOutputWindow:
6928 """
6929 A class that can be used for redirecting Python's stdout and
6930 stderr streams. It will do nothing until something is wrriten to
6931 the stream at which point it will create a Frame with a text area
6932 and write the text there.
6933 """
6934 def __init__(self, title = "wxPython: stdout/stderr"):
6935 self.frame = None
6936 self.title = title
6937 self.pos = wx.DefaultPosition
6938 self.size = (450, 300)
6939 self.parent = None
6940
6941 def SetParent(self, parent):
6942 """Set the window to be used as the popup Frame's parent."""
6943 self.parent = parent
6944
6945
6946 def CreateOutputWindow(self, st):
6947 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
6948 style=wx.DEFAULT_FRAME_STYLE)
6949 self.text = wx.TextCtrl(self.frame, -1, "",
6950 style=wx.TE_MULTILINE|wx.TE_READONLY)
6951 self.text.AppendText(st)
6952 self.frame.Show(True)
6953 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
6954
6955
6956 def OnCloseWindow(self, event):
6957 if self.frame is not None:
6958 self.frame.Destroy()
6959 self.frame = None
6960 self.text = None
6961
6962
6963 # These methods provide the file-like output behaviour.
6964 def write(self, text):
6965 """
6966 Create the output window if needed and write the string to it.
6967 If not called in the context of the gui thread then uses
6968 CallAfter to do the work there.
6969 """
6970 if self.frame is None:
6971 if not wx.Thread_IsMain():
6972 wx.CallAfter(self.CreateOutputWindow, text)
6973 else:
6974 self.CreateOutputWindow(text)
6975 else:
6976 if not wx.Thread_IsMain():
6977 wx.CallAfter(self.text.AppendText, text)
6978 else:
6979 self.text.AppendText(text)
6980
6981
6982 def close(self):
6983 if self.frame is not None:
6984 wx.CallAfter(self.frame.Close)
6985
6986
6987 def flush(self):
6988 pass
6989
6990
6991
6992 #----------------------------------------------------------------------
6993
6994 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
6995
6996 class App(wx.PyApp):
6997 """
6998 The ``wx.App`` class represents the application and is used to:
6999
7000 * bootstrap the wxPython system and initialize the underlying
7001 gui toolkit
7002 * set and get application-wide properties
7003 * implement the windowing system main message or event loop,
7004 and to dispatch events to window instances
7005 * etc.
7006
7007 Every application must have a ``wx.App`` instance, and all
7008 creation of UI objects should be delayed until after the
7009 ``wx.App`` object has been created in order to ensure that the gui
7010 platform and wxWidgets have been fully initialized.
7011
7012 Normally you would derive from this class and implement an
7013 ``OnInit`` method that creates a frame and then calls
7014 ``self.SetTopWindow(frame)``.
7015
7016 :see: `wx.PySimpleApp` for a simpler app class that can be used
7017 directly.
7018 """
7019
7020 outputWindowClass = PyOnDemandOutputWindow
7021
7022 def __init__(self, redirect=_defRedirect, filename=None,
7023 useBestVisual=False, clearSigInt=True):
7024 """
7025 Construct a ``wx.App`` object.
7026
7027 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7028 redirected? Defaults to True on Windows and Mac, False
7029 otherwise. If `filename` is None then output will be
7030 redirected to a window that pops up as needed. (You can
7031 control what kind of window is created for the output by
7032 resetting the class variable ``outputWindowClass`` to a
7033 class of your choosing.)
7034
7035 :param filename: The name of a file to redirect output to, if
7036 redirect is True.
7037
7038 :param useBestVisual: Should the app try to use the best
7039 available visual provided by the system (only relevant on
7040 systems that have more than one visual.) This parameter
7041 must be used instead of calling `SetUseBestVisual` later
7042 on because it must be set before the underlying GUI
7043 toolkit is initialized.
7044
7045 :param clearSigInt: Should SIGINT be cleared? This allows the
7046 app to terminate upon a Ctrl-C in the console like other
7047 GUI apps will.
7048
7049 :note: You should override OnInit to do applicaition
7050 initialization to ensure that the system, toolkit and
7051 wxWidgets are fully initialized.
7052 """
7053 wx.PyApp.__init__(self)
7054
7055 if wx.Platform == "__WXMAC__":
7056 try:
7057 import MacOS
7058 if not MacOS.WMAvailable():
7059 print """\
7060 This program needs access to the screen. Please run with 'pythonw',
7061 not 'python', and only when you are logged in on the main display of
7062 your Mac."""
7063 _sys.exit(1)
7064 except SystemExit:
7065 raise
7066 except:
7067 pass
7068
7069 # This has to be done before OnInit
7070 self.SetUseBestVisual(useBestVisual)
7071
7072 # Set the default handler for SIGINT. This fixes a problem
7073 # where if Ctrl-C is pressed in the console that started this
7074 # app then it will not appear to do anything, (not even send
7075 # KeyboardInterrupt???) but will later segfault on exit. By
7076 # setting the default handler then the app will exit, as
7077 # expected (depending on platform.)
7078 if clearSigInt:
7079 try:
7080 import signal
7081 signal.signal(signal.SIGINT, signal.SIG_DFL)
7082 except:
7083 pass
7084
7085 # Save and redirect the stdio to a window?
7086 self.stdioWin = None
7087 self.saveStdio = (_sys.stdout, _sys.stderr)
7088 if redirect:
7089 self.RedirectStdio(filename)
7090
7091 # Use Python's install prefix as the default
7092 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7093
7094 # This finishes the initialization of wxWindows and then calls
7095 # the OnInit that should be present in the derived class
7096 self._BootstrapApp()
7097
7098
7099 def OnPreInit(self):
7100 """
7101 Things that must be done after _BootstrapApp has done its
7102 thing, but would be nice if they were already done by the time
7103 that OnInit is called.
7104 """
7105 wx.StockGDI._initStockObjects()
7106
7107
7108 def __del__(self, destroy=wx.PyApp.__del__):
7109 self.RestoreStdio() # Just in case the MainLoop was overridden
7110 destroy(self)
7111
7112 def Destroy(self):
7113 wx.PyApp.Destroy(self)
7114 self.thisown = 0
7115
7116 def SetTopWindow(self, frame):
7117 """Set the \"main\" top level window"""
7118 if self.stdioWin:
7119 self.stdioWin.SetParent(frame)
7120 wx.PyApp.SetTopWindow(self, frame)
7121
7122
7123 def MainLoop(self):
7124 """Execute the main GUI event loop"""
7125 wx.PyApp.MainLoop(self)
7126 self.RestoreStdio()
7127
7128
7129 def RedirectStdio(self, filename=None):
7130 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7131 if filename:
7132 _sys.stdout = _sys.stderr = open(filename, 'a')
7133 else:
7134 self.stdioWin = self.outputWindowClass()
7135 _sys.stdout = _sys.stderr = self.stdioWin
7136
7137
7138 def RestoreStdio(self):
7139 try:
7140 _sys.stdout, _sys.stderr = self.saveStdio
7141 except:
7142 pass
7143
7144
7145 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7146 """
7147 Set the title, position and/or size of the output window if
7148 the stdio has been redirected. This should be called before
7149 any output would cause the output window to be created.
7150 """
7151 if self.stdioWin:
7152 if title is not None:
7153 self.stdioWin.title = title
7154 if pos is not None:
7155 self.stdioWin.pos = pos
7156 if size is not None:
7157 self.stdioWin.size = size
7158
7159
7160
7161
7162 # change from wx.PyApp_XX to wx.App_XX
7163 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7164 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7165 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7166 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7167 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7168 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7169 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7170 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7171 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7172 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7173 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7174
7175 #----------------------------------------------------------------------------
7176
7177 class PySimpleApp(wx.App):
7178 """
7179 A simple application class. You can just create one of these and
7180 then then make your top level windows later, and not have to worry
7181 about OnInit. For example::
7182
7183 app = wx.PySimpleApp()
7184 frame = wx.Frame(None, title='Hello World')
7185 frame.Show()
7186 app.MainLoop()
7187
7188 :see: `wx.App`
7189 """
7190
7191 def __init__(self, redirect=False, filename=None,
7192 useBestVisual=False, clearSigInt=True):
7193 """
7194 :see: `wx.App.__init__`
7195 """
7196 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7197
7198 def OnInit(self):
7199 return True
7200
7201
7202
7203 # Is anybody using this one?
7204 class PyWidgetTester(wx.App):
7205 def __init__(self, size = (250, 100)):
7206 self.size = size
7207 wx.App.__init__(self, 0)
7208
7209 def OnInit(self):
7210 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7211 self.SetTopWindow(self.frame)
7212 return True
7213
7214 def SetWidget(self, widgetClass, *args, **kwargs):
7215 w = widgetClass(self.frame, *args, **kwargs)
7216 self.frame.Show(True)
7217
7218 #----------------------------------------------------------------------------
7219 # DO NOT hold any other references to this object. This is how we
7220 # know when to cleanup system resources that wxWidgets is holding. When
7221 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7222 # goes to zero and it calls the wx.App_CleanUp function.
7223
7224 class __wxPyCleanup:
7225 def __init__(self):
7226 self.cleanup = _core_.App_CleanUp
7227 def __del__(self):
7228 self.cleanup()
7229
7230 _sys.__wxPythonCleanup = __wxPyCleanup()
7231
7232 ## # another possible solution, but it gets called too early...
7233 ## import atexit
7234 ## atexit.register(_core_.wxApp_CleanUp)
7235
7236
7237 #----------------------------------------------------------------------------
7238
7239 #---------------------------------------------------------------------------
7240
7241 class EventLoop(object):
7242 """Proxy of C++ EventLoop class"""
7243 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7244 __repr__ = _swig_repr
7245 def __init__(self, *args, **kwargs):
7246 """__init__(self) -> EventLoop"""
7247 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7248 __swig_destroy__ = _core_.delete_EventLoop
7249 __del__ = lambda self : None;
7250 def Run(*args, **kwargs):
7251 """Run(self) -> int"""
7252 return _core_.EventLoop_Run(*args, **kwargs)
7253
7254 def Exit(*args, **kwargs):
7255 """Exit(self, int rc=0)"""
7256 return _core_.EventLoop_Exit(*args, **kwargs)
7257
7258 def Pending(*args, **kwargs):
7259 """Pending(self) -> bool"""
7260 return _core_.EventLoop_Pending(*args, **kwargs)
7261
7262 def Dispatch(*args, **kwargs):
7263 """Dispatch(self) -> bool"""
7264 return _core_.EventLoop_Dispatch(*args, **kwargs)
7265
7266 def IsRunning(*args, **kwargs):
7267 """IsRunning(self) -> bool"""
7268 return _core_.EventLoop_IsRunning(*args, **kwargs)
7269
7270 def GetActive(*args, **kwargs):
7271 """GetActive() -> EventLoop"""
7272 return _core_.EventLoop_GetActive(*args, **kwargs)
7273
7274 GetActive = staticmethod(GetActive)
7275 def SetActive(*args, **kwargs):
7276 """SetActive(EventLoop loop)"""
7277 return _core_.EventLoop_SetActive(*args, **kwargs)
7278
7279 SetActive = staticmethod(SetActive)
7280 _core_.EventLoop_swigregister(EventLoop)
7281
7282 def EventLoop_GetActive(*args):
7283 """EventLoop_GetActive() -> EventLoop"""
7284 return _core_.EventLoop_GetActive(*args)
7285
7286 def EventLoop_SetActive(*args, **kwargs):
7287 """EventLoop_SetActive(EventLoop loop)"""
7288 return _core_.EventLoop_SetActive(*args, **kwargs)
7289
7290 class EventLoopActivator(object):
7291 """Proxy of C++ EventLoopActivator class"""
7292 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7293 __repr__ = _swig_repr
7294 def __init__(self, *args, **kwargs):
7295 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7296 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7297 __swig_destroy__ = _core_.delete_EventLoopActivator
7298 __del__ = lambda self : None;
7299 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7300
7301 #---------------------------------------------------------------------------
7302
7303 class AcceleratorEntry(object):
7304 """
7305 A class used to define items in an `wx.AcceleratorTable`. wxPython
7306 programs can choose to use wx.AcceleratorEntry objects, but using a
7307 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7308 as well. See `__init__` for of the tuple values.
7309
7310 :see: `wx.AcceleratorTable`
7311 """
7312 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7313 __repr__ = _swig_repr
7314 def __init__(self, *args, **kwargs):
7315 """
7316 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7317
7318 Construct a wx.AcceleratorEntry.
7319 """
7320 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7321 __swig_destroy__ = _core_.delete_AcceleratorEntry
7322 __del__ = lambda self : None;
7323 def Set(*args, **kwargs):
7324 """
7325 Set(self, int flags, int keyCode, int cmd)
7326
7327 (Re)set the attributes of a wx.AcceleratorEntry.
7328 :see `__init__`
7329 """
7330 return _core_.AcceleratorEntry_Set(*args, **kwargs)
7331
7332 def GetFlags(*args, **kwargs):
7333 """
7334 GetFlags(self) -> int
7335
7336 Get the AcceleratorEntry's flags.
7337 """
7338 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7339
7340 def GetKeyCode(*args, **kwargs):
7341 """
7342 GetKeyCode(self) -> int
7343
7344 Get the AcceleratorEntry's keycode.
7345 """
7346 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7347
7348 def GetCommand(*args, **kwargs):
7349 """
7350 GetCommand(self) -> int
7351
7352 Get the AcceleratorEntry's command ID.
7353 """
7354 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7355
7356 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
7357
7358 class AcceleratorTable(Object):
7359 """
7360 An accelerator table allows the application to specify a table of
7361 keyboard shortcuts for menus or other commands. On Windows, menu or
7362 button commands are supported; on GTK, only menu commands are
7363 supported.
7364 """
7365 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7366 __repr__ = _swig_repr
7367 def __init__(self, *args, **kwargs):
7368 """
7369 __init__(entries) -> AcceleratorTable
7370
7371 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7372 items or or of 3-tuples (flags, keyCode, cmdID)
7373
7374 :see: `wx.AcceleratorEntry`
7375 """
7376 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7377 __swig_destroy__ = _core_.delete_AcceleratorTable
7378 __del__ = lambda self : None;
7379 def Ok(*args, **kwargs):
7380 """Ok(self) -> bool"""
7381 return _core_.AcceleratorTable_Ok(*args, **kwargs)
7382
7383 _core_.AcceleratorTable_swigregister(AcceleratorTable)
7384
7385
7386 def GetAccelFromString(*args, **kwargs):
7387 """GetAccelFromString(String label) -> AcceleratorEntry"""
7388 return _core_.GetAccelFromString(*args, **kwargs)
7389 #---------------------------------------------------------------------------
7390
7391 class VisualAttributes(object):
7392 """struct containing all the visual attributes of a control"""
7393 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7394 __repr__ = _swig_repr
7395 def __init__(self, *args, **kwargs):
7396 """
7397 __init__(self) -> VisualAttributes
7398
7399 struct containing all the visual attributes of a control
7400 """
7401 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7402 __swig_destroy__ = _core_.delete_VisualAttributes
7403 __del__ = lambda self : None;
7404 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7405 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7406 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
7407 _core_.VisualAttributes_swigregister(VisualAttributes)
7408 NullAcceleratorTable = cvar.NullAcceleratorTable
7409 PanelNameStr = cvar.PanelNameStr
7410
7411 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7412 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7413 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7414 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7415 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7416 class Window(EvtHandler):
7417 """
7418 wx.Window is the base class for all windows and represents any visible
7419 object on the screen. All controls, top level windows and so on are
7420 wx.Windows. Sizers and device contexts are not however, as they don't
7421 appear on screen themselves.
7422
7423 """
7424 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7425 __repr__ = _swig_repr
7426 def __init__(self, *args, **kwargs):
7427 """
7428 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7429 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7430
7431 Construct and show a generic Window.
7432 """
7433 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
7434 self._setOORInfo(self)
7435
7436 def Create(*args, **kwargs):
7437 """
7438 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7439 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7440
7441 Create the GUI part of the Window for 2-phase creation mode.
7442 """
7443 return _core_.Window_Create(*args, **kwargs)
7444
7445 def Close(*args, **kwargs):
7446 """
7447 Close(self, bool force=False) -> bool
7448
7449 This function simply generates a EVT_CLOSE event whose handler usually
7450 tries to close the window. It doesn't close the window itself,
7451 however. If force is False (the default) then the window's close
7452 handler will be allowed to veto the destruction of the window.
7453 """
7454 return _core_.Window_Close(*args, **kwargs)
7455
7456 def Destroy(*args, **kwargs):
7457 """
7458 Destroy(self) -> bool
7459
7460 Destroys the window safely. Frames and dialogs are not destroyed
7461 immediately when this function is called -- they are added to a list
7462 of windows to be deleted on idle time, when all the window's events
7463 have been processed. This prevents problems with events being sent to
7464 non-existent windows.
7465
7466 Returns True if the window has either been successfully deleted, or it
7467 has been added to the list of windows pending real deletion.
7468 """
7469 val = _core_.Window_Destroy(*args, **kwargs)
7470 args[0].thisown = 0
7471 return val
7472
7473 def DestroyChildren(*args, **kwargs):
7474 """
7475 DestroyChildren(self) -> bool
7476
7477 Destroys all children of a window. Called automatically by the
7478 destructor.
7479 """
7480 return _core_.Window_DestroyChildren(*args, **kwargs)
7481
7482 def IsBeingDeleted(*args, **kwargs):
7483 """
7484 IsBeingDeleted(self) -> bool
7485
7486 Is the window in the process of being deleted?
7487 """
7488 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7489
7490 def SetLabel(*args, **kwargs):
7491 """
7492 SetLabel(self, String label)
7493
7494 Set the text which the window shows in its label if applicable.
7495 """
7496 return _core_.Window_SetLabel(*args, **kwargs)
7497
7498 def GetLabel(*args, **kwargs):
7499 """
7500 GetLabel(self) -> String
7501
7502 Generic way of getting a label from any window, for identification
7503 purposes. The interpretation of this function differs from class to
7504 class. For frames and dialogs, the value returned is the title. For
7505 buttons or static text controls, it is the button text. This function
7506 can be useful for meta-programs such as testing tools or special-needs
7507 access programs)which need to identify windows by name.
7508 """
7509 return _core_.Window_GetLabel(*args, **kwargs)
7510
7511 def SetName(*args, **kwargs):
7512 """
7513 SetName(self, String name)
7514
7515 Sets the window's name. The window name is used for ressource setting
7516 in X, it is not the same as the window title/label
7517 """
7518 return _core_.Window_SetName(*args, **kwargs)
7519
7520 def GetName(*args, **kwargs):
7521 """
7522 GetName(self) -> String
7523
7524 Returns the windows name. This name is not guaranteed to be unique;
7525 it is up to the programmer to supply an appropriate name in the window
7526 constructor or via wx.Window.SetName.
7527 """
7528 return _core_.Window_GetName(*args, **kwargs)
7529
7530 def SetWindowVariant(*args, **kwargs):
7531 """
7532 SetWindowVariant(self, int variant)
7533
7534 Sets the variant of the window/font size to use for this window, if
7535 the platform supports variants, for example, wxMac.
7536 """
7537 return _core_.Window_SetWindowVariant(*args, **kwargs)
7538
7539 def GetWindowVariant(*args, **kwargs):
7540 """GetWindowVariant(self) -> int"""
7541 return _core_.Window_GetWindowVariant(*args, **kwargs)
7542
7543 def SetId(*args, **kwargs):
7544 """
7545 SetId(self, int winid)
7546
7547 Sets the identifier of the window. Each window has an integer
7548 identifier. If the application has not provided one, an identifier
7549 will be generated. Normally, the identifier should be provided on
7550 creation and should not be modified subsequently.
7551 """
7552 return _core_.Window_SetId(*args, **kwargs)
7553
7554 def GetId(*args, **kwargs):
7555 """
7556 GetId(self) -> int
7557
7558 Returns the identifier of the window. Each window has an integer
7559 identifier. If the application has not provided one (or the default Id
7560 -1 is used) then an unique identifier with a negative value will be
7561 generated.
7562 """
7563 return _core_.Window_GetId(*args, **kwargs)
7564
7565 def NewControlId(*args, **kwargs):
7566 """
7567 NewControlId() -> int
7568
7569 Generate a control id for the controls which were not given one.
7570 """
7571 return _core_.Window_NewControlId(*args, **kwargs)
7572
7573 NewControlId = staticmethod(NewControlId)
7574 def NextControlId(*args, **kwargs):
7575 """
7576 NextControlId(int winid) -> int
7577
7578 Get the id of the control following the one with the given
7579 autogenerated) id
7580 """
7581 return _core_.Window_NextControlId(*args, **kwargs)
7582
7583 NextControlId = staticmethod(NextControlId)
7584 def PrevControlId(*args, **kwargs):
7585 """
7586 PrevControlId(int winid) -> int
7587
7588 Get the id of the control preceding the one with the given
7589 autogenerated) id
7590 """
7591 return _core_.Window_PrevControlId(*args, **kwargs)
7592
7593 PrevControlId = staticmethod(PrevControlId)
7594 def SetSize(*args, **kwargs):
7595 """
7596 SetSize(self, Size size)
7597
7598 Sets the size of the window in pixels.
7599 """
7600 return _core_.Window_SetSize(*args, **kwargs)
7601
7602 def SetDimensions(*args, **kwargs):
7603 """
7604 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7605
7606 Sets the position and size of the window in pixels. The sizeFlags
7607 parameter indicates the interpretation of the other params if they are
7608 equal to -1.
7609
7610 ======================== ======================================
7611 wx.SIZE_AUTO A -1 indicates that a class-specific
7612 default should be used.
7613 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
7614 -1 values are supplied.
7615 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
7616 interpreted as real dimensions, not
7617 default values.
7618 ======================== ======================================
7619
7620 """
7621 return _core_.Window_SetDimensions(*args, **kwargs)
7622
7623 def SetRect(*args, **kwargs):
7624 """
7625 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
7626
7627 Sets the position and size of the window in pixels using a wx.Rect.
7628 """
7629 return _core_.Window_SetRect(*args, **kwargs)
7630
7631 def SetSizeWH(*args, **kwargs):
7632 """
7633 SetSizeWH(self, int width, int height)
7634
7635 Sets the size of the window in pixels.
7636 """
7637 return _core_.Window_SetSizeWH(*args, **kwargs)
7638
7639 def Move(*args, **kwargs):
7640 """
7641 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
7642
7643 Moves the window to the given position.
7644 """
7645 return _core_.Window_Move(*args, **kwargs)
7646
7647 SetPosition = Move
7648 def MoveXY(*args, **kwargs):
7649 """
7650 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
7651
7652 Moves the window to the given position.
7653 """
7654 return _core_.Window_MoveXY(*args, **kwargs)
7655
7656 def SetBestFittingSize(*args, **kwargs):
7657 """
7658 SetBestFittingSize(self, Size size=DefaultSize)
7659
7660 A 'Smart' SetSize that will fill in default size components with the
7661 window's *best size* values. Also set's the minsize for use with sizers.
7662 """
7663 return _core_.Window_SetBestFittingSize(*args, **kwargs)
7664
7665 def Raise(*args, **kwargs):
7666 """
7667 Raise(self)
7668
7669 Raises the window to the top of the window hierarchy. In current
7670 version of wxWidgets this works both for manage and child windows.
7671 """
7672 return _core_.Window_Raise(*args, **kwargs)
7673
7674 def Lower(*args, **kwargs):
7675 """
7676 Lower(self)
7677
7678 Lowers the window to the bottom of the window hierarchy. In current
7679 version of wxWidgets this works both for manage and child windows.
7680 """
7681 return _core_.Window_Lower(*args, **kwargs)
7682
7683 def SetClientSize(*args, **kwargs):
7684 """
7685 SetClientSize(self, Size size)
7686
7687 This sets the size of the window client area in pixels. Using this
7688 function to size a window tends to be more device-independent than
7689 wx.Window.SetSize, since the application need not worry about what
7690 dimensions the border or title bar have when trying to fit the window
7691 around panel items, for example.
7692 """
7693 return _core_.Window_SetClientSize(*args, **kwargs)
7694
7695 def SetClientSizeWH(*args, **kwargs):
7696 """
7697 SetClientSizeWH(self, int width, int height)
7698
7699 This sets the size of the window client area in pixels. Using this
7700 function to size a window tends to be more device-independent than
7701 wx.Window.SetSize, since the application need not worry about what
7702 dimensions the border or title bar have when trying to fit the window
7703 around panel items, for example.
7704 """
7705 return _core_.Window_SetClientSizeWH(*args, **kwargs)
7706
7707 def SetClientRect(*args, **kwargs):
7708 """
7709 SetClientRect(self, Rect rect)
7710
7711 This sets the size of the window client area in pixels. Using this
7712 function to size a window tends to be more device-independent than
7713 wx.Window.SetSize, since the application need not worry about what
7714 dimensions the border or title bar have when trying to fit the window
7715 around panel items, for example.
7716 """
7717 return _core_.Window_SetClientRect(*args, **kwargs)
7718
7719 def GetPosition(*args, **kwargs):
7720 """
7721 GetPosition(self) -> Point
7722
7723 Get the window's position. Notice that the position is in client
7724 coordinates for child windows and screen coordinates for the top level
7725 ones, use `GetScreenPosition` if you need screen coordinates for all
7726 kinds of windows.
7727 """
7728 return _core_.Window_GetPosition(*args, **kwargs)
7729
7730 def GetPositionTuple(*args, **kwargs):
7731 """
7732 GetPositionTuple() -> (x,y)
7733
7734 Get the window's position. Notice that the position is in client
7735 coordinates for child windows and screen coordinates for the top level
7736 ones, use `GetScreenPosition` if you need screen coordinates for all
7737 kinds of windows.
7738 """
7739 return _core_.Window_GetPositionTuple(*args, **kwargs)
7740
7741 def GetScreenPosition(*args, **kwargs):
7742 """
7743 GetScreenPosition(self) -> Point
7744
7745 Get the position of the window in screen coordinantes.
7746 """
7747 return _core_.Window_GetScreenPosition(*args, **kwargs)
7748
7749 def GetScreenPositionTuple(*args, **kwargs):
7750 """
7751 GetScreenPositionTuple() -> (x,y)
7752
7753 Get the position of the window in screen coordinantes.
7754 """
7755 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
7756
7757 def GetScreenRect(*args, **kwargs):
7758 """
7759 GetScreenRect(self) -> Rect
7760
7761 Returns the size and position of the window in screen coordinantes as
7762 a `wx.Rect` object.
7763 """
7764 return _core_.Window_GetScreenRect(*args, **kwargs)
7765
7766 def GetSize(*args, **kwargs):
7767 """
7768 GetSize(self) -> Size
7769
7770 Get the window size.
7771 """
7772 return _core_.Window_GetSize(*args, **kwargs)
7773
7774 def GetSizeTuple(*args, **kwargs):
7775 """
7776 GetSizeTuple() -> (width, height)
7777
7778 Get the window size.
7779 """
7780 return _core_.Window_GetSizeTuple(*args, **kwargs)
7781
7782 def GetRect(*args, **kwargs):
7783 """
7784 GetRect(self) -> Rect
7785
7786 Returns the size and position of the window as a `wx.Rect` object.
7787 """
7788 return _core_.Window_GetRect(*args, **kwargs)
7789
7790 def GetClientSize(*args, **kwargs):
7791 """
7792 GetClientSize(self) -> Size
7793
7794 This gets the size of the window's 'client area' in pixels. The client
7795 area is the area which may be drawn on by the programmer, excluding
7796 title bar, border, scrollbars, etc.
7797 """
7798 return _core_.Window_GetClientSize(*args, **kwargs)
7799
7800 def GetClientSizeTuple(*args, **kwargs):
7801 """
7802 GetClientSizeTuple() -> (width, height)
7803
7804 This gets the size of the window's 'client area' in pixels. The client
7805 area is the area which may be drawn on by the programmer, excluding
7806 title bar, border, scrollbars, etc.
7807 """
7808 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
7809
7810 def GetClientAreaOrigin(*args, **kwargs):
7811 """
7812 GetClientAreaOrigin(self) -> Point
7813
7814 Get the origin of the client area of the window relative to the
7815 window's top left corner (the client area may be shifted because of
7816 the borders, scrollbars, other decorations...)
7817 """
7818 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
7819
7820 def GetClientRect(*args, **kwargs):
7821 """
7822 GetClientRect(self) -> Rect
7823
7824 Get the client area position and size as a `wx.Rect` object.
7825 """
7826 return _core_.Window_GetClientRect(*args, **kwargs)
7827
7828 def GetBestSize(*args, **kwargs):
7829 """
7830 GetBestSize(self) -> Size
7831
7832 This function returns the best acceptable minimal size for the
7833 window, if applicable. For example, for a static text control, it will
7834 be the minimal size such that the control label is not truncated. For
7835 windows containing subwindows (suzh aswx.Panel), the size returned by
7836 this function will be the same as the size the window would have had
7837 after calling Fit.
7838 """
7839 return _core_.Window_GetBestSize(*args, **kwargs)
7840
7841 def GetBestSizeTuple(*args, **kwargs):
7842 """
7843 GetBestSizeTuple() -> (width, height)
7844
7845 This function returns the best acceptable minimal size for the
7846 window, if applicable. For example, for a static text control, it will
7847 be the minimal size such that the control label is not truncated. For
7848 windows containing subwindows (suzh aswx.Panel), the size returned by
7849 this function will be the same as the size the window would have had
7850 after calling Fit.
7851 """
7852 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
7853
7854 def InvalidateBestSize(*args, **kwargs):
7855 """
7856 InvalidateBestSize(self)
7857
7858 Reset the cached best size value so it will be recalculated the next
7859 time it is needed.
7860 """
7861 return _core_.Window_InvalidateBestSize(*args, **kwargs)
7862
7863 def CacheBestSize(*args, **kwargs):
7864 """
7865 CacheBestSize(self, Size size)
7866
7867 Cache the best size so it doesn't need to be calculated again, (at least until
7868 some properties of the window change.)
7869 """
7870 return _core_.Window_CacheBestSize(*args, **kwargs)
7871
7872 def GetBestFittingSize(*args, **kwargs):
7873 """
7874 GetBestFittingSize(self) -> Size
7875
7876 This function will merge the window's best size into the window's
7877 minimum size, giving priority to the min size components, and returns
7878 the results.
7879
7880 """
7881 return _core_.Window_GetBestFittingSize(*args, **kwargs)
7882
7883 def GetAdjustedBestSize(*args, **kwargs):
7884 """
7885 GetAdjustedBestSize(self) -> Size
7886
7887 This method is similar to GetBestSize, except in one
7888 thing. GetBestSize should return the minimum untruncated size of the
7889 window, while this method will return the largest of BestSize and any
7890 user specified minimum size. ie. it is the minimum size the window
7891 should currently be drawn at, not the minimal size it can possibly
7892 tolerate.
7893 """
7894 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
7895
7896 def Center(*args, **kwargs):
7897 """
7898 Center(self, int direction=BOTH)
7899
7900 Centers the window. The parameter specifies the direction for
7901 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
7902 also include wx.CENTER_ON_SCREEN flag if you want to center the window
7903 on the entire screen and not on its parent window. If it is a
7904 top-level window and has no parent then it will always be centered
7905 relative to the screen.
7906 """
7907 return _core_.Window_Center(*args, **kwargs)
7908
7909 Centre = Center
7910 def CenterOnParent(*args, **kwargs):
7911 """
7912 CenterOnParent(self, int dir=BOTH)
7913
7914 Center with respect to the the parent window
7915 """
7916 return _core_.Window_CenterOnParent(*args, **kwargs)
7917
7918 CentreOnParent = CenterOnParent
7919 def Fit(*args, **kwargs):
7920 """
7921 Fit(self)
7922
7923 Sizes the window so that it fits around its subwindows. This function
7924 won't do anything if there are no subwindows and will only really work
7925 correctly if sizers are used for the subwindows layout. Also, if the
7926 window has exactly one subwindow it is better (faster and the result
7927 is more precise as Fit adds some margin to account for fuzziness of
7928 its calculations) to call window.SetClientSize(child.GetSize())
7929 instead of calling Fit.
7930 """
7931 return _core_.Window_Fit(*args, **kwargs)
7932
7933 def FitInside(*args, **kwargs):
7934 """
7935 FitInside(self)
7936
7937 Similar to Fit, but sizes the interior (virtual) size of a
7938 window. Mainly useful with scrolled windows to reset scrollbars after
7939 sizing changes that do not trigger a size event, and/or scrolled
7940 windows without an interior sizer. This function similarly won't do
7941 anything if there are no subwindows.
7942 """
7943 return _core_.Window_FitInside(*args, **kwargs)
7944
7945 def SetSizeHints(*args, **kwargs):
7946 """
7947 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
7948 int incH=-1)
7949
7950 Allows specification of minimum and maximum window sizes, and window
7951 size increments. If a pair of values is not set (or set to -1), the
7952 default values will be used. If this function is called, the user
7953 will not be able to size the window outside the given bounds (if it is
7954 a top-level window.) Sizers will also inspect the minimum window size
7955 and will use that value if set when calculating layout.
7956
7957 The resizing increments are only significant under Motif or Xt.
7958 """
7959 return _core_.Window_SetSizeHints(*args, **kwargs)
7960
7961 def SetSizeHintsSz(*args, **kwargs):
7962 """
7963 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
7964
7965 Allows specification of minimum and maximum window sizes, and window
7966 size increments. If a pair of values is not set (or set to -1), the
7967 default values will be used. If this function is called, the user
7968 will not be able to size the window outside the given bounds (if it is
7969 a top-level window.) Sizers will also inspect the minimum window size
7970 and will use that value if set when calculating layout.
7971
7972 The resizing increments are only significant under Motif or Xt.
7973 """
7974 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
7975
7976 def SetVirtualSizeHints(*args, **kwargs):
7977 """
7978 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
7979
7980 Allows specification of minimum and maximum virtual window sizes. If a
7981 pair of values is not set (or set to -1), the default values will be
7982 used. If this function is called, the user will not be able to size
7983 the virtual area of the window outside the given bounds.
7984 """
7985 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
7986
7987 def SetVirtualSizeHintsSz(*args, **kwargs):
7988 """
7989 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
7990
7991 Allows specification of minimum and maximum virtual window sizes. If a
7992 pair of values is not set (or set to -1), the default values will be
7993 used. If this function is called, the user will not be able to size
7994 the virtual area of the window outside the given bounds.
7995 """
7996 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
7997
7998 def GetMaxSize(*args, **kwargs):
7999 """GetMaxSize(self) -> Size"""
8000 return _core_.Window_GetMaxSize(*args, **kwargs)
8001
8002 def GetMinSize(*args, **kwargs):
8003 """GetMinSize(self) -> Size"""
8004 return _core_.Window_GetMinSize(*args, **kwargs)
8005
8006 def SetMinSize(*args, **kwargs):
8007 """
8008 SetMinSize(self, Size minSize)
8009
8010 A more convenient method than `SetSizeHints` for setting just the
8011 min size.
8012 """
8013 return _core_.Window_SetMinSize(*args, **kwargs)
8014
8015 def SetMaxSize(*args, **kwargs):
8016 """
8017 SetMaxSize(self, Size maxSize)
8018
8019 A more convenient method than `SetSizeHints` for setting just the
8020 max size.
8021 """
8022 return _core_.Window_SetMaxSize(*args, **kwargs)
8023
8024 def GetMinWidth(*args, **kwargs):
8025 """GetMinWidth(self) -> int"""
8026 return _core_.Window_GetMinWidth(*args, **kwargs)
8027
8028 def GetMinHeight(*args, **kwargs):
8029 """GetMinHeight(self) -> int"""
8030 return _core_.Window_GetMinHeight(*args, **kwargs)
8031
8032 def GetMaxWidth(*args, **kwargs):
8033 """GetMaxWidth(self) -> int"""
8034 return _core_.Window_GetMaxWidth(*args, **kwargs)
8035
8036 def GetMaxHeight(*args, **kwargs):
8037 """GetMaxHeight(self) -> int"""
8038 return _core_.Window_GetMaxHeight(*args, **kwargs)
8039
8040 def SetVirtualSize(*args, **kwargs):
8041 """
8042 SetVirtualSize(self, Size size)
8043
8044 Set the the virtual size of a window in pixels. For most windows this
8045 is just the client area of the window, but for some like scrolled
8046 windows it is more or less independent of the screen window size.
8047 """
8048 return _core_.Window_SetVirtualSize(*args, **kwargs)
8049
8050 def SetVirtualSizeWH(*args, **kwargs):
8051 """
8052 SetVirtualSizeWH(self, int w, int h)
8053
8054 Set the the virtual size of a window in pixels. For most windows this
8055 is just the client area of the window, but for some like scrolled
8056 windows it is more or less independent of the screen window size.
8057 """
8058 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8059
8060 def GetVirtualSize(*args, **kwargs):
8061 """
8062 GetVirtualSize(self) -> Size
8063
8064 Get the the virtual size of the window in pixels. For most windows
8065 this is just the client area of the window, but for some like scrolled
8066 windows it is more or less independent of the screen window size.
8067 """
8068 return _core_.Window_GetVirtualSize(*args, **kwargs)
8069
8070 def GetVirtualSizeTuple(*args, **kwargs):
8071 """
8072 GetVirtualSizeTuple() -> (width, height)
8073
8074 Get the the virtual size of the window in pixels. For most windows
8075 this is just the client area of the window, but for some like scrolled
8076 windows it is more or less independent of the screen window size.
8077 """
8078 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8079
8080 def GetBestVirtualSize(*args, **kwargs):
8081 """
8082 GetBestVirtualSize(self) -> Size
8083
8084 Return the largest of ClientSize and BestSize (as determined by a
8085 sizer, interior children, or other means)
8086 """
8087 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8088
8089 def Show(*args, **kwargs):
8090 """
8091 Show(self, bool show=True) -> bool
8092
8093 Shows or hides the window. You may need to call Raise for a top level
8094 window if you want to bring it to top, although this is not needed if
8095 Show is called immediately after the frame creation. Returns True if
8096 the window has been shown or hidden or False if nothing was done
8097 because it already was in the requested state.
8098 """
8099 return _core_.Window_Show(*args, **kwargs)
8100
8101 def Hide(*args, **kwargs):
8102 """
8103 Hide(self) -> bool
8104
8105 Equivalent to calling Show(False).
8106 """
8107 return _core_.Window_Hide(*args, **kwargs)
8108
8109 def Enable(*args, **kwargs):
8110 """
8111 Enable(self, bool enable=True) -> bool
8112
8113 Enable or disable the window for user input. Note that when a parent
8114 window is disabled, all of its children are disabled as well and they
8115 are reenabled again when the parent is. Returns true if the window
8116 has been enabled or disabled, false if nothing was done, i.e. if the
8117 window had already been in the specified state.
8118 """
8119 return _core_.Window_Enable(*args, **kwargs)
8120
8121 def Disable(*args, **kwargs):
8122 """
8123 Disable(self) -> bool
8124
8125 Disables the window, same as Enable(false).
8126 """
8127 return _core_.Window_Disable(*args, **kwargs)
8128
8129 def IsShown(*args, **kwargs):
8130 """
8131 IsShown(self) -> bool
8132
8133 Returns true if the window is shown, false if it has been hidden.
8134 """
8135 return _core_.Window_IsShown(*args, **kwargs)
8136
8137 def IsEnabled(*args, **kwargs):
8138 """
8139 IsEnabled(self) -> bool
8140
8141 Returns true if the window is enabled for input, false otherwise.
8142 """
8143 return _core_.Window_IsEnabled(*args, **kwargs)
8144
8145 def SetWindowStyleFlag(*args, **kwargs):
8146 """
8147 SetWindowStyleFlag(self, long style)
8148
8149 Sets the style of the window. Please note that some styles cannot be
8150 changed after the window creation and that Refresh() might need to be
8151 called after changing the others for the change to take place
8152 immediately.
8153 """
8154 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8155
8156 def GetWindowStyleFlag(*args, **kwargs):
8157 """
8158 GetWindowStyleFlag(self) -> long
8159
8160 Gets the window style that was passed to the constructor or Create
8161 method.
8162 """
8163 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8164
8165 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8166 def HasFlag(*args, **kwargs):
8167 """
8168 HasFlag(self, int flag) -> bool
8169
8170 Test if the given style is set for this window.
8171 """
8172 return _core_.Window_HasFlag(*args, **kwargs)
8173
8174 def IsRetained(*args, **kwargs):
8175 """
8176 IsRetained(self) -> bool
8177
8178 Returns true if the window is retained, false otherwise. Retained
8179 windows are only available on X platforms.
8180 """
8181 return _core_.Window_IsRetained(*args, **kwargs)
8182
8183 def SetExtraStyle(*args, **kwargs):
8184 """
8185 SetExtraStyle(self, long exStyle)
8186
8187 Sets the extra style bits for the window. Extra styles are the less
8188 often used style bits which can't be set with the constructor or with
8189 SetWindowStyleFlag()
8190 """
8191 return _core_.Window_SetExtraStyle(*args, **kwargs)
8192
8193 def GetExtraStyle(*args, **kwargs):
8194 """
8195 GetExtraStyle(self) -> long
8196
8197 Returns the extra style bits for the window.
8198 """
8199 return _core_.Window_GetExtraStyle(*args, **kwargs)
8200
8201 def MakeModal(*args, **kwargs):
8202 """
8203 MakeModal(self, bool modal=True)
8204
8205 Disables all other windows in the application so that the user can
8206 only interact with this window. Passing False will reverse this
8207 effect.
8208 """
8209 return _core_.Window_MakeModal(*args, **kwargs)
8210
8211 def SetThemeEnabled(*args, **kwargs):
8212 """
8213 SetThemeEnabled(self, bool enableTheme)
8214
8215 This function tells a window if it should use the system's "theme"
8216 code to draw the windows' background instead if its own background
8217 drawing code. This will only have an effect on platforms that support
8218 the notion of themes in user defined windows. One such platform is
8219 GTK+ where windows can have (very colourful) backgrounds defined by a
8220 user's selected theme.
8221
8222 Dialogs, notebook pages and the status bar have this flag set to true
8223 by default so that the default look and feel is simulated best.
8224 """
8225 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8226
8227 def GetThemeEnabled(*args, **kwargs):
8228 """
8229 GetThemeEnabled(self) -> bool
8230
8231 Return the themeEnabled flag.
8232 """
8233 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8234
8235 def SetFocus(*args, **kwargs):
8236 """
8237 SetFocus(self)
8238
8239 Set's the focus to this window, allowing it to receive keyboard input.
8240 """
8241 return _core_.Window_SetFocus(*args, **kwargs)
8242
8243 def SetFocusFromKbd(*args, **kwargs):
8244 """
8245 SetFocusFromKbd(self)
8246
8247 Set focus to this window as the result of a keyboard action. Normally
8248 only called internally.
8249 """
8250 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8251
8252 def FindFocus(*args, **kwargs):
8253 """
8254 FindFocus() -> Window
8255
8256 Returns the window or control that currently has the keyboard focus,
8257 or None.
8258 """
8259 return _core_.Window_FindFocus(*args, **kwargs)
8260
8261 FindFocus = staticmethod(FindFocus)
8262 def AcceptsFocus(*args, **kwargs):
8263 """
8264 AcceptsFocus(self) -> bool
8265
8266 Can this window have focus?
8267 """
8268 return _core_.Window_AcceptsFocus(*args, **kwargs)
8269
8270 def AcceptsFocusFromKeyboard(*args, **kwargs):
8271 """
8272 AcceptsFocusFromKeyboard(self) -> bool
8273
8274 Can this window be given focus by keyboard navigation? if not, the
8275 only way to give it focus (provided it accepts it at all) is to click
8276 it.
8277 """
8278 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8279
8280 def GetDefaultItem(*args, **kwargs):
8281 """
8282 GetDefaultItem(self) -> Window
8283
8284 Get the default child of this parent, i.e. the one which is activated
8285 by pressing <Enter> such as the OK button on a wx.Dialog.
8286 """
8287 return _core_.Window_GetDefaultItem(*args, **kwargs)
8288
8289 def SetDefaultItem(*args, **kwargs):
8290 """
8291 SetDefaultItem(self, Window child) -> Window
8292
8293 Set this child as default, return the old default.
8294 """
8295 return _core_.Window_SetDefaultItem(*args, **kwargs)
8296
8297 def SetTmpDefaultItem(*args, **kwargs):
8298 """
8299 SetTmpDefaultItem(self, Window win)
8300
8301 Set this child as temporary default
8302 """
8303 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
8304
8305 def GetTmpDefaultItem(*args, **kwargs):
8306 """
8307 GetTmpDefaultItem(self) -> Window
8308
8309 Return the temporary default item, which can be None.
8310 """
8311 return _core_.Window_GetTmpDefaultItem(*args, **kwargs)
8312
8313 def Navigate(*args, **kwargs):
8314 """
8315 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8316
8317 Does keyboard navigation from this window to another, by sending a
8318 `wx.NavigationKeyEvent`.
8319 """
8320 return _core_.Window_Navigate(*args, **kwargs)
8321
8322 def MoveAfterInTabOrder(*args, **kwargs):
8323 """
8324 MoveAfterInTabOrder(self, Window win)
8325
8326 Moves this window in the tab navigation order after the specified
8327 sibling window. This means that when the user presses the TAB key on
8328 that other window, the focus switches to this window.
8329
8330 The default tab order is the same as creation order. This function
8331 and `MoveBeforeInTabOrder` allow to change it after creating all the
8332 windows.
8333
8334 """
8335 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8336
8337 def MoveBeforeInTabOrder(*args, **kwargs):
8338 """
8339 MoveBeforeInTabOrder(self, Window win)
8340
8341 Same as `MoveAfterInTabOrder` except that it inserts this window just
8342 before win instead of putting it right after it.
8343 """
8344 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8345
8346 def GetChildren(*args, **kwargs):
8347 """
8348 GetChildren(self) -> PyObject
8349
8350 Returns a list of the window's children. NOTE: Currently this is a
8351 copy of the child window list maintained by the window, so the return
8352 value of this function is only valid as long as the window's children
8353 do not change.
8354 """
8355 return _core_.Window_GetChildren(*args, **kwargs)
8356
8357 def GetParent(*args, **kwargs):
8358 """
8359 GetParent(self) -> Window
8360
8361 Returns the parent window of this window, or None if there isn't one.
8362 """
8363 return _core_.Window_GetParent(*args, **kwargs)
8364
8365 def GetGrandParent(*args, **kwargs):
8366 """
8367 GetGrandParent(self) -> Window
8368
8369 Returns the parent of the parent of this window, or None if there
8370 isn't one.
8371 """
8372 return _core_.Window_GetGrandParent(*args, **kwargs)
8373
8374 def IsTopLevel(*args, **kwargs):
8375 """
8376 IsTopLevel(self) -> bool
8377
8378 Returns true if the given window is a top-level one. Currently all
8379 frames and dialogs are always considered to be top-level windows (even
8380 if they have a parent window).
8381 """
8382 return _core_.Window_IsTopLevel(*args, **kwargs)
8383
8384 def Reparent(*args, **kwargs):
8385 """
8386 Reparent(self, Window newParent) -> bool
8387
8388 Reparents the window, i.e the window will be removed from its current
8389 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8390 re-inserted into another. Available on Windows and GTK. Returns True
8391 if the parent was changed, False otherwise (error or newParent ==
8392 oldParent)
8393 """
8394 return _core_.Window_Reparent(*args, **kwargs)
8395
8396 def AddChild(*args, **kwargs):
8397 """
8398 AddChild(self, Window child)
8399
8400 Adds a child window. This is called automatically by window creation
8401 functions so should not be required by the application programmer.
8402 """
8403 return _core_.Window_AddChild(*args, **kwargs)
8404
8405 def RemoveChild(*args, **kwargs):
8406 """
8407 RemoveChild(self, Window child)
8408
8409 Removes a child window. This is called automatically by window
8410 deletion functions so should not be required by the application
8411 programmer.
8412 """
8413 return _core_.Window_RemoveChild(*args, **kwargs)
8414
8415 def SetDoubleBuffered(*args, **kwargs):
8416 """
8417 SetDoubleBuffered(self, bool on)
8418
8419 Currently wxGTK2 only.
8420 """
8421 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8422
8423 def FindWindowById(*args, **kwargs):
8424 """
8425 FindWindowById(self, long winid) -> Window
8426
8427 Find a chld of this window by window ID
8428 """
8429 return _core_.Window_FindWindowById(*args, **kwargs)
8430
8431 def FindWindowByName(*args, **kwargs):
8432 """
8433 FindWindowByName(self, String name) -> Window
8434
8435 Find a child of this window by name
8436 """
8437 return _core_.Window_FindWindowByName(*args, **kwargs)
8438
8439 def GetEventHandler(*args, **kwargs):
8440 """
8441 GetEventHandler(self) -> EvtHandler
8442
8443 Returns the event handler for this window. By default, the window is
8444 its own event handler.
8445 """
8446 return _core_.Window_GetEventHandler(*args, **kwargs)
8447
8448 def SetEventHandler(*args, **kwargs):
8449 """
8450 SetEventHandler(self, EvtHandler handler)
8451
8452 Sets the event handler for this window. An event handler is an object
8453 that is capable of processing the events sent to a window. By default,
8454 the window is its own event handler, but an application may wish to
8455 substitute another, for example to allow central implementation of
8456 event-handling for a variety of different window classes.
8457
8458 It is usually better to use `wx.Window.PushEventHandler` since this sets
8459 up a chain of event handlers, where an event not handled by one event
8460 handler is handed to the next one in the chain.
8461 """
8462 return _core_.Window_SetEventHandler(*args, **kwargs)
8463
8464 def PushEventHandler(*args, **kwargs):
8465 """
8466 PushEventHandler(self, EvtHandler handler)
8467
8468 Pushes this event handler onto the event handler stack for the window.
8469 An event handler is an object that is capable of processing the events
8470 sent to a window. By default, the window is its own event handler, but
8471 an application may wish to substitute another, for example to allow
8472 central implementation of event-handling for a variety of different
8473 window classes.
8474
8475 wx.Window.PushEventHandler allows an application to set up a chain of
8476 event handlers, where an event not handled by one event handler is
8477 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
8478 remove the event handler.
8479 """
8480 return _core_.Window_PushEventHandler(*args, **kwargs)
8481
8482 def PopEventHandler(*args, **kwargs):
8483 """
8484 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8485
8486 Removes and returns the top-most event handler on the event handler
8487 stack. If deleteHandler is True then the wx.EvtHandler object will be
8488 destroyed after it is popped.
8489 """
8490 return _core_.Window_PopEventHandler(*args, **kwargs)
8491
8492 def RemoveEventHandler(*args, **kwargs):
8493 """
8494 RemoveEventHandler(self, EvtHandler handler) -> bool
8495
8496 Find the given handler in the event handler chain and remove (but not
8497 delete) it from the event handler chain, return True if it was found
8498 and False otherwise (this also results in an assert failure so this
8499 function should only be called when the handler is supposed to be
8500 there.)
8501 """
8502 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8503
8504 def SetValidator(*args, **kwargs):
8505 """
8506 SetValidator(self, Validator validator)
8507
8508 Deletes the current validator (if any) and sets the window validator,
8509 having called wx.Validator.Clone to create a new validator of this
8510 type.
8511 """
8512 return _core_.Window_SetValidator(*args, **kwargs)
8513
8514 def GetValidator(*args, **kwargs):
8515 """
8516 GetValidator(self) -> Validator
8517
8518 Returns a pointer to the current validator for the window, or None if
8519 there is none.
8520 """
8521 return _core_.Window_GetValidator(*args, **kwargs)
8522
8523 def Validate(*args, **kwargs):
8524 """
8525 Validate(self) -> bool
8526
8527 Validates the current values of the child controls using their
8528 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8529 style flag set, the method will also call Validate() of all child
8530 windows. Returns false if any of the validations failed.
8531 """
8532 return _core_.Window_Validate(*args, **kwargs)
8533
8534 def TransferDataToWindow(*args, **kwargs):
8535 """
8536 TransferDataToWindow(self) -> bool
8537
8538 Transfers values to child controls from data areas specified by their
8539 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8540 style flag set, the method will also call TransferDataToWindow() of
8541 all child windows.
8542 """
8543 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8544
8545 def TransferDataFromWindow(*args, **kwargs):
8546 """
8547 TransferDataFromWindow(self) -> bool
8548
8549 Transfers values from child controls to data areas specified by their
8550 validators. Returns false if a transfer failed. If the window has
8551 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8552 also call TransferDataFromWindow() of all child windows.
8553 """
8554 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8555
8556 def InitDialog(*args, **kwargs):
8557 """
8558 InitDialog(self)
8559
8560 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8561 to the dialog via validators.
8562 """
8563 return _core_.Window_InitDialog(*args, **kwargs)
8564
8565 def SetAcceleratorTable(*args, **kwargs):
8566 """
8567 SetAcceleratorTable(self, AcceleratorTable accel)
8568
8569 Sets the accelerator table for this window.
8570 """
8571 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
8572
8573 def GetAcceleratorTable(*args, **kwargs):
8574 """
8575 GetAcceleratorTable(self) -> AcceleratorTable
8576
8577 Gets the accelerator table for this window.
8578 """
8579 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
8580
8581 def RegisterHotKey(*args, **kwargs):
8582 """
8583 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8584
8585 Registers a system wide hotkey. Every time the user presses the hotkey
8586 registered here, this window will receive a hotkey event. It will
8587 receive the event even if the application is in the background and
8588 does not have the input focus because the user is working with some
8589 other application. To bind an event handler function to this hotkey
8590 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
8591 hotkey was registered successfully.
8592 """
8593 return _core_.Window_RegisterHotKey(*args, **kwargs)
8594
8595 def UnregisterHotKey(*args, **kwargs):
8596 """
8597 UnregisterHotKey(self, int hotkeyId) -> bool
8598
8599 Unregisters a system wide hotkey.
8600 """
8601 return _core_.Window_UnregisterHotKey(*args, **kwargs)
8602
8603 def ConvertDialogPointToPixels(*args, **kwargs):
8604 """
8605 ConvertDialogPointToPixels(self, Point pt) -> Point
8606
8607 Converts a point or size from dialog units to pixels. Dialog units
8608 are used for maintaining a dialog's proportions even if the font
8609 changes. For the x dimension, the dialog units are multiplied by the
8610 average character width and then divided by 4. For the y dimension,
8611 the dialog units are multiplied by the average character height and
8612 then divided by 8.
8613 """
8614 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
8615
8616 def ConvertDialogSizeToPixels(*args, **kwargs):
8617 """
8618 ConvertDialogSizeToPixels(self, Size sz) -> Size
8619
8620 Converts a point or size from dialog units to pixels. Dialog units
8621 are used for maintaining a dialog's proportions even if the font
8622 changes. For the x dimension, the dialog units are multiplied by the
8623 average character width and then divided by 4. For the y dimension,
8624 the dialog units are multiplied by the average character height and
8625 then divided by 8.
8626 """
8627 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
8628
8629 def DLG_PNT(*args, **kwargs):
8630 """
8631 DLG_PNT(self, Point pt) -> Point
8632
8633 Converts a point or size from dialog units to pixels. Dialog units
8634 are used for maintaining a dialog's proportions even if the font
8635 changes. For the x dimension, the dialog units are multiplied by the
8636 average character width and then divided by 4. For the y dimension,
8637 the dialog units are multiplied by the average character height and
8638 then divided by 8.
8639 """
8640 return _core_.Window_DLG_PNT(*args, **kwargs)
8641
8642 def DLG_SZE(*args, **kwargs):
8643 """
8644 DLG_SZE(self, Size sz) -> Size
8645
8646 Converts a point or size from dialog units to pixels. Dialog units
8647 are used for maintaining a dialog's proportions even if the font
8648 changes. For the x dimension, the dialog units are multiplied by the
8649 average character width and then divided by 4. For the y dimension,
8650 the dialog units are multiplied by the average character height and
8651 then divided by 8.
8652 """
8653 return _core_.Window_DLG_SZE(*args, **kwargs)
8654
8655 def ConvertPixelPointToDialog(*args, **kwargs):
8656 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
8657 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
8658
8659 def ConvertPixelSizeToDialog(*args, **kwargs):
8660 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
8661 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
8662
8663 def WarpPointer(*args, **kwargs):
8664 """
8665 WarpPointer(self, int x, int y)
8666
8667 Moves the pointer to the given position on the window.
8668
8669 NOTE: This function is not supported under Mac because Apple Human
8670 Interface Guidelines forbid moving the mouse cursor programmatically.
8671 """
8672 return _core_.Window_WarpPointer(*args, **kwargs)
8673
8674 def CaptureMouse(*args, **kwargs):
8675 """
8676 CaptureMouse(self)
8677
8678 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
8679 release the capture.
8680
8681 Note that wxWindows maintains the stack of windows having captured the
8682 mouse and when the mouse is released the capture returns to the window
8683 which had had captured it previously and it is only really released if
8684 there were no previous window. In particular, this means that you must
8685 release the mouse as many times as you capture it.
8686 """
8687 return _core_.Window_CaptureMouse(*args, **kwargs)
8688
8689 def ReleaseMouse(*args, **kwargs):
8690 """
8691 ReleaseMouse(self)
8692
8693 Releases mouse input captured with wx.Window.CaptureMouse.
8694 """
8695 return _core_.Window_ReleaseMouse(*args, **kwargs)
8696
8697 def GetCapture(*args, **kwargs):
8698 """
8699 GetCapture() -> Window
8700
8701 Returns the window which currently captures the mouse or None
8702 """
8703 return _core_.Window_GetCapture(*args, **kwargs)
8704
8705 GetCapture = staticmethod(GetCapture)
8706 def HasCapture(*args, **kwargs):
8707 """
8708 HasCapture(self) -> bool
8709
8710 Returns true if this window has the current mouse capture.
8711 """
8712 return _core_.Window_HasCapture(*args, **kwargs)
8713
8714 def Refresh(*args, **kwargs):
8715 """
8716 Refresh(self, bool eraseBackground=True, Rect rect=None)
8717
8718 Mark the specified rectangle (or the whole window) as "dirty" so it
8719 will be repainted. Causes an EVT_PAINT event to be generated and sent
8720 to the window.
8721 """
8722 return _core_.Window_Refresh(*args, **kwargs)
8723
8724 def RefreshRect(*args, **kwargs):
8725 """
8726 RefreshRect(self, Rect rect, bool eraseBackground=True)
8727
8728 Redraws the contents of the given rectangle: the area inside it will
8729 be repainted. This is the same as Refresh but has a nicer syntax.
8730 """
8731 return _core_.Window_RefreshRect(*args, **kwargs)
8732
8733 def Update(*args, **kwargs):
8734 """
8735 Update(self)
8736
8737 Calling this method immediately repaints the invalidated area of the
8738 window instead of waiting for the EVT_PAINT event to happen, (normally
8739 this would usually only happen when the flow of control returns to the
8740 event loop.) Notice that this function doesn't refresh the window and
8741 does nothing if the window has been already repainted. Use Refresh
8742 first if you want to immediately redraw the window (or some portion of
8743 it) unconditionally.
8744 """
8745 return _core_.Window_Update(*args, **kwargs)
8746
8747 def ClearBackground(*args, **kwargs):
8748 """
8749 ClearBackground(self)
8750
8751 Clears the window by filling it with the current background
8752 colour. Does not cause an erase background event to be generated.
8753 """
8754 return _core_.Window_ClearBackground(*args, **kwargs)
8755
8756 def Freeze(*args, **kwargs):
8757 """
8758 Freeze(self)
8759
8760 Freezes the window or, in other words, prevents any updates from
8761 taking place on screen, the window is not redrawn at all. Thaw must be
8762 called to reenable window redrawing. Calls to Freeze/Thaw may be
8763 nested, with the actual Thaw being delayed until all the nesting has
8764 been undone.
8765
8766 This method is useful for visual appearance optimization (for example,
8767 it is a good idea to use it before inserting large amount of text into
8768 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
8769 for all controls so it is mostly just a hint to wxWindows and not a
8770 mandatory directive.
8771 """
8772 return _core_.Window_Freeze(*args, **kwargs)
8773
8774 def Thaw(*args, **kwargs):
8775 """
8776 Thaw(self)
8777
8778 Reenables window updating after a previous call to Freeze. Calls to
8779 Freeze/Thaw may be nested, so Thaw must be called the same number of
8780 times that Freeze was before the window will be updated.
8781 """
8782 return _core_.Window_Thaw(*args, **kwargs)
8783
8784 def PrepareDC(*args, **kwargs):
8785 """
8786 PrepareDC(self, DC dc)
8787
8788 Call this function to prepare the device context for drawing a
8789 scrolled image. It sets the device origin according to the current
8790 scroll position.
8791 """
8792 return _core_.Window_PrepareDC(*args, **kwargs)
8793
8794 def GetUpdateRegion(*args, **kwargs):
8795 """
8796 GetUpdateRegion(self) -> Region
8797
8798 Returns the region specifying which parts of the window have been
8799 damaged. Should only be called within an EVT_PAINT handler.
8800 """
8801 return _core_.Window_GetUpdateRegion(*args, **kwargs)
8802
8803 def GetUpdateClientRect(*args, **kwargs):
8804 """
8805 GetUpdateClientRect(self) -> Rect
8806
8807 Get the update rectangle region bounding box in client coords.
8808 """
8809 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
8810
8811 def IsExposed(*args, **kwargs):
8812 """
8813 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
8814
8815 Returns true if the given point or rectangle area has been exposed
8816 since the last repaint. Call this in an paint event handler to
8817 optimize redrawing by only redrawing those areas, which have been
8818 exposed.
8819 """
8820 return _core_.Window_IsExposed(*args, **kwargs)
8821
8822 def IsExposedPoint(*args, **kwargs):
8823 """
8824 IsExposedPoint(self, Point pt) -> bool
8825
8826 Returns true if the given point or rectangle area has been exposed
8827 since the last repaint. Call this in an paint event handler to
8828 optimize redrawing by only redrawing those areas, which have been
8829 exposed.
8830 """
8831 return _core_.Window_IsExposedPoint(*args, **kwargs)
8832
8833 def IsExposedRect(*args, **kwargs):
8834 """
8835 IsExposedRect(self, Rect rect) -> bool
8836
8837 Returns true if the given point or rectangle area has been exposed
8838 since the last repaint. Call this in an paint event handler to
8839 optimize redrawing by only redrawing those areas, which have been
8840 exposed.
8841 """
8842 return _core_.Window_IsExposedRect(*args, **kwargs)
8843
8844 def GetDefaultAttributes(*args, **kwargs):
8845 """
8846 GetDefaultAttributes(self) -> VisualAttributes
8847
8848 Get the default attributes for an instance of this class. This is
8849 useful if you want to use the same font or colour in your own control
8850 as in a standard control -- which is a much better idea than hard
8851 coding specific colours or fonts which might look completely out of
8852 place on the user's system, especially if it uses themes.
8853 """
8854 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
8855
8856 def GetClassDefaultAttributes(*args, **kwargs):
8857 """
8858 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8859
8860 Get the default attributes for this class. This is useful if you want
8861 to use the same font or colour in your own control as in a standard
8862 control -- which is a much better idea than hard coding specific
8863 colours or fonts which might look completely out of place on the
8864 user's system, especially if it uses themes.
8865
8866 The variant parameter is only relevant under Mac currently and is
8867 ignore under other platforms. Under Mac, it will change the size of
8868 the returned font. See `wx.Window.SetWindowVariant` for more about
8869 this.
8870 """
8871 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
8872
8873 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8874 def SetBackgroundColour(*args, **kwargs):
8875 """
8876 SetBackgroundColour(self, Colour colour) -> bool
8877
8878 Sets the background colour of the window. Returns True if the colour
8879 was changed. The background colour is usually painted by the default
8880 EVT_ERASE_BACKGROUND event handler function under Windows and
8881 automatically under GTK. Using `wx.NullColour` will reset the window
8882 to the default background colour.
8883
8884 Note that setting the background colour may not cause an immediate
8885 refresh, so you may wish to call `ClearBackground` or `Refresh` after
8886 calling this function.
8887
8888 Using this function will disable attempts to use themes for this
8889 window, if the system supports them. Use with care since usually the
8890 themes represent the appearance chosen by the user to be used for all
8891 applications on the system.
8892 """
8893 return _core_.Window_SetBackgroundColour(*args, **kwargs)
8894
8895 def SetOwnBackgroundColour(*args, **kwargs):
8896 """SetOwnBackgroundColour(self, Colour colour)"""
8897 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
8898
8899 def SetForegroundColour(*args, **kwargs):
8900 """
8901 SetForegroundColour(self, Colour colour) -> bool
8902
8903 Sets the foreground colour of the window. Returns True is the colour
8904 was changed. The interpretation of foreground colour is dependent on
8905 the window class; it may be the text colour or other colour, or it may
8906 not be used at all.
8907 """
8908 return _core_.Window_SetForegroundColour(*args, **kwargs)
8909
8910 def SetOwnForegroundColour(*args, **kwargs):
8911 """SetOwnForegroundColour(self, Colour colour)"""
8912 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
8913
8914 def GetBackgroundColour(*args, **kwargs):
8915 """
8916 GetBackgroundColour(self) -> Colour
8917
8918 Returns the background colour of the window.
8919 """
8920 return _core_.Window_GetBackgroundColour(*args, **kwargs)
8921
8922 def GetForegroundColour(*args, **kwargs):
8923 """
8924 GetForegroundColour(self) -> Colour
8925
8926 Returns the foreground colour of the window. The interpretation of
8927 foreground colour is dependent on the window class; it may be the text
8928 colour or other colour, or it may not be used at all.
8929 """
8930 return _core_.Window_GetForegroundColour(*args, **kwargs)
8931
8932 def InheritsBackgroundColour(*args, **kwargs):
8933 """InheritsBackgroundColour(self) -> bool"""
8934 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
8935
8936 def UseBgCol(*args, **kwargs):
8937 """UseBgCol(self) -> bool"""
8938 return _core_.Window_UseBgCol(*args, **kwargs)
8939
8940 def SetBackgroundStyle(*args, **kwargs):
8941 """
8942 SetBackgroundStyle(self, int style) -> bool
8943
8944 Returns the background style of the window. The background style
8945 indicates how the background of the window is drawn.
8946
8947 ====================== ========================================
8948 wx.BG_STYLE_SYSTEM The background colour or pattern should
8949 be determined by the system
8950 wx.BG_STYLE_COLOUR The background should be a solid colour
8951 wx.BG_STYLE_CUSTOM The background will be implemented by the
8952 application.
8953 ====================== ========================================
8954
8955 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
8956 a custom background, such as a tiled bitmap. Currently the style has
8957 no effect on other platforms.
8958
8959 :see: `GetBackgroundStyle`, `SetBackgroundColour`
8960 """
8961 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
8962
8963 def GetBackgroundStyle(*args, **kwargs):
8964 """
8965 GetBackgroundStyle(self) -> int
8966
8967 Returns the background style of the window.
8968
8969 :see: `SetBackgroundStyle`
8970 """
8971 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
8972
8973 def HasTransparentBackground(*args, **kwargs):
8974 """
8975 HasTransparentBackground(self) -> bool
8976
8977 Returns True if this window's background is transparent (as, for
8978 example, for `wx.StaticText`) and should show the parent window's
8979 background.
8980
8981 This method is mostly used internally by the library itself and you
8982 normally shouldn't have to call it. You may, however, have to override
8983 it in your custom control classes to ensure that background is painted
8984 correctly.
8985 """
8986 return _core_.Window_HasTransparentBackground(*args, **kwargs)
8987
8988 def SetCursor(*args, **kwargs):
8989 """
8990 SetCursor(self, Cursor cursor) -> bool
8991
8992 Sets the window's cursor. Notice that the window cursor also sets it
8993 for the children of the window implicitly.
8994
8995 The cursor may be wx.NullCursor in which case the window cursor will
8996 be reset back to default.
8997 """
8998 return _core_.Window_SetCursor(*args, **kwargs)
8999
9000 def GetCursor(*args, **kwargs):
9001 """
9002 GetCursor(self) -> Cursor
9003
9004 Return the cursor associated with this window.
9005 """
9006 return _core_.Window_GetCursor(*args, **kwargs)
9007
9008 def SetFont(*args, **kwargs):
9009 """
9010 SetFont(self, Font font) -> bool
9011
9012 Sets the font for this window.
9013 """
9014 return _core_.Window_SetFont(*args, **kwargs)
9015
9016 def SetOwnFont(*args, **kwargs):
9017 """SetOwnFont(self, Font font)"""
9018 return _core_.Window_SetOwnFont(*args, **kwargs)
9019
9020 def GetFont(*args, **kwargs):
9021 """
9022 GetFont(self) -> Font
9023
9024 Returns the default font used for this window.
9025 """
9026 return _core_.Window_GetFont(*args, **kwargs)
9027
9028 def SetCaret(*args, **kwargs):
9029 """
9030 SetCaret(self, Caret caret)
9031
9032 Sets the caret associated with the window.
9033 """
9034 return _core_.Window_SetCaret(*args, **kwargs)
9035
9036 def GetCaret(*args, **kwargs):
9037 """
9038 GetCaret(self) -> Caret
9039
9040 Returns the caret associated with the window.
9041 """
9042 return _core_.Window_GetCaret(*args, **kwargs)
9043
9044 def GetCharHeight(*args, **kwargs):
9045 """
9046 GetCharHeight(self) -> int
9047
9048 Get the (average) character size for the current font.
9049 """
9050 return _core_.Window_GetCharHeight(*args, **kwargs)
9051
9052 def GetCharWidth(*args, **kwargs):
9053 """
9054 GetCharWidth(self) -> int
9055
9056 Get the (average) character size for the current font.
9057 """
9058 return _core_.Window_GetCharWidth(*args, **kwargs)
9059
9060 def GetTextExtent(*args, **kwargs):
9061 """
9062 GetTextExtent(String string) -> (width, height)
9063
9064 Get the width and height of the text using the current font.
9065 """
9066 return _core_.Window_GetTextExtent(*args, **kwargs)
9067
9068 def GetFullTextExtent(*args, **kwargs):
9069 """
9070 GetFullTextExtent(String string, Font font=None) ->
9071 (width, height, descent, externalLeading)
9072
9073 Get the width, height, decent and leading of the text using the
9074 current or specified font.
9075 """
9076 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9077
9078 def ClientToScreenXY(*args, **kwargs):
9079 """
9080 ClientToScreenXY(int x, int y) -> (x,y)
9081
9082 Converts to screen coordinates from coordinates relative to this window.
9083 """
9084 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9085
9086 def ScreenToClientXY(*args, **kwargs):
9087 """
9088 ScreenToClientXY(int x, int y) -> (x,y)
9089
9090 Converts from screen to client window coordinates.
9091 """
9092 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9093
9094 def ClientToScreen(*args, **kwargs):
9095 """
9096 ClientToScreen(self, Point pt) -> Point
9097
9098 Converts to screen coordinates from coordinates relative to this window.
9099 """
9100 return _core_.Window_ClientToScreen(*args, **kwargs)
9101
9102 def ScreenToClient(*args, **kwargs):
9103 """
9104 ScreenToClient(self, Point pt) -> Point
9105
9106 Converts from screen to client window coordinates.
9107 """
9108 return _core_.Window_ScreenToClient(*args, **kwargs)
9109
9110 def HitTestXY(*args, **kwargs):
9111 """
9112 HitTestXY(self, int x, int y) -> int
9113
9114 Test where the given (in client coords) point lies
9115 """
9116 return _core_.Window_HitTestXY(*args, **kwargs)
9117
9118 def HitTest(*args, **kwargs):
9119 """
9120 HitTest(self, Point pt) -> int
9121
9122 Test where the given (in client coords) point lies
9123 """
9124 return _core_.Window_HitTest(*args, **kwargs)
9125
9126 def GetBorder(*args):
9127 """
9128 GetBorder(self, long flags) -> int
9129 GetBorder(self) -> int
9130
9131 Get border for the flags of this window
9132 """
9133 return _core_.Window_GetBorder(*args)
9134
9135 def UpdateWindowUI(*args, **kwargs):
9136 """
9137 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9138
9139 This function sends EVT_UPDATE_UI events to the window. The particular
9140 implementation depends on the window; for example a wx.ToolBar will
9141 send an update UI event for each toolbar button, and a wx.Frame will
9142 send an update UI event for each menubar menu item. You can call this
9143 function from your application to ensure that your UI is up-to-date at
9144 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9145 concerned). This may be necessary if you have called
9146 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9147 limit the overhead that wxWindows incurs by sending update UI events
9148 in idle time.
9149 """
9150 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9151
9152 def PopupMenuXY(*args, **kwargs):
9153 """
9154 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9155
9156 Pops up the given menu at the specified coordinates, relative to this window,
9157 and returns control when the user has dismissed the menu. If a menu item is
9158 selected, the corresponding menu event is generated and will be processed as
9159 usual. If the default position is given then the current position of the
9160 mouse cursor will be used.
9161 """
9162 return _core_.Window_PopupMenuXY(*args, **kwargs)
9163
9164 def PopupMenu(*args, **kwargs):
9165 """
9166 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9167
9168 Pops up the given menu at the specified coordinates, relative to this window,
9169 and returns control when the user has dismissed the menu. If a menu item is
9170 selected, the corresponding menu event is generated and will be processed as
9171 usual. If the default position is given then the current position of the
9172 mouse cursor will be used.
9173 """
9174 return _core_.Window_PopupMenu(*args, **kwargs)
9175
9176 def GetHandle(*args, **kwargs):
9177 """
9178 GetHandle(self) -> long
9179
9180 Returns the platform-specific handle (as a long integer) of the
9181 physical window. Currently on wxMac it returns the handle of the
9182 toplevel parent of the window.
9183 """
9184 return _core_.Window_GetHandle(*args, **kwargs)
9185
9186 def AssociateHandle(*args, **kwargs):
9187 """
9188 AssociateHandle(self, long handle)
9189
9190 Associate the window with a new native handle
9191 """
9192 return _core_.Window_AssociateHandle(*args, **kwargs)
9193
9194 def DissociateHandle(*args, **kwargs):
9195 """
9196 DissociateHandle(self)
9197
9198 Dissociate the current native handle from the window
9199 """
9200 return _core_.Window_DissociateHandle(*args, **kwargs)
9201
9202 def HasScrollbar(*args, **kwargs):
9203 """
9204 HasScrollbar(self, int orient) -> bool
9205
9206 Does the window have the scrollbar for this orientation?
9207 """
9208 return _core_.Window_HasScrollbar(*args, **kwargs)
9209
9210 def SetScrollbar(*args, **kwargs):
9211 """
9212 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9213 bool refresh=True)
9214
9215 Sets the scrollbar properties of a built-in scrollbar.
9216 """
9217 return _core_.Window_SetScrollbar(*args, **kwargs)
9218
9219 def SetScrollPos(*args, **kwargs):
9220 """
9221 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9222
9223 Sets the position of one of the built-in scrollbars.
9224 """
9225 return _core_.Window_SetScrollPos(*args, **kwargs)
9226
9227 def GetScrollPos(*args, **kwargs):
9228 """
9229 GetScrollPos(self, int orientation) -> int
9230
9231 Returns the built-in scrollbar position.
9232 """
9233 return _core_.Window_GetScrollPos(*args, **kwargs)
9234
9235 def GetScrollThumb(*args, **kwargs):
9236 """
9237 GetScrollThumb(self, int orientation) -> int
9238
9239 Returns the built-in scrollbar thumb size.
9240 """
9241 return _core_.Window_GetScrollThumb(*args, **kwargs)
9242
9243 def GetScrollRange(*args, **kwargs):
9244 """
9245 GetScrollRange(self, int orientation) -> int
9246
9247 Returns the built-in scrollbar range.
9248 """
9249 return _core_.Window_GetScrollRange(*args, **kwargs)
9250
9251 def ScrollWindow(*args, **kwargs):
9252 """
9253 ScrollWindow(self, int dx, int dy, Rect rect=None)
9254
9255 Physically scrolls the pixels in the window and move child windows
9256 accordingly. Use this function to optimise your scrolling
9257 implementations, to minimise the area that must be redrawn. Note that
9258 it is rarely required to call this function from a user program.
9259 """
9260 return _core_.Window_ScrollWindow(*args, **kwargs)
9261
9262 def ScrollLines(*args, **kwargs):
9263 """
9264 ScrollLines(self, int lines) -> bool
9265
9266 If the platform and window class supports it, scrolls the window by
9267 the given number of lines down, if lines is positive, or up if lines
9268 is negative. Returns True if the window was scrolled, False if it was
9269 already on top/bottom and nothing was done.
9270 """
9271 return _core_.Window_ScrollLines(*args, **kwargs)
9272
9273 def ScrollPages(*args, **kwargs):
9274 """
9275 ScrollPages(self, int pages) -> bool
9276
9277 If the platform and window class supports it, scrolls the window by
9278 the given number of pages down, if pages is positive, or up if pages
9279 is negative. Returns True if the window was scrolled, False if it was
9280 already on top/bottom and nothing was done.
9281 """
9282 return _core_.Window_ScrollPages(*args, **kwargs)
9283
9284 def LineUp(*args, **kwargs):
9285 """
9286 LineUp(self) -> bool
9287
9288 This is just a wrapper for ScrollLines(-1).
9289 """
9290 return _core_.Window_LineUp(*args, **kwargs)
9291
9292 def LineDown(*args, **kwargs):
9293 """
9294 LineDown(self) -> bool
9295
9296 This is just a wrapper for ScrollLines(1).
9297 """
9298 return _core_.Window_LineDown(*args, **kwargs)
9299
9300 def PageUp(*args, **kwargs):
9301 """
9302 PageUp(self) -> bool
9303
9304 This is just a wrapper for ScrollPages(-1).
9305 """
9306 return _core_.Window_PageUp(*args, **kwargs)
9307
9308 def PageDown(*args, **kwargs):
9309 """
9310 PageDown(self) -> bool
9311
9312 This is just a wrapper for ScrollPages(1).
9313 """
9314 return _core_.Window_PageDown(*args, **kwargs)
9315
9316 def SetHelpText(*args, **kwargs):
9317 """
9318 SetHelpText(self, String text)
9319
9320 Sets the help text to be used as context-sensitive help for this
9321 window. Note that the text is actually stored by the current
9322 `wx.HelpProvider` implementation, and not in the window object itself.
9323 """
9324 return _core_.Window_SetHelpText(*args, **kwargs)
9325
9326 def SetHelpTextForId(*args, **kwargs):
9327 """
9328 SetHelpTextForId(self, String text)
9329
9330 Associate this help text with all windows with the same id as this
9331 one.
9332 """
9333 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9334
9335 def GetHelpTextAtPoint(*args, **kwargs):
9336 """
9337 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9338
9339 Get the help string associated with the given position in this window.
9340
9341 Notice that pt may be invalid if event origin is keyboard or unknown
9342 and this method should return the global window help text then
9343
9344 """
9345 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9346
9347 def GetHelpText(*args, **kwargs):
9348 """
9349 GetHelpText(self) -> String
9350
9351 Gets the help text to be used as context-sensitive help for this
9352 window. Note that the text is actually stored by the current
9353 `wx.HelpProvider` implementation, and not in the window object itself.
9354 """
9355 return _core_.Window_GetHelpText(*args, **kwargs)
9356
9357 def SetToolTipString(*args, **kwargs):
9358 """
9359 SetToolTipString(self, String tip)
9360
9361 Attach a tooltip to the window.
9362 """
9363 return _core_.Window_SetToolTipString(*args, **kwargs)
9364
9365 def SetToolTip(*args, **kwargs):
9366 """
9367 SetToolTip(self, ToolTip tip)
9368
9369 Attach a tooltip to the window.
9370 """
9371 return _core_.Window_SetToolTip(*args, **kwargs)
9372
9373 def GetToolTip(*args, **kwargs):
9374 """
9375 GetToolTip(self) -> ToolTip
9376
9377 get the associated tooltip or None if none
9378 """
9379 return _core_.Window_GetToolTip(*args, **kwargs)
9380
9381 def SetDropTarget(*args, **kwargs):
9382 """
9383 SetDropTarget(self, DropTarget dropTarget)
9384
9385 Associates a drop target with this window. If the window already has
9386 a drop target, it is deleted.
9387 """
9388 return _core_.Window_SetDropTarget(*args, **kwargs)
9389
9390 def GetDropTarget(*args, **kwargs):
9391 """
9392 GetDropTarget(self) -> DropTarget
9393
9394 Returns the associated drop target, which may be None.
9395 """
9396 return _core_.Window_GetDropTarget(*args, **kwargs)
9397
9398 def DragAcceptFiles(*args, **kwargs):
9399 """
9400 DragAcceptFiles(self, bool accept)
9401
9402 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9403 Only functional on Windows.
9404 """
9405 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9406
9407 def SetConstraints(*args, **kwargs):
9408 """
9409 SetConstraints(self, LayoutConstraints constraints)
9410
9411 Sets the window to have the given layout constraints. If an existing
9412 layout constraints object is already owned by the window, it will be
9413 deleted. Pass None to disassociate and delete the window's current
9414 constraints.
9415
9416 You must call SetAutoLayout to tell a window to use the constraints
9417 automatically in its default EVT_SIZE handler; otherwise, you must
9418 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9419 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9420 effect.
9421 """
9422 return _core_.Window_SetConstraints(*args, **kwargs)
9423
9424 def GetConstraints(*args, **kwargs):
9425 """
9426 GetConstraints(self) -> LayoutConstraints
9427
9428 Returns a pointer to the window's layout constraints, or None if there
9429 are none.
9430 """
9431 return _core_.Window_GetConstraints(*args, **kwargs)
9432
9433 def SetAutoLayout(*args, **kwargs):
9434 """
9435 SetAutoLayout(self, bool autoLayout)
9436
9437 Determines whether the Layout function will be called automatically
9438 when the window is resized. lease note that this only happens for the
9439 windows usually used to contain children, namely `wx.Panel` and
9440 `wx.TopLevelWindow` (and the classes deriving from them).
9441
9442 This method is called implicitly by `SetSizer` but if you use
9443 `SetConstraints` you should call it manually or otherwise the window
9444 layout won't be correctly updated when its size changes.
9445 """
9446 return _core_.Window_SetAutoLayout(*args, **kwargs)
9447
9448 def GetAutoLayout(*args, **kwargs):
9449 """
9450 GetAutoLayout(self) -> bool
9451
9452 Returns the current autoLayout setting
9453 """
9454 return _core_.Window_GetAutoLayout(*args, **kwargs)
9455
9456 def Layout(*args, **kwargs):
9457 """
9458 Layout(self) -> bool
9459
9460 Invokes the constraint-based layout algorithm or the sizer-based
9461 algorithm for this window. See SetAutoLayout: when auto layout is on,
9462 this function gets called automatically by the default EVT_SIZE
9463 handler when the window is resized.
9464 """
9465 return _core_.Window_Layout(*args, **kwargs)
9466
9467 def SetSizer(*args, **kwargs):
9468 """
9469 SetSizer(self, Sizer sizer, bool deleteOld=True)
9470
9471 Sets the window to have the given layout sizer. The window will then
9472 own the object, and will take care of its deletion. If an existing
9473 layout sizer object is already owned by the window, it will be deleted
9474 if the deleteOld parameter is true. Note that this function will also
9475 call SetAutoLayout implicitly with a True parameter if the sizer is
9476 non-None, and False otherwise.
9477 """
9478 return _core_.Window_SetSizer(*args, **kwargs)
9479
9480 def SetSizerAndFit(*args, **kwargs):
9481 """
9482 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9483
9484 The same as SetSizer, except it also sets the size hints for the
9485 window based on the sizer's minimum size.
9486 """
9487 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9488
9489 def GetSizer(*args, **kwargs):
9490 """
9491 GetSizer(self) -> Sizer
9492
9493 Return the sizer associated with the window by a previous call to
9494 SetSizer or None if there isn't one.
9495 """
9496 return _core_.Window_GetSizer(*args, **kwargs)
9497
9498 def SetContainingSizer(*args, **kwargs):
9499 """
9500 SetContainingSizer(self, Sizer sizer)
9501
9502 This normally does not need to be called by application code. It is
9503 called internally when a window is added to a sizer, and is used so
9504 the window can remove itself from the sizer when it is destroyed.
9505 """
9506 return _core_.Window_SetContainingSizer(*args, **kwargs)
9507
9508 def GetContainingSizer(*args, **kwargs):
9509 """
9510 GetContainingSizer(self) -> Sizer
9511
9512 Return the sizer that this window is a member of, if any, otherwise None.
9513 """
9514 return _core_.Window_GetContainingSizer(*args, **kwargs)
9515
9516 def InheritAttributes(*args, **kwargs):
9517 """
9518 InheritAttributes(self)
9519
9520 This function is (or should be, in case of custom controls) called
9521 during window creation to intelligently set up the window visual
9522 attributes, that is the font and the foreground and background
9523 colours.
9524
9525 By 'intelligently' the following is meant: by default, all windows use
9526 their own default attributes. However if some of the parent's
9527 attributes are explicitly changed (that is, using SetFont and not
9528 SetOwnFont) and if the corresponding attribute hadn't been
9529 explicitly set for this window itself, then this window takes the same
9530 value as used by the parent. In addition, if the window overrides
9531 ShouldInheritColours to return false, the colours will not be changed
9532 no matter what and only the font might.
9533
9534 This rather complicated logic is necessary in order to accommodate the
9535 different usage scenarios. The most common one is when all default
9536 attributes are used and in this case, nothing should be inherited as
9537 in modern GUIs different controls use different fonts (and colours)
9538 than their siblings so they can't inherit the same value from the
9539 parent. However it was also deemed desirable to allow to simply change
9540 the attributes of all children at once by just changing the font or
9541 colour of their common parent, hence in this case we do inherit the
9542 parents attributes.
9543
9544 """
9545 return _core_.Window_InheritAttributes(*args, **kwargs)
9546
9547 def ShouldInheritColours(*args, **kwargs):
9548 """
9549 ShouldInheritColours(self) -> bool
9550
9551 Return true from here to allow the colours of this window to be
9552 changed by InheritAttributes, returning false forbids inheriting them
9553 from the parent window.
9554
9555 The base class version returns false, but this method is overridden in
9556 wxControl where it returns true.
9557 """
9558 return _core_.Window_ShouldInheritColours(*args, **kwargs)
9559
9560 def PostCreate(self, pre):
9561 """
9562 Phase 3 of the 2-phase create <wink!>
9563 Call this method after precreating the window with the 2-phase create method.
9564 """
9565 self.this = pre.this
9566 self.thisown = pre.thisown
9567 pre.thisown = 0
9568 if hasattr(self, '_setOORInfo'):
9569 self._setOORInfo(self)
9570 if hasattr(self, '_setCallbackInfo'):
9571 self._setCallbackInfo(self, self.__class__)
9572
9573 def SendSizeEvent(self):
9574 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
9575
9576 _core_.Window_swigregister(Window)
9577
9578 def PreWindow(*args, **kwargs):
9579 """
9580 PreWindow() -> Window
9581
9582 Precreate a Window for 2-phase creation.
9583 """
9584 val = _core_.new_PreWindow(*args, **kwargs)
9585 return val
9586
9587 def Window_NewControlId(*args):
9588 """
9589 Window_NewControlId() -> int
9590
9591 Generate a control id for the controls which were not given one.
9592 """
9593 return _core_.Window_NewControlId(*args)
9594
9595 def Window_NextControlId(*args, **kwargs):
9596 """
9597 Window_NextControlId(int winid) -> int
9598
9599 Get the id of the control following the one with the given
9600 autogenerated) id
9601 """
9602 return _core_.Window_NextControlId(*args, **kwargs)
9603
9604 def Window_PrevControlId(*args, **kwargs):
9605 """
9606 Window_PrevControlId(int winid) -> int
9607
9608 Get the id of the control preceding the one with the given
9609 autogenerated) id
9610 """
9611 return _core_.Window_PrevControlId(*args, **kwargs)
9612
9613 def Window_FindFocus(*args):
9614 """
9615 Window_FindFocus() -> Window
9616
9617 Returns the window or control that currently has the keyboard focus,
9618 or None.
9619 """
9620 return _core_.Window_FindFocus(*args)
9621
9622 def Window_GetCapture(*args):
9623 """
9624 Window_GetCapture() -> Window
9625
9626 Returns the window which currently captures the mouse or None
9627 """
9628 return _core_.Window_GetCapture(*args)
9629
9630 def Window_GetClassDefaultAttributes(*args, **kwargs):
9631 """
9632 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9633
9634 Get the default attributes for this class. This is useful if you want
9635 to use the same font or colour in your own control as in a standard
9636 control -- which is a much better idea than hard coding specific
9637 colours or fonts which might look completely out of place on the
9638 user's system, especially if it uses themes.
9639
9640 The variant parameter is only relevant under Mac currently and is
9641 ignore under other platforms. Under Mac, it will change the size of
9642 the returned font. See `wx.Window.SetWindowVariant` for more about
9643 this.
9644 """
9645 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9646
9647 def DLG_PNT(win, point_or_x, y=None):
9648 """
9649 Convenience function for converting a Point or (x,y) in
9650 dialog units to pixel units.
9651 """
9652 if y is None:
9653 return win.ConvertDialogPointToPixels(point_or_x)
9654 else:
9655 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
9656
9657 def DLG_SZE(win, size_width, height=None):
9658 """
9659 Convenience function for converting a Size or (w,h) in
9660 dialog units to pixel units.
9661 """
9662 if height is None:
9663 return win.ConvertDialogSizeToPixels(size_width)
9664 else:
9665 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
9666
9667
9668 def FindWindowById(*args, **kwargs):
9669 """
9670 FindWindowById(long id, Window parent=None) -> Window
9671
9672 Find the first window in the application with the given id. If parent
9673 is None, the search will start from all top-level frames and dialog
9674 boxes; if non-None, the search will be limited to the given window
9675 hierarchy. The search is recursive in both cases.
9676 """
9677 return _core_.FindWindowById(*args, **kwargs)
9678
9679 def FindWindowByName(*args, **kwargs):
9680 """
9681 FindWindowByName(String name, Window parent=None) -> Window
9682
9683 Find a window by its name (as given in a window constructor or Create
9684 function call). If parent is None, the search will start from all
9685 top-level frames and dialog boxes; if non-None, the search will be
9686 limited to the given window hierarchy. The search is recursive in both
9687 cases.
9688
9689 If no window with such name is found, wx.FindWindowByLabel is called.
9690 """
9691 return _core_.FindWindowByName(*args, **kwargs)
9692
9693 def FindWindowByLabel(*args, **kwargs):
9694 """
9695 FindWindowByLabel(String label, Window parent=None) -> Window
9696
9697 Find a window by its label. Depending on the type of window, the label
9698 may be a window title or panel item label. If parent is None, the
9699 search will start from all top-level frames and dialog boxes; if
9700 non-None, the search will be limited to the given window
9701 hierarchy. The search is recursive in both cases.
9702 """
9703 return _core_.FindWindowByLabel(*args, **kwargs)
9704
9705 def Window_FromHWND(*args, **kwargs):
9706 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
9707 return _core_.Window_FromHWND(*args, **kwargs)
9708
9709 def GetTopLevelWindows(*args):
9710 """
9711 GetTopLevelWindows() -> PyObject
9712
9713 Returns a list of the the application's top-level windows, (frames,
9714 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
9715 by wxWidgets, and so it is only valid as long as no top-level windows
9716 are closed or new top-level windows are created.
9717
9718 """
9719 return _core_.GetTopLevelWindows(*args)
9720 #---------------------------------------------------------------------------
9721
9722 class Validator(EvtHandler):
9723 """Proxy of C++ Validator class"""
9724 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9725 __repr__ = _swig_repr
9726 def __init__(self, *args, **kwargs):
9727 """__init__(self) -> Validator"""
9728 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
9729 self._setOORInfo(self)
9730
9731 def Clone(*args, **kwargs):
9732 """Clone(self) -> Validator"""
9733 return _core_.Validator_Clone(*args, **kwargs)
9734
9735 def Validate(*args, **kwargs):
9736 """Validate(self, Window parent) -> bool"""
9737 return _core_.Validator_Validate(*args, **kwargs)
9738
9739 def TransferToWindow(*args, **kwargs):
9740 """TransferToWindow(self) -> bool"""
9741 return _core_.Validator_TransferToWindow(*args, **kwargs)
9742
9743 def TransferFromWindow(*args, **kwargs):
9744 """TransferFromWindow(self) -> bool"""
9745 return _core_.Validator_TransferFromWindow(*args, **kwargs)
9746
9747 def GetWindow(*args, **kwargs):
9748 """GetWindow(self) -> Window"""
9749 return _core_.Validator_GetWindow(*args, **kwargs)
9750
9751 def SetWindow(*args, **kwargs):
9752 """SetWindow(self, Window window)"""
9753 return _core_.Validator_SetWindow(*args, **kwargs)
9754
9755 def IsSilent(*args, **kwargs):
9756 """IsSilent() -> bool"""
9757 return _core_.Validator_IsSilent(*args, **kwargs)
9758
9759 IsSilent = staticmethod(IsSilent)
9760 def SetBellOnError(*args, **kwargs):
9761 """SetBellOnError(int doIt=True)"""
9762 return _core_.Validator_SetBellOnError(*args, **kwargs)
9763
9764 SetBellOnError = staticmethod(SetBellOnError)
9765 _core_.Validator_swigregister(Validator)
9766
9767 def Validator_IsSilent(*args):
9768 """Validator_IsSilent() -> bool"""
9769 return _core_.Validator_IsSilent(*args)
9770
9771 def Validator_SetBellOnError(*args, **kwargs):
9772 """Validator_SetBellOnError(int doIt=True)"""
9773 return _core_.Validator_SetBellOnError(*args, **kwargs)
9774
9775 class PyValidator(Validator):
9776 """Proxy of C++ PyValidator class"""
9777 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9778 __repr__ = _swig_repr
9779 def __init__(self, *args, **kwargs):
9780 """__init__(self) -> PyValidator"""
9781 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
9782
9783 self._setCallbackInfo(self, PyValidator, 1)
9784 self._setOORInfo(self)
9785
9786 def _setCallbackInfo(*args, **kwargs):
9787 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
9788 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
9789
9790 _core_.PyValidator_swigregister(PyValidator)
9791
9792 #---------------------------------------------------------------------------
9793
9794 class Menu(EvtHandler):
9795 """Proxy of C++ Menu class"""
9796 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
9797 __repr__ = _swig_repr
9798 def __init__(self, *args, **kwargs):
9799 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
9800 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
9801 self._setOORInfo(self)
9802
9803 def Append(*args, **kwargs):
9804 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9805 return _core_.Menu_Append(*args, **kwargs)
9806
9807 def AppendSeparator(*args, **kwargs):
9808 """AppendSeparator(self) -> MenuItem"""
9809 return _core_.Menu_AppendSeparator(*args, **kwargs)
9810
9811 def AppendCheckItem(*args, **kwargs):
9812 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9813 return _core_.Menu_AppendCheckItem(*args, **kwargs)
9814
9815 def AppendRadioItem(*args, **kwargs):
9816 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9817 return _core_.Menu_AppendRadioItem(*args, **kwargs)
9818
9819 def AppendMenu(*args, **kwargs):
9820 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9821 return _core_.Menu_AppendMenu(*args, **kwargs)
9822
9823 def AppendSubMenu(*args, **kwargs):
9824 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
9825 return _core_.Menu_AppendSubMenu(*args, **kwargs)
9826
9827 def AppendItem(*args, **kwargs):
9828 """AppendItem(self, MenuItem item) -> MenuItem"""
9829 return _core_.Menu_AppendItem(*args, **kwargs)
9830
9831 def InsertItem(*args, **kwargs):
9832 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
9833 return _core_.Menu_InsertItem(*args, **kwargs)
9834
9835 def PrependItem(*args, **kwargs):
9836 """PrependItem(self, MenuItem item) -> MenuItem"""
9837 return _core_.Menu_PrependItem(*args, **kwargs)
9838
9839 def Break(*args, **kwargs):
9840 """Break(self)"""
9841 return _core_.Menu_Break(*args, **kwargs)
9842
9843 def Insert(*args, **kwargs):
9844 """
9845 Insert(self, size_t pos, int id, String text, String help=EmptyString,
9846 int kind=ITEM_NORMAL) -> MenuItem
9847 """
9848 return _core_.Menu_Insert(*args, **kwargs)
9849
9850 def InsertSeparator(*args, **kwargs):
9851 """InsertSeparator(self, size_t pos) -> MenuItem"""
9852 return _core_.Menu_InsertSeparator(*args, **kwargs)
9853
9854 def InsertCheckItem(*args, **kwargs):
9855 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9856 return _core_.Menu_InsertCheckItem(*args, **kwargs)
9857
9858 def InsertRadioItem(*args, **kwargs):
9859 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
9860 return _core_.Menu_InsertRadioItem(*args, **kwargs)
9861
9862 def InsertMenu(*args, **kwargs):
9863 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9864 return _core_.Menu_InsertMenu(*args, **kwargs)
9865
9866 def Prepend(*args, **kwargs):
9867 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
9868 return _core_.Menu_Prepend(*args, **kwargs)
9869
9870 def PrependSeparator(*args, **kwargs):
9871 """PrependSeparator(self) -> MenuItem"""
9872 return _core_.Menu_PrependSeparator(*args, **kwargs)
9873
9874 def PrependCheckItem(*args, **kwargs):
9875 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9876 return _core_.Menu_PrependCheckItem(*args, **kwargs)
9877
9878 def PrependRadioItem(*args, **kwargs):
9879 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
9880 return _core_.Menu_PrependRadioItem(*args, **kwargs)
9881
9882 def PrependMenu(*args, **kwargs):
9883 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
9884 return _core_.Menu_PrependMenu(*args, **kwargs)
9885
9886 def Remove(*args, **kwargs):
9887 """Remove(self, int id) -> MenuItem"""
9888 return _core_.Menu_Remove(*args, **kwargs)
9889
9890 def RemoveItem(*args, **kwargs):
9891 """RemoveItem(self, MenuItem item) -> MenuItem"""
9892 return _core_.Menu_RemoveItem(*args, **kwargs)
9893
9894 def Delete(*args, **kwargs):
9895 """Delete(self, int id) -> bool"""
9896 return _core_.Menu_Delete(*args, **kwargs)
9897
9898 def DeleteItem(*args, **kwargs):
9899 """DeleteItem(self, MenuItem item) -> bool"""
9900 return _core_.Menu_DeleteItem(*args, **kwargs)
9901
9902 def Destroy(*args, **kwargs):
9903 """
9904 Destroy(self)
9905
9906 Deletes the C++ object this Python object is a proxy for.
9907 """
9908 val = _core_.Menu_Destroy(*args, **kwargs)
9909 args[0].thisown = 0
9910 return val
9911
9912 def DestroyId(*args, **kwargs):
9913 """
9914 DestroyId(self, int id) -> bool
9915
9916 Deletes the C++ object this Python object is a proxy for.
9917 """
9918 val = _core_.Menu_DestroyId(*args, **kwargs)
9919 args[0].thisown = 0
9920 return val
9921
9922 def DestroyItem(*args, **kwargs):
9923 """
9924 DestroyItem(self, MenuItem item) -> bool
9925
9926 Deletes the C++ object this Python object is a proxy for.
9927 """
9928 val = _core_.Menu_DestroyItem(*args, **kwargs)
9929 args[0].thisown = 0
9930 return val
9931
9932 def GetMenuItemCount(*args, **kwargs):
9933 """GetMenuItemCount(self) -> size_t"""
9934 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
9935
9936 def GetMenuItems(*args, **kwargs):
9937 """GetMenuItems(self) -> PyObject"""
9938 return _core_.Menu_GetMenuItems(*args, **kwargs)
9939
9940 def FindItem(*args, **kwargs):
9941 """FindItem(self, String item) -> int"""
9942 return _core_.Menu_FindItem(*args, **kwargs)
9943
9944 def FindItemById(*args, **kwargs):
9945 """FindItemById(self, int id) -> MenuItem"""
9946 return _core_.Menu_FindItemById(*args, **kwargs)
9947
9948 def FindItemByPosition(*args, **kwargs):
9949 """FindItemByPosition(self, size_t position) -> MenuItem"""
9950 return _core_.Menu_FindItemByPosition(*args, **kwargs)
9951
9952 def Enable(*args, **kwargs):
9953 """Enable(self, int id, bool enable)"""
9954 return _core_.Menu_Enable(*args, **kwargs)
9955
9956 def IsEnabled(*args, **kwargs):
9957 """IsEnabled(self, int id) -> bool"""
9958 return _core_.Menu_IsEnabled(*args, **kwargs)
9959
9960 def Check(*args, **kwargs):
9961 """Check(self, int id, bool check)"""
9962 return _core_.Menu_Check(*args, **kwargs)
9963
9964 def IsChecked(*args, **kwargs):
9965 """IsChecked(self, int id) -> bool"""
9966 return _core_.Menu_IsChecked(*args, **kwargs)
9967
9968 def SetLabel(*args, **kwargs):
9969 """SetLabel(self, int id, String label)"""
9970 return _core_.Menu_SetLabel(*args, **kwargs)
9971
9972 def GetLabel(*args, **kwargs):
9973 """GetLabel(self, int id) -> String"""
9974 return _core_.Menu_GetLabel(*args, **kwargs)
9975
9976 def SetHelpString(*args, **kwargs):
9977 """SetHelpString(self, int id, String helpString)"""
9978 return _core_.Menu_SetHelpString(*args, **kwargs)
9979
9980 def GetHelpString(*args, **kwargs):
9981 """GetHelpString(self, int id) -> String"""
9982 return _core_.Menu_GetHelpString(*args, **kwargs)
9983
9984 def SetTitle(*args, **kwargs):
9985 """SetTitle(self, String title)"""
9986 return _core_.Menu_SetTitle(*args, **kwargs)
9987
9988 def GetTitle(*args, **kwargs):
9989 """GetTitle(self) -> String"""
9990 return _core_.Menu_GetTitle(*args, **kwargs)
9991
9992 def SetEventHandler(*args, **kwargs):
9993 """SetEventHandler(self, EvtHandler handler)"""
9994 return _core_.Menu_SetEventHandler(*args, **kwargs)
9995
9996 def GetEventHandler(*args, **kwargs):
9997 """GetEventHandler(self) -> EvtHandler"""
9998 return _core_.Menu_GetEventHandler(*args, **kwargs)
9999
10000 def SetInvokingWindow(*args, **kwargs):
10001 """SetInvokingWindow(self, Window win)"""
10002 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10003
10004 def GetInvokingWindow(*args, **kwargs):
10005 """GetInvokingWindow(self) -> Window"""
10006 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10007
10008 def GetStyle(*args, **kwargs):
10009 """GetStyle(self) -> long"""
10010 return _core_.Menu_GetStyle(*args, **kwargs)
10011
10012 def UpdateUI(*args, **kwargs):
10013 """UpdateUI(self, EvtHandler source=None)"""
10014 return _core_.Menu_UpdateUI(*args, **kwargs)
10015
10016 def GetMenuBar(*args, **kwargs):
10017 """GetMenuBar(self) -> MenuBar"""
10018 return _core_.Menu_GetMenuBar(*args, **kwargs)
10019
10020 def Attach(*args, **kwargs):
10021 """Attach(self, wxMenuBarBase menubar)"""
10022 return _core_.Menu_Attach(*args, **kwargs)
10023
10024 def Detach(*args, **kwargs):
10025 """Detach(self)"""
10026 return _core_.Menu_Detach(*args, **kwargs)
10027
10028 def IsAttached(*args, **kwargs):
10029 """IsAttached(self) -> bool"""
10030 return _core_.Menu_IsAttached(*args, **kwargs)
10031
10032 def SetParent(*args, **kwargs):
10033 """SetParent(self, Menu parent)"""
10034 return _core_.Menu_SetParent(*args, **kwargs)
10035
10036 def GetParent(*args, **kwargs):
10037 """GetParent(self) -> Menu"""
10038 return _core_.Menu_GetParent(*args, **kwargs)
10039
10040 _core_.Menu_swigregister(Menu)
10041 DefaultValidator = cvar.DefaultValidator
10042
10043 #---------------------------------------------------------------------------
10044
10045 class MenuBar(Window):
10046 """Proxy of C++ MenuBar class"""
10047 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10048 __repr__ = _swig_repr
10049 def __init__(self, *args, **kwargs):
10050 """__init__(self, long style=0) -> MenuBar"""
10051 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10052 self._setOORInfo(self)
10053
10054 def Append(*args, **kwargs):
10055 """Append(self, Menu menu, String title) -> bool"""
10056 return _core_.MenuBar_Append(*args, **kwargs)
10057
10058 def Insert(*args, **kwargs):
10059 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10060 return _core_.MenuBar_Insert(*args, **kwargs)
10061
10062 def GetMenuCount(*args, **kwargs):
10063 """GetMenuCount(self) -> size_t"""
10064 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10065
10066 def GetMenu(*args, **kwargs):
10067 """GetMenu(self, size_t pos) -> Menu"""
10068 return _core_.MenuBar_GetMenu(*args, **kwargs)
10069
10070 def Replace(*args, **kwargs):
10071 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10072 return _core_.MenuBar_Replace(*args, **kwargs)
10073
10074 def Remove(*args, **kwargs):
10075 """Remove(self, size_t pos) -> Menu"""
10076 return _core_.MenuBar_Remove(*args, **kwargs)
10077
10078 def EnableTop(*args, **kwargs):
10079 """EnableTop(self, size_t pos, bool enable)"""
10080 return _core_.MenuBar_EnableTop(*args, **kwargs)
10081
10082 def IsEnabledTop(*args, **kwargs):
10083 """IsEnabledTop(self, size_t pos) -> bool"""
10084 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10085
10086 def SetLabelTop(*args, **kwargs):
10087 """SetLabelTop(self, size_t pos, String label)"""
10088 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10089
10090 def GetLabelTop(*args, **kwargs):
10091 """GetLabelTop(self, size_t pos) -> String"""
10092 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10093
10094 def FindMenuItem(*args, **kwargs):
10095 """FindMenuItem(self, String menu, String item) -> int"""
10096 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10097
10098 def FindItemById(*args, **kwargs):
10099 """FindItemById(self, int id) -> MenuItem"""
10100 return _core_.MenuBar_FindItemById(*args, **kwargs)
10101
10102 def FindMenu(*args, **kwargs):
10103 """FindMenu(self, String title) -> int"""
10104 return _core_.MenuBar_FindMenu(*args, **kwargs)
10105
10106 def Enable(*args, **kwargs):
10107 """Enable(self, int id, bool enable)"""
10108 return _core_.MenuBar_Enable(*args, **kwargs)
10109
10110 def Check(*args, **kwargs):
10111 """Check(self, int id, bool check)"""
10112 return _core_.MenuBar_Check(*args, **kwargs)
10113
10114 def IsChecked(*args, **kwargs):
10115 """IsChecked(self, int id) -> bool"""
10116 return _core_.MenuBar_IsChecked(*args, **kwargs)
10117
10118 def IsEnabled(*args, **kwargs):
10119 """IsEnabled(self, int id) -> bool"""
10120 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10121
10122 def SetLabel(*args, **kwargs):
10123 """SetLabel(self, int id, String label)"""
10124 return _core_.MenuBar_SetLabel(*args, **kwargs)
10125
10126 def GetLabel(*args, **kwargs):
10127 """GetLabel(self, int id) -> String"""
10128 return _core_.MenuBar_GetLabel(*args, **kwargs)
10129
10130 def SetHelpString(*args, **kwargs):
10131 """SetHelpString(self, int id, String helpString)"""
10132 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10133
10134 def GetHelpString(*args, **kwargs):
10135 """GetHelpString(self, int id) -> String"""
10136 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10137
10138 def GetFrame(*args, **kwargs):
10139 """GetFrame(self) -> wxFrame"""
10140 return _core_.MenuBar_GetFrame(*args, **kwargs)
10141
10142 def IsAttached(*args, **kwargs):
10143 """IsAttached(self) -> bool"""
10144 return _core_.MenuBar_IsAttached(*args, **kwargs)
10145
10146 def Attach(*args, **kwargs):
10147 """Attach(self, wxFrame frame)"""
10148 return _core_.MenuBar_Attach(*args, **kwargs)
10149
10150 def Detach(*args, **kwargs):
10151 """Detach(self)"""
10152 return _core_.MenuBar_Detach(*args, **kwargs)
10153
10154 def SetAutoWindowMenu(*args, **kwargs):
10155 """SetAutoWindowMenu(bool enable)"""
10156 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10157
10158 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10159 def GetAutoWindowMenu(*args, **kwargs):
10160 """GetAutoWindowMenu() -> bool"""
10161 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10162
10163 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10164 _core_.MenuBar_swigregister(MenuBar)
10165
10166 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10167 """MenuBar_SetAutoWindowMenu(bool enable)"""
10168 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10169
10170 def MenuBar_GetAutoWindowMenu(*args):
10171 """MenuBar_GetAutoWindowMenu() -> bool"""
10172 return _core_.MenuBar_GetAutoWindowMenu(*args)
10173
10174 #---------------------------------------------------------------------------
10175
10176 class MenuItem(Object):
10177 """Proxy of C++ MenuItem class"""
10178 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10179 __repr__ = _swig_repr
10180 def __init__(self, *args, **kwargs):
10181 """
10182 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10183 String help=EmptyString, int kind=ITEM_NORMAL,
10184 Menu subMenu=None) -> MenuItem
10185 """
10186 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10187 __swig_destroy__ = _core_.delete_MenuItem
10188 __del__ = lambda self : None;
10189 def GetMenu(*args, **kwargs):
10190 """GetMenu(self) -> Menu"""
10191 return _core_.MenuItem_GetMenu(*args, **kwargs)
10192
10193 def SetMenu(*args, **kwargs):
10194 """SetMenu(self, Menu menu)"""
10195 return _core_.MenuItem_SetMenu(*args, **kwargs)
10196
10197 def SetId(*args, **kwargs):
10198 """SetId(self, int id)"""
10199 return _core_.MenuItem_SetId(*args, **kwargs)
10200
10201 def GetId(*args, **kwargs):
10202 """GetId(self) -> int"""
10203 return _core_.MenuItem_GetId(*args, **kwargs)
10204
10205 def IsSeparator(*args, **kwargs):
10206 """IsSeparator(self) -> bool"""
10207 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10208
10209 def SetText(*args, **kwargs):
10210 """SetText(self, String str)"""
10211 return _core_.MenuItem_SetText(*args, **kwargs)
10212
10213 def GetLabel(*args, **kwargs):
10214 """GetLabel(self) -> String"""
10215 return _core_.MenuItem_GetLabel(*args, **kwargs)
10216
10217 def GetText(*args, **kwargs):
10218 """GetText(self) -> String"""
10219 return _core_.MenuItem_GetText(*args, **kwargs)
10220
10221 def GetLabelFromText(*args, **kwargs):
10222 """GetLabelFromText(String text) -> String"""
10223 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10224
10225 GetLabelFromText = staticmethod(GetLabelFromText)
10226 def GetKind(*args, **kwargs):
10227 """GetKind(self) -> int"""
10228 return _core_.MenuItem_GetKind(*args, **kwargs)
10229
10230 def SetKind(*args, **kwargs):
10231 """SetKind(self, int kind)"""
10232 return _core_.MenuItem_SetKind(*args, **kwargs)
10233
10234 def SetCheckable(*args, **kwargs):
10235 """SetCheckable(self, bool checkable)"""
10236 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10237
10238 def IsCheckable(*args, **kwargs):
10239 """IsCheckable(self) -> bool"""
10240 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10241
10242 def IsSubMenu(*args, **kwargs):
10243 """IsSubMenu(self) -> bool"""
10244 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10245
10246 def SetSubMenu(*args, **kwargs):
10247 """SetSubMenu(self, Menu menu)"""
10248 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10249
10250 def GetSubMenu(*args, **kwargs):
10251 """GetSubMenu(self) -> Menu"""
10252 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10253
10254 def Enable(*args, **kwargs):
10255 """Enable(self, bool enable=True)"""
10256 return _core_.MenuItem_Enable(*args, **kwargs)
10257
10258 def IsEnabled(*args, **kwargs):
10259 """IsEnabled(self) -> bool"""
10260 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10261
10262 def Check(*args, **kwargs):
10263 """Check(self, bool check=True)"""
10264 return _core_.MenuItem_Check(*args, **kwargs)
10265
10266 def IsChecked(*args, **kwargs):
10267 """IsChecked(self) -> bool"""
10268 return _core_.MenuItem_IsChecked(*args, **kwargs)
10269
10270 def Toggle(*args, **kwargs):
10271 """Toggle(self)"""
10272 return _core_.MenuItem_Toggle(*args, **kwargs)
10273
10274 def SetHelp(*args, **kwargs):
10275 """SetHelp(self, String str)"""
10276 return _core_.MenuItem_SetHelp(*args, **kwargs)
10277
10278 def GetHelp(*args, **kwargs):
10279 """GetHelp(self) -> String"""
10280 return _core_.MenuItem_GetHelp(*args, **kwargs)
10281
10282 def GetAccel(*args, **kwargs):
10283 """GetAccel(self) -> AcceleratorEntry"""
10284 return _core_.MenuItem_GetAccel(*args, **kwargs)
10285
10286 def SetAccel(*args, **kwargs):
10287 """SetAccel(self, AcceleratorEntry accel)"""
10288 return _core_.MenuItem_SetAccel(*args, **kwargs)
10289
10290 def SetBitmap(*args, **kwargs):
10291 """SetBitmap(self, Bitmap bitmap)"""
10292 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10293
10294 def GetBitmap(*args, **kwargs):
10295 """GetBitmap(self) -> Bitmap"""
10296 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10297
10298 def SetFont(*args, **kwargs):
10299 """SetFont(self, Font font)"""
10300 return _core_.MenuItem_SetFont(*args, **kwargs)
10301
10302 def GetFont(*args, **kwargs):
10303 """GetFont(self) -> Font"""
10304 return _core_.MenuItem_GetFont(*args, **kwargs)
10305
10306 def SetTextColour(*args, **kwargs):
10307 """SetTextColour(self, Colour colText)"""
10308 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10309
10310 def GetTextColour(*args, **kwargs):
10311 """GetTextColour(self) -> Colour"""
10312 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10313
10314 def SetBackgroundColour(*args, **kwargs):
10315 """SetBackgroundColour(self, Colour colBack)"""
10316 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10317
10318 def GetBackgroundColour(*args, **kwargs):
10319 """GetBackgroundColour(self) -> Colour"""
10320 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10321
10322 def SetBitmaps(*args, **kwargs):
10323 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10324 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10325
10326 def SetDisabledBitmap(*args, **kwargs):
10327 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10328 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10329
10330 def GetDisabledBitmap(*args, **kwargs):
10331 """GetDisabledBitmap(self) -> Bitmap"""
10332 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10333
10334 def SetMarginWidth(*args, **kwargs):
10335 """SetMarginWidth(self, int nWidth)"""
10336 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10337
10338 def GetMarginWidth(*args, **kwargs):
10339 """GetMarginWidth(self) -> int"""
10340 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10341
10342 def GetDefaultMarginWidth(*args, **kwargs):
10343 """GetDefaultMarginWidth() -> int"""
10344 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10345
10346 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10347 def IsOwnerDrawn(*args, **kwargs):
10348 """IsOwnerDrawn(self) -> bool"""
10349 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10350
10351 def SetOwnerDrawn(*args, **kwargs):
10352 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10353 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10354
10355 def ResetOwnerDrawn(*args, **kwargs):
10356 """ResetOwnerDrawn(self)"""
10357 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10358
10359 _core_.MenuItem_swigregister(MenuItem)
10360
10361 def MenuItem_GetLabelFromText(*args, **kwargs):
10362 """MenuItem_GetLabelFromText(String text) -> String"""
10363 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10364
10365 def MenuItem_GetDefaultMarginWidth(*args):
10366 """MenuItem_GetDefaultMarginWidth() -> int"""
10367 return _core_.MenuItem_GetDefaultMarginWidth(*args)
10368
10369 #---------------------------------------------------------------------------
10370
10371 class Control(Window):
10372 """
10373 This is the base class for a control or 'widget'.
10374
10375 A control is generally a small window which processes user input
10376 and/or displays one or more item of data.
10377 """
10378 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10379 __repr__ = _swig_repr
10380 def __init__(self, *args, **kwargs):
10381 """
10382 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10383 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10384 String name=ControlNameStr) -> Control
10385
10386 Create a Control. Normally you should only call this from a subclass'
10387 __init__ as a plain old wx.Control is not very useful.
10388 """
10389 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
10390 self._setOORInfo(self)
10391
10392 def Create(*args, **kwargs):
10393 """
10394 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10395 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10396 String name=ControlNameStr) -> bool
10397
10398 Do the 2nd phase and create the GUI control.
10399 """
10400 return _core_.Control_Create(*args, **kwargs)
10401
10402 def Command(*args, **kwargs):
10403 """
10404 Command(self, CommandEvent event)
10405
10406 Simulates the effect of the user issuing a command to the item.
10407
10408 :see: `wx.CommandEvent`
10409
10410 """
10411 return _core_.Control_Command(*args, **kwargs)
10412
10413 def GetLabel(*args, **kwargs):
10414 """
10415 GetLabel(self) -> String
10416
10417 Return a control's text.
10418 """
10419 return _core_.Control_GetLabel(*args, **kwargs)
10420
10421 def GetClassDefaultAttributes(*args, **kwargs):
10422 """
10423 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10424
10425 Get the default attributes for this class. This is useful if you want
10426 to use the same font or colour in your own control as in a standard
10427 control -- which is a much better idea than hard coding specific
10428 colours or fonts which might look completely out of place on the
10429 user's system, especially if it uses themes.
10430
10431 The variant parameter is only relevant under Mac currently and is
10432 ignore under other platforms. Under Mac, it will change the size of
10433 the returned font. See `wx.Window.SetWindowVariant` for more about
10434 this.
10435 """
10436 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10437
10438 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
10439 _core_.Control_swigregister(Control)
10440 ControlNameStr = cvar.ControlNameStr
10441
10442 def PreControl(*args, **kwargs):
10443 """
10444 PreControl() -> Control
10445
10446 Precreate a Control control for 2-phase creation
10447 """
10448 val = _core_.new_PreControl(*args, **kwargs)
10449 return val
10450
10451 def Control_GetClassDefaultAttributes(*args, **kwargs):
10452 """
10453 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10454
10455 Get the default attributes for this class. This is useful if you want
10456 to use the same font or colour in your own control as in a standard
10457 control -- which is a much better idea than hard coding specific
10458 colours or fonts which might look completely out of place on the
10459 user's system, especially if it uses themes.
10460
10461 The variant parameter is only relevant under Mac currently and is
10462 ignore under other platforms. Under Mac, it will change the size of
10463 the returned font. See `wx.Window.SetWindowVariant` for more about
10464 this.
10465 """
10466 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10467
10468 #---------------------------------------------------------------------------
10469
10470 class ItemContainer(object):
10471 """
10472 The wx.ItemContainer class defines an interface which is implemented
10473 by all controls which have string subitems, each of which may be
10474 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
10475 as `wx.ComboBox` which implements an extended interface deriving from
10476 this one.
10477
10478 It defines the methods for accessing the control's items and although
10479 each of the derived classes implements them differently, they still
10480 all conform to the same interface.
10481
10482 The items in a wx.ItemContainer have (non empty) string labels and,
10483 optionally, client data associated with them.
10484
10485 """
10486 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10487 def __init__(self): raise AttributeError, "No constructor defined"
10488 __repr__ = _swig_repr
10489 def Append(*args, **kwargs):
10490 """
10491 Append(self, String item, PyObject clientData=None) -> int
10492
10493 Adds the item to the control, associating the given data with the item
10494 if not None. The return value is the index of the newly added item
10495 which may be different from the last one if the control is sorted (e.g.
10496 has wx.LB_SORT or wx.CB_SORT style).
10497 """
10498 return _core_.ItemContainer_Append(*args, **kwargs)
10499
10500 def AppendItems(*args, **kwargs):
10501 """
10502 AppendItems(self, List strings)
10503
10504 Apend several items at once to the control. Notice that calling this
10505 method may be much faster than appending the items one by one if you
10506 need to add a lot of items.
10507 """
10508 return _core_.ItemContainer_AppendItems(*args, **kwargs)
10509
10510 def Insert(*args, **kwargs):
10511 """
10512 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
10513
10514 Insert an item into the control before the item at the ``pos`` index,
10515 optionally associating some data object with the item.
10516 """
10517 return _core_.ItemContainer_Insert(*args, **kwargs)
10518
10519 def Clear(*args, **kwargs):
10520 """
10521 Clear(self)
10522
10523 Removes all items from the control.
10524 """
10525 return _core_.ItemContainer_Clear(*args, **kwargs)
10526
10527 def Delete(*args, **kwargs):
10528 """
10529 Delete(self, unsigned int n)
10530
10531 Deletes the item at the zero-based index 'n' from the control. Note
10532 that it is an error (signalled by a `wx.PyAssertionError` exception if
10533 enabled) to remove an item with the index negative or greater or equal
10534 than the number of items in the control.
10535 """
10536 return _core_.ItemContainer_Delete(*args, **kwargs)
10537
10538 def GetClientData(*args, **kwargs):
10539 """
10540 GetClientData(self, unsigned int n) -> PyObject
10541
10542 Returns the client data associated with the given item, (if any.)
10543 """
10544 return _core_.ItemContainer_GetClientData(*args, **kwargs)
10545
10546 def SetClientData(*args, **kwargs):
10547 """
10548 SetClientData(self, unsigned int n, PyObject clientData)
10549
10550 Associate the given client data with the item at position n.
10551 """
10552 return _core_.ItemContainer_SetClientData(*args, **kwargs)
10553
10554 def GetCount(*args, **kwargs):
10555 """
10556 GetCount(self) -> unsigned int
10557
10558 Returns the number of items in the control.
10559 """
10560 return _core_.ItemContainer_GetCount(*args, **kwargs)
10561
10562 def IsEmpty(*args, **kwargs):
10563 """
10564 IsEmpty(self) -> bool
10565
10566 Returns True if the control is empty or False if it has some items.
10567 """
10568 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
10569
10570 def GetString(*args, **kwargs):
10571 """
10572 GetString(self, unsigned int n) -> String
10573
10574 Returns the label of the item with the given index.
10575 """
10576 return _core_.ItemContainer_GetString(*args, **kwargs)
10577
10578 def GetStrings(*args, **kwargs):
10579 """GetStrings(self) -> wxArrayString"""
10580 return _core_.ItemContainer_GetStrings(*args, **kwargs)
10581
10582 def SetString(*args, **kwargs):
10583 """
10584 SetString(self, unsigned int n, String s)
10585
10586 Sets the label for the given item.
10587 """
10588 return _core_.ItemContainer_SetString(*args, **kwargs)
10589
10590 def FindString(*args, **kwargs):
10591 """
10592 FindString(self, String s) -> int
10593
10594 Finds an item whose label matches the given string. Returns the
10595 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
10596 found.
10597 """
10598 return _core_.ItemContainer_FindString(*args, **kwargs)
10599
10600 def SetSelection(*args, **kwargs):
10601 """
10602 SetSelection(self, int n)
10603
10604 Sets the item at index 'n' to be the selected item.
10605 """
10606 return _core_.ItemContainer_SetSelection(*args, **kwargs)
10607
10608 def GetSelection(*args, **kwargs):
10609 """
10610 GetSelection(self) -> int
10611
10612 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
10613 is selected.
10614 """
10615 return _core_.ItemContainer_GetSelection(*args, **kwargs)
10616
10617 def SetStringSelection(*args, **kwargs):
10618 """SetStringSelection(self, String s) -> bool"""
10619 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
10620
10621 def GetStringSelection(*args, **kwargs):
10622 """
10623 GetStringSelection(self) -> String
10624
10625 Returns the label of the selected item or an empty string if no item
10626 is selected.
10627 """
10628 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
10629
10630 def Select(*args, **kwargs):
10631 """
10632 Select(self, int n)
10633
10634 This is the same as `SetSelection` and exists only because it is
10635 slightly more natural for controls which support multiple selection.
10636 """
10637 return _core_.ItemContainer_Select(*args, **kwargs)
10638
10639 _core_.ItemContainer_swigregister(ItemContainer)
10640
10641 #---------------------------------------------------------------------------
10642
10643 class ControlWithItems(Control,ItemContainer):
10644 """
10645 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
10646 wx.Control class, and is used for the base class of various controls
10647 that have items.
10648 """
10649 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10650 def __init__(self): raise AttributeError, "No constructor defined"
10651 __repr__ = _swig_repr
10652 _core_.ControlWithItems_swigregister(ControlWithItems)
10653
10654 #---------------------------------------------------------------------------
10655
10656 class SizerItem(Object):
10657 """
10658 The wx.SizerItem class is used to track the position, size and other
10659 attributes of each item managed by a `wx.Sizer`. It is not usually
10660 necessary to use this class because the sizer elements can also be
10661 identified by their positions or window or sizer references but
10662 sometimes it may be more convenient to use wx.SizerItem directly.
10663 Also, custom classes derived from `wx.PySizer` will probably need to
10664 use the collection of wx.SizerItems held by wx.Sizer when calculating
10665 layout.
10666
10667 :see: `wx.Sizer`, `wx.GBSizerItem`
10668 """
10669 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10670 __repr__ = _swig_repr
10671 def __init__(self, *args, **kwargs):
10672 """
10673 __init__(self) -> SizerItem
10674
10675 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
10676 size will need to be set before this item can be used in a Sizer.
10677
10678 You will probably never need to create a wx.SizerItem directly as they
10679 are created automatically when the sizer's Add, Insert or Prepend
10680 methods are called.
10681
10682 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
10683 """
10684 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
10685 __swig_destroy__ = _core_.delete_SizerItem
10686 __del__ = lambda self : None;
10687 def DeleteWindows(*args, **kwargs):
10688 """
10689 DeleteWindows(self)
10690
10691 Destroy the window or the windows in a subsizer, depending on the type
10692 of item.
10693 """
10694 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
10695
10696 def DetachSizer(*args, **kwargs):
10697 """
10698 DetachSizer(self)
10699
10700 Enable deleting the SizerItem without destroying the contained sizer.
10701 """
10702 return _core_.SizerItem_DetachSizer(*args, **kwargs)
10703
10704 def GetSize(*args, **kwargs):
10705 """
10706 GetSize(self) -> Size
10707
10708 Get the current size of the item, as set in the last Layout.
10709 """
10710 return _core_.SizerItem_GetSize(*args, **kwargs)
10711
10712 def CalcMin(*args, **kwargs):
10713 """
10714 CalcMin(self) -> Size
10715
10716 Calculates the minimum desired size for the item, including any space
10717 needed by borders.
10718 """
10719 return _core_.SizerItem_CalcMin(*args, **kwargs)
10720
10721 def SetDimension(*args, **kwargs):
10722 """
10723 SetDimension(self, Point pos, Size size)
10724
10725 Set the position and size of the space allocated for this item by the
10726 sizer, and adjust the position and size of the item (window or
10727 subsizer) to be within that space taking alignment and borders into
10728 account.
10729 """
10730 return _core_.SizerItem_SetDimension(*args, **kwargs)
10731
10732 def GetMinSize(*args, **kwargs):
10733 """
10734 GetMinSize(self) -> Size
10735
10736 Get the minimum size needed for the item.
10737 """
10738 return _core_.SizerItem_GetMinSize(*args, **kwargs)
10739
10740 def GetMinSizeWithBorder(*args, **kwargs):
10741 """
10742 GetMinSizeWithBorder(self) -> Size
10743
10744 Get the minimum size needed for the item with space for the borders
10745 added, if needed.
10746 """
10747 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
10748
10749 def SetInitSize(*args, **kwargs):
10750 """SetInitSize(self, int x, int y)"""
10751 return _core_.SizerItem_SetInitSize(*args, **kwargs)
10752
10753 def SetRatioWH(*args, **kwargs):
10754 """
10755 SetRatioWH(self, int width, int height)
10756
10757 Set the ratio item attribute.
10758 """
10759 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
10760
10761 def SetRatioSize(*args, **kwargs):
10762 """
10763 SetRatioSize(self, Size size)
10764
10765 Set the ratio item attribute.
10766 """
10767 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
10768
10769 def SetRatio(*args, **kwargs):
10770 """
10771 SetRatio(self, float ratio)
10772
10773 Set the ratio item attribute.
10774 """
10775 return _core_.SizerItem_SetRatio(*args, **kwargs)
10776
10777 def GetRatio(*args, **kwargs):
10778 """
10779 GetRatio(self) -> float
10780
10781 Set the ratio item attribute.
10782 """
10783 return _core_.SizerItem_GetRatio(*args, **kwargs)
10784
10785 def GetRect(*args, **kwargs):
10786 """
10787 GetRect(self) -> Rect
10788
10789 Returns the rectangle that the sizer item should occupy
10790 """
10791 return _core_.SizerItem_GetRect(*args, **kwargs)
10792
10793 def IsWindow(*args, **kwargs):
10794 """
10795 IsWindow(self) -> bool
10796
10797 Is this sizer item a window?
10798 """
10799 return _core_.SizerItem_IsWindow(*args, **kwargs)
10800
10801 def IsSizer(*args, **kwargs):
10802 """
10803 IsSizer(self) -> bool
10804
10805 Is this sizer item a subsizer?
10806 """
10807 return _core_.SizerItem_IsSizer(*args, **kwargs)
10808
10809 def IsSpacer(*args, **kwargs):
10810 """
10811 IsSpacer(self) -> bool
10812
10813 Is this sizer item a spacer?
10814 """
10815 return _core_.SizerItem_IsSpacer(*args, **kwargs)
10816
10817 def SetProportion(*args, **kwargs):
10818 """
10819 SetProportion(self, int proportion)
10820
10821 Set the proportion value for this item.
10822 """
10823 return _core_.SizerItem_SetProportion(*args, **kwargs)
10824
10825 def GetProportion(*args, **kwargs):
10826 """
10827 GetProportion(self) -> int
10828
10829 Get the proportion value for this item.
10830 """
10831 return _core_.SizerItem_GetProportion(*args, **kwargs)
10832
10833 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
10834 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
10835 def SetFlag(*args, **kwargs):
10836 """
10837 SetFlag(self, int flag)
10838
10839 Set the flag value for this item.
10840 """
10841 return _core_.SizerItem_SetFlag(*args, **kwargs)
10842
10843 def GetFlag(*args, **kwargs):
10844 """
10845 GetFlag(self) -> int
10846
10847 Get the flag value for this item.
10848 """
10849 return _core_.SizerItem_GetFlag(*args, **kwargs)
10850
10851 def SetBorder(*args, **kwargs):
10852 """
10853 SetBorder(self, int border)
10854
10855 Set the border value for this item.
10856 """
10857 return _core_.SizerItem_SetBorder(*args, **kwargs)
10858
10859 def GetBorder(*args, **kwargs):
10860 """
10861 GetBorder(self) -> int
10862
10863 Get the border value for this item.
10864 """
10865 return _core_.SizerItem_GetBorder(*args, **kwargs)
10866
10867 def GetWindow(*args, **kwargs):
10868 """
10869 GetWindow(self) -> Window
10870
10871 Get the window (if any) that is managed by this sizer item.
10872 """
10873 return _core_.SizerItem_GetWindow(*args, **kwargs)
10874
10875 def SetWindow(*args, **kwargs):
10876 """
10877 SetWindow(self, Window window)
10878
10879 Set the window to be managed by this sizer item.
10880 """
10881 return _core_.SizerItem_SetWindow(*args, **kwargs)
10882
10883 def GetSizer(*args, **kwargs):
10884 """
10885 GetSizer(self) -> Sizer
10886
10887 Get the subsizer (if any) that is managed by this sizer item.
10888 """
10889 return _core_.SizerItem_GetSizer(*args, **kwargs)
10890
10891 def SetSizer(*args, **kwargs):
10892 """
10893 SetSizer(self, Sizer sizer)
10894
10895 Set the subsizer to be managed by this sizer item.
10896 """
10897 return _core_.SizerItem_SetSizer(*args, **kwargs)
10898
10899 def GetSpacer(*args, **kwargs):
10900 """
10901 GetSpacer(self) -> Size
10902
10903 Get the size of the spacer managed by this sizer item.
10904 """
10905 return _core_.SizerItem_GetSpacer(*args, **kwargs)
10906
10907 def SetSpacer(*args, **kwargs):
10908 """
10909 SetSpacer(self, Size size)
10910
10911 Set the size of the spacer to be managed by this sizer item.
10912 """
10913 return _core_.SizerItem_SetSpacer(*args, **kwargs)
10914
10915 def Show(*args, **kwargs):
10916 """
10917 Show(self, bool show)
10918
10919 Set the show item attribute, which sizers use to determine if the item
10920 is to be made part of the layout or not. If the item is tracking a
10921 window then it is shown or hidden as needed.
10922 """
10923 return _core_.SizerItem_Show(*args, **kwargs)
10924
10925 def IsShown(*args, **kwargs):
10926 """
10927 IsShown(self) -> bool
10928
10929 Is the item to be shown in the layout?
10930 """
10931 return _core_.SizerItem_IsShown(*args, **kwargs)
10932
10933 def GetPosition(*args, **kwargs):
10934 """
10935 GetPosition(self) -> Point
10936
10937 Returns the current position of the item, as set in the last Layout.
10938 """
10939 return _core_.SizerItem_GetPosition(*args, **kwargs)
10940
10941 def GetUserData(*args, **kwargs):
10942 """
10943 GetUserData(self) -> PyObject
10944
10945 Returns the userData associated with this sizer item, or None if there
10946 isn't any.
10947 """
10948 return _core_.SizerItem_GetUserData(*args, **kwargs)
10949
10950 def SetUserData(*args, **kwargs):
10951 """
10952 SetUserData(self, PyObject userData)
10953
10954 Associate a Python object with this sizer item.
10955 """
10956 return _core_.SizerItem_SetUserData(*args, **kwargs)
10957
10958 _core_.SizerItem_swigregister(SizerItem)
10959
10960 def SizerItemWindow(*args, **kwargs):
10961 """
10962 SizerItemWindow(Window window, int proportion, int flag, int border,
10963 PyObject userData=None) -> SizerItem
10964
10965 Constructs a `wx.SizerItem` for tracking a window.
10966 """
10967 val = _core_.new_SizerItemWindow(*args, **kwargs)
10968 return val
10969
10970 def SizerItemSpacer(*args, **kwargs):
10971 """
10972 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
10973 PyObject userData=None) -> SizerItem
10974
10975 Constructs a `wx.SizerItem` for tracking a spacer.
10976 """
10977 val = _core_.new_SizerItemSpacer(*args, **kwargs)
10978 return val
10979
10980 def SizerItemSizer(*args, **kwargs):
10981 """
10982 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
10983 PyObject userData=None) -> SizerItem
10984
10985 Constructs a `wx.SizerItem` for tracking a subsizer
10986 """
10987 val = _core_.new_SizerItemSizer(*args, **kwargs)
10988 return val
10989
10990 class Sizer(Object):
10991 """
10992 wx.Sizer is the abstract base class used for laying out subwindows in
10993 a window. You cannot use wx.Sizer directly; instead, you will have to
10994 use one of the sizer classes derived from it such as `wx.BoxSizer`,
10995 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
10996 `wx.GridBagSizer`.
10997
10998 The concept implemented by sizers in wxWidgets is closely related to
10999 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11000 toolkit or the Qt toolkit. It is based upon the idea of the individual
11001 subwindows reporting their minimal required size and their ability to
11002 get stretched if the size of the parent window has changed. This will
11003 most often mean that the programmer does not set the original size of
11004 a dialog in the beginning, rather the dialog will assigned a sizer and
11005 this sizer will be queried about the recommended size. The sizer in
11006 turn will query its children, which can be normal windows or contorls,
11007 empty space or other sizers, so that a hierarchy of sizers can be
11008 constructed. Note that wxSizer does not derive from wxWindow and thus
11009 do not interfere with tab ordering and requires very little resources
11010 compared to a real window on screen.
11011
11012 What makes sizers so well fitted for use in wxWidgets is the fact that
11013 every control reports its own minimal size and the algorithm can
11014 handle differences in font sizes or different window (dialog item)
11015 sizes on different platforms without problems. If for example the
11016 standard font as well as the overall design of Mac widgets requires
11017 more space than on Windows, then the initial size of a dialog using a
11018 sizer will automatically be bigger on Mac than on Windows.
11019 """
11020 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11021 def __init__(self): raise AttributeError, "No constructor defined"
11022 __repr__ = _swig_repr
11023 __swig_destroy__ = _core_.delete_Sizer
11024 __del__ = lambda self : None;
11025 def _setOORInfo(*args, **kwargs):
11026 """_setOORInfo(self, PyObject _self)"""
11027 return _core_.Sizer__setOORInfo(*args, **kwargs)
11028
11029 def Add(*args, **kwargs):
11030 """
11031 Add(self, item, int proportion=0, int flag=0, int border=0,
11032 PyObject userData=None) -> wx.SizerItem
11033
11034 Appends a child item to the sizer.
11035 """
11036 return _core_.Sizer_Add(*args, **kwargs)
11037
11038 def Insert(*args, **kwargs):
11039 """
11040 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11041 PyObject userData=None) -> wx.SizerItem
11042
11043 Inserts a new item into the list of items managed by this sizer before
11044 the item at index *before*. See `Add` for a description of the parameters.
11045 """
11046 return _core_.Sizer_Insert(*args, **kwargs)
11047
11048 def Prepend(*args, **kwargs):
11049 """
11050 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11051 PyObject userData=None) -> wx.SizerItem
11052
11053 Adds a new item to the begining of the list of sizer items managed by
11054 this sizer. See `Add` for a description of the parameters.
11055 """
11056 return _core_.Sizer_Prepend(*args, **kwargs)
11057
11058 def Remove(*args, **kwargs):
11059 """
11060 Remove(self, item) -> bool
11061
11062 Removes an item from the sizer and destroys it. This method does not
11063 cause any layout or resizing to take place, call `Layout` to update
11064 the layout on screen after removing a child from the sizer. The
11065 *item* parameter can be either a window, a sizer, or the zero-based
11066 index of an item to remove. Returns True if the child item was found
11067 and removed.
11068 """
11069 return _core_.Sizer_Remove(*args, **kwargs)
11070
11071 def Detach(*args, **kwargs):
11072 """
11073 Detach(self, item) -> bool
11074
11075 Detaches an item from the sizer without destroying it. This method
11076 does not cause any layout or resizing to take place, call `Layout` to
11077 do so. The *item* parameter can be either a window, a sizer, or the
11078 zero-based index of the item to be detached. Returns True if the child item
11079 was found and detached.
11080 """
11081 return _core_.Sizer_Detach(*args, **kwargs)
11082
11083 def GetItem(*args, **kwargs):
11084 """
11085 GetItem(self, item) -> wx.SizerItem
11086
11087 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11088 parameter can be either a window, a sizer, or the zero-based index of
11089 the item to be found.
11090 """
11091 return _core_.Sizer_GetItem(*args, **kwargs)
11092
11093 def _SetItemMinSize(*args, **kwargs):
11094 """_SetItemMinSize(self, PyObject item, Size size)"""
11095 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11096
11097 def SetItemMinSize(self, item, *args):
11098 """
11099 SetItemMinSize(self, item, Size size)
11100
11101 Sets the minimum size that will be allocated for an item in the sizer.
11102 The *item* parameter can be either a window, a sizer, or the
11103 zero-based index of the item. If a window or sizer is given then it
11104 will be searched for recursivly in subsizers if neccessary.
11105 """
11106 if len(args) == 2:
11107 # for backward compatibility accept separate width,height args too
11108 return self._SetItemMinSize(item, args)
11109 else:
11110 return self._SetItemMinSize(item, args[0])
11111
11112 def AddItem(*args, **kwargs):
11113 """
11114 AddItem(self, SizerItem item)
11115
11116 Adds a `wx.SizerItem` to the sizer.
11117 """
11118 return _core_.Sizer_AddItem(*args, **kwargs)
11119
11120 def InsertItem(*args, **kwargs):
11121 """
11122 InsertItem(self, int index, SizerItem item)
11123
11124 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11125 """
11126 return _core_.Sizer_InsertItem(*args, **kwargs)
11127
11128 def PrependItem(*args, **kwargs):
11129 """
11130 PrependItem(self, SizerItem item)
11131
11132 Prepends a `wx.SizerItem` to the sizer.
11133 """
11134 return _core_.Sizer_PrependItem(*args, **kwargs)
11135
11136 def AddMany(self, items):
11137 """
11138 AddMany is a convenience method for adding several items
11139 to a sizer at one time. Simply pass it a list of tuples,
11140 where each tuple consists of the parameters that you
11141 would normally pass to the `Add` method.
11142 """
11143 for item in items:
11144 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11145 item = (item, )
11146 self.Add(*item)
11147
11148 # for backwards compatibility only, please do not use in new code
11149 def AddWindow(self, *args, **kw):
11150 """Compatibility alias for `Add`."""
11151 return self.Add(*args, **kw)
11152 def AddSizer(self, *args, **kw):
11153 """Compatibility alias for `Add`."""
11154 return self.Add(*args, **kw)
11155 def AddSpacer(self, *args, **kw):
11156 """Compatibility alias for `Add`."""
11157 return self.Add(*args, **kw)
11158
11159 def PrependWindow(self, *args, **kw):
11160 """Compatibility alias for `Prepend`."""
11161 return self.Prepend(*args, **kw)
11162 def PrependSizer(self, *args, **kw):
11163 """Compatibility alias for `Prepend`."""
11164 return self.Prepend(*args, **kw)
11165 def PrependSpacer(self, *args, **kw):
11166 """Compatibility alias for `Prepend`."""
11167 return self.Prepend(*args, **kw)
11168
11169 def InsertWindow(self, *args, **kw):
11170 """Compatibility alias for `Insert`."""
11171 return self.Insert(*args, **kw)
11172 def InsertSizer(self, *args, **kw):
11173 """Compatibility alias for `Insert`."""
11174 return self.Insert(*args, **kw)
11175 def InsertSpacer(self, *args, **kw):
11176 """Compatibility alias for `Insert`."""
11177 return self.Insert(*args, **kw)
11178
11179 def RemoveWindow(self, *args, **kw):
11180 """Compatibility alias for `Remove`."""
11181 return self.Remove(*args, **kw)
11182 def RemoveSizer(self, *args, **kw):
11183 """Compatibility alias for `Remove`."""
11184 return self.Remove(*args, **kw)
11185 def RemovePos(self, *args, **kw):
11186 """Compatibility alias for `Remove`."""
11187 return self.Remove(*args, **kw)
11188
11189
11190 def SetDimension(*args, **kwargs):
11191 """
11192 SetDimension(self, int x, int y, int width, int height)
11193
11194 Call this to force the sizer to take the given dimension and thus
11195 force the items owned by the sizer to resize themselves according to
11196 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11197 methods.
11198 """
11199 return _core_.Sizer_SetDimension(*args, **kwargs)
11200
11201 def SetMinSize(*args, **kwargs):
11202 """
11203 SetMinSize(self, Size size)
11204
11205 Call this to give the sizer a minimal size. Normally, the sizer will
11206 calculate its minimal size based purely on how much space its children
11207 need. After calling this method `GetMinSize` will return either the
11208 minimal size as requested by its children or the minimal size set
11209 here, depending on which is bigger.
11210 """
11211 return _core_.Sizer_SetMinSize(*args, **kwargs)
11212
11213 def GetSize(*args, **kwargs):
11214 """
11215 GetSize(self) -> Size
11216
11217 Returns the current size of the space managed by the sizer.
11218 """
11219 return _core_.Sizer_GetSize(*args, **kwargs)
11220
11221 def GetPosition(*args, **kwargs):
11222 """
11223 GetPosition(self) -> Point
11224
11225 Returns the current position of the sizer's managed space.
11226 """
11227 return _core_.Sizer_GetPosition(*args, **kwargs)
11228
11229 def GetMinSize(*args, **kwargs):
11230 """
11231 GetMinSize(self) -> Size
11232
11233 Returns the minimal size of the sizer. This is either the combined
11234 minimal size of all the children and their borders or the minimal size
11235 set by SetMinSize, depending on which is bigger.
11236 """
11237 return _core_.Sizer_GetMinSize(*args, **kwargs)
11238
11239 def GetSizeTuple(self):
11240 return self.GetSize().Get()
11241 def GetPositionTuple(self):
11242 return self.GetPosition().Get()
11243 def GetMinSizeTuple(self):
11244 return self.GetMinSize().Get()
11245
11246 def RecalcSizes(*args, **kwargs):
11247 """
11248 RecalcSizes(self)
11249
11250 Using the sizes calculated by `CalcMin` reposition and resize all the
11251 items managed by this sizer. You should not need to call this directly as
11252 it is called by `Layout`.
11253 """
11254 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11255
11256 def CalcMin(*args, **kwargs):
11257 """
11258 CalcMin(self) -> Size
11259
11260 This method is where the sizer will do the actual calculation of its
11261 children's minimal sizes. You should not need to call this directly as
11262 it is called by `Layout`.
11263 """
11264 return _core_.Sizer_CalcMin(*args, **kwargs)
11265
11266 def Layout(*args, **kwargs):
11267 """
11268 Layout(self)
11269
11270 This method will force the recalculation and layout of the items
11271 controlled by the sizer using the current space allocated to the
11272 sizer. Normally this is called automatically from the owning window's
11273 EVT_SIZE handler, but it is also useful to call it from user code when
11274 one of the items in a sizer change size, or items are added or
11275 removed.
11276 """
11277 return _core_.Sizer_Layout(*args, **kwargs)
11278
11279 def Fit(*args, **kwargs):
11280 """
11281 Fit(self, Window window) -> Size
11282
11283 Tell the sizer to resize the *window* to match the sizer's minimal
11284 size. This is commonly done in the constructor of the window itself in
11285 order to set its initial size to match the needs of the children as
11286 determined by the sizer. Returns the new size.
11287
11288 For a top level window this is the total window size, not the client size.
11289 """
11290 return _core_.Sizer_Fit(*args, **kwargs)
11291
11292 def FitInside(*args, **kwargs):
11293 """
11294 FitInside(self, Window window)
11295
11296 Tell the sizer to resize the *virtual size* of the *window* to match the
11297 sizer's minimal size. This will not alter the on screen size of the
11298 window, but may cause the addition/removal/alteration of scrollbars
11299 required to view the virtual area in windows which manage it.
11300
11301 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11302
11303 """
11304 return _core_.Sizer_FitInside(*args, **kwargs)
11305
11306 def SetSizeHints(*args, **kwargs):
11307 """
11308 SetSizeHints(self, Window window)
11309
11310 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11311 match the sizer's minimal size. This is commonly done in the
11312 constructor of the window itself if the window is resizable (as are
11313 many dialogs under Unix and frames on probably all platforms) in order
11314 to prevent the window from being sized smaller than the minimal size
11315 required by the sizer.
11316 """
11317 return _core_.Sizer_SetSizeHints(*args, **kwargs)
11318
11319 def SetVirtualSizeHints(*args, **kwargs):
11320 """
11321 SetVirtualSizeHints(self, Window window)
11322
11323 Tell the sizer to set the minimal size of the window virtual area to
11324 match the sizer's minimal size. For windows with managed scrollbars
11325 this will set them appropriately.
11326
11327 :see: `wx.ScrolledWindow.SetScrollbars`
11328
11329 """
11330 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
11331
11332 def Clear(*args, **kwargs):
11333 """
11334 Clear(self, bool deleteWindows=False)
11335
11336 Clear all items from the sizer, optionally destroying the window items
11337 as well.
11338 """
11339 return _core_.Sizer_Clear(*args, **kwargs)
11340
11341 def DeleteWindows(*args, **kwargs):
11342 """
11343 DeleteWindows(self)
11344
11345 Destroy all windows managed by the sizer.
11346 """
11347 return _core_.Sizer_DeleteWindows(*args, **kwargs)
11348
11349 def GetChildren(*args, **kwargs):
11350 """
11351 GetChildren(self) -> list
11352
11353 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11354 """
11355 return _core_.Sizer_GetChildren(*args, **kwargs)
11356
11357 def Show(*args, **kwargs):
11358 """
11359 Show(self, item, bool show=True, bool recursive=false) -> bool
11360
11361 Shows or hides an item managed by the sizer. To make a sizer item
11362 disappear or reappear, use Show followed by `Layout`. The *item*
11363 parameter can be either a window, a sizer, or the zero-based index of
11364 the item. Use the recursive parameter to show or hide an item in a
11365 subsizer. Returns True if the item was found.
11366 """
11367 return _core_.Sizer_Show(*args, **kwargs)
11368
11369 def IsShown(*args, **kwargs):
11370 """
11371 IsShown(self, item)
11372
11373 Determines if the item is currently shown. To make a sizer
11374 item disappear or reappear, use Show followed by `Layout`. The *item*
11375 parameter can be either a window, a sizer, or the zero-based index of
11376 the item.
11377 """
11378 return _core_.Sizer_IsShown(*args, **kwargs)
11379
11380 def Hide(self, item, recursive=False):
11381 """
11382 A convenience method for `Show` (item, False, recursive).
11383 """
11384 return self.Show(item, False, recursive)
11385
11386 def ShowItems(*args, **kwargs):
11387 """
11388 ShowItems(self, bool show)
11389
11390 Recursively call `wx.SizerItem.Show` on all sizer items.
11391 """
11392 return _core_.Sizer_ShowItems(*args, **kwargs)
11393
11394 _core_.Sizer_swigregister(Sizer)
11395
11396 class PySizer(Sizer):
11397 """
11398 wx.PySizer is a special version of `wx.Sizer` that has been
11399 instrumented to allow the C++ virtual methods to be overloaded in
11400 Python derived classes. You would derive from this class if you are
11401 wanting to implement a custom sizer in Python code. Simply implement
11402 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
11403 For example::
11404
11405 class MySizer(wx.PySizer):
11406 def __init__(self):
11407 wx.PySizer.__init__(self)
11408
11409 def CalcMin(self):
11410 for item in self.GetChildren():
11411 # calculate the total minimum width and height needed
11412 # by all items in the sizer according to this sizer's
11413 # layout algorithm.
11414 ...
11415 return wx.Size(width, height)
11416
11417 def RecalcSizes(self):
11418 # find the space allotted to this sizer
11419 pos = self.GetPosition()
11420 size = self.GetSize()
11421 for item in self.GetChildren():
11422 # Recalculate (if necessary) the position and size of
11423 # each item and then call item.SetDimension to do the
11424 # actual positioning and sizing of the items within the
11425 # space alloted to this sizer.
11426 ...
11427 item.SetDimension(itemPos, itemSize)
11428
11429
11430 When `Layout` is called it first calls `CalcMin` followed by
11431 `RecalcSizes` so you can optimize a bit by saving the results of
11432 `CalcMin` and reusing them in `RecalcSizes`.
11433
11434 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
11435
11436
11437 """
11438 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11439 __repr__ = _swig_repr
11440 def __init__(self, *args, **kwargs):
11441 """
11442 __init__(self) -> PySizer
11443
11444 Creates a wx.PySizer. Must be called from the __init__ in the derived
11445 class.
11446 """
11447 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
11448 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
11449
11450 def _setCallbackInfo(*args, **kwargs):
11451 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
11452 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
11453
11454 _core_.PySizer_swigregister(PySizer)
11455
11456 #---------------------------------------------------------------------------
11457
11458 class BoxSizer(Sizer):
11459 """
11460 The basic idea behind a box sizer is that windows will most often be
11461 laid out in rather simple basic geometry, typically in a row or a
11462 column or nested hierarchies of either. A wx.BoxSizer will lay out
11463 its items in a simple row or column, depending on the orientation
11464 parameter passed to the constructor.
11465 """
11466 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11467 __repr__ = _swig_repr
11468 def __init__(self, *args, **kwargs):
11469 """
11470 __init__(self, int orient=HORIZONTAL) -> BoxSizer
11471
11472 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
11473 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
11474 sizer.
11475 """
11476 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
11477 self._setOORInfo(self)
11478
11479 def GetOrientation(*args, **kwargs):
11480 """
11481 GetOrientation(self) -> int
11482
11483 Returns the current orientation of the sizer.
11484 """
11485 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
11486
11487 def SetOrientation(*args, **kwargs):
11488 """
11489 SetOrientation(self, int orient)
11490
11491 Resets the orientation of the sizer.
11492 """
11493 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
11494
11495 _core_.BoxSizer_swigregister(BoxSizer)
11496
11497 #---------------------------------------------------------------------------
11498
11499 class StaticBoxSizer(BoxSizer):
11500 """
11501 wx.StaticBoxSizer derives from and functions identically to the
11502 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
11503 manages. Note that this static box must be created separately and
11504 passed to the sizer constructor.
11505 """
11506 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11507 __repr__ = _swig_repr
11508 def __init__(self, *args, **kwargs):
11509 """
11510 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
11511
11512 Constructor. It takes an associated static box and the orientation
11513 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
11514 ``wx.HORIZONTAL``.
11515 """
11516 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
11517 self._setOORInfo(self)
11518
11519 def GetStaticBox(*args, **kwargs):
11520 """
11521 GetStaticBox(self) -> StaticBox
11522
11523 Returns the static box associated with this sizer.
11524 """
11525 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
11526
11527 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
11528
11529 #---------------------------------------------------------------------------
11530
11531 class GridSizer(Sizer):
11532 """
11533 A grid sizer is a sizer which lays out its children in a
11534 two-dimensional table with all cells having the same size. In other
11535 words, the width of each cell within the grid is the width of the
11536 widest item added to the sizer and the height of each grid cell is the
11537 height of the tallest item. An optional vertical and/or horizontal
11538 gap between items can also be specified (in pixels.)
11539
11540 Items are placed in the cells of the grid in the order they are added,
11541 in row-major order. In other words, the first row is filled first,
11542 then the second, and so on until all items have been added. (If
11543 neccessary, additional rows will be added as items are added.) If you
11544 need to have greater control over the cells that items are placed in
11545 then use the `wx.GridBagSizer`.
11546
11547 """
11548 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11549 __repr__ = _swig_repr
11550 def __init__(self, *args, **kwargs):
11551 """
11552 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
11553
11554 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
11555 of columns and rows in the sizer - if either of the parameters is
11556 zero, it will be calculated to from the total number of children in
11557 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11558 define extra space between all children.
11559 """
11560 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
11561 self._setOORInfo(self)
11562
11563 def SetCols(*args, **kwargs):
11564 """
11565 SetCols(self, int cols)
11566
11567 Sets the number of columns in the sizer.
11568 """
11569 return _core_.GridSizer_SetCols(*args, **kwargs)
11570
11571 def SetRows(*args, **kwargs):
11572 """
11573 SetRows(self, int rows)
11574
11575 Sets the number of rows in the sizer.
11576 """
11577 return _core_.GridSizer_SetRows(*args, **kwargs)
11578
11579 def SetVGap(*args, **kwargs):
11580 """
11581 SetVGap(self, int gap)
11582
11583 Sets the vertical gap (in pixels) between the cells in the sizer.
11584 """
11585 return _core_.GridSizer_SetVGap(*args, **kwargs)
11586
11587 def SetHGap(*args, **kwargs):
11588 """
11589 SetHGap(self, int gap)
11590
11591 Sets the horizontal gap (in pixels) between cells in the sizer
11592 """
11593 return _core_.GridSizer_SetHGap(*args, **kwargs)
11594
11595 def GetCols(*args, **kwargs):
11596 """
11597 GetCols(self) -> int
11598
11599 Returns the number of columns in the sizer.
11600 """
11601 return _core_.GridSizer_GetCols(*args, **kwargs)
11602
11603 def GetRows(*args, **kwargs):
11604 """
11605 GetRows(self) -> int
11606
11607 Returns the number of rows in the sizer.
11608 """
11609 return _core_.GridSizer_GetRows(*args, **kwargs)
11610
11611 def GetVGap(*args, **kwargs):
11612 """
11613 GetVGap(self) -> int
11614
11615 Returns the vertical gap (in pixels) between the cells in the sizer.
11616 """
11617 return _core_.GridSizer_GetVGap(*args, **kwargs)
11618
11619 def GetHGap(*args, **kwargs):
11620 """
11621 GetHGap(self) -> int
11622
11623 Returns the horizontal gap (in pixels) between cells in the sizer.
11624 """
11625 return _core_.GridSizer_GetHGap(*args, **kwargs)
11626
11627 def CalcRowsCols(self):
11628 """
11629 CalcRowsCols() -> (rows, cols)
11630
11631 Calculates how many rows and columns will be in the sizer based
11632 on the current number of items and also the rows, cols specified
11633 in the constructor.
11634 """
11635 nitems = len(self.GetChildren())
11636 rows = self.GetRows()
11637 cols = self.GetCols()
11638 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
11639 if cols != 0:
11640 rows = (nitems + cols - 1) / cols
11641 elif rows != 0:
11642 cols = (nitems + rows - 1) / rows
11643 return (rows, cols)
11644
11645 _core_.GridSizer_swigregister(GridSizer)
11646
11647 #---------------------------------------------------------------------------
11648
11649 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
11650 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
11651 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
11652 class FlexGridSizer(GridSizer):
11653 """
11654 A flex grid sizer is a sizer which lays out its children in a
11655 two-dimensional table with all table cells in one row having the same
11656 height and all cells in one column having the same width, but all
11657 rows or all columns are not necessarily the same height or width as in
11658 the `wx.GridSizer`.
11659
11660 wx.FlexGridSizer can also size items equally in one direction but
11661 unequally ("flexibly") in the other. If the sizer is only flexible
11662 in one direction (this can be changed using `SetFlexibleDirection`), it
11663 needs to be decided how the sizer should grow in the other ("non
11664 flexible") direction in order to fill the available space. The
11665 `SetNonFlexibleGrowMode` method serves this purpose.
11666
11667
11668 """
11669 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11670 __repr__ = _swig_repr
11671 def __init__(self, *args, **kwargs):
11672 """
11673 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
11674
11675 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
11676 number of columns and rows in the sizer - if either of the parameters
11677 is zero, it will be calculated to from the total number of children in
11678 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
11679 define extra space between all children.
11680 """
11681 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
11682 self._setOORInfo(self)
11683
11684 def AddGrowableRow(*args, **kwargs):
11685 """
11686 AddGrowableRow(self, size_t idx, int proportion=0)
11687
11688 Specifies that row *idx* (starting from zero) should be grown if there
11689 is extra space available to the sizer.
11690
11691 The *proportion* parameter has the same meaning as the stretch factor
11692 for the box sizers except that if all proportions are 0, then all
11693 columns are resized equally (instead of not being resized at all).
11694 """
11695 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
11696
11697 def RemoveGrowableRow(*args, **kwargs):
11698 """
11699 RemoveGrowableRow(self, size_t idx)
11700
11701 Specifies that row *idx* is no longer growable.
11702 """
11703 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
11704
11705 def AddGrowableCol(*args, **kwargs):
11706 """
11707 AddGrowableCol(self, size_t idx, int proportion=0)
11708
11709 Specifies that column *idx* (starting from zero) should be grown if
11710 there is extra space available to the sizer.
11711
11712 The *proportion* parameter has the same meaning as the stretch factor
11713 for the box sizers except that if all proportions are 0, then all
11714 columns are resized equally (instead of not being resized at all).
11715 """
11716 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
11717
11718 def RemoveGrowableCol(*args, **kwargs):
11719 """
11720 RemoveGrowableCol(self, size_t idx)
11721
11722 Specifies that column *idx* is no longer growable.
11723 """
11724 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
11725
11726 def SetFlexibleDirection(*args, **kwargs):
11727 """
11728 SetFlexibleDirection(self, int direction)
11729
11730 Specifies whether the sizer should flexibly resize its columns, rows,
11731 or both. Argument *direction* can be one of the following values. Any
11732 other value is ignored.
11733
11734 ============== =======================================
11735 wx.VERTICAL Rows are flexibly sized.
11736 wx.HORIZONTAL Columns are flexibly sized.
11737 wx.BOTH Both rows and columns are flexibly sized
11738 (this is the default value).
11739 ============== =======================================
11740
11741 Note that this method does not trigger relayout.
11742
11743 """
11744 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
11745
11746 def GetFlexibleDirection(*args, **kwargs):
11747 """
11748 GetFlexibleDirection(self) -> int
11749
11750 Returns a value that specifies whether the sizer
11751 flexibly resizes its columns, rows, or both (default).
11752
11753 :see: `SetFlexibleDirection`
11754 """
11755 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
11756
11757 def SetNonFlexibleGrowMode(*args, **kwargs):
11758 """
11759 SetNonFlexibleGrowMode(self, int mode)
11760
11761 Specifies how the sizer should grow in the non-flexible direction if
11762 there is one (so `SetFlexibleDirection` must have been called
11763 previously). Argument *mode* can be one of the following values:
11764
11765 ========================== =================================================
11766 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
11767 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
11768 `AddGrowableCol` and `AddGrowableRow`. In this
11769 case equal sizing applies to minimum sizes of
11770 columns or rows (this is the default value).
11771 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
11772 the non flexible direction, whether they are
11773 growable or not in the flexbile direction.
11774 ========================== =================================================
11775
11776 Note that this method does not trigger relayout.
11777
11778
11779 """
11780 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
11781
11782 def GetNonFlexibleGrowMode(*args, **kwargs):
11783 """
11784 GetNonFlexibleGrowMode(self) -> int
11785
11786 Returns the value that specifies how the sizer grows in the
11787 non-flexible direction if there is one.
11788
11789 :see: `SetNonFlexibleGrowMode`
11790 """
11791 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
11792
11793 def GetRowHeights(*args, **kwargs):
11794 """
11795 GetRowHeights(self) -> list
11796
11797 Returns a list of integers representing the heights of each of the
11798 rows in the sizer.
11799 """
11800 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
11801
11802 def GetColWidths(*args, **kwargs):
11803 """
11804 GetColWidths(self) -> list
11805
11806 Returns a list of integers representing the widths of each of the
11807 columns in the sizer.
11808 """
11809 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
11810
11811 _core_.FlexGridSizer_swigregister(FlexGridSizer)
11812
11813 class StdDialogButtonSizer(BoxSizer):
11814 """
11815 A special sizer that knows how to order and position standard buttons
11816 in order to conform to the current platform's standards. You simply
11817 need to add each `wx.Button` to the sizer, and be sure to create the
11818 buttons using the standard ID's. Then call `Realize` and the sizer
11819 will take care of the rest.
11820
11821 """
11822 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11823 __repr__ = _swig_repr
11824 def __init__(self, *args, **kwargs):
11825 """__init__(self) -> StdDialogButtonSizer"""
11826 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
11827 def AddButton(*args, **kwargs):
11828 """
11829 AddButton(self, wxButton button)
11830
11831 Use this to add the buttons to this sizer. Do not use the `Add`
11832 method in the base class.
11833 """
11834 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
11835
11836 def Realize(*args, **kwargs):
11837 """
11838 Realize(self)
11839
11840 This funciton needs to be called after all the buttons have been added
11841 to the sizer. It will reorder them and position them in a platform
11842 specifc manner.
11843 """
11844 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
11845
11846 def SetAffirmativeButton(*args, **kwargs):
11847 """SetAffirmativeButton(self, wxButton button)"""
11848 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
11849
11850 def SetNegativeButton(*args, **kwargs):
11851 """SetNegativeButton(self, wxButton button)"""
11852 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
11853
11854 def SetCancelButton(*args, **kwargs):
11855 """SetCancelButton(self, wxButton button)"""
11856 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
11857
11858 def GetAffirmativeButton(*args, **kwargs):
11859 """GetAffirmativeButton(self) -> wxButton"""
11860 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
11861
11862 def GetApplyButton(*args, **kwargs):
11863 """GetApplyButton(self) -> wxButton"""
11864 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
11865
11866 def GetNegativeButton(*args, **kwargs):
11867 """GetNegativeButton(self) -> wxButton"""
11868 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
11869
11870 def GetCancelButton(*args, **kwargs):
11871 """GetCancelButton(self) -> wxButton"""
11872 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
11873
11874 def GetHelpButton(*args, **kwargs):
11875 """GetHelpButton(self) -> wxButton"""
11876 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
11877
11878 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
11879
11880 #---------------------------------------------------------------------------
11881
11882 class GBPosition(object):
11883 """
11884 This class represents the position of an item in a virtual grid of
11885 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11886 typemaps that will automatically convert from a 2-element sequence of
11887 integers to a wx.GBPosition, so you can use the more pythonic
11888 representation of the position nearly transparently in Python code.
11889 """
11890 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11891 __repr__ = _swig_repr
11892 def __init__(self, *args, **kwargs):
11893 """
11894 __init__(self, int row=0, int col=0) -> GBPosition
11895
11896 This class represents the position of an item in a virtual grid of
11897 rows and columns managed by a `wx.GridBagSizer`. wxPython has
11898 typemaps that will automatically convert from a 2-element sequence of
11899 integers to a wx.GBPosition, so you can use the more pythonic
11900 representation of the position nearly transparently in Python code.
11901 """
11902 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
11903 __swig_destroy__ = _core_.delete_GBPosition
11904 __del__ = lambda self : None;
11905 def GetRow(*args, **kwargs):
11906 """GetRow(self) -> int"""
11907 return _core_.GBPosition_GetRow(*args, **kwargs)
11908
11909 def GetCol(*args, **kwargs):
11910 """GetCol(self) -> int"""
11911 return _core_.GBPosition_GetCol(*args, **kwargs)
11912
11913 def SetRow(*args, **kwargs):
11914 """SetRow(self, int row)"""
11915 return _core_.GBPosition_SetRow(*args, **kwargs)
11916
11917 def SetCol(*args, **kwargs):
11918 """SetCol(self, int col)"""
11919 return _core_.GBPosition_SetCol(*args, **kwargs)
11920
11921 def __eq__(*args, **kwargs):
11922 """
11923 __eq__(self, PyObject other) -> bool
11924
11925 Compare GBPosition for equality.
11926 """
11927 return _core_.GBPosition___eq__(*args, **kwargs)
11928
11929 def __ne__(*args, **kwargs):
11930 """
11931 __ne__(self, PyObject other) -> bool
11932
11933 Compare GBPosition for inequality.
11934 """
11935 return _core_.GBPosition___ne__(*args, **kwargs)
11936
11937 def Set(*args, **kwargs):
11938 """Set(self, int row=0, int col=0)"""
11939 return _core_.GBPosition_Set(*args, **kwargs)
11940
11941 def Get(*args, **kwargs):
11942 """Get(self) -> PyObject"""
11943 return _core_.GBPosition_Get(*args, **kwargs)
11944
11945 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
11946 def __str__(self): return str(self.Get())
11947 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
11948 def __len__(self): return len(self.Get())
11949 def __getitem__(self, index): return self.Get()[index]
11950 def __setitem__(self, index, val):
11951 if index == 0: self.SetRow(val)
11952 elif index == 1: self.SetCol(val)
11953 else: raise IndexError
11954 def __nonzero__(self): return self.Get() != (0,0)
11955 __safe_for_unpickling__ = True
11956 def __reduce__(self): return (wx.GBPosition, self.Get())
11957
11958 row = property(GetRow, SetRow)
11959 col = property(GetCol, SetCol)
11960
11961 _core_.GBPosition_swigregister(GBPosition)
11962
11963 class GBSpan(object):
11964 """
11965 This class is used to hold the row and column spanning attributes of
11966 items in a `wx.GridBagSizer`. wxPython has typemaps that will
11967 automatically convert from a 2-element sequence of integers to a
11968 wx.GBSpan, so you can use the more pythonic representation of the span
11969 nearly transparently in Python code.
11970
11971 """
11972 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11973 __repr__ = _swig_repr
11974 def __init__(self, *args, **kwargs):
11975 """
11976 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
11977
11978 Construct a new wxGBSpan, optionally setting the rowspan and
11979 colspan. The default is (1,1). (Meaning that the item occupies one
11980 cell in each direction.
11981 """
11982 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
11983 __swig_destroy__ = _core_.delete_GBSpan
11984 __del__ = lambda self : None;
11985 def GetRowspan(*args, **kwargs):
11986 """GetRowspan(self) -> int"""
11987 return _core_.GBSpan_GetRowspan(*args, **kwargs)
11988
11989 def GetColspan(*args, **kwargs):
11990 """GetColspan(self) -> int"""
11991 return _core_.GBSpan_GetColspan(*args, **kwargs)
11992
11993 def SetRowspan(*args, **kwargs):
11994 """SetRowspan(self, int rowspan)"""
11995 return _core_.GBSpan_SetRowspan(*args, **kwargs)
11996
11997 def SetColspan(*args, **kwargs):
11998 """SetColspan(self, int colspan)"""
11999 return _core_.GBSpan_SetColspan(*args, **kwargs)
12000
12001 def __eq__(*args, **kwargs):
12002 """
12003 __eq__(self, PyObject other) -> bool
12004
12005 Compare wxGBSpan for equality.
12006 """
12007 return _core_.GBSpan___eq__(*args, **kwargs)
12008
12009 def __ne__(*args, **kwargs):
12010 """
12011 __ne__(self, PyObject other) -> bool
12012
12013 Compare GBSpan for inequality.
12014 """
12015 return _core_.GBSpan___ne__(*args, **kwargs)
12016
12017 def Set(*args, **kwargs):
12018 """Set(self, int rowspan=1, int colspan=1)"""
12019 return _core_.GBSpan_Set(*args, **kwargs)
12020
12021 def Get(*args, **kwargs):
12022 """Get(self) -> PyObject"""
12023 return _core_.GBSpan_Get(*args, **kwargs)
12024
12025 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12026 def __str__(self): return str(self.Get())
12027 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12028 def __len__(self): return len(self.Get())
12029 def __getitem__(self, index): return self.Get()[index]
12030 def __setitem__(self, index, val):
12031 if index == 0: self.SetRowspan(val)
12032 elif index == 1: self.SetColspan(val)
12033 else: raise IndexError
12034 def __nonzero__(self): return self.Get() != (0,0)
12035 __safe_for_unpickling__ = True
12036 def __reduce__(self): return (wx.GBSpan, self.Get())
12037
12038 rowspan = property(GetRowspan, SetRowspan)
12039 colspan = property(GetColspan, SetColspan)
12040
12041 _core_.GBSpan_swigregister(GBSpan)
12042
12043 class GBSizerItem(SizerItem):
12044 """
12045 The wx.GBSizerItem class is used to track the additional data about
12046 items in a `wx.GridBagSizer` such as the item's position in the grid
12047 and how many rows or columns it spans.
12048
12049 """
12050 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12051 __repr__ = _swig_repr
12052 def __init__(self, *args, **kwargs):
12053 """
12054 __init__(self) -> GBSizerItem
12055
12056 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12057 size will need to be set, as well as a position and span before this
12058 item can be used in a Sizer.
12059
12060 You will probably never need to create a wx.GBSizerItem directly as they
12061 are created automatically when the sizer's Add method is called.
12062 """
12063 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12064 __swig_destroy__ = _core_.delete_GBSizerItem
12065 __del__ = lambda self : None;
12066 def GetPos(*args, **kwargs):
12067 """
12068 GetPos(self) -> GBPosition
12069
12070 Get the grid position of the item
12071 """
12072 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12073
12074 def GetPosTuple(self): return self.GetPos().Get()
12075 def GetSpan(*args, **kwargs):
12076 """
12077 GetSpan(self) -> GBSpan
12078
12079 Get the row and column spanning of the item
12080 """
12081 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12082
12083 def GetSpanTuple(self): return self.GetSpan().Get()
12084 def SetPos(*args, **kwargs):
12085 """
12086 SetPos(self, GBPosition pos) -> bool
12087
12088 If the item is already a member of a sizer then first ensure that
12089 there is no other item that would intersect with this one at the new
12090 position, then set the new position. Returns True if the change is
12091 successful and after the next Layout() the item will be moved.
12092 """
12093 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12094
12095 def SetSpan(*args, **kwargs):
12096 """
12097 SetSpan(self, GBSpan span) -> bool
12098
12099 If the item is already a member of a sizer then first ensure that
12100 there is no other item that would intersect with this one with its new
12101 spanning size, then set the new spanning. Returns True if the change
12102 is successful and after the next Layout() the item will be resized.
12103
12104 """
12105 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12106
12107 def Intersects(*args, **kwargs):
12108 """
12109 Intersects(self, GBSizerItem other) -> bool
12110
12111 Returns True if this item and the other item instersect.
12112 """
12113 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12114
12115 def IntersectsPos(*args, **kwargs):
12116 """
12117 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12118
12119 Returns True if the given pos/span would intersect with this item.
12120 """
12121 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
12122
12123 def GetEndPos(*args, **kwargs):
12124 """
12125 GetEndPos(self) -> GBPosition
12126
12127 Get the row and column of the endpoint of this item.
12128 """
12129 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12130
12131 def GetGBSizer(*args, **kwargs):
12132 """
12133 GetGBSizer(self) -> GridBagSizer
12134
12135 Get the sizer this item is a member of.
12136 """
12137 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12138
12139 def SetGBSizer(*args, **kwargs):
12140 """
12141 SetGBSizer(self, GridBagSizer sizer)
12142
12143 Set the sizer this item is a member of.
12144 """
12145 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12146
12147 _core_.GBSizerItem_swigregister(GBSizerItem)
12148 DefaultSpan = cvar.DefaultSpan
12149
12150 def GBSizerItemWindow(*args, **kwargs):
12151 """
12152 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12153 int border, PyObject userData=None) -> GBSizerItem
12154
12155 Construct a `wx.GBSizerItem` for a window.
12156 """
12157 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12158 return val
12159
12160 def GBSizerItemSizer(*args, **kwargs):
12161 """
12162 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12163 int border, PyObject userData=None) -> GBSizerItem
12164
12165 Construct a `wx.GBSizerItem` for a sizer
12166 """
12167 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12168 return val
12169
12170 def GBSizerItemSpacer(*args, **kwargs):
12171 """
12172 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12173 int flag, int border, PyObject userData=None) -> GBSizerItem
12174
12175 Construct a `wx.GBSizerItem` for a spacer.
12176 """
12177 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12178 return val
12179
12180 class GridBagSizer(FlexGridSizer):
12181 """
12182 A `wx.Sizer` that can lay out items in a virtual grid like a
12183 `wx.FlexGridSizer` but in this case explicit positioning of the items
12184 is allowed using `wx.GBPosition`, and items can optionally span more
12185 than one row and/or column using `wx.GBSpan`. The total size of the
12186 virtual grid is determined by the largest row and column that items are
12187 positioned at, adjusted for spanning.
12188
12189 """
12190 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12191 __repr__ = _swig_repr
12192 def __init__(self, *args, **kwargs):
12193 """
12194 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12195
12196 Constructor, with optional parameters to specify the gap between the
12197 rows and columns.
12198 """
12199 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
12200 self._setOORInfo(self)
12201
12202 def Add(*args, **kwargs):
12203 """
12204 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12205 int border=0, userData=None) -> wx.GBSizerItem
12206
12207 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12208 more than one row or column as specified with *span*. The remaining
12209 args behave similarly to `wx.Sizer.Add`.
12210
12211 Returns True if the item was successfully placed at the given cell
12212 position, False if something was already there.
12213
12214 """
12215 return _core_.GridBagSizer_Add(*args, **kwargs)
12216
12217 def AddItem(*args, **kwargs):
12218 """
12219 Add(self, GBSizerItem item) -> wx.GBSizerItem
12220
12221 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12222 the item was successfully placed at its given cell position, False if
12223 something was already there.
12224 """
12225 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12226
12227 def GetCellSize(*args, **kwargs):
12228 """
12229 GetCellSize(self, int row, int col) -> Size
12230
12231 Get the size of the specified cell, including hgap and
12232 vgap. Only valid after a Layout.
12233 """
12234 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12235
12236 def GetEmptyCellSize(*args, **kwargs):
12237 """
12238 GetEmptyCellSize(self) -> Size
12239
12240 Get the size used for cells in the grid with no item.
12241 """
12242 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12243
12244 def SetEmptyCellSize(*args, **kwargs):
12245 """
12246 SetEmptyCellSize(self, Size sz)
12247
12248 Set the size used for cells in the grid with no item.
12249 """
12250 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12251
12252 def GetItemPosition(*args):
12253 """
12254 GetItemPosition(self, item) -> GBPosition
12255
12256 Get the grid position of the specified *item* where *item* is either a
12257 window or subsizer that is a member of this sizer, or a zero-based
12258 index of an item.
12259 """
12260 return _core_.GridBagSizer_GetItemPosition(*args)
12261
12262 def SetItemPosition(*args):
12263 """
12264 SetItemPosition(self, item, GBPosition pos) -> bool
12265
12266 Set the grid position of the specified *item* where *item* is either a
12267 window or subsizer that is a member of this sizer, or a zero-based
12268 index of an item. Returns True on success. If the move is not
12269 allowed (because an item is already there) then False is returned.
12270
12271 """
12272 return _core_.GridBagSizer_SetItemPosition(*args)
12273
12274 def GetItemSpan(*args):
12275 """
12276 GetItemSpan(self, item) -> GBSpan
12277
12278 Get the row/col spanning of the specified *item* where *item* is
12279 either a window or subsizer that is a member of this sizer, or a
12280 zero-based index of an item.
12281 """
12282 return _core_.GridBagSizer_GetItemSpan(*args)
12283
12284 def SetItemSpan(*args):
12285 """
12286 SetItemSpan(self, item, GBSpan span) -> bool
12287
12288 Set the row/col spanning of the specified *item* where *item* is
12289 either a window or subsizer that is a member of this sizer, or a
12290 zero-based index of an item. Returns True on success. If the move is
12291 not allowed (because an item is already there) then False is returned.
12292 """
12293 return _core_.GridBagSizer_SetItemSpan(*args)
12294
12295 def FindItem(*args):
12296 """
12297 FindItem(self, item) -> GBSizerItem
12298
12299 Find the sizer item for the given window or subsizer, returns None if
12300 not found. (non-recursive)
12301 """
12302 return _core_.GridBagSizer_FindItem(*args)
12303
12304 def FindItemAtPosition(*args, **kwargs):
12305 """
12306 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12307
12308 Return the sizer item for the given grid cell, or None if there is no
12309 item at that position. (non-recursive)
12310 """
12311 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
12312
12313 def FindItemAtPoint(*args, **kwargs):
12314 """
12315 FindItemAtPoint(self, Point pt) -> GBSizerItem
12316
12317 Return the sizer item located at the point given in *pt*, or None if
12318 there is no item at that point. The (x,y) coordinates in pt correspond
12319 to the client coordinates of the window using the sizer for
12320 layout. (non-recursive)
12321 """
12322 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
12323
12324 def CheckForIntersection(*args, **kwargs):
12325 """
12326 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
12327
12328 Look at all items and see if any intersect (or would overlap) the
12329 given *item*. Returns True if so, False if there would be no overlap.
12330 If an *excludeItem* is given then it will not be checked for
12331 intersection, for example it may be the item we are checking the
12332 position of.
12333
12334 """
12335 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
12336
12337 def CheckForIntersectionPos(*args, **kwargs):
12338 """
12339 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
12340
12341 Look at all items and see if any intersect (or would overlap) the
12342 given position and span. Returns True if so, False if there would be
12343 no overlap. If an *excludeItem* is given then it will not be checked
12344 for intersection, for example it may be the item we are checking the
12345 position of.
12346 """
12347 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
12348
12349 _core_.GridBagSizer_swigregister(GridBagSizer)
12350
12351 #---------------------------------------------------------------------------
12352
12353 Left = _core_.Left
12354 Top = _core_.Top
12355 Right = _core_.Right
12356 Bottom = _core_.Bottom
12357 Width = _core_.Width
12358 Height = _core_.Height
12359 Centre = _core_.Centre
12360 Center = _core_.Center
12361 CentreX = _core_.CentreX
12362 CentreY = _core_.CentreY
12363 Unconstrained = _core_.Unconstrained
12364 AsIs = _core_.AsIs
12365 PercentOf = _core_.PercentOf
12366 Above = _core_.Above
12367 Below = _core_.Below
12368 LeftOf = _core_.LeftOf
12369 RightOf = _core_.RightOf
12370 SameAs = _core_.SameAs
12371 Absolute = _core_.Absolute
12372 class IndividualLayoutConstraint(Object):
12373 """
12374 Objects of this class are stored in the `wx.LayoutConstraints` class as
12375 one of eight possible constraints that a window can be involved in.
12376 You will never need to create an instance of
12377 wx.IndividualLayoutConstraint, rather you should create a
12378 `wx.LayoutConstraints` instance and use the individual contstraints
12379 that it contains.
12380 """
12381 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12382 def __init__(self): raise AttributeError, "No constructor defined"
12383 __repr__ = _swig_repr
12384 def Set(*args, **kwargs):
12385 """
12386 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
12387
12388 Sets the properties of the constraint. Normally called by one of the
12389 convenience functions such as Above, RightOf, SameAs.
12390 """
12391 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
12392
12393 def LeftOf(*args, **kwargs):
12394 """
12395 LeftOf(self, Window sibling, int marg=0)
12396
12397 Constrains this edge to be to the left of the given window, with an
12398 optional margin. Implicitly, this is relative to the left edge of the
12399 other window.
12400 """
12401 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
12402
12403 def RightOf(*args, **kwargs):
12404 """
12405 RightOf(self, Window sibling, int marg=0)
12406
12407 Constrains this edge to be to the right of the given window, with an
12408 optional margin. Implicitly, this is relative to the right edge of the
12409 other window.
12410 """
12411 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
12412
12413 def Above(*args, **kwargs):
12414 """
12415 Above(self, Window sibling, int marg=0)
12416
12417 Constrains this edge to be above the given window, with an optional
12418 margin. Implicitly, this is relative to the top edge of the other
12419 window.
12420 """
12421 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
12422
12423 def Below(*args, **kwargs):
12424 """
12425 Below(self, Window sibling, int marg=0)
12426
12427 Constrains this edge to be below the given window, with an optional
12428 margin. Implicitly, this is relative to the bottom edge of the other
12429 window.
12430 """
12431 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
12432
12433 def SameAs(*args, **kwargs):
12434 """
12435 SameAs(self, Window otherW, int edge, int marg=0)
12436
12437 Constrains this edge or dimension to be to the same as the edge of the
12438 given window, with an optional margin.
12439 """
12440 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
12441
12442 def PercentOf(*args, **kwargs):
12443 """
12444 PercentOf(self, Window otherW, int wh, int per)
12445
12446 Constrains this edge or dimension to be to a percentage of the given
12447 window, with an optional margin.
12448 """
12449 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
12450
12451 def Absolute(*args, **kwargs):
12452 """
12453 Absolute(self, int val)
12454
12455 Constrains this edge or dimension to be the given absolute value.
12456 """
12457 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
12458
12459 def Unconstrained(*args, **kwargs):
12460 """
12461 Unconstrained(self)
12462
12463 Sets this edge or dimension to be unconstrained, that is, dependent on
12464 other edges and dimensions from which this value can be deduced.
12465 """
12466 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
12467
12468 def AsIs(*args, **kwargs):
12469 """
12470 AsIs(self)
12471
12472 Sets this edge or constraint to be whatever the window's value is at
12473 the moment. If either of the width and height constraints are *as is*,
12474 the window will not be resized, but moved instead. This is important
12475 when considering panel items which are intended to have a default
12476 size, such as a button, which may take its size from the size of the
12477 button label.
12478 """
12479 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
12480
12481 def GetOtherWindow(*args, **kwargs):
12482 """GetOtherWindow(self) -> Window"""
12483 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
12484
12485 def GetMyEdge(*args, **kwargs):
12486 """GetMyEdge(self) -> int"""
12487 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
12488
12489 def SetEdge(*args, **kwargs):
12490 """SetEdge(self, int which)"""
12491 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
12492
12493 def SetValue(*args, **kwargs):
12494 """SetValue(self, int v)"""
12495 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
12496
12497 def GetMargin(*args, **kwargs):
12498 """GetMargin(self) -> int"""
12499 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
12500
12501 def SetMargin(*args, **kwargs):
12502 """SetMargin(self, int m)"""
12503 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
12504
12505 def GetValue(*args, **kwargs):
12506 """GetValue(self) -> int"""
12507 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
12508
12509 def GetPercent(*args, **kwargs):
12510 """GetPercent(self) -> int"""
12511 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
12512
12513 def GetOtherEdge(*args, **kwargs):
12514 """GetOtherEdge(self) -> int"""
12515 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
12516
12517 def GetDone(*args, **kwargs):
12518 """GetDone(self) -> bool"""
12519 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
12520
12521 def SetDone(*args, **kwargs):
12522 """SetDone(self, bool d)"""
12523 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
12524
12525 def GetRelationship(*args, **kwargs):
12526 """GetRelationship(self) -> int"""
12527 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
12528
12529 def SetRelationship(*args, **kwargs):
12530 """SetRelationship(self, int r)"""
12531 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
12532
12533 def ResetIfWin(*args, **kwargs):
12534 """
12535 ResetIfWin(self, Window otherW) -> bool
12536
12537 Reset constraint if it mentions otherWin
12538 """
12539 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
12540
12541 def SatisfyConstraint(*args, **kwargs):
12542 """
12543 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
12544
12545 Try to satisfy constraint
12546 """
12547 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
12548
12549 def GetEdge(*args, **kwargs):
12550 """
12551 GetEdge(self, int which, Window thisWin, Window other) -> int
12552
12553 Get the value of this edge or dimension, or if this
12554 is not determinable, -1.
12555 """
12556 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
12557
12558 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
12559
12560 class LayoutConstraints(Object):
12561 """
12562 **Note:** constraints are now deprecated and you should use sizers
12563 instead.
12564
12565 Objects of this class can be associated with a window to define its
12566 layout constraints, with respect to siblings or its parent.
12567
12568 The class consists of the following eight constraints of class
12569 wx.IndividualLayoutConstraint, some or all of which should be accessed
12570 directly to set the appropriate constraints.
12571
12572 * left: represents the left hand edge of the window
12573 * right: represents the right hand edge of the window
12574 * top: represents the top edge of the window
12575 * bottom: represents the bottom edge of the window
12576 * width: represents the width of the window
12577 * height: represents the height of the window
12578 * centreX: represents the horizontal centre point of the window
12579 * centreY: represents the vertical centre point of the window
12580
12581 Most constraints are initially set to have the relationship
12582 wxUnconstrained, which means that their values should be calculated by
12583 looking at known constraints. The exceptions are width and height,
12584 which are set to wxAsIs to ensure that if the user does not specify a
12585 constraint, the existing width and height will be used, to be
12586 compatible with panel items which often have take a default size. If
12587 the constraint is ``wx.AsIs``, the dimension will not be changed.
12588
12589 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
12590
12591 """
12592 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12593 __repr__ = _swig_repr
12594 left = property(_core_.LayoutConstraints_left_get)
12595 top = property(_core_.LayoutConstraints_top_get)
12596 right = property(_core_.LayoutConstraints_right_get)
12597 bottom = property(_core_.LayoutConstraints_bottom_get)
12598 width = property(_core_.LayoutConstraints_width_get)
12599 height = property(_core_.LayoutConstraints_height_get)
12600 centreX = property(_core_.LayoutConstraints_centreX_get)
12601 centreY = property(_core_.LayoutConstraints_centreY_get)
12602 def __init__(self, *args, **kwargs):
12603 """__init__(self) -> LayoutConstraints"""
12604 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
12605 __swig_destroy__ = _core_.delete_LayoutConstraints
12606 __del__ = lambda self : None;
12607 def SatisfyConstraints(*args, **kwargs):
12608 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
12609 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
12610
12611 def AreSatisfied(*args, **kwargs):
12612 """AreSatisfied(self) -> bool"""
12613 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
12614
12615 _core_.LayoutConstraints_swigregister(LayoutConstraints)
12616
12617 #----------------------------------------------------------------------------
12618
12619 # Use Python's bool constants if available, make some if not
12620 try:
12621 True
12622 except NameError:
12623 __builtins__.True = 1==1
12624 __builtins__.False = 1==0
12625 def bool(value): return not not value
12626 __builtins__.bool = bool
12627
12628
12629
12630 # workarounds for bad wxRTTI names
12631 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
12632 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
12633 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
12634
12635
12636 #----------------------------------------------------------------------------
12637 # Load version numbers from __version__... Ensure that major and minor
12638 # versions are the same for both wxPython and wxWidgets.
12639
12640 from __version__ import *
12641 __version__ = VERSION_STRING
12642
12643 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
12644 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
12645 if RELEASE_VERSION != _core_.RELEASE_VERSION:
12646 import warnings
12647 warnings.warn("wxPython/wxWidgets release number mismatch")
12648
12649 #----------------------------------------------------------------------------
12650
12651 # Set wxPython's default string<-->unicode conversion encoding from
12652 # the locale, but only if Python's default hasn't been changed. (We
12653 # assume that if the user has customized it already then that is the
12654 # encoding we need to use as well.)
12655 #
12656 # The encoding selected here is used when string or unicode objects
12657 # need to be converted in order to pass them to wxWidgets. Please be
12658 # aware that the default encoding within the same locale may be
12659 # slightly different on different platforms. For example, please see
12660 # http://www.alanwood.net/demos/charsetdiffs.html for differences
12661 # between the common latin/roman encodings.
12662
12663 default = _sys.getdefaultencoding()
12664 if default == 'ascii':
12665 import locale
12666 import codecs
12667 try:
12668 default = locale.getdefaultlocale()[1]
12669 codecs.lookup(default)
12670 except (ValueError, LookupError, TypeError):
12671 default = _sys.getdefaultencoding()
12672 del locale
12673 del codecs
12674 if default:
12675 wx.SetDefaultPyEncoding(default)
12676 del default
12677
12678 #----------------------------------------------------------------------------
12679
12680 class PyDeadObjectError(AttributeError):
12681 pass
12682
12683 class _wxPyDeadObject(object):
12684 """
12685 Instances of wx objects that are OOR capable will have their __class__
12686 changed to this class when the C++ object is deleted. This should help
12687 prevent crashes due to referencing a bogus C++ pointer.
12688 """
12689 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
12690 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
12691
12692 def __repr__(self):
12693 if not hasattr(self, "_name"):
12694 self._name = "[unknown]"
12695 return self.reprStr % self._name
12696
12697 def __getattr__(self, *args):
12698 if not hasattr(self, "_name"):
12699 self._name = "[unknown]"
12700 raise PyDeadObjectError(self.attrStr % self._name)
12701
12702 def __nonzero__(self):
12703 return 0
12704
12705
12706
12707 class PyUnbornObjectError(AttributeError):
12708 pass
12709
12710 class _wxPyUnbornObject(object):
12711 """
12712 Some stock objects are created when the wx._core module is
12713 imported, but their C++ instance is not created until the wx.App
12714 object is created and initialized. These object instances will
12715 temporarily have their __class__ changed to this class so an
12716 exception will be raised if they are used before the C++ instance
12717 is ready.
12718 """
12719
12720 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
12721 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
12722
12723 def __repr__(self):
12724 #if not hasattr(self, "_name"):
12725 # self._name = "[unknown]"
12726 return self.reprStr #% self._name
12727
12728 def __getattr__(self, *args):
12729 #if not hasattr(self, "_name"):
12730 # self._name = "[unknown]"
12731 raise PyUnbornObjectError(self.attrStr) # % self._name )
12732
12733 def __nonzero__(self):
12734 return 0
12735
12736
12737 #----------------------------------------------------------------------------
12738
12739 def CallAfter(callable, *args, **kw):
12740 """
12741 Call the specified function after the current and pending event
12742 handlers have been completed. This is also good for making GUI
12743 method calls from non-GUI threads. Any extra positional or
12744 keyword args are passed on to the callable when it is called.
12745
12746 :see: `wx.FutureCall`
12747 """
12748 app = wx.GetApp()
12749 assert app is not None, 'No wx.App created yet'
12750
12751 if not hasattr(app, "_CallAfterId"):
12752 app._CallAfterId = wx.NewEventType()
12753 app.Connect(-1, -1, app._CallAfterId,
12754 lambda event: event.callable(*event.args, **event.kw) )
12755 evt = wx.PyEvent()
12756 evt.SetEventType(app._CallAfterId)
12757 evt.callable = callable
12758 evt.args = args
12759 evt.kw = kw
12760 wx.PostEvent(app, evt)
12761
12762 #----------------------------------------------------------------------------
12763
12764
12765 class FutureCall:
12766 """
12767 A convenience class for `wx.Timer`, that calls the given callable
12768 object once after the given amount of milliseconds, passing any
12769 positional or keyword args. The return value of the callable is
12770 availbale after it has been run with the `GetResult` method.
12771
12772 If you don't need to get the return value or restart the timer
12773 then there is no need to hold a reference to this object. It will
12774 hold a reference to itself while the timer is running (the timer
12775 has a reference to self.Notify) but the cycle will be broken when
12776 the timer completes, automatically cleaning up the wx.FutureCall
12777 object.
12778
12779 :see: `wx.CallAfter`
12780 """
12781 def __init__(self, millis, callable, *args, **kwargs):
12782 self.millis = millis
12783 self.callable = callable
12784 self.SetArgs(*args, **kwargs)
12785 self.runCount = 0
12786 self.running = False
12787 self.hasRun = False
12788 self.result = None
12789 self.timer = None
12790 self.Start()
12791
12792 def __del__(self):
12793 self.Stop()
12794
12795
12796 def Start(self, millis=None, *args, **kwargs):
12797 """
12798 (Re)start the timer
12799 """
12800 self.hasRun = False
12801 if millis is not None:
12802 self.millis = millis
12803 if args or kwargs:
12804 self.SetArgs(*args, **kwargs)
12805 self.Stop()
12806 self.timer = wx.PyTimer(self.Notify)
12807 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
12808 self.running = True
12809 Restart = Start
12810
12811
12812 def Stop(self):
12813 """
12814 Stop and destroy the timer.
12815 """
12816 if self.timer is not None:
12817 self.timer.Stop()
12818 self.timer = None
12819
12820
12821 def GetInterval(self):
12822 if self.timer is not None:
12823 return self.timer.GetInterval()
12824 else:
12825 return 0
12826
12827
12828 def IsRunning(self):
12829 return self.timer is not None and self.timer.IsRunning()
12830
12831
12832 def SetArgs(self, *args, **kwargs):
12833 """
12834 (Re)set the args passed to the callable object. This is
12835 useful in conjunction with Restart if you want to schedule a
12836 new call to the same callable object but with different
12837 parameters.
12838 """
12839 self.args = args
12840 self.kwargs = kwargs
12841
12842
12843 def HasRun(self):
12844 return self.hasRun
12845
12846 def GetResult(self):
12847 return self.result
12848
12849 def Notify(self):
12850 """
12851 The timer has expired so call the callable.
12852 """
12853 if self.callable and getattr(self.callable, 'im_self', True):
12854 self.runCount += 1
12855 self.running = False
12856 self.result = self.callable(*self.args, **self.kwargs)
12857 self.hasRun = True
12858 if not self.running:
12859 # if it wasn't restarted, then cleanup
12860 wx.CallAfter(self.Stop)
12861
12862
12863
12864 #----------------------------------------------------------------------------
12865 # Control which items in this module should be documented by epydoc.
12866 # We allow only classes and functions, which will help reduce the size
12867 # of the docs by filtering out the zillions of constants, EVT objects,
12868 # and etc that don't make much sense by themselves, but are instead
12869 # documented (or will be) as part of the classes/functions/methods
12870 # where they should be used.
12871
12872 class __DocFilter:
12873 """
12874 A filter for epydoc that only allows non-Ptr classes and
12875 fucntions, in order to reduce the clutter in the API docs.
12876 """
12877 def __init__(self, globals):
12878 self._globals = globals
12879
12880 def __call__(self, name):
12881 import types
12882 obj = self._globals.get(name, None)
12883 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
12884 return False
12885 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
12886 return False
12887 return True
12888
12889 #----------------------------------------------------------------------------
12890 #----------------------------------------------------------------------------
12891
12892 # Import other modules in this package that should show up in the
12893 # "core" wx namespace
12894 from _gdi import *
12895 from _windows import *
12896 from _controls import *
12897 from _misc import *
12898
12899 #----------------------------------------------------------------------------
12900 #----------------------------------------------------------------------------
12901
12902
12903