]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/gtk/_core.py
a941f30e6bef5987973ef828987796ff68331685
[wxWidgets.git] / wxPython / src / gtk / _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 IncBy(*args, **kwargs):
845 """IncBy(self, int dx, int dy)"""
846 return _core_.Size_IncBy(*args, **kwargs)
847
848 def DecBy(*args, **kwargs):
849 """DecBy(self, int dx, int dy)"""
850 return _core_.Size_DecBy(*args, **kwargs)
851
852 def Scale(*args, **kwargs):
853 """
854 Scale(self, float xscale, float yscale)
855
856 Scales the dimensions of this object by the given factors.
857 """
858 return _core_.Size_Scale(*args, **kwargs)
859
860 def Set(*args, **kwargs):
861 """
862 Set(self, int w, int h)
863
864 Set both width and height.
865 """
866 return _core_.Size_Set(*args, **kwargs)
867
868 def SetWidth(*args, **kwargs):
869 """SetWidth(self, int w)"""
870 return _core_.Size_SetWidth(*args, **kwargs)
871
872 def SetHeight(*args, **kwargs):
873 """SetHeight(self, int h)"""
874 return _core_.Size_SetHeight(*args, **kwargs)
875
876 def GetWidth(*args, **kwargs):
877 """GetWidth(self) -> int"""
878 return _core_.Size_GetWidth(*args, **kwargs)
879
880 def GetHeight(*args, **kwargs):
881 """GetHeight(self) -> int"""
882 return _core_.Size_GetHeight(*args, **kwargs)
883
884 def IsFullySpecified(*args, **kwargs):
885 """
886 IsFullySpecified(self) -> bool
887
888 Returns True if both components of the size are non-default values.
889 """
890 return _core_.Size_IsFullySpecified(*args, **kwargs)
891
892 def SetDefaults(*args, **kwargs):
893 """
894 SetDefaults(self, Size size)
895
896 Combine this size with the other one replacing the default components
897 of this object (i.e. equal to -1) with those of the other.
898 """
899 return _core_.Size_SetDefaults(*args, **kwargs)
900
901 def Get(*args, **kwargs):
902 """
903 Get() -> (width,height)
904
905 Returns the width and height properties as a tuple.
906 """
907 return _core_.Size_Get(*args, **kwargs)
908
909 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
910 def __str__(self): return str(self.Get())
911 def __repr__(self): return 'wx.Size'+str(self.Get())
912 def __len__(self): return len(self.Get())
913 def __getitem__(self, index): return self.Get()[index]
914 def __setitem__(self, index, val):
915 if index == 0: self.width = val
916 elif index == 1: self.height = val
917 else: raise IndexError
918 def __nonzero__(self): return self.Get() != (0,0)
919 __safe_for_unpickling__ = True
920 def __reduce__(self): return (wx.Size, self.Get())
921
922 _core_.Size_swigregister(Size)
923
924 #---------------------------------------------------------------------------
925
926 class RealPoint(object):
927 """
928 A data structure for representing a point or position with floating
929 point x and y properties. In wxPython most places that expect a
930 wx.RealPoint can also accept a (x,y) tuple.
931 """
932 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
933 __repr__ = _swig_repr
934 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
935 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
936 def __init__(self, *args, **kwargs):
937 """
938 __init__(self, double x=0.0, double y=0.0) -> RealPoint
939
940 Create a wx.RealPoint object
941 """
942 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
943 __swig_destroy__ = _core_.delete_RealPoint
944 __del__ = lambda self : None;
945 def __eq__(*args, **kwargs):
946 """
947 __eq__(self, PyObject other) -> bool
948
949 Test for equality of wx.RealPoint objects.
950 """
951 return _core_.RealPoint___eq__(*args, **kwargs)
952
953 def __ne__(*args, **kwargs):
954 """
955 __ne__(self, PyObject other) -> bool
956
957 Test for inequality of wx.RealPoint objects.
958 """
959 return _core_.RealPoint___ne__(*args, **kwargs)
960
961 def __add__(*args, **kwargs):
962 """
963 __add__(self, RealPoint pt) -> RealPoint
964
965 Add pt's proprties to this and return the result.
966 """
967 return _core_.RealPoint___add__(*args, **kwargs)
968
969 def __sub__(*args, **kwargs):
970 """
971 __sub__(self, RealPoint pt) -> RealPoint
972
973 Subtract pt's proprties from this and return the result
974 """
975 return _core_.RealPoint___sub__(*args, **kwargs)
976
977 def Set(*args, **kwargs):
978 """
979 Set(self, double x, double y)
980
981 Set both the x and y properties
982 """
983 return _core_.RealPoint_Set(*args, **kwargs)
984
985 def Get(*args, **kwargs):
986 """
987 Get() -> (x,y)
988
989 Return the x and y properties as a tuple.
990 """
991 return _core_.RealPoint_Get(*args, **kwargs)
992
993 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
994 def __str__(self): return str(self.Get())
995 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
996 def __len__(self): return len(self.Get())
997 def __getitem__(self, index): return self.Get()[index]
998 def __setitem__(self, index, val):
999 if index == 0: self.x = val
1000 elif index == 1: self.y = val
1001 else: raise IndexError
1002 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1003 __safe_for_unpickling__ = True
1004 def __reduce__(self): return (wx.RealPoint, self.Get())
1005
1006 _core_.RealPoint_swigregister(RealPoint)
1007
1008 #---------------------------------------------------------------------------
1009
1010 class Point(object):
1011 """
1012 A data structure for representing a point or position with integer x
1013 and y properties. Most places in wxPython that expect a wx.Point can
1014 also accept a (x,y) tuple.
1015 """
1016 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1017 __repr__ = _swig_repr
1018 x = property(_core_.Point_x_get, _core_.Point_x_set)
1019 y = property(_core_.Point_y_get, _core_.Point_y_set)
1020 def __init__(self, *args, **kwargs):
1021 """
1022 __init__(self, int x=0, int y=0) -> Point
1023
1024 Create a wx.Point object
1025 """
1026 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1027 __swig_destroy__ = _core_.delete_Point
1028 __del__ = lambda self : None;
1029 def __eq__(*args, **kwargs):
1030 """
1031 __eq__(self, PyObject other) -> bool
1032
1033 Test for equality of wx.Point objects.
1034 """
1035 return _core_.Point___eq__(*args, **kwargs)
1036
1037 def __ne__(*args, **kwargs):
1038 """
1039 __ne__(self, PyObject other) -> bool
1040
1041 Test for inequality of wx.Point objects.
1042 """
1043 return _core_.Point___ne__(*args, **kwargs)
1044
1045 def __add__(*args, **kwargs):
1046 """
1047 __add__(self, Point pt) -> Point
1048
1049 Add pt's proprties to this and return the result.
1050 """
1051 return _core_.Point___add__(*args, **kwargs)
1052
1053 def __sub__(*args, **kwargs):
1054 """
1055 __sub__(self, Point pt) -> Point
1056
1057 Subtract pt's proprties from this and return the result
1058 """
1059 return _core_.Point___sub__(*args, **kwargs)
1060
1061 def __iadd__(*args, **kwargs):
1062 """
1063 __iadd__(self, Point pt) -> Point
1064
1065 Add pt to this object.
1066 """
1067 return _core_.Point___iadd__(*args, **kwargs)
1068
1069 def __isub__(*args, **kwargs):
1070 """
1071 __isub__(self, Point pt) -> Point
1072
1073 Subtract pt from this object.
1074 """
1075 return _core_.Point___isub__(*args, **kwargs)
1076
1077 def Set(*args, **kwargs):
1078 """
1079 Set(self, long x, long y)
1080
1081 Set both the x and y properties
1082 """
1083 return _core_.Point_Set(*args, **kwargs)
1084
1085 def Get(*args, **kwargs):
1086 """
1087 Get() -> (x,y)
1088
1089 Return the x and y properties as a tuple.
1090 """
1091 return _core_.Point_Get(*args, **kwargs)
1092
1093 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1094 def __str__(self): return str(self.Get())
1095 def __repr__(self): return 'wx.Point'+str(self.Get())
1096 def __len__(self): return len(self.Get())
1097 def __getitem__(self, index): return self.Get()[index]
1098 def __setitem__(self, index, val):
1099 if index == 0: self.x = val
1100 elif index == 1: self.y = val
1101 else: raise IndexError
1102 def __nonzero__(self): return self.Get() != (0,0)
1103 __safe_for_unpickling__ = True
1104 def __reduce__(self): return (wx.Point, self.Get())
1105
1106 _core_.Point_swigregister(Point)
1107
1108 #---------------------------------------------------------------------------
1109
1110 class Rect(object):
1111 """
1112 A class for representing and manipulating rectangles. It has x, y,
1113 width and height properties. In wxPython most palces that expect a
1114 wx.Rect can also accept a (x,y,width,height) tuple.
1115 """
1116 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1117 __repr__ = _swig_repr
1118 def __init__(self, *args, **kwargs):
1119 """
1120 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1121
1122 Create a new Rect object.
1123 """
1124 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1125 __swig_destroy__ = _core_.delete_Rect
1126 __del__ = lambda self : None;
1127 def GetX(*args, **kwargs):
1128 """GetX(self) -> int"""
1129 return _core_.Rect_GetX(*args, **kwargs)
1130
1131 def SetX(*args, **kwargs):
1132 """SetX(self, int x)"""
1133 return _core_.Rect_SetX(*args, **kwargs)
1134
1135 def GetY(*args, **kwargs):
1136 """GetY(self) -> int"""
1137 return _core_.Rect_GetY(*args, **kwargs)
1138
1139 def SetY(*args, **kwargs):
1140 """SetY(self, int y)"""
1141 return _core_.Rect_SetY(*args, **kwargs)
1142
1143 def GetWidth(*args, **kwargs):
1144 """GetWidth(self) -> int"""
1145 return _core_.Rect_GetWidth(*args, **kwargs)
1146
1147 def SetWidth(*args, **kwargs):
1148 """SetWidth(self, int w)"""
1149 return _core_.Rect_SetWidth(*args, **kwargs)
1150
1151 def GetHeight(*args, **kwargs):
1152 """GetHeight(self) -> int"""
1153 return _core_.Rect_GetHeight(*args, **kwargs)
1154
1155 def SetHeight(*args, **kwargs):
1156 """SetHeight(self, int h)"""
1157 return _core_.Rect_SetHeight(*args, **kwargs)
1158
1159 def GetPosition(*args, **kwargs):
1160 """GetPosition(self) -> Point"""
1161 return _core_.Rect_GetPosition(*args, **kwargs)
1162
1163 def SetPosition(*args, **kwargs):
1164 """SetPosition(self, Point p)"""
1165 return _core_.Rect_SetPosition(*args, **kwargs)
1166
1167 def GetSize(*args, **kwargs):
1168 """GetSize(self) -> Size"""
1169 return _core_.Rect_GetSize(*args, **kwargs)
1170
1171 def SetSize(*args, **kwargs):
1172 """SetSize(self, Size s)"""
1173 return _core_.Rect_SetSize(*args, **kwargs)
1174
1175 def IsEmpty(*args, **kwargs):
1176 """IsEmpty(self) -> bool"""
1177 return _core_.Rect_IsEmpty(*args, **kwargs)
1178
1179 def GetTopLeft(*args, **kwargs):
1180 """GetTopLeft(self) -> Point"""
1181 return _core_.Rect_GetTopLeft(*args, **kwargs)
1182
1183 def SetTopLeft(*args, **kwargs):
1184 """SetTopLeft(self, Point p)"""
1185 return _core_.Rect_SetTopLeft(*args, **kwargs)
1186
1187 def GetBottomRight(*args, **kwargs):
1188 """GetBottomRight(self) -> Point"""
1189 return _core_.Rect_GetBottomRight(*args, **kwargs)
1190
1191 def SetBottomRight(*args, **kwargs):
1192 """SetBottomRight(self, Point p)"""
1193 return _core_.Rect_SetBottomRight(*args, **kwargs)
1194
1195 def GetTopRight(*args, **kwargs):
1196 """GetTopRight(self) -> Point"""
1197 return _core_.Rect_GetTopRight(*args, **kwargs)
1198
1199 def SetTopRight(*args, **kwargs):
1200 """SetTopRight(self, Point p)"""
1201 return _core_.Rect_SetTopRight(*args, **kwargs)
1202
1203 def GetBottomLeft(*args, **kwargs):
1204 """GetBottomLeft(self) -> Point"""
1205 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1206
1207 def SetBottomLeft(*args, **kwargs):
1208 """SetBottomLeft(self, Point p)"""
1209 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1210
1211 def GetLeft(*args, **kwargs):
1212 """GetLeft(self) -> int"""
1213 return _core_.Rect_GetLeft(*args, **kwargs)
1214
1215 def GetTop(*args, **kwargs):
1216 """GetTop(self) -> int"""
1217 return _core_.Rect_GetTop(*args, **kwargs)
1218
1219 def GetBottom(*args, **kwargs):
1220 """GetBottom(self) -> int"""
1221 return _core_.Rect_GetBottom(*args, **kwargs)
1222
1223 def GetRight(*args, **kwargs):
1224 """GetRight(self) -> int"""
1225 return _core_.Rect_GetRight(*args, **kwargs)
1226
1227 def SetLeft(*args, **kwargs):
1228 """SetLeft(self, int left)"""
1229 return _core_.Rect_SetLeft(*args, **kwargs)
1230
1231 def SetRight(*args, **kwargs):
1232 """SetRight(self, int right)"""
1233 return _core_.Rect_SetRight(*args, **kwargs)
1234
1235 def SetTop(*args, **kwargs):
1236 """SetTop(self, int top)"""
1237 return _core_.Rect_SetTop(*args, **kwargs)
1238
1239 def SetBottom(*args, **kwargs):
1240 """SetBottom(self, int bottom)"""
1241 return _core_.Rect_SetBottom(*args, **kwargs)
1242
1243 position = property(GetPosition, SetPosition)
1244 size = property(GetSize, SetSize)
1245 left = property(GetLeft, SetLeft)
1246 right = property(GetRight, SetRight)
1247 top = property(GetTop, SetTop)
1248 bottom = property(GetBottom, SetBottom)
1249
1250 def Inflate(*args, **kwargs):
1251 """
1252 Inflate(self, int dx, int dy) -> Rect
1253
1254 Increases the size of the rectangle.
1255
1256 The left border is moved farther left and the right border is moved
1257 farther right by ``dx``. The upper border is moved farther up and the
1258 bottom border is moved farther down by ``dy``. (Note the the width and
1259 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1260 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1261 opposite happens: the rectangle size decreases in the respective
1262 direction.
1263
1264 The change is made to the rectangle inplace, if instead you need a
1265 copy that is inflated, preserving the original then make the copy
1266 first::
1267
1268 copy = wx.Rect(*original)
1269 copy.Inflate(10,15)
1270
1271
1272 """
1273 return _core_.Rect_Inflate(*args, **kwargs)
1274
1275 def Deflate(*args, **kwargs):
1276 """
1277 Deflate(self, int dx, int dy) -> Rect
1278
1279 Decrease the rectangle size. This method is the opposite of `Inflate`
1280 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1281 `Inflate` for a full description.
1282 """
1283 return _core_.Rect_Deflate(*args, **kwargs)
1284
1285 def OffsetXY(*args, **kwargs):
1286 """
1287 OffsetXY(self, int dx, int dy)
1288
1289 Moves the rectangle by the specified offset. If dx is positive, the
1290 rectangle is moved to the right, if dy is positive, it is moved to the
1291 bottom, otherwise it is moved to the left or top respectively.
1292 """
1293 return _core_.Rect_OffsetXY(*args, **kwargs)
1294
1295 def Offset(*args, **kwargs):
1296 """
1297 Offset(self, Point pt)
1298
1299 Same as `OffsetXY` but uses dx,dy from Point
1300 """
1301 return _core_.Rect_Offset(*args, **kwargs)
1302
1303 def Intersect(*args, **kwargs):
1304 """
1305 Intersect(self, Rect rect) -> Rect
1306
1307 Returns the intersectsion of this rectangle and rect.
1308 """
1309 return _core_.Rect_Intersect(*args, **kwargs)
1310
1311 def Union(*args, **kwargs):
1312 """
1313 Union(self, Rect rect) -> Rect
1314
1315 Returns the union of this rectangle and rect.
1316 """
1317 return _core_.Rect_Union(*args, **kwargs)
1318
1319 def __add__(*args, **kwargs):
1320 """
1321 __add__(self, Rect rect) -> Rect
1322
1323 Add the properties of rect to this rectangle and return the result.
1324 """
1325 return _core_.Rect___add__(*args, **kwargs)
1326
1327 def __iadd__(*args, **kwargs):
1328 """
1329 __iadd__(self, Rect rect) -> Rect
1330
1331 Add the properties of rect to this rectangle, updating this rectangle.
1332 """
1333 return _core_.Rect___iadd__(*args, **kwargs)
1334
1335 def __eq__(*args, **kwargs):
1336 """
1337 __eq__(self, PyObject other) -> bool
1338
1339 Test for equality of wx.Rect objects.
1340 """
1341 return _core_.Rect___eq__(*args, **kwargs)
1342
1343 def __ne__(*args, **kwargs):
1344 """
1345 __ne__(self, PyObject other) -> bool
1346
1347 Test for inequality of wx.Rect objects.
1348 """
1349 return _core_.Rect___ne__(*args, **kwargs)
1350
1351 def ContainsXY(*args, **kwargs):
1352 """
1353 ContainsXY(self, int x, int y) -> bool
1354
1355 Return True if the point is inside the rect.
1356 """
1357 return _core_.Rect_ContainsXY(*args, **kwargs)
1358
1359 def Contains(*args, **kwargs):
1360 """
1361 Contains(self, Point pt) -> bool
1362
1363 Return True if the point is inside the rect.
1364 """
1365 return _core_.Rect_Contains(*args, **kwargs)
1366
1367 def ContainsRect(*args, **kwargs):
1368 """
1369 ContainsRect(self, Rect rect) -> bool
1370
1371 Returns ``True`` if the given rectangle is completely inside this
1372 rectangle or touches its boundary.
1373 """
1374 return _core_.Rect_ContainsRect(*args, **kwargs)
1375
1376 Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1377 InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1378 InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1379
1380 def Intersects(*args, **kwargs):
1381 """
1382 Intersects(self, Rect rect) -> bool
1383
1384 Returns True if the rectangles have a non empty intersection.
1385 """
1386 return _core_.Rect_Intersects(*args, **kwargs)
1387
1388 def CenterIn(*args, **kwargs):
1389 """
1390 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1391
1392 Center this rectangle within the one passed to the method, which is
1393 usually, but not necessarily, the larger one.
1394 """
1395 return _core_.Rect_CenterIn(*args, **kwargs)
1396
1397 CentreIn = CenterIn
1398 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1399 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1400 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1401 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1402 def Set(*args, **kwargs):
1403 """
1404 Set(self, int x=0, int y=0, int width=0, int height=0)
1405
1406 Set all rectangle properties.
1407 """
1408 return _core_.Rect_Set(*args, **kwargs)
1409
1410 def Get(*args, **kwargs):
1411 """
1412 Get() -> (x,y,width,height)
1413
1414 Return the rectangle properties as a tuple.
1415 """
1416 return _core_.Rect_Get(*args, **kwargs)
1417
1418 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1419 def __str__(self): return str(self.Get())
1420 def __repr__(self): return 'wx.Rect'+str(self.Get())
1421 def __len__(self): return len(self.Get())
1422 def __getitem__(self, index): return self.Get()[index]
1423 def __setitem__(self, index, val):
1424 if index == 0: self.x = val
1425 elif index == 1: self.y = val
1426 elif index == 2: self.width = val
1427 elif index == 3: self.height = val
1428 else: raise IndexError
1429 def __nonzero__(self): return self.Get() != (0,0,0,0)
1430 __safe_for_unpickling__ = True
1431 def __reduce__(self): return (wx.Rect, self.Get())
1432
1433 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1434 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1435 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
1436 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1437 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1438 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1439 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1440 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1441 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1442 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1443 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
1444 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1445 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1446 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1447 Empty = property(IsEmpty,doc="See `IsEmpty`")
1448 _core_.Rect_swigregister(Rect)
1449
1450 def RectPP(*args, **kwargs):
1451 """
1452 RectPP(Point topLeft, Point bottomRight) -> Rect
1453
1454 Create a new Rect object from Points representing two corners.
1455 """
1456 val = _core_.new_RectPP(*args, **kwargs)
1457 return val
1458
1459 def RectPS(*args, **kwargs):
1460 """
1461 RectPS(Point pos, Size size) -> Rect
1462
1463 Create a new Rect from a position and size.
1464 """
1465 val = _core_.new_RectPS(*args, **kwargs)
1466 return val
1467
1468 def RectS(*args, **kwargs):
1469 """
1470 RectS(Size size) -> Rect
1471
1472 Create a new Rect from a size only.
1473 """
1474 val = _core_.new_RectS(*args, **kwargs)
1475 return val
1476
1477
1478 def IntersectRect(*args, **kwargs):
1479 """
1480 IntersectRect(Rect r1, Rect r2) -> Rect
1481
1482 Calculate and return the intersection of r1 and r2.
1483 """
1484 return _core_.IntersectRect(*args, **kwargs)
1485 #---------------------------------------------------------------------------
1486
1487 class Point2D(object):
1488 """
1489 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1490 with floating point values.
1491 """
1492 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1493 __repr__ = _swig_repr
1494 def __init__(self, *args, **kwargs):
1495 """
1496 __init__(self, double x=0.0, double y=0.0) -> Point2D
1497
1498 Create a w.Point2D object.
1499 """
1500 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1501 def GetFloor(*args, **kwargs):
1502 """
1503 GetFloor() -> (x,y)
1504
1505 Convert to integer
1506 """
1507 return _core_.Point2D_GetFloor(*args, **kwargs)
1508
1509 def GetRounded(*args, **kwargs):
1510 """
1511 GetRounded() -> (x,y)
1512
1513 Convert to integer
1514 """
1515 return _core_.Point2D_GetRounded(*args, **kwargs)
1516
1517 def GetVectorLength(*args, **kwargs):
1518 """GetVectorLength(self) -> double"""
1519 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1520
1521 def GetVectorAngle(*args, **kwargs):
1522 """GetVectorAngle(self) -> double"""
1523 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1524
1525 def SetVectorLength(*args, **kwargs):
1526 """SetVectorLength(self, double length)"""
1527 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1528
1529 def SetVectorAngle(*args, **kwargs):
1530 """SetVectorAngle(self, double degrees)"""
1531 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1532
1533 def SetPolarCoordinates(self, angle, length):
1534 self.SetVectorLength(length)
1535 self.SetVectorAngle(angle)
1536 def Normalize(self):
1537 self.SetVectorLength(1.0)
1538
1539 def GetDistance(*args, **kwargs):
1540 """GetDistance(self, Point2D pt) -> double"""
1541 return _core_.Point2D_GetDistance(*args, **kwargs)
1542
1543 def GetDistanceSquare(*args, **kwargs):
1544 """GetDistanceSquare(self, Point2D pt) -> double"""
1545 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1546
1547 def GetDotProduct(*args, **kwargs):
1548 """GetDotProduct(self, Point2D vec) -> double"""
1549 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1550
1551 def GetCrossProduct(*args, **kwargs):
1552 """GetCrossProduct(self, Point2D vec) -> double"""
1553 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1554
1555 def __neg__(*args, **kwargs):
1556 """
1557 __neg__(self) -> Point2D
1558
1559 the reflection of this point
1560 """
1561 return _core_.Point2D___neg__(*args, **kwargs)
1562
1563 def __iadd__(*args, **kwargs):
1564 """__iadd__(self, Point2D pt) -> Point2D"""
1565 return _core_.Point2D___iadd__(*args, **kwargs)
1566
1567 def __isub__(*args, **kwargs):
1568 """__isub__(self, Point2D pt) -> Point2D"""
1569 return _core_.Point2D___isub__(*args, **kwargs)
1570
1571 def __imul__(*args, **kwargs):
1572 """__imul__(self, Point2D pt) -> Point2D"""
1573 return _core_.Point2D___imul__(*args, **kwargs)
1574
1575 def __idiv__(*args, **kwargs):
1576 """__idiv__(self, Point2D pt) -> Point2D"""
1577 return _core_.Point2D___idiv__(*args, **kwargs)
1578
1579 def __eq__(*args, **kwargs):
1580 """
1581 __eq__(self, PyObject other) -> bool
1582
1583 Test for equality of wx.Point2D objects.
1584 """
1585 return _core_.Point2D___eq__(*args, **kwargs)
1586
1587 def __ne__(*args, **kwargs):
1588 """
1589 __ne__(self, PyObject other) -> bool
1590
1591 Test for inequality of wx.Point2D objects.
1592 """
1593 return _core_.Point2D___ne__(*args, **kwargs)
1594
1595 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1596 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1597 def Set(*args, **kwargs):
1598 """Set(self, double x=0, double y=0)"""
1599 return _core_.Point2D_Set(*args, **kwargs)
1600
1601 def Get(*args, **kwargs):
1602 """
1603 Get() -> (x,y)
1604
1605 Return x and y properties as a tuple.
1606 """
1607 return _core_.Point2D_Get(*args, **kwargs)
1608
1609 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1610 def __str__(self): return str(self.Get())
1611 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1612 def __len__(self): return len(self.Get())
1613 def __getitem__(self, index): return self.Get()[index]
1614 def __setitem__(self, index, val):
1615 if index == 0: self.x = val
1616 elif index == 1: self.y = val
1617 else: raise IndexError
1618 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1619 __safe_for_unpickling__ = True
1620 def __reduce__(self): return (wx.Point2D, self.Get())
1621
1622 Floor = property(GetFloor,doc="See `GetFloor`")
1623 Rounded = property(GetRounded,doc="See `GetRounded`")
1624 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1625 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1626 _core_.Point2D_swigregister(Point2D)
1627
1628 def Point2DCopy(*args, **kwargs):
1629 """
1630 Point2DCopy(Point2D pt) -> Point2D
1631
1632 Create a w.Point2D object.
1633 """
1634 val = _core_.new_Point2DCopy(*args, **kwargs)
1635 return val
1636
1637 def Point2DFromPoint(*args, **kwargs):
1638 """
1639 Point2DFromPoint(Point pt) -> Point2D
1640
1641 Create a w.Point2D object.
1642 """
1643 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1644 return val
1645
1646 #---------------------------------------------------------------------------
1647
1648 FromStart = _core_.FromStart
1649 FromCurrent = _core_.FromCurrent
1650 FromEnd = _core_.FromEnd
1651 class InputStream(object):
1652 """Proxy of C++ InputStream class"""
1653 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1654 __repr__ = _swig_repr
1655 def __init__(self, *args, **kwargs):
1656 """__init__(self, PyObject p) -> InputStream"""
1657 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1658 __swig_destroy__ = _core_.delete_InputStream
1659 __del__ = lambda self : None;
1660 def close(*args, **kwargs):
1661 """close(self)"""
1662 return _core_.InputStream_close(*args, **kwargs)
1663
1664 def flush(*args, **kwargs):
1665 """flush(self)"""
1666 return _core_.InputStream_flush(*args, **kwargs)
1667
1668 def eof(*args, **kwargs):
1669 """eof(self) -> bool"""
1670 return _core_.InputStream_eof(*args, **kwargs)
1671
1672 def read(*args, **kwargs):
1673 """read(self, int size=-1) -> PyObject"""
1674 return _core_.InputStream_read(*args, **kwargs)
1675
1676 def readline(*args, **kwargs):
1677 """readline(self, int size=-1) -> PyObject"""
1678 return _core_.InputStream_readline(*args, **kwargs)
1679
1680 def readlines(*args, **kwargs):
1681 """readlines(self, int sizehint=-1) -> PyObject"""
1682 return _core_.InputStream_readlines(*args, **kwargs)
1683
1684 def seek(*args, **kwargs):
1685 """seek(self, int offset, int whence=0)"""
1686 return _core_.InputStream_seek(*args, **kwargs)
1687
1688 def tell(*args, **kwargs):
1689 """tell(self) -> int"""
1690 return _core_.InputStream_tell(*args, **kwargs)
1691
1692 def Peek(*args, **kwargs):
1693 """Peek(self) -> char"""
1694 return _core_.InputStream_Peek(*args, **kwargs)
1695
1696 def GetC(*args, **kwargs):
1697 """GetC(self) -> char"""
1698 return _core_.InputStream_GetC(*args, **kwargs)
1699
1700 def LastRead(*args, **kwargs):
1701 """LastRead(self) -> size_t"""
1702 return _core_.InputStream_LastRead(*args, **kwargs)
1703
1704 def CanRead(*args, **kwargs):
1705 """CanRead(self) -> bool"""
1706 return _core_.InputStream_CanRead(*args, **kwargs)
1707
1708 def Eof(*args, **kwargs):
1709 """Eof(self) -> bool"""
1710 return _core_.InputStream_Eof(*args, **kwargs)
1711
1712 def Ungetch(*args, **kwargs):
1713 """Ungetch(self, char c) -> bool"""
1714 return _core_.InputStream_Ungetch(*args, **kwargs)
1715
1716 def SeekI(*args, **kwargs):
1717 """SeekI(self, long pos, int mode=FromStart) -> long"""
1718 return _core_.InputStream_SeekI(*args, **kwargs)
1719
1720 def TellI(*args, **kwargs):
1721 """TellI(self) -> long"""
1722 return _core_.InputStream_TellI(*args, **kwargs)
1723
1724 _core_.InputStream_swigregister(InputStream)
1725 DefaultPosition = cvar.DefaultPosition
1726 DefaultSize = cvar.DefaultSize
1727
1728 class OutputStream(object):
1729 """Proxy of C++ OutputStream class"""
1730 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1731 def __init__(self): raise AttributeError, "No constructor defined"
1732 __repr__ = _swig_repr
1733 def write(*args, **kwargs):
1734 """write(self, PyObject obj)"""
1735 return _core_.OutputStream_write(*args, **kwargs)
1736
1737 def LastWrite(*args, **kwargs):
1738 """LastWrite(self) -> size_t"""
1739 return _core_.OutputStream_LastWrite(*args, **kwargs)
1740
1741 _core_.OutputStream_swigregister(OutputStream)
1742
1743 #---------------------------------------------------------------------------
1744
1745 class FSFile(Object):
1746 """Proxy of C++ FSFile class"""
1747 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1748 __repr__ = _swig_repr
1749 def __init__(self, *args, **kwargs):
1750 """
1751 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1752 DateTime modif) -> FSFile
1753 """
1754 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
1755 __swig_destroy__ = _core_.delete_FSFile
1756 __del__ = lambda self : None;
1757 def GetStream(*args, **kwargs):
1758 """GetStream(self) -> InputStream"""
1759 return _core_.FSFile_GetStream(*args, **kwargs)
1760
1761 def DetachStream(*args, **kwargs):
1762 """DetachStream(self)"""
1763 return _core_.FSFile_DetachStream(*args, **kwargs)
1764
1765 def GetMimeType(*args, **kwargs):
1766 """GetMimeType(self) -> String"""
1767 return _core_.FSFile_GetMimeType(*args, **kwargs)
1768
1769 def GetLocation(*args, **kwargs):
1770 """GetLocation(self) -> String"""
1771 return _core_.FSFile_GetLocation(*args, **kwargs)
1772
1773 def GetAnchor(*args, **kwargs):
1774 """GetAnchor(self) -> String"""
1775 return _core_.FSFile_GetAnchor(*args, **kwargs)
1776
1777 def GetModificationTime(*args, **kwargs):
1778 """GetModificationTime(self) -> DateTime"""
1779 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1780
1781 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1782 Location = property(GetLocation,doc="See `GetLocation`")
1783 MimeType = property(GetMimeType,doc="See `GetMimeType`")
1784 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
1785 Stream = property(GetStream,doc="See `GetStream`")
1786 _core_.FSFile_swigregister(FSFile)
1787
1788 class CPPFileSystemHandler(object):
1789 """Proxy of C++ CPPFileSystemHandler class"""
1790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1791 def __init__(self): raise AttributeError, "No constructor defined"
1792 __repr__ = _swig_repr
1793 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
1794 __del__ = lambda self : None;
1795 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
1796
1797 class FileSystemHandler(CPPFileSystemHandler):
1798 """Proxy of C++ FileSystemHandler class"""
1799 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1800 __repr__ = _swig_repr
1801 def __init__(self, *args, **kwargs):
1802 """__init__(self) -> FileSystemHandler"""
1803 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
1804 self._setCallbackInfo(self, FileSystemHandler)
1805
1806 def _setCallbackInfo(*args, **kwargs):
1807 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1808 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1809
1810 def CanOpen(*args, **kwargs):
1811 """CanOpen(self, String location) -> bool"""
1812 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1813
1814 def OpenFile(*args, **kwargs):
1815 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1816 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1817
1818 def FindFirst(*args, **kwargs):
1819 """FindFirst(self, String spec, int flags=0) -> String"""
1820 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1821
1822 def FindNext(*args, **kwargs):
1823 """FindNext(self) -> String"""
1824 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1825
1826 def GetProtocol(*args, **kwargs):
1827 """GetProtocol(self, String location) -> String"""
1828 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1829
1830 def GetLeftLocation(*args, **kwargs):
1831 """GetLeftLocation(self, String location) -> String"""
1832 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1833
1834 def GetAnchor(*args, **kwargs):
1835 """GetAnchor(self, String location) -> String"""
1836 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1837
1838 def GetRightLocation(*args, **kwargs):
1839 """GetRightLocation(self, String location) -> String"""
1840 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1841
1842 def GetMimeTypeFromExt(*args, **kwargs):
1843 """GetMimeTypeFromExt(self, String location) -> String"""
1844 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1845
1846 Anchor = property(GetAnchor,doc="See `GetAnchor`")
1847 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
1848 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
1849 Protocol = property(GetProtocol,doc="See `GetProtocol`")
1850 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
1851 _core_.FileSystemHandler_swigregister(FileSystemHandler)
1852
1853 class FileSystem(Object):
1854 """Proxy of C++ FileSystem class"""
1855 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1856 __repr__ = _swig_repr
1857 def __init__(self, *args, **kwargs):
1858 """__init__(self) -> FileSystem"""
1859 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
1860 __swig_destroy__ = _core_.delete_FileSystem
1861 __del__ = lambda self : None;
1862 def ChangePathTo(*args, **kwargs):
1863 """ChangePathTo(self, String location, bool is_dir=False)"""
1864 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1865
1866 def GetPath(*args, **kwargs):
1867 """GetPath(self) -> String"""
1868 return _core_.FileSystem_GetPath(*args, **kwargs)
1869
1870 def OpenFile(*args, **kwargs):
1871 """OpenFile(self, String location) -> FSFile"""
1872 return _core_.FileSystem_OpenFile(*args, **kwargs)
1873
1874 def FindFirst(*args, **kwargs):
1875 """FindFirst(self, String spec, int flags=0) -> String"""
1876 return _core_.FileSystem_FindFirst(*args, **kwargs)
1877
1878 def FindNext(*args, **kwargs):
1879 """FindNext(self) -> String"""
1880 return _core_.FileSystem_FindNext(*args, **kwargs)
1881
1882 def AddHandler(*args, **kwargs):
1883 """AddHandler(CPPFileSystemHandler handler)"""
1884 return _core_.FileSystem_AddHandler(*args, **kwargs)
1885
1886 AddHandler = staticmethod(AddHandler)
1887 def RemoveHandler(*args, **kwargs):
1888 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1889 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1890
1891 RemoveHandler = staticmethod(RemoveHandler)
1892 def CleanUpHandlers(*args, **kwargs):
1893 """CleanUpHandlers()"""
1894 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1895
1896 CleanUpHandlers = staticmethod(CleanUpHandlers)
1897 def FileNameToURL(*args, **kwargs):
1898 """FileNameToURL(String filename) -> String"""
1899 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1900
1901 FileNameToURL = staticmethod(FileNameToURL)
1902 def URLToFileName(*args, **kwargs):
1903 """URLToFileName(String url) -> String"""
1904 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1905
1906 URLToFileName = staticmethod(URLToFileName)
1907 Path = property(GetPath,doc="See `GetPath`")
1908 _core_.FileSystem_swigregister(FileSystem)
1909
1910 def FileSystem_AddHandler(*args, **kwargs):
1911 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1912 return _core_.FileSystem_AddHandler(*args, **kwargs)
1913
1914 def FileSystem_RemoveHandler(*args, **kwargs):
1915 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
1916 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
1917
1918 def FileSystem_CleanUpHandlers(*args):
1919 """FileSystem_CleanUpHandlers()"""
1920 return _core_.FileSystem_CleanUpHandlers(*args)
1921
1922 def FileSystem_FileNameToURL(*args, **kwargs):
1923 """FileSystem_FileNameToURL(String filename) -> String"""
1924 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1925
1926 def FileSystem_URLToFileName(*args, **kwargs):
1927 """FileSystem_URLToFileName(String url) -> String"""
1928 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1929
1930 class InternetFSHandler(CPPFileSystemHandler):
1931 """Proxy of C++ InternetFSHandler class"""
1932 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1933 __repr__ = _swig_repr
1934 def __init__(self, *args, **kwargs):
1935 """__init__(self) -> InternetFSHandler"""
1936 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
1937 def CanOpen(*args, **kwargs):
1938 """CanOpen(self, String location) -> bool"""
1939 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1940
1941 def OpenFile(*args, **kwargs):
1942 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1943 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1944
1945 _core_.InternetFSHandler_swigregister(InternetFSHandler)
1946
1947 class ZipFSHandler(CPPFileSystemHandler):
1948 """Proxy of C++ ZipFSHandler class"""
1949 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1950 __repr__ = _swig_repr
1951 def __init__(self, *args, **kwargs):
1952 """__init__(self) -> ZipFSHandler"""
1953 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
1954 def CanOpen(*args, **kwargs):
1955 """CanOpen(self, String location) -> bool"""
1956 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1957
1958 def OpenFile(*args, **kwargs):
1959 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1960 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1961
1962 def FindFirst(*args, **kwargs):
1963 """FindFirst(self, String spec, int flags=0) -> String"""
1964 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1965
1966 def FindNext(*args, **kwargs):
1967 """FindNext(self) -> String"""
1968 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1969
1970 _core_.ZipFSHandler_swigregister(ZipFSHandler)
1971
1972
1973 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1974 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1975 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1976
1977 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1978 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1979 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1980
1981 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1982 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1983 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1984 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1985 """
1986 Add 'file' to the memory filesystem. The dataItem parameter can
1987 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1988 arbitrary data. If a bitmap or image is used then the imgType
1989 parameter should specify what kind of image file it should be
1990 written as, wx.BITMAP_TYPE_PNG, etc.
1991 """
1992 if isinstance(dataItem, wx.Image):
1993 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1994 elif isinstance(dataItem, wx.Bitmap):
1995 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1996 elif type(dataItem) == str:
1997 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1998 else:
1999 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2000
2001 class MemoryFSHandler(CPPFileSystemHandler):
2002 """Proxy of C++ MemoryFSHandler class"""
2003 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2004 __repr__ = _swig_repr
2005 def __init__(self, *args, **kwargs):
2006 """__init__(self) -> MemoryFSHandler"""
2007 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
2008 def RemoveFile(*args, **kwargs):
2009 """RemoveFile(String filename)"""
2010 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2011
2012 RemoveFile = staticmethod(RemoveFile)
2013 AddFile = staticmethod(MemoryFSHandler_AddFile)
2014 def CanOpen(*args, **kwargs):
2015 """CanOpen(self, String location) -> bool"""
2016 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2017
2018 def OpenFile(*args, **kwargs):
2019 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2020 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2021
2022 def FindFirst(*args, **kwargs):
2023 """FindFirst(self, String spec, int flags=0) -> String"""
2024 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2025
2026 def FindNext(*args, **kwargs):
2027 """FindNext(self) -> String"""
2028 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2029
2030 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2031
2032 def MemoryFSHandler_RemoveFile(*args, **kwargs):
2033 """MemoryFSHandler_RemoveFile(String filename)"""
2034 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2035
2036 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2037 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2038 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2039 IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2040 IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
2041 #---------------------------------------------------------------------------
2042
2043 class ImageHandler(Object):
2044 """
2045 This is the base class for implementing image file loading/saving, and
2046 image creation from data. It is used within `wx.Image` and is not
2047 normally seen by the application.
2048 """
2049 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2050 def __init__(self): raise AttributeError, "No constructor defined"
2051 __repr__ = _swig_repr
2052 def GetName(*args, **kwargs):
2053 """GetName(self) -> String"""
2054 return _core_.ImageHandler_GetName(*args, **kwargs)
2055
2056 def GetExtension(*args, **kwargs):
2057 """GetExtension(self) -> String"""
2058 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2059
2060 def GetType(*args, **kwargs):
2061 """GetType(self) -> long"""
2062 return _core_.ImageHandler_GetType(*args, **kwargs)
2063
2064 def GetMimeType(*args, **kwargs):
2065 """GetMimeType(self) -> String"""
2066 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2067
2068 def CanRead(*args, **kwargs):
2069 """CanRead(self, String name) -> bool"""
2070 return _core_.ImageHandler_CanRead(*args, **kwargs)
2071
2072 def CanReadStream(*args, **kwargs):
2073 """CanReadStream(self, InputStream stream) -> bool"""
2074 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2075
2076 def SetName(*args, **kwargs):
2077 """SetName(self, String name)"""
2078 return _core_.ImageHandler_SetName(*args, **kwargs)
2079
2080 def SetExtension(*args, **kwargs):
2081 """SetExtension(self, String extension)"""
2082 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2083
2084 def SetType(*args, **kwargs):
2085 """SetType(self, long type)"""
2086 return _core_.ImageHandler_SetType(*args, **kwargs)
2087
2088 def SetMimeType(*args, **kwargs):
2089 """SetMimeType(self, String mimetype)"""
2090 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2091
2092 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2093 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2094 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2095 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2096 _core_.ImageHandler_swigregister(ImageHandler)
2097
2098 class PyImageHandler(ImageHandler):
2099 """
2100 This is the base class for implementing image file loading/saving, and
2101 image creation from data, all written in Python. To create a custom
2102 image handler derive a new class from wx.PyImageHandler and provide
2103 the following methods::
2104
2105 def DoCanRead(self, stream) --> bool
2106 '''Check if this handler can read the image on the stream'''
2107
2108 def LoadFile(self, image, stream, verbose, index) --> bool
2109 '''Load image data from the stream and load it into image.'''
2110
2111 def SaveFile(self, image, stream, verbose) --> bool
2112 '''Save the iamge data in image to the stream using
2113 this handler's image file format.'''
2114
2115 def GetImageCount(self, stream) --> int
2116 '''If this image format can hold more than one image,
2117 how many does the image on the stream have?'''
2118
2119 To activate your handler create an instance of it and pass it to
2120 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2121 `SetExtension` from your constructor.
2122
2123 """
2124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125 __repr__ = _swig_repr
2126 def __init__(self, *args, **kwargs):
2127 """
2128 __init__(self) -> PyImageHandler
2129
2130 This is the base class for implementing image file loading/saving, and
2131 image creation from data, all written in Python. To create a custom
2132 image handler derive a new class from wx.PyImageHandler and provide
2133 the following methods::
2134
2135 def DoCanRead(self, stream) --> bool
2136 '''Check if this handler can read the image on the stream'''
2137
2138 def LoadFile(self, image, stream, verbose, index) --> bool
2139 '''Load image data from the stream and load it into image.'''
2140
2141 def SaveFile(self, image, stream, verbose) --> bool
2142 '''Save the iamge data in image to the stream using
2143 this handler's image file format.'''
2144
2145 def GetImageCount(self, stream) --> int
2146 '''If this image format can hold more than one image,
2147 how many does the image on the stream have?'''
2148
2149 To activate your handler create an instance of it and pass it to
2150 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2151 `SetExtension` from your constructor.
2152
2153 """
2154 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2155 self._SetSelf(self)
2156
2157 def _SetSelf(*args, **kwargs):
2158 """_SetSelf(self, PyObject self)"""
2159 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2160
2161 _core_.PyImageHandler_swigregister(PyImageHandler)
2162
2163 class ImageHistogram(object):
2164 """Proxy of C++ ImageHistogram class"""
2165 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2166 __repr__ = _swig_repr
2167 def __init__(self, *args, **kwargs):
2168 """__init__(self) -> ImageHistogram"""
2169 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2170 def MakeKey(*args, **kwargs):
2171 """
2172 MakeKey(byte r, byte g, byte b) -> unsigned long
2173
2174 Get the key in the histogram for the given RGB values
2175 """
2176 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2177
2178 MakeKey = staticmethod(MakeKey)
2179 def FindFirstUnusedColour(*args, **kwargs):
2180 """
2181 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2182
2183 Find first colour that is not used in the image and has higher RGB
2184 values than startR, startG, startB. Returns a tuple consisting of a
2185 success flag and rgb values.
2186 """
2187 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2188
2189 def GetCount(*args, **kwargs):
2190 """
2191 GetCount(self, unsigned long key) -> unsigned long
2192
2193 Returns the pixel count for the given key. Use `MakeKey` to create a
2194 key value from a RGB tripple.
2195 """
2196 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2197
2198 def GetCountRGB(*args, **kwargs):
2199 """
2200 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2201
2202 Returns the pixel count for the given RGB values.
2203 """
2204 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2205
2206 def GetCountColour(*args, **kwargs):
2207 """
2208 GetCountColour(self, Colour colour) -> unsigned long
2209
2210 Returns the pixel count for the given `wx.Colour` value.
2211 """
2212 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2213
2214 _core_.ImageHistogram_swigregister(ImageHistogram)
2215
2216 def ImageHistogram_MakeKey(*args, **kwargs):
2217 """
2218 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2219
2220 Get the key in the histogram for the given RGB values
2221 """
2222 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2223
2224 class Image_RGBValue(object):
2225 """
2226 An object that contains values for red, green and blue which represent
2227 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2228 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2229 color space.
2230 """
2231 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2232 __repr__ = _swig_repr
2233 def __init__(self, *args, **kwargs):
2234 """
2235 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2236
2237 Constructor.
2238 """
2239 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2240 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2241 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2242 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2243 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2244
2245 class Image_HSVValue(object):
2246 """
2247 An object that contains values for hue, saturation and value which
2248 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2249 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2250 color space.
2251 """
2252 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2253 __repr__ = _swig_repr
2254 def __init__(self, *args, **kwargs):
2255 """
2256 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2257
2258 Constructor.
2259 """
2260 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2261 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2262 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2263 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2264 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2265
2266 class Image(Object):
2267 """
2268 A platform-independent image class. An image can be created from
2269 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2270 variety of formats. Functions are available to set and get image
2271 bits, so it can be used for basic image manipulation.
2272
2273 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2274 platform-specific `wx.Bitmap` object must be created from it using the
2275 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2276 device context, using `wx.DC.DrawBitmap`.
2277
2278 One colour value of the image may be used as a mask colour which will
2279 lead to the automatic creation of a `wx.Mask` object associated to the
2280 bitmap object.
2281
2282 wx.Image supports alpha channel data, that is in addition to a byte
2283 for the red, green and blue colour components for each pixel it also
2284 stores a byte representing the pixel opacity. An alpha value of 0
2285 corresponds to a transparent pixel (null opacity) while a value of 255
2286 means that the pixel is 100% opaque.
2287
2288 Unlike RGB data, not all images have an alpha channel and before using
2289 `GetAlpha` you should check if this image contains an alpha channel
2290 with `HasAlpha`. Note that currently only images loaded from PNG files
2291 with transparency information will have an alpha channel.
2292 """
2293 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2294 __repr__ = _swig_repr
2295 def __init__(self, *args, **kwargs):
2296 """
2297 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2298
2299 Loads an image from a file.
2300 """
2301 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2302 __swig_destroy__ = _core_.delete_Image
2303 __del__ = lambda self : None;
2304 def Create(*args, **kwargs):
2305 """
2306 Create(self, int width, int height, bool clear=True)
2307
2308 Creates a fresh image. If clear is ``True``, the new image will be
2309 initialized to black. Otherwise, the image data will be uninitialized.
2310 """
2311 return _core_.Image_Create(*args, **kwargs)
2312
2313 def Destroy(*args, **kwargs):
2314 """
2315 Destroy(self)
2316
2317 Destroys the image data.
2318 """
2319 val = _core_.Image_Destroy(*args, **kwargs)
2320 args[0].thisown = 0
2321 return val
2322
2323 def Scale(*args, **kwargs):
2324 """
2325 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2326
2327 Returns a scaled version of the image. This is also useful for scaling
2328 bitmaps in general as the only other way to scale bitmaps is to blit a
2329 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2330 specifies what method to use for resampling the image. It can be
2331 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2332 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2333 bicubic and box averaging resampling methods for upsampling and
2334 downsampling respectively.
2335 """
2336 return _core_.Image_Scale(*args, **kwargs)
2337
2338 def ResampleBox(*args, **kwargs):
2339 """ResampleBox(self, int width, int height) -> Image"""
2340 return _core_.Image_ResampleBox(*args, **kwargs)
2341
2342 def ResampleBicubic(*args, **kwargs):
2343 """ResampleBicubic(self, int width, int height) -> Image"""
2344 return _core_.Image_ResampleBicubic(*args, **kwargs)
2345
2346 def Blur(*args, **kwargs):
2347 """
2348 Blur(self, int radius) -> Image
2349
2350 Blurs the image in both horizontal and vertical directions by the
2351 specified pixel ``radius``. This should not be used when using a
2352 single mask colour for transparency.
2353 """
2354 return _core_.Image_Blur(*args, **kwargs)
2355
2356 def BlurHorizontal(*args, **kwargs):
2357 """
2358 BlurHorizontal(self, int radius) -> Image
2359
2360 Blurs the image in the horizontal direction only. This should not be
2361 used when using a single mask colour for transparency.
2362
2363 """
2364 return _core_.Image_BlurHorizontal(*args, **kwargs)
2365
2366 def BlurVertical(*args, **kwargs):
2367 """
2368 BlurVertical(self, int radius) -> Image
2369
2370 Blurs the image in the vertical direction only. This should not be
2371 used when using a single mask colour for transparency.
2372 """
2373 return _core_.Image_BlurVertical(*args, **kwargs)
2374
2375 def ShrinkBy(*args, **kwargs):
2376 """
2377 ShrinkBy(self, int xFactor, int yFactor) -> Image
2378
2379 Return a version of the image scaled smaller by the given factors.
2380 """
2381 return _core_.Image_ShrinkBy(*args, **kwargs)
2382
2383 def Rescale(*args, **kwargs):
2384 """
2385 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2386
2387 Changes the size of the image in-place by scaling it: after a call to
2388 this function, the image will have the given width and height.
2389
2390 Returns the (modified) image itself.
2391 """
2392 return _core_.Image_Rescale(*args, **kwargs)
2393
2394 def Resize(*args, **kwargs):
2395 """
2396 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2397
2398 Changes the size of the image in-place without scaling it, by adding
2399 either a border with the given colour or cropping as necessary. The
2400 image is pasted into a new image with the given size and background
2401 colour at the position pos relative to the upper left of the new
2402 image. If red = green = blue = -1 then use either the current mask
2403 colour if set or find, use, and set a suitable mask colour for any
2404 newly exposed areas.
2405
2406 Returns the (modified) image itself.
2407 """
2408 return _core_.Image_Resize(*args, **kwargs)
2409
2410 def SetRGB(*args, **kwargs):
2411 """
2412 SetRGB(self, int x, int y, byte r, byte g, byte b)
2413
2414 Sets the pixel at the given coordinate. This routine performs
2415 bounds-checks for the coordinate so it can be considered a safe way to
2416 manipulate the data, but in some cases this might be too slow so that
2417 the data will have to be set directly. In that case you will have to
2418 get access to the image data using the `GetData` method.
2419 """
2420 return _core_.Image_SetRGB(*args, **kwargs)
2421
2422 def SetRGBRect(*args, **kwargs):
2423 """
2424 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2425
2426 Sets the colour of the pixels within the given rectangle. This routine
2427 performs bounds-checks for the rectangle so it can be considered a
2428 safe way to manipulate the data.
2429 """
2430 return _core_.Image_SetRGBRect(*args, **kwargs)
2431
2432 def GetRed(*args, **kwargs):
2433 """
2434 GetRed(self, int x, int y) -> byte
2435
2436 Returns the red intensity at the given coordinate.
2437 """
2438 return _core_.Image_GetRed(*args, **kwargs)
2439
2440 def GetGreen(*args, **kwargs):
2441 """
2442 GetGreen(self, int x, int y) -> byte
2443
2444 Returns the green intensity at the given coordinate.
2445 """
2446 return _core_.Image_GetGreen(*args, **kwargs)
2447
2448 def GetBlue(*args, **kwargs):
2449 """
2450 GetBlue(self, int x, int y) -> byte
2451
2452 Returns the blue intensity at the given coordinate.
2453 """
2454 return _core_.Image_GetBlue(*args, **kwargs)
2455
2456 def SetAlpha(*args, **kwargs):
2457 """
2458 SetAlpha(self, int x, int y, byte alpha)
2459
2460 Sets the alpha value for the given pixel. This function should only be
2461 called if the image has alpha channel data, use `HasAlpha` to check
2462 for this.
2463 """
2464 return _core_.Image_SetAlpha(*args, **kwargs)
2465
2466 def GetAlpha(*args, **kwargs):
2467 """
2468 GetAlpha(self, int x, int y) -> byte
2469
2470 Returns the alpha value for the given pixel. This function may only be
2471 called for the images with alpha channel, use `HasAlpha` to check for
2472 this.
2473
2474 The returned value is the *opacity* of the image, i.e. the value of 0
2475 corresponds to the fully transparent pixels while the value of 255 to
2476 the fully opaque pixels.
2477 """
2478 return _core_.Image_GetAlpha(*args, **kwargs)
2479
2480 def HasAlpha(*args, **kwargs):
2481 """
2482 HasAlpha(self) -> bool
2483
2484 Returns true if this image has alpha channel, false otherwise.
2485 """
2486 return _core_.Image_HasAlpha(*args, **kwargs)
2487
2488 def InitAlpha(*args, **kwargs):
2489 """
2490 InitAlpha(self)
2491
2492 Initializes the image alpha channel data. It is an error to call it if
2493 the image already has alpha data. If it doesn't, alpha data will be by
2494 default initialized to all pixels being fully opaque. But if the image
2495 has a a mask colour, all mask pixels will be completely transparent.
2496 """
2497 return _core_.Image_InitAlpha(*args, **kwargs)
2498
2499 def IsTransparent(*args, **kwargs):
2500 """
2501 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2502
2503 Returns ``True`` if this pixel is masked or has an alpha value less
2504 than the spcified threshold.
2505 """
2506 return _core_.Image_IsTransparent(*args, **kwargs)
2507
2508 def FindFirstUnusedColour(*args, **kwargs):
2509 """
2510 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2511
2512 Find first colour that is not used in the image and has higher RGB
2513 values than startR, startG, startB. Returns a tuple consisting of a
2514 success flag and rgb values.
2515 """
2516 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2517
2518 def ConvertAlphaToMask(*args, **kwargs):
2519 """
2520 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2521
2522 If the image has alpha channel, this method converts it to mask. All
2523 pixels with alpha value less than ``threshold`` are replaced with the
2524 mask colour and the alpha channel is removed. The mask colour is
2525 chosen automatically using `FindFirstUnusedColour`.
2526
2527 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2528 nothing.
2529 """
2530 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2531
2532 def ConvertColourToAlpha(*args, **kwargs):
2533 """
2534 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2535
2536 This method converts an image where the original alpha information is
2537 only available as a shades of a colour (actually shades of grey)
2538 typically when you draw anti-aliased text into a bitmap. The DC
2539 drawing routines draw grey values on the black background although
2540 they actually mean to draw white with differnt alpha values. This
2541 method reverses it, assuming a black (!) background and white text.
2542 The method will then fill up the whole image with the colour given.
2543 """
2544 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2545
2546 def SetMaskFromImage(*args, **kwargs):
2547 """
2548 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2549
2550 Sets the image's mask so that the pixels that have RGB value of
2551 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2552 by first finding an unused colour in the image, setting this colour as
2553 the mask colour and then using this colour to draw all pixels in the
2554 image who corresponding pixel in mask has given RGB value.
2555
2556 Returns ``False`` if ``mask`` does not have same dimensions as the
2557 image or if there is no unused colour left. Returns ``True`` if the
2558 mask was successfully applied.
2559
2560 Note that this method involves computing the histogram, which is
2561 computationally intensive operation.
2562 """
2563 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2564
2565 def CanRead(*args, **kwargs):
2566 """
2567 CanRead(String filename) -> bool
2568
2569 Returns True if the image handlers can read this file.
2570 """
2571 return _core_.Image_CanRead(*args, **kwargs)
2572
2573 CanRead = staticmethod(CanRead)
2574 def GetImageCount(*args, **kwargs):
2575 """
2576 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2577
2578 If the image file contains more than one image and the image handler
2579 is capable of retrieving these individually, this function will return
2580 the number of available images.
2581 """
2582 return _core_.Image_GetImageCount(*args, **kwargs)
2583
2584 GetImageCount = staticmethod(GetImageCount)
2585 def LoadFile(*args, **kwargs):
2586 """
2587 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2588
2589 Loads an image from a file. If no handler type is provided, the
2590 library will try to autodetect the format.
2591 """
2592 return _core_.Image_LoadFile(*args, **kwargs)
2593
2594 def LoadMimeFile(*args, **kwargs):
2595 """
2596 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2597
2598 Loads an image from a file, specifying the image type with a MIME type
2599 string.
2600 """
2601 return _core_.Image_LoadMimeFile(*args, **kwargs)
2602
2603 def SaveFile(*args, **kwargs):
2604 """
2605 SaveFile(self, String name, int type) -> bool
2606
2607 Saves an image in the named file.
2608 """
2609 return _core_.Image_SaveFile(*args, **kwargs)
2610
2611 def SaveMimeFile(*args, **kwargs):
2612 """
2613 SaveMimeFile(self, String name, String mimetype) -> bool
2614
2615 Saves an image in the named file.
2616 """
2617 return _core_.Image_SaveMimeFile(*args, **kwargs)
2618
2619 def CanReadStream(*args, **kwargs):
2620 """
2621 CanReadStream(InputStream stream) -> bool
2622
2623 Returns True if the image handlers can read an image file from the
2624 data currently on the input stream, or a readable Python file-like
2625 object.
2626 """
2627 return _core_.Image_CanReadStream(*args, **kwargs)
2628
2629 CanReadStream = staticmethod(CanReadStream)
2630 def LoadStream(*args, **kwargs):
2631 """
2632 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2633
2634 Loads an image from an input stream or a readable Python file-like
2635 object. If no handler type is provided, the library will try to
2636 autodetect the format.
2637 """
2638 return _core_.Image_LoadStream(*args, **kwargs)
2639
2640 def LoadMimeStream(*args, **kwargs):
2641 """
2642 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2643
2644 Loads an image from an input stream or a readable Python file-like
2645 object, using a MIME type string to specify the image file format.
2646 """
2647 return _core_.Image_LoadMimeStream(*args, **kwargs)
2648
2649 def Ok(*args, **kwargs):
2650 """
2651 Ok(self) -> bool
2652
2653 Returns true if image data is present.
2654 """
2655 return _core_.Image_Ok(*args, **kwargs)
2656
2657 def GetWidth(*args, **kwargs):
2658 """
2659 GetWidth(self) -> int
2660
2661 Gets the width of the image in pixels.
2662 """
2663 return _core_.Image_GetWidth(*args, **kwargs)
2664
2665 def GetHeight(*args, **kwargs):
2666 """
2667 GetHeight(self) -> int
2668
2669 Gets the height of the image in pixels.
2670 """
2671 return _core_.Image_GetHeight(*args, **kwargs)
2672
2673 def GetSize(*args, **kwargs):
2674 """
2675 GetSize(self) -> Size
2676
2677 Returns the size of the image in pixels.
2678 """
2679 return _core_.Image_GetSize(*args, **kwargs)
2680
2681 def GetSubImage(*args, **kwargs):
2682 """
2683 GetSubImage(self, Rect rect) -> Image
2684
2685 Returns a sub image of the current one as long as the rect belongs
2686 entirely to the image.
2687 """
2688 return _core_.Image_GetSubImage(*args, **kwargs)
2689
2690 def Size(*args, **kwargs):
2691 """
2692 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2693
2694 Returns a resized version of this image without scaling it by adding
2695 either a border with the given colour or cropping as necessary. The
2696 image is pasted into a new image with the given size and background
2697 colour at the position ``pos`` relative to the upper left of the new
2698 image. If red = green = blue = -1 then use either the current mask
2699 colour if set or find, use, and set a suitable mask colour for any
2700 newly exposed areas.
2701 """
2702 return _core_.Image_Size(*args, **kwargs)
2703
2704 def Copy(*args, **kwargs):
2705 """
2706 Copy(self) -> Image
2707
2708 Returns an identical copy of the image.
2709 """
2710 return _core_.Image_Copy(*args, **kwargs)
2711
2712 def Paste(*args, **kwargs):
2713 """
2714 Paste(self, Image image, int x, int y)
2715
2716 Pastes ``image`` into this instance and takes care of the mask colour
2717 and any out of bounds problems.
2718 """
2719 return _core_.Image_Paste(*args, **kwargs)
2720
2721 def GetData(*args, **kwargs):
2722 """
2723 GetData(self) -> PyObject
2724
2725 Returns a string containing a copy of the RGB bytes of the image.
2726 """
2727 return _core_.Image_GetData(*args, **kwargs)
2728
2729 def SetData(*args, **kwargs):
2730 """
2731 SetData(self, buffer data)
2732
2733 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2734 either a string or a buffer object holding the data and the length of
2735 the data must be width*height*3.
2736 """
2737 return _core_.Image_SetData(*args, **kwargs)
2738
2739 def GetDataBuffer(*args, **kwargs):
2740 """
2741 GetDataBuffer(self) -> PyObject
2742
2743 Returns a writable Python buffer object that is pointing at the RGB
2744 image data buffer inside the wx.Image. You need to ensure that you do
2745 not use this buffer object after the image has been destroyed.
2746 """
2747 return _core_.Image_GetDataBuffer(*args, **kwargs)
2748
2749 def SetDataBuffer(*args, **kwargs):
2750 """
2751 SetDataBuffer(self, buffer data)
2752
2753 Sets the internal image data pointer to point at a Python buffer
2754 object. This can save making an extra copy of the data but you must
2755 ensure that the buffer object lives longer than the wx.Image does.
2756 """
2757 return _core_.Image_SetDataBuffer(*args, **kwargs)
2758
2759 def GetAlphaData(*args, **kwargs):
2760 """
2761 GetAlphaData(self) -> PyObject
2762
2763 Returns a string containing a copy of the alpha bytes of the image.
2764 """
2765 return _core_.Image_GetAlphaData(*args, **kwargs)
2766
2767 def SetAlphaData(*args, **kwargs):
2768 """
2769 SetAlphaData(self, buffer alpha)
2770
2771 Resets the Image's alpha data from a buffer of bytes. Accepts either
2772 a string or a buffer object holding the data and the length of the
2773 data must be width*height.
2774 """
2775 return _core_.Image_SetAlphaData(*args, **kwargs)
2776
2777 def GetAlphaBuffer(*args, **kwargs):
2778 """
2779 GetAlphaBuffer(self) -> PyObject
2780
2781 Returns a writable Python buffer object that is pointing at the Alpha
2782 data buffer inside the wx.Image. You need to ensure that you do not
2783 use this buffer object after the image has been destroyed.
2784 """
2785 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2786
2787 def SetAlphaBuffer(*args, **kwargs):
2788 """
2789 SetAlphaBuffer(self, buffer alpha)
2790
2791 Sets the internal image alpha pointer to point at a Python buffer
2792 object. This can save making an extra copy of the data but you must
2793 ensure that the buffer object lives as long as the wx.Image does.
2794 """
2795 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2796
2797 def SetMaskColour(*args, **kwargs):
2798 """
2799 SetMaskColour(self, byte r, byte g, byte b)
2800
2801 Sets the mask colour for this image (and tells the image to use the
2802 mask).
2803 """
2804 return _core_.Image_SetMaskColour(*args, **kwargs)
2805
2806 def GetOrFindMaskColour(*args, **kwargs):
2807 """
2808 GetOrFindMaskColour() -> (r,g,b)
2809
2810 Get the current mask colour or find a suitable colour.
2811 """
2812 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2813
2814 def GetMaskRed(*args, **kwargs):
2815 """
2816 GetMaskRed(self) -> byte
2817
2818 Gets the red component of the mask colour.
2819 """
2820 return _core_.Image_GetMaskRed(*args, **kwargs)
2821
2822 def GetMaskGreen(*args, **kwargs):
2823 """
2824 GetMaskGreen(self) -> byte
2825
2826 Gets the green component of the mask colour.
2827 """
2828 return _core_.Image_GetMaskGreen(*args, **kwargs)
2829
2830 def GetMaskBlue(*args, **kwargs):
2831 """
2832 GetMaskBlue(self) -> byte
2833
2834 Gets the blue component of the mask colour.
2835 """
2836 return _core_.Image_GetMaskBlue(*args, **kwargs)
2837
2838 def SetMask(*args, **kwargs):
2839 """
2840 SetMask(self, bool mask=True)
2841
2842 Specifies whether there is a mask or not. The area of the mask is
2843 determined by the current mask colour.
2844 """
2845 return _core_.Image_SetMask(*args, **kwargs)
2846
2847 def HasMask(*args, **kwargs):
2848 """
2849 HasMask(self) -> bool
2850
2851 Returns ``True`` if there is a mask active, ``False`` otherwise.
2852 """
2853 return _core_.Image_HasMask(*args, **kwargs)
2854
2855 def Rotate(*args, **kwargs):
2856 """
2857 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2858 Point offset_after_rotation=None) -> Image
2859
2860 Rotates the image about the given point, by ``angle`` radians. Passing
2861 ``True`` to ``interpolating`` results in better image quality, but is
2862 slower. If the image has a mask, then the mask colour is used for the
2863 uncovered pixels in the rotated image background. Otherwise, black
2864 will be used as the fill colour.
2865
2866 Returns the rotated image, leaving this image intact.
2867 """
2868 return _core_.Image_Rotate(*args, **kwargs)
2869
2870 def Rotate90(*args, **kwargs):
2871 """
2872 Rotate90(self, bool clockwise=True) -> Image
2873
2874 Returns a copy of the image rotated 90 degrees in the direction
2875 indicated by ``clockwise``.
2876 """
2877 return _core_.Image_Rotate90(*args, **kwargs)
2878
2879 def Mirror(*args, **kwargs):
2880 """
2881 Mirror(self, bool horizontally=True) -> Image
2882
2883 Returns a mirrored copy of the image. The parameter ``horizontally``
2884 indicates the orientation.
2885 """
2886 return _core_.Image_Mirror(*args, **kwargs)
2887
2888 def Replace(*args, **kwargs):
2889 """
2890 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2891
2892 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2893 ``(r2,g2,b2)``.
2894 """
2895 return _core_.Image_Replace(*args, **kwargs)
2896
2897 def ConvertToGreyscale(*args, **kwargs):
2898 """
2899 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
2900
2901 Convert to greyscale image. Uses the luminance component (Y) of the
2902 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
2903 defaults to ITU-T BT.601
2904 """
2905 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
2906
2907 def ConvertToMono(*args, **kwargs):
2908 """
2909 ConvertToMono(self, byte r, byte g, byte b) -> Image
2910
2911 Returns monochromatic version of the image. The returned image has
2912 white colour where the original has ``(r,g,b)`` colour and black
2913 colour everywhere else.
2914 """
2915 return _core_.Image_ConvertToMono(*args, **kwargs)
2916
2917 def SetOption(*args, **kwargs):
2918 """
2919 SetOption(self, String name, String value)
2920
2921 Sets an image handler defined option. For example, when saving as a
2922 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2923 number between 0 and 100 (0 is terrible, 100 is very good).
2924 """
2925 return _core_.Image_SetOption(*args, **kwargs)
2926
2927 def SetOptionInt(*args, **kwargs):
2928 """
2929 SetOptionInt(self, String name, int value)
2930
2931 Sets an image option as an integer.
2932 """
2933 return _core_.Image_SetOptionInt(*args, **kwargs)
2934
2935 def GetOption(*args, **kwargs):
2936 """
2937 GetOption(self, String name) -> String
2938
2939 Gets the value of an image handler option.
2940 """
2941 return _core_.Image_GetOption(*args, **kwargs)
2942
2943 def GetOptionInt(*args, **kwargs):
2944 """
2945 GetOptionInt(self, String name) -> int
2946
2947 Gets the value of an image handler option as an integer. If the given
2948 option is not present, the function returns 0.
2949 """
2950 return _core_.Image_GetOptionInt(*args, **kwargs)
2951
2952 def HasOption(*args, **kwargs):
2953 """
2954 HasOption(self, String name) -> bool
2955
2956 Returns true if the given option is present.
2957 """
2958 return _core_.Image_HasOption(*args, **kwargs)
2959
2960 def CountColours(*args, **kwargs):
2961 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2962 return _core_.Image_CountColours(*args, **kwargs)
2963
2964 def ComputeHistogram(*args, **kwargs):
2965 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2966 return _core_.Image_ComputeHistogram(*args, **kwargs)
2967
2968 def AddHandler(*args, **kwargs):
2969 """AddHandler(ImageHandler handler)"""
2970 return _core_.Image_AddHandler(*args, **kwargs)
2971
2972 AddHandler = staticmethod(AddHandler)
2973 def InsertHandler(*args, **kwargs):
2974 """InsertHandler(ImageHandler handler)"""
2975 return _core_.Image_InsertHandler(*args, **kwargs)
2976
2977 InsertHandler = staticmethod(InsertHandler)
2978 def RemoveHandler(*args, **kwargs):
2979 """RemoveHandler(String name) -> bool"""
2980 return _core_.Image_RemoveHandler(*args, **kwargs)
2981
2982 RemoveHandler = staticmethod(RemoveHandler)
2983 def GetHandlers(*args, **kwargs):
2984 """GetHandlers() -> PyObject"""
2985 return _core_.Image_GetHandlers(*args, **kwargs)
2986
2987 GetHandlers = staticmethod(GetHandlers)
2988 def GetImageExtWildcard(*args, **kwargs):
2989 """
2990 GetImageExtWildcard() -> String
2991
2992 Iterates all registered wxImageHandler objects, and returns a string
2993 containing file extension masks suitable for passing to file open/save
2994 dialog boxes.
2995 """
2996 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2997
2998 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2999 def ConvertToBitmap(*args, **kwargs):
3000 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3001 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3002
3003 def ConvertToMonoBitmap(*args, **kwargs):
3004 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3005 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3006
3007 def RotateHue(*args, **kwargs):
3008 """
3009 RotateHue(self, double angle)
3010
3011 Rotates the hue of each pixel of the image. Hue is a double in the
3012 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3013 """
3014 return _core_.Image_RotateHue(*args, **kwargs)
3015
3016 def RGBtoHSV(*args, **kwargs):
3017 """
3018 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3019
3020 Converts a color in RGB color space to HSV color space.
3021 """
3022 return _core_.Image_RGBtoHSV(*args, **kwargs)
3023
3024 RGBtoHSV = staticmethod(RGBtoHSV)
3025 def HSVtoRGB(*args, **kwargs):
3026 """
3027 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3028
3029 Converts a color in HSV color space to RGB color space.
3030 """
3031 return _core_.Image_HSVtoRGB(*args, **kwargs)
3032
3033 HSVtoRGB = staticmethod(HSVtoRGB)
3034 def __nonzero__(self): return self.Ok()
3035 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3036 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3037 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3038 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3039 Height = property(GetHeight,doc="See `GetHeight`")
3040 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3041 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3042 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
3043 Size = property(GetSize,doc="See `GetSize`")
3044 Width = property(GetWidth,doc="See `GetWidth`")
3045 _core_.Image_swigregister(Image)
3046
3047 def ImageFromMime(*args, **kwargs):
3048 """
3049 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3050
3051 Loads an image from a file, using a MIME type string (such as
3052 'image/jpeg') to specify image type.
3053 """
3054 val = _core_.new_ImageFromMime(*args, **kwargs)
3055 return val
3056
3057 def ImageFromStream(*args, **kwargs):
3058 """
3059 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3060
3061 Loads an image from an input stream, or any readable Python file-like
3062 object.
3063 """
3064 val = _core_.new_ImageFromStream(*args, **kwargs)
3065 return val
3066
3067 def ImageFromStreamMime(*args, **kwargs):
3068 """
3069 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3070
3071 Loads an image from an input stream, or any readable Python file-like
3072 object, specifying the image format with a MIME type string.
3073 """
3074 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3075 return val
3076
3077 def EmptyImage(*args, **kwargs):
3078 """
3079 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3080
3081 Construct an empty image of a given size, optionally setting all
3082 pixels to black.
3083 """
3084 val = _core_.new_EmptyImage(*args, **kwargs)
3085 return val
3086
3087 def ImageFromBitmap(*args, **kwargs):
3088 """
3089 ImageFromBitmap(Bitmap bitmap) -> Image
3090
3091 Construct an Image from a `wx.Bitmap`.
3092 """
3093 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3094 return val
3095
3096 def ImageFromData(*args, **kwargs):
3097 """
3098 ImageFromData(int width, int height, buffer data) -> Image
3099
3100 Construct an Image from a buffer of RGB bytes. Accepts either a
3101 string or a buffer object holding the data and the length of the data
3102 must be width*height*3.
3103 """
3104 val = _core_.new_ImageFromData(*args, **kwargs)
3105 return val
3106
3107 def ImageFromDataWithAlpha(*args, **kwargs):
3108 """
3109 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3110
3111 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3112 Accepts either a string or a buffer object holding the data and the
3113 length of the data must be width*height*3 bytes, and the length of the
3114 alpha data must be width*height bytes.
3115 """
3116 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3117 return val
3118
3119 def Image_CanRead(*args, **kwargs):
3120 """
3121 Image_CanRead(String filename) -> bool
3122
3123 Returns True if the image handlers can read this file.
3124 """
3125 return _core_.Image_CanRead(*args, **kwargs)
3126
3127 def Image_GetImageCount(*args, **kwargs):
3128 """
3129 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3130
3131 If the image file contains more than one image and the image handler
3132 is capable of retrieving these individually, this function will return
3133 the number of available images.
3134 """
3135 return _core_.Image_GetImageCount(*args, **kwargs)
3136
3137 def Image_CanReadStream(*args, **kwargs):
3138 """
3139 Image_CanReadStream(InputStream stream) -> bool
3140
3141 Returns True if the image handlers can read an image file from the
3142 data currently on the input stream, or a readable Python file-like
3143 object.
3144 """
3145 return _core_.Image_CanReadStream(*args, **kwargs)
3146
3147 def Image_AddHandler(*args, **kwargs):
3148 """Image_AddHandler(ImageHandler handler)"""
3149 return _core_.Image_AddHandler(*args, **kwargs)
3150
3151 def Image_InsertHandler(*args, **kwargs):
3152 """Image_InsertHandler(ImageHandler handler)"""
3153 return _core_.Image_InsertHandler(*args, **kwargs)
3154
3155 def Image_RemoveHandler(*args, **kwargs):
3156 """Image_RemoveHandler(String name) -> bool"""
3157 return _core_.Image_RemoveHandler(*args, **kwargs)
3158
3159 def Image_GetHandlers(*args):
3160 """Image_GetHandlers() -> PyObject"""
3161 return _core_.Image_GetHandlers(*args)
3162
3163 def Image_GetImageExtWildcard(*args):
3164 """
3165 Image_GetImageExtWildcard() -> String
3166
3167 Iterates all registered wxImageHandler objects, and returns a string
3168 containing file extension masks suitable for passing to file open/save
3169 dialog boxes.
3170 """
3171 return _core_.Image_GetImageExtWildcard(*args)
3172
3173 def Image_RGBtoHSV(*args, **kwargs):
3174 """
3175 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3176
3177 Converts a color in RGB color space to HSV color space.
3178 """
3179 return _core_.Image_RGBtoHSV(*args, **kwargs)
3180
3181 def Image_HSVtoRGB(*args, **kwargs):
3182 """
3183 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3184
3185 Converts a color in HSV color space to RGB color space.
3186 """
3187 return _core_.Image_HSVtoRGB(*args, **kwargs)
3188
3189
3190 def _ImageFromBuffer(*args, **kwargs):
3191 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3192 return _core_._ImageFromBuffer(*args, **kwargs)
3193 def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3194 """
3195 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3196 parameter must be a Python object that implements the buffer interface,
3197 such as a string, array, etc. The dataBuffer object is expected to
3198 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3199 object can optionally be supplied for the image's alpha channel data, and
3200 it is expected to be width*height bytes long.
3201
3202 The wx.Image will be created with its data and alpha pointers initialized
3203 to the memory address pointed to by the buffer objects, thus saving the
3204 time needed to copy the image data from the buffer object to the wx.Image.
3205 While this has advantages, it also has the shoot-yourself-in-the-foot
3206 risks associated with sharing a C pointer between two objects.
3207
3208 To help alleviate the risk a reference to the data and alpha buffer
3209 objects are kept with the wx.Image, so that they won't get deleted until
3210 after the wx.Image is deleted. However please be aware that it is not
3211 guaranteed that an object won't move its memory buffer to a new location
3212 when it needs to resize its contents. If that happens then the wx.Image
3213 will end up referring to an invalid memory location and could cause the
3214 application to crash. Therefore care should be taken to not manipulate
3215 the objects used for the data and alpha buffers in a way that would cause
3216 them to change size.
3217 """
3218 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3219 image._buffer = dataBuffer
3220 image._alpha = alphaBuffer
3221 return image
3222
3223 def InitAllImageHandlers():
3224 """
3225 The former functionality of InitAllImageHanders is now done internal to
3226 the _core_ extension module and so this function has become a simple NOP.
3227 """
3228 pass
3229
3230 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3231 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3232 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3233 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3234 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3235 BMP_24BPP = _core_.BMP_24BPP
3236 BMP_8BPP = _core_.BMP_8BPP
3237 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3238 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3239 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3240 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3241 BMP_4BPP = _core_.BMP_4BPP
3242 BMP_1BPP = _core_.BMP_1BPP
3243 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3244 class BMPHandler(ImageHandler):
3245 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3246 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3247 __repr__ = _swig_repr
3248 def __init__(self, *args, **kwargs):
3249 """
3250 __init__(self) -> BMPHandler
3251
3252 A `wx.ImageHandler` for \*.bmp bitmap files.
3253 """
3254 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3255 _core_.BMPHandler_swigregister(BMPHandler)
3256 NullImage = cvar.NullImage
3257 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3258 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3259 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3260 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3261 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3262 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3263 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3264 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3265 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3266 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3267 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3268 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3269 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3270 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3271 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3272
3273 class ICOHandler(BMPHandler):
3274 """A `wx.ImageHandler` for \*.ico icon files."""
3275 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3276 __repr__ = _swig_repr
3277 def __init__(self, *args, **kwargs):
3278 """
3279 __init__(self) -> ICOHandler
3280
3281 A `wx.ImageHandler` for \*.ico icon files.
3282 """
3283 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3284 _core_.ICOHandler_swigregister(ICOHandler)
3285
3286 class CURHandler(ICOHandler):
3287 """A `wx.ImageHandler` for \*.cur cursor files."""
3288 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3289 __repr__ = _swig_repr
3290 def __init__(self, *args, **kwargs):
3291 """
3292 __init__(self) -> CURHandler
3293
3294 A `wx.ImageHandler` for \*.cur cursor files.
3295 """
3296 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3297 _core_.CURHandler_swigregister(CURHandler)
3298
3299 class ANIHandler(CURHandler):
3300 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3301 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3302 __repr__ = _swig_repr
3303 def __init__(self, *args, **kwargs):
3304 """
3305 __init__(self) -> ANIHandler
3306
3307 A `wx.ImageHandler` for \*.ani animated cursor files.
3308 """
3309 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3310 _core_.ANIHandler_swigregister(ANIHandler)
3311
3312 class PNGHandler(ImageHandler):
3313 """A `wx.ImageHandler` for PNG image files."""
3314 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3315 __repr__ = _swig_repr
3316 def __init__(self, *args, **kwargs):
3317 """
3318 __init__(self) -> PNGHandler
3319
3320 A `wx.ImageHandler` for PNG image files.
3321 """
3322 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3323 _core_.PNGHandler_swigregister(PNGHandler)
3324
3325 class GIFHandler(ImageHandler):
3326 """A `wx.ImageHandler` for GIF image files."""
3327 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3328 __repr__ = _swig_repr
3329 def __init__(self, *args, **kwargs):
3330 """
3331 __init__(self) -> GIFHandler
3332
3333 A `wx.ImageHandler` for GIF image files.
3334 """
3335 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3336 _core_.GIFHandler_swigregister(GIFHandler)
3337
3338 class PCXHandler(ImageHandler):
3339 """A `wx.ImageHandler` for PCX imager files."""
3340 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3341 __repr__ = _swig_repr
3342 def __init__(self, *args, **kwargs):
3343 """
3344 __init__(self) -> PCXHandler
3345
3346 A `wx.ImageHandler` for PCX imager files.
3347 """
3348 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3349 _core_.PCXHandler_swigregister(PCXHandler)
3350
3351 class JPEGHandler(ImageHandler):
3352 """A `wx.ImageHandler` for JPEG/JPG image files."""
3353 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3354 __repr__ = _swig_repr
3355 def __init__(self, *args, **kwargs):
3356 """
3357 __init__(self) -> JPEGHandler
3358
3359 A `wx.ImageHandler` for JPEG/JPG image files.
3360 """
3361 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3362 _core_.JPEGHandler_swigregister(JPEGHandler)
3363
3364 class PNMHandler(ImageHandler):
3365 """A `wx.ImageHandler` for PNM image files."""
3366 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3367 __repr__ = _swig_repr
3368 def __init__(self, *args, **kwargs):
3369 """
3370 __init__(self) -> PNMHandler
3371
3372 A `wx.ImageHandler` for PNM image files.
3373 """
3374 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3375 _core_.PNMHandler_swigregister(PNMHandler)
3376
3377 class XPMHandler(ImageHandler):
3378 """A `wx.ImageHandler` for XPM image."""
3379 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3380 __repr__ = _swig_repr
3381 def __init__(self, *args, **kwargs):
3382 """
3383 __init__(self) -> XPMHandler
3384
3385 A `wx.ImageHandler` for XPM image.
3386 """
3387 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3388 _core_.XPMHandler_swigregister(XPMHandler)
3389
3390 class TIFFHandler(ImageHandler):
3391 """A `wx.ImageHandler` for TIFF image files."""
3392 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3393 __repr__ = _swig_repr
3394 def __init__(self, *args, **kwargs):
3395 """
3396 __init__(self) -> TIFFHandler
3397
3398 A `wx.ImageHandler` for TIFF image files.
3399 """
3400 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3401 _core_.TIFFHandler_swigregister(TIFFHandler)
3402
3403 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3404 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3405 class Quantize(object):
3406 """Performs quantization, or colour reduction, on a wxImage."""
3407 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3408 def __init__(self): raise AttributeError, "No constructor defined"
3409 __repr__ = _swig_repr
3410 def Quantize(*args, **kwargs):
3411 """
3412 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3413
3414 Reduce the colours in the source image and put the result into the
3415 destination image, setting the palette in the destination if
3416 needed. Both images may be the same, to overwrite the source image.
3417 """
3418 return _core_.Quantize_Quantize(*args, **kwargs)
3419
3420 Quantize = staticmethod(Quantize)
3421 _core_.Quantize_swigregister(Quantize)
3422
3423 def Quantize_Quantize(*args, **kwargs):
3424 """
3425 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3426
3427 Reduce the colours in the source image and put the result into the
3428 destination image, setting the palette in the destination if
3429 needed. Both images may be the same, to overwrite the source image.
3430 """
3431 return _core_.Quantize_Quantize(*args, **kwargs)
3432
3433 #---------------------------------------------------------------------------
3434
3435 class EvtHandler(Object):
3436 """Proxy of C++ EvtHandler class"""
3437 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3438 __repr__ = _swig_repr
3439 def __init__(self, *args, **kwargs):
3440 """__init__(self) -> EvtHandler"""
3441 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3442 self._setOORInfo(self)
3443
3444 def GetNextHandler(*args, **kwargs):
3445 """GetNextHandler(self) -> EvtHandler"""
3446 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3447
3448 def GetPreviousHandler(*args, **kwargs):
3449 """GetPreviousHandler(self) -> EvtHandler"""
3450 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3451
3452 def SetNextHandler(*args, **kwargs):
3453 """SetNextHandler(self, EvtHandler handler)"""
3454 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3455
3456 def SetPreviousHandler(*args, **kwargs):
3457 """SetPreviousHandler(self, EvtHandler handler)"""
3458 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3459
3460 def GetEvtHandlerEnabled(*args, **kwargs):
3461 """GetEvtHandlerEnabled(self) -> bool"""
3462 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3463
3464 def SetEvtHandlerEnabled(*args, **kwargs):
3465 """SetEvtHandlerEnabled(self, bool enabled)"""
3466 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3467
3468 def ProcessEvent(*args, **kwargs):
3469 """ProcessEvent(self, Event event) -> bool"""
3470 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3471
3472 def AddPendingEvent(*args, **kwargs):
3473 """AddPendingEvent(self, Event event)"""
3474 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3475
3476 def ProcessPendingEvents(*args, **kwargs):
3477 """ProcessPendingEvents(self)"""
3478 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3479
3480 def Connect(*args, **kwargs):
3481 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3482 return _core_.EvtHandler_Connect(*args, **kwargs)
3483
3484 def Disconnect(*args, **kwargs):
3485 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3486 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3487
3488 def _setOORInfo(*args, **kwargs):
3489 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3490 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3491 args[0].thisown = 0
3492 return val
3493
3494 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3495 """
3496 Bind an event to an event handler.
3497
3498 :param event: One of the EVT_* objects that specifies the
3499 type of event to bind,
3500
3501 :param handler: A callable object to be invoked when the
3502 event is delivered to self. Pass None to
3503 disconnect an event handler.
3504
3505 :param source: Sometimes the event originates from a
3506 different window than self, but you still
3507 want to catch it in self. (For example, a
3508 button event delivered to a frame.) By
3509 passing the source of the event, the event
3510 handling system is able to differentiate
3511 between the same event type from different
3512 controls.
3513
3514 :param id: Used to spcify the event source by ID instead
3515 of instance.
3516
3517 :param id2: Used when it is desirable to bind a handler
3518 to a range of IDs, such as with EVT_MENU_RANGE.
3519 """
3520 if source is not None:
3521 id = source.GetId()
3522 event.Bind(self, id, id2, handler)
3523
3524 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3525 """
3526 Disconencts the event handler binding for event from self.
3527 Returns True if successful.
3528 """
3529 if source is not None:
3530 id = source.GetId()
3531 return event.Unbind(self, id, id2)
3532
3533 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3534 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3535 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3536 _core_.EvtHandler_swigregister(EvtHandler)
3537
3538 #---------------------------------------------------------------------------
3539
3540 class PyEventBinder(object):
3541 """
3542 Instances of this class are used to bind specific events to event
3543 handlers.
3544 """
3545 def __init__(self, evtType, expectedIDs=0):
3546 if expectedIDs not in [0, 1, 2]:
3547 raise ValueError, "Invalid number of expectedIDs"
3548 self.expectedIDs = expectedIDs
3549
3550 if type(evtType) == list or type(evtType) == tuple:
3551 self.evtType = evtType
3552 else:
3553 self.evtType = [evtType]
3554
3555
3556 def Bind(self, target, id1, id2, function):
3557 """Bind this set of event types to target."""
3558 for et in self.evtType:
3559 target.Connect(id1, id2, et, function)
3560
3561
3562 def Unbind(self, target, id1, id2):
3563 """Remove an event binding."""
3564 success = 0
3565 for et in self.evtType:
3566 success += target.Disconnect(id1, id2, et)
3567 return success != 0
3568
3569
3570 def __call__(self, *args):
3571 """
3572 For backwards compatibility with the old EVT_* functions.
3573 Should be called with either (window, func), (window, ID,
3574 func) or (window, ID1, ID2, func) parameters depending on the
3575 type of the event.
3576 """
3577 assert len(args) == 2 + self.expectedIDs
3578 id1 = wx.ID_ANY
3579 id2 = wx.ID_ANY
3580 target = args[0]
3581 if self.expectedIDs == 0:
3582 func = args[1]
3583 elif self.expectedIDs == 1:
3584 id1 = args[1]
3585 func = args[2]
3586 elif self.expectedIDs == 2:
3587 id1 = args[1]
3588 id2 = args[2]
3589 func = args[3]
3590 else:
3591 raise ValueError, "Unexpected number of IDs"
3592
3593 self.Bind(target, id1, id2, func)
3594
3595
3596 # These two are square pegs that don't fit the PyEventBinder hole...
3597 def EVT_COMMAND(win, id, cmd, func):
3598 win.Connect(id, -1, cmd, func)
3599 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3600 win.Connect(id1, id2, cmd, func)
3601
3602
3603 #---------------------------------------------------------------------------
3604
3605 #---------------------------------------------------------------------------
3606
3607 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3608 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3609
3610 def NewEventType(*args):
3611 """NewEventType() -> EventType"""
3612 return _core_.NewEventType(*args)
3613 wxEVT_NULL = _core_.wxEVT_NULL
3614 wxEVT_FIRST = _core_.wxEVT_FIRST
3615 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3616 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3617 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3618 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3619 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3620 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3621 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3622 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3623 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3624 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3625 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3626 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3627 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3628 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3629 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3630 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3631 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3632 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3633 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3634 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3635 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3636 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3637 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3638 wxEVT_MOTION = _core_.wxEVT_MOTION
3639 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3640 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3641 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3642 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3643 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3644 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3645 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3646 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3647 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3648 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3649 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3650 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3651 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3652 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3653 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3654 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3655 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3656 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3657 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3658 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3659 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3660 wxEVT_CHAR = _core_.wxEVT_CHAR
3661 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3662 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3663 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3664 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3665 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3666 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3667 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3668 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3669 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3670 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3671 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3672 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3673 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3674 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3675 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3676 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3677 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3678 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3679 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3680 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3681 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3682 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3683 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3684 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3685 wxEVT_SIZE = _core_.wxEVT_SIZE
3686 wxEVT_MOVE = _core_.wxEVT_MOVE
3687 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3688 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3689 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3690 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3691 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3692 wxEVT_CREATE = _core_.wxEVT_CREATE
3693 wxEVT_DESTROY = _core_.wxEVT_DESTROY
3694 wxEVT_SHOW = _core_.wxEVT_SHOW
3695 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3696 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3697 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3698 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3699 wxEVT_PAINT = _core_.wxEVT_PAINT
3700 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3701 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3702 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3703 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3704 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3705 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3706 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3707 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3708 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3709 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3710 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3711 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3712 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3713 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3714 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3715 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3716 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3717 wxEVT_IDLE = _core_.wxEVT_IDLE
3718 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3719 wxEVT_SIZING = _core_.wxEVT_SIZING
3720 wxEVT_MOVING = _core_.wxEVT_MOVING
3721 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
3722 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
3723 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
3724 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
3725 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3726 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3727 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3728 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3729 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3730 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3731 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3732 #
3733 # Create some event binders
3734 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3735 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3736 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3737 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3738 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3739 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3740 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3741 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3742 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3743 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3744 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3745 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3746 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3747 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3748 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3749 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3750 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3751 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3752 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3753 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3754 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3755 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3756 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3757 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3758 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
3759 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3760 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3761 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3762 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3763 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3764 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3765 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3766 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3767 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3768 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3769 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3770 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3771 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3772 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3773 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3774 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3775 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
3776
3777 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3778 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3779 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3780 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3781 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3782 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3783 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3784 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3785 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3786 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3787 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3788 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3789 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3790
3791 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3792 wxEVT_LEFT_UP,
3793 wxEVT_MIDDLE_DOWN,
3794 wxEVT_MIDDLE_UP,
3795 wxEVT_RIGHT_DOWN,
3796 wxEVT_RIGHT_UP,
3797 wxEVT_MOTION,
3798 wxEVT_LEFT_DCLICK,
3799 wxEVT_MIDDLE_DCLICK,
3800 wxEVT_RIGHT_DCLICK,
3801 wxEVT_ENTER_WINDOW,
3802 wxEVT_LEAVE_WINDOW,
3803 wxEVT_MOUSEWHEEL
3804 ])
3805
3806
3807 # Scrolling from wxWindow (sent to wxScrolledWindow)
3808 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3809 wxEVT_SCROLLWIN_BOTTOM,
3810 wxEVT_SCROLLWIN_LINEUP,
3811 wxEVT_SCROLLWIN_LINEDOWN,
3812 wxEVT_SCROLLWIN_PAGEUP,
3813 wxEVT_SCROLLWIN_PAGEDOWN,
3814 wxEVT_SCROLLWIN_THUMBTRACK,
3815 wxEVT_SCROLLWIN_THUMBRELEASE,
3816 ])
3817
3818 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3819 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3820 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3821 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3822 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3823 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3824 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3825 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3826
3827 # Scrolling from wx.Slider and wx.ScrollBar
3828 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3829 wxEVT_SCROLL_BOTTOM,
3830 wxEVT_SCROLL_LINEUP,
3831 wxEVT_SCROLL_LINEDOWN,
3832 wxEVT_SCROLL_PAGEUP,
3833 wxEVT_SCROLL_PAGEDOWN,
3834 wxEVT_SCROLL_THUMBTRACK,
3835 wxEVT_SCROLL_THUMBRELEASE,
3836 wxEVT_SCROLL_CHANGED,
3837 ])
3838
3839 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3840 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3841 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3842 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3843 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3844 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3845 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3846 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3847 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3848 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3849
3850 # Scrolling from wx.Slider and wx.ScrollBar, with an id
3851 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3852 wxEVT_SCROLL_BOTTOM,
3853 wxEVT_SCROLL_LINEUP,
3854 wxEVT_SCROLL_LINEDOWN,
3855 wxEVT_SCROLL_PAGEUP,
3856 wxEVT_SCROLL_PAGEDOWN,
3857 wxEVT_SCROLL_THUMBTRACK,
3858 wxEVT_SCROLL_THUMBRELEASE,
3859 wxEVT_SCROLL_CHANGED,
3860 ], 1)
3861
3862 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3863 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3864 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3865 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3866 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3867 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3868 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3869 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3870 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3871 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
3872
3873 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3874 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3875 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3876 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3877 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3878 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3879 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3880 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3881 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3882 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3883
3884 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3885 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3886 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3887 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3888 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3889 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3890 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3891 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3892 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3893
3894
3895 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3896 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3897 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3898 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3899 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3900 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3901 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3902
3903 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3904
3905 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3906 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3907
3908 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3909
3910 EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
3911 EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
3912 EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
3913
3914
3915 #---------------------------------------------------------------------------
3916
3917 class Event(Object):
3918 """
3919 An event is a structure holding information about an event passed to a
3920 callback or member function. wx.Event is an abstract base class for
3921 other event classes
3922 """
3923 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3924 def __init__(self): raise AttributeError, "No constructor defined"
3925 __repr__ = _swig_repr
3926 __swig_destroy__ = _core_.delete_Event
3927 __del__ = lambda self : None;
3928 def SetEventType(*args, **kwargs):
3929 """
3930 SetEventType(self, EventType typ)
3931
3932 Sets the specific type of the event.
3933 """
3934 return _core_.Event_SetEventType(*args, **kwargs)
3935
3936 def GetEventType(*args, **kwargs):
3937 """
3938 GetEventType(self) -> EventType
3939
3940 Returns the identifier of the given event type, such as
3941 ``wxEVT_COMMAND_BUTTON_CLICKED``.
3942 """
3943 return _core_.Event_GetEventType(*args, **kwargs)
3944
3945 def GetEventObject(*args, **kwargs):
3946 """
3947 GetEventObject(self) -> Object
3948
3949 Returns the object (usually a window) associated with the event, if
3950 any.
3951 """
3952 return _core_.Event_GetEventObject(*args, **kwargs)
3953
3954 def SetEventObject(*args, **kwargs):
3955 """
3956 SetEventObject(self, Object obj)
3957
3958 Sets the originating object, or in other words, obj is normally the
3959 object that is sending the event.
3960 """
3961 return _core_.Event_SetEventObject(*args, **kwargs)
3962
3963 def GetTimestamp(*args, **kwargs):
3964 """GetTimestamp(self) -> long"""
3965 return _core_.Event_GetTimestamp(*args, **kwargs)
3966
3967 def SetTimestamp(*args, **kwargs):
3968 """SetTimestamp(self, long ts=0)"""
3969 return _core_.Event_SetTimestamp(*args, **kwargs)
3970
3971 def GetId(*args, **kwargs):
3972 """
3973 GetId(self) -> int
3974
3975 Returns the identifier associated with this event, such as a button
3976 command id.
3977 """
3978 return _core_.Event_GetId(*args, **kwargs)
3979
3980 def SetId(*args, **kwargs):
3981 """
3982 SetId(self, int Id)
3983
3984 Set's the ID for the event. This is usually the ID of the window that
3985 is sending the event, but it can also be a command id from a menu
3986 item, etc.
3987 """
3988 return _core_.Event_SetId(*args, **kwargs)
3989
3990 def IsCommandEvent(*args, **kwargs):
3991 """
3992 IsCommandEvent(self) -> bool
3993
3994 Returns true if the event is or is derived from `wx.CommandEvent` else
3995 it returns false. Note: Exists only for optimization purposes.
3996 """
3997 return _core_.Event_IsCommandEvent(*args, **kwargs)
3998
3999 def Skip(*args, **kwargs):
4000 """
4001 Skip(self, bool skip=True)
4002
4003 Called by an event handler, it controls whether additional event
4004 handlers bound to this event will be called after the current event
4005 handler returns. Skip(false) (the default setting) will prevent
4006 additional event handlers from being called and control will be
4007 returned to the sender of the event immediately after the current
4008 handler has finished. Skip(True) will cause the event processing
4009 system to continue searching for a handler function for this event.
4010
4011 """
4012 return _core_.Event_Skip(*args, **kwargs)
4013
4014 def GetSkipped(*args, **kwargs):
4015 """
4016 GetSkipped(self) -> bool
4017
4018 Returns true if the event handler should be skipped, false otherwise.
4019 :see: `Skip`
4020 """
4021 return _core_.Event_GetSkipped(*args, **kwargs)
4022
4023 def ShouldPropagate(*args, **kwargs):
4024 """
4025 ShouldPropagate(self) -> bool
4026
4027 Test if this event should be propagated to the parent window or not,
4028 i.e. if the propagation level is currently greater than 0.
4029 """
4030 return _core_.Event_ShouldPropagate(*args, **kwargs)
4031
4032 def StopPropagation(*args, **kwargs):
4033 """
4034 StopPropagation(self) -> int
4035
4036 Stop the event from propagating to its parent window. Returns the old
4037 propagation level value which may be later passed to
4038 `ResumePropagation` to allow propagating the event again.
4039 """
4040 return _core_.Event_StopPropagation(*args, **kwargs)
4041
4042 def ResumePropagation(*args, **kwargs):
4043 """
4044 ResumePropagation(self, int propagationLevel)
4045
4046 Resume the event propagation by restoring the propagation level. (For
4047 example, you can use the value returned by an earlier call to
4048 `StopPropagation`.)
4049
4050 """
4051 return _core_.Event_ResumePropagation(*args, **kwargs)
4052
4053 def Clone(*args, **kwargs):
4054 """Clone(self) -> Event"""
4055 return _core_.Event_Clone(*args, **kwargs)
4056
4057 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4058 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4059 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4060 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4061 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
4062 _core_.Event_swigregister(Event)
4063
4064 #---------------------------------------------------------------------------
4065
4066 class PropagationDisabler(object):
4067 """
4068 Helper class to temporarily change an event not to propagate. Simply
4069 create an instance of this class and then whe it is destroyed the
4070 propogation of the event will be restored.
4071 """
4072 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4073 __repr__ = _swig_repr
4074 def __init__(self, *args, **kwargs):
4075 """
4076 __init__(self, Event event) -> PropagationDisabler
4077
4078 Helper class to temporarily change an event not to propagate. Simply
4079 create an instance of this class and then whe it is destroyed the
4080 propogation of the event will be restored.
4081 """
4082 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4083 __swig_destroy__ = _core_.delete_PropagationDisabler
4084 __del__ = lambda self : None;
4085 _core_.PropagationDisabler_swigregister(PropagationDisabler)
4086
4087 class PropagateOnce(object):
4088 """
4089 A helper class that will temporarily lower propagation level of an
4090 event. Simply create an instance of this class and then whe it is
4091 destroyed the propogation of the event will be restored.
4092 """
4093 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4094 __repr__ = _swig_repr
4095 def __init__(self, *args, **kwargs):
4096 """
4097 __init__(self, Event event) -> PropagateOnce
4098
4099 A helper class that will temporarily lower propagation level of an
4100 event. Simply create an instance of this class and then whe it is
4101 destroyed the propogation of the event will be restored.
4102 """
4103 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4104 __swig_destroy__ = _core_.delete_PropagateOnce
4105 __del__ = lambda self : None;
4106 _core_.PropagateOnce_swigregister(PropagateOnce)
4107
4108 #---------------------------------------------------------------------------
4109
4110 class CommandEvent(Event):
4111 """
4112 This event class contains information about command events, which
4113 originate from a variety of simple controls, as well as menus and
4114 toolbars.
4115 """
4116 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4117 __repr__ = _swig_repr
4118 def __init__(self, *args, **kwargs):
4119 """
4120 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4121
4122 This event class contains information about command events, which
4123 originate from a variety of simple controls, as well as menus and
4124 toolbars.
4125 """
4126 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4127 def GetSelection(*args, **kwargs):
4128 """
4129 GetSelection(self) -> int
4130
4131 Returns item index for a listbox or choice selection event (not valid
4132 for a deselection).
4133 """
4134 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4135
4136 def SetString(*args, **kwargs):
4137 """SetString(self, String s)"""
4138 return _core_.CommandEvent_SetString(*args, **kwargs)
4139
4140 def GetString(*args, **kwargs):
4141 """
4142 GetString(self) -> String
4143
4144 Returns item string for a listbox or choice selection event (not valid
4145 for a deselection).
4146 """
4147 return _core_.CommandEvent_GetString(*args, **kwargs)
4148
4149 def IsChecked(*args, **kwargs):
4150 """
4151 IsChecked(self) -> bool
4152
4153 This method can be used with checkbox and menu events: for the
4154 checkboxes, the method returns true for a selection event and false
4155 for a deselection one. For the menu events, this method indicates if
4156 the menu item just has become checked or unchecked (and thus only
4157 makes sense for checkable menu items).
4158 """
4159 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4160
4161 Checked = IsChecked
4162 def IsSelection(*args, **kwargs):
4163 """
4164 IsSelection(self) -> bool
4165
4166 For a listbox or similar event, returns true if it is a selection,
4167 false if it is a deselection.
4168 """
4169 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4170
4171 def SetExtraLong(*args, **kwargs):
4172 """SetExtraLong(self, long extraLong)"""
4173 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4174
4175 def GetExtraLong(*args, **kwargs):
4176 """
4177 GetExtraLong(self) -> long
4178
4179 Returns extra information dependant on the event objects type. If the
4180 event comes from a listbox selection, it is a boolean determining
4181 whether the event was a selection (true) or a deselection (false). A
4182 listbox deselection only occurs for multiple-selection boxes, and in
4183 this case the index and string values are indeterminate and the
4184 listbox must be examined by the application.
4185 """
4186 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4187
4188 def SetInt(*args, **kwargs):
4189 """SetInt(self, int i)"""
4190 return _core_.CommandEvent_SetInt(*args, **kwargs)
4191
4192 def GetInt(*args, **kwargs):
4193 """
4194 GetInt(self) -> int
4195
4196 Returns the integer identifier corresponding to a listbox, choice or
4197 radiobox selection (only if the event was a selection, not a
4198 deselection), or a boolean value representing the value of a checkbox.
4199 """
4200 return _core_.CommandEvent_GetInt(*args, **kwargs)
4201
4202 def GetClientData(*args, **kwargs):
4203 """
4204 GetClientData(self) -> PyObject
4205
4206 Returns the client data object for a listbox or choice selection event, (if any.)
4207 """
4208 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4209
4210 def SetClientData(*args, **kwargs):
4211 """
4212 SetClientData(self, PyObject clientData)
4213
4214 Associate the given client data with the item at position n.
4215 """
4216 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4217
4218 GetClientObject = GetClientData
4219 SetClientObject = SetClientData
4220
4221 def Clone(*args, **kwargs):
4222 """Clone(self) -> Event"""
4223 return _core_.CommandEvent_Clone(*args, **kwargs)
4224
4225 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4226 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4227 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4228 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4229 Selection = property(GetSelection,doc="See `GetSelection`")
4230 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4231 _core_.CommandEvent_swigregister(CommandEvent)
4232
4233 #---------------------------------------------------------------------------
4234
4235 class NotifyEvent(CommandEvent):
4236 """
4237 An instance of this class (or one of its derived classes) is sent from
4238 a control when the control's state is being changed and the control
4239 allows that change to be prevented from happening. The event handler
4240 can call `Veto` or `Allow` to tell the control what to do.
4241 """
4242 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4243 __repr__ = _swig_repr
4244 def __init__(self, *args, **kwargs):
4245 """
4246 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4247
4248 An instance of this class (or one of its derived classes) is sent from
4249 a control when the control's state is being changed and the control
4250 allows that change to be prevented from happening. The event handler
4251 can call `Veto` or `Allow` to tell the control what to do.
4252 """
4253 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4254 def Veto(*args, **kwargs):
4255 """
4256 Veto(self)
4257
4258 Prevents the change announced by this event from happening.
4259
4260 It is in general a good idea to notify the user about the reasons for
4261 vetoing the change because otherwise the applications behaviour (which
4262 just refuses to do what the user wants) might be quite surprising.
4263 """
4264 return _core_.NotifyEvent_Veto(*args, **kwargs)
4265
4266 def Allow(*args, **kwargs):
4267 """
4268 Allow(self)
4269
4270 This is the opposite of `Veto`: it explicitly allows the event to be
4271 processed. For most events it is not necessary to call this method as
4272 the events are allowed anyhow but some are forbidden by default (this
4273 will be mentioned in the corresponding event description).
4274 """
4275 return _core_.NotifyEvent_Allow(*args, **kwargs)
4276
4277 def IsAllowed(*args, **kwargs):
4278 """
4279 IsAllowed(self) -> bool
4280
4281 Returns true if the change is allowed (`Veto` hasn't been called) or
4282 false otherwise (if it was).
4283 """
4284 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4285
4286 _core_.NotifyEvent_swigregister(NotifyEvent)
4287
4288 #---------------------------------------------------------------------------
4289
4290 class ScrollEvent(CommandEvent):
4291 """
4292 A scroll event holds information about events sent from stand-alone
4293 scrollbars and sliders. Note that scrolled windows do not send
4294 instnaces of this event class, but send the `wx.ScrollWinEvent`
4295 instead.
4296 """
4297 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4298 __repr__ = _swig_repr
4299 def __init__(self, *args, **kwargs):
4300 """
4301 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4302 int orient=0) -> ScrollEvent
4303 """
4304 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4305 def GetOrientation(*args, **kwargs):
4306 """
4307 GetOrientation(self) -> int
4308
4309 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4310 the scrollbar.
4311 """
4312 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4313
4314 def GetPosition(*args, **kwargs):
4315 """
4316 GetPosition(self) -> int
4317
4318 Returns the position of the scrollbar.
4319 """
4320 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4321
4322 def SetOrientation(*args, **kwargs):
4323 """SetOrientation(self, int orient)"""
4324 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4325
4326 def SetPosition(*args, **kwargs):
4327 """SetPosition(self, int pos)"""
4328 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4329
4330 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4331 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4332 _core_.ScrollEvent_swigregister(ScrollEvent)
4333
4334 #---------------------------------------------------------------------------
4335
4336 class ScrollWinEvent(Event):
4337 """
4338 A wx.ScrollWinEvent holds information about scrolling and is sent from
4339 scrolling windows.
4340 """
4341 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4342 __repr__ = _swig_repr
4343 def __init__(self, *args, **kwargs):
4344 """
4345 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4346
4347 A wx.ScrollWinEvent holds information about scrolling and is sent from
4348 scrolling windows.
4349 """
4350 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4351 def GetOrientation(*args, **kwargs):
4352 """
4353 GetOrientation(self) -> int
4354
4355 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4356 the scrollbar.
4357 """
4358 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4359
4360 def GetPosition(*args, **kwargs):
4361 """
4362 GetPosition(self) -> int
4363
4364 Returns the position of the scrollbar for the thumb track and release
4365 events. Note that this field can't be used for the other events, you
4366 need to query the window itself for the current position in that case.
4367 """
4368 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4369
4370 def SetOrientation(*args, **kwargs):
4371 """SetOrientation(self, int orient)"""
4372 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4373
4374 def SetPosition(*args, **kwargs):
4375 """SetPosition(self, int pos)"""
4376 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4377
4378 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4379 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4380 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4381
4382 #---------------------------------------------------------------------------
4383
4384 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4385 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4386 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4387 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4388 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4389 class MouseEvent(Event):
4390 """
4391 This event class contains information about the events generated by
4392 the mouse: they include mouse buttons press and release events and
4393 mouse move events.
4394
4395 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4396 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4397 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4398 a middle button so a portable application should avoid relying on the
4399 events from it.
4400
4401 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4402 the former returns true when the event corresponds to the left mouse
4403 button click while the latter returns true if the left mouse button is
4404 currently being pressed. For example, when the user is dragging the
4405 mouse you can use `LeftIsDown` to test whether the left mouse button
4406 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4407 `LeftIsDown` will also return true in wxWidgets whatever the
4408 underlying GUI behaviour is (which is platform-dependent). The same
4409 applies, of course, to other mouse buttons as well.
4410 """
4411 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4412 __repr__ = _swig_repr
4413 def __init__(self, *args, **kwargs):
4414 """
4415 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4416
4417 Constructs a wx.MouseEvent. Valid event types are:
4418
4419 * wxEVT_ENTER_WINDOW
4420 * wxEVT_LEAVE_WINDOW
4421 * wxEVT_LEFT_DOWN
4422 * wxEVT_LEFT_UP
4423 * wxEVT_LEFT_DCLICK
4424 * wxEVT_MIDDLE_DOWN
4425 * wxEVT_MIDDLE_UP
4426 * wxEVT_MIDDLE_DCLICK
4427 * wxEVT_RIGHT_DOWN
4428 * wxEVT_RIGHT_UP
4429 * wxEVT_RIGHT_DCLICK
4430 * wxEVT_MOTION
4431 * wxEVT_MOUSEWHEEL
4432 """
4433 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4434 def IsButton(*args, **kwargs):
4435 """
4436 IsButton(self) -> bool
4437
4438 Returns true if the event was a mouse button event (not necessarily a
4439 button down event - that may be tested using `ButtonDown`).
4440 """
4441 return _core_.MouseEvent_IsButton(*args, **kwargs)
4442
4443 def ButtonDown(*args, **kwargs):
4444 """
4445 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4446
4447 If the argument is omitted, this returns true if the event was any
4448 mouse button down event. Otherwise the argument specifies which
4449 button-down event shold be checked for (see `Button` for the possible
4450 values).
4451 """
4452 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4453
4454 def ButtonDClick(*args, **kwargs):
4455 """
4456 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4457
4458 If the argument is omitted, this returns true if the event was any
4459 mouse double click event. Otherwise the argument specifies which
4460 double click event to check for (see `Button` for the possible
4461 values).
4462 """
4463 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4464
4465 def ButtonUp(*args, **kwargs):
4466 """
4467 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4468
4469 If the argument is omitted, this returns true if the event was any
4470 mouse button up event. Otherwise the argument specifies which button
4471 up event to check for (see `Button` for the possible values).
4472 """
4473 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4474
4475 def Button(*args, **kwargs):
4476 """
4477 Button(self, int button) -> bool
4478
4479 Returns true if the identified mouse button is changing state. Valid
4480 values of button are:
4481
4482 ==================== =====================================
4483 wx.MOUSE_BTN_LEFT check if left button was pressed
4484 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4485 wx.MOUSE_BTN_RIGHT check if right button was pressed
4486 wx.MOUSE_BTN_ANY check if any button was pressed
4487 ==================== =====================================
4488
4489 """
4490 return _core_.MouseEvent_Button(*args, **kwargs)
4491
4492 def ButtonIsDown(*args, **kwargs):
4493 """ButtonIsDown(self, int but) -> bool"""
4494 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4495
4496 def GetButton(*args, **kwargs):
4497 """
4498 GetButton(self) -> int
4499
4500 Returns the mouse button which generated this event or
4501 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4502 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4503 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4504 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4505 right buttons respectively.
4506 """
4507 return _core_.MouseEvent_GetButton(*args, **kwargs)
4508
4509 def ControlDown(*args, **kwargs):
4510 """
4511 ControlDown(self) -> bool
4512
4513 Returns true if the control key was down at the time of the event.
4514 """
4515 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4516
4517 def MetaDown(*args, **kwargs):
4518 """
4519 MetaDown(self) -> bool
4520
4521 Returns true if the Meta key was down at the time of the event.
4522 """
4523 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4524
4525 def AltDown(*args, **kwargs):
4526 """
4527 AltDown(self) -> bool
4528
4529 Returns true if the Alt key was down at the time of the event.
4530 """
4531 return _core_.MouseEvent_AltDown(*args, **kwargs)
4532
4533 def ShiftDown(*args, **kwargs):
4534 """
4535 ShiftDown(self) -> bool
4536
4537 Returns true if the Shift key was down at the time of the event.
4538 """
4539 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4540
4541 def CmdDown(*args, **kwargs):
4542 """
4543 CmdDown(self) -> bool
4544
4545 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4546 platforms but the special "Apple" (a.k.a as "Command") key on
4547 Macs. It often makes sense to use it instead of, say, `ControlDown`
4548 because Cmd key is used for the same thing under Mac as Ctrl
4549 elsewhere. The Ctrl key still exists, it's just not used for this
4550 purpose. So for non-Mac platforms this is the same as `ControlDown`
4551 and Macs this is the same as `MetaDown`.
4552 """
4553 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4554
4555 def LeftDown(*args, **kwargs):
4556 """
4557 LeftDown(self) -> bool
4558
4559 Returns true if the left mouse button state changed to down.
4560 """
4561 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4562
4563 def MiddleDown(*args, **kwargs):
4564 """
4565 MiddleDown(self) -> bool
4566
4567 Returns true if the middle mouse button state changed to down.
4568 """
4569 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4570
4571 def RightDown(*args, **kwargs):
4572 """
4573 RightDown(self) -> bool
4574
4575 Returns true if the right mouse button state changed to down.
4576 """
4577 return _core_.MouseEvent_RightDown(*args, **kwargs)
4578
4579 def LeftUp(*args, **kwargs):
4580 """
4581 LeftUp(self) -> bool
4582
4583 Returns true if the left mouse button state changed to up.
4584 """
4585 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4586
4587 def MiddleUp(*args, **kwargs):
4588 """
4589 MiddleUp(self) -> bool
4590
4591 Returns true if the middle mouse button state changed to up.
4592 """
4593 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4594
4595 def RightUp(*args, **kwargs):
4596 """
4597 RightUp(self) -> bool
4598
4599 Returns true if the right mouse button state changed to up.
4600 """
4601 return _core_.MouseEvent_RightUp(*args, **kwargs)
4602
4603 def LeftDClick(*args, **kwargs):
4604 """
4605 LeftDClick(self) -> bool
4606
4607 Returns true if the event was a left button double click.
4608 """
4609 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4610
4611 def MiddleDClick(*args, **kwargs):
4612 """
4613 MiddleDClick(self) -> bool
4614
4615 Returns true if the event was a middle button double click.
4616 """
4617 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4618
4619 def RightDClick(*args, **kwargs):
4620 """
4621 RightDClick(self) -> bool
4622
4623 Returns true if the event was a right button double click.
4624 """
4625 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4626
4627 def LeftIsDown(*args, **kwargs):
4628 """
4629 LeftIsDown(self) -> bool
4630
4631 Returns true if the left mouse button is currently down, independent
4632 of the current event type.
4633
4634 Please notice that it is not the same as LeftDown which returns true
4635 if the left mouse button was just pressed. Rather, it describes the
4636 state of the mouse button before the event happened.
4637
4638 This event is usually used in the mouse event handlers which process
4639 "move mouse" messages to determine whether the user is (still)
4640 dragging the mouse.
4641 """
4642 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4643
4644 def MiddleIsDown(*args, **kwargs):
4645 """
4646 MiddleIsDown(self) -> bool
4647
4648 Returns true if the middle mouse button is currently down, independent
4649 of the current event type.
4650 """
4651 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4652
4653 def RightIsDown(*args, **kwargs):
4654 """
4655 RightIsDown(self) -> bool
4656
4657 Returns true if the right mouse button is currently down, independent
4658 of the current event type.
4659 """
4660 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4661
4662 def Dragging(*args, **kwargs):
4663 """
4664 Dragging(self) -> bool
4665
4666 Returns true if this was a dragging event (motion while a button is
4667 depressed).
4668 """
4669 return _core_.MouseEvent_Dragging(*args, **kwargs)
4670
4671 def Moving(*args, **kwargs):
4672 """
4673 Moving(self) -> bool
4674
4675 Returns true if this was a motion event and no mouse buttons were
4676 pressed. If any mouse button is held pressed, then this method returns
4677 false and Dragging returns true.
4678 """
4679 return _core_.MouseEvent_Moving(*args, **kwargs)
4680
4681 def Entering(*args, **kwargs):
4682 """
4683 Entering(self) -> bool
4684
4685 Returns true if the mouse was entering the window.
4686 """
4687 return _core_.MouseEvent_Entering(*args, **kwargs)
4688
4689 def Leaving(*args, **kwargs):
4690 """
4691 Leaving(self) -> bool
4692
4693 Returns true if the mouse was leaving the window.
4694 """
4695 return _core_.MouseEvent_Leaving(*args, **kwargs)
4696
4697 def GetPosition(*args, **kwargs):
4698 """
4699 GetPosition(self) -> Point
4700
4701 Returns the pixel position of the mouse in window coordinates when the
4702 event happened.
4703 """
4704 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4705
4706 def GetPositionTuple(*args, **kwargs):
4707 """
4708 GetPositionTuple() -> (x,y)
4709
4710 Returns the pixel position of the mouse in window coordinates when the
4711 event happened.
4712 """
4713 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4714
4715 def GetLogicalPosition(*args, **kwargs):
4716 """
4717 GetLogicalPosition(self, DC dc) -> Point
4718
4719 Returns the logical mouse position in pixels (i.e. translated
4720 according to the translation set for the DC, which usually indicates
4721 that the window has been scrolled).
4722 """
4723 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4724
4725 def GetX(*args, **kwargs):
4726 """
4727 GetX(self) -> int
4728
4729 Returns X coordinate of the physical mouse event position.
4730 """
4731 return _core_.MouseEvent_GetX(*args, **kwargs)
4732
4733 def GetY(*args, **kwargs):
4734 """
4735 GetY(self) -> int
4736
4737 Returns Y coordinate of the physical mouse event position.
4738 """
4739 return _core_.MouseEvent_GetY(*args, **kwargs)
4740
4741 def GetWheelRotation(*args, **kwargs):
4742 """
4743 GetWheelRotation(self) -> int
4744
4745 Get wheel rotation, positive or negative indicates direction of
4746 rotation. Current devices all send an event when rotation is equal to
4747 +/-WheelDelta, but this allows for finer resolution devices to be
4748 created in the future. Because of this you shouldn't assume that one
4749 event is equal to 1 line or whatever, but you should be able to either
4750 do partial line scrolling or wait until +/-WheelDelta rotation values
4751 have been accumulated before scrolling.
4752 """
4753 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4754
4755 def GetWheelDelta(*args, **kwargs):
4756 """
4757 GetWheelDelta(self) -> int
4758
4759 Get wheel delta, normally 120. This is the threshold for action to be
4760 taken, and one such action (for example, scrolling one increment)
4761 should occur for each delta.
4762 """
4763 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4764
4765 def GetLinesPerAction(*args, **kwargs):
4766 """
4767 GetLinesPerAction(self) -> int
4768
4769 Returns the configured number of lines (or whatever) to be scrolled
4770 per wheel action. Defaults to three.
4771 """
4772 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4773
4774 def IsPageScroll(*args, **kwargs):
4775 """
4776 IsPageScroll(self) -> bool
4777
4778 Returns true if the system has been setup to do page scrolling with
4779 the mouse wheel instead of line scrolling.
4780 """
4781 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4782
4783 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4784 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4785 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4786 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4787 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4788 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4789 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4790 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4791 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4792 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4793 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4794 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4795 Button = property(GetButton,doc="See `GetButton`")
4796 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
4797 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
4798 Position = property(GetPosition,doc="See `GetPosition`")
4799 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
4800 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
4801 X = property(GetX,doc="See `GetX`")
4802 Y = property(GetY,doc="See `GetY`")
4803 _core_.MouseEvent_swigregister(MouseEvent)
4804
4805 #---------------------------------------------------------------------------
4806
4807 class SetCursorEvent(Event):
4808 """
4809 A SetCursorEvent is generated when the mouse cursor is about to be set
4810 as a result of mouse motion. This event gives the application the
4811 chance to perform specific mouse cursor processing based on the
4812 current position of the mouse within the window. Use the `SetCursor`
4813 method to specify the cursor you want to be displayed.
4814 """
4815 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4816 __repr__ = _swig_repr
4817 def __init__(self, *args, **kwargs):
4818 """
4819 __init__(self, int x=0, int y=0) -> SetCursorEvent
4820
4821 Construct a new `wx.SetCursorEvent`.
4822 """
4823 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
4824 def GetX(*args, **kwargs):
4825 """
4826 GetX(self) -> int
4827
4828 Returns the X coordinate of the mouse in client coordinates.
4829 """
4830 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4831
4832 def GetY(*args, **kwargs):
4833 """
4834 GetY(self) -> int
4835
4836 Returns the Y coordinate of the mouse in client coordinates.
4837 """
4838 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4839
4840 def SetCursor(*args, **kwargs):
4841 """
4842 SetCursor(self, Cursor cursor)
4843
4844 Sets the cursor associated with this event.
4845 """
4846 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4847
4848 def GetCursor(*args, **kwargs):
4849 """
4850 GetCursor(self) -> Cursor
4851
4852 Returns a reference to the cursor specified by this event.
4853 """
4854 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4855
4856 def HasCursor(*args, **kwargs):
4857 """
4858 HasCursor(self) -> bool
4859
4860 Returns true if the cursor specified by this event is a valid cursor.
4861 """
4862 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4863
4864 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
4865 X = property(GetX,doc="See `GetX`")
4866 Y = property(GetY,doc="See `GetY`")
4867 _core_.SetCursorEvent_swigregister(SetCursorEvent)
4868
4869 #---------------------------------------------------------------------------
4870
4871 class KeyEvent(Event):
4872 """
4873 This event class contains information about keypress and character
4874 events. These events are only sent to the widget that currently has
4875 the keyboard focus.
4876
4877 Notice that there are three different kinds of keyboard events in
4878 wxWidgets: key down and up events and char events. The difference
4879 between the first two is clear - the first corresponds to a key press
4880 and the second to a key release - otherwise they are identical. Just
4881 note that if the key is maintained in a pressed state you will
4882 typically get a lot of (automatically generated) down events but only
4883 one up so it is wrong to assume that there is one up event
4884 corresponding to each down one.
4885
4886 Both key events provide untranslated key codes while the char event
4887 carries the translated one. The untranslated code for alphanumeric
4888 keys is always an upper case value. For the other keys it is one of
4889 WXK_XXX values from the keycodes table. The translated key is, in
4890 general, the character the user expects to appear as the result of the
4891 key combination when typing the text into a text entry zone, for
4892 example.
4893
4894 A few examples to clarify this (all assume that CAPS LOCK is unpressed
4895 and the standard US keyboard): when the 'A' key is pressed, the key
4896 down event key code is equal to ASCII A == 65. But the char event key
4897 code is ASCII a == 97. On the other hand, if you press both SHIFT and
4898 'A' keys simultaneously , the key code in key down event will still be
4899 just 'A' while the char event key code parameter will now be 'A' as
4900 well.
4901
4902 Although in this simple case it is clear that the correct key code
4903 could be found in the key down event handler by checking the value
4904 returned by `ShiftDown`, in general you should use EVT_CHAR for this
4905 as for non alphanumeric keys or non-US keyboard layouts the
4906 translation is keyboard-layout dependent and can only be done properly
4907 by the system itself.
4908
4909 Another kind of translation is done when the control key is pressed:
4910 for example, for CTRL-A key press the key down event still carries the
4911 same key code 'A' as usual but the char event will have key code of 1,
4912 the ASCII value of this key combination.
4913
4914 You may discover how the other keys on your system behave
4915 interactively by running the KeyEvents sample in the wxPython demo and
4916 pressing some keys while the blue box at the top has the keyboard
4917 focus.
4918
4919 **Note**: If a key down event is caught and the event handler does not
4920 call event.Skip() then the coresponding char event will not
4921 happen. This is by design and enables the programs that handle both
4922 types of events to be a bit simpler.
4923
4924 **Note for Windows programmers**: The key and char events in wxWidgets
4925 are similar to but slightly different from Windows WM_KEYDOWN and
4926 WM_CHAR events. In particular, Alt-x combination will generate a char
4927 event in wxWidgets (unless it is used as an accelerator).
4928
4929 **Tip**: be sure to call event.Skip() for events that you don't
4930 process in key event function, otherwise menu shortcuts may cease to
4931 work under Windows.
4932
4933 """
4934 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4935 __repr__ = _swig_repr
4936 def __init__(self, *args, **kwargs):
4937 """
4938 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
4939
4940 Construct a new `wx.KeyEvent`. Valid event types are:
4941 *
4942 """
4943 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
4944 def GetModifiers(*args, **kwargs):
4945 """
4946 GetModifiers(self) -> int
4947
4948 Returns a bitmask of the current modifier settings. Can be used to
4949 check if the key event has exactly the given modifiers without having
4950 to explicitly check that the other modifiers are not down. For
4951 example::
4952
4953 if event.GetModifers() == wx.MOD_CONTROL:
4954 DoSomething()
4955
4956 """
4957 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
4958
4959 def ControlDown(*args, **kwargs):
4960 """
4961 ControlDown(self) -> bool
4962
4963 Returns ``True`` if the Control key was down at the time of the event.
4964 """
4965 return _core_.KeyEvent_ControlDown(*args, **kwargs)
4966
4967 def MetaDown(*args, **kwargs):
4968 """
4969 MetaDown(self) -> bool
4970
4971 Returns ``True`` if the Meta key was down at the time of the event.
4972 """
4973 return _core_.KeyEvent_MetaDown(*args, **kwargs)
4974
4975 def AltDown(*args, **kwargs):
4976 """
4977 AltDown(self) -> bool
4978
4979 Returns ``True`` if the Alt key was down at the time of the event.
4980 """
4981 return _core_.KeyEvent_AltDown(*args, **kwargs)
4982
4983 def ShiftDown(*args, **kwargs):
4984 """
4985 ShiftDown(self) -> bool
4986
4987 Returns ``True`` if the Shift key was down at the time of the event.
4988 """
4989 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
4990
4991 def CmdDown(*args, **kwargs):
4992 """
4993 CmdDown(self) -> bool
4994
4995 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4996 platforms but the special "Apple" (a.k.a as "Command") key on
4997 Macs. It makes often sense to use it instead of, say, `ControlDown`
4998 because Cmd key is used for the same thing under Mac as Ctrl
4999 elsewhere. The Ctrl still exists, it's just not used for this
5000 purpose. So for non-Mac platforms this is the same as `ControlDown`
5001 and Macs this is the same as `MetaDown`.
5002 """
5003 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5004
5005 def HasModifiers(*args, **kwargs):
5006 """
5007 HasModifiers(self) -> bool
5008
5009 Returns true if either CTRL or ALT keys was down at the time of the
5010 key event. Note that this function does not take into account neither
5011 SHIFT nor META key states (the reason for ignoring the latter is that
5012 it is common for NUMLOCK key to be configured as META under X but the
5013 key presses even while NUMLOCK is on should be still processed
5014 normally).
5015 """
5016 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5017
5018 def GetKeyCode(*args, **kwargs):
5019 """
5020 GetKeyCode(self) -> int
5021
5022 Returns the virtual key code. ASCII events return normal ASCII values,
5023 while non-ASCII events return values such as WXK_LEFT for the left
5024 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5025 codes.
5026
5027 Note that in Unicode build, the returned value is meaningful only if
5028 the user entered a character that can be represented in current
5029 locale's default charset. You can obtain the corresponding Unicode
5030 character using `GetUnicodeKey`.
5031 """
5032 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5033
5034 def GetUnicodeKey(*args, **kwargs):
5035 """
5036 GetUnicodeKey(self) -> int
5037
5038 Returns the Unicode character corresponding to this key event. This
5039 function is only meaningfule in a Unicode build of wxPython.
5040 """
5041 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
5042
5043 GetUniChar = GetUnicodeKey
5044 def SetUnicodeKey(*args, **kwargs):
5045 """
5046 SetUnicodeKey(self, int uniChar)
5047
5048 Set the Unicode value of the key event, but only if this is a Unicode
5049 build of wxPython.
5050 """
5051 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5052
5053 def GetRawKeyCode(*args, **kwargs):
5054 """
5055 GetRawKeyCode(self) -> unsigned int
5056
5057 Returns the raw key code for this event. This is a platform-dependent
5058 scan code which should only be used in advanced
5059 applications. Currently the raw key codes are not supported by all
5060 ports.
5061 """
5062 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5063
5064 def GetRawKeyFlags(*args, **kwargs):
5065 """
5066 GetRawKeyFlags(self) -> unsigned int
5067
5068 Returns the low level key flags for this event. The flags are
5069 platform-dependent and should only be used in advanced applications.
5070 Currently the raw key flags are not supported by all ports.
5071 """
5072 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5073
5074 def GetPosition(*args, **kwargs):
5075 """
5076 GetPosition(self) -> Point
5077
5078 Find the position of the event, if applicable.
5079 """
5080 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5081
5082 def GetPositionTuple(*args, **kwargs):
5083 """
5084 GetPositionTuple() -> (x,y)
5085
5086 Find the position of the event, if applicable.
5087 """
5088 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5089
5090 def GetX(*args, **kwargs):
5091 """
5092 GetX(self) -> int
5093
5094 Returns the X position (in client coordinates) of the event, if
5095 applicable.
5096 """
5097 return _core_.KeyEvent_GetX(*args, **kwargs)
5098
5099 def GetY(*args, **kwargs):
5100 """
5101 GetY(self) -> int
5102
5103 Returns the Y position (in client coordinates) of the event, if
5104 applicable.
5105 """
5106 return _core_.KeyEvent_GetY(*args, **kwargs)
5107
5108 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5109 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5110 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5111 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5112 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5113 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5114 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5115 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5116 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5117 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5118 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5119 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5120 Position = property(GetPosition,doc="See `GetPosition`")
5121 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5122 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5123 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5124 X = property(GetX,doc="See `GetX`")
5125 Y = property(GetY,doc="See `GetY`")
5126 _core_.KeyEvent_swigregister(KeyEvent)
5127
5128 #---------------------------------------------------------------------------
5129
5130 class SizeEvent(Event):
5131 """
5132 A size event holds information about size change events. The EVT_SIZE
5133 handler function will be called when the window it is bound to has
5134 been resized.
5135
5136 Note that the size passed is of the whole window: call
5137 `wx.Window.GetClientSize` for the area which may be used by the
5138 application.
5139
5140 When a window is resized, usually only a small part of the window is
5141 damaged and and that area is all that is in the update region for the
5142 next paint event. However, if your drawing depends on the size of the
5143 window, you may need to clear the DC explicitly and repaint the whole
5144 window. In which case, you may need to call `wx.Window.Refresh` to
5145 invalidate the entire window.
5146
5147 """
5148 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5149 __repr__ = _swig_repr
5150 def __init__(self, *args, **kwargs):
5151 """
5152 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5153
5154 Construct a new ``wx.SizeEvent``.
5155 """
5156 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5157 def GetSize(*args, **kwargs):
5158 """
5159 GetSize(self) -> Size
5160
5161 Returns the entire size of the window generating the size change
5162 event.
5163 """
5164 return _core_.SizeEvent_GetSize(*args, **kwargs)
5165
5166 def GetRect(*args, **kwargs):
5167 """GetRect(self) -> Rect"""
5168 return _core_.SizeEvent_GetRect(*args, **kwargs)
5169
5170 def SetRect(*args, **kwargs):
5171 """SetRect(self, Rect rect)"""
5172 return _core_.SizeEvent_SetRect(*args, **kwargs)
5173
5174 def SetSize(*args, **kwargs):
5175 """SetSize(self, Size size)"""
5176 return _core_.SizeEvent_SetSize(*args, **kwargs)
5177
5178 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5179 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5180 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5181 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5182 _core_.SizeEvent_swigregister(SizeEvent)
5183
5184 #---------------------------------------------------------------------------
5185
5186 class MoveEvent(Event):
5187 """
5188 This event object is sent for EVT_MOVE event bindings when a window is
5189 moved to a new position.
5190 """
5191 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5192 __repr__ = _swig_repr
5193 def __init__(self, *args, **kwargs):
5194 """
5195 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5196
5197 Constructor.
5198 """
5199 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5200 def GetPosition(*args, **kwargs):
5201 """
5202 GetPosition(self) -> Point
5203
5204 Returns the position of the window generating the move change event.
5205 """
5206 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5207
5208 def GetRect(*args, **kwargs):
5209 """GetRect(self) -> Rect"""
5210 return _core_.MoveEvent_GetRect(*args, **kwargs)
5211
5212 def SetRect(*args, **kwargs):
5213 """SetRect(self, Rect rect)"""
5214 return _core_.MoveEvent_SetRect(*args, **kwargs)
5215
5216 def SetPosition(*args, **kwargs):
5217 """SetPosition(self, Point pos)"""
5218 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5219
5220 m_pos = property(GetPosition, SetPosition)
5221 m_rect = property(GetRect, SetRect)
5222
5223 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5224 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5225 _core_.MoveEvent_swigregister(MoveEvent)
5226
5227 #---------------------------------------------------------------------------
5228
5229 class PaintEvent(Event):
5230 """
5231 A paint event is sent when a window's contents needs to be repainted.
5232 Note that in an EVT_PAINT handler the application must *always* create
5233 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5234 Windows assumes that the window has not been painted yet and will send
5235 the event again, causing endless refreshes.
5236
5237 You can optimize painting by retrieving the rectangles that have been
5238 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5239 and only repainting these rectangles. The rectangles are in terms of
5240 the client area, and are unscrolled, so you will need to do some
5241 calculations using the current view position to obtain logical,
5242 scrolled units.
5243
5244 """
5245 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5246 __repr__ = _swig_repr
5247 def __init__(self, *args, **kwargs):
5248 """__init__(self, int Id=0) -> PaintEvent"""
5249 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5250 _core_.PaintEvent_swigregister(PaintEvent)
5251
5252 class NcPaintEvent(Event):
5253 """Proxy of C++ NcPaintEvent class"""
5254 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5255 __repr__ = _swig_repr
5256 def __init__(self, *args, **kwargs):
5257 """__init__(self, int winid=0) -> NcPaintEvent"""
5258 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5259 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5260
5261 #---------------------------------------------------------------------------
5262
5263 class EraseEvent(Event):
5264 """
5265 An erase event is sent whenever the background of a window needs to be
5266 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5267 binder. On some platforms, such as GTK+, this event is simulated
5268 (simply generated just before the paint event) and may cause flicker.
5269
5270 To paint a custom background use the `GetDC` method and use the returned
5271 device context if it is not ``None``, otherwise create a temporary
5272 `wx.ClientDC` and draw on that.
5273
5274 """
5275 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5276 __repr__ = _swig_repr
5277 def __init__(self, *args, **kwargs):
5278 """
5279 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5280
5281 Constructor
5282 """
5283 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5284 def GetDC(*args, **kwargs):
5285 """
5286 GetDC(self) -> DC
5287
5288 Returns the device context the event handler should draw upon. If
5289 ``None`` is returned then create a temporary `wx.ClientDC` and use
5290 that instead.
5291 """
5292 return _core_.EraseEvent_GetDC(*args, **kwargs)
5293
5294 DC = property(GetDC,doc="See `GetDC`")
5295 _core_.EraseEvent_swigregister(EraseEvent)
5296
5297 #---------------------------------------------------------------------------
5298
5299 class FocusEvent(Event):
5300 """
5301 A focus event is sent when a window's focus changes. The window losing
5302 focus receives an EVT_KILL_FOCUS event while the window gaining it
5303 gets an EVT_SET_FOCUS event.
5304
5305 Notice that the set focus event happens both when the user gives focus
5306 to the window (whether using the mouse or keyboard) and when it is
5307 done from the program itself using `wx.Window.SetFocus`.
5308
5309 """
5310 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5311 __repr__ = _swig_repr
5312 def __init__(self, *args, **kwargs):
5313 """
5314 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5315
5316 Constructor
5317 """
5318 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5319 def GetWindow(*args, **kwargs):
5320 """
5321 GetWindow(self) -> Window
5322
5323 Returns the other window associated with this event, that is the
5324 window which had the focus before for the EVT_SET_FOCUS event and the
5325 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5326
5327 Warning: the window returned may be None!
5328 """
5329 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5330
5331 def SetWindow(*args, **kwargs):
5332 """SetWindow(self, Window win)"""
5333 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5334
5335 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5336 _core_.FocusEvent_swigregister(FocusEvent)
5337
5338 #---------------------------------------------------------------------------
5339
5340 class ChildFocusEvent(CommandEvent):
5341 """
5342 A child focus event is sent to a (parent-)window when one of its child
5343 windows gains focus, so that the window could restore the focus back
5344 to its corresponding child if it loses it now and regains later.
5345
5346 Notice that child window is the direct child of the window receiving
5347 the event, and so may not be the actual widget recieving focus if it
5348 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5349 to get the widget that is actually receiving focus.
5350 """
5351 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5352 __repr__ = _swig_repr
5353 def __init__(self, *args, **kwargs):
5354 """
5355 __init__(self, Window win=None) -> ChildFocusEvent
5356
5357 Constructor
5358 """
5359 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5360 def GetWindow(*args, **kwargs):
5361 """
5362 GetWindow(self) -> Window
5363
5364 The window, or (grand)parent of the window which has just received the
5365 focus.
5366 """
5367 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5368
5369 Window = property(GetWindow,doc="See `GetWindow`")
5370 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5371
5372 #---------------------------------------------------------------------------
5373
5374 class ActivateEvent(Event):
5375 """
5376 An activate event is sent when a top-level window or the entire
5377 application is being activated or deactivated.
5378
5379 A top-level window (a dialog or frame) receives an activate event when
5380 is being activated or deactivated. This is indicated visually by the
5381 title bar changing colour, and a subwindow gaining the keyboard focus.
5382 An application is activated or deactivated when one of its frames
5383 becomes activated, or a frame becomes inactivate resulting in all
5384 application frames being inactive.
5385
5386 Please note that usually you should call event.Skip() in your handlers
5387 for these events so the default handlers will still be called, as not
5388 doing so can result in strange effects.
5389
5390 """
5391 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5392 __repr__ = _swig_repr
5393 def __init__(self, *args, **kwargs):
5394 """
5395 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5396
5397 Constructor
5398 """
5399 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5400 def GetActive(*args, **kwargs):
5401 """
5402 GetActive(self) -> bool
5403
5404 Returns true if the application or window is being activated, false
5405 otherwise.
5406 """
5407 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5408
5409 Active = property(GetActive,doc="See `GetActive`")
5410 _core_.ActivateEvent_swigregister(ActivateEvent)
5411
5412 #---------------------------------------------------------------------------
5413
5414 class InitDialogEvent(Event):
5415 """
5416 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5417 any window when `wx.Window.InitDialog` is called. Handlers for this
5418 event can transfer data to the window, or anything else that should be
5419 done before the user begins editing the form. The default handler
5420 calls `wx.Window.TransferDataToWindow`.
5421 """
5422 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5423 __repr__ = _swig_repr
5424 def __init__(self, *args, **kwargs):
5425 """
5426 __init__(self, int Id=0) -> InitDialogEvent
5427
5428 Constructor
5429 """
5430 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5431 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5432
5433 #---------------------------------------------------------------------------
5434
5435 class MenuEvent(Event):
5436 """
5437 This class is used for a variety of menu-related events. Note that
5438 these do not include menu command events, which are handled by sending
5439 `wx.CommandEvent` objects.
5440
5441 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5442 text in the first field of the status bar.
5443 """
5444 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5445 __repr__ = _swig_repr
5446 def __init__(self, *args, **kwargs):
5447 """
5448 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5449
5450 Constructor
5451 """
5452 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5453 def GetMenuId(*args, **kwargs):
5454 """
5455 GetMenuId(self) -> int
5456
5457 Returns the menu identifier associated with the event. This method
5458 should be only used with the HIGHLIGHT events.
5459 """
5460 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5461
5462 def IsPopup(*args, **kwargs):
5463 """
5464 IsPopup(self) -> bool
5465
5466 Returns ``True`` if the menu which is being opened or closed is a
5467 popup menu, ``False`` if it is a normal one. This method should only
5468 be used with the OPEN and CLOSE events.
5469 """
5470 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5471
5472 def GetMenu(*args, **kwargs):
5473 """
5474 GetMenu(self) -> Menu
5475
5476 Returns the menu which is being opened or closed. This method should
5477 only be used with the OPEN and CLOSE events.
5478 """
5479 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5480
5481 Menu = property(GetMenu,doc="See `GetMenu`")
5482 MenuId = property(GetMenuId,doc="See `GetMenuId`")
5483 _core_.MenuEvent_swigregister(MenuEvent)
5484
5485 #---------------------------------------------------------------------------
5486
5487 class CloseEvent(Event):
5488 """
5489 This event class contains information about window and session close
5490 events.
5491
5492 The handler function for EVT_CLOSE is called when the user has tried
5493 to close a a frame or dialog box using the window manager controls or
5494 the system menu. It can also be invoked by the application itself
5495 programmatically, for example by calling the `wx.Window.Close`
5496 function.
5497
5498 You should check whether the application is forcing the deletion of
5499 the window using `CanVeto`. If it returns ``False``, you must destroy
5500 the window using `wx.Window.Destroy`. If the return value is ``True``,
5501 it is up to you whether you respond by destroying the window or not.
5502 For example you may wish to display a message dialog prompting to save
5503 files or to cancel the close.
5504
5505 If you don't destroy the window, you should call `Veto` to let the
5506 calling code know that you did not destroy the window. This allows the
5507 `wx.Window.Close` function to return ``True`` or ``False`` depending
5508 on whether the close instruction was honored or not.
5509 """
5510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5511 __repr__ = _swig_repr
5512 def __init__(self, *args, **kwargs):
5513 """
5514 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5515
5516 Constructor.
5517 """
5518 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5519 def SetLoggingOff(*args, **kwargs):
5520 """
5521 SetLoggingOff(self, bool logOff)
5522
5523 Sets the 'logging off' flag.
5524 """
5525 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5526
5527 def GetLoggingOff(*args, **kwargs):
5528 """
5529 GetLoggingOff(self) -> bool
5530
5531 Returns ``True`` if the user is logging off or ``False`` if the
5532 system is shutting down. This method can only be called for end
5533 session and query end session events, it doesn't make sense for close
5534 window event.
5535 """
5536 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5537
5538 def Veto(*args, **kwargs):
5539 """
5540 Veto(self, bool veto=True)
5541
5542 Call this from your event handler to veto a system shutdown or to
5543 signal to the calling application that a window close did not happen.
5544
5545 You can only veto a shutdown or close if `CanVeto` returns true.
5546 """
5547 return _core_.CloseEvent_Veto(*args, **kwargs)
5548
5549 def GetVeto(*args, **kwargs):
5550 """GetVeto(self) -> bool"""
5551 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5552
5553 def SetCanVeto(*args, **kwargs):
5554 """
5555 SetCanVeto(self, bool canVeto)
5556
5557 Sets the 'can veto' flag.
5558 """
5559 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5560
5561 def CanVeto(*args, **kwargs):
5562 """
5563 CanVeto(self) -> bool
5564
5565 Returns true if you can veto a system shutdown or a window close
5566 event. Vetoing a window close event is not possible if the calling
5567 code wishes to force the application to exit, and so this function
5568 must be called to check this.
5569 """
5570 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5571
5572 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5573 _core_.CloseEvent_swigregister(CloseEvent)
5574
5575 #---------------------------------------------------------------------------
5576
5577 class ShowEvent(Event):
5578 """An EVT_SHOW event is sent when a window is shown or hidden."""
5579 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5580 __repr__ = _swig_repr
5581 def __init__(self, *args, **kwargs):
5582 """
5583 __init__(self, int winid=0, bool show=False) -> ShowEvent
5584
5585 An EVT_SHOW event is sent when a window is shown or hidden.
5586 """
5587 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5588 def SetShow(*args, **kwargs):
5589 """SetShow(self, bool show)"""
5590 return _core_.ShowEvent_SetShow(*args, **kwargs)
5591
5592 def GetShow(*args, **kwargs):
5593 """GetShow(self) -> bool"""
5594 return _core_.ShowEvent_GetShow(*args, **kwargs)
5595
5596 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5597 _core_.ShowEvent_swigregister(ShowEvent)
5598
5599 #---------------------------------------------------------------------------
5600
5601 class IconizeEvent(Event):
5602 """
5603 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5604 restored.
5605 """
5606 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5607 __repr__ = _swig_repr
5608 def __init__(self, *args, **kwargs):
5609 """
5610 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5611
5612 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5613 restored.
5614 """
5615 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5616 def Iconized(*args, **kwargs):
5617 """
5618 Iconized(self) -> bool
5619
5620 Returns ``True`` if the frame has been iconized, ``False`` if it has
5621 been restored.
5622 """
5623 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5624
5625 _core_.IconizeEvent_swigregister(IconizeEvent)
5626
5627 #---------------------------------------------------------------------------
5628
5629 class MaximizeEvent(Event):
5630 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5632 __repr__ = _swig_repr
5633 def __init__(self, *args, **kwargs):
5634 """
5635 __init__(self, int id=0) -> MaximizeEvent
5636
5637 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5638 """
5639 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5640 _core_.MaximizeEvent_swigregister(MaximizeEvent)
5641
5642 #---------------------------------------------------------------------------
5643
5644 class DropFilesEvent(Event):
5645 """
5646 This class is used for drop files events, that is, when files have
5647 been dropped onto the window. This functionality is only available
5648 under Windows. The window must have previously been enabled for
5649 dropping by calling `wx.Window.DragAcceptFiles`.
5650
5651 Important note: this is a separate implementation to the more general
5652 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5653 implementation uses the older, Windows message-based approach of
5654 dropping files.
5655
5656 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5657 events.
5658
5659 """
5660 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5661 def __init__(self): raise AttributeError, "No constructor defined"
5662 __repr__ = _swig_repr
5663 def GetPosition(*args, **kwargs):
5664 """
5665 GetPosition(self) -> Point
5666
5667 Returns the position at which the files were dropped.
5668 """
5669 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5670
5671 def GetNumberOfFiles(*args, **kwargs):
5672 """
5673 GetNumberOfFiles(self) -> int
5674
5675 Returns the number of files dropped.
5676 """
5677 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5678
5679 def GetFiles(*args, **kwargs):
5680 """
5681 GetFiles(self) -> PyObject
5682
5683 Returns a list of the filenames that were dropped.
5684 """
5685 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5686
5687 Files = property(GetFiles,doc="See `GetFiles`")
5688 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5689 Position = property(GetPosition,doc="See `GetPosition`")
5690 _core_.DropFilesEvent_swigregister(DropFilesEvent)
5691
5692 #---------------------------------------------------------------------------
5693
5694 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5695 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5696 class UpdateUIEvent(CommandEvent):
5697 """
5698 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5699 wxWidgets to give an application the chance to update various user
5700 interface elements.
5701
5702 Without update UI events, an application has to work hard to
5703 check/uncheck, enable/disable, and set the text for elements such as
5704 menu items and toolbar buttons. The code for doing this has to be
5705 mixed up with the code that is invoked when an action is invoked for a
5706 menu item or button.
5707
5708 With update UI events, you define an event handler to look at the
5709 state of the application and change UI elements accordingly. wxWidgets
5710 will call your handler functions in idle time, so you don't have to
5711 worry where to call this code. In addition to being a clearer and more
5712 declarative method, it also means you don't have to worry whether
5713 you're updating a toolbar or menubar identifier. The same handler can
5714 update a menu item and toolbar button, if the ID values are the same.
5715
5716 Instead of directly manipulating the menu or button, you call
5717 functions in the event object, such as `Check`. wxWidgets will
5718 determine whether such a call has been made, and which UI element to
5719 update.
5720
5721 These events will work for popup menus as well as menubars. Just
5722 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5723 any UI events for the window that owns the menu.
5724
5725 If you find that the overhead of UI update processing is affecting
5726 your application, you can do one or both of the following:
5727
5728 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5729 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5730 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5731 receive update events. No other windows will receive update
5732 events.
5733
5734 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5735 value to set the delay between updates. You may need to call
5736 `wx.Window.UpdateWindowUI` at critical points, for example when
5737 a dialog is about to be shown, in case the user sees a slight
5738 delay before windows are updated.
5739
5740 Note that although events are sent in idle time, defining a EVT_IDLE
5741 handler for a window does not affect this because the events are sent
5742 from an internal idle handler.
5743
5744 wxWidgets tries to optimize update events on some platforms. On
5745 Windows and GTK+, events for menubar items are only sent when the menu
5746 is about to be shown, and not in idle time.
5747
5748 """
5749 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5750 __repr__ = _swig_repr
5751 def __init__(self, *args, **kwargs):
5752 """
5753 __init__(self, int commandId=0) -> UpdateUIEvent
5754
5755 Constructor
5756 """
5757 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
5758 def GetChecked(*args, **kwargs):
5759 """
5760 GetChecked(self) -> bool
5761
5762 Returns ``True`` if the UI element should be checked.
5763 """
5764 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5765
5766 def GetEnabled(*args, **kwargs):
5767 """
5768 GetEnabled(self) -> bool
5769
5770 Returns ``True`` if the UI element should be enabled.
5771 """
5772 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
5773
5774 def GetShown(*args, **kwargs):
5775 """
5776 GetShown(self) -> bool
5777
5778 Returns ``True`` if the UI element should be shown.
5779 """
5780 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
5781
5782 def GetText(*args, **kwargs):
5783 """
5784 GetText(self) -> String
5785
5786 Returns the text that should be set for the UI element.
5787 """
5788 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
5789
5790 def GetSetText(*args, **kwargs):
5791 """
5792 GetSetText(self) -> bool
5793
5794 Returns ``True`` if the application has called `SetText`. For
5795 wxWidgets internal use only.
5796 """
5797 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
5798
5799 def GetSetChecked(*args, **kwargs):
5800 """
5801 GetSetChecked(self) -> bool
5802
5803 Returns ``True`` if the application has called `Check`. For wxWidgets
5804 internal use only.
5805 """
5806 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
5807
5808 def GetSetEnabled(*args, **kwargs):
5809 """
5810 GetSetEnabled(self) -> bool
5811
5812 Returns ``True`` if the application has called `Enable`. For wxWidgets
5813 internal use only.
5814 """
5815 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
5816
5817 def GetSetShown(*args, **kwargs):
5818 """
5819 GetSetShown(self) -> bool
5820
5821 Returns ``True`` if the application has called `Show`. For wxWidgets
5822 internal use only.
5823 """
5824 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
5825
5826 def Check(*args, **kwargs):
5827 """
5828 Check(self, bool check)
5829
5830 Check or uncheck the UI element.
5831 """
5832 return _core_.UpdateUIEvent_Check(*args, **kwargs)
5833
5834 def Enable(*args, **kwargs):
5835 """
5836 Enable(self, bool enable)
5837
5838 Enable or disable the UI element.
5839 """
5840 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
5841
5842 def Show(*args, **kwargs):
5843 """
5844 Show(self, bool show)
5845
5846 Show or hide the UI element.
5847 """
5848 return _core_.UpdateUIEvent_Show(*args, **kwargs)
5849
5850 def SetText(*args, **kwargs):
5851 """
5852 SetText(self, String text)
5853
5854 Sets the text for this UI element.
5855 """
5856 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
5857
5858 def SetUpdateInterval(*args, **kwargs):
5859 """
5860 SetUpdateInterval(long updateInterval)
5861
5862 Sets the interval between updates in milliseconds. Set to -1 to
5863 disable updates, or to 0 to update as frequently as possible. The
5864 default is 0.
5865
5866 Use this to reduce the overhead of UI update events if your
5867 application has a lot of windows. If you set the value to -1 or
5868 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5869 at appropriate points in your application, such as when a dialog is
5870 about to be shown.
5871 """
5872 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5873
5874 SetUpdateInterval = staticmethod(SetUpdateInterval)
5875 def GetUpdateInterval(*args, **kwargs):
5876 """
5877 GetUpdateInterval() -> long
5878
5879 Returns the current interval between updates in milliseconds. -1
5880 disables updates, 0 updates as frequently as possible.
5881 """
5882 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
5883
5884 GetUpdateInterval = staticmethod(GetUpdateInterval)
5885 def CanUpdate(*args, **kwargs):
5886 """
5887 CanUpdate(Window win) -> bool
5888
5889 Returns ``True`` if it is appropriate to update (send UI update events
5890 to) this window.
5891
5892 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5893 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5894 events were last sent in idle time, and the update interval, to
5895 determine whether events should be sent to this window now. By default
5896 this will always return true because the update mode is initially
5897 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5898 events will be sent as often as possible. You can reduce the frequency
5899 that events are sent by changing the mode and/or setting an update
5900 interval.
5901
5902 """
5903 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5904
5905 CanUpdate = staticmethod(CanUpdate)
5906 def ResetUpdateTime(*args, **kwargs):
5907 """
5908 ResetUpdateTime()
5909
5910 Used internally to reset the last-updated time to the current time. It
5911 is assumed that update events are normally sent in idle time, so this
5912 is called at the end of idle processing.
5913 """
5914 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
5915
5916 ResetUpdateTime = staticmethod(ResetUpdateTime)
5917 def SetMode(*args, **kwargs):
5918 """
5919 SetMode(int mode)
5920
5921 Specify how wxWidgets will send update events: to all windows, or only
5922 to those which specify that they will process the events.
5923
5924 The mode may be one of the following values:
5925
5926 ============================= ==========================================
5927 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
5928 is the default setting.
5929 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
5930 have the wx.WS_EX_PROCESS_UI_UPDATES extra
5931 style set.
5932 ============================= ==========================================
5933
5934 """
5935 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
5936
5937 SetMode = staticmethod(SetMode)
5938 def GetMode(*args, **kwargs):
5939 """
5940 GetMode() -> int
5941
5942 Returns a value specifying how wxWidgets will send update events: to
5943 all windows, or only to those which specify that they will process the
5944 events.
5945 """
5946 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
5947
5948 GetMode = staticmethod(GetMode)
5949 Checked = property(GetChecked,Check,doc="See `GetChecked`")
5950 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
5951 Shown = property(GetShown,Show,doc="See `GetShown`")
5952 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
5953 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
5954
5955 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5956 """
5957 UpdateUIEvent_SetUpdateInterval(long updateInterval)
5958
5959 Sets the interval between updates in milliseconds. Set to -1 to
5960 disable updates, or to 0 to update as frequently as possible. The
5961 default is 0.
5962
5963 Use this to reduce the overhead of UI update events if your
5964 application has a lot of windows. If you set the value to -1 or
5965 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
5966 at appropriate points in your application, such as when a dialog is
5967 about to be shown.
5968 """
5969 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
5970
5971 def UpdateUIEvent_GetUpdateInterval(*args):
5972 """
5973 UpdateUIEvent_GetUpdateInterval() -> long
5974
5975 Returns the current interval between updates in milliseconds. -1
5976 disables updates, 0 updates as frequently as possible.
5977 """
5978 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
5979
5980 def UpdateUIEvent_CanUpdate(*args, **kwargs):
5981 """
5982 UpdateUIEvent_CanUpdate(Window win) -> bool
5983
5984 Returns ``True`` if it is appropriate to update (send UI update events
5985 to) this window.
5986
5987 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
5988 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
5989 events were last sent in idle time, and the update interval, to
5990 determine whether events should be sent to this window now. By default
5991 this will always return true because the update mode is initially
5992 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
5993 events will be sent as often as possible. You can reduce the frequency
5994 that events are sent by changing the mode and/or setting an update
5995 interval.
5996
5997 """
5998 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
5999
6000 def UpdateUIEvent_ResetUpdateTime(*args):
6001 """
6002 UpdateUIEvent_ResetUpdateTime()
6003
6004 Used internally to reset the last-updated time to the current time. It
6005 is assumed that update events are normally sent in idle time, so this
6006 is called at the end of idle processing.
6007 """
6008 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
6009
6010 def UpdateUIEvent_SetMode(*args, **kwargs):
6011 """
6012 UpdateUIEvent_SetMode(int mode)
6013
6014 Specify how wxWidgets will send update events: to all windows, or only
6015 to those which specify that they will process the events.
6016
6017 The mode may be one of the following values:
6018
6019 ============================= ==========================================
6020 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6021 is the default setting.
6022 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6023 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6024 style set.
6025 ============================= ==========================================
6026
6027 """
6028 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6029
6030 def UpdateUIEvent_GetMode(*args):
6031 """
6032 UpdateUIEvent_GetMode() -> int
6033
6034 Returns a value specifying how wxWidgets will send update events: to
6035 all windows, or only to those which specify that they will process the
6036 events.
6037 """
6038 return _core_.UpdateUIEvent_GetMode(*args)
6039
6040 #---------------------------------------------------------------------------
6041
6042 class SysColourChangedEvent(Event):
6043 """
6044 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6045 when the user changes the colour settings using the control
6046 panel. This is only applicable under Windows.
6047
6048 The default event handler for this event propagates the event to child
6049 windows, since Windows only sends the events to top-level windows. If
6050 intercepting this event for a top-level window, remember to call
6051 `Skip` so the the base class handler will still be executed, or to
6052 pass the event on to the window's children explicitly.
6053
6054 """
6055 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6056 __repr__ = _swig_repr
6057 def __init__(self, *args, **kwargs):
6058 """
6059 __init__(self) -> SysColourChangedEvent
6060
6061 Constructor
6062 """
6063 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
6064 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
6065
6066 #---------------------------------------------------------------------------
6067
6068 class MouseCaptureChangedEvent(Event):
6069 """
6070 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6071 a window that loses its mouse capture. This is called even if
6072 `wx.Window.ReleaseMouse` was called by the application code. Handling
6073 this event allows an application to cater for unexpected capture
6074 releases which might otherwise confuse mouse handling code.
6075
6076 This event is implemented under Windows only.
6077 """
6078 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6079 __repr__ = _swig_repr
6080 def __init__(self, *args, **kwargs):
6081 """
6082 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6083
6084 Constructor
6085 """
6086 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6087 def GetCapturedWindow(*args, **kwargs):
6088 """
6089 GetCapturedWindow(self) -> Window
6090
6091 Returns the window that gained the capture, or ``None`` if it was a
6092 non-wxWidgets window.
6093 """
6094 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6095
6096 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6097 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6098
6099 #---------------------------------------------------------------------------
6100
6101 class MouseCaptureLostEvent(Event):
6102 """
6103 A mouse capture lost event is sent to a window that obtained mouse
6104 capture, which was subsequently loss due to "external" event, for
6105 example when a dialog box is shown or if another application captures
6106 the mouse.
6107
6108 If this happens, this event is sent to all windows that are on the
6109 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6110 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6111 if the capture changes because of a call to CaptureMouse or
6112 ReleaseMouse.
6113
6114 This event is currently emitted under Windows only.
6115
6116 """
6117 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6118 __repr__ = _swig_repr
6119 def __init__(self, *args, **kwargs):
6120 """
6121 __init__(self, int winid=0) -> MouseCaptureLostEvent
6122
6123 A mouse capture lost event is sent to a window that obtained mouse
6124 capture, which was subsequently loss due to "external" event, for
6125 example when a dialog box is shown or if another application captures
6126 the mouse.
6127
6128 If this happens, this event is sent to all windows that are on the
6129 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6130 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6131 if the capture changes because of a call to CaptureMouse or
6132 ReleaseMouse.
6133
6134 This event is currently emitted under Windows only.
6135
6136 """
6137 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6138 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6139
6140 #---------------------------------------------------------------------------
6141
6142 class DisplayChangedEvent(Event):
6143 """
6144 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6145 resolution has changed.
6146
6147 This event is implemented under Windows only.
6148 """
6149 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6150 __repr__ = _swig_repr
6151 def __init__(self, *args, **kwargs):
6152 """__init__(self) -> DisplayChangedEvent"""
6153 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6154 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6155
6156 #---------------------------------------------------------------------------
6157
6158 class PaletteChangedEvent(Event):
6159 """
6160 An EVT_PALETTE_CHANGED event is sent when the system palette has
6161 changed, thereby giving each window a chance to redo their own to
6162 match.
6163
6164 This event is implemented under Windows only.
6165 """
6166 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6167 __repr__ = _swig_repr
6168 def __init__(self, *args, **kwargs):
6169 """
6170 __init__(self, int id=0) -> PaletteChangedEvent
6171
6172 An EVT_PALETTE_CHANGED event is sent when the system palette has
6173 changed, thereby giving each window a chance to redo their own to
6174 match.
6175
6176 This event is implemented under Windows only.
6177 """
6178 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6179 def SetChangedWindow(*args, **kwargs):
6180 """SetChangedWindow(self, Window win)"""
6181 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6182
6183 def GetChangedWindow(*args, **kwargs):
6184 """GetChangedWindow(self) -> Window"""
6185 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6186
6187 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6188 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6189
6190 #---------------------------------------------------------------------------
6191
6192 class QueryNewPaletteEvent(Event):
6193 """
6194 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6195 focus and should re-do its palette.
6196
6197 This event is implemented under Windows only.
6198 """
6199 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6200 __repr__ = _swig_repr
6201 def __init__(self, *args, **kwargs):
6202 """
6203 __init__(self, int winid=0) -> QueryNewPaletteEvent
6204
6205 Constructor.
6206 """
6207 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6208 def SetPaletteRealized(*args, **kwargs):
6209 """
6210 SetPaletteRealized(self, bool realized)
6211
6212 App should set this if it changes the palette.
6213 """
6214 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6215
6216 def GetPaletteRealized(*args, **kwargs):
6217 """GetPaletteRealized(self) -> bool"""
6218 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6219
6220 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6221 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6222
6223 #---------------------------------------------------------------------------
6224
6225 class NavigationKeyEvent(Event):
6226 """
6227 EVT_NAVIGATION_KEY events are used to control moving the focus between
6228 widgets, otherwise known as tab-traversal. You woudl normally not
6229 catch navigation events in applications as there are already
6230 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6231 it useful to send navigation events in certain situations to change
6232 the focus in certain ways, although it's probably easier to just call
6233 `wx.Window.Navigate`.
6234 """
6235 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6236 __repr__ = _swig_repr
6237 def __init__(self, *args, **kwargs):
6238 """__init__(self) -> NavigationKeyEvent"""
6239 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6240 def GetDirection(*args, **kwargs):
6241 """
6242 GetDirection(self) -> bool
6243
6244 Returns ``True`` if the direction is forward, ``False`` otherwise.
6245 """
6246 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6247
6248 def SetDirection(*args, **kwargs):
6249 """
6250 SetDirection(self, bool forward)
6251
6252 Specify the direction that the navigation should take. Usually the
6253 difference between using Tab and Shift-Tab.
6254 """
6255 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6256
6257 def IsWindowChange(*args, **kwargs):
6258 """
6259 IsWindowChange(self) -> bool
6260
6261 Returns ``True`` if window change is allowed.
6262 """
6263 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6264
6265 def SetWindowChange(*args, **kwargs):
6266 """
6267 SetWindowChange(self, bool ischange)
6268
6269 Specify if the navigation should be able to change parent windows.
6270 For example, changing notebook pages, etc. This is usually implemented
6271 by using Control-Tab.
6272 """
6273 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6274
6275 def IsFromTab(*args, **kwargs):
6276 """
6277 IsFromTab(self) -> bool
6278
6279 Returns ``True`` if the navigation event is originated from the Tab
6280 key.
6281 """
6282 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6283
6284 def SetFromTab(*args, **kwargs):
6285 """
6286 SetFromTab(self, bool bIs)
6287
6288 Set to true under MSW if the event was generated using the tab key.
6289 This is required for proper navogation over radio buttons.
6290 """
6291 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6292
6293 def SetFlags(*args, **kwargs):
6294 """
6295 SetFlags(self, long flags)
6296
6297 Set the navigation flags to a combination of the following:
6298
6299 * wx.NavigationKeyEvent.IsBackward
6300 * wx.NavigationKeyEvent.IsForward
6301 * wx.NavigationKeyEvent.WinChange
6302 * wx.NavigationKeyEvent.FromTab
6303
6304 """
6305 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6306
6307 def GetCurrentFocus(*args, **kwargs):
6308 """
6309 GetCurrentFocus(self) -> Window
6310
6311 Returns the child window which currenty has the focus. May be
6312 ``None``.
6313 """
6314 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6315
6316 def SetCurrentFocus(*args, **kwargs):
6317 """
6318 SetCurrentFocus(self, Window win)
6319
6320 Set the window that has the focus.
6321 """
6322 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6323
6324 IsBackward = _core_.NavigationKeyEvent_IsBackward
6325 IsForward = _core_.NavigationKeyEvent_IsForward
6326 WinChange = _core_.NavigationKeyEvent_WinChange
6327 FromTab = _core_.NavigationKeyEvent_FromTab
6328 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6329 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6330 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6331
6332 #---------------------------------------------------------------------------
6333
6334 class WindowCreateEvent(CommandEvent):
6335 """
6336 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6337 underlying GUI object) exists.
6338 """
6339 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6340 __repr__ = _swig_repr
6341 def __init__(self, *args, **kwargs):
6342 """
6343 __init__(self, Window win=None) -> WindowCreateEvent
6344
6345 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6346 underlying GUI object) exists.
6347 """
6348 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6349 def GetWindow(*args, **kwargs):
6350 """
6351 GetWindow(self) -> Window
6352
6353 Returns the window that this event refers to.
6354 """
6355 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6356
6357 Window = property(GetWindow,doc="See `GetWindow`")
6358 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6359
6360 class WindowDestroyEvent(CommandEvent):
6361 """
6362 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6363 when the GUI window is destroyed.
6364
6365 When a class derived from `wx.Window` is destroyed its destructor will
6366 have already run by the time this event is sent. Therefore this event
6367 will not usually be received at all by the window itself. Since it is
6368 received after the destructor has run, an object should not try to
6369 handle its own wx.WindowDestroyEvent, but it can be used to get
6370 notification of the destruction of another window.
6371 """
6372 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6373 __repr__ = _swig_repr
6374 def __init__(self, *args, **kwargs):
6375 """
6376 __init__(self, Window win=None) -> WindowDestroyEvent
6377
6378 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6379 when the GUI window is destroyed.
6380
6381 When a class derived from `wx.Window` is destroyed its destructor will
6382 have already run by the time this event is sent. Therefore this event
6383 will not usually be received at all by the window itself. Since it is
6384 received after the destructor has run, an object should not try to
6385 handle its own wx.WindowDestroyEvent, but it can be used to get
6386 notification of the destruction of another window.
6387 """
6388 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6389 def GetWindow(*args, **kwargs):
6390 """
6391 GetWindow(self) -> Window
6392
6393 Returns the window that this event refers to.
6394 """
6395 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6396
6397 Window = property(GetWindow,doc="See `GetWindow`")
6398 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6399
6400 #---------------------------------------------------------------------------
6401
6402 class ContextMenuEvent(CommandEvent):
6403 """
6404 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6405 give the application a chance to show a context (popup) menu.
6406 """
6407 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6408 __repr__ = _swig_repr
6409 def __init__(self, *args, **kwargs):
6410 """
6411 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6412
6413 Constructor.
6414 """
6415 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6416 def GetPosition(*args, **kwargs):
6417 """
6418 GetPosition(self) -> Point
6419
6420 Returns the position (in screen coordinants) at which the menu should
6421 be shown.
6422 """
6423 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6424
6425 def SetPosition(*args, **kwargs):
6426 """
6427 SetPosition(self, Point pos)
6428
6429 Sets the position at which the menu should be shown.
6430 """
6431 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6432
6433 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6434 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6435
6436 #---------------------------------------------------------------------------
6437
6438 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6439 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6440 class IdleEvent(Event):
6441 """
6442 This class is used for EVT_IDLE events, which are generated and sent
6443 when the application *becomes* idle. In other words, the when the
6444 event queue becomes empty then idle events are sent to all windows (by
6445 default) and as long as none of them call `RequestMore` then there are
6446 no more idle events until after the system event queue has some normal
6447 events and then becomes empty again.
6448
6449 By default, idle events are sent to all windows. If this is causing a
6450 significant overhead in your application, you can call
6451 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6452 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6453 which should receive idle events. Then idle events will only be sent
6454 to those windows and not to any others.
6455 """
6456 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6457 __repr__ = _swig_repr
6458 def __init__(self, *args, **kwargs):
6459 """
6460 __init__(self) -> IdleEvent
6461
6462 Constructor
6463 """
6464 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6465 def RequestMore(*args, **kwargs):
6466 """
6467 RequestMore(self, bool needMore=True)
6468
6469 Tells wxWidgets that more processing is required. This function can be
6470 called by an EVT_IDLE handler for a window to indicate that the
6471 application should forward the EVT_IDLE event once more to the
6472 application windows. If no window calls this function during its
6473 EVT_IDLE handler, then the application will remain in a passive event
6474 loop until a new event is posted to the application by the windowing
6475 system.
6476 """
6477 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6478
6479 def MoreRequested(*args, **kwargs):
6480 """
6481 MoreRequested(self) -> bool
6482
6483 Returns ``True`` if the OnIdle function processing this event
6484 requested more processing time.
6485 """
6486 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6487
6488 def SetMode(*args, **kwargs):
6489 """
6490 SetMode(int mode)
6491
6492 Static method for specifying how wxWidgets will send idle events: to
6493 all windows, or only to those which specify that they will process the
6494 events.
6495
6496 The mode can be one of the following values:
6497
6498 ========================= ========================================
6499 wx.IDLE_PROCESS_ALL Send idle events to all windows
6500 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6501 the wx.WS_EX_PROCESS_IDLE extra style
6502 flag set.
6503 ========================= ========================================
6504
6505 """
6506 return _core_.IdleEvent_SetMode(*args, **kwargs)
6507
6508 SetMode = staticmethod(SetMode)
6509 def GetMode(*args, **kwargs):
6510 """
6511 GetMode() -> int
6512
6513 Static method returning a value specifying how wxWidgets will send
6514 idle events: to all windows, or only to those which specify that they
6515 will process the events.
6516 """
6517 return _core_.IdleEvent_GetMode(*args, **kwargs)
6518
6519 GetMode = staticmethod(GetMode)
6520 def CanSend(*args, **kwargs):
6521 """
6522 CanSend(Window win) -> bool
6523
6524 Returns ``True`` if it is appropriate to send idle events to this
6525 window.
6526
6527 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6528 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6529 events should be sent to this window now. By default this will always
6530 return ``True`` because the update mode is initially
6531 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6532 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6533 """
6534 return _core_.IdleEvent_CanSend(*args, **kwargs)
6535
6536 CanSend = staticmethod(CanSend)
6537 _core_.IdleEvent_swigregister(IdleEvent)
6538
6539 def IdleEvent_SetMode(*args, **kwargs):
6540 """
6541 IdleEvent_SetMode(int mode)
6542
6543 Static method for specifying how wxWidgets will send idle events: to
6544 all windows, or only to those which specify that they will process the
6545 events.
6546
6547 The mode can be one of the following values:
6548
6549 ========================= ========================================
6550 wx.IDLE_PROCESS_ALL Send idle events to all windows
6551 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6552 the wx.WS_EX_PROCESS_IDLE extra style
6553 flag set.
6554 ========================= ========================================
6555
6556 """
6557 return _core_.IdleEvent_SetMode(*args, **kwargs)
6558
6559 def IdleEvent_GetMode(*args):
6560 """
6561 IdleEvent_GetMode() -> int
6562
6563 Static method returning a value specifying how wxWidgets will send
6564 idle events: to all windows, or only to those which specify that they
6565 will process the events.
6566 """
6567 return _core_.IdleEvent_GetMode(*args)
6568
6569 def IdleEvent_CanSend(*args, **kwargs):
6570 """
6571 IdleEvent_CanSend(Window win) -> bool
6572
6573 Returns ``True`` if it is appropriate to send idle events to this
6574 window.
6575
6576 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6577 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6578 events should be sent to this window now. By default this will always
6579 return ``True`` because the update mode is initially
6580 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6581 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6582 """
6583 return _core_.IdleEvent_CanSend(*args, **kwargs)
6584
6585 #---------------------------------------------------------------------------
6586
6587 class ClipboardTextEvent(CommandEvent):
6588 """
6589 A Clipboard Text event is sent when a window intercepts a text
6590 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6591 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6592 popup menu command, etc. NOTE : under windows these events are *NOT*
6593 generated automatically for a Rich Edit text control.
6594 """
6595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6596 __repr__ = _swig_repr
6597 def __init__(self, *args, **kwargs):
6598 """
6599 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6600
6601 A Clipboard Text event is sent when a window intercepts a text
6602 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6603 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6604 popup menu command, etc. NOTE : under windows these events are *NOT*
6605 generated automatically for a Rich Edit text control.
6606 """
6607 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6608 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6609
6610 #---------------------------------------------------------------------------
6611
6612 class PyEvent(Event):
6613 """
6614 wx.PyEvent can be used as a base class for implementing custom event
6615 types in Python. You should derived from this class instead of
6616 `wx.Event` because this class is Python-aware and is able to transport
6617 its Python bits safely through the wxWidgets event system and have
6618 them still be there when the event handler is invoked.
6619
6620 :see: `wx.PyCommandEvent`
6621
6622 """
6623 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6624 __repr__ = _swig_repr
6625 def __init__(self, *args, **kwargs):
6626 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6627 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6628 self._SetSelf(self)
6629
6630 __swig_destroy__ = _core_.delete_PyEvent
6631 __del__ = lambda self : None;
6632 def _SetSelf(*args, **kwargs):
6633 """_SetSelf(self, PyObject self)"""
6634 return _core_.PyEvent__SetSelf(*args, **kwargs)
6635
6636 def _GetSelf(*args, **kwargs):
6637 """_GetSelf(self) -> PyObject"""
6638 return _core_.PyEvent__GetSelf(*args, **kwargs)
6639
6640 _core_.PyEvent_swigregister(PyEvent)
6641
6642 class PyCommandEvent(CommandEvent):
6643 """
6644 wx.PyCommandEvent can be used as a base class for implementing custom
6645 event types in Python, where the event shoudl travel up to parent
6646 windows looking for a handler. You should derived from this class
6647 instead of `wx.CommandEvent` because this class is Python-aware and is
6648 able to transport its Python bits safely through the wxWidgets event
6649 system and have them still be there when the event handler is invoked.
6650
6651 :see: `wx.PyEvent`
6652
6653 """
6654 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6655 __repr__ = _swig_repr
6656 def __init__(self, *args, **kwargs):
6657 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6658 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6659 self._SetSelf(self)
6660
6661 __swig_destroy__ = _core_.delete_PyCommandEvent
6662 __del__ = lambda self : None;
6663 def _SetSelf(*args, **kwargs):
6664 """_SetSelf(self, PyObject self)"""
6665 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6666
6667 def _GetSelf(*args, **kwargs):
6668 """_GetSelf(self) -> PyObject"""
6669 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6670
6671 _core_.PyCommandEvent_swigregister(PyCommandEvent)
6672
6673 class DateEvent(CommandEvent):
6674 """
6675 This event class holds information about a date change event and is
6676 used together with `wx.DatePickerCtrl`. It also serves as a base class
6677 for `wx.calendar.CalendarEvent`. Bind these event types with
6678 EVT_DATE_CHANGED.
6679 """
6680 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6681 __repr__ = _swig_repr
6682 def __init__(self, *args, **kwargs):
6683 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6684 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6685 def GetDate(*args, **kwargs):
6686 """
6687 GetDate(self) -> DateTime
6688
6689 Returns the date.
6690 """
6691 return _core_.DateEvent_GetDate(*args, **kwargs)
6692
6693 def SetDate(*args, **kwargs):
6694 """
6695 SetDate(self, DateTime date)
6696
6697 Sets the date carried by the event, normally only used by the library
6698 internally.
6699 """
6700 return _core_.DateEvent_SetDate(*args, **kwargs)
6701
6702 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
6703 _core_.DateEvent_swigregister(DateEvent)
6704
6705 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6706 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6707
6708 #---------------------------------------------------------------------------
6709
6710 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6711 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6712 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6713 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6714 PRINT_WINDOWS = _core_.PRINT_WINDOWS
6715 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6716 class PyApp(EvtHandler):
6717 """
6718 The ``wx.PyApp`` class is an *implementation detail*, please use the
6719 `wx.App` class (or some other derived class) instead.
6720 """
6721 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6722 __repr__ = _swig_repr
6723 def __init__(self, *args, **kwargs):
6724 """
6725 __init__(self) -> PyApp
6726
6727 Create a new application object, starting the bootstrap process.
6728 """
6729 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
6730 self._setCallbackInfo(self, PyApp, False)
6731 self._setOORInfo(self, False)
6732
6733 __swig_destroy__ = _core_.delete_PyApp
6734 __del__ = lambda self : None;
6735 def _setCallbackInfo(*args, **kwargs):
6736 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
6737 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
6738
6739 def GetAppName(*args, **kwargs):
6740 """
6741 GetAppName(self) -> String
6742
6743 Get the application name.
6744 """
6745 return _core_.PyApp_GetAppName(*args, **kwargs)
6746
6747 def SetAppName(*args, **kwargs):
6748 """
6749 SetAppName(self, String name)
6750
6751 Set the application name. This value may be used automatically by
6752 `wx.Config` and such.
6753 """
6754 return _core_.PyApp_SetAppName(*args, **kwargs)
6755
6756 def GetClassName(*args, **kwargs):
6757 """
6758 GetClassName(self) -> String
6759
6760 Get the application's class name.
6761 """
6762 return _core_.PyApp_GetClassName(*args, **kwargs)
6763
6764 def SetClassName(*args, **kwargs):
6765 """
6766 SetClassName(self, String name)
6767
6768 Set the application's class name. This value may be used for
6769 X-resources if applicable for the platform
6770 """
6771 return _core_.PyApp_SetClassName(*args, **kwargs)
6772
6773 def GetVendorName(*args, **kwargs):
6774 """
6775 GetVendorName(self) -> String
6776
6777 Get the application's vendor name.
6778 """
6779 return _core_.PyApp_GetVendorName(*args, **kwargs)
6780
6781 def SetVendorName(*args, **kwargs):
6782 """
6783 SetVendorName(self, String name)
6784
6785 Set the application's vendor name. This value may be used
6786 automatically by `wx.Config` and such.
6787 """
6788 return _core_.PyApp_SetVendorName(*args, **kwargs)
6789
6790 def GetTraits(*args, **kwargs):
6791 """
6792 GetTraits(self) -> wxAppTraits
6793
6794 Return (and create if necessary) the app traits object to which we
6795 delegate for everything which either should be configurable by the
6796 user (then he can change the default behaviour simply by overriding
6797 CreateTraits() and returning his own traits object) or which is
6798 GUI/console dependent as then wx.AppTraits allows us to abstract the
6799 differences behind the common facade.
6800
6801 :todo: Add support for overriding CreateAppTraits in wxPython.
6802 """
6803 return _core_.PyApp_GetTraits(*args, **kwargs)
6804
6805 def ProcessPendingEvents(*args, **kwargs):
6806 """
6807 ProcessPendingEvents(self)
6808
6809 Process all events in the Pending Events list -- it is necessary to
6810 call this function to process posted events. This normally happens
6811 during each event loop iteration.
6812 """
6813 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
6814
6815 def Yield(*args, **kwargs):
6816 """
6817 Yield(self, bool onlyIfNeeded=False) -> bool
6818
6819 Process all currently pending events right now, instead of waiting
6820 until return to the event loop. It is an error to call ``Yield``
6821 recursively unless the value of ``onlyIfNeeded`` is True.
6822
6823 :warning: This function is dangerous as it can lead to unexpected
6824 reentrancies (i.e. when called from an event handler it may
6825 result in calling the same event handler again), use with
6826 extreme care or, better, don't use at all!
6827
6828 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
6829
6830 """
6831 return _core_.PyApp_Yield(*args, **kwargs)
6832
6833 def WakeUpIdle(*args, **kwargs):
6834 """
6835 WakeUpIdle(self)
6836
6837 Make sure that idle events are sent again.
6838 :see: `wx.WakeUpIdle`
6839 """
6840 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
6841
6842 def IsMainLoopRunning(*args, **kwargs):
6843 """
6844 IsMainLoopRunning() -> bool
6845
6846 Returns True if we're running the main loop, i.e. if the events can
6847 currently be dispatched.
6848 """
6849 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
6850
6851 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
6852 def MainLoop(*args, **kwargs):
6853 """
6854 MainLoop(self) -> int
6855
6856 Execute the main GUI loop, the function doesn't normally return until
6857 all top level windows have been closed and destroyed.
6858 """
6859 return _core_.PyApp_MainLoop(*args, **kwargs)
6860
6861 def Exit(*args, **kwargs):
6862 """
6863 Exit(self)
6864
6865 Exit the main loop thus terminating the application.
6866 :see: `wx.Exit`
6867 """
6868 return _core_.PyApp_Exit(*args, **kwargs)
6869
6870 def GetLayoutDirection(*args, **kwargs):
6871 """
6872 GetLayoutDirection(self) -> int
6873
6874 Return the layout direction for the current locale.
6875 """
6876 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
6877
6878 def ExitMainLoop(*args, **kwargs):
6879 """
6880 ExitMainLoop(self)
6881
6882 Exit the main GUI loop during the next iteration of the main
6883 loop, (i.e. it does not stop the program immediately!)
6884 """
6885 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
6886
6887 def Pending(*args, **kwargs):
6888 """
6889 Pending(self) -> bool
6890
6891 Returns True if there are unprocessed events in the event queue.
6892 """
6893 return _core_.PyApp_Pending(*args, **kwargs)
6894
6895 def Dispatch(*args, **kwargs):
6896 """
6897 Dispatch(self) -> bool
6898
6899 Process the first event in the event queue (blocks until an event
6900 appears if there are none currently)
6901 """
6902 return _core_.PyApp_Dispatch(*args, **kwargs)
6903
6904 def ProcessIdle(*args, **kwargs):
6905 """
6906 ProcessIdle(self) -> bool
6907
6908 Called from the MainLoop when the application becomes idle (there are
6909 no pending events) and sends a `wx.IdleEvent` to all interested
6910 parties. Returns True if more idle events are needed, False if not.
6911 """
6912 return _core_.PyApp_ProcessIdle(*args, **kwargs)
6913
6914 def SendIdleEvents(*args, **kwargs):
6915 """
6916 SendIdleEvents(self, Window win, IdleEvent event) -> bool
6917
6918 Send idle event to window and all subwindows. Returns True if more
6919 idle time is requested.
6920 """
6921 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
6922
6923 def IsActive(*args, **kwargs):
6924 """
6925 IsActive(self) -> bool
6926
6927 Return True if our app has focus.
6928 """
6929 return _core_.PyApp_IsActive(*args, **kwargs)
6930
6931 def SetTopWindow(*args, **kwargs):
6932 """
6933 SetTopWindow(self, Window win)
6934
6935 Set the *main* top level window
6936 """
6937 return _core_.PyApp_SetTopWindow(*args, **kwargs)
6938
6939 def GetTopWindow(*args, **kwargs):
6940 """
6941 GetTopWindow(self) -> Window
6942
6943 Return the *main* top level window (if it hadn't been set previously
6944 with SetTopWindow(), will return just some top level window and, if
6945 there not any, will return None)
6946 """
6947 return _core_.PyApp_GetTopWindow(*args, **kwargs)
6948
6949 def SetExitOnFrameDelete(*args, **kwargs):
6950 """
6951 SetExitOnFrameDelete(self, bool flag)
6952
6953 Control the exit behaviour: by default, the program will exit the main
6954 loop (and so, usually, terminate) when the last top-level program
6955 window is deleted. Beware that if you disable this behaviour (with
6956 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
6957 explicitly from somewhere.
6958 """
6959 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
6960
6961 def GetExitOnFrameDelete(*args, **kwargs):
6962 """
6963 GetExitOnFrameDelete(self) -> bool
6964
6965 Get the current exit behaviour setting.
6966 """
6967 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
6968
6969 def SetUseBestVisual(*args, **kwargs):
6970 """
6971 SetUseBestVisual(self, bool flag)
6972
6973 Set whether the app should try to use the best available visual on
6974 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
6975 """
6976 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
6977
6978 def GetUseBestVisual(*args, **kwargs):
6979 """
6980 GetUseBestVisual(self) -> bool
6981
6982 Get current UseBestVisual setting.
6983 """
6984 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
6985
6986 def SetPrintMode(*args, **kwargs):
6987 """SetPrintMode(self, int mode)"""
6988 return _core_.PyApp_SetPrintMode(*args, **kwargs)
6989
6990 def GetPrintMode(*args, **kwargs):
6991 """GetPrintMode(self) -> int"""
6992 return _core_.PyApp_GetPrintMode(*args, **kwargs)
6993
6994 def SetAssertMode(*args, **kwargs):
6995 """
6996 SetAssertMode(self, int mode)
6997
6998 Set the OnAssert behaviour for debug and hybrid builds.
6999 """
7000 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7001
7002 def GetAssertMode(*args, **kwargs):
7003 """
7004 GetAssertMode(self) -> int
7005
7006 Get the current OnAssert behaviour setting.
7007 """
7008 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7009
7010 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
7011 """GetMacSupportPCMenuShortcuts() -> bool"""
7012 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7013
7014 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7015 def GetMacAboutMenuItemId(*args, **kwargs):
7016 """GetMacAboutMenuItemId() -> long"""
7017 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7018
7019 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7020 def GetMacPreferencesMenuItemId(*args, **kwargs):
7021 """GetMacPreferencesMenuItemId() -> long"""
7022 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7023
7024 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7025 def GetMacExitMenuItemId(*args, **kwargs):
7026 """GetMacExitMenuItemId() -> long"""
7027 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7028
7029 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7030 def GetMacHelpMenuTitleName(*args, **kwargs):
7031 """GetMacHelpMenuTitleName() -> String"""
7032 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7033
7034 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7035 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
7036 """SetMacSupportPCMenuShortcuts(bool val)"""
7037 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7038
7039 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7040 def SetMacAboutMenuItemId(*args, **kwargs):
7041 """SetMacAboutMenuItemId(long val)"""
7042 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7043
7044 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7045 def SetMacPreferencesMenuItemId(*args, **kwargs):
7046 """SetMacPreferencesMenuItemId(long val)"""
7047 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7048
7049 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7050 def SetMacExitMenuItemId(*args, **kwargs):
7051 """SetMacExitMenuItemId(long val)"""
7052 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7053
7054 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7055 def SetMacHelpMenuTitleName(*args, **kwargs):
7056 """SetMacHelpMenuTitleName(String val)"""
7057 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7058
7059 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7060 def _BootstrapApp(*args, **kwargs):
7061 """
7062 _BootstrapApp(self)
7063
7064 For internal use only
7065 """
7066 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7067
7068 def GetComCtl32Version(*args, **kwargs):
7069 """
7070 GetComCtl32Version() -> int
7071
7072 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7073 it wasn't found at all. Raises an exception on non-Windows platforms.
7074 """
7075 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7076
7077 GetComCtl32Version = staticmethod(GetComCtl32Version)
7078 def IsDisplayAvailable(*args, **kwargs):
7079 """
7080 IsDisplayAvailable() -> bool
7081
7082 Tests if it is possible to create a GUI in the current environment.
7083 This will mean different things on the different platforms.
7084
7085 * On X Windows systems this function will return ``False`` if it is
7086 not able to open a connection to the X display, which can happen
7087 if $DISPLAY is not set, or is not set correctly.
7088
7089 * On Mac OS X a ``False`` return value will mean that wx is not
7090 able to access the window manager, which can happen if logged in
7091 remotely or if running from the normal version of python instead
7092 of the framework version, (i.e., pythonw.)
7093
7094 * On MS Windows...
7095
7096 """
7097 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7098
7099 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7100 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7101 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7102 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7103 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7104 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7105 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7106 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7107 Traits = property(GetTraits,doc="See `GetTraits`")
7108 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7109 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7110 Active = property(IsActive)
7111 _core_.PyApp_swigregister(PyApp)
7112
7113 def PyApp_IsMainLoopRunning(*args):
7114 """
7115 PyApp_IsMainLoopRunning() -> bool
7116
7117 Returns True if we're running the main loop, i.e. if the events can
7118 currently be dispatched.
7119 """
7120 return _core_.PyApp_IsMainLoopRunning(*args)
7121
7122 def PyApp_GetMacSupportPCMenuShortcuts(*args):
7123 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7124 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7125
7126 def PyApp_GetMacAboutMenuItemId(*args):
7127 """PyApp_GetMacAboutMenuItemId() -> long"""
7128 return _core_.PyApp_GetMacAboutMenuItemId(*args)
7129
7130 def PyApp_GetMacPreferencesMenuItemId(*args):
7131 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7132 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7133
7134 def PyApp_GetMacExitMenuItemId(*args):
7135 """PyApp_GetMacExitMenuItemId() -> long"""
7136 return _core_.PyApp_GetMacExitMenuItemId(*args)
7137
7138 def PyApp_GetMacHelpMenuTitleName(*args):
7139 """PyApp_GetMacHelpMenuTitleName() -> String"""
7140 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7141
7142 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7143 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7144 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7145
7146 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7147 """PyApp_SetMacAboutMenuItemId(long val)"""
7148 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7149
7150 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7151 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7152 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7153
7154 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7155 """PyApp_SetMacExitMenuItemId(long val)"""
7156 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7157
7158 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7159 """PyApp_SetMacHelpMenuTitleName(String val)"""
7160 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7161
7162 def PyApp_GetComCtl32Version(*args):
7163 """
7164 PyApp_GetComCtl32Version() -> int
7165
7166 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7167 it wasn't found at all. Raises an exception on non-Windows platforms.
7168 """
7169 return _core_.PyApp_GetComCtl32Version(*args)
7170
7171 def PyApp_IsDisplayAvailable(*args):
7172 """
7173 PyApp_IsDisplayAvailable() -> bool
7174
7175 Tests if it is possible to create a GUI in the current environment.
7176 This will mean different things on the different platforms.
7177
7178 * On X Windows systems this function will return ``False`` if it is
7179 not able to open a connection to the X display, which can happen
7180 if $DISPLAY is not set, or is not set correctly.
7181
7182 * On Mac OS X a ``False`` return value will mean that wx is not
7183 able to access the window manager, which can happen if logged in
7184 remotely or if running from the normal version of python instead
7185 of the framework version, (i.e., pythonw.)
7186
7187 * On MS Windows...
7188
7189 """
7190 return _core_.PyApp_IsDisplayAvailable(*args)
7191
7192 #---------------------------------------------------------------------------
7193
7194
7195 def Exit(*args):
7196 """
7197 Exit()
7198
7199 Force an exit of the application. Convenience for wx.GetApp().Exit()
7200 """
7201 return _core_.Exit(*args)
7202
7203 def Yield(*args):
7204 """
7205 Yield() -> bool
7206
7207 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7208 """
7209 return _core_.Yield(*args)
7210
7211 def YieldIfNeeded(*args):
7212 """
7213 YieldIfNeeded() -> bool
7214
7215 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7216 """
7217 return _core_.YieldIfNeeded(*args)
7218
7219 def SafeYield(*args, **kwargs):
7220 """
7221 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7222
7223 This function is similar to `wx.Yield`, except that it disables the
7224 user input to all program windows before calling `wx.Yield` and
7225 re-enables it again afterwards. If ``win`` is not None, this window
7226 will remain enabled, allowing the implementation of some limited user
7227 interaction.
7228
7229 :Returns: the result of the call to `wx.Yield`.
7230 """
7231 return _core_.SafeYield(*args, **kwargs)
7232
7233 def WakeUpIdle(*args):
7234 """
7235 WakeUpIdle()
7236
7237 Cause the message queue to become empty again, so idle events will be
7238 sent.
7239 """
7240 return _core_.WakeUpIdle(*args)
7241
7242 def PostEvent(*args, **kwargs):
7243 """
7244 PostEvent(EvtHandler dest, Event event)
7245
7246 Send an event to a window or other wx.EvtHandler to be processed
7247 later.
7248 """
7249 return _core_.PostEvent(*args, **kwargs)
7250
7251 def App_CleanUp(*args):
7252 """
7253 App_CleanUp()
7254
7255 For internal use only, it is used to cleanup after wxWidgets when
7256 Python shuts down.
7257 """
7258 return _core_.App_CleanUp(*args)
7259
7260 def GetApp(*args):
7261 """
7262 GetApp() -> PyApp
7263
7264 Return a reference to the current wx.App object.
7265 """
7266 return _core_.GetApp(*args)
7267
7268 def SetDefaultPyEncoding(*args, **kwargs):
7269 """
7270 SetDefaultPyEncoding(string encoding)
7271
7272 Sets the encoding that wxPython will use when it needs to convert a
7273 Python string or unicode object to or from a wxString.
7274
7275 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7276 but please be aware that the default encoding within the same locale
7277 may be slightly different on different platforms. For example, please
7278 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7279 between the common latin/roman encodings.
7280 """
7281 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7282
7283 def GetDefaultPyEncoding(*args):
7284 """
7285 GetDefaultPyEncoding() -> string
7286
7287 Gets the current encoding that wxPython will use when it needs to
7288 convert a Python string or unicode object to or from a wxString.
7289 """
7290 return _core_.GetDefaultPyEncoding(*args)
7291 #----------------------------------------------------------------------
7292
7293 class PyOnDemandOutputWindow:
7294 """
7295 A class that can be used for redirecting Python's stdout and
7296 stderr streams. It will do nothing until something is wrriten to
7297 the stream at which point it will create a Frame with a text area
7298 and write the text there.
7299 """
7300 def __init__(self, title = "wxPython: stdout/stderr"):
7301 self.frame = None
7302 self.title = title
7303 self.pos = wx.DefaultPosition
7304 self.size = (450, 300)
7305 self.parent = None
7306
7307 def SetParent(self, parent):
7308 """Set the window to be used as the popup Frame's parent."""
7309 self.parent = parent
7310
7311
7312 def CreateOutputWindow(self, st):
7313 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7314 style=wx.DEFAULT_FRAME_STYLE)
7315 self.text = wx.TextCtrl(self.frame, -1, "",
7316 style=wx.TE_MULTILINE|wx.TE_READONLY)
7317 self.text.AppendText(st)
7318 self.frame.Show(True)
7319 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7320
7321
7322 def OnCloseWindow(self, event):
7323 if self.frame is not None:
7324 self.frame.Destroy()
7325 self.frame = None
7326 self.text = None
7327
7328
7329 # These methods provide the file-like output behaviour.
7330 def write(self, text):
7331 """
7332 Create the output window if needed and write the string to it.
7333 If not called in the context of the gui thread then uses
7334 CallAfter to do the work there.
7335 """
7336 if self.frame is None:
7337 if not wx.Thread_IsMain():
7338 wx.CallAfter(self.CreateOutputWindow, text)
7339 else:
7340 self.CreateOutputWindow(text)
7341 else:
7342 if not wx.Thread_IsMain():
7343 wx.CallAfter(self.text.AppendText, text)
7344 else:
7345 self.text.AppendText(text)
7346
7347
7348 def close(self):
7349 if self.frame is not None:
7350 wx.CallAfter(self.frame.Close)
7351
7352
7353 def flush(self):
7354 pass
7355
7356
7357
7358 #----------------------------------------------------------------------
7359
7360 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7361
7362 class App(wx.PyApp):
7363 """
7364 The ``wx.App`` class represents the application and is used to:
7365
7366 * bootstrap the wxPython system and initialize the underlying
7367 gui toolkit
7368 * set and get application-wide properties
7369 * implement the windowing system main message or event loop,
7370 and to dispatch events to window instances
7371 * etc.
7372
7373 Every application must have a ``wx.App`` instance, and all
7374 creation of UI objects should be delayed until after the
7375 ``wx.App`` object has been created in order to ensure that the gui
7376 platform and wxWidgets have been fully initialized.
7377
7378 Normally you would derive from this class and implement an
7379 ``OnInit`` method that creates a frame and then calls
7380 ``self.SetTopWindow(frame)``.
7381
7382 :see: `wx.PySimpleApp` for a simpler app class that can be used
7383 directly.
7384 """
7385
7386 outputWindowClass = PyOnDemandOutputWindow
7387
7388 def __init__(self, redirect=_defRedirect, filename=None,
7389 useBestVisual=False, clearSigInt=True):
7390 """
7391 Construct a ``wx.App`` object.
7392
7393 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7394 redirected? Defaults to True on Windows and Mac, False
7395 otherwise. If `filename` is None then output will be
7396 redirected to a window that pops up as needed. (You can
7397 control what kind of window is created for the output by
7398 resetting the class variable ``outputWindowClass`` to a
7399 class of your choosing.)
7400
7401 :param filename: The name of a file to redirect output to, if
7402 redirect is True.
7403
7404 :param useBestVisual: Should the app try to use the best
7405 available visual provided by the system (only relevant on
7406 systems that have more than one visual.) This parameter
7407 must be used instead of calling `SetUseBestVisual` later
7408 on because it must be set before the underlying GUI
7409 toolkit is initialized.
7410
7411 :param clearSigInt: Should SIGINT be cleared? This allows the
7412 app to terminate upon a Ctrl-C in the console like other
7413 GUI apps will.
7414
7415 :note: You should override OnInit to do applicaition
7416 initialization to ensure that the system, toolkit and
7417 wxWidgets are fully initialized.
7418 """
7419
7420 wx.PyApp.__init__(self)
7421
7422 # make sure we can create a GUI
7423 if not self.IsDisplayAvailable():
7424
7425 if wx.Platform == "__WXMAC__":
7426 msg = """This program needs access to the screen.
7427 Please run with 'pythonw', not 'python', and only when you are logged
7428 in on the main display of your Mac."""
7429
7430 elif wx.Platform == "__WXGTK__":
7431 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7432
7433 else:
7434 msg = "Unable to create GUI"
7435 # TODO: more description is needed for wxMSW...
7436
7437 raise SystemExit(msg)
7438
7439 # This has to be done before OnInit
7440 self.SetUseBestVisual(useBestVisual)
7441
7442 # Set the default handler for SIGINT. This fixes a problem
7443 # where if Ctrl-C is pressed in the console that started this
7444 # app then it will not appear to do anything, (not even send
7445 # KeyboardInterrupt???) but will later segfault on exit. By
7446 # setting the default handler then the app will exit, as
7447 # expected (depending on platform.)
7448 if clearSigInt:
7449 try:
7450 import signal
7451 signal.signal(signal.SIGINT, signal.SIG_DFL)
7452 except:
7453 pass
7454
7455 # Save and redirect the stdio to a window?
7456 self.stdioWin = None
7457 self.saveStdio = (_sys.stdout, _sys.stderr)
7458 if redirect:
7459 self.RedirectStdio(filename)
7460
7461 # Use Python's install prefix as the default
7462 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7463
7464 # This finishes the initialization of wxWindows and then calls
7465 # the OnInit that should be present in the derived class
7466 self._BootstrapApp()
7467
7468
7469 def OnPreInit(self):
7470 """
7471 Things that must be done after _BootstrapApp has done its
7472 thing, but would be nice if they were already done by the time
7473 that OnInit is called.
7474 """
7475 wx.StockGDI._initStockObjects()
7476
7477
7478 def __del__(self, destroy=wx.PyApp.__del__):
7479 self.RestoreStdio() # Just in case the MainLoop was overridden
7480 destroy(self)
7481
7482 def Destroy(self):
7483 wx.PyApp.Destroy(self)
7484 self.thisown = 0
7485
7486 def SetTopWindow(self, frame):
7487 """Set the \"main\" top level window"""
7488 if self.stdioWin:
7489 self.stdioWin.SetParent(frame)
7490 wx.PyApp.SetTopWindow(self, frame)
7491
7492
7493 def MainLoop(self):
7494 """Execute the main GUI event loop"""
7495 wx.PyApp.MainLoop(self)
7496 self.RestoreStdio()
7497
7498
7499 def RedirectStdio(self, filename=None):
7500 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7501 if filename:
7502 _sys.stdout = _sys.stderr = open(filename, 'a')
7503 else:
7504 self.stdioWin = self.outputWindowClass()
7505 _sys.stdout = _sys.stderr = self.stdioWin
7506
7507
7508 def RestoreStdio(self):
7509 try:
7510 _sys.stdout, _sys.stderr = self.saveStdio
7511 except:
7512 pass
7513
7514
7515 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7516 """
7517 Set the title, position and/or size of the output window if
7518 the stdio has been redirected. This should be called before
7519 any output would cause the output window to be created.
7520 """
7521 if self.stdioWin:
7522 if title is not None:
7523 self.stdioWin.title = title
7524 if pos is not None:
7525 self.stdioWin.pos = pos
7526 if size is not None:
7527 self.stdioWin.size = size
7528
7529
7530
7531
7532 # change from wx.PyApp_XX to wx.App_XX
7533 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7534 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7535 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7536 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7537 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7538 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7539 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7540 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7541 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7542 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7543 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7544
7545 #----------------------------------------------------------------------------
7546
7547 class PySimpleApp(wx.App):
7548 """
7549 A simple application class. You can just create one of these and
7550 then then make your top level windows later, and not have to worry
7551 about OnInit. For example::
7552
7553 app = wx.PySimpleApp()
7554 frame = wx.Frame(None, title='Hello World')
7555 frame.Show()
7556 app.MainLoop()
7557
7558 :see: `wx.App`
7559 """
7560
7561 def __init__(self, redirect=False, filename=None,
7562 useBestVisual=False, clearSigInt=True):
7563 """
7564 :see: `wx.App.__init__`
7565 """
7566 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7567
7568 def OnInit(self):
7569 return True
7570
7571
7572
7573 # Is anybody using this one?
7574 class PyWidgetTester(wx.App):
7575 def __init__(self, size = (250, 100)):
7576 self.size = size
7577 wx.App.__init__(self, 0)
7578
7579 def OnInit(self):
7580 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7581 self.SetTopWindow(self.frame)
7582 return True
7583
7584 def SetWidget(self, widgetClass, *args, **kwargs):
7585 w = widgetClass(self.frame, *args, **kwargs)
7586 self.frame.Show(True)
7587
7588 #----------------------------------------------------------------------------
7589 # DO NOT hold any other references to this object. This is how we
7590 # know when to cleanup system resources that wxWidgets is holding. When
7591 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7592 # goes to zero and it calls the wx.App_CleanUp function.
7593
7594 class __wxPyCleanup:
7595 def __init__(self):
7596 self.cleanup = _core_.App_CleanUp
7597 def __del__(self):
7598 self.cleanup()
7599
7600 _sys.__wxPythonCleanup = __wxPyCleanup()
7601
7602 ## # another possible solution, but it gets called too early...
7603 ## import atexit
7604 ## atexit.register(_core_.wxApp_CleanUp)
7605
7606
7607 #----------------------------------------------------------------------------
7608
7609 #---------------------------------------------------------------------------
7610
7611 class EventLoop(object):
7612 """Proxy of C++ EventLoop class"""
7613 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7614 __repr__ = _swig_repr
7615 def __init__(self, *args, **kwargs):
7616 """__init__(self) -> EventLoop"""
7617 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7618 __swig_destroy__ = _core_.delete_EventLoop
7619 __del__ = lambda self : None;
7620 def Run(*args, **kwargs):
7621 """Run(self) -> int"""
7622 return _core_.EventLoop_Run(*args, **kwargs)
7623
7624 def Exit(*args, **kwargs):
7625 """Exit(self, int rc=0)"""
7626 return _core_.EventLoop_Exit(*args, **kwargs)
7627
7628 def Pending(*args, **kwargs):
7629 """Pending(self) -> bool"""
7630 return _core_.EventLoop_Pending(*args, **kwargs)
7631
7632 def Dispatch(*args, **kwargs):
7633 """Dispatch(self) -> bool"""
7634 return _core_.EventLoop_Dispatch(*args, **kwargs)
7635
7636 def IsRunning(*args, **kwargs):
7637 """IsRunning(self) -> bool"""
7638 return _core_.EventLoop_IsRunning(*args, **kwargs)
7639
7640 def GetActive(*args, **kwargs):
7641 """GetActive() -> EventLoop"""
7642 return _core_.EventLoop_GetActive(*args, **kwargs)
7643
7644 GetActive = staticmethod(GetActive)
7645 def SetActive(*args, **kwargs):
7646 """SetActive(EventLoop loop)"""
7647 return _core_.EventLoop_SetActive(*args, **kwargs)
7648
7649 SetActive = staticmethod(SetActive)
7650 _core_.EventLoop_swigregister(EventLoop)
7651
7652 def EventLoop_GetActive(*args):
7653 """EventLoop_GetActive() -> EventLoop"""
7654 return _core_.EventLoop_GetActive(*args)
7655
7656 def EventLoop_SetActive(*args, **kwargs):
7657 """EventLoop_SetActive(EventLoop loop)"""
7658 return _core_.EventLoop_SetActive(*args, **kwargs)
7659
7660 class EventLoopActivator(object):
7661 """Proxy of C++ EventLoopActivator class"""
7662 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7663 __repr__ = _swig_repr
7664 def __init__(self, *args, **kwargs):
7665 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7666 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7667 __swig_destroy__ = _core_.delete_EventLoopActivator
7668 __del__ = lambda self : None;
7669 _core_.EventLoopActivator_swigregister(EventLoopActivator)
7670
7671 #---------------------------------------------------------------------------
7672
7673 ACCEL_ALT = _core_.ACCEL_ALT
7674 ACCEL_CTRL = _core_.ACCEL_CTRL
7675 ACCEL_SHIFT = _core_.ACCEL_SHIFT
7676 ACCEL_NORMAL = _core_.ACCEL_NORMAL
7677 ACCEL_CMD = _core_.ACCEL_CMD
7678 class AcceleratorEntry(object):
7679 """
7680 A class used to define items in an `wx.AcceleratorTable`. wxPython
7681 programs can choose to use wx.AcceleratorEntry objects, but using a
7682 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7683 as well. See `__init__` for of the tuple values.
7684
7685 :see: `wx.AcceleratorTable`
7686 """
7687 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7688 __repr__ = _swig_repr
7689 def __init__(self, *args, **kwargs):
7690 """
7691 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7692
7693 Construct a wx.AcceleratorEntry.
7694 """
7695 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7696 __swig_destroy__ = _core_.delete_AcceleratorEntry
7697 __del__ = lambda self : None;
7698 def Set(*args, **kwargs):
7699 """
7700 Set(self, int flags, int keyCode, int cmd)
7701
7702 (Re)set the attributes of a wx.AcceleratorEntry.
7703 :see `__init__`
7704 """
7705 return _core_.AcceleratorEntry_Set(*args, **kwargs)
7706
7707 def Create(*args, **kwargs):
7708 """
7709 Create(String str) -> AcceleratorEntry
7710
7711 Create accelerator corresponding to the specified string, or None if
7712 it coulnd't be parsed.
7713 """
7714 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7715
7716 Create = staticmethod(Create)
7717 def GetFlags(*args, **kwargs):
7718 """
7719 GetFlags(self) -> int
7720
7721 Get the AcceleratorEntry's flags.
7722 """
7723 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7724
7725 def GetKeyCode(*args, **kwargs):
7726 """
7727 GetKeyCode(self) -> int
7728
7729 Get the AcceleratorEntry's keycode.
7730 """
7731 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7732
7733 def GetCommand(*args, **kwargs):
7734 """
7735 GetCommand(self) -> int
7736
7737 Get the AcceleratorEntry's command ID.
7738 """
7739 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7740
7741 def IsOk(*args, **kwargs):
7742 """IsOk(self) -> bool"""
7743 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
7744
7745 def ToString(*args, **kwargs):
7746 """
7747 ToString(self) -> String
7748
7749 Returns a string representation for the this accelerator. The string
7750 is formatted using the <flags>-<keycode> format where <flags> maybe a
7751 hyphen-separed list of "shift|alt|ctrl"
7752
7753 """
7754 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
7755
7756 def FromString(*args, **kwargs):
7757 """
7758 FromString(self, String str) -> bool
7759
7760 Returns true if the given string correctly initialized this object.
7761 """
7762 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
7763
7764 Command = property(GetCommand,doc="See `GetCommand`")
7765 Flags = property(GetFlags,doc="See `GetFlags`")
7766 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
7767 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
7768
7769 def AcceleratorEntry_Create(*args, **kwargs):
7770 """
7771 AcceleratorEntry_Create(String str) -> AcceleratorEntry
7772
7773 Create accelerator corresponding to the specified string, or None if
7774 it coulnd't be parsed.
7775 """
7776 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7777
7778 class AcceleratorTable(Object):
7779 """
7780 An accelerator table allows the application to specify a table of
7781 keyboard shortcuts for menus or other commands. On Windows, menu or
7782 button commands are supported; on GTK, only menu commands are
7783 supported.
7784 """
7785 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7786 __repr__ = _swig_repr
7787 def __init__(self, *args, **kwargs):
7788 """
7789 __init__(entries) -> AcceleratorTable
7790
7791 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7792 items or or of 3-tuples (flags, keyCode, cmdID)
7793
7794 :see: `wx.AcceleratorEntry`
7795 """
7796 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
7797 __swig_destroy__ = _core_.delete_AcceleratorTable
7798 __del__ = lambda self : None;
7799 def Ok(*args, **kwargs):
7800 """Ok(self) -> bool"""
7801 return _core_.AcceleratorTable_Ok(*args, **kwargs)
7802
7803 _core_.AcceleratorTable_swigregister(AcceleratorTable)
7804
7805
7806 def GetAccelFromString(*args, **kwargs):
7807 """GetAccelFromString(String label) -> AcceleratorEntry"""
7808 return _core_.GetAccelFromString(*args, **kwargs)
7809 #---------------------------------------------------------------------------
7810
7811 class VisualAttributes(object):
7812 """struct containing all the visual attributes of a control"""
7813 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7814 __repr__ = _swig_repr
7815 def __init__(self, *args, **kwargs):
7816 """
7817 __init__(self) -> VisualAttributes
7818
7819 struct containing all the visual attributes of a control
7820 """
7821 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
7822 __swig_destroy__ = _core_.delete_VisualAttributes
7823 __del__ = lambda self : None;
7824 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
7825 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
7826 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
7827 _core_.VisualAttributes_swigregister(VisualAttributes)
7828 NullAcceleratorTable = cvar.NullAcceleratorTable
7829 PanelNameStr = cvar.PanelNameStr
7830
7831 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
7832 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
7833 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
7834 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
7835 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
7836 class Window(EvtHandler):
7837 """
7838 wx.Window is the base class for all windows and represents any visible
7839 object on the screen. All controls, top level windows and so on are
7840 wx.Windows. Sizers and device contexts are not however, as they don't
7841 appear on screen themselves.
7842
7843 """
7844 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7845 __repr__ = _swig_repr
7846 def __init__(self, *args, **kwargs):
7847 """
7848 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
7849 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
7850
7851 Construct and show a generic Window.
7852 """
7853 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
7854 self._setOORInfo(self)
7855
7856 def Create(*args, **kwargs):
7857 """
7858 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
7859 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
7860
7861 Create the GUI part of the Window for 2-phase creation mode.
7862 """
7863 return _core_.Window_Create(*args, **kwargs)
7864
7865 def Close(*args, **kwargs):
7866 """
7867 Close(self, bool force=False) -> bool
7868
7869 This function simply generates a EVT_CLOSE event whose handler usually
7870 tries to close the window. It doesn't close the window itself,
7871 however. If force is False (the default) then the window's close
7872 handler will be allowed to veto the destruction of the window.
7873 """
7874 return _core_.Window_Close(*args, **kwargs)
7875
7876 def Destroy(*args, **kwargs):
7877 """
7878 Destroy(self) -> bool
7879
7880 Destroys the window safely. Frames and dialogs are not destroyed
7881 immediately when this function is called -- they are added to a list
7882 of windows to be deleted on idle time, when all the window's events
7883 have been processed. This prevents problems with events being sent to
7884 non-existent windows.
7885
7886 Returns True if the window has either been successfully deleted, or it
7887 has been added to the list of windows pending real deletion.
7888 """
7889 val = _core_.Window_Destroy(*args, **kwargs)
7890 args[0].thisown = 0
7891 return val
7892
7893 def DestroyChildren(*args, **kwargs):
7894 """
7895 DestroyChildren(self) -> bool
7896
7897 Destroys all children of a window. Called automatically by the
7898 destructor.
7899 """
7900 return _core_.Window_DestroyChildren(*args, **kwargs)
7901
7902 def IsBeingDeleted(*args, **kwargs):
7903 """
7904 IsBeingDeleted(self) -> bool
7905
7906 Is the window in the process of being deleted?
7907 """
7908 return _core_.Window_IsBeingDeleted(*args, **kwargs)
7909
7910 def SetLabel(*args, **kwargs):
7911 """
7912 SetLabel(self, String label)
7913
7914 Set the text which the window shows in its label if applicable.
7915 """
7916 return _core_.Window_SetLabel(*args, **kwargs)
7917
7918 def GetLabel(*args, **kwargs):
7919 """
7920 GetLabel(self) -> String
7921
7922 Generic way of getting a label from any window, for identification
7923 purposes. The interpretation of this function differs from class to
7924 class. For frames and dialogs, the value returned is the title. For
7925 buttons or static text controls, it is the button text. This function
7926 can be useful for meta-programs such as testing tools or special-needs
7927 access programs)which need to identify windows by name.
7928 """
7929 return _core_.Window_GetLabel(*args, **kwargs)
7930
7931 def SetName(*args, **kwargs):
7932 """
7933 SetName(self, String name)
7934
7935 Sets the window's name. The window name is used for ressource setting
7936 in X, it is not the same as the window title/label
7937 """
7938 return _core_.Window_SetName(*args, **kwargs)
7939
7940 def GetName(*args, **kwargs):
7941 """
7942 GetName(self) -> String
7943
7944 Returns the windows name. This name is not guaranteed to be unique;
7945 it is up to the programmer to supply an appropriate name in the window
7946 constructor or via wx.Window.SetName.
7947 """
7948 return _core_.Window_GetName(*args, **kwargs)
7949
7950 def SetWindowVariant(*args, **kwargs):
7951 """
7952 SetWindowVariant(self, int variant)
7953
7954 Sets the variant of the window/font size to use for this window, if
7955 the platform supports variants, for example, wxMac.
7956 """
7957 return _core_.Window_SetWindowVariant(*args, **kwargs)
7958
7959 def GetWindowVariant(*args, **kwargs):
7960 """GetWindowVariant(self) -> int"""
7961 return _core_.Window_GetWindowVariant(*args, **kwargs)
7962
7963 def SetId(*args, **kwargs):
7964 """
7965 SetId(self, int winid)
7966
7967 Sets the identifier of the window. Each window has an integer
7968 identifier. If the application has not provided one, an identifier
7969 will be generated. Normally, the identifier should be provided on
7970 creation and should not be modified subsequently.
7971 """
7972 return _core_.Window_SetId(*args, **kwargs)
7973
7974 def GetId(*args, **kwargs):
7975 """
7976 GetId(self) -> int
7977
7978 Returns the identifier of the window. Each window has an integer
7979 identifier. If the application has not provided one (or the default Id
7980 -1 is used) then an unique identifier with a negative value will be
7981 generated.
7982 """
7983 return _core_.Window_GetId(*args, **kwargs)
7984
7985 def NewControlId(*args, **kwargs):
7986 """
7987 NewControlId() -> int
7988
7989 Generate a control id for the controls which were not given one.
7990 """
7991 return _core_.Window_NewControlId(*args, **kwargs)
7992
7993 NewControlId = staticmethod(NewControlId)
7994 def NextControlId(*args, **kwargs):
7995 """
7996 NextControlId(int winid) -> int
7997
7998 Get the id of the control following the one with the given
7999 autogenerated) id
8000 """
8001 return _core_.Window_NextControlId(*args, **kwargs)
8002
8003 NextControlId = staticmethod(NextControlId)
8004 def PrevControlId(*args, **kwargs):
8005 """
8006 PrevControlId(int winid) -> int
8007
8008 Get the id of the control preceding the one with the given
8009 autogenerated) id
8010 """
8011 return _core_.Window_PrevControlId(*args, **kwargs)
8012
8013 PrevControlId = staticmethod(PrevControlId)
8014 def GetLayoutDirection(*args, **kwargs):
8015 """
8016 GetLayoutDirection(self) -> int
8017
8018 Get the layout direction (LTR or RTL) for this window. Returns
8019 ``wx.Layout_Default`` if layout direction is not supported.
8020 """
8021 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8022
8023 def SetLayoutDirection(*args, **kwargs):
8024 """
8025 SetLayoutDirection(self, int dir)
8026
8027 Set the layout direction (LTR or RTL) for this window.
8028 """
8029 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8030
8031 def AdjustForLayoutDirection(*args, **kwargs):
8032 """
8033 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8034
8035 Mirror coordinates for RTL layout if this window uses it and if the
8036 mirroring is not done automatically like Win32.
8037 """
8038 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8039
8040 def SetSize(*args, **kwargs):
8041 """
8042 SetSize(self, Size size)
8043
8044 Sets the size of the window in pixels.
8045 """
8046 return _core_.Window_SetSize(*args, **kwargs)
8047
8048 def SetDimensions(*args, **kwargs):
8049 """
8050 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8051
8052 Sets the position and size of the window in pixels. The sizeFlags
8053 parameter indicates the interpretation of the other params if they are
8054 equal to -1.
8055
8056 ======================== ======================================
8057 wx.SIZE_AUTO A -1 indicates that a class-specific
8058 default should be used.
8059 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8060 -1 values are supplied.
8061 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8062 interpreted as real dimensions, not
8063 default values.
8064 ======================== ======================================
8065
8066 """
8067 return _core_.Window_SetDimensions(*args, **kwargs)
8068
8069 def SetRect(*args, **kwargs):
8070 """
8071 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8072
8073 Sets the position and size of the window in pixels using a wx.Rect.
8074 """
8075 return _core_.Window_SetRect(*args, **kwargs)
8076
8077 def SetSizeWH(*args, **kwargs):
8078 """
8079 SetSizeWH(self, int width, int height)
8080
8081 Sets the size of the window in pixels.
8082 """
8083 return _core_.Window_SetSizeWH(*args, **kwargs)
8084
8085 def Move(*args, **kwargs):
8086 """
8087 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8088
8089 Moves the window to the given position.
8090 """
8091 return _core_.Window_Move(*args, **kwargs)
8092
8093 SetPosition = Move
8094 def MoveXY(*args, **kwargs):
8095 """
8096 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8097
8098 Moves the window to the given position.
8099 """
8100 return _core_.Window_MoveXY(*args, **kwargs)
8101
8102 def SetBestFittingSize(*args, **kwargs):
8103 """
8104 SetBestFittingSize(self, Size size=DefaultSize)
8105
8106 A 'Smart' SetSize that will fill in default size components with the
8107 window's *best size* values. Also set's the minsize for use with sizers.
8108 """
8109 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8110
8111 def Raise(*args, **kwargs):
8112 """
8113 Raise(self)
8114
8115 Raises the window to the top of the window hierarchy. In current
8116 version of wxWidgets this works both for manage and child windows.
8117 """
8118 return _core_.Window_Raise(*args, **kwargs)
8119
8120 def Lower(*args, **kwargs):
8121 """
8122 Lower(self)
8123
8124 Lowers the window to the bottom of the window hierarchy. In current
8125 version of wxWidgets this works both for manage and child windows.
8126 """
8127 return _core_.Window_Lower(*args, **kwargs)
8128
8129 def SetClientSize(*args, **kwargs):
8130 """
8131 SetClientSize(self, Size size)
8132
8133 This sets the size of the window client area in pixels. Using this
8134 function to size a window tends to be more device-independent than
8135 wx.Window.SetSize, since the application need not worry about what
8136 dimensions the border or title bar have when trying to fit the window
8137 around panel items, for example.
8138 """
8139 return _core_.Window_SetClientSize(*args, **kwargs)
8140
8141 def SetClientSizeWH(*args, **kwargs):
8142 """
8143 SetClientSizeWH(self, int width, int height)
8144
8145 This sets the size of the window client area in pixels. Using this
8146 function to size a window tends to be more device-independent than
8147 wx.Window.SetSize, since the application need not worry about what
8148 dimensions the border or title bar have when trying to fit the window
8149 around panel items, for example.
8150 """
8151 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8152
8153 def SetClientRect(*args, **kwargs):
8154 """
8155 SetClientRect(self, Rect rect)
8156
8157 This sets the size of the window client area in pixels. Using this
8158 function to size a window tends to be more device-independent than
8159 wx.Window.SetSize, since the application need not worry about what
8160 dimensions the border or title bar have when trying to fit the window
8161 around panel items, for example.
8162 """
8163 return _core_.Window_SetClientRect(*args, **kwargs)
8164
8165 def GetPosition(*args, **kwargs):
8166 """
8167 GetPosition(self) -> Point
8168
8169 Get the window's position. Notice that the position is in client
8170 coordinates for child windows and screen coordinates for the top level
8171 ones, use `GetScreenPosition` if you need screen coordinates for all
8172 kinds of windows.
8173 """
8174 return _core_.Window_GetPosition(*args, **kwargs)
8175
8176 def GetPositionTuple(*args, **kwargs):
8177 """
8178 GetPositionTuple() -> (x,y)
8179
8180 Get the window's position. Notice that the position is in client
8181 coordinates for child windows and screen coordinates for the top level
8182 ones, use `GetScreenPosition` if you need screen coordinates for all
8183 kinds of windows.
8184 """
8185 return _core_.Window_GetPositionTuple(*args, **kwargs)
8186
8187 def GetScreenPosition(*args, **kwargs):
8188 """
8189 GetScreenPosition(self) -> Point
8190
8191 Get the position of the window in screen coordinantes.
8192 """
8193 return _core_.Window_GetScreenPosition(*args, **kwargs)
8194
8195 def GetScreenPositionTuple(*args, **kwargs):
8196 """
8197 GetScreenPositionTuple() -> (x,y)
8198
8199 Get the position of the window in screen coordinantes.
8200 """
8201 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8202
8203 def GetScreenRect(*args, **kwargs):
8204 """
8205 GetScreenRect(self) -> Rect
8206
8207 Returns the size and position of the window in screen coordinantes as
8208 a `wx.Rect` object.
8209 """
8210 return _core_.Window_GetScreenRect(*args, **kwargs)
8211
8212 def GetSize(*args, **kwargs):
8213 """
8214 GetSize(self) -> Size
8215
8216 Get the window size.
8217 """
8218 return _core_.Window_GetSize(*args, **kwargs)
8219
8220 def GetSizeTuple(*args, **kwargs):
8221 """
8222 GetSizeTuple() -> (width, height)
8223
8224 Get the window size.
8225 """
8226 return _core_.Window_GetSizeTuple(*args, **kwargs)
8227
8228 def GetRect(*args, **kwargs):
8229 """
8230 GetRect(self) -> Rect
8231
8232 Returns the size and position of the window as a `wx.Rect` object.
8233 """
8234 return _core_.Window_GetRect(*args, **kwargs)
8235
8236 def GetClientSize(*args, **kwargs):
8237 """
8238 GetClientSize(self) -> Size
8239
8240 This gets the size of the window's 'client area' in pixels. The client
8241 area is the area which may be drawn on by the programmer, excluding
8242 title bar, border, scrollbars, etc.
8243 """
8244 return _core_.Window_GetClientSize(*args, **kwargs)
8245
8246 def GetClientSizeTuple(*args, **kwargs):
8247 """
8248 GetClientSizeTuple() -> (width, height)
8249
8250 This gets the size of the window's 'client area' in pixels. The client
8251 area is the area which may be drawn on by the programmer, excluding
8252 title bar, border, scrollbars, etc.
8253 """
8254 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8255
8256 def GetClientAreaOrigin(*args, **kwargs):
8257 """
8258 GetClientAreaOrigin(self) -> Point
8259
8260 Get the origin of the client area of the window relative to the
8261 window's top left corner (the client area may be shifted because of
8262 the borders, scrollbars, other decorations...)
8263 """
8264 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8265
8266 def GetClientRect(*args, **kwargs):
8267 """
8268 GetClientRect(self) -> Rect
8269
8270 Get the client area position and size as a `wx.Rect` object.
8271 """
8272 return _core_.Window_GetClientRect(*args, **kwargs)
8273
8274 def GetBestSize(*args, **kwargs):
8275 """
8276 GetBestSize(self) -> Size
8277
8278 This function returns the best acceptable minimal size for the
8279 window, if applicable. For example, for a static text control, it will
8280 be the minimal size such that the control label is not truncated. For
8281 windows containing subwindows (suzh aswx.Panel), the size returned by
8282 this function will be the same as the size the window would have had
8283 after calling Fit.
8284 """
8285 return _core_.Window_GetBestSize(*args, **kwargs)
8286
8287 def GetBestSizeTuple(*args, **kwargs):
8288 """
8289 GetBestSizeTuple() -> (width, height)
8290
8291 This function returns the best acceptable minimal size for the
8292 window, if applicable. For example, for a static text control, it will
8293 be the minimal size such that the control label is not truncated. For
8294 windows containing subwindows (suzh aswx.Panel), the size returned by
8295 this function will be the same as the size the window would have had
8296 after calling Fit.
8297 """
8298 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8299
8300 def InvalidateBestSize(*args, **kwargs):
8301 """
8302 InvalidateBestSize(self)
8303
8304 Reset the cached best size value so it will be recalculated the next
8305 time it is needed.
8306 """
8307 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8308
8309 def CacheBestSize(*args, **kwargs):
8310 """
8311 CacheBestSize(self, Size size)
8312
8313 Cache the best size so it doesn't need to be calculated again, (at least until
8314 some properties of the window change.)
8315 """
8316 return _core_.Window_CacheBestSize(*args, **kwargs)
8317
8318 def GetBestFittingSize(*args, **kwargs):
8319 """
8320 GetBestFittingSize(self) -> Size
8321
8322 This function will merge the window's best size into the window's
8323 minimum size, giving priority to the min size components, and returns
8324 the results.
8325
8326 """
8327 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8328
8329 def GetAdjustedBestSize(*args, **kwargs):
8330 """
8331 GetAdjustedBestSize(self) -> Size
8332
8333 This method is similar to GetBestSize, except in one
8334 thing. GetBestSize should return the minimum untruncated size of the
8335 window, while this method will return the largest of BestSize and any
8336 user specified minimum size. ie. it is the minimum size the window
8337 should currently be drawn at, not the minimal size it can possibly
8338 tolerate.
8339 """
8340 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8341
8342 def Center(*args, **kwargs):
8343 """
8344 Center(self, int direction=BOTH)
8345
8346 Centers the window. The parameter specifies the direction for
8347 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8348 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8349 on the entire screen and not on its parent window. If it is a
8350 top-level window and has no parent then it will always be centered
8351 relative to the screen.
8352 """
8353 return _core_.Window_Center(*args, **kwargs)
8354
8355 Centre = Center
8356 def CenterOnParent(*args, **kwargs):
8357 """
8358 CenterOnParent(self, int dir=BOTH)
8359
8360 Center with respect to the the parent window
8361 """
8362 return _core_.Window_CenterOnParent(*args, **kwargs)
8363
8364 CentreOnParent = CenterOnParent
8365 def Fit(*args, **kwargs):
8366 """
8367 Fit(self)
8368
8369 Sizes the window so that it fits around its subwindows. This function
8370 won't do anything if there are no subwindows and will only really work
8371 correctly if sizers are used for the subwindows layout. Also, if the
8372 window has exactly one subwindow it is better (faster and the result
8373 is more precise as Fit adds some margin to account for fuzziness of
8374 its calculations) to call window.SetClientSize(child.GetSize())
8375 instead of calling Fit.
8376 """
8377 return _core_.Window_Fit(*args, **kwargs)
8378
8379 def FitInside(*args, **kwargs):
8380 """
8381 FitInside(self)
8382
8383 Similar to Fit, but sizes the interior (virtual) size of a
8384 window. Mainly useful with scrolled windows to reset scrollbars after
8385 sizing changes that do not trigger a size event, and/or scrolled
8386 windows without an interior sizer. This function similarly won't do
8387 anything if there are no subwindows.
8388 """
8389 return _core_.Window_FitInside(*args, **kwargs)
8390
8391 def SetSizeHints(*args, **kwargs):
8392 """
8393 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8394 int incH=-1)
8395
8396 Allows specification of minimum and maximum window sizes, and window
8397 size increments. If a pair of values is not set (or set to -1), the
8398 default values will be used. If this function is called, the user
8399 will not be able to size the window outside the given bounds (if it is
8400 a top-level window.) Sizers will also inspect the minimum window size
8401 and will use that value if set when calculating layout.
8402
8403 The resizing increments are only significant under Motif or Xt.
8404 """
8405 return _core_.Window_SetSizeHints(*args, **kwargs)
8406
8407 def SetSizeHintsSz(*args, **kwargs):
8408 """
8409 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8410
8411 Allows specification of minimum and maximum window sizes, and window
8412 size increments. If a pair of values is not set (or set to -1), the
8413 default values will be used. If this function is called, the user
8414 will not be able to size the window outside the given bounds (if it is
8415 a top-level window.) Sizers will also inspect the minimum window size
8416 and will use that value if set when calculating layout.
8417
8418 The resizing increments are only significant under Motif or Xt.
8419 """
8420 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8421
8422 def SetVirtualSizeHints(*args, **kwargs):
8423 """
8424 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8425
8426 Allows specification of minimum and maximum virtual window sizes. If a
8427 pair of values is not set (or set to -1), the default values will be
8428 used. If this function is called, the user will not be able to size
8429 the virtual area of the window outside the given bounds.
8430 """
8431 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8432
8433 def SetVirtualSizeHintsSz(*args, **kwargs):
8434 """
8435 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8436
8437 Allows specification of minimum and maximum virtual window sizes. If a
8438 pair of values is not set (or set to -1), the default values will be
8439 used. If this function is called, the user will not be able to size
8440 the virtual area of the window outside the given bounds.
8441 """
8442 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8443
8444 def GetMaxSize(*args, **kwargs):
8445 """GetMaxSize(self) -> Size"""
8446 return _core_.Window_GetMaxSize(*args, **kwargs)
8447
8448 def GetMinSize(*args, **kwargs):
8449 """GetMinSize(self) -> Size"""
8450 return _core_.Window_GetMinSize(*args, **kwargs)
8451
8452 def SetMinSize(*args, **kwargs):
8453 """
8454 SetMinSize(self, Size minSize)
8455
8456 A more convenient method than `SetSizeHints` for setting just the
8457 min size.
8458 """
8459 return _core_.Window_SetMinSize(*args, **kwargs)
8460
8461 def SetMaxSize(*args, **kwargs):
8462 """
8463 SetMaxSize(self, Size maxSize)
8464
8465 A more convenient method than `SetSizeHints` for setting just the
8466 max size.
8467 """
8468 return _core_.Window_SetMaxSize(*args, **kwargs)
8469
8470 def GetMinWidth(*args, **kwargs):
8471 """GetMinWidth(self) -> int"""
8472 return _core_.Window_GetMinWidth(*args, **kwargs)
8473
8474 def GetMinHeight(*args, **kwargs):
8475 """GetMinHeight(self) -> int"""
8476 return _core_.Window_GetMinHeight(*args, **kwargs)
8477
8478 def GetMaxWidth(*args, **kwargs):
8479 """GetMaxWidth(self) -> int"""
8480 return _core_.Window_GetMaxWidth(*args, **kwargs)
8481
8482 def GetMaxHeight(*args, **kwargs):
8483 """GetMaxHeight(self) -> int"""
8484 return _core_.Window_GetMaxHeight(*args, **kwargs)
8485
8486 def SetVirtualSize(*args, **kwargs):
8487 """
8488 SetVirtualSize(self, Size size)
8489
8490 Set the the virtual size of a window in pixels. For most windows this
8491 is just the client area of the window, but for some like scrolled
8492 windows it is more or less independent of the screen window size.
8493 """
8494 return _core_.Window_SetVirtualSize(*args, **kwargs)
8495
8496 def SetVirtualSizeWH(*args, **kwargs):
8497 """
8498 SetVirtualSizeWH(self, int w, int h)
8499
8500 Set the the virtual size of a window in pixels. For most windows this
8501 is just the client area of the window, but for some like scrolled
8502 windows it is more or less independent of the screen window size.
8503 """
8504 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8505
8506 def GetVirtualSize(*args, **kwargs):
8507 """
8508 GetVirtualSize(self) -> Size
8509
8510 Get the the virtual size of the window in pixels. For most windows
8511 this is just the client area of the window, but for some like scrolled
8512 windows it is more or less independent of the screen window size.
8513 """
8514 return _core_.Window_GetVirtualSize(*args, **kwargs)
8515
8516 def GetVirtualSizeTuple(*args, **kwargs):
8517 """
8518 GetVirtualSizeTuple() -> (width, height)
8519
8520 Get the the virtual size of the window in pixels. For most windows
8521 this is just the client area of the window, but for some like scrolled
8522 windows it is more or less independent of the screen window size.
8523 """
8524 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8525
8526 def GetBestVirtualSize(*args, **kwargs):
8527 """
8528 GetBestVirtualSize(self) -> Size
8529
8530 Return the largest of ClientSize and BestSize (as determined by a
8531 sizer, interior children, or other means)
8532 """
8533 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8534
8535 def Show(*args, **kwargs):
8536 """
8537 Show(self, bool show=True) -> bool
8538
8539 Shows or hides the window. You may need to call Raise for a top level
8540 window if you want to bring it to top, although this is not needed if
8541 Show is called immediately after the frame creation. Returns True if
8542 the window has been shown or hidden or False if nothing was done
8543 because it already was in the requested state.
8544 """
8545 return _core_.Window_Show(*args, **kwargs)
8546
8547 def Hide(*args, **kwargs):
8548 """
8549 Hide(self) -> bool
8550
8551 Equivalent to calling Show(False).
8552 """
8553 return _core_.Window_Hide(*args, **kwargs)
8554
8555 def Enable(*args, **kwargs):
8556 """
8557 Enable(self, bool enable=True) -> bool
8558
8559 Enable or disable the window for user input. Note that when a parent
8560 window is disabled, all of its children are disabled as well and they
8561 are reenabled again when the parent is. Returns true if the window
8562 has been enabled or disabled, false if nothing was done, i.e. if the
8563 window had already been in the specified state.
8564 """
8565 return _core_.Window_Enable(*args, **kwargs)
8566
8567 def Disable(*args, **kwargs):
8568 """
8569 Disable(self) -> bool
8570
8571 Disables the window, same as Enable(false).
8572 """
8573 return _core_.Window_Disable(*args, **kwargs)
8574
8575 def IsShown(*args, **kwargs):
8576 """
8577 IsShown(self) -> bool
8578
8579 Returns true if the window is shown, false if it has been hidden.
8580 """
8581 return _core_.Window_IsShown(*args, **kwargs)
8582
8583 def IsEnabled(*args, **kwargs):
8584 """
8585 IsEnabled(self) -> bool
8586
8587 Returns true if the window is enabled for input, false otherwise.
8588 """
8589 return _core_.Window_IsEnabled(*args, **kwargs)
8590
8591 def IsShownOnScreen(*args, **kwargs):
8592 """
8593 IsShownOnScreen(self) -> bool
8594
8595 Returns ``True`` if the window is physically visible on the screen,
8596 i.e. it is shown and all its parents up to the toplevel window are
8597 shown as well.
8598 """
8599 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8600
8601 def SetWindowStyleFlag(*args, **kwargs):
8602 """
8603 SetWindowStyleFlag(self, long style)
8604
8605 Sets the style of the window. Please note that some styles cannot be
8606 changed after the window creation and that Refresh() might need to be
8607 called after changing the others for the change to take place
8608 immediately.
8609 """
8610 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8611
8612 def GetWindowStyleFlag(*args, **kwargs):
8613 """
8614 GetWindowStyleFlag(self) -> long
8615
8616 Gets the window style that was passed to the constructor or Create
8617 method.
8618 """
8619 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8620
8621 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8622 def HasFlag(*args, **kwargs):
8623 """
8624 HasFlag(self, int flag) -> bool
8625
8626 Test if the given style is set for this window.
8627 """
8628 return _core_.Window_HasFlag(*args, **kwargs)
8629
8630 def IsRetained(*args, **kwargs):
8631 """
8632 IsRetained(self) -> bool
8633
8634 Returns true if the window is retained, false otherwise. Retained
8635 windows are only available on X platforms.
8636 """
8637 return _core_.Window_IsRetained(*args, **kwargs)
8638
8639 def SetExtraStyle(*args, **kwargs):
8640 """
8641 SetExtraStyle(self, long exStyle)
8642
8643 Sets the extra style bits for the window. Extra styles are the less
8644 often used style bits which can't be set with the constructor or with
8645 SetWindowStyleFlag()
8646 """
8647 return _core_.Window_SetExtraStyle(*args, **kwargs)
8648
8649 def GetExtraStyle(*args, **kwargs):
8650 """
8651 GetExtraStyle(self) -> long
8652
8653 Returns the extra style bits for the window.
8654 """
8655 return _core_.Window_GetExtraStyle(*args, **kwargs)
8656
8657 def MakeModal(*args, **kwargs):
8658 """
8659 MakeModal(self, bool modal=True)
8660
8661 Disables all other windows in the application so that the user can
8662 only interact with this window. Passing False will reverse this
8663 effect.
8664 """
8665 return _core_.Window_MakeModal(*args, **kwargs)
8666
8667 def SetThemeEnabled(*args, **kwargs):
8668 """
8669 SetThemeEnabled(self, bool enableTheme)
8670
8671 This function tells a window if it should use the system's "theme"
8672 code to draw the windows' background instead if its own background
8673 drawing code. This will only have an effect on platforms that support
8674 the notion of themes in user defined windows. One such platform is
8675 GTK+ where windows can have (very colourful) backgrounds defined by a
8676 user's selected theme.
8677
8678 Dialogs, notebook pages and the status bar have this flag set to true
8679 by default so that the default look and feel is simulated best.
8680 """
8681 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8682
8683 def GetThemeEnabled(*args, **kwargs):
8684 """
8685 GetThemeEnabled(self) -> bool
8686
8687 Return the themeEnabled flag.
8688 """
8689 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8690
8691 def SetFocus(*args, **kwargs):
8692 """
8693 SetFocus(self)
8694
8695 Set's the focus to this window, allowing it to receive keyboard input.
8696 """
8697 return _core_.Window_SetFocus(*args, **kwargs)
8698
8699 def SetFocusFromKbd(*args, **kwargs):
8700 """
8701 SetFocusFromKbd(self)
8702
8703 Set focus to this window as the result of a keyboard action. Normally
8704 only called internally.
8705 """
8706 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8707
8708 def FindFocus(*args, **kwargs):
8709 """
8710 FindFocus() -> Window
8711
8712 Returns the window or control that currently has the keyboard focus,
8713 or None.
8714 """
8715 return _core_.Window_FindFocus(*args, **kwargs)
8716
8717 FindFocus = staticmethod(FindFocus)
8718 def AcceptsFocus(*args, **kwargs):
8719 """
8720 AcceptsFocus(self) -> bool
8721
8722 Can this window have focus?
8723 """
8724 return _core_.Window_AcceptsFocus(*args, **kwargs)
8725
8726 def AcceptsFocusFromKeyboard(*args, **kwargs):
8727 """
8728 AcceptsFocusFromKeyboard(self) -> bool
8729
8730 Can this window be given focus by keyboard navigation? if not, the
8731 only way to give it focus (provided it accepts it at all) is to click
8732 it.
8733 """
8734 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8735
8736 def Navigate(*args, **kwargs):
8737 """
8738 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8739
8740 Does keyboard navigation from this window to another, by sending a
8741 `wx.NavigationKeyEvent`.
8742 """
8743 return _core_.Window_Navigate(*args, **kwargs)
8744
8745 def MoveAfterInTabOrder(*args, **kwargs):
8746 """
8747 MoveAfterInTabOrder(self, Window win)
8748
8749 Moves this window in the tab navigation order after the specified
8750 sibling window. This means that when the user presses the TAB key on
8751 that other window, the focus switches to this window.
8752
8753 The default tab order is the same as creation order. This function
8754 and `MoveBeforeInTabOrder` allow to change it after creating all the
8755 windows.
8756
8757 """
8758 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8759
8760 def MoveBeforeInTabOrder(*args, **kwargs):
8761 """
8762 MoveBeforeInTabOrder(self, Window win)
8763
8764 Same as `MoveAfterInTabOrder` except that it inserts this window just
8765 before win instead of putting it right after it.
8766 """
8767 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8768
8769 def GetChildren(*args, **kwargs):
8770 """
8771 GetChildren(self) -> PyObject
8772
8773 Returns a list of the window's children. NOTE: Currently this is a
8774 copy of the child window list maintained by the window, so the return
8775 value of this function is only valid as long as the window's children
8776 do not change.
8777 """
8778 return _core_.Window_GetChildren(*args, **kwargs)
8779
8780 def GetParent(*args, **kwargs):
8781 """
8782 GetParent(self) -> Window
8783
8784 Returns the parent window of this window, or None if there isn't one.
8785 """
8786 return _core_.Window_GetParent(*args, **kwargs)
8787
8788 def GetGrandParent(*args, **kwargs):
8789 """
8790 GetGrandParent(self) -> Window
8791
8792 Returns the parent of the parent of this window, or None if there
8793 isn't one.
8794 """
8795 return _core_.Window_GetGrandParent(*args, **kwargs)
8796
8797 def IsTopLevel(*args, **kwargs):
8798 """
8799 IsTopLevel(self) -> bool
8800
8801 Returns true if the given window is a top-level one. Currently all
8802 frames and dialogs are always considered to be top-level windows (even
8803 if they have a parent window).
8804 """
8805 return _core_.Window_IsTopLevel(*args, **kwargs)
8806
8807 def Reparent(*args, **kwargs):
8808 """
8809 Reparent(self, Window newParent) -> bool
8810
8811 Reparents the window, i.e the window will be removed from its current
8812 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8813 re-inserted into another. Available on Windows and GTK. Returns True
8814 if the parent was changed, False otherwise (error or newParent ==
8815 oldParent)
8816 """
8817 return _core_.Window_Reparent(*args, **kwargs)
8818
8819 def AddChild(*args, **kwargs):
8820 """
8821 AddChild(self, Window child)
8822
8823 Adds a child window. This is called automatically by window creation
8824 functions so should not be required by the application programmer.
8825 """
8826 return _core_.Window_AddChild(*args, **kwargs)
8827
8828 def RemoveChild(*args, **kwargs):
8829 """
8830 RemoveChild(self, Window child)
8831
8832 Removes a child window. This is called automatically by window
8833 deletion functions so should not be required by the application
8834 programmer.
8835 """
8836 return _core_.Window_RemoveChild(*args, **kwargs)
8837
8838 def SetDoubleBuffered(*args, **kwargs):
8839 """
8840 SetDoubleBuffered(self, bool on)
8841
8842 Currently wxGTK2 only.
8843 """
8844 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
8845
8846 def FindWindowById(*args, **kwargs):
8847 """
8848 FindWindowById(self, long winid) -> Window
8849
8850 Find a chld of this window by window ID
8851 """
8852 return _core_.Window_FindWindowById(*args, **kwargs)
8853
8854 def FindWindowByName(*args, **kwargs):
8855 """
8856 FindWindowByName(self, String name) -> Window
8857
8858 Find a child of this window by name
8859 """
8860 return _core_.Window_FindWindowByName(*args, **kwargs)
8861
8862 def GetEventHandler(*args, **kwargs):
8863 """
8864 GetEventHandler(self) -> EvtHandler
8865
8866 Returns the event handler for this window. By default, the window is
8867 its own event handler.
8868 """
8869 return _core_.Window_GetEventHandler(*args, **kwargs)
8870
8871 def SetEventHandler(*args, **kwargs):
8872 """
8873 SetEventHandler(self, EvtHandler handler)
8874
8875 Sets the event handler for this window. An event handler is an object
8876 that is capable of processing the events sent to a window. (In other
8877 words, is able to dispatch the events to handler function.) By
8878 default, the window is its own event handler, but an application may
8879 wish to substitute another, for example to allow central
8880 implementation of event-handling for a variety of different window
8881 classes.
8882
8883 It is usually better to use `wx.Window.PushEventHandler` since this sets
8884 up a chain of event handlers, where an event not handled by one event
8885 handler is handed off to the next one in the chain.
8886 """
8887 return _core_.Window_SetEventHandler(*args, **kwargs)
8888
8889 def PushEventHandler(*args, **kwargs):
8890 """
8891 PushEventHandler(self, EvtHandler handler)
8892
8893 Pushes this event handler onto the event handler stack for the window.
8894 An event handler is an object that is capable of processing the events
8895 sent to a window. (In other words, is able to dispatch the events to
8896 handler function.) By default, the window is its own event handler,
8897 but an application may wish to substitute another, for example to
8898 allow central implementation of event-handling for a variety of
8899 different window classes.
8900
8901 wx.Window.PushEventHandler allows an application to set up a chain of
8902 event handlers, where an event not handled by one event handler is
8903 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
8904 to remove the event handler. Ownership of the handler is *not* given
8905 to the window, so you should be sure to pop the handler before the
8906 window is destroyed and either let PopEventHandler destroy it, or call
8907 its Destroy method yourself.
8908 """
8909 return _core_.Window_PushEventHandler(*args, **kwargs)
8910
8911 def PopEventHandler(*args, **kwargs):
8912 """
8913 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
8914
8915 Removes and returns the top-most event handler on the event handler
8916 stack. If deleteHandler is True then the wx.EvtHandler object will be
8917 destroyed after it is popped, and ``None`` will be returned instead.
8918 """
8919 return _core_.Window_PopEventHandler(*args, **kwargs)
8920
8921 def RemoveEventHandler(*args, **kwargs):
8922 """
8923 RemoveEventHandler(self, EvtHandler handler) -> bool
8924
8925 Find the given handler in the event handler chain and remove (but not
8926 delete) it from the event handler chain, returns True if it was found
8927 and False otherwise (this also results in an assert failure so this
8928 function should only be called when the handler is supposed to be
8929 there.)
8930 """
8931 return _core_.Window_RemoveEventHandler(*args, **kwargs)
8932
8933 def SetValidator(*args, **kwargs):
8934 """
8935 SetValidator(self, Validator validator)
8936
8937 Deletes the current validator (if any) and sets the window validator,
8938 having called wx.Validator.Clone to create a new validator of this
8939 type.
8940 """
8941 return _core_.Window_SetValidator(*args, **kwargs)
8942
8943 def GetValidator(*args, **kwargs):
8944 """
8945 GetValidator(self) -> Validator
8946
8947 Returns a pointer to the current validator for the window, or None if
8948 there is none.
8949 """
8950 return _core_.Window_GetValidator(*args, **kwargs)
8951
8952 def Validate(*args, **kwargs):
8953 """
8954 Validate(self) -> bool
8955
8956 Validates the current values of the child controls using their
8957 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8958 style flag set, the method will also call Validate() of all child
8959 windows. Returns false if any of the validations failed.
8960 """
8961 return _core_.Window_Validate(*args, **kwargs)
8962
8963 def TransferDataToWindow(*args, **kwargs):
8964 """
8965 TransferDataToWindow(self) -> bool
8966
8967 Transfers values to child controls from data areas specified by their
8968 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
8969 style flag set, the method will also call TransferDataToWindow() of
8970 all child windows.
8971 """
8972 return _core_.Window_TransferDataToWindow(*args, **kwargs)
8973
8974 def TransferDataFromWindow(*args, **kwargs):
8975 """
8976 TransferDataFromWindow(self) -> bool
8977
8978 Transfers values from child controls to data areas specified by their
8979 validators. Returns false if a transfer failed. If the window has
8980 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
8981 also call TransferDataFromWindow() of all child windows.
8982 """
8983 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
8984
8985 def InitDialog(*args, **kwargs):
8986 """
8987 InitDialog(self)
8988
8989 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
8990 to the dialog via validators.
8991 """
8992 return _core_.Window_InitDialog(*args, **kwargs)
8993
8994 def SetAcceleratorTable(*args, **kwargs):
8995 """
8996 SetAcceleratorTable(self, AcceleratorTable accel)
8997
8998 Sets the accelerator table for this window.
8999 """
9000 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9001
9002 def GetAcceleratorTable(*args, **kwargs):
9003 """
9004 GetAcceleratorTable(self) -> AcceleratorTable
9005
9006 Gets the accelerator table for this window.
9007 """
9008 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9009
9010 def RegisterHotKey(*args, **kwargs):
9011 """
9012 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9013
9014 Registers a system wide hotkey. Every time the user presses the hotkey
9015 registered here, this window will receive a hotkey event. It will
9016 receive the event even if the application is in the background and
9017 does not have the input focus because the user is working with some
9018 other application. To bind an event handler function to this hotkey
9019 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9020 hotkey was registered successfully.
9021 """
9022 return _core_.Window_RegisterHotKey(*args, **kwargs)
9023
9024 def UnregisterHotKey(*args, **kwargs):
9025 """
9026 UnregisterHotKey(self, int hotkeyId) -> bool
9027
9028 Unregisters a system wide hotkey.
9029 """
9030 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9031
9032 def ConvertDialogPointToPixels(*args, **kwargs):
9033 """
9034 ConvertDialogPointToPixels(self, Point pt) -> Point
9035
9036 Converts a point or size from dialog units to pixels. Dialog units
9037 are used for maintaining a dialog's proportions even if the font
9038 changes. For the x dimension, the dialog units are multiplied by the
9039 average character width and then divided by 4. For the y dimension,
9040 the dialog units are multiplied by the average character height and
9041 then divided by 8.
9042 """
9043 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9044
9045 def ConvertDialogSizeToPixels(*args, **kwargs):
9046 """
9047 ConvertDialogSizeToPixels(self, Size sz) -> Size
9048
9049 Converts a point or size from dialog units to pixels. Dialog units
9050 are used for maintaining a dialog's proportions even if the font
9051 changes. For the x dimension, the dialog units are multiplied by the
9052 average character width and then divided by 4. For the y dimension,
9053 the dialog units are multiplied by the average character height and
9054 then divided by 8.
9055 """
9056 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9057
9058 def DLG_PNT(*args, **kwargs):
9059 """
9060 DLG_PNT(self, Point pt) -> Point
9061
9062 Converts a point or size from dialog units to pixels. Dialog units
9063 are used for maintaining a dialog's proportions even if the font
9064 changes. For the x dimension, the dialog units are multiplied by the
9065 average character width and then divided by 4. For the y dimension,
9066 the dialog units are multiplied by the average character height and
9067 then divided by 8.
9068 """
9069 return _core_.Window_DLG_PNT(*args, **kwargs)
9070
9071 def DLG_SZE(*args, **kwargs):
9072 """
9073 DLG_SZE(self, Size sz) -> Size
9074
9075 Converts a point or size from dialog units to pixels. Dialog units
9076 are used for maintaining a dialog's proportions even if the font
9077 changes. For the x dimension, the dialog units are multiplied by the
9078 average character width and then divided by 4. For the y dimension,
9079 the dialog units are multiplied by the average character height and
9080 then divided by 8.
9081 """
9082 return _core_.Window_DLG_SZE(*args, **kwargs)
9083
9084 def ConvertPixelPointToDialog(*args, **kwargs):
9085 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9086 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9087
9088 def ConvertPixelSizeToDialog(*args, **kwargs):
9089 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9090 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9091
9092 def WarpPointer(*args, **kwargs):
9093 """
9094 WarpPointer(self, int x, int y)
9095
9096 Moves the pointer to the given position on the window.
9097
9098 NOTE: This function is not supported under Mac because Apple Human
9099 Interface Guidelines forbid moving the mouse cursor programmatically.
9100 """
9101 return _core_.Window_WarpPointer(*args, **kwargs)
9102
9103 def CaptureMouse(*args, **kwargs):
9104 """
9105 CaptureMouse(self)
9106
9107 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9108 release the capture.
9109
9110 Note that wxWindows maintains the stack of windows having captured the
9111 mouse and when the mouse is released the capture returns to the window
9112 which had had captured it previously and it is only really released if
9113 there were no previous window. In particular, this means that you must
9114 release the mouse as many times as you capture it, unless the window
9115 receives the `wx.MouseCaptureLostEvent` event.
9116
9117 Any application which captures the mouse in the beginning of some
9118 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9119 operation when it receives the event. The event handler must not
9120 recapture mouse.
9121 """
9122 return _core_.Window_CaptureMouse(*args, **kwargs)
9123
9124 def ReleaseMouse(*args, **kwargs):
9125 """
9126 ReleaseMouse(self)
9127
9128 Releases mouse input captured with wx.Window.CaptureMouse.
9129 """
9130 return _core_.Window_ReleaseMouse(*args, **kwargs)
9131
9132 def GetCapture(*args, **kwargs):
9133 """
9134 GetCapture() -> Window
9135
9136 Returns the window which currently captures the mouse or None
9137 """
9138 return _core_.Window_GetCapture(*args, **kwargs)
9139
9140 GetCapture = staticmethod(GetCapture)
9141 def HasCapture(*args, **kwargs):
9142 """
9143 HasCapture(self) -> bool
9144
9145 Returns true if this window has the current mouse capture.
9146 """
9147 return _core_.Window_HasCapture(*args, **kwargs)
9148
9149 def Refresh(*args, **kwargs):
9150 """
9151 Refresh(self, bool eraseBackground=True, Rect rect=None)
9152
9153 Mark the specified rectangle (or the whole window) as "dirty" so it
9154 will be repainted. Causes an EVT_PAINT event to be generated and sent
9155 to the window.
9156 """
9157 return _core_.Window_Refresh(*args, **kwargs)
9158
9159 def RefreshRect(*args, **kwargs):
9160 """
9161 RefreshRect(self, Rect rect, bool eraseBackground=True)
9162
9163 Redraws the contents of the given rectangle: the area inside it will
9164 be repainted. This is the same as Refresh but has a nicer syntax.
9165 """
9166 return _core_.Window_RefreshRect(*args, **kwargs)
9167
9168 def Update(*args, **kwargs):
9169 """
9170 Update(self)
9171
9172 Calling this method immediately repaints the invalidated area of the
9173 window instead of waiting for the EVT_PAINT event to happen, (normally
9174 this would usually only happen when the flow of control returns to the
9175 event loop.) Notice that this function doesn't refresh the window and
9176 does nothing if the window has been already repainted. Use Refresh
9177 first if you want to immediately redraw the window (or some portion of
9178 it) unconditionally.
9179 """
9180 return _core_.Window_Update(*args, **kwargs)
9181
9182 def ClearBackground(*args, **kwargs):
9183 """
9184 ClearBackground(self)
9185
9186 Clears the window by filling it with the current background
9187 colour. Does not cause an erase background event to be generated.
9188 """
9189 return _core_.Window_ClearBackground(*args, **kwargs)
9190
9191 def Freeze(*args, **kwargs):
9192 """
9193 Freeze(self)
9194
9195 Freezes the window or, in other words, prevents any updates from
9196 taking place on screen, the window is not redrawn at all. Thaw must be
9197 called to reenable window redrawing. Calls to Freeze/Thaw may be
9198 nested, with the actual Thaw being delayed until all the nesting has
9199 been undone.
9200
9201 This method is useful for visual appearance optimization (for example,
9202 it is a good idea to use it before inserting large amount of text into
9203 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9204 for all controls so it is mostly just a hint to wxWindows and not a
9205 mandatory directive.
9206 """
9207 return _core_.Window_Freeze(*args, **kwargs)
9208
9209 def IsFrozen(*args, **kwargs):
9210 """
9211 IsFrozen(self) -> bool
9212
9213 Returns ``True`` if the window has been frozen and not thawed yet.
9214
9215 :see: `Freeze` and `Thaw`
9216 """
9217 return _core_.Window_IsFrozen(*args, **kwargs)
9218
9219 def Thaw(*args, **kwargs):
9220 """
9221 Thaw(self)
9222
9223 Reenables window updating after a previous call to Freeze. Calls to
9224 Freeze/Thaw may be nested, so Thaw must be called the same number of
9225 times that Freeze was before the window will be updated.
9226 """
9227 return _core_.Window_Thaw(*args, **kwargs)
9228
9229 def PrepareDC(*args, **kwargs):
9230 """
9231 PrepareDC(self, DC dc)
9232
9233 Call this function to prepare the device context for drawing a
9234 scrolled image. It sets the device origin according to the current
9235 scroll position.
9236 """
9237 return _core_.Window_PrepareDC(*args, **kwargs)
9238
9239 def GetUpdateRegion(*args, **kwargs):
9240 """
9241 GetUpdateRegion(self) -> Region
9242
9243 Returns the region specifying which parts of the window have been
9244 damaged. Should only be called within an EVT_PAINT handler.
9245 """
9246 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9247
9248 def GetUpdateClientRect(*args, **kwargs):
9249 """
9250 GetUpdateClientRect(self) -> Rect
9251
9252 Get the update rectangle region bounding box in client coords.
9253 """
9254 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9255
9256 def IsExposed(*args, **kwargs):
9257 """
9258 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9259
9260 Returns true if the given point or rectangle area has been exposed
9261 since the last repaint. Call this in an paint event handler to
9262 optimize redrawing by only redrawing those areas, which have been
9263 exposed.
9264 """
9265 return _core_.Window_IsExposed(*args, **kwargs)
9266
9267 def IsExposedPoint(*args, **kwargs):
9268 """
9269 IsExposedPoint(self, Point pt) -> bool
9270
9271 Returns true if the given point or rectangle area has been exposed
9272 since the last repaint. Call this in an paint event handler to
9273 optimize redrawing by only redrawing those areas, which have been
9274 exposed.
9275 """
9276 return _core_.Window_IsExposedPoint(*args, **kwargs)
9277
9278 def IsExposedRect(*args, **kwargs):
9279 """
9280 IsExposedRect(self, Rect rect) -> bool
9281
9282 Returns true if the given point or rectangle area has been exposed
9283 since the last repaint. Call this in an paint event handler to
9284 optimize redrawing by only redrawing those areas, which have been
9285 exposed.
9286 """
9287 return _core_.Window_IsExposedRect(*args, **kwargs)
9288
9289 def GetDefaultAttributes(*args, **kwargs):
9290 """
9291 GetDefaultAttributes(self) -> VisualAttributes
9292
9293 Get the default attributes for an instance of this class. This is
9294 useful if you want to use the same font or colour in your own control
9295 as in a standard control -- which is a much better idea than hard
9296 coding specific colours or fonts which might look completely out of
9297 place on the user's system, especially if it uses themes.
9298 """
9299 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9300
9301 def GetClassDefaultAttributes(*args, **kwargs):
9302 """
9303 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9304
9305 Get the default attributes for this class. This is useful if you want
9306 to use the same font or colour in your own control as in a standard
9307 control -- which is a much better idea than hard coding specific
9308 colours or fonts which might look completely out of place on the
9309 user's system, especially if it uses themes.
9310
9311 The variant parameter is only relevant under Mac currently and is
9312 ignore under other platforms. Under Mac, it will change the size of
9313 the returned font. See `wx.Window.SetWindowVariant` for more about
9314 this.
9315 """
9316 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9317
9318 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9319 def SetBackgroundColour(*args, **kwargs):
9320 """
9321 SetBackgroundColour(self, Colour colour) -> bool
9322
9323 Sets the background colour of the window. Returns True if the colour
9324 was changed. The background colour is usually painted by the default
9325 EVT_ERASE_BACKGROUND event handler function under Windows and
9326 automatically under GTK. Using `wx.NullColour` will reset the window
9327 to the default background colour.
9328
9329 Note that setting the background colour may not cause an immediate
9330 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9331 calling this function.
9332
9333 Using this function will disable attempts to use themes for this
9334 window, if the system supports them. Use with care since usually the
9335 themes represent the appearance chosen by the user to be used for all
9336 applications on the system.
9337 """
9338 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9339
9340 def SetOwnBackgroundColour(*args, **kwargs):
9341 """SetOwnBackgroundColour(self, Colour colour)"""
9342 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9343
9344 def SetForegroundColour(*args, **kwargs):
9345 """
9346 SetForegroundColour(self, Colour colour) -> bool
9347
9348 Sets the foreground colour of the window. Returns True is the colour
9349 was changed. The interpretation of foreground colour is dependent on
9350 the window class; it may be the text colour or other colour, or it may
9351 not be used at all.
9352 """
9353 return _core_.Window_SetForegroundColour(*args, **kwargs)
9354
9355 def SetOwnForegroundColour(*args, **kwargs):
9356 """SetOwnForegroundColour(self, Colour colour)"""
9357 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9358
9359 def GetBackgroundColour(*args, **kwargs):
9360 """
9361 GetBackgroundColour(self) -> Colour
9362
9363 Returns the background colour of the window.
9364 """
9365 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9366
9367 def GetForegroundColour(*args, **kwargs):
9368 """
9369 GetForegroundColour(self) -> Colour
9370
9371 Returns the foreground colour of the window. The interpretation of
9372 foreground colour is dependent on the window class; it may be the text
9373 colour or other colour, or it may not be used at all.
9374 """
9375 return _core_.Window_GetForegroundColour(*args, **kwargs)
9376
9377 def InheritsBackgroundColour(*args, **kwargs):
9378 """InheritsBackgroundColour(self) -> bool"""
9379 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9380
9381 def UseBgCol(*args, **kwargs):
9382 """UseBgCol(self) -> bool"""
9383 return _core_.Window_UseBgCol(*args, **kwargs)
9384
9385 def SetBackgroundStyle(*args, **kwargs):
9386 """
9387 SetBackgroundStyle(self, int style) -> bool
9388
9389 Returns the background style of the window. The background style
9390 indicates how the background of the window is drawn.
9391
9392 ====================== ========================================
9393 wx.BG_STYLE_SYSTEM The background colour or pattern should
9394 be determined by the system
9395 wx.BG_STYLE_COLOUR The background should be a solid colour
9396 wx.BG_STYLE_CUSTOM The background will be implemented by the
9397 application.
9398 ====================== ========================================
9399
9400 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9401 a custom background, such as a tiled bitmap. Currently the style has
9402 no effect on other platforms.
9403
9404 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9405 """
9406 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9407
9408 def GetBackgroundStyle(*args, **kwargs):
9409 """
9410 GetBackgroundStyle(self) -> int
9411
9412 Returns the background style of the window.
9413
9414 :see: `SetBackgroundStyle`
9415 """
9416 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9417
9418 def HasTransparentBackground(*args, **kwargs):
9419 """
9420 HasTransparentBackground(self) -> bool
9421
9422 Returns True if this window's background is transparent (as, for
9423 example, for `wx.StaticText`) and should show the parent window's
9424 background.
9425
9426 This method is mostly used internally by the library itself and you
9427 normally shouldn't have to call it. You may, however, have to override
9428 it in your custom control classes to ensure that background is painted
9429 correctly.
9430 """
9431 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9432
9433 def SetCursor(*args, **kwargs):
9434 """
9435 SetCursor(self, Cursor cursor) -> bool
9436
9437 Sets the window's cursor. Notice that the window cursor also sets it
9438 for the children of the window implicitly.
9439
9440 The cursor may be wx.NullCursor in which case the window cursor will
9441 be reset back to default.
9442 """
9443 return _core_.Window_SetCursor(*args, **kwargs)
9444
9445 def GetCursor(*args, **kwargs):
9446 """
9447 GetCursor(self) -> Cursor
9448
9449 Return the cursor associated with this window.
9450 """
9451 return _core_.Window_GetCursor(*args, **kwargs)
9452
9453 def SetFont(*args, **kwargs):
9454 """
9455 SetFont(self, Font font) -> bool
9456
9457 Sets the font for this window.
9458 """
9459 return _core_.Window_SetFont(*args, **kwargs)
9460
9461 def SetOwnFont(*args, **kwargs):
9462 """SetOwnFont(self, Font font)"""
9463 return _core_.Window_SetOwnFont(*args, **kwargs)
9464
9465 def GetFont(*args, **kwargs):
9466 """
9467 GetFont(self) -> Font
9468
9469 Returns the default font used for this window.
9470 """
9471 return _core_.Window_GetFont(*args, **kwargs)
9472
9473 def SetCaret(*args, **kwargs):
9474 """
9475 SetCaret(self, Caret caret)
9476
9477 Sets the caret associated with the window.
9478 """
9479 return _core_.Window_SetCaret(*args, **kwargs)
9480
9481 def GetCaret(*args, **kwargs):
9482 """
9483 GetCaret(self) -> Caret
9484
9485 Returns the caret associated with the window.
9486 """
9487 return _core_.Window_GetCaret(*args, **kwargs)
9488
9489 def GetCharHeight(*args, **kwargs):
9490 """
9491 GetCharHeight(self) -> int
9492
9493 Get the (average) character size for the current font.
9494 """
9495 return _core_.Window_GetCharHeight(*args, **kwargs)
9496
9497 def GetCharWidth(*args, **kwargs):
9498 """
9499 GetCharWidth(self) -> int
9500
9501 Get the (average) character size for the current font.
9502 """
9503 return _core_.Window_GetCharWidth(*args, **kwargs)
9504
9505 def GetTextExtent(*args, **kwargs):
9506 """
9507 GetTextExtent(String string) -> (width, height)
9508
9509 Get the width and height of the text using the current font.
9510 """
9511 return _core_.Window_GetTextExtent(*args, **kwargs)
9512
9513 def GetFullTextExtent(*args, **kwargs):
9514 """
9515 GetFullTextExtent(String string, Font font=None) ->
9516 (width, height, descent, externalLeading)
9517
9518 Get the width, height, decent and leading of the text using the
9519 current or specified font.
9520 """
9521 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9522
9523 def ClientToScreenXY(*args, **kwargs):
9524 """
9525 ClientToScreenXY(int x, int y) -> (x,y)
9526
9527 Converts to screen coordinates from coordinates relative to this window.
9528 """
9529 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9530
9531 def ScreenToClientXY(*args, **kwargs):
9532 """
9533 ScreenToClientXY(int x, int y) -> (x,y)
9534
9535 Converts from screen to client window coordinates.
9536 """
9537 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9538
9539 def ClientToScreen(*args, **kwargs):
9540 """
9541 ClientToScreen(self, Point pt) -> Point
9542
9543 Converts to screen coordinates from coordinates relative to this window.
9544 """
9545 return _core_.Window_ClientToScreen(*args, **kwargs)
9546
9547 def ScreenToClient(*args, **kwargs):
9548 """
9549 ScreenToClient(self, Point pt) -> Point
9550
9551 Converts from screen to client window coordinates.
9552 """
9553 return _core_.Window_ScreenToClient(*args, **kwargs)
9554
9555 def HitTestXY(*args, **kwargs):
9556 """
9557 HitTestXY(self, int x, int y) -> int
9558
9559 Test where the given (in client coords) point lies
9560 """
9561 return _core_.Window_HitTestXY(*args, **kwargs)
9562
9563 def HitTest(*args, **kwargs):
9564 """
9565 HitTest(self, Point pt) -> int
9566
9567 Test where the given (in client coords) point lies
9568 """
9569 return _core_.Window_HitTest(*args, **kwargs)
9570
9571 def GetBorder(*args):
9572 """
9573 GetBorder(self, long flags) -> int
9574 GetBorder(self) -> int
9575
9576 Get border for the flags of this window
9577 """
9578 return _core_.Window_GetBorder(*args)
9579
9580 def UpdateWindowUI(*args, **kwargs):
9581 """
9582 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9583
9584 This function sends EVT_UPDATE_UI events to the window. The particular
9585 implementation depends on the window; for example a wx.ToolBar will
9586 send an update UI event for each toolbar button, and a wx.Frame will
9587 send an update UI event for each menubar menu item. You can call this
9588 function from your application to ensure that your UI is up-to-date at
9589 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9590 concerned). This may be necessary if you have called
9591 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9592 limit the overhead that wxWindows incurs by sending update UI events
9593 in idle time.
9594 """
9595 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9596
9597 def PopupMenuXY(*args, **kwargs):
9598 """
9599 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9600
9601 Pops up the given menu at the specified coordinates, relative to this window,
9602 and returns control when the user has dismissed the menu. If a menu item is
9603 selected, the corresponding menu event is generated and will be processed as
9604 usual. If the default position is given then the current position of the
9605 mouse cursor will be used.
9606 """
9607 return _core_.Window_PopupMenuXY(*args, **kwargs)
9608
9609 def PopupMenu(*args, **kwargs):
9610 """
9611 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9612
9613 Pops up the given menu at the specified coordinates, relative to this window,
9614 and returns control when the user has dismissed the menu. If a menu item is
9615 selected, the corresponding menu event is generated and will be processed as
9616 usual. If the default position is given then the current position of the
9617 mouse cursor will be used.
9618 """
9619 return _core_.Window_PopupMenu(*args, **kwargs)
9620
9621 def HasMultiplePages(*args, **kwargs):
9622 """HasMultiplePages(self) -> bool"""
9623 return _core_.Window_HasMultiplePages(*args, **kwargs)
9624
9625 def GetHandle(*args, **kwargs):
9626 """
9627 GetHandle(self) -> long
9628
9629 Returns the platform-specific handle (as a long integer) of the
9630 physical window. Currently on wxMac it returns the handle of the
9631 toplevel parent of the window.
9632 """
9633 return _core_.Window_GetHandle(*args, **kwargs)
9634
9635 def AssociateHandle(*args, **kwargs):
9636 """
9637 AssociateHandle(self, long handle)
9638
9639 Associate the window with a new native handle
9640 """
9641 return _core_.Window_AssociateHandle(*args, **kwargs)
9642
9643 def DissociateHandle(*args, **kwargs):
9644 """
9645 DissociateHandle(self)
9646
9647 Dissociate the current native handle from the window
9648 """
9649 return _core_.Window_DissociateHandle(*args, **kwargs)
9650
9651 def HasScrollbar(*args, **kwargs):
9652 """
9653 HasScrollbar(self, int orient) -> bool
9654
9655 Does the window have the scrollbar for this orientation?
9656 """
9657 return _core_.Window_HasScrollbar(*args, **kwargs)
9658
9659 def SetScrollbar(*args, **kwargs):
9660 """
9661 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9662 bool refresh=True)
9663
9664 Sets the scrollbar properties of a built-in scrollbar.
9665 """
9666 return _core_.Window_SetScrollbar(*args, **kwargs)
9667
9668 def SetScrollPos(*args, **kwargs):
9669 """
9670 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9671
9672 Sets the position of one of the built-in scrollbars.
9673 """
9674 return _core_.Window_SetScrollPos(*args, **kwargs)
9675
9676 def GetScrollPos(*args, **kwargs):
9677 """
9678 GetScrollPos(self, int orientation) -> int
9679
9680 Returns the built-in scrollbar position.
9681 """
9682 return _core_.Window_GetScrollPos(*args, **kwargs)
9683
9684 def GetScrollThumb(*args, **kwargs):
9685 """
9686 GetScrollThumb(self, int orientation) -> int
9687
9688 Returns the built-in scrollbar thumb size.
9689 """
9690 return _core_.Window_GetScrollThumb(*args, **kwargs)
9691
9692 def GetScrollRange(*args, **kwargs):
9693 """
9694 GetScrollRange(self, int orientation) -> int
9695
9696 Returns the built-in scrollbar range.
9697 """
9698 return _core_.Window_GetScrollRange(*args, **kwargs)
9699
9700 def ScrollWindow(*args, **kwargs):
9701 """
9702 ScrollWindow(self, int dx, int dy, Rect rect=None)
9703
9704 Physically scrolls the pixels in the window and move child windows
9705 accordingly. Use this function to optimise your scrolling
9706 implementations, to minimise the area that must be redrawn. Note that
9707 it is rarely required to call this function from a user program.
9708 """
9709 return _core_.Window_ScrollWindow(*args, **kwargs)
9710
9711 def ScrollLines(*args, **kwargs):
9712 """
9713 ScrollLines(self, int lines) -> bool
9714
9715 If the platform and window class supports it, scrolls the window by
9716 the given number of lines down, if lines is positive, or up if lines
9717 is negative. Returns True if the window was scrolled, False if it was
9718 already on top/bottom and nothing was done.
9719 """
9720 return _core_.Window_ScrollLines(*args, **kwargs)
9721
9722 def ScrollPages(*args, **kwargs):
9723 """
9724 ScrollPages(self, int pages) -> bool
9725
9726 If the platform and window class supports it, scrolls the window by
9727 the given number of pages down, if pages is positive, or up if pages
9728 is negative. Returns True if the window was scrolled, False if it was
9729 already on top/bottom and nothing was done.
9730 """
9731 return _core_.Window_ScrollPages(*args, **kwargs)
9732
9733 def LineUp(*args, **kwargs):
9734 """
9735 LineUp(self) -> bool
9736
9737 This is just a wrapper for ScrollLines(-1).
9738 """
9739 return _core_.Window_LineUp(*args, **kwargs)
9740
9741 def LineDown(*args, **kwargs):
9742 """
9743 LineDown(self) -> bool
9744
9745 This is just a wrapper for ScrollLines(1).
9746 """
9747 return _core_.Window_LineDown(*args, **kwargs)
9748
9749 def PageUp(*args, **kwargs):
9750 """
9751 PageUp(self) -> bool
9752
9753 This is just a wrapper for ScrollPages(-1).
9754 """
9755 return _core_.Window_PageUp(*args, **kwargs)
9756
9757 def PageDown(*args, **kwargs):
9758 """
9759 PageDown(self) -> bool
9760
9761 This is just a wrapper for ScrollPages(1).
9762 """
9763 return _core_.Window_PageDown(*args, **kwargs)
9764
9765 def SetHelpText(*args, **kwargs):
9766 """
9767 SetHelpText(self, String text)
9768
9769 Sets the help text to be used as context-sensitive help for this
9770 window. Note that the text is actually stored by the current
9771 `wx.HelpProvider` implementation, and not in the window object itself.
9772 """
9773 return _core_.Window_SetHelpText(*args, **kwargs)
9774
9775 def SetHelpTextForId(*args, **kwargs):
9776 """
9777 SetHelpTextForId(self, String text)
9778
9779 Associate this help text with all windows with the same id as this
9780 one.
9781 """
9782 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9783
9784 def GetHelpTextAtPoint(*args, **kwargs):
9785 """
9786 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
9787
9788 Get the help string associated with the given position in this window.
9789
9790 Notice that pt may be invalid if event origin is keyboard or unknown
9791 and this method should return the global window help text then
9792
9793 """
9794 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
9795
9796 def GetHelpText(*args, **kwargs):
9797 """
9798 GetHelpText(self) -> String
9799
9800 Gets the help text to be used as context-sensitive help for this
9801 window. Note that the text is actually stored by the current
9802 `wx.HelpProvider` implementation, and not in the window object itself.
9803 """
9804 return _core_.Window_GetHelpText(*args, **kwargs)
9805
9806 def SetToolTipString(*args, **kwargs):
9807 """
9808 SetToolTipString(self, String tip)
9809
9810 Attach a tooltip to the window.
9811 """
9812 return _core_.Window_SetToolTipString(*args, **kwargs)
9813
9814 def SetToolTip(*args, **kwargs):
9815 """
9816 SetToolTip(self, ToolTip tip)
9817
9818 Attach a tooltip to the window.
9819 """
9820 return _core_.Window_SetToolTip(*args, **kwargs)
9821
9822 def GetToolTip(*args, **kwargs):
9823 """
9824 GetToolTip(self) -> ToolTip
9825
9826 get the associated tooltip or None if none
9827 """
9828 return _core_.Window_GetToolTip(*args, **kwargs)
9829
9830 def SetDropTarget(*args, **kwargs):
9831 """
9832 SetDropTarget(self, DropTarget dropTarget)
9833
9834 Associates a drop target with this window. If the window already has
9835 a drop target, it is deleted.
9836 """
9837 return _core_.Window_SetDropTarget(*args, **kwargs)
9838
9839 def GetDropTarget(*args, **kwargs):
9840 """
9841 GetDropTarget(self) -> DropTarget
9842
9843 Returns the associated drop target, which may be None.
9844 """
9845 return _core_.Window_GetDropTarget(*args, **kwargs)
9846
9847 def DragAcceptFiles(*args, **kwargs):
9848 """
9849 DragAcceptFiles(self, bool accept)
9850
9851 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
9852 Only functional on Windows.
9853 """
9854 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9855
9856 def SetConstraints(*args, **kwargs):
9857 """
9858 SetConstraints(self, LayoutConstraints constraints)
9859
9860 Sets the window to have the given layout constraints. If an existing
9861 layout constraints object is already owned by the window, it will be
9862 deleted. Pass None to disassociate and delete the window's current
9863 constraints.
9864
9865 You must call SetAutoLayout to tell a window to use the constraints
9866 automatically in its default EVT_SIZE handler; otherwise, you must
9867 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9868 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9869 effect.
9870 """
9871 return _core_.Window_SetConstraints(*args, **kwargs)
9872
9873 def GetConstraints(*args, **kwargs):
9874 """
9875 GetConstraints(self) -> LayoutConstraints
9876
9877 Returns a pointer to the window's layout constraints, or None if there
9878 are none.
9879 """
9880 return _core_.Window_GetConstraints(*args, **kwargs)
9881
9882 def SetAutoLayout(*args, **kwargs):
9883 """
9884 SetAutoLayout(self, bool autoLayout)
9885
9886 Determines whether the Layout function will be called automatically
9887 when the window is resized. lease note that this only happens for the
9888 windows usually used to contain children, namely `wx.Panel` and
9889 `wx.TopLevelWindow` (and the classes deriving from them).
9890
9891 This method is called implicitly by `SetSizer` but if you use
9892 `SetConstraints` you should call it manually or otherwise the window
9893 layout won't be correctly updated when its size changes.
9894 """
9895 return _core_.Window_SetAutoLayout(*args, **kwargs)
9896
9897 def GetAutoLayout(*args, **kwargs):
9898 """
9899 GetAutoLayout(self) -> bool
9900
9901 Returns the current autoLayout setting
9902 """
9903 return _core_.Window_GetAutoLayout(*args, **kwargs)
9904
9905 def Layout(*args, **kwargs):
9906 """
9907 Layout(self) -> bool
9908
9909 Invokes the constraint-based layout algorithm or the sizer-based
9910 algorithm for this window. See SetAutoLayout: when auto layout is on,
9911 this function gets called automatically by the default EVT_SIZE
9912 handler when the window is resized.
9913 """
9914 return _core_.Window_Layout(*args, **kwargs)
9915
9916 def SetSizer(*args, **kwargs):
9917 """
9918 SetSizer(self, Sizer sizer, bool deleteOld=True)
9919
9920 Sets the window to have the given layout sizer. The window will then
9921 own the object, and will take care of its deletion. If an existing
9922 layout sizer object is already owned by the window, it will be deleted
9923 if the deleteOld parameter is true. Note that this function will also
9924 call SetAutoLayout implicitly with a True parameter if the sizer is
9925 non-None, and False otherwise.
9926 """
9927 return _core_.Window_SetSizer(*args, **kwargs)
9928
9929 def SetSizerAndFit(*args, **kwargs):
9930 """
9931 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
9932
9933 The same as SetSizer, except it also sets the size hints for the
9934 window based on the sizer's minimum size.
9935 """
9936 return _core_.Window_SetSizerAndFit(*args, **kwargs)
9937
9938 def GetSizer(*args, **kwargs):
9939 """
9940 GetSizer(self) -> Sizer
9941
9942 Return the sizer associated with the window by a previous call to
9943 SetSizer or None if there isn't one.
9944 """
9945 return _core_.Window_GetSizer(*args, **kwargs)
9946
9947 def SetContainingSizer(*args, **kwargs):
9948 """
9949 SetContainingSizer(self, Sizer sizer)
9950
9951 This normally does not need to be called by application code. It is
9952 called internally when a window is added to a sizer, and is used so
9953 the window can remove itself from the sizer when it is destroyed.
9954 """
9955 return _core_.Window_SetContainingSizer(*args, **kwargs)
9956
9957 def GetContainingSizer(*args, **kwargs):
9958 """
9959 GetContainingSizer(self) -> Sizer
9960
9961 Return the sizer that this window is a member of, if any, otherwise None.
9962 """
9963 return _core_.Window_GetContainingSizer(*args, **kwargs)
9964
9965 def InheritAttributes(*args, **kwargs):
9966 """
9967 InheritAttributes(self)
9968
9969 This function is (or should be, in case of custom controls) called
9970 during window creation to intelligently set up the window visual
9971 attributes, that is the font and the foreground and background
9972 colours.
9973
9974 By 'intelligently' the following is meant: by default, all windows use
9975 their own default attributes. However if some of the parent's
9976 attributes are explicitly changed (that is, using SetFont and not
9977 SetOwnFont) and if the corresponding attribute hadn't been
9978 explicitly set for this window itself, then this window takes the same
9979 value as used by the parent. In addition, if the window overrides
9980 ShouldInheritColours to return false, the colours will not be changed
9981 no matter what and only the font might.
9982
9983 This rather complicated logic is necessary in order to accommodate the
9984 different usage scenarios. The most common one is when all default
9985 attributes are used and in this case, nothing should be inherited as
9986 in modern GUIs different controls use different fonts (and colours)
9987 than their siblings so they can't inherit the same value from the
9988 parent. However it was also deemed desirable to allow to simply change
9989 the attributes of all children at once by just changing the font or
9990 colour of their common parent, hence in this case we do inherit the
9991 parents attributes.
9992
9993 """
9994 return _core_.Window_InheritAttributes(*args, **kwargs)
9995
9996 def ShouldInheritColours(*args, **kwargs):
9997 """
9998 ShouldInheritColours(self) -> bool
9999
10000 Return true from here to allow the colours of this window to be
10001 changed by InheritAttributes, returning false forbids inheriting them
10002 from the parent window.
10003
10004 The base class version returns false, but this method is overridden in
10005 wxControl where it returns true.
10006 """
10007 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10008
10009 def CanSetTransparent(*args, **kwargs):
10010 """
10011 CanSetTransparent(self) -> bool
10012
10013 Returns ``True`` if the platform supports setting the transparency for
10014 this window. Note that this method will err on the side of caution,
10015 so it is possible that this will return ``False`` when it is in fact
10016 possible to set the transparency.
10017
10018 NOTE: On X-windows systems the X server must have the composite
10019 extension loaded, and there must be a composite manager program (such
10020 as xcompmgr) running.
10021 """
10022 return _core_.Window_CanSetTransparent(*args, **kwargs)
10023
10024 def SetTransparent(*args, **kwargs):
10025 """
10026 SetTransparent(self, byte alpha) -> bool
10027
10028 Attempt to set the transparency of this window to the ``alpha`` value,
10029 returns True on success. The ``alpha`` value is an integer in the
10030 range of 0 to 255, where 0 is fully transparent and 255 is fully
10031 opaque.
10032 """
10033 return _core_.Window_SetTransparent(*args, **kwargs)
10034
10035 def PostCreate(self, pre):
10036 """
10037 Phase 3 of the 2-phase create <wink!>
10038 Call this method after precreating the window with the 2-phase create method.
10039 """
10040 self.this = pre.this
10041 self.thisown = pre.thisown
10042 pre.thisown = 0
10043 if hasattr(self, '_setOORInfo'):
10044 self._setOORInfo(self)
10045 if hasattr(self, '_setCallbackInfo'):
10046 self._setCallbackInfo(self, self.__class__)
10047
10048 def SendSizeEvent(self):
10049 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
10050
10051 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10052 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10053 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10054 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10055 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10056 BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`")
10057 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10058 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10059 Border = property(GetBorder,doc="See `GetBorder`")
10060 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10061 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10062 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10063 Children = property(GetChildren,doc="See `GetChildren`")
10064 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10065 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10066 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10067 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10068 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10069 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10070 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10071 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10072 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10073 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10074 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10075 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
10076 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10077 Handle = property(GetHandle,doc="See `GetHandle`")
10078 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
10079 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10080 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
10081 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
10082 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10083 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10084 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10085 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10086 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10087 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10088 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10089 Parent = property(GetParent,doc="See `GetParent`")
10090 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10091 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10092 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10093 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10094 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10095 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10096 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10097 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10098 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10099 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10100 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10101 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10102 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10103 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10104 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10105 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10106 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10107 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10108 _core_.Window_swigregister(Window)
10109
10110 def PreWindow(*args, **kwargs):
10111 """
10112 PreWindow() -> Window
10113
10114 Precreate a Window for 2-phase creation.
10115 """
10116 val = _core_.new_PreWindow(*args, **kwargs)
10117 return val
10118
10119 def Window_NewControlId(*args):
10120 """
10121 Window_NewControlId() -> int
10122
10123 Generate a control id for the controls which were not given one.
10124 """
10125 return _core_.Window_NewControlId(*args)
10126
10127 def Window_NextControlId(*args, **kwargs):
10128 """
10129 Window_NextControlId(int winid) -> int
10130
10131 Get the id of the control following the one with the given
10132 autogenerated) id
10133 """
10134 return _core_.Window_NextControlId(*args, **kwargs)
10135
10136 def Window_PrevControlId(*args, **kwargs):
10137 """
10138 Window_PrevControlId(int winid) -> int
10139
10140 Get the id of the control preceding the one with the given
10141 autogenerated) id
10142 """
10143 return _core_.Window_PrevControlId(*args, **kwargs)
10144
10145 def Window_FindFocus(*args):
10146 """
10147 Window_FindFocus() -> Window
10148
10149 Returns the window or control that currently has the keyboard focus,
10150 or None.
10151 """
10152 return _core_.Window_FindFocus(*args)
10153
10154 def Window_GetCapture(*args):
10155 """
10156 Window_GetCapture() -> Window
10157
10158 Returns the window which currently captures the mouse or None
10159 """
10160 return _core_.Window_GetCapture(*args)
10161
10162 def Window_GetClassDefaultAttributes(*args, **kwargs):
10163 """
10164 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10165
10166 Get the default attributes for this class. This is useful if you want
10167 to use the same font or colour in your own control as in a standard
10168 control -- which is a much better idea than hard coding specific
10169 colours or fonts which might look completely out of place on the
10170 user's system, especially if it uses themes.
10171
10172 The variant parameter is only relevant under Mac currently and is
10173 ignore under other platforms. Under Mac, it will change the size of
10174 the returned font. See `wx.Window.SetWindowVariant` for more about
10175 this.
10176 """
10177 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10178
10179 def DLG_PNT(win, point_or_x, y=None):
10180 """
10181 Convenience function for converting a Point or (x,y) in
10182 dialog units to pixel units.
10183 """
10184 if y is None:
10185 return win.ConvertDialogPointToPixels(point_or_x)
10186 else:
10187 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10188
10189 def DLG_SZE(win, size_width, height=None):
10190 """
10191 Convenience function for converting a Size or (w,h) in
10192 dialog units to pixel units.
10193 """
10194 if height is None:
10195 return win.ConvertDialogSizeToPixels(size_width)
10196 else:
10197 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10198
10199
10200 def FindWindowById(*args, **kwargs):
10201 """
10202 FindWindowById(long id, Window parent=None) -> Window
10203
10204 Find the first window in the application with the given id. If parent
10205 is None, the search will start from all top-level frames and dialog
10206 boxes; if non-None, the search will be limited to the given window
10207 hierarchy. The search is recursive in both cases.
10208 """
10209 return _core_.FindWindowById(*args, **kwargs)
10210
10211 def FindWindowByName(*args, **kwargs):
10212 """
10213 FindWindowByName(String name, Window parent=None) -> Window
10214
10215 Find a window by its name (as given in a window constructor or Create
10216 function call). If parent is None, the search will start from all
10217 top-level frames and dialog boxes; if non-None, the search will be
10218 limited to the given window hierarchy. The search is recursive in both
10219 cases.
10220
10221 If no window with such name is found, wx.FindWindowByLabel is called.
10222 """
10223 return _core_.FindWindowByName(*args, **kwargs)
10224
10225 def FindWindowByLabel(*args, **kwargs):
10226 """
10227 FindWindowByLabel(String label, Window parent=None) -> Window
10228
10229 Find a window by its label. Depending on the type of window, the label
10230 may be a window title or panel item label. If parent is None, the
10231 search will start from all top-level frames and dialog boxes; if
10232 non-None, the search will be limited to the given window
10233 hierarchy. The search is recursive in both cases.
10234 """
10235 return _core_.FindWindowByLabel(*args, **kwargs)
10236
10237 def Window_FromHWND(*args, **kwargs):
10238 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10239 return _core_.Window_FromHWND(*args, **kwargs)
10240
10241 def GetTopLevelWindows(*args):
10242 """
10243 GetTopLevelWindows() -> PyObject
10244
10245 Returns a list of the the application's top-level windows, (frames,
10246 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10247 by wxWidgets, and so it is only valid as long as no top-level windows
10248 are closed or new top-level windows are created.
10249
10250 """
10251 return _core_.GetTopLevelWindows(*args)
10252 #---------------------------------------------------------------------------
10253
10254 class Validator(EvtHandler):
10255 """Proxy of C++ Validator class"""
10256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10257 __repr__ = _swig_repr
10258 def __init__(self, *args, **kwargs):
10259 """__init__(self) -> Validator"""
10260 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10261 self._setOORInfo(self)
10262
10263 def Clone(*args, **kwargs):
10264 """Clone(self) -> Validator"""
10265 return _core_.Validator_Clone(*args, **kwargs)
10266
10267 def Validate(*args, **kwargs):
10268 """Validate(self, Window parent) -> bool"""
10269 return _core_.Validator_Validate(*args, **kwargs)
10270
10271 def TransferToWindow(*args, **kwargs):
10272 """TransferToWindow(self) -> bool"""
10273 return _core_.Validator_TransferToWindow(*args, **kwargs)
10274
10275 def TransferFromWindow(*args, **kwargs):
10276 """TransferFromWindow(self) -> bool"""
10277 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10278
10279 def GetWindow(*args, **kwargs):
10280 """GetWindow(self) -> Window"""
10281 return _core_.Validator_GetWindow(*args, **kwargs)
10282
10283 def SetWindow(*args, **kwargs):
10284 """SetWindow(self, Window window)"""
10285 return _core_.Validator_SetWindow(*args, **kwargs)
10286
10287 def IsSilent(*args, **kwargs):
10288 """IsSilent() -> bool"""
10289 return _core_.Validator_IsSilent(*args, **kwargs)
10290
10291 IsSilent = staticmethod(IsSilent)
10292 def SetBellOnError(*args, **kwargs):
10293 """SetBellOnError(int doIt=True)"""
10294 return _core_.Validator_SetBellOnError(*args, **kwargs)
10295
10296 SetBellOnError = staticmethod(SetBellOnError)
10297 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
10298 _core_.Validator_swigregister(Validator)
10299
10300 def Validator_IsSilent(*args):
10301 """Validator_IsSilent() -> bool"""
10302 return _core_.Validator_IsSilent(*args)
10303
10304 def Validator_SetBellOnError(*args, **kwargs):
10305 """Validator_SetBellOnError(int doIt=True)"""
10306 return _core_.Validator_SetBellOnError(*args, **kwargs)
10307
10308 class PyValidator(Validator):
10309 """Proxy of C++ PyValidator class"""
10310 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10311 __repr__ = _swig_repr
10312 def __init__(self, *args, **kwargs):
10313 """__init__(self) -> PyValidator"""
10314 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10315
10316 self._setCallbackInfo(self, PyValidator, 1)
10317 self._setOORInfo(self)
10318
10319 def _setCallbackInfo(*args, **kwargs):
10320 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10321 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10322
10323 _core_.PyValidator_swigregister(PyValidator)
10324
10325 #---------------------------------------------------------------------------
10326
10327 class Menu(EvtHandler):
10328 """Proxy of C++ Menu class"""
10329 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10330 __repr__ = _swig_repr
10331 def __init__(self, *args, **kwargs):
10332 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10333 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10334 self._setOORInfo(self)
10335
10336 def Append(*args, **kwargs):
10337 """
10338 Append(self, int id, String text=EmptyString, String help=EmptyString,
10339 int kind=ITEM_NORMAL) -> MenuItem
10340 """
10341 return _core_.Menu_Append(*args, **kwargs)
10342
10343 def AppendSeparator(*args, **kwargs):
10344 """AppendSeparator(self) -> MenuItem"""
10345 return _core_.Menu_AppendSeparator(*args, **kwargs)
10346
10347 def AppendCheckItem(*args, **kwargs):
10348 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10349 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10350
10351 def AppendRadioItem(*args, **kwargs):
10352 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10353 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10354
10355 def AppendMenu(*args, **kwargs):
10356 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10357 return _core_.Menu_AppendMenu(*args, **kwargs)
10358
10359 def AppendSubMenu(*args, **kwargs):
10360 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10361 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10362
10363 def AppendItem(*args, **kwargs):
10364 """AppendItem(self, MenuItem item) -> MenuItem"""
10365 return _core_.Menu_AppendItem(*args, **kwargs)
10366
10367 def InsertItem(*args, **kwargs):
10368 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10369 return _core_.Menu_InsertItem(*args, **kwargs)
10370
10371 def PrependItem(*args, **kwargs):
10372 """PrependItem(self, MenuItem item) -> MenuItem"""
10373 return _core_.Menu_PrependItem(*args, **kwargs)
10374
10375 def Break(*args, **kwargs):
10376 """Break(self)"""
10377 return _core_.Menu_Break(*args, **kwargs)
10378
10379 def Insert(*args, **kwargs):
10380 """
10381 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10382 int kind=ITEM_NORMAL) -> MenuItem
10383 """
10384 return _core_.Menu_Insert(*args, **kwargs)
10385
10386 def InsertSeparator(*args, **kwargs):
10387 """InsertSeparator(self, size_t pos) -> MenuItem"""
10388 return _core_.Menu_InsertSeparator(*args, **kwargs)
10389
10390 def InsertCheckItem(*args, **kwargs):
10391 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10392 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10393
10394 def InsertRadioItem(*args, **kwargs):
10395 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10396 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10397
10398 def InsertMenu(*args, **kwargs):
10399 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10400 return _core_.Menu_InsertMenu(*args, **kwargs)
10401
10402 def Prepend(*args, **kwargs):
10403 """
10404 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10405 int kind=ITEM_NORMAL) -> MenuItem
10406 """
10407 return _core_.Menu_Prepend(*args, **kwargs)
10408
10409 def PrependSeparator(*args, **kwargs):
10410 """PrependSeparator(self) -> MenuItem"""
10411 return _core_.Menu_PrependSeparator(*args, **kwargs)
10412
10413 def PrependCheckItem(*args, **kwargs):
10414 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10415 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10416
10417 def PrependRadioItem(*args, **kwargs):
10418 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10419 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10420
10421 def PrependMenu(*args, **kwargs):
10422 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10423 return _core_.Menu_PrependMenu(*args, **kwargs)
10424
10425 def Remove(*args, **kwargs):
10426 """Remove(self, int id) -> MenuItem"""
10427 return _core_.Menu_Remove(*args, **kwargs)
10428
10429 def RemoveItem(*args, **kwargs):
10430 """RemoveItem(self, MenuItem item) -> MenuItem"""
10431 return _core_.Menu_RemoveItem(*args, **kwargs)
10432
10433 def Delete(*args, **kwargs):
10434 """Delete(self, int id) -> bool"""
10435 return _core_.Menu_Delete(*args, **kwargs)
10436
10437 def DeleteItem(*args, **kwargs):
10438 """DeleteItem(self, MenuItem item) -> bool"""
10439 return _core_.Menu_DeleteItem(*args, **kwargs)
10440
10441 def Destroy(*args, **kwargs):
10442 """
10443 Destroy(self)
10444
10445 Deletes the C++ object this Python object is a proxy for.
10446 """
10447 val = _core_.Menu_Destroy(*args, **kwargs)
10448 args[0].thisown = 0
10449 return val
10450
10451 def DestroyId(*args, **kwargs):
10452 """
10453 DestroyId(self, int id) -> bool
10454
10455 Deletes the C++ object this Python object is a proxy for.
10456 """
10457 val = _core_.Menu_DestroyId(*args, **kwargs)
10458 args[0].thisown = 0
10459 return val
10460
10461 def DestroyItem(*args, **kwargs):
10462 """
10463 DestroyItem(self, MenuItem item) -> bool
10464
10465 Deletes the C++ object this Python object is a proxy for.
10466 """
10467 val = _core_.Menu_DestroyItem(*args, **kwargs)
10468 args[0].thisown = 0
10469 return val
10470
10471 def GetMenuItemCount(*args, **kwargs):
10472 """GetMenuItemCount(self) -> size_t"""
10473 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10474
10475 def GetMenuItems(*args, **kwargs):
10476 """GetMenuItems(self) -> PyObject"""
10477 return _core_.Menu_GetMenuItems(*args, **kwargs)
10478
10479 def FindItem(*args, **kwargs):
10480 """FindItem(self, String item) -> int"""
10481 return _core_.Menu_FindItem(*args, **kwargs)
10482
10483 def FindItemById(*args, **kwargs):
10484 """FindItemById(self, int id) -> MenuItem"""
10485 return _core_.Menu_FindItemById(*args, **kwargs)
10486
10487 def FindItemByPosition(*args, **kwargs):
10488 """FindItemByPosition(self, size_t position) -> MenuItem"""
10489 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10490
10491 def Enable(*args, **kwargs):
10492 """Enable(self, int id, bool enable)"""
10493 return _core_.Menu_Enable(*args, **kwargs)
10494
10495 def IsEnabled(*args, **kwargs):
10496 """IsEnabled(self, int id) -> bool"""
10497 return _core_.Menu_IsEnabled(*args, **kwargs)
10498
10499 def Check(*args, **kwargs):
10500 """Check(self, int id, bool check)"""
10501 return _core_.Menu_Check(*args, **kwargs)
10502
10503 def IsChecked(*args, **kwargs):
10504 """IsChecked(self, int id) -> bool"""
10505 return _core_.Menu_IsChecked(*args, **kwargs)
10506
10507 def SetLabel(*args, **kwargs):
10508 """SetLabel(self, int id, String label)"""
10509 return _core_.Menu_SetLabel(*args, **kwargs)
10510
10511 def GetLabel(*args, **kwargs):
10512 """GetLabel(self, int id) -> String"""
10513 return _core_.Menu_GetLabel(*args, **kwargs)
10514
10515 def SetHelpString(*args, **kwargs):
10516 """SetHelpString(self, int id, String helpString)"""
10517 return _core_.Menu_SetHelpString(*args, **kwargs)
10518
10519 def GetHelpString(*args, **kwargs):
10520 """GetHelpString(self, int id) -> String"""
10521 return _core_.Menu_GetHelpString(*args, **kwargs)
10522
10523 def SetTitle(*args, **kwargs):
10524 """SetTitle(self, String title)"""
10525 return _core_.Menu_SetTitle(*args, **kwargs)
10526
10527 def GetTitle(*args, **kwargs):
10528 """GetTitle(self) -> String"""
10529 return _core_.Menu_GetTitle(*args, **kwargs)
10530
10531 def SetEventHandler(*args, **kwargs):
10532 """SetEventHandler(self, EvtHandler handler)"""
10533 return _core_.Menu_SetEventHandler(*args, **kwargs)
10534
10535 def GetEventHandler(*args, **kwargs):
10536 """GetEventHandler(self) -> EvtHandler"""
10537 return _core_.Menu_GetEventHandler(*args, **kwargs)
10538
10539 def SetInvokingWindow(*args, **kwargs):
10540 """SetInvokingWindow(self, Window win)"""
10541 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10542
10543 def GetInvokingWindow(*args, **kwargs):
10544 """GetInvokingWindow(self) -> Window"""
10545 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10546
10547 def GetStyle(*args, **kwargs):
10548 """GetStyle(self) -> long"""
10549 return _core_.Menu_GetStyle(*args, **kwargs)
10550
10551 def UpdateUI(*args, **kwargs):
10552 """UpdateUI(self, EvtHandler source=None)"""
10553 return _core_.Menu_UpdateUI(*args, **kwargs)
10554
10555 def GetMenuBar(*args, **kwargs):
10556 """GetMenuBar(self) -> MenuBar"""
10557 return _core_.Menu_GetMenuBar(*args, **kwargs)
10558
10559 def Attach(*args, **kwargs):
10560 """Attach(self, wxMenuBarBase menubar)"""
10561 return _core_.Menu_Attach(*args, **kwargs)
10562
10563 def Detach(*args, **kwargs):
10564 """Detach(self)"""
10565 return _core_.Menu_Detach(*args, **kwargs)
10566
10567 def IsAttached(*args, **kwargs):
10568 """IsAttached(self) -> bool"""
10569 return _core_.Menu_IsAttached(*args, **kwargs)
10570
10571 def SetParent(*args, **kwargs):
10572 """SetParent(self, Menu parent)"""
10573 return _core_.Menu_SetParent(*args, **kwargs)
10574
10575 def GetParent(*args, **kwargs):
10576 """GetParent(self) -> Menu"""
10577 return _core_.Menu_GetParent(*args, **kwargs)
10578
10579 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10580 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10581 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10582 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10583 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10584 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10585 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10586 Style = property(GetStyle,doc="See `GetStyle`")
10587 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
10588 _core_.Menu_swigregister(Menu)
10589 DefaultValidator = cvar.DefaultValidator
10590
10591 #---------------------------------------------------------------------------
10592
10593 class MenuBar(Window):
10594 """Proxy of C++ MenuBar class"""
10595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10596 __repr__ = _swig_repr
10597 def __init__(self, *args, **kwargs):
10598 """__init__(self, long style=0) -> MenuBar"""
10599 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10600 self._setOORInfo(self)
10601
10602 def Append(*args, **kwargs):
10603 """Append(self, Menu menu, String title) -> bool"""
10604 return _core_.MenuBar_Append(*args, **kwargs)
10605
10606 def Insert(*args, **kwargs):
10607 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10608 return _core_.MenuBar_Insert(*args, **kwargs)
10609
10610 def GetMenuCount(*args, **kwargs):
10611 """GetMenuCount(self) -> size_t"""
10612 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10613
10614 def GetMenu(*args, **kwargs):
10615 """GetMenu(self, size_t pos) -> Menu"""
10616 return _core_.MenuBar_GetMenu(*args, **kwargs)
10617
10618 def Replace(*args, **kwargs):
10619 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10620 return _core_.MenuBar_Replace(*args, **kwargs)
10621
10622 def Remove(*args, **kwargs):
10623 """Remove(self, size_t pos) -> Menu"""
10624 return _core_.MenuBar_Remove(*args, **kwargs)
10625
10626 def EnableTop(*args, **kwargs):
10627 """EnableTop(self, size_t pos, bool enable)"""
10628 return _core_.MenuBar_EnableTop(*args, **kwargs)
10629
10630 def IsEnabledTop(*args, **kwargs):
10631 """IsEnabledTop(self, size_t pos) -> bool"""
10632 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10633
10634 def SetLabelTop(*args, **kwargs):
10635 """SetLabelTop(self, size_t pos, String label)"""
10636 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10637
10638 def GetLabelTop(*args, **kwargs):
10639 """GetLabelTop(self, size_t pos) -> String"""
10640 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10641
10642 def FindMenuItem(*args, **kwargs):
10643 """FindMenuItem(self, String menu, String item) -> int"""
10644 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10645
10646 def FindItemById(*args, **kwargs):
10647 """FindItemById(self, int id) -> MenuItem"""
10648 return _core_.MenuBar_FindItemById(*args, **kwargs)
10649
10650 def FindMenu(*args, **kwargs):
10651 """FindMenu(self, String title) -> int"""
10652 return _core_.MenuBar_FindMenu(*args, **kwargs)
10653
10654 def Enable(*args, **kwargs):
10655 """Enable(self, int id, bool enable)"""
10656 return _core_.MenuBar_Enable(*args, **kwargs)
10657
10658 def Check(*args, **kwargs):
10659 """Check(self, int id, bool check)"""
10660 return _core_.MenuBar_Check(*args, **kwargs)
10661
10662 def IsChecked(*args, **kwargs):
10663 """IsChecked(self, int id) -> bool"""
10664 return _core_.MenuBar_IsChecked(*args, **kwargs)
10665
10666 def IsEnabled(*args, **kwargs):
10667 """IsEnabled(self, int id) -> bool"""
10668 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10669
10670 def SetLabel(*args, **kwargs):
10671 """SetLabel(self, int id, String label)"""
10672 return _core_.MenuBar_SetLabel(*args, **kwargs)
10673
10674 def GetLabel(*args, **kwargs):
10675 """GetLabel(self, int id) -> String"""
10676 return _core_.MenuBar_GetLabel(*args, **kwargs)
10677
10678 def SetHelpString(*args, **kwargs):
10679 """SetHelpString(self, int id, String helpString)"""
10680 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10681
10682 def GetHelpString(*args, **kwargs):
10683 """GetHelpString(self, int id) -> String"""
10684 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10685
10686 def GetFrame(*args, **kwargs):
10687 """GetFrame(self) -> wxFrame"""
10688 return _core_.MenuBar_GetFrame(*args, **kwargs)
10689
10690 def IsAttached(*args, **kwargs):
10691 """IsAttached(self) -> bool"""
10692 return _core_.MenuBar_IsAttached(*args, **kwargs)
10693
10694 def Attach(*args, **kwargs):
10695 """Attach(self, wxFrame frame)"""
10696 return _core_.MenuBar_Attach(*args, **kwargs)
10697
10698 def Detach(*args, **kwargs):
10699 """Detach(self)"""
10700 return _core_.MenuBar_Detach(*args, **kwargs)
10701
10702 def UpdateMenus(*args, **kwargs):
10703 """UpdateMenus(self)"""
10704 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10705
10706 def SetAutoWindowMenu(*args, **kwargs):
10707 """SetAutoWindowMenu(bool enable)"""
10708 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10709
10710 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10711 def GetAutoWindowMenu(*args, **kwargs):
10712 """GetAutoWindowMenu() -> bool"""
10713 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10714
10715 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10716 def GetMenus(self):
10717 """Return a list of (menu, label) items for the menus in the MenuBar. """
10718 return [(self.GetMenu(i), self.GetLabelTop(i))
10719 for i in range(self.GetMenuCount())]
10720
10721 def SetMenus(self, items):
10722 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10723 for i in range(self.GetMenuCount()-1, -1, -1):
10724 self.Remove(i)
10725 for m, l in items:
10726 self.Append(m, l)
10727
10728 Frame = property(GetFrame,doc="See `GetFrame`")
10729 Menu = property(GetMenu,doc="See `GetMenu`")
10730 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
10731 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
10732 _core_.MenuBar_swigregister(MenuBar)
10733
10734 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10735 """MenuBar_SetAutoWindowMenu(bool enable)"""
10736 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10737
10738 def MenuBar_GetAutoWindowMenu(*args):
10739 """MenuBar_GetAutoWindowMenu() -> bool"""
10740 return _core_.MenuBar_GetAutoWindowMenu(*args)
10741
10742 #---------------------------------------------------------------------------
10743
10744 class MenuItem(Object):
10745 """Proxy of C++ MenuItem class"""
10746 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10747 __repr__ = _swig_repr
10748 def __init__(self, *args, **kwargs):
10749 """
10750 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10751 String help=EmptyString, int kind=ITEM_NORMAL,
10752 Menu subMenu=None) -> MenuItem
10753 """
10754 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
10755 __swig_destroy__ = _core_.delete_MenuItem
10756 __del__ = lambda self : None;
10757 def GetMenu(*args, **kwargs):
10758 """GetMenu(self) -> Menu"""
10759 return _core_.MenuItem_GetMenu(*args, **kwargs)
10760
10761 def SetMenu(*args, **kwargs):
10762 """SetMenu(self, Menu menu)"""
10763 return _core_.MenuItem_SetMenu(*args, **kwargs)
10764
10765 def SetId(*args, **kwargs):
10766 """SetId(self, int id)"""
10767 return _core_.MenuItem_SetId(*args, **kwargs)
10768
10769 def GetId(*args, **kwargs):
10770 """GetId(self) -> int"""
10771 return _core_.MenuItem_GetId(*args, **kwargs)
10772
10773 def IsSeparator(*args, **kwargs):
10774 """IsSeparator(self) -> bool"""
10775 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10776
10777 def SetText(*args, **kwargs):
10778 """SetText(self, String str)"""
10779 return _core_.MenuItem_SetText(*args, **kwargs)
10780
10781 def GetLabel(*args, **kwargs):
10782 """GetLabel(self) -> String"""
10783 return _core_.MenuItem_GetLabel(*args, **kwargs)
10784
10785 def GetText(*args, **kwargs):
10786 """GetText(self) -> String"""
10787 return _core_.MenuItem_GetText(*args, **kwargs)
10788
10789 def GetLabelFromText(*args, **kwargs):
10790 """GetLabelFromText(String text) -> String"""
10791 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10792
10793 GetLabelFromText = staticmethod(GetLabelFromText)
10794 def GetKind(*args, **kwargs):
10795 """GetKind(self) -> int"""
10796 return _core_.MenuItem_GetKind(*args, **kwargs)
10797
10798 def SetKind(*args, **kwargs):
10799 """SetKind(self, int kind)"""
10800 return _core_.MenuItem_SetKind(*args, **kwargs)
10801
10802 def SetCheckable(*args, **kwargs):
10803 """SetCheckable(self, bool checkable)"""
10804 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10805
10806 def IsCheckable(*args, **kwargs):
10807 """IsCheckable(self) -> bool"""
10808 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10809
10810 def IsSubMenu(*args, **kwargs):
10811 """IsSubMenu(self) -> bool"""
10812 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10813
10814 def SetSubMenu(*args, **kwargs):
10815 """SetSubMenu(self, Menu menu)"""
10816 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10817
10818 def GetSubMenu(*args, **kwargs):
10819 """GetSubMenu(self) -> Menu"""
10820 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10821
10822 def Enable(*args, **kwargs):
10823 """Enable(self, bool enable=True)"""
10824 return _core_.MenuItem_Enable(*args, **kwargs)
10825
10826 def IsEnabled(*args, **kwargs):
10827 """IsEnabled(self) -> bool"""
10828 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10829
10830 def Check(*args, **kwargs):
10831 """Check(self, bool check=True)"""
10832 return _core_.MenuItem_Check(*args, **kwargs)
10833
10834 def IsChecked(*args, **kwargs):
10835 """IsChecked(self) -> bool"""
10836 return _core_.MenuItem_IsChecked(*args, **kwargs)
10837
10838 def Toggle(*args, **kwargs):
10839 """Toggle(self)"""
10840 return _core_.MenuItem_Toggle(*args, **kwargs)
10841
10842 def SetHelp(*args, **kwargs):
10843 """SetHelp(self, String str)"""
10844 return _core_.MenuItem_SetHelp(*args, **kwargs)
10845
10846 def GetHelp(*args, **kwargs):
10847 """GetHelp(self) -> String"""
10848 return _core_.MenuItem_GetHelp(*args, **kwargs)
10849
10850 def GetAccel(*args, **kwargs):
10851 """GetAccel(self) -> AcceleratorEntry"""
10852 return _core_.MenuItem_GetAccel(*args, **kwargs)
10853
10854 def SetAccel(*args, **kwargs):
10855 """SetAccel(self, AcceleratorEntry accel)"""
10856 return _core_.MenuItem_SetAccel(*args, **kwargs)
10857
10858 def SetBitmap(*args, **kwargs):
10859 """SetBitmap(self, Bitmap bitmap)"""
10860 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10861
10862 def GetBitmap(*args, **kwargs):
10863 """GetBitmap(self) -> Bitmap"""
10864 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10865
10866 def SetFont(*args, **kwargs):
10867 """SetFont(self, Font font)"""
10868 return _core_.MenuItem_SetFont(*args, **kwargs)
10869
10870 def GetFont(*args, **kwargs):
10871 """GetFont(self) -> Font"""
10872 return _core_.MenuItem_GetFont(*args, **kwargs)
10873
10874 def SetTextColour(*args, **kwargs):
10875 """SetTextColour(self, Colour colText)"""
10876 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10877
10878 def GetTextColour(*args, **kwargs):
10879 """GetTextColour(self) -> Colour"""
10880 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10881
10882 def SetBackgroundColour(*args, **kwargs):
10883 """SetBackgroundColour(self, Colour colBack)"""
10884 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10885
10886 def GetBackgroundColour(*args, **kwargs):
10887 """GetBackgroundColour(self) -> Colour"""
10888 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10889
10890 def SetBitmaps(*args, **kwargs):
10891 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10892 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10893
10894 def SetDisabledBitmap(*args, **kwargs):
10895 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10896 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10897
10898 def GetDisabledBitmap(*args, **kwargs):
10899 """GetDisabledBitmap(self) -> Bitmap"""
10900 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10901
10902 def SetMarginWidth(*args, **kwargs):
10903 """SetMarginWidth(self, int nWidth)"""
10904 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10905
10906 def GetMarginWidth(*args, **kwargs):
10907 """GetMarginWidth(self) -> int"""
10908 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10909
10910 def GetDefaultMarginWidth(*args, **kwargs):
10911 """GetDefaultMarginWidth() -> int"""
10912 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10913
10914 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10915 def IsOwnerDrawn(*args, **kwargs):
10916 """IsOwnerDrawn(self) -> bool"""
10917 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10918
10919 def SetOwnerDrawn(*args, **kwargs):
10920 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10921 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10922
10923 def ResetOwnerDrawn(*args, **kwargs):
10924 """ResetOwnerDrawn(self)"""
10925 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10926
10927 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
10928 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10929 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
10930 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
10931 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10932 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
10933 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10934 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
10935 Label = property(GetLabel,doc="See `GetLabel`")
10936 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
10937 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
10938 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
10939 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
10940 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
10941 _core_.MenuItem_swigregister(MenuItem)
10942
10943 def MenuItem_GetLabelFromText(*args, **kwargs):
10944 """MenuItem_GetLabelFromText(String text) -> String"""
10945 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10946
10947 def MenuItem_GetDefaultMarginWidth(*args):
10948 """MenuItem_GetDefaultMarginWidth() -> int"""
10949 return _core_.MenuItem_GetDefaultMarginWidth(*args)
10950
10951 #---------------------------------------------------------------------------
10952
10953 class Control(Window):
10954 """
10955 This is the base class for a control or 'widget'.
10956
10957 A control is generally a small window which processes user input
10958 and/or displays one or more item of data.
10959 """
10960 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10961 __repr__ = _swig_repr
10962 def __init__(self, *args, **kwargs):
10963 """
10964 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10965 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10966 String name=ControlNameStr) -> Control
10967
10968 Create a Control. Normally you should only call this from a subclass'
10969 __init__ as a plain old wx.Control is not very useful.
10970 """
10971 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
10972 self._setOORInfo(self)
10973
10974 def Create(*args, **kwargs):
10975 """
10976 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10977 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
10978 String name=ControlNameStr) -> bool
10979
10980 Do the 2nd phase and create the GUI control.
10981 """
10982 return _core_.Control_Create(*args, **kwargs)
10983
10984 def GetAlignment(*args, **kwargs):
10985 """
10986 GetAlignment(self) -> int
10987
10988 Get the control alignment (left/right/centre, top/bottom/centre)
10989 """
10990 return _core_.Control_GetAlignment(*args, **kwargs)
10991
10992 def GetLabelText(*args, **kwargs):
10993 """
10994 GetLabelText(self) -> String
10995
10996 Get just the text of the label, without mnemonic characters ('&')
10997 """
10998 return _core_.Control_GetLabelText(*args, **kwargs)
10999
11000 def Command(*args, **kwargs):
11001 """
11002 Command(self, CommandEvent event)
11003
11004 Simulates the effect of the user issuing a command to the item.
11005
11006 :see: `wx.CommandEvent`
11007
11008 """
11009 return _core_.Control_Command(*args, **kwargs)
11010
11011 def GetClassDefaultAttributes(*args, **kwargs):
11012 """
11013 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11014
11015 Get the default attributes for this class. This is useful if you want
11016 to use the same font or colour in your own control as in a standard
11017 control -- which is a much better idea than hard coding specific
11018 colours or fonts which might look completely out of place on the
11019 user's system, especially if it uses themes.
11020
11021 The variant parameter is only relevant under Mac currently and is
11022 ignore under other platforms. Under Mac, it will change the size of
11023 the returned font. See `wx.Window.SetWindowVariant` for more about
11024 this.
11025 """
11026 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11027
11028 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11029 Alignment = property(GetAlignment,doc="See `GetAlignment`")
11030 LabelText = property(GetLabelText,doc="See `GetLabelText`")
11031 _core_.Control_swigregister(Control)
11032 ControlNameStr = cvar.ControlNameStr
11033
11034 def PreControl(*args, **kwargs):
11035 """
11036 PreControl() -> Control
11037
11038 Precreate a Control control for 2-phase creation
11039 """
11040 val = _core_.new_PreControl(*args, **kwargs)
11041 return val
11042
11043 def Control_GetClassDefaultAttributes(*args, **kwargs):
11044 """
11045 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11046
11047 Get the default attributes for this class. This is useful if you want
11048 to use the same font or colour in your own control as in a standard
11049 control -- which is a much better idea than hard coding specific
11050 colours or fonts which might look completely out of place on the
11051 user's system, especially if it uses themes.
11052
11053 The variant parameter is only relevant under Mac currently and is
11054 ignore under other platforms. Under Mac, it will change the size of
11055 the returned font. See `wx.Window.SetWindowVariant` for more about
11056 this.
11057 """
11058 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11059
11060 #---------------------------------------------------------------------------
11061
11062 class ItemContainer(object):
11063 """
11064 The wx.ItemContainer class defines an interface which is implemented
11065 by all controls which have string subitems, each of which may be
11066 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11067 as `wx.ComboBox` which implements an extended interface deriving from
11068 this one.
11069
11070 It defines the methods for accessing the control's items and although
11071 each of the derived classes implements them differently, they still
11072 all conform to the same interface.
11073
11074 The items in a wx.ItemContainer have (non empty) string labels and,
11075 optionally, client data associated with them.
11076
11077 """
11078 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11079 def __init__(self): raise AttributeError, "No constructor defined"
11080 __repr__ = _swig_repr
11081 def Append(*args, **kwargs):
11082 """
11083 Append(self, String item, PyObject clientData=None) -> int
11084
11085 Adds the item to the control, associating the given data with the item
11086 if not None. The return value is the index of the newly added item
11087 which may be different from the last one if the control is sorted (e.g.
11088 has wx.LB_SORT or wx.CB_SORT style).
11089 """
11090 return _core_.ItemContainer_Append(*args, **kwargs)
11091
11092 def AppendItems(*args, **kwargs):
11093 """
11094 AppendItems(self, List strings)
11095
11096 Apend several items at once to the control. Notice that calling this
11097 method may be much faster than appending the items one by one if you
11098 need to add a lot of items.
11099 """
11100 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11101
11102 def Insert(*args, **kwargs):
11103 """
11104 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11105
11106 Insert an item into the control before the item at the ``pos`` index,
11107 optionally associating some data object with the item.
11108 """
11109 return _core_.ItemContainer_Insert(*args, **kwargs)
11110
11111 def Clear(*args, **kwargs):
11112 """
11113 Clear(self)
11114
11115 Removes all items from the control.
11116 """
11117 return _core_.ItemContainer_Clear(*args, **kwargs)
11118
11119 def Delete(*args, **kwargs):
11120 """
11121 Delete(self, unsigned int n)
11122
11123 Deletes the item at the zero-based index 'n' from the control. Note
11124 that it is an error (signalled by a `wx.PyAssertionError` exception if
11125 enabled) to remove an item with the index negative or greater or equal
11126 than the number of items in the control.
11127 """
11128 return _core_.ItemContainer_Delete(*args, **kwargs)
11129
11130 def GetClientData(*args, **kwargs):
11131 """
11132 GetClientData(self, unsigned int n) -> PyObject
11133
11134 Returns the client data associated with the given item, (if any.)
11135 """
11136 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11137
11138 def SetClientData(*args, **kwargs):
11139 """
11140 SetClientData(self, unsigned int n, PyObject clientData)
11141
11142 Associate the given client data with the item at position n.
11143 """
11144 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11145
11146 def GetCount(*args, **kwargs):
11147 """
11148 GetCount(self) -> unsigned int
11149
11150 Returns the number of items in the control.
11151 """
11152 return _core_.ItemContainer_GetCount(*args, **kwargs)
11153
11154 def IsEmpty(*args, **kwargs):
11155 """
11156 IsEmpty(self) -> bool
11157
11158 Returns True if the control is empty or False if it has some items.
11159 """
11160 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11161
11162 def GetString(*args, **kwargs):
11163 """
11164 GetString(self, unsigned int n) -> String
11165
11166 Returns the label of the item with the given index.
11167 """
11168 return _core_.ItemContainer_GetString(*args, **kwargs)
11169
11170 def GetStrings(*args, **kwargs):
11171 """GetStrings(self) -> wxArrayString"""
11172 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11173
11174 def SetString(*args, **kwargs):
11175 """
11176 SetString(self, unsigned int n, String s)
11177
11178 Sets the label for the given item.
11179 """
11180 return _core_.ItemContainer_SetString(*args, **kwargs)
11181
11182 def FindString(*args, **kwargs):
11183 """
11184 FindString(self, String s) -> int
11185
11186 Finds an item whose label matches the given string. Returns the
11187 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11188 found.
11189 """
11190 return _core_.ItemContainer_FindString(*args, **kwargs)
11191
11192 def SetSelection(*args, **kwargs):
11193 """
11194 SetSelection(self, int n)
11195
11196 Sets the item at index 'n' to be the selected item.
11197 """
11198 return _core_.ItemContainer_SetSelection(*args, **kwargs)
11199
11200 def GetSelection(*args, **kwargs):
11201 """
11202 GetSelection(self) -> int
11203
11204 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11205 is selected.
11206 """
11207 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11208
11209 def SetStringSelection(*args, **kwargs):
11210 """SetStringSelection(self, String s) -> bool"""
11211 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11212
11213 def GetStringSelection(*args, **kwargs):
11214 """
11215 GetStringSelection(self) -> String
11216
11217 Returns the label of the selected item or an empty string if no item
11218 is selected.
11219 """
11220 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11221
11222 def Select(*args, **kwargs):
11223 """
11224 Select(self, int n)
11225
11226 This is the same as `SetSelection` and exists only because it is
11227 slightly more natural for controls which support multiple selection.
11228 """
11229 return _core_.ItemContainer_Select(*args, **kwargs)
11230
11231 def GetItems(self):
11232 """Return a list of the strings in the control"""
11233 return [self.GetString(i) for i in xrange(self.GetCount())]
11234
11235 def SetItems(self, items):
11236 """Clear and set the strings in the control from a list"""
11237 self.Clear()
11238 for i in items:
11239 self.Append(i)
11240
11241 Count = property(GetCount,doc="See `GetCount`")
11242 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11243 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11244 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11245 Strings = property(GetStrings,doc="See `GetStrings`")
11246 _core_.ItemContainer_swigregister(ItemContainer)
11247
11248 #---------------------------------------------------------------------------
11249
11250 class ControlWithItems(Control,ItemContainer):
11251 """
11252 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11253 wx.Control class, and is used for the base class of various controls
11254 that have items.
11255 """
11256 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11257 def __init__(self): raise AttributeError, "No constructor defined"
11258 __repr__ = _swig_repr
11259 _core_.ControlWithItems_swigregister(ControlWithItems)
11260
11261 #---------------------------------------------------------------------------
11262
11263 class SizerItem(Object):
11264 """
11265 The wx.SizerItem class is used to track the position, size and other
11266 attributes of each item managed by a `wx.Sizer`. It is not usually
11267 necessary to use this class because the sizer elements can also be
11268 identified by their positions or window or sizer references but
11269 sometimes it may be more convenient to use wx.SizerItem directly.
11270 Also, custom classes derived from `wx.PySizer` will probably need to
11271 use the collection of wx.SizerItems held by wx.Sizer when calculating
11272 layout.
11273
11274 :see: `wx.Sizer`, `wx.GBSizerItem`
11275 """
11276 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11277 __repr__ = _swig_repr
11278 def __init__(self, *args, **kwargs):
11279 """
11280 __init__(self) -> SizerItem
11281
11282 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11283 size will need to be set before this item can be used in a Sizer.
11284
11285 You will probably never need to create a wx.SizerItem directly as they
11286 are created automatically when the sizer's Add, Insert or Prepend
11287 methods are called.
11288
11289 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11290 """
11291 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11292 __swig_destroy__ = _core_.delete_SizerItem
11293 __del__ = lambda self : None;
11294 def DeleteWindows(*args, **kwargs):
11295 """
11296 DeleteWindows(self)
11297
11298 Destroy the window or the windows in a subsizer, depending on the type
11299 of item.
11300 """
11301 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11302
11303 def DetachSizer(*args, **kwargs):
11304 """
11305 DetachSizer(self)
11306
11307 Enable deleting the SizerItem without destroying the contained sizer.
11308 """
11309 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11310
11311 def GetSize(*args, **kwargs):
11312 """
11313 GetSize(self) -> Size
11314
11315 Get the current size of the item, as set in the last Layout.
11316 """
11317 return _core_.SizerItem_GetSize(*args, **kwargs)
11318
11319 def CalcMin(*args, **kwargs):
11320 """
11321 CalcMin(self) -> Size
11322
11323 Calculates the minimum desired size for the item, including any space
11324 needed by borders.
11325 """
11326 return _core_.SizerItem_CalcMin(*args, **kwargs)
11327
11328 def SetDimension(*args, **kwargs):
11329 """
11330 SetDimension(self, Point pos, Size size)
11331
11332 Set the position and size of the space allocated for this item by the
11333 sizer, and adjust the position and size of the item (window or
11334 subsizer) to be within that space taking alignment and borders into
11335 account.
11336 """
11337 return _core_.SizerItem_SetDimension(*args, **kwargs)
11338
11339 def GetMinSize(*args, **kwargs):
11340 """
11341 GetMinSize(self) -> Size
11342
11343 Get the minimum size needed for the item.
11344 """
11345 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11346
11347 def GetMinSizeWithBorder(*args, **kwargs):
11348 """
11349 GetMinSizeWithBorder(self) -> Size
11350
11351 Get the minimum size needed for the item with space for the borders
11352 added, if needed.
11353 """
11354 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11355
11356 def SetInitSize(*args, **kwargs):
11357 """SetInitSize(self, int x, int y)"""
11358 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11359
11360 def SetRatioWH(*args, **kwargs):
11361 """
11362 SetRatioWH(self, int width, int height)
11363
11364 Set the ratio item attribute.
11365 """
11366 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11367
11368 def SetRatioSize(*args, **kwargs):
11369 """
11370 SetRatioSize(self, Size size)
11371
11372 Set the ratio item attribute.
11373 """
11374 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11375
11376 def SetRatio(*args, **kwargs):
11377 """
11378 SetRatio(self, float ratio)
11379
11380 Set the ratio item attribute.
11381 """
11382 return _core_.SizerItem_SetRatio(*args, **kwargs)
11383
11384 def GetRatio(*args, **kwargs):
11385 """
11386 GetRatio(self) -> float
11387
11388 Set the ratio item attribute.
11389 """
11390 return _core_.SizerItem_GetRatio(*args, **kwargs)
11391
11392 def GetRect(*args, **kwargs):
11393 """
11394 GetRect(self) -> Rect
11395
11396 Returns the rectangle that the sizer item should occupy
11397 """
11398 return _core_.SizerItem_GetRect(*args, **kwargs)
11399
11400 def IsWindow(*args, **kwargs):
11401 """
11402 IsWindow(self) -> bool
11403
11404 Is this sizer item a window?
11405 """
11406 return _core_.SizerItem_IsWindow(*args, **kwargs)
11407
11408 def IsSizer(*args, **kwargs):
11409 """
11410 IsSizer(self) -> bool
11411
11412 Is this sizer item a subsizer?
11413 """
11414 return _core_.SizerItem_IsSizer(*args, **kwargs)
11415
11416 def IsSpacer(*args, **kwargs):
11417 """
11418 IsSpacer(self) -> bool
11419
11420 Is this sizer item a spacer?
11421 """
11422 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11423
11424 def SetProportion(*args, **kwargs):
11425 """
11426 SetProportion(self, int proportion)
11427
11428 Set the proportion value for this item.
11429 """
11430 return _core_.SizerItem_SetProportion(*args, **kwargs)
11431
11432 def GetProportion(*args, **kwargs):
11433 """
11434 GetProportion(self) -> int
11435
11436 Get the proportion value for this item.
11437 """
11438 return _core_.SizerItem_GetProportion(*args, **kwargs)
11439
11440 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11441 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
11442 def SetFlag(*args, **kwargs):
11443 """
11444 SetFlag(self, int flag)
11445
11446 Set the flag value for this item.
11447 """
11448 return _core_.SizerItem_SetFlag(*args, **kwargs)
11449
11450 def GetFlag(*args, **kwargs):
11451 """
11452 GetFlag(self) -> int
11453
11454 Get the flag value for this item.
11455 """
11456 return _core_.SizerItem_GetFlag(*args, **kwargs)
11457
11458 def SetBorder(*args, **kwargs):
11459 """
11460 SetBorder(self, int border)
11461
11462 Set the border value for this item.
11463 """
11464 return _core_.SizerItem_SetBorder(*args, **kwargs)
11465
11466 def GetBorder(*args, **kwargs):
11467 """
11468 GetBorder(self) -> int
11469
11470 Get the border value for this item.
11471 """
11472 return _core_.SizerItem_GetBorder(*args, **kwargs)
11473
11474 def GetWindow(*args, **kwargs):
11475 """
11476 GetWindow(self) -> Window
11477
11478 Get the window (if any) that is managed by this sizer item.
11479 """
11480 return _core_.SizerItem_GetWindow(*args, **kwargs)
11481
11482 def SetWindow(*args, **kwargs):
11483 """
11484 SetWindow(self, Window window)
11485
11486 Set the window to be managed by this sizer item.
11487 """
11488 return _core_.SizerItem_SetWindow(*args, **kwargs)
11489
11490 def GetSizer(*args, **kwargs):
11491 """
11492 GetSizer(self) -> Sizer
11493
11494 Get the subsizer (if any) that is managed by this sizer item.
11495 """
11496 return _core_.SizerItem_GetSizer(*args, **kwargs)
11497
11498 def SetSizer(*args, **kwargs):
11499 """
11500 SetSizer(self, Sizer sizer)
11501
11502 Set the subsizer to be managed by this sizer item.
11503 """
11504 return _core_.SizerItem_SetSizer(*args, **kwargs)
11505
11506 def GetSpacer(*args, **kwargs):
11507 """
11508 GetSpacer(self) -> Size
11509
11510 Get the size of the spacer managed by this sizer item.
11511 """
11512 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11513
11514 def SetSpacer(*args, **kwargs):
11515 """
11516 SetSpacer(self, Size size)
11517
11518 Set the size of the spacer to be managed by this sizer item.
11519 """
11520 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11521
11522 def Show(*args, **kwargs):
11523 """
11524 Show(self, bool show)
11525
11526 Set the show item attribute, which sizers use to determine if the item
11527 is to be made part of the layout or not. If the item is tracking a
11528 window then it is shown or hidden as needed.
11529 """
11530 return _core_.SizerItem_Show(*args, **kwargs)
11531
11532 def IsShown(*args, **kwargs):
11533 """
11534 IsShown(self) -> bool
11535
11536 Is the item to be shown in the layout?
11537 """
11538 return _core_.SizerItem_IsShown(*args, **kwargs)
11539
11540 def GetPosition(*args, **kwargs):
11541 """
11542 GetPosition(self) -> Point
11543
11544 Returns the current position of the item, as set in the last Layout.
11545 """
11546 return _core_.SizerItem_GetPosition(*args, **kwargs)
11547
11548 def GetUserData(*args, **kwargs):
11549 """
11550 GetUserData(self) -> PyObject
11551
11552 Returns the userData associated with this sizer item, or None if there
11553 isn't any.
11554 """
11555 return _core_.SizerItem_GetUserData(*args, **kwargs)
11556
11557 def SetUserData(*args, **kwargs):
11558 """
11559 SetUserData(self, PyObject userData)
11560
11561 Associate a Python object with this sizer item.
11562 """
11563 return _core_.SizerItem_SetUserData(*args, **kwargs)
11564
11565 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11566 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11567 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11568 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11569 Position = property(GetPosition,doc="See `GetPosition`")
11570 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11571 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11572 Rect = property(GetRect,doc="See `GetRect`")
11573 Size = property(GetSize,doc="See `GetSize`")
11574 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11575 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11576 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11577 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
11578 _core_.SizerItem_swigregister(SizerItem)
11579
11580 def SizerItemWindow(*args, **kwargs):
11581 """
11582 SizerItemWindow(Window window, int proportion, int flag, int border,
11583 PyObject userData=None) -> SizerItem
11584
11585 Constructs a `wx.SizerItem` for tracking a window.
11586 """
11587 val = _core_.new_SizerItemWindow(*args, **kwargs)
11588 return val
11589
11590 def SizerItemSpacer(*args, **kwargs):
11591 """
11592 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11593 PyObject userData=None) -> SizerItem
11594
11595 Constructs a `wx.SizerItem` for tracking a spacer.
11596 """
11597 val = _core_.new_SizerItemSpacer(*args, **kwargs)
11598 return val
11599
11600 def SizerItemSizer(*args, **kwargs):
11601 """
11602 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11603 PyObject userData=None) -> SizerItem
11604
11605 Constructs a `wx.SizerItem` for tracking a subsizer
11606 """
11607 val = _core_.new_SizerItemSizer(*args, **kwargs)
11608 return val
11609
11610 class Sizer(Object):
11611 """
11612 wx.Sizer is the abstract base class used for laying out subwindows in
11613 a window. You cannot use wx.Sizer directly; instead, you will have to
11614 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11615 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11616 `wx.GridBagSizer`.
11617
11618 The concept implemented by sizers in wxWidgets is closely related to
11619 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11620 toolkit or the Qt toolkit. It is based upon the idea of the individual
11621 subwindows reporting their minimal required size and their ability to
11622 get stretched if the size of the parent window has changed. This will
11623 most often mean that the programmer does not set the original size of
11624 a dialog in the beginning, rather the dialog will assigned a sizer and
11625 this sizer will be queried about the recommended size. The sizer in
11626 turn will query its children, which can be normal windows or contorls,
11627 empty space or other sizers, so that a hierarchy of sizers can be
11628 constructed. Note that wxSizer does not derive from wxWindow and thus
11629 do not interfere with tab ordering and requires very little resources
11630 compared to a real window on screen.
11631
11632 What makes sizers so well fitted for use in wxWidgets is the fact that
11633 every control reports its own minimal size and the algorithm can
11634 handle differences in font sizes or different window (dialog item)
11635 sizes on different platforms without problems. If for example the
11636 standard font as well as the overall design of Mac widgets requires
11637 more space than on Windows, then the initial size of a dialog using a
11638 sizer will automatically be bigger on Mac than on Windows.
11639 """
11640 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11641 def __init__(self): raise AttributeError, "No constructor defined"
11642 __repr__ = _swig_repr
11643 __swig_destroy__ = _core_.delete_Sizer
11644 __del__ = lambda self : None;
11645 def _setOORInfo(*args, **kwargs):
11646 """_setOORInfo(self, PyObject _self)"""
11647 return _core_.Sizer__setOORInfo(*args, **kwargs)
11648
11649 def Add(*args, **kwargs):
11650 """
11651 Add(self, item, int proportion=0, int flag=0, int border=0,
11652 PyObject userData=None) -> wx.SizerItem
11653
11654 Appends a child item to the sizer.
11655 """
11656 return _core_.Sizer_Add(*args, **kwargs)
11657
11658 def Insert(*args, **kwargs):
11659 """
11660 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11661 PyObject userData=None) -> wx.SizerItem
11662
11663 Inserts a new item into the list of items managed by this sizer before
11664 the item at index *before*. See `Add` for a description of the parameters.
11665 """
11666 return _core_.Sizer_Insert(*args, **kwargs)
11667
11668 def Prepend(*args, **kwargs):
11669 """
11670 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11671 PyObject userData=None) -> wx.SizerItem
11672
11673 Adds a new item to the begining of the list of sizer items managed by
11674 this sizer. See `Add` for a description of the parameters.
11675 """
11676 return _core_.Sizer_Prepend(*args, **kwargs)
11677
11678 def Remove(*args, **kwargs):
11679 """
11680 Remove(self, item) -> bool
11681
11682 Removes an item from the sizer and destroys it. This method does not
11683 cause any layout or resizing to take place, call `Layout` to update
11684 the layout on screen after removing a child from the sizer. The
11685 *item* parameter can be either a window, a sizer, or the zero-based
11686 index of an item to remove. Returns True if the child item was found
11687 and removed.
11688 """
11689 return _core_.Sizer_Remove(*args, **kwargs)
11690
11691 def Detach(*args, **kwargs):
11692 """
11693 Detach(self, item) -> bool
11694
11695 Detaches an item from the sizer without destroying it. This method
11696 does not cause any layout or resizing to take place, call `Layout` to
11697 do so. The *item* parameter can be either a window, a sizer, or the
11698 zero-based index of the item to be detached. Returns True if the child item
11699 was found and detached.
11700 """
11701 return _core_.Sizer_Detach(*args, **kwargs)
11702
11703 def GetItem(*args, **kwargs):
11704 """
11705 GetItem(self, item) -> wx.SizerItem
11706
11707 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11708 parameter can be either a window, a sizer, or the zero-based index of
11709 the item to be found.
11710 """
11711 return _core_.Sizer_GetItem(*args, **kwargs)
11712
11713 def _SetItemMinSize(*args, **kwargs):
11714 """_SetItemMinSize(self, PyObject item, Size size)"""
11715 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11716
11717 def _ReplaceWin(*args, **kwargs):
11718 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11719 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11720
11721 def _ReplaceSizer(*args, **kwargs):
11722 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11723 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
11724
11725 def _ReplaceItem(*args, **kwargs):
11726 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
11727 return _core_.Sizer__ReplaceItem(*args, **kwargs)
11728
11729 def Replace(self, olditem, item, recursive=False):
11730 """
11731 Detaches the given ``olditem`` from the sizer and replaces it with
11732 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
11733 detached child is destroyed only if it is not a window, (because
11734 windows are owned by their parent, not the sizer.) The
11735 ``recursive`` parameter can be used to search for the given
11736 element recursivly in subsizers.
11737
11738 This method does not cause any layout or resizing to take place,
11739 call `Layout` to do so.
11740
11741 Returns ``True`` if the child item was found and removed.
11742 """
11743 if isinstance(olditem, wx.Window):
11744 return self._ReplaceWin(olditem, item, recursive)
11745 elif isinstnace(olditem, wx.Sizer):
11746 return self._ReplaceSizer(olditem, item, recursive)
11747 elif isinstnace(olditem, int):
11748 return self._ReplaceItem(olditem, item)
11749 else:
11750 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
11751
11752 def SetContainingWindow(*args, **kwargs):
11753 """
11754 SetContainingWindow(self, Window window)
11755
11756 Set (or unset) the window this sizer is used in.
11757 """
11758 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
11759
11760 def GetContainingWindow(*args, **kwargs):
11761 """
11762 GetContainingWindow(self) -> Window
11763
11764 Get the window this sizer is used in.
11765 """
11766 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
11767
11768 def SetItemMinSize(self, item, *args):
11769 """
11770 SetItemMinSize(self, item, Size size)
11771
11772 Sets the minimum size that will be allocated for an item in the sizer.
11773 The *item* parameter can be either a window, a sizer, or the
11774 zero-based index of the item. If a window or sizer is given then it
11775 will be searched for recursivly in subsizers if neccessary.
11776 """
11777 if len(args) == 2:
11778 # for backward compatibility accept separate width,height args too
11779 return self._SetItemMinSize(item, args)
11780 else:
11781 return self._SetItemMinSize(item, args[0])
11782
11783 def AddItem(*args, **kwargs):
11784 """
11785 AddItem(self, SizerItem item)
11786
11787 Adds a `wx.SizerItem` to the sizer.
11788 """
11789 return _core_.Sizer_AddItem(*args, **kwargs)
11790
11791 def InsertItem(*args, **kwargs):
11792 """
11793 InsertItem(self, int index, SizerItem item)
11794
11795 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11796 """
11797 return _core_.Sizer_InsertItem(*args, **kwargs)
11798
11799 def PrependItem(*args, **kwargs):
11800 """
11801 PrependItem(self, SizerItem item)
11802
11803 Prepends a `wx.SizerItem` to the sizer.
11804 """
11805 return _core_.Sizer_PrependItem(*args, **kwargs)
11806
11807 def AddMany(self, items):
11808 """
11809 AddMany is a convenience method for adding several items
11810 to a sizer at one time. Simply pass it a list of tuples,
11811 where each tuple consists of the parameters that you
11812 would normally pass to the `Add` method.
11813 """
11814 for item in items:
11815 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11816 item = (item, )
11817 self.Add(*item)
11818
11819 def AddSpacer(self, *args, **kw):
11820 """AddSpacer(int size) --> SizerItem
11821
11822 Add a spacer that is (size,size) pixels.
11823 """
11824 if args and type(args[0]) == int:
11825 return self.Add( (args[0],args[0] ), 0)
11826 else: # otherwise stay compatible with old AddSpacer
11827 return self.Add(*args, **kw)
11828 def PrependSpacer(self, *args, **kw):
11829 """PrependSpacer(int size) --> SizerItem
11830
11831 Prepend a spacer that is (size, size) pixels."""
11832 if args and type(args[0]) == int:
11833 return self.Prepend( (args[0],args[0] ), 0)
11834 else: # otherwise stay compatible with old PrependSpacer
11835 return self.Prepend(*args, **kw)
11836 def InsertSpacer(self, index, *args, **kw):
11837 """InsertSpacer(int index, int size) --> SizerItem
11838
11839 Insert a spacer at position index that is (size, size) pixels."""
11840 if args and type(args[0]) == int:
11841 return self.Insert( index, (args[0],args[0] ), 0)
11842 else: # otherwise stay compatible with old InsertSpacer
11843 return self.Insert(index, *args, **kw)
11844
11845
11846 def AddStretchSpacer(self, prop=1):
11847 """AddStretchSpacer(int prop=1) --> SizerItem
11848
11849 Add a stretchable spacer."""
11850 return self.Add((0,0), prop)
11851 def PrependStretchSpacer(self, prop=1):
11852 """PrependStretchSpacer(int prop=1) --> SizerItem
11853
11854 Prepend a stretchable spacer."""
11855 return self.Prepend((0,0), prop)
11856 def InsertStretchSpacer(self, index, prop=1):
11857 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
11858
11859 Insert a stretchable spacer."""
11860 return self.Insert(index, (0,0), prop)
11861
11862
11863 # for backwards compatibility only, please do not use in new code
11864 def AddWindow(self, *args, **kw):
11865 """Compatibility alias for `Add`."""
11866 return self.Add(*args, **kw)
11867 def AddSizer(self, *args, **kw):
11868 """Compatibility alias for `Add`."""
11869 return self.Add(*args, **kw)
11870
11871 def PrependWindow(self, *args, **kw):
11872 """Compatibility alias for `Prepend`."""
11873 return self.Prepend(*args, **kw)
11874 def PrependSizer(self, *args, **kw):
11875 """Compatibility alias for `Prepend`."""
11876 return self.Prepend(*args, **kw)
11877
11878 def InsertWindow(self, *args, **kw):
11879 """Compatibility alias for `Insert`."""
11880 return self.Insert(*args, **kw)
11881 def InsertSizer(self, *args, **kw):
11882 """Compatibility alias for `Insert`."""
11883 return self.Insert(*args, **kw)
11884
11885 def RemoveWindow(self, *args, **kw):
11886 """Compatibility alias for `Remove`."""
11887 return self.Remove(*args, **kw)
11888 def RemoveSizer(self, *args, **kw):
11889 """Compatibility alias for `Remove`."""
11890 return self.Remove(*args, **kw)
11891 def RemovePos(self, *args, **kw):
11892 """Compatibility alias for `Remove`."""
11893 return self.Remove(*args, **kw)
11894
11895
11896 def SetDimension(*args, **kwargs):
11897 """
11898 SetDimension(self, int x, int y, int width, int height)
11899
11900 Call this to force the sizer to take the given dimension and thus
11901 force the items owned by the sizer to resize themselves according to
11902 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11903 methods.
11904 """
11905 return _core_.Sizer_SetDimension(*args, **kwargs)
11906
11907 def SetMinSize(*args, **kwargs):
11908 """
11909 SetMinSize(self, Size size)
11910
11911 Call this to give the sizer a minimal size. Normally, the sizer will
11912 calculate its minimal size based purely on how much space its children
11913 need. After calling this method `GetMinSize` will return either the
11914 minimal size as requested by its children or the minimal size set
11915 here, depending on which is bigger.
11916 """
11917 return _core_.Sizer_SetMinSize(*args, **kwargs)
11918
11919 def GetSize(*args, **kwargs):
11920 """
11921 GetSize(self) -> Size
11922
11923 Returns the current size of the space managed by the sizer.
11924 """
11925 return _core_.Sizer_GetSize(*args, **kwargs)
11926
11927 def GetPosition(*args, **kwargs):
11928 """
11929 GetPosition(self) -> Point
11930
11931 Returns the current position of the sizer's managed space.
11932 """
11933 return _core_.Sizer_GetPosition(*args, **kwargs)
11934
11935 def GetMinSize(*args, **kwargs):
11936 """
11937 GetMinSize(self) -> Size
11938
11939 Returns the minimal size of the sizer. This is either the combined
11940 minimal size of all the children and their borders or the minimal size
11941 set by SetMinSize, depending on which is bigger.
11942 """
11943 return _core_.Sizer_GetMinSize(*args, **kwargs)
11944
11945 def GetSizeTuple(self):
11946 return self.GetSize().Get()
11947 def GetPositionTuple(self):
11948 return self.GetPosition().Get()
11949 def GetMinSizeTuple(self):
11950 return self.GetMinSize().Get()
11951
11952 def RecalcSizes(*args, **kwargs):
11953 """
11954 RecalcSizes(self)
11955
11956 Using the sizes calculated by `CalcMin` reposition and resize all the
11957 items managed by this sizer. You should not need to call this directly as
11958 it is called by `Layout`.
11959 """
11960 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11961
11962 def CalcMin(*args, **kwargs):
11963 """
11964 CalcMin(self) -> Size
11965
11966 This method is where the sizer will do the actual calculation of its
11967 children's minimal sizes. You should not need to call this directly as
11968 it is called by `Layout`.
11969 """
11970 return _core_.Sizer_CalcMin(*args, **kwargs)
11971
11972 def Layout(*args, **kwargs):
11973 """
11974 Layout(self)
11975
11976 This method will force the recalculation and layout of the items
11977 controlled by the sizer using the current space allocated to the
11978 sizer. Normally this is called automatically from the owning window's
11979 EVT_SIZE handler, but it is also useful to call it from user code when
11980 one of the items in a sizer change size, or items are added or
11981 removed.
11982 """
11983 return _core_.Sizer_Layout(*args, **kwargs)
11984
11985 def Fit(*args, **kwargs):
11986 """
11987 Fit(self, Window window) -> Size
11988
11989 Tell the sizer to resize the *window* to match the sizer's minimal
11990 size. This is commonly done in the constructor of the window itself in
11991 order to set its initial size to match the needs of the children as
11992 determined by the sizer. Returns the new size.
11993
11994 For a top level window this is the total window size, not the client size.
11995 """
11996 return _core_.Sizer_Fit(*args, **kwargs)
11997
11998 def FitInside(*args, **kwargs):
11999 """
12000 FitInside(self, Window window)
12001
12002 Tell the sizer to resize the *virtual size* of the *window* to match the
12003 sizer's minimal size. This will not alter the on screen size of the
12004 window, but may cause the addition/removal/alteration of scrollbars
12005 required to view the virtual area in windows which manage it.
12006
12007 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12008
12009 """
12010 return _core_.Sizer_FitInside(*args, **kwargs)
12011
12012 def SetSizeHints(*args, **kwargs):
12013 """
12014 SetSizeHints(self, Window window)
12015
12016 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12017 match the sizer's minimal size. This is commonly done in the
12018 constructor of the window itself if the window is resizable (as are
12019 many dialogs under Unix and frames on probably all platforms) in order
12020 to prevent the window from being sized smaller than the minimal size
12021 required by the sizer.
12022 """
12023 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12024
12025 def SetVirtualSizeHints(*args, **kwargs):
12026 """
12027 SetVirtualSizeHints(self, Window window)
12028
12029 Tell the sizer to set the minimal size of the window virtual area to
12030 match the sizer's minimal size. For windows with managed scrollbars
12031 this will set them appropriately.
12032
12033 :see: `wx.ScrolledWindow.SetScrollbars`
12034
12035 """
12036 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12037
12038 def Clear(*args, **kwargs):
12039 """
12040 Clear(self, bool deleteWindows=False)
12041
12042 Clear all items from the sizer, optionally destroying the window items
12043 as well.
12044 """
12045 return _core_.Sizer_Clear(*args, **kwargs)
12046
12047 def DeleteWindows(*args, **kwargs):
12048 """
12049 DeleteWindows(self)
12050
12051 Destroy all windows managed by the sizer.
12052 """
12053 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12054
12055 def GetChildren(*args, **kwargs):
12056 """
12057 GetChildren(self) -> list
12058
12059 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12060 """
12061 return _core_.Sizer_GetChildren(*args, **kwargs)
12062
12063 def Show(*args, **kwargs):
12064 """
12065 Show(self, item, bool show=True, bool recursive=false) -> bool
12066
12067 Shows or hides an item managed by the sizer. To make a sizer item
12068 disappear or reappear, use Show followed by `Layout`. The *item*
12069 parameter can be either a window, a sizer, or the zero-based index of
12070 the item. Use the recursive parameter to show or hide an item in a
12071 subsizer. Returns True if the item was found.
12072 """
12073 return _core_.Sizer_Show(*args, **kwargs)
12074
12075 def IsShown(*args, **kwargs):
12076 """
12077 IsShown(self, item)
12078
12079 Determines if the item is currently shown. To make a sizer
12080 item disappear or reappear, use Show followed by `Layout`. The *item*
12081 parameter can be either a window, a sizer, or the zero-based index of
12082 the item.
12083 """
12084 return _core_.Sizer_IsShown(*args, **kwargs)
12085
12086 def Hide(self, item, recursive=False):
12087 """
12088 A convenience method for `Show` (item, False, recursive).
12089 """
12090 return self.Show(item, False, recursive)
12091
12092 def ShowItems(*args, **kwargs):
12093 """
12094 ShowItems(self, bool show)
12095
12096 Recursively call `wx.SizerItem.Show` on all sizer items.
12097 """
12098 return _core_.Sizer_ShowItems(*args, **kwargs)
12099
12100 Children = property(GetChildren,doc="See `GetChildren`")
12101 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12102 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12103 Position = property(GetPosition,doc="See `GetPosition`")
12104 Size = property(GetSize,doc="See `GetSize`")
12105 _core_.Sizer_swigregister(Sizer)
12106
12107 class PySizer(Sizer):
12108 """
12109 wx.PySizer is a special version of `wx.Sizer` that has been
12110 instrumented to allow the C++ virtual methods to be overloaded in
12111 Python derived classes. You would derive from this class if you are
12112 wanting to implement a custom sizer in Python code. Simply implement
12113 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12114 For example::
12115
12116 class MySizer(wx.PySizer):
12117 def __init__(self):
12118 wx.PySizer.__init__(self)
12119
12120 def CalcMin(self):
12121 for item in self.GetChildren():
12122 # calculate the total minimum width and height needed
12123 # by all items in the sizer according to this sizer's
12124 # layout algorithm.
12125 ...
12126 return wx.Size(width, height)
12127
12128 def RecalcSizes(self):
12129 # find the space allotted to this sizer
12130 pos = self.GetPosition()
12131 size = self.GetSize()
12132 for item in self.GetChildren():
12133 # Recalculate (if necessary) the position and size of
12134 # each item and then call item.SetDimension to do the
12135 # actual positioning and sizing of the items within the
12136 # space alloted to this sizer.
12137 ...
12138 item.SetDimension(itemPos, itemSize)
12139
12140
12141 When `Layout` is called it first calls `CalcMin` followed by
12142 `RecalcSizes` so you can optimize a bit by saving the results of
12143 `CalcMin` and reusing them in `RecalcSizes`.
12144
12145 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12146
12147
12148 """
12149 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12150 __repr__ = _swig_repr
12151 def __init__(self, *args, **kwargs):
12152 """
12153 __init__(self) -> PySizer
12154
12155 Creates a wx.PySizer. Must be called from the __init__ in the derived
12156 class.
12157 """
12158 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12159 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12160
12161 def _setCallbackInfo(*args, **kwargs):
12162 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12163 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12164
12165 _core_.PySizer_swigregister(PySizer)
12166
12167 #---------------------------------------------------------------------------
12168
12169 class BoxSizer(Sizer):
12170 """
12171 The basic idea behind a box sizer is that windows will most often be
12172 laid out in rather simple basic geometry, typically in a row or a
12173 column or nested hierarchies of either. A wx.BoxSizer will lay out
12174 its items in a simple row or column, depending on the orientation
12175 parameter passed to the constructor.
12176 """
12177 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12178 __repr__ = _swig_repr
12179 def __init__(self, *args, **kwargs):
12180 """
12181 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12182
12183 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12184 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12185 sizer.
12186 """
12187 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12188 self._setOORInfo(self)
12189
12190 def GetOrientation(*args, **kwargs):
12191 """
12192 GetOrientation(self) -> int
12193
12194 Returns the current orientation of the sizer.
12195 """
12196 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12197
12198 def SetOrientation(*args, **kwargs):
12199 """
12200 SetOrientation(self, int orient)
12201
12202 Resets the orientation of the sizer.
12203 """
12204 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12205
12206 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12207 _core_.BoxSizer_swigregister(BoxSizer)
12208
12209 #---------------------------------------------------------------------------
12210
12211 class StaticBoxSizer(BoxSizer):
12212 """
12213 wx.StaticBoxSizer derives from and functions identically to the
12214 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12215 manages. Note that this static box must be created separately and
12216 passed to the sizer constructor.
12217 """
12218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12219 __repr__ = _swig_repr
12220 def __init__(self, *args, **kwargs):
12221 """
12222 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12223
12224 Constructor. It takes an associated static box and the orientation
12225 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12226 ``wx.HORIZONTAL``.
12227 """
12228 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12229 self._setOORInfo(self)
12230
12231 def GetStaticBox(*args, **kwargs):
12232 """
12233 GetStaticBox(self) -> StaticBox
12234
12235 Returns the static box associated with this sizer.
12236 """
12237 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12238
12239 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12240 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
12241
12242 #---------------------------------------------------------------------------
12243
12244 class GridSizer(Sizer):
12245 """
12246 A grid sizer is a sizer which lays out its children in a
12247 two-dimensional table with all cells having the same size. In other
12248 words, the width of each cell within the grid is the width of the
12249 widest item added to the sizer and the height of each grid cell is the
12250 height of the tallest item. An optional vertical and/or horizontal
12251 gap between items can also be specified (in pixels.)
12252
12253 Items are placed in the cells of the grid in the order they are added,
12254 in row-major order. In other words, the first row is filled first,
12255 then the second, and so on until all items have been added. (If
12256 neccessary, additional rows will be added as items are added.) If you
12257 need to have greater control over the cells that items are placed in
12258 then use the `wx.GridBagSizer`.
12259
12260 """
12261 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12262 __repr__ = _swig_repr
12263 def __init__(self, *args, **kwargs):
12264 """
12265 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12266
12267 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12268 of columns and rows in the sizer - if either of the parameters is
12269 zero, it will be calculated to from the total number of children in
12270 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12271 define extra space between all children.
12272 """
12273 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
12274 self._setOORInfo(self)
12275
12276 def SetCols(*args, **kwargs):
12277 """
12278 SetCols(self, int cols)
12279
12280 Sets the number of columns in the sizer.
12281 """
12282 return _core_.GridSizer_SetCols(*args, **kwargs)
12283
12284 def SetRows(*args, **kwargs):
12285 """
12286 SetRows(self, int rows)
12287
12288 Sets the number of rows in the sizer.
12289 """
12290 return _core_.GridSizer_SetRows(*args, **kwargs)
12291
12292 def SetVGap(*args, **kwargs):
12293 """
12294 SetVGap(self, int gap)
12295
12296 Sets the vertical gap (in pixels) between the cells in the sizer.
12297 """
12298 return _core_.GridSizer_SetVGap(*args, **kwargs)
12299
12300 def SetHGap(*args, **kwargs):
12301 """
12302 SetHGap(self, int gap)
12303
12304 Sets the horizontal gap (in pixels) between cells in the sizer
12305 """
12306 return _core_.GridSizer_SetHGap(*args, **kwargs)
12307
12308 def GetCols(*args, **kwargs):
12309 """
12310 GetCols(self) -> int
12311
12312 Returns the number of columns in the sizer.
12313 """
12314 return _core_.GridSizer_GetCols(*args, **kwargs)
12315
12316 def GetRows(*args, **kwargs):
12317 """
12318 GetRows(self) -> int
12319
12320 Returns the number of rows in the sizer.
12321 """
12322 return _core_.GridSizer_GetRows(*args, **kwargs)
12323
12324 def GetVGap(*args, **kwargs):
12325 """
12326 GetVGap(self) -> int
12327
12328 Returns the vertical gap (in pixels) between the cells in the sizer.
12329 """
12330 return _core_.GridSizer_GetVGap(*args, **kwargs)
12331
12332 def GetHGap(*args, **kwargs):
12333 """
12334 GetHGap(self) -> int
12335
12336 Returns the horizontal gap (in pixels) between cells in the sizer.
12337 """
12338 return _core_.GridSizer_GetHGap(*args, **kwargs)
12339
12340 def CalcRowsCols(self):
12341 """
12342 CalcRowsCols() -> (rows, cols)
12343
12344 Calculates how many rows and columns will be in the sizer based
12345 on the current number of items and also the rows, cols specified
12346 in the constructor.
12347 """
12348 nitems = len(self.GetChildren())
12349 rows = self.GetRows()
12350 cols = self.GetCols()
12351 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12352 if cols != 0:
12353 rows = (nitems + cols - 1) / cols
12354 elif rows != 0:
12355 cols = (nitems + rows - 1) / rows
12356 return (rows, cols)
12357
12358 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12359 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12360 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12361 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
12362 _core_.GridSizer_swigregister(GridSizer)
12363
12364 #---------------------------------------------------------------------------
12365
12366 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12367 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12368 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12369 class FlexGridSizer(GridSizer):
12370 """
12371 A flex grid sizer is a sizer which lays out its children in a
12372 two-dimensional table with all table cells in one row having the same
12373 height and all cells in one column having the same width, but all
12374 rows or all columns are not necessarily the same height or width as in
12375 the `wx.GridSizer`.
12376
12377 wx.FlexGridSizer can also size items equally in one direction but
12378 unequally ("flexibly") in the other. If the sizer is only flexible
12379 in one direction (this can be changed using `SetFlexibleDirection`), it
12380 needs to be decided how the sizer should grow in the other ("non
12381 flexible") direction in order to fill the available space. The
12382 `SetNonFlexibleGrowMode` method serves this purpose.
12383
12384
12385 """
12386 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12387 __repr__ = _swig_repr
12388 def __init__(self, *args, **kwargs):
12389 """
12390 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12391
12392 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12393 number of columns and rows in the sizer - if either of the parameters
12394 is zero, it will be calculated to from the total number of children in
12395 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12396 define extra space between all children.
12397 """
12398 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
12399 self._setOORInfo(self)
12400
12401 def AddGrowableRow(*args, **kwargs):
12402 """
12403 AddGrowableRow(self, size_t idx, int proportion=0)
12404
12405 Specifies that row *idx* (starting from zero) should be grown if there
12406 is extra space available to the sizer.
12407
12408 The *proportion* parameter has the same meaning as the stretch factor
12409 for the box sizers except that if all proportions are 0, then all
12410 columns are resized equally (instead of not being resized at all).
12411 """
12412 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12413
12414 def RemoveGrowableRow(*args, **kwargs):
12415 """
12416 RemoveGrowableRow(self, size_t idx)
12417
12418 Specifies that row *idx* is no longer growable.
12419 """
12420 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12421
12422 def AddGrowableCol(*args, **kwargs):
12423 """
12424 AddGrowableCol(self, size_t idx, int proportion=0)
12425
12426 Specifies that column *idx* (starting from zero) should be grown if
12427 there is extra space available to the sizer.
12428
12429 The *proportion* parameter has the same meaning as the stretch factor
12430 for the box sizers except that if all proportions are 0, then all
12431 columns are resized equally (instead of not being resized at all).
12432 """
12433 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12434
12435 def RemoveGrowableCol(*args, **kwargs):
12436 """
12437 RemoveGrowableCol(self, size_t idx)
12438
12439 Specifies that column *idx* is no longer growable.
12440 """
12441 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12442
12443 def SetFlexibleDirection(*args, **kwargs):
12444 """
12445 SetFlexibleDirection(self, int direction)
12446
12447 Specifies whether the sizer should flexibly resize its columns, rows,
12448 or both. Argument *direction* can be one of the following values. Any
12449 other value is ignored.
12450
12451 ============== =======================================
12452 wx.VERTICAL Rows are flexibly sized.
12453 wx.HORIZONTAL Columns are flexibly sized.
12454 wx.BOTH Both rows and columns are flexibly sized
12455 (this is the default value).
12456 ============== =======================================
12457
12458 Note that this method does not trigger relayout.
12459
12460 """
12461 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12462
12463 def GetFlexibleDirection(*args, **kwargs):
12464 """
12465 GetFlexibleDirection(self) -> int
12466
12467 Returns a value that specifies whether the sizer
12468 flexibly resizes its columns, rows, or both (default).
12469
12470 :see: `SetFlexibleDirection`
12471 """
12472 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12473
12474 def SetNonFlexibleGrowMode(*args, **kwargs):
12475 """
12476 SetNonFlexibleGrowMode(self, int mode)
12477
12478 Specifies how the sizer should grow in the non-flexible direction if
12479 there is one (so `SetFlexibleDirection` must have been called
12480 previously). Argument *mode* can be one of the following values:
12481
12482 ========================== =================================================
12483 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12484 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12485 `AddGrowableCol` and `AddGrowableRow`. In this
12486 case equal sizing applies to minimum sizes of
12487 columns or rows (this is the default value).
12488 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12489 the non flexible direction, whether they are
12490 growable or not in the flexbile direction.
12491 ========================== =================================================
12492
12493 Note that this method does not trigger relayout.
12494 """
12495 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12496
12497 def GetNonFlexibleGrowMode(*args, **kwargs):
12498 """
12499 GetNonFlexibleGrowMode(self) -> int
12500
12501 Returns the value that specifies how the sizer grows in the
12502 non-flexible direction if there is one.
12503
12504 :see: `SetNonFlexibleGrowMode`
12505 """
12506 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12507
12508 def GetRowHeights(*args, **kwargs):
12509 """
12510 GetRowHeights(self) -> list
12511
12512 Returns a list of integers representing the heights of each of the
12513 rows in the sizer.
12514 """
12515 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12516
12517 def GetColWidths(*args, **kwargs):
12518 """
12519 GetColWidths(self) -> list
12520
12521 Returns a list of integers representing the widths of each of the
12522 columns in the sizer.
12523 """
12524 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12525
12526 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12527 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12528 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12529 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
12530 _core_.FlexGridSizer_swigregister(FlexGridSizer)
12531
12532 class StdDialogButtonSizer(BoxSizer):
12533 """
12534 A special sizer that knows how to order and position standard buttons
12535 in order to conform to the current platform's standards. You simply
12536 need to add each `wx.Button` to the sizer, and be sure to create the
12537 buttons using the standard ID's. Then call `Realize` and the sizer
12538 will take care of the rest.
12539
12540 """
12541 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12542 __repr__ = _swig_repr
12543 def __init__(self, *args, **kwargs):
12544 """__init__(self) -> StdDialogButtonSizer"""
12545 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
12546 def AddButton(*args, **kwargs):
12547 """
12548 AddButton(self, wxButton button)
12549
12550 Use this to add the buttons to this sizer. Do not use the `Add`
12551 method in the base class.
12552 """
12553 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12554
12555 def Realize(*args, **kwargs):
12556 """
12557 Realize(self)
12558
12559 This funciton needs to be called after all the buttons have been added
12560 to the sizer. It will reorder them and position them in a platform
12561 specifc manner.
12562 """
12563 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
12564
12565 def SetAffirmativeButton(*args, **kwargs):
12566 """SetAffirmativeButton(self, wxButton button)"""
12567 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12568
12569 def SetNegativeButton(*args, **kwargs):
12570 """SetNegativeButton(self, wxButton button)"""
12571 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12572
12573 def SetCancelButton(*args, **kwargs):
12574 """SetCancelButton(self, wxButton button)"""
12575 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
12576
12577 def GetAffirmativeButton(*args, **kwargs):
12578 """GetAffirmativeButton(self) -> wxButton"""
12579 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12580
12581 def GetApplyButton(*args, **kwargs):
12582 """GetApplyButton(self) -> wxButton"""
12583 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12584
12585 def GetNegativeButton(*args, **kwargs):
12586 """GetNegativeButton(self) -> wxButton"""
12587 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12588
12589 def GetCancelButton(*args, **kwargs):
12590 """GetCancelButton(self) -> wxButton"""
12591 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12592
12593 def GetHelpButton(*args, **kwargs):
12594 """GetHelpButton(self) -> wxButton"""
12595 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12596
12597 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12598 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12599 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12600 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12601 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
12602 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
12603
12604 #---------------------------------------------------------------------------
12605
12606 class GBPosition(object):
12607 """
12608 This class represents the position of an item in a virtual grid of
12609 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12610 typemaps that will automatically convert from a 2-element sequence of
12611 integers to a wx.GBPosition, so you can use the more pythonic
12612 representation of the position nearly transparently in Python code.
12613 """
12614 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12615 __repr__ = _swig_repr
12616 def __init__(self, *args, **kwargs):
12617 """
12618 __init__(self, int row=0, int col=0) -> GBPosition
12619
12620 This class represents the position of an item in a virtual grid of
12621 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12622 typemaps that will automatically convert from a 2-element sequence of
12623 integers to a wx.GBPosition, so you can use the more pythonic
12624 representation of the position nearly transparently in Python code.
12625 """
12626 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12627 __swig_destroy__ = _core_.delete_GBPosition
12628 __del__ = lambda self : None;
12629 def GetRow(*args, **kwargs):
12630 """GetRow(self) -> int"""
12631 return _core_.GBPosition_GetRow(*args, **kwargs)
12632
12633 def GetCol(*args, **kwargs):
12634 """GetCol(self) -> int"""
12635 return _core_.GBPosition_GetCol(*args, **kwargs)
12636
12637 def SetRow(*args, **kwargs):
12638 """SetRow(self, int row)"""
12639 return _core_.GBPosition_SetRow(*args, **kwargs)
12640
12641 def SetCol(*args, **kwargs):
12642 """SetCol(self, int col)"""
12643 return _core_.GBPosition_SetCol(*args, **kwargs)
12644
12645 def __eq__(*args, **kwargs):
12646 """
12647 __eq__(self, PyObject other) -> bool
12648
12649 Compare GBPosition for equality.
12650 """
12651 return _core_.GBPosition___eq__(*args, **kwargs)
12652
12653 def __ne__(*args, **kwargs):
12654 """
12655 __ne__(self, PyObject other) -> bool
12656
12657 Compare GBPosition for inequality.
12658 """
12659 return _core_.GBPosition___ne__(*args, **kwargs)
12660
12661 def Set(*args, **kwargs):
12662 """Set(self, int row=0, int col=0)"""
12663 return _core_.GBPosition_Set(*args, **kwargs)
12664
12665 def Get(*args, **kwargs):
12666 """Get(self) -> PyObject"""
12667 return _core_.GBPosition_Get(*args, **kwargs)
12668
12669 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12670 def __str__(self): return str(self.Get())
12671 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12672 def __len__(self): return len(self.Get())
12673 def __getitem__(self, index): return self.Get()[index]
12674 def __setitem__(self, index, val):
12675 if index == 0: self.SetRow(val)
12676 elif index == 1: self.SetCol(val)
12677 else: raise IndexError
12678 def __nonzero__(self): return self.Get() != (0,0)
12679 __safe_for_unpickling__ = True
12680 def __reduce__(self): return (wx.GBPosition, self.Get())
12681
12682 row = property(GetRow, SetRow)
12683 col = property(GetCol, SetCol)
12684
12685 _core_.GBPosition_swigregister(GBPosition)
12686
12687 class GBSpan(object):
12688 """
12689 This class is used to hold the row and column spanning attributes of
12690 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12691 automatically convert from a 2-element sequence of integers to a
12692 wx.GBSpan, so you can use the more pythonic representation of the span
12693 nearly transparently in Python code.
12694
12695 """
12696 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12697 __repr__ = _swig_repr
12698 def __init__(self, *args, **kwargs):
12699 """
12700 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12701
12702 Construct a new wxGBSpan, optionally setting the rowspan and
12703 colspan. The default is (1,1). (Meaning that the item occupies one
12704 cell in each direction.
12705 """
12706 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12707 __swig_destroy__ = _core_.delete_GBSpan
12708 __del__ = lambda self : None;
12709 def GetRowspan(*args, **kwargs):
12710 """GetRowspan(self) -> int"""
12711 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12712
12713 def GetColspan(*args, **kwargs):
12714 """GetColspan(self) -> int"""
12715 return _core_.GBSpan_GetColspan(*args, **kwargs)
12716
12717 def SetRowspan(*args, **kwargs):
12718 """SetRowspan(self, int rowspan)"""
12719 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12720
12721 def SetColspan(*args, **kwargs):
12722 """SetColspan(self, int colspan)"""
12723 return _core_.GBSpan_SetColspan(*args, **kwargs)
12724
12725 def __eq__(*args, **kwargs):
12726 """
12727 __eq__(self, PyObject other) -> bool
12728
12729 Compare wxGBSpan for equality.
12730 """
12731 return _core_.GBSpan___eq__(*args, **kwargs)
12732
12733 def __ne__(*args, **kwargs):
12734 """
12735 __ne__(self, PyObject other) -> bool
12736
12737 Compare GBSpan for inequality.
12738 """
12739 return _core_.GBSpan___ne__(*args, **kwargs)
12740
12741 def Set(*args, **kwargs):
12742 """Set(self, int rowspan=1, int colspan=1)"""
12743 return _core_.GBSpan_Set(*args, **kwargs)
12744
12745 def Get(*args, **kwargs):
12746 """Get(self) -> PyObject"""
12747 return _core_.GBSpan_Get(*args, **kwargs)
12748
12749 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12750 def __str__(self): return str(self.Get())
12751 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12752 def __len__(self): return len(self.Get())
12753 def __getitem__(self, index): return self.Get()[index]
12754 def __setitem__(self, index, val):
12755 if index == 0: self.SetRowspan(val)
12756 elif index == 1: self.SetColspan(val)
12757 else: raise IndexError
12758 def __nonzero__(self): return self.Get() != (0,0)
12759 __safe_for_unpickling__ = True
12760 def __reduce__(self): return (wx.GBSpan, self.Get())
12761
12762 rowspan = property(GetRowspan, SetRowspan)
12763 colspan = property(GetColspan, SetColspan)
12764
12765 _core_.GBSpan_swigregister(GBSpan)
12766
12767 class GBSizerItem(SizerItem):
12768 """
12769 The wx.GBSizerItem class is used to track the additional data about
12770 items in a `wx.GridBagSizer` such as the item's position in the grid
12771 and how many rows or columns it spans.
12772
12773 """
12774 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12775 __repr__ = _swig_repr
12776 def __init__(self, *args, **kwargs):
12777 """
12778 __init__(self) -> GBSizerItem
12779
12780 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12781 size will need to be set, as well as a position and span before this
12782 item can be used in a Sizer.
12783
12784 You will probably never need to create a wx.GBSizerItem directly as they
12785 are created automatically when the sizer's Add method is called.
12786 """
12787 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
12788 __swig_destroy__ = _core_.delete_GBSizerItem
12789 __del__ = lambda self : None;
12790 def GetPos(*args, **kwargs):
12791 """
12792 GetPos(self) -> GBPosition
12793
12794 Get the grid position of the item
12795 """
12796 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12797
12798 def GetPosTuple(self): return self.GetPos().Get()
12799 def GetSpan(*args, **kwargs):
12800 """
12801 GetSpan(self) -> GBSpan
12802
12803 Get the row and column spanning of the item
12804 """
12805 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12806
12807 def GetSpanTuple(self): return self.GetSpan().Get()
12808 def SetPos(*args, **kwargs):
12809 """
12810 SetPos(self, GBPosition pos) -> bool
12811
12812 If the item is already a member of a sizer then first ensure that
12813 there is no other item that would intersect with this one at the new
12814 position, then set the new position. Returns True if the change is
12815 successful and after the next Layout() the item will be moved.
12816 """
12817 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12818
12819 def SetSpan(*args, **kwargs):
12820 """
12821 SetSpan(self, GBSpan span) -> bool
12822
12823 If the item is already a member of a sizer then first ensure that
12824 there is no other item that would intersect with this one with its new
12825 spanning size, then set the new spanning. Returns True if the change
12826 is successful and after the next Layout() the item will be resized.
12827
12828 """
12829 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12830
12831 def Intersects(*args, **kwargs):
12832 """
12833 Intersects(self, GBSizerItem other) -> bool
12834
12835 Returns True if this item and the other item instersect.
12836 """
12837 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12838
12839 def IntersectsPos(*args, **kwargs):
12840 """
12841 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12842
12843 Returns True if the given pos/span would intersect with this item.
12844 """
12845 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
12846
12847 def GetEndPos(*args, **kwargs):
12848 """
12849 GetEndPos(self) -> GBPosition
12850
12851 Get the row and column of the endpoint of this item.
12852 """
12853 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12854
12855 def GetGBSizer(*args, **kwargs):
12856 """
12857 GetGBSizer(self) -> GridBagSizer
12858
12859 Get the sizer this item is a member of.
12860 """
12861 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12862
12863 def SetGBSizer(*args, **kwargs):
12864 """
12865 SetGBSizer(self, GridBagSizer sizer)
12866
12867 Set the sizer this item is a member of.
12868 """
12869 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12870
12871 EndPos = property(GetEndPos,doc="See `GetEndPos`")
12872 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
12873 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
12874 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
12875 _core_.GBSizerItem_swigregister(GBSizerItem)
12876 DefaultSpan = cvar.DefaultSpan
12877
12878 def GBSizerItemWindow(*args, **kwargs):
12879 """
12880 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
12881 int border, PyObject userData=None) -> GBSizerItem
12882
12883 Construct a `wx.GBSizerItem` for a window.
12884 """
12885 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12886 return val
12887
12888 def GBSizerItemSizer(*args, **kwargs):
12889 """
12890 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
12891 int border, PyObject userData=None) -> GBSizerItem
12892
12893 Construct a `wx.GBSizerItem` for a sizer
12894 """
12895 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12896 return val
12897
12898 def GBSizerItemSpacer(*args, **kwargs):
12899 """
12900 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
12901 int flag, int border, PyObject userData=None) -> GBSizerItem
12902
12903 Construct a `wx.GBSizerItem` for a spacer.
12904 """
12905 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12906 return val
12907
12908 class GridBagSizer(FlexGridSizer):
12909 """
12910 A `wx.Sizer` that can lay out items in a virtual grid like a
12911 `wx.FlexGridSizer` but in this case explicit positioning of the items
12912 is allowed using `wx.GBPosition`, and items can optionally span more
12913 than one row and/or column using `wx.GBSpan`. The total size of the
12914 virtual grid is determined by the largest row and column that items are
12915 positioned at, adjusted for spanning.
12916
12917 """
12918 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12919 __repr__ = _swig_repr
12920 def __init__(self, *args, **kwargs):
12921 """
12922 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12923
12924 Constructor, with optional parameters to specify the gap between the
12925 rows and columns.
12926 """
12927 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
12928 self._setOORInfo(self)
12929
12930 def Add(*args, **kwargs):
12931 """
12932 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
12933 int border=0, userData=None) -> wx.GBSizerItem
12934
12935 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12936 more than one row or column as specified with *span*. The remaining
12937 args behave similarly to `wx.Sizer.Add`.
12938
12939 Returns True if the item was successfully placed at the given cell
12940 position, False if something was already there.
12941
12942 """
12943 return _core_.GridBagSizer_Add(*args, **kwargs)
12944
12945 def AddItem(*args, **kwargs):
12946 """
12947 Add(self, GBSizerItem item) -> wx.GBSizerItem
12948
12949 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12950 the item was successfully placed at its given cell position, False if
12951 something was already there.
12952 """
12953 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12954
12955 def GetCellSize(*args, **kwargs):
12956 """
12957 GetCellSize(self, int row, int col) -> Size
12958
12959 Get the size of the specified cell, including hgap and
12960 vgap. Only valid after a Layout.
12961 """
12962 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12963
12964 def GetEmptyCellSize(*args, **kwargs):
12965 """
12966 GetEmptyCellSize(self) -> Size
12967
12968 Get the size used for cells in the grid with no item.
12969 """
12970 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12971
12972 def SetEmptyCellSize(*args, **kwargs):
12973 """
12974 SetEmptyCellSize(self, Size sz)
12975
12976 Set the size used for cells in the grid with no item.
12977 """
12978 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12979
12980 def GetItemPosition(*args):
12981 """
12982 GetItemPosition(self, item) -> GBPosition
12983
12984 Get the grid position of the specified *item* where *item* is either a
12985 window or subsizer that is a member of this sizer, or a zero-based
12986 index of an item.
12987 """
12988 return _core_.GridBagSizer_GetItemPosition(*args)
12989
12990 def SetItemPosition(*args):
12991 """
12992 SetItemPosition(self, item, GBPosition pos) -> bool
12993
12994 Set the grid position of the specified *item* where *item* is either a
12995 window or subsizer that is a member of this sizer, or a zero-based
12996 index of an item. Returns True on success. If the move is not
12997 allowed (because an item is already there) then False is returned.
12998
12999 """
13000 return _core_.GridBagSizer_SetItemPosition(*args)
13001
13002 def GetItemSpan(*args):
13003 """
13004 GetItemSpan(self, item) -> GBSpan
13005
13006 Get the row/col spanning of the specified *item* where *item* is
13007 either a window or subsizer that is a member of this sizer, or a
13008 zero-based index of an item.
13009 """
13010 return _core_.GridBagSizer_GetItemSpan(*args)
13011
13012 def SetItemSpan(*args):
13013 """
13014 SetItemSpan(self, item, GBSpan span) -> bool
13015
13016 Set the row/col spanning of the specified *item* where *item* is
13017 either a window or subsizer that is a member of this sizer, or a
13018 zero-based index of an item. Returns True on success. If the move is
13019 not allowed (because an item is already there) then False is returned.
13020 """
13021 return _core_.GridBagSizer_SetItemSpan(*args)
13022
13023 def FindItem(*args):
13024 """
13025 FindItem(self, item) -> GBSizerItem
13026
13027 Find the sizer item for the given window or subsizer, returns None if
13028 not found. (non-recursive)
13029 """
13030 return _core_.GridBagSizer_FindItem(*args)
13031
13032 def FindItemAtPosition(*args, **kwargs):
13033 """
13034 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13035
13036 Return the sizer item for the given grid cell, or None if there is no
13037 item at that position. (non-recursive)
13038 """
13039 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13040
13041 def FindItemAtPoint(*args, **kwargs):
13042 """
13043 FindItemAtPoint(self, Point pt) -> GBSizerItem
13044
13045 Return the sizer item located at the point given in *pt*, or None if
13046 there is no item at that point. The (x,y) coordinates in pt correspond
13047 to the client coordinates of the window using the sizer for
13048 layout. (non-recursive)
13049 """
13050 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13051
13052 def CheckForIntersection(*args, **kwargs):
13053 """
13054 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13055
13056 Look at all items and see if any intersect (or would overlap) the
13057 given *item*. Returns True if so, False if there would be no overlap.
13058 If an *excludeItem* is given then it will not be checked for
13059 intersection, for example it may be the item we are checking the
13060 position of.
13061
13062 """
13063 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
13064
13065 def CheckForIntersectionPos(*args, **kwargs):
13066 """
13067 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13068
13069 Look at all items and see if any intersect (or would overlap) the
13070 given position and span. Returns True if so, False if there would be
13071 no overlap. If an *excludeItem* is given then it will not be checked
13072 for intersection, for example it may be the item we are checking the
13073 position of.
13074 """
13075 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13076
13077 _core_.GridBagSizer_swigregister(GridBagSizer)
13078
13079 #---------------------------------------------------------------------------
13080
13081 Left = _core_.Left
13082 Top = _core_.Top
13083 Right = _core_.Right
13084 Bottom = _core_.Bottom
13085 Width = _core_.Width
13086 Height = _core_.Height
13087 Centre = _core_.Centre
13088 Center = _core_.Center
13089 CentreX = _core_.CentreX
13090 CentreY = _core_.CentreY
13091 Unconstrained = _core_.Unconstrained
13092 AsIs = _core_.AsIs
13093 PercentOf = _core_.PercentOf
13094 Above = _core_.Above
13095 Below = _core_.Below
13096 LeftOf = _core_.LeftOf
13097 RightOf = _core_.RightOf
13098 SameAs = _core_.SameAs
13099 Absolute = _core_.Absolute
13100 class IndividualLayoutConstraint(Object):
13101 """
13102 Objects of this class are stored in the `wx.LayoutConstraints` class as
13103 one of eight possible constraints that a window can be involved in.
13104 You will never need to create an instance of
13105 wx.IndividualLayoutConstraint, rather you should create a
13106 `wx.LayoutConstraints` instance and use the individual contstraints
13107 that it contains.
13108 """
13109 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13110 def __init__(self): raise AttributeError, "No constructor defined"
13111 __repr__ = _swig_repr
13112 def Set(*args, **kwargs):
13113 """
13114 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13115
13116 Sets the properties of the constraint. Normally called by one of the
13117 convenience functions such as Above, RightOf, SameAs.
13118 """
13119 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13120
13121 def LeftOf(*args, **kwargs):
13122 """
13123 LeftOf(self, Window sibling, int marg=0)
13124
13125 Constrains this edge to be to the left of the given window, with an
13126 optional margin. Implicitly, this is relative to the left edge of the
13127 other window.
13128 """
13129 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13130
13131 def RightOf(*args, **kwargs):
13132 """
13133 RightOf(self, Window sibling, int marg=0)
13134
13135 Constrains this edge to be to the right of the given window, with an
13136 optional margin. Implicitly, this is relative to the right edge of the
13137 other window.
13138 """
13139 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13140
13141 def Above(*args, **kwargs):
13142 """
13143 Above(self, Window sibling, int marg=0)
13144
13145 Constrains this edge to be above the given window, with an optional
13146 margin. Implicitly, this is relative to the top edge of the other
13147 window.
13148 """
13149 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13150
13151 def Below(*args, **kwargs):
13152 """
13153 Below(self, Window sibling, int marg=0)
13154
13155 Constrains this edge to be below the given window, with an optional
13156 margin. Implicitly, this is relative to the bottom edge of the other
13157 window.
13158 """
13159 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13160
13161 def SameAs(*args, **kwargs):
13162 """
13163 SameAs(self, Window otherW, int edge, int marg=0)
13164
13165 Constrains this edge or dimension to be to the same as the edge of the
13166 given window, with an optional margin.
13167 """
13168 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13169
13170 def PercentOf(*args, **kwargs):
13171 """
13172 PercentOf(self, Window otherW, int wh, int per)
13173
13174 Constrains this edge or dimension to be to a percentage of the given
13175 window, with an optional margin.
13176 """
13177 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13178
13179 def Absolute(*args, **kwargs):
13180 """
13181 Absolute(self, int val)
13182
13183 Constrains this edge or dimension to be the given absolute value.
13184 """
13185 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13186
13187 def Unconstrained(*args, **kwargs):
13188 """
13189 Unconstrained(self)
13190
13191 Sets this edge or dimension to be unconstrained, that is, dependent on
13192 other edges and dimensions from which this value can be deduced.
13193 """
13194 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13195
13196 def AsIs(*args, **kwargs):
13197 """
13198 AsIs(self)
13199
13200 Sets this edge or constraint to be whatever the window's value is at
13201 the moment. If either of the width and height constraints are *as is*,
13202 the window will not be resized, but moved instead. This is important
13203 when considering panel items which are intended to have a default
13204 size, such as a button, which may take its size from the size of the
13205 button label.
13206 """
13207 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13208
13209 def GetOtherWindow(*args, **kwargs):
13210 """GetOtherWindow(self) -> Window"""
13211 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13212
13213 def GetMyEdge(*args, **kwargs):
13214 """GetMyEdge(self) -> int"""
13215 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13216
13217 def SetEdge(*args, **kwargs):
13218 """SetEdge(self, int which)"""
13219 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13220
13221 def SetValue(*args, **kwargs):
13222 """SetValue(self, int v)"""
13223 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13224
13225 def GetMargin(*args, **kwargs):
13226 """GetMargin(self) -> int"""
13227 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13228
13229 def SetMargin(*args, **kwargs):
13230 """SetMargin(self, int m)"""
13231 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13232
13233 def GetValue(*args, **kwargs):
13234 """GetValue(self) -> int"""
13235 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13236
13237 def GetPercent(*args, **kwargs):
13238 """GetPercent(self) -> int"""
13239 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13240
13241 def GetOtherEdge(*args, **kwargs):
13242 """GetOtherEdge(self) -> int"""
13243 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13244
13245 def GetDone(*args, **kwargs):
13246 """GetDone(self) -> bool"""
13247 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13248
13249 def SetDone(*args, **kwargs):
13250 """SetDone(self, bool d)"""
13251 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13252
13253 def GetRelationship(*args, **kwargs):
13254 """GetRelationship(self) -> int"""
13255 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13256
13257 def SetRelationship(*args, **kwargs):
13258 """SetRelationship(self, int r)"""
13259 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13260
13261 def ResetIfWin(*args, **kwargs):
13262 """
13263 ResetIfWin(self, Window otherW) -> bool
13264
13265 Reset constraint if it mentions otherWin
13266 """
13267 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13268
13269 def SatisfyConstraint(*args, **kwargs):
13270 """
13271 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13272
13273 Try to satisfy constraint
13274 """
13275 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13276
13277 def GetEdge(*args, **kwargs):
13278 """
13279 GetEdge(self, int which, Window thisWin, Window other) -> int
13280
13281 Get the value of this edge or dimension, or if this
13282 is not determinable, -1.
13283 """
13284 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13285
13286 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13287 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13288 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13289 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13290 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13291 Percent = property(GetPercent,doc="See `GetPercent`")
13292 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13293 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
13294 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
13295
13296 class LayoutConstraints(Object):
13297 """
13298 **Note:** constraints are now deprecated and you should use sizers
13299 instead.
13300
13301 Objects of this class can be associated with a window to define its
13302 layout constraints, with respect to siblings or its parent.
13303
13304 The class consists of the following eight constraints of class
13305 wx.IndividualLayoutConstraint, some or all of which should be accessed
13306 directly to set the appropriate constraints.
13307
13308 * left: represents the left hand edge of the window
13309 * right: represents the right hand edge of the window
13310 * top: represents the top edge of the window
13311 * bottom: represents the bottom edge of the window
13312 * width: represents the width of the window
13313 * height: represents the height of the window
13314 * centreX: represents the horizontal centre point of the window
13315 * centreY: represents the vertical centre point of the window
13316
13317 Most constraints are initially set to have the relationship
13318 wxUnconstrained, which means that their values should be calculated by
13319 looking at known constraints. The exceptions are width and height,
13320 which are set to wxAsIs to ensure that if the user does not specify a
13321 constraint, the existing width and height will be used, to be
13322 compatible with panel items which often have take a default size. If
13323 the constraint is ``wx.AsIs``, the dimension will not be changed.
13324
13325 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13326
13327 """
13328 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13329 __repr__ = _swig_repr
13330 left = property(_core_.LayoutConstraints_left_get)
13331 top = property(_core_.LayoutConstraints_top_get)
13332 right = property(_core_.LayoutConstraints_right_get)
13333 bottom = property(_core_.LayoutConstraints_bottom_get)
13334 width = property(_core_.LayoutConstraints_width_get)
13335 height = property(_core_.LayoutConstraints_height_get)
13336 centreX = property(_core_.LayoutConstraints_centreX_get)
13337 centreY = property(_core_.LayoutConstraints_centreY_get)
13338 def __init__(self, *args, **kwargs):
13339 """__init__(self) -> LayoutConstraints"""
13340 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13341 __swig_destroy__ = _core_.delete_LayoutConstraints
13342 __del__ = lambda self : None;
13343 def SatisfyConstraints(*args, **kwargs):
13344 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13345 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13346
13347 def AreSatisfied(*args, **kwargs):
13348 """AreSatisfied(self) -> bool"""
13349 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13350
13351 _core_.LayoutConstraints_swigregister(LayoutConstraints)
13352
13353 #----------------------------------------------------------------------------
13354
13355 # Use Python's bool constants if available, make some if not
13356 try:
13357 True
13358 except NameError:
13359 __builtins__.True = 1==1
13360 __builtins__.False = 1==0
13361 def bool(value): return not not value
13362 __builtins__.bool = bool
13363
13364
13365
13366 # workarounds for bad wxRTTI names
13367 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13368 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13369 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13370
13371
13372 #----------------------------------------------------------------------------
13373 # Load version numbers from __version__... Ensure that major and minor
13374 # versions are the same for both wxPython and wxWidgets.
13375
13376 from __version__ import *
13377 __version__ = VERSION_STRING
13378
13379 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13380 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
13381 if RELEASE_VERSION != _core_.RELEASE_VERSION:
13382 import warnings
13383 warnings.warn("wxPython/wxWidgets release number mismatch")
13384
13385 #----------------------------------------------------------------------------
13386
13387 # Set wxPython's default string<-->unicode conversion encoding from
13388 # the locale, but only if Python's default hasn't been changed. (We
13389 # assume that if the user has customized it already then that is the
13390 # encoding we need to use as well.)
13391 #
13392 # The encoding selected here is used when string or unicode objects
13393 # need to be converted in order to pass them to wxWidgets. Please be
13394 # aware that the default encoding within the same locale may be
13395 # slightly different on different platforms. For example, please see
13396 # http://www.alanwood.net/demos/charsetdiffs.html for differences
13397 # between the common latin/roman encodings.
13398
13399 default = _sys.getdefaultencoding()
13400 if default == 'ascii':
13401 import locale
13402 import codecs
13403 try:
13404 default = locale.getdefaultlocale()[1]
13405 codecs.lookup(default)
13406 except (ValueError, LookupError, TypeError):
13407 default = _sys.getdefaultencoding()
13408 del locale
13409 del codecs
13410 if default:
13411 wx.SetDefaultPyEncoding(default)
13412 del default
13413
13414 #----------------------------------------------------------------------------
13415
13416 class PyDeadObjectError(AttributeError):
13417 pass
13418
13419 class _wxPyDeadObject(object):
13420 """
13421 Instances of wx objects that are OOR capable will have their __class__
13422 changed to this class when the C++ object is deleted. This should help
13423 prevent crashes due to referencing a bogus C++ pointer.
13424 """
13425 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13426 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13427
13428 def __repr__(self):
13429 if not hasattr(self, "_name"):
13430 self._name = "[unknown]"
13431 return self.reprStr % self._name
13432
13433 def __getattr__(self, *args):
13434 if not hasattr(self, "_name"):
13435 self._name = "[unknown]"
13436 raise PyDeadObjectError(self.attrStr % self._name)
13437
13438 def __nonzero__(self):
13439 return 0
13440
13441
13442
13443 class PyUnbornObjectError(AttributeError):
13444 pass
13445
13446 class _wxPyUnbornObject(object):
13447 """
13448 Some stock objects are created when the wx._core module is
13449 imported, but their C++ instance is not created until the wx.App
13450 object is created and initialized. These object instances will
13451 temporarily have their __class__ changed to this class so an
13452 exception will be raised if they are used before the C++ instance
13453 is ready.
13454 """
13455
13456 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13457 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13458
13459 def __repr__(self):
13460 #if not hasattr(self, "_name"):
13461 # self._name = "[unknown]"
13462 return self.reprStr #% self._name
13463
13464 def __getattr__(self, *args):
13465 #if not hasattr(self, "_name"):
13466 # self._name = "[unknown]"
13467 raise PyUnbornObjectError(self.attrStr) # % self._name )
13468
13469 def __nonzero__(self):
13470 return 0
13471
13472
13473 #----------------------------------------------------------------------------
13474
13475 def CallAfter(callable, *args, **kw):
13476 """
13477 Call the specified function after the current and pending event
13478 handlers have been completed. This is also good for making GUI
13479 method calls from non-GUI threads. Any extra positional or
13480 keyword args are passed on to the callable when it is called.
13481
13482 :see: `wx.FutureCall`
13483 """
13484 app = wx.GetApp()
13485 assert app is not None, 'No wx.App created yet'
13486
13487 if not hasattr(app, "_CallAfterId"):
13488 app._CallAfterId = wx.NewEventType()
13489 app.Connect(-1, -1, app._CallAfterId,
13490 lambda event: event.callable(*event.args, **event.kw) )
13491 evt = wx.PyEvent()
13492 evt.SetEventType(app._CallAfterId)
13493 evt.callable = callable
13494 evt.args = args
13495 evt.kw = kw
13496 wx.PostEvent(app, evt)
13497
13498 #----------------------------------------------------------------------------
13499
13500
13501 class FutureCall:
13502 """
13503 A convenience class for `wx.Timer`, that calls the given callable
13504 object once after the given amount of milliseconds, passing any
13505 positional or keyword args. The return value of the callable is
13506 availbale after it has been run with the `GetResult` method.
13507
13508 If you don't need to get the return value or restart the timer
13509 then there is no need to hold a reference to this object. It will
13510 hold a reference to itself while the timer is running (the timer
13511 has a reference to self.Notify) but the cycle will be broken when
13512 the timer completes, automatically cleaning up the wx.FutureCall
13513 object.
13514
13515 :see: `wx.CallAfter`
13516 """
13517 def __init__(self, millis, callable, *args, **kwargs):
13518 self.millis = millis
13519 self.callable = callable
13520 self.SetArgs(*args, **kwargs)
13521 self.runCount = 0
13522 self.running = False
13523 self.hasRun = False
13524 self.result = None
13525 self.timer = None
13526 self.Start()
13527
13528 def __del__(self):
13529 self.Stop()
13530
13531
13532 def Start(self, millis=None, *args, **kwargs):
13533 """
13534 (Re)start the timer
13535 """
13536 self.hasRun = False
13537 if millis is not None:
13538 self.millis = millis
13539 if args or kwargs:
13540 self.SetArgs(*args, **kwargs)
13541 self.Stop()
13542 self.timer = wx.PyTimer(self.Notify)
13543 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13544 self.running = True
13545 Restart = Start
13546
13547
13548 def Stop(self):
13549 """
13550 Stop and destroy the timer.
13551 """
13552 if self.timer is not None:
13553 self.timer.Stop()
13554 self.timer = None
13555
13556
13557 def GetInterval(self):
13558 if self.timer is not None:
13559 return self.timer.GetInterval()
13560 else:
13561 return 0
13562
13563
13564 def IsRunning(self):
13565 return self.timer is not None and self.timer.IsRunning()
13566
13567
13568 def SetArgs(self, *args, **kwargs):
13569 """
13570 (Re)set the args passed to the callable object. This is
13571 useful in conjunction with Restart if you want to schedule a
13572 new call to the same callable object but with different
13573 parameters.
13574 """
13575 self.args = args
13576 self.kwargs = kwargs
13577
13578
13579 def HasRun(self):
13580 return self.hasRun
13581
13582 def GetResult(self):
13583 return self.result
13584
13585 def Notify(self):
13586 """
13587 The timer has expired so call the callable.
13588 """
13589 if self.callable and getattr(self.callable, 'im_self', True):
13590 self.runCount += 1
13591 self.running = False
13592 self.result = self.callable(*self.args, **self.kwargs)
13593 self.hasRun = True
13594 if not self.running:
13595 # if it wasn't restarted, then cleanup
13596 wx.CallAfter(self.Stop)
13597
13598 Interval = property(GetInterval)
13599 Result = property(GetResult)
13600
13601
13602 #----------------------------------------------------------------------------
13603 # Control which items in this module should be documented by epydoc.
13604 # We allow only classes and functions, which will help reduce the size
13605 # of the docs by filtering out the zillions of constants, EVT objects,
13606 # and etc that don't make much sense by themselves, but are instead
13607 # documented (or will be) as part of the classes/functions/methods
13608 # where they should be used.
13609
13610 class __DocFilter:
13611 """
13612 A filter for epydoc that only allows non-Ptr classes and
13613 functions, in order to reduce the clutter in the API docs.
13614 """
13615 def __init__(self, globals):
13616 self._globals = globals
13617
13618 def __call__(self, name):
13619 import types
13620 obj = self._globals.get(name, None)
13621
13622 # only document classes and function
13623 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13624 return False
13625
13626 # skip other things that are private or will be documented as part of somethign else
13627 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
13628 return False
13629
13630 # skip functions that are duplicates of static functions in a class
13631 if name.find('_') != -1:
13632 cls = self._globals.get(name.split('_')[0], None)
13633 methname = name.split('_')[1]
13634 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13635 return False
13636
13637 return True
13638
13639 #----------------------------------------------------------------------------
13640 #----------------------------------------------------------------------------
13641
13642 # Import other modules in this package that should show up in the
13643 # "core" wx namespace
13644 from _gdi import *
13645 from _windows import *
13646 from _controls import *
13647 from _misc import *
13648
13649 #----------------------------------------------------------------------------
13650 #----------------------------------------------------------------------------
13651
13652
13653