]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/mac/_core.py
SetTextColor --> SetTextColour
[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_PAGE_SETUP = _core_.ID_PAGE_SETUP
198 ID_PREVIEW = _core_.ID_PREVIEW
199 ID_ABOUT = _core_.ID_ABOUT
200 ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
201 ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
202 ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
203 ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
204 ID_HELP_INDEX = _core_.ID_HELP_INDEX
205 ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
206 ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207 ID_PREFERENCES = _core_.ID_PREFERENCES
208 ID_EDIT = _core_.ID_EDIT
209 ID_CUT = _core_.ID_CUT
210 ID_COPY = _core_.ID_COPY
211 ID_PASTE = _core_.ID_PASTE
212 ID_CLEAR = _core_.ID_CLEAR
213 ID_FIND = _core_.ID_FIND
214 ID_DUPLICATE = _core_.ID_DUPLICATE
215 ID_SELECTALL = _core_.ID_SELECTALL
216 ID_DELETE = _core_.ID_DELETE
217 ID_REPLACE = _core_.ID_REPLACE
218 ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
219 ID_PROPERTIES = _core_.ID_PROPERTIES
220 ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
221 ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
222 ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
223 ID_VIEW_LIST = _core_.ID_VIEW_LIST
224 ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
225 ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
226 ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
227 ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
228 ID_FILE = _core_.ID_FILE
229 ID_FILE1 = _core_.ID_FILE1
230 ID_FILE2 = _core_.ID_FILE2
231 ID_FILE3 = _core_.ID_FILE3
232 ID_FILE4 = _core_.ID_FILE4
233 ID_FILE5 = _core_.ID_FILE5
234 ID_FILE6 = _core_.ID_FILE6
235 ID_FILE7 = _core_.ID_FILE7
236 ID_FILE8 = _core_.ID_FILE8
237 ID_FILE9 = _core_.ID_FILE9
238 ID_OK = _core_.ID_OK
239 ID_CANCEL = _core_.ID_CANCEL
240 ID_APPLY = _core_.ID_APPLY
241 ID_YES = _core_.ID_YES
242 ID_NO = _core_.ID_NO
243 ID_STATIC = _core_.ID_STATIC
244 ID_FORWARD = _core_.ID_FORWARD
245 ID_BACKWARD = _core_.ID_BACKWARD
246 ID_DEFAULT = _core_.ID_DEFAULT
247 ID_MORE = _core_.ID_MORE
248 ID_SETUP = _core_.ID_SETUP
249 ID_RESET = _core_.ID_RESET
250 ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
251 ID_YESTOALL = _core_.ID_YESTOALL
252 ID_NOTOALL = _core_.ID_NOTOALL
253 ID_ABORT = _core_.ID_ABORT
254 ID_RETRY = _core_.ID_RETRY
255 ID_IGNORE = _core_.ID_IGNORE
256 ID_ADD = _core_.ID_ADD
257 ID_REMOVE = _core_.ID_REMOVE
258 ID_UP = _core_.ID_UP
259 ID_DOWN = _core_.ID_DOWN
260 ID_HOME = _core_.ID_HOME
261 ID_REFRESH = _core_.ID_REFRESH
262 ID_STOP = _core_.ID_STOP
263 ID_INDEX = _core_.ID_INDEX
264 ID_BOLD = _core_.ID_BOLD
265 ID_ITALIC = _core_.ID_ITALIC
266 ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
267 ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
268 ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
269 ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
270 ID_UNDERLINE = _core_.ID_UNDERLINE
271 ID_INDENT = _core_.ID_INDENT
272 ID_UNINDENT = _core_.ID_UNINDENT
273 ID_ZOOM_100 = _core_.ID_ZOOM_100
274 ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
275 ID_ZOOM_IN = _core_.ID_ZOOM_IN
276 ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
277 ID_UNDELETE = _core_.ID_UNDELETE
278 ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
279 ID_HIGHEST = _core_.ID_HIGHEST
280 MENU_TEAROFF = _core_.MENU_TEAROFF
281 MB_DOCKABLE = _core_.MB_DOCKABLE
282 NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
283 FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
284 LI_HORIZONTAL = _core_.LI_HORIZONTAL
285 LI_VERTICAL = _core_.LI_VERTICAL
286 WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
287 WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
288 WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
289 WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
290 WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
291 WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
292 MM_TEXT = _core_.MM_TEXT
293 MM_LOMETRIC = _core_.MM_LOMETRIC
294 MM_HIMETRIC = _core_.MM_HIMETRIC
295 MM_LOENGLISH = _core_.MM_LOENGLISH
296 MM_HIENGLISH = _core_.MM_HIENGLISH
297 MM_TWIPS = _core_.MM_TWIPS
298 MM_ISOTROPIC = _core_.MM_ISOTROPIC
299 MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
300 MM_POINTS = _core_.MM_POINTS
301 MM_METRIC = _core_.MM_METRIC
302 CENTRE = _core_.CENTRE
303 CENTER = _core_.CENTER
304 HORIZONTAL = _core_.HORIZONTAL
305 VERTICAL = _core_.VERTICAL
306 BOTH = _core_.BOTH
307 LEFT = _core_.LEFT
308 RIGHT = _core_.RIGHT
309 UP = _core_.UP
310 DOWN = _core_.DOWN
311 TOP = _core_.TOP
312 BOTTOM = _core_.BOTTOM
313 NORTH = _core_.NORTH
314 SOUTH = _core_.SOUTH
315 WEST = _core_.WEST
316 EAST = _core_.EAST
317 ALL = _core_.ALL
318 ALIGN_NOT = _core_.ALIGN_NOT
319 ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
320 ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
321 ALIGN_LEFT = _core_.ALIGN_LEFT
322 ALIGN_TOP = _core_.ALIGN_TOP
323 ALIGN_RIGHT = _core_.ALIGN_RIGHT
324 ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
325 ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
326 ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
327 ALIGN_CENTER = _core_.ALIGN_CENTER
328 ALIGN_CENTRE = _core_.ALIGN_CENTRE
329 ALIGN_MASK = _core_.ALIGN_MASK
330 STRETCH_NOT = _core_.STRETCH_NOT
331 SHRINK = _core_.SHRINK
332 GROW = _core_.GROW
333 EXPAND = _core_.EXPAND
334 SHAPED = _core_.SHAPED
335 FIXED_MINSIZE = _core_.FIXED_MINSIZE
336 TILE = _core_.TILE
337 ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
338 BORDER_DEFAULT = _core_.BORDER_DEFAULT
339 BORDER_NONE = _core_.BORDER_NONE
340 BORDER_STATIC = _core_.BORDER_STATIC
341 BORDER_SIMPLE = _core_.BORDER_SIMPLE
342 BORDER_RAISED = _core_.BORDER_RAISED
343 BORDER_SUNKEN = _core_.BORDER_SUNKEN
344 BORDER_DOUBLE = _core_.BORDER_DOUBLE
345 BORDER_MASK = _core_.BORDER_MASK
346 BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347 BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348 BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
349 DEFAULT = _core_.DEFAULT
350 DECORATIVE = _core_.DECORATIVE
351 ROMAN = _core_.ROMAN
352 SCRIPT = _core_.SCRIPT
353 SWISS = _core_.SWISS
354 MODERN = _core_.MODERN
355 TELETYPE = _core_.TELETYPE
356 VARIABLE = _core_.VARIABLE
357 FIXED = _core_.FIXED
358 NORMAL = _core_.NORMAL
359 LIGHT = _core_.LIGHT
360 BOLD = _core_.BOLD
361 ITALIC = _core_.ITALIC
362 SLANT = _core_.SLANT
363 SOLID = _core_.SOLID
364 DOT = _core_.DOT
365 LONG_DASH = _core_.LONG_DASH
366 SHORT_DASH = _core_.SHORT_DASH
367 DOT_DASH = _core_.DOT_DASH
368 USER_DASH = _core_.USER_DASH
369 TRANSPARENT = _core_.TRANSPARENT
370 STIPPLE = _core_.STIPPLE
371 STIPPLE_MASK = _core_.STIPPLE_MASK
372 STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
373 BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374 CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375 FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376 CROSS_HATCH = _core_.CROSS_HATCH
377 HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378 VERTICAL_HATCH = _core_.VERTICAL_HATCH
379 JOIN_BEVEL = _core_.JOIN_BEVEL
380 JOIN_MITER = _core_.JOIN_MITER
381 JOIN_ROUND = _core_.JOIN_ROUND
382 CAP_ROUND = _core_.CAP_ROUND
383 CAP_PROJECTING = _core_.CAP_PROJECTING
384 CAP_BUTT = _core_.CAP_BUTT
385 CLEAR = _core_.CLEAR
386 XOR = _core_.XOR
387 INVERT = _core_.INVERT
388 OR_REVERSE = _core_.OR_REVERSE
389 AND_REVERSE = _core_.AND_REVERSE
390 COPY = _core_.COPY
391 AND = _core_.AND
392 AND_INVERT = _core_.AND_INVERT
393 NO_OP = _core_.NO_OP
394 NOR = _core_.NOR
395 EQUIV = _core_.EQUIV
396 SRC_INVERT = _core_.SRC_INVERT
397 OR_INVERT = _core_.OR_INVERT
398 NAND = _core_.NAND
399 OR = _core_.OR
400 SET = _core_.SET
401 WXK_BACK = _core_.WXK_BACK
402 WXK_TAB = _core_.WXK_TAB
403 WXK_RETURN = _core_.WXK_RETURN
404 WXK_ESCAPE = _core_.WXK_ESCAPE
405 WXK_SPACE = _core_.WXK_SPACE
406 WXK_DELETE = _core_.WXK_DELETE
407 WXK_START = _core_.WXK_START
408 WXK_LBUTTON = _core_.WXK_LBUTTON
409 WXK_RBUTTON = _core_.WXK_RBUTTON
410 WXK_CANCEL = _core_.WXK_CANCEL
411 WXK_MBUTTON = _core_.WXK_MBUTTON
412 WXK_CLEAR = _core_.WXK_CLEAR
413 WXK_SHIFT = _core_.WXK_SHIFT
414 WXK_ALT = _core_.WXK_ALT
415 WXK_CONTROL = _core_.WXK_CONTROL
416 WXK_MENU = _core_.WXK_MENU
417 WXK_PAUSE = _core_.WXK_PAUSE
418 WXK_CAPITAL = _core_.WXK_CAPITAL
419 WXK_PRIOR = _core_.WXK_PRIOR
420 WXK_NEXT = _core_.WXK_NEXT
421 WXK_END = _core_.WXK_END
422 WXK_HOME = _core_.WXK_HOME
423 WXK_LEFT = _core_.WXK_LEFT
424 WXK_UP = _core_.WXK_UP
425 WXK_RIGHT = _core_.WXK_RIGHT
426 WXK_DOWN = _core_.WXK_DOWN
427 WXK_SELECT = _core_.WXK_SELECT
428 WXK_PRINT = _core_.WXK_PRINT
429 WXK_EXECUTE = _core_.WXK_EXECUTE
430 WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431 WXK_INSERT = _core_.WXK_INSERT
432 WXK_HELP = _core_.WXK_HELP
433 WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434 WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435 WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436 WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437 WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438 WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439 WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440 WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441 WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442 WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443 WXK_MULTIPLY = _core_.WXK_MULTIPLY
444 WXK_ADD = _core_.WXK_ADD
445 WXK_SEPARATOR = _core_.WXK_SEPARATOR
446 WXK_SUBTRACT = _core_.WXK_SUBTRACT
447 WXK_DECIMAL = _core_.WXK_DECIMAL
448 WXK_DIVIDE = _core_.WXK_DIVIDE
449 WXK_F1 = _core_.WXK_F1
450 WXK_F2 = _core_.WXK_F2
451 WXK_F3 = _core_.WXK_F3
452 WXK_F4 = _core_.WXK_F4
453 WXK_F5 = _core_.WXK_F5
454 WXK_F6 = _core_.WXK_F6
455 WXK_F7 = _core_.WXK_F7
456 WXK_F8 = _core_.WXK_F8
457 WXK_F9 = _core_.WXK_F9
458 WXK_F10 = _core_.WXK_F10
459 WXK_F11 = _core_.WXK_F11
460 WXK_F12 = _core_.WXK_F12
461 WXK_F13 = _core_.WXK_F13
462 WXK_F14 = _core_.WXK_F14
463 WXK_F15 = _core_.WXK_F15
464 WXK_F16 = _core_.WXK_F16
465 WXK_F17 = _core_.WXK_F17
466 WXK_F18 = _core_.WXK_F18
467 WXK_F19 = _core_.WXK_F19
468 WXK_F20 = _core_.WXK_F20
469 WXK_F21 = _core_.WXK_F21
470 WXK_F22 = _core_.WXK_F22
471 WXK_F23 = _core_.WXK_F23
472 WXK_F24 = _core_.WXK_F24
473 WXK_NUMLOCK = _core_.WXK_NUMLOCK
474 WXK_SCROLL = _core_.WXK_SCROLL
475 WXK_PAGEUP = _core_.WXK_PAGEUP
476 WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477 WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478 WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479 WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480 WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481 WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482 WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483 WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484 WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485 WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486 WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487 WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488 WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489 WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490 WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491 WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492 WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493 WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494 WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495 WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496 WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497 WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498 WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499 WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500 WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501 WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502 WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503 WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504 WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505 WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506 WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
507 WXK_COMMAND = _core_.WXK_COMMAND
508 WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509 WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510 WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511 WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512 WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513 WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514 WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515 WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516 WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517 WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518 WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519 WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520 WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521 WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522 WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523 WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524 WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525 WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526 WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527 WXK_SPECIAL20 = _core_.WXK_SPECIAL20
528 PAPER_NONE = _core_.PAPER_NONE
529 PAPER_LETTER = _core_.PAPER_LETTER
530 PAPER_LEGAL = _core_.PAPER_LEGAL
531 PAPER_A4 = _core_.PAPER_A4
532 PAPER_CSHEET = _core_.PAPER_CSHEET
533 PAPER_DSHEET = _core_.PAPER_DSHEET
534 PAPER_ESHEET = _core_.PAPER_ESHEET
535 PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536 PAPER_TABLOID = _core_.PAPER_TABLOID
537 PAPER_LEDGER = _core_.PAPER_LEDGER
538 PAPER_STATEMENT = _core_.PAPER_STATEMENT
539 PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540 PAPER_A3 = _core_.PAPER_A3
541 PAPER_A4SMALL = _core_.PAPER_A4SMALL
542 PAPER_A5 = _core_.PAPER_A5
543 PAPER_B4 = _core_.PAPER_B4
544 PAPER_B5 = _core_.PAPER_B5
545 PAPER_FOLIO = _core_.PAPER_FOLIO
546 PAPER_QUARTO = _core_.PAPER_QUARTO
547 PAPER_10X14 = _core_.PAPER_10X14
548 PAPER_11X17 = _core_.PAPER_11X17
549 PAPER_NOTE = _core_.PAPER_NOTE
550 PAPER_ENV_9 = _core_.PAPER_ENV_9
551 PAPER_ENV_10 = _core_.PAPER_ENV_10
552 PAPER_ENV_11 = _core_.PAPER_ENV_11
553 PAPER_ENV_12 = _core_.PAPER_ENV_12
554 PAPER_ENV_14 = _core_.PAPER_ENV_14
555 PAPER_ENV_DL = _core_.PAPER_ENV_DL
556 PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557 PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558 PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559 PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560 PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561 PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562 PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563 PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564 PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565 PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566 PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567 PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568 PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569 PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570 PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571 PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572 PAPER_9X11 = _core_.PAPER_9X11
573 PAPER_10X11 = _core_.PAPER_10X11
574 PAPER_15X11 = _core_.PAPER_15X11
575 PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576 PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577 PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578 PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579 PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580 PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581 PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582 PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583 PAPER_A_PLUS = _core_.PAPER_A_PLUS
584 PAPER_B_PLUS = _core_.PAPER_B_PLUS
585 PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586 PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587 PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588 PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589 PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590 PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591 PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592 PAPER_A2 = _core_.PAPER_A2
593 PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594 PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
595 PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
596 PAPER_A6 = _core_.PAPER_A6
597 PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
598 PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
599 PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
600 PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
601 PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
602 PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
603 PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
604 PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
605 PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
606 PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
607 PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
608 PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609 PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
610 PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
611 PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
612 PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
613 PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
614 PAPER_B6_JIS = _core_.PAPER_B6_JIS
615 PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
616 PAPER_12X11 = _core_.PAPER_12X11
617 PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
618 PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
619 PAPER_P16K = _core_.PAPER_P16K
620 PAPER_P32K = _core_.PAPER_P32K
621 PAPER_P32KBIG = _core_.PAPER_P32KBIG
622 PAPER_PENV_1 = _core_.PAPER_PENV_1
623 PAPER_PENV_2 = _core_.PAPER_PENV_2
624 PAPER_PENV_3 = _core_.PAPER_PENV_3
625 PAPER_PENV_4 = _core_.PAPER_PENV_4
626 PAPER_PENV_5 = _core_.PAPER_PENV_5
627 PAPER_PENV_6 = _core_.PAPER_PENV_6
628 PAPER_PENV_7 = _core_.PAPER_PENV_7
629 PAPER_PENV_8 = _core_.PAPER_PENV_8
630 PAPER_PENV_9 = _core_.PAPER_PENV_9
631 PAPER_PENV_10 = _core_.PAPER_PENV_10
632 PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
633 PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
634 PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
635 PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
636 PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
637 PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
638 PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
639 PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
640 PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
641 PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
642 PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
643 PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
644 PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
645 DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
646 DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
647 DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
648 ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
649 ITEM_NORMAL = _core_.ITEM_NORMAL
650 ITEM_CHECK = _core_.ITEM_CHECK
651 ITEM_RADIO = _core_.ITEM_RADIO
652 ITEM_MAX = _core_.ITEM_MAX
653 HT_NOWHERE = _core_.HT_NOWHERE
654 HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
655 HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
656 HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
657 HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
658 HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
659 HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
660 HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
661 HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
662 HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
663 HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
664 HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
665 HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
666 HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
667 HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
668 HT_MAX = _core_.HT_MAX
669 MOD_NONE = _core_.MOD_NONE
670 MOD_ALT = _core_.MOD_ALT
671 MOD_CONTROL = _core_.MOD_CONTROL
672 MOD_ALTGR = _core_.MOD_ALTGR
673 MOD_SHIFT = _core_.MOD_SHIFT
674 MOD_META = _core_.MOD_META
675 MOD_WIN = _core_.MOD_WIN
676 MOD_CMD = _core_.MOD_CMD
677 MOD_ALL = _core_.MOD_ALL
678 UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
679 UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
680 UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
681 Layout_Default = _core_.Layout_Default
682 Layout_LeftToRight = _core_.Layout_LeftToRight
683 Layout_RightToLeft = _core_.Layout_RightToLeft
684 #---------------------------------------------------------------------------
685
686 class Object(object):
687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
692 def __init__(self): raise AttributeError, "No constructor defined"
693 __repr__ = _swig_repr
694 def GetClassName(*args, **kwargs):
695 """
696 GetClassName(self) -> String
697
698 Returns the class name of the C++ class using wxRTTI.
699 """
700 return _core_.Object_GetClassName(*args, **kwargs)
701
702 def Destroy(*args, **kwargs):
703 """
704 Destroy(self)
705
706 Deletes the C++ object this Python object is a proxy for.
707 """
708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
710
711 ClassName = property(GetClassName,doc="See `GetClassName`")
712 _core_.Object_swigregister(Object)
713 _wxPySetDictionary = _core_._wxPySetDictionary
714 cvar = _core_.cvar
715 EmptyString = cvar.EmptyString
716
717 #---------------------------------------------------------------------------
718
719 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
720 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
721 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
722 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
723 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
724 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
725 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
726 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
727 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
728 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
729 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
730 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
731 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
732 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
733 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
734 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
735 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
736 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
737 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
738 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
739 CURSOR_NONE = _core_.CURSOR_NONE
740 CURSOR_ARROW = _core_.CURSOR_ARROW
741 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
742 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
743 CURSOR_CHAR = _core_.CURSOR_CHAR
744 CURSOR_CROSS = _core_.CURSOR_CROSS
745 CURSOR_HAND = _core_.CURSOR_HAND
746 CURSOR_IBEAM = _core_.CURSOR_IBEAM
747 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
748 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
749 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
750 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
751 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
752 CURSOR_PENCIL = _core_.CURSOR_PENCIL
753 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
754 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
755 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
756 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
757 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
758 CURSOR_SIZENS = _core_.CURSOR_SIZENS
759 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
760 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
761 CURSOR_SIZING = _core_.CURSOR_SIZING
762 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
763 CURSOR_WAIT = _core_.CURSOR_WAIT
764 CURSOR_WATCH = _core_.CURSOR_WATCH
765 CURSOR_BLANK = _core_.CURSOR_BLANK
766 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
767 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
768 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
769 CURSOR_MAX = _core_.CURSOR_MAX
770 #---------------------------------------------------------------------------
771
772 class Size(object):
773 """
774 wx.Size is a useful data structure used to represent the size of
775 something. It simply contains integer width and height
776 properties. In most places in wxPython where a wx.Size is
777 expected a (width, height) tuple can be used instead.
778 """
779 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
780 __repr__ = _swig_repr
781 width = property(_core_.Size_width_get, _core_.Size_width_set)
782 height = property(_core_.Size_height_get, _core_.Size_height_set)
783 x = width; y = height
784 def __init__(self, *args, **kwargs):
785 """
786 __init__(self, int w=0, int h=0) -> Size
787
788 Creates a size object.
789 """
790 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
791 __swig_destroy__ = _core_.delete_Size
792 __del__ = lambda self : None;
793 def __eq__(*args, **kwargs):
794 """
795 __eq__(self, PyObject other) -> bool
796
797 Test for equality of wx.Size objects.
798 """
799 return _core_.Size___eq__(*args, **kwargs)
800
801 def __ne__(*args, **kwargs):
802 """
803 __ne__(self, PyObject other) -> bool
804
805 Test for inequality of wx.Size objects.
806 """
807 return _core_.Size___ne__(*args, **kwargs)
808
809 def __add__(*args, **kwargs):
810 """
811 __add__(self, Size sz) -> Size
812
813 Add sz's proprties to this and return the result.
814 """
815 return _core_.Size___add__(*args, **kwargs)
816
817 def __sub__(*args, **kwargs):
818 """
819 __sub__(self, Size sz) -> Size
820
821 Subtract sz's properties from this and return the result.
822 """
823 return _core_.Size___sub__(*args, **kwargs)
824
825 def IncTo(*args, **kwargs):
826 """
827 IncTo(self, Size sz)
828
829 Increments this object so that both of its dimensions are not less
830 than the corresponding dimensions of the size.
831 """
832 return _core_.Size_IncTo(*args, **kwargs)
833
834 def DecTo(*args, **kwargs):
835 """
836 DecTo(self, Size sz)
837
838 Decrements this object so that both of its dimensions are not greater
839 than the corresponding dimensions of the size.
840 """
841 return _core_.Size_DecTo(*args, **kwargs)
842
843 def IncBy(*args, **kwargs):
844 """IncBy(self, int dx, int dy)"""
845 return _core_.Size_IncBy(*args, **kwargs)
846
847 def DecBy(*args, **kwargs):
848 """DecBy(self, int dx, int dy)"""
849 return _core_.Size_DecBy(*args, **kwargs)
850
851 def Scale(*args, **kwargs):
852 """
853 Scale(self, float xscale, float yscale)
854
855 Scales the dimensions of this object by the given factors.
856 """
857 return _core_.Size_Scale(*args, **kwargs)
858
859 def Set(*args, **kwargs):
860 """
861 Set(self, int w, int h)
862
863 Set both width and height.
864 """
865 return _core_.Size_Set(*args, **kwargs)
866
867 def SetWidth(*args, **kwargs):
868 """SetWidth(self, int w)"""
869 return _core_.Size_SetWidth(*args, **kwargs)
870
871 def SetHeight(*args, **kwargs):
872 """SetHeight(self, int h)"""
873 return _core_.Size_SetHeight(*args, **kwargs)
874
875 def GetWidth(*args, **kwargs):
876 """GetWidth(self) -> int"""
877 return _core_.Size_GetWidth(*args, **kwargs)
878
879 def GetHeight(*args, **kwargs):
880 """GetHeight(self) -> int"""
881 return _core_.Size_GetHeight(*args, **kwargs)
882
883 def IsFullySpecified(*args, **kwargs):
884 """
885 IsFullySpecified(self) -> bool
886
887 Returns True if both components of the size are non-default values.
888 """
889 return _core_.Size_IsFullySpecified(*args, **kwargs)
890
891 def SetDefaults(*args, **kwargs):
892 """
893 SetDefaults(self, Size size)
894
895 Combine this size with the other one replacing the default components
896 of this object (i.e. equal to -1) with those of the other.
897 """
898 return _core_.Size_SetDefaults(*args, **kwargs)
899
900 def Get(*args, **kwargs):
901 """
902 Get() -> (width,height)
903
904 Returns the width and height properties as a tuple.
905 """
906 return _core_.Size_Get(*args, **kwargs)
907
908 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
909 def __str__(self): return str(self.Get())
910 def __repr__(self): return 'wx.Size'+str(self.Get())
911 def __len__(self): return len(self.Get())
912 def __getitem__(self, index): return self.Get()[index]
913 def __setitem__(self, index, val):
914 if index == 0: self.width = val
915 elif index == 1: self.height = val
916 else: raise IndexError
917 def __nonzero__(self): return self.Get() != (0,0)
918 __safe_for_unpickling__ = True
919 def __reduce__(self): return (wx.Size, self.Get())
920
921 _core_.Size_swigregister(Size)
922
923 #---------------------------------------------------------------------------
924
925 class RealPoint(object):
926 """
927 A data structure for representing a point or position with floating
928 point x and y properties. In wxPython most places that expect a
929 wx.RealPoint can also accept a (x,y) tuple.
930 """
931 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
932 __repr__ = _swig_repr
933 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
934 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
935 def __init__(self, *args, **kwargs):
936 """
937 __init__(self, double x=0.0, double y=0.0) -> RealPoint
938
939 Create a wx.RealPoint object
940 """
941 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
942 __swig_destroy__ = _core_.delete_RealPoint
943 __del__ = lambda self : None;
944 def __eq__(*args, **kwargs):
945 """
946 __eq__(self, PyObject other) -> bool
947
948 Test for equality of wx.RealPoint objects.
949 """
950 return _core_.RealPoint___eq__(*args, **kwargs)
951
952 def __ne__(*args, **kwargs):
953 """
954 __ne__(self, PyObject other) -> bool
955
956 Test for inequality of wx.RealPoint objects.
957 """
958 return _core_.RealPoint___ne__(*args, **kwargs)
959
960 def __add__(*args, **kwargs):
961 """
962 __add__(self, RealPoint pt) -> RealPoint
963
964 Add pt's proprties to this and return the result.
965 """
966 return _core_.RealPoint___add__(*args, **kwargs)
967
968 def __sub__(*args, **kwargs):
969 """
970 __sub__(self, RealPoint pt) -> RealPoint
971
972 Subtract pt's proprties from this and return the result
973 """
974 return _core_.RealPoint___sub__(*args, **kwargs)
975
976 def Set(*args, **kwargs):
977 """
978 Set(self, double x, double y)
979
980 Set both the x and y properties
981 """
982 return _core_.RealPoint_Set(*args, **kwargs)
983
984 def Get(*args, **kwargs):
985 """
986 Get() -> (x,y)
987
988 Return the x and y properties as a tuple.
989 """
990 return _core_.RealPoint_Get(*args, **kwargs)
991
992 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
993 def __str__(self): return str(self.Get())
994 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
995 def __len__(self): return len(self.Get())
996 def __getitem__(self, index): return self.Get()[index]
997 def __setitem__(self, index, val):
998 if index == 0: self.x = val
999 elif index == 1: self.y = val
1000 else: raise IndexError
1001 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1002 __safe_for_unpickling__ = True
1003 def __reduce__(self): return (wx.RealPoint, self.Get())
1004
1005 _core_.RealPoint_swigregister(RealPoint)
1006
1007 #---------------------------------------------------------------------------
1008
1009 class Point(object):
1010 """
1011 A data structure for representing a point or position with integer x
1012 and y properties. Most places in wxPython that expect a wx.Point can
1013 also accept a (x,y) tuple.
1014 """
1015 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1016 __repr__ = _swig_repr
1017 x = property(_core_.Point_x_get, _core_.Point_x_set)
1018 y = property(_core_.Point_y_get, _core_.Point_y_set)
1019 def __init__(self, *args, **kwargs):
1020 """
1021 __init__(self, int x=0, int y=0) -> Point
1022
1023 Create a wx.Point object
1024 """
1025 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1026 __swig_destroy__ = _core_.delete_Point
1027 __del__ = lambda self : None;
1028 def __eq__(*args, **kwargs):
1029 """
1030 __eq__(self, PyObject other) -> bool
1031
1032 Test for equality of wx.Point objects.
1033 """
1034 return _core_.Point___eq__(*args, **kwargs)
1035
1036 def __ne__(*args, **kwargs):
1037 """
1038 __ne__(self, PyObject other) -> bool
1039
1040 Test for inequality of wx.Point objects.
1041 """
1042 return _core_.Point___ne__(*args, **kwargs)
1043
1044 def __add__(*args, **kwargs):
1045 """
1046 __add__(self, Point pt) -> Point
1047
1048 Add pt's proprties to this and return the result.
1049 """
1050 return _core_.Point___add__(*args, **kwargs)
1051
1052 def __sub__(*args, **kwargs):
1053 """
1054 __sub__(self, Point pt) -> Point
1055
1056 Subtract pt's proprties from this and return the result
1057 """
1058 return _core_.Point___sub__(*args, **kwargs)
1059
1060 def __iadd__(*args, **kwargs):
1061 """
1062 __iadd__(self, Point pt) -> Point
1063
1064 Add pt to this object.
1065 """
1066 return _core_.Point___iadd__(*args, **kwargs)
1067
1068 def __isub__(*args, **kwargs):
1069 """
1070 __isub__(self, Point pt) -> Point
1071
1072 Subtract pt from this object.
1073 """
1074 return _core_.Point___isub__(*args, **kwargs)
1075
1076 def Set(*args, **kwargs):
1077 """
1078 Set(self, long x, long y)
1079
1080 Set both the x and y properties
1081 """
1082 return _core_.Point_Set(*args, **kwargs)
1083
1084 def Get(*args, **kwargs):
1085 """
1086 Get() -> (x,y)
1087
1088 Return the x and y properties as a tuple.
1089 """
1090 return _core_.Point_Get(*args, **kwargs)
1091
1092 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1093 def __str__(self): return str(self.Get())
1094 def __repr__(self): return 'wx.Point'+str(self.Get())
1095 def __len__(self): return len(self.Get())
1096 def __getitem__(self, index): return self.Get()[index]
1097 def __setitem__(self, index, val):
1098 if index == 0: self.x = val
1099 elif index == 1: self.y = val
1100 else: raise IndexError
1101 def __nonzero__(self): return self.Get() != (0,0)
1102 __safe_for_unpickling__ = True
1103 def __reduce__(self): return (wx.Point, self.Get())
1104
1105 _core_.Point_swigregister(Point)
1106
1107 #---------------------------------------------------------------------------
1108
1109 class Rect(object):
1110 """
1111 A class for representing and manipulating rectangles. It has x, y,
1112 width and height properties. In wxPython most palces that expect a
1113 wx.Rect can also accept a (x,y,width,height) tuple.
1114 """
1115 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1116 __repr__ = _swig_repr
1117 def __init__(self, *args, **kwargs):
1118 """
1119 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1120
1121 Create a new Rect object.
1122 """
1123 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1124 __swig_destroy__ = _core_.delete_Rect
1125 __del__ = lambda self : None;
1126 def GetX(*args, **kwargs):
1127 """GetX(self) -> int"""
1128 return _core_.Rect_GetX(*args, **kwargs)
1129
1130 def SetX(*args, **kwargs):
1131 """SetX(self, int x)"""
1132 return _core_.Rect_SetX(*args, **kwargs)
1133
1134 def GetY(*args, **kwargs):
1135 """GetY(self) -> int"""
1136 return _core_.Rect_GetY(*args, **kwargs)
1137
1138 def SetY(*args, **kwargs):
1139 """SetY(self, int y)"""
1140 return _core_.Rect_SetY(*args, **kwargs)
1141
1142 def GetWidth(*args, **kwargs):
1143 """GetWidth(self) -> int"""
1144 return _core_.Rect_GetWidth(*args, **kwargs)
1145
1146 def SetWidth(*args, **kwargs):
1147 """SetWidth(self, int w)"""
1148 return _core_.Rect_SetWidth(*args, **kwargs)
1149
1150 def GetHeight(*args, **kwargs):
1151 """GetHeight(self) -> int"""
1152 return _core_.Rect_GetHeight(*args, **kwargs)
1153
1154 def SetHeight(*args, **kwargs):
1155 """SetHeight(self, int h)"""
1156 return _core_.Rect_SetHeight(*args, **kwargs)
1157
1158 def GetPosition(*args, **kwargs):
1159 """GetPosition(self) -> Point"""
1160 return _core_.Rect_GetPosition(*args, **kwargs)
1161
1162 def SetPosition(*args, **kwargs):
1163 """SetPosition(self, Point p)"""
1164 return _core_.Rect_SetPosition(*args, **kwargs)
1165
1166 def GetSize(*args, **kwargs):
1167 """GetSize(self) -> Size"""
1168 return _core_.Rect_GetSize(*args, **kwargs)
1169
1170 def SetSize(*args, **kwargs):
1171 """SetSize(self, Size s)"""
1172 return _core_.Rect_SetSize(*args, **kwargs)
1173
1174 def IsEmpty(*args, **kwargs):
1175 """IsEmpty(self) -> bool"""
1176 return _core_.Rect_IsEmpty(*args, **kwargs)
1177
1178 def GetTopLeft(*args, **kwargs):
1179 """GetTopLeft(self) -> Point"""
1180 return _core_.Rect_GetTopLeft(*args, **kwargs)
1181
1182 def SetTopLeft(*args, **kwargs):
1183 """SetTopLeft(self, Point p)"""
1184 return _core_.Rect_SetTopLeft(*args, **kwargs)
1185
1186 def GetBottomRight(*args, **kwargs):
1187 """GetBottomRight(self) -> Point"""
1188 return _core_.Rect_GetBottomRight(*args, **kwargs)
1189
1190 def SetBottomRight(*args, **kwargs):
1191 """SetBottomRight(self, Point p)"""
1192 return _core_.Rect_SetBottomRight(*args, **kwargs)
1193
1194 def GetTopRight(*args, **kwargs):
1195 """GetTopRight(self) -> Point"""
1196 return _core_.Rect_GetTopRight(*args, **kwargs)
1197
1198 def SetTopRight(*args, **kwargs):
1199 """SetTopRight(self, Point p)"""
1200 return _core_.Rect_SetTopRight(*args, **kwargs)
1201
1202 def GetBottomLeft(*args, **kwargs):
1203 """GetBottomLeft(self) -> Point"""
1204 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1205
1206 def SetBottomLeft(*args, **kwargs):
1207 """SetBottomLeft(self, Point p)"""
1208 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1209
1210 def GetLeft(*args, **kwargs):
1211 """GetLeft(self) -> int"""
1212 return _core_.Rect_GetLeft(*args, **kwargs)
1213
1214 def GetTop(*args, **kwargs):
1215 """GetTop(self) -> int"""
1216 return _core_.Rect_GetTop(*args, **kwargs)
1217
1218 def GetBottom(*args, **kwargs):
1219 """GetBottom(self) -> int"""
1220 return _core_.Rect_GetBottom(*args, **kwargs)
1221
1222 def GetRight(*args, **kwargs):
1223 """GetRight(self) -> int"""
1224 return _core_.Rect_GetRight(*args, **kwargs)
1225
1226 def SetLeft(*args, **kwargs):
1227 """SetLeft(self, int left)"""
1228 return _core_.Rect_SetLeft(*args, **kwargs)
1229
1230 def SetRight(*args, **kwargs):
1231 """SetRight(self, int right)"""
1232 return _core_.Rect_SetRight(*args, **kwargs)
1233
1234 def SetTop(*args, **kwargs):
1235 """SetTop(self, int top)"""
1236 return _core_.Rect_SetTop(*args, **kwargs)
1237
1238 def SetBottom(*args, **kwargs):
1239 """SetBottom(self, int bottom)"""
1240 return _core_.Rect_SetBottom(*args, **kwargs)
1241
1242 position = property(GetPosition, SetPosition)
1243 size = property(GetSize, SetSize)
1244 left = property(GetLeft, SetLeft)
1245 right = property(GetRight, SetRight)
1246 top = property(GetTop, SetTop)
1247 bottom = property(GetBottom, SetBottom)
1248
1249 def Inflate(*args, **kwargs):
1250 """
1251 Inflate(self, int dx, int dy) -> Rect
1252
1253 Increases the size of the rectangle.
1254
1255 The left border is moved farther left and the right border is moved
1256 farther right by ``dx``. The upper border is moved farther up and the
1257 bottom border is moved farther down by ``dy``. (Note the the width and
1258 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1259 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1260 opposite happens: the rectangle size decreases in the respective
1261 direction.
1262
1263 The change is made to the rectangle inplace, if instead you need a
1264 copy that is inflated, preserving the original then make the copy
1265 first::
1266
1267 copy = wx.Rect(*original)
1268 copy.Inflate(10,15)
1269
1270
1271 """
1272 return _core_.Rect_Inflate(*args, **kwargs)
1273
1274 def Deflate(*args, **kwargs):
1275 """
1276 Deflate(self, int dx, int dy) -> Rect
1277
1278 Decrease the rectangle size. This method is the opposite of `Inflate`
1279 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1280 `Inflate` for a full description.
1281 """
1282 return _core_.Rect_Deflate(*args, **kwargs)
1283
1284 def OffsetXY(*args, **kwargs):
1285 """
1286 OffsetXY(self, int dx, int dy)
1287
1288 Moves the rectangle by the specified offset. If dx is positive, the
1289 rectangle is moved to the right, if dy is positive, it is moved to the
1290 bottom, otherwise it is moved to the left or top respectively.
1291 """
1292 return _core_.Rect_OffsetXY(*args, **kwargs)
1293
1294 def Offset(*args, **kwargs):
1295 """
1296 Offset(self, Point pt)
1297
1298 Same as `OffsetXY` but uses dx,dy from Point
1299 """
1300 return _core_.Rect_Offset(*args, **kwargs)
1301
1302 def Intersect(*args, **kwargs):
1303 """
1304 Intersect(self, Rect rect) -> Rect
1305
1306 Returns the intersectsion of this rectangle and rect.
1307 """
1308 return _core_.Rect_Intersect(*args, **kwargs)
1309
1310 def Union(*args, **kwargs):
1311 """
1312 Union(self, Rect rect) -> Rect
1313
1314 Returns the union of this rectangle and rect.
1315 """
1316 return _core_.Rect_Union(*args, **kwargs)
1317
1318 def __add__(*args, **kwargs):
1319 """
1320 __add__(self, Rect rect) -> Rect
1321
1322 Add the properties of rect to this rectangle and return the result.
1323 """
1324 return _core_.Rect___add__(*args, **kwargs)
1325
1326 def __iadd__(*args, **kwargs):
1327 """
1328 __iadd__(self, Rect rect) -> Rect
1329
1330 Add the properties of rect to this rectangle, updating this rectangle.
1331 """
1332 return _core_.Rect___iadd__(*args, **kwargs)
1333
1334 def __eq__(*args, **kwargs):
1335 """
1336 __eq__(self, PyObject other) -> bool
1337
1338 Test for equality of wx.Rect objects.
1339 """
1340 return _core_.Rect___eq__(*args, **kwargs)
1341
1342 def __ne__(*args, **kwargs):
1343 """
1344 __ne__(self, PyObject other) -> bool
1345
1346 Test for inequality of wx.Rect objects.
1347 """
1348 return _core_.Rect___ne__(*args, **kwargs)
1349
1350 def ContainsXY(*args, **kwargs):
1351 """
1352 ContainsXY(self, int x, int y) -> bool
1353
1354 Return True if the point is inside the rect.
1355 """
1356 return _core_.Rect_ContainsXY(*args, **kwargs)
1357
1358 def Contains(*args, **kwargs):
1359 """
1360 Contains(self, Point pt) -> bool
1361
1362 Return True if the point is inside the rect.
1363 """
1364 return _core_.Rect_Contains(*args, **kwargs)
1365
1366 def ContainsRect(*args, **kwargs):
1367 """
1368 ContainsRect(self, Rect rect) -> bool
1369
1370 Returns ``True`` if the given rectangle is completely inside this
1371 rectangle or touches its boundary.
1372 """
1373 return _core_.Rect_ContainsRect(*args, **kwargs)
1374
1375 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1376 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1377 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1378 Inside = Contains
1379 InsideXY = ContainsXY
1380 InsideRect = ContainsRect
1381
1382 def Intersects(*args, **kwargs):
1383 """
1384 Intersects(self, Rect rect) -> bool
1385
1386 Returns True if the rectangles have a non empty intersection.
1387 """
1388 return _core_.Rect_Intersects(*args, **kwargs)
1389
1390 def CenterIn(*args, **kwargs):
1391 """
1392 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1393
1394 Center this rectangle within the one passed to the method, which is
1395 usually, but not necessarily, the larger one.
1396 """
1397 return _core_.Rect_CenterIn(*args, **kwargs)
1398
1399 CentreIn = CenterIn
1400 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1401 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1402 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1403 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1404 def Set(*args, **kwargs):
1405 """
1406 Set(self, int x=0, int y=0, int width=0, int height=0)
1407
1408 Set all rectangle properties.
1409 """
1410 return _core_.Rect_Set(*args, **kwargs)
1411
1412 def Get(*args, **kwargs):
1413 """
1414 Get() -> (x,y,width,height)
1415
1416 Return the rectangle properties as a tuple.
1417 """
1418 return _core_.Rect_Get(*args, **kwargs)
1419
1420 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1421 def __str__(self): return str(self.Get())
1422 def __repr__(self): return 'wx.Rect'+str(self.Get())
1423 def __len__(self): return len(self.Get())
1424 def __getitem__(self, index): return self.Get()[index]
1425 def __setitem__(self, index, val):
1426 if index == 0: self.x = val
1427 elif index == 1: self.y = val
1428 elif index == 2: self.width = val
1429 elif index == 3: self.height = val
1430 else: raise IndexError
1431 def __nonzero__(self): return self.Get() != (0,0,0,0)
1432 __safe_for_unpickling__ = True
1433 def __reduce__(self): return (wx.Rect, self.Get())
1434
1435 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1436 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1437 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
1438 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1439 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1440 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1441 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1442 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1443 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1444 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1445 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
1446 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1447 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1448 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1449 Empty = property(IsEmpty,doc="See `IsEmpty`")
1450 _core_.Rect_swigregister(Rect)
1451
1452 def RectPP(*args, **kwargs):
1453 """
1454 RectPP(Point topLeft, Point bottomRight) -> Rect
1455
1456 Create a new Rect object from Points representing two corners.
1457 """
1458 val = _core_.new_RectPP(*args, **kwargs)
1459 return val
1460
1461 def RectPS(*args, **kwargs):
1462 """
1463 RectPS(Point pos, Size size) -> Rect
1464
1465 Create a new Rect from a position and size.
1466 """
1467 val = _core_.new_RectPS(*args, **kwargs)
1468 return val
1469
1470 def RectS(*args, **kwargs):
1471 """
1472 RectS(Size size) -> Rect
1473
1474 Create a new Rect from a size only.
1475 """
1476 val = _core_.new_RectS(*args, **kwargs)
1477 return val
1478
1479
1480 def IntersectRect(*args, **kwargs):
1481 """
1482 IntersectRect(Rect r1, Rect r2) -> Rect
1483
1484 Calculate and return the intersection of r1 and r2.
1485 """
1486 return _core_.IntersectRect(*args, **kwargs)
1487 #---------------------------------------------------------------------------
1488
1489 class Point2D(object):
1490 """
1491 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1492 with floating point values.
1493 """
1494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1495 __repr__ = _swig_repr
1496 def __init__(self, *args, **kwargs):
1497 """
1498 __init__(self, double x=0.0, double y=0.0) -> Point2D
1499
1500 Create a w.Point2D object.
1501 """
1502 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1503 __swig_destroy__ = _core_.delete_Point2D
1504 __del__ = lambda self : None;
1505 def GetFloor(*args, **kwargs):
1506 """
1507 GetFloor() -> (x,y)
1508
1509 Convert to integer
1510 """
1511 return _core_.Point2D_GetFloor(*args, **kwargs)
1512
1513 def GetRounded(*args, **kwargs):
1514 """
1515 GetRounded() -> (x,y)
1516
1517 Convert to integer
1518 """
1519 return _core_.Point2D_GetRounded(*args, **kwargs)
1520
1521 def GetVectorLength(*args, **kwargs):
1522 """GetVectorLength(self) -> double"""
1523 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1524
1525 def GetVectorAngle(*args, **kwargs):
1526 """GetVectorAngle(self) -> double"""
1527 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1528
1529 def SetVectorLength(*args, **kwargs):
1530 """SetVectorLength(self, double length)"""
1531 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1532
1533 def SetVectorAngle(*args, **kwargs):
1534 """SetVectorAngle(self, double degrees)"""
1535 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1536
1537 def SetPolarCoordinates(self, angle, length):
1538 self.SetVectorLength(length)
1539 self.SetVectorAngle(angle)
1540 def Normalize(self):
1541 self.SetVectorLength(1.0)
1542
1543 def GetDistance(*args, **kwargs):
1544 """GetDistance(self, Point2D pt) -> double"""
1545 return _core_.Point2D_GetDistance(*args, **kwargs)
1546
1547 def GetDistanceSquare(*args, **kwargs):
1548 """GetDistanceSquare(self, Point2D pt) -> double"""
1549 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1550
1551 def GetDotProduct(*args, **kwargs):
1552 """GetDotProduct(self, Point2D vec) -> double"""
1553 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1554
1555 def GetCrossProduct(*args, **kwargs):
1556 """GetCrossProduct(self, Point2D vec) -> double"""
1557 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1558
1559 def __neg__(*args, **kwargs):
1560 """
1561 __neg__(self) -> Point2D
1562
1563 the reflection of this point
1564 """
1565 return _core_.Point2D___neg__(*args, **kwargs)
1566
1567 def __iadd__(*args, **kwargs):
1568 """__iadd__(self, Point2D pt) -> Point2D"""
1569 return _core_.Point2D___iadd__(*args, **kwargs)
1570
1571 def __isub__(*args, **kwargs):
1572 """__isub__(self, Point2D pt) -> Point2D"""
1573 return _core_.Point2D___isub__(*args, **kwargs)
1574
1575 def __imul__(*args, **kwargs):
1576 """__imul__(self, Point2D pt) -> Point2D"""
1577 return _core_.Point2D___imul__(*args, **kwargs)
1578
1579 def __idiv__(*args, **kwargs):
1580 """__idiv__(self, Point2D pt) -> Point2D"""
1581 return _core_.Point2D___idiv__(*args, **kwargs)
1582
1583 def __eq__(*args, **kwargs):
1584 """
1585 __eq__(self, PyObject other) -> bool
1586
1587 Test for equality of wx.Point2D objects.
1588 """
1589 return _core_.Point2D___eq__(*args, **kwargs)
1590
1591 def __ne__(*args, **kwargs):
1592 """
1593 __ne__(self, PyObject other) -> bool
1594
1595 Test for inequality of wx.Point2D objects.
1596 """
1597 return _core_.Point2D___ne__(*args, **kwargs)
1598
1599 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1600 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1601 def Set(*args, **kwargs):
1602 """Set(self, double x=0, double y=0)"""
1603 return _core_.Point2D_Set(*args, **kwargs)
1604
1605 def Get(*args, **kwargs):
1606 """
1607 Get() -> (x,y)
1608
1609 Return x and y properties as a tuple.
1610 """
1611 return _core_.Point2D_Get(*args, **kwargs)
1612
1613 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1614 def __str__(self): return str(self.Get())
1615 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1616 def __len__(self): return len(self.Get())
1617 def __getitem__(self, index): return self.Get()[index]
1618 def __setitem__(self, index, val):
1619 if index == 0: self.x = val
1620 elif index == 1: self.y = val
1621 else: raise IndexError
1622 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1623 __safe_for_unpickling__ = True
1624 def __reduce__(self): return (wx.Point2D, self.Get())
1625
1626 Floor = property(GetFloor,doc="See `GetFloor`")
1627 Rounded = property(GetRounded,doc="See `GetRounded`")
1628 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1629 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1630 _core_.Point2D_swigregister(Point2D)
1631
1632 def Point2DCopy(*args, **kwargs):
1633 """
1634 Point2DCopy(Point2D pt) -> Point2D
1635
1636 Create a w.Point2D object.
1637 """
1638 val = _core_.new_Point2DCopy(*args, **kwargs)
1639 return val
1640
1641 def Point2DFromPoint(*args, **kwargs):
1642 """
1643 Point2DFromPoint(Point pt) -> Point2D
1644
1645 Create a w.Point2D object.
1646 """
1647 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1648 return val
1649
1650 #---------------------------------------------------------------------------
1651
1652 FromStart = _core_.FromStart
1653 FromCurrent = _core_.FromCurrent
1654 FromEnd = _core_.FromEnd
1655 class InputStream(object):
1656 """Proxy of C++ InputStream class"""
1657 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1658 __repr__ = _swig_repr
1659 def __init__(self, *args, **kwargs):
1660 """__init__(self, PyObject p) -> InputStream"""
1661 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1662 __swig_destroy__ = _core_.delete_InputStream
1663 __del__ = lambda self : None;
1664 def close(*args, **kwargs):
1665 """close(self)"""
1666 return _core_.InputStream_close(*args, **kwargs)
1667
1668 def flush(*args, **kwargs):
1669 """flush(self)"""
1670 return _core_.InputStream_flush(*args, **kwargs)
1671
1672 def eof(*args, **kwargs):
1673 """eof(self) -> bool"""
1674 return _core_.InputStream_eof(*args, **kwargs)
1675
1676 def read(*args, **kwargs):
1677 """read(self, int size=-1) -> PyObject"""
1678 return _core_.InputStream_read(*args, **kwargs)
1679
1680 def readline(*args, **kwargs):
1681 """readline(self, int size=-1) -> PyObject"""
1682 return _core_.InputStream_readline(*args, **kwargs)
1683
1684 def readlines(*args, **kwargs):
1685 """readlines(self, int sizehint=-1) -> PyObject"""
1686 return _core_.InputStream_readlines(*args, **kwargs)
1687
1688 def seek(*args, **kwargs):
1689 """seek(self, int offset, int whence=0)"""
1690 return _core_.InputStream_seek(*args, **kwargs)
1691
1692 def tell(*args, **kwargs):
1693 """tell(self) -> int"""
1694 return _core_.InputStream_tell(*args, **kwargs)
1695
1696 def Peek(*args, **kwargs):
1697 """Peek(self) -> char"""
1698 return _core_.InputStream_Peek(*args, **kwargs)
1699
1700 def GetC(*args, **kwargs):
1701 """GetC(self) -> char"""
1702 return _core_.InputStream_GetC(*args, **kwargs)
1703
1704 def LastRead(*args, **kwargs):
1705 """LastRead(self) -> size_t"""
1706 return _core_.InputStream_LastRead(*args, **kwargs)
1707
1708 def CanRead(*args, **kwargs):
1709 """CanRead(self) -> bool"""
1710 return _core_.InputStream_CanRead(*args, **kwargs)
1711
1712 def Eof(*args, **kwargs):
1713 """Eof(self) -> bool"""
1714 return _core_.InputStream_Eof(*args, **kwargs)
1715
1716 def Ungetch(*args, **kwargs):
1717 """Ungetch(self, char c) -> bool"""
1718 return _core_.InputStream_Ungetch(*args, **kwargs)
1719
1720 def SeekI(*args, **kwargs):
1721 """SeekI(self, long pos, int mode=FromStart) -> long"""
1722 return _core_.InputStream_SeekI(*args, **kwargs)
1723
1724 def TellI(*args, **kwargs):
1725 """TellI(self) -> long"""
1726 return _core_.InputStream_TellI(*args, **kwargs)
1727
1728 _core_.InputStream_swigregister(InputStream)
1729 DefaultPosition = cvar.DefaultPosition
1730 DefaultSize = cvar.DefaultSize
1731
1732 class OutputStream(object):
1733 """Proxy of C++ OutputStream class"""
1734 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1735 def __init__(self): raise AttributeError, "No constructor defined"
1736 __repr__ = _swig_repr
1737 def write(*args, **kwargs):
1738 """write(self, PyObject obj)"""
1739 return _core_.OutputStream_write(*args, **kwargs)
1740
1741 def LastWrite(*args, **kwargs):
1742 """LastWrite(self) -> size_t"""
1743 return _core_.OutputStream_LastWrite(*args, **kwargs)
1744
1745 _core_.OutputStream_swigregister(OutputStream)
1746
1747 #---------------------------------------------------------------------------
1748
1749 class FSFile(Object):
1750 """Proxy of C++ FSFile class"""
1751 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1752 __repr__ = _swig_repr
1753 def __init__(self, *args, **kwargs):
1754 """
1755 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1756 DateTime modif) -> FSFile
1757 """
1758 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1759 __swig_destroy__ = _core_.delete_FSFile
1760 __del__ = lambda self : None;
1761 def GetStream(*args, **kwargs):
1762 """GetStream(self) -> InputStream"""
1763 return _core_.FSFile_GetStream(*args, **kwargs)
1764
1765 def DetachStream(*args, **kwargs):
1766 """DetachStream(self)"""
1767 return _core_.FSFile_DetachStream(*args, **kwargs)
1768
1769 def GetMimeType(*args, **kwargs):
1770 """GetMimeType(self) -> String"""
1771 return _core_.FSFile_GetMimeType(*args, **kwargs)
1772
1773 def GetLocation(*args, **kwargs):
1774 """GetLocation(self) -> String"""
1775 return _core_.FSFile_GetLocation(*args, **kwargs)
1776
1777 def GetAnchor(*args, **kwargs):
1778 """GetAnchor(self) -> String"""
1779 return _core_.FSFile_GetAnchor(*args, **kwargs)
1780
1781 def GetModificationTime(*args, **kwargs):
1782 """GetModificationTime(self) -> DateTime"""
1783 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1784
1785 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1786 Location = property(GetLocation,doc="See `GetLocation`")
1787 MimeType = property(GetMimeType,doc="See `GetMimeType`")
1788 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
1789 Stream = property(GetStream,doc="See `GetStream`")
1790 _core_.FSFile_swigregister(FSFile)
1791
1792 class CPPFileSystemHandler(object):
1793 """Proxy of C++ CPPFileSystemHandler class"""
1794 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1795 def __init__(self): raise AttributeError, "No constructor defined"
1796 __repr__ = _swig_repr
1797 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1798 __del__ = lambda self : None;
1799 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
1800
1801 class FileSystemHandler(CPPFileSystemHandler):
1802 """Proxy of C++ FileSystemHandler class"""
1803 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1804 __repr__ = _swig_repr
1805 def __init__(self, *args, **kwargs):
1806 """__init__(self) -> FileSystemHandler"""
1807 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
1808 self._setCallbackInfo(self, FileSystemHandler)
1809
1810 def _setCallbackInfo(*args, **kwargs):
1811 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1812 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1813
1814 def CanOpen(*args, **kwargs):
1815 """CanOpen(self, String location) -> bool"""
1816 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1817
1818 def OpenFile(*args, **kwargs):
1819 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1820 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1821
1822 def FindFirst(*args, **kwargs):
1823 """FindFirst(self, String spec, int flags=0) -> String"""
1824 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1825
1826 def FindNext(*args, **kwargs):
1827 """FindNext(self) -> String"""
1828 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1829
1830 def GetProtocol(*args, **kwargs):
1831 """GetProtocol(self, String location) -> String"""
1832 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1833
1834 def GetLeftLocation(*args, **kwargs):
1835 """GetLeftLocation(self, String location) -> String"""
1836 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1837
1838 def GetAnchor(*args, **kwargs):
1839 """GetAnchor(self, String location) -> String"""
1840 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1841
1842 def GetRightLocation(*args, **kwargs):
1843 """GetRightLocation(self, String location) -> String"""
1844 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1845
1846 def GetMimeTypeFromExt(*args, **kwargs):
1847 """GetMimeTypeFromExt(self, String location) -> String"""
1848 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1849
1850 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1851 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
1852 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
1853 Protocol = property(GetProtocol,doc="See `GetProtocol`")
1854 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
1855 _core_.FileSystemHandler_swigregister(FileSystemHandler)
1856
1857 class FileSystem(Object):
1858 """Proxy of C++ FileSystem class"""
1859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1860 __repr__ = _swig_repr
1861 def __init__(self, *args, **kwargs):
1862 """__init__(self) -> FileSystem"""
1863 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1864 __swig_destroy__ = _core_.delete_FileSystem
1865 __del__ = lambda self : None;
1866 def ChangePathTo(*args, **kwargs):
1867 """ChangePathTo(self, String location, bool is_dir=False)"""
1868 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1869
1870 def GetPath(*args, **kwargs):
1871 """GetPath(self) -> String"""
1872 return _core_.FileSystem_GetPath(*args, **kwargs)
1873
1874 def OpenFile(*args, **kwargs):
1875 """OpenFile(self, String location) -> FSFile"""
1876 return _core_.FileSystem_OpenFile(*args, **kwargs)
1877
1878 def FindFirst(*args, **kwargs):
1879 """FindFirst(self, String spec, int flags=0) -> String"""
1880 return _core_.FileSystem_FindFirst(*args, **kwargs)
1881
1882 def FindNext(*args, **kwargs):
1883 """FindNext(self) -> String"""
1884 return _core_.FileSystem_FindNext(*args, **kwargs)
1885
1886 def AddHandler(*args, **kwargs):
1887 """AddHandler(CPPFileSystemHandler handler)"""
1888 return _core_.FileSystem_AddHandler(*args, **kwargs)
1889
1890 AddHandler = staticmethod(AddHandler)
1891 def RemoveHandler(*args, **kwargs):
1892 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1893 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1894
1895 RemoveHandler = staticmethod(RemoveHandler)
1896 def CleanUpHandlers(*args, **kwargs):
1897 """CleanUpHandlers()"""
1898 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1899
1900 CleanUpHandlers = staticmethod(CleanUpHandlers)
1901 def FileNameToURL(*args, **kwargs):
1902 """FileNameToURL(String filename) -> String"""
1903 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1904
1905 FileNameToURL = staticmethod(FileNameToURL)
1906 def URLToFileName(*args, **kwargs):
1907 """URLToFileName(String url) -> String"""
1908 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1909
1910 URLToFileName = staticmethod(URLToFileName)
1911 Path = property(GetPath,doc="See `GetPath`")
1912 _core_.FileSystem_swigregister(FileSystem)
1913
1914 def FileSystem_AddHandler(*args, **kwargs):
1915 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1916 return _core_.FileSystem_AddHandler(*args, **kwargs)
1917
1918 def FileSystem_RemoveHandler(*args, **kwargs):
1919 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1920 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1921
1922 def FileSystem_CleanUpHandlers(*args):
1923 """FileSystem_CleanUpHandlers()"""
1924 return _core_.FileSystem_CleanUpHandlers(*args)
1925
1926 def FileSystem_FileNameToURL(*args, **kwargs):
1927 """FileSystem_FileNameToURL(String filename) -> String"""
1928 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1929
1930 def FileSystem_URLToFileName(*args, **kwargs):
1931 """FileSystem_URLToFileName(String url) -> String"""
1932 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1933
1934 class InternetFSHandler(CPPFileSystemHandler):
1935 """Proxy of C++ InternetFSHandler class"""
1936 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1937 __repr__ = _swig_repr
1938 def __init__(self, *args, **kwargs):
1939 """__init__(self) -> InternetFSHandler"""
1940 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
1941 def CanOpen(*args, **kwargs):
1942 """CanOpen(self, String location) -> bool"""
1943 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1944
1945 def OpenFile(*args, **kwargs):
1946 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1947 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1948
1949 _core_.InternetFSHandler_swigregister(InternetFSHandler)
1950
1951 class ZipFSHandler(CPPFileSystemHandler):
1952 """Proxy of C++ ZipFSHandler class"""
1953 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1954 __repr__ = _swig_repr
1955 def __init__(self, *args, **kwargs):
1956 """__init__(self) -> ZipFSHandler"""
1957 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
1958 def CanOpen(*args, **kwargs):
1959 """CanOpen(self, String location) -> bool"""
1960 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1961
1962 def OpenFile(*args, **kwargs):
1963 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1964 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1965
1966 def FindFirst(*args, **kwargs):
1967 """FindFirst(self, String spec, int flags=0) -> String"""
1968 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1969
1970 def FindNext(*args, **kwargs):
1971 """FindNext(self) -> String"""
1972 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1973
1974 _core_.ZipFSHandler_swigregister(ZipFSHandler)
1975
1976
1977 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1978 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1979 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1980
1981 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1982 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1983 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1984
1985 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1986 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1987 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1988 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1989 """
1990 Add 'file' to the memory filesystem. The dataItem parameter can
1991 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1992 arbitrary data. If a bitmap or image is used then the imgType
1993 parameter should specify what kind of image file it should be
1994 written as, wx.BITMAP_TYPE_PNG, etc.
1995 """
1996 if isinstance(dataItem, wx.Image):
1997 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1998 elif isinstance(dataItem, wx.Bitmap):
1999 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2000 elif type(dataItem) == str:
2001 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2002 else:
2003 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2004
2005 class MemoryFSHandler(CPPFileSystemHandler):
2006 """Proxy of C++ MemoryFSHandler class"""
2007 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2008 __repr__ = _swig_repr
2009 def __init__(self, *args, **kwargs):
2010 """__init__(self) -> MemoryFSHandler"""
2011 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
2012 def RemoveFile(*args, **kwargs):
2013 """RemoveFile(String filename)"""
2014 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2015
2016 RemoveFile = staticmethod(RemoveFile)
2017 AddFile = staticmethod(MemoryFSHandler_AddFile)
2018 def CanOpen(*args, **kwargs):
2019 """CanOpen(self, String location) -> bool"""
2020 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2021
2022 def OpenFile(*args, **kwargs):
2023 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2024 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2025
2026 def FindFirst(*args, **kwargs):
2027 """FindFirst(self, String spec, int flags=0) -> String"""
2028 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2029
2030 def FindNext(*args, **kwargs):
2031 """FindNext(self) -> String"""
2032 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2033
2034 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2035
2036 def MemoryFSHandler_RemoveFile(*args, **kwargs):
2037 """MemoryFSHandler_RemoveFile(String filename)"""
2038 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2039
2040 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2041 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2042 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2043 IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2044 IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
2045 #---------------------------------------------------------------------------
2046
2047 class ImageHandler(Object):
2048 """
2049 This is the base class for implementing image file loading/saving, and
2050 image creation from data. It is used within `wx.Image` and is not
2051 normally seen by the application.
2052 """
2053 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2054 def __init__(self): raise AttributeError, "No constructor defined"
2055 __repr__ = _swig_repr
2056 def GetName(*args, **kwargs):
2057 """GetName(self) -> String"""
2058 return _core_.ImageHandler_GetName(*args, **kwargs)
2059
2060 def GetExtension(*args, **kwargs):
2061 """GetExtension(self) -> String"""
2062 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2063
2064 def GetType(*args, **kwargs):
2065 """GetType(self) -> long"""
2066 return _core_.ImageHandler_GetType(*args, **kwargs)
2067
2068 def GetMimeType(*args, **kwargs):
2069 """GetMimeType(self) -> String"""
2070 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2071
2072 def CanRead(*args, **kwargs):
2073 """CanRead(self, String name) -> bool"""
2074 return _core_.ImageHandler_CanRead(*args, **kwargs)
2075
2076 def CanReadStream(*args, **kwargs):
2077 """CanReadStream(self, InputStream stream) -> bool"""
2078 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2079
2080 def SetName(*args, **kwargs):
2081 """SetName(self, String name)"""
2082 return _core_.ImageHandler_SetName(*args, **kwargs)
2083
2084 def SetExtension(*args, **kwargs):
2085 """SetExtension(self, String extension)"""
2086 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2087
2088 def SetType(*args, **kwargs):
2089 """SetType(self, long type)"""
2090 return _core_.ImageHandler_SetType(*args, **kwargs)
2091
2092 def SetMimeType(*args, **kwargs):
2093 """SetMimeType(self, String mimetype)"""
2094 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2095
2096 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2097 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2098 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2099 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2100 _core_.ImageHandler_swigregister(ImageHandler)
2101
2102 class PyImageHandler(ImageHandler):
2103 """
2104 This is the base class for implementing image file loading/saving, and
2105 image creation from data, all written in Python. To create a custom
2106 image handler derive a new class from wx.PyImageHandler and provide
2107 the following methods::
2108
2109 def DoCanRead(self, stream) --> bool
2110 '''Check if this handler can read the image on the stream'''
2111
2112 def LoadFile(self, image, stream, verbose, index) --> bool
2113 '''Load image data from the stream and load it into image.'''
2114
2115 def SaveFile(self, image, stream, verbose) --> bool
2116 '''Save the iamge data in image to the stream using
2117 this handler's image file format.'''
2118
2119 def GetImageCount(self, stream) --> int
2120 '''If this image format can hold more than one image,
2121 how many does the image on the stream have?'''
2122
2123 To activate your handler create an instance of it and pass it to
2124 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2125 `SetExtension` from your constructor.
2126
2127 """
2128 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2129 __repr__ = _swig_repr
2130 def __init__(self, *args, **kwargs):
2131 """
2132 __init__(self) -> PyImageHandler
2133
2134 This is the base class for implementing image file loading/saving, and
2135 image creation from data, all written in Python. To create a custom
2136 image handler derive a new class from wx.PyImageHandler and provide
2137 the following methods::
2138
2139 def DoCanRead(self, stream) --> bool
2140 '''Check if this handler can read the image on the stream'''
2141
2142 def LoadFile(self, image, stream, verbose, index) --> bool
2143 '''Load image data from the stream and load it into image.'''
2144
2145 def SaveFile(self, image, stream, verbose) --> bool
2146 '''Save the iamge data in image to the stream using
2147 this handler's image file format.'''
2148
2149 def GetImageCount(self, stream) --> int
2150 '''If this image format can hold more than one image,
2151 how many does the image on the stream have?'''
2152
2153 To activate your handler create an instance of it and pass it to
2154 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2155 `SetExtension` from your constructor.
2156
2157 """
2158 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2159 self._SetSelf(self)
2160
2161 def _SetSelf(*args, **kwargs):
2162 """_SetSelf(self, PyObject self)"""
2163 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2164
2165 _core_.PyImageHandler_swigregister(PyImageHandler)
2166
2167 class ImageHistogram(object):
2168 """Proxy of C++ ImageHistogram class"""
2169 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2170 __repr__ = _swig_repr
2171 def __init__(self, *args, **kwargs):
2172 """__init__(self) -> ImageHistogram"""
2173 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2174 def MakeKey(*args, **kwargs):
2175 """
2176 MakeKey(byte r, byte g, byte b) -> unsigned long
2177
2178 Get the key in the histogram for the given RGB values
2179 """
2180 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2181
2182 MakeKey = staticmethod(MakeKey)
2183 def FindFirstUnusedColour(*args, **kwargs):
2184 """
2185 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2186
2187 Find first colour that is not used in the image and has higher RGB
2188 values than startR, startG, startB. Returns a tuple consisting of a
2189 success flag and rgb values.
2190 """
2191 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2192
2193 def GetCount(*args, **kwargs):
2194 """
2195 GetCount(self, unsigned long key) -> unsigned long
2196
2197 Returns the pixel count for the given key. Use `MakeKey` to create a
2198 key value from a RGB tripple.
2199 """
2200 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2201
2202 def GetCountRGB(*args, **kwargs):
2203 """
2204 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2205
2206 Returns the pixel count for the given RGB values.
2207 """
2208 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2209
2210 def GetCountColour(*args, **kwargs):
2211 """
2212 GetCountColour(self, Colour colour) -> unsigned long
2213
2214 Returns the pixel count for the given `wx.Colour` value.
2215 """
2216 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2217
2218 _core_.ImageHistogram_swigregister(ImageHistogram)
2219
2220 def ImageHistogram_MakeKey(*args, **kwargs):
2221 """
2222 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2223
2224 Get the key in the histogram for the given RGB values
2225 """
2226 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2227
2228 class Image_RGBValue(object):
2229 """
2230 An object that contains values for red, green and blue which represent
2231 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2232 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2233 color space.
2234 """
2235 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2236 __repr__ = _swig_repr
2237 def __init__(self, *args, **kwargs):
2238 """
2239 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2240
2241 Constructor.
2242 """
2243 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2244 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2245 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2246 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2247 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2248
2249 class Image_HSVValue(object):
2250 """
2251 An object that contains values for hue, saturation and value which
2252 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2253 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2254 color space.
2255 """
2256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2257 __repr__ = _swig_repr
2258 def __init__(self, *args, **kwargs):
2259 """
2260 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2261
2262 Constructor.
2263 """
2264 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2265 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2266 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2267 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2268 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2269
2270 class Image(Object):
2271 """
2272 A platform-independent image class. An image can be created from
2273 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2274 variety of formats. Functions are available to set and get image
2275 bits, so it can be used for basic image manipulation.
2276
2277 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2278 platform-specific `wx.Bitmap` object must be created from it using the
2279 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2280 device context, using `wx.DC.DrawBitmap`.
2281
2282 One colour value of the image may be used as a mask colour which will
2283 lead to the automatic creation of a `wx.Mask` object associated to the
2284 bitmap object.
2285
2286 wx.Image supports alpha channel data, that is in addition to a byte
2287 for the red, green and blue colour components for each pixel it also
2288 stores a byte representing the pixel opacity. An alpha value of 0
2289 corresponds to a transparent pixel (null opacity) while a value of 255
2290 means that the pixel is 100% opaque.
2291
2292 Unlike RGB data, not all images have an alpha channel and before using
2293 `GetAlpha` you should check if this image contains an alpha channel
2294 with `HasAlpha`. Note that currently only images loaded from PNG files
2295 with transparency information will have an alpha channel.
2296 """
2297 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2298 __repr__ = _swig_repr
2299 def __init__(self, *args, **kwargs):
2300 """
2301 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2302
2303 Loads an image from a file.
2304 """
2305 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2306 __swig_destroy__ = _core_.delete_Image
2307 __del__ = lambda self : None;
2308 def Create(*args, **kwargs):
2309 """
2310 Create(self, int width, int height, bool clear=True)
2311
2312 Creates a fresh image. If clear is ``True``, the new image will be
2313 initialized to black. Otherwise, the image data will be uninitialized.
2314 """
2315 return _core_.Image_Create(*args, **kwargs)
2316
2317 def Destroy(*args, **kwargs):
2318 """
2319 Destroy(self)
2320
2321 Destroys the image data.
2322 """
2323 args[0].this.own(False)
2324 return _core_.Image_Destroy(*args, **kwargs)
2325
2326 def Scale(*args, **kwargs):
2327 """
2328 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2329
2330 Returns a scaled version of the image. This is also useful for scaling
2331 bitmaps in general as the only other way to scale bitmaps is to blit a
2332 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2333 specifies what method to use for resampling the image. It can be
2334 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2335 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2336 bicubic and box averaging resampling methods for upsampling and
2337 downsampling respectively.
2338 """
2339 return _core_.Image_Scale(*args, **kwargs)
2340
2341 def ResampleBox(*args, **kwargs):
2342 """ResampleBox(self, int width, int height) -> Image"""
2343 return _core_.Image_ResampleBox(*args, **kwargs)
2344
2345 def ResampleBicubic(*args, **kwargs):
2346 """ResampleBicubic(self, int width, int height) -> Image"""
2347 return _core_.Image_ResampleBicubic(*args, **kwargs)
2348
2349 def Blur(*args, **kwargs):
2350 """
2351 Blur(self, int radius) -> Image
2352
2353 Blurs the image in both horizontal and vertical directions by the
2354 specified pixel ``radius``. This should not be used when using a
2355 single mask colour for transparency.
2356 """
2357 return _core_.Image_Blur(*args, **kwargs)
2358
2359 def BlurHorizontal(*args, **kwargs):
2360 """
2361 BlurHorizontal(self, int radius) -> Image
2362
2363 Blurs the image in the horizontal direction only. This should not be
2364 used when using a single mask colour for transparency.
2365
2366 """
2367 return _core_.Image_BlurHorizontal(*args, **kwargs)
2368
2369 def BlurVertical(*args, **kwargs):
2370 """
2371 BlurVertical(self, int radius) -> Image
2372
2373 Blurs the image in the vertical direction only. This should not be
2374 used when using a single mask colour for transparency.
2375 """
2376 return _core_.Image_BlurVertical(*args, **kwargs)
2377
2378 def ShrinkBy(*args, **kwargs):
2379 """
2380 ShrinkBy(self, int xFactor, int yFactor) -> Image
2381
2382 Return a version of the image scaled smaller by the given factors.
2383 """
2384 return _core_.Image_ShrinkBy(*args, **kwargs)
2385
2386 def Rescale(*args, **kwargs):
2387 """
2388 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2389
2390 Changes the size of the image in-place by scaling it: after a call to
2391 this function, the image will have the given width and height.
2392
2393 Returns the (modified) image itself.
2394 """
2395 return _core_.Image_Rescale(*args, **kwargs)
2396
2397 def Resize(*args, **kwargs):
2398 """
2399 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2400
2401 Changes the size of the image in-place without scaling it, by adding
2402 either a border with the given colour or cropping as necessary. The
2403 image is pasted into a new image with the given size and background
2404 colour at the position pos relative to the upper left of the new
2405 image. If red = green = blue = -1 then use either the current mask
2406 colour if set or find, use, and set a suitable mask colour for any
2407 newly exposed areas.
2408
2409 Returns the (modified) image itself.
2410 """
2411 return _core_.Image_Resize(*args, **kwargs)
2412
2413 def SetRGB(*args, **kwargs):
2414 """
2415 SetRGB(self, int x, int y, byte r, byte g, byte b)
2416
2417 Sets the pixel at the given coordinate. This routine performs
2418 bounds-checks for the coordinate so it can be considered a safe way to
2419 manipulate the data, but in some cases this might be too slow so that
2420 the data will have to be set directly. In that case you will have to
2421 get access to the image data using the `GetData` method.
2422 """
2423 return _core_.Image_SetRGB(*args, **kwargs)
2424
2425 def SetRGBRect(*args, **kwargs):
2426 """
2427 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2428
2429 Sets the colour of the pixels within the given rectangle. This routine
2430 performs bounds-checks for the rectangle so it can be considered a
2431 safe way to manipulate the data.
2432 """
2433 return _core_.Image_SetRGBRect(*args, **kwargs)
2434
2435 def GetRed(*args, **kwargs):
2436 """
2437 GetRed(self, int x, int y) -> byte
2438
2439 Returns the red intensity at the given coordinate.
2440 """
2441 return _core_.Image_GetRed(*args, **kwargs)
2442
2443 def GetGreen(*args, **kwargs):
2444 """
2445 GetGreen(self, int x, int y) -> byte
2446
2447 Returns the green intensity at the given coordinate.
2448 """
2449 return _core_.Image_GetGreen(*args, **kwargs)
2450
2451 def GetBlue(*args, **kwargs):
2452 """
2453 GetBlue(self, int x, int y) -> byte
2454
2455 Returns the blue intensity at the given coordinate.
2456 """
2457 return _core_.Image_GetBlue(*args, **kwargs)
2458
2459 def SetAlpha(*args, **kwargs):
2460 """
2461 SetAlpha(self, int x, int y, byte alpha)
2462
2463 Sets the alpha value for the given pixel. This function should only be
2464 called if the image has alpha channel data, use `HasAlpha` to check
2465 for this.
2466 """
2467 return _core_.Image_SetAlpha(*args, **kwargs)
2468
2469 def GetAlpha(*args, **kwargs):
2470 """
2471 GetAlpha(self, int x, int y) -> byte
2472
2473 Returns the alpha value for the given pixel. This function may only be
2474 called for the images with alpha channel, use `HasAlpha` to check for
2475 this.
2476
2477 The returned value is the *opacity* of the image, i.e. the value of 0
2478 corresponds to the fully transparent pixels while the value of 255 to
2479 the fully opaque pixels.
2480 """
2481 return _core_.Image_GetAlpha(*args, **kwargs)
2482
2483 def HasAlpha(*args, **kwargs):
2484 """
2485 HasAlpha(self) -> bool
2486
2487 Returns true if this image has alpha channel, false otherwise.
2488 """
2489 return _core_.Image_HasAlpha(*args, **kwargs)
2490
2491 def InitAlpha(*args, **kwargs):
2492 """
2493 InitAlpha(self)
2494
2495 Initializes the image alpha channel data. It is an error to call it if
2496 the image already has alpha data. If it doesn't, alpha data will be by
2497 default initialized to all pixels being fully opaque. But if the image
2498 has a a mask colour, all mask pixels will be completely transparent.
2499 """
2500 return _core_.Image_InitAlpha(*args, **kwargs)
2501
2502 def IsTransparent(*args, **kwargs):
2503 """
2504 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2505
2506 Returns ``True`` if this pixel is masked or has an alpha value less
2507 than the spcified threshold.
2508 """
2509 return _core_.Image_IsTransparent(*args, **kwargs)
2510
2511 def FindFirstUnusedColour(*args, **kwargs):
2512 """
2513 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2514
2515 Find first colour that is not used in the image and has higher RGB
2516 values than startR, startG, startB. Returns a tuple consisting of a
2517 success flag and rgb values.
2518 """
2519 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2520
2521 def ConvertAlphaToMask(*args, **kwargs):
2522 """
2523 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2524
2525 If the image has alpha channel, this method converts it to mask. All
2526 pixels with alpha value less than ``threshold`` are replaced with the
2527 mask colour and the alpha channel is removed. The mask colour is
2528 chosen automatically using `FindFirstUnusedColour`.
2529
2530 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2531 nothing.
2532 """
2533 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2534
2535 def ConvertColourToAlpha(*args, **kwargs):
2536 """
2537 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2538
2539 This method converts an image where the original alpha information is
2540 only available as a shades of a colour (actually shades of grey)
2541 typically when you draw anti-aliased text into a bitmap. The DC
2542 drawing routines draw grey values on the black background although
2543 they actually mean to draw white with differnt alpha values. This
2544 method reverses it, assuming a black (!) background and white text.
2545 The method will then fill up the whole image with the colour given.
2546 """
2547 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2548
2549 def SetMaskFromImage(*args, **kwargs):
2550 """
2551 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2552
2553 Sets the image's mask so that the pixels that have RGB value of
2554 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2555 by first finding an unused colour in the image, setting this colour as
2556 the mask colour and then using this colour to draw all pixels in the
2557 image who corresponding pixel in mask has given RGB value.
2558
2559 Returns ``False`` if ``mask`` does not have same dimensions as the
2560 image or if there is no unused colour left. Returns ``True`` if the
2561 mask was successfully applied.
2562
2563 Note that this method involves computing the histogram, which is
2564 computationally intensive operation.
2565 """
2566 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2567
2568 def CanRead(*args, **kwargs):
2569 """
2570 CanRead(String filename) -> bool
2571
2572 Returns True if the image handlers can read this file.
2573 """
2574 return _core_.Image_CanRead(*args, **kwargs)
2575
2576 CanRead = staticmethod(CanRead)
2577 def GetImageCount(*args, **kwargs):
2578 """
2579 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2580
2581 If the image file contains more than one image and the image handler
2582 is capable of retrieving these individually, this function will return
2583 the number of available images.
2584 """
2585 return _core_.Image_GetImageCount(*args, **kwargs)
2586
2587 GetImageCount = staticmethod(GetImageCount)
2588 def LoadFile(*args, **kwargs):
2589 """
2590 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2591
2592 Loads an image from a file. If no handler type is provided, the
2593 library will try to autodetect the format.
2594 """
2595 return _core_.Image_LoadFile(*args, **kwargs)
2596
2597 def LoadMimeFile(*args, **kwargs):
2598 """
2599 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2600
2601 Loads an image from a file, specifying the image type with a MIME type
2602 string.
2603 """
2604 return _core_.Image_LoadMimeFile(*args, **kwargs)
2605
2606 def SaveFile(*args, **kwargs):
2607 """
2608 SaveFile(self, String name, int type) -> bool
2609
2610 Saves an image in the named file.
2611 """
2612 return _core_.Image_SaveFile(*args, **kwargs)
2613
2614 def SaveMimeFile(*args, **kwargs):
2615 """
2616 SaveMimeFile(self, String name, String mimetype) -> bool
2617
2618 Saves an image in the named file.
2619 """
2620 return _core_.Image_SaveMimeFile(*args, **kwargs)
2621
2622 def CanReadStream(*args, **kwargs):
2623 """
2624 CanReadStream(InputStream stream) -> bool
2625
2626 Returns True if the image handlers can read an image file from the
2627 data currently on the input stream, or a readable Python file-like
2628 object.
2629 """
2630 return _core_.Image_CanReadStream(*args, **kwargs)
2631
2632 CanReadStream = staticmethod(CanReadStream)
2633 def LoadStream(*args, **kwargs):
2634 """
2635 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2636
2637 Loads an image from an input stream or a readable Python file-like
2638 object. If no handler type is provided, the library will try to
2639 autodetect the format.
2640 """
2641 return _core_.Image_LoadStream(*args, **kwargs)
2642
2643 def LoadMimeStream(*args, **kwargs):
2644 """
2645 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2646
2647 Loads an image from an input stream or a readable Python file-like
2648 object, using a MIME type string to specify the image file format.
2649 """
2650 return _core_.Image_LoadMimeStream(*args, **kwargs)
2651
2652 def IsOk(*args, **kwargs):
2653 """
2654 IsOk(self) -> bool
2655
2656 Returns true if image data is present.
2657 """
2658 return _core_.Image_IsOk(*args, **kwargs)
2659
2660 Ok = IsOk
2661 def GetWidth(*args, **kwargs):
2662 """
2663 GetWidth(self) -> int
2664
2665 Gets the width of the image in pixels.
2666 """
2667 return _core_.Image_GetWidth(*args, **kwargs)
2668
2669 def GetHeight(*args, **kwargs):
2670 """
2671 GetHeight(self) -> int
2672
2673 Gets the height of the image in pixels.
2674 """
2675 return _core_.Image_GetHeight(*args, **kwargs)
2676
2677 def GetSize(*args, **kwargs):
2678 """
2679 GetSize(self) -> Size
2680
2681 Returns the size of the image in pixels.
2682 """
2683 return _core_.Image_GetSize(*args, **kwargs)
2684
2685 def GetSubImage(*args, **kwargs):
2686 """
2687 GetSubImage(self, Rect rect) -> Image
2688
2689 Returns a sub image of the current one as long as the rect belongs
2690 entirely to the image.
2691 """
2692 return _core_.Image_GetSubImage(*args, **kwargs)
2693
2694 def Size(*args, **kwargs):
2695 """
2696 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2697
2698 Returns a resized version of this image without scaling it by adding
2699 either a border with the given colour or cropping as necessary. The
2700 image is pasted into a new image with the given size and background
2701 colour at the position ``pos`` relative to the upper left of the new
2702 image. If red = green = blue = -1 then use either the current mask
2703 colour if set or find, use, and set a suitable mask colour for any
2704 newly exposed areas.
2705 """
2706 return _core_.Image_Size(*args, **kwargs)
2707
2708 def Copy(*args, **kwargs):
2709 """
2710 Copy(self) -> Image
2711
2712 Returns an identical copy of the image.
2713 """
2714 return _core_.Image_Copy(*args, **kwargs)
2715
2716 def Paste(*args, **kwargs):
2717 """
2718 Paste(self, Image image, int x, int y)
2719
2720 Pastes ``image`` into this instance and takes care of the mask colour
2721 and any out of bounds problems.
2722 """
2723 return _core_.Image_Paste(*args, **kwargs)
2724
2725 def GetData(*args, **kwargs):
2726 """
2727 GetData(self) -> PyObject
2728
2729 Returns a string containing a copy of the RGB bytes of the image.
2730 """
2731 return _core_.Image_GetData(*args, **kwargs)
2732
2733 def SetData(*args, **kwargs):
2734 """
2735 SetData(self, buffer data)
2736
2737 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2738 either a string or a buffer object holding the data and the length of
2739 the data must be width*height*3.
2740 """
2741 return _core_.Image_SetData(*args, **kwargs)
2742
2743 def GetDataBuffer(*args, **kwargs):
2744 """
2745 GetDataBuffer(self) -> PyObject
2746
2747 Returns a writable Python buffer object that is pointing at the RGB
2748 image data buffer inside the wx.Image. You need to ensure that you do
2749 not use this buffer object after the image has been destroyed.
2750 """
2751 return _core_.Image_GetDataBuffer(*args, **kwargs)
2752
2753 def SetDataBuffer(*args, **kwargs):
2754 """
2755 SetDataBuffer(self, buffer data)
2756
2757 Sets the internal image data pointer to point at a Python buffer
2758 object. This can save making an extra copy of the data but you must
2759 ensure that the buffer object lives longer than the wx.Image does.
2760 """
2761 return _core_.Image_SetDataBuffer(*args, **kwargs)
2762
2763 def GetAlphaData(*args, **kwargs):
2764 """
2765 GetAlphaData(self) -> PyObject
2766
2767 Returns a string containing a copy of the alpha bytes of the image.
2768 """
2769 return _core_.Image_GetAlphaData(*args, **kwargs)
2770
2771 def SetAlphaData(*args, **kwargs):
2772 """
2773 SetAlphaData(self, buffer alpha)
2774
2775 Resets the Image's alpha data from a buffer of bytes. Accepts either
2776 a string or a buffer object holding the data and the length of the
2777 data must be width*height.
2778 """
2779 return _core_.Image_SetAlphaData(*args, **kwargs)
2780
2781 def GetAlphaBuffer(*args, **kwargs):
2782 """
2783 GetAlphaBuffer(self) -> PyObject
2784
2785 Returns a writable Python buffer object that is pointing at the Alpha
2786 data buffer inside the wx.Image. You need to ensure that you do not
2787 use this buffer object after the image has been destroyed.
2788 """
2789 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2790
2791 def SetAlphaBuffer(*args, **kwargs):
2792 """
2793 SetAlphaBuffer(self, buffer alpha)
2794
2795 Sets the internal image alpha pointer to point at a Python buffer
2796 object. This can save making an extra copy of the data but you must
2797 ensure that the buffer object lives as long as the wx.Image does.
2798 """
2799 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2800
2801 def SetMaskColour(*args, **kwargs):
2802 """
2803 SetMaskColour(self, byte r, byte g, byte b)
2804
2805 Sets the mask colour for this image (and tells the image to use the
2806 mask).
2807 """
2808 return _core_.Image_SetMaskColour(*args, **kwargs)
2809
2810 def GetOrFindMaskColour(*args, **kwargs):
2811 """
2812 GetOrFindMaskColour() -> (r,g,b)
2813
2814 Get the current mask colour or find a suitable colour.
2815 """
2816 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2817
2818 def GetMaskRed(*args, **kwargs):
2819 """
2820 GetMaskRed(self) -> byte
2821
2822 Gets the red component of the mask colour.
2823 """
2824 return _core_.Image_GetMaskRed(*args, **kwargs)
2825
2826 def GetMaskGreen(*args, **kwargs):
2827 """
2828 GetMaskGreen(self) -> byte
2829
2830 Gets the green component of the mask colour.
2831 """
2832 return _core_.Image_GetMaskGreen(*args, **kwargs)
2833
2834 def GetMaskBlue(*args, **kwargs):
2835 """
2836 GetMaskBlue(self) -> byte
2837
2838 Gets the blue component of the mask colour.
2839 """
2840 return _core_.Image_GetMaskBlue(*args, **kwargs)
2841
2842 def SetMask(*args, **kwargs):
2843 """
2844 SetMask(self, bool mask=True)
2845
2846 Specifies whether there is a mask or not. The area of the mask is
2847 determined by the current mask colour.
2848 """
2849 return _core_.Image_SetMask(*args, **kwargs)
2850
2851 def HasMask(*args, **kwargs):
2852 """
2853 HasMask(self) -> bool
2854
2855 Returns ``True`` if there is a mask active, ``False`` otherwise.
2856 """
2857 return _core_.Image_HasMask(*args, **kwargs)
2858
2859 def Rotate(*args, **kwargs):
2860 """
2861 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2862 Point offset_after_rotation=None) -> Image
2863
2864 Rotates the image about the given point, by ``angle`` radians. Passing
2865 ``True`` to ``interpolating`` results in better image quality, but is
2866 slower. If the image has a mask, then the mask colour is used for the
2867 uncovered pixels in the rotated image background. Otherwise, black
2868 will be used as the fill colour.
2869
2870 Returns the rotated image, leaving this image intact.
2871 """
2872 return _core_.Image_Rotate(*args, **kwargs)
2873
2874 def Rotate90(*args, **kwargs):
2875 """
2876 Rotate90(self, bool clockwise=True) -> Image
2877
2878 Returns a copy of the image rotated 90 degrees in the direction
2879 indicated by ``clockwise``.
2880 """
2881 return _core_.Image_Rotate90(*args, **kwargs)
2882
2883 def Mirror(*args, **kwargs):
2884 """
2885 Mirror(self, bool horizontally=True) -> Image
2886
2887 Returns a mirrored copy of the image. The parameter ``horizontally``
2888 indicates the orientation.
2889 """
2890 return _core_.Image_Mirror(*args, **kwargs)
2891
2892 def Replace(*args, **kwargs):
2893 """
2894 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2895
2896 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2897 ``(r2,g2,b2)``.
2898 """
2899 return _core_.Image_Replace(*args, **kwargs)
2900
2901 def ConvertToGreyscale(*args, **kwargs):
2902 """
2903 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2904
2905 Convert to greyscale image. Uses the luminance component (Y) of the
2906 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2907 defaults to ITU-T BT.601
2908 """
2909 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2910
2911 def ConvertToMono(*args, **kwargs):
2912 """
2913 ConvertToMono(self, byte r, byte g, byte b) -> Image
2914
2915 Returns monochromatic version of the image. The returned image has
2916 white colour where the original has ``(r,g,b)`` colour and black
2917 colour everywhere else.
2918 """
2919 return _core_.Image_ConvertToMono(*args, **kwargs)
2920
2921 def SetOption(*args, **kwargs):
2922 """
2923 SetOption(self, String name, String value)
2924
2925 Sets an image handler defined option. For example, when saving as a
2926 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2927 number between 0 and 100 (0 is terrible, 100 is very good).
2928 """
2929 return _core_.Image_SetOption(*args, **kwargs)
2930
2931 def SetOptionInt(*args, **kwargs):
2932 """
2933 SetOptionInt(self, String name, int value)
2934
2935 Sets an image option as an integer.
2936 """
2937 return _core_.Image_SetOptionInt(*args, **kwargs)
2938
2939 def GetOption(*args, **kwargs):
2940 """
2941 GetOption(self, String name) -> String
2942
2943 Gets the value of an image handler option.
2944 """
2945 return _core_.Image_GetOption(*args, **kwargs)
2946
2947 def GetOptionInt(*args, **kwargs):
2948 """
2949 GetOptionInt(self, String name) -> int
2950
2951 Gets the value of an image handler option as an integer. If the given
2952 option is not present, the function returns 0.
2953 """
2954 return _core_.Image_GetOptionInt(*args, **kwargs)
2955
2956 def HasOption(*args, **kwargs):
2957 """
2958 HasOption(self, String name) -> bool
2959
2960 Returns true if the given option is present.
2961 """
2962 return _core_.Image_HasOption(*args, **kwargs)
2963
2964 def CountColours(*args, **kwargs):
2965 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2966 return _core_.Image_CountColours(*args, **kwargs)
2967
2968 def ComputeHistogram(*args, **kwargs):
2969 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2970 return _core_.Image_ComputeHistogram(*args, **kwargs)
2971
2972 def AddHandler(*args, **kwargs):
2973 """AddHandler(ImageHandler handler)"""
2974 return _core_.Image_AddHandler(*args, **kwargs)
2975
2976 AddHandler = staticmethod(AddHandler)
2977 def InsertHandler(*args, **kwargs):
2978 """InsertHandler(ImageHandler handler)"""
2979 return _core_.Image_InsertHandler(*args, **kwargs)
2980
2981 InsertHandler = staticmethod(InsertHandler)
2982 def RemoveHandler(*args, **kwargs):
2983 """RemoveHandler(String name) -> bool"""
2984 return _core_.Image_RemoveHandler(*args, **kwargs)
2985
2986 RemoveHandler = staticmethod(RemoveHandler)
2987 def GetHandlers(*args, **kwargs):
2988 """GetHandlers() -> PyObject"""
2989 return _core_.Image_GetHandlers(*args, **kwargs)
2990
2991 GetHandlers = staticmethod(GetHandlers)
2992 def GetImageExtWildcard(*args, **kwargs):
2993 """
2994 GetImageExtWildcard() -> String
2995
2996 Iterates all registered wxImageHandler objects, and returns a string
2997 containing file extension masks suitable for passing to file open/save
2998 dialog boxes.
2999 """
3000 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3001
3002 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3003 def ConvertToBitmap(*args, **kwargs):
3004 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3005 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3006
3007 def ConvertToMonoBitmap(*args, **kwargs):
3008 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3009 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3010
3011 def RotateHue(*args, **kwargs):
3012 """
3013 RotateHue(self, double angle)
3014
3015 Rotates the hue of each pixel of the image. Hue is a double in the
3016 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3017 """
3018 return _core_.Image_RotateHue(*args, **kwargs)
3019
3020 def RGBtoHSV(*args, **kwargs):
3021 """
3022 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3023
3024 Converts a color in RGB color space to HSV color space.
3025 """
3026 return _core_.Image_RGBtoHSV(*args, **kwargs)
3027
3028 RGBtoHSV = staticmethod(RGBtoHSV)
3029 def HSVtoRGB(*args, **kwargs):
3030 """
3031 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3032
3033 Converts a color in HSV color space to RGB color space.
3034 """
3035 return _core_.Image_HSVtoRGB(*args, **kwargs)
3036
3037 HSVtoRGB = staticmethod(HSVtoRGB)
3038 def __nonzero__(self): return self.IsOk()
3039 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3040 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3041 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3042 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3043 Height = property(GetHeight,doc="See `GetHeight`")
3044 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3045 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3046 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
3047 Width = property(GetWidth,doc="See `GetWidth`")
3048 _core_.Image_swigregister(Image)
3049
3050 def ImageFromMime(*args, **kwargs):
3051 """
3052 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3053
3054 Loads an image from a file, using a MIME type string (such as
3055 'image/jpeg') to specify image type.
3056 """
3057 val = _core_.new_ImageFromMime(*args, **kwargs)
3058 return val
3059
3060 def ImageFromStream(*args, **kwargs):
3061 """
3062 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3063
3064 Loads an image from an input stream, or any readable Python file-like
3065 object.
3066 """
3067 val = _core_.new_ImageFromStream(*args, **kwargs)
3068 return val
3069
3070 def ImageFromStreamMime(*args, **kwargs):
3071 """
3072 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3073
3074 Loads an image from an input stream, or any readable Python file-like
3075 object, specifying the image format with a MIME type string.
3076 """
3077 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3078 return val
3079
3080 def EmptyImage(*args, **kwargs):
3081 """
3082 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3083
3084 Construct an empty image of a given size, optionally setting all
3085 pixels to black.
3086 """
3087 val = _core_.new_EmptyImage(*args, **kwargs)
3088 return val
3089
3090 def ImageFromBitmap(*args, **kwargs):
3091 """
3092 ImageFromBitmap(Bitmap bitmap) -> Image
3093
3094 Construct an Image from a `wx.Bitmap`.
3095 """
3096 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3097 return val
3098
3099 def ImageFromData(*args, **kwargs):
3100 """
3101 ImageFromData(int width, int height, buffer data) -> Image
3102
3103 Construct an Image from a buffer of RGB bytes. Accepts either a
3104 string or a buffer object holding the data and the length of the data
3105 must be width*height*3.
3106 """
3107 val = _core_.new_ImageFromData(*args, **kwargs)
3108 return val
3109
3110 def ImageFromDataWithAlpha(*args, **kwargs):
3111 """
3112 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3113
3114 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3115 Accepts either a string or a buffer object holding the data and the
3116 length of the data must be width*height*3 bytes, and the length of the
3117 alpha data must be width*height bytes.
3118 """
3119 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3120 return val
3121
3122 def Image_CanRead(*args, **kwargs):
3123 """
3124 Image_CanRead(String filename) -> bool
3125
3126 Returns True if the image handlers can read this file.
3127 """
3128 return _core_.Image_CanRead(*args, **kwargs)
3129
3130 def Image_GetImageCount(*args, **kwargs):
3131 """
3132 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3133
3134 If the image file contains more than one image and the image handler
3135 is capable of retrieving these individually, this function will return
3136 the number of available images.
3137 """
3138 return _core_.Image_GetImageCount(*args, **kwargs)
3139
3140 def Image_CanReadStream(*args, **kwargs):
3141 """
3142 Image_CanReadStream(InputStream stream) -> bool
3143
3144 Returns True if the image handlers can read an image file from the
3145 data currently on the input stream, or a readable Python file-like
3146 object.
3147 """
3148 return _core_.Image_CanReadStream(*args, **kwargs)
3149
3150 def Image_AddHandler(*args, **kwargs):
3151 """Image_AddHandler(ImageHandler handler)"""
3152 return _core_.Image_AddHandler(*args, **kwargs)
3153
3154 def Image_InsertHandler(*args, **kwargs):
3155 """Image_InsertHandler(ImageHandler handler)"""
3156 return _core_.Image_InsertHandler(*args, **kwargs)
3157
3158 def Image_RemoveHandler(*args, **kwargs):
3159 """Image_RemoveHandler(String name) -> bool"""
3160 return _core_.Image_RemoveHandler(*args, **kwargs)
3161
3162 def Image_GetHandlers(*args):
3163 """Image_GetHandlers() -> PyObject"""
3164 return _core_.Image_GetHandlers(*args)
3165
3166 def Image_GetImageExtWildcard(*args):
3167 """
3168 Image_GetImageExtWildcard() -> String
3169
3170 Iterates all registered wxImageHandler objects, and returns a string
3171 containing file extension masks suitable for passing to file open/save
3172 dialog boxes.
3173 """
3174 return _core_.Image_GetImageExtWildcard(*args)
3175
3176 def Image_RGBtoHSV(*args, **kwargs):
3177 """
3178 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3179
3180 Converts a color in RGB color space to HSV color space.
3181 """
3182 return _core_.Image_RGBtoHSV(*args, **kwargs)
3183
3184 def Image_HSVtoRGB(*args, **kwargs):
3185 """
3186 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3187
3188 Converts a color in HSV color space to RGB color space.
3189 """
3190 return _core_.Image_HSVtoRGB(*args, **kwargs)
3191
3192
3193 def _ImageFromBuffer(*args, **kwargs):
3194 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3195 return _core_._ImageFromBuffer(*args, **kwargs)
3196 def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3197 """
3198 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3199 parameter must be a Python object that implements the buffer interface,
3200 such as a string, array, etc. The dataBuffer object is expected to
3201 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3202 object can optionally be supplied for the image's alpha channel data, and
3203 it is expected to be width*height bytes long.
3204
3205 The wx.Image will be created with its data and alpha pointers initialized
3206 to the memory address pointed to by the buffer objects, thus saving the
3207 time needed to copy the image data from the buffer object to the wx.Image.
3208 While this has advantages, it also has the shoot-yourself-in-the-foot
3209 risks associated with sharing a C pointer between two objects.
3210
3211 To help alleviate the risk a reference to the data and alpha buffer
3212 objects are kept with the wx.Image, so that they won't get deleted until
3213 after the wx.Image is deleted. However please be aware that it is not
3214 guaranteed that an object won't move its memory buffer to a new location
3215 when it needs to resize its contents. If that happens then the wx.Image
3216 will end up referring to an invalid memory location and could cause the
3217 application to crash. Therefore care should be taken to not manipulate
3218 the objects used for the data and alpha buffers in a way that would cause
3219 them to change size.
3220 """
3221 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3222 image._buffer = dataBuffer
3223 image._alpha = alphaBuffer
3224 return image
3225
3226 def InitAllImageHandlers():
3227 """
3228 The former functionality of InitAllImageHanders is now done internal to
3229 the _core_ extension module and so this function has become a simple NOP.
3230 """
3231 pass
3232
3233 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3234 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3235 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3236 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3237 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3238 BMP_24BPP = _core_.BMP_24BPP
3239 BMP_8BPP = _core_.BMP_8BPP
3240 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3241 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3242 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3243 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3244 BMP_4BPP = _core_.BMP_4BPP
3245 BMP_1BPP = _core_.BMP_1BPP
3246 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3247 class BMPHandler(ImageHandler):
3248 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3249 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3250 __repr__ = _swig_repr
3251 def __init__(self, *args, **kwargs):
3252 """
3253 __init__(self) -> BMPHandler
3254
3255 A `wx.ImageHandler` for \*.bmp bitmap files.
3256 """
3257 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3258 _core_.BMPHandler_swigregister(BMPHandler)
3259 NullImage = cvar.NullImage
3260 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3261 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3262 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3263 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3264 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3265 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3266 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3267 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3268 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3269 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3270 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3271 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3272 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3273 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3274 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3275
3276 class ICOHandler(BMPHandler):
3277 """A `wx.ImageHandler` for \*.ico icon files."""
3278 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3279 __repr__ = _swig_repr
3280 def __init__(self, *args, **kwargs):
3281 """
3282 __init__(self) -> ICOHandler
3283
3284 A `wx.ImageHandler` for \*.ico icon files.
3285 """
3286 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3287 _core_.ICOHandler_swigregister(ICOHandler)
3288
3289 class CURHandler(ICOHandler):
3290 """A `wx.ImageHandler` for \*.cur cursor files."""
3291 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3292 __repr__ = _swig_repr
3293 def __init__(self, *args, **kwargs):
3294 """
3295 __init__(self) -> CURHandler
3296
3297 A `wx.ImageHandler` for \*.cur cursor files.
3298 """
3299 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3300 _core_.CURHandler_swigregister(CURHandler)
3301
3302 class ANIHandler(CURHandler):
3303 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3304 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3305 __repr__ = _swig_repr
3306 def __init__(self, *args, **kwargs):
3307 """
3308 __init__(self) -> ANIHandler
3309
3310 A `wx.ImageHandler` for \*.ani animated cursor files.
3311 """
3312 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3313 _core_.ANIHandler_swigregister(ANIHandler)
3314
3315 class PNGHandler(ImageHandler):
3316 """A `wx.ImageHandler` for PNG image files."""
3317 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3318 __repr__ = _swig_repr
3319 def __init__(self, *args, **kwargs):
3320 """
3321 __init__(self) -> PNGHandler
3322
3323 A `wx.ImageHandler` for PNG image files.
3324 """
3325 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3326 _core_.PNGHandler_swigregister(PNGHandler)
3327
3328 class GIFHandler(ImageHandler):
3329 """A `wx.ImageHandler` for GIF image files."""
3330 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3331 __repr__ = _swig_repr
3332 def __init__(self, *args, **kwargs):
3333 """
3334 __init__(self) -> GIFHandler
3335
3336 A `wx.ImageHandler` for GIF image files.
3337 """
3338 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3339 _core_.GIFHandler_swigregister(GIFHandler)
3340
3341 class PCXHandler(ImageHandler):
3342 """A `wx.ImageHandler` for PCX imager files."""
3343 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3344 __repr__ = _swig_repr
3345 def __init__(self, *args, **kwargs):
3346 """
3347 __init__(self) -> PCXHandler
3348
3349 A `wx.ImageHandler` for PCX imager files.
3350 """
3351 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3352 _core_.PCXHandler_swigregister(PCXHandler)
3353
3354 class JPEGHandler(ImageHandler):
3355 """A `wx.ImageHandler` for JPEG/JPG image files."""
3356 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3357 __repr__ = _swig_repr
3358 def __init__(self, *args, **kwargs):
3359 """
3360 __init__(self) -> JPEGHandler
3361
3362 A `wx.ImageHandler` for JPEG/JPG image files.
3363 """
3364 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3365 _core_.JPEGHandler_swigregister(JPEGHandler)
3366
3367 class PNMHandler(ImageHandler):
3368 """A `wx.ImageHandler` for PNM image files."""
3369 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3370 __repr__ = _swig_repr
3371 def __init__(self, *args, **kwargs):
3372 """
3373 __init__(self) -> PNMHandler
3374
3375 A `wx.ImageHandler` for PNM image files.
3376 """
3377 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3378 _core_.PNMHandler_swigregister(PNMHandler)
3379
3380 class XPMHandler(ImageHandler):
3381 """A `wx.ImageHandler` for XPM image."""
3382 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3383 __repr__ = _swig_repr
3384 def __init__(self, *args, **kwargs):
3385 """
3386 __init__(self) -> XPMHandler
3387
3388 A `wx.ImageHandler` for XPM image.
3389 """
3390 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3391 _core_.XPMHandler_swigregister(XPMHandler)
3392
3393 class TIFFHandler(ImageHandler):
3394 """A `wx.ImageHandler` for TIFF image files."""
3395 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3396 __repr__ = _swig_repr
3397 def __init__(self, *args, **kwargs):
3398 """
3399 __init__(self) -> TIFFHandler
3400
3401 A `wx.ImageHandler` for TIFF image files.
3402 """
3403 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3404 _core_.TIFFHandler_swigregister(TIFFHandler)
3405
3406 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3407 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3408 class Quantize(object):
3409 """Performs quantization, or colour reduction, on a wxImage."""
3410 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3411 def __init__(self): raise AttributeError, "No constructor defined"
3412 __repr__ = _swig_repr
3413 def Quantize(*args, **kwargs):
3414 """
3415 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3416
3417 Reduce the colours in the source image and put the result into the
3418 destination image, setting the palette in the destination if
3419 needed. Both images may be the same, to overwrite the source image.
3420 """
3421 return _core_.Quantize_Quantize(*args, **kwargs)
3422
3423 Quantize = staticmethod(Quantize)
3424 _core_.Quantize_swigregister(Quantize)
3425
3426 def Quantize_Quantize(*args, **kwargs):
3427 """
3428 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3429
3430 Reduce the colours in the source image and put the result into the
3431 destination image, setting the palette in the destination if
3432 needed. Both images may be the same, to overwrite the source image.
3433 """
3434 return _core_.Quantize_Quantize(*args, **kwargs)
3435
3436 #---------------------------------------------------------------------------
3437
3438 class EvtHandler(Object):
3439 """Proxy of C++ EvtHandler class"""
3440 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3441 __repr__ = _swig_repr
3442 def __init__(self, *args, **kwargs):
3443 """__init__(self) -> EvtHandler"""
3444 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3445 self._setOORInfo(self)
3446
3447 def GetNextHandler(*args, **kwargs):
3448 """GetNextHandler(self) -> EvtHandler"""
3449 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3450
3451 def GetPreviousHandler(*args, **kwargs):
3452 """GetPreviousHandler(self) -> EvtHandler"""
3453 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3454
3455 def SetNextHandler(*args, **kwargs):
3456 """SetNextHandler(self, EvtHandler handler)"""
3457 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3458
3459 def SetPreviousHandler(*args, **kwargs):
3460 """SetPreviousHandler(self, EvtHandler handler)"""
3461 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3462
3463 def GetEvtHandlerEnabled(*args, **kwargs):
3464 """GetEvtHandlerEnabled(self) -> bool"""
3465 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3466
3467 def SetEvtHandlerEnabled(*args, **kwargs):
3468 """SetEvtHandlerEnabled(self, bool enabled)"""
3469 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3470
3471 def ProcessEvent(*args, **kwargs):
3472 """ProcessEvent(self, Event event) -> bool"""
3473 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3474
3475 def AddPendingEvent(*args, **kwargs):
3476 """AddPendingEvent(self, Event event)"""
3477 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3478
3479 def ProcessPendingEvents(*args, **kwargs):
3480 """ProcessPendingEvents(self)"""
3481 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3482
3483 def AllowReentrance(*args, **kwargs):
3484 """AllowReentrance(self, bool allow=True)"""
3485 return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
3486
3487 def IsReentranceAllowed(*args, **kwargs):
3488 """IsReentranceAllowed(self) -> bool"""
3489 return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
3490
3491 def IsEventHandlingInProgress(*args, **kwargs):
3492 """IsEventHandlingInProgress(self) -> bool"""
3493 return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
3494
3495 def Connect(*args, **kwargs):
3496 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3497 return _core_.EvtHandler_Connect(*args, **kwargs)
3498
3499 def Disconnect(*args, **kwargs):
3500 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3501 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3502
3503 def _setOORInfo(*args, **kwargs):
3504 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3505 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3506 args[0].thisown = 0
3507 return val
3508
3509 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3510 """
3511 Bind an event to an event handler.
3512
3513 :param event: One of the EVT_* objects that specifies the
3514 type of event to bind,
3515
3516 :param handler: A callable object to be invoked when the
3517 event is delivered to self. Pass None to
3518 disconnect an event handler.
3519
3520 :param source: Sometimes the event originates from a
3521 different window than self, but you still
3522 want to catch it in self. (For example, a
3523 button event delivered to a frame.) By
3524 passing the source of the event, the event
3525 handling system is able to differentiate
3526 between the same event type from different
3527 controls.
3528
3529 :param id: Used to spcify the event source by ID instead
3530 of instance.
3531
3532 :param id2: Used when it is desirable to bind a handler
3533 to a range of IDs, such as with EVT_MENU_RANGE.
3534 """
3535 if source is not None:
3536 id = source.GetId()
3537 event.Bind(self, id, id2, handler)
3538
3539 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3540 """
3541 Disconencts the event handler binding for event from self.
3542 Returns True if successful.
3543 """
3544 if source is not None:
3545 id = source.GetId()
3546 return event.Unbind(self, id, id2)
3547
3548 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3549 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3550 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3551 _core_.EvtHandler_swigregister(EvtHandler)
3552
3553 #---------------------------------------------------------------------------
3554
3555 class PyEventBinder(object):
3556 """
3557 Instances of this class are used to bind specific events to event
3558 handlers.
3559 """
3560 def __init__(self, evtType, expectedIDs=0):
3561 if expectedIDs not in [0, 1, 2]:
3562 raise ValueError, "Invalid number of expectedIDs"
3563 self.expectedIDs = expectedIDs
3564
3565 if type(evtType) == list or type(evtType) == tuple:
3566 self.evtType = evtType
3567 else:
3568 self.evtType = [evtType]
3569
3570
3571 def Bind(self, target, id1, id2, function):
3572 """Bind this set of event types to target."""
3573 for et in self.evtType:
3574 target.Connect(id1, id2, et, function)
3575
3576
3577 def Unbind(self, target, id1, id2):
3578 """Remove an event binding."""
3579 success = 0
3580 for et in self.evtType:
3581 success += target.Disconnect(id1, id2, et)
3582 return success != 0
3583
3584
3585 def __call__(self, *args):
3586 """
3587 For backwards compatibility with the old EVT_* functions.
3588 Should be called with either (window, func), (window, ID,
3589 func) or (window, ID1, ID2, func) parameters depending on the
3590 type of the event.
3591 """
3592 assert len(args) == 2 + self.expectedIDs
3593 id1 = wx.ID_ANY
3594 id2 = wx.ID_ANY
3595 target = args[0]
3596 if self.expectedIDs == 0:
3597 func = args[1]
3598 elif self.expectedIDs == 1:
3599 id1 = args[1]
3600 func = args[2]
3601 elif self.expectedIDs == 2:
3602 id1 = args[1]
3603 id2 = args[2]
3604 func = args[3]
3605 else:
3606 raise ValueError, "Unexpected number of IDs"
3607
3608 self.Bind(target, id1, id2, func)
3609
3610
3611 # These two are square pegs that don't fit the PyEventBinder hole...
3612 def EVT_COMMAND(win, id, cmd, func):
3613 win.Connect(id, -1, cmd, func)
3614 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3615 win.Connect(id1, id2, cmd, func)
3616
3617
3618 #---------------------------------------------------------------------------
3619
3620 #---------------------------------------------------------------------------
3621
3622 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3623 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3624
3625 def NewEventType(*args):
3626 """NewEventType() -> EventType"""
3627 return _core_.NewEventType(*args)
3628 wxEVT_NULL = _core_.wxEVT_NULL
3629 wxEVT_FIRST = _core_.wxEVT_FIRST
3630 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3631 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3632 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3633 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3634 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3635 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3636 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3637 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3638 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3639 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3640 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3641 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3642 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3643 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3644 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3645 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3646 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3647 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3648 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3649 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3650 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3651 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3652 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3653 wxEVT_MOTION = _core_.wxEVT_MOTION
3654 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3655 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3656 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3657 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3658 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3659 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3660 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3661 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3662 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3663 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3664 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3665 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3666 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3667 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3668 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3669 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3670 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3671 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3672 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3673 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3674 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3675 wxEVT_CHAR = _core_.wxEVT_CHAR
3676 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3677 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3678 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3679 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3680 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3681 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3682 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3683 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3684 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3685 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3686 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3687 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3688 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3689 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3690 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3691 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3692 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3693 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3694 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3695 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3696 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3697 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3698 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3699 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3700 wxEVT_SIZE = _core_.wxEVT_SIZE
3701 wxEVT_MOVE = _core_.wxEVT_MOVE
3702 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3703 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3704 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3705 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3706 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3707 wxEVT_CREATE = _core_.wxEVT_CREATE
3708 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3709 wxEVT_SHOW = _core_.wxEVT_SHOW
3710 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3711 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3712 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3713 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3714 wxEVT_PAINT = _core_.wxEVT_PAINT
3715 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3716 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3717 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3718 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3719 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3720 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3721 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3722 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3723 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3724 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3725 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3726 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3727 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3728 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3729 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3730 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3731 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3732 wxEVT_IDLE = _core_.wxEVT_IDLE
3733 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3734 wxEVT_SIZING = _core_.wxEVT_SIZING
3735 wxEVT_MOVING = _core_.wxEVT_MOVING
3736 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
3737 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3738 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3739 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
3740 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3741 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3742 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3743 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3744 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3745 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3746 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3747 #
3748 # Create some event binders
3749 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3750 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3751 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3752 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3753 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3754 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3755 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3756 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3757 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3758 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3759 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3760 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3761 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3762 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3763 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3764 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3765 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3766 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3767 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3768 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3769 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3770 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3771 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3772 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3773 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
3774 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3775 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3776 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3777 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3778 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3779 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3780 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3781 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3782 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3783 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3784 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3785 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3786 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3787 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3788 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3789 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3790 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
3791
3792 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3793 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3794 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3795 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3796 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3797 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3798 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3799 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3800 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3801 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3802 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3803 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3804 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3805
3806 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3807 wxEVT_LEFT_UP,
3808 wxEVT_MIDDLE_DOWN,
3809 wxEVT_MIDDLE_UP,
3810 wxEVT_RIGHT_DOWN,
3811 wxEVT_RIGHT_UP,
3812 wxEVT_MOTION,
3813 wxEVT_LEFT_DCLICK,
3814 wxEVT_MIDDLE_DCLICK,
3815 wxEVT_RIGHT_DCLICK,
3816 wxEVT_ENTER_WINDOW,
3817 wxEVT_LEAVE_WINDOW,
3818 wxEVT_MOUSEWHEEL
3819 ])
3820
3821
3822 # Scrolling from wxWindow (sent to wxScrolledWindow)
3823 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3824 wxEVT_SCROLLWIN_BOTTOM,
3825 wxEVT_SCROLLWIN_LINEUP,
3826 wxEVT_SCROLLWIN_LINEDOWN,
3827 wxEVT_SCROLLWIN_PAGEUP,
3828 wxEVT_SCROLLWIN_PAGEDOWN,
3829 wxEVT_SCROLLWIN_THUMBTRACK,
3830 wxEVT_SCROLLWIN_THUMBRELEASE,
3831 ])
3832
3833 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3834 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3835 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3836 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3837 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3838 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3839 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3840 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3841
3842 # Scrolling from wx.Slider and wx.ScrollBar
3843 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3844 wxEVT_SCROLL_BOTTOM,
3845 wxEVT_SCROLL_LINEUP,
3846 wxEVT_SCROLL_LINEDOWN,
3847 wxEVT_SCROLL_PAGEUP,
3848 wxEVT_SCROLL_PAGEDOWN,
3849 wxEVT_SCROLL_THUMBTRACK,
3850 wxEVT_SCROLL_THUMBRELEASE,
3851 wxEVT_SCROLL_CHANGED,
3852 ])
3853
3854 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3855 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3856 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3857 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3858 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3859 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3860 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3861 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3862 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3863 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3864
3865 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3866 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3867 wxEVT_SCROLL_BOTTOM,
3868 wxEVT_SCROLL_LINEUP,
3869 wxEVT_SCROLL_LINEDOWN,
3870 wxEVT_SCROLL_PAGEUP,
3871 wxEVT_SCROLL_PAGEDOWN,
3872 wxEVT_SCROLL_THUMBTRACK,
3873 wxEVT_SCROLL_THUMBRELEASE,
3874 wxEVT_SCROLL_CHANGED,
3875 ], 1)
3876
3877 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3878 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3879 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3880 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3881 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3882 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3883 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3884 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3885 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3886 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
3887
3888 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3889 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3890 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3891 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3892 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3893 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3894 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3895 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3896 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3897 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3898
3899 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3900 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3901 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3902 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3903 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3904 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3905 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3906 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3907 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3908
3909
3910 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3911 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3912 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3913 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3914 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3915 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3916 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3917
3918 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3919
3920 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3921 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3922
3923 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3924
3925 EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3926 EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3927 EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
3928
3929
3930 #---------------------------------------------------------------------------
3931
3932 class Event(Object):
3933 """
3934 An event is a structure holding information about an event passed to a
3935 callback or member function. wx.Event is an abstract base class for
3936 other event classes
3937 """
3938 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3939 def __init__(self): raise AttributeError, "No constructor defined"
3940 __repr__ = _swig_repr
3941 __swig_destroy__ = _core_.delete_Event
3942 __del__ = lambda self : None;
3943 def SetEventType(*args, **kwargs):
3944 """
3945 SetEventType(self, EventType typ)
3946
3947 Sets the specific type of the event.
3948 """
3949 return _core_.Event_SetEventType(*args, **kwargs)
3950
3951 def GetEventType(*args, **kwargs):
3952 """
3953 GetEventType(self) -> EventType
3954
3955 Returns the identifier of the given event type, such as
3956 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3957 """
3958 return _core_.Event_GetEventType(*args, **kwargs)
3959
3960 def GetEventObject(*args, **kwargs):
3961 """
3962 GetEventObject(self) -> Object
3963
3964 Returns the object (usually a window) associated with the event, if
3965 any.
3966 """
3967 return _core_.Event_GetEventObject(*args, **kwargs)
3968
3969 def SetEventObject(*args, **kwargs):
3970 """
3971 SetEventObject(self, Object obj)
3972
3973 Sets the originating object, or in other words, obj is normally the
3974 object that is sending the event.
3975 """
3976 return _core_.Event_SetEventObject(*args, **kwargs)
3977
3978 def GetTimestamp(*args, **kwargs):
3979 """GetTimestamp(self) -> long"""
3980 return _core_.Event_GetTimestamp(*args, **kwargs)
3981
3982 def SetTimestamp(*args, **kwargs):
3983 """SetTimestamp(self, long ts=0)"""
3984 return _core_.Event_SetTimestamp(*args, **kwargs)
3985
3986 def GetId(*args, **kwargs):
3987 """
3988 GetId(self) -> int
3989
3990 Returns the identifier associated with this event, such as a button
3991 command id.
3992 """
3993 return _core_.Event_GetId(*args, **kwargs)
3994
3995 def SetId(*args, **kwargs):
3996 """
3997 SetId(self, int Id)
3998
3999 Set's the ID for the event. This is usually the ID of the window that
4000 is sending the event, but it can also be a command id from a menu
4001 item, etc.
4002 """
4003 return _core_.Event_SetId(*args, **kwargs)
4004
4005 def IsCommandEvent(*args, **kwargs):
4006 """
4007 IsCommandEvent(self) -> bool
4008
4009 Returns true if the event is or is derived from `wx.CommandEvent` else
4010 it returns false. Note: Exists only for optimization purposes.
4011 """
4012 return _core_.Event_IsCommandEvent(*args, **kwargs)
4013
4014 def Skip(*args, **kwargs):
4015 """
4016 Skip(self, bool skip=True)
4017
4018 This method can be used inside an event handler to control whether
4019 further event handlers bound to this event will be called after the
4020 current one returns. Without Skip() (or equivalently if Skip(False) is
4021 used), the event will not be processed any more. If Skip(True) is
4022 called, the event processing system continues searching for a further
4023 handler function for this event, even though it has been processed
4024 already in the current handler.
4025 """
4026 return _core_.Event_Skip(*args, **kwargs)
4027
4028 def GetSkipped(*args, **kwargs):
4029 """
4030 GetSkipped(self) -> bool
4031
4032 Returns true if the event handler should be skipped, false otherwise.
4033 :see: `Skip`
4034 """
4035 return _core_.Event_GetSkipped(*args, **kwargs)
4036
4037 def ShouldPropagate(*args, **kwargs):
4038 """
4039 ShouldPropagate(self) -> bool
4040
4041 Test if this event should be propagated to the parent window or not,
4042 i.e. if the propagation level is currently greater than 0.
4043 """
4044 return _core_.Event_ShouldPropagate(*args, **kwargs)
4045
4046 def StopPropagation(*args, **kwargs):
4047 """
4048 StopPropagation(self) -> int
4049
4050 Stop the event from propagating to its parent window. Returns the old
4051 propagation level value which may be later passed to
4052 `ResumePropagation` to allow propagating the event again.
4053 """
4054 return _core_.Event_StopPropagation(*args, **kwargs)
4055
4056 def ResumePropagation(*args, **kwargs):
4057 """
4058 ResumePropagation(self, int propagationLevel)
4059
4060 Resume the event propagation by restoring the propagation level. (For
4061 example, you can use the value returned by an earlier call to
4062 `StopPropagation`.)
4063
4064 """
4065 return _core_.Event_ResumePropagation(*args, **kwargs)
4066
4067 def Clone(*args, **kwargs):
4068 """Clone(self) -> Event"""
4069 return _core_.Event_Clone(*args, **kwargs)
4070
4071 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4072 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4073 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4074 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4075 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
4076 _core_.Event_swigregister(Event)
4077
4078 #---------------------------------------------------------------------------
4079
4080 class PropagationDisabler(object):
4081 """
4082 Helper class to temporarily change an event not to propagate. Simply
4083 create an instance of this class and then whe it is destroyed the
4084 propogation of the event will be restored.
4085 """
4086 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4087 __repr__ = _swig_repr
4088 def __init__(self, *args, **kwargs):
4089 """
4090 __init__(self, Event event) -> PropagationDisabler
4091
4092 Helper class to temporarily change an event not to propagate. Simply
4093 create an instance of this class and then whe it is destroyed the
4094 propogation of the event will be restored.
4095 """
4096 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4097 __swig_destroy__ = _core_.delete_PropagationDisabler
4098 __del__ = lambda self : None;
4099 _core_.PropagationDisabler_swigregister(PropagationDisabler)
4100
4101 class PropagateOnce(object):
4102 """
4103 A helper class that will temporarily lower propagation level of an
4104 event. Simply create an instance of this class and then whe it is
4105 destroyed the propogation of the event will be restored.
4106 """
4107 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4108 __repr__ = _swig_repr
4109 def __init__(self, *args, **kwargs):
4110 """
4111 __init__(self, Event event) -> PropagateOnce
4112
4113 A helper class that will temporarily lower propagation level of an
4114 event. Simply create an instance of this class and then whe it is
4115 destroyed the propogation of the event will be restored.
4116 """
4117 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4118 __swig_destroy__ = _core_.delete_PropagateOnce
4119 __del__ = lambda self : None;
4120 _core_.PropagateOnce_swigregister(PropagateOnce)
4121
4122 #---------------------------------------------------------------------------
4123
4124 class CommandEvent(Event):
4125 """
4126 This event class contains information about command events, which
4127 originate from a variety of simple controls, as well as menus and
4128 toolbars.
4129 """
4130 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4131 __repr__ = _swig_repr
4132 def __init__(self, *args, **kwargs):
4133 """
4134 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4135
4136 This event class contains information about command events, which
4137 originate from a variety of simple controls, as well as menus and
4138 toolbars.
4139 """
4140 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4141 def GetSelection(*args, **kwargs):
4142 """
4143 GetSelection(self) -> int
4144
4145 Returns item index for a listbox or choice selection event (not valid
4146 for a deselection).
4147 """
4148 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4149
4150 def SetString(*args, **kwargs):
4151 """SetString(self, String s)"""
4152 return _core_.CommandEvent_SetString(*args, **kwargs)
4153
4154 def GetString(*args, **kwargs):
4155 """
4156 GetString(self) -> String
4157
4158 Returns item string for a listbox or choice selection event (not valid
4159 for a deselection).
4160 """
4161 return _core_.CommandEvent_GetString(*args, **kwargs)
4162
4163 def IsChecked(*args, **kwargs):
4164 """
4165 IsChecked(self) -> bool
4166
4167 This method can be used with checkbox and menu events: for the
4168 checkboxes, the method returns true for a selection event and false
4169 for a deselection one. For the menu events, this method indicates if
4170 the menu item just has become checked or unchecked (and thus only
4171 makes sense for checkable menu items).
4172 """
4173 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4174
4175 Checked = IsChecked
4176 def IsSelection(*args, **kwargs):
4177 """
4178 IsSelection(self) -> bool
4179
4180 For a listbox or similar event, returns true if it is a selection,
4181 false if it is a deselection.
4182 """
4183 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4184
4185 def SetExtraLong(*args, **kwargs):
4186 """SetExtraLong(self, long extraLong)"""
4187 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4188
4189 def GetExtraLong(*args, **kwargs):
4190 """
4191 GetExtraLong(self) -> long
4192
4193 Returns extra information dependant on the event objects type. If the
4194 event comes from a listbox selection, it is a boolean determining
4195 whether the event was a selection (true) or a deselection (false). A
4196 listbox deselection only occurs for multiple-selection boxes, and in
4197 this case the index and string values are indeterminate and the
4198 listbox must be examined by the application.
4199 """
4200 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4201
4202 def SetInt(*args, **kwargs):
4203 """SetInt(self, int i)"""
4204 return _core_.CommandEvent_SetInt(*args, **kwargs)
4205
4206 def GetInt(*args, **kwargs):
4207 """
4208 GetInt(self) -> int
4209
4210 Returns the integer identifier corresponding to a listbox, choice or
4211 radiobox selection (only if the event was a selection, not a
4212 deselection), or a boolean value representing the value of a checkbox.
4213 """
4214 return _core_.CommandEvent_GetInt(*args, **kwargs)
4215
4216 def GetClientData(*args, **kwargs):
4217 """
4218 GetClientData(self) -> PyObject
4219
4220 Returns the client data object for a listbox or choice selection event, (if any.)
4221 """
4222 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4223
4224 def SetClientData(*args, **kwargs):
4225 """
4226 SetClientData(self, PyObject clientData)
4227
4228 Associate the given client data with the item at position n.
4229 """
4230 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4231
4232 GetClientObject = GetClientData
4233 SetClientObject = SetClientData
4234
4235 def Clone(*args, **kwargs):
4236 """Clone(self) -> Event"""
4237 return _core_.CommandEvent_Clone(*args, **kwargs)
4238
4239 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4240 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4241 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4242 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4243 Selection = property(GetSelection,doc="See `GetSelection`")
4244 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4245 _core_.CommandEvent_swigregister(CommandEvent)
4246
4247 #---------------------------------------------------------------------------
4248
4249 class NotifyEvent(CommandEvent):
4250 """
4251 An instance of this class (or one of its derived classes) is sent from
4252 a control when the control's state is being changed and the control
4253 allows that change to be prevented from happening. The event handler
4254 can call `Veto` or `Allow` to tell the control what to do.
4255 """
4256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4257 __repr__ = _swig_repr
4258 def __init__(self, *args, **kwargs):
4259 """
4260 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4261
4262 An instance of this class (or one of its derived classes) is sent from
4263 a control when the control's state is being changed and the control
4264 allows that change to be prevented from happening. The event handler
4265 can call `Veto` or `Allow` to tell the control what to do.
4266 """
4267 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4268 def Veto(*args, **kwargs):
4269 """
4270 Veto(self)
4271
4272 Prevents the change announced by this event from happening.
4273
4274 It is in general a good idea to notify the user about the reasons for
4275 vetoing the change because otherwise the applications behaviour (which
4276 just refuses to do what the user wants) might be quite surprising.
4277 """
4278 return _core_.NotifyEvent_Veto(*args, **kwargs)
4279
4280 def Allow(*args, **kwargs):
4281 """
4282 Allow(self)
4283
4284 This is the opposite of `Veto`: it explicitly allows the event to be
4285 processed. For most events it is not necessary to call this method as
4286 the events are allowed anyhow but some are forbidden by default (this
4287 will be mentioned in the corresponding event description).
4288 """
4289 return _core_.NotifyEvent_Allow(*args, **kwargs)
4290
4291 def IsAllowed(*args, **kwargs):
4292 """
4293 IsAllowed(self) -> bool
4294
4295 Returns true if the change is allowed (`Veto` hasn't been called) or
4296 false otherwise (if it was).
4297 """
4298 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4299
4300 _core_.NotifyEvent_swigregister(NotifyEvent)
4301
4302 #---------------------------------------------------------------------------
4303
4304 class ScrollEvent(CommandEvent):
4305 """
4306 A scroll event holds information about events sent from stand-alone
4307 scrollbars and sliders. Note that scrolled windows do not send
4308 instnaces of this event class, but send the `wx.ScrollWinEvent`
4309 instead.
4310 """
4311 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4312 __repr__ = _swig_repr
4313 def __init__(self, *args, **kwargs):
4314 """
4315 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4316 int orient=0) -> ScrollEvent
4317 """
4318 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4319 def GetOrientation(*args, **kwargs):
4320 """
4321 GetOrientation(self) -> int
4322
4323 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4324 the scrollbar.
4325 """
4326 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4327
4328 def GetPosition(*args, **kwargs):
4329 """
4330 GetPosition(self) -> int
4331
4332 Returns the position of the scrollbar.
4333 """
4334 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4335
4336 def SetOrientation(*args, **kwargs):
4337 """SetOrientation(self, int orient)"""
4338 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4339
4340 def SetPosition(*args, **kwargs):
4341 """SetPosition(self, int pos)"""
4342 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4343
4344 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4345 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4346 _core_.ScrollEvent_swigregister(ScrollEvent)
4347
4348 #---------------------------------------------------------------------------
4349
4350 class ScrollWinEvent(Event):
4351 """
4352 A wx.ScrollWinEvent holds information about scrolling and is sent from
4353 scrolling windows.
4354 """
4355 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4356 __repr__ = _swig_repr
4357 def __init__(self, *args, **kwargs):
4358 """
4359 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4360
4361 A wx.ScrollWinEvent holds information about scrolling and is sent from
4362 scrolling windows.
4363 """
4364 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4365 def GetOrientation(*args, **kwargs):
4366 """
4367 GetOrientation(self) -> int
4368
4369 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4370 the scrollbar.
4371 """
4372 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4373
4374 def GetPosition(*args, **kwargs):
4375 """
4376 GetPosition(self) -> int
4377
4378 Returns the position of the scrollbar for the thumb track and release
4379 events. Note that this field can't be used for the other events, you
4380 need to query the window itself for the current position in that case.
4381 """
4382 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4383
4384 def SetOrientation(*args, **kwargs):
4385 """SetOrientation(self, int orient)"""
4386 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4387
4388 def SetPosition(*args, **kwargs):
4389 """SetPosition(self, int pos)"""
4390 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4391
4392 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4393 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4394 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4395
4396 #---------------------------------------------------------------------------
4397
4398 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4399 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4400 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4401 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4402 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4403 class MouseEvent(Event):
4404 """
4405 This event class contains information about the events generated by
4406 the mouse: they include mouse buttons press and release events and
4407 mouse move events.
4408
4409 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4410 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4411 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4412 a middle button so a portable application should avoid relying on the
4413 events from it.
4414
4415 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4416 the former returns true when the event corresponds to the left mouse
4417 button click while the latter returns true if the left mouse button is
4418 currently being pressed. For example, when the user is dragging the
4419 mouse you can use `LeftIsDown` to test whether the left mouse button
4420 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4421 `LeftIsDown` will also return true in wxWidgets whatever the
4422 underlying GUI behaviour is (which is platform-dependent). The same
4423 applies, of course, to other mouse buttons as well.
4424 """
4425 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4426 __repr__ = _swig_repr
4427 def __init__(self, *args, **kwargs):
4428 """
4429 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4430
4431 Constructs a wx.MouseEvent. Valid event types are:
4432
4433 * wxEVT_ENTER_WINDOW
4434 * wxEVT_LEAVE_WINDOW
4435 * wxEVT_LEFT_DOWN
4436 * wxEVT_LEFT_UP
4437 * wxEVT_LEFT_DCLICK
4438 * wxEVT_MIDDLE_DOWN
4439 * wxEVT_MIDDLE_UP
4440 * wxEVT_MIDDLE_DCLICK
4441 * wxEVT_RIGHT_DOWN
4442 * wxEVT_RIGHT_UP
4443 * wxEVT_RIGHT_DCLICK
4444 * wxEVT_MOTION
4445 * wxEVT_MOUSEWHEEL
4446 """
4447 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4448 def IsButton(*args, **kwargs):
4449 """
4450 IsButton(self) -> bool
4451
4452 Returns true if the event was a mouse button event (not necessarily a
4453 button down event - that may be tested using `ButtonDown`).
4454 """
4455 return _core_.MouseEvent_IsButton(*args, **kwargs)
4456
4457 def ButtonDown(*args, **kwargs):
4458 """
4459 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4460
4461 If the argument is omitted, this returns true if the event was any
4462 mouse button down event. Otherwise the argument specifies which
4463 button-down event shold be checked for (see `Button` for the possible
4464 values).
4465 """
4466 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4467
4468 def ButtonDClick(*args, **kwargs):
4469 """
4470 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4471
4472 If the argument is omitted, this returns true if the event was any
4473 mouse double click event. Otherwise the argument specifies which
4474 double click event to check for (see `Button` for the possible
4475 values).
4476 """
4477 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4478
4479 def ButtonUp(*args, **kwargs):
4480 """
4481 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4482
4483 If the argument is omitted, this returns true if the event was any
4484 mouse button up event. Otherwise the argument specifies which button
4485 up event to check for (see `Button` for the possible values).
4486 """
4487 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4488
4489 def Button(*args, **kwargs):
4490 """
4491 Button(self, int button) -> bool
4492
4493 Returns true if the identified mouse button is changing state. Valid
4494 values of button are:
4495
4496 ==================== =====================================
4497 wx.MOUSE_BTN_LEFT check if left button was pressed
4498 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4499 wx.MOUSE_BTN_RIGHT check if right button was pressed
4500 wx.MOUSE_BTN_ANY check if any button was pressed
4501 ==================== =====================================
4502
4503 """
4504 return _core_.MouseEvent_Button(*args, **kwargs)
4505
4506 def ButtonIsDown(*args, **kwargs):
4507 """ButtonIsDown(self, int but) -> bool"""
4508 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4509
4510 def GetButton(*args, **kwargs):
4511 """
4512 GetButton(self) -> int
4513
4514 Returns the mouse button which generated this event or
4515 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4516 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4517 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4518 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4519 right buttons respectively.
4520 """
4521 return _core_.MouseEvent_GetButton(*args, **kwargs)
4522
4523 def ControlDown(*args, **kwargs):
4524 """
4525 ControlDown(self) -> bool
4526
4527 Returns true if the control key was down at the time of the event.
4528 """
4529 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4530
4531 def MetaDown(*args, **kwargs):
4532 """
4533 MetaDown(self) -> bool
4534
4535 Returns true if the Meta key was down at the time of the event.
4536 """
4537 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4538
4539 def AltDown(*args, **kwargs):
4540 """
4541 AltDown(self) -> bool
4542
4543 Returns true if the Alt key was down at the time of the event.
4544 """
4545 return _core_.MouseEvent_AltDown(*args, **kwargs)
4546
4547 def ShiftDown(*args, **kwargs):
4548 """
4549 ShiftDown(self) -> bool
4550
4551 Returns true if the Shift key was down at the time of the event.
4552 """
4553 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4554
4555 def CmdDown(*args, **kwargs):
4556 """
4557 CmdDown(self) -> bool
4558
4559 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4560 platforms but the special "Apple" (a.k.a as "Command") key on
4561 Macs. It often makes sense to use it instead of, say, `ControlDown`
4562 because Cmd key is used for the same thing under Mac as Ctrl
4563 elsewhere. The Ctrl key still exists, it's just not used for this
4564 purpose. So for non-Mac platforms this is the same as `ControlDown`
4565 and Macs this is the same as `MetaDown`.
4566 """
4567 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4568
4569 def LeftDown(*args, **kwargs):
4570 """
4571 LeftDown(self) -> bool
4572
4573 Returns true if the left mouse button state changed to down.
4574 """
4575 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4576
4577 def MiddleDown(*args, **kwargs):
4578 """
4579 MiddleDown(self) -> bool
4580
4581 Returns true if the middle mouse button state changed to down.
4582 """
4583 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4584
4585 def RightDown(*args, **kwargs):
4586 """
4587 RightDown(self) -> bool
4588
4589 Returns true if the right mouse button state changed to down.
4590 """
4591 return _core_.MouseEvent_RightDown(*args, **kwargs)
4592
4593 def LeftUp(*args, **kwargs):
4594 """
4595 LeftUp(self) -> bool
4596
4597 Returns true if the left mouse button state changed to up.
4598 """
4599 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4600
4601 def MiddleUp(*args, **kwargs):
4602 """
4603 MiddleUp(self) -> bool
4604
4605 Returns true if the middle mouse button state changed to up.
4606 """
4607 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4608
4609 def RightUp(*args, **kwargs):
4610 """
4611 RightUp(self) -> bool
4612
4613 Returns true if the right mouse button state changed to up.
4614 """
4615 return _core_.MouseEvent_RightUp(*args, **kwargs)
4616
4617 def LeftDClick(*args, **kwargs):
4618 """
4619 LeftDClick(self) -> bool
4620
4621 Returns true if the event was a left button double click.
4622 """
4623 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4624
4625 def MiddleDClick(*args, **kwargs):
4626 """
4627 MiddleDClick(self) -> bool
4628
4629 Returns true if the event was a middle button double click.
4630 """
4631 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4632
4633 def RightDClick(*args, **kwargs):
4634 """
4635 RightDClick(self) -> bool
4636
4637 Returns true if the event was a right button double click.
4638 """
4639 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4640
4641 def LeftIsDown(*args, **kwargs):
4642 """
4643 LeftIsDown(self) -> bool
4644
4645 Returns true if the left mouse button is currently down, independent
4646 of the current event type.
4647
4648 Please notice that it is not the same as LeftDown which returns true
4649 if the left mouse button was just pressed. Rather, it describes the
4650 state of the mouse button before the event happened.
4651
4652 This event is usually used in the mouse event handlers which process
4653 "move mouse" messages to determine whether the user is (still)
4654 dragging the mouse.
4655 """
4656 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4657
4658 def MiddleIsDown(*args, **kwargs):
4659 """
4660 MiddleIsDown(self) -> bool
4661
4662 Returns true if the middle mouse button is currently down, independent
4663 of the current event type.
4664 """
4665 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4666
4667 def RightIsDown(*args, **kwargs):
4668 """
4669 RightIsDown(self) -> bool
4670
4671 Returns true if the right mouse button is currently down, independent
4672 of the current event type.
4673 """
4674 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4675
4676 def Dragging(*args, **kwargs):
4677 """
4678 Dragging(self) -> bool
4679
4680 Returns true if this was a dragging event (motion while a button is
4681 depressed).
4682 """
4683 return _core_.MouseEvent_Dragging(*args, **kwargs)
4684
4685 def Moving(*args, **kwargs):
4686 """
4687 Moving(self) -> bool
4688
4689 Returns true if this was a motion event and no mouse buttons were
4690 pressed. If any mouse button is held pressed, then this method returns
4691 false and Dragging returns true.
4692 """
4693 return _core_.MouseEvent_Moving(*args, **kwargs)
4694
4695 def Entering(*args, **kwargs):
4696 """
4697 Entering(self) -> bool
4698
4699 Returns true if the mouse was entering the window.
4700 """
4701 return _core_.MouseEvent_Entering(*args, **kwargs)
4702
4703 def Leaving(*args, **kwargs):
4704 """
4705 Leaving(self) -> bool
4706
4707 Returns true if the mouse was leaving the window.
4708 """
4709 return _core_.MouseEvent_Leaving(*args, **kwargs)
4710
4711 def GetPosition(*args, **kwargs):
4712 """
4713 GetPosition(self) -> Point
4714
4715 Returns the pixel position of the mouse in window coordinates when the
4716 event happened.
4717 """
4718 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4719
4720 def GetPositionTuple(*args, **kwargs):
4721 """
4722 GetPositionTuple() -> (x,y)
4723
4724 Returns the pixel position of the mouse in window coordinates when the
4725 event happened.
4726 """
4727 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4728
4729 def GetLogicalPosition(*args, **kwargs):
4730 """
4731 GetLogicalPosition(self, DC dc) -> Point
4732
4733 Returns the logical mouse position in pixels (i.e. translated
4734 according to the translation set for the DC, which usually indicates
4735 that the window has been scrolled).
4736 """
4737 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4738
4739 def GetX(*args, **kwargs):
4740 """
4741 GetX(self) -> int
4742
4743 Returns X coordinate of the physical mouse event position.
4744 """
4745 return _core_.MouseEvent_GetX(*args, **kwargs)
4746
4747 def GetY(*args, **kwargs):
4748 """
4749 GetY(self) -> int
4750
4751 Returns Y coordinate of the physical mouse event position.
4752 """
4753 return _core_.MouseEvent_GetY(*args, **kwargs)
4754
4755 def GetWheelRotation(*args, **kwargs):
4756 """
4757 GetWheelRotation(self) -> int
4758
4759 Get wheel rotation, positive or negative indicates direction of
4760 rotation. Current devices all send an event when rotation is equal to
4761 +/-WheelDelta, but this allows for finer resolution devices to be
4762 created in the future. Because of this you shouldn't assume that one
4763 event is equal to 1 line or whatever, but you should be able to either
4764 do partial line scrolling or wait until +/-WheelDelta rotation values
4765 have been accumulated before scrolling.
4766 """
4767 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4768
4769 def GetWheelDelta(*args, **kwargs):
4770 """
4771 GetWheelDelta(self) -> int
4772
4773 Get wheel delta, normally 120. This is the threshold for action to be
4774 taken, and one such action (for example, scrolling one increment)
4775 should occur for each delta.
4776 """
4777 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4778
4779 def GetLinesPerAction(*args, **kwargs):
4780 """
4781 GetLinesPerAction(self) -> int
4782
4783 Returns the configured number of lines (or whatever) to be scrolled
4784 per wheel action. Defaults to three.
4785 """
4786 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4787
4788 def IsPageScroll(*args, **kwargs):
4789 """
4790 IsPageScroll(self) -> bool
4791
4792 Returns true if the system has been setup to do page scrolling with
4793 the mouse wheel instead of line scrolling.
4794 """
4795 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4796
4797 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4798 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4799 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4800 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4801 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4802 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4803 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4804 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4805 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4806 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4807 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4808 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4809 Button = property(GetButton,doc="See `GetButton`")
4810 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
4811 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
4812 Position = property(GetPosition,doc="See `GetPosition`")
4813 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
4814 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
4815 X = property(GetX,doc="See `GetX`")
4816 Y = property(GetY,doc="See `GetY`")
4817 _core_.MouseEvent_swigregister(MouseEvent)
4818
4819 #---------------------------------------------------------------------------
4820
4821 class SetCursorEvent(Event):
4822 """
4823 A SetCursorEvent is generated when the mouse cursor is about to be set
4824 as a result of mouse motion. This event gives the application the
4825 chance to perform specific mouse cursor processing based on the
4826 current position of the mouse within the window. Use the `SetCursor`
4827 method to specify the cursor you want to be displayed.
4828 """
4829 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4830 __repr__ = _swig_repr
4831 def __init__(self, *args, **kwargs):
4832 """
4833 __init__(self, int x=0, int y=0) -> SetCursorEvent
4834
4835 Construct a new `wx.SetCursorEvent`.
4836 """
4837 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
4838 def GetX(*args, **kwargs):
4839 """
4840 GetX(self) -> int
4841
4842 Returns the X coordinate of the mouse in client coordinates.
4843 """
4844 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4845
4846 def GetY(*args, **kwargs):
4847 """
4848 GetY(self) -> int
4849
4850 Returns the Y coordinate of the mouse in client coordinates.
4851 """
4852 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4853
4854 def SetCursor(*args, **kwargs):
4855 """
4856 SetCursor(self, Cursor cursor)
4857
4858 Sets the cursor associated with this event.
4859 """
4860 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4861
4862 def GetCursor(*args, **kwargs):
4863 """
4864 GetCursor(self) -> Cursor
4865
4866 Returns a reference to the cursor specified by this event.
4867 """
4868 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4869
4870 def HasCursor(*args, **kwargs):
4871 """
4872 HasCursor(self) -> bool
4873
4874 Returns true if the cursor specified by this event is a valid cursor.
4875 """
4876 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4877
4878 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
4879 X = property(GetX,doc="See `GetX`")
4880 Y = property(GetY,doc="See `GetY`")
4881 _core_.SetCursorEvent_swigregister(SetCursorEvent)
4882
4883 #---------------------------------------------------------------------------
4884
4885 class KeyEvent(Event):
4886 """
4887 This event class contains information about keypress and character
4888 events. These events are only sent to the widget that currently has
4889 the keyboard focus.
4890
4891 Notice that there are three different kinds of keyboard events in
4892 wxWidgets: key down and up events and char events. The difference
4893 between the first two is clear - the first corresponds to a key press
4894 and the second to a key release - otherwise they are identical. Just
4895 note that if the key is maintained in a pressed state you will
4896 typically get a lot of (automatically generated) down events but only
4897 one up so it is wrong to assume that there is one up event
4898 corresponding to each down one.
4899
4900 Both key events provide untranslated key codes while the char event
4901 carries the translated one. The untranslated code for alphanumeric
4902 keys is always an upper case value. For the other keys it is one of
4903 WXK_XXX values from the keycodes table. The translated key is, in
4904 general, the character the user expects to appear as the result of the
4905 key combination when typing the text into a text entry zone, for
4906 example.
4907
4908 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4909 and the standard US keyboard): when the 'A' key is pressed, the key
4910 down event key code is equal to ASCII A == 65. But the char event key
4911 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4912 'A' keys simultaneously , the key code in key down event will still be
4913 just 'A' while the char event key code parameter will now be 'A' as
4914 well.
4915
4916 Although in this simple case it is clear that the correct key code
4917 could be found in the key down event handler by checking the value
4918 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4919 as for non alphanumeric keys or non-US keyboard layouts the
4920 translation is keyboard-layout dependent and can only be done properly
4921 by the system itself.
4922
4923 Another kind of translation is done when the control key is pressed:
4924 for example, for CTRL-A key press the key down event still carries the
4925 same key code 'A' as usual but the char event will have key code of 1,
4926 the ASCII value of this key combination.
4927
4928 You may discover how the other keys on your system behave
4929 interactively by running the KeyEvents sample in the wxPython demo and
4930 pressing some keys while the blue box at the top has the keyboard
4931 focus.
4932
4933 **Note**: If a key down event is caught and the event handler does not
4934 call event.Skip() then the coresponding char event will not
4935 happen. This is by design and enables the programs that handle both
4936 types of events to be a bit simpler.
4937
4938 **Note for Windows programmers**: The key and char events in wxWidgets
4939 are similar to but slightly different from Windows WM_KEYDOWN and
4940 WM_CHAR events. In particular, Alt-x combination will generate a char
4941 event in wxWidgets (unless it is used as an accelerator).
4942
4943 **Tip**: be sure to call event.Skip() for events that you don't
4944 process in key event function, otherwise menu shortcuts may cease to
4945 work under Windows.
4946
4947 """
4948 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4949 __repr__ = _swig_repr
4950 def __init__(self, *args, **kwargs):
4951 """
4952 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4953
4954 Construct a new `wx.KeyEvent`. Valid event types are:
4955 *
4956 """
4957 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
4958 def GetModifiers(*args, **kwargs):
4959 """
4960 GetModifiers(self) -> int
4961
4962 Returns a bitmask of the current modifier settings. Can be used to
4963 check if the key event has exactly the given modifiers without having
4964 to explicitly check that the other modifiers are not down. For
4965 example::
4966
4967 if event.GetModifers() == wx.MOD_CONTROL:
4968 DoSomething()
4969
4970 """
4971 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4972
4973 def ControlDown(*args, **kwargs):
4974 """
4975 ControlDown(self) -> bool
4976
4977 Returns ``True`` if the Control key was down at the time of the event.
4978 """
4979 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4980
4981 def MetaDown(*args, **kwargs):
4982 """
4983 MetaDown(self) -> bool
4984
4985 Returns ``True`` if the Meta key was down at the time of the event.
4986 """
4987 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4988
4989 def AltDown(*args, **kwargs):
4990 """
4991 AltDown(self) -> bool
4992
4993 Returns ``True`` if the Alt key was down at the time of the event.
4994 """
4995 return _core_.KeyEvent_AltDown(*args, **kwargs)
4996
4997 def ShiftDown(*args, **kwargs):
4998 """
4999 ShiftDown(self) -> bool
5000
5001 Returns ``True`` if the Shift key was down at the time of the event.
5002 """
5003 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5004
5005 def CmdDown(*args, **kwargs):
5006 """
5007 CmdDown(self) -> bool
5008
5009 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5010 platforms but the special "Apple" (a.k.a as "Command") key on
5011 Macs. It makes often sense to use it instead of, say, `ControlDown`
5012 because Cmd key is used for the same thing under Mac as Ctrl
5013 elsewhere. The Ctrl still exists, it's just not used for this
5014 purpose. So for non-Mac platforms this is the same as `ControlDown`
5015 and Macs this is the same as `MetaDown`.
5016 """
5017 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5018
5019 def HasModifiers(*args, **kwargs):
5020 """
5021 HasModifiers(self) -> bool
5022
5023 Returns true if either CTRL or ALT keys was down at the time of the
5024 key event. Note that this function does not take into account neither
5025 SHIFT nor META key states (the reason for ignoring the latter is that
5026 it is common for NUMLOCK key to be configured as META under X but the
5027 key presses even while NUMLOCK is on should be still processed
5028 normally).
5029 """
5030 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5031
5032 def GetKeyCode(*args, **kwargs):
5033 """
5034 GetKeyCode(self) -> int
5035
5036 Returns the virtual key code. ASCII events return normal ASCII values,
5037 while non-ASCII events return values such as WXK_LEFT for the left
5038 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5039 codes.
5040
5041 Note that in Unicode build, the returned value is meaningful only if
5042 the user entered a character that can be represented in current
5043 locale's default charset. You can obtain the corresponding Unicode
5044 character using `GetUnicodeKey`.
5045 """
5046 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5047
5048 def GetUnicodeKey(*args, **kwargs):
5049 """
5050 GetUnicodeKey(self) -> int
5051
5052 Returns the Unicode character corresponding to this key event. This
5053 function is only meaningfule in a Unicode build of wxPython.
5054 """
5055 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
5056
5057 GetUniChar = GetUnicodeKey
5058 def SetUnicodeKey(*args, **kwargs):
5059 """
5060 SetUnicodeKey(self, int uniChar)
5061
5062 Set the Unicode value of the key event, but only if this is a Unicode
5063 build of wxPython.
5064 """
5065 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5066
5067 def GetRawKeyCode(*args, **kwargs):
5068 """
5069 GetRawKeyCode(self) -> unsigned int
5070
5071 Returns the raw key code for this event. This is a platform-dependent
5072 scan code which should only be used in advanced
5073 applications. Currently the raw key codes are not supported by all
5074 ports.
5075 """
5076 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5077
5078 def GetRawKeyFlags(*args, **kwargs):
5079 """
5080 GetRawKeyFlags(self) -> unsigned int
5081
5082 Returns the low level key flags for this event. The flags are
5083 platform-dependent and should only be used in advanced applications.
5084 Currently the raw key flags are not supported by all ports.
5085 """
5086 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5087
5088 def GetPosition(*args, **kwargs):
5089 """
5090 GetPosition(self) -> Point
5091
5092 Find the position of the event, if applicable.
5093 """
5094 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5095
5096 def GetPositionTuple(*args, **kwargs):
5097 """
5098 GetPositionTuple() -> (x,y)
5099
5100 Find the position of the event, if applicable.
5101 """
5102 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5103
5104 def GetX(*args, **kwargs):
5105 """
5106 GetX(self) -> int
5107
5108 Returns the X position (in client coordinates) of the event, if
5109 applicable.
5110 """
5111 return _core_.KeyEvent_GetX(*args, **kwargs)
5112
5113 def GetY(*args, **kwargs):
5114 """
5115 GetY(self) -> int
5116
5117 Returns the Y position (in client coordinates) of the event, if
5118 applicable.
5119 """
5120 return _core_.KeyEvent_GetY(*args, **kwargs)
5121
5122 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5123 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5124 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5125 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5126 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5127 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5128 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5129 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5130 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5131 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5132 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5133 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5134 Position = property(GetPosition,doc="See `GetPosition`")
5135 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5136 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5137 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5138 X = property(GetX,doc="See `GetX`")
5139 Y = property(GetY,doc="See `GetY`")
5140 _core_.KeyEvent_swigregister(KeyEvent)
5141
5142 #---------------------------------------------------------------------------
5143
5144 class SizeEvent(Event):
5145 """
5146 A size event holds information about size change events. The EVT_SIZE
5147 handler function will be called when the window it is bound to has
5148 been resized.
5149
5150 Note that the size passed is of the whole window: call
5151 `wx.Window.GetClientSize` for the area which may be used by the
5152 application.
5153
5154 When a window is resized, usually only a small part of the window is
5155 damaged and and that area is all that is in the update region for the
5156 next paint event. However, if your drawing depends on the size of the
5157 window, you may need to clear the DC explicitly and repaint the whole
5158 window. In which case, you may need to call `wx.Window.Refresh` to
5159 invalidate the entire window.
5160
5161 """
5162 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5163 __repr__ = _swig_repr
5164 def __init__(self, *args, **kwargs):
5165 """
5166 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5167
5168 Construct a new ``wx.SizeEvent``.
5169 """
5170 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5171 def GetSize(*args, **kwargs):
5172 """
5173 GetSize(self) -> Size
5174
5175 Returns the entire size of the window generating the size change
5176 event.
5177 """
5178 return _core_.SizeEvent_GetSize(*args, **kwargs)
5179
5180 def GetRect(*args, **kwargs):
5181 """GetRect(self) -> Rect"""
5182 return _core_.SizeEvent_GetRect(*args, **kwargs)
5183
5184 def SetRect(*args, **kwargs):
5185 """SetRect(self, Rect rect)"""
5186 return _core_.SizeEvent_SetRect(*args, **kwargs)
5187
5188 def SetSize(*args, **kwargs):
5189 """SetSize(self, Size size)"""
5190 return _core_.SizeEvent_SetSize(*args, **kwargs)
5191
5192 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5193 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5194 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5195 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5196 _core_.SizeEvent_swigregister(SizeEvent)
5197
5198 #---------------------------------------------------------------------------
5199
5200 class MoveEvent(Event):
5201 """
5202 This event object is sent for EVT_MOVE event bindings when a window is
5203 moved to a new position.
5204 """
5205 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5206 __repr__ = _swig_repr
5207 def __init__(self, *args, **kwargs):
5208 """
5209 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5210
5211 Constructor.
5212 """
5213 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5214 def GetPosition(*args, **kwargs):
5215 """
5216 GetPosition(self) -> Point
5217
5218 Returns the position of the window generating the move change event.
5219 """
5220 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5221
5222 def GetRect(*args, **kwargs):
5223 """GetRect(self) -> Rect"""
5224 return _core_.MoveEvent_GetRect(*args, **kwargs)
5225
5226 def SetRect(*args, **kwargs):
5227 """SetRect(self, Rect rect)"""
5228 return _core_.MoveEvent_SetRect(*args, **kwargs)
5229
5230 def SetPosition(*args, **kwargs):
5231 """SetPosition(self, Point pos)"""
5232 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5233
5234 m_pos = property(GetPosition, SetPosition)
5235 m_rect = property(GetRect, SetRect)
5236
5237 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5238 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5239 _core_.MoveEvent_swigregister(MoveEvent)
5240
5241 #---------------------------------------------------------------------------
5242
5243 class PaintEvent(Event):
5244 """
5245 A paint event is sent when a window's contents needs to be repainted.
5246 Note that in an EVT_PAINT handler the application must *always* create
5247 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5248 Windows assumes that the window has not been painted yet and will send
5249 the event again, causing endless refreshes.
5250
5251 You can optimize painting by retrieving the rectangles that have been
5252 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5253 and only repainting these rectangles. The rectangles are in terms of
5254 the client area, and are unscrolled, so you will need to do some
5255 calculations using the current view position to obtain logical,
5256 scrolled units.
5257
5258 """
5259 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5260 __repr__ = _swig_repr
5261 def __init__(self, *args, **kwargs):
5262 """__init__(self, int Id=0) -> PaintEvent"""
5263 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5264 _core_.PaintEvent_swigregister(PaintEvent)
5265
5266 class NcPaintEvent(Event):
5267 """Proxy of C++ NcPaintEvent class"""
5268 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5269 __repr__ = _swig_repr
5270 def __init__(self, *args, **kwargs):
5271 """__init__(self, int winid=0) -> NcPaintEvent"""
5272 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5273 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5274
5275 #---------------------------------------------------------------------------
5276
5277 class EraseEvent(Event):
5278 """
5279 An erase event is sent whenever the background of a window needs to be
5280 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5281 binder. On some platforms, such as GTK+, this event is simulated
5282 (simply generated just before the paint event) and may cause flicker.
5283
5284 To paint a custom background use the `GetDC` method and use the returned
5285 device context if it is not ``None``, otherwise create a temporary
5286 `wx.ClientDC` and draw on that.
5287
5288 """
5289 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5290 __repr__ = _swig_repr
5291 def __init__(self, *args, **kwargs):
5292 """
5293 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5294
5295 Constructor
5296 """
5297 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5298 def GetDC(*args, **kwargs):
5299 """
5300 GetDC(self) -> DC
5301
5302 Returns the device context the event handler should draw upon. If
5303 ``None`` is returned then create a temporary `wx.ClientDC` and use
5304 that instead.
5305 """
5306 return _core_.EraseEvent_GetDC(*args, **kwargs)
5307
5308 DC = property(GetDC,doc="See `GetDC`")
5309 _core_.EraseEvent_swigregister(EraseEvent)
5310
5311 #---------------------------------------------------------------------------
5312
5313 class FocusEvent(Event):
5314 """
5315 A focus event is sent when a window's focus changes. The window losing
5316 focus receives an EVT_KILL_FOCUS event while the window gaining it
5317 gets an EVT_SET_FOCUS event.
5318
5319 Notice that the set focus event happens both when the user gives focus
5320 to the window (whether using the mouse or keyboard) and when it is
5321 done from the program itself using `wx.Window.SetFocus`.
5322
5323 """
5324 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5325 __repr__ = _swig_repr
5326 def __init__(self, *args, **kwargs):
5327 """
5328 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5329
5330 Constructor
5331 """
5332 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5333 def GetWindow(*args, **kwargs):
5334 """
5335 GetWindow(self) -> Window
5336
5337 Returns the other window associated with this event, that is the
5338 window which had the focus before for the EVT_SET_FOCUS event and the
5339 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5340
5341 Warning: the window returned may be None!
5342 """
5343 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5344
5345 def SetWindow(*args, **kwargs):
5346 """SetWindow(self, Window win)"""
5347 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5348
5349 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5350 _core_.FocusEvent_swigregister(FocusEvent)
5351
5352 #---------------------------------------------------------------------------
5353
5354 class ChildFocusEvent(CommandEvent):
5355 """
5356 A child focus event is sent to a (parent-)window when one of its child
5357 windows gains focus, so that the window could restore the focus back
5358 to its corresponding child if it loses it now and regains later.
5359
5360 Notice that child window is the direct child of the window receiving
5361 the event, and so may not be the actual widget recieving focus if it
5362 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5363 to get the widget that is actually receiving focus.
5364 """
5365 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5366 __repr__ = _swig_repr
5367 def __init__(self, *args, **kwargs):
5368 """
5369 __init__(self, Window win=None) -> ChildFocusEvent
5370
5371 Constructor
5372 """
5373 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5374 def GetWindow(*args, **kwargs):
5375 """
5376 GetWindow(self) -> Window
5377
5378 The window, or (grand)parent of the window which has just received the
5379 focus.
5380 """
5381 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5382
5383 Window = property(GetWindow,doc="See `GetWindow`")
5384 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5385
5386 #---------------------------------------------------------------------------
5387
5388 class ActivateEvent(Event):
5389 """
5390 An activate event is sent when a top-level window or the entire
5391 application is being activated or deactivated.
5392
5393 A top-level window (a dialog or frame) receives an activate event when
5394 is being activated or deactivated. This is indicated visually by the
5395 title bar changing colour, and a subwindow gaining the keyboard focus.
5396 An application is activated or deactivated when one of its frames
5397 becomes activated, or a frame becomes inactivate resulting in all
5398 application frames being inactive.
5399
5400 Please note that usually you should call event.Skip() in your handlers
5401 for these events so the default handlers will still be called, as not
5402 doing so can result in strange effects.
5403
5404 """
5405 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5406 __repr__ = _swig_repr
5407 def __init__(self, *args, **kwargs):
5408 """
5409 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5410
5411 Constructor
5412 """
5413 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5414 def GetActive(*args, **kwargs):
5415 """
5416 GetActive(self) -> bool
5417
5418 Returns true if the application or window is being activated, false
5419 otherwise.
5420 """
5421 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5422
5423 Active = property(GetActive,doc="See `GetActive`")
5424 _core_.ActivateEvent_swigregister(ActivateEvent)
5425
5426 #---------------------------------------------------------------------------
5427
5428 class InitDialogEvent(Event):
5429 """
5430 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5431 any window when `wx.Window.InitDialog` is called. Handlers for this
5432 event can transfer data to the window, or anything else that should be
5433 done before the user begins editing the form. The default handler
5434 calls `wx.Window.TransferDataToWindow`.
5435 """
5436 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5437 __repr__ = _swig_repr
5438 def __init__(self, *args, **kwargs):
5439 """
5440 __init__(self, int Id=0) -> InitDialogEvent
5441
5442 Constructor
5443 """
5444 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5445 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5446
5447 #---------------------------------------------------------------------------
5448
5449 class MenuEvent(Event):
5450 """
5451 This class is used for a variety of menu-related events. Note that
5452 these do not include menu command events, which are handled by sending
5453 `wx.CommandEvent` objects.
5454
5455 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5456 text in the first field of the status bar.
5457 """
5458 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5459 __repr__ = _swig_repr
5460 def __init__(self, *args, **kwargs):
5461 """
5462 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5463
5464 Constructor
5465 """
5466 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5467 def GetMenuId(*args, **kwargs):
5468 """
5469 GetMenuId(self) -> int
5470
5471 Returns the menu identifier associated with the event. This method
5472 should be only used with the HIGHLIGHT events.
5473 """
5474 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5475
5476 def IsPopup(*args, **kwargs):
5477 """
5478 IsPopup(self) -> bool
5479
5480 Returns ``True`` if the menu which is being opened or closed is a
5481 popup menu, ``False`` if it is a normal one. This method should only
5482 be used with the OPEN and CLOSE events.
5483 """
5484 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5485
5486 def GetMenu(*args, **kwargs):
5487 """
5488 GetMenu(self) -> Menu
5489
5490 Returns the menu which is being opened or closed. This method should
5491 only be used with the OPEN and CLOSE events.
5492 """
5493 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5494
5495 Menu = property(GetMenu,doc="See `GetMenu`")
5496 MenuId = property(GetMenuId,doc="See `GetMenuId`")
5497 _core_.MenuEvent_swigregister(MenuEvent)
5498
5499 #---------------------------------------------------------------------------
5500
5501 class CloseEvent(Event):
5502 """
5503 This event class contains information about window and session close
5504 events.
5505
5506 The handler function for EVT_CLOSE is called when the user has tried
5507 to close a a frame or dialog box using the window manager controls or
5508 the system menu. It can also be invoked by the application itself
5509 programmatically, for example by calling the `wx.Window.Close`
5510 function.
5511
5512 You should check whether the application is forcing the deletion of
5513 the window using `CanVeto`. If it returns ``False``, you must destroy
5514 the window using `wx.Window.Destroy`. If the return value is ``True``,
5515 it is up to you whether you respond by destroying the window or not.
5516 For example you may wish to display a message dialog prompting to save
5517 files or to cancel the close.
5518
5519 If you don't destroy the window, you should call `Veto` to let the
5520 calling code know that you did not destroy the window. This allows the
5521 `wx.Window.Close` function to return ``True`` or ``False`` depending
5522 on whether the close instruction was honored or not.
5523 """
5524 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5525 __repr__ = _swig_repr
5526 def __init__(self, *args, **kwargs):
5527 """
5528 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5529
5530 Constructor.
5531 """
5532 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5533 def SetLoggingOff(*args, **kwargs):
5534 """
5535 SetLoggingOff(self, bool logOff)
5536
5537 Sets the 'logging off' flag.
5538 """
5539 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5540
5541 def GetLoggingOff(*args, **kwargs):
5542 """
5543 GetLoggingOff(self) -> bool
5544
5545 Returns ``True`` if the user is logging off or ``False`` if the
5546 system is shutting down. This method can only be called for end
5547 session and query end session events, it doesn't make sense for close
5548 window event.
5549 """
5550 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5551
5552 def Veto(*args, **kwargs):
5553 """
5554 Veto(self, bool veto=True)
5555
5556 Call this from your event handler to veto a system shutdown or to
5557 signal to the calling application that a window close did not happen.
5558
5559 You can only veto a shutdown or close if `CanVeto` returns true.
5560 """
5561 return _core_.CloseEvent_Veto(*args, **kwargs)
5562
5563 def GetVeto(*args, **kwargs):
5564 """GetVeto(self) -> bool"""
5565 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5566
5567 def SetCanVeto(*args, **kwargs):
5568 """
5569 SetCanVeto(self, bool canVeto)
5570
5571 Sets the 'can veto' flag.
5572 """
5573 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5574
5575 def CanVeto(*args, **kwargs):
5576 """
5577 CanVeto(self) -> bool
5578
5579 Returns true if you can veto a system shutdown or a window close
5580 event. Vetoing a window close event is not possible if the calling
5581 code wishes to force the application to exit, and so this function
5582 must be called to check this.
5583 """
5584 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5585
5586 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5587 _core_.CloseEvent_swigregister(CloseEvent)
5588
5589 #---------------------------------------------------------------------------
5590
5591 class ShowEvent(Event):
5592 """An EVT_SHOW event is sent when a window is shown or hidden."""
5593 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5594 __repr__ = _swig_repr
5595 def __init__(self, *args, **kwargs):
5596 """
5597 __init__(self, int winid=0, bool show=False) -> ShowEvent
5598
5599 An EVT_SHOW event is sent when a window is shown or hidden.
5600 """
5601 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5602 def SetShow(*args, **kwargs):
5603 """SetShow(self, bool show)"""
5604 return _core_.ShowEvent_SetShow(*args, **kwargs)
5605
5606 def GetShow(*args, **kwargs):
5607 """GetShow(self) -> bool"""
5608 return _core_.ShowEvent_GetShow(*args, **kwargs)
5609
5610 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5611 _core_.ShowEvent_swigregister(ShowEvent)
5612
5613 #---------------------------------------------------------------------------
5614
5615 class IconizeEvent(Event):
5616 """
5617 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5618 restored.
5619 """
5620 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5621 __repr__ = _swig_repr
5622 def __init__(self, *args, **kwargs):
5623 """
5624 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5625
5626 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5627 restored.
5628 """
5629 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5630 def Iconized(*args, **kwargs):
5631 """
5632 Iconized(self) -> bool
5633
5634 Returns ``True`` if the frame has been iconized, ``False`` if it has
5635 been restored.
5636 """
5637 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5638
5639 _core_.IconizeEvent_swigregister(IconizeEvent)
5640
5641 #---------------------------------------------------------------------------
5642
5643 class MaximizeEvent(Event):
5644 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5645 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5646 __repr__ = _swig_repr
5647 def __init__(self, *args, **kwargs):
5648 """
5649 __init__(self, int id=0) -> MaximizeEvent
5650
5651 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5652 """
5653 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5654 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5655
5656 #---------------------------------------------------------------------------
5657
5658 class DropFilesEvent(Event):
5659 """
5660 This class is used for drop files events, that is, when files have
5661 been dropped onto the window. This functionality is only available
5662 under Windows. The window must have previously been enabled for
5663 dropping by calling `wx.Window.DragAcceptFiles`.
5664
5665 Important note: this is a separate implementation to the more general
5666 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5667 implementation uses the older, Windows message-based approach of
5668 dropping files.
5669
5670 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5671 events.
5672
5673 """
5674 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5675 def __init__(self): raise AttributeError, "No constructor defined"
5676 __repr__ = _swig_repr
5677 def GetPosition(*args, **kwargs):
5678 """
5679 GetPosition(self) -> Point
5680
5681 Returns the position at which the files were dropped.
5682 """
5683 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5684
5685 def GetNumberOfFiles(*args, **kwargs):
5686 """
5687 GetNumberOfFiles(self) -> int
5688
5689 Returns the number of files dropped.
5690 """
5691 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5692
5693 def GetFiles(*args, **kwargs):
5694 """
5695 GetFiles(self) -> PyObject
5696
5697 Returns a list of the filenames that were dropped.
5698 """
5699 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5700
5701 Files = property(GetFiles,doc="See `GetFiles`")
5702 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5703 Position = property(GetPosition,doc="See `GetPosition`")
5704 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5705
5706 #---------------------------------------------------------------------------
5707
5708 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5709 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5710 class UpdateUIEvent(CommandEvent):
5711 """
5712 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5713 wxWidgets to give an application the chance to update various user
5714 interface elements.
5715
5716 Without update UI events, an application has to work hard to
5717 check/uncheck, enable/disable, and set the text for elements such as
5718 menu items and toolbar buttons. The code for doing this has to be
5719 mixed up with the code that is invoked when an action is invoked for a
5720 menu item or button.
5721
5722 With update UI events, you define an event handler to look at the
5723 state of the application and change UI elements accordingly. wxWidgets
5724 will call your handler functions in idle time, so you don't have to
5725 worry where to call this code. In addition to being a clearer and more
5726 declarative method, it also means you don't have to worry whether
5727 you're updating a toolbar or menubar identifier. The same handler can
5728 update a menu item and toolbar button, if the ID values are the same.
5729
5730 Instead of directly manipulating the menu or button, you call
5731 functions in the event object, such as `Check`. wxWidgets will
5732 determine whether such a call has been made, and which UI element to
5733 update.
5734
5735 These events will work for popup menus as well as menubars. Just
5736 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5737 any UI events for the window that owns the menu.
5738
5739 If you find that the overhead of UI update processing is affecting
5740 your application, you can do one or both of the following:
5741
5742 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5743 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5744 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5745 receive update events. No other windows will receive update
5746 events.
5747
5748 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5749 value to set the delay between updates. You may need to call
5750 `wx.Window.UpdateWindowUI` at critical points, for example when
5751 a dialog is about to be shown, in case the user sees a slight
5752 delay before windows are updated.
5753
5754 Note that although events are sent in idle time, defining a EVT_IDLE
5755 handler for a window does not affect this because the events are sent
5756 from an internal idle handler.
5757
5758 wxWidgets tries to optimize update events on some platforms. On
5759 Windows and GTK+, events for menubar items are only sent when the menu
5760 is about to be shown, and not in idle time.
5761
5762 """
5763 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5764 __repr__ = _swig_repr
5765 def __init__(self, *args, **kwargs):
5766 """
5767 __init__(self, int commandId=0) -> UpdateUIEvent
5768
5769 Constructor
5770 """
5771 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
5772 def GetChecked(*args, **kwargs):
5773 """
5774 GetChecked(self) -> bool
5775
5776 Returns ``True`` if the UI element should be checked.
5777 """
5778 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5779
5780 def GetEnabled(*args, **kwargs):
5781 """
5782 GetEnabled(self) -> bool
5783
5784 Returns ``True`` if the UI element should be enabled.
5785 """
5786 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5787
5788 def GetShown(*args, **kwargs):
5789 """
5790 GetShown(self) -> bool
5791
5792 Returns ``True`` if the UI element should be shown.
5793 """
5794 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5795
5796 def GetText(*args, **kwargs):
5797 """
5798 GetText(self) -> String
5799
5800 Returns the text that should be set for the UI element.
5801 """
5802 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5803
5804 def GetSetText(*args, **kwargs):
5805 """
5806 GetSetText(self) -> bool
5807
5808 Returns ``True`` if the application has called `SetText`. For
5809 wxWidgets internal use only.
5810 """
5811 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5812
5813 def GetSetChecked(*args, **kwargs):
5814 """
5815 GetSetChecked(self) -> bool
5816
5817 Returns ``True`` if the application has called `Check`. For wxWidgets
5818 internal use only.
5819 """
5820 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5821
5822 def GetSetEnabled(*args, **kwargs):
5823 """
5824 GetSetEnabled(self) -> bool
5825
5826 Returns ``True`` if the application has called `Enable`. For wxWidgets
5827 internal use only.
5828 """
5829 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5830
5831 def GetSetShown(*args, **kwargs):
5832 """
5833 GetSetShown(self) -> bool
5834
5835 Returns ``True`` if the application has called `Show`. For wxWidgets
5836 internal use only.
5837 """
5838 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5839
5840 def Check(*args, **kwargs):
5841 """
5842 Check(self, bool check)
5843
5844 Check or uncheck the UI element.
5845 """
5846 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5847
5848 def Enable(*args, **kwargs):
5849 """
5850 Enable(self, bool enable)
5851
5852 Enable or disable the UI element.
5853 """
5854 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5855
5856 def Show(*args, **kwargs):
5857 """
5858 Show(self, bool show)
5859
5860 Show or hide the UI element.
5861 """
5862 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5863
5864 def SetText(*args, **kwargs):
5865 """
5866 SetText(self, String text)
5867
5868 Sets the text for this UI element.
5869 """
5870 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5871
5872 def SetUpdateInterval(*args, **kwargs):
5873 """
5874 SetUpdateInterval(long updateInterval)
5875
5876 Sets the interval between updates in milliseconds. Set to -1 to
5877 disable updates, or to 0 to update as frequently as possible. The
5878 default is 0.
5879
5880 Use this to reduce the overhead of UI update events if your
5881 application has a lot of windows. If you set the value to -1 or
5882 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5883 at appropriate points in your application, such as when a dialog is
5884 about to be shown.
5885 """
5886 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5887
5888 SetUpdateInterval = staticmethod(SetUpdateInterval)
5889 def GetUpdateInterval(*args, **kwargs):
5890 """
5891 GetUpdateInterval() -> long
5892
5893 Returns the current interval between updates in milliseconds. -1
5894 disables updates, 0 updates as frequently as possible.
5895 """
5896 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5897
5898 GetUpdateInterval = staticmethod(GetUpdateInterval)
5899 def CanUpdate(*args, **kwargs):
5900 """
5901 CanUpdate(Window win) -> bool
5902
5903 Returns ``True`` if it is appropriate to update (send UI update events
5904 to) this window.
5905
5906 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5907 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5908 events were last sent in idle time, and the update interval, to
5909 determine whether events should be sent to this window now. By default
5910 this will always return true because the update mode is initially
5911 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5912 events will be sent as often as possible. You can reduce the frequency
5913 that events are sent by changing the mode and/or setting an update
5914 interval.
5915
5916 """
5917 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5918
5919 CanUpdate = staticmethod(CanUpdate)
5920 def ResetUpdateTime(*args, **kwargs):
5921 """
5922 ResetUpdateTime()
5923
5924 Used internally to reset the last-updated time to the current time. It
5925 is assumed that update events are normally sent in idle time, so this
5926 is called at the end of idle processing.
5927 """
5928 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5929
5930 ResetUpdateTime = staticmethod(ResetUpdateTime)
5931 def SetMode(*args, **kwargs):
5932 """
5933 SetMode(int mode)
5934
5935 Specify how wxWidgets will send update events: to all windows, or only
5936 to those which specify that they will process the events.
5937
5938 The mode may be one of the following values:
5939
5940 ============================= ==========================================
5941 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5942 is the default setting.
5943 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5944 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5945 style set.
5946 ============================= ==========================================
5947
5948 """
5949 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5950
5951 SetMode = staticmethod(SetMode)
5952 def GetMode(*args, **kwargs):
5953 """
5954 GetMode() -> int
5955
5956 Returns a value specifying how wxWidgets will send update events: to
5957 all windows, or only to those which specify that they will process the
5958 events.
5959 """
5960 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5961
5962 GetMode = staticmethod(GetMode)
5963 Checked = property(GetChecked,Check,doc="See `GetChecked`")
5964 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
5965 Shown = property(GetShown,Show,doc="See `GetShown`")
5966 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
5967 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
5968
5969 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5970 """
5971 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5972
5973 Sets the interval between updates in milliseconds. Set to -1 to
5974 disable updates, or to 0 to update as frequently as possible. The
5975 default is 0.
5976
5977 Use this to reduce the overhead of UI update events if your
5978 application has a lot of windows. If you set the value to -1 or
5979 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5980 at appropriate points in your application, such as when a dialog is
5981 about to be shown.
5982 """
5983 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5984
5985 def UpdateUIEvent_GetUpdateInterval(*args):
5986 """
5987 UpdateUIEvent_GetUpdateInterval() -> long
5988
5989 Returns the current interval between updates in milliseconds. -1
5990 disables updates, 0 updates as frequently as possible.
5991 """
5992 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
5993
5994 def UpdateUIEvent_CanUpdate(*args, **kwargs):
5995 """
5996 UpdateUIEvent_CanUpdate(Window win) -> bool
5997
5998 Returns ``True`` if it is appropriate to update (send UI update events
5999 to) this window.
6000
6001 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6002 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6003 events were last sent in idle time, and the update interval, to
6004 determine whether events should be sent to this window now. By default
6005 this will always return true because the update mode is initially
6006 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6007 events will be sent as often as possible. You can reduce the frequency
6008 that events are sent by changing the mode and/or setting an update
6009 interval.
6010
6011 """
6012 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6013
6014 def UpdateUIEvent_ResetUpdateTime(*args):
6015 """
6016 UpdateUIEvent_ResetUpdateTime()
6017
6018 Used internally to reset the last-updated time to the current time. It
6019 is assumed that update events are normally sent in idle time, so this
6020 is called at the end of idle processing.
6021 """
6022 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
6023
6024 def UpdateUIEvent_SetMode(*args, **kwargs):
6025 """
6026 UpdateUIEvent_SetMode(int mode)
6027
6028 Specify how wxWidgets will send update events: to all windows, or only
6029 to those which specify that they will process the events.
6030
6031 The mode may be one of the following values:
6032
6033 ============================= ==========================================
6034 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6035 is the default setting.
6036 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6037 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6038 style set.
6039 ============================= ==========================================
6040
6041 """
6042 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6043
6044 def UpdateUIEvent_GetMode(*args):
6045 """
6046 UpdateUIEvent_GetMode() -> int
6047
6048 Returns a value specifying how wxWidgets will send update events: to
6049 all windows, or only to those which specify that they will process the
6050 events.
6051 """
6052 return _core_.UpdateUIEvent_GetMode(*args)
6053
6054 #---------------------------------------------------------------------------
6055
6056 class SysColourChangedEvent(Event):
6057 """
6058 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6059 when the user changes the colour settings using the control
6060 panel. This is only applicable under Windows.
6061
6062 The default event handler for this event propagates the event to child
6063 windows, since Windows only sends the events to top-level windows. If
6064 intercepting this event for a top-level window, remember to call
6065 `Skip` so the the base class handler will still be executed, or to
6066 pass the event on to the window's children explicitly.
6067
6068 """
6069 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6070 __repr__ = _swig_repr
6071 def __init__(self, *args, **kwargs):
6072 """
6073 __init__(self) -> SysColourChangedEvent
6074
6075 Constructor
6076 """
6077 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
6078 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
6079
6080 #---------------------------------------------------------------------------
6081
6082 class MouseCaptureChangedEvent(Event):
6083 """
6084 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6085 a window that loses its mouse capture. This is called even if
6086 `wx.Window.ReleaseMouse` was called by the application code. Handling
6087 this event allows an application to cater for unexpected capture
6088 releases which might otherwise confuse mouse handling code.
6089
6090 This event is implemented under Windows only.
6091 """
6092 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6093 __repr__ = _swig_repr
6094 def __init__(self, *args, **kwargs):
6095 """
6096 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6097
6098 Constructor
6099 """
6100 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6101 def GetCapturedWindow(*args, **kwargs):
6102 """
6103 GetCapturedWindow(self) -> Window
6104
6105 Returns the window that gained the capture, or ``None`` if it was a
6106 non-wxWidgets window.
6107 """
6108 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6109
6110 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6111 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6112
6113 #---------------------------------------------------------------------------
6114
6115 class MouseCaptureLostEvent(Event):
6116 """
6117 A mouse capture lost event is sent to a window that obtained mouse
6118 capture, which was subsequently loss due to "external" event, for
6119 example when a dialog box is shown or if another application captures
6120 the mouse.
6121
6122 If this happens, this event is sent to all windows that are on the
6123 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6124 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6125 if the capture changes because of a call to CaptureMouse or
6126 ReleaseMouse.
6127
6128 This event is currently emitted under Windows only.
6129
6130 """
6131 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6132 __repr__ = _swig_repr
6133 def __init__(self, *args, **kwargs):
6134 """
6135 __init__(self, int winid=0) -> MouseCaptureLostEvent
6136
6137 A mouse capture lost event is sent to a window that obtained mouse
6138 capture, which was subsequently loss due to "external" event, for
6139 example when a dialog box is shown or if another application captures
6140 the mouse.
6141
6142 If this happens, this event is sent to all windows that are on the
6143 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6144 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6145 if the capture changes because of a call to CaptureMouse or
6146 ReleaseMouse.
6147
6148 This event is currently emitted under Windows only.
6149
6150 """
6151 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6152 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6153
6154 #---------------------------------------------------------------------------
6155
6156 class DisplayChangedEvent(Event):
6157 """
6158 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6159 resolution has changed.
6160
6161 This event is implemented under Windows only.
6162 """
6163 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6164 __repr__ = _swig_repr
6165 def __init__(self, *args, **kwargs):
6166 """__init__(self) -> DisplayChangedEvent"""
6167 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6168 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6169
6170 #---------------------------------------------------------------------------
6171
6172 class PaletteChangedEvent(Event):
6173 """
6174 An EVT_PALETTE_CHANGED event is sent when the system palette has
6175 changed, thereby giving each window a chance to redo their own to
6176 match.
6177
6178 This event is implemented under Windows only.
6179 """
6180 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6181 __repr__ = _swig_repr
6182 def __init__(self, *args, **kwargs):
6183 """
6184 __init__(self, int id=0) -> PaletteChangedEvent
6185
6186 An EVT_PALETTE_CHANGED event is sent when the system palette has
6187 changed, thereby giving each window a chance to redo their own to
6188 match.
6189
6190 This event is implemented under Windows only.
6191 """
6192 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6193 def SetChangedWindow(*args, **kwargs):
6194 """SetChangedWindow(self, Window win)"""
6195 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6196
6197 def GetChangedWindow(*args, **kwargs):
6198 """GetChangedWindow(self) -> Window"""
6199 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6200
6201 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6202 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6203
6204 #---------------------------------------------------------------------------
6205
6206 class QueryNewPaletteEvent(Event):
6207 """
6208 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6209 focus and should re-do its palette.
6210
6211 This event is implemented under Windows only.
6212 """
6213 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6214 __repr__ = _swig_repr
6215 def __init__(self, *args, **kwargs):
6216 """
6217 __init__(self, int winid=0) -> QueryNewPaletteEvent
6218
6219 Constructor.
6220 """
6221 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6222 def SetPaletteRealized(*args, **kwargs):
6223 """
6224 SetPaletteRealized(self, bool realized)
6225
6226 App should set this if it changes the palette.
6227 """
6228 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6229
6230 def GetPaletteRealized(*args, **kwargs):
6231 """GetPaletteRealized(self) -> bool"""
6232 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6233
6234 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6235 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6236
6237 #---------------------------------------------------------------------------
6238
6239 class NavigationKeyEvent(Event):
6240 """
6241 EVT_NAVIGATION_KEY events are used to control moving the focus between
6242 widgets, otherwise known as tab-traversal. You woudl normally not
6243 catch navigation events in applications as there are already
6244 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6245 it useful to send navigation events in certain situations to change
6246 the focus in certain ways, although it's probably easier to just call
6247 `wx.Window.Navigate`.
6248 """
6249 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6250 __repr__ = _swig_repr
6251 def __init__(self, *args, **kwargs):
6252 """__init__(self) -> NavigationKeyEvent"""
6253 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6254 def GetDirection(*args, **kwargs):
6255 """
6256 GetDirection(self) -> bool
6257
6258 Returns ``True`` if the direction is forward, ``False`` otherwise.
6259 """
6260 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6261
6262 def SetDirection(*args, **kwargs):
6263 """
6264 SetDirection(self, bool forward)
6265
6266 Specify the direction that the navigation should take. Usually the
6267 difference between using Tab and Shift-Tab.
6268 """
6269 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6270
6271 def IsWindowChange(*args, **kwargs):
6272 """
6273 IsWindowChange(self) -> bool
6274
6275 Returns ``True`` if window change is allowed.
6276 """
6277 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6278
6279 def SetWindowChange(*args, **kwargs):
6280 """
6281 SetWindowChange(self, bool ischange)
6282
6283 Specify if the navigation should be able to change parent windows.
6284 For example, changing notebook pages, etc. This is usually implemented
6285 by using Control-Tab.
6286 """
6287 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6288
6289 def IsFromTab(*args, **kwargs):
6290 """
6291 IsFromTab(self) -> bool
6292
6293 Returns ``True`` if the navigation event is originated from the Tab
6294 key.
6295 """
6296 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6297
6298 def SetFromTab(*args, **kwargs):
6299 """
6300 SetFromTab(self, bool bIs)
6301
6302 Set to true under MSW if the event was generated using the tab key.
6303 This is required for proper navogation over radio buttons.
6304 """
6305 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6306
6307 def SetFlags(*args, **kwargs):
6308 """
6309 SetFlags(self, long flags)
6310
6311 Set the navigation flags to a combination of the following:
6312
6313 * wx.NavigationKeyEvent.IsBackward
6314 * wx.NavigationKeyEvent.IsForward
6315 * wx.NavigationKeyEvent.WinChange
6316 * wx.NavigationKeyEvent.FromTab
6317
6318 """
6319 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6320
6321 def GetCurrentFocus(*args, **kwargs):
6322 """
6323 GetCurrentFocus(self) -> Window
6324
6325 Returns the child window which currenty has the focus. May be
6326 ``None``.
6327 """
6328 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6329
6330 def SetCurrentFocus(*args, **kwargs):
6331 """
6332 SetCurrentFocus(self, Window win)
6333
6334 Set the window that has the focus.
6335 """
6336 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6337
6338 IsBackward = _core_.NavigationKeyEvent_IsBackward
6339 IsForward = _core_.NavigationKeyEvent_IsForward
6340 WinChange = _core_.NavigationKeyEvent_WinChange
6341 FromTab = _core_.NavigationKeyEvent_FromTab
6342 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6343 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6344 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6345
6346 #---------------------------------------------------------------------------
6347
6348 class WindowCreateEvent(CommandEvent):
6349 """
6350 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6351 underlying GUI object) exists.
6352 """
6353 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6354 __repr__ = _swig_repr
6355 def __init__(self, *args, **kwargs):
6356 """
6357 __init__(self, Window win=None) -> WindowCreateEvent
6358
6359 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6360 underlying GUI object) exists.
6361 """
6362 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6363 def GetWindow(*args, **kwargs):
6364 """
6365 GetWindow(self) -> Window
6366
6367 Returns the window that this event refers to.
6368 """
6369 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6370
6371 Window = property(GetWindow,doc="See `GetWindow`")
6372 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6373
6374 class WindowDestroyEvent(CommandEvent):
6375 """
6376 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6377 when the GUI window is destroyed.
6378
6379 When a class derived from `wx.Window` is destroyed its destructor will
6380 have already run by the time this event is sent. Therefore this event
6381 will not usually be received at all by the window itself. Since it is
6382 received after the destructor has run, an object should not try to
6383 handle its own wx.WindowDestroyEvent, but it can be used to get
6384 notification of the destruction of another window.
6385 """
6386 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6387 __repr__ = _swig_repr
6388 def __init__(self, *args, **kwargs):
6389 """
6390 __init__(self, Window win=None) -> WindowDestroyEvent
6391
6392 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6393 when the GUI window is destroyed.
6394
6395 When a class derived from `wx.Window` is destroyed its destructor will
6396 have already run by the time this event is sent. Therefore this event
6397 will not usually be received at all by the window itself. Since it is
6398 received after the destructor has run, an object should not try to
6399 handle its own wx.WindowDestroyEvent, but it can be used to get
6400 notification of the destruction of another window.
6401 """
6402 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6403 def GetWindow(*args, **kwargs):
6404 """
6405 GetWindow(self) -> Window
6406
6407 Returns the window that this event refers to.
6408 """
6409 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6410
6411 Window = property(GetWindow,doc="See `GetWindow`")
6412 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6413
6414 #---------------------------------------------------------------------------
6415
6416 class ContextMenuEvent(CommandEvent):
6417 """
6418 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6419 give the application a chance to show a context (popup) menu.
6420 """
6421 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6422 __repr__ = _swig_repr
6423 def __init__(self, *args, **kwargs):
6424 """
6425 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6426
6427 Constructor.
6428 """
6429 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6430 def GetPosition(*args, **kwargs):
6431 """
6432 GetPosition(self) -> Point
6433
6434 Returns the position (in screen coordinants) at which the menu should
6435 be shown.
6436 """
6437 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6438
6439 def SetPosition(*args, **kwargs):
6440 """
6441 SetPosition(self, Point pos)
6442
6443 Sets the position at which the menu should be shown.
6444 """
6445 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6446
6447 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6448 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6449
6450 #---------------------------------------------------------------------------
6451
6452 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6453 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6454 class IdleEvent(Event):
6455 """
6456 This class is used for EVT_IDLE events, which are generated and sent
6457 when the application *becomes* idle. In other words, the when the
6458 event queue becomes empty then idle events are sent to all windows (by
6459 default) and as long as none of them call `RequestMore` then there are
6460 no more idle events until after the system event queue has some normal
6461 events and then becomes empty again.
6462
6463 By default, idle events are sent to all windows. If this is causing a
6464 significant overhead in your application, you can call
6465 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6466 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6467 which should receive idle events. Then idle events will only be sent
6468 to those windows and not to any others.
6469 """
6470 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6471 __repr__ = _swig_repr
6472 def __init__(self, *args, **kwargs):
6473 """
6474 __init__(self) -> IdleEvent
6475
6476 Constructor
6477 """
6478 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6479 def RequestMore(*args, **kwargs):
6480 """
6481 RequestMore(self, bool needMore=True)
6482
6483 Tells wxWidgets that more processing is required. This function can be
6484 called by an EVT_IDLE handler for a window to indicate that the
6485 application should forward the EVT_IDLE event once more to the
6486 application windows. If no window calls this function during its
6487 EVT_IDLE handler, then the application will remain in a passive event
6488 loop until a new event is posted to the application by the windowing
6489 system.
6490 """
6491 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6492
6493 def MoreRequested(*args, **kwargs):
6494 """
6495 MoreRequested(self) -> bool
6496
6497 Returns ``True`` if the OnIdle function processing this event
6498 requested more processing time.
6499 """
6500 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6501
6502 def SetMode(*args, **kwargs):
6503 """
6504 SetMode(int mode)
6505
6506 Static method for specifying how wxWidgets will send idle events: to
6507 all windows, or only to those which specify that they will process the
6508 events.
6509
6510 The mode can be one of the following values:
6511
6512 ========================= ========================================
6513 wx.IDLE_PROCESS_ALL Send idle events to all windows
6514 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6515 the wx.WS_EX_PROCESS_IDLE extra style
6516 flag set.
6517 ========================= ========================================
6518
6519 """
6520 return _core_.IdleEvent_SetMode(*args, **kwargs)
6521
6522 SetMode = staticmethod(SetMode)
6523 def GetMode(*args, **kwargs):
6524 """
6525 GetMode() -> int
6526
6527 Static method returning a value specifying how wxWidgets will send
6528 idle events: to all windows, or only to those which specify that they
6529 will process the events.
6530 """
6531 return _core_.IdleEvent_GetMode(*args, **kwargs)
6532
6533 GetMode = staticmethod(GetMode)
6534 def CanSend(*args, **kwargs):
6535 """
6536 CanSend(Window win) -> bool
6537
6538 Returns ``True`` if it is appropriate to send idle events to this
6539 window.
6540
6541 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6542 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6543 events should be sent to this window now. By default this will always
6544 return ``True`` because the update mode is initially
6545 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6546 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6547 """
6548 return _core_.IdleEvent_CanSend(*args, **kwargs)
6549
6550 CanSend = staticmethod(CanSend)
6551 _core_.IdleEvent_swigregister(IdleEvent)
6552
6553 def IdleEvent_SetMode(*args, **kwargs):
6554 """
6555 IdleEvent_SetMode(int mode)
6556
6557 Static method for specifying how wxWidgets will send idle events: to
6558 all windows, or only to those which specify that they will process the
6559 events.
6560
6561 The mode can be one of the following values:
6562
6563 ========================= ========================================
6564 wx.IDLE_PROCESS_ALL Send idle events to all windows
6565 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6566 the wx.WS_EX_PROCESS_IDLE extra style
6567 flag set.
6568 ========================= ========================================
6569
6570 """
6571 return _core_.IdleEvent_SetMode(*args, **kwargs)
6572
6573 def IdleEvent_GetMode(*args):
6574 """
6575 IdleEvent_GetMode() -> int
6576
6577 Static method returning a value specifying how wxWidgets will send
6578 idle events: to all windows, or only to those which specify that they
6579 will process the events.
6580 """
6581 return _core_.IdleEvent_GetMode(*args)
6582
6583 def IdleEvent_CanSend(*args, **kwargs):
6584 """
6585 IdleEvent_CanSend(Window win) -> bool
6586
6587 Returns ``True`` if it is appropriate to send idle events to this
6588 window.
6589
6590 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6591 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6592 events should be sent to this window now. By default this will always
6593 return ``True`` because the update mode is initially
6594 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6595 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6596 """
6597 return _core_.IdleEvent_CanSend(*args, **kwargs)
6598
6599 #---------------------------------------------------------------------------
6600
6601 class ClipboardTextEvent(CommandEvent):
6602 """
6603 A Clipboard Text event is sent when a window intercepts a text
6604 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6605 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6606 popup menu command, etc. NOTE : under windows these events are *NOT*
6607 generated automatically for a Rich Edit text control.
6608 """
6609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6610 __repr__ = _swig_repr
6611 def __init__(self, *args, **kwargs):
6612 """
6613 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6614
6615 A Clipboard Text event is sent when a window intercepts a text
6616 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6617 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6618 popup menu command, etc. NOTE : under windows these events are *NOT*
6619 generated automatically for a Rich Edit text control.
6620 """
6621 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6622 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6623
6624 #---------------------------------------------------------------------------
6625
6626 class PyEvent(Event):
6627 """
6628 wx.PyEvent can be used as a base class for implementing custom event
6629 types in Python. You should derived from this class instead of
6630 `wx.Event` because this class is Python-aware and is able to transport
6631 its Python bits safely through the wxWidgets event system and have
6632 them still be there when the event handler is invoked.
6633
6634 :see: `wx.PyCommandEvent`
6635
6636 """
6637 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6638 __repr__ = _swig_repr
6639 def __init__(self, *args, **kwargs):
6640 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6641 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6642 self._SetSelf(self)
6643
6644 __swig_destroy__ = _core_.delete_PyEvent
6645 __del__ = lambda self : None;
6646 def _SetSelf(*args, **kwargs):
6647 """_SetSelf(self, PyObject self)"""
6648 return _core_.PyEvent__SetSelf(*args, **kwargs)
6649
6650 def _GetSelf(*args, **kwargs):
6651 """_GetSelf(self) -> PyObject"""
6652 return _core_.PyEvent__GetSelf(*args, **kwargs)
6653
6654 _core_.PyEvent_swigregister(PyEvent)
6655
6656 class PyCommandEvent(CommandEvent):
6657 """
6658 wx.PyCommandEvent can be used as a base class for implementing custom
6659 event types in Python, where the event shoudl travel up to parent
6660 windows looking for a handler. You should derived from this class
6661 instead of `wx.CommandEvent` because this class is Python-aware and is
6662 able to transport its Python bits safely through the wxWidgets event
6663 system and have them still be there when the event handler is invoked.
6664
6665 :see: `wx.PyEvent`
6666
6667 """
6668 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6669 __repr__ = _swig_repr
6670 def __init__(self, *args, **kwargs):
6671 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6672 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6673 self._SetSelf(self)
6674
6675 __swig_destroy__ = _core_.delete_PyCommandEvent
6676 __del__ = lambda self : None;
6677 def _SetSelf(*args, **kwargs):
6678 """_SetSelf(self, PyObject self)"""
6679 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6680
6681 def _GetSelf(*args, **kwargs):
6682 """_GetSelf(self) -> PyObject"""
6683 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6684
6685 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6686
6687 class DateEvent(CommandEvent):
6688 """
6689 This event class holds information about a date change event and is
6690 used together with `wx.DatePickerCtrl`. It also serves as a base class
6691 for `wx.calendar.CalendarEvent`. Bind these event types with
6692 EVT_DATE_CHANGED.
6693 """
6694 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6695 __repr__ = _swig_repr
6696 def __init__(self, *args, **kwargs):
6697 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6698 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6699 def GetDate(*args, **kwargs):
6700 """
6701 GetDate(self) -> DateTime
6702
6703 Returns the date.
6704 """
6705 return _core_.DateEvent_GetDate(*args, **kwargs)
6706
6707 def SetDate(*args, **kwargs):
6708 """
6709 SetDate(self, DateTime date)
6710
6711 Sets the date carried by the event, normally only used by the library
6712 internally.
6713 """
6714 return _core_.DateEvent_SetDate(*args, **kwargs)
6715
6716 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
6717 _core_.DateEvent_swigregister(DateEvent)
6718
6719 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6720 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6721
6722 #---------------------------------------------------------------------------
6723
6724 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6725 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6726 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6727 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6728 PRINT_WINDOWS = _core_.PRINT_WINDOWS
6729 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6730 class PyApp(EvtHandler):
6731 """
6732 The ``wx.PyApp`` class is an *implementation detail*, please use the
6733 `wx.App` class (or some other derived class) instead.
6734 """
6735 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6736 __repr__ = _swig_repr
6737 def __init__(self, *args, **kwargs):
6738 """
6739 __init__(self) -> PyApp
6740
6741 Create a new application object, starting the bootstrap process.
6742 """
6743 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
6744 self._setCallbackInfo(self, PyApp, False)
6745 self._setOORInfo(self, False)
6746
6747 __swig_destroy__ = _core_.delete_PyApp
6748 __del__ = lambda self : None;
6749 def _setCallbackInfo(*args, **kwargs):
6750 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6751 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6752
6753 def GetAppName(*args, **kwargs):
6754 """
6755 GetAppName(self) -> String
6756
6757 Get the application name.
6758 """
6759 return _core_.PyApp_GetAppName(*args, **kwargs)
6760
6761 def SetAppName(*args, **kwargs):
6762 """
6763 SetAppName(self, String name)
6764
6765 Set the application name. This value may be used automatically by
6766 `wx.Config` and such.
6767 """
6768 return _core_.PyApp_SetAppName(*args, **kwargs)
6769
6770 def GetClassName(*args, **kwargs):
6771 """
6772 GetClassName(self) -> String
6773
6774 Get the application's class name.
6775 """
6776 return _core_.PyApp_GetClassName(*args, **kwargs)
6777
6778 def SetClassName(*args, **kwargs):
6779 """
6780 SetClassName(self, String name)
6781
6782 Set the application's class name. This value may be used for
6783 X-resources if applicable for the platform
6784 """
6785 return _core_.PyApp_SetClassName(*args, **kwargs)
6786
6787 def GetVendorName(*args, **kwargs):
6788 """
6789 GetVendorName(self) -> String
6790
6791 Get the application's vendor name.
6792 """
6793 return _core_.PyApp_GetVendorName(*args, **kwargs)
6794
6795 def SetVendorName(*args, **kwargs):
6796 """
6797 SetVendorName(self, String name)
6798
6799 Set the application's vendor name. This value may be used
6800 automatically by `wx.Config` and such.
6801 """
6802 return _core_.PyApp_SetVendorName(*args, **kwargs)
6803
6804 def GetTraits(*args, **kwargs):
6805 """
6806 GetTraits(self) -> wxAppTraits
6807
6808 Return (and create if necessary) the app traits object to which we
6809 delegate for everything which either should be configurable by the
6810 user (then he can change the default behaviour simply by overriding
6811 CreateTraits() and returning his own traits object) or which is
6812 GUI/console dependent as then wx.AppTraits allows us to abstract the
6813 differences behind the common facade.
6814
6815 :todo: Add support for overriding CreateAppTraits in wxPython.
6816 """
6817 return _core_.PyApp_GetTraits(*args, **kwargs)
6818
6819 def ProcessPendingEvents(*args, **kwargs):
6820 """
6821 ProcessPendingEvents(self)
6822
6823 Process all events in the Pending Events list -- it is necessary to
6824 call this function to process posted events. This normally happens
6825 during each event loop iteration.
6826 """
6827 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6828
6829 def Yield(*args, **kwargs):
6830 """
6831 Yield(self, bool onlyIfNeeded=False) -> bool
6832
6833 Process all currently pending events right now, instead of waiting
6834 until return to the event loop. It is an error to call ``Yield``
6835 recursively unless the value of ``onlyIfNeeded`` is True.
6836
6837 :warning: This function is dangerous as it can lead to unexpected
6838 reentrancies (i.e. when called from an event handler it may
6839 result in calling the same event handler again), use with
6840 extreme care or, better, don't use at all!
6841
6842 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6843
6844 """
6845 return _core_.PyApp_Yield(*args, **kwargs)
6846
6847 def WakeUpIdle(*args, **kwargs):
6848 """
6849 WakeUpIdle(self)
6850
6851 Make sure that idle events are sent again.
6852 :see: `wx.WakeUpIdle`
6853 """
6854 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6855
6856 def IsMainLoopRunning(*args, **kwargs):
6857 """
6858 IsMainLoopRunning() -> bool
6859
6860 Returns True if we're running the main loop, i.e. if the events can
6861 currently be dispatched.
6862 """
6863 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6864
6865 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
6866 def MainLoop(*args, **kwargs):
6867 """
6868 MainLoop(self) -> int
6869
6870 Execute the main GUI loop, the function doesn't normally return until
6871 all top level windows have been closed and destroyed.
6872 """
6873 return _core_.PyApp_MainLoop(*args, **kwargs)
6874
6875 def Exit(*args, **kwargs):
6876 """
6877 Exit(self)
6878
6879 Exit the main loop thus terminating the application.
6880 :see: `wx.Exit`
6881 """
6882 return _core_.PyApp_Exit(*args, **kwargs)
6883
6884 def GetLayoutDirection(*args, **kwargs):
6885 """
6886 GetLayoutDirection(self) -> int
6887
6888 Return the layout direction for the current locale.
6889 """
6890 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
6891
6892 def ExitMainLoop(*args, **kwargs):
6893 """
6894 ExitMainLoop(self)
6895
6896 Exit the main GUI loop during the next iteration of the main
6897 loop, (i.e. it does not stop the program immediately!)
6898 """
6899 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6900
6901 def Pending(*args, **kwargs):
6902 """
6903 Pending(self) -> bool
6904
6905 Returns True if there are unprocessed events in the event queue.
6906 """
6907 return _core_.PyApp_Pending(*args, **kwargs)
6908
6909 def Dispatch(*args, **kwargs):
6910 """
6911 Dispatch(self) -> bool
6912
6913 Process the first event in the event queue (blocks until an event
6914 appears if there are none currently)
6915 """
6916 return _core_.PyApp_Dispatch(*args, **kwargs)
6917
6918 def ProcessIdle(*args, **kwargs):
6919 """
6920 ProcessIdle(self) -> bool
6921
6922 Called from the MainLoop when the application becomes idle (there are
6923 no pending events) and sends a `wx.IdleEvent` to all interested
6924 parties. Returns True if more idle events are needed, False if not.
6925 """
6926 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6927
6928 def SendIdleEvents(*args, **kwargs):
6929 """
6930 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6931
6932 Send idle event to window and all subwindows. Returns True if more
6933 idle time is requested.
6934 """
6935 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6936
6937 def IsActive(*args, **kwargs):
6938 """
6939 IsActive(self) -> bool
6940
6941 Return True if our app has focus.
6942 """
6943 return _core_.PyApp_IsActive(*args, **kwargs)
6944
6945 def SetTopWindow(*args, **kwargs):
6946 """
6947 SetTopWindow(self, Window win)
6948
6949 Set the *main* top level window
6950 """
6951 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6952
6953 def GetTopWindow(*args, **kwargs):
6954 """
6955 GetTopWindow(self) -> Window
6956
6957 Return the *main* top level window (if it hadn't been set previously
6958 with SetTopWindow(), will return just some top level window and, if
6959 there not any, will return None)
6960 """
6961 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6962
6963 def SetExitOnFrameDelete(*args, **kwargs):
6964 """
6965 SetExitOnFrameDelete(self, bool flag)
6966
6967 Control the exit behaviour: by default, the program will exit the main
6968 loop (and so, usually, terminate) when the last top-level program
6969 window is deleted. Beware that if you disable this behaviour (with
6970 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6971 explicitly from somewhere.
6972 """
6973 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6974
6975 def GetExitOnFrameDelete(*args, **kwargs):
6976 """
6977 GetExitOnFrameDelete(self) -> bool
6978
6979 Get the current exit behaviour setting.
6980 """
6981 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6982
6983 def SetUseBestVisual(*args, **kwargs):
6984 """
6985 SetUseBestVisual(self, bool flag)
6986
6987 Set whether the app should try to use the best available visual on
6988 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6989 """
6990 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6991
6992 def GetUseBestVisual(*args, **kwargs):
6993 """
6994 GetUseBestVisual(self) -> bool
6995
6996 Get current UseBestVisual setting.
6997 """
6998 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6999
7000 def SetPrintMode(*args, **kwargs):
7001 """SetPrintMode(self, int mode)"""
7002 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7003
7004 def GetPrintMode(*args, **kwargs):
7005 """GetPrintMode(self) -> int"""
7006 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7007
7008 def SetAssertMode(*args, **kwargs):
7009 """
7010 SetAssertMode(self, int mode)
7011
7012 Set the OnAssert behaviour for debug and hybrid builds.
7013 """
7014 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7015
7016 def GetAssertMode(*args, **kwargs):
7017 """
7018 GetAssertMode(self) -> int
7019
7020 Get the current OnAssert behaviour setting.
7021 """
7022 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7023
7024 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
7025 """GetMacSupportPCMenuShortcuts() -> bool"""
7026 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7027
7028 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7029 def GetMacAboutMenuItemId(*args, **kwargs):
7030 """GetMacAboutMenuItemId() -> long"""
7031 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7032
7033 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7034 def GetMacPreferencesMenuItemId(*args, **kwargs):
7035 """GetMacPreferencesMenuItemId() -> long"""
7036 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7037
7038 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7039 def GetMacExitMenuItemId(*args, **kwargs):
7040 """GetMacExitMenuItemId() -> long"""
7041 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7042
7043 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7044 def GetMacHelpMenuTitleName(*args, **kwargs):
7045 """GetMacHelpMenuTitleName() -> String"""
7046 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7047
7048 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7049 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
7050 """SetMacSupportPCMenuShortcuts(bool val)"""
7051 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7052
7053 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7054 def SetMacAboutMenuItemId(*args, **kwargs):
7055 """SetMacAboutMenuItemId(long val)"""
7056 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7057
7058 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7059 def SetMacPreferencesMenuItemId(*args, **kwargs):
7060 """SetMacPreferencesMenuItemId(long val)"""
7061 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7062
7063 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7064 def SetMacExitMenuItemId(*args, **kwargs):
7065 """SetMacExitMenuItemId(long val)"""
7066 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7067
7068 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7069 def SetMacHelpMenuTitleName(*args, **kwargs):
7070 """SetMacHelpMenuTitleName(String val)"""
7071 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7072
7073 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7074 def _BootstrapApp(*args, **kwargs):
7075 """
7076 _BootstrapApp(self)
7077
7078 For internal use only
7079 """
7080 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7081
7082 def GetComCtl32Version(*args, **kwargs):
7083 """
7084 GetComCtl32Version() -> int
7085
7086 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7087 it wasn't found at all. Raises an exception on non-Windows platforms.
7088 """
7089 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7090
7091 GetComCtl32Version = staticmethod(GetComCtl32Version)
7092 def IsDisplayAvailable(*args, **kwargs):
7093 """
7094 IsDisplayAvailable() -> bool
7095
7096 Tests if it is possible to create a GUI in the current environment.
7097 This will mean different things on the different platforms.
7098
7099 * On X Windows systems this function will return ``False`` if it is
7100 not able to open a connection to the X display, which can happen
7101 if $DISPLAY is not set, or is not set correctly.
7102
7103 * On Mac OS X a ``False`` return value will mean that wx is not
7104 able to access the window manager, which can happen if logged in
7105 remotely or if running from the normal version of python instead
7106 of the framework version, (i.e., pythonw.)
7107
7108 * On MS Windows...
7109
7110 """
7111 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7112
7113 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7114 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7115 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7116 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7117 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7118 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7119 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7120 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7121 Traits = property(GetTraits,doc="See `GetTraits`")
7122 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7123 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7124 Active = property(IsActive)
7125 _core_.PyApp_swigregister(PyApp)
7126
7127 def PyApp_IsMainLoopRunning(*args):
7128 """
7129 PyApp_IsMainLoopRunning() -> bool
7130
7131 Returns True if we're running the main loop, i.e. if the events can
7132 currently be dispatched.
7133 """
7134 return _core_.PyApp_IsMainLoopRunning(*args)
7135
7136 def PyApp_GetMacSupportPCMenuShortcuts(*args):
7137 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7138 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7139
7140 def PyApp_GetMacAboutMenuItemId(*args):
7141 """PyApp_GetMacAboutMenuItemId() -> long"""
7142 return _core_.PyApp_GetMacAboutMenuItemId(*args)
7143
7144 def PyApp_GetMacPreferencesMenuItemId(*args):
7145 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7146 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7147
7148 def PyApp_GetMacExitMenuItemId(*args):
7149 """PyApp_GetMacExitMenuItemId() -> long"""
7150 return _core_.PyApp_GetMacExitMenuItemId(*args)
7151
7152 def PyApp_GetMacHelpMenuTitleName(*args):
7153 """PyApp_GetMacHelpMenuTitleName() -> String"""
7154 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7155
7156 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7157 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7158 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7159
7160 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7161 """PyApp_SetMacAboutMenuItemId(long val)"""
7162 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7163
7164 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7165 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7166 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7167
7168 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7169 """PyApp_SetMacExitMenuItemId(long val)"""
7170 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7171
7172 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7173 """PyApp_SetMacHelpMenuTitleName(String val)"""
7174 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7175
7176 def PyApp_GetComCtl32Version(*args):
7177 """
7178 PyApp_GetComCtl32Version() -> int
7179
7180 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7181 it wasn't found at all. Raises an exception on non-Windows platforms.
7182 """
7183 return _core_.PyApp_GetComCtl32Version(*args)
7184
7185 def PyApp_IsDisplayAvailable(*args):
7186 """
7187 PyApp_IsDisplayAvailable() -> bool
7188
7189 Tests if it is possible to create a GUI in the current environment.
7190 This will mean different things on the different platforms.
7191
7192 * On X Windows systems this function will return ``False`` if it is
7193 not able to open a connection to the X display, which can happen
7194 if $DISPLAY is not set, or is not set correctly.
7195
7196 * On Mac OS X a ``False`` return value will mean that wx is not
7197 able to access the window manager, which can happen if logged in
7198 remotely or if running from the normal version of python instead
7199 of the framework version, (i.e., pythonw.)
7200
7201 * On MS Windows...
7202
7203 """
7204 return _core_.PyApp_IsDisplayAvailable(*args)
7205
7206 #---------------------------------------------------------------------------
7207
7208
7209 def Exit(*args):
7210 """
7211 Exit()
7212
7213 Force an exit of the application. Convenience for wx.GetApp().Exit()
7214 """
7215 return _core_.Exit(*args)
7216
7217 def Yield(*args):
7218 """
7219 Yield() -> bool
7220
7221 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7222 """
7223 return _core_.Yield(*args)
7224
7225 def YieldIfNeeded(*args):
7226 """
7227 YieldIfNeeded() -> bool
7228
7229 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7230 """
7231 return _core_.YieldIfNeeded(*args)
7232
7233 def SafeYield(*args, **kwargs):
7234 """
7235 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7236
7237 This function is similar to `wx.Yield`, except that it disables the
7238 user input to all program windows before calling `wx.Yield` and
7239 re-enables it again afterwards. If ``win`` is not None, this window
7240 will remain enabled, allowing the implementation of some limited user
7241 interaction.
7242
7243 :Returns: the result of the call to `wx.Yield`.
7244 """
7245 return _core_.SafeYield(*args, **kwargs)
7246
7247 def WakeUpIdle(*args):
7248 """
7249 WakeUpIdle()
7250
7251 Cause the message queue to become empty again, so idle events will be
7252 sent.
7253 """
7254 return _core_.WakeUpIdle(*args)
7255
7256 def PostEvent(*args, **kwargs):
7257 """
7258 PostEvent(EvtHandler dest, Event event)
7259
7260 Send an event to a window or other wx.EvtHandler to be processed
7261 later.
7262 """
7263 return _core_.PostEvent(*args, **kwargs)
7264
7265 def App_CleanUp(*args):
7266 """
7267 App_CleanUp()
7268
7269 For internal use only, it is used to cleanup after wxWidgets when
7270 Python shuts down.
7271 """
7272 return _core_.App_CleanUp(*args)
7273
7274 def GetApp(*args):
7275 """
7276 GetApp() -> PyApp
7277
7278 Return a reference to the current wx.App object.
7279 """
7280 return _core_.GetApp(*args)
7281
7282 def SetDefaultPyEncoding(*args, **kwargs):
7283 """
7284 SetDefaultPyEncoding(string encoding)
7285
7286 Sets the encoding that wxPython will use when it needs to convert a
7287 Python string or unicode object to or from a wxString.
7288
7289 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7290 but please be aware that the default encoding within the same locale
7291 may be slightly different on different platforms. For example, please
7292 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7293 between the common latin/roman encodings.
7294 """
7295 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7296
7297 def GetDefaultPyEncoding(*args):
7298 """
7299 GetDefaultPyEncoding() -> string
7300
7301 Gets the current encoding that wxPython will use when it needs to
7302 convert a Python string or unicode object to or from a wxString.
7303 """
7304 return _core_.GetDefaultPyEncoding(*args)
7305 #----------------------------------------------------------------------
7306
7307 class PyOnDemandOutputWindow:
7308 """
7309 A class that can be used for redirecting Python's stdout and
7310 stderr streams. It will do nothing until something is wrriten to
7311 the stream at which point it will create a Frame with a text area
7312 and write the text there.
7313 """
7314 def __init__(self, title = "wxPython: stdout/stderr"):
7315 self.frame = None
7316 self.title = title
7317 self.pos = wx.DefaultPosition
7318 self.size = (450, 300)
7319 self.parent = None
7320
7321 def SetParent(self, parent):
7322 """Set the window to be used as the popup Frame's parent."""
7323 self.parent = parent
7324
7325
7326 def CreateOutputWindow(self, st):
7327 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7328 style=wx.DEFAULT_FRAME_STYLE)
7329 self.text = wx.TextCtrl(self.frame, -1, "",
7330 style=wx.TE_MULTILINE|wx.TE_READONLY)
7331 self.text.AppendText(st)
7332 self.frame.Show(True)
7333 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7334
7335
7336 def OnCloseWindow(self, event):
7337 if self.frame is not None:
7338 self.frame.Destroy()
7339 self.frame = None
7340 self.text = None
7341
7342
7343 # These methods provide the file-like output behaviour.
7344 def write(self, text):
7345 """
7346 Create the output window if needed and write the string to it.
7347 If not called in the context of the gui thread then uses
7348 CallAfter to do the work there.
7349 """
7350 if self.frame is None:
7351 if not wx.Thread_IsMain():
7352 wx.CallAfter(self.CreateOutputWindow, text)
7353 else:
7354 self.CreateOutputWindow(text)
7355 else:
7356 if not wx.Thread_IsMain():
7357 wx.CallAfter(self.text.AppendText, text)
7358 else:
7359 self.text.AppendText(text)
7360
7361
7362 def close(self):
7363 if self.frame is not None:
7364 wx.CallAfter(self.frame.Close)
7365
7366
7367 def flush(self):
7368 pass
7369
7370
7371
7372 #----------------------------------------------------------------------
7373
7374 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7375
7376 class App(wx.PyApp):
7377 """
7378 The ``wx.App`` class represents the application and is used to:
7379
7380 * bootstrap the wxPython system and initialize the underlying
7381 gui toolkit
7382 * set and get application-wide properties
7383 * implement the windowing system main message or event loop,
7384 and to dispatch events to window instances
7385 * etc.
7386
7387 Every application must have a ``wx.App`` instance, and all
7388 creation of UI objects should be delayed until after the
7389 ``wx.App`` object has been created in order to ensure that the gui
7390 platform and wxWidgets have been fully initialized.
7391
7392 Normally you would derive from this class and implement an
7393 ``OnInit`` method that creates a frame and then calls
7394 ``self.SetTopWindow(frame)``.
7395
7396 :see: `wx.PySimpleApp` for a simpler app class that can be used
7397 directly.
7398 """
7399
7400 outputWindowClass = PyOnDemandOutputWindow
7401
7402 def __init__(self, redirect=_defRedirect, filename=None,
7403 useBestVisual=False, clearSigInt=True):
7404 """
7405 Construct a ``wx.App`` object.
7406
7407 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7408 redirected? Defaults to True on Windows and Mac, False
7409 otherwise. If `filename` is None then output will be
7410 redirected to a window that pops up as needed. (You can
7411 control what kind of window is created for the output by
7412 resetting the class variable ``outputWindowClass`` to a
7413 class of your choosing.)
7414
7415 :param filename: The name of a file to redirect output to, if
7416 redirect is True.
7417
7418 :param useBestVisual: Should the app try to use the best
7419 available visual provided by the system (only relevant on
7420 systems that have more than one visual.) This parameter
7421 must be used instead of calling `SetUseBestVisual` later
7422 on because it must be set before the underlying GUI
7423 toolkit is initialized.
7424
7425 :param clearSigInt: Should SIGINT be cleared? This allows the
7426 app to terminate upon a Ctrl-C in the console like other
7427 GUI apps will.
7428
7429 :note: You should override OnInit to do applicaition
7430 initialization to ensure that the system, toolkit and
7431 wxWidgets are fully initialized.
7432 """
7433
7434 wx.PyApp.__init__(self)
7435
7436 # make sure we can create a GUI
7437 if not self.IsDisplayAvailable():
7438
7439 if wx.Platform == "__WXMAC__":
7440 msg = """This program needs access to the screen.
7441 Please run with 'pythonw', not 'python', and only when you are logged
7442 in on the main display of your Mac."""
7443
7444 elif wx.Platform == "__WXGTK__":
7445 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7446
7447 else:
7448 msg = "Unable to create GUI"
7449 # TODO: more description is needed for wxMSW...
7450
7451 raise SystemExit(msg)
7452
7453 # This has to be done before OnInit
7454 self.SetUseBestVisual(useBestVisual)
7455
7456 # Set the default handler for SIGINT. This fixes a problem
7457 # where if Ctrl-C is pressed in the console that started this
7458 # app then it will not appear to do anything, (not even send
7459 # KeyboardInterrupt???) but will later segfault on exit. By
7460 # setting the default handler then the app will exit, as
7461 # expected (depending on platform.)
7462 if clearSigInt:
7463 try:
7464 import signal
7465 signal.signal(signal.SIGINT, signal.SIG_DFL)
7466 except:
7467 pass
7468
7469 # Save and redirect the stdio to a window?
7470 self.stdioWin = None
7471 self.saveStdio = (_sys.stdout, _sys.stderr)
7472 if redirect:
7473 self.RedirectStdio(filename)
7474
7475 # Use Python's install prefix as the default
7476 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7477
7478 # This finishes the initialization of wxWindows and then calls
7479 # the OnInit that should be present in the derived class
7480 self._BootstrapApp()
7481
7482
7483 def OnPreInit(self):
7484 """
7485 Things that must be done after _BootstrapApp has done its
7486 thing, but would be nice if they were already done by the time
7487 that OnInit is called.
7488 """
7489 wx.StockGDI._initStockObjects()
7490
7491
7492 def __del__(self, destroy=wx.PyApp.__del__):
7493 self.RestoreStdio() # Just in case the MainLoop was overridden
7494 destroy(self)
7495
7496 def Destroy(self):
7497 self.this.own(False)
7498 wx.PyApp.Destroy(self)
7499
7500 def SetTopWindow(self, frame):
7501 """Set the \"main\" top level window"""
7502 if self.stdioWin:
7503 self.stdioWin.SetParent(frame)
7504 wx.PyApp.SetTopWindow(self, frame)
7505
7506
7507 def MainLoop(self):
7508 """Execute the main GUI event loop"""
7509 wx.PyApp.MainLoop(self)
7510 self.RestoreStdio()
7511
7512
7513 def RedirectStdio(self, filename=None):
7514 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7515 if filename:
7516 _sys.stdout = _sys.stderr = open(filename, 'a')
7517 else:
7518 self.stdioWin = self.outputWindowClass()
7519 _sys.stdout = _sys.stderr = self.stdioWin
7520
7521
7522 def RestoreStdio(self):
7523 try:
7524 _sys.stdout, _sys.stderr = self.saveStdio
7525 except:
7526 pass
7527
7528
7529 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7530 """
7531 Set the title, position and/or size of the output window if
7532 the stdio has been redirected. This should be called before
7533 any output would cause the output window to be created.
7534 """
7535 if self.stdioWin:
7536 if title is not None:
7537 self.stdioWin.title = title
7538 if pos is not None:
7539 self.stdioWin.pos = pos
7540 if size is not None:
7541 self.stdioWin.size = size
7542
7543
7544
7545
7546 # change from wx.PyApp_XX to wx.App_XX
7547 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7548 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7549 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7550 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7551 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7552 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7553 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7554 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7555 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7556 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7557 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7558
7559 #----------------------------------------------------------------------------
7560
7561 class PySimpleApp(wx.App):
7562 """
7563 A simple application class. You can just create one of these and
7564 then then make your top level windows later, and not have to worry
7565 about OnInit. For example::
7566
7567 app = wx.PySimpleApp()
7568 frame = wx.Frame(None, title='Hello World')
7569 frame.Show()
7570 app.MainLoop()
7571
7572 :see: `wx.App`
7573 """
7574
7575 def __init__(self, redirect=False, filename=None,
7576 useBestVisual=False, clearSigInt=True):
7577 """
7578 :see: `wx.App.__init__`
7579 """
7580 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7581
7582 def OnInit(self):
7583 return True
7584
7585
7586
7587 # Is anybody using this one?
7588 class PyWidgetTester(wx.App):
7589 def __init__(self, size = (250, 100)):
7590 self.size = size
7591 wx.App.__init__(self, 0)
7592
7593 def OnInit(self):
7594 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7595 self.SetTopWindow(self.frame)
7596 return True
7597
7598 def SetWidget(self, widgetClass, *args, **kwargs):
7599 w = widgetClass(self.frame, *args, **kwargs)
7600 self.frame.Show(True)
7601
7602 #----------------------------------------------------------------------------
7603 # DO NOT hold any other references to this object. This is how we
7604 # know when to cleanup system resources that wxWidgets is holding. When
7605 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7606 # goes to zero and it calls the wx.App_CleanUp function.
7607
7608 class __wxPyCleanup:
7609 def __init__(self):
7610 self.cleanup = _core_.App_CleanUp
7611 def __del__(self):
7612 self.cleanup()
7613
7614 _sys.__wxPythonCleanup = __wxPyCleanup()
7615
7616 ## # another possible solution, but it gets called too early...
7617 ## import atexit
7618 ## atexit.register(_core_.wxApp_CleanUp)
7619
7620
7621 #----------------------------------------------------------------------------
7622
7623 #---------------------------------------------------------------------------
7624
7625 class EventLoop(object):
7626 """Proxy of C++ EventLoop class"""
7627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7628 __repr__ = _swig_repr
7629 def __init__(self, *args, **kwargs):
7630 """__init__(self) -> EventLoop"""
7631 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7632 __swig_destroy__ = _core_.delete_EventLoop
7633 __del__ = lambda self : None;
7634 def Run(*args, **kwargs):
7635 """Run(self) -> int"""
7636 return _core_.EventLoop_Run(*args, **kwargs)
7637
7638 def Exit(*args, **kwargs):
7639 """Exit(self, int rc=0)"""
7640 return _core_.EventLoop_Exit(*args, **kwargs)
7641
7642 def Pending(*args, **kwargs):
7643 """Pending(self) -> bool"""
7644 return _core_.EventLoop_Pending(*args, **kwargs)
7645
7646 def Dispatch(*args, **kwargs):
7647 """Dispatch(self) -> bool"""
7648 return _core_.EventLoop_Dispatch(*args, **kwargs)
7649
7650 def IsRunning(*args, **kwargs):
7651 """IsRunning(self) -> bool"""
7652 return _core_.EventLoop_IsRunning(*args, **kwargs)
7653
7654 def GetActive(*args, **kwargs):
7655 """GetActive() -> EventLoop"""
7656 return _core_.EventLoop_GetActive(*args, **kwargs)
7657
7658 GetActive = staticmethod(GetActive)
7659 def SetActive(*args, **kwargs):
7660 """SetActive(EventLoop loop)"""
7661 return _core_.EventLoop_SetActive(*args, **kwargs)
7662
7663 SetActive = staticmethod(SetActive)
7664 _core_.EventLoop_swigregister(EventLoop)
7665
7666 def EventLoop_GetActive(*args):
7667 """EventLoop_GetActive() -> EventLoop"""
7668 return _core_.EventLoop_GetActive(*args)
7669
7670 def EventLoop_SetActive(*args, **kwargs):
7671 """EventLoop_SetActive(EventLoop loop)"""
7672 return _core_.EventLoop_SetActive(*args, **kwargs)
7673
7674 class EventLoopActivator(object):
7675 """Proxy of C++ EventLoopActivator class"""
7676 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7677 __repr__ = _swig_repr
7678 def __init__(self, *args, **kwargs):
7679 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7680 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7681 __swig_destroy__ = _core_.delete_EventLoopActivator
7682 __del__ = lambda self : None;
7683 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7684
7685 #---------------------------------------------------------------------------
7686
7687 ACCEL_ALT = _core_.ACCEL_ALT
7688 ACCEL_CTRL = _core_.ACCEL_CTRL
7689 ACCEL_SHIFT = _core_.ACCEL_SHIFT
7690 ACCEL_NORMAL = _core_.ACCEL_NORMAL
7691 ACCEL_CMD = _core_.ACCEL_CMD
7692 class AcceleratorEntry(object):
7693 """
7694 A class used to define items in an `wx.AcceleratorTable`. wxPython
7695 programs can choose to use wx.AcceleratorEntry objects, but using a
7696 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7697 as well. See `__init__` for of the tuple values.
7698
7699 :see: `wx.AcceleratorTable`
7700 """
7701 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7702 __repr__ = _swig_repr
7703 def __init__(self, *args, **kwargs):
7704 """
7705 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7706
7707 Construct a wx.AcceleratorEntry.
7708 """
7709 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7710 __swig_destroy__ = _core_.delete_AcceleratorEntry
7711 __del__ = lambda self : None;
7712 def Set(*args, **kwargs):
7713 """
7714 Set(self, int flags, int keyCode, int cmd)
7715
7716 (Re)set the attributes of a wx.AcceleratorEntry.
7717 :see `__init__`
7718 """
7719 return _core_.AcceleratorEntry_Set(*args, **kwargs)
7720
7721 def Create(*args, **kwargs):
7722 """
7723 Create(String str) -> AcceleratorEntry
7724
7725 Create accelerator corresponding to the specified string, or None if
7726 it coulnd't be parsed.
7727 """
7728 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7729
7730 Create = staticmethod(Create)
7731 def GetFlags(*args, **kwargs):
7732 """
7733 GetFlags(self) -> int
7734
7735 Get the AcceleratorEntry's flags.
7736 """
7737 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7738
7739 def GetKeyCode(*args, **kwargs):
7740 """
7741 GetKeyCode(self) -> int
7742
7743 Get the AcceleratorEntry's keycode.
7744 """
7745 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7746
7747 def GetCommand(*args, **kwargs):
7748 """
7749 GetCommand(self) -> int
7750
7751 Get the AcceleratorEntry's command ID.
7752 """
7753 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7754
7755 def IsOk(*args, **kwargs):
7756 """IsOk(self) -> bool"""
7757 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
7758
7759 def ToString(*args, **kwargs):
7760 """
7761 ToString(self) -> String
7762
7763 Returns a string representation for the this accelerator. The string
7764 is formatted using the <flags>-<keycode> format where <flags> maybe a
7765 hyphen-separed list of "shift|alt|ctrl"
7766
7767 """
7768 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
7769
7770 def FromString(*args, **kwargs):
7771 """
7772 FromString(self, String str) -> bool
7773
7774 Returns true if the given string correctly initialized this object.
7775 """
7776 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
7777
7778 Command = property(GetCommand,doc="See `GetCommand`")
7779 Flags = property(GetFlags,doc="See `GetFlags`")
7780 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
7781 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
7782
7783 def AcceleratorEntry_Create(*args, **kwargs):
7784 """
7785 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7786
7787 Create accelerator corresponding to the specified string, or None if
7788 it coulnd't be parsed.
7789 """
7790 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7791
7792 class AcceleratorTable(Object):
7793 """
7794 An accelerator table allows the application to specify a table of
7795 keyboard shortcuts for menus or other commands. On Windows, menu or
7796 button commands are supported; on GTK, only menu commands are
7797 supported.
7798 """
7799 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7800 __repr__ = _swig_repr
7801 def __init__(self, *args, **kwargs):
7802 """
7803 __init__(entries) -> AcceleratorTable
7804
7805 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7806 items or or of 3-tuples (flags, keyCode, cmdID)
7807
7808 :see: `wx.AcceleratorEntry`
7809 """
7810 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7811 __swig_destroy__ = _core_.delete_AcceleratorTable
7812 __del__ = lambda self : None;
7813 def IsOk(*args, **kwargs):
7814 """IsOk(self) -> bool"""
7815 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
7816
7817 Ok = IsOk
7818 _core_.AcceleratorTable_swigregister(AcceleratorTable)
7819
7820
7821 def GetAccelFromString(*args, **kwargs):
7822 """GetAccelFromString(String label) -> AcceleratorEntry"""
7823 return _core_.GetAccelFromString(*args, **kwargs)
7824 #---------------------------------------------------------------------------
7825
7826 class VisualAttributes(object):
7827 """struct containing all the visual attributes of a control"""
7828 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7829 __repr__ = _swig_repr
7830 def __init__(self, *args, **kwargs):
7831 """
7832 __init__(self) -> VisualAttributes
7833
7834 struct containing all the visual attributes of a control
7835 """
7836 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7837 __swig_destroy__ = _core_.delete_VisualAttributes
7838 __del__ = lambda self : None;
7839 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7840 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7841 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
7842 _core_.VisualAttributes_swigregister(VisualAttributes)
7843 NullAcceleratorTable = cvar.NullAcceleratorTable
7844 PanelNameStr = cvar.PanelNameStr
7845
7846 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7847 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7848 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7849 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7850 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7851 class Window(EvtHandler):
7852 """
7853 wx.Window is the base class for all windows and represents any visible
7854 object on the screen. All controls, top level windows and so on are
7855 wx.Windows. Sizers and device contexts are not however, as they don't
7856 appear on screen themselves.
7857
7858 """
7859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7860 __repr__ = _swig_repr
7861 def __init__(self, *args, **kwargs):
7862 """
7863 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7864 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7865
7866 Construct and show a generic Window.
7867 """
7868 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
7869 self._setOORInfo(self)
7870
7871 def Create(*args, **kwargs):
7872 """
7873 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7874 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7875
7876 Create the GUI part of the Window for 2-phase creation mode.
7877 """
7878 return _core_.Window_Create(*args, **kwargs)
7879
7880 def Close(*args, **kwargs):
7881 """
7882 Close(self, bool force=False) -> bool
7883
7884 This function simply generates a EVT_CLOSE event whose handler usually
7885 tries to close the window. It doesn't close the window itself,
7886 however. If force is False (the default) then the window's close
7887 handler will be allowed to veto the destruction of the window.
7888 """
7889 return _core_.Window_Close(*args, **kwargs)
7890
7891 def Destroy(*args, **kwargs):
7892 """
7893 Destroy(self) -> bool
7894
7895 Destroys the window safely. Frames and dialogs are not destroyed
7896 immediately when this function is called -- they are added to a list
7897 of windows to be deleted on idle time, when all the window's events
7898 have been processed. This prevents problems with events being sent to
7899 non-existent windows.
7900
7901 Returns True if the window has either been successfully deleted, or it
7902 has been added to the list of windows pending real deletion.
7903 """
7904 args[0].this.own(False)
7905 return _core_.Window_Destroy(*args, **kwargs)
7906
7907 def DestroyChildren(*args, **kwargs):
7908 """
7909 DestroyChildren(self) -> bool
7910
7911 Destroys all children of a window. Called automatically by the
7912 destructor.
7913 """
7914 return _core_.Window_DestroyChildren(*args, **kwargs)
7915
7916 def IsBeingDeleted(*args, **kwargs):
7917 """
7918 IsBeingDeleted(self) -> bool
7919
7920 Is the window in the process of being deleted?
7921 """
7922 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7923
7924 def SetLabel(*args, **kwargs):
7925 """
7926 SetLabel(self, String label)
7927
7928 Set the text which the window shows in its label if applicable.
7929 """
7930 return _core_.Window_SetLabel(*args, **kwargs)
7931
7932 def GetLabel(*args, **kwargs):
7933 """
7934 GetLabel(self) -> String
7935
7936 Generic way of getting a label from any window, for identification
7937 purposes. The interpretation of this function differs from class to
7938 class. For frames and dialogs, the value returned is the title. For
7939 buttons or static text controls, it is the button text. This function
7940 can be useful for meta-programs such as testing tools or special-needs
7941 access programs)which need to identify windows by name.
7942 """
7943 return _core_.Window_GetLabel(*args, **kwargs)
7944
7945 def SetName(*args, **kwargs):
7946 """
7947 SetName(self, String name)
7948
7949 Sets the window's name. The window name is used for ressource setting
7950 in X, it is not the same as the window title/label
7951 """
7952 return _core_.Window_SetName(*args, **kwargs)
7953
7954 def GetName(*args, **kwargs):
7955 """
7956 GetName(self) -> String
7957
7958 Returns the windows name. This name is not guaranteed to be unique;
7959 it is up to the programmer to supply an appropriate name in the window
7960 constructor or via wx.Window.SetName.
7961 """
7962 return _core_.Window_GetName(*args, **kwargs)
7963
7964 def SetWindowVariant(*args, **kwargs):
7965 """
7966 SetWindowVariant(self, int variant)
7967
7968 Sets the variant of the window/font size to use for this window, if
7969 the platform supports variants, for example, wxMac.
7970 """
7971 return _core_.Window_SetWindowVariant(*args, **kwargs)
7972
7973 def GetWindowVariant(*args, **kwargs):
7974 """GetWindowVariant(self) -> int"""
7975 return _core_.Window_GetWindowVariant(*args, **kwargs)
7976
7977 def SetId(*args, **kwargs):
7978 """
7979 SetId(self, int winid)
7980
7981 Sets the identifier of the window. Each window has an integer
7982 identifier. If the application has not provided one, an identifier
7983 will be generated. Normally, the identifier should be provided on
7984 creation and should not be modified subsequently.
7985 """
7986 return _core_.Window_SetId(*args, **kwargs)
7987
7988 def GetId(*args, **kwargs):
7989 """
7990 GetId(self) -> int
7991
7992 Returns the identifier of the window. Each window has an integer
7993 identifier. If the application has not provided one (or the default Id
7994 -1 is used) then an unique identifier with a negative value will be
7995 generated.
7996 """
7997 return _core_.Window_GetId(*args, **kwargs)
7998
7999 def NewControlId(*args, **kwargs):
8000 """
8001 NewControlId() -> int
8002
8003 Generate a control id for the controls which were not given one.
8004 """
8005 return _core_.Window_NewControlId(*args, **kwargs)
8006
8007 NewControlId = staticmethod(NewControlId)
8008 def NextControlId(*args, **kwargs):
8009 """
8010 NextControlId(int winid) -> int
8011
8012 Get the id of the control following the one with the given
8013 autogenerated) id
8014 """
8015 return _core_.Window_NextControlId(*args, **kwargs)
8016
8017 NextControlId = staticmethod(NextControlId)
8018 def PrevControlId(*args, **kwargs):
8019 """
8020 PrevControlId(int winid) -> int
8021
8022 Get the id of the control preceding the one with the given
8023 autogenerated) id
8024 """
8025 return _core_.Window_PrevControlId(*args, **kwargs)
8026
8027 PrevControlId = staticmethod(PrevControlId)
8028 def GetLayoutDirection(*args, **kwargs):
8029 """
8030 GetLayoutDirection(self) -> int
8031
8032 Get the layout direction (LTR or RTL) for this window. Returns
8033 ``wx.Layout_Default`` if layout direction is not supported.
8034 """
8035 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8036
8037 def SetLayoutDirection(*args, **kwargs):
8038 """
8039 SetLayoutDirection(self, int dir)
8040
8041 Set the layout direction (LTR or RTL) for this window.
8042 """
8043 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8044
8045 def AdjustForLayoutDirection(*args, **kwargs):
8046 """
8047 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8048
8049 Mirror coordinates for RTL layout if this window uses it and if the
8050 mirroring is not done automatically like Win32.
8051 """
8052 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8053
8054 def SetSize(*args, **kwargs):
8055 """
8056 SetSize(self, Size size)
8057
8058 Sets the size of the window in pixels.
8059 """
8060 return _core_.Window_SetSize(*args, **kwargs)
8061
8062 def SetDimensions(*args, **kwargs):
8063 """
8064 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8065
8066 Sets the position and size of the window in pixels. The sizeFlags
8067 parameter indicates the interpretation of the other params if they are
8068 equal to -1.
8069
8070 ======================== ======================================
8071 wx.SIZE_AUTO A -1 indicates that a class-specific
8072 default should be used.
8073 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8074 -1 values are supplied.
8075 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8076 interpreted as real dimensions, not
8077 default values.
8078 ======================== ======================================
8079
8080 """
8081 return _core_.Window_SetDimensions(*args, **kwargs)
8082
8083 def SetRect(*args, **kwargs):
8084 """
8085 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8086
8087 Sets the position and size of the window in pixels using a wx.Rect.
8088 """
8089 return _core_.Window_SetRect(*args, **kwargs)
8090
8091 def SetSizeWH(*args, **kwargs):
8092 """
8093 SetSizeWH(self, int width, int height)
8094
8095 Sets the size of the window in pixels.
8096 """
8097 return _core_.Window_SetSizeWH(*args, **kwargs)
8098
8099 def Move(*args, **kwargs):
8100 """
8101 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8102
8103 Moves the window to the given position.
8104 """
8105 return _core_.Window_Move(*args, **kwargs)
8106
8107 SetPosition = Move
8108 def MoveXY(*args, **kwargs):
8109 """
8110 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8111
8112 Moves the window to the given position.
8113 """
8114 return _core_.Window_MoveXY(*args, **kwargs)
8115
8116 def SetBestFittingSize(*args, **kwargs):
8117 """
8118 SetBestFittingSize(self, Size size=DefaultSize)
8119
8120 A 'Smart' SetSize that will fill in default size components with the
8121 window's *best size* values. Also set's the minsize for use with sizers.
8122 """
8123 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8124
8125 def Raise(*args, **kwargs):
8126 """
8127 Raise(self)
8128
8129 Raises the window to the top of the window hierarchy. In current
8130 version of wxWidgets this works both for manage and child windows.
8131 """
8132 return _core_.Window_Raise(*args, **kwargs)
8133
8134 def Lower(*args, **kwargs):
8135 """
8136 Lower(self)
8137
8138 Lowers the window to the bottom of the window hierarchy. In current
8139 version of wxWidgets this works both for manage and child windows.
8140 """
8141 return _core_.Window_Lower(*args, **kwargs)
8142
8143 def SetClientSize(*args, **kwargs):
8144 """
8145 SetClientSize(self, Size size)
8146
8147 This sets the size of the window client area in pixels. Using this
8148 function to size a window tends to be more device-independent than
8149 wx.Window.SetSize, since the application need not worry about what
8150 dimensions the border or title bar have when trying to fit the window
8151 around panel items, for example.
8152 """
8153 return _core_.Window_SetClientSize(*args, **kwargs)
8154
8155 def SetClientSizeWH(*args, **kwargs):
8156 """
8157 SetClientSizeWH(self, int width, int height)
8158
8159 This sets the size of the window client area in pixels. Using this
8160 function to size a window tends to be more device-independent than
8161 wx.Window.SetSize, since the application need not worry about what
8162 dimensions the border or title bar have when trying to fit the window
8163 around panel items, for example.
8164 """
8165 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8166
8167 def SetClientRect(*args, **kwargs):
8168 """
8169 SetClientRect(self, Rect rect)
8170
8171 This sets the size of the window client area in pixels. Using this
8172 function to size a window tends to be more device-independent than
8173 wx.Window.SetSize, since the application need not worry about what
8174 dimensions the border or title bar have when trying to fit the window
8175 around panel items, for example.
8176 """
8177 return _core_.Window_SetClientRect(*args, **kwargs)
8178
8179 def GetPosition(*args, **kwargs):
8180 """
8181 GetPosition(self) -> Point
8182
8183 Get the window's position. Notice that the position is in client
8184 coordinates for child windows and screen coordinates for the top level
8185 ones, use `GetScreenPosition` if you need screen coordinates for all
8186 kinds of windows.
8187 """
8188 return _core_.Window_GetPosition(*args, **kwargs)
8189
8190 def GetPositionTuple(*args, **kwargs):
8191 """
8192 GetPositionTuple() -> (x,y)
8193
8194 Get the window's position. Notice that the position is in client
8195 coordinates for child windows and screen coordinates for the top level
8196 ones, use `GetScreenPosition` if you need screen coordinates for all
8197 kinds of windows.
8198 """
8199 return _core_.Window_GetPositionTuple(*args, **kwargs)
8200
8201 def GetScreenPosition(*args, **kwargs):
8202 """
8203 GetScreenPosition(self) -> Point
8204
8205 Get the position of the window in screen coordinantes.
8206 """
8207 return _core_.Window_GetScreenPosition(*args, **kwargs)
8208
8209 def GetScreenPositionTuple(*args, **kwargs):
8210 """
8211 GetScreenPositionTuple() -> (x,y)
8212
8213 Get the position of the window in screen coordinantes.
8214 """
8215 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8216
8217 def GetScreenRect(*args, **kwargs):
8218 """
8219 GetScreenRect(self) -> Rect
8220
8221 Returns the size and position of the window in screen coordinantes as
8222 a `wx.Rect` object.
8223 """
8224 return _core_.Window_GetScreenRect(*args, **kwargs)
8225
8226 def GetSize(*args, **kwargs):
8227 """
8228 GetSize(self) -> Size
8229
8230 Get the window size.
8231 """
8232 return _core_.Window_GetSize(*args, **kwargs)
8233
8234 def GetSizeTuple(*args, **kwargs):
8235 """
8236 GetSizeTuple() -> (width, height)
8237
8238 Get the window size.
8239 """
8240 return _core_.Window_GetSizeTuple(*args, **kwargs)
8241
8242 def GetRect(*args, **kwargs):
8243 """
8244 GetRect(self) -> Rect
8245
8246 Returns the size and position of the window as a `wx.Rect` object.
8247 """
8248 return _core_.Window_GetRect(*args, **kwargs)
8249
8250 def GetClientSize(*args, **kwargs):
8251 """
8252 GetClientSize(self) -> Size
8253
8254 This gets the size of the window's 'client area' in pixels. The client
8255 area is the area which may be drawn on by the programmer, excluding
8256 title bar, border, scrollbars, etc.
8257 """
8258 return _core_.Window_GetClientSize(*args, **kwargs)
8259
8260 def GetClientSizeTuple(*args, **kwargs):
8261 """
8262 GetClientSizeTuple() -> (width, height)
8263
8264 This gets the size of the window's 'client area' in pixels. The client
8265 area is the area which may be drawn on by the programmer, excluding
8266 title bar, border, scrollbars, etc.
8267 """
8268 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8269
8270 def GetClientAreaOrigin(*args, **kwargs):
8271 """
8272 GetClientAreaOrigin(self) -> Point
8273
8274 Get the origin of the client area of the window relative to the
8275 window's top left corner (the client area may be shifted because of
8276 the borders, scrollbars, other decorations...)
8277 """
8278 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8279
8280 def GetClientRect(*args, **kwargs):
8281 """
8282 GetClientRect(self) -> Rect
8283
8284 Get the client area position and size as a `wx.Rect` object.
8285 """
8286 return _core_.Window_GetClientRect(*args, **kwargs)
8287
8288 def GetBestSize(*args, **kwargs):
8289 """
8290 GetBestSize(self) -> Size
8291
8292 This function returns the best acceptable minimal size for the
8293 window, if applicable. For example, for a static text control, it will
8294 be the minimal size such that the control label is not truncated. For
8295 windows containing subwindows (suzh aswx.Panel), the size returned by
8296 this function will be the same as the size the window would have had
8297 after calling Fit.
8298 """
8299 return _core_.Window_GetBestSize(*args, **kwargs)
8300
8301 def GetBestSizeTuple(*args, **kwargs):
8302 """
8303 GetBestSizeTuple() -> (width, height)
8304
8305 This function returns the best acceptable minimal size for the
8306 window, if applicable. For example, for a static text control, it will
8307 be the minimal size such that the control label is not truncated. For
8308 windows containing subwindows (suzh aswx.Panel), the size returned by
8309 this function will be the same as the size the window would have had
8310 after calling Fit.
8311 """
8312 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8313
8314 def InvalidateBestSize(*args, **kwargs):
8315 """
8316 InvalidateBestSize(self)
8317
8318 Reset the cached best size value so it will be recalculated the next
8319 time it is needed.
8320 """
8321 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8322
8323 def CacheBestSize(*args, **kwargs):
8324 """
8325 CacheBestSize(self, Size size)
8326
8327 Cache the best size so it doesn't need to be calculated again, (at least until
8328 some properties of the window change.)
8329 """
8330 return _core_.Window_CacheBestSize(*args, **kwargs)
8331
8332 def GetBestFittingSize(*args, **kwargs):
8333 """
8334 GetBestFittingSize(self) -> Size
8335
8336 This function will merge the window's best size into the window's
8337 minimum size, giving priority to the min size components, and returns
8338 the results.
8339
8340 """
8341 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8342
8343 def GetAdjustedBestSize(*args, **kwargs):
8344 """
8345 GetAdjustedBestSize(self) -> Size
8346
8347 This method is similar to GetBestSize, except in one
8348 thing. GetBestSize should return the minimum untruncated size of the
8349 window, while this method will return the largest of BestSize and any
8350 user specified minimum size. ie. it is the minimum size the window
8351 should currently be drawn at, not the minimal size it can possibly
8352 tolerate.
8353 """
8354 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8355
8356 def Center(*args, **kwargs):
8357 """
8358 Center(self, int direction=BOTH)
8359
8360 Centers the window. The parameter specifies the direction for
8361 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8362 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8363 on the entire screen and not on its parent window. If it is a
8364 top-level window and has no parent then it will always be centered
8365 relative to the screen.
8366 """
8367 return _core_.Window_Center(*args, **kwargs)
8368
8369 Centre = Center
8370 def CenterOnParent(*args, **kwargs):
8371 """
8372 CenterOnParent(self, int dir=BOTH)
8373
8374 Center with respect to the the parent window
8375 """
8376 return _core_.Window_CenterOnParent(*args, **kwargs)
8377
8378 CentreOnParent = CenterOnParent
8379 def Fit(*args, **kwargs):
8380 """
8381 Fit(self)
8382
8383 Sizes the window so that it fits around its subwindows. This function
8384 won't do anything if there are no subwindows and will only really work
8385 correctly if sizers are used for the subwindows layout. Also, if the
8386 window has exactly one subwindow it is better (faster and the result
8387 is more precise as Fit adds some margin to account for fuzziness of
8388 its calculations) to call window.SetClientSize(child.GetSize())
8389 instead of calling Fit.
8390 """
8391 return _core_.Window_Fit(*args, **kwargs)
8392
8393 def FitInside(*args, **kwargs):
8394 """
8395 FitInside(self)
8396
8397 Similar to Fit, but sizes the interior (virtual) size of a
8398 window. Mainly useful with scrolled windows to reset scrollbars after
8399 sizing changes that do not trigger a size event, and/or scrolled
8400 windows without an interior sizer. This function similarly won't do
8401 anything if there are no subwindows.
8402 """
8403 return _core_.Window_FitInside(*args, **kwargs)
8404
8405 def SetSizeHints(*args, **kwargs):
8406 """
8407 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8408 int incH=-1)
8409
8410 Allows specification of minimum and maximum window sizes, and window
8411 size increments. If a pair of values is not set (or set to -1), the
8412 default values will be used. If this function is called, the user
8413 will not be able to size the window outside the given bounds (if it is
8414 a top-level window.) Sizers will also inspect the minimum window size
8415 and will use that value if set when calculating layout.
8416
8417 The resizing increments are only significant under Motif or Xt.
8418 """
8419 return _core_.Window_SetSizeHints(*args, **kwargs)
8420
8421 def SetSizeHintsSz(*args, **kwargs):
8422 """
8423 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8424
8425 Allows specification of minimum and maximum window sizes, and window
8426 size increments. If a pair of values is not set (or set to -1), the
8427 default values will be used. If this function is called, the user
8428 will not be able to size the window outside the given bounds (if it is
8429 a top-level window.) Sizers will also inspect the minimum window size
8430 and will use that value if set when calculating layout.
8431
8432 The resizing increments are only significant under Motif or Xt.
8433 """
8434 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8435
8436 def SetVirtualSizeHints(*args, **kwargs):
8437 """
8438 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8439
8440 Allows specification of minimum and maximum virtual window sizes. If a
8441 pair of values is not set (or set to -1), the default values will be
8442 used. If this function is called, the user will not be able to size
8443 the virtual area of the window outside the given bounds.
8444 """
8445 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8446
8447 def SetVirtualSizeHintsSz(*args, **kwargs):
8448 """
8449 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8450
8451 Allows specification of minimum and maximum virtual window sizes. If a
8452 pair of values is not set (or set to -1), the default values will be
8453 used. If this function is called, the user will not be able to size
8454 the virtual area of the window outside the given bounds.
8455 """
8456 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8457
8458 def GetMaxSize(*args, **kwargs):
8459 """GetMaxSize(self) -> Size"""
8460 return _core_.Window_GetMaxSize(*args, **kwargs)
8461
8462 def GetMinSize(*args, **kwargs):
8463 """GetMinSize(self) -> Size"""
8464 return _core_.Window_GetMinSize(*args, **kwargs)
8465
8466 def SetMinSize(*args, **kwargs):
8467 """
8468 SetMinSize(self, Size minSize)
8469
8470 A more convenient method than `SetSizeHints` for setting just the
8471 min size.
8472 """
8473 return _core_.Window_SetMinSize(*args, **kwargs)
8474
8475 def SetMaxSize(*args, **kwargs):
8476 """
8477 SetMaxSize(self, Size maxSize)
8478
8479 A more convenient method than `SetSizeHints` for setting just the
8480 max size.
8481 """
8482 return _core_.Window_SetMaxSize(*args, **kwargs)
8483
8484 def GetMinWidth(*args, **kwargs):
8485 """GetMinWidth(self) -> int"""
8486 return _core_.Window_GetMinWidth(*args, **kwargs)
8487
8488 def GetMinHeight(*args, **kwargs):
8489 """GetMinHeight(self) -> int"""
8490 return _core_.Window_GetMinHeight(*args, **kwargs)
8491
8492 def GetMaxWidth(*args, **kwargs):
8493 """GetMaxWidth(self) -> int"""
8494 return _core_.Window_GetMaxWidth(*args, **kwargs)
8495
8496 def GetMaxHeight(*args, **kwargs):
8497 """GetMaxHeight(self) -> int"""
8498 return _core_.Window_GetMaxHeight(*args, **kwargs)
8499
8500 def SetVirtualSize(*args, **kwargs):
8501 """
8502 SetVirtualSize(self, Size size)
8503
8504 Set the the virtual size of a window in pixels. For most windows this
8505 is just the client area of the window, but for some like scrolled
8506 windows it is more or less independent of the screen window size.
8507 """
8508 return _core_.Window_SetVirtualSize(*args, **kwargs)
8509
8510 def SetVirtualSizeWH(*args, **kwargs):
8511 """
8512 SetVirtualSizeWH(self, int w, int h)
8513
8514 Set the the virtual size of a window in pixels. For most windows this
8515 is just the client area of the window, but for some like scrolled
8516 windows it is more or less independent of the screen window size.
8517 """
8518 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8519
8520 def GetVirtualSize(*args, **kwargs):
8521 """
8522 GetVirtualSize(self) -> Size
8523
8524 Get the the virtual size of the window in pixels. For most windows
8525 this is just the client area of the window, but for some like scrolled
8526 windows it is more or less independent of the screen window size.
8527 """
8528 return _core_.Window_GetVirtualSize(*args, **kwargs)
8529
8530 def GetVirtualSizeTuple(*args, **kwargs):
8531 """
8532 GetVirtualSizeTuple() -> (width, height)
8533
8534 Get the the virtual size of the window in pixels. For most windows
8535 this is just the client area of the window, but for some like scrolled
8536 windows it is more or less independent of the screen window size.
8537 """
8538 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8539
8540 def GetBestVirtualSize(*args, **kwargs):
8541 """
8542 GetBestVirtualSize(self) -> Size
8543
8544 Return the largest of ClientSize and BestSize (as determined by a
8545 sizer, interior children, or other means)
8546 """
8547 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8548
8549 def Show(*args, **kwargs):
8550 """
8551 Show(self, bool show=True) -> bool
8552
8553 Shows or hides the window. You may need to call Raise for a top level
8554 window if you want to bring it to top, although this is not needed if
8555 Show is called immediately after the frame creation. Returns True if
8556 the window has been shown or hidden or False if nothing was done
8557 because it already was in the requested state.
8558 """
8559 return _core_.Window_Show(*args, **kwargs)
8560
8561 def Hide(*args, **kwargs):
8562 """
8563 Hide(self) -> bool
8564
8565 Equivalent to calling Show(False).
8566 """
8567 return _core_.Window_Hide(*args, **kwargs)
8568
8569 def Enable(*args, **kwargs):
8570 """
8571 Enable(self, bool enable=True) -> bool
8572
8573 Enable or disable the window for user input. Note that when a parent
8574 window is disabled, all of its children are disabled as well and they
8575 are reenabled again when the parent is. Returns true if the window
8576 has been enabled or disabled, false if nothing was done, i.e. if the
8577 window had already been in the specified state.
8578 """
8579 return _core_.Window_Enable(*args, **kwargs)
8580
8581 def Disable(*args, **kwargs):
8582 """
8583 Disable(self) -> bool
8584
8585 Disables the window, same as Enable(false).
8586 """
8587 return _core_.Window_Disable(*args, **kwargs)
8588
8589 def IsShown(*args, **kwargs):
8590 """
8591 IsShown(self) -> bool
8592
8593 Returns true if the window is shown, false if it has been hidden.
8594 """
8595 return _core_.Window_IsShown(*args, **kwargs)
8596
8597 def IsEnabled(*args, **kwargs):
8598 """
8599 IsEnabled(self) -> bool
8600
8601 Returns true if the window is enabled for input, false otherwise.
8602 """
8603 return _core_.Window_IsEnabled(*args, **kwargs)
8604
8605 def IsShownOnScreen(*args, **kwargs):
8606 """
8607 IsShownOnScreen(self) -> bool
8608
8609 Returns ``True`` if the window is physically visible on the screen,
8610 i.e. it is shown and all its parents up to the toplevel window are
8611 shown as well.
8612 """
8613 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8614
8615 def SetWindowStyleFlag(*args, **kwargs):
8616 """
8617 SetWindowStyleFlag(self, long style)
8618
8619 Sets the style of the window. Please note that some styles cannot be
8620 changed after the window creation and that Refresh() might need to be
8621 called after changing the others for the change to take place
8622 immediately.
8623 """
8624 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8625
8626 def GetWindowStyleFlag(*args, **kwargs):
8627 """
8628 GetWindowStyleFlag(self) -> long
8629
8630 Gets the window style that was passed to the constructor or Create
8631 method.
8632 """
8633 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8634
8635 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8636 def HasFlag(*args, **kwargs):
8637 """
8638 HasFlag(self, int flag) -> bool
8639
8640 Test if the given style is set for this window.
8641 """
8642 return _core_.Window_HasFlag(*args, **kwargs)
8643
8644 def IsRetained(*args, **kwargs):
8645 """
8646 IsRetained(self) -> bool
8647
8648 Returns true if the window is retained, false otherwise. Retained
8649 windows are only available on X platforms.
8650 """
8651 return _core_.Window_IsRetained(*args, **kwargs)
8652
8653 def SetExtraStyle(*args, **kwargs):
8654 """
8655 SetExtraStyle(self, long exStyle)
8656
8657 Sets the extra style bits for the window. Extra styles are the less
8658 often used style bits which can't be set with the constructor or with
8659 SetWindowStyleFlag()
8660 """
8661 return _core_.Window_SetExtraStyle(*args, **kwargs)
8662
8663 def GetExtraStyle(*args, **kwargs):
8664 """
8665 GetExtraStyle(self) -> long
8666
8667 Returns the extra style bits for the window.
8668 """
8669 return _core_.Window_GetExtraStyle(*args, **kwargs)
8670
8671 def MakeModal(*args, **kwargs):
8672 """
8673 MakeModal(self, bool modal=True)
8674
8675 Disables all other windows in the application so that the user can
8676 only interact with this window. Passing False will reverse this
8677 effect.
8678 """
8679 return _core_.Window_MakeModal(*args, **kwargs)
8680
8681 def SetThemeEnabled(*args, **kwargs):
8682 """
8683 SetThemeEnabled(self, bool enableTheme)
8684
8685 This function tells a window if it should use the system's "theme"
8686 code to draw the windows' background instead if its own background
8687 drawing code. This will only have an effect on platforms that support
8688 the notion of themes in user defined windows. One such platform is
8689 GTK+ where windows can have (very colourful) backgrounds defined by a
8690 user's selected theme.
8691
8692 Dialogs, notebook pages and the status bar have this flag set to true
8693 by default so that the default look and feel is simulated best.
8694 """
8695 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8696
8697 def GetThemeEnabled(*args, **kwargs):
8698 """
8699 GetThemeEnabled(self) -> bool
8700
8701 Return the themeEnabled flag.
8702 """
8703 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8704
8705 def SetFocus(*args, **kwargs):
8706 """
8707 SetFocus(self)
8708
8709 Set's the focus to this window, allowing it to receive keyboard input.
8710 """
8711 return _core_.Window_SetFocus(*args, **kwargs)
8712
8713 def SetFocusFromKbd(*args, **kwargs):
8714 """
8715 SetFocusFromKbd(self)
8716
8717 Set focus to this window as the result of a keyboard action. Normally
8718 only called internally.
8719 """
8720 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8721
8722 def FindFocus(*args, **kwargs):
8723 """
8724 FindFocus() -> Window
8725
8726 Returns the window or control that currently has the keyboard focus,
8727 or None.
8728 """
8729 return _core_.Window_FindFocus(*args, **kwargs)
8730
8731 FindFocus = staticmethod(FindFocus)
8732 def AcceptsFocus(*args, **kwargs):
8733 """
8734 AcceptsFocus(self) -> bool
8735
8736 Can this window have focus?
8737 """
8738 return _core_.Window_AcceptsFocus(*args, **kwargs)
8739
8740 def AcceptsFocusFromKeyboard(*args, **kwargs):
8741 """
8742 AcceptsFocusFromKeyboard(self) -> bool
8743
8744 Can this window be given focus by keyboard navigation? if not, the
8745 only way to give it focus (provided it accepts it at all) is to click
8746 it.
8747 """
8748 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8749
8750 def Navigate(*args, **kwargs):
8751 """
8752 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8753
8754 Does keyboard navigation from this window to another, by sending a
8755 `wx.NavigationKeyEvent`.
8756 """
8757 return _core_.Window_Navigate(*args, **kwargs)
8758
8759 def MoveAfterInTabOrder(*args, **kwargs):
8760 """
8761 MoveAfterInTabOrder(self, Window win)
8762
8763 Moves this window in the tab navigation order after the specified
8764 sibling window. This means that when the user presses the TAB key on
8765 that other window, the focus switches to this window.
8766
8767 The default tab order is the same as creation order. This function
8768 and `MoveBeforeInTabOrder` allow to change it after creating all the
8769 windows.
8770
8771 """
8772 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8773
8774 def MoveBeforeInTabOrder(*args, **kwargs):
8775 """
8776 MoveBeforeInTabOrder(self, Window win)
8777
8778 Same as `MoveAfterInTabOrder` except that it inserts this window just
8779 before win instead of putting it right after it.
8780 """
8781 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8782
8783 def GetChildren(*args, **kwargs):
8784 """
8785 GetChildren(self) -> PyObject
8786
8787 Returns a list of the window's children. NOTE: Currently this is a
8788 copy of the child window list maintained by the window, so the return
8789 value of this function is only valid as long as the window's children
8790 do not change.
8791 """
8792 return _core_.Window_GetChildren(*args, **kwargs)
8793
8794 def GetParent(*args, **kwargs):
8795 """
8796 GetParent(self) -> Window
8797
8798 Returns the parent window of this window, or None if there isn't one.
8799 """
8800 return _core_.Window_GetParent(*args, **kwargs)
8801
8802 def GetGrandParent(*args, **kwargs):
8803 """
8804 GetGrandParent(self) -> Window
8805
8806 Returns the parent of the parent of this window, or None if there
8807 isn't one.
8808 """
8809 return _core_.Window_GetGrandParent(*args, **kwargs)
8810
8811 def IsTopLevel(*args, **kwargs):
8812 """
8813 IsTopLevel(self) -> bool
8814
8815 Returns true if the given window is a top-level one. Currently all
8816 frames and dialogs are always considered to be top-level windows (even
8817 if they have a parent window).
8818 """
8819 return _core_.Window_IsTopLevel(*args, **kwargs)
8820
8821 def Reparent(*args, **kwargs):
8822 """
8823 Reparent(self, Window newParent) -> bool
8824
8825 Reparents the window, i.e the window will be removed from its current
8826 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8827 re-inserted into another. Available on Windows and GTK. Returns True
8828 if the parent was changed, False otherwise (error or newParent ==
8829 oldParent)
8830 """
8831 return _core_.Window_Reparent(*args, **kwargs)
8832
8833 def AddChild(*args, **kwargs):
8834 """
8835 AddChild(self, Window child)
8836
8837 Adds a child window. This is called automatically by window creation
8838 functions so should not be required by the application programmer.
8839 """
8840 return _core_.Window_AddChild(*args, **kwargs)
8841
8842 def RemoveChild(*args, **kwargs):
8843 """
8844 RemoveChild(self, Window child)
8845
8846 Removes a child window. This is called automatically by window
8847 deletion functions so should not be required by the application
8848 programmer.
8849 """
8850 return _core_.Window_RemoveChild(*args, **kwargs)
8851
8852 def SetDoubleBuffered(*args, **kwargs):
8853 """
8854 SetDoubleBuffered(self, bool on)
8855
8856 Currently wxGTK2 only.
8857 """
8858 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8859
8860 def FindWindowById(*args, **kwargs):
8861 """
8862 FindWindowById(self, long winid) -> Window
8863
8864 Find a chld of this window by window ID
8865 """
8866 return _core_.Window_FindWindowById(*args, **kwargs)
8867
8868 def FindWindowByName(*args, **kwargs):
8869 """
8870 FindWindowByName(self, String name) -> Window
8871
8872 Find a child of this window by name
8873 """
8874 return _core_.Window_FindWindowByName(*args, **kwargs)
8875
8876 def GetEventHandler(*args, **kwargs):
8877 """
8878 GetEventHandler(self) -> EvtHandler
8879
8880 Returns the event handler for this window. By default, the window is
8881 its own event handler.
8882 """
8883 return _core_.Window_GetEventHandler(*args, **kwargs)
8884
8885 def SetEventHandler(*args, **kwargs):
8886 """
8887 SetEventHandler(self, EvtHandler handler)
8888
8889 Sets the event handler for this window. An event handler is an object
8890 that is capable of processing the events sent to a window. (In other
8891 words, is able to dispatch the events to handler function.) By
8892 default, the window is its own event handler, but an application may
8893 wish to substitute another, for example to allow central
8894 implementation of event-handling for a variety of different window
8895 classes.
8896
8897 It is usually better to use `wx.Window.PushEventHandler` since this sets
8898 up a chain of event handlers, where an event not handled by one event
8899 handler is handed off to the next one in the chain.
8900 """
8901 return _core_.Window_SetEventHandler(*args, **kwargs)
8902
8903 def PushEventHandler(*args, **kwargs):
8904 """
8905 PushEventHandler(self, EvtHandler handler)
8906
8907 Pushes this event handler onto the event handler stack for the window.
8908 An event handler is an object that is capable of processing the events
8909 sent to a window. (In other words, is able to dispatch the events to
8910 handler function.) By default, the window is its own event handler,
8911 but an application may wish to substitute another, for example to
8912 allow central implementation of event-handling for a variety of
8913 different window classes.
8914
8915 wx.Window.PushEventHandler allows an application to set up a chain of
8916 event handlers, where an event not handled by one event handler is
8917 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
8918 to remove the event handler. Ownership of the handler is *not* given
8919 to the window, so you should be sure to pop the handler before the
8920 window is destroyed and either let PopEventHandler destroy it, or call
8921 its Destroy method yourself.
8922 """
8923 return _core_.Window_PushEventHandler(*args, **kwargs)
8924
8925 def PopEventHandler(*args, **kwargs):
8926 """
8927 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8928
8929 Removes and returns the top-most event handler on the event handler
8930 stack. If deleteHandler is True then the wx.EvtHandler object will be
8931 destroyed after it is popped, and ``None`` will be returned instead.
8932 """
8933 return _core_.Window_PopEventHandler(*args, **kwargs)
8934
8935 def RemoveEventHandler(*args, **kwargs):
8936 """
8937 RemoveEventHandler(self, EvtHandler handler) -> bool
8938
8939 Find the given handler in the event handler chain and remove (but not
8940 delete) it from the event handler chain, returns True if it was found
8941 and False otherwise (this also results in an assert failure so this
8942 function should only be called when the handler is supposed to be
8943 there.)
8944 """
8945 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8946
8947 def SetValidator(*args, **kwargs):
8948 """
8949 SetValidator(self, Validator validator)
8950
8951 Deletes the current validator (if any) and sets the window validator,
8952 having called wx.Validator.Clone to create a new validator of this
8953 type.
8954 """
8955 return _core_.Window_SetValidator(*args, **kwargs)
8956
8957 def GetValidator(*args, **kwargs):
8958 """
8959 GetValidator(self) -> Validator
8960
8961 Returns a pointer to the current validator for the window, or None if
8962 there is none.
8963 """
8964 return _core_.Window_GetValidator(*args, **kwargs)
8965
8966 def Validate(*args, **kwargs):
8967 """
8968 Validate(self) -> bool
8969
8970 Validates the current values of the child controls using their
8971 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8972 style flag set, the method will also call Validate() of all child
8973 windows. Returns false if any of the validations failed.
8974 """
8975 return _core_.Window_Validate(*args, **kwargs)
8976
8977 def TransferDataToWindow(*args, **kwargs):
8978 """
8979 TransferDataToWindow(self) -> bool
8980
8981 Transfers values to child controls from data areas specified by their
8982 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8983 style flag set, the method will also call TransferDataToWindow() of
8984 all child windows.
8985 """
8986 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8987
8988 def TransferDataFromWindow(*args, **kwargs):
8989 """
8990 TransferDataFromWindow(self) -> bool
8991
8992 Transfers values from child controls to data areas specified by their
8993 validators. Returns false if a transfer failed. If the window has
8994 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8995 also call TransferDataFromWindow() of all child windows.
8996 """
8997 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8998
8999 def InitDialog(*args, **kwargs):
9000 """
9001 InitDialog(self)
9002
9003 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9004 to the dialog via validators.
9005 """
9006 return _core_.Window_InitDialog(*args, **kwargs)
9007
9008 def SetAcceleratorTable(*args, **kwargs):
9009 """
9010 SetAcceleratorTable(self, AcceleratorTable accel)
9011
9012 Sets the accelerator table for this window.
9013 """
9014 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9015
9016 def GetAcceleratorTable(*args, **kwargs):
9017 """
9018 GetAcceleratorTable(self) -> AcceleratorTable
9019
9020 Gets the accelerator table for this window.
9021 """
9022 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9023
9024 def RegisterHotKey(*args, **kwargs):
9025 """
9026 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9027
9028 Registers a system wide hotkey. Every time the user presses the hotkey
9029 registered here, this window will receive a hotkey event. It will
9030 receive the event even if the application is in the background and
9031 does not have the input focus because the user is working with some
9032 other application. To bind an event handler function to this hotkey
9033 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9034 hotkey was registered successfully.
9035 """
9036 return _core_.Window_RegisterHotKey(*args, **kwargs)
9037
9038 def UnregisterHotKey(*args, **kwargs):
9039 """
9040 UnregisterHotKey(self, int hotkeyId) -> bool
9041
9042 Unregisters a system wide hotkey.
9043 """
9044 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9045
9046 def ConvertDialogPointToPixels(*args, **kwargs):
9047 """
9048 ConvertDialogPointToPixels(self, Point pt) -> Point
9049
9050 Converts a point or size from dialog units to pixels. Dialog units
9051 are used for maintaining a dialog's proportions even if the font
9052 changes. For the x dimension, the dialog units are multiplied by the
9053 average character width and then divided by 4. For the y dimension,
9054 the dialog units are multiplied by the average character height and
9055 then divided by 8.
9056 """
9057 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9058
9059 def ConvertDialogSizeToPixels(*args, **kwargs):
9060 """
9061 ConvertDialogSizeToPixels(self, Size sz) -> Size
9062
9063 Converts a point or size from dialog units to pixels. Dialog units
9064 are used for maintaining a dialog's proportions even if the font
9065 changes. For the x dimension, the dialog units are multiplied by the
9066 average character width and then divided by 4. For the y dimension,
9067 the dialog units are multiplied by the average character height and
9068 then divided by 8.
9069 """
9070 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9071
9072 def DLG_PNT(*args, **kwargs):
9073 """
9074 DLG_PNT(self, Point pt) -> Point
9075
9076 Converts a point or size from dialog units to pixels. Dialog units
9077 are used for maintaining a dialog's proportions even if the font
9078 changes. For the x dimension, the dialog units are multiplied by the
9079 average character width and then divided by 4. For the y dimension,
9080 the dialog units are multiplied by the average character height and
9081 then divided by 8.
9082 """
9083 return _core_.Window_DLG_PNT(*args, **kwargs)
9084
9085 def DLG_SZE(*args, **kwargs):
9086 """
9087 DLG_SZE(self, Size sz) -> Size
9088
9089 Converts a point or size from dialog units to pixels. Dialog units
9090 are used for maintaining a dialog's proportions even if the font
9091 changes. For the x dimension, the dialog units are multiplied by the
9092 average character width and then divided by 4. For the y dimension,
9093 the dialog units are multiplied by the average character height and
9094 then divided by 8.
9095 """
9096 return _core_.Window_DLG_SZE(*args, **kwargs)
9097
9098 def ConvertPixelPointToDialog(*args, **kwargs):
9099 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9100 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9101
9102 def ConvertPixelSizeToDialog(*args, **kwargs):
9103 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9104 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9105
9106 def WarpPointer(*args, **kwargs):
9107 """
9108 WarpPointer(self, int x, int y)
9109
9110 Moves the pointer to the given position on the window.
9111
9112 NOTE: This function is not supported under Mac because Apple Human
9113 Interface Guidelines forbid moving the mouse cursor programmatically.
9114 """
9115 return _core_.Window_WarpPointer(*args, **kwargs)
9116
9117 def CaptureMouse(*args, **kwargs):
9118 """
9119 CaptureMouse(self)
9120
9121 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9122 release the capture.
9123
9124 Note that wxWindows maintains the stack of windows having captured the
9125 mouse and when the mouse is released the capture returns to the window
9126 which had had captured it previously and it is only really released if
9127 there were no previous window. In particular, this means that you must
9128 release the mouse as many times as you capture it, unless the window
9129 receives the `wx.MouseCaptureLostEvent` event.
9130
9131 Any application which captures the mouse in the beginning of some
9132 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9133 operation when it receives the event. The event handler must not
9134 recapture mouse.
9135 """
9136 return _core_.Window_CaptureMouse(*args, **kwargs)
9137
9138 def ReleaseMouse(*args, **kwargs):
9139 """
9140 ReleaseMouse(self)
9141
9142 Releases mouse input captured with wx.Window.CaptureMouse.
9143 """
9144 return _core_.Window_ReleaseMouse(*args, **kwargs)
9145
9146 def GetCapture(*args, **kwargs):
9147 """
9148 GetCapture() -> Window
9149
9150 Returns the window which currently captures the mouse or None
9151 """
9152 return _core_.Window_GetCapture(*args, **kwargs)
9153
9154 GetCapture = staticmethod(GetCapture)
9155 def HasCapture(*args, **kwargs):
9156 """
9157 HasCapture(self) -> bool
9158
9159 Returns true if this window has the current mouse capture.
9160 """
9161 return _core_.Window_HasCapture(*args, **kwargs)
9162
9163 def Refresh(*args, **kwargs):
9164 """
9165 Refresh(self, bool eraseBackground=True, Rect rect=None)
9166
9167 Mark the specified rectangle (or the whole window) as "dirty" so it
9168 will be repainted. Causes an EVT_PAINT event to be generated and sent
9169 to the window.
9170 """
9171 return _core_.Window_Refresh(*args, **kwargs)
9172
9173 def RefreshRect(*args, **kwargs):
9174 """
9175 RefreshRect(self, Rect rect, bool eraseBackground=True)
9176
9177 Redraws the contents of the given rectangle: the area inside it will
9178 be repainted. This is the same as Refresh but has a nicer syntax.
9179 """
9180 return _core_.Window_RefreshRect(*args, **kwargs)
9181
9182 def Update(*args, **kwargs):
9183 """
9184 Update(self)
9185
9186 Calling this method immediately repaints the invalidated area of the
9187 window instead of waiting for the EVT_PAINT event to happen, (normally
9188 this would usually only happen when the flow of control returns to the
9189 event loop.) Notice that this function doesn't refresh the window and
9190 does nothing if the window has been already repainted. Use `Refresh`
9191 first if you want to immediately redraw the window (or some portion of
9192 it) unconditionally.
9193 """
9194 return _core_.Window_Update(*args, **kwargs)
9195
9196 def ClearBackground(*args, **kwargs):
9197 """
9198 ClearBackground(self)
9199
9200 Clears the window by filling it with the current background
9201 colour. Does not cause an erase background event to be generated.
9202 """
9203 return _core_.Window_ClearBackground(*args, **kwargs)
9204
9205 def Freeze(*args, **kwargs):
9206 """
9207 Freeze(self)
9208
9209 Freezes the window or, in other words, prevents any updates from
9210 taking place on screen, the window is not redrawn at all. Thaw must be
9211 called to reenable window redrawing. Calls to Freeze/Thaw may be
9212 nested, with the actual Thaw being delayed until all the nesting has
9213 been undone.
9214
9215 This method is useful for visual appearance optimization (for example,
9216 it is a good idea to use it before inserting large amount of text into
9217 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9218 for all controls so it is mostly just a hint to wxWindows and not a
9219 mandatory directive.
9220 """
9221 return _core_.Window_Freeze(*args, **kwargs)
9222
9223 def IsFrozen(*args, **kwargs):
9224 """
9225 IsFrozen(self) -> bool
9226
9227 Returns ``True`` if the window has been frozen and not thawed yet.
9228
9229 :see: `Freeze` and `Thaw`
9230 """
9231 return _core_.Window_IsFrozen(*args, **kwargs)
9232
9233 def Thaw(*args, **kwargs):
9234 """
9235 Thaw(self)
9236
9237 Reenables window updating after a previous call to Freeze. Calls to
9238 Freeze/Thaw may be nested, so Thaw must be called the same number of
9239 times that Freeze was before the window will be updated.
9240 """
9241 return _core_.Window_Thaw(*args, **kwargs)
9242
9243 def PrepareDC(*args, **kwargs):
9244 """
9245 PrepareDC(self, DC dc)
9246
9247 Call this function to prepare the device context for drawing a
9248 scrolled image. It sets the device origin according to the current
9249 scroll position.
9250 """
9251 return _core_.Window_PrepareDC(*args, **kwargs)
9252
9253 def IsDoubleBuffered(*args, **kwargs):
9254 """
9255 IsDoubleBuffered(self) -> bool
9256
9257 Returns ``True`` if the window contents is double-buffered by the
9258 system, i.e. if any drawing done on the window is really done on a
9259 temporary backing surface and transferred to the screen all at once
9260 later.
9261 """
9262 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9263
9264 def GetUpdateRegion(*args, **kwargs):
9265 """
9266 GetUpdateRegion(self) -> Region
9267
9268 Returns the region specifying which parts of the window have been
9269 damaged. Should only be called within an EVT_PAINT handler.
9270 """
9271 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9272
9273 def GetUpdateClientRect(*args, **kwargs):
9274 """
9275 GetUpdateClientRect(self) -> Rect
9276
9277 Get the update rectangle region bounding box in client coords.
9278 """
9279 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9280
9281 def IsExposed(*args, **kwargs):
9282 """
9283 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9284
9285 Returns true if the given point or rectangle area has been exposed
9286 since the last repaint. Call this in an paint event handler to
9287 optimize redrawing by only redrawing those areas, which have been
9288 exposed.
9289 """
9290 return _core_.Window_IsExposed(*args, **kwargs)
9291
9292 def IsExposedPoint(*args, **kwargs):
9293 """
9294 IsExposedPoint(self, Point pt) -> bool
9295
9296 Returns true if the given point or rectangle area has been exposed
9297 since the last repaint. Call this in an paint event handler to
9298 optimize redrawing by only redrawing those areas, which have been
9299 exposed.
9300 """
9301 return _core_.Window_IsExposedPoint(*args, **kwargs)
9302
9303 def IsExposedRect(*args, **kwargs):
9304 """
9305 IsExposedRect(self, Rect rect) -> bool
9306
9307 Returns true if the given point or rectangle area has been exposed
9308 since the last repaint. Call this in an paint event handler to
9309 optimize redrawing by only redrawing those areas, which have been
9310 exposed.
9311 """
9312 return _core_.Window_IsExposedRect(*args, **kwargs)
9313
9314 def GetDefaultAttributes(*args, **kwargs):
9315 """
9316 GetDefaultAttributes(self) -> VisualAttributes
9317
9318 Get the default attributes for an instance of this class. This is
9319 useful if you want to use the same font or colour in your own control
9320 as in a standard control -- which is a much better idea than hard
9321 coding specific colours or fonts which might look completely out of
9322 place on the user's system, especially if it uses themes.
9323 """
9324 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9325
9326 def GetClassDefaultAttributes(*args, **kwargs):
9327 """
9328 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9329
9330 Get the default attributes for this class. This is useful if you want
9331 to use the same font or colour in your own control as in a standard
9332 control -- which is a much better idea than hard coding specific
9333 colours or fonts which might look completely out of place on the
9334 user's system, especially if it uses themes.
9335
9336 The variant parameter is only relevant under Mac currently and is
9337 ignore under other platforms. Under Mac, it will change the size of
9338 the returned font. See `wx.Window.SetWindowVariant` for more about
9339 this.
9340 """
9341 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9342
9343 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9344 def SetBackgroundColour(*args, **kwargs):
9345 """
9346 SetBackgroundColour(self, Colour colour) -> bool
9347
9348 Sets the background colour of the window. Returns True if the colour
9349 was changed. The background colour is usually painted by the default
9350 EVT_ERASE_BACKGROUND event handler function under Windows and
9351 automatically under GTK. Using `wx.NullColour` will reset the window
9352 to the default background colour.
9353
9354 Note that setting the background colour may not cause an immediate
9355 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9356 calling this function.
9357
9358 Using this function will disable attempts to use themes for this
9359 window, if the system supports them. Use with care since usually the
9360 themes represent the appearance chosen by the user to be used for all
9361 applications on the system.
9362 """
9363 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9364
9365 def SetOwnBackgroundColour(*args, **kwargs):
9366 """SetOwnBackgroundColour(self, Colour colour)"""
9367 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9368
9369 def SetForegroundColour(*args, **kwargs):
9370 """
9371 SetForegroundColour(self, Colour colour) -> bool
9372
9373 Sets the foreground colour of the window. Returns True is the colour
9374 was changed. The interpretation of foreground colour is dependent on
9375 the window class; it may be the text colour or other colour, or it may
9376 not be used at all.
9377 """
9378 return _core_.Window_SetForegroundColour(*args, **kwargs)
9379
9380 def SetOwnForegroundColour(*args, **kwargs):
9381 """SetOwnForegroundColour(self, Colour colour)"""
9382 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9383
9384 def GetBackgroundColour(*args, **kwargs):
9385 """
9386 GetBackgroundColour(self) -> Colour
9387
9388 Returns the background colour of the window.
9389 """
9390 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9391
9392 def GetForegroundColour(*args, **kwargs):
9393 """
9394 GetForegroundColour(self) -> Colour
9395
9396 Returns the foreground colour of the window. The interpretation of
9397 foreground colour is dependent on the window class; it may be the text
9398 colour or other colour, or it may not be used at all.
9399 """
9400 return _core_.Window_GetForegroundColour(*args, **kwargs)
9401
9402 def InheritsBackgroundColour(*args, **kwargs):
9403 """InheritsBackgroundColour(self) -> bool"""
9404 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9405
9406 def UseBgCol(*args, **kwargs):
9407 """UseBgCol(self) -> bool"""
9408 return _core_.Window_UseBgCol(*args, **kwargs)
9409
9410 def SetBackgroundStyle(*args, **kwargs):
9411 """
9412 SetBackgroundStyle(self, int style) -> bool
9413
9414 Returns the background style of the window. The background style
9415 indicates how the background of the window is drawn.
9416
9417 ====================== ========================================
9418 wx.BG_STYLE_SYSTEM The background colour or pattern should
9419 be determined by the system
9420 wx.BG_STYLE_COLOUR The background should be a solid colour
9421 wx.BG_STYLE_CUSTOM The background will be implemented by the
9422 application.
9423 ====================== ========================================
9424
9425 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9426 a custom background, such as a tiled bitmap. Currently the style has
9427 no effect on other platforms.
9428
9429 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9430 """
9431 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9432
9433 def GetBackgroundStyle(*args, **kwargs):
9434 """
9435 GetBackgroundStyle(self) -> int
9436
9437 Returns the background style of the window.
9438
9439 :see: `SetBackgroundStyle`
9440 """
9441 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9442
9443 def HasTransparentBackground(*args, **kwargs):
9444 """
9445 HasTransparentBackground(self) -> bool
9446
9447 Returns True if this window's background is transparent (as, for
9448 example, for `wx.StaticText`) and should show the parent window's
9449 background.
9450
9451 This method is mostly used internally by the library itself and you
9452 normally shouldn't have to call it. You may, however, have to override
9453 it in your custom control classes to ensure that background is painted
9454 correctly.
9455 """
9456 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9457
9458 def SetCursor(*args, **kwargs):
9459 """
9460 SetCursor(self, Cursor cursor) -> bool
9461
9462 Sets the window's cursor. Notice that the window cursor also sets it
9463 for the children of the window implicitly.
9464
9465 The cursor may be wx.NullCursor in which case the window cursor will
9466 be reset back to default.
9467 """
9468 return _core_.Window_SetCursor(*args, **kwargs)
9469
9470 def GetCursor(*args, **kwargs):
9471 """
9472 GetCursor(self) -> Cursor
9473
9474 Return the cursor associated with this window.
9475 """
9476 return _core_.Window_GetCursor(*args, **kwargs)
9477
9478 def SetFont(*args, **kwargs):
9479 """
9480 SetFont(self, Font font) -> bool
9481
9482 Sets the font for this window.
9483 """
9484 return _core_.Window_SetFont(*args, **kwargs)
9485
9486 def SetOwnFont(*args, **kwargs):
9487 """SetOwnFont(self, Font font)"""
9488 return _core_.Window_SetOwnFont(*args, **kwargs)
9489
9490 def GetFont(*args, **kwargs):
9491 """
9492 GetFont(self) -> Font
9493
9494 Returns the default font used for this window.
9495 """
9496 return _core_.Window_GetFont(*args, **kwargs)
9497
9498 def SetCaret(*args, **kwargs):
9499 """
9500 SetCaret(self, Caret caret)
9501
9502 Sets the caret associated with the window.
9503 """
9504 return _core_.Window_SetCaret(*args, **kwargs)
9505
9506 def GetCaret(*args, **kwargs):
9507 """
9508 GetCaret(self) -> Caret
9509
9510 Returns the caret associated with the window.
9511 """
9512 return _core_.Window_GetCaret(*args, **kwargs)
9513
9514 def GetCharHeight(*args, **kwargs):
9515 """
9516 GetCharHeight(self) -> int
9517
9518 Get the (average) character size for the current font.
9519 """
9520 return _core_.Window_GetCharHeight(*args, **kwargs)
9521
9522 def GetCharWidth(*args, **kwargs):
9523 """
9524 GetCharWidth(self) -> int
9525
9526 Get the (average) character size for the current font.
9527 """
9528 return _core_.Window_GetCharWidth(*args, **kwargs)
9529
9530 def GetTextExtent(*args, **kwargs):
9531 """
9532 GetTextExtent(String string) -> (width, height)
9533
9534 Get the width and height of the text using the current font.
9535 """
9536 return _core_.Window_GetTextExtent(*args, **kwargs)
9537
9538 def GetFullTextExtent(*args, **kwargs):
9539 """
9540 GetFullTextExtent(String string, Font font=None) ->
9541 (width, height, descent, externalLeading)
9542
9543 Get the width, height, decent and leading of the text using the
9544 current or specified font.
9545 """
9546 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9547
9548 def ClientToScreenXY(*args, **kwargs):
9549 """
9550 ClientToScreenXY(int x, int y) -> (x,y)
9551
9552 Converts to screen coordinates from coordinates relative to this window.
9553 """
9554 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9555
9556 def ScreenToClientXY(*args, **kwargs):
9557 """
9558 ScreenToClientXY(int x, int y) -> (x,y)
9559
9560 Converts from screen to client window coordinates.
9561 """
9562 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9563
9564 def ClientToScreen(*args, **kwargs):
9565 """
9566 ClientToScreen(self, Point pt) -> Point
9567
9568 Converts to screen coordinates from coordinates relative to this window.
9569 """
9570 return _core_.Window_ClientToScreen(*args, **kwargs)
9571
9572 def ScreenToClient(*args, **kwargs):
9573 """
9574 ScreenToClient(self, Point pt) -> Point
9575
9576 Converts from screen to client window coordinates.
9577 """
9578 return _core_.Window_ScreenToClient(*args, **kwargs)
9579
9580 def HitTestXY(*args, **kwargs):
9581 """
9582 HitTestXY(self, int x, int y) -> int
9583
9584 Test where the given (in client coords) point lies
9585 """
9586 return _core_.Window_HitTestXY(*args, **kwargs)
9587
9588 def HitTest(*args, **kwargs):
9589 """
9590 HitTest(self, Point pt) -> int
9591
9592 Test where the given (in client coords) point lies
9593 """
9594 return _core_.Window_HitTest(*args, **kwargs)
9595
9596 def GetBorder(*args):
9597 """
9598 GetBorder(self, long flags) -> int
9599 GetBorder(self) -> int
9600
9601 Get border for the flags of this window
9602 """
9603 return _core_.Window_GetBorder(*args)
9604
9605 def UpdateWindowUI(*args, **kwargs):
9606 """
9607 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9608
9609 This function sends EVT_UPDATE_UI events to the window. The particular
9610 implementation depends on the window; for example a wx.ToolBar will
9611 send an update UI event for each toolbar button, and a wx.Frame will
9612 send an update UI event for each menubar menu item. You can call this
9613 function from your application to ensure that your UI is up-to-date at
9614 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9615 concerned). This may be necessary if you have called
9616 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9617 limit the overhead that wxWindows incurs by sending update UI events
9618 in idle time.
9619 """
9620 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9621
9622 def PopupMenuXY(*args, **kwargs):
9623 """
9624 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9625
9626 Pops up the given menu at the specified coordinates, relative to this window,
9627 and returns control when the user has dismissed the menu. If a menu item is
9628 selected, the corresponding menu event is generated and will be processed as
9629 usual. If the default position is given then the current position of the
9630 mouse cursor will be used.
9631 """
9632 return _core_.Window_PopupMenuXY(*args, **kwargs)
9633
9634 def PopupMenu(*args, **kwargs):
9635 """
9636 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9637
9638 Pops up the given menu at the specified coordinates, relative to this window,
9639 and returns control when the user has dismissed the menu. If a menu item is
9640 selected, the corresponding menu event is generated and will be processed as
9641 usual. If the default position is given then the current position of the
9642 mouse cursor will be used.
9643 """
9644 return _core_.Window_PopupMenu(*args, **kwargs)
9645
9646 def HasMultiplePages(*args, **kwargs):
9647 """HasMultiplePages(self) -> bool"""
9648 return _core_.Window_HasMultiplePages(*args, **kwargs)
9649
9650 def GetHandle(*args, **kwargs):
9651 """
9652 GetHandle(self) -> long
9653
9654 Returns the platform-specific handle (as a long integer) of the
9655 physical window. Currently on wxMac it returns the handle of the
9656 toplevel parent of the window.
9657 """
9658 return _core_.Window_GetHandle(*args, **kwargs)
9659
9660 def AssociateHandle(*args, **kwargs):
9661 """
9662 AssociateHandle(self, long handle)
9663
9664 Associate the window with a new native handle
9665 """
9666 return _core_.Window_AssociateHandle(*args, **kwargs)
9667
9668 def DissociateHandle(*args, **kwargs):
9669 """
9670 DissociateHandle(self)
9671
9672 Dissociate the current native handle from the window
9673 """
9674 return _core_.Window_DissociateHandle(*args, **kwargs)
9675
9676 def HasScrollbar(*args, **kwargs):
9677 """
9678 HasScrollbar(self, int orient) -> bool
9679
9680 Does the window have the scrollbar for this orientation?
9681 """
9682 return _core_.Window_HasScrollbar(*args, **kwargs)
9683
9684 def SetScrollbar(*args, **kwargs):
9685 """
9686 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9687 bool refresh=True)
9688
9689 Sets the scrollbar properties of a built-in scrollbar.
9690 """
9691 return _core_.Window_SetScrollbar(*args, **kwargs)
9692
9693 def SetScrollPos(*args, **kwargs):
9694 """
9695 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9696
9697 Sets the position of one of the built-in scrollbars.
9698 """
9699 return _core_.Window_SetScrollPos(*args, **kwargs)
9700
9701 def GetScrollPos(*args, **kwargs):
9702 """
9703 GetScrollPos(self, int orientation) -> int
9704
9705 Returns the built-in scrollbar position.
9706 """
9707 return _core_.Window_GetScrollPos(*args, **kwargs)
9708
9709 def GetScrollThumb(*args, **kwargs):
9710 """
9711 GetScrollThumb(self, int orientation) -> int
9712
9713 Returns the built-in scrollbar thumb size.
9714 """
9715 return _core_.Window_GetScrollThumb(*args, **kwargs)
9716
9717 def GetScrollRange(*args, **kwargs):
9718 """
9719 GetScrollRange(self, int orientation) -> int
9720
9721 Returns the built-in scrollbar range.
9722 """
9723 return _core_.Window_GetScrollRange(*args, **kwargs)
9724
9725 def ScrollWindow(*args, **kwargs):
9726 """
9727 ScrollWindow(self, int dx, int dy, Rect rect=None)
9728
9729 Physically scrolls the pixels in the window and move child windows
9730 accordingly. Use this function to optimise your scrolling
9731 implementations, to minimise the area that must be redrawn. Note that
9732 it is rarely required to call this function from a user program.
9733 """
9734 return _core_.Window_ScrollWindow(*args, **kwargs)
9735
9736 def ScrollLines(*args, **kwargs):
9737 """
9738 ScrollLines(self, int lines) -> bool
9739
9740 If the platform and window class supports it, scrolls the window by
9741 the given number of lines down, if lines is positive, or up if lines
9742 is negative. Returns True if the window was scrolled, False if it was
9743 already on top/bottom and nothing was done.
9744 """
9745 return _core_.Window_ScrollLines(*args, **kwargs)
9746
9747 def ScrollPages(*args, **kwargs):
9748 """
9749 ScrollPages(self, int pages) -> bool
9750
9751 If the platform and window class supports it, scrolls the window by
9752 the given number of pages down, if pages is positive, or up if pages
9753 is negative. Returns True if the window was scrolled, False if it was
9754 already on top/bottom and nothing was done.
9755 """
9756 return _core_.Window_ScrollPages(*args, **kwargs)
9757
9758 def LineUp(*args, **kwargs):
9759 """
9760 LineUp(self) -> bool
9761
9762 This is just a wrapper for ScrollLines(-1).
9763 """
9764 return _core_.Window_LineUp(*args, **kwargs)
9765
9766 def LineDown(*args, **kwargs):
9767 """
9768 LineDown(self) -> bool
9769
9770 This is just a wrapper for ScrollLines(1).
9771 """
9772 return _core_.Window_LineDown(*args, **kwargs)
9773
9774 def PageUp(*args, **kwargs):
9775 """
9776 PageUp(self) -> bool
9777
9778 This is just a wrapper for ScrollPages(-1).
9779 """
9780 return _core_.Window_PageUp(*args, **kwargs)
9781
9782 def PageDown(*args, **kwargs):
9783 """
9784 PageDown(self) -> bool
9785
9786 This is just a wrapper for ScrollPages(1).
9787 """
9788 return _core_.Window_PageDown(*args, **kwargs)
9789
9790 def SetHelpText(*args, **kwargs):
9791 """
9792 SetHelpText(self, String text)
9793
9794 Sets the help text to be used as context-sensitive help for this
9795 window. Note that the text is actually stored by the current
9796 `wx.HelpProvider` implementation, and not in the window object itself.
9797 """
9798 return _core_.Window_SetHelpText(*args, **kwargs)
9799
9800 def SetHelpTextForId(*args, **kwargs):
9801 """
9802 SetHelpTextForId(self, String text)
9803
9804 Associate this help text with all windows with the same id as this
9805 one.
9806 """
9807 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9808
9809 def GetHelpTextAtPoint(*args, **kwargs):
9810 """
9811 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9812
9813 Get the help string associated with the given position in this window.
9814
9815 Notice that pt may be invalid if event origin is keyboard or unknown
9816 and this method should return the global window help text then
9817
9818 """
9819 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9820
9821 def GetHelpText(*args, **kwargs):
9822 """
9823 GetHelpText(self) -> String
9824
9825 Gets the help text to be used as context-sensitive help for this
9826 window. Note that the text is actually stored by the current
9827 `wx.HelpProvider` implementation, and not in the window object itself.
9828 """
9829 return _core_.Window_GetHelpText(*args, **kwargs)
9830
9831 def SetToolTipString(*args, **kwargs):
9832 """
9833 SetToolTipString(self, String tip)
9834
9835 Attach a tooltip to the window.
9836 """
9837 return _core_.Window_SetToolTipString(*args, **kwargs)
9838
9839 def SetToolTip(*args, **kwargs):
9840 """
9841 SetToolTip(self, ToolTip tip)
9842
9843 Attach a tooltip to the window.
9844 """
9845 return _core_.Window_SetToolTip(*args, **kwargs)
9846
9847 def GetToolTip(*args, **kwargs):
9848 """
9849 GetToolTip(self) -> ToolTip
9850
9851 get the associated tooltip or None if none
9852 """
9853 return _core_.Window_GetToolTip(*args, **kwargs)
9854
9855 def SetDropTarget(*args, **kwargs):
9856 """
9857 SetDropTarget(self, DropTarget dropTarget)
9858
9859 Associates a drop target with this window. If the window already has
9860 a drop target, it is deleted.
9861 """
9862 return _core_.Window_SetDropTarget(*args, **kwargs)
9863
9864 def GetDropTarget(*args, **kwargs):
9865 """
9866 GetDropTarget(self) -> DropTarget
9867
9868 Returns the associated drop target, which may be None.
9869 """
9870 return _core_.Window_GetDropTarget(*args, **kwargs)
9871
9872 def DragAcceptFiles(*args, **kwargs):
9873 """
9874 DragAcceptFiles(self, bool accept)
9875
9876 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9877 Only functional on Windows.
9878 """
9879 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9880
9881 def SetConstraints(*args, **kwargs):
9882 """
9883 SetConstraints(self, LayoutConstraints constraints)
9884
9885 Sets the window to have the given layout constraints. If an existing
9886 layout constraints object is already owned by the window, it will be
9887 deleted. Pass None to disassociate and delete the window's current
9888 constraints.
9889
9890 You must call SetAutoLayout to tell a window to use the constraints
9891 automatically in its default EVT_SIZE handler; otherwise, you must
9892 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9893 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9894 effect.
9895 """
9896 return _core_.Window_SetConstraints(*args, **kwargs)
9897
9898 def GetConstraints(*args, **kwargs):
9899 """
9900 GetConstraints(self) -> LayoutConstraints
9901
9902 Returns a pointer to the window's layout constraints, or None if there
9903 are none.
9904 """
9905 return _core_.Window_GetConstraints(*args, **kwargs)
9906
9907 def SetAutoLayout(*args, **kwargs):
9908 """
9909 SetAutoLayout(self, bool autoLayout)
9910
9911 Determines whether the Layout function will be called automatically
9912 when the window is resized. lease note that this only happens for the
9913 windows usually used to contain children, namely `wx.Panel` and
9914 `wx.TopLevelWindow` (and the classes deriving from them).
9915
9916 This method is called implicitly by `SetSizer` but if you use
9917 `SetConstraints` you should call it manually or otherwise the window
9918 layout won't be correctly updated when its size changes.
9919 """
9920 return _core_.Window_SetAutoLayout(*args, **kwargs)
9921
9922 def GetAutoLayout(*args, **kwargs):
9923 """
9924 GetAutoLayout(self) -> bool
9925
9926 Returns the current autoLayout setting
9927 """
9928 return _core_.Window_GetAutoLayout(*args, **kwargs)
9929
9930 def Layout(*args, **kwargs):
9931 """
9932 Layout(self) -> bool
9933
9934 Invokes the constraint-based layout algorithm or the sizer-based
9935 algorithm for this window. See SetAutoLayout: when auto layout is on,
9936 this function gets called automatically by the default EVT_SIZE
9937 handler when the window is resized.
9938 """
9939 return _core_.Window_Layout(*args, **kwargs)
9940
9941 def SetSizer(*args, **kwargs):
9942 """
9943 SetSizer(self, Sizer sizer, bool deleteOld=True)
9944
9945 Sets the window to have the given layout sizer. The window will then
9946 own the object, and will take care of its deletion. If an existing
9947 layout sizer object is already owned by the window, it will be deleted
9948 if the deleteOld parameter is true. Note that this function will also
9949 call SetAutoLayout implicitly with a True parameter if the sizer is
9950 non-None, and False otherwise.
9951 """
9952 return _core_.Window_SetSizer(*args, **kwargs)
9953
9954 def SetSizerAndFit(*args, **kwargs):
9955 """
9956 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9957
9958 The same as SetSizer, except it also sets the size hints for the
9959 window based on the sizer's minimum size.
9960 """
9961 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9962
9963 def GetSizer(*args, **kwargs):
9964 """
9965 GetSizer(self) -> Sizer
9966
9967 Return the sizer associated with the window by a previous call to
9968 SetSizer or None if there isn't one.
9969 """
9970 return _core_.Window_GetSizer(*args, **kwargs)
9971
9972 def SetContainingSizer(*args, **kwargs):
9973 """
9974 SetContainingSizer(self, Sizer sizer)
9975
9976 This normally does not need to be called by application code. It is
9977 called internally when a window is added to a sizer, and is used so
9978 the window can remove itself from the sizer when it is destroyed.
9979 """
9980 return _core_.Window_SetContainingSizer(*args, **kwargs)
9981
9982 def GetContainingSizer(*args, **kwargs):
9983 """
9984 GetContainingSizer(self) -> Sizer
9985
9986 Return the sizer that this window is a member of, if any, otherwise None.
9987 """
9988 return _core_.Window_GetContainingSizer(*args, **kwargs)
9989
9990 def InheritAttributes(*args, **kwargs):
9991 """
9992 InheritAttributes(self)
9993
9994 This function is (or should be, in case of custom controls) called
9995 during window creation to intelligently set up the window visual
9996 attributes, that is the font and the foreground and background
9997 colours.
9998
9999 By 'intelligently' the following is meant: by default, all windows use
10000 their own default attributes. However if some of the parent's
10001 attributes are explicitly changed (that is, using SetFont and not
10002 SetOwnFont) and if the corresponding attribute hadn't been
10003 explicitly set for this window itself, then this window takes the same
10004 value as used by the parent. In addition, if the window overrides
10005 ShouldInheritColours to return false, the colours will not be changed
10006 no matter what and only the font might.
10007
10008 This rather complicated logic is necessary in order to accommodate the
10009 different usage scenarios. The most common one is when all default
10010 attributes are used and in this case, nothing should be inherited as
10011 in modern GUIs different controls use different fonts (and colours)
10012 than their siblings so they can't inherit the same value from the
10013 parent. However it was also deemed desirable to allow to simply change
10014 the attributes of all children at once by just changing the font or
10015 colour of their common parent, hence in this case we do inherit the
10016 parents attributes.
10017
10018 """
10019 return _core_.Window_InheritAttributes(*args, **kwargs)
10020
10021 def ShouldInheritColours(*args, **kwargs):
10022 """
10023 ShouldInheritColours(self) -> bool
10024
10025 Return true from here to allow the colours of this window to be
10026 changed by InheritAttributes, returning false forbids inheriting them
10027 from the parent window.
10028
10029 The base class version returns false, but this method is overridden in
10030 wxControl where it returns true.
10031 """
10032 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10033
10034 def CanSetTransparent(*args, **kwargs):
10035 """
10036 CanSetTransparent(self) -> bool
10037
10038 Returns ``True`` if the platform supports setting the transparency for
10039 this window. Note that this method will err on the side of caution,
10040 so it is possible that this will return ``False`` when it is in fact
10041 possible to set the transparency.
10042
10043 NOTE: On X-windows systems the X server must have the composite
10044 extension loaded, and there must be a composite manager program (such
10045 as xcompmgr) running.
10046 """
10047 return _core_.Window_CanSetTransparent(*args, **kwargs)
10048
10049 def SetTransparent(*args, **kwargs):
10050 """
10051 SetTransparent(self, byte alpha) -> bool
10052
10053 Attempt to set the transparency of this window to the ``alpha`` value,
10054 returns True on success. The ``alpha`` value is an integer in the
10055 range of 0 to 255, where 0 is fully transparent and 255 is fully
10056 opaque.
10057 """
10058 return _core_.Window_SetTransparent(*args, **kwargs)
10059
10060 def PostCreate(self, pre):
10061 """
10062 Phase 3 of the 2-phase create <wink!>
10063 Call this method after precreating the window with the 2-phase create method.
10064 """
10065 self.this = pre.this
10066 self.thisown = pre.thisown
10067 pre.thisown = 0
10068 if hasattr(self, '_setOORInfo'):
10069 self._setOORInfo(self)
10070 if hasattr(self, '_setCallbackInfo'):
10071 self._setCallbackInfo(self, self.__class__)
10072
10073 def SendSizeEvent(self):
10074 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
10075
10076 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10077 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10078 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10079 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10080 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10081 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
10082 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10083 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10084 Border = property(GetBorder,doc="See `GetBorder`")
10085 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10086 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10087 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10088 Children = property(GetChildren,doc="See `GetChildren`")
10089 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10090 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10091 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10092 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10093 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10094 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10095 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10096 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10097 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10098 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10099 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10100 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
10101 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10102 Handle = property(GetHandle,doc="See `GetHandle`")
10103 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
10104 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10105 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
10106 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
10107 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10108 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10109 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10110 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10111 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10112 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10113 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10114 Parent = property(GetParent,doc="See `GetParent`")
10115 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10116 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10117 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10118 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10119 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10120 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10121 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10122 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10123 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10124 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10125 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10126 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10127 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10128 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10129 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10130 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10131 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10132 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10133 _core_.Window_swigregister(Window)
10134
10135 def PreWindow(*args, **kwargs):
10136 """
10137 PreWindow() -> Window
10138
10139 Precreate a Window for 2-phase creation.
10140 """
10141 val = _core_.new_PreWindow(*args, **kwargs)
10142 return val
10143
10144 def Window_NewControlId(*args):
10145 """
10146 Window_NewControlId() -> int
10147
10148 Generate a control id for the controls which were not given one.
10149 """
10150 return _core_.Window_NewControlId(*args)
10151
10152 def Window_NextControlId(*args, **kwargs):
10153 """
10154 Window_NextControlId(int winid) -> int
10155
10156 Get the id of the control following the one with the given
10157 autogenerated) id
10158 """
10159 return _core_.Window_NextControlId(*args, **kwargs)
10160
10161 def Window_PrevControlId(*args, **kwargs):
10162 """
10163 Window_PrevControlId(int winid) -> int
10164
10165 Get the id of the control preceding the one with the given
10166 autogenerated) id
10167 """
10168 return _core_.Window_PrevControlId(*args, **kwargs)
10169
10170 def Window_FindFocus(*args):
10171 """
10172 Window_FindFocus() -> Window
10173
10174 Returns the window or control that currently has the keyboard focus,
10175 or None.
10176 """
10177 return _core_.Window_FindFocus(*args)
10178
10179 def Window_GetCapture(*args):
10180 """
10181 Window_GetCapture() -> Window
10182
10183 Returns the window which currently captures the mouse or None
10184 """
10185 return _core_.Window_GetCapture(*args)
10186
10187 def Window_GetClassDefaultAttributes(*args, **kwargs):
10188 """
10189 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10190
10191 Get the default attributes for this class. This is useful if you want
10192 to use the same font or colour in your own control as in a standard
10193 control -- which is a much better idea than hard coding specific
10194 colours or fonts which might look completely out of place on the
10195 user's system, especially if it uses themes.
10196
10197 The variant parameter is only relevant under Mac currently and is
10198 ignore under other platforms. Under Mac, it will change the size of
10199 the returned font. See `wx.Window.SetWindowVariant` for more about
10200 this.
10201 """
10202 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10203
10204 def DLG_PNT(win, point_or_x, y=None):
10205 """
10206 Convenience function for converting a Point or (x,y) in
10207 dialog units to pixel units.
10208 """
10209 if y is None:
10210 return win.ConvertDialogPointToPixels(point_or_x)
10211 else:
10212 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10213
10214 def DLG_SZE(win, size_width, height=None):
10215 """
10216 Convenience function for converting a Size or (w,h) in
10217 dialog units to pixel units.
10218 """
10219 if height is None:
10220 return win.ConvertDialogSizeToPixels(size_width)
10221 else:
10222 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10223
10224
10225 def FindWindowById(*args, **kwargs):
10226 """
10227 FindWindowById(long id, Window parent=None) -> Window
10228
10229 Find the first window in the application with the given id. If parent
10230 is None, the search will start from all top-level frames and dialog
10231 boxes; if non-None, the search will be limited to the given window
10232 hierarchy. The search is recursive in both cases.
10233 """
10234 return _core_.FindWindowById(*args, **kwargs)
10235
10236 def FindWindowByName(*args, **kwargs):
10237 """
10238 FindWindowByName(String name, Window parent=None) -> Window
10239
10240 Find a window by its name (as given in a window constructor or Create
10241 function call). If parent is None, the search will start from all
10242 top-level frames and dialog boxes; if non-None, the search will be
10243 limited to the given window hierarchy. The search is recursive in both
10244 cases.
10245
10246 If no window with such name is found, wx.FindWindowByLabel is called.
10247 """
10248 return _core_.FindWindowByName(*args, **kwargs)
10249
10250 def FindWindowByLabel(*args, **kwargs):
10251 """
10252 FindWindowByLabel(String label, Window parent=None) -> Window
10253
10254 Find a window by its label. Depending on the type of window, the label
10255 may be a window title or panel item label. If parent is None, the
10256 search will start from all top-level frames and dialog boxes; if
10257 non-None, the search will be limited to the given window
10258 hierarchy. The search is recursive in both cases.
10259 """
10260 return _core_.FindWindowByLabel(*args, **kwargs)
10261
10262 def Window_FromHWND(*args, **kwargs):
10263 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10264 return _core_.Window_FromHWND(*args, **kwargs)
10265
10266 def GetTopLevelWindows(*args):
10267 """
10268 GetTopLevelWindows() -> PyObject
10269
10270 Returns a list of the the application's top-level windows, (frames,
10271 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10272 by wxWidgets, and so it is only valid as long as no top-level windows
10273 are closed or new top-level windows are created.
10274
10275 """
10276 return _core_.GetTopLevelWindows(*args)
10277 #---------------------------------------------------------------------------
10278
10279 class Validator(EvtHandler):
10280 """Proxy of C++ Validator class"""
10281 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10282 __repr__ = _swig_repr
10283 def __init__(self, *args, **kwargs):
10284 """__init__(self) -> Validator"""
10285 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10286 self._setOORInfo(self)
10287
10288 def Clone(*args, **kwargs):
10289 """Clone(self) -> Validator"""
10290 return _core_.Validator_Clone(*args, **kwargs)
10291
10292 def Validate(*args, **kwargs):
10293 """Validate(self, Window parent) -> bool"""
10294 return _core_.Validator_Validate(*args, **kwargs)
10295
10296 def TransferToWindow(*args, **kwargs):
10297 """TransferToWindow(self) -> bool"""
10298 return _core_.Validator_TransferToWindow(*args, **kwargs)
10299
10300 def TransferFromWindow(*args, **kwargs):
10301 """TransferFromWindow(self) -> bool"""
10302 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10303
10304 def GetWindow(*args, **kwargs):
10305 """GetWindow(self) -> Window"""
10306 return _core_.Validator_GetWindow(*args, **kwargs)
10307
10308 def SetWindow(*args, **kwargs):
10309 """SetWindow(self, Window window)"""
10310 return _core_.Validator_SetWindow(*args, **kwargs)
10311
10312 def IsSilent(*args, **kwargs):
10313 """IsSilent() -> bool"""
10314 return _core_.Validator_IsSilent(*args, **kwargs)
10315
10316 IsSilent = staticmethod(IsSilent)
10317 def SetBellOnError(*args, **kwargs):
10318 """SetBellOnError(int doIt=True)"""
10319 return _core_.Validator_SetBellOnError(*args, **kwargs)
10320
10321 SetBellOnError = staticmethod(SetBellOnError)
10322 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
10323 _core_.Validator_swigregister(Validator)
10324
10325 def Validator_IsSilent(*args):
10326 """Validator_IsSilent() -> bool"""
10327 return _core_.Validator_IsSilent(*args)
10328
10329 def Validator_SetBellOnError(*args, **kwargs):
10330 """Validator_SetBellOnError(int doIt=True)"""
10331 return _core_.Validator_SetBellOnError(*args, **kwargs)
10332
10333 class PyValidator(Validator):
10334 """Proxy of C++ PyValidator class"""
10335 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10336 __repr__ = _swig_repr
10337 def __init__(self, *args, **kwargs):
10338 """__init__(self) -> PyValidator"""
10339 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10340
10341 self._setCallbackInfo(self, PyValidator, 1)
10342 self._setOORInfo(self)
10343
10344 def _setCallbackInfo(*args, **kwargs):
10345 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10346 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10347
10348 _core_.PyValidator_swigregister(PyValidator)
10349
10350 #---------------------------------------------------------------------------
10351
10352 class Menu(EvtHandler):
10353 """Proxy of C++ Menu class"""
10354 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10355 __repr__ = _swig_repr
10356 def __init__(self, *args, **kwargs):
10357 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10358 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10359 self._setOORInfo(self)
10360
10361 def Append(*args, **kwargs):
10362 """
10363 Append(self, int id, String text=EmptyString, String help=EmptyString,
10364 int kind=ITEM_NORMAL) -> MenuItem
10365 """
10366 return _core_.Menu_Append(*args, **kwargs)
10367
10368 def AppendSeparator(*args, **kwargs):
10369 """AppendSeparator(self) -> MenuItem"""
10370 return _core_.Menu_AppendSeparator(*args, **kwargs)
10371
10372 def AppendCheckItem(*args, **kwargs):
10373 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10374 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10375
10376 def AppendRadioItem(*args, **kwargs):
10377 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10378 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10379
10380 def AppendMenu(*args, **kwargs):
10381 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10382 return _core_.Menu_AppendMenu(*args, **kwargs)
10383
10384 def AppendSubMenu(*args, **kwargs):
10385 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10386 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10387
10388 def AppendItem(*args, **kwargs):
10389 """AppendItem(self, MenuItem item) -> MenuItem"""
10390 return _core_.Menu_AppendItem(*args, **kwargs)
10391
10392 def InsertItem(*args, **kwargs):
10393 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10394 return _core_.Menu_InsertItem(*args, **kwargs)
10395
10396 def PrependItem(*args, **kwargs):
10397 """PrependItem(self, MenuItem item) -> MenuItem"""
10398 return _core_.Menu_PrependItem(*args, **kwargs)
10399
10400 def Break(*args, **kwargs):
10401 """Break(self)"""
10402 return _core_.Menu_Break(*args, **kwargs)
10403
10404 def Insert(*args, **kwargs):
10405 """
10406 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10407 int kind=ITEM_NORMAL) -> MenuItem
10408 """
10409 return _core_.Menu_Insert(*args, **kwargs)
10410
10411 def InsertSeparator(*args, **kwargs):
10412 """InsertSeparator(self, size_t pos) -> MenuItem"""
10413 return _core_.Menu_InsertSeparator(*args, **kwargs)
10414
10415 def InsertCheckItem(*args, **kwargs):
10416 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10417 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10418
10419 def InsertRadioItem(*args, **kwargs):
10420 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10421 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10422
10423 def InsertMenu(*args, **kwargs):
10424 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10425 return _core_.Menu_InsertMenu(*args, **kwargs)
10426
10427 def Prepend(*args, **kwargs):
10428 """
10429 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10430 int kind=ITEM_NORMAL) -> MenuItem
10431 """
10432 return _core_.Menu_Prepend(*args, **kwargs)
10433
10434 def PrependSeparator(*args, **kwargs):
10435 """PrependSeparator(self) -> MenuItem"""
10436 return _core_.Menu_PrependSeparator(*args, **kwargs)
10437
10438 def PrependCheckItem(*args, **kwargs):
10439 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10440 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10441
10442 def PrependRadioItem(*args, **kwargs):
10443 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10444 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10445
10446 def PrependMenu(*args, **kwargs):
10447 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10448 return _core_.Menu_PrependMenu(*args, **kwargs)
10449
10450 def Remove(*args, **kwargs):
10451 """Remove(self, int id) -> MenuItem"""
10452 return _core_.Menu_Remove(*args, **kwargs)
10453
10454 def RemoveItem(*args, **kwargs):
10455 """RemoveItem(self, MenuItem item) -> MenuItem"""
10456 return _core_.Menu_RemoveItem(*args, **kwargs)
10457
10458 def Delete(*args, **kwargs):
10459 """Delete(self, int id) -> bool"""
10460 return _core_.Menu_Delete(*args, **kwargs)
10461
10462 def DeleteItem(*args, **kwargs):
10463 """DeleteItem(self, MenuItem item) -> bool"""
10464 return _core_.Menu_DeleteItem(*args, **kwargs)
10465
10466 def Destroy(*args, **kwargs):
10467 """
10468 Destroy(self)
10469
10470 Deletes the C++ object this Python object is a proxy for.
10471 """
10472 args[0].this.own(False)
10473 return _core_.Menu_Destroy(*args, **kwargs)
10474
10475 def DestroyId(*args, **kwargs):
10476 """DestroyId(self, int id) -> bool"""
10477 return _core_.Menu_DestroyId(*args, **kwargs)
10478
10479 def DestroyItem(*args, **kwargs):
10480 """DestroyItem(self, MenuItem item) -> bool"""
10481 return _core_.Menu_DestroyItem(*args, **kwargs)
10482
10483 def GetMenuItemCount(*args, **kwargs):
10484 """GetMenuItemCount(self) -> size_t"""
10485 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10486
10487 def GetMenuItems(*args, **kwargs):
10488 """GetMenuItems(self) -> PyObject"""
10489 return _core_.Menu_GetMenuItems(*args, **kwargs)
10490
10491 def FindItem(*args, **kwargs):
10492 """FindItem(self, String item) -> int"""
10493 return _core_.Menu_FindItem(*args, **kwargs)
10494
10495 def FindItemById(*args, **kwargs):
10496 """FindItemById(self, int id) -> MenuItem"""
10497 return _core_.Menu_FindItemById(*args, **kwargs)
10498
10499 def FindItemByPosition(*args, **kwargs):
10500 """FindItemByPosition(self, size_t position) -> MenuItem"""
10501 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10502
10503 def Enable(*args, **kwargs):
10504 """Enable(self, int id, bool enable)"""
10505 return _core_.Menu_Enable(*args, **kwargs)
10506
10507 def IsEnabled(*args, **kwargs):
10508 """IsEnabled(self, int id) -> bool"""
10509 return _core_.Menu_IsEnabled(*args, **kwargs)
10510
10511 def Check(*args, **kwargs):
10512 """Check(self, int id, bool check)"""
10513 return _core_.Menu_Check(*args, **kwargs)
10514
10515 def IsChecked(*args, **kwargs):
10516 """IsChecked(self, int id) -> bool"""
10517 return _core_.Menu_IsChecked(*args, **kwargs)
10518
10519 def SetLabel(*args, **kwargs):
10520 """SetLabel(self, int id, String label)"""
10521 return _core_.Menu_SetLabel(*args, **kwargs)
10522
10523 def GetLabel(*args, **kwargs):
10524 """GetLabel(self, int id) -> String"""
10525 return _core_.Menu_GetLabel(*args, **kwargs)
10526
10527 def SetHelpString(*args, **kwargs):
10528 """SetHelpString(self, int id, String helpString)"""
10529 return _core_.Menu_SetHelpString(*args, **kwargs)
10530
10531 def GetHelpString(*args, **kwargs):
10532 """GetHelpString(self, int id) -> String"""
10533 return _core_.Menu_GetHelpString(*args, **kwargs)
10534
10535 def SetTitle(*args, **kwargs):
10536 """SetTitle(self, String title)"""
10537 return _core_.Menu_SetTitle(*args, **kwargs)
10538
10539 def GetTitle(*args, **kwargs):
10540 """GetTitle(self) -> String"""
10541 return _core_.Menu_GetTitle(*args, **kwargs)
10542
10543 def SetEventHandler(*args, **kwargs):
10544 """SetEventHandler(self, EvtHandler handler)"""
10545 return _core_.Menu_SetEventHandler(*args, **kwargs)
10546
10547 def GetEventHandler(*args, **kwargs):
10548 """GetEventHandler(self) -> EvtHandler"""
10549 return _core_.Menu_GetEventHandler(*args, **kwargs)
10550
10551 def SetInvokingWindow(*args, **kwargs):
10552 """SetInvokingWindow(self, Window win)"""
10553 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10554
10555 def GetInvokingWindow(*args, **kwargs):
10556 """GetInvokingWindow(self) -> Window"""
10557 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10558
10559 def GetStyle(*args, **kwargs):
10560 """GetStyle(self) -> long"""
10561 return _core_.Menu_GetStyle(*args, **kwargs)
10562
10563 def UpdateUI(*args, **kwargs):
10564 """UpdateUI(self, EvtHandler source=None)"""
10565 return _core_.Menu_UpdateUI(*args, **kwargs)
10566
10567 def GetMenuBar(*args, **kwargs):
10568 """GetMenuBar(self) -> MenuBar"""
10569 return _core_.Menu_GetMenuBar(*args, **kwargs)
10570
10571 def Attach(*args, **kwargs):
10572 """Attach(self, wxMenuBarBase menubar)"""
10573 return _core_.Menu_Attach(*args, **kwargs)
10574
10575 def Detach(*args, **kwargs):
10576 """Detach(self)"""
10577 return _core_.Menu_Detach(*args, **kwargs)
10578
10579 def IsAttached(*args, **kwargs):
10580 """IsAttached(self) -> bool"""
10581 return _core_.Menu_IsAttached(*args, **kwargs)
10582
10583 def SetParent(*args, **kwargs):
10584 """SetParent(self, Menu parent)"""
10585 return _core_.Menu_SetParent(*args, **kwargs)
10586
10587 def GetParent(*args, **kwargs):
10588 """GetParent(self) -> Menu"""
10589 return _core_.Menu_GetParent(*args, **kwargs)
10590
10591 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10592 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10593 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10594 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10595 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10596 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10597 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10598 Style = property(GetStyle,doc="See `GetStyle`")
10599 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
10600 _core_.Menu_swigregister(Menu)
10601 DefaultValidator = cvar.DefaultValidator
10602
10603 #---------------------------------------------------------------------------
10604
10605 class MenuBar(Window):
10606 """Proxy of C++ MenuBar class"""
10607 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10608 __repr__ = _swig_repr
10609 def __init__(self, *args, **kwargs):
10610 """__init__(self, long style=0) -> MenuBar"""
10611 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10612 self._setOORInfo(self)
10613
10614 def Append(*args, **kwargs):
10615 """Append(self, Menu menu, String title) -> bool"""
10616 return _core_.MenuBar_Append(*args, **kwargs)
10617
10618 def Insert(*args, **kwargs):
10619 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10620 return _core_.MenuBar_Insert(*args, **kwargs)
10621
10622 def GetMenuCount(*args, **kwargs):
10623 """GetMenuCount(self) -> size_t"""
10624 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10625
10626 def GetMenu(*args, **kwargs):
10627 """GetMenu(self, size_t pos) -> Menu"""
10628 return _core_.MenuBar_GetMenu(*args, **kwargs)
10629
10630 def Replace(*args, **kwargs):
10631 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10632 return _core_.MenuBar_Replace(*args, **kwargs)
10633
10634 def Remove(*args, **kwargs):
10635 """Remove(self, size_t pos) -> Menu"""
10636 return _core_.MenuBar_Remove(*args, **kwargs)
10637
10638 def EnableTop(*args, **kwargs):
10639 """EnableTop(self, size_t pos, bool enable)"""
10640 return _core_.MenuBar_EnableTop(*args, **kwargs)
10641
10642 def IsEnabledTop(*args, **kwargs):
10643 """IsEnabledTop(self, size_t pos) -> bool"""
10644 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10645
10646 def SetLabelTop(*args, **kwargs):
10647 """SetLabelTop(self, size_t pos, String label)"""
10648 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10649
10650 def GetLabelTop(*args, **kwargs):
10651 """GetLabelTop(self, size_t pos) -> String"""
10652 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10653
10654 def FindMenuItem(*args, **kwargs):
10655 """FindMenuItem(self, String menu, String item) -> int"""
10656 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10657
10658 def FindItemById(*args, **kwargs):
10659 """FindItemById(self, int id) -> MenuItem"""
10660 return _core_.MenuBar_FindItemById(*args, **kwargs)
10661
10662 def FindMenu(*args, **kwargs):
10663 """FindMenu(self, String title) -> int"""
10664 return _core_.MenuBar_FindMenu(*args, **kwargs)
10665
10666 def Enable(*args, **kwargs):
10667 """Enable(self, int id, bool enable)"""
10668 return _core_.MenuBar_Enable(*args, **kwargs)
10669
10670 def Check(*args, **kwargs):
10671 """Check(self, int id, bool check)"""
10672 return _core_.MenuBar_Check(*args, **kwargs)
10673
10674 def IsChecked(*args, **kwargs):
10675 """IsChecked(self, int id) -> bool"""
10676 return _core_.MenuBar_IsChecked(*args, **kwargs)
10677
10678 def IsEnabled(*args, **kwargs):
10679 """IsEnabled(self, int id) -> bool"""
10680 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10681
10682 def SetLabel(*args, **kwargs):
10683 """SetLabel(self, int id, String label)"""
10684 return _core_.MenuBar_SetLabel(*args, **kwargs)
10685
10686 def GetLabel(*args, **kwargs):
10687 """GetLabel(self, int id) -> String"""
10688 return _core_.MenuBar_GetLabel(*args, **kwargs)
10689
10690 def SetHelpString(*args, **kwargs):
10691 """SetHelpString(self, int id, String helpString)"""
10692 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10693
10694 def GetHelpString(*args, **kwargs):
10695 """GetHelpString(self, int id) -> String"""
10696 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10697
10698 def GetFrame(*args, **kwargs):
10699 """GetFrame(self) -> wxFrame"""
10700 return _core_.MenuBar_GetFrame(*args, **kwargs)
10701
10702 def IsAttached(*args, **kwargs):
10703 """IsAttached(self) -> bool"""
10704 return _core_.MenuBar_IsAttached(*args, **kwargs)
10705
10706 def Attach(*args, **kwargs):
10707 """Attach(self, wxFrame frame)"""
10708 return _core_.MenuBar_Attach(*args, **kwargs)
10709
10710 def Detach(*args, **kwargs):
10711 """Detach(self)"""
10712 return _core_.MenuBar_Detach(*args, **kwargs)
10713
10714 def UpdateMenus(*args, **kwargs):
10715 """UpdateMenus(self)"""
10716 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10717
10718 def SetAutoWindowMenu(*args, **kwargs):
10719 """SetAutoWindowMenu(bool enable)"""
10720 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10721
10722 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10723 def GetAutoWindowMenu(*args, **kwargs):
10724 """GetAutoWindowMenu() -> bool"""
10725 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10726
10727 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10728 def GetMenus(self):
10729 """Return a list of (menu, label) items for the menus in the MenuBar. """
10730 return [(self.GetMenu(i), self.GetLabelTop(i))
10731 for i in range(self.GetMenuCount())]
10732
10733 def SetMenus(self, items):
10734 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10735 for i in range(self.GetMenuCount()-1, -1, -1):
10736 self.Remove(i)
10737 for m, l in items:
10738 self.Append(m, l)
10739
10740 Frame = property(GetFrame,doc="See `GetFrame`")
10741 Menu = property(GetMenu,doc="See `GetMenu`")
10742 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
10743 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
10744 _core_.MenuBar_swigregister(MenuBar)
10745
10746 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10747 """MenuBar_SetAutoWindowMenu(bool enable)"""
10748 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10749
10750 def MenuBar_GetAutoWindowMenu(*args):
10751 """MenuBar_GetAutoWindowMenu() -> bool"""
10752 return _core_.MenuBar_GetAutoWindowMenu(*args)
10753
10754 #---------------------------------------------------------------------------
10755
10756 class MenuItem(Object):
10757 """Proxy of C++ MenuItem class"""
10758 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10759 __repr__ = _swig_repr
10760 def __init__(self, *args, **kwargs):
10761 """
10762 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10763 String help=EmptyString, int kind=ITEM_NORMAL,
10764 Menu subMenu=None) -> MenuItem
10765 """
10766 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10767 __swig_destroy__ = _core_.delete_MenuItem
10768 __del__ = lambda self : None;
10769 def GetMenu(*args, **kwargs):
10770 """GetMenu(self) -> Menu"""
10771 return _core_.MenuItem_GetMenu(*args, **kwargs)
10772
10773 def SetMenu(*args, **kwargs):
10774 """SetMenu(self, Menu menu)"""
10775 return _core_.MenuItem_SetMenu(*args, **kwargs)
10776
10777 def SetId(*args, **kwargs):
10778 """SetId(self, int id)"""
10779 return _core_.MenuItem_SetId(*args, **kwargs)
10780
10781 def GetId(*args, **kwargs):
10782 """GetId(self) -> int"""
10783 return _core_.MenuItem_GetId(*args, **kwargs)
10784
10785 def IsSeparator(*args, **kwargs):
10786 """IsSeparator(self) -> bool"""
10787 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10788
10789 def SetText(*args, **kwargs):
10790 """SetText(self, String str)"""
10791 return _core_.MenuItem_SetText(*args, **kwargs)
10792
10793 def GetLabel(*args, **kwargs):
10794 """GetLabel(self) -> String"""
10795 return _core_.MenuItem_GetLabel(*args, **kwargs)
10796
10797 def GetText(*args, **kwargs):
10798 """GetText(self) -> String"""
10799 return _core_.MenuItem_GetText(*args, **kwargs)
10800
10801 def GetLabelFromText(*args, **kwargs):
10802 """GetLabelFromText(String text) -> String"""
10803 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10804
10805 GetLabelFromText = staticmethod(GetLabelFromText)
10806 def GetKind(*args, **kwargs):
10807 """GetKind(self) -> int"""
10808 return _core_.MenuItem_GetKind(*args, **kwargs)
10809
10810 def SetKind(*args, **kwargs):
10811 """SetKind(self, int kind)"""
10812 return _core_.MenuItem_SetKind(*args, **kwargs)
10813
10814 def SetCheckable(*args, **kwargs):
10815 """SetCheckable(self, bool checkable)"""
10816 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10817
10818 def IsCheckable(*args, **kwargs):
10819 """IsCheckable(self) -> bool"""
10820 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10821
10822 def IsSubMenu(*args, **kwargs):
10823 """IsSubMenu(self) -> bool"""
10824 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10825
10826 def SetSubMenu(*args, **kwargs):
10827 """SetSubMenu(self, Menu menu)"""
10828 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10829
10830 def GetSubMenu(*args, **kwargs):
10831 """GetSubMenu(self) -> Menu"""
10832 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10833
10834 def Enable(*args, **kwargs):
10835 """Enable(self, bool enable=True)"""
10836 return _core_.MenuItem_Enable(*args, **kwargs)
10837
10838 def IsEnabled(*args, **kwargs):
10839 """IsEnabled(self) -> bool"""
10840 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10841
10842 def Check(*args, **kwargs):
10843 """Check(self, bool check=True)"""
10844 return _core_.MenuItem_Check(*args, **kwargs)
10845
10846 def IsChecked(*args, **kwargs):
10847 """IsChecked(self) -> bool"""
10848 return _core_.MenuItem_IsChecked(*args, **kwargs)
10849
10850 def Toggle(*args, **kwargs):
10851 """Toggle(self)"""
10852 return _core_.MenuItem_Toggle(*args, **kwargs)
10853
10854 def SetHelp(*args, **kwargs):
10855 """SetHelp(self, String str)"""
10856 return _core_.MenuItem_SetHelp(*args, **kwargs)
10857
10858 def GetHelp(*args, **kwargs):
10859 """GetHelp(self) -> String"""
10860 return _core_.MenuItem_GetHelp(*args, **kwargs)
10861
10862 def GetAccel(*args, **kwargs):
10863 """GetAccel(self) -> AcceleratorEntry"""
10864 return _core_.MenuItem_GetAccel(*args, **kwargs)
10865
10866 def SetAccel(*args, **kwargs):
10867 """SetAccel(self, AcceleratorEntry accel)"""
10868 return _core_.MenuItem_SetAccel(*args, **kwargs)
10869
10870 def SetBitmap(*args, **kwargs):
10871 """SetBitmap(self, Bitmap bitmap)"""
10872 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10873
10874 def GetBitmap(*args, **kwargs):
10875 """GetBitmap(self) -> Bitmap"""
10876 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10877
10878 def SetFont(*args, **kwargs):
10879 """SetFont(self, Font font)"""
10880 return _core_.MenuItem_SetFont(*args, **kwargs)
10881
10882 def GetFont(*args, **kwargs):
10883 """GetFont(self) -> Font"""
10884 return _core_.MenuItem_GetFont(*args, **kwargs)
10885
10886 def SetTextColour(*args, **kwargs):
10887 """SetTextColour(self, Colour colText)"""
10888 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10889
10890 def GetTextColour(*args, **kwargs):
10891 """GetTextColour(self) -> Colour"""
10892 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10893
10894 def SetBackgroundColour(*args, **kwargs):
10895 """SetBackgroundColour(self, Colour colBack)"""
10896 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10897
10898 def GetBackgroundColour(*args, **kwargs):
10899 """GetBackgroundColour(self) -> Colour"""
10900 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10901
10902 def SetBitmaps(*args, **kwargs):
10903 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10904 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10905
10906 def SetDisabledBitmap(*args, **kwargs):
10907 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10908 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10909
10910 def GetDisabledBitmap(*args, **kwargs):
10911 """GetDisabledBitmap(self) -> Bitmap"""
10912 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10913
10914 def SetMarginWidth(*args, **kwargs):
10915 """SetMarginWidth(self, int nWidth)"""
10916 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10917
10918 def GetMarginWidth(*args, **kwargs):
10919 """GetMarginWidth(self) -> int"""
10920 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10921
10922 def GetDefaultMarginWidth(*args, **kwargs):
10923 """GetDefaultMarginWidth() -> int"""
10924 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10925
10926 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10927 def IsOwnerDrawn(*args, **kwargs):
10928 """IsOwnerDrawn(self) -> bool"""
10929 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10930
10931 def SetOwnerDrawn(*args, **kwargs):
10932 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10933 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10934
10935 def ResetOwnerDrawn(*args, **kwargs):
10936 """ResetOwnerDrawn(self)"""
10937 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10938
10939 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
10940 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10941 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
10942 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10943 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10944 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
10945 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10946 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
10947 Label = property(GetLabel,doc="See `GetLabel`")
10948 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
10949 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
10950 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
10951 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
10952 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
10953 _core_.MenuItem_swigregister(MenuItem)
10954
10955 def MenuItem_GetLabelFromText(*args, **kwargs):
10956 """MenuItem_GetLabelFromText(String text) -> String"""
10957 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10958
10959 def MenuItem_GetDefaultMarginWidth(*args):
10960 """MenuItem_GetDefaultMarginWidth() -> int"""
10961 return _core_.MenuItem_GetDefaultMarginWidth(*args)
10962
10963 #---------------------------------------------------------------------------
10964
10965 class Control(Window):
10966 """
10967 This is the base class for a control or 'widget'.
10968
10969 A control is generally a small window which processes user input
10970 and/or displays one or more item of data.
10971 """
10972 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10973 __repr__ = _swig_repr
10974 def __init__(self, *args, **kwargs):
10975 """
10976 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10977 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10978 String name=ControlNameStr) -> Control
10979
10980 Create a Control. Normally you should only call this from a subclass'
10981 __init__ as a plain old wx.Control is not very useful.
10982 """
10983 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
10984 self._setOORInfo(self)
10985
10986 def Create(*args, **kwargs):
10987 """
10988 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10989 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10990 String name=ControlNameStr) -> bool
10991
10992 Do the 2nd phase and create the GUI control.
10993 """
10994 return _core_.Control_Create(*args, **kwargs)
10995
10996 def GetAlignment(*args, **kwargs):
10997 """
10998 GetAlignment(self) -> int
10999
11000 Get the control alignment (left/right/centre, top/bottom/centre)
11001 """
11002 return _core_.Control_GetAlignment(*args, **kwargs)
11003
11004 def GetLabelText(*args, **kwargs):
11005 """
11006 GetLabelText(self) -> String
11007
11008 Get just the text of the label, without mnemonic characters ('&')
11009 """
11010 return _core_.Control_GetLabelText(*args, **kwargs)
11011
11012 def Command(*args, **kwargs):
11013 """
11014 Command(self, CommandEvent event)
11015
11016 Simulates the effect of the user issuing a command to the item.
11017
11018 :see: `wx.CommandEvent`
11019
11020 """
11021 return _core_.Control_Command(*args, **kwargs)
11022
11023 def GetClassDefaultAttributes(*args, **kwargs):
11024 """
11025 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11026
11027 Get the default attributes for this class. This is useful if you want
11028 to use the same font or colour in your own control as in a standard
11029 control -- which is a much better idea than hard coding specific
11030 colours or fonts which might look completely out of place on the
11031 user's system, especially if it uses themes.
11032
11033 The variant parameter is only relevant under Mac currently and is
11034 ignore under other platforms. Under Mac, it will change the size of
11035 the returned font. See `wx.Window.SetWindowVariant` for more about
11036 this.
11037 """
11038 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11039
11040 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11041 Alignment = property(GetAlignment,doc="See `GetAlignment`")
11042 LabelText = property(GetLabelText,doc="See `GetLabelText`")
11043 _core_.Control_swigregister(Control)
11044 ControlNameStr = cvar.ControlNameStr
11045
11046 def PreControl(*args, **kwargs):
11047 """
11048 PreControl() -> Control
11049
11050 Precreate a Control control for 2-phase creation
11051 """
11052 val = _core_.new_PreControl(*args, **kwargs)
11053 return val
11054
11055 def Control_GetClassDefaultAttributes(*args, **kwargs):
11056 """
11057 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11058
11059 Get the default attributes for this class. This is useful if you want
11060 to use the same font or colour in your own control as in a standard
11061 control -- which is a much better idea than hard coding specific
11062 colours or fonts which might look completely out of place on the
11063 user's system, especially if it uses themes.
11064
11065 The variant parameter is only relevant under Mac currently and is
11066 ignore under other platforms. Under Mac, it will change the size of
11067 the returned font. See `wx.Window.SetWindowVariant` for more about
11068 this.
11069 """
11070 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11071
11072 #---------------------------------------------------------------------------
11073
11074 class ItemContainer(object):
11075 """
11076 The wx.ItemContainer class defines an interface which is implemented
11077 by all controls which have string subitems, each of which may be
11078 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11079 as `wx.ComboBox` which implements an extended interface deriving from
11080 this one.
11081
11082 It defines the methods for accessing the control's items and although
11083 each of the derived classes implements them differently, they still
11084 all conform to the same interface.
11085
11086 The items in a wx.ItemContainer have (non empty) string labels and,
11087 optionally, client data associated with them.
11088
11089 """
11090 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11091 def __init__(self): raise AttributeError, "No constructor defined"
11092 __repr__ = _swig_repr
11093 def Append(*args, **kwargs):
11094 """
11095 Append(self, String item, PyObject clientData=None) -> int
11096
11097 Adds the item to the control, associating the given data with the item
11098 if not None. The return value is the index of the newly added item
11099 which may be different from the last one if the control is sorted (e.g.
11100 has wx.LB_SORT or wx.CB_SORT style).
11101 """
11102 return _core_.ItemContainer_Append(*args, **kwargs)
11103
11104 def AppendItems(*args, **kwargs):
11105 """
11106 AppendItems(self, List strings)
11107
11108 Apend several items at once to the control. Notice that calling this
11109 method may be much faster than appending the items one by one if you
11110 need to add a lot of items.
11111 """
11112 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11113
11114 def Insert(*args, **kwargs):
11115 """
11116 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11117
11118 Insert an item into the control before the item at the ``pos`` index,
11119 optionally associating some data object with the item.
11120 """
11121 return _core_.ItemContainer_Insert(*args, **kwargs)
11122
11123 def Clear(*args, **kwargs):
11124 """
11125 Clear(self)
11126
11127 Removes all items from the control.
11128 """
11129 return _core_.ItemContainer_Clear(*args, **kwargs)
11130
11131 def Delete(*args, **kwargs):
11132 """
11133 Delete(self, unsigned int n)
11134
11135 Deletes the item at the zero-based index 'n' from the control. Note
11136 that it is an error (signalled by a `wx.PyAssertionError` exception if
11137 enabled) to remove an item with the index negative or greater or equal
11138 than the number of items in the control.
11139 """
11140 return _core_.ItemContainer_Delete(*args, **kwargs)
11141
11142 def GetClientData(*args, **kwargs):
11143 """
11144 GetClientData(self, unsigned int n) -> PyObject
11145
11146 Returns the client data associated with the given item, (if any.)
11147 """
11148 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11149
11150 def SetClientData(*args, **kwargs):
11151 """
11152 SetClientData(self, unsigned int n, PyObject clientData)
11153
11154 Associate the given client data with the item at position n.
11155 """
11156 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11157
11158 def GetCount(*args, **kwargs):
11159 """
11160 GetCount(self) -> unsigned int
11161
11162 Returns the number of items in the control.
11163 """
11164 return _core_.ItemContainer_GetCount(*args, **kwargs)
11165
11166 def IsEmpty(*args, **kwargs):
11167 """
11168 IsEmpty(self) -> bool
11169
11170 Returns True if the control is empty or False if it has some items.
11171 """
11172 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11173
11174 def GetString(*args, **kwargs):
11175 """
11176 GetString(self, unsigned int n) -> String
11177
11178 Returns the label of the item with the given index.
11179 """
11180 return _core_.ItemContainer_GetString(*args, **kwargs)
11181
11182 def GetStrings(*args, **kwargs):
11183 """GetStrings(self) -> wxArrayString"""
11184 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11185
11186 def SetString(*args, **kwargs):
11187 """
11188 SetString(self, unsigned int n, String s)
11189
11190 Sets the label for the given item.
11191 """
11192 return _core_.ItemContainer_SetString(*args, **kwargs)
11193
11194 def FindString(*args, **kwargs):
11195 """
11196 FindString(self, String s) -> int
11197
11198 Finds an item whose label matches the given string. Returns the
11199 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11200 found.
11201 """
11202 return _core_.ItemContainer_FindString(*args, **kwargs)
11203
11204 def SetSelection(*args, **kwargs):
11205 """
11206 SetSelection(self, int n)
11207
11208 Sets the item at index 'n' to be the selected item.
11209 """
11210 return _core_.ItemContainer_SetSelection(*args, **kwargs)
11211
11212 def GetSelection(*args, **kwargs):
11213 """
11214 GetSelection(self) -> int
11215
11216 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11217 is selected.
11218 """
11219 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11220
11221 def SetStringSelection(*args, **kwargs):
11222 """SetStringSelection(self, String s) -> bool"""
11223 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11224
11225 def GetStringSelection(*args, **kwargs):
11226 """
11227 GetStringSelection(self) -> String
11228
11229 Returns the label of the selected item or an empty string if no item
11230 is selected.
11231 """
11232 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11233
11234 def Select(*args, **kwargs):
11235 """
11236 Select(self, int n)
11237
11238 This is the same as `SetSelection` and exists only because it is
11239 slightly more natural for controls which support multiple selection.
11240 """
11241 return _core_.ItemContainer_Select(*args, **kwargs)
11242
11243 def GetItems(self):
11244 """Return a list of the strings in the control"""
11245 return [self.GetString(i) for i in xrange(self.GetCount())]
11246
11247 def SetItems(self, items):
11248 """Clear and set the strings in the control from a list"""
11249 self.Clear()
11250 for i in items:
11251 self.Append(i)
11252
11253 Count = property(GetCount,doc="See `GetCount`")
11254 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11255 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11256 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11257 Strings = property(GetStrings,doc="See `GetStrings`")
11258 _core_.ItemContainer_swigregister(ItemContainer)
11259
11260 #---------------------------------------------------------------------------
11261
11262 class ControlWithItems(Control,ItemContainer):
11263 """
11264 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11265 wx.Control class, and is used for the base class of various controls
11266 that have items.
11267 """
11268 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11269 def __init__(self): raise AttributeError, "No constructor defined"
11270 __repr__ = _swig_repr
11271 _core_.ControlWithItems_swigregister(ControlWithItems)
11272
11273 #---------------------------------------------------------------------------
11274
11275 class SizerItem(Object):
11276 """
11277 The wx.SizerItem class is used to track the position, size and other
11278 attributes of each item managed by a `wx.Sizer`. It is not usually
11279 necessary to use this class because the sizer elements can also be
11280 identified by their positions or window or sizer references but
11281 sometimes it may be more convenient to use wx.SizerItem directly.
11282 Also, custom classes derived from `wx.PySizer` will probably need to
11283 use the collection of wx.SizerItems held by wx.Sizer when calculating
11284 layout.
11285
11286 :see: `wx.Sizer`, `wx.GBSizerItem`
11287 """
11288 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11289 __repr__ = _swig_repr
11290 def __init__(self, *args, **kwargs):
11291 """
11292 __init__(self) -> SizerItem
11293
11294 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11295 size will need to be set before this item can be used in a Sizer.
11296
11297 You will probably never need to create a wx.SizerItem directly as they
11298 are created automatically when the sizer's Add, Insert or Prepend
11299 methods are called.
11300
11301 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11302 """
11303 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11304 __swig_destroy__ = _core_.delete_SizerItem
11305 __del__ = lambda self : None;
11306 def DeleteWindows(*args, **kwargs):
11307 """
11308 DeleteWindows(self)
11309
11310 Destroy the window or the windows in a subsizer, depending on the type
11311 of item.
11312 """
11313 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11314
11315 def DetachSizer(*args, **kwargs):
11316 """
11317 DetachSizer(self)
11318
11319 Enable deleting the SizerItem without destroying the contained sizer.
11320 """
11321 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11322
11323 def GetSize(*args, **kwargs):
11324 """
11325 GetSize(self) -> Size
11326
11327 Get the current size of the item, as set in the last Layout.
11328 """
11329 return _core_.SizerItem_GetSize(*args, **kwargs)
11330
11331 def CalcMin(*args, **kwargs):
11332 """
11333 CalcMin(self) -> Size
11334
11335 Calculates the minimum desired size for the item, including any space
11336 needed by borders.
11337 """
11338 return _core_.SizerItem_CalcMin(*args, **kwargs)
11339
11340 def SetDimension(*args, **kwargs):
11341 """
11342 SetDimension(self, Point pos, Size size)
11343
11344 Set the position and size of the space allocated for this item by the
11345 sizer, and adjust the position and size of the item (window or
11346 subsizer) to be within that space taking alignment and borders into
11347 account.
11348 """
11349 return _core_.SizerItem_SetDimension(*args, **kwargs)
11350
11351 def GetMinSize(*args, **kwargs):
11352 """
11353 GetMinSize(self) -> Size
11354
11355 Get the minimum size needed for the item.
11356 """
11357 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11358
11359 def GetMinSizeWithBorder(*args, **kwargs):
11360 """
11361 GetMinSizeWithBorder(self) -> Size
11362
11363 Get the minimum size needed for the item with space for the borders
11364 added, if needed.
11365 """
11366 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11367
11368 def SetInitSize(*args, **kwargs):
11369 """SetInitSize(self, int x, int y)"""
11370 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11371
11372 def SetRatioWH(*args, **kwargs):
11373 """
11374 SetRatioWH(self, int width, int height)
11375
11376 Set the ratio item attribute.
11377 """
11378 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11379
11380 def SetRatioSize(*args, **kwargs):
11381 """
11382 SetRatioSize(self, Size size)
11383
11384 Set the ratio item attribute.
11385 """
11386 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11387
11388 def SetRatio(*args, **kwargs):
11389 """
11390 SetRatio(self, float ratio)
11391
11392 Set the ratio item attribute.
11393 """
11394 return _core_.SizerItem_SetRatio(*args, **kwargs)
11395
11396 def GetRatio(*args, **kwargs):
11397 """
11398 GetRatio(self) -> float
11399
11400 Set the ratio item attribute.
11401 """
11402 return _core_.SizerItem_GetRatio(*args, **kwargs)
11403
11404 def GetRect(*args, **kwargs):
11405 """
11406 GetRect(self) -> Rect
11407
11408 Returns the rectangle that the sizer item should occupy
11409 """
11410 return _core_.SizerItem_GetRect(*args, **kwargs)
11411
11412 def IsWindow(*args, **kwargs):
11413 """
11414 IsWindow(self) -> bool
11415
11416 Is this sizer item a window?
11417 """
11418 return _core_.SizerItem_IsWindow(*args, **kwargs)
11419
11420 def IsSizer(*args, **kwargs):
11421 """
11422 IsSizer(self) -> bool
11423
11424 Is this sizer item a subsizer?
11425 """
11426 return _core_.SizerItem_IsSizer(*args, **kwargs)
11427
11428 def IsSpacer(*args, **kwargs):
11429 """
11430 IsSpacer(self) -> bool
11431
11432 Is this sizer item a spacer?
11433 """
11434 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11435
11436 def SetProportion(*args, **kwargs):
11437 """
11438 SetProportion(self, int proportion)
11439
11440 Set the proportion value for this item.
11441 """
11442 return _core_.SizerItem_SetProportion(*args, **kwargs)
11443
11444 def GetProportion(*args, **kwargs):
11445 """
11446 GetProportion(self) -> int
11447
11448 Get the proportion value for this item.
11449 """
11450 return _core_.SizerItem_GetProportion(*args, **kwargs)
11451
11452 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11453 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
11454 def SetFlag(*args, **kwargs):
11455 """
11456 SetFlag(self, int flag)
11457
11458 Set the flag value for this item.
11459 """
11460 return _core_.SizerItem_SetFlag(*args, **kwargs)
11461
11462 def GetFlag(*args, **kwargs):
11463 """
11464 GetFlag(self) -> int
11465
11466 Get the flag value for this item.
11467 """
11468 return _core_.SizerItem_GetFlag(*args, **kwargs)
11469
11470 def SetBorder(*args, **kwargs):
11471 """
11472 SetBorder(self, int border)
11473
11474 Set the border value for this item.
11475 """
11476 return _core_.SizerItem_SetBorder(*args, **kwargs)
11477
11478 def GetBorder(*args, **kwargs):
11479 """
11480 GetBorder(self) -> int
11481
11482 Get the border value for this item.
11483 """
11484 return _core_.SizerItem_GetBorder(*args, **kwargs)
11485
11486 def GetWindow(*args, **kwargs):
11487 """
11488 GetWindow(self) -> Window
11489
11490 Get the window (if any) that is managed by this sizer item.
11491 """
11492 return _core_.SizerItem_GetWindow(*args, **kwargs)
11493
11494 def SetWindow(*args, **kwargs):
11495 """
11496 SetWindow(self, Window window)
11497
11498 Set the window to be managed by this sizer item.
11499 """
11500 return _core_.SizerItem_SetWindow(*args, **kwargs)
11501
11502 def GetSizer(*args, **kwargs):
11503 """
11504 GetSizer(self) -> Sizer
11505
11506 Get the subsizer (if any) that is managed by this sizer item.
11507 """
11508 return _core_.SizerItem_GetSizer(*args, **kwargs)
11509
11510 def SetSizer(*args, **kwargs):
11511 """
11512 SetSizer(self, Sizer sizer)
11513
11514 Set the subsizer to be managed by this sizer item.
11515 """
11516 return _core_.SizerItem_SetSizer(*args, **kwargs)
11517
11518 def GetSpacer(*args, **kwargs):
11519 """
11520 GetSpacer(self) -> Size
11521
11522 Get the size of the spacer managed by this sizer item.
11523 """
11524 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11525
11526 def SetSpacer(*args, **kwargs):
11527 """
11528 SetSpacer(self, Size size)
11529
11530 Set the size of the spacer to be managed by this sizer item.
11531 """
11532 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11533
11534 def Show(*args, **kwargs):
11535 """
11536 Show(self, bool show)
11537
11538 Set the show item attribute, which sizers use to determine if the item
11539 is to be made part of the layout or not. If the item is tracking a
11540 window then it is shown or hidden as needed.
11541 """
11542 return _core_.SizerItem_Show(*args, **kwargs)
11543
11544 def IsShown(*args, **kwargs):
11545 """
11546 IsShown(self) -> bool
11547
11548 Is the item to be shown in the layout?
11549 """
11550 return _core_.SizerItem_IsShown(*args, **kwargs)
11551
11552 def GetPosition(*args, **kwargs):
11553 """
11554 GetPosition(self) -> Point
11555
11556 Returns the current position of the item, as set in the last Layout.
11557 """
11558 return _core_.SizerItem_GetPosition(*args, **kwargs)
11559
11560 def GetUserData(*args, **kwargs):
11561 """
11562 GetUserData(self) -> PyObject
11563
11564 Returns the userData associated with this sizer item, or None if there
11565 isn't any.
11566 """
11567 return _core_.SizerItem_GetUserData(*args, **kwargs)
11568
11569 def SetUserData(*args, **kwargs):
11570 """
11571 SetUserData(self, PyObject userData)
11572
11573 Associate a Python object with this sizer item.
11574 """
11575 return _core_.SizerItem_SetUserData(*args, **kwargs)
11576
11577 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11578 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11579 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11580 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11581 Position = property(GetPosition,doc="See `GetPosition`")
11582 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11583 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11584 Rect = property(GetRect,doc="See `GetRect`")
11585 Size = property(GetSize,doc="See `GetSize`")
11586 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11587 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11588 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11589 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
11590 _core_.SizerItem_swigregister(SizerItem)
11591
11592 def SizerItemWindow(*args, **kwargs):
11593 """
11594 SizerItemWindow(Window window, int proportion, int flag, int border,
11595 PyObject userData=None) -> SizerItem
11596
11597 Constructs a `wx.SizerItem` for tracking a window.
11598 """
11599 val = _core_.new_SizerItemWindow(*args, **kwargs)
11600 return val
11601
11602 def SizerItemSpacer(*args, **kwargs):
11603 """
11604 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11605 PyObject userData=None) -> SizerItem
11606
11607 Constructs a `wx.SizerItem` for tracking a spacer.
11608 """
11609 val = _core_.new_SizerItemSpacer(*args, **kwargs)
11610 return val
11611
11612 def SizerItemSizer(*args, **kwargs):
11613 """
11614 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11615 PyObject userData=None) -> SizerItem
11616
11617 Constructs a `wx.SizerItem` for tracking a subsizer
11618 """
11619 val = _core_.new_SizerItemSizer(*args, **kwargs)
11620 return val
11621
11622 class Sizer(Object):
11623 """
11624 wx.Sizer is the abstract base class used for laying out subwindows in
11625 a window. You cannot use wx.Sizer directly; instead, you will have to
11626 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11627 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11628 `wx.GridBagSizer`.
11629
11630 The concept implemented by sizers in wxWidgets is closely related to
11631 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11632 toolkit or the Qt toolkit. It is based upon the idea of the individual
11633 subwindows reporting their minimal required size and their ability to
11634 get stretched if the size of the parent window has changed. This will
11635 most often mean that the programmer does not set the original size of
11636 a dialog in the beginning, rather the dialog will assigned a sizer and
11637 this sizer will be queried about the recommended size. The sizer in
11638 turn will query its children, which can be normal windows or contorls,
11639 empty space or other sizers, so that a hierarchy of sizers can be
11640 constructed. Note that wxSizer does not derive from wxWindow and thus
11641 do not interfere with tab ordering and requires very little resources
11642 compared to a real window on screen.
11643
11644 What makes sizers so well fitted for use in wxWidgets is the fact that
11645 every control reports its own minimal size and the algorithm can
11646 handle differences in font sizes or different window (dialog item)
11647 sizes on different platforms without problems. If for example the
11648 standard font as well as the overall design of Mac widgets requires
11649 more space than on Windows, then the initial size of a dialog using a
11650 sizer will automatically be bigger on Mac than on Windows.
11651 """
11652 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11653 def __init__(self): raise AttributeError, "No constructor defined"
11654 __repr__ = _swig_repr
11655 __swig_destroy__ = _core_.delete_Sizer
11656 __del__ = lambda self : None;
11657 def _setOORInfo(*args, **kwargs):
11658 """_setOORInfo(self, PyObject _self)"""
11659 return _core_.Sizer__setOORInfo(*args, **kwargs)
11660
11661 def Add(*args, **kwargs):
11662 """
11663 Add(self, item, int proportion=0, int flag=0, int border=0,
11664 PyObject userData=None) -> wx.SizerItem
11665
11666 Appends a child item to the sizer.
11667 """
11668 return _core_.Sizer_Add(*args, **kwargs)
11669
11670 def Insert(*args, **kwargs):
11671 """
11672 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11673 PyObject userData=None) -> wx.SizerItem
11674
11675 Inserts a new item into the list of items managed by this sizer before
11676 the item at index *before*. See `Add` for a description of the parameters.
11677 """
11678 return _core_.Sizer_Insert(*args, **kwargs)
11679
11680 def Prepend(*args, **kwargs):
11681 """
11682 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11683 PyObject userData=None) -> wx.SizerItem
11684
11685 Adds a new item to the begining of the list of sizer items managed by
11686 this sizer. See `Add` for a description of the parameters.
11687 """
11688 return _core_.Sizer_Prepend(*args, **kwargs)
11689
11690 def Remove(*args, **kwargs):
11691 """
11692 Remove(self, item) -> bool
11693
11694 Removes an item from the sizer and destroys it. This method does not
11695 cause any layout or resizing to take place, call `Layout` to update
11696 the layout on screen after removing a child from the sizer. The
11697 *item* parameter can be either a window, a sizer, or the zero-based
11698 index of an item to remove. Returns True if the child item was found
11699 and removed.
11700 """
11701 return _core_.Sizer_Remove(*args, **kwargs)
11702
11703 def Detach(*args, **kwargs):
11704 """
11705 Detach(self, item) -> bool
11706
11707 Detaches an item from the sizer without destroying it. This method
11708 does not cause any layout or resizing to take place, call `Layout` to
11709 do so. The *item* parameter can be either a window, a sizer, or the
11710 zero-based index of the item to be detached. Returns True if the child item
11711 was found and detached.
11712 """
11713 return _core_.Sizer_Detach(*args, **kwargs)
11714
11715 def GetItem(*args, **kwargs):
11716 """
11717 GetItem(self, item) -> wx.SizerItem
11718
11719 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11720 parameter can be either a window, a sizer, or the zero-based index of
11721 the item to be found.
11722 """
11723 return _core_.Sizer_GetItem(*args, **kwargs)
11724
11725 def _SetItemMinSize(*args, **kwargs):
11726 """_SetItemMinSize(self, PyObject item, Size size)"""
11727 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11728
11729 def _ReplaceWin(*args, **kwargs):
11730 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11731 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11732
11733 def _ReplaceSizer(*args, **kwargs):
11734 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11735 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11736
11737 def _ReplaceItem(*args, **kwargs):
11738 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11739 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11740
11741 def Replace(self, olditem, item, recursive=False):
11742 """
11743 Detaches the given ``olditem`` from the sizer and replaces it with
11744 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11745 detached child is destroyed only if it is not a window, (because
11746 windows are owned by their parent, not the sizer.) The
11747 ``recursive`` parameter can be used to search for the given
11748 element recursivly in subsizers.
11749
11750 This method does not cause any layout or resizing to take place,
11751 call `Layout` to do so.
11752
11753 Returns ``True`` if the child item was found and removed.
11754 """
11755 if isinstance(olditem, wx.Window):
11756 return self._ReplaceWin(olditem, item, recursive)
11757 elif isinstnace(olditem, wx.Sizer):
11758 return self._ReplaceSizer(olditem, item, recursive)
11759 elif isinstnace(olditem, int):
11760 return self._ReplaceItem(olditem, item)
11761 else:
11762 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11763
11764 def SetContainingWindow(*args, **kwargs):
11765 """
11766 SetContainingWindow(self, Window window)
11767
11768 Set (or unset) the window this sizer is used in.
11769 """
11770 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
11771
11772 def GetContainingWindow(*args, **kwargs):
11773 """
11774 GetContainingWindow(self) -> Window
11775
11776 Get the window this sizer is used in.
11777 """
11778 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
11779
11780 def SetItemMinSize(self, item, *args):
11781 """
11782 SetItemMinSize(self, item, Size size)
11783
11784 Sets the minimum size that will be allocated for an item in the sizer.
11785 The *item* parameter can be either a window, a sizer, or the
11786 zero-based index of the item. If a window or sizer is given then it
11787 will be searched for recursivly in subsizers if neccessary.
11788 """
11789 if len(args) == 2:
11790 # for backward compatibility accept separate width,height args too
11791 return self._SetItemMinSize(item, args)
11792 else:
11793 return self._SetItemMinSize(item, args[0])
11794
11795 def AddItem(*args, **kwargs):
11796 """
11797 AddItem(self, SizerItem item)
11798
11799 Adds a `wx.SizerItem` to the sizer.
11800 """
11801 return _core_.Sizer_AddItem(*args, **kwargs)
11802
11803 def InsertItem(*args, **kwargs):
11804 """
11805 InsertItem(self, int index, SizerItem item)
11806
11807 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11808 """
11809 return _core_.Sizer_InsertItem(*args, **kwargs)
11810
11811 def PrependItem(*args, **kwargs):
11812 """
11813 PrependItem(self, SizerItem item)
11814
11815 Prepends a `wx.SizerItem` to the sizer.
11816 """
11817 return _core_.Sizer_PrependItem(*args, **kwargs)
11818
11819 def AddMany(self, items):
11820 """
11821 AddMany is a convenience method for adding several items
11822 to a sizer at one time. Simply pass it a list of tuples,
11823 where each tuple consists of the parameters that you
11824 would normally pass to the `Add` method.
11825 """
11826 for item in items:
11827 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11828 item = (item, )
11829 self.Add(*item)
11830
11831 def AddSpacer(self, *args, **kw):
11832 """AddSpacer(int size) --> SizerItem
11833
11834 Add a spacer that is (size,size) pixels.
11835 """
11836 if args and type(args[0]) == int:
11837 return self.Add( (args[0],args[0] ), 0)
11838 else: # otherwise stay compatible with old AddSpacer
11839 return self.Add(*args, **kw)
11840 def PrependSpacer(self, *args, **kw):
11841 """PrependSpacer(int size) --> SizerItem
11842
11843 Prepend a spacer that is (size, size) pixels."""
11844 if args and type(args[0]) == int:
11845 return self.Prepend( (args[0],args[0] ), 0)
11846 else: # otherwise stay compatible with old PrependSpacer
11847 return self.Prepend(*args, **kw)
11848 def InsertSpacer(self, index, *args, **kw):
11849 """InsertSpacer(int index, int size) --> SizerItem
11850
11851 Insert a spacer at position index that is (size, size) pixels."""
11852 if args and type(args[0]) == int:
11853 return self.Insert( index, (args[0],args[0] ), 0)
11854 else: # otherwise stay compatible with old InsertSpacer
11855 return self.Insert(index, *args, **kw)
11856
11857
11858 def AddStretchSpacer(self, prop=1):
11859 """AddStretchSpacer(int prop=1) --> SizerItem
11860
11861 Add a stretchable spacer."""
11862 return self.Add((0,0), prop)
11863 def PrependStretchSpacer(self, prop=1):
11864 """PrependStretchSpacer(int prop=1) --> SizerItem
11865
11866 Prepend a stretchable spacer."""
11867 return self.Prepend((0,0), prop)
11868 def InsertStretchSpacer(self, index, prop=1):
11869 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11870
11871 Insert a stretchable spacer."""
11872 return self.Insert(index, (0,0), prop)
11873
11874
11875 # for backwards compatibility only, please do not use in new code
11876 def AddWindow(self, *args, **kw):
11877 """Compatibility alias for `Add`."""
11878 return self.Add(*args, **kw)
11879 def AddSizer(self, *args, **kw):
11880 """Compatibility alias for `Add`."""
11881 return self.Add(*args, **kw)
11882
11883 def PrependWindow(self, *args, **kw):
11884 """Compatibility alias for `Prepend`."""
11885 return self.Prepend(*args, **kw)
11886 def PrependSizer(self, *args, **kw):
11887 """Compatibility alias for `Prepend`."""
11888 return self.Prepend(*args, **kw)
11889
11890 def InsertWindow(self, *args, **kw):
11891 """Compatibility alias for `Insert`."""
11892 return self.Insert(*args, **kw)
11893 def InsertSizer(self, *args, **kw):
11894 """Compatibility alias for `Insert`."""
11895 return self.Insert(*args, **kw)
11896
11897 def RemoveWindow(self, *args, **kw):
11898 """Compatibility alias for `Remove`."""
11899 return self.Remove(*args, **kw)
11900 def RemoveSizer(self, *args, **kw):
11901 """Compatibility alias for `Remove`."""
11902 return self.Remove(*args, **kw)
11903 def RemovePos(self, *args, **kw):
11904 """Compatibility alias for `Remove`."""
11905 return self.Remove(*args, **kw)
11906
11907
11908 def SetDimension(*args, **kwargs):
11909 """
11910 SetDimension(self, int x, int y, int width, int height)
11911
11912 Call this to force the sizer to take the given dimension and thus
11913 force the items owned by the sizer to resize themselves according to
11914 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11915 methods.
11916 """
11917 return _core_.Sizer_SetDimension(*args, **kwargs)
11918
11919 def SetMinSize(*args, **kwargs):
11920 """
11921 SetMinSize(self, Size size)
11922
11923 Call this to give the sizer a minimal size. Normally, the sizer will
11924 calculate its minimal size based purely on how much space its children
11925 need. After calling this method `GetMinSize` will return either the
11926 minimal size as requested by its children or the minimal size set
11927 here, depending on which is bigger.
11928 """
11929 return _core_.Sizer_SetMinSize(*args, **kwargs)
11930
11931 def GetSize(*args, **kwargs):
11932 """
11933 GetSize(self) -> Size
11934
11935 Returns the current size of the space managed by the sizer.
11936 """
11937 return _core_.Sizer_GetSize(*args, **kwargs)
11938
11939 def GetPosition(*args, **kwargs):
11940 """
11941 GetPosition(self) -> Point
11942
11943 Returns the current position of the sizer's managed space.
11944 """
11945 return _core_.Sizer_GetPosition(*args, **kwargs)
11946
11947 def GetMinSize(*args, **kwargs):
11948 """
11949 GetMinSize(self) -> Size
11950
11951 Returns the minimal size of the sizer. This is either the combined
11952 minimal size of all the children and their borders or the minimal size
11953 set by SetMinSize, depending on which is bigger.
11954 """
11955 return _core_.Sizer_GetMinSize(*args, **kwargs)
11956
11957 def GetSizeTuple(self):
11958 return self.GetSize().Get()
11959 def GetPositionTuple(self):
11960 return self.GetPosition().Get()
11961 def GetMinSizeTuple(self):
11962 return self.GetMinSize().Get()
11963
11964 def RecalcSizes(*args, **kwargs):
11965 """
11966 RecalcSizes(self)
11967
11968 Using the sizes calculated by `CalcMin` reposition and resize all the
11969 items managed by this sizer. You should not need to call this directly as
11970 it is called by `Layout`.
11971 """
11972 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11973
11974 def CalcMin(*args, **kwargs):
11975 """
11976 CalcMin(self) -> Size
11977
11978 This method is where the sizer will do the actual calculation of its
11979 children's minimal sizes. You should not need to call this directly as
11980 it is called by `Layout`.
11981 """
11982 return _core_.Sizer_CalcMin(*args, **kwargs)
11983
11984 def Layout(*args, **kwargs):
11985 """
11986 Layout(self)
11987
11988 This method will force the recalculation and layout of the items
11989 controlled by the sizer using the current space allocated to the
11990 sizer. Normally this is called automatically from the owning window's
11991 EVT_SIZE handler, but it is also useful to call it from user code when
11992 one of the items in a sizer change size, or items are added or
11993 removed.
11994 """
11995 return _core_.Sizer_Layout(*args, **kwargs)
11996
11997 def Fit(*args, **kwargs):
11998 """
11999 Fit(self, Window window) -> Size
12000
12001 Tell the sizer to resize the *window* to match the sizer's minimal
12002 size. This is commonly done in the constructor of the window itself in
12003 order to set its initial size to match the needs of the children as
12004 determined by the sizer. Returns the new size.
12005
12006 For a top level window this is the total window size, not the client size.
12007 """
12008 return _core_.Sizer_Fit(*args, **kwargs)
12009
12010 def FitInside(*args, **kwargs):
12011 """
12012 FitInside(self, Window window)
12013
12014 Tell the sizer to resize the *virtual size* of the *window* to match the
12015 sizer's minimal size. This will not alter the on screen size of the
12016 window, but may cause the addition/removal/alteration of scrollbars
12017 required to view the virtual area in windows which manage it.
12018
12019 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12020
12021 """
12022 return _core_.Sizer_FitInside(*args, **kwargs)
12023
12024 def SetSizeHints(*args, **kwargs):
12025 """
12026 SetSizeHints(self, Window window)
12027
12028 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12029 match the sizer's minimal size. This is commonly done in the
12030 constructor of the window itself if the window is resizable (as are
12031 many dialogs under Unix and frames on probably all platforms) in order
12032 to prevent the window from being sized smaller than the minimal size
12033 required by the sizer.
12034 """
12035 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12036
12037 def SetVirtualSizeHints(*args, **kwargs):
12038 """
12039 SetVirtualSizeHints(self, Window window)
12040
12041 Tell the sizer to set the minimal size of the window virtual area to
12042 match the sizer's minimal size. For windows with managed scrollbars
12043 this will set them appropriately.
12044
12045 :see: `wx.ScrolledWindow.SetScrollbars`
12046
12047 """
12048 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12049
12050 def Clear(*args, **kwargs):
12051 """
12052 Clear(self, bool deleteWindows=False)
12053
12054 Clear all items from the sizer, optionally destroying the window items
12055 as well.
12056 """
12057 return _core_.Sizer_Clear(*args, **kwargs)
12058
12059 def DeleteWindows(*args, **kwargs):
12060 """
12061 DeleteWindows(self)
12062
12063 Destroy all windows managed by the sizer.
12064 """
12065 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12066
12067 def GetChildren(*args, **kwargs):
12068 """
12069 GetChildren(self) -> list
12070
12071 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12072 """
12073 return _core_.Sizer_GetChildren(*args, **kwargs)
12074
12075 def Show(*args, **kwargs):
12076 """
12077 Show(self, item, bool show=True, bool recursive=false) -> bool
12078
12079 Shows or hides an item managed by the sizer. To make a sizer item
12080 disappear or reappear, use Show followed by `Layout`. The *item*
12081 parameter can be either a window, a sizer, or the zero-based index of
12082 the item. Use the recursive parameter to show or hide an item in a
12083 subsizer. Returns True if the item was found.
12084 """
12085 return _core_.Sizer_Show(*args, **kwargs)
12086
12087 def IsShown(*args, **kwargs):
12088 """
12089 IsShown(self, item)
12090
12091 Determines if the item is currently shown. To make a sizer
12092 item disappear or reappear, use Show followed by `Layout`. The *item*
12093 parameter can be either a window, a sizer, or the zero-based index of
12094 the item.
12095 """
12096 return _core_.Sizer_IsShown(*args, **kwargs)
12097
12098 def Hide(self, item, recursive=False):
12099 """
12100 A convenience method for `Show` (item, False, recursive).
12101 """
12102 return self.Show(item, False, recursive)
12103
12104 def ShowItems(*args, **kwargs):
12105 """
12106 ShowItems(self, bool show)
12107
12108 Recursively call `wx.SizerItem.Show` on all sizer items.
12109 """
12110 return _core_.Sizer_ShowItems(*args, **kwargs)
12111
12112 Children = property(GetChildren,doc="See `GetChildren`")
12113 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12114 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12115 Position = property(GetPosition,doc="See `GetPosition`")
12116 Size = property(GetSize,doc="See `GetSize`")
12117 _core_.Sizer_swigregister(Sizer)
12118
12119 class PySizer(Sizer):
12120 """
12121 wx.PySizer is a special version of `wx.Sizer` that has been
12122 instrumented to allow the C++ virtual methods to be overloaded in
12123 Python derived classes. You would derive from this class if you are
12124 wanting to implement a custom sizer in Python code. Simply implement
12125 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12126 For example::
12127
12128 class MySizer(wx.PySizer):
12129 def __init__(self):
12130 wx.PySizer.__init__(self)
12131
12132 def CalcMin(self):
12133 for item in self.GetChildren():
12134 # calculate the total minimum width and height needed
12135 # by all items in the sizer according to this sizer's
12136 # layout algorithm.
12137 ...
12138 return wx.Size(width, height)
12139
12140 def RecalcSizes(self):
12141 # find the space allotted to this sizer
12142 pos = self.GetPosition()
12143 size = self.GetSize()
12144 for item in self.GetChildren():
12145 # Recalculate (if necessary) the position and size of
12146 # each item and then call item.SetDimension to do the
12147 # actual positioning and sizing of the items within the
12148 # space alloted to this sizer.
12149 ...
12150 item.SetDimension(itemPos, itemSize)
12151
12152
12153 When `Layout` is called it first calls `CalcMin` followed by
12154 `RecalcSizes` so you can optimize a bit by saving the results of
12155 `CalcMin` and reusing them in `RecalcSizes`.
12156
12157 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12158
12159
12160 """
12161 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12162 __repr__ = _swig_repr
12163 def __init__(self, *args, **kwargs):
12164 """
12165 __init__(self) -> PySizer
12166
12167 Creates a wx.PySizer. Must be called from the __init__ in the derived
12168 class.
12169 """
12170 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12171 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12172
12173 def _setCallbackInfo(*args, **kwargs):
12174 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12175 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12176
12177 _core_.PySizer_swigregister(PySizer)
12178
12179 #---------------------------------------------------------------------------
12180
12181 class BoxSizer(Sizer):
12182 """
12183 The basic idea behind a box sizer is that windows will most often be
12184 laid out in rather simple basic geometry, typically in a row or a
12185 column or nested hierarchies of either. A wx.BoxSizer will lay out
12186 its items in a simple row or column, depending on the orientation
12187 parameter passed to the constructor.
12188 """
12189 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12190 __repr__ = _swig_repr
12191 def __init__(self, *args, **kwargs):
12192 """
12193 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12194
12195 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12196 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12197 sizer.
12198 """
12199 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12200 self._setOORInfo(self)
12201
12202 def GetOrientation(*args, **kwargs):
12203 """
12204 GetOrientation(self) -> int
12205
12206 Returns the current orientation of the sizer.
12207 """
12208 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12209
12210 def SetOrientation(*args, **kwargs):
12211 """
12212 SetOrientation(self, int orient)
12213
12214 Resets the orientation of the sizer.
12215 """
12216 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12217
12218 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12219 _core_.BoxSizer_swigregister(BoxSizer)
12220
12221 #---------------------------------------------------------------------------
12222
12223 class StaticBoxSizer(BoxSizer):
12224 """
12225 wx.StaticBoxSizer derives from and functions identically to the
12226 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12227 manages. Note that this static box must be created separately and
12228 passed to the sizer constructor.
12229 """
12230 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12231 __repr__ = _swig_repr
12232 def __init__(self, *args, **kwargs):
12233 """
12234 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12235
12236 Constructor. It takes an associated static box and the orientation
12237 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12238 ``wx.HORIZONTAL``.
12239 """
12240 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12241 self._setOORInfo(self)
12242
12243 def GetStaticBox(*args, **kwargs):
12244 """
12245 GetStaticBox(self) -> StaticBox
12246
12247 Returns the static box associated with this sizer.
12248 """
12249 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12250
12251 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12252 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
12253
12254 #---------------------------------------------------------------------------
12255
12256 class GridSizer(Sizer):
12257 """
12258 A grid sizer is a sizer which lays out its children in a
12259 two-dimensional table with all cells having the same size. In other
12260 words, the width of each cell within the grid is the width of the
12261 widest item added to the sizer and the height of each grid cell is the
12262 height of the tallest item. An optional vertical and/or horizontal
12263 gap between items can also be specified (in pixels.)
12264
12265 Items are placed in the cells of the grid in the order they are added,
12266 in row-major order. In other words, the first row is filled first,
12267 then the second, and so on until all items have been added. (If
12268 neccessary, additional rows will be added as items are added.) If you
12269 need to have greater control over the cells that items are placed in
12270 then use the `wx.GridBagSizer`.
12271
12272 """
12273 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12274 __repr__ = _swig_repr
12275 def __init__(self, *args, **kwargs):
12276 """
12277 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12278
12279 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12280 of columns and rows in the sizer - if either of the parameters is
12281 zero, it will be calculated to from the total number of children in
12282 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12283 define extra space between all children.
12284 """
12285 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
12286 self._setOORInfo(self)
12287
12288 def SetCols(*args, **kwargs):
12289 """
12290 SetCols(self, int cols)
12291
12292 Sets the number of columns in the sizer.
12293 """
12294 return _core_.GridSizer_SetCols(*args, **kwargs)
12295
12296 def SetRows(*args, **kwargs):
12297 """
12298 SetRows(self, int rows)
12299
12300 Sets the number of rows in the sizer.
12301 """
12302 return _core_.GridSizer_SetRows(*args, **kwargs)
12303
12304 def SetVGap(*args, **kwargs):
12305 """
12306 SetVGap(self, int gap)
12307
12308 Sets the vertical gap (in pixels) between the cells in the sizer.
12309 """
12310 return _core_.GridSizer_SetVGap(*args, **kwargs)
12311
12312 def SetHGap(*args, **kwargs):
12313 """
12314 SetHGap(self, int gap)
12315
12316 Sets the horizontal gap (in pixels) between cells in the sizer
12317 """
12318 return _core_.GridSizer_SetHGap(*args, **kwargs)
12319
12320 def GetCols(*args, **kwargs):
12321 """
12322 GetCols(self) -> int
12323
12324 Returns the number of columns in the sizer.
12325 """
12326 return _core_.GridSizer_GetCols(*args, **kwargs)
12327
12328 def GetRows(*args, **kwargs):
12329 """
12330 GetRows(self) -> int
12331
12332 Returns the number of rows in the sizer.
12333 """
12334 return _core_.GridSizer_GetRows(*args, **kwargs)
12335
12336 def GetVGap(*args, **kwargs):
12337 """
12338 GetVGap(self) -> int
12339
12340 Returns the vertical gap (in pixels) between the cells in the sizer.
12341 """
12342 return _core_.GridSizer_GetVGap(*args, **kwargs)
12343
12344 def GetHGap(*args, **kwargs):
12345 """
12346 GetHGap(self) -> int
12347
12348 Returns the horizontal gap (in pixels) between cells in the sizer.
12349 """
12350 return _core_.GridSizer_GetHGap(*args, **kwargs)
12351
12352 def CalcRowsCols(self):
12353 """
12354 CalcRowsCols() -> (rows, cols)
12355
12356 Calculates how many rows and columns will be in the sizer based
12357 on the current number of items and also the rows, cols specified
12358 in the constructor.
12359 """
12360 nitems = len(self.GetChildren())
12361 rows = self.GetRows()
12362 cols = self.GetCols()
12363 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12364 if cols != 0:
12365 rows = (nitems + cols - 1) / cols
12366 elif rows != 0:
12367 cols = (nitems + rows - 1) / rows
12368 return (rows, cols)
12369
12370 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12371 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12372 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12373 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
12374 _core_.GridSizer_swigregister(GridSizer)
12375
12376 #---------------------------------------------------------------------------
12377
12378 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12379 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12380 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12381 class FlexGridSizer(GridSizer):
12382 """
12383 A flex grid sizer is a sizer which lays out its children in a
12384 two-dimensional table with all table cells in one row having the same
12385 height and all cells in one column having the same width, but all
12386 rows or all columns are not necessarily the same height or width as in
12387 the `wx.GridSizer`.
12388
12389 wx.FlexGridSizer can also size items equally in one direction but
12390 unequally ("flexibly") in the other. If the sizer is only flexible
12391 in one direction (this can be changed using `SetFlexibleDirection`), it
12392 needs to be decided how the sizer should grow in the other ("non
12393 flexible") direction in order to fill the available space. The
12394 `SetNonFlexibleGrowMode` method serves this purpose.
12395
12396
12397 """
12398 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12399 __repr__ = _swig_repr
12400 def __init__(self, *args, **kwargs):
12401 """
12402 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12403
12404 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12405 number of columns and rows in the sizer - if either of the parameters
12406 is zero, it will be calculated to from the total number of children in
12407 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12408 define extra space between all children.
12409 """
12410 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
12411 self._setOORInfo(self)
12412
12413 def AddGrowableRow(*args, **kwargs):
12414 """
12415 AddGrowableRow(self, size_t idx, int proportion=0)
12416
12417 Specifies that row *idx* (starting from zero) should be grown if there
12418 is extra space available to the sizer.
12419
12420 The *proportion* parameter has the same meaning as the stretch factor
12421 for the box sizers except that if all proportions are 0, then all
12422 columns are resized equally (instead of not being resized at all).
12423 """
12424 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12425
12426 def RemoveGrowableRow(*args, **kwargs):
12427 """
12428 RemoveGrowableRow(self, size_t idx)
12429
12430 Specifies that row *idx* is no longer growable.
12431 """
12432 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12433
12434 def AddGrowableCol(*args, **kwargs):
12435 """
12436 AddGrowableCol(self, size_t idx, int proportion=0)
12437
12438 Specifies that column *idx* (starting from zero) should be grown if
12439 there is extra space available to the sizer.
12440
12441 The *proportion* parameter has the same meaning as the stretch factor
12442 for the box sizers except that if all proportions are 0, then all
12443 columns are resized equally (instead of not being resized at all).
12444 """
12445 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12446
12447 def RemoveGrowableCol(*args, **kwargs):
12448 """
12449 RemoveGrowableCol(self, size_t idx)
12450
12451 Specifies that column *idx* is no longer growable.
12452 """
12453 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12454
12455 def SetFlexibleDirection(*args, **kwargs):
12456 """
12457 SetFlexibleDirection(self, int direction)
12458
12459 Specifies whether the sizer should flexibly resize its columns, rows,
12460 or both. Argument *direction* can be one of the following values. Any
12461 other value is ignored.
12462
12463 ============== =======================================
12464 wx.VERTICAL Rows are flexibly sized.
12465 wx.HORIZONTAL Columns are flexibly sized.
12466 wx.BOTH Both rows and columns are flexibly sized
12467 (this is the default value).
12468 ============== =======================================
12469
12470 Note that this method does not trigger relayout.
12471
12472 """
12473 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12474
12475 def GetFlexibleDirection(*args, **kwargs):
12476 """
12477 GetFlexibleDirection(self) -> int
12478
12479 Returns a value that specifies whether the sizer
12480 flexibly resizes its columns, rows, or both (default).
12481
12482 :see: `SetFlexibleDirection`
12483 """
12484 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12485
12486 def SetNonFlexibleGrowMode(*args, **kwargs):
12487 """
12488 SetNonFlexibleGrowMode(self, int mode)
12489
12490 Specifies how the sizer should grow in the non-flexible direction if
12491 there is one (so `SetFlexibleDirection` must have been called
12492 previously). Argument *mode* can be one of the following values:
12493
12494 ========================== =================================================
12495 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12496 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12497 `AddGrowableCol` and `AddGrowableRow`. In this
12498 case equal sizing applies to minimum sizes of
12499 columns or rows (this is the default value).
12500 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12501 the non flexible direction, whether they are
12502 growable or not in the flexbile direction.
12503 ========================== =================================================
12504
12505 Note that this method does not trigger relayout.
12506 """
12507 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12508
12509 def GetNonFlexibleGrowMode(*args, **kwargs):
12510 """
12511 GetNonFlexibleGrowMode(self) -> int
12512
12513 Returns the value that specifies how the sizer grows in the
12514 non-flexible direction if there is one.
12515
12516 :see: `SetNonFlexibleGrowMode`
12517 """
12518 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12519
12520 def GetRowHeights(*args, **kwargs):
12521 """
12522 GetRowHeights(self) -> list
12523
12524 Returns a list of integers representing the heights of each of the
12525 rows in the sizer.
12526 """
12527 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12528
12529 def GetColWidths(*args, **kwargs):
12530 """
12531 GetColWidths(self) -> list
12532
12533 Returns a list of integers representing the widths of each of the
12534 columns in the sizer.
12535 """
12536 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12537
12538 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12539 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12540 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12541 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
12542 _core_.FlexGridSizer_swigregister(FlexGridSizer)
12543
12544 class StdDialogButtonSizer(BoxSizer):
12545 """
12546 A special sizer that knows how to order and position standard buttons
12547 in order to conform to the current platform's standards. You simply
12548 need to add each `wx.Button` to the sizer, and be sure to create the
12549 buttons using the standard ID's. Then call `Realize` and the sizer
12550 will take care of the rest.
12551
12552 """
12553 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12554 __repr__ = _swig_repr
12555 def __init__(self, *args, **kwargs):
12556 """__init__(self) -> StdDialogButtonSizer"""
12557 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
12558 def AddButton(*args, **kwargs):
12559 """
12560 AddButton(self, wxButton button)
12561
12562 Use this to add the buttons to this sizer. Do not use the `Add`
12563 method in the base class.
12564 """
12565 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12566
12567 def Realize(*args, **kwargs):
12568 """
12569 Realize(self)
12570
12571 This funciton needs to be called after all the buttons have been added
12572 to the sizer. It will reorder them and position them in a platform
12573 specifc manner.
12574 """
12575 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
12576
12577 def SetAffirmativeButton(*args, **kwargs):
12578 """SetAffirmativeButton(self, wxButton button)"""
12579 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12580
12581 def SetNegativeButton(*args, **kwargs):
12582 """SetNegativeButton(self, wxButton button)"""
12583 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12584
12585 def SetCancelButton(*args, **kwargs):
12586 """SetCancelButton(self, wxButton button)"""
12587 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
12588
12589 def GetAffirmativeButton(*args, **kwargs):
12590 """GetAffirmativeButton(self) -> wxButton"""
12591 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12592
12593 def GetApplyButton(*args, **kwargs):
12594 """GetApplyButton(self) -> wxButton"""
12595 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12596
12597 def GetNegativeButton(*args, **kwargs):
12598 """GetNegativeButton(self) -> wxButton"""
12599 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12600
12601 def GetCancelButton(*args, **kwargs):
12602 """GetCancelButton(self) -> wxButton"""
12603 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12604
12605 def GetHelpButton(*args, **kwargs):
12606 """GetHelpButton(self) -> wxButton"""
12607 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12608
12609 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12610 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12611 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12612 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12613 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
12614 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
12615
12616 #---------------------------------------------------------------------------
12617
12618 class GBPosition(object):
12619 """
12620 This class represents the position of an item in a virtual grid of
12621 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12622 typemaps that will automatically convert from a 2-element sequence of
12623 integers to a wx.GBPosition, so you can use the more pythonic
12624 representation of the position nearly transparently in Python code.
12625 """
12626 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12627 __repr__ = _swig_repr
12628 def __init__(self, *args, **kwargs):
12629 """
12630 __init__(self, int row=0, int col=0) -> GBPosition
12631
12632 This class represents the position of an item in a virtual grid of
12633 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12634 typemaps that will automatically convert from a 2-element sequence of
12635 integers to a wx.GBPosition, so you can use the more pythonic
12636 representation of the position nearly transparently in Python code.
12637 """
12638 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12639 __swig_destroy__ = _core_.delete_GBPosition
12640 __del__ = lambda self : None;
12641 def GetRow(*args, **kwargs):
12642 """GetRow(self) -> int"""
12643 return _core_.GBPosition_GetRow(*args, **kwargs)
12644
12645 def GetCol(*args, **kwargs):
12646 """GetCol(self) -> int"""
12647 return _core_.GBPosition_GetCol(*args, **kwargs)
12648
12649 def SetRow(*args, **kwargs):
12650 """SetRow(self, int row)"""
12651 return _core_.GBPosition_SetRow(*args, **kwargs)
12652
12653 def SetCol(*args, **kwargs):
12654 """SetCol(self, int col)"""
12655 return _core_.GBPosition_SetCol(*args, **kwargs)
12656
12657 def __eq__(*args, **kwargs):
12658 """
12659 __eq__(self, PyObject other) -> bool
12660
12661 Compare GBPosition for equality.
12662 """
12663 return _core_.GBPosition___eq__(*args, **kwargs)
12664
12665 def __ne__(*args, **kwargs):
12666 """
12667 __ne__(self, PyObject other) -> bool
12668
12669 Compare GBPosition for inequality.
12670 """
12671 return _core_.GBPosition___ne__(*args, **kwargs)
12672
12673 def Set(*args, **kwargs):
12674 """Set(self, int row=0, int col=0)"""
12675 return _core_.GBPosition_Set(*args, **kwargs)
12676
12677 def Get(*args, **kwargs):
12678 """Get(self) -> PyObject"""
12679 return _core_.GBPosition_Get(*args, **kwargs)
12680
12681 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12682 def __str__(self): return str(self.Get())
12683 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12684 def __len__(self): return len(self.Get())
12685 def __getitem__(self, index): return self.Get()[index]
12686 def __setitem__(self, index, val):
12687 if index == 0: self.SetRow(val)
12688 elif index == 1: self.SetCol(val)
12689 else: raise IndexError
12690 def __nonzero__(self): return self.Get() != (0,0)
12691 __safe_for_unpickling__ = True
12692 def __reduce__(self): return (wx.GBPosition, self.Get())
12693
12694 row = property(GetRow, SetRow)
12695 col = property(GetCol, SetCol)
12696
12697 _core_.GBPosition_swigregister(GBPosition)
12698
12699 class GBSpan(object):
12700 """
12701 This class is used to hold the row and column spanning attributes of
12702 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12703 automatically convert from a 2-element sequence of integers to a
12704 wx.GBSpan, so you can use the more pythonic representation of the span
12705 nearly transparently in Python code.
12706
12707 """
12708 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12709 __repr__ = _swig_repr
12710 def __init__(self, *args, **kwargs):
12711 """
12712 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12713
12714 Construct a new wxGBSpan, optionally setting the rowspan and
12715 colspan. The default is (1,1). (Meaning that the item occupies one
12716 cell in each direction.
12717 """
12718 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12719 __swig_destroy__ = _core_.delete_GBSpan
12720 __del__ = lambda self : None;
12721 def GetRowspan(*args, **kwargs):
12722 """GetRowspan(self) -> int"""
12723 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12724
12725 def GetColspan(*args, **kwargs):
12726 """GetColspan(self) -> int"""
12727 return _core_.GBSpan_GetColspan(*args, **kwargs)
12728
12729 def SetRowspan(*args, **kwargs):
12730 """SetRowspan(self, int rowspan)"""
12731 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12732
12733 def SetColspan(*args, **kwargs):
12734 """SetColspan(self, int colspan)"""
12735 return _core_.GBSpan_SetColspan(*args, **kwargs)
12736
12737 def __eq__(*args, **kwargs):
12738 """
12739 __eq__(self, PyObject other) -> bool
12740
12741 Compare wxGBSpan for equality.
12742 """
12743 return _core_.GBSpan___eq__(*args, **kwargs)
12744
12745 def __ne__(*args, **kwargs):
12746 """
12747 __ne__(self, PyObject other) -> bool
12748
12749 Compare GBSpan for inequality.
12750 """
12751 return _core_.GBSpan___ne__(*args, **kwargs)
12752
12753 def Set(*args, **kwargs):
12754 """Set(self, int rowspan=1, int colspan=1)"""
12755 return _core_.GBSpan_Set(*args, **kwargs)
12756
12757 def Get(*args, **kwargs):
12758 """Get(self) -> PyObject"""
12759 return _core_.GBSpan_Get(*args, **kwargs)
12760
12761 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12762 def __str__(self): return str(self.Get())
12763 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12764 def __len__(self): return len(self.Get())
12765 def __getitem__(self, index): return self.Get()[index]
12766 def __setitem__(self, index, val):
12767 if index == 0: self.SetRowspan(val)
12768 elif index == 1: self.SetColspan(val)
12769 else: raise IndexError
12770 def __nonzero__(self): return self.Get() != (0,0)
12771 __safe_for_unpickling__ = True
12772 def __reduce__(self): return (wx.GBSpan, self.Get())
12773
12774 rowspan = property(GetRowspan, SetRowspan)
12775 colspan = property(GetColspan, SetColspan)
12776
12777 _core_.GBSpan_swigregister(GBSpan)
12778
12779 class GBSizerItem(SizerItem):
12780 """
12781 The wx.GBSizerItem class is used to track the additional data about
12782 items in a `wx.GridBagSizer` such as the item's position in the grid
12783 and how many rows or columns it spans.
12784
12785 """
12786 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12787 __repr__ = _swig_repr
12788 def __init__(self, *args, **kwargs):
12789 """
12790 __init__(self) -> GBSizerItem
12791
12792 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12793 size will need to be set, as well as a position and span before this
12794 item can be used in a Sizer.
12795
12796 You will probably never need to create a wx.GBSizerItem directly as they
12797 are created automatically when the sizer's Add method is called.
12798 """
12799 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12800 __swig_destroy__ = _core_.delete_GBSizerItem
12801 __del__ = lambda self : None;
12802 def GetPos(*args, **kwargs):
12803 """
12804 GetPos(self) -> GBPosition
12805
12806 Get the grid position of the item
12807 """
12808 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12809
12810 def GetPosTuple(self): return self.GetPos().Get()
12811 def GetSpan(*args, **kwargs):
12812 """
12813 GetSpan(self) -> GBSpan
12814
12815 Get the row and column spanning of the item
12816 """
12817 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12818
12819 def GetSpanTuple(self): return self.GetSpan().Get()
12820 def SetPos(*args, **kwargs):
12821 """
12822 SetPos(self, GBPosition pos) -> bool
12823
12824 If the item is already a member of a sizer then first ensure that
12825 there is no other item that would intersect with this one at the new
12826 position, then set the new position. Returns True if the change is
12827 successful and after the next Layout() the item will be moved.
12828 """
12829 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12830
12831 def SetSpan(*args, **kwargs):
12832 """
12833 SetSpan(self, GBSpan span) -> bool
12834
12835 If the item is already a member of a sizer then first ensure that
12836 there is no other item that would intersect with this one with its new
12837 spanning size, then set the new spanning. Returns True if the change
12838 is successful and after the next Layout() the item will be resized.
12839
12840 """
12841 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12842
12843 def Intersects(*args, **kwargs):
12844 """
12845 Intersects(self, GBSizerItem other) -> bool
12846
12847 Returns True if this item and the other item instersect.
12848 """
12849 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12850
12851 def IntersectsPos(*args, **kwargs):
12852 """
12853 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12854
12855 Returns True if the given pos/span would intersect with this item.
12856 """
12857 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
12858
12859 def GetEndPos(*args, **kwargs):
12860 """
12861 GetEndPos(self) -> GBPosition
12862
12863 Get the row and column of the endpoint of this item.
12864 """
12865 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12866
12867 def GetGBSizer(*args, **kwargs):
12868 """
12869 GetGBSizer(self) -> GridBagSizer
12870
12871 Get the sizer this item is a member of.
12872 """
12873 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12874
12875 def SetGBSizer(*args, **kwargs):
12876 """
12877 SetGBSizer(self, GridBagSizer sizer)
12878
12879 Set the sizer this item is a member of.
12880 """
12881 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12882
12883 EndPos = property(GetEndPos,doc="See `GetEndPos`")
12884 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
12885 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
12886 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
12887 _core_.GBSizerItem_swigregister(GBSizerItem)
12888 DefaultSpan = cvar.DefaultSpan
12889
12890 def GBSizerItemWindow(*args, **kwargs):
12891 """
12892 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12893 int border, PyObject userData=None) -> GBSizerItem
12894
12895 Construct a `wx.GBSizerItem` for a window.
12896 """
12897 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12898 return val
12899
12900 def GBSizerItemSizer(*args, **kwargs):
12901 """
12902 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12903 int border, PyObject userData=None) -> GBSizerItem
12904
12905 Construct a `wx.GBSizerItem` for a sizer
12906 """
12907 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12908 return val
12909
12910 def GBSizerItemSpacer(*args, **kwargs):
12911 """
12912 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12913 int flag, int border, PyObject userData=None) -> GBSizerItem
12914
12915 Construct a `wx.GBSizerItem` for a spacer.
12916 """
12917 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12918 return val
12919
12920 class GridBagSizer(FlexGridSizer):
12921 """
12922 A `wx.Sizer` that can lay out items in a virtual grid like a
12923 `wx.FlexGridSizer` but in this case explicit positioning of the items
12924 is allowed using `wx.GBPosition`, and items can optionally span more
12925 than one row and/or column using `wx.GBSpan`. The total size of the
12926 virtual grid is determined by the largest row and column that items are
12927 positioned at, adjusted for spanning.
12928
12929 """
12930 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12931 __repr__ = _swig_repr
12932 def __init__(self, *args, **kwargs):
12933 """
12934 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12935
12936 Constructor, with optional parameters to specify the gap between the
12937 rows and columns.
12938 """
12939 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
12940 self._setOORInfo(self)
12941
12942 def Add(*args, **kwargs):
12943 """
12944 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12945 int border=0, userData=None) -> wx.GBSizerItem
12946
12947 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12948 more than one row or column as specified with *span*. The remaining
12949 args behave similarly to `wx.Sizer.Add`.
12950
12951 Returns True if the item was successfully placed at the given cell
12952 position, False if something was already there.
12953
12954 """
12955 return _core_.GridBagSizer_Add(*args, **kwargs)
12956
12957 def AddItem(*args, **kwargs):
12958 """
12959 Add(self, GBSizerItem item) -> wx.GBSizerItem
12960
12961 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12962 the item was successfully placed at its given cell position, False if
12963 something was already there.
12964 """
12965 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12966
12967 def GetCellSize(*args, **kwargs):
12968 """
12969 GetCellSize(self, int row, int col) -> Size
12970
12971 Get the size of the specified cell, including hgap and
12972 vgap. Only valid after a Layout.
12973 """
12974 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12975
12976 def GetEmptyCellSize(*args, **kwargs):
12977 """
12978 GetEmptyCellSize(self) -> Size
12979
12980 Get the size used for cells in the grid with no item.
12981 """
12982 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12983
12984 def SetEmptyCellSize(*args, **kwargs):
12985 """
12986 SetEmptyCellSize(self, Size sz)
12987
12988 Set the size used for cells in the grid with no item.
12989 """
12990 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12991
12992 def GetItemPosition(*args):
12993 """
12994 GetItemPosition(self, item) -> GBPosition
12995
12996 Get the grid position of the specified *item* where *item* is either a
12997 window or subsizer that is a member of this sizer, or a zero-based
12998 index of an item.
12999 """
13000 return _core_.GridBagSizer_GetItemPosition(*args)
13001
13002 def SetItemPosition(*args):
13003 """
13004 SetItemPosition(self, item, GBPosition pos) -> bool
13005
13006 Set the grid position of the specified *item* where *item* is either a
13007 window or subsizer that is a member of this sizer, or a zero-based
13008 index of an item. Returns True on success. If the move is not
13009 allowed (because an item is already there) then False is returned.
13010
13011 """
13012 return _core_.GridBagSizer_SetItemPosition(*args)
13013
13014 def GetItemSpan(*args):
13015 """
13016 GetItemSpan(self, item) -> GBSpan
13017
13018 Get the row/col spanning of the specified *item* where *item* is
13019 either a window or subsizer that is a member of this sizer, or a
13020 zero-based index of an item.
13021 """
13022 return _core_.GridBagSizer_GetItemSpan(*args)
13023
13024 def SetItemSpan(*args):
13025 """
13026 SetItemSpan(self, item, GBSpan span) -> bool
13027
13028 Set the row/col spanning of the specified *item* where *item* is
13029 either a window or subsizer that is a member of this sizer, or a
13030 zero-based index of an item. Returns True on success. If the move is
13031 not allowed (because an item is already there) then False is returned.
13032 """
13033 return _core_.GridBagSizer_SetItemSpan(*args)
13034
13035 def FindItem(*args):
13036 """
13037 FindItem(self, item) -> GBSizerItem
13038
13039 Find the sizer item for the given window or subsizer, returns None if
13040 not found. (non-recursive)
13041 """
13042 return _core_.GridBagSizer_FindItem(*args)
13043
13044 def FindItemAtPosition(*args, **kwargs):
13045 """
13046 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13047
13048 Return the sizer item for the given grid cell, or None if there is no
13049 item at that position. (non-recursive)
13050 """
13051 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13052
13053 def FindItemAtPoint(*args, **kwargs):
13054 """
13055 FindItemAtPoint(self, Point pt) -> GBSizerItem
13056
13057 Return the sizer item located at the point given in *pt*, or None if
13058 there is no item at that point. The (x,y) coordinates in pt correspond
13059 to the client coordinates of the window using the sizer for
13060 layout. (non-recursive)
13061 """
13062 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13063
13064 def CheckForIntersection(*args, **kwargs):
13065 """
13066 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13067
13068 Look at all items and see if any intersect (or would overlap) the
13069 given *item*. Returns True if so, False if there would be no overlap.
13070 If an *excludeItem* is given then it will not be checked for
13071 intersection, for example it may be the item we are checking the
13072 position of.
13073
13074 """
13075 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
13076
13077 def CheckForIntersectionPos(*args, **kwargs):
13078 """
13079 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13080
13081 Look at all items and see if any intersect (or would overlap) the
13082 given position and span. Returns True if so, False if there would be
13083 no overlap. If an *excludeItem* is given then it will not be checked
13084 for intersection, for example it may be the item we are checking the
13085 position of.
13086 """
13087 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13088
13089 _core_.GridBagSizer_swigregister(GridBagSizer)
13090
13091 #---------------------------------------------------------------------------
13092
13093 Left = _core_.Left
13094 Top = _core_.Top
13095 Right = _core_.Right
13096 Bottom = _core_.Bottom
13097 Width = _core_.Width
13098 Height = _core_.Height
13099 Centre = _core_.Centre
13100 Center = _core_.Center
13101 CentreX = _core_.CentreX
13102 CentreY = _core_.CentreY
13103 Unconstrained = _core_.Unconstrained
13104 AsIs = _core_.AsIs
13105 PercentOf = _core_.PercentOf
13106 Above = _core_.Above
13107 Below = _core_.Below
13108 LeftOf = _core_.LeftOf
13109 RightOf = _core_.RightOf
13110 SameAs = _core_.SameAs
13111 Absolute = _core_.Absolute
13112 class IndividualLayoutConstraint(Object):
13113 """
13114 Objects of this class are stored in the `wx.LayoutConstraints` class as
13115 one of eight possible constraints that a window can be involved in.
13116 You will never need to create an instance of
13117 wx.IndividualLayoutConstraint, rather you should create a
13118 `wx.LayoutConstraints` instance and use the individual contstraints
13119 that it contains.
13120 """
13121 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13122 def __init__(self): raise AttributeError, "No constructor defined"
13123 __repr__ = _swig_repr
13124 def Set(*args, **kwargs):
13125 """
13126 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13127
13128 Sets the properties of the constraint. Normally called by one of the
13129 convenience functions such as Above, RightOf, SameAs.
13130 """
13131 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13132
13133 def LeftOf(*args, **kwargs):
13134 """
13135 LeftOf(self, Window sibling, int marg=0)
13136
13137 Constrains this edge to be to the left of the given window, with an
13138 optional margin. Implicitly, this is relative to the left edge of the
13139 other window.
13140 """
13141 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13142
13143 def RightOf(*args, **kwargs):
13144 """
13145 RightOf(self, Window sibling, int marg=0)
13146
13147 Constrains this edge to be to the right of the given window, with an
13148 optional margin. Implicitly, this is relative to the right edge of the
13149 other window.
13150 """
13151 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13152
13153 def Above(*args, **kwargs):
13154 """
13155 Above(self, Window sibling, int marg=0)
13156
13157 Constrains this edge to be above the given window, with an optional
13158 margin. Implicitly, this is relative to the top edge of the other
13159 window.
13160 """
13161 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13162
13163 def Below(*args, **kwargs):
13164 """
13165 Below(self, Window sibling, int marg=0)
13166
13167 Constrains this edge to be below the given window, with an optional
13168 margin. Implicitly, this is relative to the bottom edge of the other
13169 window.
13170 """
13171 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13172
13173 def SameAs(*args, **kwargs):
13174 """
13175 SameAs(self, Window otherW, int edge, int marg=0)
13176
13177 Constrains this edge or dimension to be to the same as the edge of the
13178 given window, with an optional margin.
13179 """
13180 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13181
13182 def PercentOf(*args, **kwargs):
13183 """
13184 PercentOf(self, Window otherW, int wh, int per)
13185
13186 Constrains this edge or dimension to be to a percentage of the given
13187 window, with an optional margin.
13188 """
13189 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13190
13191 def Absolute(*args, **kwargs):
13192 """
13193 Absolute(self, int val)
13194
13195 Constrains this edge or dimension to be the given absolute value.
13196 """
13197 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13198
13199 def Unconstrained(*args, **kwargs):
13200 """
13201 Unconstrained(self)
13202
13203 Sets this edge or dimension to be unconstrained, that is, dependent on
13204 other edges and dimensions from which this value can be deduced.
13205 """
13206 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13207
13208 def AsIs(*args, **kwargs):
13209 """
13210 AsIs(self)
13211
13212 Sets this edge or constraint to be whatever the window's value is at
13213 the moment. If either of the width and height constraints are *as is*,
13214 the window will not be resized, but moved instead. This is important
13215 when considering panel items which are intended to have a default
13216 size, such as a button, which may take its size from the size of the
13217 button label.
13218 """
13219 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13220
13221 def GetOtherWindow(*args, **kwargs):
13222 """GetOtherWindow(self) -> Window"""
13223 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13224
13225 def GetMyEdge(*args, **kwargs):
13226 """GetMyEdge(self) -> int"""
13227 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13228
13229 def SetEdge(*args, **kwargs):
13230 """SetEdge(self, int which)"""
13231 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13232
13233 def SetValue(*args, **kwargs):
13234 """SetValue(self, int v)"""
13235 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13236
13237 def GetMargin(*args, **kwargs):
13238 """GetMargin(self) -> int"""
13239 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13240
13241 def SetMargin(*args, **kwargs):
13242 """SetMargin(self, int m)"""
13243 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13244
13245 def GetValue(*args, **kwargs):
13246 """GetValue(self) -> int"""
13247 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13248
13249 def GetPercent(*args, **kwargs):
13250 """GetPercent(self) -> int"""
13251 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13252
13253 def GetOtherEdge(*args, **kwargs):
13254 """GetOtherEdge(self) -> int"""
13255 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13256
13257 def GetDone(*args, **kwargs):
13258 """GetDone(self) -> bool"""
13259 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13260
13261 def SetDone(*args, **kwargs):
13262 """SetDone(self, bool d)"""
13263 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13264
13265 def GetRelationship(*args, **kwargs):
13266 """GetRelationship(self) -> int"""
13267 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13268
13269 def SetRelationship(*args, **kwargs):
13270 """SetRelationship(self, int r)"""
13271 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13272
13273 def ResetIfWin(*args, **kwargs):
13274 """
13275 ResetIfWin(self, Window otherW) -> bool
13276
13277 Reset constraint if it mentions otherWin
13278 """
13279 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13280
13281 def SatisfyConstraint(*args, **kwargs):
13282 """
13283 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13284
13285 Try to satisfy constraint
13286 """
13287 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13288
13289 def GetEdge(*args, **kwargs):
13290 """
13291 GetEdge(self, int which, Window thisWin, Window other) -> int
13292
13293 Get the value of this edge or dimension, or if this
13294 is not determinable, -1.
13295 """
13296 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13297
13298 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13299 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13300 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13301 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13302 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13303 Percent = property(GetPercent,doc="See `GetPercent`")
13304 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13305 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
13306 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
13307
13308 class LayoutConstraints(Object):
13309 """
13310 **Note:** constraints are now deprecated and you should use sizers
13311 instead.
13312
13313 Objects of this class can be associated with a window to define its
13314 layout constraints, with respect to siblings or its parent.
13315
13316 The class consists of the following eight constraints of class
13317 wx.IndividualLayoutConstraint, some or all of which should be accessed
13318 directly to set the appropriate constraints.
13319
13320 * left: represents the left hand edge of the window
13321 * right: represents the right hand edge of the window
13322 * top: represents the top edge of the window
13323 * bottom: represents the bottom edge of the window
13324 * width: represents the width of the window
13325 * height: represents the height of the window
13326 * centreX: represents the horizontal centre point of the window
13327 * centreY: represents the vertical centre point of the window
13328
13329 Most constraints are initially set to have the relationship
13330 wxUnconstrained, which means that their values should be calculated by
13331 looking at known constraints. The exceptions are width and height,
13332 which are set to wxAsIs to ensure that if the user does not specify a
13333 constraint, the existing width and height will be used, to be
13334 compatible with panel items which often have take a default size. If
13335 the constraint is ``wx.AsIs``, the dimension will not be changed.
13336
13337 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13338
13339 """
13340 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13341 __repr__ = _swig_repr
13342 left = property(_core_.LayoutConstraints_left_get)
13343 top = property(_core_.LayoutConstraints_top_get)
13344 right = property(_core_.LayoutConstraints_right_get)
13345 bottom = property(_core_.LayoutConstraints_bottom_get)
13346 width = property(_core_.LayoutConstraints_width_get)
13347 height = property(_core_.LayoutConstraints_height_get)
13348 centreX = property(_core_.LayoutConstraints_centreX_get)
13349 centreY = property(_core_.LayoutConstraints_centreY_get)
13350 def __init__(self, *args, **kwargs):
13351 """__init__(self) -> LayoutConstraints"""
13352 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13353 __swig_destroy__ = _core_.delete_LayoutConstraints
13354 __del__ = lambda self : None;
13355 def SatisfyConstraints(*args, **kwargs):
13356 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13357 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13358
13359 def AreSatisfied(*args, **kwargs):
13360 """AreSatisfied(self) -> bool"""
13361 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13362
13363 _core_.LayoutConstraints_swigregister(LayoutConstraints)
13364
13365 #----------------------------------------------------------------------------
13366
13367 # Use Python's bool constants if available, make some if not
13368 try:
13369 True
13370 except NameError:
13371 __builtins__.True = 1==1
13372 __builtins__.False = 1==0
13373 def bool(value): return not not value
13374 __builtins__.bool = bool
13375
13376
13377
13378 # workarounds for bad wxRTTI names
13379 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13380 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13381 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13382
13383
13384 #----------------------------------------------------------------------------
13385 # Load version numbers from __version__... Ensure that major and minor
13386 # versions are the same for both wxPython and wxWidgets.
13387
13388 from __version__ import *
13389 __version__ = VERSION_STRING
13390
13391 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13392 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
13393 if RELEASE_VERSION != _core_.RELEASE_VERSION:
13394 import warnings
13395 warnings.warn("wxPython/wxWidgets release number mismatch")
13396
13397 #----------------------------------------------------------------------------
13398
13399 # Set wxPython's default string<-->unicode conversion encoding from
13400 # the locale, but only if Python's default hasn't been changed. (We
13401 # assume that if the user has customized it already then that is the
13402 # encoding we need to use as well.)
13403 #
13404 # The encoding selected here is used when string or unicode objects
13405 # need to be converted in order to pass them to wxWidgets. Please be
13406 # aware that the default encoding within the same locale may be
13407 # slightly different on different platforms. For example, please see
13408 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13409 # between the common latin/roman encodings.
13410
13411 default = _sys.getdefaultencoding()
13412 if default == 'ascii':
13413 import locale
13414 import codecs
13415 try:
13416 default = locale.getdefaultlocale()[1]
13417 codecs.lookup(default)
13418 except (ValueError, LookupError, TypeError):
13419 default = _sys.getdefaultencoding()
13420 del locale
13421 del codecs
13422 if default:
13423 wx.SetDefaultPyEncoding(default)
13424 del default
13425
13426 #----------------------------------------------------------------------------
13427
13428 class PyDeadObjectError(AttributeError):
13429 pass
13430
13431 class _wxPyDeadObject(object):
13432 """
13433 Instances of wx objects that are OOR capable will have their __class__
13434 changed to this class when the C++ object is deleted. This should help
13435 prevent crashes due to referencing a bogus C++ pointer.
13436 """
13437 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13438 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13439
13440 def __repr__(self):
13441 if not hasattr(self, "_name"):
13442 self._name = "[unknown]"
13443 return self.reprStr % self._name
13444
13445 def __getattr__(self, *args):
13446 if not hasattr(self, "_name"):
13447 self._name = "[unknown]"
13448 raise PyDeadObjectError(self.attrStr % self._name)
13449
13450 def __nonzero__(self):
13451 return 0
13452
13453
13454
13455 class PyUnbornObjectError(AttributeError):
13456 pass
13457
13458 class _wxPyUnbornObject(object):
13459 """
13460 Some stock objects are created when the wx._core module is
13461 imported, but their C++ instance is not created until the wx.App
13462 object is created and initialized. These object instances will
13463 temporarily have their __class__ changed to this class so an
13464 exception will be raised if they are used before the C++ instance
13465 is ready.
13466 """
13467
13468 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13469 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13470
13471 def __repr__(self):
13472 #if not hasattr(self, "_name"):
13473 # self._name = "[unknown]"
13474 return self.reprStr #% self._name
13475
13476 def __getattr__(self, *args):
13477 #if not hasattr(self, "_name"):
13478 # self._name = "[unknown]"
13479 raise PyUnbornObjectError(self.attrStr) # % self._name )
13480
13481 def __nonzero__(self):
13482 return 0
13483
13484
13485 #----------------------------------------------------------------------------
13486
13487 def CallAfter(callable, *args, **kw):
13488 """
13489 Call the specified function after the current and pending event
13490 handlers have been completed. This is also good for making GUI
13491 method calls from non-GUI threads. Any extra positional or
13492 keyword args are passed on to the callable when it is called.
13493
13494 :see: `wx.CallLater`
13495 """
13496 app = wx.GetApp()
13497 assert app is not None, 'No wx.App created yet'
13498
13499 if not hasattr(app, "_CallAfterId"):
13500 app._CallAfterId = wx.NewEventType()
13501 app.Connect(-1, -1, app._CallAfterId,
13502 lambda event: event.callable(*event.args, **event.kw) )
13503 evt = wx.PyEvent()
13504 evt.SetEventType(app._CallAfterId)
13505 evt.callable = callable
13506 evt.args = args
13507 evt.kw = kw
13508 wx.PostEvent(app, evt)
13509
13510 #----------------------------------------------------------------------------
13511
13512
13513 class CallLater:
13514 """
13515 A convenience class for `wx.Timer`, that calls the given callable
13516 object once after the given amount of milliseconds, passing any
13517 positional or keyword args. The return value of the callable is
13518 availbale after it has been run with the `GetResult` method.
13519
13520 If you don't need to get the return value or restart the timer
13521 then there is no need to hold a reference to this object. It will
13522 hold a reference to itself while the timer is running (the timer
13523 has a reference to self.Notify) but the cycle will be broken when
13524 the timer completes, automatically cleaning up the wx.CallLater
13525 object.
13526
13527 :see: `wx.CallAfter`
13528 """
13529 def __init__(self, millis, callable, *args, **kwargs):
13530 self.millis = millis
13531 self.callable = callable
13532 self.SetArgs(*args, **kwargs)
13533 self.runCount = 0
13534 self.running = False
13535 self.hasRun = False
13536 self.result = None
13537 self.timer = None
13538 self.Start()
13539
13540 def __del__(self):
13541 self.Stop()
13542
13543
13544 def Start(self, millis=None, *args, **kwargs):
13545 """
13546 (Re)start the timer
13547 """
13548 self.hasRun = False
13549 if millis is not None:
13550 self.millis = millis
13551 if args or kwargs:
13552 self.SetArgs(*args, **kwargs)
13553 self.Stop()
13554 self.timer = wx.PyTimer(self.Notify)
13555 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13556 self.running = True
13557 Restart = Start
13558
13559
13560 def Stop(self):
13561 """
13562 Stop and destroy the timer.
13563 """
13564 if self.timer is not None:
13565 self.timer.Stop()
13566 self.timer = None
13567
13568
13569 def GetInterval(self):
13570 if self.timer is not None:
13571 return self.timer.GetInterval()
13572 else:
13573 return 0
13574
13575
13576 def IsRunning(self):
13577 return self.timer is not None and self.timer.IsRunning()
13578
13579
13580 def SetArgs(self, *args, **kwargs):
13581 """
13582 (Re)set the args passed to the callable object. This is
13583 useful in conjunction with Restart if you want to schedule a
13584 new call to the same callable object but with different
13585 parameters.
13586 """
13587 self.args = args
13588 self.kwargs = kwargs
13589
13590
13591 def HasRun(self):
13592 return self.hasRun
13593
13594 def GetResult(self):
13595 return self.result
13596
13597 def Notify(self):
13598 """
13599 The timer has expired so call the callable.
13600 """
13601 if self.callable and getattr(self.callable, 'im_self', True):
13602 self.runCount += 1
13603 self.running = False
13604 self.result = self.callable(*self.args, **self.kwargs)
13605 self.hasRun = True
13606 if not self.running:
13607 # if it wasn't restarted, then cleanup
13608 wx.CallAfter(self.Stop)
13609
13610 Interval = property(GetInterval)
13611 Result = property(GetResult)
13612
13613
13614 class FutureCall(CallLater):
13615 """A compatibility alias for `CallLater`."""
13616
13617 #----------------------------------------------------------------------------
13618 # Control which items in this module should be documented by epydoc.
13619 # We allow only classes and functions, which will help reduce the size
13620 # of the docs by filtering out the zillions of constants, EVT objects,
13621 # and etc that don't make much sense by themselves, but are instead
13622 # documented (or will be) as part of the classes/functions/methods
13623 # where they should be used.
13624
13625 class __DocFilter:
13626 """
13627 A filter for epydoc that only allows non-Ptr classes and
13628 functions, in order to reduce the clutter in the API docs.
13629 """
13630 def __init__(self, globals):
13631 self._globals = globals
13632
13633 def __call__(self, name):
13634 import types
13635 obj = self._globals.get(name, None)
13636
13637 # only document classes and function
13638 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13639 return False
13640
13641 # skip other things that are private or will be documented as part of somethign else
13642 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
13643 return False
13644
13645 # skip functions that are duplicates of static functions in a class
13646 if name.find('_') != -1:
13647 cls = self._globals.get(name.split('_')[0], None)
13648 methname = name.split('_')[1]
13649 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13650 return False
13651
13652 return True
13653
13654 #----------------------------------------------------------------------------
13655 #----------------------------------------------------------------------------
13656
13657 # Import other modules in this package that should show up in the
13658 # "core" wx namespace
13659 from _gdi import *
13660 from _windows import *
13661 from _controls import *
13662 from _misc import *
13663
13664 #----------------------------------------------------------------------------
13665 #----------------------------------------------------------------------------
13666
13667
13668