]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/mac/_core.py
added more properties
[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 val = _core_.Object_Destroy(*args, **kwargs)
709 args[0].thisown = 0
710 return val
711
712 ClassName = property(GetClassName,doc="See `GetClassName`")
713 _core_.Object_swigregister(Object)
714 _wxPySetDictionary = _core_._wxPySetDictionary
715 cvar = _core_.cvar
716 EmptyString = cvar.EmptyString
717
718 #---------------------------------------------------------------------------
719
720 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
721 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
722 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
723 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
724 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
725 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
726 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
727 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
728 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
729 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
730 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
731 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
732 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
733 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
734 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
735 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
736 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
737 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
738 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
739 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
740 CURSOR_NONE = _core_.CURSOR_NONE
741 CURSOR_ARROW = _core_.CURSOR_ARROW
742 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
743 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
744 CURSOR_CHAR = _core_.CURSOR_CHAR
745 CURSOR_CROSS = _core_.CURSOR_CROSS
746 CURSOR_HAND = _core_.CURSOR_HAND
747 CURSOR_IBEAM = _core_.CURSOR_IBEAM
748 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
749 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
750 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
751 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
752 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
753 CURSOR_PENCIL = _core_.CURSOR_PENCIL
754 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
755 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
756 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
757 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
758 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
759 CURSOR_SIZENS = _core_.CURSOR_SIZENS
760 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
761 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
762 CURSOR_SIZING = _core_.CURSOR_SIZING
763 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
764 CURSOR_WAIT = _core_.CURSOR_WAIT
765 CURSOR_WATCH = _core_.CURSOR_WATCH
766 CURSOR_BLANK = _core_.CURSOR_BLANK
767 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
768 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
769 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
770 CURSOR_MAX = _core_.CURSOR_MAX
771 #---------------------------------------------------------------------------
772
773 class Size(object):
774 """
775 wx.Size is a useful data structure used to represent the size of
776 something. It simply contains integer width and height
777 properties. In most places in wxPython where a wx.Size is
778 expected a (width, height) tuple can be used instead.
779 """
780 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
781 __repr__ = _swig_repr
782 width = property(_core_.Size_width_get, _core_.Size_width_set)
783 height = property(_core_.Size_height_get, _core_.Size_height_set)
784 x = width; y = height
785 def __init__(self, *args, **kwargs):
786 """
787 __init__(self, int w=0, int h=0) -> Size
788
789 Creates a size object.
790 """
791 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
792 __swig_destroy__ = _core_.delete_Size
793 __del__ = lambda self : None;
794 def __eq__(*args, **kwargs):
795 """
796 __eq__(self, PyObject other) -> bool
797
798 Test for equality of wx.Size objects.
799 """
800 return _core_.Size___eq__(*args, **kwargs)
801
802 def __ne__(*args, **kwargs):
803 """
804 __ne__(self, PyObject other) -> bool
805
806 Test for inequality of wx.Size objects.
807 """
808 return _core_.Size___ne__(*args, **kwargs)
809
810 def __add__(*args, **kwargs):
811 """
812 __add__(self, Size sz) -> Size
813
814 Add sz's proprties to this and return the result.
815 """
816 return _core_.Size___add__(*args, **kwargs)
817
818 def __sub__(*args, **kwargs):
819 """
820 __sub__(self, Size sz) -> Size
821
822 Subtract sz's properties from this and return the result.
823 """
824 return _core_.Size___sub__(*args, **kwargs)
825
826 def IncTo(*args, **kwargs):
827 """
828 IncTo(self, Size sz)
829
830 Increments this object so that both of its dimensions are not less
831 than the corresponding dimensions of the size.
832 """
833 return _core_.Size_IncTo(*args, **kwargs)
834
835 def DecTo(*args, **kwargs):
836 """
837 DecTo(self, Size sz)
838
839 Decrements this object so that both of its dimensions are not greater
840 than the corresponding dimensions of the size.
841 """
842 return _core_.Size_DecTo(*args, **kwargs)
843
844 def Scale(*args, **kwargs):
845 """
846 Scale(self, float xscale, float yscale)
847
848 Scales the dimensions of this object by the given factors.
849 """
850 return _core_.Size_Scale(*args, **kwargs)
851
852 def Set(*args, **kwargs):
853 """
854 Set(self, int w, int h)
855
856 Set both width and height.
857 """
858 return _core_.Size_Set(*args, **kwargs)
859
860 def SetWidth(*args, **kwargs):
861 """SetWidth(self, int w)"""
862 return _core_.Size_SetWidth(*args, **kwargs)
863
864 def SetHeight(*args, **kwargs):
865 """SetHeight(self, int h)"""
866 return _core_.Size_SetHeight(*args, **kwargs)
867
868 def GetWidth(*args, **kwargs):
869 """GetWidth(self) -> int"""
870 return _core_.Size_GetWidth(*args, **kwargs)
871
872 def GetHeight(*args, **kwargs):
873 """GetHeight(self) -> int"""
874 return _core_.Size_GetHeight(*args, **kwargs)
875
876 def IsFullySpecified(*args, **kwargs):
877 """
878 IsFullySpecified(self) -> bool
879
880 Returns True if both components of the size are non-default values.
881 """
882 return _core_.Size_IsFullySpecified(*args, **kwargs)
883
884 def SetDefaults(*args, **kwargs):
885 """
886 SetDefaults(self, Size size)
887
888 Combine this size with the other one replacing the default components
889 of this object (i.e. equal to -1) with those of the other.
890 """
891 return _core_.Size_SetDefaults(*args, **kwargs)
892
893 def Get(*args, **kwargs):
894 """
895 Get() -> (width,height)
896
897 Returns the width and height properties as a tuple.
898 """
899 return _core_.Size_Get(*args, **kwargs)
900
901 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
902 def __str__(self): return str(self.Get())
903 def __repr__(self): return 'wx.Size'+str(self.Get())
904 def __len__(self): return len(self.Get())
905 def __getitem__(self, index): return self.Get()[index]
906 def __setitem__(self, index, val):
907 if index == 0: self.width = val
908 elif index == 1: self.height = val
909 else: raise IndexError
910 def __nonzero__(self): return self.Get() != (0,0)
911 __safe_for_unpickling__ = True
912 def __reduce__(self): return (wx.Size, self.Get())
913
914 _core_.Size_swigregister(Size)
915
916 #---------------------------------------------------------------------------
917
918 class RealPoint(object):
919 """
920 A data structure for representing a point or position with floating
921 point x and y properties. In wxPython most places that expect a
922 wx.RealPoint can also accept a (x,y) tuple.
923 """
924 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
925 __repr__ = _swig_repr
926 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
927 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
928 def __init__(self, *args, **kwargs):
929 """
930 __init__(self, double x=0.0, double y=0.0) -> RealPoint
931
932 Create a wx.RealPoint object
933 """
934 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
935 __swig_destroy__ = _core_.delete_RealPoint
936 __del__ = lambda self : None;
937 def __eq__(*args, **kwargs):
938 """
939 __eq__(self, PyObject other) -> bool
940
941 Test for equality of wx.RealPoint objects.
942 """
943 return _core_.RealPoint___eq__(*args, **kwargs)
944
945 def __ne__(*args, **kwargs):
946 """
947 __ne__(self, PyObject other) -> bool
948
949 Test for inequality of wx.RealPoint objects.
950 """
951 return _core_.RealPoint___ne__(*args, **kwargs)
952
953 def __add__(*args, **kwargs):
954 """
955 __add__(self, RealPoint pt) -> RealPoint
956
957 Add pt's proprties to this and return the result.
958 """
959 return _core_.RealPoint___add__(*args, **kwargs)
960
961 def __sub__(*args, **kwargs):
962 """
963 __sub__(self, RealPoint pt) -> RealPoint
964
965 Subtract pt's proprties from this and return the result
966 """
967 return _core_.RealPoint___sub__(*args, **kwargs)
968
969 def Set(*args, **kwargs):
970 """
971 Set(self, double x, double y)
972
973 Set both the x and y properties
974 """
975 return _core_.RealPoint_Set(*args, **kwargs)
976
977 def Get(*args, **kwargs):
978 """
979 Get() -> (x,y)
980
981 Return the x and y properties as a tuple.
982 """
983 return _core_.RealPoint_Get(*args, **kwargs)
984
985 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
986 def __str__(self): return str(self.Get())
987 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
988 def __len__(self): return len(self.Get())
989 def __getitem__(self, index): return self.Get()[index]
990 def __setitem__(self, index, val):
991 if index == 0: self.x = val
992 elif index == 1: self.y = val
993 else: raise IndexError
994 def __nonzero__(self): return self.Get() != (0.0, 0.0)
995 __safe_for_unpickling__ = True
996 def __reduce__(self): return (wx.RealPoint, self.Get())
997
998 _core_.RealPoint_swigregister(RealPoint)
999
1000 #---------------------------------------------------------------------------
1001
1002 class Point(object):
1003 """
1004 A data structure for representing a point or position with integer x
1005 and y properties. Most places in wxPython that expect a wx.Point can
1006 also accept a (x,y) tuple.
1007 """
1008 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1009 __repr__ = _swig_repr
1010 x = property(_core_.Point_x_get, _core_.Point_x_set)
1011 y = property(_core_.Point_y_get, _core_.Point_y_set)
1012 def __init__(self, *args, **kwargs):
1013 """
1014 __init__(self, int x=0, int y=0) -> Point
1015
1016 Create a wx.Point object
1017 """
1018 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1019 __swig_destroy__ = _core_.delete_Point
1020 __del__ = lambda self : None;
1021 def __eq__(*args, **kwargs):
1022 """
1023 __eq__(self, PyObject other) -> bool
1024
1025 Test for equality of wx.Point objects.
1026 """
1027 return _core_.Point___eq__(*args, **kwargs)
1028
1029 def __ne__(*args, **kwargs):
1030 """
1031 __ne__(self, PyObject other) -> bool
1032
1033 Test for inequality of wx.Point objects.
1034 """
1035 return _core_.Point___ne__(*args, **kwargs)
1036
1037 def __add__(*args, **kwargs):
1038 """
1039 __add__(self, Point pt) -> Point
1040
1041 Add pt's proprties to this and return the result.
1042 """
1043 return _core_.Point___add__(*args, **kwargs)
1044
1045 def __sub__(*args, **kwargs):
1046 """
1047 __sub__(self, Point pt) -> Point
1048
1049 Subtract pt's proprties from this and return the result
1050 """
1051 return _core_.Point___sub__(*args, **kwargs)
1052
1053 def __iadd__(*args, **kwargs):
1054 """
1055 __iadd__(self, Point pt) -> Point
1056
1057 Add pt to this object.
1058 """
1059 return _core_.Point___iadd__(*args, **kwargs)
1060
1061 def __isub__(*args, **kwargs):
1062 """
1063 __isub__(self, Point pt) -> Point
1064
1065 Subtract pt from this object.
1066 """
1067 return _core_.Point___isub__(*args, **kwargs)
1068
1069 def Set(*args, **kwargs):
1070 """
1071 Set(self, long x, long y)
1072
1073 Set both the x and y properties
1074 """
1075 return _core_.Point_Set(*args, **kwargs)
1076
1077 def Get(*args, **kwargs):
1078 """
1079 Get() -> (x,y)
1080
1081 Return the x and y properties as a tuple.
1082 """
1083 return _core_.Point_Get(*args, **kwargs)
1084
1085 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1086 def __str__(self): return str(self.Get())
1087 def __repr__(self): return 'wx.Point'+str(self.Get())
1088 def __len__(self): return len(self.Get())
1089 def __getitem__(self, index): return self.Get()[index]
1090 def __setitem__(self, index, val):
1091 if index == 0: self.x = val
1092 elif index == 1: self.y = val
1093 else: raise IndexError
1094 def __nonzero__(self): return self.Get() != (0,0)
1095 __safe_for_unpickling__ = True
1096 def __reduce__(self): return (wx.Point, self.Get())
1097
1098 _core_.Point_swigregister(Point)
1099
1100 #---------------------------------------------------------------------------
1101
1102 class Rect(object):
1103 """
1104 A class for representing and manipulating rectangles. It has x, y,
1105 width and height properties. In wxPython most palces that expect a
1106 wx.Rect can also accept a (x,y,width,height) tuple.
1107 """
1108 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1109 __repr__ = _swig_repr
1110 def __init__(self, *args, **kwargs):
1111 """
1112 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1113
1114 Create a new Rect object.
1115 """
1116 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1117 __swig_destroy__ = _core_.delete_Rect
1118 __del__ = lambda self : None;
1119 def GetX(*args, **kwargs):
1120 """GetX(self) -> int"""
1121 return _core_.Rect_GetX(*args, **kwargs)
1122
1123 def SetX(*args, **kwargs):
1124 """SetX(self, int x)"""
1125 return _core_.Rect_SetX(*args, **kwargs)
1126
1127 def GetY(*args, **kwargs):
1128 """GetY(self) -> int"""
1129 return _core_.Rect_GetY(*args, **kwargs)
1130
1131 def SetY(*args, **kwargs):
1132 """SetY(self, int y)"""
1133 return _core_.Rect_SetY(*args, **kwargs)
1134
1135 def GetWidth(*args, **kwargs):
1136 """GetWidth(self) -> int"""
1137 return _core_.Rect_GetWidth(*args, **kwargs)
1138
1139 def SetWidth(*args, **kwargs):
1140 """SetWidth(self, int w)"""
1141 return _core_.Rect_SetWidth(*args, **kwargs)
1142
1143 def GetHeight(*args, **kwargs):
1144 """GetHeight(self) -> int"""
1145 return _core_.Rect_GetHeight(*args, **kwargs)
1146
1147 def SetHeight(*args, **kwargs):
1148 """SetHeight(self, int h)"""
1149 return _core_.Rect_SetHeight(*args, **kwargs)
1150
1151 def GetPosition(*args, **kwargs):
1152 """GetPosition(self) -> Point"""
1153 return _core_.Rect_GetPosition(*args, **kwargs)
1154
1155 def SetPosition(*args, **kwargs):
1156 """SetPosition(self, Point p)"""
1157 return _core_.Rect_SetPosition(*args, **kwargs)
1158
1159 def GetSize(*args, **kwargs):
1160 """GetSize(self) -> Size"""
1161 return _core_.Rect_GetSize(*args, **kwargs)
1162
1163 def SetSize(*args, **kwargs):
1164 """SetSize(self, Size s)"""
1165 return _core_.Rect_SetSize(*args, **kwargs)
1166
1167 def IsEmpty(*args, **kwargs):
1168 """IsEmpty(self) -> bool"""
1169 return _core_.Rect_IsEmpty(*args, **kwargs)
1170
1171 def GetTopLeft(*args, **kwargs):
1172 """GetTopLeft(self) -> Point"""
1173 return _core_.Rect_GetTopLeft(*args, **kwargs)
1174
1175 def SetTopLeft(*args, **kwargs):
1176 """SetTopLeft(self, Point p)"""
1177 return _core_.Rect_SetTopLeft(*args, **kwargs)
1178
1179 def GetBottomRight(*args, **kwargs):
1180 """GetBottomRight(self) -> Point"""
1181 return _core_.Rect_GetBottomRight(*args, **kwargs)
1182
1183 def SetBottomRight(*args, **kwargs):
1184 """SetBottomRight(self, Point p)"""
1185 return _core_.Rect_SetBottomRight(*args, **kwargs)
1186
1187 def GetLeft(*args, **kwargs):
1188 """GetLeft(self) -> int"""
1189 return _core_.Rect_GetLeft(*args, **kwargs)
1190
1191 def GetTop(*args, **kwargs):
1192 """GetTop(self) -> int"""
1193 return _core_.Rect_GetTop(*args, **kwargs)
1194
1195 def GetBottom(*args, **kwargs):
1196 """GetBottom(self) -> int"""
1197 return _core_.Rect_GetBottom(*args, **kwargs)
1198
1199 def GetRight(*args, **kwargs):
1200 """GetRight(self) -> int"""
1201 return _core_.Rect_GetRight(*args, **kwargs)
1202
1203 def SetLeft(*args, **kwargs):
1204 """SetLeft(self, int left)"""
1205 return _core_.Rect_SetLeft(*args, **kwargs)
1206
1207 def SetRight(*args, **kwargs):
1208 """SetRight(self, int right)"""
1209 return _core_.Rect_SetRight(*args, **kwargs)
1210
1211 def SetTop(*args, **kwargs):
1212 """SetTop(self, int top)"""
1213 return _core_.Rect_SetTop(*args, **kwargs)
1214
1215 def SetBottom(*args, **kwargs):
1216 """SetBottom(self, int bottom)"""
1217 return _core_.Rect_SetBottom(*args, **kwargs)
1218
1219 position = property(GetPosition, SetPosition)
1220 size = property(GetSize, SetSize)
1221 left = property(GetLeft, SetLeft)
1222 right = property(GetRight, SetRight)
1223 top = property(GetTop, SetTop)
1224 bottom = property(GetBottom, SetBottom)
1225
1226 def Inflate(*args, **kwargs):
1227 """
1228 Inflate(self, int dx, int dy) -> Rect
1229
1230 Increases the size of the rectangle.
1231
1232 The left border is moved farther left and the right border is moved
1233 farther right by ``dx``. The upper border is moved farther up and the
1234 bottom border is moved farther down by ``dy``. (Note the the width and
1235 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1236 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1237 opposite happens: the rectangle size decreases in the respective
1238 direction.
1239
1240 The change is made to the rectangle inplace, if instead you need a
1241 copy that is inflated, preserving the original then make the copy
1242 first::
1243
1244 copy = wx.Rect(*original)
1245 copy.Inflate(10,15)
1246
1247
1248 """
1249 return _core_.Rect_Inflate(*args, **kwargs)
1250
1251 def Deflate(*args, **kwargs):
1252 """
1253 Deflate(self, int dx, int dy) -> Rect
1254
1255 Decrease the rectangle size. This method is the opposite of `Inflate`
1256 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1257 `Inflate` for a full description.
1258 """
1259 return _core_.Rect_Deflate(*args, **kwargs)
1260
1261 def OffsetXY(*args, **kwargs):
1262 """
1263 OffsetXY(self, int dx, int dy)
1264
1265 Moves the rectangle by the specified offset. If dx is positive, the
1266 rectangle is moved to the right, if dy is positive, it is moved to the
1267 bottom, otherwise it is moved to the left or top respectively.
1268 """
1269 return _core_.Rect_OffsetXY(*args, **kwargs)
1270
1271 def Offset(*args, **kwargs):
1272 """
1273 Offset(self, Point pt)
1274
1275 Same as `OffsetXY` but uses dx,dy from Point
1276 """
1277 return _core_.Rect_Offset(*args, **kwargs)
1278
1279 def Intersect(*args, **kwargs):
1280 """
1281 Intersect(self, Rect rect) -> Rect
1282
1283 Returns the intersectsion of this rectangle and rect.
1284 """
1285 return _core_.Rect_Intersect(*args, **kwargs)
1286
1287 def Union(*args, **kwargs):
1288 """
1289 Union(self, Rect rect) -> Rect
1290
1291 Returns the union of this rectangle and rect.
1292 """
1293 return _core_.Rect_Union(*args, **kwargs)
1294
1295 def __add__(*args, **kwargs):
1296 """
1297 __add__(self, Rect rect) -> Rect
1298
1299 Add the properties of rect to this rectangle and return the result.
1300 """
1301 return _core_.Rect___add__(*args, **kwargs)
1302
1303 def __iadd__(*args, **kwargs):
1304 """
1305 __iadd__(self, Rect rect) -> Rect
1306
1307 Add the properties of rect to this rectangle, updating this rectangle.
1308 """
1309 return _core_.Rect___iadd__(*args, **kwargs)
1310
1311 def __eq__(*args, **kwargs):
1312 """
1313 __eq__(self, PyObject other) -> bool
1314
1315 Test for equality of wx.Rect objects.
1316 """
1317 return _core_.Rect___eq__(*args, **kwargs)
1318
1319 def __ne__(*args, **kwargs):
1320 """
1321 __ne__(self, PyObject other) -> bool
1322
1323 Test for inequality of wx.Rect objects.
1324 """
1325 return _core_.Rect___ne__(*args, **kwargs)
1326
1327 def ContainsXY(*args, **kwargs):
1328 """
1329 ContainsXY(self, int x, int y) -> bool
1330
1331 Return True if the point is inside the rect.
1332 """
1333 return _core_.Rect_ContainsXY(*args, **kwargs)
1334
1335 def Contains(*args, **kwargs):
1336 """
1337 Contains(self, Point pt) -> bool
1338
1339 Return True if the point is inside the rect.
1340 """
1341 return _core_.Rect_Contains(*args, **kwargs)
1342
1343 def ContainsRect(*args, **kwargs):
1344 """
1345 ContainsRect(self, Rect rect) -> bool
1346
1347 Returns ``True`` if the given rectangle is completely inside this
1348 rectangle or touches its boundary.
1349 """
1350 return _core_.Rect_ContainsRect(*args, **kwargs)
1351
1352 Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1353 InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1354 InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1355
1356 def Intersects(*args, **kwargs):
1357 """
1358 Intersects(self, Rect rect) -> bool
1359
1360 Returns True if the rectangles have a non empty intersection.
1361 """
1362 return _core_.Rect_Intersects(*args, **kwargs)
1363
1364 def CenterIn(*args, **kwargs):
1365 """
1366 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1367
1368 Center this rectangle within the one passed to the method, which is
1369 usually, but not necessarily, the larger one.
1370 """
1371 return _core_.Rect_CenterIn(*args, **kwargs)
1372
1373 CentreIn = CenterIn
1374 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1375 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1376 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1377 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1378 def Set(*args, **kwargs):
1379 """
1380 Set(self, int x=0, int y=0, int width=0, int height=0)
1381
1382 Set all rectangle properties.
1383 """
1384 return _core_.Rect_Set(*args, **kwargs)
1385
1386 def Get(*args, **kwargs):
1387 """
1388 Get() -> (x,y,width,height)
1389
1390 Return the rectangle properties as a tuple.
1391 """
1392 return _core_.Rect_Get(*args, **kwargs)
1393
1394 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1395 def __str__(self): return str(self.Get())
1396 def __repr__(self): return 'wx.Rect'+str(self.Get())
1397 def __len__(self): return len(self.Get())
1398 def __getitem__(self, index): return self.Get()[index]
1399 def __setitem__(self, index, val):
1400 if index == 0: self.x = val
1401 elif index == 1: self.y = val
1402 elif index == 2: self.width = val
1403 elif index == 3: self.height = val
1404 else: raise IndexError
1405 def __nonzero__(self): return self.Get() != (0,0,0,0)
1406 __safe_for_unpickling__ = True
1407 def __reduce__(self): return (wx.Rect, self.Get())
1408
1409 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1410 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1411 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1412 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1413 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1414 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1415 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1416 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1417 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1418 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1419 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1420 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1421 Empty = property(IsEmpty,doc="See `IsEmpty`")
1422 _core_.Rect_swigregister(Rect)
1423
1424 def RectPP(*args, **kwargs):
1425 """
1426 RectPP(Point topLeft, Point bottomRight) -> Rect
1427
1428 Create a new Rect object from Points representing two corners.
1429 """
1430 val = _core_.new_RectPP(*args, **kwargs)
1431 return val
1432
1433 def RectPS(*args, **kwargs):
1434 """
1435 RectPS(Point pos, Size size) -> Rect
1436
1437 Create a new Rect from a position and size.
1438 """
1439 val = _core_.new_RectPS(*args, **kwargs)
1440 return val
1441
1442 def RectS(*args, **kwargs):
1443 """
1444 RectS(Size size) -> Rect
1445
1446 Create a new Rect from a size only.
1447 """
1448 val = _core_.new_RectS(*args, **kwargs)
1449 return val
1450
1451
1452 def IntersectRect(*args, **kwargs):
1453 """
1454 IntersectRect(Rect r1, Rect r2) -> Rect
1455
1456 Calculate and return the intersection of r1 and r2.
1457 """
1458 return _core_.IntersectRect(*args, **kwargs)
1459 #---------------------------------------------------------------------------
1460
1461 class Point2D(object):
1462 """
1463 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1464 with floating point values.
1465 """
1466 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1467 __repr__ = _swig_repr
1468 def __init__(self, *args, **kwargs):
1469 """
1470 __init__(self, double x=0.0, double y=0.0) -> Point2D
1471
1472 Create a w.Point2D object.
1473 """
1474 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1475 def GetFloor(*args, **kwargs):
1476 """
1477 GetFloor() -> (x,y)
1478
1479 Convert to integer
1480 """
1481 return _core_.Point2D_GetFloor(*args, **kwargs)
1482
1483 def GetRounded(*args, **kwargs):
1484 """
1485 GetRounded() -> (x,y)
1486
1487 Convert to integer
1488 """
1489 return _core_.Point2D_GetRounded(*args, **kwargs)
1490
1491 def GetVectorLength(*args, **kwargs):
1492 """GetVectorLength(self) -> double"""
1493 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1494
1495 def GetVectorAngle(*args, **kwargs):
1496 """GetVectorAngle(self) -> double"""
1497 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1498
1499 def SetVectorLength(*args, **kwargs):
1500 """SetVectorLength(self, double length)"""
1501 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1502
1503 def SetVectorAngle(*args, **kwargs):
1504 """SetVectorAngle(self, double degrees)"""
1505 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1506
1507 def SetPolarCoordinates(self, angle, length):
1508 self.SetVectorLength(length)
1509 self.SetVectorAngle(angle)
1510 def Normalize(self):
1511 self.SetVectorLength(1.0)
1512
1513 def GetDistance(*args, **kwargs):
1514 """GetDistance(self, Point2D pt) -> double"""
1515 return _core_.Point2D_GetDistance(*args, **kwargs)
1516
1517 def GetDistanceSquare(*args, **kwargs):
1518 """GetDistanceSquare(self, Point2D pt) -> double"""
1519 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1520
1521 def GetDotProduct(*args, **kwargs):
1522 """GetDotProduct(self, Point2D vec) -> double"""
1523 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1524
1525 def GetCrossProduct(*args, **kwargs):
1526 """GetCrossProduct(self, Point2D vec) -> double"""
1527 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1528
1529 def __neg__(*args, **kwargs):
1530 """
1531 __neg__(self) -> Point2D
1532
1533 the reflection of this point
1534 """
1535 return _core_.Point2D___neg__(*args, **kwargs)
1536
1537 def __iadd__(*args, **kwargs):
1538 """__iadd__(self, Point2D pt) -> Point2D"""
1539 return _core_.Point2D___iadd__(*args, **kwargs)
1540
1541 def __isub__(*args, **kwargs):
1542 """__isub__(self, Point2D pt) -> Point2D"""
1543 return _core_.Point2D___isub__(*args, **kwargs)
1544
1545 def __imul__(*args, **kwargs):
1546 """__imul__(self, Point2D pt) -> Point2D"""
1547 return _core_.Point2D___imul__(*args, **kwargs)
1548
1549 def __idiv__(*args, **kwargs):
1550 """__idiv__(self, Point2D pt) -> Point2D"""
1551 return _core_.Point2D___idiv__(*args, **kwargs)
1552
1553 def __eq__(*args, **kwargs):
1554 """
1555 __eq__(self, PyObject other) -> bool
1556
1557 Test for equality of wx.Point2D objects.
1558 """
1559 return _core_.Point2D___eq__(*args, **kwargs)
1560
1561 def __ne__(*args, **kwargs):
1562 """
1563 __ne__(self, PyObject other) -> bool
1564
1565 Test for inequality of wx.Point2D objects.
1566 """
1567 return _core_.Point2D___ne__(*args, **kwargs)
1568
1569 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1570 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1571 def Set(*args, **kwargs):
1572 """Set(self, double x=0, double y=0)"""
1573 return _core_.Point2D_Set(*args, **kwargs)
1574
1575 def Get(*args, **kwargs):
1576 """
1577 Get() -> (x,y)
1578
1579 Return x and y properties as a tuple.
1580 """
1581 return _core_.Point2D_Get(*args, **kwargs)
1582
1583 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1584 def __str__(self): return str(self.Get())
1585 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1586 def __len__(self): return len(self.Get())
1587 def __getitem__(self, index): return self.Get()[index]
1588 def __setitem__(self, index, val):
1589 if index == 0: self.x = val
1590 elif index == 1: self.y = val
1591 else: raise IndexError
1592 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1593 __safe_for_unpickling__ = True
1594 def __reduce__(self): return (wx.Point2D, self.Get())
1595
1596 Floor = property(GetFloor,doc="See `GetFloor`")
1597 Rounded = property(GetRounded,doc="See `GetRounded`")
1598 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1599 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1600 _core_.Point2D_swigregister(Point2D)
1601
1602 def Point2DCopy(*args, **kwargs):
1603 """
1604 Point2DCopy(Point2D pt) -> Point2D
1605
1606 Create a w.Point2D object.
1607 """
1608 val = _core_.new_Point2DCopy(*args, **kwargs)
1609 return val
1610
1611 def Point2DFromPoint(*args, **kwargs):
1612 """
1613 Point2DFromPoint(Point pt) -> Point2D
1614
1615 Create a w.Point2D object.
1616 """
1617 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1618 return val
1619
1620 #---------------------------------------------------------------------------
1621
1622 FromStart = _core_.FromStart
1623 FromCurrent = _core_.FromCurrent
1624 FromEnd = _core_.FromEnd
1625 class InputStream(object):
1626 """Proxy of C++ InputStream class"""
1627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1628 __repr__ = _swig_repr
1629 def __init__(self, *args, **kwargs):
1630 """__init__(self, PyObject p) -> InputStream"""
1631 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1632 __swig_destroy__ = _core_.delete_InputStream
1633 __del__ = lambda self : None;
1634 def close(*args, **kwargs):
1635 """close(self)"""
1636 return _core_.InputStream_close(*args, **kwargs)
1637
1638 def flush(*args, **kwargs):
1639 """flush(self)"""
1640 return _core_.InputStream_flush(*args, **kwargs)
1641
1642 def eof(*args, **kwargs):
1643 """eof(self) -> bool"""
1644 return _core_.InputStream_eof(*args, **kwargs)
1645
1646 def read(*args, **kwargs):
1647 """read(self, int size=-1) -> PyObject"""
1648 return _core_.InputStream_read(*args, **kwargs)
1649
1650 def readline(*args, **kwargs):
1651 """readline(self, int size=-1) -> PyObject"""
1652 return _core_.InputStream_readline(*args, **kwargs)
1653
1654 def readlines(*args, **kwargs):
1655 """readlines(self, int sizehint=-1) -> PyObject"""
1656 return _core_.InputStream_readlines(*args, **kwargs)
1657
1658 def seek(*args, **kwargs):
1659 """seek(self, int offset, int whence=0)"""
1660 return _core_.InputStream_seek(*args, **kwargs)
1661
1662 def tell(*args, **kwargs):
1663 """tell(self) -> int"""
1664 return _core_.InputStream_tell(*args, **kwargs)
1665
1666 def Peek(*args, **kwargs):
1667 """Peek(self) -> char"""
1668 return _core_.InputStream_Peek(*args, **kwargs)
1669
1670 def GetC(*args, **kwargs):
1671 """GetC(self) -> char"""
1672 return _core_.InputStream_GetC(*args, **kwargs)
1673
1674 def LastRead(*args, **kwargs):
1675 """LastRead(self) -> size_t"""
1676 return _core_.InputStream_LastRead(*args, **kwargs)
1677
1678 def CanRead(*args, **kwargs):
1679 """CanRead(self) -> bool"""
1680 return _core_.InputStream_CanRead(*args, **kwargs)
1681
1682 def Eof(*args, **kwargs):
1683 """Eof(self) -> bool"""
1684 return _core_.InputStream_Eof(*args, **kwargs)
1685
1686 def Ungetch(*args, **kwargs):
1687 """Ungetch(self, char c) -> bool"""
1688 return _core_.InputStream_Ungetch(*args, **kwargs)
1689
1690 def SeekI(*args, **kwargs):
1691 """SeekI(self, long pos, int mode=FromStart) -> long"""
1692 return _core_.InputStream_SeekI(*args, **kwargs)
1693
1694 def TellI(*args, **kwargs):
1695 """TellI(self) -> long"""
1696 return _core_.InputStream_TellI(*args, **kwargs)
1697
1698 _core_.InputStream_swigregister(InputStream)
1699 DefaultPosition = cvar.DefaultPosition
1700 DefaultSize = cvar.DefaultSize
1701
1702 class OutputStream(object):
1703 """Proxy of C++ OutputStream class"""
1704 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1705 def __init__(self): raise AttributeError, "No constructor defined"
1706 __repr__ = _swig_repr
1707 def write(*args, **kwargs):
1708 """write(self, PyObject obj)"""
1709 return _core_.OutputStream_write(*args, **kwargs)
1710
1711 def LastWrite(*args, **kwargs):
1712 """LastWrite(self) -> size_t"""
1713 return _core_.OutputStream_LastWrite(*args, **kwargs)
1714
1715 _core_.OutputStream_swigregister(OutputStream)
1716
1717 #---------------------------------------------------------------------------
1718
1719 class FSFile(Object):
1720 """Proxy of C++ FSFile class"""
1721 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1722 __repr__ = _swig_repr
1723 def __init__(self, *args, **kwargs):
1724 """
1725 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1726 DateTime modif) -> FSFile
1727 """
1728 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1729 __swig_destroy__ = _core_.delete_FSFile
1730 __del__ = lambda self : None;
1731 def GetStream(*args, **kwargs):
1732 """GetStream(self) -> InputStream"""
1733 return _core_.FSFile_GetStream(*args, **kwargs)
1734
1735 def DetachStream(*args, **kwargs):
1736 """DetachStream(self)"""
1737 return _core_.FSFile_DetachStream(*args, **kwargs)
1738
1739 def GetMimeType(*args, **kwargs):
1740 """GetMimeType(self) -> String"""
1741 return _core_.FSFile_GetMimeType(*args, **kwargs)
1742
1743 def GetLocation(*args, **kwargs):
1744 """GetLocation(self) -> String"""
1745 return _core_.FSFile_GetLocation(*args, **kwargs)
1746
1747 def GetAnchor(*args, **kwargs):
1748 """GetAnchor(self) -> String"""
1749 return _core_.FSFile_GetAnchor(*args, **kwargs)
1750
1751 def GetModificationTime(*args, **kwargs):
1752 """GetModificationTime(self) -> DateTime"""
1753 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1754
1755 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1756 Location = property(GetLocation,doc="See `GetLocation`")
1757 MimeType = property(GetMimeType,doc="See `GetMimeType`")
1758 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
1759 Stream = property(GetStream,doc="See `GetStream`")
1760 _core_.FSFile_swigregister(FSFile)
1761
1762 class CPPFileSystemHandler(object):
1763 """Proxy of C++ CPPFileSystemHandler class"""
1764 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1765 def __init__(self): raise AttributeError, "No constructor defined"
1766 __repr__ = _swig_repr
1767 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1768 __del__ = lambda self : None;
1769 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
1770
1771 class FileSystemHandler(CPPFileSystemHandler):
1772 """Proxy of C++ FileSystemHandler class"""
1773 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1774 __repr__ = _swig_repr
1775 def __init__(self, *args, **kwargs):
1776 """__init__(self) -> FileSystemHandler"""
1777 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
1778 self._setCallbackInfo(self, FileSystemHandler)
1779
1780 def _setCallbackInfo(*args, **kwargs):
1781 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1782 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1783
1784 def CanOpen(*args, **kwargs):
1785 """CanOpen(self, String location) -> bool"""
1786 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1787
1788 def OpenFile(*args, **kwargs):
1789 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1790 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1791
1792 def FindFirst(*args, **kwargs):
1793 """FindFirst(self, String spec, int flags=0) -> String"""
1794 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1795
1796 def FindNext(*args, **kwargs):
1797 """FindNext(self) -> String"""
1798 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1799
1800 def GetProtocol(*args, **kwargs):
1801 """GetProtocol(self, String location) -> String"""
1802 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1803
1804 def GetLeftLocation(*args, **kwargs):
1805 """GetLeftLocation(self, String location) -> String"""
1806 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1807
1808 def GetAnchor(*args, **kwargs):
1809 """GetAnchor(self, String location) -> String"""
1810 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1811
1812 def GetRightLocation(*args, **kwargs):
1813 """GetRightLocation(self, String location) -> String"""
1814 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1815
1816 def GetMimeTypeFromExt(*args, **kwargs):
1817 """GetMimeTypeFromExt(self, String location) -> String"""
1818 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1819
1820 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1821 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
1822 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
1823 Protocol = property(GetProtocol,doc="See `GetProtocol`")
1824 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
1825 _core_.FileSystemHandler_swigregister(FileSystemHandler)
1826
1827 class FileSystem(Object):
1828 """Proxy of C++ FileSystem class"""
1829 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1830 __repr__ = _swig_repr
1831 def __init__(self, *args, **kwargs):
1832 """__init__(self) -> FileSystem"""
1833 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1834 __swig_destroy__ = _core_.delete_FileSystem
1835 __del__ = lambda self : None;
1836 def ChangePathTo(*args, **kwargs):
1837 """ChangePathTo(self, String location, bool is_dir=False)"""
1838 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1839
1840 def GetPath(*args, **kwargs):
1841 """GetPath(self) -> String"""
1842 return _core_.FileSystem_GetPath(*args, **kwargs)
1843
1844 def OpenFile(*args, **kwargs):
1845 """OpenFile(self, String location) -> FSFile"""
1846 return _core_.FileSystem_OpenFile(*args, **kwargs)
1847
1848 def FindFirst(*args, **kwargs):
1849 """FindFirst(self, String spec, int flags=0) -> String"""
1850 return _core_.FileSystem_FindFirst(*args, **kwargs)
1851
1852 def FindNext(*args, **kwargs):
1853 """FindNext(self) -> String"""
1854 return _core_.FileSystem_FindNext(*args, **kwargs)
1855
1856 def AddHandler(*args, **kwargs):
1857 """AddHandler(CPPFileSystemHandler handler)"""
1858 return _core_.FileSystem_AddHandler(*args, **kwargs)
1859
1860 AddHandler = staticmethod(AddHandler)
1861 def RemoveHandler(*args, **kwargs):
1862 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1863 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1864
1865 RemoveHandler = staticmethod(RemoveHandler)
1866 def CleanUpHandlers(*args, **kwargs):
1867 """CleanUpHandlers()"""
1868 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1869
1870 CleanUpHandlers = staticmethod(CleanUpHandlers)
1871 def FileNameToURL(*args, **kwargs):
1872 """FileNameToURL(String filename) -> String"""
1873 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1874
1875 FileNameToURL = staticmethod(FileNameToURL)
1876 def URLToFileName(*args, **kwargs):
1877 """URLToFileName(String url) -> String"""
1878 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1879
1880 URLToFileName = staticmethod(URLToFileName)
1881 Path = property(GetPath,doc="See `GetPath`")
1882 _core_.FileSystem_swigregister(FileSystem)
1883
1884 def FileSystem_AddHandler(*args, **kwargs):
1885 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1886 return _core_.FileSystem_AddHandler(*args, **kwargs)
1887
1888 def FileSystem_RemoveHandler(*args, **kwargs):
1889 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1890 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1891
1892 def FileSystem_CleanUpHandlers(*args):
1893 """FileSystem_CleanUpHandlers()"""
1894 return _core_.FileSystem_CleanUpHandlers(*args)
1895
1896 def FileSystem_FileNameToURL(*args, **kwargs):
1897 """FileSystem_FileNameToURL(String filename) -> String"""
1898 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1899
1900 def FileSystem_URLToFileName(*args, **kwargs):
1901 """FileSystem_URLToFileName(String url) -> String"""
1902 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1903
1904 class InternetFSHandler(CPPFileSystemHandler):
1905 """Proxy of C++ InternetFSHandler class"""
1906 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1907 __repr__ = _swig_repr
1908 def __init__(self, *args, **kwargs):
1909 """__init__(self) -> InternetFSHandler"""
1910 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
1911 def CanOpen(*args, **kwargs):
1912 """CanOpen(self, String location) -> bool"""
1913 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1914
1915 def OpenFile(*args, **kwargs):
1916 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1917 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1918
1919 _core_.InternetFSHandler_swigregister(InternetFSHandler)
1920
1921 class ZipFSHandler(CPPFileSystemHandler):
1922 """Proxy of C++ ZipFSHandler class"""
1923 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1924 __repr__ = _swig_repr
1925 def __init__(self, *args, **kwargs):
1926 """__init__(self) -> ZipFSHandler"""
1927 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
1928 def CanOpen(*args, **kwargs):
1929 """CanOpen(self, String location) -> bool"""
1930 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1931
1932 def OpenFile(*args, **kwargs):
1933 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1934 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1935
1936 def FindFirst(*args, **kwargs):
1937 """FindFirst(self, String spec, int flags=0) -> String"""
1938 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1939
1940 def FindNext(*args, **kwargs):
1941 """FindNext(self) -> String"""
1942 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1943
1944 _core_.ZipFSHandler_swigregister(ZipFSHandler)
1945
1946
1947 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1948 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1949 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1950
1951 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1952 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1953 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1954
1955 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1956 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1957 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1958 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1959 """
1960 Add 'file' to the memory filesystem. The dataItem parameter can
1961 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1962 arbitrary data. If a bitmap or image is used then the imgType
1963 parameter should specify what kind of image file it should be
1964 written as, wx.BITMAP_TYPE_PNG, etc.
1965 """
1966 if isinstance(dataItem, wx.Image):
1967 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1968 elif isinstance(dataItem, wx.Bitmap):
1969 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1970 elif type(dataItem) == str:
1971 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1972 else:
1973 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1974
1975 class MemoryFSHandler(CPPFileSystemHandler):
1976 """Proxy of C++ MemoryFSHandler class"""
1977 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1978 __repr__ = _swig_repr
1979 def __init__(self, *args, **kwargs):
1980 """__init__(self) -> MemoryFSHandler"""
1981 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
1982 def RemoveFile(*args, **kwargs):
1983 """RemoveFile(String filename)"""
1984 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1985
1986 RemoveFile = staticmethod(RemoveFile)
1987 AddFile = staticmethod(MemoryFSHandler_AddFile)
1988 def CanOpen(*args, **kwargs):
1989 """CanOpen(self, String location) -> bool"""
1990 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1991
1992 def OpenFile(*args, **kwargs):
1993 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1994 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1995
1996 def FindFirst(*args, **kwargs):
1997 """FindFirst(self, String spec, int flags=0) -> String"""
1998 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1999
2000 def FindNext(*args, **kwargs):
2001 """FindNext(self) -> String"""
2002 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2003
2004 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2005
2006 def MemoryFSHandler_RemoveFile(*args, **kwargs):
2007 """MemoryFSHandler_RemoveFile(String filename)"""
2008 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2009
2010 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2011 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2012 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2013 #---------------------------------------------------------------------------
2014
2015 class ImageHandler(Object):
2016 """
2017 This is the base class for implementing image file loading/saving, and
2018 image creation from data. It is used within `wx.Image` and is not
2019 normally seen by the application.
2020 """
2021 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2022 def __init__(self): raise AttributeError, "No constructor defined"
2023 __repr__ = _swig_repr
2024 def GetName(*args, **kwargs):
2025 """GetName(self) -> String"""
2026 return _core_.ImageHandler_GetName(*args, **kwargs)
2027
2028 def GetExtension(*args, **kwargs):
2029 """GetExtension(self) -> String"""
2030 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2031
2032 def GetType(*args, **kwargs):
2033 """GetType(self) -> long"""
2034 return _core_.ImageHandler_GetType(*args, **kwargs)
2035
2036 def GetMimeType(*args, **kwargs):
2037 """GetMimeType(self) -> String"""
2038 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2039
2040 def CanRead(*args, **kwargs):
2041 """CanRead(self, String name) -> bool"""
2042 return _core_.ImageHandler_CanRead(*args, **kwargs)
2043
2044 def CanReadStream(*args, **kwargs):
2045 """CanReadStream(self, InputStream stream) -> bool"""
2046 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2047
2048 def SetName(*args, **kwargs):
2049 """SetName(self, String name)"""
2050 return _core_.ImageHandler_SetName(*args, **kwargs)
2051
2052 def SetExtension(*args, **kwargs):
2053 """SetExtension(self, String extension)"""
2054 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2055
2056 def SetType(*args, **kwargs):
2057 """SetType(self, long type)"""
2058 return _core_.ImageHandler_SetType(*args, **kwargs)
2059
2060 def SetMimeType(*args, **kwargs):
2061 """SetMimeType(self, String mimetype)"""
2062 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2063
2064 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2065 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2066 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2067 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2068 _core_.ImageHandler_swigregister(ImageHandler)
2069
2070 class PyImageHandler(ImageHandler):
2071 """
2072 This is the base class for implementing image file loading/saving, and
2073 image creation from data, all written in Python. To create a custom
2074 image handler derive a new class from wx.PyImageHandler and provide
2075 the following methods::
2076
2077 def DoCanRead(self, stream) --> bool
2078 '''Check if this handler can read the image on the stream'''
2079
2080 def LoadFile(self, image, stream, verbose, index) --> bool
2081 '''Load image data from the stream and load it into image.'''
2082
2083 def SaveFile(self, image, stream, verbose) --> bool
2084 '''Save the iamge data in image to the stream using
2085 this handler's image file format.'''
2086
2087 def GetImageCount(self, stream) --> int
2088 '''If this image format can hold more than one image,
2089 how many does the image on the stream have?'''
2090
2091 To activate your handler create an instance of it and pass it to
2092 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2093 `SetExtension` from your constructor.
2094
2095 """
2096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2097 __repr__ = _swig_repr
2098 def __init__(self, *args, **kwargs):
2099 """
2100 __init__(self) -> PyImageHandler
2101
2102 This is the base class for implementing image file loading/saving, and
2103 image creation from data, all written in Python. To create a custom
2104 image handler derive a new class from wx.PyImageHandler and provide
2105 the following methods::
2106
2107 def DoCanRead(self, stream) --> bool
2108 '''Check if this handler can read the image on the stream'''
2109
2110 def LoadFile(self, image, stream, verbose, index) --> bool
2111 '''Load image data from the stream and load it into image.'''
2112
2113 def SaveFile(self, image, stream, verbose) --> bool
2114 '''Save the iamge data in image to the stream using
2115 this handler's image file format.'''
2116
2117 def GetImageCount(self, stream) --> int
2118 '''If this image format can hold more than one image,
2119 how many does the image on the stream have?'''
2120
2121 To activate your handler create an instance of it and pass it to
2122 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2123 `SetExtension` from your constructor.
2124
2125 """
2126 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2127 self._SetSelf(self)
2128
2129 def _SetSelf(*args, **kwargs):
2130 """_SetSelf(self, PyObject self)"""
2131 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2132
2133 _core_.PyImageHandler_swigregister(PyImageHandler)
2134
2135 class ImageHistogram(object):
2136 """Proxy of C++ ImageHistogram class"""
2137 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2138 __repr__ = _swig_repr
2139 def __init__(self, *args, **kwargs):
2140 """__init__(self) -> ImageHistogram"""
2141 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2142 def MakeKey(*args, **kwargs):
2143 """
2144 MakeKey(byte r, byte g, byte b) -> unsigned long
2145
2146 Get the key in the histogram for the given RGB values
2147 """
2148 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2149
2150 MakeKey = staticmethod(MakeKey)
2151 def FindFirstUnusedColour(*args, **kwargs):
2152 """
2153 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2154
2155 Find first colour that is not used in the image and has higher RGB
2156 values than startR, startG, startB. Returns a tuple consisting of a
2157 success flag and rgb values.
2158 """
2159 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2160
2161 def GetCount(*args, **kwargs):
2162 """
2163 GetCount(self, unsigned long key) -> unsigned long
2164
2165 Returns the pixel count for the given key. Use `MakeKey` to create a
2166 key value from a RGB tripple.
2167 """
2168 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2169
2170 def GetCountRGB(*args, **kwargs):
2171 """
2172 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2173
2174 Returns the pixel count for the given RGB values.
2175 """
2176 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2177
2178 def GetCountColour(*args, **kwargs):
2179 """
2180 GetCountColour(self, Colour colour) -> unsigned long
2181
2182 Returns the pixel count for the given `wx.Colour` value.
2183 """
2184 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2185
2186 _core_.ImageHistogram_swigregister(ImageHistogram)
2187
2188 def ImageHistogram_MakeKey(*args, **kwargs):
2189 """
2190 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2191
2192 Get the key in the histogram for the given RGB values
2193 """
2194 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2195
2196 class Image_RGBValue(object):
2197 """
2198 An object that contains values for red, green and blue which represent
2199 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2200 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2201 color space.
2202 """
2203 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2204 __repr__ = _swig_repr
2205 def __init__(self, *args, **kwargs):
2206 """
2207 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2208
2209 Constructor.
2210 """
2211 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2212 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2213 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2214 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2215 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2216
2217 class Image_HSVValue(object):
2218 """
2219 An object that contains values for hue, saturation and value which
2220 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2221 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2222 color space.
2223 """
2224 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2225 __repr__ = _swig_repr
2226 def __init__(self, *args, **kwargs):
2227 """
2228 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2229
2230 Constructor.
2231 """
2232 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2233 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2234 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2235 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2236 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2237
2238 class Image(Object):
2239 """
2240 A platform-independent image class. An image can be created from
2241 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2242 variety of formats. Functions are available to set and get image
2243 bits, so it can be used for basic image manipulation.
2244
2245 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2246 platform-specific `wx.Bitmap` object must be created from it using the
2247 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2248 device context, using `wx.DC.DrawBitmap`.
2249
2250 One colour value of the image may be used as a mask colour which will
2251 lead to the automatic creation of a `wx.Mask` object associated to the
2252 bitmap object.
2253
2254 wx.Image supports alpha channel data, that is in addition to a byte
2255 for the red, green and blue colour components for each pixel it also
2256 stores a byte representing the pixel opacity. An alpha value of 0
2257 corresponds to a transparent pixel (null opacity) while a value of 255
2258 means that the pixel is 100% opaque.
2259
2260 Unlike RGB data, not all images have an alpha channel and before using
2261 `GetAlpha` you should check if this image contains an alpha channel
2262 with `HasAlpha`. Note that currently only images loaded from PNG files
2263 with transparency information will have an alpha channel.
2264 """
2265 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2266 __repr__ = _swig_repr
2267 def __init__(self, *args, **kwargs):
2268 """
2269 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2270
2271 Loads an image from a file.
2272 """
2273 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2274 __swig_destroy__ = _core_.delete_Image
2275 __del__ = lambda self : None;
2276 def Create(*args, **kwargs):
2277 """
2278 Create(self, int width, int height, bool clear=True)
2279
2280 Creates a fresh image. If clear is ``True``, the new image will be
2281 initialized to black. Otherwise, the image data will be uninitialized.
2282 """
2283 return _core_.Image_Create(*args, **kwargs)
2284
2285 def Destroy(*args, **kwargs):
2286 """
2287 Destroy(self)
2288
2289 Destroys the image data.
2290 """
2291 val = _core_.Image_Destroy(*args, **kwargs)
2292 args[0].thisown = 0
2293 return val
2294
2295 def Scale(*args, **kwargs):
2296 """
2297 Scale(self, int width, int height) -> Image
2298
2299 Returns a scaled version of the image. This is also useful for scaling
2300 bitmaps in general as the only other way to scale bitmaps is to blit a
2301 `wx.MemoryDC` into another `wx.MemoryDC`.
2302 """
2303 return _core_.Image_Scale(*args, **kwargs)
2304
2305 def ShrinkBy(*args, **kwargs):
2306 """
2307 ShrinkBy(self, int xFactor, int yFactor) -> Image
2308
2309 Return a version of the image scaled smaller by the given factors.
2310 """
2311 return _core_.Image_ShrinkBy(*args, **kwargs)
2312
2313 def Rescale(*args, **kwargs):
2314 """
2315 Rescale(self, int width, int height) -> Image
2316
2317 Changes the size of the image in-place by scaling it: after a call to
2318 this function, the image will have the given width and height.
2319
2320 Returns the (modified) image itself.
2321 """
2322 return _core_.Image_Rescale(*args, **kwargs)
2323
2324 def Resize(*args, **kwargs):
2325 """
2326 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2327
2328 Changes the size of the image in-place without scaling it, by adding
2329 either a border with the given colour or cropping as necessary. The
2330 image is pasted into a new image with the given size and background
2331 colour at the position pos relative to the upper left of the new
2332 image. If red = green = blue = -1 then use either the current mask
2333 colour if set or find, use, and set a suitable mask colour for any
2334 newly exposed areas.
2335
2336 Returns the (modified) image itself.
2337 """
2338 return _core_.Image_Resize(*args, **kwargs)
2339
2340 def SetRGB(*args, **kwargs):
2341 """
2342 SetRGB(self, int x, int y, byte r, byte g, byte b)
2343
2344 Sets the pixel at the given coordinate. This routine performs
2345 bounds-checks for the coordinate so it can be considered a safe way to
2346 manipulate the data, but in some cases this might be too slow so that
2347 the data will have to be set directly. In that case you will have to
2348 get access to the image data using the `GetData` method.
2349 """
2350 return _core_.Image_SetRGB(*args, **kwargs)
2351
2352 def SetRGBRect(*args, **kwargs):
2353 """
2354 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2355
2356 Sets the colour of the pixels within the given rectangle. This routine
2357 performs bounds-checks for the rectangle so it can be considered a
2358 safe way to manipulate the data.
2359 """
2360 return _core_.Image_SetRGBRect(*args, **kwargs)
2361
2362 def GetRed(*args, **kwargs):
2363 """
2364 GetRed(self, int x, int y) -> byte
2365
2366 Returns the red intensity at the given coordinate.
2367 """
2368 return _core_.Image_GetRed(*args, **kwargs)
2369
2370 def GetGreen(*args, **kwargs):
2371 """
2372 GetGreen(self, int x, int y) -> byte
2373
2374 Returns the green intensity at the given coordinate.
2375 """
2376 return _core_.Image_GetGreen(*args, **kwargs)
2377
2378 def GetBlue(*args, **kwargs):
2379 """
2380 GetBlue(self, int x, int y) -> byte
2381
2382 Returns the blue intensity at the given coordinate.
2383 """
2384 return _core_.Image_GetBlue(*args, **kwargs)
2385
2386 def SetAlpha(*args, **kwargs):
2387 """
2388 SetAlpha(self, int x, int y, byte alpha)
2389
2390 Sets the alpha value for the given pixel. This function should only be
2391 called if the image has alpha channel data, use `HasAlpha` to check
2392 for this.
2393 """
2394 return _core_.Image_SetAlpha(*args, **kwargs)
2395
2396 def GetAlpha(*args, **kwargs):
2397 """
2398 GetAlpha(self, int x, int y) -> byte
2399
2400 Returns the alpha value for the given pixel. This function may only be
2401 called for the images with alpha channel, use `HasAlpha` to check for
2402 this.
2403
2404 The returned value is the *opacity* of the image, i.e. the value of 0
2405 corresponds to the fully transparent pixels while the value of 255 to
2406 the fully opaque pixels.
2407 """
2408 return _core_.Image_GetAlpha(*args, **kwargs)
2409
2410 def HasAlpha(*args, **kwargs):
2411 """
2412 HasAlpha(self) -> bool
2413
2414 Returns true if this image has alpha channel, false otherwise.
2415 """
2416 return _core_.Image_HasAlpha(*args, **kwargs)
2417
2418 def InitAlpha(*args, **kwargs):
2419 """
2420 InitAlpha(self)
2421
2422 Initializes the image alpha channel data. It is an error to call it if
2423 the image already has alpha data. If it doesn't, alpha data will be by
2424 default initialized to all pixels being fully opaque. But if the image
2425 has a a mask colour, all mask pixels will be completely transparent.
2426 """
2427 return _core_.Image_InitAlpha(*args, **kwargs)
2428
2429 def IsTransparent(*args, **kwargs):
2430 """
2431 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2432
2433 Returns ``True`` if this pixel is masked or has an alpha value less
2434 than the spcified threshold.
2435 """
2436 return _core_.Image_IsTransparent(*args, **kwargs)
2437
2438 def FindFirstUnusedColour(*args, **kwargs):
2439 """
2440 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2441
2442 Find first colour that is not used in the image and has higher RGB
2443 values than startR, startG, startB. Returns a tuple consisting of a
2444 success flag and rgb values.
2445 """
2446 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2447
2448 def ConvertAlphaToMask(*args, **kwargs):
2449 """
2450 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2451
2452 If the image has alpha channel, this method converts it to mask. All
2453 pixels with alpha value less than ``threshold`` are replaced with the
2454 mask colour and the alpha channel is removed. The mask colour is
2455 chosen automatically using `FindFirstUnusedColour`.
2456
2457 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2458 nothing.
2459 """
2460 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2461
2462 def ConvertColourToAlpha(*args, **kwargs):
2463 """
2464 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2465
2466 This method converts an image where the original alpha information is
2467 only available as a shades of a colour (actually shades of grey)
2468 typically when you draw anti-aliased text into a bitmap. The DC
2469 drawing routines draw grey values on the black background although
2470 they actually mean to draw white with differnt alpha values. This
2471 method reverses it, assuming a black (!) background and white text.
2472 The method will then fill up the whole image with the colour given.
2473 """
2474 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2475
2476 def SetMaskFromImage(*args, **kwargs):
2477 """
2478 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2479
2480 Sets the image's mask so that the pixels that have RGB value of
2481 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2482 by first finding an unused colour in the image, setting this colour as
2483 the mask colour and then using this colour to draw all pixels in the
2484 image who corresponding pixel in mask has given RGB value.
2485
2486 Returns ``False`` if ``mask`` does not have same dimensions as the
2487 image or if there is no unused colour left. Returns ``True`` if the
2488 mask was successfully applied.
2489
2490 Note that this method involves computing the histogram, which is
2491 computationally intensive operation.
2492 """
2493 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2494
2495 def CanRead(*args, **kwargs):
2496 """
2497 CanRead(String filename) -> bool
2498
2499 Returns True if the image handlers can read this file.
2500 """
2501 return _core_.Image_CanRead(*args, **kwargs)
2502
2503 CanRead = staticmethod(CanRead)
2504 def GetImageCount(*args, **kwargs):
2505 """
2506 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2507
2508 If the image file contains more than one image and the image handler
2509 is capable of retrieving these individually, this function will return
2510 the number of available images.
2511 """
2512 return _core_.Image_GetImageCount(*args, **kwargs)
2513
2514 GetImageCount = staticmethod(GetImageCount)
2515 def LoadFile(*args, **kwargs):
2516 """
2517 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2518
2519 Loads an image from a file. If no handler type is provided, the
2520 library will try to autodetect the format.
2521 """
2522 return _core_.Image_LoadFile(*args, **kwargs)
2523
2524 def LoadMimeFile(*args, **kwargs):
2525 """
2526 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2527
2528 Loads an image from a file, specifying the image type with a MIME type
2529 string.
2530 """
2531 return _core_.Image_LoadMimeFile(*args, **kwargs)
2532
2533 def SaveFile(*args, **kwargs):
2534 """
2535 SaveFile(self, String name, int type) -> bool
2536
2537 Saves an image in the named file.
2538 """
2539 return _core_.Image_SaveFile(*args, **kwargs)
2540
2541 def SaveMimeFile(*args, **kwargs):
2542 """
2543 SaveMimeFile(self, String name, String mimetype) -> bool
2544
2545 Saves an image in the named file.
2546 """
2547 return _core_.Image_SaveMimeFile(*args, **kwargs)
2548
2549 def CanReadStream(*args, **kwargs):
2550 """
2551 CanReadStream(InputStream stream) -> bool
2552
2553 Returns True if the image handlers can read an image file from the
2554 data currently on the input stream, or a readable Python file-like
2555 object.
2556 """
2557 return _core_.Image_CanReadStream(*args, **kwargs)
2558
2559 CanReadStream = staticmethod(CanReadStream)
2560 def LoadStream(*args, **kwargs):
2561 """
2562 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2563
2564 Loads an image from an input stream or a readable Python file-like
2565 object. If no handler type is provided, the library will try to
2566 autodetect the format.
2567 """
2568 return _core_.Image_LoadStream(*args, **kwargs)
2569
2570 def LoadMimeStream(*args, **kwargs):
2571 """
2572 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2573
2574 Loads an image from an input stream or a readable Python file-like
2575 object, using a MIME type string to specify the image file format.
2576 """
2577 return _core_.Image_LoadMimeStream(*args, **kwargs)
2578
2579 def Ok(*args, **kwargs):
2580 """
2581 Ok(self) -> bool
2582
2583 Returns true if image data is present.
2584 """
2585 return _core_.Image_Ok(*args, **kwargs)
2586
2587 def GetWidth(*args, **kwargs):
2588 """
2589 GetWidth(self) -> int
2590
2591 Gets the width of the image in pixels.
2592 """
2593 return _core_.Image_GetWidth(*args, **kwargs)
2594
2595 def GetHeight(*args, **kwargs):
2596 """
2597 GetHeight(self) -> int
2598
2599 Gets the height of the image in pixels.
2600 """
2601 return _core_.Image_GetHeight(*args, **kwargs)
2602
2603 def GetSize(*args, **kwargs):
2604 """
2605 GetSize(self) -> Size
2606
2607 Returns the size of the image in pixels.
2608 """
2609 return _core_.Image_GetSize(*args, **kwargs)
2610
2611 def GetSubImage(*args, **kwargs):
2612 """
2613 GetSubImage(self, Rect rect) -> Image
2614
2615 Returns a sub image of the current one as long as the rect belongs
2616 entirely to the image.
2617 """
2618 return _core_.Image_GetSubImage(*args, **kwargs)
2619
2620 def Size(*args, **kwargs):
2621 """
2622 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2623
2624 Returns a resized version of this image without scaling it by adding
2625 either a border with the given colour or cropping as necessary. The
2626 image is pasted into a new image with the given size and background
2627 colour at the position ``pos`` relative to the upper left of the new
2628 image. If red = green = blue = -1 then use either the current mask
2629 colour if set or find, use, and set a suitable mask colour for any
2630 newly exposed areas.
2631 """
2632 return _core_.Image_Size(*args, **kwargs)
2633
2634 def Copy(*args, **kwargs):
2635 """
2636 Copy(self) -> Image
2637
2638 Returns an identical copy of the image.
2639 """
2640 return _core_.Image_Copy(*args, **kwargs)
2641
2642 def Paste(*args, **kwargs):
2643 """
2644 Paste(self, Image image, int x, int y)
2645
2646 Pastes ``image`` into this instance and takes care of the mask colour
2647 and any out of bounds problems.
2648 """
2649 return _core_.Image_Paste(*args, **kwargs)
2650
2651 def GetData(*args, **kwargs):
2652 """
2653 GetData(self) -> PyObject
2654
2655 Returns a string containing a copy of the RGB bytes of the image.
2656 """
2657 return _core_.Image_GetData(*args, **kwargs)
2658
2659 def SetData(*args, **kwargs):
2660 """
2661 SetData(self, buffer data)
2662
2663 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2664 either a string or a buffer object holding the data and the length of
2665 the data must be width*height*3.
2666 """
2667 return _core_.Image_SetData(*args, **kwargs)
2668
2669 def GetDataBuffer(*args, **kwargs):
2670 """
2671 GetDataBuffer(self) -> PyObject
2672
2673 Returns a writable Python buffer object that is pointing at the RGB
2674 image data buffer inside the wx.Image. You need to ensure that you do
2675 not use this buffer object after the image has been destroyed.
2676 """
2677 return _core_.Image_GetDataBuffer(*args, **kwargs)
2678
2679 def SetDataBuffer(*args, **kwargs):
2680 """
2681 SetDataBuffer(self, buffer data)
2682
2683 Sets the internal image data pointer to point at a Python buffer
2684 object. This can save making an extra copy of the data but you must
2685 ensure that the buffer object lives longer than the wx.Image does.
2686 """
2687 return _core_.Image_SetDataBuffer(*args, **kwargs)
2688
2689 def GetAlphaData(*args, **kwargs):
2690 """
2691 GetAlphaData(self) -> PyObject
2692
2693 Returns a string containing a copy of the alpha bytes of the image.
2694 """
2695 return _core_.Image_GetAlphaData(*args, **kwargs)
2696
2697 def SetAlphaData(*args, **kwargs):
2698 """
2699 SetAlphaData(self, buffer alpha)
2700
2701 Resets the Image's alpha data from a buffer of bytes. Accepts either
2702 a string or a buffer object holding the data and the length of the
2703 data must be width*height.
2704 """
2705 return _core_.Image_SetAlphaData(*args, **kwargs)
2706
2707 def GetAlphaBuffer(*args, **kwargs):
2708 """
2709 GetAlphaBuffer(self) -> PyObject
2710
2711 Returns a writable Python buffer object that is pointing at the Alpha
2712 data buffer inside the wx.Image. You need to ensure that you do not
2713 use this buffer object after the image has been destroyed.
2714 """
2715 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2716
2717 def SetAlphaBuffer(*args, **kwargs):
2718 """
2719 SetAlphaBuffer(self, buffer alpha)
2720
2721 Sets the internal image alpha pointer to point at a Python buffer
2722 object. This can save making an extra copy of the data but you must
2723 ensure that the buffer object lives as long as the wx.Image does.
2724 """
2725 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2726
2727 def SetMaskColour(*args, **kwargs):
2728 """
2729 SetMaskColour(self, byte r, byte g, byte b)
2730
2731 Sets the mask colour for this image (and tells the image to use the
2732 mask).
2733 """
2734 return _core_.Image_SetMaskColour(*args, **kwargs)
2735
2736 def GetOrFindMaskColour(*args, **kwargs):
2737 """
2738 GetOrFindMaskColour() -> (r,g,b)
2739
2740 Get the current mask colour or find a suitable colour.
2741 """
2742 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2743
2744 def GetMaskRed(*args, **kwargs):
2745 """
2746 GetMaskRed(self) -> byte
2747
2748 Gets the red component of the mask colour.
2749 """
2750 return _core_.Image_GetMaskRed(*args, **kwargs)
2751
2752 def GetMaskGreen(*args, **kwargs):
2753 """
2754 GetMaskGreen(self) -> byte
2755
2756 Gets the green component of the mask colour.
2757 """
2758 return _core_.Image_GetMaskGreen(*args, **kwargs)
2759
2760 def GetMaskBlue(*args, **kwargs):
2761 """
2762 GetMaskBlue(self) -> byte
2763
2764 Gets the blue component of the mask colour.
2765 """
2766 return _core_.Image_GetMaskBlue(*args, **kwargs)
2767
2768 def SetMask(*args, **kwargs):
2769 """
2770 SetMask(self, bool mask=True)
2771
2772 Specifies whether there is a mask or not. The area of the mask is
2773 determined by the current mask colour.
2774 """
2775 return _core_.Image_SetMask(*args, **kwargs)
2776
2777 def HasMask(*args, **kwargs):
2778 """
2779 HasMask(self) -> bool
2780
2781 Returns ``True`` if there is a mask active, ``False`` otherwise.
2782 """
2783 return _core_.Image_HasMask(*args, **kwargs)
2784
2785 def Rotate(*args, **kwargs):
2786 """
2787 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2788 Point offset_after_rotation=None) -> Image
2789
2790 Rotates the image about the given point, by ``angle`` radians. Passing
2791 ``True`` to ``interpolating`` results in better image quality, but is
2792 slower. If the image has a mask, then the mask colour is used for the
2793 uncovered pixels in the rotated image background. Otherwise, black
2794 will be used as the fill colour.
2795
2796 Returns the rotated image, leaving this image intact.
2797 """
2798 return _core_.Image_Rotate(*args, **kwargs)
2799
2800 def Rotate90(*args, **kwargs):
2801 """
2802 Rotate90(self, bool clockwise=True) -> Image
2803
2804 Returns a copy of the image rotated 90 degrees in the direction
2805 indicated by ``clockwise``.
2806 """
2807 return _core_.Image_Rotate90(*args, **kwargs)
2808
2809 def Mirror(*args, **kwargs):
2810 """
2811 Mirror(self, bool horizontally=True) -> Image
2812
2813 Returns a mirrored copy of the image. The parameter ``horizontally``
2814 indicates the orientation.
2815 """
2816 return _core_.Image_Mirror(*args, **kwargs)
2817
2818 def Replace(*args, **kwargs):
2819 """
2820 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2821
2822 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2823 ``(r2,g2,b2)``.
2824 """
2825 return _core_.Image_Replace(*args, **kwargs)
2826
2827 def ConvertToGreyscale(*args, **kwargs):
2828 """
2829 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2830
2831 Convert to greyscale image. Uses the luminance component (Y) of the
2832 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2833 defaults to ITU-T BT.601
2834 """
2835 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2836
2837 def ConvertToMono(*args, **kwargs):
2838 """
2839 ConvertToMono(self, byte r, byte g, byte b) -> Image
2840
2841 Returns monochromatic version of the image. The returned image has
2842 white colour where the original has ``(r,g,b)`` colour and black
2843 colour everywhere else.
2844 """
2845 return _core_.Image_ConvertToMono(*args, **kwargs)
2846
2847 def SetOption(*args, **kwargs):
2848 """
2849 SetOption(self, String name, String value)
2850
2851 Sets an image handler defined option. For example, when saving as a
2852 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2853 number between 0 and 100 (0 is terrible, 100 is very good).
2854 """
2855 return _core_.Image_SetOption(*args, **kwargs)
2856
2857 def SetOptionInt(*args, **kwargs):
2858 """
2859 SetOptionInt(self, String name, int value)
2860
2861 Sets an image option as an integer.
2862 """
2863 return _core_.Image_SetOptionInt(*args, **kwargs)
2864
2865 def GetOption(*args, **kwargs):
2866 """
2867 GetOption(self, String name) -> String
2868
2869 Gets the value of an image handler option.
2870 """
2871 return _core_.Image_GetOption(*args, **kwargs)
2872
2873 def GetOptionInt(*args, **kwargs):
2874 """
2875 GetOptionInt(self, String name) -> int
2876
2877 Gets the value of an image handler option as an integer. If the given
2878 option is not present, the function returns 0.
2879 """
2880 return _core_.Image_GetOptionInt(*args, **kwargs)
2881
2882 def HasOption(*args, **kwargs):
2883 """
2884 HasOption(self, String name) -> bool
2885
2886 Returns true if the given option is present.
2887 """
2888 return _core_.Image_HasOption(*args, **kwargs)
2889
2890 def CountColours(*args, **kwargs):
2891 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2892 return _core_.Image_CountColours(*args, **kwargs)
2893
2894 def ComputeHistogram(*args, **kwargs):
2895 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2896 return _core_.Image_ComputeHistogram(*args, **kwargs)
2897
2898 def AddHandler(*args, **kwargs):
2899 """AddHandler(ImageHandler handler)"""
2900 return _core_.Image_AddHandler(*args, **kwargs)
2901
2902 AddHandler = staticmethod(AddHandler)
2903 def InsertHandler(*args, **kwargs):
2904 """InsertHandler(ImageHandler handler)"""
2905 return _core_.Image_InsertHandler(*args, **kwargs)
2906
2907 InsertHandler = staticmethod(InsertHandler)
2908 def RemoveHandler(*args, **kwargs):
2909 """RemoveHandler(String name) -> bool"""
2910 return _core_.Image_RemoveHandler(*args, **kwargs)
2911
2912 RemoveHandler = staticmethod(RemoveHandler)
2913 def GetHandlers(*args, **kwargs):
2914 """GetHandlers() -> PyObject"""
2915 return _core_.Image_GetHandlers(*args, **kwargs)
2916
2917 GetHandlers = staticmethod(GetHandlers)
2918 def GetImageExtWildcard(*args, **kwargs):
2919 """
2920 GetImageExtWildcard() -> String
2921
2922 Iterates all registered wxImageHandler objects, and returns a string
2923 containing file extension masks suitable for passing to file open/save
2924 dialog boxes.
2925 """
2926 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2927
2928 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2929 def ConvertToBitmap(*args, **kwargs):
2930 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
2931 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2932
2933 def ConvertToMonoBitmap(*args, **kwargs):
2934 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
2935 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2936
2937 def RotateHue(*args, **kwargs):
2938 """
2939 RotateHue(self, double angle)
2940
2941 Rotates the hue of each pixel of the image. Hue is a double in the
2942 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
2943 """
2944 return _core_.Image_RotateHue(*args, **kwargs)
2945
2946 def RGBtoHSV(*args, **kwargs):
2947 """
2948 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
2949
2950 Converts a color in RGB color space to HSV color space.
2951 """
2952 return _core_.Image_RGBtoHSV(*args, **kwargs)
2953
2954 RGBtoHSV = staticmethod(RGBtoHSV)
2955 def HSVtoRGB(*args, **kwargs):
2956 """
2957 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
2958
2959 Converts a color in HSV color space to RGB color space.
2960 """
2961 return _core_.Image_HSVtoRGB(*args, **kwargs)
2962
2963 HSVtoRGB = staticmethod(HSVtoRGB)
2964 def __nonzero__(self): return self.Ok()
2965 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
2966 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
2967 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
2968 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
2969 Height = property(GetHeight,doc="See `GetHeight`")
2970 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
2971 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
2972 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
2973 Size = property(GetSize,doc="See `GetSize`")
2974 Width = property(GetWidth,doc="See `GetWidth`")
2975 _core_.Image_swigregister(Image)
2976
2977 def ImageFromMime(*args, **kwargs):
2978 """
2979 ImageFromMime(String name, String mimetype, int index=-1) -> Image
2980
2981 Loads an image from a file, using a MIME type string (such as
2982 'image/jpeg') to specify image type.
2983 """
2984 val = _core_.new_ImageFromMime(*args, **kwargs)
2985 return val
2986
2987 def ImageFromStream(*args, **kwargs):
2988 """
2989 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2990
2991 Loads an image from an input stream, or any readable Python file-like
2992 object.
2993 """
2994 val = _core_.new_ImageFromStream(*args, **kwargs)
2995 return val
2996
2997 def ImageFromStreamMime(*args, **kwargs):
2998 """
2999 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3000
3001 Loads an image from an input stream, or any readable Python file-like
3002 object, specifying the image format with a MIME type string.
3003 """
3004 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3005 return val
3006
3007 def EmptyImage(*args, **kwargs):
3008 """
3009 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3010
3011 Construct an empty image of a given size, optionally setting all
3012 pixels to black.
3013 """
3014 val = _core_.new_EmptyImage(*args, **kwargs)
3015 return val
3016
3017 def ImageFromBitmap(*args, **kwargs):
3018 """
3019 ImageFromBitmap(Bitmap bitmap) -> Image
3020
3021 Construct an Image from a `wx.Bitmap`.
3022 """
3023 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3024 return val
3025
3026 def ImageFromData(*args, **kwargs):
3027 """
3028 ImageFromData(int width, int height, buffer data) -> Image
3029
3030 Construct an Image from a buffer of RGB bytes. Accepts either a
3031 string or a buffer object holding the data and the length of the data
3032 must be width*height*3.
3033 """
3034 val = _core_.new_ImageFromData(*args, **kwargs)
3035 return val
3036
3037 def ImageFromDataWithAlpha(*args, **kwargs):
3038 """
3039 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3040
3041 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3042 Accepts either a string or a buffer object holding the data and the
3043 length of the data must be width*height*3 bytes, and the length of the
3044 alpha data must be width*height bytes.
3045 """
3046 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3047 return val
3048
3049 def Image_CanRead(*args, **kwargs):
3050 """
3051 Image_CanRead(String filename) -> bool
3052
3053 Returns True if the image handlers can read this file.
3054 """
3055 return _core_.Image_CanRead(*args, **kwargs)
3056
3057 def Image_GetImageCount(*args, **kwargs):
3058 """
3059 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3060
3061 If the image file contains more than one image and the image handler
3062 is capable of retrieving these individually, this function will return
3063 the number of available images.
3064 """
3065 return _core_.Image_GetImageCount(*args, **kwargs)
3066
3067 def Image_CanReadStream(*args, **kwargs):
3068 """
3069 Image_CanReadStream(InputStream stream) -> bool
3070
3071 Returns True if the image handlers can read an image file from the
3072 data currently on the input stream, or a readable Python file-like
3073 object.
3074 """
3075 return _core_.Image_CanReadStream(*args, **kwargs)
3076
3077 def Image_AddHandler(*args, **kwargs):
3078 """Image_AddHandler(ImageHandler handler)"""
3079 return _core_.Image_AddHandler(*args, **kwargs)
3080
3081 def Image_InsertHandler(*args, **kwargs):
3082 """Image_InsertHandler(ImageHandler handler)"""
3083 return _core_.Image_InsertHandler(*args, **kwargs)
3084
3085 def Image_RemoveHandler(*args, **kwargs):
3086 """Image_RemoveHandler(String name) -> bool"""
3087 return _core_.Image_RemoveHandler(*args, **kwargs)
3088
3089 def Image_GetHandlers(*args):
3090 """Image_GetHandlers() -> PyObject"""
3091 return _core_.Image_GetHandlers(*args)
3092
3093 def Image_GetImageExtWildcard(*args):
3094 """
3095 Image_GetImageExtWildcard() -> String
3096
3097 Iterates all registered wxImageHandler objects, and returns a string
3098 containing file extension masks suitable for passing to file open/save
3099 dialog boxes.
3100 """
3101 return _core_.Image_GetImageExtWildcard(*args)
3102
3103 def Image_RGBtoHSV(*args, **kwargs):
3104 """
3105 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3106
3107 Converts a color in RGB color space to HSV color space.
3108 """
3109 return _core_.Image_RGBtoHSV(*args, **kwargs)
3110
3111 def Image_HSVtoRGB(*args, **kwargs):
3112 """
3113 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3114
3115 Converts a color in HSV color space to RGB color space.
3116 """
3117 return _core_.Image_HSVtoRGB(*args, **kwargs)
3118
3119
3120 def _ImageFromBuffer(*args, **kwargs):
3121 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3122 return _core_._ImageFromBuffer(*args, **kwargs)
3123 def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3124 """
3125 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3126 parameter must be a Python object that implements the buffer interface,
3127 such as a string, array, etc. The dataBuffer object is expected to
3128 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3129 object can optionally be supplied for the image's alpha channel data, and
3130 it is expected to be width*height bytes long.
3131
3132 The wx.Image will be created with its data and alpha pointers initialized
3133 to the memory address pointed to by the buffer objects, thus saving the
3134 time needed to copy the image data from the buffer object to the wx.Image.
3135 While this has advantages, it also has the shoot-yourself-in-the-foot
3136 risks associated with sharing a C pointer between two objects.
3137
3138 To help alleviate the risk a reference to the data and alpha buffer
3139 objects are kept with the wx.Image, so that they won't get deleted until
3140 after the wx.Image is deleted. However please be aware that it is not
3141 guaranteed that an object won't move its memory buffer to a new location
3142 when it needs to resize its contents. If that happens then the wx.Image
3143 will end up referring to an invalid memory location and could cause the
3144 application to crash. Therefore care should be taken to not manipulate
3145 the objects used for the data and alpha buffers in a way that would cause
3146 them to change size.
3147 """
3148 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3149 image._buffer = dataBuffer
3150 image._alpha = alphaBuffer
3151 return image
3152
3153 def InitAllImageHandlers():
3154 """
3155 The former functionality of InitAllImageHanders is now done internal to
3156 the _core_ extension module and so this function has become a simple NOP.
3157 """
3158 pass
3159
3160 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3161 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3162 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3163 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3164 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3165 BMP_24BPP = _core_.BMP_24BPP
3166 BMP_8BPP = _core_.BMP_8BPP
3167 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3168 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3169 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3170 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3171 BMP_4BPP = _core_.BMP_4BPP
3172 BMP_1BPP = _core_.BMP_1BPP
3173 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3174 class BMPHandler(ImageHandler):
3175 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3176 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3177 __repr__ = _swig_repr
3178 def __init__(self, *args, **kwargs):
3179 """
3180 __init__(self) -> BMPHandler
3181
3182 A `wx.ImageHandler` for \*.bmp bitmap files.
3183 """
3184 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3185 _core_.BMPHandler_swigregister(BMPHandler)
3186 NullImage = cvar.NullImage
3187 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3188 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3189 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3190 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3191 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3192 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3193 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3194 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3195 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3196 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3197 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3198 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3199 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3200 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3201 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3202
3203 class ICOHandler(BMPHandler):
3204 """A `wx.ImageHandler` for \*.ico icon files."""
3205 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3206 __repr__ = _swig_repr
3207 def __init__(self, *args, **kwargs):
3208 """
3209 __init__(self) -> ICOHandler
3210
3211 A `wx.ImageHandler` for \*.ico icon files.
3212 """
3213 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3214 _core_.ICOHandler_swigregister(ICOHandler)
3215
3216 class CURHandler(ICOHandler):
3217 """A `wx.ImageHandler` for \*.cur cursor files."""
3218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3219 __repr__ = _swig_repr
3220 def __init__(self, *args, **kwargs):
3221 """
3222 __init__(self) -> CURHandler
3223
3224 A `wx.ImageHandler` for \*.cur cursor files.
3225 """
3226 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3227 _core_.CURHandler_swigregister(CURHandler)
3228
3229 class ANIHandler(CURHandler):
3230 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3231 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3232 __repr__ = _swig_repr
3233 def __init__(self, *args, **kwargs):
3234 """
3235 __init__(self) -> ANIHandler
3236
3237 A `wx.ImageHandler` for \*.ani animated cursor files.
3238 """
3239 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3240 _core_.ANIHandler_swigregister(ANIHandler)
3241
3242 class PNGHandler(ImageHandler):
3243 """A `wx.ImageHandler` for PNG image files."""
3244 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3245 __repr__ = _swig_repr
3246 def __init__(self, *args, **kwargs):
3247 """
3248 __init__(self) -> PNGHandler
3249
3250 A `wx.ImageHandler` for PNG image files.
3251 """
3252 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3253 _core_.PNGHandler_swigregister(PNGHandler)
3254
3255 class GIFHandler(ImageHandler):
3256 """A `wx.ImageHandler` for GIF image files."""
3257 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3258 __repr__ = _swig_repr
3259 def __init__(self, *args, **kwargs):
3260 """
3261 __init__(self) -> GIFHandler
3262
3263 A `wx.ImageHandler` for GIF image files.
3264 """
3265 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3266 _core_.GIFHandler_swigregister(GIFHandler)
3267
3268 class PCXHandler(ImageHandler):
3269 """A `wx.ImageHandler` for PCX imager files."""
3270 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3271 __repr__ = _swig_repr
3272 def __init__(self, *args, **kwargs):
3273 """
3274 __init__(self) -> PCXHandler
3275
3276 A `wx.ImageHandler` for PCX imager files.
3277 """
3278 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3279 _core_.PCXHandler_swigregister(PCXHandler)
3280
3281 class JPEGHandler(ImageHandler):
3282 """A `wx.ImageHandler` for JPEG/JPG image files."""
3283 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3284 __repr__ = _swig_repr
3285 def __init__(self, *args, **kwargs):
3286 """
3287 __init__(self) -> JPEGHandler
3288
3289 A `wx.ImageHandler` for JPEG/JPG image files.
3290 """
3291 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3292 _core_.JPEGHandler_swigregister(JPEGHandler)
3293
3294 class PNMHandler(ImageHandler):
3295 """A `wx.ImageHandler` for PNM image files."""
3296 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3297 __repr__ = _swig_repr
3298 def __init__(self, *args, **kwargs):
3299 """
3300 __init__(self) -> PNMHandler
3301
3302 A `wx.ImageHandler` for PNM image files.
3303 """
3304 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3305 _core_.PNMHandler_swigregister(PNMHandler)
3306
3307 class XPMHandler(ImageHandler):
3308 """A `wx.ImageHandler` for XPM image."""
3309 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3310 __repr__ = _swig_repr
3311 def __init__(self, *args, **kwargs):
3312 """
3313 __init__(self) -> XPMHandler
3314
3315 A `wx.ImageHandler` for XPM image.
3316 """
3317 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3318 _core_.XPMHandler_swigregister(XPMHandler)
3319
3320 class TIFFHandler(ImageHandler):
3321 """A `wx.ImageHandler` for TIFF image files."""
3322 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3323 __repr__ = _swig_repr
3324 def __init__(self, *args, **kwargs):
3325 """
3326 __init__(self) -> TIFFHandler
3327
3328 A `wx.ImageHandler` for TIFF image files.
3329 """
3330 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3331 _core_.TIFFHandler_swigregister(TIFFHandler)
3332
3333 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3334 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3335 class Quantize(object):
3336 """Performs quantization, or colour reduction, on a wxImage."""
3337 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3338 def __init__(self): raise AttributeError, "No constructor defined"
3339 __repr__ = _swig_repr
3340 def Quantize(*args, **kwargs):
3341 """
3342 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3343
3344 Reduce the colours in the source image and put the result into the
3345 destination image, setting the palette in the destination if
3346 needed. Both images may be the same, to overwrite the source image.
3347 """
3348 return _core_.Quantize_Quantize(*args, **kwargs)
3349
3350 Quantize = staticmethod(Quantize)
3351 _core_.Quantize_swigregister(Quantize)
3352
3353 def Quantize_Quantize(*args, **kwargs):
3354 """
3355 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3356
3357 Reduce the colours in the source image and put the result into the
3358 destination image, setting the palette in the destination if
3359 needed. Both images may be the same, to overwrite the source image.
3360 """
3361 return _core_.Quantize_Quantize(*args, **kwargs)
3362
3363 #---------------------------------------------------------------------------
3364
3365 class EvtHandler(Object):
3366 """Proxy of C++ EvtHandler class"""
3367 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3368 __repr__ = _swig_repr
3369 def __init__(self, *args, **kwargs):
3370 """__init__(self) -> EvtHandler"""
3371 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3372 def GetNextHandler(*args, **kwargs):
3373 """GetNextHandler(self) -> EvtHandler"""
3374 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3375
3376 def GetPreviousHandler(*args, **kwargs):
3377 """GetPreviousHandler(self) -> EvtHandler"""
3378 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3379
3380 def SetNextHandler(*args, **kwargs):
3381 """SetNextHandler(self, EvtHandler handler)"""
3382 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3383
3384 def SetPreviousHandler(*args, **kwargs):
3385 """SetPreviousHandler(self, EvtHandler handler)"""
3386 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3387
3388 def GetEvtHandlerEnabled(*args, **kwargs):
3389 """GetEvtHandlerEnabled(self) -> bool"""
3390 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3391
3392 def SetEvtHandlerEnabled(*args, **kwargs):
3393 """SetEvtHandlerEnabled(self, bool enabled)"""
3394 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3395
3396 def ProcessEvent(*args, **kwargs):
3397 """ProcessEvent(self, Event event) -> bool"""
3398 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3399
3400 def AddPendingEvent(*args, **kwargs):
3401 """AddPendingEvent(self, Event event)"""
3402 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3403
3404 def ProcessPendingEvents(*args, **kwargs):
3405 """ProcessPendingEvents(self)"""
3406 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3407
3408 def Connect(*args, **kwargs):
3409 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3410 return _core_.EvtHandler_Connect(*args, **kwargs)
3411
3412 def Disconnect(*args, **kwargs):
3413 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3414 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3415
3416 def _setOORInfo(*args, **kwargs):
3417 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3418 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3419 args[0].thisown = 0
3420 return val
3421
3422 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3423 """
3424 Bind an event to an event handler.
3425
3426 :param event: One of the EVT_* objects that specifies the
3427 type of event to bind,
3428
3429 :param handler: A callable object to be invoked when the
3430 event is delivered to self. Pass None to
3431 disconnect an event handler.
3432
3433 :param source: Sometimes the event originates from a
3434 different window than self, but you still
3435 want to catch it in self. (For example, a
3436 button event delivered to a frame.) By
3437 passing the source of the event, the event
3438 handling system is able to differentiate
3439 between the same event type from different
3440 controls.
3441
3442 :param id: Used to spcify the event source by ID instead
3443 of instance.
3444
3445 :param id2: Used when it is desirable to bind a handler
3446 to a range of IDs, such as with EVT_MENU_RANGE.
3447 """
3448 if source is not None:
3449 id = source.GetId()
3450 event.Bind(self, id, id2, handler)
3451
3452 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3453 """
3454 Disconencts the event handler binding for event from self.
3455 Returns True if successful.
3456 """
3457 if source is not None:
3458 id = source.GetId()
3459 return event.Unbind(self, id, id2)
3460
3461 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3462 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3463 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3464 _core_.EvtHandler_swigregister(EvtHandler)
3465
3466 #---------------------------------------------------------------------------
3467
3468 class PyEventBinder(object):
3469 """
3470 Instances of this class are used to bind specific events to event
3471 handlers.
3472 """
3473 def __init__(self, evtType, expectedIDs=0):
3474 if expectedIDs not in [0, 1, 2]:
3475 raise ValueError, "Invalid number of expectedIDs"
3476 self.expectedIDs = expectedIDs
3477
3478 if type(evtType) == list or type(evtType) == tuple:
3479 self.evtType = evtType
3480 else:
3481 self.evtType = [evtType]
3482
3483
3484 def Bind(self, target, id1, id2, function):
3485 """Bind this set of event types to target."""
3486 for et in self.evtType:
3487 target.Connect(id1, id2, et, function)
3488
3489
3490 def Unbind(self, target, id1, id2):
3491 """Remove an event binding."""
3492 success = 0
3493 for et in self.evtType:
3494 success += target.Disconnect(id1, id2, et)
3495 return success != 0
3496
3497
3498 def __call__(self, *args):
3499 """
3500 For backwards compatibility with the old EVT_* functions.
3501 Should be called with either (window, func), (window, ID,
3502 func) or (window, ID1, ID2, func) parameters depending on the
3503 type of the event.
3504 """
3505 assert len(args) == 2 + self.expectedIDs
3506 id1 = wx.ID_ANY
3507 id2 = wx.ID_ANY
3508 target = args[0]
3509 if self.expectedIDs == 0:
3510 func = args[1]
3511 elif self.expectedIDs == 1:
3512 id1 = args[1]
3513 func = args[2]
3514 elif self.expectedIDs == 2:
3515 id1 = args[1]
3516 id2 = args[2]
3517 func = args[3]
3518 else:
3519 raise ValueError, "Unexpected number of IDs"
3520
3521 self.Bind(target, id1, id2, func)
3522
3523
3524 # These two are square pegs that don't fit the PyEventBinder hole...
3525 def EVT_COMMAND(win, id, cmd, func):
3526 win.Connect(id, -1, cmd, func)
3527 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3528 win.Connect(id1, id2, cmd, func)
3529
3530
3531 #---------------------------------------------------------------------------
3532
3533 #---------------------------------------------------------------------------
3534
3535 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3536 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3537
3538 def NewEventType(*args):
3539 """NewEventType() -> EventType"""
3540 return _core_.NewEventType(*args)
3541 wxEVT_NULL = _core_.wxEVT_NULL
3542 wxEVT_FIRST = _core_.wxEVT_FIRST
3543 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3544 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3545 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3546 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3547 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3548 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3549 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3550 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3551 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3552 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3553 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3554 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3555 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3556 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3557 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3558 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3559 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3560 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3561 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3562 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3563 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3564 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3565 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3566 wxEVT_MOTION = _core_.wxEVT_MOTION
3567 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3568 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3569 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3570 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3571 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3572 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3573 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3574 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3575 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3576 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3577 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3578 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3579 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3580 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3581 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3582 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3583 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3584 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3585 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3586 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3587 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3588 wxEVT_CHAR = _core_.wxEVT_CHAR
3589 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3590 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3591 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3592 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3593 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3594 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3595 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3596 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3597 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3598 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3599 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3600 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3601 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3602 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3603 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3604 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3605 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3606 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3607 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3608 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3609 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3610 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3611 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3612 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3613 wxEVT_SIZE = _core_.wxEVT_SIZE
3614 wxEVT_MOVE = _core_.wxEVT_MOVE
3615 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3616 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3617 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3618 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3619 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3620 wxEVT_CREATE = _core_.wxEVT_CREATE
3621 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3622 wxEVT_SHOW = _core_.wxEVT_SHOW
3623 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3624 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3625 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3626 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3627 wxEVT_PAINT = _core_.wxEVT_PAINT
3628 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3629 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3630 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3631 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3632 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3633 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3634 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3635 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3636 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3637 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3638 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3639 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3640 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3641 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3642 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3643 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3644 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3645 wxEVT_IDLE = _core_.wxEVT_IDLE
3646 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3647 wxEVT_SIZING = _core_.wxEVT_SIZING
3648 wxEVT_MOVING = _core_.wxEVT_MOVING
3649 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
3650 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3651 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3652 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
3653 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3654 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3655 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3656 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3657 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3658 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3659 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3660 #
3661 # Create some event binders
3662 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3663 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3664 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3665 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3666 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3667 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3668 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3669 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3670 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3671 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3672 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3673 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3674 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3675 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3676 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3677 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3678 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3679 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3680 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3681 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3682 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3683 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3684 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3685 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3686 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
3687 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3688 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3689 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3690 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3691 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3692 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3693 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3694 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3695 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3696 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3697 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3698 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3699 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3700 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3701 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3702 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3703 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
3704
3705 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3706 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3707 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3708 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3709 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3710 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3711 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3712 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3713 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3714 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3715 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3716 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3717 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3718
3719 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3720 wxEVT_LEFT_UP,
3721 wxEVT_MIDDLE_DOWN,
3722 wxEVT_MIDDLE_UP,
3723 wxEVT_RIGHT_DOWN,
3724 wxEVT_RIGHT_UP,
3725 wxEVT_MOTION,
3726 wxEVT_LEFT_DCLICK,
3727 wxEVT_MIDDLE_DCLICK,
3728 wxEVT_RIGHT_DCLICK,
3729 wxEVT_ENTER_WINDOW,
3730 wxEVT_LEAVE_WINDOW,
3731 wxEVT_MOUSEWHEEL
3732 ])
3733
3734
3735 # Scrolling from wxWindow (sent to wxScrolledWindow)
3736 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3737 wxEVT_SCROLLWIN_BOTTOM,
3738 wxEVT_SCROLLWIN_LINEUP,
3739 wxEVT_SCROLLWIN_LINEDOWN,
3740 wxEVT_SCROLLWIN_PAGEUP,
3741 wxEVT_SCROLLWIN_PAGEDOWN,
3742 wxEVT_SCROLLWIN_THUMBTRACK,
3743 wxEVT_SCROLLWIN_THUMBRELEASE,
3744 ])
3745
3746 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3747 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3748 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3749 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3750 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3751 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3752 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3753 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3754
3755 # Scrolling from wx.Slider and wx.ScrollBar
3756 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3757 wxEVT_SCROLL_BOTTOM,
3758 wxEVT_SCROLL_LINEUP,
3759 wxEVT_SCROLL_LINEDOWN,
3760 wxEVT_SCROLL_PAGEUP,
3761 wxEVT_SCROLL_PAGEDOWN,
3762 wxEVT_SCROLL_THUMBTRACK,
3763 wxEVT_SCROLL_THUMBRELEASE,
3764 wxEVT_SCROLL_CHANGED,
3765 ])
3766
3767 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3768 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3769 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3770 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3771 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3772 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3773 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3774 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3775 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3776 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3777
3778 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3779 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3780 wxEVT_SCROLL_BOTTOM,
3781 wxEVT_SCROLL_LINEUP,
3782 wxEVT_SCROLL_LINEDOWN,
3783 wxEVT_SCROLL_PAGEUP,
3784 wxEVT_SCROLL_PAGEDOWN,
3785 wxEVT_SCROLL_THUMBTRACK,
3786 wxEVT_SCROLL_THUMBRELEASE,
3787 wxEVT_SCROLL_CHANGED,
3788 ], 1)
3789
3790 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3791 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3792 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3793 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3794 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3795 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3796 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3797 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3798 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3799 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
3800
3801 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3802 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3803 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3804 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3805 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3806 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3807 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3808 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3809 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3810 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3811
3812 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3813 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3814 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3815 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3816 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3817 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3818 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3819 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3820 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3821
3822
3823 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3824 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3825 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3826 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3827 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3828 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3829 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3830
3831 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3832
3833 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3834 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3835
3836 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3837
3838 EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3839 EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3840 EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
3841
3842
3843 #---------------------------------------------------------------------------
3844
3845 class Event(Object):
3846 """
3847 An event is a structure holding information about an event passed to a
3848 callback or member function. wx.Event is an abstract base class for
3849 other event classes
3850 """
3851 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3852 def __init__(self): raise AttributeError, "No constructor defined"
3853 __repr__ = _swig_repr
3854 __swig_destroy__ = _core_.delete_Event
3855 __del__ = lambda self : None;
3856 def SetEventType(*args, **kwargs):
3857 """
3858 SetEventType(self, EventType typ)
3859
3860 Sets the specific type of the event.
3861 """
3862 return _core_.Event_SetEventType(*args, **kwargs)
3863
3864 def GetEventType(*args, **kwargs):
3865 """
3866 GetEventType(self) -> EventType
3867
3868 Returns the identifier of the given event type, such as
3869 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3870 """
3871 return _core_.Event_GetEventType(*args, **kwargs)
3872
3873 def GetEventObject(*args, **kwargs):
3874 """
3875 GetEventObject(self) -> Object
3876
3877 Returns the object (usually a window) associated with the event, if
3878 any.
3879 """
3880 return _core_.Event_GetEventObject(*args, **kwargs)
3881
3882 def SetEventObject(*args, **kwargs):
3883 """
3884 SetEventObject(self, Object obj)
3885
3886 Sets the originating object, or in other words, obj is normally the
3887 object that is sending the event.
3888 """
3889 return _core_.Event_SetEventObject(*args, **kwargs)
3890
3891 def GetTimestamp(*args, **kwargs):
3892 """GetTimestamp(self) -> long"""
3893 return _core_.Event_GetTimestamp(*args, **kwargs)
3894
3895 def SetTimestamp(*args, **kwargs):
3896 """SetTimestamp(self, long ts=0)"""
3897 return _core_.Event_SetTimestamp(*args, **kwargs)
3898
3899 def GetId(*args, **kwargs):
3900 """
3901 GetId(self) -> int
3902
3903 Returns the identifier associated with this event, such as a button
3904 command id.
3905 """
3906 return _core_.Event_GetId(*args, **kwargs)
3907
3908 def SetId(*args, **kwargs):
3909 """
3910 SetId(self, int Id)
3911
3912 Set's the ID for the event. This is usually the ID of the window that
3913 is sending the event, but it can also be a command id from a menu
3914 item, etc.
3915 """
3916 return _core_.Event_SetId(*args, **kwargs)
3917
3918 def IsCommandEvent(*args, **kwargs):
3919 """
3920 IsCommandEvent(self) -> bool
3921
3922 Returns true if the event is or is derived from `wx.CommandEvent` else
3923 it returns false. Note: Exists only for optimization purposes.
3924 """
3925 return _core_.Event_IsCommandEvent(*args, **kwargs)
3926
3927 def Skip(*args, **kwargs):
3928 """
3929 Skip(self, bool skip=True)
3930
3931 Called by an event handler, it controls whether additional event
3932 handlers bound to this event will be called after the current event
3933 handler returns. Skip(false) (the default setting) will prevent
3934 additional event handlers from being called and control will be
3935 returned to the sender of the event immediately after the current
3936 handler has finished. Skip(True) will cause the event processing
3937 system to continue searching for a handler function for this event.
3938
3939 """
3940 return _core_.Event_Skip(*args, **kwargs)
3941
3942 def GetSkipped(*args, **kwargs):
3943 """
3944 GetSkipped(self) -> bool
3945
3946 Returns true if the event handler should be skipped, false otherwise.
3947 :see: `Skip`
3948 """
3949 return _core_.Event_GetSkipped(*args, **kwargs)
3950
3951 def ShouldPropagate(*args, **kwargs):
3952 """
3953 ShouldPropagate(self) -> bool
3954
3955 Test if this event should be propagated to the parent window or not,
3956 i.e. if the propagation level is currently greater than 0.
3957 """
3958 return _core_.Event_ShouldPropagate(*args, **kwargs)
3959
3960 def StopPropagation(*args, **kwargs):
3961 """
3962 StopPropagation(self) -> int
3963
3964 Stop the event from propagating to its parent window. Returns the old
3965 propagation level value which may be later passed to
3966 `ResumePropagation` to allow propagating the event again.
3967 """
3968 return _core_.Event_StopPropagation(*args, **kwargs)
3969
3970 def ResumePropagation(*args, **kwargs):
3971 """
3972 ResumePropagation(self, int propagationLevel)
3973
3974 Resume the event propagation by restoring the propagation level. (For
3975 example, you can use the value returned by an earlier call to
3976 `StopPropagation`.)
3977
3978 """
3979 return _core_.Event_ResumePropagation(*args, **kwargs)
3980
3981 def Clone(*args, **kwargs):
3982 """Clone(self) -> Event"""
3983 return _core_.Event_Clone(*args, **kwargs)
3984
3985 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
3986 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
3987 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
3988 Skipped = property(GetSkipped,doc="See `GetSkipped`")
3989 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
3990 _core_.Event_swigregister(Event)
3991
3992 #---------------------------------------------------------------------------
3993
3994 class PropagationDisabler(object):
3995 """
3996 Helper class to temporarily change an event not to propagate. Simply
3997 create an instance of this class and then whe it is destroyed the
3998 propogation of the event will be restored.
3999 """
4000 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4001 __repr__ = _swig_repr
4002 def __init__(self, *args, **kwargs):
4003 """
4004 __init__(self, Event event) -> PropagationDisabler
4005
4006 Helper class to temporarily change an event not to propagate. Simply
4007 create an instance of this class and then whe it is destroyed the
4008 propogation of the event will be restored.
4009 """
4010 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4011 __swig_destroy__ = _core_.delete_PropagationDisabler
4012 __del__ = lambda self : None;
4013 _core_.PropagationDisabler_swigregister(PropagationDisabler)
4014
4015 class PropagateOnce(object):
4016 """
4017 A helper class that will temporarily lower propagation level of an
4018 event. Simply create an instance of this class and then whe it is
4019 destroyed the propogation of the event will be restored.
4020 """
4021 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4022 __repr__ = _swig_repr
4023 def __init__(self, *args, **kwargs):
4024 """
4025 __init__(self, Event event) -> PropagateOnce
4026
4027 A helper class that will temporarily lower propagation level of an
4028 event. Simply create an instance of this class and then whe it is
4029 destroyed the propogation of the event will be restored.
4030 """
4031 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4032 __swig_destroy__ = _core_.delete_PropagateOnce
4033 __del__ = lambda self : None;
4034 _core_.PropagateOnce_swigregister(PropagateOnce)
4035
4036 #---------------------------------------------------------------------------
4037
4038 class CommandEvent(Event):
4039 """
4040 This event class contains information about command events, which
4041 originate from a variety of simple controls, as well as menus and
4042 toolbars.
4043 """
4044 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4045 __repr__ = _swig_repr
4046 def __init__(self, *args, **kwargs):
4047 """
4048 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4049
4050 This event class contains information about command events, which
4051 originate from a variety of simple controls, as well as menus and
4052 toolbars.
4053 """
4054 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4055 def GetSelection(*args, **kwargs):
4056 """
4057 GetSelection(self) -> int
4058
4059 Returns item index for a listbox or choice selection event (not valid
4060 for a deselection).
4061 """
4062 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4063
4064 def SetString(*args, **kwargs):
4065 """SetString(self, String s)"""
4066 return _core_.CommandEvent_SetString(*args, **kwargs)
4067
4068 def GetString(*args, **kwargs):
4069 """
4070 GetString(self) -> String
4071
4072 Returns item string for a listbox or choice selection event (not valid
4073 for a deselection).
4074 """
4075 return _core_.CommandEvent_GetString(*args, **kwargs)
4076
4077 def IsChecked(*args, **kwargs):
4078 """
4079 IsChecked(self) -> bool
4080
4081 This method can be used with checkbox and menu events: for the
4082 checkboxes, the method returns true for a selection event and false
4083 for a deselection one. For the menu events, this method indicates if
4084 the menu item just has become checked or unchecked (and thus only
4085 makes sense for checkable menu items).
4086 """
4087 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4088
4089 Checked = IsChecked
4090 def IsSelection(*args, **kwargs):
4091 """
4092 IsSelection(self) -> bool
4093
4094 For a listbox or similar event, returns true if it is a selection,
4095 false if it is a deselection.
4096 """
4097 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4098
4099 def SetExtraLong(*args, **kwargs):
4100 """SetExtraLong(self, long extraLong)"""
4101 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4102
4103 def GetExtraLong(*args, **kwargs):
4104 """
4105 GetExtraLong(self) -> long
4106
4107 Returns extra information dependant on the event objects type. If the
4108 event comes from a listbox selection, it is a boolean determining
4109 whether the event was a selection (true) or a deselection (false). A
4110 listbox deselection only occurs for multiple-selection boxes, and in
4111 this case the index and string values are indeterminate and the
4112 listbox must be examined by the application.
4113 """
4114 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4115
4116 def SetInt(*args, **kwargs):
4117 """SetInt(self, int i)"""
4118 return _core_.CommandEvent_SetInt(*args, **kwargs)
4119
4120 def GetInt(*args, **kwargs):
4121 """
4122 GetInt(self) -> int
4123
4124 Returns the integer identifier corresponding to a listbox, choice or
4125 radiobox selection (only if the event was a selection, not a
4126 deselection), or a boolean value representing the value of a checkbox.
4127 """
4128 return _core_.CommandEvent_GetInt(*args, **kwargs)
4129
4130 def GetClientData(*args, **kwargs):
4131 """
4132 GetClientData(self) -> PyObject
4133
4134 Returns the client data object for a listbox or choice selection event, (if any.)
4135 """
4136 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4137
4138 def SetClientData(*args, **kwargs):
4139 """
4140 SetClientData(self, PyObject clientData)
4141
4142 Associate the given client data with the item at position n.
4143 """
4144 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4145
4146 GetClientObject = GetClientData
4147 SetClientObject = SetClientData
4148
4149 def Clone(*args, **kwargs):
4150 """Clone(self) -> Event"""
4151 return _core_.CommandEvent_Clone(*args, **kwargs)
4152
4153 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4154 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4155 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4156 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4157 Selection = property(GetSelection,doc="See `GetSelection`")
4158 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4159 _core_.CommandEvent_swigregister(CommandEvent)
4160
4161 #---------------------------------------------------------------------------
4162
4163 class NotifyEvent(CommandEvent):
4164 """
4165 An instance of this class (or one of its derived classes) is sent from
4166 a control when the control's state is being changed and the control
4167 allows that change to be prevented from happening. The event handler
4168 can call `Veto` or `Allow` to tell the control what to do.
4169 """
4170 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4171 __repr__ = _swig_repr
4172 def __init__(self, *args, **kwargs):
4173 """
4174 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4175
4176 An instance of this class (or one of its derived classes) is sent from
4177 a control when the control's state is being changed and the control
4178 allows that change to be prevented from happening. The event handler
4179 can call `Veto` or `Allow` to tell the control what to do.
4180 """
4181 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4182 def Veto(*args, **kwargs):
4183 """
4184 Veto(self)
4185
4186 Prevents the change announced by this event from happening.
4187
4188 It is in general a good idea to notify the user about the reasons for
4189 vetoing the change because otherwise the applications behaviour (which
4190 just refuses to do what the user wants) might be quite surprising.
4191 """
4192 return _core_.NotifyEvent_Veto(*args, **kwargs)
4193
4194 def Allow(*args, **kwargs):
4195 """
4196 Allow(self)
4197
4198 This is the opposite of `Veto`: it explicitly allows the event to be
4199 processed. For most events it is not necessary to call this method as
4200 the events are allowed anyhow but some are forbidden by default (this
4201 will be mentioned in the corresponding event description).
4202 """
4203 return _core_.NotifyEvent_Allow(*args, **kwargs)
4204
4205 def IsAllowed(*args, **kwargs):
4206 """
4207 IsAllowed(self) -> bool
4208
4209 Returns true if the change is allowed (`Veto` hasn't been called) or
4210 false otherwise (if it was).
4211 """
4212 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4213
4214 _core_.NotifyEvent_swigregister(NotifyEvent)
4215
4216 #---------------------------------------------------------------------------
4217
4218 class ScrollEvent(CommandEvent):
4219 """
4220 A scroll event holds information about events sent from stand-alone
4221 scrollbars and sliders. Note that scrolled windows do not send
4222 instnaces of this event class, but send the `wx.ScrollWinEvent`
4223 instead.
4224 """
4225 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4226 __repr__ = _swig_repr
4227 def __init__(self, *args, **kwargs):
4228 """
4229 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4230 int orient=0) -> ScrollEvent
4231 """
4232 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4233 def GetOrientation(*args, **kwargs):
4234 """
4235 GetOrientation(self) -> int
4236
4237 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4238 the scrollbar.
4239 """
4240 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4241
4242 def GetPosition(*args, **kwargs):
4243 """
4244 GetPosition(self) -> int
4245
4246 Returns the position of the scrollbar.
4247 """
4248 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4249
4250 def SetOrientation(*args, **kwargs):
4251 """SetOrientation(self, int orient)"""
4252 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4253
4254 def SetPosition(*args, **kwargs):
4255 """SetPosition(self, int pos)"""
4256 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4257
4258 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4259 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4260 _core_.ScrollEvent_swigregister(ScrollEvent)
4261
4262 #---------------------------------------------------------------------------
4263
4264 class ScrollWinEvent(Event):
4265 """
4266 A wx.ScrollWinEvent holds information about scrolling and is sent from
4267 scrolling windows.
4268 """
4269 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4270 __repr__ = _swig_repr
4271 def __init__(self, *args, **kwargs):
4272 """
4273 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4274
4275 A wx.ScrollWinEvent holds information about scrolling and is sent from
4276 scrolling windows.
4277 """
4278 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4279 def GetOrientation(*args, **kwargs):
4280 """
4281 GetOrientation(self) -> int
4282
4283 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4284 the scrollbar.
4285 """
4286 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4287
4288 def GetPosition(*args, **kwargs):
4289 """
4290 GetPosition(self) -> int
4291
4292 Returns the position of the scrollbar for the thumb track and release
4293 events. Note that this field can't be used for the other events, you
4294 need to query the window itself for the current position in that case.
4295 """
4296 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4297
4298 def SetOrientation(*args, **kwargs):
4299 """SetOrientation(self, int orient)"""
4300 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4301
4302 def SetPosition(*args, **kwargs):
4303 """SetPosition(self, int pos)"""
4304 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4305
4306 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4307 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4308 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4309
4310 #---------------------------------------------------------------------------
4311
4312 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4313 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4314 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4315 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4316 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4317 class MouseEvent(Event):
4318 """
4319 This event class contains information about the events generated by
4320 the mouse: they include mouse buttons press and release events and
4321 mouse move events.
4322
4323 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4324 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4325 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4326 a middle button so a portable application should avoid relying on the
4327 events from it.
4328
4329 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4330 the former returns true when the event corresponds to the left mouse
4331 button click while the latter returns true if the left mouse button is
4332 currently being pressed. For example, when the user is dragging the
4333 mouse you can use `LeftIsDown` to test whether the left mouse button
4334 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4335 `LeftIsDown` will also return true in wxWidgets whatever the
4336 underlying GUI behaviour is (which is platform-dependent). The same
4337 applies, of course, to other mouse buttons as well.
4338 """
4339 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4340 __repr__ = _swig_repr
4341 def __init__(self, *args, **kwargs):
4342 """
4343 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4344
4345 Constructs a wx.MouseEvent. Valid event types are:
4346
4347 * wxEVT_ENTER_WINDOW
4348 * wxEVT_LEAVE_WINDOW
4349 * wxEVT_LEFT_DOWN
4350 * wxEVT_LEFT_UP
4351 * wxEVT_LEFT_DCLICK
4352 * wxEVT_MIDDLE_DOWN
4353 * wxEVT_MIDDLE_UP
4354 * wxEVT_MIDDLE_DCLICK
4355 * wxEVT_RIGHT_DOWN
4356 * wxEVT_RIGHT_UP
4357 * wxEVT_RIGHT_DCLICK
4358 * wxEVT_MOTION
4359 * wxEVT_MOUSEWHEEL
4360 """
4361 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4362 def IsButton(*args, **kwargs):
4363 """
4364 IsButton(self) -> bool
4365
4366 Returns true if the event was a mouse button event (not necessarily a
4367 button down event - that may be tested using `ButtonDown`).
4368 """
4369 return _core_.MouseEvent_IsButton(*args, **kwargs)
4370
4371 def ButtonDown(*args, **kwargs):
4372 """
4373 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4374
4375 If the argument is omitted, this returns true if the event was any
4376 mouse button down event. Otherwise the argument specifies which
4377 button-down event shold be checked for (see `Button` for the possible
4378 values).
4379 """
4380 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4381
4382 def ButtonDClick(*args, **kwargs):
4383 """
4384 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4385
4386 If the argument is omitted, this returns true if the event was any
4387 mouse double click event. Otherwise the argument specifies which
4388 double click event to check for (see `Button` for the possible
4389 values).
4390 """
4391 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4392
4393 def ButtonUp(*args, **kwargs):
4394 """
4395 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4396
4397 If the argument is omitted, this returns true if the event was any
4398 mouse button up event. Otherwise the argument specifies which button
4399 up event to check for (see `Button` for the possible values).
4400 """
4401 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4402
4403 def Button(*args, **kwargs):
4404 """
4405 Button(self, int button) -> bool
4406
4407 Returns true if the identified mouse button is changing state. Valid
4408 values of button are:
4409
4410 ==================== =====================================
4411 wx.MOUSE_BTN_LEFT check if left button was pressed
4412 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4413 wx.MOUSE_BTN_RIGHT check if right button was pressed
4414 wx.MOUSE_BTN_ANY check if any button was pressed
4415 ==================== =====================================
4416
4417 """
4418 return _core_.MouseEvent_Button(*args, **kwargs)
4419
4420 def ButtonIsDown(*args, **kwargs):
4421 """ButtonIsDown(self, int but) -> bool"""
4422 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4423
4424 def GetButton(*args, **kwargs):
4425 """
4426 GetButton(self) -> int
4427
4428 Returns the mouse button which generated this event or
4429 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4430 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4431 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4432 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4433 right buttons respectively.
4434 """
4435 return _core_.MouseEvent_GetButton(*args, **kwargs)
4436
4437 def ControlDown(*args, **kwargs):
4438 """
4439 ControlDown(self) -> bool
4440
4441 Returns true if the control key was down at the time of the event.
4442 """
4443 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4444
4445 def MetaDown(*args, **kwargs):
4446 """
4447 MetaDown(self) -> bool
4448
4449 Returns true if the Meta key was down at the time of the event.
4450 """
4451 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4452
4453 def AltDown(*args, **kwargs):
4454 """
4455 AltDown(self) -> bool
4456
4457 Returns true if the Alt key was down at the time of the event.
4458 """
4459 return _core_.MouseEvent_AltDown(*args, **kwargs)
4460
4461 def ShiftDown(*args, **kwargs):
4462 """
4463 ShiftDown(self) -> bool
4464
4465 Returns true if the Shift key was down at the time of the event.
4466 """
4467 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4468
4469 def CmdDown(*args, **kwargs):
4470 """
4471 CmdDown(self) -> bool
4472
4473 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4474 platforms but the special "Apple" (a.k.a as "Command") key on
4475 Macs. It often makes sense to use it instead of, say, `ControlDown`
4476 because Cmd key is used for the same thing under Mac as Ctrl
4477 elsewhere. The Ctrl key still exists, it's just not used for this
4478 purpose. So for non-Mac platforms this is the same as `ControlDown`
4479 and Macs this is the same as `MetaDown`.
4480 """
4481 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4482
4483 def LeftDown(*args, **kwargs):
4484 """
4485 LeftDown(self) -> bool
4486
4487 Returns true if the left mouse button state changed to down.
4488 """
4489 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4490
4491 def MiddleDown(*args, **kwargs):
4492 """
4493 MiddleDown(self) -> bool
4494
4495 Returns true if the middle mouse button state changed to down.
4496 """
4497 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4498
4499 def RightDown(*args, **kwargs):
4500 """
4501 RightDown(self) -> bool
4502
4503 Returns true if the right mouse button state changed to down.
4504 """
4505 return _core_.MouseEvent_RightDown(*args, **kwargs)
4506
4507 def LeftUp(*args, **kwargs):
4508 """
4509 LeftUp(self) -> bool
4510
4511 Returns true if the left mouse button state changed to up.
4512 """
4513 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4514
4515 def MiddleUp(*args, **kwargs):
4516 """
4517 MiddleUp(self) -> bool
4518
4519 Returns true if the middle mouse button state changed to up.
4520 """
4521 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4522
4523 def RightUp(*args, **kwargs):
4524 """
4525 RightUp(self) -> bool
4526
4527 Returns true if the right mouse button state changed to up.
4528 """
4529 return _core_.MouseEvent_RightUp(*args, **kwargs)
4530
4531 def LeftDClick(*args, **kwargs):
4532 """
4533 LeftDClick(self) -> bool
4534
4535 Returns true if the event was a left button double click.
4536 """
4537 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4538
4539 def MiddleDClick(*args, **kwargs):
4540 """
4541 MiddleDClick(self) -> bool
4542
4543 Returns true if the event was a middle button double click.
4544 """
4545 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4546
4547 def RightDClick(*args, **kwargs):
4548 """
4549 RightDClick(self) -> bool
4550
4551 Returns true if the event was a right button double click.
4552 """
4553 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4554
4555 def LeftIsDown(*args, **kwargs):
4556 """
4557 LeftIsDown(self) -> bool
4558
4559 Returns true if the left mouse button is currently down, independent
4560 of the current event type.
4561
4562 Please notice that it is not the same as LeftDown which returns true
4563 if the left mouse button was just pressed. Rather, it describes the
4564 state of the mouse button before the event happened.
4565
4566 This event is usually used in the mouse event handlers which process
4567 "move mouse" messages to determine whether the user is (still)
4568 dragging the mouse.
4569 """
4570 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4571
4572 def MiddleIsDown(*args, **kwargs):
4573 """
4574 MiddleIsDown(self) -> bool
4575
4576 Returns true if the middle mouse button is currently down, independent
4577 of the current event type.
4578 """
4579 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4580
4581 def RightIsDown(*args, **kwargs):
4582 """
4583 RightIsDown(self) -> bool
4584
4585 Returns true if the right mouse button is currently down, independent
4586 of the current event type.
4587 """
4588 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4589
4590 def Dragging(*args, **kwargs):
4591 """
4592 Dragging(self) -> bool
4593
4594 Returns true if this was a dragging event (motion while a button is
4595 depressed).
4596 """
4597 return _core_.MouseEvent_Dragging(*args, **kwargs)
4598
4599 def Moving(*args, **kwargs):
4600 """
4601 Moving(self) -> bool
4602
4603 Returns true if this was a motion event and no mouse buttons were
4604 pressed. If any mouse button is held pressed, then this method returns
4605 false and Dragging returns true.
4606 """
4607 return _core_.MouseEvent_Moving(*args, **kwargs)
4608
4609 def Entering(*args, **kwargs):
4610 """
4611 Entering(self) -> bool
4612
4613 Returns true if the mouse was entering the window.
4614 """
4615 return _core_.MouseEvent_Entering(*args, **kwargs)
4616
4617 def Leaving(*args, **kwargs):
4618 """
4619 Leaving(self) -> bool
4620
4621 Returns true if the mouse was leaving the window.
4622 """
4623 return _core_.MouseEvent_Leaving(*args, **kwargs)
4624
4625 def GetPosition(*args, **kwargs):
4626 """
4627 GetPosition(self) -> Point
4628
4629 Returns the pixel position of the mouse in window coordinates when the
4630 event happened.
4631 """
4632 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4633
4634 def GetPositionTuple(*args, **kwargs):
4635 """
4636 GetPositionTuple() -> (x,y)
4637
4638 Returns the pixel position of the mouse in window coordinates when the
4639 event happened.
4640 """
4641 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4642
4643 def GetLogicalPosition(*args, **kwargs):
4644 """
4645 GetLogicalPosition(self, DC dc) -> Point
4646
4647 Returns the logical mouse position in pixels (i.e. translated
4648 according to the translation set for the DC, which usually indicates
4649 that the window has been scrolled).
4650 """
4651 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4652
4653 def GetX(*args, **kwargs):
4654 """
4655 GetX(self) -> int
4656
4657 Returns X coordinate of the physical mouse event position.
4658 """
4659 return _core_.MouseEvent_GetX(*args, **kwargs)
4660
4661 def GetY(*args, **kwargs):
4662 """
4663 GetY(self) -> int
4664
4665 Returns Y coordinate of the physical mouse event position.
4666 """
4667 return _core_.MouseEvent_GetY(*args, **kwargs)
4668
4669 def GetWheelRotation(*args, **kwargs):
4670 """
4671 GetWheelRotation(self) -> int
4672
4673 Get wheel rotation, positive or negative indicates direction of
4674 rotation. Current devices all send an event when rotation is equal to
4675 +/-WheelDelta, but this allows for finer resolution devices to be
4676 created in the future. Because of this you shouldn't assume that one
4677 event is equal to 1 line or whatever, but you should be able to either
4678 do partial line scrolling or wait until +/-WheelDelta rotation values
4679 have been accumulated before scrolling.
4680 """
4681 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4682
4683 def GetWheelDelta(*args, **kwargs):
4684 """
4685 GetWheelDelta(self) -> int
4686
4687 Get wheel delta, normally 120. This is the threshold for action to be
4688 taken, and one such action (for example, scrolling one increment)
4689 should occur for each delta.
4690 """
4691 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4692
4693 def GetLinesPerAction(*args, **kwargs):
4694 """
4695 GetLinesPerAction(self) -> int
4696
4697 Returns the configured number of lines (or whatever) to be scrolled
4698 per wheel action. Defaults to three.
4699 """
4700 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4701
4702 def IsPageScroll(*args, **kwargs):
4703 """
4704 IsPageScroll(self) -> bool
4705
4706 Returns true if the system has been setup to do page scrolling with
4707 the mouse wheel instead of line scrolling.
4708 """
4709 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4710
4711 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4712 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4713 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4714 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4715 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4716 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4717 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4718 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4719 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4720 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4721 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4722 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4723 Button = property(GetButton,doc="See `GetButton`")
4724 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
4725 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
4726 Position = property(GetPosition,doc="See `GetPosition`")
4727 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
4728 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
4729 X = property(GetX,doc="See `GetX`")
4730 Y = property(GetY,doc="See `GetY`")
4731 _core_.MouseEvent_swigregister(MouseEvent)
4732
4733 #---------------------------------------------------------------------------
4734
4735 class SetCursorEvent(Event):
4736 """
4737 A SetCursorEvent is generated when the mouse cursor is about to be set
4738 as a result of mouse motion. This event gives the application the
4739 chance to perform specific mouse cursor processing based on the
4740 current position of the mouse within the window. Use the `SetCursor`
4741 method to specify the cursor you want to be displayed.
4742 """
4743 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4744 __repr__ = _swig_repr
4745 def __init__(self, *args, **kwargs):
4746 """
4747 __init__(self, int x=0, int y=0) -> SetCursorEvent
4748
4749 Construct a new `wx.SetCursorEvent`.
4750 """
4751 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
4752 def GetX(*args, **kwargs):
4753 """
4754 GetX(self) -> int
4755
4756 Returns the X coordinate of the mouse in client coordinates.
4757 """
4758 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4759
4760 def GetY(*args, **kwargs):
4761 """
4762 GetY(self) -> int
4763
4764 Returns the Y coordinate of the mouse in client coordinates.
4765 """
4766 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4767
4768 def SetCursor(*args, **kwargs):
4769 """
4770 SetCursor(self, Cursor cursor)
4771
4772 Sets the cursor associated with this event.
4773 """
4774 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4775
4776 def GetCursor(*args, **kwargs):
4777 """
4778 GetCursor(self) -> Cursor
4779
4780 Returns a reference to the cursor specified by this event.
4781 """
4782 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4783
4784 def HasCursor(*args, **kwargs):
4785 """
4786 HasCursor(self) -> bool
4787
4788 Returns true if the cursor specified by this event is a valid cursor.
4789 """
4790 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4791
4792 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
4793 X = property(GetX,doc="See `GetX`")
4794 Y = property(GetY,doc="See `GetY`")
4795 _core_.SetCursorEvent_swigregister(SetCursorEvent)
4796
4797 #---------------------------------------------------------------------------
4798
4799 class KeyEvent(Event):
4800 """
4801 This event class contains information about keypress and character
4802 events. These events are only sent to the widget that currently has
4803 the keyboard focus.
4804
4805 Notice that there are three different kinds of keyboard events in
4806 wxWidgets: key down and up events and char events. The difference
4807 between the first two is clear - the first corresponds to a key press
4808 and the second to a key release - otherwise they are identical. Just
4809 note that if the key is maintained in a pressed state you will
4810 typically get a lot of (automatically generated) down events but only
4811 one up so it is wrong to assume that there is one up event
4812 corresponding to each down one.
4813
4814 Both key events provide untranslated key codes while the char event
4815 carries the translated one. The untranslated code for alphanumeric
4816 keys is always an upper case value. For the other keys it is one of
4817 WXK_XXX values from the keycodes table. The translated key is, in
4818 general, the character the user expects to appear as the result of the
4819 key combination when typing the text into a text entry zone, for
4820 example.
4821
4822 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4823 and the standard US keyboard): when the 'A' key is pressed, the key
4824 down event key code is equal to ASCII A == 65. But the char event key
4825 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4826 'A' keys simultaneously , the key code in key down event will still be
4827 just 'A' while the char event key code parameter will now be 'A' as
4828 well.
4829
4830 Although in this simple case it is clear that the correct key code
4831 could be found in the key down event handler by checking the value
4832 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4833 as for non alphanumeric keys or non-US keyboard layouts the
4834 translation is keyboard-layout dependent and can only be done properly
4835 by the system itself.
4836
4837 Another kind of translation is done when the control key is pressed:
4838 for example, for CTRL-A key press the key down event still carries the
4839 same key code 'A' as usual but the char event will have key code of 1,
4840 the ASCII value of this key combination.
4841
4842 You may discover how the other keys on your system behave
4843 interactively by running the KeyEvents sample in the wxPython demo and
4844 pressing some keys while the blue box at the top has the keyboard
4845 focus.
4846
4847 **Note**: If a key down event is caught and the event handler does not
4848 call event.Skip() then the coresponding char event will not
4849 happen. This is by design and enables the programs that handle both
4850 types of events to be a bit simpler.
4851
4852 **Note for Windows programmers**: The key and char events in wxWidgets
4853 are similar to but slightly different from Windows WM_KEYDOWN and
4854 WM_CHAR events. In particular, Alt-x combination will generate a char
4855 event in wxWidgets (unless it is used as an accelerator).
4856
4857 **Tip**: be sure to call event.Skip() for events that you don't
4858 process in key event function, otherwise menu shortcuts may cease to
4859 work under Windows.
4860
4861 """
4862 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4863 __repr__ = _swig_repr
4864 def __init__(self, *args, **kwargs):
4865 """
4866 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4867
4868 Construct a new `wx.KeyEvent`. Valid event types are:
4869 *
4870 """
4871 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
4872 def GetModifiers(*args, **kwargs):
4873 """
4874 GetModifiers(self) -> int
4875
4876 Returns a bitmask of the current modifier settings. Can be used to
4877 check if the key event has exactly the given modifiers without having
4878 to explicitly check that the other modifiers are not down. For
4879 example::
4880
4881 if event.GetModifers() == wx.MOD_CONTROL:
4882 DoSomething()
4883
4884 """
4885 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4886
4887 def ControlDown(*args, **kwargs):
4888 """
4889 ControlDown(self) -> bool
4890
4891 Returns ``True`` if the Control key was down at the time of the event.
4892 """
4893 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4894
4895 def MetaDown(*args, **kwargs):
4896 """
4897 MetaDown(self) -> bool
4898
4899 Returns ``True`` if the Meta key was down at the time of the event.
4900 """
4901 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4902
4903 def AltDown(*args, **kwargs):
4904 """
4905 AltDown(self) -> bool
4906
4907 Returns ``True`` if the Alt key was down at the time of the event.
4908 """
4909 return _core_.KeyEvent_AltDown(*args, **kwargs)
4910
4911 def ShiftDown(*args, **kwargs):
4912 """
4913 ShiftDown(self) -> bool
4914
4915 Returns ``True`` if the Shift key was down at the time of the event.
4916 """
4917 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
4918
4919 def CmdDown(*args, **kwargs):
4920 """
4921 CmdDown(self) -> bool
4922
4923 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4924 platforms but the special "Apple" (a.k.a as "Command") key on
4925 Macs. It makes often sense to use it instead of, say, `ControlDown`
4926 because Cmd key is used for the same thing under Mac as Ctrl
4927 elsewhere. The Ctrl still exists, it's just not used for this
4928 purpose. So for non-Mac platforms this is the same as `ControlDown`
4929 and Macs this is the same as `MetaDown`.
4930 """
4931 return _core_.KeyEvent_CmdDown(*args, **kwargs)
4932
4933 def HasModifiers(*args, **kwargs):
4934 """
4935 HasModifiers(self) -> bool
4936
4937 Returns true if either CTRL or ALT keys was down at the time of the
4938 key event. Note that this function does not take into account neither
4939 SHIFT nor META key states (the reason for ignoring the latter is that
4940 it is common for NUMLOCK key to be configured as META under X but the
4941 key presses even while NUMLOCK is on should be still processed
4942 normally).
4943 """
4944 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
4945
4946 def GetKeyCode(*args, **kwargs):
4947 """
4948 GetKeyCode(self) -> int
4949
4950 Returns the virtual key code. ASCII events return normal ASCII values,
4951 while non-ASCII events return values such as WXK_LEFT for the left
4952 cursor key. See `wx.KeyEvent` for a full list of the virtual key
4953 codes.
4954
4955 Note that in Unicode build, the returned value is meaningful only if
4956 the user entered a character that can be represented in current
4957 locale's default charset. You can obtain the corresponding Unicode
4958 character using `GetUnicodeKey`.
4959 """
4960 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
4961
4962 def GetUnicodeKey(*args, **kwargs):
4963 """
4964 GetUnicodeKey(self) -> int
4965
4966 Returns the Unicode character corresponding to this key event. This
4967 function is only meaningfule in a Unicode build of wxPython.
4968 """
4969 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
4970
4971 GetUniChar = GetUnicodeKey
4972 def SetUnicodeKey(*args, **kwargs):
4973 """
4974 SetUnicodeKey(self, int uniChar)
4975
4976 Set the Unicode value of the key event, but only if this is a Unicode
4977 build of wxPython.
4978 """
4979 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
4980
4981 def GetRawKeyCode(*args, **kwargs):
4982 """
4983 GetRawKeyCode(self) -> unsigned int
4984
4985 Returns the raw key code for this event. This is a platform-dependent
4986 scan code which should only be used in advanced
4987 applications. Currently the raw key codes are not supported by all
4988 ports.
4989 """
4990 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
4991
4992 def GetRawKeyFlags(*args, **kwargs):
4993 """
4994 GetRawKeyFlags(self) -> unsigned int
4995
4996 Returns the low level key flags for this event. The flags are
4997 platform-dependent and should only be used in advanced applications.
4998 Currently the raw key flags are not supported by all ports.
4999 """
5000 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5001
5002 def GetPosition(*args, **kwargs):
5003 """
5004 GetPosition(self) -> Point
5005
5006 Find the position of the event, if applicable.
5007 """
5008 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5009
5010 def GetPositionTuple(*args, **kwargs):
5011 """
5012 GetPositionTuple() -> (x,y)
5013
5014 Find the position of the event, if applicable.
5015 """
5016 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5017
5018 def GetX(*args, **kwargs):
5019 """
5020 GetX(self) -> int
5021
5022 Returns the X position (in client coordinates) of the event, if
5023 applicable.
5024 """
5025 return _core_.KeyEvent_GetX(*args, **kwargs)
5026
5027 def GetY(*args, **kwargs):
5028 """
5029 GetY(self) -> int
5030
5031 Returns the Y position (in client coordinates) of the event, if
5032 applicable.
5033 """
5034 return _core_.KeyEvent_GetY(*args, **kwargs)
5035
5036 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5037 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5038 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5039 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5040 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5041 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5042 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5043 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5044 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5045 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5046 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5047 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5048 Position = property(GetPosition,doc="See `GetPosition`")
5049 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5050 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5051 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5052 X = property(GetX,doc="See `GetX`")
5053 Y = property(GetY,doc="See `GetY`")
5054 _core_.KeyEvent_swigregister(KeyEvent)
5055
5056 #---------------------------------------------------------------------------
5057
5058 class SizeEvent(Event):
5059 """
5060 A size event holds information about size change events. The EVT_SIZE
5061 handler function will be called when the window it is bound to has
5062 been resized.
5063
5064 Note that the size passed is of the whole window: call
5065 `wx.Window.GetClientSize` for the area which may be used by the
5066 application.
5067
5068 When a window is resized, usually only a small part of the window is
5069 damaged and and that area is all that is in the update region for the
5070 next paint event. However, if your drawing depends on the size of the
5071 window, you may need to clear the DC explicitly and repaint the whole
5072 window. In which case, you may need to call `wx.Window.Refresh` to
5073 invalidate the entire window.
5074
5075 """
5076 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5077 __repr__ = _swig_repr
5078 def __init__(self, *args, **kwargs):
5079 """
5080 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5081
5082 Construct a new ``wx.SizeEvent``.
5083 """
5084 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5085 def GetSize(*args, **kwargs):
5086 """
5087 GetSize(self) -> Size
5088
5089 Returns the entire size of the window generating the size change
5090 event.
5091 """
5092 return _core_.SizeEvent_GetSize(*args, **kwargs)
5093
5094 def GetRect(*args, **kwargs):
5095 """GetRect(self) -> Rect"""
5096 return _core_.SizeEvent_GetRect(*args, **kwargs)
5097
5098 def SetRect(*args, **kwargs):
5099 """SetRect(self, Rect rect)"""
5100 return _core_.SizeEvent_SetRect(*args, **kwargs)
5101
5102 def SetSize(*args, **kwargs):
5103 """SetSize(self, Size size)"""
5104 return _core_.SizeEvent_SetSize(*args, **kwargs)
5105
5106 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5107 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5108 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5109 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5110 _core_.SizeEvent_swigregister(SizeEvent)
5111
5112 #---------------------------------------------------------------------------
5113
5114 class MoveEvent(Event):
5115 """
5116 This event object is sent for EVT_MOVE event bindings when a window is
5117 moved to a new position.
5118 """
5119 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5120 __repr__ = _swig_repr
5121 def __init__(self, *args, **kwargs):
5122 """
5123 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5124
5125 Constructor.
5126 """
5127 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5128 def GetPosition(*args, **kwargs):
5129 """
5130 GetPosition(self) -> Point
5131
5132 Returns the position of the window generating the move change event.
5133 """
5134 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5135
5136 def GetRect(*args, **kwargs):
5137 """GetRect(self) -> Rect"""
5138 return _core_.MoveEvent_GetRect(*args, **kwargs)
5139
5140 def SetRect(*args, **kwargs):
5141 """SetRect(self, Rect rect)"""
5142 return _core_.MoveEvent_SetRect(*args, **kwargs)
5143
5144 def SetPosition(*args, **kwargs):
5145 """SetPosition(self, Point pos)"""
5146 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5147
5148 m_pos = property(GetPosition, SetPosition)
5149 m_rect = property(GetRect, SetRect)
5150
5151 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5152 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5153 _core_.MoveEvent_swigregister(MoveEvent)
5154
5155 #---------------------------------------------------------------------------
5156
5157 class PaintEvent(Event):
5158 """
5159 A paint event is sent when a window's contents needs to be repainted.
5160 Note that in an EVT_PAINT handler the application must *always* create
5161 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5162 Windows assumes that the window has not been painted yet and will send
5163 the event again, causing endless refreshes.
5164
5165 You can optimize painting by retrieving the rectangles that have been
5166 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5167 and only repainting these rectangles. The rectangles are in terms of
5168 the client area, and are unscrolled, so you will need to do some
5169 calculations using the current view position to obtain logical,
5170 scrolled units.
5171
5172 """
5173 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5174 __repr__ = _swig_repr
5175 def __init__(self, *args, **kwargs):
5176 """__init__(self, int Id=0) -> PaintEvent"""
5177 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5178 _core_.PaintEvent_swigregister(PaintEvent)
5179
5180 class NcPaintEvent(Event):
5181 """Proxy of C++ NcPaintEvent class"""
5182 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5183 __repr__ = _swig_repr
5184 def __init__(self, *args, **kwargs):
5185 """__init__(self, int winid=0) -> NcPaintEvent"""
5186 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5187 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5188
5189 #---------------------------------------------------------------------------
5190
5191 class EraseEvent(Event):
5192 """
5193 An erase event is sent whenever the background of a window needs to be
5194 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5195 binder. On some platforms, such as GTK+, this event is simulated
5196 (simply generated just before the paint event) and may cause flicker.
5197
5198 To paint a custom background use the `GetDC` method and use the returned
5199 device context if it is not ``None``, otherwise create a temporary
5200 `wx.ClientDC` and draw on that.
5201
5202 """
5203 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5204 __repr__ = _swig_repr
5205 def __init__(self, *args, **kwargs):
5206 """
5207 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5208
5209 Constructor
5210 """
5211 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5212 def GetDC(*args, **kwargs):
5213 """
5214 GetDC(self) -> DC
5215
5216 Returns the device context the event handler should draw upon. If
5217 ``None`` is returned then create a temporary `wx.ClientDC` and use
5218 that instead.
5219 """
5220 return _core_.EraseEvent_GetDC(*args, **kwargs)
5221
5222 DC = property(GetDC,doc="See `GetDC`")
5223 _core_.EraseEvent_swigregister(EraseEvent)
5224
5225 #---------------------------------------------------------------------------
5226
5227 class FocusEvent(Event):
5228 """
5229 A focus event is sent when a window's focus changes. The window losing
5230 focus receives an EVT_KILL_FOCUS event while the window gaining it
5231 gets an EVT_SET_FOCUS event.
5232
5233 Notice that the set focus event happens both when the user gives focus
5234 to the window (whether using the mouse or keyboard) and when it is
5235 done from the program itself using `wx.Window.SetFocus`.
5236
5237 """
5238 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5239 __repr__ = _swig_repr
5240 def __init__(self, *args, **kwargs):
5241 """
5242 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5243
5244 Constructor
5245 """
5246 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5247 def GetWindow(*args, **kwargs):
5248 """
5249 GetWindow(self) -> Window
5250
5251 Returns the other window associated with this event, that is the
5252 window which had the focus before for the EVT_SET_FOCUS event and the
5253 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5254
5255 Warning: the window returned may be None!
5256 """
5257 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5258
5259 def SetWindow(*args, **kwargs):
5260 """SetWindow(self, Window win)"""
5261 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5262
5263 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5264 _core_.FocusEvent_swigregister(FocusEvent)
5265
5266 #---------------------------------------------------------------------------
5267
5268 class ChildFocusEvent(CommandEvent):
5269 """
5270 A child focus event is sent to a (parent-)window when one of its child
5271 windows gains focus, so that the window could restore the focus back
5272 to its corresponding child if it loses it now and regains later.
5273
5274 Notice that child window is the direct child of the window receiving
5275 the event, and so may not be the actual widget recieving focus if it
5276 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5277 to get the widget that is actually receiving focus.
5278 """
5279 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5280 __repr__ = _swig_repr
5281 def __init__(self, *args, **kwargs):
5282 """
5283 __init__(self, Window win=None) -> ChildFocusEvent
5284
5285 Constructor
5286 """
5287 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5288 def GetWindow(*args, **kwargs):
5289 """
5290 GetWindow(self) -> Window
5291
5292 The window, or (grand)parent of the window which has just received the
5293 focus.
5294 """
5295 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5296
5297 Window = property(GetWindow,doc="See `GetWindow`")
5298 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5299
5300 #---------------------------------------------------------------------------
5301
5302 class ActivateEvent(Event):
5303 """
5304 An activate event is sent when a top-level window or the entire
5305 application is being activated or deactivated.
5306
5307 A top-level window (a dialog or frame) receives an activate event when
5308 is being activated or deactivated. This is indicated visually by the
5309 title bar changing colour, and a subwindow gaining the keyboard focus.
5310 An application is activated or deactivated when one of its frames
5311 becomes activated, or a frame becomes inactivate resulting in all
5312 application frames being inactive.
5313
5314 Please note that usually you should call event.Skip() in your handlers
5315 for these events so the default handlers will still be called, as not
5316 doing so can result in strange effects.
5317
5318 """
5319 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5320 __repr__ = _swig_repr
5321 def __init__(self, *args, **kwargs):
5322 """
5323 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5324
5325 Constructor
5326 """
5327 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5328 def GetActive(*args, **kwargs):
5329 """
5330 GetActive(self) -> bool
5331
5332 Returns true if the application or window is being activated, false
5333 otherwise.
5334 """
5335 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5336
5337 Active = property(GetActive,doc="See `GetActive`")
5338 _core_.ActivateEvent_swigregister(ActivateEvent)
5339
5340 #---------------------------------------------------------------------------
5341
5342 class InitDialogEvent(Event):
5343 """
5344 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5345 any window when `wx.Window.InitDialog` is called. Handlers for this
5346 event can transfer data to the window, or anything else that should be
5347 done before the user begins editing the form. The default handler
5348 calls `wx.Window.TransferDataToWindow`.
5349 """
5350 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5351 __repr__ = _swig_repr
5352 def __init__(self, *args, **kwargs):
5353 """
5354 __init__(self, int Id=0) -> InitDialogEvent
5355
5356 Constructor
5357 """
5358 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5359 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5360
5361 #---------------------------------------------------------------------------
5362
5363 class MenuEvent(Event):
5364 """
5365 This class is used for a variety of menu-related events. Note that
5366 these do not include menu command events, which are handled by sending
5367 `wx.CommandEvent` objects.
5368
5369 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5370 text in the first field of the status bar.
5371 """
5372 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5373 __repr__ = _swig_repr
5374 def __init__(self, *args, **kwargs):
5375 """
5376 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5377
5378 Constructor
5379 """
5380 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5381 def GetMenuId(*args, **kwargs):
5382 """
5383 GetMenuId(self) -> int
5384
5385 Returns the menu identifier associated with the event. This method
5386 should be only used with the HIGHLIGHT events.
5387 """
5388 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5389
5390 def IsPopup(*args, **kwargs):
5391 """
5392 IsPopup(self) -> bool
5393
5394 Returns ``True`` if the menu which is being opened or closed is a
5395 popup menu, ``False`` if it is a normal one. This method should only
5396 be used with the OPEN and CLOSE events.
5397 """
5398 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5399
5400 def GetMenu(*args, **kwargs):
5401 """
5402 GetMenu(self) -> Menu
5403
5404 Returns the menu which is being opened or closed. This method should
5405 only be used with the OPEN and CLOSE events.
5406 """
5407 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5408
5409 Menu = property(GetMenu,doc="See `GetMenu`")
5410 MenuId = property(GetMenuId,doc="See `GetMenuId`")
5411 _core_.MenuEvent_swigregister(MenuEvent)
5412
5413 #---------------------------------------------------------------------------
5414
5415 class CloseEvent(Event):
5416 """
5417 This event class contains information about window and session close
5418 events.
5419
5420 The handler function for EVT_CLOSE is called when the user has tried
5421 to close a a frame or dialog box using the window manager controls or
5422 the system menu. It can also be invoked by the application itself
5423 programmatically, for example by calling the `wx.Window.Close`
5424 function.
5425
5426 You should check whether the application is forcing the deletion of
5427 the window using `CanVeto`. If it returns ``False``, you must destroy
5428 the window using `wx.Window.Destroy`. If the return value is ``True``,
5429 it is up to you whether you respond by destroying the window or not.
5430 For example you may wish to display a message dialog prompting to save
5431 files or to cancel the close.
5432
5433 If you don't destroy the window, you should call `Veto` to let the
5434 calling code know that you did not destroy the window. This allows the
5435 `wx.Window.Close` function to return ``True`` or ``False`` depending
5436 on whether the close instruction was honored or not.
5437 """
5438 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5439 __repr__ = _swig_repr
5440 def __init__(self, *args, **kwargs):
5441 """
5442 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5443
5444 Constructor.
5445 """
5446 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5447 def SetLoggingOff(*args, **kwargs):
5448 """
5449 SetLoggingOff(self, bool logOff)
5450
5451 Sets the 'logging off' flag.
5452 """
5453 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5454
5455 def GetLoggingOff(*args, **kwargs):
5456 """
5457 GetLoggingOff(self) -> bool
5458
5459 Returns ``True`` if the user is logging off or ``False`` if the
5460 system is shutting down. This method can only be called for end
5461 session and query end session events, it doesn't make sense for close
5462 window event.
5463 """
5464 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5465
5466 def Veto(*args, **kwargs):
5467 """
5468 Veto(self, bool veto=True)
5469
5470 Call this from your event handler to veto a system shutdown or to
5471 signal to the calling application that a window close did not happen.
5472
5473 You can only veto a shutdown or close if `CanVeto` returns true.
5474 """
5475 return _core_.CloseEvent_Veto(*args, **kwargs)
5476
5477 def GetVeto(*args, **kwargs):
5478 """GetVeto(self) -> bool"""
5479 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5480
5481 def SetCanVeto(*args, **kwargs):
5482 """
5483 SetCanVeto(self, bool canVeto)
5484
5485 Sets the 'can veto' flag.
5486 """
5487 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5488
5489 def CanVeto(*args, **kwargs):
5490 """
5491 CanVeto(self) -> bool
5492
5493 Returns true if you can veto a system shutdown or a window close
5494 event. Vetoing a window close event is not possible if the calling
5495 code wishes to force the application to exit, and so this function
5496 must be called to check this.
5497 """
5498 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5499
5500 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5501 _core_.CloseEvent_swigregister(CloseEvent)
5502
5503 #---------------------------------------------------------------------------
5504
5505 class ShowEvent(Event):
5506 """An EVT_SHOW event is sent when a window is shown or hidden."""
5507 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5508 __repr__ = _swig_repr
5509 def __init__(self, *args, **kwargs):
5510 """
5511 __init__(self, int winid=0, bool show=False) -> ShowEvent
5512
5513 An EVT_SHOW event is sent when a window is shown or hidden.
5514 """
5515 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5516 def SetShow(*args, **kwargs):
5517 """SetShow(self, bool show)"""
5518 return _core_.ShowEvent_SetShow(*args, **kwargs)
5519
5520 def GetShow(*args, **kwargs):
5521 """GetShow(self) -> bool"""
5522 return _core_.ShowEvent_GetShow(*args, **kwargs)
5523
5524 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5525 _core_.ShowEvent_swigregister(ShowEvent)
5526
5527 #---------------------------------------------------------------------------
5528
5529 class IconizeEvent(Event):
5530 """
5531 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5532 restored.
5533 """
5534 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5535 __repr__ = _swig_repr
5536 def __init__(self, *args, **kwargs):
5537 """
5538 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5539
5540 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5541 restored.
5542 """
5543 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5544 def Iconized(*args, **kwargs):
5545 """
5546 Iconized(self) -> bool
5547
5548 Returns ``True`` if the frame has been iconized, ``False`` if it has
5549 been restored.
5550 """
5551 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5552
5553 _core_.IconizeEvent_swigregister(IconizeEvent)
5554
5555 #---------------------------------------------------------------------------
5556
5557 class MaximizeEvent(Event):
5558 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5559 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5560 __repr__ = _swig_repr
5561 def __init__(self, *args, **kwargs):
5562 """
5563 __init__(self, int id=0) -> MaximizeEvent
5564
5565 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5566 """
5567 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5568 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5569
5570 #---------------------------------------------------------------------------
5571
5572 class DropFilesEvent(Event):
5573 """
5574 This class is used for drop files events, that is, when files have
5575 been dropped onto the window. This functionality is only available
5576 under Windows. The window must have previously been enabled for
5577 dropping by calling `wx.Window.DragAcceptFiles`.
5578
5579 Important note: this is a separate implementation to the more general
5580 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5581 implementation uses the older, Windows message-based approach of
5582 dropping files.
5583
5584 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5585 events.
5586
5587 """
5588 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5589 def __init__(self): raise AttributeError, "No constructor defined"
5590 __repr__ = _swig_repr
5591 def GetPosition(*args, **kwargs):
5592 """
5593 GetPosition(self) -> Point
5594
5595 Returns the position at which the files were dropped.
5596 """
5597 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5598
5599 def GetNumberOfFiles(*args, **kwargs):
5600 """
5601 GetNumberOfFiles(self) -> int
5602
5603 Returns the number of files dropped.
5604 """
5605 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5606
5607 def GetFiles(*args, **kwargs):
5608 """
5609 GetFiles(self) -> PyObject
5610
5611 Returns a list of the filenames that were dropped.
5612 """
5613 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5614
5615 Files = property(GetFiles,doc="See `GetFiles`")
5616 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5617 Position = property(GetPosition,doc="See `GetPosition`")
5618 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5619
5620 #---------------------------------------------------------------------------
5621
5622 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5623 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5624 class UpdateUIEvent(CommandEvent):
5625 """
5626 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5627 wxWidgets to give an application the chance to update various user
5628 interface elements.
5629
5630 Without update UI events, an application has to work hard to
5631 check/uncheck, enable/disable, and set the text for elements such as
5632 menu items and toolbar buttons. The code for doing this has to be
5633 mixed up with the code that is invoked when an action is invoked for a
5634 menu item or button.
5635
5636 With update UI events, you define an event handler to look at the
5637 state of the application and change UI elements accordingly. wxWidgets
5638 will call your handler functions in idle time, so you don't have to
5639 worry where to call this code. In addition to being a clearer and more
5640 declarative method, it also means you don't have to worry whether
5641 you're updating a toolbar or menubar identifier. The same handler can
5642 update a menu item and toolbar button, if the ID values are the same.
5643
5644 Instead of directly manipulating the menu or button, you call
5645 functions in the event object, such as `Check`. wxWidgets will
5646 determine whether such a call has been made, and which UI element to
5647 update.
5648
5649 These events will work for popup menus as well as menubars. Just
5650 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5651 any UI events for the window that owns the menu.
5652
5653 If you find that the overhead of UI update processing is affecting
5654 your application, you can do one or both of the following:
5655
5656 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5657 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5658 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5659 receive update events. No other windows will receive update
5660 events.
5661
5662 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5663 value to set the delay between updates. You may need to call
5664 `wx.Window.UpdateWindowUI` at critical points, for example when
5665 a dialog is about to be shown, in case the user sees a slight
5666 delay before windows are updated.
5667
5668 Note that although events are sent in idle time, defining a EVT_IDLE
5669 handler for a window does not affect this because the events are sent
5670 from an internal idle handler.
5671
5672 wxWidgets tries to optimize update events on some platforms. On
5673 Windows and GTK+, events for menubar items are only sent when the menu
5674 is about to be shown, and not in idle time.
5675
5676 """
5677 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5678 __repr__ = _swig_repr
5679 def __init__(self, *args, **kwargs):
5680 """
5681 __init__(self, int commandId=0) -> UpdateUIEvent
5682
5683 Constructor
5684 """
5685 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
5686 def GetChecked(*args, **kwargs):
5687 """
5688 GetChecked(self) -> bool
5689
5690 Returns ``True`` if the UI element should be checked.
5691 """
5692 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5693
5694 def GetEnabled(*args, **kwargs):
5695 """
5696 GetEnabled(self) -> bool
5697
5698 Returns ``True`` if the UI element should be enabled.
5699 """
5700 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5701
5702 def GetShown(*args, **kwargs):
5703 """
5704 GetShown(self) -> bool
5705
5706 Returns ``True`` if the UI element should be shown.
5707 """
5708 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5709
5710 def GetText(*args, **kwargs):
5711 """
5712 GetText(self) -> String
5713
5714 Returns the text that should be set for the UI element.
5715 """
5716 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5717
5718 def GetSetText(*args, **kwargs):
5719 """
5720 GetSetText(self) -> bool
5721
5722 Returns ``True`` if the application has called `SetText`. For
5723 wxWidgets internal use only.
5724 """
5725 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5726
5727 def GetSetChecked(*args, **kwargs):
5728 """
5729 GetSetChecked(self) -> bool
5730
5731 Returns ``True`` if the application has called `Check`. For wxWidgets
5732 internal use only.
5733 """
5734 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5735
5736 def GetSetEnabled(*args, **kwargs):
5737 """
5738 GetSetEnabled(self) -> bool
5739
5740 Returns ``True`` if the application has called `Enable`. For wxWidgets
5741 internal use only.
5742 """
5743 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5744
5745 def GetSetShown(*args, **kwargs):
5746 """
5747 GetSetShown(self) -> bool
5748
5749 Returns ``True`` if the application has called `Show`. For wxWidgets
5750 internal use only.
5751 """
5752 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5753
5754 def Check(*args, **kwargs):
5755 """
5756 Check(self, bool check)
5757
5758 Check or uncheck the UI element.
5759 """
5760 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5761
5762 def Enable(*args, **kwargs):
5763 """
5764 Enable(self, bool enable)
5765
5766 Enable or disable the UI element.
5767 """
5768 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5769
5770 def Show(*args, **kwargs):
5771 """
5772 Show(self, bool show)
5773
5774 Show or hide the UI element.
5775 """
5776 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5777
5778 def SetText(*args, **kwargs):
5779 """
5780 SetText(self, String text)
5781
5782 Sets the text for this UI element.
5783 """
5784 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5785
5786 def SetUpdateInterval(*args, **kwargs):
5787 """
5788 SetUpdateInterval(long updateInterval)
5789
5790 Sets the interval between updates in milliseconds. Set to -1 to
5791 disable updates, or to 0 to update as frequently as possible. The
5792 default is 0.
5793
5794 Use this to reduce the overhead of UI update events if your
5795 application has a lot of windows. If you set the value to -1 or
5796 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5797 at appropriate points in your application, such as when a dialog is
5798 about to be shown.
5799 """
5800 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5801
5802 SetUpdateInterval = staticmethod(SetUpdateInterval)
5803 def GetUpdateInterval(*args, **kwargs):
5804 """
5805 GetUpdateInterval() -> long
5806
5807 Returns the current interval between updates in milliseconds. -1
5808 disables updates, 0 updates as frequently as possible.
5809 """
5810 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5811
5812 GetUpdateInterval = staticmethod(GetUpdateInterval)
5813 def CanUpdate(*args, **kwargs):
5814 """
5815 CanUpdate(Window win) -> bool
5816
5817 Returns ``True`` if it is appropriate to update (send UI update events
5818 to) this window.
5819
5820 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5821 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5822 events were last sent in idle time, and the update interval, to
5823 determine whether events should be sent to this window now. By default
5824 this will always return true because the update mode is initially
5825 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5826 events will be sent as often as possible. You can reduce the frequency
5827 that events are sent by changing the mode and/or setting an update
5828 interval.
5829
5830 """
5831 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5832
5833 CanUpdate = staticmethod(CanUpdate)
5834 def ResetUpdateTime(*args, **kwargs):
5835 """
5836 ResetUpdateTime()
5837
5838 Used internally to reset the last-updated time to the current time. It
5839 is assumed that update events are normally sent in idle time, so this
5840 is called at the end of idle processing.
5841 """
5842 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5843
5844 ResetUpdateTime = staticmethod(ResetUpdateTime)
5845 def SetMode(*args, **kwargs):
5846 """
5847 SetMode(int mode)
5848
5849 Specify how wxWidgets will send update events: to all windows, or only
5850 to those which specify that they will process the events.
5851
5852 The mode may be one of the following values:
5853
5854 ============================= ==========================================
5855 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5856 is the default setting.
5857 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5858 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5859 style set.
5860 ============================= ==========================================
5861
5862 """
5863 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5864
5865 SetMode = staticmethod(SetMode)
5866 def GetMode(*args, **kwargs):
5867 """
5868 GetMode() -> int
5869
5870 Returns a value specifying how wxWidgets will send update events: to
5871 all windows, or only to those which specify that they will process the
5872 events.
5873 """
5874 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5875
5876 GetMode = staticmethod(GetMode)
5877 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
5878
5879 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5880 """
5881 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5882
5883 Sets the interval between updates in milliseconds. Set to -1 to
5884 disable updates, or to 0 to update as frequently as possible. The
5885 default is 0.
5886
5887 Use this to reduce the overhead of UI update events if your
5888 application has a lot of windows. If you set the value to -1 or
5889 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5890 at appropriate points in your application, such as when a dialog is
5891 about to be shown.
5892 """
5893 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5894
5895 def UpdateUIEvent_GetUpdateInterval(*args):
5896 """
5897 UpdateUIEvent_GetUpdateInterval() -> long
5898
5899 Returns the current interval between updates in milliseconds. -1
5900 disables updates, 0 updates as frequently as possible.
5901 """
5902 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
5903
5904 def UpdateUIEvent_CanUpdate(*args, **kwargs):
5905 """
5906 UpdateUIEvent_CanUpdate(Window win) -> bool
5907
5908 Returns ``True`` if it is appropriate to update (send UI update events
5909 to) this window.
5910
5911 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5912 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5913 events were last sent in idle time, and the update interval, to
5914 determine whether events should be sent to this window now. By default
5915 this will always return true because the update mode is initially
5916 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5917 events will be sent as often as possible. You can reduce the frequency
5918 that events are sent by changing the mode and/or setting an update
5919 interval.
5920
5921 """
5922 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5923
5924 def UpdateUIEvent_ResetUpdateTime(*args):
5925 """
5926 UpdateUIEvent_ResetUpdateTime()
5927
5928 Used internally to reset the last-updated time to the current time. It
5929 is assumed that update events are normally sent in idle time, so this
5930 is called at the end of idle processing.
5931 """
5932 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
5933
5934 def UpdateUIEvent_SetMode(*args, **kwargs):
5935 """
5936 UpdateUIEvent_SetMode(int mode)
5937
5938 Specify how wxWidgets will send update events: to all windows, or only
5939 to those which specify that they will process the events.
5940
5941 The mode may be one of the following values:
5942
5943 ============================= ==========================================
5944 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5945 is the default setting.
5946 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5947 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5948 style set.
5949 ============================= ==========================================
5950
5951 """
5952 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5953
5954 def UpdateUIEvent_GetMode(*args):
5955 """
5956 UpdateUIEvent_GetMode() -> int
5957
5958 Returns a value specifying how wxWidgets will send update events: to
5959 all windows, or only to those which specify that they will process the
5960 events.
5961 """
5962 return _core_.UpdateUIEvent_GetMode(*args)
5963
5964 #---------------------------------------------------------------------------
5965
5966 class SysColourChangedEvent(Event):
5967 """
5968 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
5969 when the user changes the colour settings using the control
5970 panel. This is only applicable under Windows.
5971
5972 The default event handler for this event propagates the event to child
5973 windows, since Windows only sends the events to top-level windows. If
5974 intercepting this event for a top-level window, remember to call
5975 `Skip` so the the base class handler will still be executed, or to
5976 pass the event on to the window's children explicitly.
5977
5978 """
5979 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5980 __repr__ = _swig_repr
5981 def __init__(self, *args, **kwargs):
5982 """
5983 __init__(self) -> SysColourChangedEvent
5984
5985 Constructor
5986 """
5987 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
5988 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
5989
5990 #---------------------------------------------------------------------------
5991
5992 class MouseCaptureChangedEvent(Event):
5993 """
5994 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
5995 a window that loses its mouse capture. This is called even if
5996 `wx.Window.ReleaseMouse` was called by the application code. Handling
5997 this event allows an application to cater for unexpected capture
5998 releases which might otherwise confuse mouse handling code.
5999
6000 This event is implemented under Windows only.
6001 """
6002 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6003 __repr__ = _swig_repr
6004 def __init__(self, *args, **kwargs):
6005 """
6006 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6007
6008 Constructor
6009 """
6010 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6011 def GetCapturedWindow(*args, **kwargs):
6012 """
6013 GetCapturedWindow(self) -> Window
6014
6015 Returns the window that gained the capture, or ``None`` if it was a
6016 non-wxWidgets window.
6017 """
6018 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6019
6020 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6021 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6022
6023 #---------------------------------------------------------------------------
6024
6025 class MouseCaptureLostEvent(Event):
6026 """
6027 A mouse capture lost event is sent to a window that obtained mouse
6028 capture, which was subsequently loss due to "external" event, for
6029 example when a dialog box is shown or if another application captures
6030 the mouse.
6031
6032 If this happens, this event is sent to all windows that are on the
6033 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6034 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6035 if the capture changes because of a call to CaptureMouse or
6036 ReleaseMouse.
6037
6038 This event is currently emitted under Windows only.
6039
6040 """
6041 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6042 __repr__ = _swig_repr
6043 def __init__(self, *args, **kwargs):
6044 """
6045 __init__(self, int winid=0) -> MouseCaptureLostEvent
6046
6047 A mouse capture lost event is sent to a window that obtained mouse
6048 capture, which was subsequently loss due to "external" event, for
6049 example when a dialog box is shown or if another application captures
6050 the mouse.
6051
6052 If this happens, this event is sent to all windows that are on the
6053 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6054 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6055 if the capture changes because of a call to CaptureMouse or
6056 ReleaseMouse.
6057
6058 This event is currently emitted under Windows only.
6059
6060 """
6061 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6062 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6063
6064 #---------------------------------------------------------------------------
6065
6066 class DisplayChangedEvent(Event):
6067 """
6068 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6069 resolution has changed.
6070
6071 This event is implemented under Windows only.
6072 """
6073 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6074 __repr__ = _swig_repr
6075 def __init__(self, *args, **kwargs):
6076 """__init__(self) -> DisplayChangedEvent"""
6077 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6078 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6079
6080 #---------------------------------------------------------------------------
6081
6082 class PaletteChangedEvent(Event):
6083 """
6084 An EVT_PALETTE_CHANGED event is sent when the system palette has
6085 changed, thereby giving each window a chance to redo their own to
6086 match.
6087
6088 This event is implemented under Windows only.
6089 """
6090 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6091 __repr__ = _swig_repr
6092 def __init__(self, *args, **kwargs):
6093 """
6094 __init__(self, int id=0) -> PaletteChangedEvent
6095
6096 An EVT_PALETTE_CHANGED event is sent when the system palette has
6097 changed, thereby giving each window a chance to redo their own to
6098 match.
6099
6100 This event is implemented under Windows only.
6101 """
6102 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6103 def SetChangedWindow(*args, **kwargs):
6104 """SetChangedWindow(self, Window win)"""
6105 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6106
6107 def GetChangedWindow(*args, **kwargs):
6108 """GetChangedWindow(self) -> Window"""
6109 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6110
6111 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6112 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6113
6114 #---------------------------------------------------------------------------
6115
6116 class QueryNewPaletteEvent(Event):
6117 """
6118 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6119 focus and should re-do its palette.
6120
6121 This event is implemented under Windows only.
6122 """
6123 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6124 __repr__ = _swig_repr
6125 def __init__(self, *args, **kwargs):
6126 """
6127 __init__(self, int winid=0) -> QueryNewPaletteEvent
6128
6129 Constructor.
6130 """
6131 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6132 def SetPaletteRealized(*args, **kwargs):
6133 """
6134 SetPaletteRealized(self, bool realized)
6135
6136 App should set this if it changes the palette.
6137 """
6138 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6139
6140 def GetPaletteRealized(*args, **kwargs):
6141 """GetPaletteRealized(self) -> bool"""
6142 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6143
6144 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6145 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6146
6147 #---------------------------------------------------------------------------
6148
6149 class NavigationKeyEvent(Event):
6150 """
6151 EVT_NAVIGATION_KEY events are used to control moving the focus between
6152 widgets, otherwise known as tab-traversal. You woudl normally not
6153 catch navigation events in applications as there are already
6154 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6155 it useful to send navigation events in certain situations to change
6156 the focus in certain ways, although it's probably easier to just call
6157 `wx.Window.Navigate`.
6158 """
6159 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6160 __repr__ = _swig_repr
6161 def __init__(self, *args, **kwargs):
6162 """__init__(self) -> NavigationKeyEvent"""
6163 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6164 def GetDirection(*args, **kwargs):
6165 """
6166 GetDirection(self) -> bool
6167
6168 Returns ``True`` if the direction is forward, ``False`` otherwise.
6169 """
6170 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6171
6172 def SetDirection(*args, **kwargs):
6173 """
6174 SetDirection(self, bool forward)
6175
6176 Specify the direction that the navigation should take. Usually the
6177 difference between using Tab and Shift-Tab.
6178 """
6179 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6180
6181 def IsWindowChange(*args, **kwargs):
6182 """
6183 IsWindowChange(self) -> bool
6184
6185 Returns ``True`` if window change is allowed.
6186 """
6187 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6188
6189 def SetWindowChange(*args, **kwargs):
6190 """
6191 SetWindowChange(self, bool ischange)
6192
6193 Specify if the navigation should be able to change parent windows.
6194 For example, changing notebook pages, etc. This is usually implemented
6195 by using Control-Tab.
6196 """
6197 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6198
6199 def IsFromTab(*args, **kwargs):
6200 """
6201 IsFromTab(self) -> bool
6202
6203 Returns ``True`` if the navigation event is originated from the Tab
6204 key.
6205 """
6206 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6207
6208 def SetFromTab(*args, **kwargs):
6209 """
6210 SetFromTab(self, bool bIs)
6211
6212 Set to true under MSW if the event was generated using the tab key.
6213 This is required for proper navogation over radio buttons.
6214 """
6215 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6216
6217 def SetFlags(*args, **kwargs):
6218 """
6219 SetFlags(self, long flags)
6220
6221 Set the navigation flags to a combination of the following:
6222
6223 * wx.NavigationKeyEvent.IsBackward
6224 * wx.NavigationKeyEvent.IsForward
6225 * wx.NavigationKeyEvent.WinChange
6226 * wx.NavigationKeyEvent.FromTab
6227
6228 """
6229 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6230
6231 def GetCurrentFocus(*args, **kwargs):
6232 """
6233 GetCurrentFocus(self) -> Window
6234
6235 Returns the child window which currenty has the focus. May be
6236 ``None``.
6237 """
6238 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6239
6240 def SetCurrentFocus(*args, **kwargs):
6241 """
6242 SetCurrentFocus(self, Window win)
6243
6244 Set the window that has the focus.
6245 """
6246 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6247
6248 IsBackward = _core_.NavigationKeyEvent_IsBackward
6249 IsForward = _core_.NavigationKeyEvent_IsForward
6250 WinChange = _core_.NavigationKeyEvent_WinChange
6251 FromTab = _core_.NavigationKeyEvent_FromTab
6252 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6253 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6254 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6255
6256 #---------------------------------------------------------------------------
6257
6258 class WindowCreateEvent(CommandEvent):
6259 """
6260 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6261 underlying GUI object) exists.
6262 """
6263 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6264 __repr__ = _swig_repr
6265 def __init__(self, *args, **kwargs):
6266 """
6267 __init__(self, Window win=None) -> WindowCreateEvent
6268
6269 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6270 underlying GUI object) exists.
6271 """
6272 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6273 def GetWindow(*args, **kwargs):
6274 """
6275 GetWindow(self) -> Window
6276
6277 Returns the window that this event refers to.
6278 """
6279 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6280
6281 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6282
6283 class WindowDestroyEvent(CommandEvent):
6284 """
6285 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6286 when the GUI window is destroyed.
6287
6288 When a class derived from `wx.Window` is destroyed its destructor will
6289 have already run by the time this event is sent. Therefore this event
6290 will not usually be received at all by the window itself. Since it is
6291 received after the destructor has run, an object should not try to
6292 handle its own wx.WindowDestroyEvent, but it can be used to get
6293 notification of the destruction of another window.
6294 """
6295 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6296 __repr__ = _swig_repr
6297 def __init__(self, *args, **kwargs):
6298 """
6299 __init__(self, Window win=None) -> WindowDestroyEvent
6300
6301 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6302 when the GUI window is destroyed.
6303
6304 When a class derived from `wx.Window` is destroyed its destructor will
6305 have already run by the time this event is sent. Therefore this event
6306 will not usually be received at all by the window itself. Since it is
6307 received after the destructor has run, an object should not try to
6308 handle its own wx.WindowDestroyEvent, but it can be used to get
6309 notification of the destruction of another window.
6310 """
6311 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6312 def GetWindow(*args, **kwargs):
6313 """
6314 GetWindow(self) -> Window
6315
6316 Returns the window that this event refers to.
6317 """
6318 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6319
6320 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6321
6322 #---------------------------------------------------------------------------
6323
6324 class ContextMenuEvent(CommandEvent):
6325 """
6326 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6327 give the application a chance to show a context (popup) menu.
6328 """
6329 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6330 __repr__ = _swig_repr
6331 def __init__(self, *args, **kwargs):
6332 """
6333 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6334
6335 Constructor.
6336 """
6337 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6338 def GetPosition(*args, **kwargs):
6339 """
6340 GetPosition(self) -> Point
6341
6342 Returns the position (in screen coordinants) at which the menu should
6343 be shown.
6344 """
6345 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6346
6347 def SetPosition(*args, **kwargs):
6348 """
6349 SetPosition(self, Point pos)
6350
6351 Sets the position at which the menu should be shown.
6352 """
6353 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6354
6355 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6356 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6357
6358 #---------------------------------------------------------------------------
6359
6360 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6361 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6362 class IdleEvent(Event):
6363 """
6364 This class is used for EVT_IDLE events, which are generated and sent
6365 when the application *becomes* idle. In other words, the when the
6366 event queue becomes empty then idle events are sent to all windows (by
6367 default) and as long as none of them call `RequestMore` then there are
6368 no more idle events until after the system event queue has some normal
6369 events and then becomes empty again.
6370
6371 By default, idle events are sent to all windows. If this is causing a
6372 significant overhead in your application, you can call
6373 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6374 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6375 which should receive idle events. Then idle events will only be sent
6376 to those windows and not to any others.
6377 """
6378 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6379 __repr__ = _swig_repr
6380 def __init__(self, *args, **kwargs):
6381 """
6382 __init__(self) -> IdleEvent
6383
6384 Constructor
6385 """
6386 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6387 def RequestMore(*args, **kwargs):
6388 """
6389 RequestMore(self, bool needMore=True)
6390
6391 Tells wxWidgets that more processing is required. This function can be
6392 called by an EVT_IDLE handler for a window to indicate that the
6393 application should forward the EVT_IDLE event once more to the
6394 application windows. If no window calls this function during its
6395 EVT_IDLE handler, then the application will remain in a passive event
6396 loop until a new event is posted to the application by the windowing
6397 system.
6398 """
6399 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6400
6401 def MoreRequested(*args, **kwargs):
6402 """
6403 MoreRequested(self) -> bool
6404
6405 Returns ``True`` if the OnIdle function processing this event
6406 requested more processing time.
6407 """
6408 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6409
6410 def SetMode(*args, **kwargs):
6411 """
6412 SetMode(int mode)
6413
6414 Static method for specifying how wxWidgets will send idle events: to
6415 all windows, or only to those which specify that they will process the
6416 events.
6417
6418 The mode can be one of the following values:
6419
6420 ========================= ========================================
6421 wx.IDLE_PROCESS_ALL Send idle events to all windows
6422 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6423 the wx.WS_EX_PROCESS_IDLE extra style
6424 flag set.
6425 ========================= ========================================
6426
6427 """
6428 return _core_.IdleEvent_SetMode(*args, **kwargs)
6429
6430 SetMode = staticmethod(SetMode)
6431 def GetMode(*args, **kwargs):
6432 """
6433 GetMode() -> int
6434
6435 Static method returning a value specifying how wxWidgets will send
6436 idle events: to all windows, or only to those which specify that they
6437 will process the events.
6438 """
6439 return _core_.IdleEvent_GetMode(*args, **kwargs)
6440
6441 GetMode = staticmethod(GetMode)
6442 def CanSend(*args, **kwargs):
6443 """
6444 CanSend(Window win) -> bool
6445
6446 Returns ``True`` if it is appropriate to send idle events to this
6447 window.
6448
6449 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6450 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6451 events should be sent to this window now. By default this will always
6452 return ``True`` because the update mode is initially
6453 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6454 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6455 """
6456 return _core_.IdleEvent_CanSend(*args, **kwargs)
6457
6458 CanSend = staticmethod(CanSend)
6459 _core_.IdleEvent_swigregister(IdleEvent)
6460
6461 def IdleEvent_SetMode(*args, **kwargs):
6462 """
6463 IdleEvent_SetMode(int mode)
6464
6465 Static method for specifying how wxWidgets will send idle events: to
6466 all windows, or only to those which specify that they will process the
6467 events.
6468
6469 The mode can be one of the following values:
6470
6471 ========================= ========================================
6472 wx.IDLE_PROCESS_ALL Send idle events to all windows
6473 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6474 the wx.WS_EX_PROCESS_IDLE extra style
6475 flag set.
6476 ========================= ========================================
6477
6478 """
6479 return _core_.IdleEvent_SetMode(*args, **kwargs)
6480
6481 def IdleEvent_GetMode(*args):
6482 """
6483 IdleEvent_GetMode() -> int
6484
6485 Static method returning a value specifying how wxWidgets will send
6486 idle events: to all windows, or only to those which specify that they
6487 will process the events.
6488 """
6489 return _core_.IdleEvent_GetMode(*args)
6490
6491 def IdleEvent_CanSend(*args, **kwargs):
6492 """
6493 IdleEvent_CanSend(Window win) -> bool
6494
6495 Returns ``True`` if it is appropriate to send idle events to this
6496 window.
6497
6498 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6499 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6500 events should be sent to this window now. By default this will always
6501 return ``True`` because the update mode is initially
6502 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6503 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6504 """
6505 return _core_.IdleEvent_CanSend(*args, **kwargs)
6506
6507 #---------------------------------------------------------------------------
6508
6509 class ClipboardTextEvent(CommandEvent):
6510 """
6511 A Clipboard Text event is sent when a window intercepts a text
6512 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6513 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6514 popup menu command, etc. NOTE : under windows these events are *NOT*
6515 generated automatically for a Rich Edit text control.
6516 """
6517 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6518 __repr__ = _swig_repr
6519 def __init__(self, *args, **kwargs):
6520 """
6521 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6522
6523 A Clipboard Text event is sent when a window intercepts a text
6524 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6525 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6526 popup menu command, etc. NOTE : under windows these events are *NOT*
6527 generated automatically for a Rich Edit text control.
6528 """
6529 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6530 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6531
6532 #---------------------------------------------------------------------------
6533
6534 class PyEvent(Event):
6535 """
6536 wx.PyEvent can be used as a base class for implementing custom event
6537 types in Python. You should derived from this class instead of
6538 `wx.Event` because this class is Python-aware and is able to transport
6539 its Python bits safely through the wxWidgets event system and have
6540 them still be there when the event handler is invoked.
6541
6542 :see: `wx.PyCommandEvent`
6543
6544 """
6545 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6546 __repr__ = _swig_repr
6547 def __init__(self, *args, **kwargs):
6548 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6549 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6550 self._SetSelf(self)
6551
6552 __swig_destroy__ = _core_.delete_PyEvent
6553 __del__ = lambda self : None;
6554 def _SetSelf(*args, **kwargs):
6555 """_SetSelf(self, PyObject self)"""
6556 return _core_.PyEvent__SetSelf(*args, **kwargs)
6557
6558 def _GetSelf(*args, **kwargs):
6559 """_GetSelf(self) -> PyObject"""
6560 return _core_.PyEvent__GetSelf(*args, **kwargs)
6561
6562 _core_.PyEvent_swigregister(PyEvent)
6563
6564 class PyCommandEvent(CommandEvent):
6565 """
6566 wx.PyCommandEvent can be used as a base class for implementing custom
6567 event types in Python, where the event shoudl travel up to parent
6568 windows looking for a handler. You should derived from this class
6569 instead of `wx.CommandEvent` because this class is Python-aware and is
6570 able to transport its Python bits safely through the wxWidgets event
6571 system and have them still be there when the event handler is invoked.
6572
6573 :see: `wx.PyEvent`
6574
6575 """
6576 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6577 __repr__ = _swig_repr
6578 def __init__(self, *args, **kwargs):
6579 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6580 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6581 self._SetSelf(self)
6582
6583 __swig_destroy__ = _core_.delete_PyCommandEvent
6584 __del__ = lambda self : None;
6585 def _SetSelf(*args, **kwargs):
6586 """_SetSelf(self, PyObject self)"""
6587 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6588
6589 def _GetSelf(*args, **kwargs):
6590 """_GetSelf(self) -> PyObject"""
6591 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6592
6593 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6594
6595 class DateEvent(CommandEvent):
6596 """
6597 This event class holds information about a date change event and is
6598 used together with `wx.DatePickerCtrl`. It also serves as a base class
6599 for `wx.calendar.CalendarEvent`. Bind these event types with
6600 EVT_DATE_CHANGED.
6601 """
6602 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6603 __repr__ = _swig_repr
6604 def __init__(self, *args, **kwargs):
6605 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6606 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6607 def GetDate(*args, **kwargs):
6608 """
6609 GetDate(self) -> DateTime
6610
6611 Returns the date.
6612 """
6613 return _core_.DateEvent_GetDate(*args, **kwargs)
6614
6615 def SetDate(*args, **kwargs):
6616 """
6617 SetDate(self, DateTime date)
6618
6619 Sets the date carried by the event, normally only used by the library
6620 internally.
6621 """
6622 return _core_.DateEvent_SetDate(*args, **kwargs)
6623
6624 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
6625 _core_.DateEvent_swigregister(DateEvent)
6626
6627 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6628 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6629
6630 #---------------------------------------------------------------------------
6631
6632 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6633 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6634 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6635 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6636 PRINT_WINDOWS = _core_.PRINT_WINDOWS
6637 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6638 class PyApp(EvtHandler):
6639 """
6640 The ``wx.PyApp`` class is an *implementation detail*, please use the
6641 `wx.App` class (or some other derived class) instead.
6642 """
6643 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6644 __repr__ = _swig_repr
6645 def __init__(self, *args, **kwargs):
6646 """
6647 __init__(self) -> PyApp
6648
6649 Create a new application object, starting the bootstrap process.
6650 """
6651 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
6652 self._setCallbackInfo(self, PyApp, False)
6653 self._setOORInfo(self, False)
6654
6655 __swig_destroy__ = _core_.delete_PyApp
6656 __del__ = lambda self : None;
6657 def _setCallbackInfo(*args, **kwargs):
6658 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6659 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6660
6661 def GetAppName(*args, **kwargs):
6662 """
6663 GetAppName(self) -> String
6664
6665 Get the application name.
6666 """
6667 return _core_.PyApp_GetAppName(*args, **kwargs)
6668
6669 def SetAppName(*args, **kwargs):
6670 """
6671 SetAppName(self, String name)
6672
6673 Set the application name. This value may be used automatically by
6674 `wx.Config` and such.
6675 """
6676 return _core_.PyApp_SetAppName(*args, **kwargs)
6677
6678 def GetClassName(*args, **kwargs):
6679 """
6680 GetClassName(self) -> String
6681
6682 Get the application's class name.
6683 """
6684 return _core_.PyApp_GetClassName(*args, **kwargs)
6685
6686 def SetClassName(*args, **kwargs):
6687 """
6688 SetClassName(self, String name)
6689
6690 Set the application's class name. This value may be used for
6691 X-resources if applicable for the platform
6692 """
6693 return _core_.PyApp_SetClassName(*args, **kwargs)
6694
6695 def GetVendorName(*args, **kwargs):
6696 """
6697 GetVendorName(self) -> String
6698
6699 Get the application's vendor name.
6700 """
6701 return _core_.PyApp_GetVendorName(*args, **kwargs)
6702
6703 def SetVendorName(*args, **kwargs):
6704 """
6705 SetVendorName(self, String name)
6706
6707 Set the application's vendor name. This value may be used
6708 automatically by `wx.Config` and such.
6709 """
6710 return _core_.PyApp_SetVendorName(*args, **kwargs)
6711
6712 def GetTraits(*args, **kwargs):
6713 """
6714 GetTraits(self) -> wxAppTraits
6715
6716 Return (and create if necessary) the app traits object to which we
6717 delegate for everything which either should be configurable by the
6718 user (then he can change the default behaviour simply by overriding
6719 CreateTraits() and returning his own traits object) or which is
6720 GUI/console dependent as then wx.AppTraits allows us to abstract the
6721 differences behind the common facade.
6722
6723 :todo: Add support for overriding CreateAppTraits in wxPython.
6724 """
6725 return _core_.PyApp_GetTraits(*args, **kwargs)
6726
6727 def ProcessPendingEvents(*args, **kwargs):
6728 """
6729 ProcessPendingEvents(self)
6730
6731 Process all events in the Pending Events list -- it is necessary to
6732 call this function to process posted events. This normally happens
6733 during each event loop iteration.
6734 """
6735 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6736
6737 def Yield(*args, **kwargs):
6738 """
6739 Yield(self, bool onlyIfNeeded=False) -> bool
6740
6741 Process all currently pending events right now, instead of waiting
6742 until return to the event loop. It is an error to call ``Yield``
6743 recursively unless the value of ``onlyIfNeeded`` is True.
6744
6745 :warning: This function is dangerous as it can lead to unexpected
6746 reentrancies (i.e. when called from an event handler it may
6747 result in calling the same event handler again), use with
6748 extreme care or, better, don't use at all!
6749
6750 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6751
6752 """
6753 return _core_.PyApp_Yield(*args, **kwargs)
6754
6755 def WakeUpIdle(*args, **kwargs):
6756 """
6757 WakeUpIdle(self)
6758
6759 Make sure that idle events are sent again.
6760 :see: `wx.WakeUpIdle`
6761 """
6762 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6763
6764 def IsMainLoopRunning(*args, **kwargs):
6765 """
6766 IsMainLoopRunning() -> bool
6767
6768 Returns True if we're running the main loop, i.e. if the events can
6769 currently be dispatched.
6770 """
6771 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6772
6773 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
6774 def MainLoop(*args, **kwargs):
6775 """
6776 MainLoop(self) -> int
6777
6778 Execute the main GUI loop, the function doesn't normally return until
6779 all top level windows have been closed and destroyed.
6780 """
6781 return _core_.PyApp_MainLoop(*args, **kwargs)
6782
6783 def Exit(*args, **kwargs):
6784 """
6785 Exit(self)
6786
6787 Exit the main loop thus terminating the application.
6788 :see: `wx.Exit`
6789 """
6790 return _core_.PyApp_Exit(*args, **kwargs)
6791
6792 def GetLayoutDirection(*args, **kwargs):
6793 """
6794 GetLayoutDirection(self) -> int
6795
6796 Return the layout direction for the current locale.
6797 """
6798 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
6799
6800 def ExitMainLoop(*args, **kwargs):
6801 """
6802 ExitMainLoop(self)
6803
6804 Exit the main GUI loop during the next iteration of the main
6805 loop, (i.e. it does not stop the program immediately!)
6806 """
6807 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6808
6809 def Pending(*args, **kwargs):
6810 """
6811 Pending(self) -> bool
6812
6813 Returns True if there are unprocessed events in the event queue.
6814 """
6815 return _core_.PyApp_Pending(*args, **kwargs)
6816
6817 def Dispatch(*args, **kwargs):
6818 """
6819 Dispatch(self) -> bool
6820
6821 Process the first event in the event queue (blocks until an event
6822 appears if there are none currently)
6823 """
6824 return _core_.PyApp_Dispatch(*args, **kwargs)
6825
6826 def ProcessIdle(*args, **kwargs):
6827 """
6828 ProcessIdle(self) -> bool
6829
6830 Called from the MainLoop when the application becomes idle (there are
6831 no pending events) and sends a `wx.IdleEvent` to all interested
6832 parties. Returns True if more idle events are needed, False if not.
6833 """
6834 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6835
6836 def SendIdleEvents(*args, **kwargs):
6837 """
6838 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6839
6840 Send idle event to window and all subwindows. Returns True if more
6841 idle time is requested.
6842 """
6843 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6844
6845 def IsActive(*args, **kwargs):
6846 """
6847 IsActive(self) -> bool
6848
6849 Return True if our app has focus.
6850 """
6851 return _core_.PyApp_IsActive(*args, **kwargs)
6852
6853 def SetTopWindow(*args, **kwargs):
6854 """
6855 SetTopWindow(self, Window win)
6856
6857 Set the *main* top level window
6858 """
6859 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6860
6861 def GetTopWindow(*args, **kwargs):
6862 """
6863 GetTopWindow(self) -> Window
6864
6865 Return the *main* top level window (if it hadn't been set previously
6866 with SetTopWindow(), will return just some top level window and, if
6867 there not any, will return None)
6868 """
6869 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6870
6871 def SetExitOnFrameDelete(*args, **kwargs):
6872 """
6873 SetExitOnFrameDelete(self, bool flag)
6874
6875 Control the exit behaviour: by default, the program will exit the main
6876 loop (and so, usually, terminate) when the last top-level program
6877 window is deleted. Beware that if you disable this behaviour (with
6878 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6879 explicitly from somewhere.
6880 """
6881 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6882
6883 def GetExitOnFrameDelete(*args, **kwargs):
6884 """
6885 GetExitOnFrameDelete(self) -> bool
6886
6887 Get the current exit behaviour setting.
6888 """
6889 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6890
6891 def SetUseBestVisual(*args, **kwargs):
6892 """
6893 SetUseBestVisual(self, bool flag)
6894
6895 Set whether the app should try to use the best available visual on
6896 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6897 """
6898 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6899
6900 def GetUseBestVisual(*args, **kwargs):
6901 """
6902 GetUseBestVisual(self) -> bool
6903
6904 Get current UseBestVisual setting.
6905 """
6906 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6907
6908 def SetPrintMode(*args, **kwargs):
6909 """SetPrintMode(self, int mode)"""
6910 return _core_.PyApp_SetPrintMode(*args, **kwargs)
6911
6912 def GetPrintMode(*args, **kwargs):
6913 """GetPrintMode(self) -> int"""
6914 return _core_.PyApp_GetPrintMode(*args, **kwargs)
6915
6916 def SetAssertMode(*args, **kwargs):
6917 """
6918 SetAssertMode(self, int mode)
6919
6920 Set the OnAssert behaviour for debug and hybrid builds.
6921 """
6922 return _core_.PyApp_SetAssertMode(*args, **kwargs)
6923
6924 def GetAssertMode(*args, **kwargs):
6925 """
6926 GetAssertMode(self) -> int
6927
6928 Get the current OnAssert behaviour setting.
6929 """
6930 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6931
6932 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
6933 """GetMacSupportPCMenuShortcuts() -> bool"""
6934 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
6935
6936 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
6937 def GetMacAboutMenuItemId(*args, **kwargs):
6938 """GetMacAboutMenuItemId() -> long"""
6939 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
6940
6941 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
6942 def GetMacPreferencesMenuItemId(*args, **kwargs):
6943 """GetMacPreferencesMenuItemId() -> long"""
6944 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
6945
6946 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
6947 def GetMacExitMenuItemId(*args, **kwargs):
6948 """GetMacExitMenuItemId() -> long"""
6949 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
6950
6951 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
6952 def GetMacHelpMenuTitleName(*args, **kwargs):
6953 """GetMacHelpMenuTitleName() -> String"""
6954 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
6955
6956 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
6957 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
6958 """SetMacSupportPCMenuShortcuts(bool val)"""
6959 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
6960
6961 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
6962 def SetMacAboutMenuItemId(*args, **kwargs):
6963 """SetMacAboutMenuItemId(long val)"""
6964 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
6965
6966 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
6967 def SetMacPreferencesMenuItemId(*args, **kwargs):
6968 """SetMacPreferencesMenuItemId(long val)"""
6969 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
6970
6971 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
6972 def SetMacExitMenuItemId(*args, **kwargs):
6973 """SetMacExitMenuItemId(long val)"""
6974 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
6975
6976 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
6977 def SetMacHelpMenuTitleName(*args, **kwargs):
6978 """SetMacHelpMenuTitleName(String val)"""
6979 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
6980
6981 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
6982 def _BootstrapApp(*args, **kwargs):
6983 """
6984 _BootstrapApp(self)
6985
6986 For internal use only
6987 """
6988 return _core_.PyApp__BootstrapApp(*args, **kwargs)
6989
6990 def GetComCtl32Version(*args, **kwargs):
6991 """
6992 GetComCtl32Version() -> int
6993
6994 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
6995 it wasn't found at all. Raises an exception on non-Windows platforms.
6996 """
6997 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
6998
6999 GetComCtl32Version = staticmethod(GetComCtl32Version)
7000 def IsDisplayAvailable(*args, **kwargs):
7001 """
7002 IsDisplayAvailable() -> bool
7003
7004 Tests if it is possible to create a GUI in the current environment.
7005 This will mean different things on the different platforms.
7006
7007 * On X Windows systems this function will return ``False`` if it is
7008 not able to open a connection to the X display, which can happen
7009 if $DISPLAY is not set, or is not set correctly.
7010
7011 * On Mac OS X a ``False`` return value will mean that wx is not
7012 able to access the window manager, which can happen if logged in
7013 remotely or if running from the normal version of python instead
7014 of the framework version, (i.e., pythonw.)
7015
7016 * On MS Windows...
7017
7018 """
7019 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7020
7021 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7022 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7023 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7024 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7025 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7026 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7027 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7028 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7029 Traits = property(GetTraits,doc="See `GetTraits`")
7030 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7031 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7032 Active = property(IsActive)
7033 _core_.PyApp_swigregister(PyApp)
7034
7035 def PyApp_IsMainLoopRunning(*args):
7036 """
7037 PyApp_IsMainLoopRunning() -> bool
7038
7039 Returns True if we're running the main loop, i.e. if the events can
7040 currently be dispatched.
7041 """
7042 return _core_.PyApp_IsMainLoopRunning(*args)
7043
7044 def PyApp_GetMacSupportPCMenuShortcuts(*args):
7045 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7046 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7047
7048 def PyApp_GetMacAboutMenuItemId(*args):
7049 """PyApp_GetMacAboutMenuItemId() -> long"""
7050 return _core_.PyApp_GetMacAboutMenuItemId(*args)
7051
7052 def PyApp_GetMacPreferencesMenuItemId(*args):
7053 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7054 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7055
7056 def PyApp_GetMacExitMenuItemId(*args):
7057 """PyApp_GetMacExitMenuItemId() -> long"""
7058 return _core_.PyApp_GetMacExitMenuItemId(*args)
7059
7060 def PyApp_GetMacHelpMenuTitleName(*args):
7061 """PyApp_GetMacHelpMenuTitleName() -> String"""
7062 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7063
7064 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7065 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7066 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7067
7068 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7069 """PyApp_SetMacAboutMenuItemId(long val)"""
7070 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7071
7072 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7073 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7074 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7075
7076 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7077 """PyApp_SetMacExitMenuItemId(long val)"""
7078 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7079
7080 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7081 """PyApp_SetMacHelpMenuTitleName(String val)"""
7082 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7083
7084 def PyApp_GetComCtl32Version(*args):
7085 """
7086 PyApp_GetComCtl32Version() -> int
7087
7088 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7089 it wasn't found at all. Raises an exception on non-Windows platforms.
7090 """
7091 return _core_.PyApp_GetComCtl32Version(*args)
7092
7093 def PyApp_IsDisplayAvailable(*args):
7094 """
7095 PyApp_IsDisplayAvailable() -> bool
7096
7097 Tests if it is possible to create a GUI in the current environment.
7098 This will mean different things on the different platforms.
7099
7100 * On X Windows systems this function will return ``False`` if it is
7101 not able to open a connection to the X display, which can happen
7102 if $DISPLAY is not set, or is not set correctly.
7103
7104 * On Mac OS X a ``False`` return value will mean that wx is not
7105 able to access the window manager, which can happen if logged in
7106 remotely or if running from the normal version of python instead
7107 of the framework version, (i.e., pythonw.)
7108
7109 * On MS Windows...
7110
7111 """
7112 return _core_.PyApp_IsDisplayAvailable(*args)
7113
7114 #---------------------------------------------------------------------------
7115
7116
7117 def Exit(*args):
7118 """
7119 Exit()
7120
7121 Force an exit of the application. Convenience for wx.GetApp().Exit()
7122 """
7123 return _core_.Exit(*args)
7124
7125 def Yield(*args):
7126 """
7127 Yield() -> bool
7128
7129 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7130 """
7131 return _core_.Yield(*args)
7132
7133 def YieldIfNeeded(*args):
7134 """
7135 YieldIfNeeded() -> bool
7136
7137 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7138 """
7139 return _core_.YieldIfNeeded(*args)
7140
7141 def SafeYield(*args, **kwargs):
7142 """
7143 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7144
7145 This function is similar to `wx.Yield`, except that it disables the
7146 user input to all program windows before calling `wx.Yield` and
7147 re-enables it again afterwards. If ``win`` is not None, this window
7148 will remain enabled, allowing the implementation of some limited user
7149 interaction.
7150
7151 :Returns: the result of the call to `wx.Yield`.
7152 """
7153 return _core_.SafeYield(*args, **kwargs)
7154
7155 def WakeUpIdle(*args):
7156 """
7157 WakeUpIdle()
7158
7159 Cause the message queue to become empty again, so idle events will be
7160 sent.
7161 """
7162 return _core_.WakeUpIdle(*args)
7163
7164 def PostEvent(*args, **kwargs):
7165 """
7166 PostEvent(EvtHandler dest, Event event)
7167
7168 Send an event to a window or other wx.EvtHandler to be processed
7169 later.
7170 """
7171 return _core_.PostEvent(*args, **kwargs)
7172
7173 def App_CleanUp(*args):
7174 """
7175 App_CleanUp()
7176
7177 For internal use only, it is used to cleanup after wxWidgets when
7178 Python shuts down.
7179 """
7180 return _core_.App_CleanUp(*args)
7181
7182 def GetApp(*args):
7183 """
7184 GetApp() -> PyApp
7185
7186 Return a reference to the current wx.App object.
7187 """
7188 return _core_.GetApp(*args)
7189
7190 def SetDefaultPyEncoding(*args, **kwargs):
7191 """
7192 SetDefaultPyEncoding(string encoding)
7193
7194 Sets the encoding that wxPython will use when it needs to convert a
7195 Python string or unicode object to or from a wxString.
7196
7197 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7198 but please be aware that the default encoding within the same locale
7199 may be slightly different on different platforms. For example, please
7200 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7201 between the common latin/roman encodings.
7202 """
7203 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7204
7205 def GetDefaultPyEncoding(*args):
7206 """
7207 GetDefaultPyEncoding() -> string
7208
7209 Gets the current encoding that wxPython will use when it needs to
7210 convert a Python string or unicode object to or from a wxString.
7211 """
7212 return _core_.GetDefaultPyEncoding(*args)
7213 #----------------------------------------------------------------------
7214
7215 class PyOnDemandOutputWindow:
7216 """
7217 A class that can be used for redirecting Python's stdout and
7218 stderr streams. It will do nothing until something is wrriten to
7219 the stream at which point it will create a Frame with a text area
7220 and write the text there.
7221 """
7222 def __init__(self, title = "wxPython: stdout/stderr"):
7223 self.frame = None
7224 self.title = title
7225 self.pos = wx.DefaultPosition
7226 self.size = (450, 300)
7227 self.parent = None
7228
7229 def SetParent(self, parent):
7230 """Set the window to be used as the popup Frame's parent."""
7231 self.parent = parent
7232
7233
7234 def CreateOutputWindow(self, st):
7235 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7236 style=wx.DEFAULT_FRAME_STYLE)
7237 self.text = wx.TextCtrl(self.frame, -1, "",
7238 style=wx.TE_MULTILINE|wx.TE_READONLY)
7239 self.text.AppendText(st)
7240 self.frame.Show(True)
7241 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7242
7243
7244 def OnCloseWindow(self, event):
7245 if self.frame is not None:
7246 self.frame.Destroy()
7247 self.frame = None
7248 self.text = None
7249
7250
7251 # These methods provide the file-like output behaviour.
7252 def write(self, text):
7253 """
7254 Create the output window if needed and write the string to it.
7255 If not called in the context of the gui thread then uses
7256 CallAfter to do the work there.
7257 """
7258 if self.frame is None:
7259 if not wx.Thread_IsMain():
7260 wx.CallAfter(self.CreateOutputWindow, text)
7261 else:
7262 self.CreateOutputWindow(text)
7263 else:
7264 if not wx.Thread_IsMain():
7265 wx.CallAfter(self.text.AppendText, text)
7266 else:
7267 self.text.AppendText(text)
7268
7269
7270 def close(self):
7271 if self.frame is not None:
7272 wx.CallAfter(self.frame.Close)
7273
7274
7275 def flush(self):
7276 pass
7277
7278
7279
7280 #----------------------------------------------------------------------
7281
7282 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7283
7284 class App(wx.PyApp):
7285 """
7286 The ``wx.App`` class represents the application and is used to:
7287
7288 * bootstrap the wxPython system and initialize the underlying
7289 gui toolkit
7290 * set and get application-wide properties
7291 * implement the windowing system main message or event loop,
7292 and to dispatch events to window instances
7293 * etc.
7294
7295 Every application must have a ``wx.App`` instance, and all
7296 creation of UI objects should be delayed until after the
7297 ``wx.App`` object has been created in order to ensure that the gui
7298 platform and wxWidgets have been fully initialized.
7299
7300 Normally you would derive from this class and implement an
7301 ``OnInit`` method that creates a frame and then calls
7302 ``self.SetTopWindow(frame)``.
7303
7304 :see: `wx.PySimpleApp` for a simpler app class that can be used
7305 directly.
7306 """
7307
7308 outputWindowClass = PyOnDemandOutputWindow
7309
7310 def __init__(self, redirect=_defRedirect, filename=None,
7311 useBestVisual=False, clearSigInt=True):
7312 """
7313 Construct a ``wx.App`` object.
7314
7315 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7316 redirected? Defaults to True on Windows and Mac, False
7317 otherwise. If `filename` is None then output will be
7318 redirected to a window that pops up as needed. (You can
7319 control what kind of window is created for the output by
7320 resetting the class variable ``outputWindowClass`` to a
7321 class of your choosing.)
7322
7323 :param filename: The name of a file to redirect output to, if
7324 redirect is True.
7325
7326 :param useBestVisual: Should the app try to use the best
7327 available visual provided by the system (only relevant on
7328 systems that have more than one visual.) This parameter
7329 must be used instead of calling `SetUseBestVisual` later
7330 on because it must be set before the underlying GUI
7331 toolkit is initialized.
7332
7333 :param clearSigInt: Should SIGINT be cleared? This allows the
7334 app to terminate upon a Ctrl-C in the console like other
7335 GUI apps will.
7336
7337 :note: You should override OnInit to do applicaition
7338 initialization to ensure that the system, toolkit and
7339 wxWidgets are fully initialized.
7340 """
7341
7342 wx.PyApp.__init__(self)
7343
7344 # make sure we can create a GUI
7345 if not self.IsDisplayAvailable():
7346
7347 if wx.Platform == "__WXMAC__":
7348 msg = """This program needs access to the screen.
7349 Please run with 'pythonw', not 'python', and only when you are logged
7350 in on the main display of your Mac."""
7351
7352 elif wx.Platform == "__WXGTK__":
7353 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7354
7355 else:
7356 msg = "Unable to create GUI"
7357 # TODO: more description is needed for wxMSW...
7358
7359 raise SystemExit(msg)
7360
7361 # This has to be done before OnInit
7362 self.SetUseBestVisual(useBestVisual)
7363
7364 # Set the default handler for SIGINT. This fixes a problem
7365 # where if Ctrl-C is pressed in the console that started this
7366 # app then it will not appear to do anything, (not even send
7367 # KeyboardInterrupt???) but will later segfault on exit. By
7368 # setting the default handler then the app will exit, as
7369 # expected (depending on platform.)
7370 if clearSigInt:
7371 try:
7372 import signal
7373 signal.signal(signal.SIGINT, signal.SIG_DFL)
7374 except:
7375 pass
7376
7377 # Save and redirect the stdio to a window?
7378 self.stdioWin = None
7379 self.saveStdio = (_sys.stdout, _sys.stderr)
7380 if redirect:
7381 self.RedirectStdio(filename)
7382
7383 # Use Python's install prefix as the default
7384 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7385
7386 # This finishes the initialization of wxWindows and then calls
7387 # the OnInit that should be present in the derived class
7388 self._BootstrapApp()
7389
7390
7391 def OnPreInit(self):
7392 """
7393 Things that must be done after _BootstrapApp has done its
7394 thing, but would be nice if they were already done by the time
7395 that OnInit is called.
7396 """
7397 wx.StockGDI._initStockObjects()
7398
7399
7400 def __del__(self, destroy=wx.PyApp.__del__):
7401 self.RestoreStdio() # Just in case the MainLoop was overridden
7402 destroy(self)
7403
7404 def Destroy(self):
7405 wx.PyApp.Destroy(self)
7406 self.thisown = 0
7407
7408 def SetTopWindow(self, frame):
7409 """Set the \"main\" top level window"""
7410 if self.stdioWin:
7411 self.stdioWin.SetParent(frame)
7412 wx.PyApp.SetTopWindow(self, frame)
7413
7414
7415 def MainLoop(self):
7416 """Execute the main GUI event loop"""
7417 wx.PyApp.MainLoop(self)
7418 self.RestoreStdio()
7419
7420
7421 def RedirectStdio(self, filename=None):
7422 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7423 if filename:
7424 _sys.stdout = _sys.stderr = open(filename, 'a')
7425 else:
7426 self.stdioWin = self.outputWindowClass()
7427 _sys.stdout = _sys.stderr = self.stdioWin
7428
7429
7430 def RestoreStdio(self):
7431 try:
7432 _sys.stdout, _sys.stderr = self.saveStdio
7433 except:
7434 pass
7435
7436
7437 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7438 """
7439 Set the title, position and/or size of the output window if
7440 the stdio has been redirected. This should be called before
7441 any output would cause the output window to be created.
7442 """
7443 if self.stdioWin:
7444 if title is not None:
7445 self.stdioWin.title = title
7446 if pos is not None:
7447 self.stdioWin.pos = pos
7448 if size is not None:
7449 self.stdioWin.size = size
7450
7451
7452
7453
7454 # change from wx.PyApp_XX to wx.App_XX
7455 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7456 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7457 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7458 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7459 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7460 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7461 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7462 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7463 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7464 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7465 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7466
7467 #----------------------------------------------------------------------------
7468
7469 class PySimpleApp(wx.App):
7470 """
7471 A simple application class. You can just create one of these and
7472 then then make your top level windows later, and not have to worry
7473 about OnInit. For example::
7474
7475 app = wx.PySimpleApp()
7476 frame = wx.Frame(None, title='Hello World')
7477 frame.Show()
7478 app.MainLoop()
7479
7480 :see: `wx.App`
7481 """
7482
7483 def __init__(self, redirect=False, filename=None,
7484 useBestVisual=False, clearSigInt=True):
7485 """
7486 :see: `wx.App.__init__`
7487 """
7488 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7489
7490 def OnInit(self):
7491 return True
7492
7493
7494
7495 # Is anybody using this one?
7496 class PyWidgetTester(wx.App):
7497 def __init__(self, size = (250, 100)):
7498 self.size = size
7499 wx.App.__init__(self, 0)
7500
7501 def OnInit(self):
7502 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7503 self.SetTopWindow(self.frame)
7504 return True
7505
7506 def SetWidget(self, widgetClass, *args, **kwargs):
7507 w = widgetClass(self.frame, *args, **kwargs)
7508 self.frame.Show(True)
7509
7510 #----------------------------------------------------------------------------
7511 # DO NOT hold any other references to this object. This is how we
7512 # know when to cleanup system resources that wxWidgets is holding. When
7513 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7514 # goes to zero and it calls the wx.App_CleanUp function.
7515
7516 class __wxPyCleanup:
7517 def __init__(self):
7518 self.cleanup = _core_.App_CleanUp
7519 def __del__(self):
7520 self.cleanup()
7521
7522 _sys.__wxPythonCleanup = __wxPyCleanup()
7523
7524 ## # another possible solution, but it gets called too early...
7525 ## import atexit
7526 ## atexit.register(_core_.wxApp_CleanUp)
7527
7528
7529 #----------------------------------------------------------------------------
7530
7531 #---------------------------------------------------------------------------
7532
7533 class EventLoop(object):
7534 """Proxy of C++ EventLoop class"""
7535 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7536 __repr__ = _swig_repr
7537 def __init__(self, *args, **kwargs):
7538 """__init__(self) -> EventLoop"""
7539 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7540 __swig_destroy__ = _core_.delete_EventLoop
7541 __del__ = lambda self : None;
7542 def Run(*args, **kwargs):
7543 """Run(self) -> int"""
7544 return _core_.EventLoop_Run(*args, **kwargs)
7545
7546 def Exit(*args, **kwargs):
7547 """Exit(self, int rc=0)"""
7548 return _core_.EventLoop_Exit(*args, **kwargs)
7549
7550 def Pending(*args, **kwargs):
7551 """Pending(self) -> bool"""
7552 return _core_.EventLoop_Pending(*args, **kwargs)
7553
7554 def Dispatch(*args, **kwargs):
7555 """Dispatch(self) -> bool"""
7556 return _core_.EventLoop_Dispatch(*args, **kwargs)
7557
7558 def IsRunning(*args, **kwargs):
7559 """IsRunning(self) -> bool"""
7560 return _core_.EventLoop_IsRunning(*args, **kwargs)
7561
7562 def GetActive(*args, **kwargs):
7563 """GetActive() -> EventLoop"""
7564 return _core_.EventLoop_GetActive(*args, **kwargs)
7565
7566 GetActive = staticmethod(GetActive)
7567 def SetActive(*args, **kwargs):
7568 """SetActive(EventLoop loop)"""
7569 return _core_.EventLoop_SetActive(*args, **kwargs)
7570
7571 SetActive = staticmethod(SetActive)
7572 _core_.EventLoop_swigregister(EventLoop)
7573
7574 def EventLoop_GetActive(*args):
7575 """EventLoop_GetActive() -> EventLoop"""
7576 return _core_.EventLoop_GetActive(*args)
7577
7578 def EventLoop_SetActive(*args, **kwargs):
7579 """EventLoop_SetActive(EventLoop loop)"""
7580 return _core_.EventLoop_SetActive(*args, **kwargs)
7581
7582 class EventLoopActivator(object):
7583 """Proxy of C++ EventLoopActivator class"""
7584 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7585 __repr__ = _swig_repr
7586 def __init__(self, *args, **kwargs):
7587 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7588 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7589 __swig_destroy__ = _core_.delete_EventLoopActivator
7590 __del__ = lambda self : None;
7591 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7592
7593 #---------------------------------------------------------------------------
7594
7595 ACCEL_ALT = _core_.ACCEL_ALT
7596 ACCEL_CTRL = _core_.ACCEL_CTRL
7597 ACCEL_SHIFT = _core_.ACCEL_SHIFT
7598 ACCEL_NORMAL = _core_.ACCEL_NORMAL
7599 ACCEL_CMD = _core_.ACCEL_CMD
7600 class AcceleratorEntry(object):
7601 """
7602 A class used to define items in an `wx.AcceleratorTable`. wxPython
7603 programs can choose to use wx.AcceleratorEntry objects, but using a
7604 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7605 as well. See `__init__` for of the tuple values.
7606
7607 :see: `wx.AcceleratorTable`
7608 """
7609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7610 __repr__ = _swig_repr
7611 def __init__(self, *args, **kwargs):
7612 """
7613 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7614
7615 Construct a wx.AcceleratorEntry.
7616 """
7617 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7618 __swig_destroy__ = _core_.delete_AcceleratorEntry
7619 __del__ = lambda self : None;
7620 def Set(*args, **kwargs):
7621 """
7622 Set(self, int flags, int keyCode, int cmd)
7623
7624 (Re)set the attributes of a wx.AcceleratorEntry.
7625 :see `__init__`
7626 """
7627 return _core_.AcceleratorEntry_Set(*args, **kwargs)
7628
7629 def Create(*args, **kwargs):
7630 """
7631 Create(String str) -> AcceleratorEntry
7632
7633 Create accelerator corresponding to the specified string, or None if
7634 it coulnd't be parsed.
7635 """
7636 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7637
7638 Create = staticmethod(Create)
7639 def GetFlags(*args, **kwargs):
7640 """
7641 GetFlags(self) -> int
7642
7643 Get the AcceleratorEntry's flags.
7644 """
7645 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7646
7647 def GetKeyCode(*args, **kwargs):
7648 """
7649 GetKeyCode(self) -> int
7650
7651 Get the AcceleratorEntry's keycode.
7652 """
7653 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7654
7655 def GetCommand(*args, **kwargs):
7656 """
7657 GetCommand(self) -> int
7658
7659 Get the AcceleratorEntry's command ID.
7660 """
7661 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7662
7663 def IsOk(*args, **kwargs):
7664 """IsOk(self) -> bool"""
7665 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
7666
7667 def ToString(*args, **kwargs):
7668 """
7669 ToString(self) -> String
7670
7671 Returns a string representation for the this accelerator. The string
7672 is formatted using the <flags>-<keycode> format where <flags> maybe a
7673 hyphen-separed list of "shift|alt|ctrl"
7674
7675 """
7676 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
7677
7678 def FromString(*args, **kwargs):
7679 """
7680 FromString(self, String str) -> bool
7681
7682 Returns true if the given string correctly initialized this object.
7683 """
7684 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
7685
7686 Command = property(GetCommand,doc="See `GetCommand`")
7687 Flags = property(GetFlags,doc="See `GetFlags`")
7688 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
7689 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
7690
7691 def AcceleratorEntry_Create(*args, **kwargs):
7692 """
7693 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7694
7695 Create accelerator corresponding to the specified string, or None if
7696 it coulnd't be parsed.
7697 """
7698 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7699
7700 class AcceleratorTable(Object):
7701 """
7702 An accelerator table allows the application to specify a table of
7703 keyboard shortcuts for menus or other commands. On Windows, menu or
7704 button commands are supported; on GTK, only menu commands are
7705 supported.
7706 """
7707 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7708 __repr__ = _swig_repr
7709 def __init__(self, *args, **kwargs):
7710 """
7711 __init__(entries) -> AcceleratorTable
7712
7713 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7714 items or or of 3-tuples (flags, keyCode, cmdID)
7715
7716 :see: `wx.AcceleratorEntry`
7717 """
7718 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7719 __swig_destroy__ = _core_.delete_AcceleratorTable
7720 __del__ = lambda self : None;
7721 def Ok(*args, **kwargs):
7722 """Ok(self) -> bool"""
7723 return _core_.AcceleratorTable_Ok(*args, **kwargs)
7724
7725 _core_.AcceleratorTable_swigregister(AcceleratorTable)
7726
7727
7728 def GetAccelFromString(*args, **kwargs):
7729 """GetAccelFromString(String label) -> AcceleratorEntry"""
7730 return _core_.GetAccelFromString(*args, **kwargs)
7731 #---------------------------------------------------------------------------
7732
7733 class VisualAttributes(object):
7734 """struct containing all the visual attributes of a control"""
7735 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7736 __repr__ = _swig_repr
7737 def __init__(self, *args, **kwargs):
7738 """
7739 __init__(self) -> VisualAttributes
7740
7741 struct containing all the visual attributes of a control
7742 """
7743 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7744 __swig_destroy__ = _core_.delete_VisualAttributes
7745 __del__ = lambda self : None;
7746 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7747 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7748 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
7749 _core_.VisualAttributes_swigregister(VisualAttributes)
7750 NullAcceleratorTable = cvar.NullAcceleratorTable
7751 PanelNameStr = cvar.PanelNameStr
7752
7753 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7754 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7755 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7756 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7757 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7758 class Window(EvtHandler):
7759 """
7760 wx.Window is the base class for all windows and represents any visible
7761 object on the screen. All controls, top level windows and so on are
7762 wx.Windows. Sizers and device contexts are not however, as they don't
7763 appear on screen themselves.
7764
7765 """
7766 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7767 __repr__ = _swig_repr
7768 def __init__(self, *args, **kwargs):
7769 """
7770 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7771 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7772
7773 Construct and show a generic Window.
7774 """
7775 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
7776 self._setOORInfo(self)
7777
7778 def Create(*args, **kwargs):
7779 """
7780 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7781 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7782
7783 Create the GUI part of the Window for 2-phase creation mode.
7784 """
7785 return _core_.Window_Create(*args, **kwargs)
7786
7787 def Close(*args, **kwargs):
7788 """
7789 Close(self, bool force=False) -> bool
7790
7791 This function simply generates a EVT_CLOSE event whose handler usually
7792 tries to close the window. It doesn't close the window itself,
7793 however. If force is False (the default) then the window's close
7794 handler will be allowed to veto the destruction of the window.
7795 """
7796 return _core_.Window_Close(*args, **kwargs)
7797
7798 def Destroy(*args, **kwargs):
7799 """
7800 Destroy(self) -> bool
7801
7802 Destroys the window safely. Frames and dialogs are not destroyed
7803 immediately when this function is called -- they are added to a list
7804 of windows to be deleted on idle time, when all the window's events
7805 have been processed. This prevents problems with events being sent to
7806 non-existent windows.
7807
7808 Returns True if the window has either been successfully deleted, or it
7809 has been added to the list of windows pending real deletion.
7810 """
7811 val = _core_.Window_Destroy(*args, **kwargs)
7812 args[0].thisown = 0
7813 return val
7814
7815 def DestroyChildren(*args, **kwargs):
7816 """
7817 DestroyChildren(self) -> bool
7818
7819 Destroys all children of a window. Called automatically by the
7820 destructor.
7821 """
7822 return _core_.Window_DestroyChildren(*args, **kwargs)
7823
7824 def IsBeingDeleted(*args, **kwargs):
7825 """
7826 IsBeingDeleted(self) -> bool
7827
7828 Is the window in the process of being deleted?
7829 """
7830 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7831
7832 def SetLabel(*args, **kwargs):
7833 """
7834 SetLabel(self, String label)
7835
7836 Set the text which the window shows in its label if applicable.
7837 """
7838 return _core_.Window_SetLabel(*args, **kwargs)
7839
7840 def GetLabel(*args, **kwargs):
7841 """
7842 GetLabel(self) -> String
7843
7844 Generic way of getting a label from any window, for identification
7845 purposes. The interpretation of this function differs from class to
7846 class. For frames and dialogs, the value returned is the title. For
7847 buttons or static text controls, it is the button text. This function
7848 can be useful for meta-programs such as testing tools or special-needs
7849 access programs)which need to identify windows by name.
7850 """
7851 return _core_.Window_GetLabel(*args, **kwargs)
7852
7853 def SetName(*args, **kwargs):
7854 """
7855 SetName(self, String name)
7856
7857 Sets the window's name. The window name is used for ressource setting
7858 in X, it is not the same as the window title/label
7859 """
7860 return _core_.Window_SetName(*args, **kwargs)
7861
7862 def GetName(*args, **kwargs):
7863 """
7864 GetName(self) -> String
7865
7866 Returns the windows name. This name is not guaranteed to be unique;
7867 it is up to the programmer to supply an appropriate name in the window
7868 constructor or via wx.Window.SetName.
7869 """
7870 return _core_.Window_GetName(*args, **kwargs)
7871
7872 def SetWindowVariant(*args, **kwargs):
7873 """
7874 SetWindowVariant(self, int variant)
7875
7876 Sets the variant of the window/font size to use for this window, if
7877 the platform supports variants, for example, wxMac.
7878 """
7879 return _core_.Window_SetWindowVariant(*args, **kwargs)
7880
7881 def GetWindowVariant(*args, **kwargs):
7882 """GetWindowVariant(self) -> int"""
7883 return _core_.Window_GetWindowVariant(*args, **kwargs)
7884
7885 def SetId(*args, **kwargs):
7886 """
7887 SetId(self, int winid)
7888
7889 Sets the identifier of the window. Each window has an integer
7890 identifier. If the application has not provided one, an identifier
7891 will be generated. Normally, the identifier should be provided on
7892 creation and should not be modified subsequently.
7893 """
7894 return _core_.Window_SetId(*args, **kwargs)
7895
7896 def GetId(*args, **kwargs):
7897 """
7898 GetId(self) -> int
7899
7900 Returns the identifier of the window. Each window has an integer
7901 identifier. If the application has not provided one (or the default Id
7902 -1 is used) then an unique identifier with a negative value will be
7903 generated.
7904 """
7905 return _core_.Window_GetId(*args, **kwargs)
7906
7907 def NewControlId(*args, **kwargs):
7908 """
7909 NewControlId() -> int
7910
7911 Generate a control id for the controls which were not given one.
7912 """
7913 return _core_.Window_NewControlId(*args, **kwargs)
7914
7915 NewControlId = staticmethod(NewControlId)
7916 def NextControlId(*args, **kwargs):
7917 """
7918 NextControlId(int winid) -> int
7919
7920 Get the id of the control following the one with the given
7921 autogenerated) id
7922 """
7923 return _core_.Window_NextControlId(*args, **kwargs)
7924
7925 NextControlId = staticmethod(NextControlId)
7926 def PrevControlId(*args, **kwargs):
7927 """
7928 PrevControlId(int winid) -> int
7929
7930 Get the id of the control preceding the one with the given
7931 autogenerated) id
7932 """
7933 return _core_.Window_PrevControlId(*args, **kwargs)
7934
7935 PrevControlId = staticmethod(PrevControlId)
7936 def GetLayoutDirection(*args, **kwargs):
7937 """
7938 GetLayoutDirection(self) -> int
7939
7940 Get the layout direction (LTR or RTL) for this window. Returns
7941 ``wx.Layout_Default`` if layout direction is not supported.
7942 """
7943 return _core_.Window_GetLayoutDirection(*args, **kwargs)
7944
7945 def SetLayoutDirection(*args, **kwargs):
7946 """
7947 SetLayoutDirection(self, int dir)
7948
7949 Set the layout direction (LTR or RTL) for this window.
7950 """
7951 return _core_.Window_SetLayoutDirection(*args, **kwargs)
7952
7953 def AdjustForLayoutDirection(*args, **kwargs):
7954 """
7955 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
7956
7957 Mirror coordinates for RTL layout if this window uses it and if the
7958 mirroring is not done automatically like Win32.
7959 """
7960 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
7961
7962 def SetSize(*args, **kwargs):
7963 """
7964 SetSize(self, Size size)
7965
7966 Sets the size of the window in pixels.
7967 """
7968 return _core_.Window_SetSize(*args, **kwargs)
7969
7970 def SetDimensions(*args, **kwargs):
7971 """
7972 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
7973
7974 Sets the position and size of the window in pixels. The sizeFlags
7975 parameter indicates the interpretation of the other params if they are
7976 equal to -1.
7977
7978 ======================== ======================================
7979 wx.SIZE_AUTO A -1 indicates that a class-specific
7980 default should be used.
7981 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
7982 -1 values are supplied.
7983 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
7984 interpreted as real dimensions, not
7985 default values.
7986 ======================== ======================================
7987
7988 """
7989 return _core_.Window_SetDimensions(*args, **kwargs)
7990
7991 def SetRect(*args, **kwargs):
7992 """
7993 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
7994
7995 Sets the position and size of the window in pixels using a wx.Rect.
7996 """
7997 return _core_.Window_SetRect(*args, **kwargs)
7998
7999 def SetSizeWH(*args, **kwargs):
8000 """
8001 SetSizeWH(self, int width, int height)
8002
8003 Sets the size of the window in pixels.
8004 """
8005 return _core_.Window_SetSizeWH(*args, **kwargs)
8006
8007 def Move(*args, **kwargs):
8008 """
8009 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8010
8011 Moves the window to the given position.
8012 """
8013 return _core_.Window_Move(*args, **kwargs)
8014
8015 SetPosition = Move
8016 def MoveXY(*args, **kwargs):
8017 """
8018 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8019
8020 Moves the window to the given position.
8021 """
8022 return _core_.Window_MoveXY(*args, **kwargs)
8023
8024 def SetBestFittingSize(*args, **kwargs):
8025 """
8026 SetBestFittingSize(self, Size size=DefaultSize)
8027
8028 A 'Smart' SetSize that will fill in default size components with the
8029 window's *best size* values. Also set's the minsize for use with sizers.
8030 """
8031 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8032
8033 def Raise(*args, **kwargs):
8034 """
8035 Raise(self)
8036
8037 Raises the window to the top of the window hierarchy. In current
8038 version of wxWidgets this works both for manage and child windows.
8039 """
8040 return _core_.Window_Raise(*args, **kwargs)
8041
8042 def Lower(*args, **kwargs):
8043 """
8044 Lower(self)
8045
8046 Lowers the window to the bottom of the window hierarchy. In current
8047 version of wxWidgets this works both for manage and child windows.
8048 """
8049 return _core_.Window_Lower(*args, **kwargs)
8050
8051 def SetClientSize(*args, **kwargs):
8052 """
8053 SetClientSize(self, Size size)
8054
8055 This sets the size of the window client area in pixels. Using this
8056 function to size a window tends to be more device-independent than
8057 wx.Window.SetSize, since the application need not worry about what
8058 dimensions the border or title bar have when trying to fit the window
8059 around panel items, for example.
8060 """
8061 return _core_.Window_SetClientSize(*args, **kwargs)
8062
8063 def SetClientSizeWH(*args, **kwargs):
8064 """
8065 SetClientSizeWH(self, int width, int height)
8066
8067 This sets the size of the window client area in pixels. Using this
8068 function to size a window tends to be more device-independent than
8069 wx.Window.SetSize, since the application need not worry about what
8070 dimensions the border or title bar have when trying to fit the window
8071 around panel items, for example.
8072 """
8073 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8074
8075 def SetClientRect(*args, **kwargs):
8076 """
8077 SetClientRect(self, Rect rect)
8078
8079 This sets the size of the window client area in pixels. Using this
8080 function to size a window tends to be more device-independent than
8081 wx.Window.SetSize, since the application need not worry about what
8082 dimensions the border or title bar have when trying to fit the window
8083 around panel items, for example.
8084 """
8085 return _core_.Window_SetClientRect(*args, **kwargs)
8086
8087 def GetPosition(*args, **kwargs):
8088 """
8089 GetPosition(self) -> Point
8090
8091 Get the window's position. Notice that the position is in client
8092 coordinates for child windows and screen coordinates for the top level
8093 ones, use `GetScreenPosition` if you need screen coordinates for all
8094 kinds of windows.
8095 """
8096 return _core_.Window_GetPosition(*args, **kwargs)
8097
8098 def GetPositionTuple(*args, **kwargs):
8099 """
8100 GetPositionTuple() -> (x,y)
8101
8102 Get the window's position. Notice that the position is in client
8103 coordinates for child windows and screen coordinates for the top level
8104 ones, use `GetScreenPosition` if you need screen coordinates for all
8105 kinds of windows.
8106 """
8107 return _core_.Window_GetPositionTuple(*args, **kwargs)
8108
8109 def GetScreenPosition(*args, **kwargs):
8110 """
8111 GetScreenPosition(self) -> Point
8112
8113 Get the position of the window in screen coordinantes.
8114 """
8115 return _core_.Window_GetScreenPosition(*args, **kwargs)
8116
8117 def GetScreenPositionTuple(*args, **kwargs):
8118 """
8119 GetScreenPositionTuple() -> (x,y)
8120
8121 Get the position of the window in screen coordinantes.
8122 """
8123 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8124
8125 def GetScreenRect(*args, **kwargs):
8126 """
8127 GetScreenRect(self) -> Rect
8128
8129 Returns the size and position of the window in screen coordinantes as
8130 a `wx.Rect` object.
8131 """
8132 return _core_.Window_GetScreenRect(*args, **kwargs)
8133
8134 def GetSize(*args, **kwargs):
8135 """
8136 GetSize(self) -> Size
8137
8138 Get the window size.
8139 """
8140 return _core_.Window_GetSize(*args, **kwargs)
8141
8142 def GetSizeTuple(*args, **kwargs):
8143 """
8144 GetSizeTuple() -> (width, height)
8145
8146 Get the window size.
8147 """
8148 return _core_.Window_GetSizeTuple(*args, **kwargs)
8149
8150 def GetRect(*args, **kwargs):
8151 """
8152 GetRect(self) -> Rect
8153
8154 Returns the size and position of the window as a `wx.Rect` object.
8155 """
8156 return _core_.Window_GetRect(*args, **kwargs)
8157
8158 def GetClientSize(*args, **kwargs):
8159 """
8160 GetClientSize(self) -> Size
8161
8162 This gets the size of the window's 'client area' in pixels. The client
8163 area is the area which may be drawn on by the programmer, excluding
8164 title bar, border, scrollbars, etc.
8165 """
8166 return _core_.Window_GetClientSize(*args, **kwargs)
8167
8168 def GetClientSizeTuple(*args, **kwargs):
8169 """
8170 GetClientSizeTuple() -> (width, height)
8171
8172 This gets the size of the window's 'client area' in pixels. The client
8173 area is the area which may be drawn on by the programmer, excluding
8174 title bar, border, scrollbars, etc.
8175 """
8176 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8177
8178 def GetClientAreaOrigin(*args, **kwargs):
8179 """
8180 GetClientAreaOrigin(self) -> Point
8181
8182 Get the origin of the client area of the window relative to the
8183 window's top left corner (the client area may be shifted because of
8184 the borders, scrollbars, other decorations...)
8185 """
8186 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8187
8188 def GetClientRect(*args, **kwargs):
8189 """
8190 GetClientRect(self) -> Rect
8191
8192 Get the client area position and size as a `wx.Rect` object.
8193 """
8194 return _core_.Window_GetClientRect(*args, **kwargs)
8195
8196 def GetBestSize(*args, **kwargs):
8197 """
8198 GetBestSize(self) -> Size
8199
8200 This function returns the best acceptable minimal size for the
8201 window, if applicable. For example, for a static text control, it will
8202 be the minimal size such that the control label is not truncated. For
8203 windows containing subwindows (suzh aswx.Panel), the size returned by
8204 this function will be the same as the size the window would have had
8205 after calling Fit.
8206 """
8207 return _core_.Window_GetBestSize(*args, **kwargs)
8208
8209 def GetBestSizeTuple(*args, **kwargs):
8210 """
8211 GetBestSizeTuple() -> (width, height)
8212
8213 This function returns the best acceptable minimal size for the
8214 window, if applicable. For example, for a static text control, it will
8215 be the minimal size such that the control label is not truncated. For
8216 windows containing subwindows (suzh aswx.Panel), the size returned by
8217 this function will be the same as the size the window would have had
8218 after calling Fit.
8219 """
8220 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8221
8222 def InvalidateBestSize(*args, **kwargs):
8223 """
8224 InvalidateBestSize(self)
8225
8226 Reset the cached best size value so it will be recalculated the next
8227 time it is needed.
8228 """
8229 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8230
8231 def CacheBestSize(*args, **kwargs):
8232 """
8233 CacheBestSize(self, Size size)
8234
8235 Cache the best size so it doesn't need to be calculated again, (at least until
8236 some properties of the window change.)
8237 """
8238 return _core_.Window_CacheBestSize(*args, **kwargs)
8239
8240 def GetBestFittingSize(*args, **kwargs):
8241 """
8242 GetBestFittingSize(self) -> Size
8243
8244 This function will merge the window's best size into the window's
8245 minimum size, giving priority to the min size components, and returns
8246 the results.
8247
8248 """
8249 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8250
8251 def GetAdjustedBestSize(*args, **kwargs):
8252 """
8253 GetAdjustedBestSize(self) -> Size
8254
8255 This method is similar to GetBestSize, except in one
8256 thing. GetBestSize should return the minimum untruncated size of the
8257 window, while this method will return the largest of BestSize and any
8258 user specified minimum size. ie. it is the minimum size the window
8259 should currently be drawn at, not the minimal size it can possibly
8260 tolerate.
8261 """
8262 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8263
8264 def Center(*args, **kwargs):
8265 """
8266 Center(self, int direction=BOTH)
8267
8268 Centers the window. The parameter specifies the direction for
8269 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8270 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8271 on the entire screen and not on its parent window. If it is a
8272 top-level window and has no parent then it will always be centered
8273 relative to the screen.
8274 """
8275 return _core_.Window_Center(*args, **kwargs)
8276
8277 Centre = Center
8278 def CenterOnParent(*args, **kwargs):
8279 """
8280 CenterOnParent(self, int dir=BOTH)
8281
8282 Center with respect to the the parent window
8283 """
8284 return _core_.Window_CenterOnParent(*args, **kwargs)
8285
8286 CentreOnParent = CenterOnParent
8287 def Fit(*args, **kwargs):
8288 """
8289 Fit(self)
8290
8291 Sizes the window so that it fits around its subwindows. This function
8292 won't do anything if there are no subwindows and will only really work
8293 correctly if sizers are used for the subwindows layout. Also, if the
8294 window has exactly one subwindow it is better (faster and the result
8295 is more precise as Fit adds some margin to account for fuzziness of
8296 its calculations) to call window.SetClientSize(child.GetSize())
8297 instead of calling Fit.
8298 """
8299 return _core_.Window_Fit(*args, **kwargs)
8300
8301 def FitInside(*args, **kwargs):
8302 """
8303 FitInside(self)
8304
8305 Similar to Fit, but sizes the interior (virtual) size of a
8306 window. Mainly useful with scrolled windows to reset scrollbars after
8307 sizing changes that do not trigger a size event, and/or scrolled
8308 windows without an interior sizer. This function similarly won't do
8309 anything if there are no subwindows.
8310 """
8311 return _core_.Window_FitInside(*args, **kwargs)
8312
8313 def SetSizeHints(*args, **kwargs):
8314 """
8315 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8316 int incH=-1)
8317
8318 Allows specification of minimum and maximum window sizes, and window
8319 size increments. If a pair of values is not set (or set to -1), the
8320 default values will be used. If this function is called, the user
8321 will not be able to size the window outside the given bounds (if it is
8322 a top-level window.) Sizers will also inspect the minimum window size
8323 and will use that value if set when calculating layout.
8324
8325 The resizing increments are only significant under Motif or Xt.
8326 """
8327 return _core_.Window_SetSizeHints(*args, **kwargs)
8328
8329 def SetSizeHintsSz(*args, **kwargs):
8330 """
8331 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8332
8333 Allows specification of minimum and maximum window sizes, and window
8334 size increments. If a pair of values is not set (or set to -1), the
8335 default values will be used. If this function is called, the user
8336 will not be able to size the window outside the given bounds (if it is
8337 a top-level window.) Sizers will also inspect the minimum window size
8338 and will use that value if set when calculating layout.
8339
8340 The resizing increments are only significant under Motif or Xt.
8341 """
8342 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8343
8344 def SetVirtualSizeHints(*args, **kwargs):
8345 """
8346 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8347
8348 Allows specification of minimum and maximum virtual window sizes. If a
8349 pair of values is not set (or set to -1), the default values will be
8350 used. If this function is called, the user will not be able to size
8351 the virtual area of the window outside the given bounds.
8352 """
8353 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8354
8355 def SetVirtualSizeHintsSz(*args, **kwargs):
8356 """
8357 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8358
8359 Allows specification of minimum and maximum virtual window sizes. If a
8360 pair of values is not set (or set to -1), the default values will be
8361 used. If this function is called, the user will not be able to size
8362 the virtual area of the window outside the given bounds.
8363 """
8364 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8365
8366 def GetMaxSize(*args, **kwargs):
8367 """GetMaxSize(self) -> Size"""
8368 return _core_.Window_GetMaxSize(*args, **kwargs)
8369
8370 def GetMinSize(*args, **kwargs):
8371 """GetMinSize(self) -> Size"""
8372 return _core_.Window_GetMinSize(*args, **kwargs)
8373
8374 def SetMinSize(*args, **kwargs):
8375 """
8376 SetMinSize(self, Size minSize)
8377
8378 A more convenient method than `SetSizeHints` for setting just the
8379 min size.
8380 """
8381 return _core_.Window_SetMinSize(*args, **kwargs)
8382
8383 def SetMaxSize(*args, **kwargs):
8384 """
8385 SetMaxSize(self, Size maxSize)
8386
8387 A more convenient method than `SetSizeHints` for setting just the
8388 max size.
8389 """
8390 return _core_.Window_SetMaxSize(*args, **kwargs)
8391
8392 def GetMinWidth(*args, **kwargs):
8393 """GetMinWidth(self) -> int"""
8394 return _core_.Window_GetMinWidth(*args, **kwargs)
8395
8396 def GetMinHeight(*args, **kwargs):
8397 """GetMinHeight(self) -> int"""
8398 return _core_.Window_GetMinHeight(*args, **kwargs)
8399
8400 def GetMaxWidth(*args, **kwargs):
8401 """GetMaxWidth(self) -> int"""
8402 return _core_.Window_GetMaxWidth(*args, **kwargs)
8403
8404 def GetMaxHeight(*args, **kwargs):
8405 """GetMaxHeight(self) -> int"""
8406 return _core_.Window_GetMaxHeight(*args, **kwargs)
8407
8408 def SetVirtualSize(*args, **kwargs):
8409 """
8410 SetVirtualSize(self, Size size)
8411
8412 Set the the virtual size of a window in pixels. For most windows this
8413 is just the client area of the window, but for some like scrolled
8414 windows it is more or less independent of the screen window size.
8415 """
8416 return _core_.Window_SetVirtualSize(*args, **kwargs)
8417
8418 def SetVirtualSizeWH(*args, **kwargs):
8419 """
8420 SetVirtualSizeWH(self, int w, int h)
8421
8422 Set the the virtual size of a window in pixels. For most windows this
8423 is just the client area of the window, but for some like scrolled
8424 windows it is more or less independent of the screen window size.
8425 """
8426 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8427
8428 def GetVirtualSize(*args, **kwargs):
8429 """
8430 GetVirtualSize(self) -> Size
8431
8432 Get the the virtual size of the window in pixels. For most windows
8433 this is just the client area of the window, but for some like scrolled
8434 windows it is more or less independent of the screen window size.
8435 """
8436 return _core_.Window_GetVirtualSize(*args, **kwargs)
8437
8438 def GetVirtualSizeTuple(*args, **kwargs):
8439 """
8440 GetVirtualSizeTuple() -> (width, height)
8441
8442 Get the the virtual size of the window in pixels. For most windows
8443 this is just the client area of the window, but for some like scrolled
8444 windows it is more or less independent of the screen window size.
8445 """
8446 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8447
8448 def GetBestVirtualSize(*args, **kwargs):
8449 """
8450 GetBestVirtualSize(self) -> Size
8451
8452 Return the largest of ClientSize and BestSize (as determined by a
8453 sizer, interior children, or other means)
8454 """
8455 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8456
8457 def Show(*args, **kwargs):
8458 """
8459 Show(self, bool show=True) -> bool
8460
8461 Shows or hides the window. You may need to call Raise for a top level
8462 window if you want to bring it to top, although this is not needed if
8463 Show is called immediately after the frame creation. Returns True if
8464 the window has been shown or hidden or False if nothing was done
8465 because it already was in the requested state.
8466 """
8467 return _core_.Window_Show(*args, **kwargs)
8468
8469 def Hide(*args, **kwargs):
8470 """
8471 Hide(self) -> bool
8472
8473 Equivalent to calling Show(False).
8474 """
8475 return _core_.Window_Hide(*args, **kwargs)
8476
8477 def Enable(*args, **kwargs):
8478 """
8479 Enable(self, bool enable=True) -> bool
8480
8481 Enable or disable the window for user input. Note that when a parent
8482 window is disabled, all of its children are disabled as well and they
8483 are reenabled again when the parent is. Returns true if the window
8484 has been enabled or disabled, false if nothing was done, i.e. if the
8485 window had already been in the specified state.
8486 """
8487 return _core_.Window_Enable(*args, **kwargs)
8488
8489 def Disable(*args, **kwargs):
8490 """
8491 Disable(self) -> bool
8492
8493 Disables the window, same as Enable(false).
8494 """
8495 return _core_.Window_Disable(*args, **kwargs)
8496
8497 def IsShown(*args, **kwargs):
8498 """
8499 IsShown(self) -> bool
8500
8501 Returns true if the window is shown, false if it has been hidden.
8502 """
8503 return _core_.Window_IsShown(*args, **kwargs)
8504
8505 def IsEnabled(*args, **kwargs):
8506 """
8507 IsEnabled(self) -> bool
8508
8509 Returns true if the window is enabled for input, false otherwise.
8510 """
8511 return _core_.Window_IsEnabled(*args, **kwargs)
8512
8513 def IsShownOnScreen(*args, **kwargs):
8514 """
8515 IsShownOnScreen(self) -> bool
8516
8517 Returns ``True`` if the window is physically visible on the screen,
8518 i.e. it is shown and all its parents up to the toplevel window are
8519 shown as well.
8520 """
8521 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8522
8523 def SetWindowStyleFlag(*args, **kwargs):
8524 """
8525 SetWindowStyleFlag(self, long style)
8526
8527 Sets the style of the window. Please note that some styles cannot be
8528 changed after the window creation and that Refresh() might need to be
8529 called after changing the others for the change to take place
8530 immediately.
8531 """
8532 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8533
8534 def GetWindowStyleFlag(*args, **kwargs):
8535 """
8536 GetWindowStyleFlag(self) -> long
8537
8538 Gets the window style that was passed to the constructor or Create
8539 method.
8540 """
8541 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8542
8543 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8544 def HasFlag(*args, **kwargs):
8545 """
8546 HasFlag(self, int flag) -> bool
8547
8548 Test if the given style is set for this window.
8549 """
8550 return _core_.Window_HasFlag(*args, **kwargs)
8551
8552 def IsRetained(*args, **kwargs):
8553 """
8554 IsRetained(self) -> bool
8555
8556 Returns true if the window is retained, false otherwise. Retained
8557 windows are only available on X platforms.
8558 """
8559 return _core_.Window_IsRetained(*args, **kwargs)
8560
8561 def SetExtraStyle(*args, **kwargs):
8562 """
8563 SetExtraStyle(self, long exStyle)
8564
8565 Sets the extra style bits for the window. Extra styles are the less
8566 often used style bits which can't be set with the constructor or with
8567 SetWindowStyleFlag()
8568 """
8569 return _core_.Window_SetExtraStyle(*args, **kwargs)
8570
8571 def GetExtraStyle(*args, **kwargs):
8572 """
8573 GetExtraStyle(self) -> long
8574
8575 Returns the extra style bits for the window.
8576 """
8577 return _core_.Window_GetExtraStyle(*args, **kwargs)
8578
8579 def MakeModal(*args, **kwargs):
8580 """
8581 MakeModal(self, bool modal=True)
8582
8583 Disables all other windows in the application so that the user can
8584 only interact with this window. Passing False will reverse this
8585 effect.
8586 """
8587 return _core_.Window_MakeModal(*args, **kwargs)
8588
8589 def SetThemeEnabled(*args, **kwargs):
8590 """
8591 SetThemeEnabled(self, bool enableTheme)
8592
8593 This function tells a window if it should use the system's "theme"
8594 code to draw the windows' background instead if its own background
8595 drawing code. This will only have an effect on platforms that support
8596 the notion of themes in user defined windows. One such platform is
8597 GTK+ where windows can have (very colourful) backgrounds defined by a
8598 user's selected theme.
8599
8600 Dialogs, notebook pages and the status bar have this flag set to true
8601 by default so that the default look and feel is simulated best.
8602 """
8603 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8604
8605 def GetThemeEnabled(*args, **kwargs):
8606 """
8607 GetThemeEnabled(self) -> bool
8608
8609 Return the themeEnabled flag.
8610 """
8611 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8612
8613 def SetFocus(*args, **kwargs):
8614 """
8615 SetFocus(self)
8616
8617 Set's the focus to this window, allowing it to receive keyboard input.
8618 """
8619 return _core_.Window_SetFocus(*args, **kwargs)
8620
8621 def SetFocusFromKbd(*args, **kwargs):
8622 """
8623 SetFocusFromKbd(self)
8624
8625 Set focus to this window as the result of a keyboard action. Normally
8626 only called internally.
8627 """
8628 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8629
8630 def FindFocus(*args, **kwargs):
8631 """
8632 FindFocus() -> Window
8633
8634 Returns the window or control that currently has the keyboard focus,
8635 or None.
8636 """
8637 return _core_.Window_FindFocus(*args, **kwargs)
8638
8639 FindFocus = staticmethod(FindFocus)
8640 def AcceptsFocus(*args, **kwargs):
8641 """
8642 AcceptsFocus(self) -> bool
8643
8644 Can this window have focus?
8645 """
8646 return _core_.Window_AcceptsFocus(*args, **kwargs)
8647
8648 def AcceptsFocusFromKeyboard(*args, **kwargs):
8649 """
8650 AcceptsFocusFromKeyboard(self) -> bool
8651
8652 Can this window be given focus by keyboard navigation? if not, the
8653 only way to give it focus (provided it accepts it at all) is to click
8654 it.
8655 """
8656 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8657
8658 def Navigate(*args, **kwargs):
8659 """
8660 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8661
8662 Does keyboard navigation from this window to another, by sending a
8663 `wx.NavigationKeyEvent`.
8664 """
8665 return _core_.Window_Navigate(*args, **kwargs)
8666
8667 def MoveAfterInTabOrder(*args, **kwargs):
8668 """
8669 MoveAfterInTabOrder(self, Window win)
8670
8671 Moves this window in the tab navigation order after the specified
8672 sibling window. This means that when the user presses the TAB key on
8673 that other window, the focus switches to this window.
8674
8675 The default tab order is the same as creation order. This function
8676 and `MoveBeforeInTabOrder` allow to change it after creating all the
8677 windows.
8678
8679 """
8680 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8681
8682 def MoveBeforeInTabOrder(*args, **kwargs):
8683 """
8684 MoveBeforeInTabOrder(self, Window win)
8685
8686 Same as `MoveAfterInTabOrder` except that it inserts this window just
8687 before win instead of putting it right after it.
8688 """
8689 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8690
8691 def GetChildren(*args, **kwargs):
8692 """
8693 GetChildren(self) -> PyObject
8694
8695 Returns a list of the window's children. NOTE: Currently this is a
8696 copy of the child window list maintained by the window, so the return
8697 value of this function is only valid as long as the window's children
8698 do not change.
8699 """
8700 return _core_.Window_GetChildren(*args, **kwargs)
8701
8702 def GetParent(*args, **kwargs):
8703 """
8704 GetParent(self) -> Window
8705
8706 Returns the parent window of this window, or None if there isn't one.
8707 """
8708 return _core_.Window_GetParent(*args, **kwargs)
8709
8710 def GetGrandParent(*args, **kwargs):
8711 """
8712 GetGrandParent(self) -> Window
8713
8714 Returns the parent of the parent of this window, or None if there
8715 isn't one.
8716 """
8717 return _core_.Window_GetGrandParent(*args, **kwargs)
8718
8719 def IsTopLevel(*args, **kwargs):
8720 """
8721 IsTopLevel(self) -> bool
8722
8723 Returns true if the given window is a top-level one. Currently all
8724 frames and dialogs are always considered to be top-level windows (even
8725 if they have a parent window).
8726 """
8727 return _core_.Window_IsTopLevel(*args, **kwargs)
8728
8729 def Reparent(*args, **kwargs):
8730 """
8731 Reparent(self, Window newParent) -> bool
8732
8733 Reparents the window, i.e the window will be removed from its current
8734 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8735 re-inserted into another. Available on Windows and GTK. Returns True
8736 if the parent was changed, False otherwise (error or newParent ==
8737 oldParent)
8738 """
8739 return _core_.Window_Reparent(*args, **kwargs)
8740
8741 def AddChild(*args, **kwargs):
8742 """
8743 AddChild(self, Window child)
8744
8745 Adds a child window. This is called automatically by window creation
8746 functions so should not be required by the application programmer.
8747 """
8748 return _core_.Window_AddChild(*args, **kwargs)
8749
8750 def RemoveChild(*args, **kwargs):
8751 """
8752 RemoveChild(self, Window child)
8753
8754 Removes a child window. This is called automatically by window
8755 deletion functions so should not be required by the application
8756 programmer.
8757 """
8758 return _core_.Window_RemoveChild(*args, **kwargs)
8759
8760 def SetDoubleBuffered(*args, **kwargs):
8761 """
8762 SetDoubleBuffered(self, bool on)
8763
8764 Currently wxGTK2 only.
8765 """
8766 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8767
8768 def FindWindowById(*args, **kwargs):
8769 """
8770 FindWindowById(self, long winid) -> Window
8771
8772 Find a chld of this window by window ID
8773 """
8774 return _core_.Window_FindWindowById(*args, **kwargs)
8775
8776 def FindWindowByName(*args, **kwargs):
8777 """
8778 FindWindowByName(self, String name) -> Window
8779
8780 Find a child of this window by name
8781 """
8782 return _core_.Window_FindWindowByName(*args, **kwargs)
8783
8784 def GetEventHandler(*args, **kwargs):
8785 """
8786 GetEventHandler(self) -> EvtHandler
8787
8788 Returns the event handler for this window. By default, the window is
8789 its own event handler.
8790 """
8791 return _core_.Window_GetEventHandler(*args, **kwargs)
8792
8793 def SetEventHandler(*args, **kwargs):
8794 """
8795 SetEventHandler(self, EvtHandler handler)
8796
8797 Sets the event handler for this window. An event handler is an object
8798 that is capable of processing the events sent to a window. By default,
8799 the window is its own event handler, but an application may wish to
8800 substitute another, for example to allow central implementation of
8801 event-handling for a variety of different window classes.
8802
8803 It is usually better to use `wx.Window.PushEventHandler` since this sets
8804 up a chain of event handlers, where an event not handled by one event
8805 handler is handed to the next one in the chain.
8806 """
8807 return _core_.Window_SetEventHandler(*args, **kwargs)
8808
8809 def PushEventHandler(*args, **kwargs):
8810 """
8811 PushEventHandler(self, EvtHandler handler)
8812
8813 Pushes this event handler onto the event handler stack for the window.
8814 An event handler is an object that is capable of processing the events
8815 sent to a window. By default, the window is its own event handler, but
8816 an application may wish to substitute another, for example to allow
8817 central implementation of event-handling for a variety of different
8818 window classes.
8819
8820 wx.Window.PushEventHandler allows an application to set up a chain of
8821 event handlers, where an event not handled by one event handler is
8822 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
8823 remove the event handler.
8824 """
8825 return _core_.Window_PushEventHandler(*args, **kwargs)
8826
8827 def PopEventHandler(*args, **kwargs):
8828 """
8829 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8830
8831 Removes and returns the top-most event handler on the event handler
8832 stack. If deleteHandler is True then the wx.EvtHandler object will be
8833 destroyed after it is popped.
8834 """
8835 return _core_.Window_PopEventHandler(*args, **kwargs)
8836
8837 def RemoveEventHandler(*args, **kwargs):
8838 """
8839 RemoveEventHandler(self, EvtHandler handler) -> bool
8840
8841 Find the given handler in the event handler chain and remove (but not
8842 delete) it from the event handler chain, return True if it was found
8843 and False otherwise (this also results in an assert failure so this
8844 function should only be called when the handler is supposed to be
8845 there.)
8846 """
8847 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8848
8849 def SetValidator(*args, **kwargs):
8850 """
8851 SetValidator(self, Validator validator)
8852
8853 Deletes the current validator (if any) and sets the window validator,
8854 having called wx.Validator.Clone to create a new validator of this
8855 type.
8856 """
8857 return _core_.Window_SetValidator(*args, **kwargs)
8858
8859 def GetValidator(*args, **kwargs):
8860 """
8861 GetValidator(self) -> Validator
8862
8863 Returns a pointer to the current validator for the window, or None if
8864 there is none.
8865 """
8866 return _core_.Window_GetValidator(*args, **kwargs)
8867
8868 def Validate(*args, **kwargs):
8869 """
8870 Validate(self) -> bool
8871
8872 Validates the current values of the child controls using their
8873 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8874 style flag set, the method will also call Validate() of all child
8875 windows. Returns false if any of the validations failed.
8876 """
8877 return _core_.Window_Validate(*args, **kwargs)
8878
8879 def TransferDataToWindow(*args, **kwargs):
8880 """
8881 TransferDataToWindow(self) -> bool
8882
8883 Transfers values to child controls from data areas specified by their
8884 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8885 style flag set, the method will also call TransferDataToWindow() of
8886 all child windows.
8887 """
8888 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8889
8890 def TransferDataFromWindow(*args, **kwargs):
8891 """
8892 TransferDataFromWindow(self) -> bool
8893
8894 Transfers values from child controls to data areas specified by their
8895 validators. Returns false if a transfer failed. If the window has
8896 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8897 also call TransferDataFromWindow() of all child windows.
8898 """
8899 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8900
8901 def InitDialog(*args, **kwargs):
8902 """
8903 InitDialog(self)
8904
8905 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8906 to the dialog via validators.
8907 """
8908 return _core_.Window_InitDialog(*args, **kwargs)
8909
8910 def SetAcceleratorTable(*args, **kwargs):
8911 """
8912 SetAcceleratorTable(self, AcceleratorTable accel)
8913
8914 Sets the accelerator table for this window.
8915 """
8916 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
8917
8918 def GetAcceleratorTable(*args, **kwargs):
8919 """
8920 GetAcceleratorTable(self) -> AcceleratorTable
8921
8922 Gets the accelerator table for this window.
8923 """
8924 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
8925
8926 def RegisterHotKey(*args, **kwargs):
8927 """
8928 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
8929
8930 Registers a system wide hotkey. Every time the user presses the hotkey
8931 registered here, this window will receive a hotkey event. It will
8932 receive the event even if the application is in the background and
8933 does not have the input focus because the user is working with some
8934 other application. To bind an event handler function to this hotkey
8935 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
8936 hotkey was registered successfully.
8937 """
8938 return _core_.Window_RegisterHotKey(*args, **kwargs)
8939
8940 def UnregisterHotKey(*args, **kwargs):
8941 """
8942 UnregisterHotKey(self, int hotkeyId) -> bool
8943
8944 Unregisters a system wide hotkey.
8945 """
8946 return _core_.Window_UnregisterHotKey(*args, **kwargs)
8947
8948 def ConvertDialogPointToPixels(*args, **kwargs):
8949 """
8950 ConvertDialogPointToPixels(self, Point pt) -> Point
8951
8952 Converts a point or size from dialog units to pixels. Dialog units
8953 are used for maintaining a dialog's proportions even if the font
8954 changes. For the x dimension, the dialog units are multiplied by the
8955 average character width and then divided by 4. For the y dimension,
8956 the dialog units are multiplied by the average character height and
8957 then divided by 8.
8958 """
8959 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
8960
8961 def ConvertDialogSizeToPixels(*args, **kwargs):
8962 """
8963 ConvertDialogSizeToPixels(self, Size sz) -> Size
8964
8965 Converts a point or size from dialog units to pixels. Dialog units
8966 are used for maintaining a dialog's proportions even if the font
8967 changes. For the x dimension, the dialog units are multiplied by the
8968 average character width and then divided by 4. For the y dimension,
8969 the dialog units are multiplied by the average character height and
8970 then divided by 8.
8971 """
8972 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
8973
8974 def DLG_PNT(*args, **kwargs):
8975 """
8976 DLG_PNT(self, Point pt) -> Point
8977
8978 Converts a point or size from dialog units to pixels. Dialog units
8979 are used for maintaining a dialog's proportions even if the font
8980 changes. For the x dimension, the dialog units are multiplied by the
8981 average character width and then divided by 4. For the y dimension,
8982 the dialog units are multiplied by the average character height and
8983 then divided by 8.
8984 """
8985 return _core_.Window_DLG_PNT(*args, **kwargs)
8986
8987 def DLG_SZE(*args, **kwargs):
8988 """
8989 DLG_SZE(self, Size sz) -> Size
8990
8991 Converts a point or size from dialog units to pixels. Dialog units
8992 are used for maintaining a dialog's proportions even if the font
8993 changes. For the x dimension, the dialog units are multiplied by the
8994 average character width and then divided by 4. For the y dimension,
8995 the dialog units are multiplied by the average character height and
8996 then divided by 8.
8997 """
8998 return _core_.Window_DLG_SZE(*args, **kwargs)
8999
9000 def ConvertPixelPointToDialog(*args, **kwargs):
9001 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9002 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9003
9004 def ConvertPixelSizeToDialog(*args, **kwargs):
9005 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9006 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9007
9008 def WarpPointer(*args, **kwargs):
9009 """
9010 WarpPointer(self, int x, int y)
9011
9012 Moves the pointer to the given position on the window.
9013
9014 NOTE: This function is not supported under Mac because Apple Human
9015 Interface Guidelines forbid moving the mouse cursor programmatically.
9016 """
9017 return _core_.Window_WarpPointer(*args, **kwargs)
9018
9019 def CaptureMouse(*args, **kwargs):
9020 """
9021 CaptureMouse(self)
9022
9023 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9024 release the capture.
9025
9026 Note that wxWindows maintains the stack of windows having captured the
9027 mouse and when the mouse is released the capture returns to the window
9028 which had had captured it previously and it is only really released if
9029 there were no previous window. In particular, this means that you must
9030 release the mouse as many times as you capture it, unless the window
9031 receives the `wx.MouseCaptureLostEvent` event.
9032
9033 Any application which captures the mouse in the beginning of some
9034 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9035 operation when it receives the event. The event handler must not
9036 recapture mouse.
9037 """
9038 return _core_.Window_CaptureMouse(*args, **kwargs)
9039
9040 def ReleaseMouse(*args, **kwargs):
9041 """
9042 ReleaseMouse(self)
9043
9044 Releases mouse input captured with wx.Window.CaptureMouse.
9045 """
9046 return _core_.Window_ReleaseMouse(*args, **kwargs)
9047
9048 def GetCapture(*args, **kwargs):
9049 """
9050 GetCapture() -> Window
9051
9052 Returns the window which currently captures the mouse or None
9053 """
9054 return _core_.Window_GetCapture(*args, **kwargs)
9055
9056 GetCapture = staticmethod(GetCapture)
9057 def HasCapture(*args, **kwargs):
9058 """
9059 HasCapture(self) -> bool
9060
9061 Returns true if this window has the current mouse capture.
9062 """
9063 return _core_.Window_HasCapture(*args, **kwargs)
9064
9065 def Refresh(*args, **kwargs):
9066 """
9067 Refresh(self, bool eraseBackground=True, Rect rect=None)
9068
9069 Mark the specified rectangle (or the whole window) as "dirty" so it
9070 will be repainted. Causes an EVT_PAINT event to be generated and sent
9071 to the window.
9072 """
9073 return _core_.Window_Refresh(*args, **kwargs)
9074
9075 def RefreshRect(*args, **kwargs):
9076 """
9077 RefreshRect(self, Rect rect, bool eraseBackground=True)
9078
9079 Redraws the contents of the given rectangle: the area inside it will
9080 be repainted. This is the same as Refresh but has a nicer syntax.
9081 """
9082 return _core_.Window_RefreshRect(*args, **kwargs)
9083
9084 def Update(*args, **kwargs):
9085 """
9086 Update(self)
9087
9088 Calling this method immediately repaints the invalidated area of the
9089 window instead of waiting for the EVT_PAINT event to happen, (normally
9090 this would usually only happen when the flow of control returns to the
9091 event loop.) Notice that this function doesn't refresh the window and
9092 does nothing if the window has been already repainted. Use Refresh
9093 first if you want to immediately redraw the window (or some portion of
9094 it) unconditionally.
9095 """
9096 return _core_.Window_Update(*args, **kwargs)
9097
9098 def ClearBackground(*args, **kwargs):
9099 """
9100 ClearBackground(self)
9101
9102 Clears the window by filling it with the current background
9103 colour. Does not cause an erase background event to be generated.
9104 """
9105 return _core_.Window_ClearBackground(*args, **kwargs)
9106
9107 def Freeze(*args, **kwargs):
9108 """
9109 Freeze(self)
9110
9111 Freezes the window or, in other words, prevents any updates from
9112 taking place on screen, the window is not redrawn at all. Thaw must be
9113 called to reenable window redrawing. Calls to Freeze/Thaw may be
9114 nested, with the actual Thaw being delayed until all the nesting has
9115 been undone.
9116
9117 This method is useful for visual appearance optimization (for example,
9118 it is a good idea to use it before inserting large amount of text into
9119 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9120 for all controls so it is mostly just a hint to wxWindows and not a
9121 mandatory directive.
9122 """
9123 return _core_.Window_Freeze(*args, **kwargs)
9124
9125 def IsFrozen(*args, **kwargs):
9126 """
9127 IsFrozen(self) -> bool
9128
9129 Returns ``True`` if the window has been frozen and not thawed yet.
9130
9131 :see: `Freeze` and `Thaw`
9132 """
9133 return _core_.Window_IsFrozen(*args, **kwargs)
9134
9135 def Thaw(*args, **kwargs):
9136 """
9137 Thaw(self)
9138
9139 Reenables window updating after a previous call to Freeze. Calls to
9140 Freeze/Thaw may be nested, so Thaw must be called the same number of
9141 times that Freeze was before the window will be updated.
9142 """
9143 return _core_.Window_Thaw(*args, **kwargs)
9144
9145 def PrepareDC(*args, **kwargs):
9146 """
9147 PrepareDC(self, DC dc)
9148
9149 Call this function to prepare the device context for drawing a
9150 scrolled image. It sets the device origin according to the current
9151 scroll position.
9152 """
9153 return _core_.Window_PrepareDC(*args, **kwargs)
9154
9155 def GetUpdateRegion(*args, **kwargs):
9156 """
9157 GetUpdateRegion(self) -> Region
9158
9159 Returns the region specifying which parts of the window have been
9160 damaged. Should only be called within an EVT_PAINT handler.
9161 """
9162 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9163
9164 def GetUpdateClientRect(*args, **kwargs):
9165 """
9166 GetUpdateClientRect(self) -> Rect
9167
9168 Get the update rectangle region bounding box in client coords.
9169 """
9170 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9171
9172 def IsExposed(*args, **kwargs):
9173 """
9174 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9175
9176 Returns true if the given point or rectangle area has been exposed
9177 since the last repaint. Call this in an paint event handler to
9178 optimize redrawing by only redrawing those areas, which have been
9179 exposed.
9180 """
9181 return _core_.Window_IsExposed(*args, **kwargs)
9182
9183 def IsExposedPoint(*args, **kwargs):
9184 """
9185 IsExposedPoint(self, Point pt) -> bool
9186
9187 Returns true if the given point or rectangle area has been exposed
9188 since the last repaint. Call this in an paint event handler to
9189 optimize redrawing by only redrawing those areas, which have been
9190 exposed.
9191 """
9192 return _core_.Window_IsExposedPoint(*args, **kwargs)
9193
9194 def IsExposedRect(*args, **kwargs):
9195 """
9196 IsExposedRect(self, Rect rect) -> bool
9197
9198 Returns true if the given point or rectangle area has been exposed
9199 since the last repaint. Call this in an paint event handler to
9200 optimize redrawing by only redrawing those areas, which have been
9201 exposed.
9202 """
9203 return _core_.Window_IsExposedRect(*args, **kwargs)
9204
9205 def GetDefaultAttributes(*args, **kwargs):
9206 """
9207 GetDefaultAttributes(self) -> VisualAttributes
9208
9209 Get the default attributes for an instance of this class. This is
9210 useful if you want to use the same font or colour in your own control
9211 as in a standard control -- which is a much better idea than hard
9212 coding specific colours or fonts which might look completely out of
9213 place on the user's system, especially if it uses themes.
9214 """
9215 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9216
9217 def GetClassDefaultAttributes(*args, **kwargs):
9218 """
9219 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9220
9221 Get the default attributes for this class. This is useful if you want
9222 to use the same font or colour in your own control as in a standard
9223 control -- which is a much better idea than hard coding specific
9224 colours or fonts which might look completely out of place on the
9225 user's system, especially if it uses themes.
9226
9227 The variant parameter is only relevant under Mac currently and is
9228 ignore under other platforms. Under Mac, it will change the size of
9229 the returned font. See `wx.Window.SetWindowVariant` for more about
9230 this.
9231 """
9232 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9233
9234 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9235 def SetBackgroundColour(*args, **kwargs):
9236 """
9237 SetBackgroundColour(self, Colour colour) -> bool
9238
9239 Sets the background colour of the window. Returns True if the colour
9240 was changed. The background colour is usually painted by the default
9241 EVT_ERASE_BACKGROUND event handler function under Windows and
9242 automatically under GTK. Using `wx.NullColour` will reset the window
9243 to the default background colour.
9244
9245 Note that setting the background colour may not cause an immediate
9246 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9247 calling this function.
9248
9249 Using this function will disable attempts to use themes for this
9250 window, if the system supports them. Use with care since usually the
9251 themes represent the appearance chosen by the user to be used for all
9252 applications on the system.
9253 """
9254 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9255
9256 def SetOwnBackgroundColour(*args, **kwargs):
9257 """SetOwnBackgroundColour(self, Colour colour)"""
9258 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9259
9260 def SetForegroundColour(*args, **kwargs):
9261 """
9262 SetForegroundColour(self, Colour colour) -> bool
9263
9264 Sets the foreground colour of the window. Returns True is the colour
9265 was changed. The interpretation of foreground colour is dependent on
9266 the window class; it may be the text colour or other colour, or it may
9267 not be used at all.
9268 """
9269 return _core_.Window_SetForegroundColour(*args, **kwargs)
9270
9271 def SetOwnForegroundColour(*args, **kwargs):
9272 """SetOwnForegroundColour(self, Colour colour)"""
9273 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9274
9275 def GetBackgroundColour(*args, **kwargs):
9276 """
9277 GetBackgroundColour(self) -> Colour
9278
9279 Returns the background colour of the window.
9280 """
9281 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9282
9283 def GetForegroundColour(*args, **kwargs):
9284 """
9285 GetForegroundColour(self) -> Colour
9286
9287 Returns the foreground colour of the window. The interpretation of
9288 foreground colour is dependent on the window class; it may be the text
9289 colour or other colour, or it may not be used at all.
9290 """
9291 return _core_.Window_GetForegroundColour(*args, **kwargs)
9292
9293 def InheritsBackgroundColour(*args, **kwargs):
9294 """InheritsBackgroundColour(self) -> bool"""
9295 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9296
9297 def UseBgCol(*args, **kwargs):
9298 """UseBgCol(self) -> bool"""
9299 return _core_.Window_UseBgCol(*args, **kwargs)
9300
9301 def SetBackgroundStyle(*args, **kwargs):
9302 """
9303 SetBackgroundStyle(self, int style) -> bool
9304
9305 Returns the background style of the window. The background style
9306 indicates how the background of the window is drawn.
9307
9308 ====================== ========================================
9309 wx.BG_STYLE_SYSTEM The background colour or pattern should
9310 be determined by the system
9311 wx.BG_STYLE_COLOUR The background should be a solid colour
9312 wx.BG_STYLE_CUSTOM The background will be implemented by the
9313 application.
9314 ====================== ========================================
9315
9316 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9317 a custom background, such as a tiled bitmap. Currently the style has
9318 no effect on other platforms.
9319
9320 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9321 """
9322 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9323
9324 def GetBackgroundStyle(*args, **kwargs):
9325 """
9326 GetBackgroundStyle(self) -> int
9327
9328 Returns the background style of the window.
9329
9330 :see: `SetBackgroundStyle`
9331 """
9332 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9333
9334 def HasTransparentBackground(*args, **kwargs):
9335 """
9336 HasTransparentBackground(self) -> bool
9337
9338 Returns True if this window's background is transparent (as, for
9339 example, for `wx.StaticText`) and should show the parent window's
9340 background.
9341
9342 This method is mostly used internally by the library itself and you
9343 normally shouldn't have to call it. You may, however, have to override
9344 it in your custom control classes to ensure that background is painted
9345 correctly.
9346 """
9347 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9348
9349 def SetCursor(*args, **kwargs):
9350 """
9351 SetCursor(self, Cursor cursor) -> bool
9352
9353 Sets the window's cursor. Notice that the window cursor also sets it
9354 for the children of the window implicitly.
9355
9356 The cursor may be wx.NullCursor in which case the window cursor will
9357 be reset back to default.
9358 """
9359 return _core_.Window_SetCursor(*args, **kwargs)
9360
9361 def GetCursor(*args, **kwargs):
9362 """
9363 GetCursor(self) -> Cursor
9364
9365 Return the cursor associated with this window.
9366 """
9367 return _core_.Window_GetCursor(*args, **kwargs)
9368
9369 def SetFont(*args, **kwargs):
9370 """
9371 SetFont(self, Font font) -> bool
9372
9373 Sets the font for this window.
9374 """
9375 return _core_.Window_SetFont(*args, **kwargs)
9376
9377 def SetOwnFont(*args, **kwargs):
9378 """SetOwnFont(self, Font font)"""
9379 return _core_.Window_SetOwnFont(*args, **kwargs)
9380
9381 def GetFont(*args, **kwargs):
9382 """
9383 GetFont(self) -> Font
9384
9385 Returns the default font used for this window.
9386 """
9387 return _core_.Window_GetFont(*args, **kwargs)
9388
9389 def SetCaret(*args, **kwargs):
9390 """
9391 SetCaret(self, Caret caret)
9392
9393 Sets the caret associated with the window.
9394 """
9395 return _core_.Window_SetCaret(*args, **kwargs)
9396
9397 def GetCaret(*args, **kwargs):
9398 """
9399 GetCaret(self) -> Caret
9400
9401 Returns the caret associated with the window.
9402 """
9403 return _core_.Window_GetCaret(*args, **kwargs)
9404
9405 def GetCharHeight(*args, **kwargs):
9406 """
9407 GetCharHeight(self) -> int
9408
9409 Get the (average) character size for the current font.
9410 """
9411 return _core_.Window_GetCharHeight(*args, **kwargs)
9412
9413 def GetCharWidth(*args, **kwargs):
9414 """
9415 GetCharWidth(self) -> int
9416
9417 Get the (average) character size for the current font.
9418 """
9419 return _core_.Window_GetCharWidth(*args, **kwargs)
9420
9421 def GetTextExtent(*args, **kwargs):
9422 """
9423 GetTextExtent(String string) -> (width, height)
9424
9425 Get the width and height of the text using the current font.
9426 """
9427 return _core_.Window_GetTextExtent(*args, **kwargs)
9428
9429 def GetFullTextExtent(*args, **kwargs):
9430 """
9431 GetFullTextExtent(String string, Font font=None) ->
9432 (width, height, descent, externalLeading)
9433
9434 Get the width, height, decent and leading of the text using the
9435 current or specified font.
9436 """
9437 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9438
9439 def ClientToScreenXY(*args, **kwargs):
9440 """
9441 ClientToScreenXY(int x, int y) -> (x,y)
9442
9443 Converts to screen coordinates from coordinates relative to this window.
9444 """
9445 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9446
9447 def ScreenToClientXY(*args, **kwargs):
9448 """
9449 ScreenToClientXY(int x, int y) -> (x,y)
9450
9451 Converts from screen to client window coordinates.
9452 """
9453 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9454
9455 def ClientToScreen(*args, **kwargs):
9456 """
9457 ClientToScreen(self, Point pt) -> Point
9458
9459 Converts to screen coordinates from coordinates relative to this window.
9460 """
9461 return _core_.Window_ClientToScreen(*args, **kwargs)
9462
9463 def ScreenToClient(*args, **kwargs):
9464 """
9465 ScreenToClient(self, Point pt) -> Point
9466
9467 Converts from screen to client window coordinates.
9468 """
9469 return _core_.Window_ScreenToClient(*args, **kwargs)
9470
9471 def HitTestXY(*args, **kwargs):
9472 """
9473 HitTestXY(self, int x, int y) -> int
9474
9475 Test where the given (in client coords) point lies
9476 """
9477 return _core_.Window_HitTestXY(*args, **kwargs)
9478
9479 def HitTest(*args, **kwargs):
9480 """
9481 HitTest(self, Point pt) -> int
9482
9483 Test where the given (in client coords) point lies
9484 """
9485 return _core_.Window_HitTest(*args, **kwargs)
9486
9487 def GetBorder(*args):
9488 """
9489 GetBorder(self, long flags) -> int
9490 GetBorder(self) -> int
9491
9492 Get border for the flags of this window
9493 """
9494 return _core_.Window_GetBorder(*args)
9495
9496 def UpdateWindowUI(*args, **kwargs):
9497 """
9498 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9499
9500 This function sends EVT_UPDATE_UI events to the window. The particular
9501 implementation depends on the window; for example a wx.ToolBar will
9502 send an update UI event for each toolbar button, and a wx.Frame will
9503 send an update UI event for each menubar menu item. You can call this
9504 function from your application to ensure that your UI is up-to-date at
9505 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9506 concerned). This may be necessary if you have called
9507 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9508 limit the overhead that wxWindows incurs by sending update UI events
9509 in idle time.
9510 """
9511 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9512
9513 def PopupMenuXY(*args, **kwargs):
9514 """
9515 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9516
9517 Pops up the given menu at the specified coordinates, relative to this window,
9518 and returns control when the user has dismissed the menu. If a menu item is
9519 selected, the corresponding menu event is generated and will be processed as
9520 usual. If the default position is given then the current position of the
9521 mouse cursor will be used.
9522 """
9523 return _core_.Window_PopupMenuXY(*args, **kwargs)
9524
9525 def PopupMenu(*args, **kwargs):
9526 """
9527 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9528
9529 Pops up the given menu at the specified coordinates, relative to this window,
9530 and returns control when the user has dismissed the menu. If a menu item is
9531 selected, the corresponding menu event is generated and will be processed as
9532 usual. If the default position is given then the current position of the
9533 mouse cursor will be used.
9534 """
9535 return _core_.Window_PopupMenu(*args, **kwargs)
9536
9537 def HasMultiplePages(*args, **kwargs):
9538 """HasMultiplePages(self) -> bool"""
9539 return _core_.Window_HasMultiplePages(*args, **kwargs)
9540
9541 def GetHandle(*args, **kwargs):
9542 """
9543 GetHandle(self) -> long
9544
9545 Returns the platform-specific handle (as a long integer) of the
9546 physical window. Currently on wxMac it returns the handle of the
9547 toplevel parent of the window.
9548 """
9549 return _core_.Window_GetHandle(*args, **kwargs)
9550
9551 def AssociateHandle(*args, **kwargs):
9552 """
9553 AssociateHandle(self, long handle)
9554
9555 Associate the window with a new native handle
9556 """
9557 return _core_.Window_AssociateHandle(*args, **kwargs)
9558
9559 def DissociateHandle(*args, **kwargs):
9560 """
9561 DissociateHandle(self)
9562
9563 Dissociate the current native handle from the window
9564 """
9565 return _core_.Window_DissociateHandle(*args, **kwargs)
9566
9567 def HasScrollbar(*args, **kwargs):
9568 """
9569 HasScrollbar(self, int orient) -> bool
9570
9571 Does the window have the scrollbar for this orientation?
9572 """
9573 return _core_.Window_HasScrollbar(*args, **kwargs)
9574
9575 def SetScrollbar(*args, **kwargs):
9576 """
9577 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9578 bool refresh=True)
9579
9580 Sets the scrollbar properties of a built-in scrollbar.
9581 """
9582 return _core_.Window_SetScrollbar(*args, **kwargs)
9583
9584 def SetScrollPos(*args, **kwargs):
9585 """
9586 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9587
9588 Sets the position of one of the built-in scrollbars.
9589 """
9590 return _core_.Window_SetScrollPos(*args, **kwargs)
9591
9592 def GetScrollPos(*args, **kwargs):
9593 """
9594 GetScrollPos(self, int orientation) -> int
9595
9596 Returns the built-in scrollbar position.
9597 """
9598 return _core_.Window_GetScrollPos(*args, **kwargs)
9599
9600 def GetScrollThumb(*args, **kwargs):
9601 """
9602 GetScrollThumb(self, int orientation) -> int
9603
9604 Returns the built-in scrollbar thumb size.
9605 """
9606 return _core_.Window_GetScrollThumb(*args, **kwargs)
9607
9608 def GetScrollRange(*args, **kwargs):
9609 """
9610 GetScrollRange(self, int orientation) -> int
9611
9612 Returns the built-in scrollbar range.
9613 """
9614 return _core_.Window_GetScrollRange(*args, **kwargs)
9615
9616 def ScrollWindow(*args, **kwargs):
9617 """
9618 ScrollWindow(self, int dx, int dy, Rect rect=None)
9619
9620 Physically scrolls the pixels in the window and move child windows
9621 accordingly. Use this function to optimise your scrolling
9622 implementations, to minimise the area that must be redrawn. Note that
9623 it is rarely required to call this function from a user program.
9624 """
9625 return _core_.Window_ScrollWindow(*args, **kwargs)
9626
9627 def ScrollLines(*args, **kwargs):
9628 """
9629 ScrollLines(self, int lines) -> bool
9630
9631 If the platform and window class supports it, scrolls the window by
9632 the given number of lines down, if lines is positive, or up if lines
9633 is negative. Returns True if the window was scrolled, False if it was
9634 already on top/bottom and nothing was done.
9635 """
9636 return _core_.Window_ScrollLines(*args, **kwargs)
9637
9638 def ScrollPages(*args, **kwargs):
9639 """
9640 ScrollPages(self, int pages) -> bool
9641
9642 If the platform and window class supports it, scrolls the window by
9643 the given number of pages down, if pages is positive, or up if pages
9644 is negative. Returns True if the window was scrolled, False if it was
9645 already on top/bottom and nothing was done.
9646 """
9647 return _core_.Window_ScrollPages(*args, **kwargs)
9648
9649 def LineUp(*args, **kwargs):
9650 """
9651 LineUp(self) -> bool
9652
9653 This is just a wrapper for ScrollLines(-1).
9654 """
9655 return _core_.Window_LineUp(*args, **kwargs)
9656
9657 def LineDown(*args, **kwargs):
9658 """
9659 LineDown(self) -> bool
9660
9661 This is just a wrapper for ScrollLines(1).
9662 """
9663 return _core_.Window_LineDown(*args, **kwargs)
9664
9665 def PageUp(*args, **kwargs):
9666 """
9667 PageUp(self) -> bool
9668
9669 This is just a wrapper for ScrollPages(-1).
9670 """
9671 return _core_.Window_PageUp(*args, **kwargs)
9672
9673 def PageDown(*args, **kwargs):
9674 """
9675 PageDown(self) -> bool
9676
9677 This is just a wrapper for ScrollPages(1).
9678 """
9679 return _core_.Window_PageDown(*args, **kwargs)
9680
9681 def SetHelpText(*args, **kwargs):
9682 """
9683 SetHelpText(self, String text)
9684
9685 Sets the help text to be used as context-sensitive help for this
9686 window. Note that the text is actually stored by the current
9687 `wx.HelpProvider` implementation, and not in the window object itself.
9688 """
9689 return _core_.Window_SetHelpText(*args, **kwargs)
9690
9691 def SetHelpTextForId(*args, **kwargs):
9692 """
9693 SetHelpTextForId(self, String text)
9694
9695 Associate this help text with all windows with the same id as this
9696 one.
9697 """
9698 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9699
9700 def GetHelpTextAtPoint(*args, **kwargs):
9701 """
9702 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9703
9704 Get the help string associated with the given position in this window.
9705
9706 Notice that pt may be invalid if event origin is keyboard or unknown
9707 and this method should return the global window help text then
9708
9709 """
9710 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9711
9712 def GetHelpText(*args, **kwargs):
9713 """
9714 GetHelpText(self) -> String
9715
9716 Gets the help text to be used as context-sensitive help for this
9717 window. Note that the text is actually stored by the current
9718 `wx.HelpProvider` implementation, and not in the window object itself.
9719 """
9720 return _core_.Window_GetHelpText(*args, **kwargs)
9721
9722 def SetToolTipString(*args, **kwargs):
9723 """
9724 SetToolTipString(self, String tip)
9725
9726 Attach a tooltip to the window.
9727 """
9728 return _core_.Window_SetToolTipString(*args, **kwargs)
9729
9730 def SetToolTip(*args, **kwargs):
9731 """
9732 SetToolTip(self, ToolTip tip)
9733
9734 Attach a tooltip to the window.
9735 """
9736 return _core_.Window_SetToolTip(*args, **kwargs)
9737
9738 def GetToolTip(*args, **kwargs):
9739 """
9740 GetToolTip(self) -> ToolTip
9741
9742 get the associated tooltip or None if none
9743 """
9744 return _core_.Window_GetToolTip(*args, **kwargs)
9745
9746 def SetDropTarget(*args, **kwargs):
9747 """
9748 SetDropTarget(self, DropTarget dropTarget)
9749
9750 Associates a drop target with this window. If the window already has
9751 a drop target, it is deleted.
9752 """
9753 return _core_.Window_SetDropTarget(*args, **kwargs)
9754
9755 def GetDropTarget(*args, **kwargs):
9756 """
9757 GetDropTarget(self) -> DropTarget
9758
9759 Returns the associated drop target, which may be None.
9760 """
9761 return _core_.Window_GetDropTarget(*args, **kwargs)
9762
9763 def DragAcceptFiles(*args, **kwargs):
9764 """
9765 DragAcceptFiles(self, bool accept)
9766
9767 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9768 Only functional on Windows.
9769 """
9770 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9771
9772 def SetConstraints(*args, **kwargs):
9773 """
9774 SetConstraints(self, LayoutConstraints constraints)
9775
9776 Sets the window to have the given layout constraints. If an existing
9777 layout constraints object is already owned by the window, it will be
9778 deleted. Pass None to disassociate and delete the window's current
9779 constraints.
9780
9781 You must call SetAutoLayout to tell a window to use the constraints
9782 automatically in its default EVT_SIZE handler; otherwise, you must
9783 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9784 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9785 effect.
9786 """
9787 return _core_.Window_SetConstraints(*args, **kwargs)
9788
9789 def GetConstraints(*args, **kwargs):
9790 """
9791 GetConstraints(self) -> LayoutConstraints
9792
9793 Returns a pointer to the window's layout constraints, or None if there
9794 are none.
9795 """
9796 return _core_.Window_GetConstraints(*args, **kwargs)
9797
9798 def SetAutoLayout(*args, **kwargs):
9799 """
9800 SetAutoLayout(self, bool autoLayout)
9801
9802 Determines whether the Layout function will be called automatically
9803 when the window is resized. lease note that this only happens for the
9804 windows usually used to contain children, namely `wx.Panel` and
9805 `wx.TopLevelWindow` (and the classes deriving from them).
9806
9807 This method is called implicitly by `SetSizer` but if you use
9808 `SetConstraints` you should call it manually or otherwise the window
9809 layout won't be correctly updated when its size changes.
9810 """
9811 return _core_.Window_SetAutoLayout(*args, **kwargs)
9812
9813 def GetAutoLayout(*args, **kwargs):
9814 """
9815 GetAutoLayout(self) -> bool
9816
9817 Returns the current autoLayout setting
9818 """
9819 return _core_.Window_GetAutoLayout(*args, **kwargs)
9820
9821 def Layout(*args, **kwargs):
9822 """
9823 Layout(self) -> bool
9824
9825 Invokes the constraint-based layout algorithm or the sizer-based
9826 algorithm for this window. See SetAutoLayout: when auto layout is on,
9827 this function gets called automatically by the default EVT_SIZE
9828 handler when the window is resized.
9829 """
9830 return _core_.Window_Layout(*args, **kwargs)
9831
9832 def SetSizer(*args, **kwargs):
9833 """
9834 SetSizer(self, Sizer sizer, bool deleteOld=True)
9835
9836 Sets the window to have the given layout sizer. The window will then
9837 own the object, and will take care of its deletion. If an existing
9838 layout sizer object is already owned by the window, it will be deleted
9839 if the deleteOld parameter is true. Note that this function will also
9840 call SetAutoLayout implicitly with a True parameter if the sizer is
9841 non-None, and False otherwise.
9842 """
9843 return _core_.Window_SetSizer(*args, **kwargs)
9844
9845 def SetSizerAndFit(*args, **kwargs):
9846 """
9847 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9848
9849 The same as SetSizer, except it also sets the size hints for the
9850 window based on the sizer's minimum size.
9851 """
9852 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9853
9854 def GetSizer(*args, **kwargs):
9855 """
9856 GetSizer(self) -> Sizer
9857
9858 Return the sizer associated with the window by a previous call to
9859 SetSizer or None if there isn't one.
9860 """
9861 return _core_.Window_GetSizer(*args, **kwargs)
9862
9863 def SetContainingSizer(*args, **kwargs):
9864 """
9865 SetContainingSizer(self, Sizer sizer)
9866
9867 This normally does not need to be called by application code. It is
9868 called internally when a window is added to a sizer, and is used so
9869 the window can remove itself from the sizer when it is destroyed.
9870 """
9871 return _core_.Window_SetContainingSizer(*args, **kwargs)
9872
9873 def GetContainingSizer(*args, **kwargs):
9874 """
9875 GetContainingSizer(self) -> Sizer
9876
9877 Return the sizer that this window is a member of, if any, otherwise None.
9878 """
9879 return _core_.Window_GetContainingSizer(*args, **kwargs)
9880
9881 def InheritAttributes(*args, **kwargs):
9882 """
9883 InheritAttributes(self)
9884
9885 This function is (or should be, in case of custom controls) called
9886 during window creation to intelligently set up the window visual
9887 attributes, that is the font and the foreground and background
9888 colours.
9889
9890 By 'intelligently' the following is meant: by default, all windows use
9891 their own default attributes. However if some of the parent's
9892 attributes are explicitly changed (that is, using SetFont and not
9893 SetOwnFont) and if the corresponding attribute hadn't been
9894 explicitly set for this window itself, then this window takes the same
9895 value as used by the parent. In addition, if the window overrides
9896 ShouldInheritColours to return false, the colours will not be changed
9897 no matter what and only the font might.
9898
9899 This rather complicated logic is necessary in order to accommodate the
9900 different usage scenarios. The most common one is when all default
9901 attributes are used and in this case, nothing should be inherited as
9902 in modern GUIs different controls use different fonts (and colours)
9903 than their siblings so they can't inherit the same value from the
9904 parent. However it was also deemed desirable to allow to simply change
9905 the attributes of all children at once by just changing the font or
9906 colour of their common parent, hence in this case we do inherit the
9907 parents attributes.
9908
9909 """
9910 return _core_.Window_InheritAttributes(*args, **kwargs)
9911
9912 def ShouldInheritColours(*args, **kwargs):
9913 """
9914 ShouldInheritColours(self) -> bool
9915
9916 Return true from here to allow the colours of this window to be
9917 changed by InheritAttributes, returning false forbids inheriting them
9918 from the parent window.
9919
9920 The base class version returns false, but this method is overridden in
9921 wxControl where it returns true.
9922 """
9923 return _core_.Window_ShouldInheritColours(*args, **kwargs)
9924
9925 def CanSetTransparent(*args, **kwargs):
9926 """
9927 CanSetTransparent(self) -> bool
9928
9929 Returns ``True`` if the platform supports setting the transparency for
9930 this window. Note that this method will err on the side of caution,
9931 so it is possible that this will return ``False`` when it is in fact
9932 possible to set the transparency.
9933
9934 NOTE: On X-windows systems the X server must have the composite
9935 extension loaded, and there must be a composite manager program (such
9936 as xcompmgr) running.
9937 """
9938 return _core_.Window_CanSetTransparent(*args, **kwargs)
9939
9940 def SetTransparent(*args, **kwargs):
9941 """
9942 SetTransparent(self, byte alpha) -> bool
9943
9944 Attempt to set the transparency of this window to the ``alpha`` value,
9945 returns True on success. The ``alpha`` value is an integer in the
9946 range of 0 to 255, where 0 is fully transparent and 255 is fully
9947 opaque.
9948 """
9949 return _core_.Window_SetTransparent(*args, **kwargs)
9950
9951 def PostCreate(self, pre):
9952 """
9953 Phase 3 of the 2-phase create <wink!>
9954 Call this method after precreating the window with the 2-phase create method.
9955 """
9956 self.this = pre.this
9957 self.thisown = pre.thisown
9958 pre.thisown = 0
9959 if hasattr(self, '_setOORInfo'):
9960 self._setOORInfo(self)
9961 if hasattr(self, '_setCallbackInfo'):
9962 self._setCallbackInfo(self, self.__class__)
9963
9964 def SendSizeEvent(self):
9965 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
9966
9967 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
9968 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
9969 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
9970 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
9971 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
9972 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
9973 BestSize = property(GetBestSize,doc="See `GetBestSize`")
9974 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
9975 Border = property(GetBorder,doc="See `GetBorder`")
9976 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
9977 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
9978 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
9979 Children = property(GetChildren,doc="See `GetChildren`")
9980 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
9981 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
9982 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
9983 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
9984 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
9985 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
9986 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
9987 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
9988 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
9989 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
9990 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
9991 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
9992 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
9993 Handle = property(GetHandle,doc="See `GetHandle`")
9994 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
9995 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
9996 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
9997 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
9998 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
9999 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10000 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10001 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10002 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10003 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10004 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10005 Parent = property(GetParent,doc="See `GetParent`")
10006 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10007 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10008 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10009 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10010 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10011 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10012 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10013 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10014 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10015 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10016 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10017 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10018 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10019 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10020 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10021 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10022 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10023 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10024 _core_.Window_swigregister(Window)
10025
10026 def PreWindow(*args, **kwargs):
10027 """
10028 PreWindow() -> Window
10029
10030 Precreate a Window for 2-phase creation.
10031 """
10032 val = _core_.new_PreWindow(*args, **kwargs)
10033 return val
10034
10035 def Window_NewControlId(*args):
10036 """
10037 Window_NewControlId() -> int
10038
10039 Generate a control id for the controls which were not given one.
10040 """
10041 return _core_.Window_NewControlId(*args)
10042
10043 def Window_NextControlId(*args, **kwargs):
10044 """
10045 Window_NextControlId(int winid) -> int
10046
10047 Get the id of the control following the one with the given
10048 autogenerated) id
10049 """
10050 return _core_.Window_NextControlId(*args, **kwargs)
10051
10052 def Window_PrevControlId(*args, **kwargs):
10053 """
10054 Window_PrevControlId(int winid) -> int
10055
10056 Get the id of the control preceding the one with the given
10057 autogenerated) id
10058 """
10059 return _core_.Window_PrevControlId(*args, **kwargs)
10060
10061 def Window_FindFocus(*args):
10062 """
10063 Window_FindFocus() -> Window
10064
10065 Returns the window or control that currently has the keyboard focus,
10066 or None.
10067 """
10068 return _core_.Window_FindFocus(*args)
10069
10070 def Window_GetCapture(*args):
10071 """
10072 Window_GetCapture() -> Window
10073
10074 Returns the window which currently captures the mouse or None
10075 """
10076 return _core_.Window_GetCapture(*args)
10077
10078 def Window_GetClassDefaultAttributes(*args, **kwargs):
10079 """
10080 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10081
10082 Get the default attributes for this class. This is useful if you want
10083 to use the same font or colour in your own control as in a standard
10084 control -- which is a much better idea than hard coding specific
10085 colours or fonts which might look completely out of place on the
10086 user's system, especially if it uses themes.
10087
10088 The variant parameter is only relevant under Mac currently and is
10089 ignore under other platforms. Under Mac, it will change the size of
10090 the returned font. See `wx.Window.SetWindowVariant` for more about
10091 this.
10092 """
10093 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10094
10095 def DLG_PNT(win, point_or_x, y=None):
10096 """
10097 Convenience function for converting a Point or (x,y) in
10098 dialog units to pixel units.
10099 """
10100 if y is None:
10101 return win.ConvertDialogPointToPixels(point_or_x)
10102 else:
10103 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10104
10105 def DLG_SZE(win, size_width, height=None):
10106 """
10107 Convenience function for converting a Size or (w,h) in
10108 dialog units to pixel units.
10109 """
10110 if height is None:
10111 return win.ConvertDialogSizeToPixels(size_width)
10112 else:
10113 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10114
10115
10116 def FindWindowById(*args, **kwargs):
10117 """
10118 FindWindowById(long id, Window parent=None) -> Window
10119
10120 Find the first window in the application with the given id. If parent
10121 is None, the search will start from all top-level frames and dialog
10122 boxes; if non-None, the search will be limited to the given window
10123 hierarchy. The search is recursive in both cases.
10124 """
10125 return _core_.FindWindowById(*args, **kwargs)
10126
10127 def FindWindowByName(*args, **kwargs):
10128 """
10129 FindWindowByName(String name, Window parent=None) -> Window
10130
10131 Find a window by its name (as given in a window constructor or Create
10132 function call). If parent is None, the search will start from all
10133 top-level frames and dialog boxes; if non-None, the search will be
10134 limited to the given window hierarchy. The search is recursive in both
10135 cases.
10136
10137 If no window with such name is found, wx.FindWindowByLabel is called.
10138 """
10139 return _core_.FindWindowByName(*args, **kwargs)
10140
10141 def FindWindowByLabel(*args, **kwargs):
10142 """
10143 FindWindowByLabel(String label, Window parent=None) -> Window
10144
10145 Find a window by its label. Depending on the type of window, the label
10146 may be a window title or panel item label. If parent is None, the
10147 search will start from all top-level frames and dialog boxes; if
10148 non-None, the search will be limited to the given window
10149 hierarchy. The search is recursive in both cases.
10150 """
10151 return _core_.FindWindowByLabel(*args, **kwargs)
10152
10153 def Window_FromHWND(*args, **kwargs):
10154 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10155 return _core_.Window_FromHWND(*args, **kwargs)
10156
10157 def GetTopLevelWindows(*args):
10158 """
10159 GetTopLevelWindows() -> PyObject
10160
10161 Returns a list of the the application's top-level windows, (frames,
10162 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10163 by wxWidgets, and so it is only valid as long as no top-level windows
10164 are closed or new top-level windows are created.
10165
10166 """
10167 return _core_.GetTopLevelWindows(*args)
10168 #---------------------------------------------------------------------------
10169
10170 class Validator(EvtHandler):
10171 """Proxy of C++ Validator class"""
10172 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10173 __repr__ = _swig_repr
10174 def __init__(self, *args, **kwargs):
10175 """__init__(self) -> Validator"""
10176 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10177 self._setOORInfo(self)
10178
10179 def Clone(*args, **kwargs):
10180 """Clone(self) -> Validator"""
10181 return _core_.Validator_Clone(*args, **kwargs)
10182
10183 def Validate(*args, **kwargs):
10184 """Validate(self, Window parent) -> bool"""
10185 return _core_.Validator_Validate(*args, **kwargs)
10186
10187 def TransferToWindow(*args, **kwargs):
10188 """TransferToWindow(self) -> bool"""
10189 return _core_.Validator_TransferToWindow(*args, **kwargs)
10190
10191 def TransferFromWindow(*args, **kwargs):
10192 """TransferFromWindow(self) -> bool"""
10193 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10194
10195 def GetWindow(*args, **kwargs):
10196 """GetWindow(self) -> Window"""
10197 return _core_.Validator_GetWindow(*args, **kwargs)
10198
10199 def SetWindow(*args, **kwargs):
10200 """SetWindow(self, Window window)"""
10201 return _core_.Validator_SetWindow(*args, **kwargs)
10202
10203 def IsSilent(*args, **kwargs):
10204 """IsSilent() -> bool"""
10205 return _core_.Validator_IsSilent(*args, **kwargs)
10206
10207 IsSilent = staticmethod(IsSilent)
10208 def SetBellOnError(*args, **kwargs):
10209 """SetBellOnError(int doIt=True)"""
10210 return _core_.Validator_SetBellOnError(*args, **kwargs)
10211
10212 SetBellOnError = staticmethod(SetBellOnError)
10213 _core_.Validator_swigregister(Validator)
10214
10215 def Validator_IsSilent(*args):
10216 """Validator_IsSilent() -> bool"""
10217 return _core_.Validator_IsSilent(*args)
10218
10219 def Validator_SetBellOnError(*args, **kwargs):
10220 """Validator_SetBellOnError(int doIt=True)"""
10221 return _core_.Validator_SetBellOnError(*args, **kwargs)
10222
10223 class PyValidator(Validator):
10224 """Proxy of C++ PyValidator class"""
10225 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10226 __repr__ = _swig_repr
10227 def __init__(self, *args, **kwargs):
10228 """__init__(self) -> PyValidator"""
10229 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10230
10231 self._setCallbackInfo(self, PyValidator, 1)
10232 self._setOORInfo(self)
10233
10234 def _setCallbackInfo(*args, **kwargs):
10235 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10236 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10237
10238 _core_.PyValidator_swigregister(PyValidator)
10239
10240 #---------------------------------------------------------------------------
10241
10242 class Menu(EvtHandler):
10243 """Proxy of C++ Menu class"""
10244 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10245 __repr__ = _swig_repr
10246 def __init__(self, *args, **kwargs):
10247 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10248 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10249 self._setOORInfo(self)
10250
10251 def Append(*args, **kwargs):
10252 """
10253 Append(self, int id, String text=EmptyString, String help=EmptyString,
10254 int kind=ITEM_NORMAL) -> MenuItem
10255 """
10256 return _core_.Menu_Append(*args, **kwargs)
10257
10258 def AppendSeparator(*args, **kwargs):
10259 """AppendSeparator(self) -> MenuItem"""
10260 return _core_.Menu_AppendSeparator(*args, **kwargs)
10261
10262 def AppendCheckItem(*args, **kwargs):
10263 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10264 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10265
10266 def AppendRadioItem(*args, **kwargs):
10267 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10268 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10269
10270 def AppendMenu(*args, **kwargs):
10271 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10272 return _core_.Menu_AppendMenu(*args, **kwargs)
10273
10274 def AppendSubMenu(*args, **kwargs):
10275 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10276 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10277
10278 def AppendItem(*args, **kwargs):
10279 """AppendItem(self, MenuItem item) -> MenuItem"""
10280 return _core_.Menu_AppendItem(*args, **kwargs)
10281
10282 def InsertItem(*args, **kwargs):
10283 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10284 return _core_.Menu_InsertItem(*args, **kwargs)
10285
10286 def PrependItem(*args, **kwargs):
10287 """PrependItem(self, MenuItem item) -> MenuItem"""
10288 return _core_.Menu_PrependItem(*args, **kwargs)
10289
10290 def Break(*args, **kwargs):
10291 """Break(self)"""
10292 return _core_.Menu_Break(*args, **kwargs)
10293
10294 def Insert(*args, **kwargs):
10295 """
10296 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10297 int kind=ITEM_NORMAL) -> MenuItem
10298 """
10299 return _core_.Menu_Insert(*args, **kwargs)
10300
10301 def InsertSeparator(*args, **kwargs):
10302 """InsertSeparator(self, size_t pos) -> MenuItem"""
10303 return _core_.Menu_InsertSeparator(*args, **kwargs)
10304
10305 def InsertCheckItem(*args, **kwargs):
10306 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10307 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10308
10309 def InsertRadioItem(*args, **kwargs):
10310 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10311 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10312
10313 def InsertMenu(*args, **kwargs):
10314 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10315 return _core_.Menu_InsertMenu(*args, **kwargs)
10316
10317 def Prepend(*args, **kwargs):
10318 """
10319 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10320 int kind=ITEM_NORMAL) -> MenuItem
10321 """
10322 return _core_.Menu_Prepend(*args, **kwargs)
10323
10324 def PrependSeparator(*args, **kwargs):
10325 """PrependSeparator(self) -> MenuItem"""
10326 return _core_.Menu_PrependSeparator(*args, **kwargs)
10327
10328 def PrependCheckItem(*args, **kwargs):
10329 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10330 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10331
10332 def PrependRadioItem(*args, **kwargs):
10333 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10334 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10335
10336 def PrependMenu(*args, **kwargs):
10337 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10338 return _core_.Menu_PrependMenu(*args, **kwargs)
10339
10340 def Remove(*args, **kwargs):
10341 """Remove(self, int id) -> MenuItem"""
10342 return _core_.Menu_Remove(*args, **kwargs)
10343
10344 def RemoveItem(*args, **kwargs):
10345 """RemoveItem(self, MenuItem item) -> MenuItem"""
10346 return _core_.Menu_RemoveItem(*args, **kwargs)
10347
10348 def Delete(*args, **kwargs):
10349 """Delete(self, int id) -> bool"""
10350 return _core_.Menu_Delete(*args, **kwargs)
10351
10352 def DeleteItem(*args, **kwargs):
10353 """DeleteItem(self, MenuItem item) -> bool"""
10354 return _core_.Menu_DeleteItem(*args, **kwargs)
10355
10356 def Destroy(*args, **kwargs):
10357 """
10358 Destroy(self)
10359
10360 Deletes the C++ object this Python object is a proxy for.
10361 """
10362 val = _core_.Menu_Destroy(*args, **kwargs)
10363 args[0].thisown = 0
10364 return val
10365
10366 def DestroyId(*args, **kwargs):
10367 """
10368 DestroyId(self, int id) -> bool
10369
10370 Deletes the C++ object this Python object is a proxy for.
10371 """
10372 val = _core_.Menu_DestroyId(*args, **kwargs)
10373 args[0].thisown = 0
10374 return val
10375
10376 def DestroyItem(*args, **kwargs):
10377 """
10378 DestroyItem(self, MenuItem item) -> bool
10379
10380 Deletes the C++ object this Python object is a proxy for.
10381 """
10382 val = _core_.Menu_DestroyItem(*args, **kwargs)
10383 args[0].thisown = 0
10384 return val
10385
10386 def GetMenuItemCount(*args, **kwargs):
10387 """GetMenuItemCount(self) -> size_t"""
10388 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10389
10390 def GetMenuItems(*args, **kwargs):
10391 """GetMenuItems(self) -> PyObject"""
10392 return _core_.Menu_GetMenuItems(*args, **kwargs)
10393
10394 def FindItem(*args, **kwargs):
10395 """FindItem(self, String item) -> int"""
10396 return _core_.Menu_FindItem(*args, **kwargs)
10397
10398 def FindItemById(*args, **kwargs):
10399 """FindItemById(self, int id) -> MenuItem"""
10400 return _core_.Menu_FindItemById(*args, **kwargs)
10401
10402 def FindItemByPosition(*args, **kwargs):
10403 """FindItemByPosition(self, size_t position) -> MenuItem"""
10404 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10405
10406 def Enable(*args, **kwargs):
10407 """Enable(self, int id, bool enable)"""
10408 return _core_.Menu_Enable(*args, **kwargs)
10409
10410 def IsEnabled(*args, **kwargs):
10411 """IsEnabled(self, int id) -> bool"""
10412 return _core_.Menu_IsEnabled(*args, **kwargs)
10413
10414 def Check(*args, **kwargs):
10415 """Check(self, int id, bool check)"""
10416 return _core_.Menu_Check(*args, **kwargs)
10417
10418 def IsChecked(*args, **kwargs):
10419 """IsChecked(self, int id) -> bool"""
10420 return _core_.Menu_IsChecked(*args, **kwargs)
10421
10422 def SetLabel(*args, **kwargs):
10423 """SetLabel(self, int id, String label)"""
10424 return _core_.Menu_SetLabel(*args, **kwargs)
10425
10426 def GetLabel(*args, **kwargs):
10427 """GetLabel(self, int id) -> String"""
10428 return _core_.Menu_GetLabel(*args, **kwargs)
10429
10430 def SetHelpString(*args, **kwargs):
10431 """SetHelpString(self, int id, String helpString)"""
10432 return _core_.Menu_SetHelpString(*args, **kwargs)
10433
10434 def GetHelpString(*args, **kwargs):
10435 """GetHelpString(self, int id) -> String"""
10436 return _core_.Menu_GetHelpString(*args, **kwargs)
10437
10438 def SetTitle(*args, **kwargs):
10439 """SetTitle(self, String title)"""
10440 return _core_.Menu_SetTitle(*args, **kwargs)
10441
10442 def GetTitle(*args, **kwargs):
10443 """GetTitle(self) -> String"""
10444 return _core_.Menu_GetTitle(*args, **kwargs)
10445
10446 def SetEventHandler(*args, **kwargs):
10447 """SetEventHandler(self, EvtHandler handler)"""
10448 return _core_.Menu_SetEventHandler(*args, **kwargs)
10449
10450 def GetEventHandler(*args, **kwargs):
10451 """GetEventHandler(self) -> EvtHandler"""
10452 return _core_.Menu_GetEventHandler(*args, **kwargs)
10453
10454 def SetInvokingWindow(*args, **kwargs):
10455 """SetInvokingWindow(self, Window win)"""
10456 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10457
10458 def GetInvokingWindow(*args, **kwargs):
10459 """GetInvokingWindow(self) -> Window"""
10460 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10461
10462 def GetStyle(*args, **kwargs):
10463 """GetStyle(self) -> long"""
10464 return _core_.Menu_GetStyle(*args, **kwargs)
10465
10466 def UpdateUI(*args, **kwargs):
10467 """UpdateUI(self, EvtHandler source=None)"""
10468 return _core_.Menu_UpdateUI(*args, **kwargs)
10469
10470 def GetMenuBar(*args, **kwargs):
10471 """GetMenuBar(self) -> MenuBar"""
10472 return _core_.Menu_GetMenuBar(*args, **kwargs)
10473
10474 def Attach(*args, **kwargs):
10475 """Attach(self, wxMenuBarBase menubar)"""
10476 return _core_.Menu_Attach(*args, **kwargs)
10477
10478 def Detach(*args, **kwargs):
10479 """Detach(self)"""
10480 return _core_.Menu_Detach(*args, **kwargs)
10481
10482 def IsAttached(*args, **kwargs):
10483 """IsAttached(self) -> bool"""
10484 return _core_.Menu_IsAttached(*args, **kwargs)
10485
10486 def SetParent(*args, **kwargs):
10487 """SetParent(self, Menu parent)"""
10488 return _core_.Menu_SetParent(*args, **kwargs)
10489
10490 def GetParent(*args, **kwargs):
10491 """GetParent(self) -> Menu"""
10492 return _core_.Menu_GetParent(*args, **kwargs)
10493
10494 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10495 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10496 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10497 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10498 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10499 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10500 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10501 Style = property(GetStyle,doc="See `GetStyle`")
10502 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
10503 _core_.Menu_swigregister(Menu)
10504 DefaultValidator = cvar.DefaultValidator
10505
10506 #---------------------------------------------------------------------------
10507
10508 class MenuBar(Window):
10509 """Proxy of C++ MenuBar class"""
10510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10511 __repr__ = _swig_repr
10512 def __init__(self, *args, **kwargs):
10513 """__init__(self, long style=0) -> MenuBar"""
10514 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10515 self._setOORInfo(self)
10516
10517 def Append(*args, **kwargs):
10518 """Append(self, Menu menu, String title) -> bool"""
10519 return _core_.MenuBar_Append(*args, **kwargs)
10520
10521 def Insert(*args, **kwargs):
10522 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10523 return _core_.MenuBar_Insert(*args, **kwargs)
10524
10525 def GetMenuCount(*args, **kwargs):
10526 """GetMenuCount(self) -> size_t"""
10527 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10528
10529 def GetMenu(*args, **kwargs):
10530 """GetMenu(self, size_t pos) -> Menu"""
10531 return _core_.MenuBar_GetMenu(*args, **kwargs)
10532
10533 def Replace(*args, **kwargs):
10534 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10535 return _core_.MenuBar_Replace(*args, **kwargs)
10536
10537 def Remove(*args, **kwargs):
10538 """Remove(self, size_t pos) -> Menu"""
10539 return _core_.MenuBar_Remove(*args, **kwargs)
10540
10541 def EnableTop(*args, **kwargs):
10542 """EnableTop(self, size_t pos, bool enable)"""
10543 return _core_.MenuBar_EnableTop(*args, **kwargs)
10544
10545 def IsEnabledTop(*args, **kwargs):
10546 """IsEnabledTop(self, size_t pos) -> bool"""
10547 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10548
10549 def SetLabelTop(*args, **kwargs):
10550 """SetLabelTop(self, size_t pos, String label)"""
10551 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10552
10553 def GetLabelTop(*args, **kwargs):
10554 """GetLabelTop(self, size_t pos) -> String"""
10555 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10556
10557 def FindMenuItem(*args, **kwargs):
10558 """FindMenuItem(self, String menu, String item) -> int"""
10559 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10560
10561 def FindItemById(*args, **kwargs):
10562 """FindItemById(self, int id) -> MenuItem"""
10563 return _core_.MenuBar_FindItemById(*args, **kwargs)
10564
10565 def FindMenu(*args, **kwargs):
10566 """FindMenu(self, String title) -> int"""
10567 return _core_.MenuBar_FindMenu(*args, **kwargs)
10568
10569 def Enable(*args, **kwargs):
10570 """Enable(self, int id, bool enable)"""
10571 return _core_.MenuBar_Enable(*args, **kwargs)
10572
10573 def Check(*args, **kwargs):
10574 """Check(self, int id, bool check)"""
10575 return _core_.MenuBar_Check(*args, **kwargs)
10576
10577 def IsChecked(*args, **kwargs):
10578 """IsChecked(self, int id) -> bool"""
10579 return _core_.MenuBar_IsChecked(*args, **kwargs)
10580
10581 def IsEnabled(*args, **kwargs):
10582 """IsEnabled(self, int id) -> bool"""
10583 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10584
10585 def SetLabel(*args, **kwargs):
10586 """SetLabel(self, int id, String label)"""
10587 return _core_.MenuBar_SetLabel(*args, **kwargs)
10588
10589 def GetLabel(*args, **kwargs):
10590 """GetLabel(self, int id) -> String"""
10591 return _core_.MenuBar_GetLabel(*args, **kwargs)
10592
10593 def SetHelpString(*args, **kwargs):
10594 """SetHelpString(self, int id, String helpString)"""
10595 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10596
10597 def GetHelpString(*args, **kwargs):
10598 """GetHelpString(self, int id) -> String"""
10599 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10600
10601 def GetFrame(*args, **kwargs):
10602 """GetFrame(self) -> wxFrame"""
10603 return _core_.MenuBar_GetFrame(*args, **kwargs)
10604
10605 def IsAttached(*args, **kwargs):
10606 """IsAttached(self) -> bool"""
10607 return _core_.MenuBar_IsAttached(*args, **kwargs)
10608
10609 def Attach(*args, **kwargs):
10610 """Attach(self, wxFrame frame)"""
10611 return _core_.MenuBar_Attach(*args, **kwargs)
10612
10613 def Detach(*args, **kwargs):
10614 """Detach(self)"""
10615 return _core_.MenuBar_Detach(*args, **kwargs)
10616
10617 def UpdateMenus(*args, **kwargs):
10618 """UpdateMenus(self)"""
10619 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10620
10621 def SetAutoWindowMenu(*args, **kwargs):
10622 """SetAutoWindowMenu(bool enable)"""
10623 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10624
10625 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10626 def GetAutoWindowMenu(*args, **kwargs):
10627 """GetAutoWindowMenu() -> bool"""
10628 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10629
10630 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10631 def GetMenus(self):
10632 """Return a list of (menu, label) items for the menus in the MenuBar. """
10633 return [(self.GetMenu(i), self.GetLabelTop(i))
10634 for i in range(self.GetMenuCount())]
10635
10636 def SetMenus(self, items):
10637 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10638 for i in range(self.GetMenuCount()-1, -1, -1):
10639 self.Remove(i)
10640 for m, l in items:
10641 self.Append(m, l)
10642
10643 Frame = property(GetFrame,doc="See `GetFrame`")
10644 Menu = property(GetMenu,doc="See `GetMenu`")
10645 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
10646 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
10647 _core_.MenuBar_swigregister(MenuBar)
10648
10649 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10650 """MenuBar_SetAutoWindowMenu(bool enable)"""
10651 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10652
10653 def MenuBar_GetAutoWindowMenu(*args):
10654 """MenuBar_GetAutoWindowMenu() -> bool"""
10655 return _core_.MenuBar_GetAutoWindowMenu(*args)
10656
10657 #---------------------------------------------------------------------------
10658
10659 class MenuItem(Object):
10660 """Proxy of C++ MenuItem class"""
10661 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10662 __repr__ = _swig_repr
10663 def __init__(self, *args, **kwargs):
10664 """
10665 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10666 String help=EmptyString, int kind=ITEM_NORMAL,
10667 Menu subMenu=None) -> MenuItem
10668 """
10669 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10670 __swig_destroy__ = _core_.delete_MenuItem
10671 __del__ = lambda self : None;
10672 def GetMenu(*args, **kwargs):
10673 """GetMenu(self) -> Menu"""
10674 return _core_.MenuItem_GetMenu(*args, **kwargs)
10675
10676 def SetMenu(*args, **kwargs):
10677 """SetMenu(self, Menu menu)"""
10678 return _core_.MenuItem_SetMenu(*args, **kwargs)
10679
10680 def SetId(*args, **kwargs):
10681 """SetId(self, int id)"""
10682 return _core_.MenuItem_SetId(*args, **kwargs)
10683
10684 def GetId(*args, **kwargs):
10685 """GetId(self) -> int"""
10686 return _core_.MenuItem_GetId(*args, **kwargs)
10687
10688 def IsSeparator(*args, **kwargs):
10689 """IsSeparator(self) -> bool"""
10690 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10691
10692 def SetText(*args, **kwargs):
10693 """SetText(self, String str)"""
10694 return _core_.MenuItem_SetText(*args, **kwargs)
10695
10696 def GetLabel(*args, **kwargs):
10697 """GetLabel(self) -> String"""
10698 return _core_.MenuItem_GetLabel(*args, **kwargs)
10699
10700 def GetText(*args, **kwargs):
10701 """GetText(self) -> String"""
10702 return _core_.MenuItem_GetText(*args, **kwargs)
10703
10704 def GetLabelFromText(*args, **kwargs):
10705 """GetLabelFromText(String text) -> String"""
10706 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10707
10708 GetLabelFromText = staticmethod(GetLabelFromText)
10709 def GetKind(*args, **kwargs):
10710 """GetKind(self) -> int"""
10711 return _core_.MenuItem_GetKind(*args, **kwargs)
10712
10713 def SetKind(*args, **kwargs):
10714 """SetKind(self, int kind)"""
10715 return _core_.MenuItem_SetKind(*args, **kwargs)
10716
10717 def SetCheckable(*args, **kwargs):
10718 """SetCheckable(self, bool checkable)"""
10719 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10720
10721 def IsCheckable(*args, **kwargs):
10722 """IsCheckable(self) -> bool"""
10723 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10724
10725 def IsSubMenu(*args, **kwargs):
10726 """IsSubMenu(self) -> bool"""
10727 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10728
10729 def SetSubMenu(*args, **kwargs):
10730 """SetSubMenu(self, Menu menu)"""
10731 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10732
10733 def GetSubMenu(*args, **kwargs):
10734 """GetSubMenu(self) -> Menu"""
10735 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10736
10737 def Enable(*args, **kwargs):
10738 """Enable(self, bool enable=True)"""
10739 return _core_.MenuItem_Enable(*args, **kwargs)
10740
10741 def IsEnabled(*args, **kwargs):
10742 """IsEnabled(self) -> bool"""
10743 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10744
10745 def Check(*args, **kwargs):
10746 """Check(self, bool check=True)"""
10747 return _core_.MenuItem_Check(*args, **kwargs)
10748
10749 def IsChecked(*args, **kwargs):
10750 """IsChecked(self) -> bool"""
10751 return _core_.MenuItem_IsChecked(*args, **kwargs)
10752
10753 def Toggle(*args, **kwargs):
10754 """Toggle(self)"""
10755 return _core_.MenuItem_Toggle(*args, **kwargs)
10756
10757 def SetHelp(*args, **kwargs):
10758 """SetHelp(self, String str)"""
10759 return _core_.MenuItem_SetHelp(*args, **kwargs)
10760
10761 def GetHelp(*args, **kwargs):
10762 """GetHelp(self) -> String"""
10763 return _core_.MenuItem_GetHelp(*args, **kwargs)
10764
10765 def GetAccel(*args, **kwargs):
10766 """GetAccel(self) -> AcceleratorEntry"""
10767 return _core_.MenuItem_GetAccel(*args, **kwargs)
10768
10769 def SetAccel(*args, **kwargs):
10770 """SetAccel(self, AcceleratorEntry accel)"""
10771 return _core_.MenuItem_SetAccel(*args, **kwargs)
10772
10773 def SetBitmap(*args, **kwargs):
10774 """SetBitmap(self, Bitmap bitmap)"""
10775 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10776
10777 def GetBitmap(*args, **kwargs):
10778 """GetBitmap(self) -> Bitmap"""
10779 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10780
10781 def SetFont(*args, **kwargs):
10782 """SetFont(self, Font font)"""
10783 return _core_.MenuItem_SetFont(*args, **kwargs)
10784
10785 def GetFont(*args, **kwargs):
10786 """GetFont(self) -> Font"""
10787 return _core_.MenuItem_GetFont(*args, **kwargs)
10788
10789 def SetTextColour(*args, **kwargs):
10790 """SetTextColour(self, Colour colText)"""
10791 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10792
10793 def GetTextColour(*args, **kwargs):
10794 """GetTextColour(self) -> Colour"""
10795 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10796
10797 def SetBackgroundColour(*args, **kwargs):
10798 """SetBackgroundColour(self, Colour colBack)"""
10799 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10800
10801 def GetBackgroundColour(*args, **kwargs):
10802 """GetBackgroundColour(self) -> Colour"""
10803 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10804
10805 def SetBitmaps(*args, **kwargs):
10806 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10807 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10808
10809 def SetDisabledBitmap(*args, **kwargs):
10810 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10811 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10812
10813 def GetDisabledBitmap(*args, **kwargs):
10814 """GetDisabledBitmap(self) -> Bitmap"""
10815 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10816
10817 def SetMarginWidth(*args, **kwargs):
10818 """SetMarginWidth(self, int nWidth)"""
10819 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10820
10821 def GetMarginWidth(*args, **kwargs):
10822 """GetMarginWidth(self) -> int"""
10823 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10824
10825 def GetDefaultMarginWidth(*args, **kwargs):
10826 """GetDefaultMarginWidth() -> int"""
10827 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10828
10829 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10830 def IsOwnerDrawn(*args, **kwargs):
10831 """IsOwnerDrawn(self) -> bool"""
10832 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10833
10834 def SetOwnerDrawn(*args, **kwargs):
10835 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10836 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10837
10838 def ResetOwnerDrawn(*args, **kwargs):
10839 """ResetOwnerDrawn(self)"""
10840 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10841
10842 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
10843 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10844 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
10845 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10846 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10847 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
10848 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10849 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
10850 Label = property(GetLabel,doc="See `GetLabel`")
10851 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
10852 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
10853 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
10854 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
10855 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
10856 _core_.MenuItem_swigregister(MenuItem)
10857
10858 def MenuItem_GetLabelFromText(*args, **kwargs):
10859 """MenuItem_GetLabelFromText(String text) -> String"""
10860 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10861
10862 def MenuItem_GetDefaultMarginWidth(*args):
10863 """MenuItem_GetDefaultMarginWidth() -> int"""
10864 return _core_.MenuItem_GetDefaultMarginWidth(*args)
10865
10866 #---------------------------------------------------------------------------
10867
10868 class Control(Window):
10869 """
10870 This is the base class for a control or 'widget'.
10871
10872 A control is generally a small window which processes user input
10873 and/or displays one or more item of data.
10874 """
10875 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10876 __repr__ = _swig_repr
10877 def __init__(self, *args, **kwargs):
10878 """
10879 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10880 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10881 String name=ControlNameStr) -> Control
10882
10883 Create a Control. Normally you should only call this from a subclass'
10884 __init__ as a plain old wx.Control is not very useful.
10885 """
10886 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
10887 self._setOORInfo(self)
10888
10889 def Create(*args, **kwargs):
10890 """
10891 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10892 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10893 String name=ControlNameStr) -> bool
10894
10895 Do the 2nd phase and create the GUI control.
10896 """
10897 return _core_.Control_Create(*args, **kwargs)
10898
10899 def GetAlignment(*args, **kwargs):
10900 """
10901 GetAlignment(self) -> int
10902
10903 Get the control alignment (left/right/centre, top/bottom/centre)
10904 """
10905 return _core_.Control_GetAlignment(*args, **kwargs)
10906
10907 def GetLabelText(*args, **kwargs):
10908 """
10909 GetLabelText(self) -> String
10910
10911 Get just the text of the label, without mnemonic characters ('&')
10912 """
10913 return _core_.Control_GetLabelText(*args, **kwargs)
10914
10915 def Command(*args, **kwargs):
10916 """
10917 Command(self, CommandEvent event)
10918
10919 Simulates the effect of the user issuing a command to the item.
10920
10921 :see: `wx.CommandEvent`
10922
10923 """
10924 return _core_.Control_Command(*args, **kwargs)
10925
10926 def GetLabel(*args, **kwargs):
10927 """
10928 GetLabel(self) -> String
10929
10930 Return a control's text.
10931 """
10932 return _core_.Control_GetLabel(*args, **kwargs)
10933
10934 def GetClassDefaultAttributes(*args, **kwargs):
10935 """
10936 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10937
10938 Get the default attributes for this class. This is useful if you want
10939 to use the same font or colour in your own control as in a standard
10940 control -- which is a much better idea than hard coding specific
10941 colours or fonts which might look completely out of place on the
10942 user's system, especially if it uses themes.
10943
10944 The variant parameter is only relevant under Mac currently and is
10945 ignore under other platforms. Under Mac, it will change the size of
10946 the returned font. See `wx.Window.SetWindowVariant` for more about
10947 this.
10948 """
10949 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10950
10951 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
10952 Alignment = property(GetAlignment,doc="See `GetAlignment`")
10953 Label = property(GetLabel,doc="See `GetLabel`")
10954 LabelText = property(GetLabelText,doc="See `GetLabelText`")
10955 _core_.Control_swigregister(Control)
10956 ControlNameStr = cvar.ControlNameStr
10957
10958 def PreControl(*args, **kwargs):
10959 """
10960 PreControl() -> Control
10961
10962 Precreate a Control control for 2-phase creation
10963 """
10964 val = _core_.new_PreControl(*args, **kwargs)
10965 return val
10966
10967 def Control_GetClassDefaultAttributes(*args, **kwargs):
10968 """
10969 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10970
10971 Get the default attributes for this class. This is useful if you want
10972 to use the same font or colour in your own control as in a standard
10973 control -- which is a much better idea than hard coding specific
10974 colours or fonts which might look completely out of place on the
10975 user's system, especially if it uses themes.
10976
10977 The variant parameter is only relevant under Mac currently and is
10978 ignore under other platforms. Under Mac, it will change the size of
10979 the returned font. See `wx.Window.SetWindowVariant` for more about
10980 this.
10981 """
10982 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
10983
10984 #---------------------------------------------------------------------------
10985
10986 class ItemContainer(object):
10987 """
10988 The wx.ItemContainer class defines an interface which is implemented
10989 by all controls which have string subitems, each of which may be
10990 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
10991 as `wx.ComboBox` which implements an extended interface deriving from
10992 this one.
10993
10994 It defines the methods for accessing the control's items and although
10995 each of the derived classes implements them differently, they still
10996 all conform to the same interface.
10997
10998 The items in a wx.ItemContainer have (non empty) string labels and,
10999 optionally, client data associated with them.
11000
11001 """
11002 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11003 def __init__(self): raise AttributeError, "No constructor defined"
11004 __repr__ = _swig_repr
11005 def Append(*args, **kwargs):
11006 """
11007 Append(self, String item, PyObject clientData=None) -> int
11008
11009 Adds the item to the control, associating the given data with the item
11010 if not None. The return value is the index of the newly added item
11011 which may be different from the last one if the control is sorted (e.g.
11012 has wx.LB_SORT or wx.CB_SORT style).
11013 """
11014 return _core_.ItemContainer_Append(*args, **kwargs)
11015
11016 def AppendItems(*args, **kwargs):
11017 """
11018 AppendItems(self, List strings)
11019
11020 Apend several items at once to the control. Notice that calling this
11021 method may be much faster than appending the items one by one if you
11022 need to add a lot of items.
11023 """
11024 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11025
11026 def Insert(*args, **kwargs):
11027 """
11028 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11029
11030 Insert an item into the control before the item at the ``pos`` index,
11031 optionally associating some data object with the item.
11032 """
11033 return _core_.ItemContainer_Insert(*args, **kwargs)
11034
11035 def Clear(*args, **kwargs):
11036 """
11037 Clear(self)
11038
11039 Removes all items from the control.
11040 """
11041 return _core_.ItemContainer_Clear(*args, **kwargs)
11042
11043 def Delete(*args, **kwargs):
11044 """
11045 Delete(self, unsigned int n)
11046
11047 Deletes the item at the zero-based index 'n' from the control. Note
11048 that it is an error (signalled by a `wx.PyAssertionError` exception if
11049 enabled) to remove an item with the index negative or greater or equal
11050 than the number of items in the control.
11051 """
11052 return _core_.ItemContainer_Delete(*args, **kwargs)
11053
11054 def GetClientData(*args, **kwargs):
11055 """
11056 GetClientData(self, unsigned int n) -> PyObject
11057
11058 Returns the client data associated with the given item, (if any.)
11059 """
11060 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11061
11062 def SetClientData(*args, **kwargs):
11063 """
11064 SetClientData(self, unsigned int n, PyObject clientData)
11065
11066 Associate the given client data with the item at position n.
11067 """
11068 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11069
11070 def GetCount(*args, **kwargs):
11071 """
11072 GetCount(self) -> unsigned int
11073
11074 Returns the number of items in the control.
11075 """
11076 return _core_.ItemContainer_GetCount(*args, **kwargs)
11077
11078 def IsEmpty(*args, **kwargs):
11079 """
11080 IsEmpty(self) -> bool
11081
11082 Returns True if the control is empty or False if it has some items.
11083 """
11084 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11085
11086 def GetString(*args, **kwargs):
11087 """
11088 GetString(self, unsigned int n) -> String
11089
11090 Returns the label of the item with the given index.
11091 """
11092 return _core_.ItemContainer_GetString(*args, **kwargs)
11093
11094 def GetStrings(*args, **kwargs):
11095 """GetStrings(self) -> wxArrayString"""
11096 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11097
11098 def SetString(*args, **kwargs):
11099 """
11100 SetString(self, unsigned int n, String s)
11101
11102 Sets the label for the given item.
11103 """
11104 return _core_.ItemContainer_SetString(*args, **kwargs)
11105
11106 def FindString(*args, **kwargs):
11107 """
11108 FindString(self, String s) -> int
11109
11110 Finds an item whose label matches the given string. Returns the
11111 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11112 found.
11113 """
11114 return _core_.ItemContainer_FindString(*args, **kwargs)
11115
11116 def SetSelection(*args, **kwargs):
11117 """
11118 SetSelection(self, int n)
11119
11120 Sets the item at index 'n' to be the selected item.
11121 """
11122 return _core_.ItemContainer_SetSelection(*args, **kwargs)
11123
11124 def GetSelection(*args, **kwargs):
11125 """
11126 GetSelection(self) -> int
11127
11128 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11129 is selected.
11130 """
11131 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11132
11133 def SetStringSelection(*args, **kwargs):
11134 """SetStringSelection(self, String s) -> bool"""
11135 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11136
11137 def GetStringSelection(*args, **kwargs):
11138 """
11139 GetStringSelection(self) -> String
11140
11141 Returns the label of the selected item or an empty string if no item
11142 is selected.
11143 """
11144 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11145
11146 def Select(*args, **kwargs):
11147 """
11148 Select(self, int n)
11149
11150 This is the same as `SetSelection` and exists only because it is
11151 slightly more natural for controls which support multiple selection.
11152 """
11153 return _core_.ItemContainer_Select(*args, **kwargs)
11154
11155 def GetItems(self):
11156 """Return a list of the strings in the control"""
11157 return [self.GetString(i) for i in xrange(self.GetCount())]
11158
11159 def SetItems(self, items):
11160 """Clear and set the strings in the control from a list"""
11161 self.Clear()
11162 for i in items:
11163 self.Append(i)
11164
11165 Count = property(GetCount,doc="See `GetCount`")
11166 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11167 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11168 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11169 Strings = property(GetStrings,doc="See `GetStrings`")
11170 _core_.ItemContainer_swigregister(ItemContainer)
11171
11172 #---------------------------------------------------------------------------
11173
11174 class ControlWithItems(Control,ItemContainer):
11175 """
11176 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11177 wx.Control class, and is used for the base class of various controls
11178 that have items.
11179 """
11180 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11181 def __init__(self): raise AttributeError, "No constructor defined"
11182 __repr__ = _swig_repr
11183 _core_.ControlWithItems_swigregister(ControlWithItems)
11184
11185 #---------------------------------------------------------------------------
11186
11187 class SizerItem(Object):
11188 """
11189 The wx.SizerItem class is used to track the position, size and other
11190 attributes of each item managed by a `wx.Sizer`. It is not usually
11191 necessary to use this class because the sizer elements can also be
11192 identified by their positions or window or sizer references but
11193 sometimes it may be more convenient to use wx.SizerItem directly.
11194 Also, custom classes derived from `wx.PySizer` will probably need to
11195 use the collection of wx.SizerItems held by wx.Sizer when calculating
11196 layout.
11197
11198 :see: `wx.Sizer`, `wx.GBSizerItem`
11199 """
11200 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11201 __repr__ = _swig_repr
11202 def __init__(self, *args, **kwargs):
11203 """
11204 __init__(self) -> SizerItem
11205
11206 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11207 size will need to be set before this item can be used in a Sizer.
11208
11209 You will probably never need to create a wx.SizerItem directly as they
11210 are created automatically when the sizer's Add, Insert or Prepend
11211 methods are called.
11212
11213 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11214 """
11215 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11216 __swig_destroy__ = _core_.delete_SizerItem
11217 __del__ = lambda self : None;
11218 def DeleteWindows(*args, **kwargs):
11219 """
11220 DeleteWindows(self)
11221
11222 Destroy the window or the windows in a subsizer, depending on the type
11223 of item.
11224 """
11225 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11226
11227 def DetachSizer(*args, **kwargs):
11228 """
11229 DetachSizer(self)
11230
11231 Enable deleting the SizerItem without destroying the contained sizer.
11232 """
11233 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11234
11235 def GetSize(*args, **kwargs):
11236 """
11237 GetSize(self) -> Size
11238
11239 Get the current size of the item, as set in the last Layout.
11240 """
11241 return _core_.SizerItem_GetSize(*args, **kwargs)
11242
11243 def CalcMin(*args, **kwargs):
11244 """
11245 CalcMin(self) -> Size
11246
11247 Calculates the minimum desired size for the item, including any space
11248 needed by borders.
11249 """
11250 return _core_.SizerItem_CalcMin(*args, **kwargs)
11251
11252 def SetDimension(*args, **kwargs):
11253 """
11254 SetDimension(self, Point pos, Size size)
11255
11256 Set the position and size of the space allocated for this item by the
11257 sizer, and adjust the position and size of the item (window or
11258 subsizer) to be within that space taking alignment and borders into
11259 account.
11260 """
11261 return _core_.SizerItem_SetDimension(*args, **kwargs)
11262
11263 def GetMinSize(*args, **kwargs):
11264 """
11265 GetMinSize(self) -> Size
11266
11267 Get the minimum size needed for the item.
11268 """
11269 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11270
11271 def GetMinSizeWithBorder(*args, **kwargs):
11272 """
11273 GetMinSizeWithBorder(self) -> Size
11274
11275 Get the minimum size needed for the item with space for the borders
11276 added, if needed.
11277 """
11278 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11279
11280 def SetInitSize(*args, **kwargs):
11281 """SetInitSize(self, int x, int y)"""
11282 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11283
11284 def SetRatioWH(*args, **kwargs):
11285 """
11286 SetRatioWH(self, int width, int height)
11287
11288 Set the ratio item attribute.
11289 """
11290 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11291
11292 def SetRatioSize(*args, **kwargs):
11293 """
11294 SetRatioSize(self, Size size)
11295
11296 Set the ratio item attribute.
11297 """
11298 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11299
11300 def SetRatio(*args, **kwargs):
11301 """
11302 SetRatio(self, float ratio)
11303
11304 Set the ratio item attribute.
11305 """
11306 return _core_.SizerItem_SetRatio(*args, **kwargs)
11307
11308 def GetRatio(*args, **kwargs):
11309 """
11310 GetRatio(self) -> float
11311
11312 Set the ratio item attribute.
11313 """
11314 return _core_.SizerItem_GetRatio(*args, **kwargs)
11315
11316 def GetRect(*args, **kwargs):
11317 """
11318 GetRect(self) -> Rect
11319
11320 Returns the rectangle that the sizer item should occupy
11321 """
11322 return _core_.SizerItem_GetRect(*args, **kwargs)
11323
11324 def IsWindow(*args, **kwargs):
11325 """
11326 IsWindow(self) -> bool
11327
11328 Is this sizer item a window?
11329 """
11330 return _core_.SizerItem_IsWindow(*args, **kwargs)
11331
11332 def IsSizer(*args, **kwargs):
11333 """
11334 IsSizer(self) -> bool
11335
11336 Is this sizer item a subsizer?
11337 """
11338 return _core_.SizerItem_IsSizer(*args, **kwargs)
11339
11340 def IsSpacer(*args, **kwargs):
11341 """
11342 IsSpacer(self) -> bool
11343
11344 Is this sizer item a spacer?
11345 """
11346 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11347
11348 def SetProportion(*args, **kwargs):
11349 """
11350 SetProportion(self, int proportion)
11351
11352 Set the proportion value for this item.
11353 """
11354 return _core_.SizerItem_SetProportion(*args, **kwargs)
11355
11356 def GetProportion(*args, **kwargs):
11357 """
11358 GetProportion(self) -> int
11359
11360 Get the proportion value for this item.
11361 """
11362 return _core_.SizerItem_GetProportion(*args, **kwargs)
11363
11364 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11365 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
11366 def SetFlag(*args, **kwargs):
11367 """
11368 SetFlag(self, int flag)
11369
11370 Set the flag value for this item.
11371 """
11372 return _core_.SizerItem_SetFlag(*args, **kwargs)
11373
11374 def GetFlag(*args, **kwargs):
11375 """
11376 GetFlag(self) -> int
11377
11378 Get the flag value for this item.
11379 """
11380 return _core_.SizerItem_GetFlag(*args, **kwargs)
11381
11382 def SetBorder(*args, **kwargs):
11383 """
11384 SetBorder(self, int border)
11385
11386 Set the border value for this item.
11387 """
11388 return _core_.SizerItem_SetBorder(*args, **kwargs)
11389
11390 def GetBorder(*args, **kwargs):
11391 """
11392 GetBorder(self) -> int
11393
11394 Get the border value for this item.
11395 """
11396 return _core_.SizerItem_GetBorder(*args, **kwargs)
11397
11398 def GetWindow(*args, **kwargs):
11399 """
11400 GetWindow(self) -> Window
11401
11402 Get the window (if any) that is managed by this sizer item.
11403 """
11404 return _core_.SizerItem_GetWindow(*args, **kwargs)
11405
11406 def SetWindow(*args, **kwargs):
11407 """
11408 SetWindow(self, Window window)
11409
11410 Set the window to be managed by this sizer item.
11411 """
11412 return _core_.SizerItem_SetWindow(*args, **kwargs)
11413
11414 def GetSizer(*args, **kwargs):
11415 """
11416 GetSizer(self) -> Sizer
11417
11418 Get the subsizer (if any) that is managed by this sizer item.
11419 """
11420 return _core_.SizerItem_GetSizer(*args, **kwargs)
11421
11422 def SetSizer(*args, **kwargs):
11423 """
11424 SetSizer(self, Sizer sizer)
11425
11426 Set the subsizer to be managed by this sizer item.
11427 """
11428 return _core_.SizerItem_SetSizer(*args, **kwargs)
11429
11430 def GetSpacer(*args, **kwargs):
11431 """
11432 GetSpacer(self) -> Size
11433
11434 Get the size of the spacer managed by this sizer item.
11435 """
11436 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11437
11438 def SetSpacer(*args, **kwargs):
11439 """
11440 SetSpacer(self, Size size)
11441
11442 Set the size of the spacer to be managed by this sizer item.
11443 """
11444 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11445
11446 def Show(*args, **kwargs):
11447 """
11448 Show(self, bool show)
11449
11450 Set the show item attribute, which sizers use to determine if the item
11451 is to be made part of the layout or not. If the item is tracking a
11452 window then it is shown or hidden as needed.
11453 """
11454 return _core_.SizerItem_Show(*args, **kwargs)
11455
11456 def IsShown(*args, **kwargs):
11457 """
11458 IsShown(self) -> bool
11459
11460 Is the item to be shown in the layout?
11461 """
11462 return _core_.SizerItem_IsShown(*args, **kwargs)
11463
11464 def GetPosition(*args, **kwargs):
11465 """
11466 GetPosition(self) -> Point
11467
11468 Returns the current position of the item, as set in the last Layout.
11469 """
11470 return _core_.SizerItem_GetPosition(*args, **kwargs)
11471
11472 def GetUserData(*args, **kwargs):
11473 """
11474 GetUserData(self) -> PyObject
11475
11476 Returns the userData associated with this sizer item, or None if there
11477 isn't any.
11478 """
11479 return _core_.SizerItem_GetUserData(*args, **kwargs)
11480
11481 def SetUserData(*args, **kwargs):
11482 """
11483 SetUserData(self, PyObject userData)
11484
11485 Associate a Python object with this sizer item.
11486 """
11487 return _core_.SizerItem_SetUserData(*args, **kwargs)
11488
11489 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11490 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11491 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11492 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11493 Position = property(GetPosition,doc="See `GetPosition`")
11494 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11495 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11496 Rect = property(GetRect,doc="See `GetRect`")
11497 Size = property(GetSize,doc="See `GetSize`")
11498 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11499 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11500 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11501 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
11502 _core_.SizerItem_swigregister(SizerItem)
11503
11504 def SizerItemWindow(*args, **kwargs):
11505 """
11506 SizerItemWindow(Window window, int proportion, int flag, int border,
11507 PyObject userData=None) -> SizerItem
11508
11509 Constructs a `wx.SizerItem` for tracking a window.
11510 """
11511 val = _core_.new_SizerItemWindow(*args, **kwargs)
11512 return val
11513
11514 def SizerItemSpacer(*args, **kwargs):
11515 """
11516 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11517 PyObject userData=None) -> SizerItem
11518
11519 Constructs a `wx.SizerItem` for tracking a spacer.
11520 """
11521 val = _core_.new_SizerItemSpacer(*args, **kwargs)
11522 return val
11523
11524 def SizerItemSizer(*args, **kwargs):
11525 """
11526 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11527 PyObject userData=None) -> SizerItem
11528
11529 Constructs a `wx.SizerItem` for tracking a subsizer
11530 """
11531 val = _core_.new_SizerItemSizer(*args, **kwargs)
11532 return val
11533
11534 class Sizer(Object):
11535 """
11536 wx.Sizer is the abstract base class used for laying out subwindows in
11537 a window. You cannot use wx.Sizer directly; instead, you will have to
11538 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11539 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11540 `wx.GridBagSizer`.
11541
11542 The concept implemented by sizers in wxWidgets is closely related to
11543 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11544 toolkit or the Qt toolkit. It is based upon the idea of the individual
11545 subwindows reporting their minimal required size and their ability to
11546 get stretched if the size of the parent window has changed. This will
11547 most often mean that the programmer does not set the original size of
11548 a dialog in the beginning, rather the dialog will assigned a sizer and
11549 this sizer will be queried about the recommended size. The sizer in
11550 turn will query its children, which can be normal windows or contorls,
11551 empty space or other sizers, so that a hierarchy of sizers can be
11552 constructed. Note that wxSizer does not derive from wxWindow and thus
11553 do not interfere with tab ordering and requires very little resources
11554 compared to a real window on screen.
11555
11556 What makes sizers so well fitted for use in wxWidgets is the fact that
11557 every control reports its own minimal size and the algorithm can
11558 handle differences in font sizes or different window (dialog item)
11559 sizes on different platforms without problems. If for example the
11560 standard font as well as the overall design of Mac widgets requires
11561 more space than on Windows, then the initial size of a dialog using a
11562 sizer will automatically be bigger on Mac than on Windows.
11563 """
11564 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11565 def __init__(self): raise AttributeError, "No constructor defined"
11566 __repr__ = _swig_repr
11567 __swig_destroy__ = _core_.delete_Sizer
11568 __del__ = lambda self : None;
11569 def _setOORInfo(*args, **kwargs):
11570 """_setOORInfo(self, PyObject _self)"""
11571 return _core_.Sizer__setOORInfo(*args, **kwargs)
11572
11573 def Add(*args, **kwargs):
11574 """
11575 Add(self, item, int proportion=0, int flag=0, int border=0,
11576 PyObject userData=None) -> wx.SizerItem
11577
11578 Appends a child item to the sizer.
11579 """
11580 return _core_.Sizer_Add(*args, **kwargs)
11581
11582 def Insert(*args, **kwargs):
11583 """
11584 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11585 PyObject userData=None) -> wx.SizerItem
11586
11587 Inserts a new item into the list of items managed by this sizer before
11588 the item at index *before*. See `Add` for a description of the parameters.
11589 """
11590 return _core_.Sizer_Insert(*args, **kwargs)
11591
11592 def Prepend(*args, **kwargs):
11593 """
11594 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11595 PyObject userData=None) -> wx.SizerItem
11596
11597 Adds a new item to the begining of the list of sizer items managed by
11598 this sizer. See `Add` for a description of the parameters.
11599 """
11600 return _core_.Sizer_Prepend(*args, **kwargs)
11601
11602 def Remove(*args, **kwargs):
11603 """
11604 Remove(self, item) -> bool
11605
11606 Removes an item from the sizer and destroys it. This method does not
11607 cause any layout or resizing to take place, call `Layout` to update
11608 the layout on screen after removing a child from the sizer. The
11609 *item* parameter can be either a window, a sizer, or the zero-based
11610 index of an item to remove. Returns True if the child item was found
11611 and removed.
11612 """
11613 return _core_.Sizer_Remove(*args, **kwargs)
11614
11615 def Detach(*args, **kwargs):
11616 """
11617 Detach(self, item) -> bool
11618
11619 Detaches an item from the sizer without destroying it. This method
11620 does not cause any layout or resizing to take place, call `Layout` to
11621 do so. The *item* parameter can be either a window, a sizer, or the
11622 zero-based index of the item to be detached. Returns True if the child item
11623 was found and detached.
11624 """
11625 return _core_.Sizer_Detach(*args, **kwargs)
11626
11627 def GetItem(*args, **kwargs):
11628 """
11629 GetItem(self, item) -> wx.SizerItem
11630
11631 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11632 parameter can be either a window, a sizer, or the zero-based index of
11633 the item to be found.
11634 """
11635 return _core_.Sizer_GetItem(*args, **kwargs)
11636
11637 def _SetItemMinSize(*args, **kwargs):
11638 """_SetItemMinSize(self, PyObject item, Size size)"""
11639 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11640
11641 def _ReplaceWin(*args, **kwargs):
11642 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11643 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11644
11645 def _ReplaceSizer(*args, **kwargs):
11646 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11647 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11648
11649 def _ReplaceItem(*args, **kwargs):
11650 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11651 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11652
11653 def Replace(self, olditem, item, recursive=False):
11654 """
11655 Detaches the given ``olditem`` from the sizer and replaces it with
11656 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11657 detached child is destroyed only if it is not a window, (because
11658 windows are owned by their parent, not the sizer.) The
11659 ``recursive`` parameter can be used to search for the given
11660 element recursivly in subsizers.
11661
11662 This method does not cause any layout or resizing to take place,
11663 call `Layout` to do so.
11664
11665 Returns ``True`` if the child item was found and removed.
11666 """
11667 if isinstance(olditem, wx.Window):
11668 return self._ReplaceWin(olditem, item, recursive)
11669 elif isinstnace(olditem, wx.Sizer):
11670 return self._ReplaceSizer(olditem, item, recursive)
11671 elif isinstnace(olditem, int):
11672 return self._ReplaceItem(olditem, item)
11673 else:
11674 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11675
11676 def SetContainingWindow(*args, **kwargs):
11677 """
11678 SetContainingWindow(self, Window window)
11679
11680 Set (or unset) the window this sizer is used in.
11681 """
11682 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
11683
11684 def GetContainingWindow(*args, **kwargs):
11685 """
11686 GetContainingWindow(self) -> Window
11687
11688 Get the window this sizer is used in.
11689 """
11690 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
11691
11692 def SetItemMinSize(self, item, *args):
11693 """
11694 SetItemMinSize(self, item, Size size)
11695
11696 Sets the minimum size that will be allocated for an item in the sizer.
11697 The *item* parameter can be either a window, a sizer, or the
11698 zero-based index of the item. If a window or sizer is given then it
11699 will be searched for recursivly in subsizers if neccessary.
11700 """
11701 if len(args) == 2:
11702 # for backward compatibility accept separate width,height args too
11703 return self._SetItemMinSize(item, args)
11704 else:
11705 return self._SetItemMinSize(item, args[0])
11706
11707 def AddItem(*args, **kwargs):
11708 """
11709 AddItem(self, SizerItem item)
11710
11711 Adds a `wx.SizerItem` to the sizer.
11712 """
11713 return _core_.Sizer_AddItem(*args, **kwargs)
11714
11715 def InsertItem(*args, **kwargs):
11716 """
11717 InsertItem(self, int index, SizerItem item)
11718
11719 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11720 """
11721 return _core_.Sizer_InsertItem(*args, **kwargs)
11722
11723 def PrependItem(*args, **kwargs):
11724 """
11725 PrependItem(self, SizerItem item)
11726
11727 Prepends a `wx.SizerItem` to the sizer.
11728 """
11729 return _core_.Sizer_PrependItem(*args, **kwargs)
11730
11731 def AddMany(self, items):
11732 """
11733 AddMany is a convenience method for adding several items
11734 to a sizer at one time. Simply pass it a list of tuples,
11735 where each tuple consists of the parameters that you
11736 would normally pass to the `Add` method.
11737 """
11738 for item in items:
11739 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11740 item = (item, )
11741 self.Add(*item)
11742
11743 def AddSpacer(self, *args, **kw):
11744 """AddSpacer(int size) --> SizerItem
11745
11746 Add a spacer that is (size,size) pixels.
11747 """
11748 if args and type(args[0]) == int:
11749 return self.Add( (args[0],args[0] ), 0)
11750 else: # otherwise stay compatible with old AddSpacer
11751 return self.Add(*args, **kw)
11752 def PrependSpacer(self, *args, **kw):
11753 """PrependSpacer(int size) --> SizerItem
11754
11755 Prepend a spacer that is (size, size) pixels."""
11756 if args and type(args[0]) == int:
11757 return self.Prepend( (args[0],args[0] ), 0)
11758 else: # otherwise stay compatible with old PrependSpacer
11759 return self.Prepend(*args, **kw)
11760 def InsertSpacer(self, index, *args, **kw):
11761 """InsertSpacer(int index, int size) --> SizerItem
11762
11763 Insert a spacer at position index that is (size, size) pixels."""
11764 if args and type(args[0]) == int:
11765 return self.Insert( index, (args[0],args[0] ), 0)
11766 else: # otherwise stay compatible with old InsertSpacer
11767 return self.Insert(index, *args, **kw)
11768
11769
11770 def AddStretchSpacer(self, prop=1):
11771 """AddStretchSpacer(int prop=1) --> SizerItem
11772
11773 Add a stretchable spacer."""
11774 return self.Add((0,0), prop)
11775 def PrependStretchSpacer(self, prop=1):
11776 """PrependStretchSpacer(int prop=1) --> SizerItem
11777
11778 Prepend a stretchable spacer."""
11779 return self.Prepend((0,0), prop)
11780 def InsertStretchSpacer(self, index, prop=1):
11781 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11782
11783 Insert a stretchable spacer."""
11784 return self.Insert(index, (0,0), prop)
11785
11786
11787 # for backwards compatibility only, please do not use in new code
11788 def AddWindow(self, *args, **kw):
11789 """Compatibility alias for `Add`."""
11790 return self.Add(*args, **kw)
11791 def AddSizer(self, *args, **kw):
11792 """Compatibility alias for `Add`."""
11793 return self.Add(*args, **kw)
11794
11795 def PrependWindow(self, *args, **kw):
11796 """Compatibility alias for `Prepend`."""
11797 return self.Prepend(*args, **kw)
11798 def PrependSizer(self, *args, **kw):
11799 """Compatibility alias for `Prepend`."""
11800 return self.Prepend(*args, **kw)
11801
11802 def InsertWindow(self, *args, **kw):
11803 """Compatibility alias for `Insert`."""
11804 return self.Insert(*args, **kw)
11805 def InsertSizer(self, *args, **kw):
11806 """Compatibility alias for `Insert`."""
11807 return self.Insert(*args, **kw)
11808
11809 def RemoveWindow(self, *args, **kw):
11810 """Compatibility alias for `Remove`."""
11811 return self.Remove(*args, **kw)
11812 def RemoveSizer(self, *args, **kw):
11813 """Compatibility alias for `Remove`."""
11814 return self.Remove(*args, **kw)
11815 def RemovePos(self, *args, **kw):
11816 """Compatibility alias for `Remove`."""
11817 return self.Remove(*args, **kw)
11818
11819
11820 def SetDimension(*args, **kwargs):
11821 """
11822 SetDimension(self, int x, int y, int width, int height)
11823
11824 Call this to force the sizer to take the given dimension and thus
11825 force the items owned by the sizer to resize themselves according to
11826 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11827 methods.
11828 """
11829 return _core_.Sizer_SetDimension(*args, **kwargs)
11830
11831 def SetMinSize(*args, **kwargs):
11832 """
11833 SetMinSize(self, Size size)
11834
11835 Call this to give the sizer a minimal size. Normally, the sizer will
11836 calculate its minimal size based purely on how much space its children
11837 need. After calling this method `GetMinSize` will return either the
11838 minimal size as requested by its children or the minimal size set
11839 here, depending on which is bigger.
11840 """
11841 return _core_.Sizer_SetMinSize(*args, **kwargs)
11842
11843 def GetSize(*args, **kwargs):
11844 """
11845 GetSize(self) -> Size
11846
11847 Returns the current size of the space managed by the sizer.
11848 """
11849 return _core_.Sizer_GetSize(*args, **kwargs)
11850
11851 def GetPosition(*args, **kwargs):
11852 """
11853 GetPosition(self) -> Point
11854
11855 Returns the current position of the sizer's managed space.
11856 """
11857 return _core_.Sizer_GetPosition(*args, **kwargs)
11858
11859 def GetMinSize(*args, **kwargs):
11860 """
11861 GetMinSize(self) -> Size
11862
11863 Returns the minimal size of the sizer. This is either the combined
11864 minimal size of all the children and their borders or the minimal size
11865 set by SetMinSize, depending on which is bigger.
11866 """
11867 return _core_.Sizer_GetMinSize(*args, **kwargs)
11868
11869 def GetSizeTuple(self):
11870 return self.GetSize().Get()
11871 def GetPositionTuple(self):
11872 return self.GetPosition().Get()
11873 def GetMinSizeTuple(self):
11874 return self.GetMinSize().Get()
11875
11876 def RecalcSizes(*args, **kwargs):
11877 """
11878 RecalcSizes(self)
11879
11880 Using the sizes calculated by `CalcMin` reposition and resize all the
11881 items managed by this sizer. You should not need to call this directly as
11882 it is called by `Layout`.
11883 """
11884 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11885
11886 def CalcMin(*args, **kwargs):
11887 """
11888 CalcMin(self) -> Size
11889
11890 This method is where the sizer will do the actual calculation of its
11891 children's minimal sizes. You should not need to call this directly as
11892 it is called by `Layout`.
11893 """
11894 return _core_.Sizer_CalcMin(*args, **kwargs)
11895
11896 def Layout(*args, **kwargs):
11897 """
11898 Layout(self)
11899
11900 This method will force the recalculation and layout of the items
11901 controlled by the sizer using the current space allocated to the
11902 sizer. Normally this is called automatically from the owning window's
11903 EVT_SIZE handler, but it is also useful to call it from user code when
11904 one of the items in a sizer change size, or items are added or
11905 removed.
11906 """
11907 return _core_.Sizer_Layout(*args, **kwargs)
11908
11909 def Fit(*args, **kwargs):
11910 """
11911 Fit(self, Window window) -> Size
11912
11913 Tell the sizer to resize the *window* to match the sizer's minimal
11914 size. This is commonly done in the constructor of the window itself in
11915 order to set its initial size to match the needs of the children as
11916 determined by the sizer. Returns the new size.
11917
11918 For a top level window this is the total window size, not the client size.
11919 """
11920 return _core_.Sizer_Fit(*args, **kwargs)
11921
11922 def FitInside(*args, **kwargs):
11923 """
11924 FitInside(self, Window window)
11925
11926 Tell the sizer to resize the *virtual size* of the *window* to match the
11927 sizer's minimal size. This will not alter the on screen size of the
11928 window, but may cause the addition/removal/alteration of scrollbars
11929 required to view the virtual area in windows which manage it.
11930
11931 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11932
11933 """
11934 return _core_.Sizer_FitInside(*args, **kwargs)
11935
11936 def SetSizeHints(*args, **kwargs):
11937 """
11938 SetSizeHints(self, Window window)
11939
11940 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11941 match the sizer's minimal size. This is commonly done in the
11942 constructor of the window itself if the window is resizable (as are
11943 many dialogs under Unix and frames on probably all platforms) in order
11944 to prevent the window from being sized smaller than the minimal size
11945 required by the sizer.
11946 """
11947 return _core_.Sizer_SetSizeHints(*args, **kwargs)
11948
11949 def SetVirtualSizeHints(*args, **kwargs):
11950 """
11951 SetVirtualSizeHints(self, Window window)
11952
11953 Tell the sizer to set the minimal size of the window virtual area to
11954 match the sizer's minimal size. For windows with managed scrollbars
11955 this will set them appropriately.
11956
11957 :see: `wx.ScrolledWindow.SetScrollbars`
11958
11959 """
11960 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
11961
11962 def Clear(*args, **kwargs):
11963 """
11964 Clear(self, bool deleteWindows=False)
11965
11966 Clear all items from the sizer, optionally destroying the window items
11967 as well.
11968 """
11969 return _core_.Sizer_Clear(*args, **kwargs)
11970
11971 def DeleteWindows(*args, **kwargs):
11972 """
11973 DeleteWindows(self)
11974
11975 Destroy all windows managed by the sizer.
11976 """
11977 return _core_.Sizer_DeleteWindows(*args, **kwargs)
11978
11979 def GetChildren(*args, **kwargs):
11980 """
11981 GetChildren(self) -> list
11982
11983 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11984 """
11985 return _core_.Sizer_GetChildren(*args, **kwargs)
11986
11987 def Show(*args, **kwargs):
11988 """
11989 Show(self, item, bool show=True, bool recursive=false) -> bool
11990
11991 Shows or hides an item managed by the sizer. To make a sizer item
11992 disappear or reappear, use Show followed by `Layout`. The *item*
11993 parameter can be either a window, a sizer, or the zero-based index of
11994 the item. Use the recursive parameter to show or hide an item in a
11995 subsizer. Returns True if the item was found.
11996 """
11997 return _core_.Sizer_Show(*args, **kwargs)
11998
11999 def IsShown(*args, **kwargs):
12000 """
12001 IsShown(self, item)
12002
12003 Determines if the item is currently shown. To make a sizer
12004 item disappear or reappear, use Show followed by `Layout`. The *item*
12005 parameter can be either a window, a sizer, or the zero-based index of
12006 the item.
12007 """
12008 return _core_.Sizer_IsShown(*args, **kwargs)
12009
12010 def Hide(self, item, recursive=False):
12011 """
12012 A convenience method for `Show` (item, False, recursive).
12013 """
12014 return self.Show(item, False, recursive)
12015
12016 def ShowItems(*args, **kwargs):
12017 """
12018 ShowItems(self, bool show)
12019
12020 Recursively call `wx.SizerItem.Show` on all sizer items.
12021 """
12022 return _core_.Sizer_ShowItems(*args, **kwargs)
12023
12024 Children = property(GetChildren,doc="See `GetChildren`")
12025 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12026 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12027 Position = property(GetPosition,doc="See `GetPosition`")
12028 Size = property(GetSize,doc="See `GetSize`")
12029 _core_.Sizer_swigregister(Sizer)
12030
12031 class PySizer(Sizer):
12032 """
12033 wx.PySizer is a special version of `wx.Sizer` that has been
12034 instrumented to allow the C++ virtual methods to be overloaded in
12035 Python derived classes. You would derive from this class if you are
12036 wanting to implement a custom sizer in Python code. Simply implement
12037 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12038 For example::
12039
12040 class MySizer(wx.PySizer):
12041 def __init__(self):
12042 wx.PySizer.__init__(self)
12043
12044 def CalcMin(self):
12045 for item in self.GetChildren():
12046 # calculate the total minimum width and height needed
12047 # by all items in the sizer according to this sizer's
12048 # layout algorithm.
12049 ...
12050 return wx.Size(width, height)
12051
12052 def RecalcSizes(self):
12053 # find the space allotted to this sizer
12054 pos = self.GetPosition()
12055 size = self.GetSize()
12056 for item in self.GetChildren():
12057 # Recalculate (if necessary) the position and size of
12058 # each item and then call item.SetDimension to do the
12059 # actual positioning and sizing of the items within the
12060 # space alloted to this sizer.
12061 ...
12062 item.SetDimension(itemPos, itemSize)
12063
12064
12065 When `Layout` is called it first calls `CalcMin` followed by
12066 `RecalcSizes` so you can optimize a bit by saving the results of
12067 `CalcMin` and reusing them in `RecalcSizes`.
12068
12069 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12070
12071
12072 """
12073 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12074 __repr__ = _swig_repr
12075 def __init__(self, *args, **kwargs):
12076 """
12077 __init__(self) -> PySizer
12078
12079 Creates a wx.PySizer. Must be called from the __init__ in the derived
12080 class.
12081 """
12082 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12083 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12084
12085 def _setCallbackInfo(*args, **kwargs):
12086 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12087 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12088
12089 _core_.PySizer_swigregister(PySizer)
12090
12091 #---------------------------------------------------------------------------
12092
12093 class BoxSizer(Sizer):
12094 """
12095 The basic idea behind a box sizer is that windows will most often be
12096 laid out in rather simple basic geometry, typically in a row or a
12097 column or nested hierarchies of either. A wx.BoxSizer will lay out
12098 its items in a simple row or column, depending on the orientation
12099 parameter passed to the constructor.
12100 """
12101 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12102 __repr__ = _swig_repr
12103 def __init__(self, *args, **kwargs):
12104 """
12105 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12106
12107 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12108 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12109 sizer.
12110 """
12111 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12112 self._setOORInfo(self)
12113
12114 def GetOrientation(*args, **kwargs):
12115 """
12116 GetOrientation(self) -> int
12117
12118 Returns the current orientation of the sizer.
12119 """
12120 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12121
12122 def SetOrientation(*args, **kwargs):
12123 """
12124 SetOrientation(self, int orient)
12125
12126 Resets the orientation of the sizer.
12127 """
12128 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12129
12130 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12131 _core_.BoxSizer_swigregister(BoxSizer)
12132
12133 #---------------------------------------------------------------------------
12134
12135 class StaticBoxSizer(BoxSizer):
12136 """
12137 wx.StaticBoxSizer derives from and functions identically to the
12138 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12139 manages. Note that this static box must be created separately and
12140 passed to the sizer constructor.
12141 """
12142 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12143 __repr__ = _swig_repr
12144 def __init__(self, *args, **kwargs):
12145 """
12146 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12147
12148 Constructor. It takes an associated static box and the orientation
12149 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12150 ``wx.HORIZONTAL``.
12151 """
12152 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12153 self._setOORInfo(self)
12154
12155 def GetStaticBox(*args, **kwargs):
12156 """
12157 GetStaticBox(self) -> StaticBox
12158
12159 Returns the static box associated with this sizer.
12160 """
12161 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12162
12163 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12164 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
12165
12166 #---------------------------------------------------------------------------
12167
12168 class GridSizer(Sizer):
12169 """
12170 A grid sizer is a sizer which lays out its children in a
12171 two-dimensional table with all cells having the same size. In other
12172 words, the width of each cell within the grid is the width of the
12173 widest item added to the sizer and the height of each grid cell is the
12174 height of the tallest item. An optional vertical and/or horizontal
12175 gap between items can also be specified (in pixels.)
12176
12177 Items are placed in the cells of the grid in the order they are added,
12178 in row-major order. In other words, the first row is filled first,
12179 then the second, and so on until all items have been added. (If
12180 neccessary, additional rows will be added as items are added.) If you
12181 need to have greater control over the cells that items are placed in
12182 then use the `wx.GridBagSizer`.
12183
12184 """
12185 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12186 __repr__ = _swig_repr
12187 def __init__(self, *args, **kwargs):
12188 """
12189 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12190
12191 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12192 of columns and rows in the sizer - if either of the parameters is
12193 zero, it will be calculated to from the total number of children in
12194 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12195 define extra space between all children.
12196 """
12197 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
12198 self._setOORInfo(self)
12199
12200 def SetCols(*args, **kwargs):
12201 """
12202 SetCols(self, int cols)
12203
12204 Sets the number of columns in the sizer.
12205 """
12206 return _core_.GridSizer_SetCols(*args, **kwargs)
12207
12208 def SetRows(*args, **kwargs):
12209 """
12210 SetRows(self, int rows)
12211
12212 Sets the number of rows in the sizer.
12213 """
12214 return _core_.GridSizer_SetRows(*args, **kwargs)
12215
12216 def SetVGap(*args, **kwargs):
12217 """
12218 SetVGap(self, int gap)
12219
12220 Sets the vertical gap (in pixels) between the cells in the sizer.
12221 """
12222 return _core_.GridSizer_SetVGap(*args, **kwargs)
12223
12224 def SetHGap(*args, **kwargs):
12225 """
12226 SetHGap(self, int gap)
12227
12228 Sets the horizontal gap (in pixels) between cells in the sizer
12229 """
12230 return _core_.GridSizer_SetHGap(*args, **kwargs)
12231
12232 def GetCols(*args, **kwargs):
12233 """
12234 GetCols(self) -> int
12235
12236 Returns the number of columns in the sizer.
12237 """
12238 return _core_.GridSizer_GetCols(*args, **kwargs)
12239
12240 def GetRows(*args, **kwargs):
12241 """
12242 GetRows(self) -> int
12243
12244 Returns the number of rows in the sizer.
12245 """
12246 return _core_.GridSizer_GetRows(*args, **kwargs)
12247
12248 def GetVGap(*args, **kwargs):
12249 """
12250 GetVGap(self) -> int
12251
12252 Returns the vertical gap (in pixels) between the cells in the sizer.
12253 """
12254 return _core_.GridSizer_GetVGap(*args, **kwargs)
12255
12256 def GetHGap(*args, **kwargs):
12257 """
12258 GetHGap(self) -> int
12259
12260 Returns the horizontal gap (in pixels) between cells in the sizer.
12261 """
12262 return _core_.GridSizer_GetHGap(*args, **kwargs)
12263
12264 def CalcRowsCols(self):
12265 """
12266 CalcRowsCols() -> (rows, cols)
12267
12268 Calculates how many rows and columns will be in the sizer based
12269 on the current number of items and also the rows, cols specified
12270 in the constructor.
12271 """
12272 nitems = len(self.GetChildren())
12273 rows = self.GetRows()
12274 cols = self.GetCols()
12275 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12276 if cols != 0:
12277 rows = (nitems + cols - 1) / cols
12278 elif rows != 0:
12279 cols = (nitems + rows - 1) / rows
12280 return (rows, cols)
12281
12282 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12283 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12284 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12285 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
12286 _core_.GridSizer_swigregister(GridSizer)
12287
12288 #---------------------------------------------------------------------------
12289
12290 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12291 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12292 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12293 class FlexGridSizer(GridSizer):
12294 """
12295 A flex grid sizer is a sizer which lays out its children in a
12296 two-dimensional table with all table cells in one row having the same
12297 height and all cells in one column having the same width, but all
12298 rows or all columns are not necessarily the same height or width as in
12299 the `wx.GridSizer`.
12300
12301 wx.FlexGridSizer can also size items equally in one direction but
12302 unequally ("flexibly") in the other. If the sizer is only flexible
12303 in one direction (this can be changed using `SetFlexibleDirection`), it
12304 needs to be decided how the sizer should grow in the other ("non
12305 flexible") direction in order to fill the available space. The
12306 `SetNonFlexibleGrowMode` method serves this purpose.
12307
12308
12309 """
12310 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12311 __repr__ = _swig_repr
12312 def __init__(self, *args, **kwargs):
12313 """
12314 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12315
12316 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12317 number of columns and rows in the sizer - if either of the parameters
12318 is zero, it will be calculated to from the total number of children in
12319 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12320 define extra space between all children.
12321 """
12322 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
12323 self._setOORInfo(self)
12324
12325 def AddGrowableRow(*args, **kwargs):
12326 """
12327 AddGrowableRow(self, size_t idx, int proportion=0)
12328
12329 Specifies that row *idx* (starting from zero) should be grown if there
12330 is extra space available to the sizer.
12331
12332 The *proportion* parameter has the same meaning as the stretch factor
12333 for the box sizers except that if all proportions are 0, then all
12334 columns are resized equally (instead of not being resized at all).
12335 """
12336 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12337
12338 def RemoveGrowableRow(*args, **kwargs):
12339 """
12340 RemoveGrowableRow(self, size_t idx)
12341
12342 Specifies that row *idx* is no longer growable.
12343 """
12344 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12345
12346 def AddGrowableCol(*args, **kwargs):
12347 """
12348 AddGrowableCol(self, size_t idx, int proportion=0)
12349
12350 Specifies that column *idx* (starting from zero) should be grown if
12351 there is extra space available to the sizer.
12352
12353 The *proportion* parameter has the same meaning as the stretch factor
12354 for the box sizers except that if all proportions are 0, then all
12355 columns are resized equally (instead of not being resized at all).
12356 """
12357 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12358
12359 def RemoveGrowableCol(*args, **kwargs):
12360 """
12361 RemoveGrowableCol(self, size_t idx)
12362
12363 Specifies that column *idx* is no longer growable.
12364 """
12365 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12366
12367 def SetFlexibleDirection(*args, **kwargs):
12368 """
12369 SetFlexibleDirection(self, int direction)
12370
12371 Specifies whether the sizer should flexibly resize its columns, rows,
12372 or both. Argument *direction* can be one of the following values. Any
12373 other value is ignored.
12374
12375 ============== =======================================
12376 wx.VERTICAL Rows are flexibly sized.
12377 wx.HORIZONTAL Columns are flexibly sized.
12378 wx.BOTH Both rows and columns are flexibly sized
12379 (this is the default value).
12380 ============== =======================================
12381
12382 Note that this method does not trigger relayout.
12383
12384 """
12385 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12386
12387 def GetFlexibleDirection(*args, **kwargs):
12388 """
12389 GetFlexibleDirection(self) -> int
12390
12391 Returns a value that specifies whether the sizer
12392 flexibly resizes its columns, rows, or both (default).
12393
12394 :see: `SetFlexibleDirection`
12395 """
12396 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12397
12398 def SetNonFlexibleGrowMode(*args, **kwargs):
12399 """
12400 SetNonFlexibleGrowMode(self, int mode)
12401
12402 Specifies how the sizer should grow in the non-flexible direction if
12403 there is one (so `SetFlexibleDirection` must have been called
12404 previously). Argument *mode* can be one of the following values:
12405
12406 ========================== =================================================
12407 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12408 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12409 `AddGrowableCol` and `AddGrowableRow`. In this
12410 case equal sizing applies to minimum sizes of
12411 columns or rows (this is the default value).
12412 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12413 the non flexible direction, whether they are
12414 growable or not in the flexbile direction.
12415 ========================== =================================================
12416
12417 Note that this method does not trigger relayout.
12418 """
12419 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12420
12421 def GetNonFlexibleGrowMode(*args, **kwargs):
12422 """
12423 GetNonFlexibleGrowMode(self) -> int
12424
12425 Returns the value that specifies how the sizer grows in the
12426 non-flexible direction if there is one.
12427
12428 :see: `SetNonFlexibleGrowMode`
12429 """
12430 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12431
12432 def GetRowHeights(*args, **kwargs):
12433 """
12434 GetRowHeights(self) -> list
12435
12436 Returns a list of integers representing the heights of each of the
12437 rows in the sizer.
12438 """
12439 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12440
12441 def GetColWidths(*args, **kwargs):
12442 """
12443 GetColWidths(self) -> list
12444
12445 Returns a list of integers representing the widths of each of the
12446 columns in the sizer.
12447 """
12448 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12449
12450 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12451 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12452 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12453 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
12454 _core_.FlexGridSizer_swigregister(FlexGridSizer)
12455
12456 class StdDialogButtonSizer(BoxSizer):
12457 """
12458 A special sizer that knows how to order and position standard buttons
12459 in order to conform to the current platform's standards. You simply
12460 need to add each `wx.Button` to the sizer, and be sure to create the
12461 buttons using the standard ID's. Then call `Realize` and the sizer
12462 will take care of the rest.
12463
12464 """
12465 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12466 __repr__ = _swig_repr
12467 def __init__(self, *args, **kwargs):
12468 """__init__(self) -> StdDialogButtonSizer"""
12469 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
12470 def AddButton(*args, **kwargs):
12471 """
12472 AddButton(self, wxButton button)
12473
12474 Use this to add the buttons to this sizer. Do not use the `Add`
12475 method in the base class.
12476 """
12477 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12478
12479 def Realize(*args, **kwargs):
12480 """
12481 Realize(self)
12482
12483 This funciton needs to be called after all the buttons have been added
12484 to the sizer. It will reorder them and position them in a platform
12485 specifc manner.
12486 """
12487 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
12488
12489 def SetAffirmativeButton(*args, **kwargs):
12490 """SetAffirmativeButton(self, wxButton button)"""
12491 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12492
12493 def SetNegativeButton(*args, **kwargs):
12494 """SetNegativeButton(self, wxButton button)"""
12495 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12496
12497 def SetCancelButton(*args, **kwargs):
12498 """SetCancelButton(self, wxButton button)"""
12499 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
12500
12501 def GetAffirmativeButton(*args, **kwargs):
12502 """GetAffirmativeButton(self) -> wxButton"""
12503 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12504
12505 def GetApplyButton(*args, **kwargs):
12506 """GetApplyButton(self) -> wxButton"""
12507 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12508
12509 def GetNegativeButton(*args, **kwargs):
12510 """GetNegativeButton(self) -> wxButton"""
12511 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12512
12513 def GetCancelButton(*args, **kwargs):
12514 """GetCancelButton(self) -> wxButton"""
12515 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12516
12517 def GetHelpButton(*args, **kwargs):
12518 """GetHelpButton(self) -> wxButton"""
12519 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12520
12521 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12522 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12523 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12524 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12525 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
12526 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
12527
12528 #---------------------------------------------------------------------------
12529
12530 class GBPosition(object):
12531 """
12532 This class represents the position of an item in a virtual grid of
12533 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12534 typemaps that will automatically convert from a 2-element sequence of
12535 integers to a wx.GBPosition, so you can use the more pythonic
12536 representation of the position nearly transparently in Python code.
12537 """
12538 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12539 __repr__ = _swig_repr
12540 def __init__(self, *args, **kwargs):
12541 """
12542 __init__(self, int row=0, int col=0) -> GBPosition
12543
12544 This class represents the position of an item in a virtual grid of
12545 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12546 typemaps that will automatically convert from a 2-element sequence of
12547 integers to a wx.GBPosition, so you can use the more pythonic
12548 representation of the position nearly transparently in Python code.
12549 """
12550 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12551 __swig_destroy__ = _core_.delete_GBPosition
12552 __del__ = lambda self : None;
12553 def GetRow(*args, **kwargs):
12554 """GetRow(self) -> int"""
12555 return _core_.GBPosition_GetRow(*args, **kwargs)
12556
12557 def GetCol(*args, **kwargs):
12558 """GetCol(self) -> int"""
12559 return _core_.GBPosition_GetCol(*args, **kwargs)
12560
12561 def SetRow(*args, **kwargs):
12562 """SetRow(self, int row)"""
12563 return _core_.GBPosition_SetRow(*args, **kwargs)
12564
12565 def SetCol(*args, **kwargs):
12566 """SetCol(self, int col)"""
12567 return _core_.GBPosition_SetCol(*args, **kwargs)
12568
12569 def __eq__(*args, **kwargs):
12570 """
12571 __eq__(self, PyObject other) -> bool
12572
12573 Compare GBPosition for equality.
12574 """
12575 return _core_.GBPosition___eq__(*args, **kwargs)
12576
12577 def __ne__(*args, **kwargs):
12578 """
12579 __ne__(self, PyObject other) -> bool
12580
12581 Compare GBPosition for inequality.
12582 """
12583 return _core_.GBPosition___ne__(*args, **kwargs)
12584
12585 def Set(*args, **kwargs):
12586 """Set(self, int row=0, int col=0)"""
12587 return _core_.GBPosition_Set(*args, **kwargs)
12588
12589 def Get(*args, **kwargs):
12590 """Get(self) -> PyObject"""
12591 return _core_.GBPosition_Get(*args, **kwargs)
12592
12593 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12594 def __str__(self): return str(self.Get())
12595 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12596 def __len__(self): return len(self.Get())
12597 def __getitem__(self, index): return self.Get()[index]
12598 def __setitem__(self, index, val):
12599 if index == 0: self.SetRow(val)
12600 elif index == 1: self.SetCol(val)
12601 else: raise IndexError
12602 def __nonzero__(self): return self.Get() != (0,0)
12603 __safe_for_unpickling__ = True
12604 def __reduce__(self): return (wx.GBPosition, self.Get())
12605
12606 row = property(GetRow, SetRow)
12607 col = property(GetCol, SetCol)
12608
12609 _core_.GBPosition_swigregister(GBPosition)
12610
12611 class GBSpan(object):
12612 """
12613 This class is used to hold the row and column spanning attributes of
12614 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12615 automatically convert from a 2-element sequence of integers to a
12616 wx.GBSpan, so you can use the more pythonic representation of the span
12617 nearly transparently in Python code.
12618
12619 """
12620 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12621 __repr__ = _swig_repr
12622 def __init__(self, *args, **kwargs):
12623 """
12624 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12625
12626 Construct a new wxGBSpan, optionally setting the rowspan and
12627 colspan. The default is (1,1). (Meaning that the item occupies one
12628 cell in each direction.
12629 """
12630 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12631 __swig_destroy__ = _core_.delete_GBSpan
12632 __del__ = lambda self : None;
12633 def GetRowspan(*args, **kwargs):
12634 """GetRowspan(self) -> int"""
12635 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12636
12637 def GetColspan(*args, **kwargs):
12638 """GetColspan(self) -> int"""
12639 return _core_.GBSpan_GetColspan(*args, **kwargs)
12640
12641 def SetRowspan(*args, **kwargs):
12642 """SetRowspan(self, int rowspan)"""
12643 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12644
12645 def SetColspan(*args, **kwargs):
12646 """SetColspan(self, int colspan)"""
12647 return _core_.GBSpan_SetColspan(*args, **kwargs)
12648
12649 def __eq__(*args, **kwargs):
12650 """
12651 __eq__(self, PyObject other) -> bool
12652
12653 Compare wxGBSpan for equality.
12654 """
12655 return _core_.GBSpan___eq__(*args, **kwargs)
12656
12657 def __ne__(*args, **kwargs):
12658 """
12659 __ne__(self, PyObject other) -> bool
12660
12661 Compare GBSpan for inequality.
12662 """
12663 return _core_.GBSpan___ne__(*args, **kwargs)
12664
12665 def Set(*args, **kwargs):
12666 """Set(self, int rowspan=1, int colspan=1)"""
12667 return _core_.GBSpan_Set(*args, **kwargs)
12668
12669 def Get(*args, **kwargs):
12670 """Get(self) -> PyObject"""
12671 return _core_.GBSpan_Get(*args, **kwargs)
12672
12673 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12674 def __str__(self): return str(self.Get())
12675 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12676 def __len__(self): return len(self.Get())
12677 def __getitem__(self, index): return self.Get()[index]
12678 def __setitem__(self, index, val):
12679 if index == 0: self.SetRowspan(val)
12680 elif index == 1: self.SetColspan(val)
12681 else: raise IndexError
12682 def __nonzero__(self): return self.Get() != (0,0)
12683 __safe_for_unpickling__ = True
12684 def __reduce__(self): return (wx.GBSpan, self.Get())
12685
12686 rowspan = property(GetRowspan, SetRowspan)
12687 colspan = property(GetColspan, SetColspan)
12688
12689 _core_.GBSpan_swigregister(GBSpan)
12690
12691 class GBSizerItem(SizerItem):
12692 """
12693 The wx.GBSizerItem class is used to track the additional data about
12694 items in a `wx.GridBagSizer` such as the item's position in the grid
12695 and how many rows or columns it spans.
12696
12697 """
12698 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12699 __repr__ = _swig_repr
12700 def __init__(self, *args, **kwargs):
12701 """
12702 __init__(self) -> GBSizerItem
12703
12704 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12705 size will need to be set, as well as a position and span before this
12706 item can be used in a Sizer.
12707
12708 You will probably never need to create a wx.GBSizerItem directly as they
12709 are created automatically when the sizer's Add method is called.
12710 """
12711 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12712 __swig_destroy__ = _core_.delete_GBSizerItem
12713 __del__ = lambda self : None;
12714 def GetPos(*args, **kwargs):
12715 """
12716 GetPos(self) -> GBPosition
12717
12718 Get the grid position of the item
12719 """
12720 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12721
12722 def GetPosTuple(self): return self.GetPos().Get()
12723 def GetSpan(*args, **kwargs):
12724 """
12725 GetSpan(self) -> GBSpan
12726
12727 Get the row and column spanning of the item
12728 """
12729 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12730
12731 def GetSpanTuple(self): return self.GetSpan().Get()
12732 def SetPos(*args, **kwargs):
12733 """
12734 SetPos(self, GBPosition pos) -> bool
12735
12736 If the item is already a member of a sizer then first ensure that
12737 there is no other item that would intersect with this one at the new
12738 position, then set the new position. Returns True if the change is
12739 successful and after the next Layout() the item will be moved.
12740 """
12741 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12742
12743 def SetSpan(*args, **kwargs):
12744 """
12745 SetSpan(self, GBSpan span) -> bool
12746
12747 If the item is already a member of a sizer then first ensure that
12748 there is no other item that would intersect with this one with its new
12749 spanning size, then set the new spanning. Returns True if the change
12750 is successful and after the next Layout() the item will be resized.
12751
12752 """
12753 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12754
12755 def Intersects(*args, **kwargs):
12756 """
12757 Intersects(self, GBSizerItem other) -> bool
12758
12759 Returns True if this item and the other item instersect.
12760 """
12761 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12762
12763 def IntersectsPos(*args, **kwargs):
12764 """
12765 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12766
12767 Returns True if the given pos/span would intersect with this item.
12768 """
12769 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
12770
12771 def GetEndPos(*args, **kwargs):
12772 """
12773 GetEndPos(self) -> GBPosition
12774
12775 Get the row and column of the endpoint of this item.
12776 """
12777 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12778
12779 def GetGBSizer(*args, **kwargs):
12780 """
12781 GetGBSizer(self) -> GridBagSizer
12782
12783 Get the sizer this item is a member of.
12784 """
12785 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12786
12787 def SetGBSizer(*args, **kwargs):
12788 """
12789 SetGBSizer(self, GridBagSizer sizer)
12790
12791 Set the sizer this item is a member of.
12792 """
12793 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12794
12795 EndPos = property(GetEndPos,doc="See `GetEndPos`")
12796 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
12797 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
12798 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
12799 _core_.GBSizerItem_swigregister(GBSizerItem)
12800 DefaultSpan = cvar.DefaultSpan
12801
12802 def GBSizerItemWindow(*args, **kwargs):
12803 """
12804 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12805 int border, PyObject userData=None) -> GBSizerItem
12806
12807 Construct a `wx.GBSizerItem` for a window.
12808 """
12809 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12810 return val
12811
12812 def GBSizerItemSizer(*args, **kwargs):
12813 """
12814 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12815 int border, PyObject userData=None) -> GBSizerItem
12816
12817 Construct a `wx.GBSizerItem` for a sizer
12818 """
12819 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12820 return val
12821
12822 def GBSizerItemSpacer(*args, **kwargs):
12823 """
12824 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12825 int flag, int border, PyObject userData=None) -> GBSizerItem
12826
12827 Construct a `wx.GBSizerItem` for a spacer.
12828 """
12829 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12830 return val
12831
12832 class GridBagSizer(FlexGridSizer):
12833 """
12834 A `wx.Sizer` that can lay out items in a virtual grid like a
12835 `wx.FlexGridSizer` but in this case explicit positioning of the items
12836 is allowed using `wx.GBPosition`, and items can optionally span more
12837 than one row and/or column using `wx.GBSpan`. The total size of the
12838 virtual grid is determined by the largest row and column that items are
12839 positioned at, adjusted for spanning.
12840
12841 """
12842 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12843 __repr__ = _swig_repr
12844 def __init__(self, *args, **kwargs):
12845 """
12846 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12847
12848 Constructor, with optional parameters to specify the gap between the
12849 rows and columns.
12850 """
12851 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
12852 self._setOORInfo(self)
12853
12854 def Add(*args, **kwargs):
12855 """
12856 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12857 int border=0, userData=None) -> wx.GBSizerItem
12858
12859 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12860 more than one row or column as specified with *span*. The remaining
12861 args behave similarly to `wx.Sizer.Add`.
12862
12863 Returns True if the item was successfully placed at the given cell
12864 position, False if something was already there.
12865
12866 """
12867 return _core_.GridBagSizer_Add(*args, **kwargs)
12868
12869 def AddItem(*args, **kwargs):
12870 """
12871 Add(self, GBSizerItem item) -> wx.GBSizerItem
12872
12873 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12874 the item was successfully placed at its given cell position, False if
12875 something was already there.
12876 """
12877 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12878
12879 def GetCellSize(*args, **kwargs):
12880 """
12881 GetCellSize(self, int row, int col) -> Size
12882
12883 Get the size of the specified cell, including hgap and
12884 vgap. Only valid after a Layout.
12885 """
12886 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12887
12888 def GetEmptyCellSize(*args, **kwargs):
12889 """
12890 GetEmptyCellSize(self) -> Size
12891
12892 Get the size used for cells in the grid with no item.
12893 """
12894 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12895
12896 def SetEmptyCellSize(*args, **kwargs):
12897 """
12898 SetEmptyCellSize(self, Size sz)
12899
12900 Set the size used for cells in the grid with no item.
12901 """
12902 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12903
12904 def GetItemPosition(*args):
12905 """
12906 GetItemPosition(self, item) -> GBPosition
12907
12908 Get the grid position of the specified *item* where *item* is either a
12909 window or subsizer that is a member of this sizer, or a zero-based
12910 index of an item.
12911 """
12912 return _core_.GridBagSizer_GetItemPosition(*args)
12913
12914 def SetItemPosition(*args):
12915 """
12916 SetItemPosition(self, item, GBPosition pos) -> bool
12917
12918 Set the grid position of the specified *item* where *item* is either a
12919 window or subsizer that is a member of this sizer, or a zero-based
12920 index of an item. Returns True on success. If the move is not
12921 allowed (because an item is already there) then False is returned.
12922
12923 """
12924 return _core_.GridBagSizer_SetItemPosition(*args)
12925
12926 def GetItemSpan(*args):
12927 """
12928 GetItemSpan(self, item) -> GBSpan
12929
12930 Get the row/col spanning of the specified *item* where *item* is
12931 either a window or subsizer that is a member of this sizer, or a
12932 zero-based index of an item.
12933 """
12934 return _core_.GridBagSizer_GetItemSpan(*args)
12935
12936 def SetItemSpan(*args):
12937 """
12938 SetItemSpan(self, item, GBSpan span) -> bool
12939
12940 Set the row/col spanning of the specified *item* where *item* is
12941 either a window or subsizer that is a member of this sizer, or a
12942 zero-based index of an item. Returns True on success. If the move is
12943 not allowed (because an item is already there) then False is returned.
12944 """
12945 return _core_.GridBagSizer_SetItemSpan(*args)
12946
12947 def FindItem(*args):
12948 """
12949 FindItem(self, item) -> GBSizerItem
12950
12951 Find the sizer item for the given window or subsizer, returns None if
12952 not found. (non-recursive)
12953 """
12954 return _core_.GridBagSizer_FindItem(*args)
12955
12956 def FindItemAtPosition(*args, **kwargs):
12957 """
12958 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12959
12960 Return the sizer item for the given grid cell, or None if there is no
12961 item at that position. (non-recursive)
12962 """
12963 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
12964
12965 def FindItemAtPoint(*args, **kwargs):
12966 """
12967 FindItemAtPoint(self, Point pt) -> GBSizerItem
12968
12969 Return the sizer item located at the point given in *pt*, or None if
12970 there is no item at that point. The (x,y) coordinates in pt correspond
12971 to the client coordinates of the window using the sizer for
12972 layout. (non-recursive)
12973 """
12974 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
12975
12976 def CheckForIntersection(*args, **kwargs):
12977 """
12978 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
12979
12980 Look at all items and see if any intersect (or would overlap) the
12981 given *item*. Returns True if so, False if there would be no overlap.
12982 If an *excludeItem* is given then it will not be checked for
12983 intersection, for example it may be the item we are checking the
12984 position of.
12985
12986 """
12987 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
12988
12989 def CheckForIntersectionPos(*args, **kwargs):
12990 """
12991 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
12992
12993 Look at all items and see if any intersect (or would overlap) the
12994 given position and span. Returns True if so, False if there would be
12995 no overlap. If an *excludeItem* is given then it will not be checked
12996 for intersection, for example it may be the item we are checking the
12997 position of.
12998 """
12999 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13000
13001 _core_.GridBagSizer_swigregister(GridBagSizer)
13002
13003 #---------------------------------------------------------------------------
13004
13005 Left = _core_.Left
13006 Top = _core_.Top
13007 Right = _core_.Right
13008 Bottom = _core_.Bottom
13009 Width = _core_.Width
13010 Height = _core_.Height
13011 Centre = _core_.Centre
13012 Center = _core_.Center
13013 CentreX = _core_.CentreX
13014 CentreY = _core_.CentreY
13015 Unconstrained = _core_.Unconstrained
13016 AsIs = _core_.AsIs
13017 PercentOf = _core_.PercentOf
13018 Above = _core_.Above
13019 Below = _core_.Below
13020 LeftOf = _core_.LeftOf
13021 RightOf = _core_.RightOf
13022 SameAs = _core_.SameAs
13023 Absolute = _core_.Absolute
13024 class IndividualLayoutConstraint(Object):
13025 """
13026 Objects of this class are stored in the `wx.LayoutConstraints` class as
13027 one of eight possible constraints that a window can be involved in.
13028 You will never need to create an instance of
13029 wx.IndividualLayoutConstraint, rather you should create a
13030 `wx.LayoutConstraints` instance and use the individual contstraints
13031 that it contains.
13032 """
13033 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13034 def __init__(self): raise AttributeError, "No constructor defined"
13035 __repr__ = _swig_repr
13036 def Set(*args, **kwargs):
13037 """
13038 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13039
13040 Sets the properties of the constraint. Normally called by one of the
13041 convenience functions such as Above, RightOf, SameAs.
13042 """
13043 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13044
13045 def LeftOf(*args, **kwargs):
13046 """
13047 LeftOf(self, Window sibling, int marg=0)
13048
13049 Constrains this edge to be to the left of the given window, with an
13050 optional margin. Implicitly, this is relative to the left edge of the
13051 other window.
13052 """
13053 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13054
13055 def RightOf(*args, **kwargs):
13056 """
13057 RightOf(self, Window sibling, int marg=0)
13058
13059 Constrains this edge to be to the right of the given window, with an
13060 optional margin. Implicitly, this is relative to the right edge of the
13061 other window.
13062 """
13063 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13064
13065 def Above(*args, **kwargs):
13066 """
13067 Above(self, Window sibling, int marg=0)
13068
13069 Constrains this edge to be above the given window, with an optional
13070 margin. Implicitly, this is relative to the top edge of the other
13071 window.
13072 """
13073 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13074
13075 def Below(*args, **kwargs):
13076 """
13077 Below(self, Window sibling, int marg=0)
13078
13079 Constrains this edge to be below the given window, with an optional
13080 margin. Implicitly, this is relative to the bottom edge of the other
13081 window.
13082 """
13083 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13084
13085 def SameAs(*args, **kwargs):
13086 """
13087 SameAs(self, Window otherW, int edge, int marg=0)
13088
13089 Constrains this edge or dimension to be to the same as the edge of the
13090 given window, with an optional margin.
13091 """
13092 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13093
13094 def PercentOf(*args, **kwargs):
13095 """
13096 PercentOf(self, Window otherW, int wh, int per)
13097
13098 Constrains this edge or dimension to be to a percentage of the given
13099 window, with an optional margin.
13100 """
13101 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13102
13103 def Absolute(*args, **kwargs):
13104 """
13105 Absolute(self, int val)
13106
13107 Constrains this edge or dimension to be the given absolute value.
13108 """
13109 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13110
13111 def Unconstrained(*args, **kwargs):
13112 """
13113 Unconstrained(self)
13114
13115 Sets this edge or dimension to be unconstrained, that is, dependent on
13116 other edges and dimensions from which this value can be deduced.
13117 """
13118 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13119
13120 def AsIs(*args, **kwargs):
13121 """
13122 AsIs(self)
13123
13124 Sets this edge or constraint to be whatever the window's value is at
13125 the moment. If either of the width and height constraints are *as is*,
13126 the window will not be resized, but moved instead. This is important
13127 when considering panel items which are intended to have a default
13128 size, such as a button, which may take its size from the size of the
13129 button label.
13130 """
13131 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13132
13133 def GetOtherWindow(*args, **kwargs):
13134 """GetOtherWindow(self) -> Window"""
13135 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13136
13137 def GetMyEdge(*args, **kwargs):
13138 """GetMyEdge(self) -> int"""
13139 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13140
13141 def SetEdge(*args, **kwargs):
13142 """SetEdge(self, int which)"""
13143 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13144
13145 def SetValue(*args, **kwargs):
13146 """SetValue(self, int v)"""
13147 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13148
13149 def GetMargin(*args, **kwargs):
13150 """GetMargin(self) -> int"""
13151 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13152
13153 def SetMargin(*args, **kwargs):
13154 """SetMargin(self, int m)"""
13155 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13156
13157 def GetValue(*args, **kwargs):
13158 """GetValue(self) -> int"""
13159 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13160
13161 def GetPercent(*args, **kwargs):
13162 """GetPercent(self) -> int"""
13163 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13164
13165 def GetOtherEdge(*args, **kwargs):
13166 """GetOtherEdge(self) -> int"""
13167 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13168
13169 def GetDone(*args, **kwargs):
13170 """GetDone(self) -> bool"""
13171 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13172
13173 def SetDone(*args, **kwargs):
13174 """SetDone(self, bool d)"""
13175 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13176
13177 def GetRelationship(*args, **kwargs):
13178 """GetRelationship(self) -> int"""
13179 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13180
13181 def SetRelationship(*args, **kwargs):
13182 """SetRelationship(self, int r)"""
13183 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13184
13185 def ResetIfWin(*args, **kwargs):
13186 """
13187 ResetIfWin(self, Window otherW) -> bool
13188
13189 Reset constraint if it mentions otherWin
13190 """
13191 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13192
13193 def SatisfyConstraint(*args, **kwargs):
13194 """
13195 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13196
13197 Try to satisfy constraint
13198 """
13199 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13200
13201 def GetEdge(*args, **kwargs):
13202 """
13203 GetEdge(self, int which, Window thisWin, Window other) -> int
13204
13205 Get the value of this edge or dimension, or if this
13206 is not determinable, -1.
13207 """
13208 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13209
13210 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13211 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13212 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13213 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13214 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13215 Percent = property(GetPercent,doc="See `GetPercent`")
13216 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13217 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
13218 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
13219
13220 class LayoutConstraints(Object):
13221 """
13222 **Note:** constraints are now deprecated and you should use sizers
13223 instead.
13224
13225 Objects of this class can be associated with a window to define its
13226 layout constraints, with respect to siblings or its parent.
13227
13228 The class consists of the following eight constraints of class
13229 wx.IndividualLayoutConstraint, some or all of which should be accessed
13230 directly to set the appropriate constraints.
13231
13232 * left: represents the left hand edge of the window
13233 * right: represents the right hand edge of the window
13234 * top: represents the top edge of the window
13235 * bottom: represents the bottom edge of the window
13236 * width: represents the width of the window
13237 * height: represents the height of the window
13238 * centreX: represents the horizontal centre point of the window
13239 * centreY: represents the vertical centre point of the window
13240
13241 Most constraints are initially set to have the relationship
13242 wxUnconstrained, which means that their values should be calculated by
13243 looking at known constraints. The exceptions are width and height,
13244 which are set to wxAsIs to ensure that if the user does not specify a
13245 constraint, the existing width and height will be used, to be
13246 compatible with panel items which often have take a default size. If
13247 the constraint is ``wx.AsIs``, the dimension will not be changed.
13248
13249 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13250
13251 """
13252 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13253 __repr__ = _swig_repr
13254 left = property(_core_.LayoutConstraints_left_get)
13255 top = property(_core_.LayoutConstraints_top_get)
13256 right = property(_core_.LayoutConstraints_right_get)
13257 bottom = property(_core_.LayoutConstraints_bottom_get)
13258 width = property(_core_.LayoutConstraints_width_get)
13259 height = property(_core_.LayoutConstraints_height_get)
13260 centreX = property(_core_.LayoutConstraints_centreX_get)
13261 centreY = property(_core_.LayoutConstraints_centreY_get)
13262 def __init__(self, *args, **kwargs):
13263 """__init__(self) -> LayoutConstraints"""
13264 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13265 __swig_destroy__ = _core_.delete_LayoutConstraints
13266 __del__ = lambda self : None;
13267 def SatisfyConstraints(*args, **kwargs):
13268 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13269 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13270
13271 def AreSatisfied(*args, **kwargs):
13272 """AreSatisfied(self) -> bool"""
13273 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13274
13275 _core_.LayoutConstraints_swigregister(LayoutConstraints)
13276
13277 #----------------------------------------------------------------------------
13278
13279 # Use Python's bool constants if available, make some if not
13280 try:
13281 True
13282 except NameError:
13283 __builtins__.True = 1==1
13284 __builtins__.False = 1==0
13285 def bool(value): return not not value
13286 __builtins__.bool = bool
13287
13288
13289
13290 # workarounds for bad wxRTTI names
13291 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13292 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13293 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13294
13295
13296 #----------------------------------------------------------------------------
13297 # Load version numbers from __version__... Ensure that major and minor
13298 # versions are the same for both wxPython and wxWidgets.
13299
13300 from __version__ import *
13301 __version__ = VERSION_STRING
13302
13303 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13304 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
13305 if RELEASE_VERSION != _core_.RELEASE_VERSION:
13306 import warnings
13307 warnings.warn("wxPython/wxWidgets release number mismatch")
13308
13309 #----------------------------------------------------------------------------
13310
13311 # Set wxPython's default string<-->unicode conversion encoding from
13312 # the locale, but only if Python's default hasn't been changed. (We
13313 # assume that if the user has customized it already then that is the
13314 # encoding we need to use as well.)
13315 #
13316 # The encoding selected here is used when string or unicode objects
13317 # need to be converted in order to pass them to wxWidgets. Please be
13318 # aware that the default encoding within the same locale may be
13319 # slightly different on different platforms. For example, please see
13320 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13321 # between the common latin/roman encodings.
13322
13323 default = _sys.getdefaultencoding()
13324 if default == 'ascii':
13325 import locale
13326 import codecs
13327 try:
13328 default = locale.getdefaultlocale()[1]
13329 codecs.lookup(default)
13330 except (ValueError, LookupError, TypeError):
13331 default = _sys.getdefaultencoding()
13332 del locale
13333 del codecs
13334 if default:
13335 wx.SetDefaultPyEncoding(default)
13336 del default
13337
13338 #----------------------------------------------------------------------------
13339
13340 class PyDeadObjectError(AttributeError):
13341 pass
13342
13343 class _wxPyDeadObject(object):
13344 """
13345 Instances of wx objects that are OOR capable will have their __class__
13346 changed to this class when the C++ object is deleted. This should help
13347 prevent crashes due to referencing a bogus C++ pointer.
13348 """
13349 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13350 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13351
13352 def __repr__(self):
13353 if not hasattr(self, "_name"):
13354 self._name = "[unknown]"
13355 return self.reprStr % self._name
13356
13357 def __getattr__(self, *args):
13358 if not hasattr(self, "_name"):
13359 self._name = "[unknown]"
13360 raise PyDeadObjectError(self.attrStr % self._name)
13361
13362 def __nonzero__(self):
13363 return 0
13364
13365
13366
13367 class PyUnbornObjectError(AttributeError):
13368 pass
13369
13370 class _wxPyUnbornObject(object):
13371 """
13372 Some stock objects are created when the wx._core module is
13373 imported, but their C++ instance is not created until the wx.App
13374 object is created and initialized. These object instances will
13375 temporarily have their __class__ changed to this class so an
13376 exception will be raised if they are used before the C++ instance
13377 is ready.
13378 """
13379
13380 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13381 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13382
13383 def __repr__(self):
13384 #if not hasattr(self, "_name"):
13385 # self._name = "[unknown]"
13386 return self.reprStr #% self._name
13387
13388 def __getattr__(self, *args):
13389 #if not hasattr(self, "_name"):
13390 # self._name = "[unknown]"
13391 raise PyUnbornObjectError(self.attrStr) # % self._name )
13392
13393 def __nonzero__(self):
13394 return 0
13395
13396
13397 #----------------------------------------------------------------------------
13398
13399 def CallAfter(callable, *args, **kw):
13400 """
13401 Call the specified function after the current and pending event
13402 handlers have been completed. This is also good for making GUI
13403 method calls from non-GUI threads. Any extra positional or
13404 keyword args are passed on to the callable when it is called.
13405
13406 :see: `wx.FutureCall`
13407 """
13408 app = wx.GetApp()
13409 assert app is not None, 'No wx.App created yet'
13410
13411 if not hasattr(app, "_CallAfterId"):
13412 app._CallAfterId = wx.NewEventType()
13413 app.Connect(-1, -1, app._CallAfterId,
13414 lambda event: event.callable(*event.args, **event.kw) )
13415 evt = wx.PyEvent()
13416 evt.SetEventType(app._CallAfterId)
13417 evt.callable = callable
13418 evt.args = args
13419 evt.kw = kw
13420 wx.PostEvent(app, evt)
13421
13422 #----------------------------------------------------------------------------
13423
13424
13425 class FutureCall:
13426 """
13427 A convenience class for `wx.Timer`, that calls the given callable
13428 object once after the given amount of milliseconds, passing any
13429 positional or keyword args. The return value of the callable is
13430 availbale after it has been run with the `GetResult` method.
13431
13432 If you don't need to get the return value or restart the timer
13433 then there is no need to hold a reference to this object. It will
13434 hold a reference to itself while the timer is running (the timer
13435 has a reference to self.Notify) but the cycle will be broken when
13436 the timer completes, automatically cleaning up the wx.FutureCall
13437 object.
13438
13439 :see: `wx.CallAfter`
13440 """
13441 def __init__(self, millis, callable, *args, **kwargs):
13442 self.millis = millis
13443 self.callable = callable
13444 self.SetArgs(*args, **kwargs)
13445 self.runCount = 0
13446 self.running = False
13447 self.hasRun = False
13448 self.result = None
13449 self.timer = None
13450 self.Start()
13451
13452 def __del__(self):
13453 self.Stop()
13454
13455
13456 def Start(self, millis=None, *args, **kwargs):
13457 """
13458 (Re)start the timer
13459 """
13460 self.hasRun = False
13461 if millis is not None:
13462 self.millis = millis
13463 if args or kwargs:
13464 self.SetArgs(*args, **kwargs)
13465 self.Stop()
13466 self.timer = wx.PyTimer(self.Notify)
13467 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13468 self.running = True
13469 Restart = Start
13470
13471
13472 def Stop(self):
13473 """
13474 Stop and destroy the timer.
13475 """
13476 if self.timer is not None:
13477 self.timer.Stop()
13478 self.timer = None
13479
13480
13481 def GetInterval(self):
13482 if self.timer is not None:
13483 return self.timer.GetInterval()
13484 else:
13485 return 0
13486
13487
13488 def IsRunning(self):
13489 return self.timer is not None and self.timer.IsRunning()
13490
13491
13492 def SetArgs(self, *args, **kwargs):
13493 """
13494 (Re)set the args passed to the callable object. This is
13495 useful in conjunction with Restart if you want to schedule a
13496 new call to the same callable object but with different
13497 parameters.
13498 """
13499 self.args = args
13500 self.kwargs = kwargs
13501
13502
13503 def HasRun(self):
13504 return self.hasRun
13505
13506 def GetResult(self):
13507 return self.result
13508
13509 def Notify(self):
13510 """
13511 The timer has expired so call the callable.
13512 """
13513 if self.callable and getattr(self.callable, 'im_self', True):
13514 self.runCount += 1
13515 self.running = False
13516 self.result = self.callable(*self.args, **self.kwargs)
13517 self.hasRun = True
13518 if not self.running:
13519 # if it wasn't restarted, then cleanup
13520 wx.CallAfter(self.Stop)
13521
13522 Interval = property(GetInterval)
13523 Result = property(GetResult)
13524
13525
13526 #----------------------------------------------------------------------------
13527 # Control which items in this module should be documented by epydoc.
13528 # We allow only classes and functions, which will help reduce the size
13529 # of the docs by filtering out the zillions of constants, EVT objects,
13530 # and etc that don't make much sense by themselves, but are instead
13531 # documented (or will be) as part of the classes/functions/methods
13532 # where they should be used.
13533
13534 class __DocFilter:
13535 """
13536 A filter for epydoc that only allows non-Ptr classes and
13537 functions, in order to reduce the clutter in the API docs.
13538 """
13539 def __init__(self, globals):
13540 self._globals = globals
13541
13542 def __call__(self, name):
13543 import types
13544 obj = self._globals.get(name, None)
13545
13546 # only document classes and function
13547 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13548 return False
13549
13550 # skip other things that are private or will be documented as part of somethign else
13551 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
13552 return False
13553
13554 # skip functions that are duplicates of static functions in a class
13555 if name.find('_') != -1:
13556 cls = self._globals.get(name.split('_')[0], None)
13557 methname = name.split('_')[1]
13558 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13559 return False
13560
13561 return True
13562
13563 #----------------------------------------------------------------------------
13564 #----------------------------------------------------------------------------
13565
13566 # Import other modules in this package that should show up in the
13567 # "core" wx namespace
13568 from _gdi import *
13569 from _windows import *
13570 from _controls import *
13571 from _misc import *
13572
13573 #----------------------------------------------------------------------------
13574 #----------------------------------------------------------------------------
13575
13576
13577