]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/msw/_core.py
reSWIGged
[wxWidgets.git] / wxPython / src / msw / _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 CB_SIMPLE = _core_.CB_SIMPLE
120 CB_DROPDOWN = _core_.CB_DROPDOWN
121 CB_SORT = _core_.CB_SORT
122 CB_READONLY = _core_.CB_READONLY
123 RA_HORIZONTAL = _core_.RA_HORIZONTAL
124 RA_VERTICAL = _core_.RA_VERTICAL
125 RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
126 RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
127 RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
128 RB_GROUP = _core_.RB_GROUP
129 RB_SINGLE = _core_.RB_SINGLE
130 SB_HORIZONTAL = _core_.SB_HORIZONTAL
131 SB_VERTICAL = _core_.SB_VERTICAL
132 RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
133 ST_SIZEGRIP = _core_.ST_SIZEGRIP
134 FLOOD_SURFACE = _core_.FLOOD_SURFACE
135 FLOOD_BORDER = _core_.FLOOD_BORDER
136 ODDEVEN_RULE = _core_.ODDEVEN_RULE
137 WINDING_RULE = _core_.WINDING_RULE
138 TOOL_TOP = _core_.TOOL_TOP
139 TOOL_BOTTOM = _core_.TOOL_BOTTOM
140 TOOL_LEFT = _core_.TOOL_LEFT
141 TOOL_RIGHT = _core_.TOOL_RIGHT
142 OK = _core_.OK
143 YES_NO = _core_.YES_NO
144 CANCEL = _core_.CANCEL
145 YES = _core_.YES
146 NO = _core_.NO
147 NO_DEFAULT = _core_.NO_DEFAULT
148 YES_DEFAULT = _core_.YES_DEFAULT
149 APPLY = _core_.APPLY
150 CLOSE = _core_.CLOSE
151 ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
152 ICON_HAND = _core_.ICON_HAND
153 ICON_QUESTION = _core_.ICON_QUESTION
154 ICON_INFORMATION = _core_.ICON_INFORMATION
155 ICON_STOP = _core_.ICON_STOP
156 ICON_ASTERISK = _core_.ICON_ASTERISK
157 ICON_MASK = _core_.ICON_MASK
158 ICON_WARNING = _core_.ICON_WARNING
159 ICON_ERROR = _core_.ICON_ERROR
160 FORWARD = _core_.FORWARD
161 BACKWARD = _core_.BACKWARD
162 RESET = _core_.RESET
163 HELP = _core_.HELP
164 MORE = _core_.MORE
165 SETUP = _core_.SETUP
166 SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
167 SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
168 SIZE_AUTO = _core_.SIZE_AUTO
169 SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
170 SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
171 SIZE_FORCE = _core_.SIZE_FORCE
172 PORTRAIT = _core_.PORTRAIT
173 LANDSCAPE = _core_.LANDSCAPE
174 PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
175 PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
176 PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
177 PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
178 ID_ANY = _core_.ID_ANY
179 ID_SEPARATOR = _core_.ID_SEPARATOR
180 ID_NONE = _core_.ID_NONE
181 ID_LOWEST = _core_.ID_LOWEST
182 ID_OPEN = _core_.ID_OPEN
183 ID_CLOSE = _core_.ID_CLOSE
184 ID_NEW = _core_.ID_NEW
185 ID_SAVE = _core_.ID_SAVE
186 ID_SAVEAS = _core_.ID_SAVEAS
187 ID_REVERT = _core_.ID_REVERT
188 ID_EXIT = _core_.ID_EXIT
189 ID_UNDO = _core_.ID_UNDO
190 ID_REDO = _core_.ID_REDO
191 ID_HELP = _core_.ID_HELP
192 ID_PRINT = _core_.ID_PRINT
193 ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
194 ID_PAGE_SETUP = _core_.ID_PAGE_SETUP
195 ID_PREVIEW = _core_.ID_PREVIEW
196 ID_ABOUT = _core_.ID_ABOUT
197 ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
198 ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
199 ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
200 ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
201 ID_HELP_INDEX = _core_.ID_HELP_INDEX
202 ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
203 ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
204 ID_PREFERENCES = _core_.ID_PREFERENCES
205 ID_EDIT = _core_.ID_EDIT
206 ID_CUT = _core_.ID_CUT
207 ID_COPY = _core_.ID_COPY
208 ID_PASTE = _core_.ID_PASTE
209 ID_CLEAR = _core_.ID_CLEAR
210 ID_FIND = _core_.ID_FIND
211 ID_DUPLICATE = _core_.ID_DUPLICATE
212 ID_SELECTALL = _core_.ID_SELECTALL
213 ID_DELETE = _core_.ID_DELETE
214 ID_REPLACE = _core_.ID_REPLACE
215 ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
216 ID_PROPERTIES = _core_.ID_PROPERTIES
217 ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
218 ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
219 ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
220 ID_VIEW_LIST = _core_.ID_VIEW_LIST
221 ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
222 ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
223 ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
224 ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
225 ID_FILE = _core_.ID_FILE
226 ID_FILE1 = _core_.ID_FILE1
227 ID_FILE2 = _core_.ID_FILE2
228 ID_FILE3 = _core_.ID_FILE3
229 ID_FILE4 = _core_.ID_FILE4
230 ID_FILE5 = _core_.ID_FILE5
231 ID_FILE6 = _core_.ID_FILE6
232 ID_FILE7 = _core_.ID_FILE7
233 ID_FILE8 = _core_.ID_FILE8
234 ID_FILE9 = _core_.ID_FILE9
235 ID_OK = _core_.ID_OK
236 ID_CANCEL = _core_.ID_CANCEL
237 ID_APPLY = _core_.ID_APPLY
238 ID_YES = _core_.ID_YES
239 ID_NO = _core_.ID_NO
240 ID_STATIC = _core_.ID_STATIC
241 ID_FORWARD = _core_.ID_FORWARD
242 ID_BACKWARD = _core_.ID_BACKWARD
243 ID_DEFAULT = _core_.ID_DEFAULT
244 ID_MORE = _core_.ID_MORE
245 ID_SETUP = _core_.ID_SETUP
246 ID_RESET = _core_.ID_RESET
247 ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
248 ID_YESTOALL = _core_.ID_YESTOALL
249 ID_NOTOALL = _core_.ID_NOTOALL
250 ID_ABORT = _core_.ID_ABORT
251 ID_RETRY = _core_.ID_RETRY
252 ID_IGNORE = _core_.ID_IGNORE
253 ID_ADD = _core_.ID_ADD
254 ID_REMOVE = _core_.ID_REMOVE
255 ID_UP = _core_.ID_UP
256 ID_DOWN = _core_.ID_DOWN
257 ID_HOME = _core_.ID_HOME
258 ID_REFRESH = _core_.ID_REFRESH
259 ID_STOP = _core_.ID_STOP
260 ID_INDEX = _core_.ID_INDEX
261 ID_BOLD = _core_.ID_BOLD
262 ID_ITALIC = _core_.ID_ITALIC
263 ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
264 ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
265 ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
266 ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
267 ID_UNDERLINE = _core_.ID_UNDERLINE
268 ID_INDENT = _core_.ID_INDENT
269 ID_UNINDENT = _core_.ID_UNINDENT
270 ID_ZOOM_100 = _core_.ID_ZOOM_100
271 ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
272 ID_ZOOM_IN = _core_.ID_ZOOM_IN
273 ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
274 ID_UNDELETE = _core_.ID_UNDELETE
275 ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
276 ID_HIGHEST = _core_.ID_HIGHEST
277 MENU_TEAROFF = _core_.MENU_TEAROFF
278 MB_DOCKABLE = _core_.MB_DOCKABLE
279 NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
280 FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
281 LI_HORIZONTAL = _core_.LI_HORIZONTAL
282 LI_VERTICAL = _core_.LI_VERTICAL
283 WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
284 WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
285 WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
286 WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
287 WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
288 WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
289 MM_TEXT = _core_.MM_TEXT
290 MM_LOMETRIC = _core_.MM_LOMETRIC
291 MM_HIMETRIC = _core_.MM_HIMETRIC
292 MM_LOENGLISH = _core_.MM_LOENGLISH
293 MM_HIENGLISH = _core_.MM_HIENGLISH
294 MM_TWIPS = _core_.MM_TWIPS
295 MM_ISOTROPIC = _core_.MM_ISOTROPIC
296 MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
297 MM_POINTS = _core_.MM_POINTS
298 MM_METRIC = _core_.MM_METRIC
299 CENTRE = _core_.CENTRE
300 CENTER = _core_.CENTER
301 HORIZONTAL = _core_.HORIZONTAL
302 VERTICAL = _core_.VERTICAL
303 BOTH = _core_.BOTH
304 LEFT = _core_.LEFT
305 RIGHT = _core_.RIGHT
306 UP = _core_.UP
307 DOWN = _core_.DOWN
308 TOP = _core_.TOP
309 BOTTOM = _core_.BOTTOM
310 NORTH = _core_.NORTH
311 SOUTH = _core_.SOUTH
312 WEST = _core_.WEST
313 EAST = _core_.EAST
314 ALL = _core_.ALL
315 ALIGN_NOT = _core_.ALIGN_NOT
316 ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
317 ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
318 ALIGN_LEFT = _core_.ALIGN_LEFT
319 ALIGN_TOP = _core_.ALIGN_TOP
320 ALIGN_RIGHT = _core_.ALIGN_RIGHT
321 ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
322 ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
323 ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
324 ALIGN_CENTER = _core_.ALIGN_CENTER
325 ALIGN_CENTRE = _core_.ALIGN_CENTRE
326 ALIGN_MASK = _core_.ALIGN_MASK
327 STRETCH_NOT = _core_.STRETCH_NOT
328 SHRINK = _core_.SHRINK
329 GROW = _core_.GROW
330 EXPAND = _core_.EXPAND
331 SHAPED = _core_.SHAPED
332 FIXED_MINSIZE = _core_.FIXED_MINSIZE
333 TILE = _core_.TILE
334 ADJUST_MINSIZE = 0
335 BORDER_DEFAULT = _core_.BORDER_DEFAULT
336 BORDER_NONE = _core_.BORDER_NONE
337 BORDER_STATIC = _core_.BORDER_STATIC
338 BORDER_SIMPLE = _core_.BORDER_SIMPLE
339 BORDER_RAISED = _core_.BORDER_RAISED
340 BORDER_SUNKEN = _core_.BORDER_SUNKEN
341 BORDER_DOUBLE = _core_.BORDER_DOUBLE
342 BORDER_MASK = _core_.BORDER_MASK
343 BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
344 BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
345 BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
346 DEFAULT = _core_.DEFAULT
347 DECORATIVE = _core_.DECORATIVE
348 ROMAN = _core_.ROMAN
349 SCRIPT = _core_.SCRIPT
350 SWISS = _core_.SWISS
351 MODERN = _core_.MODERN
352 TELETYPE = _core_.TELETYPE
353 VARIABLE = _core_.VARIABLE
354 FIXED = _core_.FIXED
355 NORMAL = _core_.NORMAL
356 LIGHT = _core_.LIGHT
357 BOLD = _core_.BOLD
358 ITALIC = _core_.ITALIC
359 SLANT = _core_.SLANT
360 SOLID = _core_.SOLID
361 DOT = _core_.DOT
362 LONG_DASH = _core_.LONG_DASH
363 SHORT_DASH = _core_.SHORT_DASH
364 DOT_DASH = _core_.DOT_DASH
365 USER_DASH = _core_.USER_DASH
366 TRANSPARENT = _core_.TRANSPARENT
367 STIPPLE = _core_.STIPPLE
368 STIPPLE_MASK = _core_.STIPPLE_MASK
369 STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
370 BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
371 CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
372 FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
373 CROSS_HATCH = _core_.CROSS_HATCH
374 HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
375 VERTICAL_HATCH = _core_.VERTICAL_HATCH
376 JOIN_BEVEL = _core_.JOIN_BEVEL
377 JOIN_MITER = _core_.JOIN_MITER
378 JOIN_ROUND = _core_.JOIN_ROUND
379 CAP_ROUND = _core_.CAP_ROUND
380 CAP_PROJECTING = _core_.CAP_PROJECTING
381 CAP_BUTT = _core_.CAP_BUTT
382 CLEAR = _core_.CLEAR
383 XOR = _core_.XOR
384 INVERT = _core_.INVERT
385 OR_REVERSE = _core_.OR_REVERSE
386 AND_REVERSE = _core_.AND_REVERSE
387 COPY = _core_.COPY
388 AND = _core_.AND
389 AND_INVERT = _core_.AND_INVERT
390 NO_OP = _core_.NO_OP
391 NOR = _core_.NOR
392 EQUIV = _core_.EQUIV
393 SRC_INVERT = _core_.SRC_INVERT
394 OR_INVERT = _core_.OR_INVERT
395 NAND = _core_.NAND
396 OR = _core_.OR
397 SET = _core_.SET
398 WXK_BACK = _core_.WXK_BACK
399 WXK_TAB = _core_.WXK_TAB
400 WXK_RETURN = _core_.WXK_RETURN
401 WXK_ESCAPE = _core_.WXK_ESCAPE
402 WXK_SPACE = _core_.WXK_SPACE
403 WXK_DELETE = _core_.WXK_DELETE
404 WXK_START = _core_.WXK_START
405 WXK_LBUTTON = _core_.WXK_LBUTTON
406 WXK_RBUTTON = _core_.WXK_RBUTTON
407 WXK_CANCEL = _core_.WXK_CANCEL
408 WXK_MBUTTON = _core_.WXK_MBUTTON
409 WXK_CLEAR = _core_.WXK_CLEAR
410 WXK_SHIFT = _core_.WXK_SHIFT
411 WXK_ALT = _core_.WXK_ALT
412 WXK_CONTROL = _core_.WXK_CONTROL
413 WXK_MENU = _core_.WXK_MENU
414 WXK_PAUSE = _core_.WXK_PAUSE
415 WXK_CAPITAL = _core_.WXK_CAPITAL
416 WXK_END = _core_.WXK_END
417 WXK_HOME = _core_.WXK_HOME
418 WXK_LEFT = _core_.WXK_LEFT
419 WXK_UP = _core_.WXK_UP
420 WXK_RIGHT = _core_.WXK_RIGHT
421 WXK_DOWN = _core_.WXK_DOWN
422 WXK_SELECT = _core_.WXK_SELECT
423 WXK_PRINT = _core_.WXK_PRINT
424 WXK_EXECUTE = _core_.WXK_EXECUTE
425 WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
426 WXK_INSERT = _core_.WXK_INSERT
427 WXK_HELP = _core_.WXK_HELP
428 WXK_NUMPAD0 = _core_.WXK_NUMPAD0
429 WXK_NUMPAD1 = _core_.WXK_NUMPAD1
430 WXK_NUMPAD2 = _core_.WXK_NUMPAD2
431 WXK_NUMPAD3 = _core_.WXK_NUMPAD3
432 WXK_NUMPAD4 = _core_.WXK_NUMPAD4
433 WXK_NUMPAD5 = _core_.WXK_NUMPAD5
434 WXK_NUMPAD6 = _core_.WXK_NUMPAD6
435 WXK_NUMPAD7 = _core_.WXK_NUMPAD7
436 WXK_NUMPAD8 = _core_.WXK_NUMPAD8
437 WXK_NUMPAD9 = _core_.WXK_NUMPAD9
438 WXK_MULTIPLY = _core_.WXK_MULTIPLY
439 WXK_ADD = _core_.WXK_ADD
440 WXK_SEPARATOR = _core_.WXK_SEPARATOR
441 WXK_SUBTRACT = _core_.WXK_SUBTRACT
442 WXK_DECIMAL = _core_.WXK_DECIMAL
443 WXK_DIVIDE = _core_.WXK_DIVIDE
444 WXK_F1 = _core_.WXK_F1
445 WXK_F2 = _core_.WXK_F2
446 WXK_F3 = _core_.WXK_F3
447 WXK_F4 = _core_.WXK_F4
448 WXK_F5 = _core_.WXK_F5
449 WXK_F6 = _core_.WXK_F6
450 WXK_F7 = _core_.WXK_F7
451 WXK_F8 = _core_.WXK_F8
452 WXK_F9 = _core_.WXK_F9
453 WXK_F10 = _core_.WXK_F10
454 WXK_F11 = _core_.WXK_F11
455 WXK_F12 = _core_.WXK_F12
456 WXK_F13 = _core_.WXK_F13
457 WXK_F14 = _core_.WXK_F14
458 WXK_F15 = _core_.WXK_F15
459 WXK_F16 = _core_.WXK_F16
460 WXK_F17 = _core_.WXK_F17
461 WXK_F18 = _core_.WXK_F18
462 WXK_F19 = _core_.WXK_F19
463 WXK_F20 = _core_.WXK_F20
464 WXK_F21 = _core_.WXK_F21
465 WXK_F22 = _core_.WXK_F22
466 WXK_F23 = _core_.WXK_F23
467 WXK_F24 = _core_.WXK_F24
468 WXK_NUMLOCK = _core_.WXK_NUMLOCK
469 WXK_SCROLL = _core_.WXK_SCROLL
470 WXK_PAGEUP = _core_.WXK_PAGEUP
471 WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
472 WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
473 WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
474 WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
475 WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
476 WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
477 WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
478 WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
479 WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
480 WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
481 WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
482 WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
483 WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
484 WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
485 WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
486 WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
487 WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
488 WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
489 WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
490 WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
491 WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
492 WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
493 WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
494 WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
495 WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
496 WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
497 WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
498 WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
499 WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
500 WXK_COMMAND = _core_.WXK_COMMAND
501 WXK_SPECIAL1 = _core_.WXK_SPECIAL1
502 WXK_SPECIAL2 = _core_.WXK_SPECIAL2
503 WXK_SPECIAL3 = _core_.WXK_SPECIAL3
504 WXK_SPECIAL4 = _core_.WXK_SPECIAL4
505 WXK_SPECIAL5 = _core_.WXK_SPECIAL5
506 WXK_SPECIAL6 = _core_.WXK_SPECIAL6
507 WXK_SPECIAL7 = _core_.WXK_SPECIAL7
508 WXK_SPECIAL8 = _core_.WXK_SPECIAL8
509 WXK_SPECIAL9 = _core_.WXK_SPECIAL9
510 WXK_SPECIAL10 = _core_.WXK_SPECIAL10
511 WXK_SPECIAL11 = _core_.WXK_SPECIAL11
512 WXK_SPECIAL12 = _core_.WXK_SPECIAL12
513 WXK_SPECIAL13 = _core_.WXK_SPECIAL13
514 WXK_SPECIAL14 = _core_.WXK_SPECIAL14
515 WXK_SPECIAL15 = _core_.WXK_SPECIAL15
516 WXK_SPECIAL16 = _core_.WXK_SPECIAL16
517 WXK_SPECIAL17 = _core_.WXK_SPECIAL17
518 WXK_SPECIAL18 = _core_.WXK_SPECIAL18
519 WXK_SPECIAL19 = _core_.WXK_SPECIAL19
520 WXK_SPECIAL20 = _core_.WXK_SPECIAL20
521 WXK_PRIOR = WXK_PAGEUP
522 WXK_NEXT = WXK_PAGEDOWN
523 WXK_NUMPAD_PRIOR = WXK_NUMPAD_PAGEUP
524 WXK_NUMPAD_NEXT = WXK_NUMPAD_PAGEDOWN
525
526 PAPER_NONE = _core_.PAPER_NONE
527 PAPER_LETTER = _core_.PAPER_LETTER
528 PAPER_LEGAL = _core_.PAPER_LEGAL
529 PAPER_A4 = _core_.PAPER_A4
530 PAPER_CSHEET = _core_.PAPER_CSHEET
531 PAPER_DSHEET = _core_.PAPER_DSHEET
532 PAPER_ESHEET = _core_.PAPER_ESHEET
533 PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
534 PAPER_TABLOID = _core_.PAPER_TABLOID
535 PAPER_LEDGER = _core_.PAPER_LEDGER
536 PAPER_STATEMENT = _core_.PAPER_STATEMENT
537 PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
538 PAPER_A3 = _core_.PAPER_A3
539 PAPER_A4SMALL = _core_.PAPER_A4SMALL
540 PAPER_A5 = _core_.PAPER_A5
541 PAPER_B4 = _core_.PAPER_B4
542 PAPER_B5 = _core_.PAPER_B5
543 PAPER_FOLIO = _core_.PAPER_FOLIO
544 PAPER_QUARTO = _core_.PAPER_QUARTO
545 PAPER_10X14 = _core_.PAPER_10X14
546 PAPER_11X17 = _core_.PAPER_11X17
547 PAPER_NOTE = _core_.PAPER_NOTE
548 PAPER_ENV_9 = _core_.PAPER_ENV_9
549 PAPER_ENV_10 = _core_.PAPER_ENV_10
550 PAPER_ENV_11 = _core_.PAPER_ENV_11
551 PAPER_ENV_12 = _core_.PAPER_ENV_12
552 PAPER_ENV_14 = _core_.PAPER_ENV_14
553 PAPER_ENV_DL = _core_.PAPER_ENV_DL
554 PAPER_ENV_C5 = _core_.PAPER_ENV_C5
555 PAPER_ENV_C3 = _core_.PAPER_ENV_C3
556 PAPER_ENV_C4 = _core_.PAPER_ENV_C4
557 PAPER_ENV_C6 = _core_.PAPER_ENV_C6
558 PAPER_ENV_C65 = _core_.PAPER_ENV_C65
559 PAPER_ENV_B4 = _core_.PAPER_ENV_B4
560 PAPER_ENV_B5 = _core_.PAPER_ENV_B5
561 PAPER_ENV_B6 = _core_.PAPER_ENV_B6
562 PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
563 PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
564 PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
565 PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
566 PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
567 PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
568 PAPER_ISO_B4 = _core_.PAPER_ISO_B4
569 PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
570 PAPER_9X11 = _core_.PAPER_9X11
571 PAPER_10X11 = _core_.PAPER_10X11
572 PAPER_15X11 = _core_.PAPER_15X11
573 PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
574 PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
575 PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
576 PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
577 PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
578 PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
579 PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
580 PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
581 PAPER_A_PLUS = _core_.PAPER_A_PLUS
582 PAPER_B_PLUS = _core_.PAPER_B_PLUS
583 PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
584 PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
585 PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
586 PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
587 PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
588 PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
589 PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
590 PAPER_A2 = _core_.PAPER_A2
591 PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
592 PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
593 PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
594 PAPER_A6 = _core_.PAPER_A6
595 PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
596 PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
597 PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
598 PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
599 PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
600 PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
601 PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
602 PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
603 PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
604 PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
605 PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
606 PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
607 PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
608 PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
609 PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
610 PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
611 PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
612 PAPER_B6_JIS = _core_.PAPER_B6_JIS
613 PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
614 PAPER_12X11 = _core_.PAPER_12X11
615 PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
616 PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
617 PAPER_P16K = _core_.PAPER_P16K
618 PAPER_P32K = _core_.PAPER_P32K
619 PAPER_P32KBIG = _core_.PAPER_P32KBIG
620 PAPER_PENV_1 = _core_.PAPER_PENV_1
621 PAPER_PENV_2 = _core_.PAPER_PENV_2
622 PAPER_PENV_3 = _core_.PAPER_PENV_3
623 PAPER_PENV_4 = _core_.PAPER_PENV_4
624 PAPER_PENV_5 = _core_.PAPER_PENV_5
625 PAPER_PENV_6 = _core_.PAPER_PENV_6
626 PAPER_PENV_7 = _core_.PAPER_PENV_7
627 PAPER_PENV_8 = _core_.PAPER_PENV_8
628 PAPER_PENV_9 = _core_.PAPER_PENV_9
629 PAPER_PENV_10 = _core_.PAPER_PENV_10
630 PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
631 PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
632 PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
633 PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
634 PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
635 PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
636 PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
637 PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
638 PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
639 PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
640 PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
641 PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
642 PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
643 DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
644 DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
645 DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
646 ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
647 ITEM_NORMAL = _core_.ITEM_NORMAL
648 ITEM_CHECK = _core_.ITEM_CHECK
649 ITEM_RADIO = _core_.ITEM_RADIO
650 ITEM_MAX = _core_.ITEM_MAX
651 HT_NOWHERE = _core_.HT_NOWHERE
652 HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
653 HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
654 HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
655 HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
656 HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
657 HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
658 HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
659 HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
660 HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
661 HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
662 HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
663 HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
664 HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
665 HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
666 HT_MAX = _core_.HT_MAX
667 MOD_NONE = _core_.MOD_NONE
668 MOD_ALT = _core_.MOD_ALT
669 MOD_CONTROL = _core_.MOD_CONTROL
670 MOD_ALTGR = _core_.MOD_ALTGR
671 MOD_SHIFT = _core_.MOD_SHIFT
672 MOD_META = _core_.MOD_META
673 MOD_WIN = _core_.MOD_WIN
674 MOD_CMD = _core_.MOD_CMD
675 MOD_ALL = _core_.MOD_ALL
676 UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
677 UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
678 UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
679 Layout_Default = _core_.Layout_Default
680 Layout_LeftToRight = _core_.Layout_LeftToRight
681 Layout_RightToLeft = _core_.Layout_RightToLeft
682 #---------------------------------------------------------------------------
683
684 class Object(object):
685 """
686 The base class for most wx objects, although in wxPython not
687 much functionality is needed nor exposed.
688 """
689 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
690 def __init__(self): raise AttributeError, "No constructor defined"
691 __repr__ = _swig_repr
692 def GetClassName(*args, **kwargs):
693 """
694 GetClassName(self) -> String
695
696 Returns the class name of the C++ class using wxRTTI.
697 """
698 return _core_.Object_GetClassName(*args, **kwargs)
699
700 def Destroy(*args, **kwargs):
701 """
702 Destroy(self)
703
704 Deletes the C++ object this Python object is a proxy for.
705 """
706 args[0].this.own(False)
707 return _core_.Object_Destroy(*args, **kwargs)
708
709 def IsSameAs(*args, **kwargs):
710 """
711 IsSameAs(self, Object p) -> bool
712
713 For wx.Objects that use C++ reference counting internally, this method
714 can be used to determine if two objects are referencing the same data
715 object.
716 """
717 return _core_.Object_IsSameAs(*args, **kwargs)
718
719 ClassName = property(GetClassName,doc="See `GetClassName`")
720 _core_.Object_swigregister(Object)
721 _wxPySetDictionary = _core_._wxPySetDictionary
722 cvar = _core_.cvar
723 EmptyString = cvar.EmptyString
724
725 #---------------------------------------------------------------------------
726
727 BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
728 BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
729 BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
730 BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
731 BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
732 BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
733 BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
734 BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
735 BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
736 BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
737 BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
738 BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
739 BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
740 BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
741 BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
742 BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
743 BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
744 BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
745 BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
746 BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
747 BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
748 CURSOR_NONE = _core_.CURSOR_NONE
749 CURSOR_ARROW = _core_.CURSOR_ARROW
750 CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
751 CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
752 CURSOR_CHAR = _core_.CURSOR_CHAR
753 CURSOR_CROSS = _core_.CURSOR_CROSS
754 CURSOR_HAND = _core_.CURSOR_HAND
755 CURSOR_IBEAM = _core_.CURSOR_IBEAM
756 CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
757 CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
758 CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
759 CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
760 CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
761 CURSOR_PENCIL = _core_.CURSOR_PENCIL
762 CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
763 CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
764 CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
765 CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
766 CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
767 CURSOR_SIZENS = _core_.CURSOR_SIZENS
768 CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
769 CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
770 CURSOR_SIZING = _core_.CURSOR_SIZING
771 CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
772 CURSOR_WAIT = _core_.CURSOR_WAIT
773 CURSOR_WATCH = _core_.CURSOR_WATCH
774 CURSOR_BLANK = _core_.CURSOR_BLANK
775 CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
776 CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
777 CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
778 CURSOR_MAX = _core_.CURSOR_MAX
779 #---------------------------------------------------------------------------
780
781 class Size(object):
782 """
783 wx.Size is a useful data structure used to represent the size of
784 something. It simply contains integer width and height
785 properties. In most places in wxPython where a wx.Size is
786 expected a (width, height) tuple can be used instead.
787 """
788 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
789 __repr__ = _swig_repr
790 width = property(_core_.Size_width_get, _core_.Size_width_set)
791 height = property(_core_.Size_height_get, _core_.Size_height_set)
792 x = width; y = height
793 def __init__(self, *args, **kwargs):
794 """
795 __init__(self, int w=0, int h=0) -> Size
796
797 Creates a size object.
798 """
799 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
800 __swig_destroy__ = _core_.delete_Size
801 __del__ = lambda self : None;
802 def __eq__(*args, **kwargs):
803 """
804 __eq__(self, PyObject other) -> bool
805
806 Test for equality of wx.Size objects.
807 """
808 return _core_.Size___eq__(*args, **kwargs)
809
810 def __ne__(*args, **kwargs):
811 """
812 __ne__(self, PyObject other) -> bool
813
814 Test for inequality of wx.Size objects.
815 """
816 return _core_.Size___ne__(*args, **kwargs)
817
818 def __add__(*args, **kwargs):
819 """
820 __add__(self, Size sz) -> Size
821
822 Add sz's proprties to this and return the result.
823 """
824 return _core_.Size___add__(*args, **kwargs)
825
826 def __sub__(*args, **kwargs):
827 """
828 __sub__(self, Size sz) -> Size
829
830 Subtract sz's properties from this and return the result.
831 """
832 return _core_.Size___sub__(*args, **kwargs)
833
834 def IncTo(*args, **kwargs):
835 """
836 IncTo(self, Size sz)
837
838 Increments this object so that both of its dimensions are not less
839 than the corresponding dimensions of the size.
840 """
841 return _core_.Size_IncTo(*args, **kwargs)
842
843 def DecTo(*args, **kwargs):
844 """
845 DecTo(self, Size sz)
846
847 Decrements this object so that both of its dimensions are not greater
848 than the corresponding dimensions of the size.
849 """
850 return _core_.Size_DecTo(*args, **kwargs)
851
852 def IncBy(*args, **kwargs):
853 """IncBy(self, int dx, int dy)"""
854 return _core_.Size_IncBy(*args, **kwargs)
855
856 def DecBy(*args, **kwargs):
857 """DecBy(self, int dx, int dy)"""
858 return _core_.Size_DecBy(*args, **kwargs)
859
860 def Scale(*args, **kwargs):
861 """
862 Scale(self, float xscale, float yscale)
863
864 Scales the dimensions of this object by the given factors.
865 """
866 return _core_.Size_Scale(*args, **kwargs)
867
868 def Set(*args, **kwargs):
869 """
870 Set(self, int w, int h)
871
872 Set both width and height.
873 """
874 return _core_.Size_Set(*args, **kwargs)
875
876 def SetWidth(*args, **kwargs):
877 """SetWidth(self, int w)"""
878 return _core_.Size_SetWidth(*args, **kwargs)
879
880 def SetHeight(*args, **kwargs):
881 """SetHeight(self, int h)"""
882 return _core_.Size_SetHeight(*args, **kwargs)
883
884 def GetWidth(*args, **kwargs):
885 """GetWidth(self) -> int"""
886 return _core_.Size_GetWidth(*args, **kwargs)
887
888 def GetHeight(*args, **kwargs):
889 """GetHeight(self) -> int"""
890 return _core_.Size_GetHeight(*args, **kwargs)
891
892 def IsFullySpecified(*args, **kwargs):
893 """
894 IsFullySpecified(self) -> bool
895
896 Returns True if both components of the size are non-default values.
897 """
898 return _core_.Size_IsFullySpecified(*args, **kwargs)
899
900 def SetDefaults(*args, **kwargs):
901 """
902 SetDefaults(self, Size size)
903
904 Combine this size with the other one replacing the default components
905 of this object (i.e. equal to -1) with those of the other.
906 """
907 return _core_.Size_SetDefaults(*args, **kwargs)
908
909 def Get(*args, **kwargs):
910 """
911 Get() -> (width,height)
912
913 Returns the width and height properties as a tuple.
914 """
915 return _core_.Size_Get(*args, **kwargs)
916
917 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
918 def __str__(self): return str(self.Get())
919 def __repr__(self): return 'wx.Size'+str(self.Get())
920 def __len__(self): return len(self.Get())
921 def __getitem__(self, index): return self.Get()[index]
922 def __setitem__(self, index, val):
923 if index == 0: self.width = val
924 elif index == 1: self.height = val
925 else: raise IndexError
926 def __nonzero__(self): return self.Get() != (0,0)
927 __safe_for_unpickling__ = True
928 def __reduce__(self): return (wx.Size, self.Get())
929
930 _core_.Size_swigregister(Size)
931
932 #---------------------------------------------------------------------------
933
934 class RealPoint(object):
935 """
936 A data structure for representing a point or position with floating
937 point x and y properties. In wxPython most places that expect a
938 wx.RealPoint can also accept a (x,y) tuple.
939 """
940 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
941 __repr__ = _swig_repr
942 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
943 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
944 def __init__(self, *args, **kwargs):
945 """
946 __init__(self, double x=0.0, double y=0.0) -> RealPoint
947
948 Create a wx.RealPoint object
949 """
950 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
951 __swig_destroy__ = _core_.delete_RealPoint
952 __del__ = lambda self : None;
953 def __eq__(*args, **kwargs):
954 """
955 __eq__(self, PyObject other) -> bool
956
957 Test for equality of wx.RealPoint objects.
958 """
959 return _core_.RealPoint___eq__(*args, **kwargs)
960
961 def __ne__(*args, **kwargs):
962 """
963 __ne__(self, PyObject other) -> bool
964
965 Test for inequality of wx.RealPoint objects.
966 """
967 return _core_.RealPoint___ne__(*args, **kwargs)
968
969 def __add__(*args, **kwargs):
970 """
971 __add__(self, RealPoint pt) -> RealPoint
972
973 Add pt's proprties to this and return the result.
974 """
975 return _core_.RealPoint___add__(*args, **kwargs)
976
977 def __sub__(*args, **kwargs):
978 """
979 __sub__(self, RealPoint pt) -> RealPoint
980
981 Subtract pt's proprties from this and return the result
982 """
983 return _core_.RealPoint___sub__(*args, **kwargs)
984
985 def Set(*args, **kwargs):
986 """
987 Set(self, double x, double y)
988
989 Set both the x and y properties
990 """
991 return _core_.RealPoint_Set(*args, **kwargs)
992
993 def Get(*args, **kwargs):
994 """
995 Get() -> (x,y)
996
997 Return the x and y properties as a tuple.
998 """
999 return _core_.RealPoint_Get(*args, **kwargs)
1000
1001 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1002 def __str__(self): return str(self.Get())
1003 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
1004 def __len__(self): return len(self.Get())
1005 def __getitem__(self, index): return self.Get()[index]
1006 def __setitem__(self, index, val):
1007 if index == 0: self.x = val
1008 elif index == 1: self.y = val
1009 else: raise IndexError
1010 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1011 __safe_for_unpickling__ = True
1012 def __reduce__(self): return (wx.RealPoint, self.Get())
1013
1014 _core_.RealPoint_swigregister(RealPoint)
1015
1016 #---------------------------------------------------------------------------
1017
1018 class Point(object):
1019 """
1020 A data structure for representing a point or position with integer x
1021 and y properties. Most places in wxPython that expect a wx.Point can
1022 also accept a (x,y) tuple.
1023 """
1024 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1025 __repr__ = _swig_repr
1026 x = property(_core_.Point_x_get, _core_.Point_x_set)
1027 y = property(_core_.Point_y_get, _core_.Point_y_set)
1028 def __init__(self, *args, **kwargs):
1029 """
1030 __init__(self, int x=0, int y=0) -> Point
1031
1032 Create a wx.Point object
1033 """
1034 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1035 __swig_destroy__ = _core_.delete_Point
1036 __del__ = lambda self : None;
1037 def __eq__(*args, **kwargs):
1038 """
1039 __eq__(self, PyObject other) -> bool
1040
1041 Test for equality of wx.Point objects.
1042 """
1043 return _core_.Point___eq__(*args, **kwargs)
1044
1045 def __ne__(*args, **kwargs):
1046 """
1047 __ne__(self, PyObject other) -> bool
1048
1049 Test for inequality of wx.Point objects.
1050 """
1051 return _core_.Point___ne__(*args, **kwargs)
1052
1053 def __add__(*args, **kwargs):
1054 """
1055 __add__(self, Point pt) -> Point
1056
1057 Add pt's proprties to this and return the result.
1058 """
1059 return _core_.Point___add__(*args, **kwargs)
1060
1061 def __sub__(*args, **kwargs):
1062 """
1063 __sub__(self, Point pt) -> Point
1064
1065 Subtract pt's proprties from this and return the result
1066 """
1067 return _core_.Point___sub__(*args, **kwargs)
1068
1069 def __iadd__(*args, **kwargs):
1070 """
1071 __iadd__(self, Point pt) -> Point
1072
1073 Add pt to this object.
1074 """
1075 return _core_.Point___iadd__(*args, **kwargs)
1076
1077 def __isub__(*args, **kwargs):
1078 """
1079 __isub__(self, Point pt) -> Point
1080
1081 Subtract pt from this object.
1082 """
1083 return _core_.Point___isub__(*args, **kwargs)
1084
1085 def Set(*args, **kwargs):
1086 """
1087 Set(self, long x, long y)
1088
1089 Set both the x and y properties
1090 """
1091 return _core_.Point_Set(*args, **kwargs)
1092
1093 def Get(*args, **kwargs):
1094 """
1095 Get() -> (x,y)
1096
1097 Return the x and y properties as a tuple.
1098 """
1099 return _core_.Point_Get(*args, **kwargs)
1100
1101 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1102 def __str__(self): return str(self.Get())
1103 def __repr__(self): return 'wx.Point'+str(self.Get())
1104 def __len__(self): return len(self.Get())
1105 def __getitem__(self, index): return self.Get()[index]
1106 def __setitem__(self, index, val):
1107 if index == 0: self.x = val
1108 elif index == 1: self.y = val
1109 else: raise IndexError
1110 def __nonzero__(self): return self.Get() != (0,0)
1111 __safe_for_unpickling__ = True
1112 def __reduce__(self): return (wx.Point, self.Get())
1113
1114 _core_.Point_swigregister(Point)
1115
1116 #---------------------------------------------------------------------------
1117
1118 class Rect(object):
1119 """
1120 A class for representing and manipulating rectangles. It has x, y,
1121 width and height properties. In wxPython most palces that expect a
1122 wx.Rect can also accept a (x,y,width,height) tuple.
1123 """
1124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1125 __repr__ = _swig_repr
1126 def __init__(self, *args, **kwargs):
1127 """
1128 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1129
1130 Create a new Rect object.
1131 """
1132 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1133 __swig_destroy__ = _core_.delete_Rect
1134 __del__ = lambda self : None;
1135 def GetX(*args, **kwargs):
1136 """GetX(self) -> int"""
1137 return _core_.Rect_GetX(*args, **kwargs)
1138
1139 def SetX(*args, **kwargs):
1140 """SetX(self, int x)"""
1141 return _core_.Rect_SetX(*args, **kwargs)
1142
1143 def GetY(*args, **kwargs):
1144 """GetY(self) -> int"""
1145 return _core_.Rect_GetY(*args, **kwargs)
1146
1147 def SetY(*args, **kwargs):
1148 """SetY(self, int y)"""
1149 return _core_.Rect_SetY(*args, **kwargs)
1150
1151 def GetWidth(*args, **kwargs):
1152 """GetWidth(self) -> int"""
1153 return _core_.Rect_GetWidth(*args, **kwargs)
1154
1155 def SetWidth(*args, **kwargs):
1156 """SetWidth(self, int w)"""
1157 return _core_.Rect_SetWidth(*args, **kwargs)
1158
1159 def GetHeight(*args, **kwargs):
1160 """GetHeight(self) -> int"""
1161 return _core_.Rect_GetHeight(*args, **kwargs)
1162
1163 def SetHeight(*args, **kwargs):
1164 """SetHeight(self, int h)"""
1165 return _core_.Rect_SetHeight(*args, **kwargs)
1166
1167 def GetPosition(*args, **kwargs):
1168 """GetPosition(self) -> Point"""
1169 return _core_.Rect_GetPosition(*args, **kwargs)
1170
1171 def SetPosition(*args, **kwargs):
1172 """SetPosition(self, Point p)"""
1173 return _core_.Rect_SetPosition(*args, **kwargs)
1174
1175 def GetSize(*args, **kwargs):
1176 """GetSize(self) -> Size"""
1177 return _core_.Rect_GetSize(*args, **kwargs)
1178
1179 def SetSize(*args, **kwargs):
1180 """SetSize(self, Size s)"""
1181 return _core_.Rect_SetSize(*args, **kwargs)
1182
1183 def IsEmpty(*args, **kwargs):
1184 """IsEmpty(self) -> bool"""
1185 return _core_.Rect_IsEmpty(*args, **kwargs)
1186
1187 def GetTopLeft(*args, **kwargs):
1188 """GetTopLeft(self) -> Point"""
1189 return _core_.Rect_GetTopLeft(*args, **kwargs)
1190
1191 def SetTopLeft(*args, **kwargs):
1192 """SetTopLeft(self, Point p)"""
1193 return _core_.Rect_SetTopLeft(*args, **kwargs)
1194
1195 def GetBottomRight(*args, **kwargs):
1196 """GetBottomRight(self) -> Point"""
1197 return _core_.Rect_GetBottomRight(*args, **kwargs)
1198
1199 def SetBottomRight(*args, **kwargs):
1200 """SetBottomRight(self, Point p)"""
1201 return _core_.Rect_SetBottomRight(*args, **kwargs)
1202
1203 def GetTopRight(*args, **kwargs):
1204 """GetTopRight(self) -> Point"""
1205 return _core_.Rect_GetTopRight(*args, **kwargs)
1206
1207 def SetTopRight(*args, **kwargs):
1208 """SetTopRight(self, Point p)"""
1209 return _core_.Rect_SetTopRight(*args, **kwargs)
1210
1211 def GetBottomLeft(*args, **kwargs):
1212 """GetBottomLeft(self) -> Point"""
1213 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1214
1215 def SetBottomLeft(*args, **kwargs):
1216 """SetBottomLeft(self, Point p)"""
1217 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1218
1219 def GetLeft(*args, **kwargs):
1220 """GetLeft(self) -> int"""
1221 return _core_.Rect_GetLeft(*args, **kwargs)
1222
1223 def GetTop(*args, **kwargs):
1224 """GetTop(self) -> int"""
1225 return _core_.Rect_GetTop(*args, **kwargs)
1226
1227 def GetBottom(*args, **kwargs):
1228 """GetBottom(self) -> int"""
1229 return _core_.Rect_GetBottom(*args, **kwargs)
1230
1231 def GetRight(*args, **kwargs):
1232 """GetRight(self) -> int"""
1233 return _core_.Rect_GetRight(*args, **kwargs)
1234
1235 def SetLeft(*args, **kwargs):
1236 """SetLeft(self, int left)"""
1237 return _core_.Rect_SetLeft(*args, **kwargs)
1238
1239 def SetRight(*args, **kwargs):
1240 """SetRight(self, int right)"""
1241 return _core_.Rect_SetRight(*args, **kwargs)
1242
1243 def SetTop(*args, **kwargs):
1244 """SetTop(self, int top)"""
1245 return _core_.Rect_SetTop(*args, **kwargs)
1246
1247 def SetBottom(*args, **kwargs):
1248 """SetBottom(self, int bottom)"""
1249 return _core_.Rect_SetBottom(*args, **kwargs)
1250
1251 position = property(GetPosition, SetPosition)
1252 size = property(GetSize, SetSize)
1253 left = property(GetLeft, SetLeft)
1254 right = property(GetRight, SetRight)
1255 top = property(GetTop, SetTop)
1256 bottom = property(GetBottom, SetBottom)
1257
1258 def Inflate(*args, **kwargs):
1259 """
1260 Inflate(self, int dx, int dy) -> Rect
1261
1262 Increases the size of the rectangle.
1263
1264 The left border is moved farther left and the right border is moved
1265 farther right by ``dx``. The upper border is moved farther up and the
1266 bottom border is moved farther down by ``dy``. (Note the the width and
1267 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1268 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1269 opposite happens: the rectangle size decreases in the respective
1270 direction.
1271
1272 The change is made to the rectangle inplace, if instead you need a
1273 copy that is inflated, preserving the original then make the copy
1274 first::
1275
1276 copy = wx.Rect(*original)
1277 copy.Inflate(10,15)
1278
1279
1280 """
1281 return _core_.Rect_Inflate(*args, **kwargs)
1282
1283 def Deflate(*args, **kwargs):
1284 """
1285 Deflate(self, int dx, int dy) -> Rect
1286
1287 Decrease the rectangle size. This method is the opposite of `Inflate`
1288 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1289 `Inflate` for a full description.
1290 """
1291 return _core_.Rect_Deflate(*args, **kwargs)
1292
1293 def OffsetXY(*args, **kwargs):
1294 """
1295 OffsetXY(self, int dx, int dy)
1296
1297 Moves the rectangle by the specified offset. If dx is positive, the
1298 rectangle is moved to the right, if dy is positive, it is moved to the
1299 bottom, otherwise it is moved to the left or top respectively.
1300 """
1301 return _core_.Rect_OffsetXY(*args, **kwargs)
1302
1303 def Offset(*args, **kwargs):
1304 """
1305 Offset(self, Point pt)
1306
1307 Same as `OffsetXY` but uses dx,dy from Point
1308 """
1309 return _core_.Rect_Offset(*args, **kwargs)
1310
1311 def Intersect(*args, **kwargs):
1312 """
1313 Intersect(self, Rect rect) -> Rect
1314
1315 Returns the intersectsion of this rectangle and rect.
1316 """
1317 return _core_.Rect_Intersect(*args, **kwargs)
1318
1319 def Union(*args, **kwargs):
1320 """
1321 Union(self, Rect rect) -> Rect
1322
1323 Returns the union of this rectangle and rect.
1324 """
1325 return _core_.Rect_Union(*args, **kwargs)
1326
1327 def __add__(*args, **kwargs):
1328 """
1329 __add__(self, Rect rect) -> Rect
1330
1331 Add the properties of rect to this rectangle and return the result.
1332 """
1333 return _core_.Rect___add__(*args, **kwargs)
1334
1335 def __iadd__(*args, **kwargs):
1336 """
1337 __iadd__(self, Rect rect) -> Rect
1338
1339 Add the properties of rect to this rectangle, updating this rectangle.
1340 """
1341 return _core_.Rect___iadd__(*args, **kwargs)
1342
1343 def __eq__(*args, **kwargs):
1344 """
1345 __eq__(self, PyObject other) -> bool
1346
1347 Test for equality of wx.Rect objects.
1348 """
1349 return _core_.Rect___eq__(*args, **kwargs)
1350
1351 def __ne__(*args, **kwargs):
1352 """
1353 __ne__(self, PyObject other) -> bool
1354
1355 Test for inequality of wx.Rect objects.
1356 """
1357 return _core_.Rect___ne__(*args, **kwargs)
1358
1359 def ContainsXY(*args, **kwargs):
1360 """
1361 ContainsXY(self, int x, int y) -> bool
1362
1363 Return True if the point is inside the rect.
1364 """
1365 return _core_.Rect_ContainsXY(*args, **kwargs)
1366
1367 def Contains(*args, **kwargs):
1368 """
1369 Contains(self, Point pt) -> bool
1370
1371 Return True if the point is inside the rect.
1372 """
1373 return _core_.Rect_Contains(*args, **kwargs)
1374
1375 def ContainsRect(*args, **kwargs):
1376 """
1377 ContainsRect(self, Rect rect) -> bool
1378
1379 Returns ``True`` if the given rectangle is completely inside this
1380 rectangle or touches its boundary.
1381 """
1382 return _core_.Rect_ContainsRect(*args, **kwargs)
1383
1384 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1385 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1386 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1387 Inside = Contains
1388 InsideXY = ContainsXY
1389 InsideRect = ContainsRect
1390
1391 def Intersects(*args, **kwargs):
1392 """
1393 Intersects(self, Rect rect) -> bool
1394
1395 Returns True if the rectangles have a non empty intersection.
1396 """
1397 return _core_.Rect_Intersects(*args, **kwargs)
1398
1399 def CenterIn(*args, **kwargs):
1400 """
1401 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1402
1403 Center this rectangle within the one passed to the method, which is
1404 usually, but not necessarily, the larger one.
1405 """
1406 return _core_.Rect_CenterIn(*args, **kwargs)
1407
1408 CentreIn = CenterIn
1409 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1410 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1411 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1412 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1413 def Set(*args, **kwargs):
1414 """
1415 Set(self, int x=0, int y=0, int width=0, int height=0)
1416
1417 Set all rectangle properties.
1418 """
1419 return _core_.Rect_Set(*args, **kwargs)
1420
1421 def Get(*args, **kwargs):
1422 """
1423 Get() -> (x,y,width,height)
1424
1425 Return the rectangle properties as a tuple.
1426 """
1427 return _core_.Rect_Get(*args, **kwargs)
1428
1429 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1430 def __str__(self): return str(self.Get())
1431 def __repr__(self): return 'wx.Rect'+str(self.Get())
1432 def __len__(self): return len(self.Get())
1433 def __getitem__(self, index): return self.Get()[index]
1434 def __setitem__(self, index, val):
1435 if index == 0: self.x = val
1436 elif index == 1: self.y = val
1437 elif index == 2: self.width = val
1438 elif index == 3: self.height = val
1439 else: raise IndexError
1440 def __nonzero__(self): return self.Get() != (0,0,0,0)
1441 __safe_for_unpickling__ = True
1442 def __reduce__(self): return (wx.Rect, self.Get())
1443
1444 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1445 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1446 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
1447 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1448 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1449 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1450 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1451 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1452 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1453 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1454 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
1455 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1456 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1457 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1458 Empty = property(IsEmpty,doc="See `IsEmpty`")
1459 _core_.Rect_swigregister(Rect)
1460
1461 def RectPP(*args, **kwargs):
1462 """
1463 RectPP(Point topLeft, Point bottomRight) -> Rect
1464
1465 Create a new Rect object from Points representing two corners.
1466 """
1467 val = _core_.new_RectPP(*args, **kwargs)
1468 return val
1469
1470 def RectPS(*args, **kwargs):
1471 """
1472 RectPS(Point pos, Size size) -> Rect
1473
1474 Create a new Rect from a position and size.
1475 """
1476 val = _core_.new_RectPS(*args, **kwargs)
1477 return val
1478
1479 def RectS(*args, **kwargs):
1480 """
1481 RectS(Size size) -> Rect
1482
1483 Create a new Rect from a size only.
1484 """
1485 val = _core_.new_RectS(*args, **kwargs)
1486 return val
1487
1488
1489 def IntersectRect(*args, **kwargs):
1490 """
1491 IntersectRect(Rect r1, Rect r2) -> Rect
1492
1493 Calculate and return the intersection of r1 and r2.
1494 """
1495 return _core_.IntersectRect(*args, **kwargs)
1496 #---------------------------------------------------------------------------
1497
1498 class Point2D(object):
1499 """
1500 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1501 with floating point values.
1502 """
1503 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1504 __repr__ = _swig_repr
1505 def __init__(self, *args, **kwargs):
1506 """
1507 __init__(self, double x=0.0, double y=0.0) -> Point2D
1508
1509 Create a w.Point2D object.
1510 """
1511 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1512 __swig_destroy__ = _core_.delete_Point2D
1513 __del__ = lambda self : None;
1514 def GetFloor(*args, **kwargs):
1515 """
1516 GetFloor() -> (x,y)
1517
1518 Convert to integer
1519 """
1520 return _core_.Point2D_GetFloor(*args, **kwargs)
1521
1522 def GetRounded(*args, **kwargs):
1523 """
1524 GetRounded() -> (x,y)
1525
1526 Convert to integer
1527 """
1528 return _core_.Point2D_GetRounded(*args, **kwargs)
1529
1530 def GetVectorLength(*args, **kwargs):
1531 """GetVectorLength(self) -> double"""
1532 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1533
1534 def GetVectorAngle(*args, **kwargs):
1535 """GetVectorAngle(self) -> double"""
1536 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1537
1538 def SetVectorLength(*args, **kwargs):
1539 """SetVectorLength(self, double length)"""
1540 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1541
1542 def SetVectorAngle(*args, **kwargs):
1543 """SetVectorAngle(self, double degrees)"""
1544 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1545
1546 def SetPolarCoordinates(self, angle, length):
1547 self.SetVectorLength(length)
1548 self.SetVectorAngle(angle)
1549 def Normalize(self):
1550 self.SetVectorLength(1.0)
1551
1552 def GetDistance(*args, **kwargs):
1553 """GetDistance(self, Point2D pt) -> double"""
1554 return _core_.Point2D_GetDistance(*args, **kwargs)
1555
1556 def GetDistanceSquare(*args, **kwargs):
1557 """GetDistanceSquare(self, Point2D pt) -> double"""
1558 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1559
1560 def GetDotProduct(*args, **kwargs):
1561 """GetDotProduct(self, Point2D vec) -> double"""
1562 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1563
1564 def GetCrossProduct(*args, **kwargs):
1565 """GetCrossProduct(self, Point2D vec) -> double"""
1566 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1567
1568 def __neg__(*args, **kwargs):
1569 """
1570 __neg__(self) -> Point2D
1571
1572 the reflection of this point
1573 """
1574 return _core_.Point2D___neg__(*args, **kwargs)
1575
1576 def __iadd__(*args, **kwargs):
1577 """__iadd__(self, Point2D pt) -> Point2D"""
1578 return _core_.Point2D___iadd__(*args, **kwargs)
1579
1580 def __isub__(*args, **kwargs):
1581 """__isub__(self, Point2D pt) -> Point2D"""
1582 return _core_.Point2D___isub__(*args, **kwargs)
1583
1584 def __imul__(*args, **kwargs):
1585 """__imul__(self, Point2D pt) -> Point2D"""
1586 return _core_.Point2D___imul__(*args, **kwargs)
1587
1588 def __idiv__(*args, **kwargs):
1589 """__idiv__(self, Point2D pt) -> Point2D"""
1590 return _core_.Point2D___idiv__(*args, **kwargs)
1591
1592 def __eq__(*args, **kwargs):
1593 """
1594 __eq__(self, PyObject other) -> bool
1595
1596 Test for equality of wx.Point2D objects.
1597 """
1598 return _core_.Point2D___eq__(*args, **kwargs)
1599
1600 def __ne__(*args, **kwargs):
1601 """
1602 __ne__(self, PyObject other) -> bool
1603
1604 Test for inequality of wx.Point2D objects.
1605 """
1606 return _core_.Point2D___ne__(*args, **kwargs)
1607
1608 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1609 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1610 def Set(*args, **kwargs):
1611 """Set(self, double x=0, double y=0)"""
1612 return _core_.Point2D_Set(*args, **kwargs)
1613
1614 def Get(*args, **kwargs):
1615 """
1616 Get() -> (x,y)
1617
1618 Return x and y properties as a tuple.
1619 """
1620 return _core_.Point2D_Get(*args, **kwargs)
1621
1622 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1623 def __str__(self): return str(self.Get())
1624 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1625 def __len__(self): return len(self.Get())
1626 def __getitem__(self, index): return self.Get()[index]
1627 def __setitem__(self, index, val):
1628 if index == 0: self.x = val
1629 elif index == 1: self.y = val
1630 else: raise IndexError
1631 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1632 __safe_for_unpickling__ = True
1633 def __reduce__(self): return (wx.Point2D, self.Get())
1634
1635 Floor = property(GetFloor,doc="See `GetFloor`")
1636 Rounded = property(GetRounded,doc="See `GetRounded`")
1637 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1638 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1639 _core_.Point2D_swigregister(Point2D)
1640
1641 def Point2DCopy(*args, **kwargs):
1642 """
1643 Point2DCopy(Point2D pt) -> Point2D
1644
1645 Create a w.Point2D object.
1646 """
1647 val = _core_.new_Point2DCopy(*args, **kwargs)
1648 return val
1649
1650 def Point2DFromPoint(*args, **kwargs):
1651 """
1652 Point2DFromPoint(Point pt) -> Point2D
1653
1654 Create a w.Point2D object.
1655 """
1656 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1657 return val
1658
1659 #---------------------------------------------------------------------------
1660
1661 Inside = _core_.Inside
1662 OutLeft = _core_.OutLeft
1663 OutRight = _core_.OutRight
1664 OutTop = _core_.OutTop
1665 OutBottom = _core_.OutBottom
1666 class Rect2D(object):
1667 """
1668 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1669 with floating point component values.
1670 """
1671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1672 __repr__ = _swig_repr
1673 def __init__(self, *args, **kwargs):
1674 """
1675 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1676
1677 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1678 with floating point component values.
1679 """
1680 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1681 __swig_destroy__ = _core_.delete_Rect2D
1682 __del__ = lambda self : None;
1683 def GetPosition(*args, **kwargs):
1684 """GetPosition(self) -> Point2D"""
1685 return _core_.Rect2D_GetPosition(*args, **kwargs)
1686
1687 def GetSize(*args, **kwargs):
1688 """GetSize(self) -> Size"""
1689 return _core_.Rect2D_GetSize(*args, **kwargs)
1690
1691 def GetLeft(*args, **kwargs):
1692 """GetLeft(self) -> wxDouble"""
1693 return _core_.Rect2D_GetLeft(*args, **kwargs)
1694
1695 def SetLeft(*args, **kwargs):
1696 """SetLeft(self, wxDouble n)"""
1697 return _core_.Rect2D_SetLeft(*args, **kwargs)
1698
1699 def MoveLeftTo(*args, **kwargs):
1700 """MoveLeftTo(self, wxDouble n)"""
1701 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1702
1703 def GetTop(*args, **kwargs):
1704 """GetTop(self) -> wxDouble"""
1705 return _core_.Rect2D_GetTop(*args, **kwargs)
1706
1707 def SetTop(*args, **kwargs):
1708 """SetTop(self, wxDouble n)"""
1709 return _core_.Rect2D_SetTop(*args, **kwargs)
1710
1711 def MoveTopTo(*args, **kwargs):
1712 """MoveTopTo(self, wxDouble n)"""
1713 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1714
1715 def GetBottom(*args, **kwargs):
1716 """GetBottom(self) -> wxDouble"""
1717 return _core_.Rect2D_GetBottom(*args, **kwargs)
1718
1719 def SetBottom(*args, **kwargs):
1720 """SetBottom(self, wxDouble n)"""
1721 return _core_.Rect2D_SetBottom(*args, **kwargs)
1722
1723 def MoveBottomTo(*args, **kwargs):
1724 """MoveBottomTo(self, wxDouble n)"""
1725 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1726
1727 def GetRight(*args, **kwargs):
1728 """GetRight(self) -> wxDouble"""
1729 return _core_.Rect2D_GetRight(*args, **kwargs)
1730
1731 def SetRight(*args, **kwargs):
1732 """SetRight(self, wxDouble n)"""
1733 return _core_.Rect2D_SetRight(*args, **kwargs)
1734
1735 def MoveRightTo(*args, **kwargs):
1736 """MoveRightTo(self, wxDouble n)"""
1737 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1738
1739 def GetLeftTop(*args, **kwargs):
1740 """GetLeftTop(self) -> Point2D"""
1741 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1742
1743 def SetLeftTop(*args, **kwargs):
1744 """SetLeftTop(self, Point2D pt)"""
1745 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1746
1747 def MoveLeftTopTo(*args, **kwargs):
1748 """MoveLeftTopTo(self, Point2D pt)"""
1749 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1750
1751 def GetLeftBottom(*args, **kwargs):
1752 """GetLeftBottom(self) -> Point2D"""
1753 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1754
1755 def SetLeftBottom(*args, **kwargs):
1756 """SetLeftBottom(self, Point2D pt)"""
1757 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1758
1759 def MoveLeftBottomTo(*args, **kwargs):
1760 """MoveLeftBottomTo(self, Point2D pt)"""
1761 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1762
1763 def GetRightTop(*args, **kwargs):
1764 """GetRightTop(self) -> Point2D"""
1765 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1766
1767 def SetRightTop(*args, **kwargs):
1768 """SetRightTop(self, Point2D pt)"""
1769 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1770
1771 def MoveRightTopTo(*args, **kwargs):
1772 """MoveRightTopTo(self, Point2D pt)"""
1773 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1774
1775 def GetRightBottom(*args, **kwargs):
1776 """GetRightBottom(self) -> Point2D"""
1777 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1778
1779 def SetRightBottom(*args, **kwargs):
1780 """SetRightBottom(self, Point2D pt)"""
1781 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1782
1783 def MoveRightBottomTo(*args, **kwargs):
1784 """MoveRightBottomTo(self, Point2D pt)"""
1785 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1786
1787 def GetCentre(*args, **kwargs):
1788 """GetCentre(self) -> Point2D"""
1789 return _core_.Rect2D_GetCentre(*args, **kwargs)
1790
1791 def SetCentre(*args, **kwargs):
1792 """SetCentre(self, Point2D pt)"""
1793 return _core_.Rect2D_SetCentre(*args, **kwargs)
1794
1795 def MoveCentreTo(*args, **kwargs):
1796 """MoveCentreTo(self, Point2D pt)"""
1797 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1798
1799 def GetOutcode(*args, **kwargs):
1800 """GetOutcode(self, Point2D pt) -> int"""
1801 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1802
1803 def Contains(*args, **kwargs):
1804 """Contains(self, Point2D pt) -> bool"""
1805 return _core_.Rect2D_Contains(*args, **kwargs)
1806
1807 def ContainsRect(*args, **kwargs):
1808 """ContainsRect(self, Rect2D rect) -> bool"""
1809 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1810
1811 def IsEmpty(*args, **kwargs):
1812 """IsEmpty(self) -> bool"""
1813 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1814
1815 def HaveEqualSize(*args, **kwargs):
1816 """HaveEqualSize(self, Rect2D rect) -> bool"""
1817 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1818
1819 def Inset(*args):
1820 """
1821 Inset(self, wxDouble x, wxDouble y)
1822 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1823 """
1824 return _core_.Rect2D_Inset(*args)
1825
1826 def Offset(*args, **kwargs):
1827 """Offset(self, Point2D pt)"""
1828 return _core_.Rect2D_Offset(*args, **kwargs)
1829
1830 def ConstrainTo(*args, **kwargs):
1831 """ConstrainTo(self, Rect2D rect)"""
1832 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1833
1834 def Interpolate(*args, **kwargs):
1835 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1836 return _core_.Rect2D_Interpolate(*args, **kwargs)
1837
1838 def Intersect(*args, **kwargs):
1839 """Intersect(self, Rect2D otherRect)"""
1840 return _core_.Rect2D_Intersect(*args, **kwargs)
1841
1842 def CreateIntersection(*args, **kwargs):
1843 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1844 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1845
1846 def Intersects(*args, **kwargs):
1847 """Intersects(self, Rect2D rect) -> bool"""
1848 return _core_.Rect2D_Intersects(*args, **kwargs)
1849
1850 def Union(*args, **kwargs):
1851 """Union(self, Rect2D otherRect)"""
1852 return _core_.Rect2D_Union(*args, **kwargs)
1853
1854 def CreateUnion(*args, **kwargs):
1855 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1856 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1857
1858 def Scale(*args):
1859 """
1860 Scale(self, wxDouble f)
1861 Scale(self, int num, int denum)
1862 """
1863 return _core_.Rect2D_Scale(*args)
1864
1865 def __eq__(*args, **kwargs):
1866 """
1867 __eq__(self, PyObject other) -> bool
1868
1869 Test for equality of wx.Rect2D objects.
1870 """
1871 return _core_.Rect2D___eq__(*args, **kwargs)
1872
1873 def __ne__(*args, **kwargs):
1874 """
1875 __ne__(self, PyObject other) -> bool
1876
1877 Test for inequality of wx.Rect2D objects.
1878 """
1879 return _core_.Rect2D___ne__(*args, **kwargs)
1880
1881 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1882 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1883 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1884 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1885 def Set(*args, **kwargs):
1886 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1887 return _core_.Rect2D_Set(*args, **kwargs)
1888
1889 def Get(*args, **kwargs):
1890 """
1891 Get() -> (x,y, width, height)
1892
1893 Return x, y, width and height y properties as a tuple.
1894 """
1895 return _core_.Rect2D_Get(*args, **kwargs)
1896
1897 def __str__(self): return str(self.Get())
1898 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1899 def __len__(self): return len(self.Get())
1900 def __getitem__(self, index): return self.Get()[index]
1901 def __setitem__(self, index, val):
1902 if index == 0: self.x = val
1903 elif index == 1: self.y = val
1904 elif index == 2: self.width = val
1905 elif index == 3: self.height = val
1906 else: raise IndexError
1907 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1908 __safe_for_unpickling__ = True
1909 def __reduce__(self): return (wx.Rect2D, self.Get())
1910
1911 _core_.Rect2D_swigregister(Rect2D)
1912
1913 class Position(object):
1914 """Proxy of C++ Position class"""
1915 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1916 __repr__ = _swig_repr
1917 def __init__(self, *args, **kwargs):
1918 """__init__(self, int row=0, int col=0) -> Position"""
1919 _core_.Position_swiginit(self,_core_.new_Position(*args, **kwargs))
1920 __swig_destroy__ = _core_.delete_Position
1921 __del__ = lambda self : None;
1922 def GetRow(*args, **kwargs):
1923 """GetRow(self) -> int"""
1924 return _core_.Position_GetRow(*args, **kwargs)
1925
1926 def GetColumn(*args, **kwargs):
1927 """GetColumn(self) -> int"""
1928 return _core_.Position_GetColumn(*args, **kwargs)
1929
1930 def GetCol(*args, **kwargs):
1931 """GetCol(self) -> int"""
1932 return _core_.Position_GetCol(*args, **kwargs)
1933
1934 def SetRow(*args, **kwargs):
1935 """SetRow(self, int row)"""
1936 return _core_.Position_SetRow(*args, **kwargs)
1937
1938 def SetColumn(*args, **kwargs):
1939 """SetColumn(self, int column)"""
1940 return _core_.Position_SetColumn(*args, **kwargs)
1941
1942 def SetCol(*args, **kwargs):
1943 """SetCol(self, int column)"""
1944 return _core_.Position_SetCol(*args, **kwargs)
1945
1946 def __eq__(*args, **kwargs):
1947 """
1948 __eq__(self, PyObject other) -> bool
1949
1950 Test for equality of wx.Position objects.
1951 """
1952 return _core_.Position___eq__(*args, **kwargs)
1953
1954 def __ne__(*args, **kwargs):
1955 """
1956 __ne__(self, PyObject other) -> bool
1957
1958 Test for inequality of wx.Position objects.
1959 """
1960 return _core_.Position___ne__(*args, **kwargs)
1961
1962 def __add__(*args):
1963 """
1964 __add__(self, Position p) -> Position
1965 __add__(self, Size s) -> Position
1966 """
1967 return _core_.Position___add__(*args)
1968
1969 def __sub__(*args):
1970 """
1971 __sub__(self, Position p) -> Position
1972 __sub__(self, Size s) -> Position
1973 """
1974 return _core_.Position___sub__(*args)
1975
1976 row = property(GetRow,SetRow)
1977 col = property(GetCol,SetCol)
1978 _core_.Position_swigregister(Position)
1979
1980 #---------------------------------------------------------------------------
1981
1982 FromStart = _core_.FromStart
1983 FromCurrent = _core_.FromCurrent
1984 FromEnd = _core_.FromEnd
1985 class InputStream(object):
1986 """Proxy of C++ InputStream class"""
1987 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1988 __repr__ = _swig_repr
1989 def __init__(self, *args, **kwargs):
1990 """__init__(self, PyObject p) -> InputStream"""
1991 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1992 __swig_destroy__ = _core_.delete_InputStream
1993 __del__ = lambda self : None;
1994 def close(*args, **kwargs):
1995 """close(self)"""
1996 return _core_.InputStream_close(*args, **kwargs)
1997
1998 def flush(*args, **kwargs):
1999 """flush(self)"""
2000 return _core_.InputStream_flush(*args, **kwargs)
2001
2002 def eof(*args, **kwargs):
2003 """eof(self) -> bool"""
2004 return _core_.InputStream_eof(*args, **kwargs)
2005
2006 def read(*args, **kwargs):
2007 """read(self, int size=-1) -> PyObject"""
2008 return _core_.InputStream_read(*args, **kwargs)
2009
2010 def readline(*args, **kwargs):
2011 """readline(self, int size=-1) -> PyObject"""
2012 return _core_.InputStream_readline(*args, **kwargs)
2013
2014 def readlines(*args, **kwargs):
2015 """readlines(self, int sizehint=-1) -> PyObject"""
2016 return _core_.InputStream_readlines(*args, **kwargs)
2017
2018 def seek(*args, **kwargs):
2019 """seek(self, int offset, int whence=0)"""
2020 return _core_.InputStream_seek(*args, **kwargs)
2021
2022 def tell(*args, **kwargs):
2023 """tell(self) -> int"""
2024 return _core_.InputStream_tell(*args, **kwargs)
2025
2026 def Peek(*args, **kwargs):
2027 """Peek(self) -> char"""
2028 return _core_.InputStream_Peek(*args, **kwargs)
2029
2030 def GetC(*args, **kwargs):
2031 """GetC(self) -> char"""
2032 return _core_.InputStream_GetC(*args, **kwargs)
2033
2034 def LastRead(*args, **kwargs):
2035 """LastRead(self) -> size_t"""
2036 return _core_.InputStream_LastRead(*args, **kwargs)
2037
2038 def CanRead(*args, **kwargs):
2039 """CanRead(self) -> bool"""
2040 return _core_.InputStream_CanRead(*args, **kwargs)
2041
2042 def Eof(*args, **kwargs):
2043 """Eof(self) -> bool"""
2044 return _core_.InputStream_Eof(*args, **kwargs)
2045
2046 def Ungetch(*args, **kwargs):
2047 """Ungetch(self, char c) -> bool"""
2048 return _core_.InputStream_Ungetch(*args, **kwargs)
2049
2050 def SeekI(*args, **kwargs):
2051 """SeekI(self, long pos, int mode=FromStart) -> long"""
2052 return _core_.InputStream_SeekI(*args, **kwargs)
2053
2054 def TellI(*args, **kwargs):
2055 """TellI(self) -> long"""
2056 return _core_.InputStream_TellI(*args, **kwargs)
2057
2058 _core_.InputStream_swigregister(InputStream)
2059 DefaultPosition = cvar.DefaultPosition
2060 DefaultSize = cvar.DefaultSize
2061
2062 class OutputStream(object):
2063 """Proxy of C++ OutputStream class"""
2064 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2065 def __init__(self): raise AttributeError, "No constructor defined"
2066 __repr__ = _swig_repr
2067 def write(*args, **kwargs):
2068 """write(self, PyObject obj)"""
2069 return _core_.OutputStream_write(*args, **kwargs)
2070
2071 def LastWrite(*args, **kwargs):
2072 """LastWrite(self) -> size_t"""
2073 return _core_.OutputStream_LastWrite(*args, **kwargs)
2074
2075 _core_.OutputStream_swigregister(OutputStream)
2076
2077 #---------------------------------------------------------------------------
2078
2079 class FSFile(Object):
2080 """Proxy of C++ FSFile class"""
2081 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2082 __repr__ = _swig_repr
2083 def __init__(self, *args, **kwargs):
2084 """
2085 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2086 DateTime modif) -> FSFile
2087 """
2088 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
2089 __swig_destroy__ = _core_.delete_FSFile
2090 __del__ = lambda self : None;
2091 def GetStream(*args, **kwargs):
2092 """GetStream(self) -> InputStream"""
2093 return _core_.FSFile_GetStream(*args, **kwargs)
2094
2095 def DetachStream(*args, **kwargs):
2096 """DetachStream(self)"""
2097 return _core_.FSFile_DetachStream(*args, **kwargs)
2098
2099 def GetMimeType(*args, **kwargs):
2100 """GetMimeType(self) -> String"""
2101 return _core_.FSFile_GetMimeType(*args, **kwargs)
2102
2103 def GetLocation(*args, **kwargs):
2104 """GetLocation(self) -> String"""
2105 return _core_.FSFile_GetLocation(*args, **kwargs)
2106
2107 def GetAnchor(*args, **kwargs):
2108 """GetAnchor(self) -> String"""
2109 return _core_.FSFile_GetAnchor(*args, **kwargs)
2110
2111 def GetModificationTime(*args, **kwargs):
2112 """GetModificationTime(self) -> DateTime"""
2113 return _core_.FSFile_GetModificationTime(*args, **kwargs)
2114
2115 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2116 Location = property(GetLocation,doc="See `GetLocation`")
2117 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2118 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2119 Stream = property(GetStream,doc="See `GetStream`")
2120 _core_.FSFile_swigregister(FSFile)
2121
2122 class CPPFileSystemHandler(object):
2123 """Proxy of C++ CPPFileSystemHandler class"""
2124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125 def __init__(self): raise AttributeError, "No constructor defined"
2126 __repr__ = _swig_repr
2127 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2128 __del__ = lambda self : None;
2129 _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
2130
2131 class FileSystemHandler(CPPFileSystemHandler):
2132 """Proxy of C++ FileSystemHandler class"""
2133 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2134 __repr__ = _swig_repr
2135 def __init__(self, *args, **kwargs):
2136 """__init__(self) -> FileSystemHandler"""
2137 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
2138 FileSystemHandler._setCallbackInfo(self, self, FileSystemHandler)
2139
2140 def _setCallbackInfo(*args, **kwargs):
2141 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2142 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
2143
2144 def CanOpen(*args, **kwargs):
2145 """CanOpen(self, String location) -> bool"""
2146 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
2147
2148 def OpenFile(*args, **kwargs):
2149 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2150 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
2151
2152 def FindFirst(*args, **kwargs):
2153 """FindFirst(self, String spec, int flags=0) -> String"""
2154 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
2155
2156 def FindNext(*args, **kwargs):
2157 """FindNext(self) -> String"""
2158 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
2159
2160 def GetProtocol(*args, **kwargs):
2161 """GetProtocol(self, String location) -> String"""
2162 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
2163
2164 def GetLeftLocation(*args, **kwargs):
2165 """GetLeftLocation(self, String location) -> String"""
2166 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
2167
2168 def GetAnchor(*args, **kwargs):
2169 """GetAnchor(self, String location) -> String"""
2170 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
2171
2172 def GetRightLocation(*args, **kwargs):
2173 """GetRightLocation(self, String location) -> String"""
2174 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
2175
2176 def GetMimeTypeFromExt(*args, **kwargs):
2177 """GetMimeTypeFromExt(self, String location) -> String"""
2178 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
2179
2180 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2181 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2182 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2183 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2184 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2185 _core_.FileSystemHandler_swigregister(FileSystemHandler)
2186
2187 class FileSystem(Object):
2188 """Proxy of C++ FileSystem class"""
2189 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2190 __repr__ = _swig_repr
2191 def __init__(self, *args, **kwargs):
2192 """__init__(self) -> FileSystem"""
2193 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2194 __swig_destroy__ = _core_.delete_FileSystem
2195 __del__ = lambda self : None;
2196 def ChangePathTo(*args, **kwargs):
2197 """ChangePathTo(self, String location, bool is_dir=False)"""
2198 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
2199
2200 def GetPath(*args, **kwargs):
2201 """GetPath(self) -> String"""
2202 return _core_.FileSystem_GetPath(*args, **kwargs)
2203
2204 def OpenFile(*args, **kwargs):
2205 """OpenFile(self, String location) -> FSFile"""
2206 return _core_.FileSystem_OpenFile(*args, **kwargs)
2207
2208 def FindFirst(*args, **kwargs):
2209 """FindFirst(self, String spec, int flags=0) -> String"""
2210 return _core_.FileSystem_FindFirst(*args, **kwargs)
2211
2212 def FindNext(*args, **kwargs):
2213 """FindNext(self) -> String"""
2214 return _core_.FileSystem_FindNext(*args, **kwargs)
2215
2216 def AddHandler(*args, **kwargs):
2217 """AddHandler(CPPFileSystemHandler handler)"""
2218 return _core_.FileSystem_AddHandler(*args, **kwargs)
2219
2220 AddHandler = staticmethod(AddHandler)
2221 def RemoveHandler(*args, **kwargs):
2222 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2223 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2224
2225 RemoveHandler = staticmethod(RemoveHandler)
2226 def CleanUpHandlers(*args, **kwargs):
2227 """CleanUpHandlers()"""
2228 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
2229
2230 CleanUpHandlers = staticmethod(CleanUpHandlers)
2231 def FileNameToURL(*args, **kwargs):
2232 """FileNameToURL(String filename) -> String"""
2233 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2234
2235 FileNameToURL = staticmethod(FileNameToURL)
2236 def URLToFileName(*args, **kwargs):
2237 """URLToFileName(String url) -> String"""
2238 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2239
2240 URLToFileName = staticmethod(URLToFileName)
2241 Path = property(GetPath,doc="See `GetPath`")
2242 _core_.FileSystem_swigregister(FileSystem)
2243
2244 def FileSystem_AddHandler(*args, **kwargs):
2245 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2246 return _core_.FileSystem_AddHandler(*args, **kwargs)
2247
2248 def FileSystem_RemoveHandler(*args, **kwargs):
2249 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2250 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2251
2252 def FileSystem_CleanUpHandlers(*args):
2253 """FileSystem_CleanUpHandlers()"""
2254 return _core_.FileSystem_CleanUpHandlers(*args)
2255
2256 def FileSystem_FileNameToURL(*args, **kwargs):
2257 """FileSystem_FileNameToURL(String filename) -> String"""
2258 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2259
2260 def FileSystem_URLToFileName(*args, **kwargs):
2261 """FileSystem_URLToFileName(String url) -> String"""
2262 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2263
2264 class InternetFSHandler(CPPFileSystemHandler):
2265 """Proxy of C++ InternetFSHandler class"""
2266 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2267 __repr__ = _swig_repr
2268 def __init__(self, *args, **kwargs):
2269 """__init__(self) -> InternetFSHandler"""
2270 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
2271 def CanOpen(*args, **kwargs):
2272 """CanOpen(self, String location) -> bool"""
2273 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
2274
2275 def OpenFile(*args, **kwargs):
2276 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2277 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
2278
2279 _core_.InternetFSHandler_swigregister(InternetFSHandler)
2280
2281 class ZipFSHandler(CPPFileSystemHandler):
2282 """Proxy of C++ ZipFSHandler class"""
2283 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2284 __repr__ = _swig_repr
2285 def __init__(self, *args, **kwargs):
2286 """__init__(self) -> ZipFSHandler"""
2287 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
2288 def CanOpen(*args, **kwargs):
2289 """CanOpen(self, String location) -> bool"""
2290 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
2291
2292 def OpenFile(*args, **kwargs):
2293 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2294 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
2295
2296 def FindFirst(*args, **kwargs):
2297 """FindFirst(self, String spec, int flags=0) -> String"""
2298 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
2299
2300 def FindNext(*args, **kwargs):
2301 """FindNext(self) -> String"""
2302 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
2303
2304 _core_.ZipFSHandler_swigregister(ZipFSHandler)
2305
2306
2307 def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
2308 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2309 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
2310
2311 def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
2312 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2313 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
2314
2315 def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
2316 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2317 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2318 def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2319 """
2320 Add 'file' to the memory filesystem. The dataItem parameter can
2321 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2322 arbitrary data. If a bitmap or image is used then the imgType
2323 parameter should specify what kind of image file it should be
2324 written as, wx.BITMAP_TYPE_PNG, etc.
2325 """
2326 if isinstance(dataItem, wx.Image):
2327 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2328 elif isinstance(dataItem, wx.Bitmap):
2329 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2330 elif type(dataItem) == str:
2331 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2332 else:
2333 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2334
2335 class MemoryFSHandler(CPPFileSystemHandler):
2336 """Proxy of C++ MemoryFSHandler class"""
2337 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2338 __repr__ = _swig_repr
2339 def __init__(self, *args, **kwargs):
2340 """__init__(self) -> MemoryFSHandler"""
2341 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
2342 def RemoveFile(*args, **kwargs):
2343 """RemoveFile(String filename)"""
2344 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2345
2346 RemoveFile = staticmethod(RemoveFile)
2347 AddFile = staticmethod(MemoryFSHandler_AddFile)
2348 def CanOpen(*args, **kwargs):
2349 """CanOpen(self, String location) -> bool"""
2350 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2351
2352 def OpenFile(*args, **kwargs):
2353 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2354 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2355
2356 def FindFirst(*args, **kwargs):
2357 """FindFirst(self, String spec, int flags=0) -> String"""
2358 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2359
2360 def FindNext(*args, **kwargs):
2361 """FindNext(self) -> String"""
2362 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2363
2364 _core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2365
2366 def MemoryFSHandler_RemoveFile(*args, **kwargs):
2367 """MemoryFSHandler_RemoveFile(String filename)"""
2368 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2369
2370 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2371 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2372 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2373 IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2374 IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
2375 #---------------------------------------------------------------------------
2376
2377 class ImageHandler(Object):
2378 """
2379 This is the base class for implementing image file loading/saving, and
2380 image creation from data. It is used within `wx.Image` and is not
2381 normally seen by the application.
2382 """
2383 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2384 def __init__(self): raise AttributeError, "No constructor defined"
2385 __repr__ = _swig_repr
2386 def GetName(*args, **kwargs):
2387 """GetName(self) -> String"""
2388 return _core_.ImageHandler_GetName(*args, **kwargs)
2389
2390 def GetExtension(*args, **kwargs):
2391 """GetExtension(self) -> String"""
2392 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2393
2394 def GetType(*args, **kwargs):
2395 """GetType(self) -> long"""
2396 return _core_.ImageHandler_GetType(*args, **kwargs)
2397
2398 def GetMimeType(*args, **kwargs):
2399 """GetMimeType(self) -> String"""
2400 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2401
2402 def CanRead(*args, **kwargs):
2403 """CanRead(self, String name) -> bool"""
2404 return _core_.ImageHandler_CanRead(*args, **kwargs)
2405
2406 def CanReadStream(*args, **kwargs):
2407 """CanReadStream(self, InputStream stream) -> bool"""
2408 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2409
2410 def SetName(*args, **kwargs):
2411 """SetName(self, String name)"""
2412 return _core_.ImageHandler_SetName(*args, **kwargs)
2413
2414 def SetExtension(*args, **kwargs):
2415 """SetExtension(self, String extension)"""
2416 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2417
2418 def SetType(*args, **kwargs):
2419 """SetType(self, long type)"""
2420 return _core_.ImageHandler_SetType(*args, **kwargs)
2421
2422 def SetMimeType(*args, **kwargs):
2423 """SetMimeType(self, String mimetype)"""
2424 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2425
2426 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2427 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2428 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2429 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2430 _core_.ImageHandler_swigregister(ImageHandler)
2431
2432 class PyImageHandler(ImageHandler):
2433 """
2434 This is the base class for implementing image file loading/saving, and
2435 image creation from data, all written in Python. To create a custom
2436 image handler derive a new class from wx.PyImageHandler and provide
2437 the following methods::
2438
2439 def DoCanRead(self, stream) --> bool
2440 '''Check if this handler can read the image on the stream'''
2441
2442 def LoadFile(self, image, stream, verbose, index) --> bool
2443 '''Load image data from the stream and load it into image.'''
2444
2445 def SaveFile(self, image, stream, verbose) --> bool
2446 '''Save the iamge data in image to the stream using
2447 this handler's image file format.'''
2448
2449 def GetImageCount(self, stream) --> int
2450 '''If this image format can hold more than one image,
2451 how many does the image on the stream have?'''
2452
2453 To activate your handler create an instance of it and pass it to
2454 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2455 `SetExtension` from your constructor.
2456
2457 """
2458 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2459 __repr__ = _swig_repr
2460 def __init__(self, *args, **kwargs):
2461 """
2462 __init__(self) -> PyImageHandler
2463
2464 This is the base class for implementing image file loading/saving, and
2465 image creation from data, all written in Python. To create a custom
2466 image handler derive a new class from wx.PyImageHandler and provide
2467 the following methods::
2468
2469 def DoCanRead(self, stream) --> bool
2470 '''Check if this handler can read the image on the stream'''
2471
2472 def LoadFile(self, image, stream, verbose, index) --> bool
2473 '''Load image data from the stream and load it into image.'''
2474
2475 def SaveFile(self, image, stream, verbose) --> bool
2476 '''Save the iamge data in image to the stream using
2477 this handler's image file format.'''
2478
2479 def GetImageCount(self, stream) --> int
2480 '''If this image format can hold more than one image,
2481 how many does the image on the stream have?'''
2482
2483 To activate your handler create an instance of it and pass it to
2484 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2485 `SetExtension` from your constructor.
2486
2487 """
2488 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2489 self._SetSelf(self)
2490
2491 def _SetSelf(*args, **kwargs):
2492 """_SetSelf(self, PyObject self)"""
2493 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2494
2495 _core_.PyImageHandler_swigregister(PyImageHandler)
2496
2497 class ImageHistogram(object):
2498 """Proxy of C++ ImageHistogram class"""
2499 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2500 __repr__ = _swig_repr
2501 def __init__(self, *args, **kwargs):
2502 """__init__(self) -> ImageHistogram"""
2503 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2504 def MakeKey(*args, **kwargs):
2505 """
2506 MakeKey(byte r, byte g, byte b) -> unsigned long
2507
2508 Get the key in the histogram for the given RGB values
2509 """
2510 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2511
2512 MakeKey = staticmethod(MakeKey)
2513 def FindFirstUnusedColour(*args, **kwargs):
2514 """
2515 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2516
2517 Find first colour that is not used in the image and has higher RGB
2518 values than startR, startG, startB. Returns a tuple consisting of a
2519 success flag and rgb values.
2520 """
2521 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2522
2523 def GetCount(*args, **kwargs):
2524 """
2525 GetCount(self, unsigned long key) -> unsigned long
2526
2527 Returns the pixel count for the given key. Use `MakeKey` to create a
2528 key value from a RGB tripple.
2529 """
2530 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2531
2532 def GetCountRGB(*args, **kwargs):
2533 """
2534 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2535
2536 Returns the pixel count for the given RGB values.
2537 """
2538 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2539
2540 def GetCountColour(*args, **kwargs):
2541 """
2542 GetCountColour(self, Colour colour) -> unsigned long
2543
2544 Returns the pixel count for the given `wx.Colour` value.
2545 """
2546 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2547
2548 _core_.ImageHistogram_swigregister(ImageHistogram)
2549
2550 def ImageHistogram_MakeKey(*args, **kwargs):
2551 """
2552 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2553
2554 Get the key in the histogram for the given RGB values
2555 """
2556 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2557
2558 class Image_RGBValue(object):
2559 """
2560 An object that contains values for red, green and blue which represent
2561 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2562 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2563 color space.
2564 """
2565 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2566 __repr__ = _swig_repr
2567 def __init__(self, *args, **kwargs):
2568 """
2569 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2570
2571 Constructor.
2572 """
2573 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2574 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2575 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2576 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2577 _core_.Image_RGBValue_swigregister(Image_RGBValue)
2578
2579 class Image_HSVValue(object):
2580 """
2581 An object that contains values for hue, saturation and value which
2582 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2583 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2584 color space.
2585 """
2586 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2587 __repr__ = _swig_repr
2588 def __init__(self, *args, **kwargs):
2589 """
2590 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2591
2592 Constructor.
2593 """
2594 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2595 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2596 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2597 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2598 _core_.Image_HSVValue_swigregister(Image_HSVValue)
2599
2600 class Image(Object):
2601 """
2602 A platform-independent image class. An image can be created from
2603 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2604 variety of formats. Functions are available to set and get image
2605 bits, so it can be used for basic image manipulation.
2606
2607 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2608 platform-specific `wx.Bitmap` object must be created from it using the
2609 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2610 device context, using `wx.DC.DrawBitmap`.
2611
2612 One colour value of the image may be used as a mask colour which will
2613 lead to the automatic creation of a `wx.Mask` object associated to the
2614 bitmap object.
2615
2616 wx.Image supports alpha channel data, that is in addition to a byte
2617 for the red, green and blue colour components for each pixel it also
2618 stores a byte representing the pixel opacity. An alpha value of 0
2619 corresponds to a transparent pixel (null opacity) while a value of 255
2620 means that the pixel is 100% opaque.
2621
2622 Unlike RGB data, not all images have an alpha channel and before using
2623 `GetAlpha` you should check if this image contains an alpha channel
2624 with `HasAlpha`. Note that currently only images loaded from PNG files
2625 with transparency information will have an alpha channel.
2626 """
2627 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2628 __repr__ = _swig_repr
2629 def __init__(self, *args, **kwargs):
2630 """
2631 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2632
2633 Loads an image from a file.
2634 """
2635 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2636 __swig_destroy__ = _core_.delete_Image
2637 __del__ = lambda self : None;
2638 def Create(*args, **kwargs):
2639 """
2640 Create(self, int width, int height, bool clear=True)
2641
2642 Creates a fresh image. If clear is ``True``, the new image will be
2643 initialized to black. Otherwise, the image data will be uninitialized.
2644 """
2645 return _core_.Image_Create(*args, **kwargs)
2646
2647 def Destroy(*args, **kwargs):
2648 """
2649 Destroy(self)
2650
2651 Destroys the image data.
2652 """
2653 args[0].this.own(False)
2654 return _core_.Image_Destroy(*args, **kwargs)
2655
2656 def Scale(*args, **kwargs):
2657 """
2658 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2659
2660 Returns a scaled version of the image. This is also useful for scaling
2661 bitmaps in general as the only other way to scale bitmaps is to blit a
2662 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2663 specifies what method to use for resampling the image. It can be
2664 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2665 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2666 bicubic and box averaging resampling methods for upsampling and
2667 downsampling respectively.
2668 """
2669 return _core_.Image_Scale(*args, **kwargs)
2670
2671 def ResampleBox(*args, **kwargs):
2672 """ResampleBox(self, int width, int height) -> Image"""
2673 return _core_.Image_ResampleBox(*args, **kwargs)
2674
2675 def ResampleBicubic(*args, **kwargs):
2676 """ResampleBicubic(self, int width, int height) -> Image"""
2677 return _core_.Image_ResampleBicubic(*args, **kwargs)
2678
2679 def Blur(*args, **kwargs):
2680 """
2681 Blur(self, int radius) -> Image
2682
2683 Blurs the image in both horizontal and vertical directions by the
2684 specified pixel ``radius``. This should not be used when using a
2685 single mask colour for transparency.
2686 """
2687 return _core_.Image_Blur(*args, **kwargs)
2688
2689 def BlurHorizontal(*args, **kwargs):
2690 """
2691 BlurHorizontal(self, int radius) -> Image
2692
2693 Blurs the image in the horizontal direction only. This should not be
2694 used when using a single mask colour for transparency.
2695
2696 """
2697 return _core_.Image_BlurHorizontal(*args, **kwargs)
2698
2699 def BlurVertical(*args, **kwargs):
2700 """
2701 BlurVertical(self, int radius) -> Image
2702
2703 Blurs the image in the vertical direction only. This should not be
2704 used when using a single mask colour for transparency.
2705 """
2706 return _core_.Image_BlurVertical(*args, **kwargs)
2707
2708 def ShrinkBy(*args, **kwargs):
2709 """
2710 ShrinkBy(self, int xFactor, int yFactor) -> Image
2711
2712 Return a version of the image scaled smaller by the given factors.
2713 """
2714 return _core_.Image_ShrinkBy(*args, **kwargs)
2715
2716 def Rescale(*args, **kwargs):
2717 """
2718 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2719
2720 Changes the size of the image in-place by scaling it: after a call to
2721 this function, the image will have the given width and height.
2722
2723 Returns the (modified) image itself.
2724 """
2725 return _core_.Image_Rescale(*args, **kwargs)
2726
2727 def Resize(*args, **kwargs):
2728 """
2729 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2730
2731 Changes the size of the image in-place without scaling it, by adding
2732 either a border with the given colour or cropping as necessary. The
2733 image is pasted into a new image with the given size and background
2734 colour at the position pos relative to the upper left of the new
2735 image. If red = green = blue = -1 then use either the current mask
2736 colour if set or find, use, and set a suitable mask colour for any
2737 newly exposed areas.
2738
2739 Returns the (modified) image itself.
2740 """
2741 return _core_.Image_Resize(*args, **kwargs)
2742
2743 def SetRGB(*args, **kwargs):
2744 """
2745 SetRGB(self, int x, int y, byte r, byte g, byte b)
2746
2747 Sets the pixel at the given coordinate. This routine performs
2748 bounds-checks for the coordinate so it can be considered a safe way to
2749 manipulate the data, but in some cases this might be too slow so that
2750 the data will have to be set directly. In that case you will have to
2751 get access to the image data using the `GetData` method.
2752 """
2753 return _core_.Image_SetRGB(*args, **kwargs)
2754
2755 def SetRGBRect(*args, **kwargs):
2756 """
2757 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2758
2759 Sets the colour of the pixels within the given rectangle. This routine
2760 performs bounds-checks for the rectangle so it can be considered a
2761 safe way to manipulate the data.
2762 """
2763 return _core_.Image_SetRGBRect(*args, **kwargs)
2764
2765 def GetRed(*args, **kwargs):
2766 """
2767 GetRed(self, int x, int y) -> byte
2768
2769 Returns the red intensity at the given coordinate.
2770 """
2771 return _core_.Image_GetRed(*args, **kwargs)
2772
2773 def GetGreen(*args, **kwargs):
2774 """
2775 GetGreen(self, int x, int y) -> byte
2776
2777 Returns the green intensity at the given coordinate.
2778 """
2779 return _core_.Image_GetGreen(*args, **kwargs)
2780
2781 def GetBlue(*args, **kwargs):
2782 """
2783 GetBlue(self, int x, int y) -> byte
2784
2785 Returns the blue intensity at the given coordinate.
2786 """
2787 return _core_.Image_GetBlue(*args, **kwargs)
2788
2789 def SetAlpha(*args, **kwargs):
2790 """
2791 SetAlpha(self, int x, int y, byte alpha)
2792
2793 Sets the alpha value for the given pixel. This function should only be
2794 called if the image has alpha channel data, use `HasAlpha` to check
2795 for this.
2796 """
2797 return _core_.Image_SetAlpha(*args, **kwargs)
2798
2799 def GetAlpha(*args, **kwargs):
2800 """
2801 GetAlpha(self, int x, int y) -> byte
2802
2803 Returns the alpha value for the given pixel. This function may only be
2804 called for the images with alpha channel, use `HasAlpha` to check for
2805 this.
2806
2807 The returned value is the *opacity* of the image, i.e. the value of 0
2808 corresponds to the fully transparent pixels while the value of 255 to
2809 the fully opaque pixels.
2810 """
2811 return _core_.Image_GetAlpha(*args, **kwargs)
2812
2813 def HasAlpha(*args, **kwargs):
2814 """
2815 HasAlpha(self) -> bool
2816
2817 Returns true if this image has alpha channel, false otherwise.
2818 """
2819 return _core_.Image_HasAlpha(*args, **kwargs)
2820
2821 def InitAlpha(*args, **kwargs):
2822 """
2823 InitAlpha(self)
2824
2825 Initializes the image alpha channel data. It is an error to call it if
2826 the image already has alpha data. If it doesn't, alpha data will be by
2827 default initialized to all pixels being fully opaque. But if the image
2828 has a a mask colour, all mask pixels will be completely transparent.
2829 """
2830 return _core_.Image_InitAlpha(*args, **kwargs)
2831
2832 def IsTransparent(*args, **kwargs):
2833 """
2834 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2835
2836 Returns ``True`` if this pixel is masked or has an alpha value less
2837 than the spcified threshold.
2838 """
2839 return _core_.Image_IsTransparent(*args, **kwargs)
2840
2841 def FindFirstUnusedColour(*args, **kwargs):
2842 """
2843 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2844
2845 Find first colour that is not used in the image and has higher RGB
2846 values than startR, startG, startB. Returns a tuple consisting of a
2847 success flag and rgb values.
2848 """
2849 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2850
2851 def ConvertAlphaToMask(*args, **kwargs):
2852 """
2853 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2854
2855 If the image has alpha channel, this method converts it to mask. All
2856 pixels with alpha value less than ``threshold`` are replaced with the
2857 mask colour and the alpha channel is removed. The mask colour is
2858 chosen automatically using `FindFirstUnusedColour`.
2859
2860 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2861 nothing.
2862 """
2863 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2864
2865 def ConvertColourToAlpha(*args, **kwargs):
2866 """
2867 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2868
2869 This method converts an image where the original alpha information is
2870 only available as a shades of a colour (actually shades of grey)
2871 typically when you draw anti-aliased text into a bitmap. The DC
2872 drawing routines draw grey values on the black background although
2873 they actually mean to draw white with differnt alpha values. This
2874 method reverses it, assuming a black (!) background and white text.
2875 The method will then fill up the whole image with the colour given.
2876 """
2877 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2878
2879 def SetMaskFromImage(*args, **kwargs):
2880 """
2881 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2882
2883 Sets the image's mask so that the pixels that have RGB value of
2884 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2885 by first finding an unused colour in the image, setting this colour as
2886 the mask colour and then using this colour to draw all pixels in the
2887 image who corresponding pixel in mask has given RGB value.
2888
2889 Returns ``False`` if ``mask`` does not have same dimensions as the
2890 image or if there is no unused colour left. Returns ``True`` if the
2891 mask was successfully applied.
2892
2893 Note that this method involves computing the histogram, which is
2894 computationally intensive operation.
2895 """
2896 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2897
2898 def CanRead(*args, **kwargs):
2899 """
2900 CanRead(String filename) -> bool
2901
2902 Returns True if the image handlers can read this file.
2903 """
2904 return _core_.Image_CanRead(*args, **kwargs)
2905
2906 CanRead = staticmethod(CanRead)
2907 def GetImageCount(*args, **kwargs):
2908 """
2909 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2910
2911 If the image file contains more than one image and the image handler
2912 is capable of retrieving these individually, this function will return
2913 the number of available images.
2914 """
2915 return _core_.Image_GetImageCount(*args, **kwargs)
2916
2917 GetImageCount = staticmethod(GetImageCount)
2918 def LoadFile(*args, **kwargs):
2919 """
2920 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2921
2922 Loads an image from a file. If no handler type is provided, the
2923 library will try to autodetect the format.
2924 """
2925 return _core_.Image_LoadFile(*args, **kwargs)
2926
2927 def LoadMimeFile(*args, **kwargs):
2928 """
2929 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2930
2931 Loads an image from a file, specifying the image type with a MIME type
2932 string.
2933 """
2934 return _core_.Image_LoadMimeFile(*args, **kwargs)
2935
2936 def SaveFile(*args, **kwargs):
2937 """
2938 SaveFile(self, String name, int type) -> bool
2939
2940 Saves an image in the named file.
2941 """
2942 return _core_.Image_SaveFile(*args, **kwargs)
2943
2944 def SaveMimeFile(*args, **kwargs):
2945 """
2946 SaveMimeFile(self, String name, String mimetype) -> bool
2947
2948 Saves an image in the named file.
2949 """
2950 return _core_.Image_SaveMimeFile(*args, **kwargs)
2951
2952 def CanReadStream(*args, **kwargs):
2953 """
2954 CanReadStream(InputStream stream) -> bool
2955
2956 Returns True if the image handlers can read an image file from the
2957 data currently on the input stream, or a readable Python file-like
2958 object.
2959 """
2960 return _core_.Image_CanReadStream(*args, **kwargs)
2961
2962 CanReadStream = staticmethod(CanReadStream)
2963 def LoadStream(*args, **kwargs):
2964 """
2965 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2966
2967 Loads an image from an input stream or a readable Python file-like
2968 object. If no handler type is provided, the library will try to
2969 autodetect the format.
2970 """
2971 return _core_.Image_LoadStream(*args, **kwargs)
2972
2973 def LoadMimeStream(*args, **kwargs):
2974 """
2975 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2976
2977 Loads an image from an input stream or a readable Python file-like
2978 object, using a MIME type string to specify the image file format.
2979 """
2980 return _core_.Image_LoadMimeStream(*args, **kwargs)
2981
2982 def IsOk(*args, **kwargs):
2983 """
2984 IsOk(self) -> bool
2985
2986 Returns true if image data is present.
2987 """
2988 return _core_.Image_IsOk(*args, **kwargs)
2989
2990 Ok = IsOk
2991 def GetWidth(*args, **kwargs):
2992 """
2993 GetWidth(self) -> int
2994
2995 Gets the width of the image in pixels.
2996 """
2997 return _core_.Image_GetWidth(*args, **kwargs)
2998
2999 def GetHeight(*args, **kwargs):
3000 """
3001 GetHeight(self) -> int
3002
3003 Gets the height of the image in pixels.
3004 """
3005 return _core_.Image_GetHeight(*args, **kwargs)
3006
3007 def GetSize(*args, **kwargs):
3008 """
3009 GetSize(self) -> Size
3010
3011 Returns the size of the image in pixels.
3012 """
3013 return _core_.Image_GetSize(*args, **kwargs)
3014
3015 def GetSubImage(*args, **kwargs):
3016 """
3017 GetSubImage(self, Rect rect) -> Image
3018
3019 Returns a sub image of the current one as long as the rect belongs
3020 entirely to the image.
3021 """
3022 return _core_.Image_GetSubImage(*args, **kwargs)
3023
3024 def Size(*args, **kwargs):
3025 """
3026 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
3027
3028 Returns a resized version of this image without scaling it by adding
3029 either a border with the given colour or cropping as necessary. The
3030 image is pasted into a new image with the given size and background
3031 colour at the position ``pos`` relative to the upper left of the new
3032 image. If red = green = blue = -1 then use either the current mask
3033 colour if set or find, use, and set a suitable mask colour for any
3034 newly exposed areas.
3035 """
3036 return _core_.Image_Size(*args, **kwargs)
3037
3038 def Copy(*args, **kwargs):
3039 """
3040 Copy(self) -> Image
3041
3042 Returns an identical copy of the image.
3043 """
3044 return _core_.Image_Copy(*args, **kwargs)
3045
3046 def Paste(*args, **kwargs):
3047 """
3048 Paste(self, Image image, int x, int y)
3049
3050 Pastes ``image`` into this instance and takes care of the mask colour
3051 and any out of bounds problems.
3052 """
3053 return _core_.Image_Paste(*args, **kwargs)
3054
3055 def GetData(*args, **kwargs):
3056 """
3057 GetData(self) -> PyObject
3058
3059 Returns a string containing a copy of the RGB bytes of the image.
3060 """
3061 return _core_.Image_GetData(*args, **kwargs)
3062
3063 def SetData(*args, **kwargs):
3064 """
3065 SetData(self, buffer data)
3066
3067 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3068 either a string or a buffer object holding the data and the length of
3069 the data must be width*height*3.
3070 """
3071 return _core_.Image_SetData(*args, **kwargs)
3072
3073 def GetDataBuffer(*args, **kwargs):
3074 """
3075 GetDataBuffer(self) -> PyObject
3076
3077 Returns a writable Python buffer object that is pointing at the RGB
3078 image data buffer inside the wx.Image. You need to ensure that you do
3079 not use this buffer object after the image has been destroyed.
3080 """
3081 return _core_.Image_GetDataBuffer(*args, **kwargs)
3082
3083 def SetDataBuffer(*args, **kwargs):
3084 """
3085 SetDataBuffer(self, buffer data)
3086
3087 Sets the internal image data pointer to point at a Python buffer
3088 object. This can save making an extra copy of the data but you must
3089 ensure that the buffer object lives longer than the wx.Image does.
3090 """
3091 return _core_.Image_SetDataBuffer(*args, **kwargs)
3092
3093 def GetAlphaData(*args, **kwargs):
3094 """
3095 GetAlphaData(self) -> PyObject
3096
3097 Returns a string containing a copy of the alpha bytes of the image.
3098 """
3099 return _core_.Image_GetAlphaData(*args, **kwargs)
3100
3101 def SetAlphaData(*args, **kwargs):
3102 """
3103 SetAlphaData(self, buffer alpha)
3104
3105 Resets the Image's alpha data from a buffer of bytes. Accepts either
3106 a string or a buffer object holding the data and the length of the
3107 data must be width*height.
3108 """
3109 return _core_.Image_SetAlphaData(*args, **kwargs)
3110
3111 def GetAlphaBuffer(*args, **kwargs):
3112 """
3113 GetAlphaBuffer(self) -> PyObject
3114
3115 Returns a writable Python buffer object that is pointing at the Alpha
3116 data buffer inside the wx.Image. You need to ensure that you do not
3117 use this buffer object after the image has been destroyed.
3118 """
3119 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
3120
3121 def SetAlphaBuffer(*args, **kwargs):
3122 """
3123 SetAlphaBuffer(self, buffer alpha)
3124
3125 Sets the internal image alpha pointer to point at a Python buffer
3126 object. This can save making an extra copy of the data but you must
3127 ensure that the buffer object lives as long as the wx.Image does.
3128 """
3129 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
3130
3131 def SetMaskColour(*args, **kwargs):
3132 """
3133 SetMaskColour(self, byte r, byte g, byte b)
3134
3135 Sets the mask colour for this image (and tells the image to use the
3136 mask).
3137 """
3138 return _core_.Image_SetMaskColour(*args, **kwargs)
3139
3140 def GetOrFindMaskColour(*args, **kwargs):
3141 """
3142 GetOrFindMaskColour() -> (r,g,b)
3143
3144 Get the current mask colour or find a suitable colour.
3145 """
3146 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3147
3148 def GetMaskRed(*args, **kwargs):
3149 """
3150 GetMaskRed(self) -> byte
3151
3152 Gets the red component of the mask colour.
3153 """
3154 return _core_.Image_GetMaskRed(*args, **kwargs)
3155
3156 def GetMaskGreen(*args, **kwargs):
3157 """
3158 GetMaskGreen(self) -> byte
3159
3160 Gets the green component of the mask colour.
3161 """
3162 return _core_.Image_GetMaskGreen(*args, **kwargs)
3163
3164 def GetMaskBlue(*args, **kwargs):
3165 """
3166 GetMaskBlue(self) -> byte
3167
3168 Gets the blue component of the mask colour.
3169 """
3170 return _core_.Image_GetMaskBlue(*args, **kwargs)
3171
3172 def SetMask(*args, **kwargs):
3173 """
3174 SetMask(self, bool mask=True)
3175
3176 Specifies whether there is a mask or not. The area of the mask is
3177 determined by the current mask colour.
3178 """
3179 return _core_.Image_SetMask(*args, **kwargs)
3180
3181 def HasMask(*args, **kwargs):
3182 """
3183 HasMask(self) -> bool
3184
3185 Returns ``True`` if there is a mask active, ``False`` otherwise.
3186 """
3187 return _core_.Image_HasMask(*args, **kwargs)
3188
3189 def Rotate(*args, **kwargs):
3190 """
3191 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3192 Point offset_after_rotation=None) -> Image
3193
3194 Rotates the image about the given point, by ``angle`` radians. Passing
3195 ``True`` to ``interpolating`` results in better image quality, but is
3196 slower. If the image has a mask, then the mask colour is used for the
3197 uncovered pixels in the rotated image background. Otherwise, black
3198 will be used as the fill colour.
3199
3200 Returns the rotated image, leaving this image intact.
3201 """
3202 return _core_.Image_Rotate(*args, **kwargs)
3203
3204 def Rotate90(*args, **kwargs):
3205 """
3206 Rotate90(self, bool clockwise=True) -> Image
3207
3208 Returns a copy of the image rotated 90 degrees in the direction
3209 indicated by ``clockwise``.
3210 """
3211 return _core_.Image_Rotate90(*args, **kwargs)
3212
3213 def Mirror(*args, **kwargs):
3214 """
3215 Mirror(self, bool horizontally=True) -> Image
3216
3217 Returns a mirrored copy of the image. The parameter ``horizontally``
3218 indicates the orientation.
3219 """
3220 return _core_.Image_Mirror(*args, **kwargs)
3221
3222 def Replace(*args, **kwargs):
3223 """
3224 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3225
3226 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3227 ``(r2,g2,b2)``.
3228 """
3229 return _core_.Image_Replace(*args, **kwargs)
3230
3231 def ConvertToGreyscale(*args, **kwargs):
3232 """
3233 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3234
3235 Convert to greyscale image. Uses the luminance component (Y) of the
3236 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3237 defaults to ITU-T BT.601
3238 """
3239 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3240
3241 def ConvertToMono(*args, **kwargs):
3242 """
3243 ConvertToMono(self, byte r, byte g, byte b) -> Image
3244
3245 Returns monochromatic version of the image. The returned image has
3246 white colour where the original has ``(r,g,b)`` colour and black
3247 colour everywhere else.
3248 """
3249 return _core_.Image_ConvertToMono(*args, **kwargs)
3250
3251 def SetOption(*args, **kwargs):
3252 """
3253 SetOption(self, String name, String value)
3254
3255 Sets an image handler defined option. For example, when saving as a
3256 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3257 number between 0 and 100 (0 is terrible, 100 is very good).
3258 """
3259 return _core_.Image_SetOption(*args, **kwargs)
3260
3261 def SetOptionInt(*args, **kwargs):
3262 """
3263 SetOptionInt(self, String name, int value)
3264
3265 Sets an image option as an integer.
3266 """
3267 return _core_.Image_SetOptionInt(*args, **kwargs)
3268
3269 def GetOption(*args, **kwargs):
3270 """
3271 GetOption(self, String name) -> String
3272
3273 Gets the value of an image handler option.
3274 """
3275 return _core_.Image_GetOption(*args, **kwargs)
3276
3277 def GetOptionInt(*args, **kwargs):
3278 """
3279 GetOptionInt(self, String name) -> int
3280
3281 Gets the value of an image handler option as an integer. If the given
3282 option is not present, the function returns 0.
3283 """
3284 return _core_.Image_GetOptionInt(*args, **kwargs)
3285
3286 def HasOption(*args, **kwargs):
3287 """
3288 HasOption(self, String name) -> bool
3289
3290 Returns true if the given option is present.
3291 """
3292 return _core_.Image_HasOption(*args, **kwargs)
3293
3294 def CountColours(*args, **kwargs):
3295 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3296 return _core_.Image_CountColours(*args, **kwargs)
3297
3298 def ComputeHistogram(*args, **kwargs):
3299 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3300 return _core_.Image_ComputeHistogram(*args, **kwargs)
3301
3302 def AddHandler(*args, **kwargs):
3303 """AddHandler(ImageHandler handler)"""
3304 return _core_.Image_AddHandler(*args, **kwargs)
3305
3306 AddHandler = staticmethod(AddHandler)
3307 def InsertHandler(*args, **kwargs):
3308 """InsertHandler(ImageHandler handler)"""
3309 return _core_.Image_InsertHandler(*args, **kwargs)
3310
3311 InsertHandler = staticmethod(InsertHandler)
3312 def RemoveHandler(*args, **kwargs):
3313 """RemoveHandler(String name) -> bool"""
3314 return _core_.Image_RemoveHandler(*args, **kwargs)
3315
3316 RemoveHandler = staticmethod(RemoveHandler)
3317 def GetHandlers(*args, **kwargs):
3318 """GetHandlers() -> PyObject"""
3319 return _core_.Image_GetHandlers(*args, **kwargs)
3320
3321 GetHandlers = staticmethod(GetHandlers)
3322 def GetImageExtWildcard(*args, **kwargs):
3323 """
3324 GetImageExtWildcard() -> String
3325
3326 Iterates all registered wxImageHandler objects, and returns a string
3327 containing file extension masks suitable for passing to file open/save
3328 dialog boxes.
3329 """
3330 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3331
3332 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3333 def ConvertToBitmap(*args, **kwargs):
3334 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3335 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3336
3337 def ConvertToMonoBitmap(*args, **kwargs):
3338 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3339 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3340
3341 def RotateHue(*args, **kwargs):
3342 """
3343 RotateHue(self, double angle)
3344
3345 Rotates the hue of each pixel of the image. Hue is a double in the
3346 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3347 """
3348 return _core_.Image_RotateHue(*args, **kwargs)
3349
3350 def RGBtoHSV(*args, **kwargs):
3351 """
3352 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3353
3354 Converts a color in RGB color space to HSV color space.
3355 """
3356 return _core_.Image_RGBtoHSV(*args, **kwargs)
3357
3358 RGBtoHSV = staticmethod(RGBtoHSV)
3359 def HSVtoRGB(*args, **kwargs):
3360 """
3361 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3362
3363 Converts a color in HSV color space to RGB color space.
3364 """
3365 return _core_.Image_HSVtoRGB(*args, **kwargs)
3366
3367 HSVtoRGB = staticmethod(HSVtoRGB)
3368 def __nonzero__(self): return self.IsOk()
3369 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3370 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3371 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3372 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3373 Height = property(GetHeight,doc="See `GetHeight`")
3374 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3375 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3376 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
3377 Width = property(GetWidth,doc="See `GetWidth`")
3378 _core_.Image_swigregister(Image)
3379
3380 def ImageFromMime(*args, **kwargs):
3381 """
3382 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3383
3384 Loads an image from a file, using a MIME type string (such as
3385 'image/jpeg') to specify image type.
3386 """
3387 val = _core_.new_ImageFromMime(*args, **kwargs)
3388 return val
3389
3390 def ImageFromStream(*args, **kwargs):
3391 """
3392 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3393
3394 Loads an image from an input stream, or any readable Python file-like
3395 object.
3396 """
3397 val = _core_.new_ImageFromStream(*args, **kwargs)
3398 return val
3399
3400 def ImageFromStreamMime(*args, **kwargs):
3401 """
3402 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3403
3404 Loads an image from an input stream, or any readable Python file-like
3405 object, specifying the image format with a MIME type string.
3406 """
3407 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3408 return val
3409
3410 def EmptyImage(*args, **kwargs):
3411 """
3412 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3413
3414 Construct an empty image of a given size, optionally setting all
3415 pixels to black.
3416 """
3417 val = _core_.new_EmptyImage(*args, **kwargs)
3418 return val
3419
3420 def ImageFromBitmap(*args, **kwargs):
3421 """
3422 ImageFromBitmap(Bitmap bitmap) -> Image
3423
3424 Construct an Image from a `wx.Bitmap`.
3425 """
3426 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3427 return val
3428
3429 def ImageFromData(*args, **kwargs):
3430 """
3431 ImageFromData(int width, int height, buffer data) -> Image
3432
3433 Construct an Image from a buffer of RGB bytes. Accepts either a
3434 string or a buffer object holding the data and the length of the data
3435 must be width*height*3.
3436 """
3437 val = _core_.new_ImageFromData(*args, **kwargs)
3438 return val
3439
3440 def ImageFromDataWithAlpha(*args, **kwargs):
3441 """
3442 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3443
3444 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3445 Accepts either a string or a buffer object holding the data and the
3446 length of the data must be width*height*3 bytes, and the length of the
3447 alpha data must be width*height bytes.
3448 """
3449 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3450 return val
3451
3452 def Image_CanRead(*args, **kwargs):
3453 """
3454 Image_CanRead(String filename) -> bool
3455
3456 Returns True if the image handlers can read this file.
3457 """
3458 return _core_.Image_CanRead(*args, **kwargs)
3459
3460 def Image_GetImageCount(*args, **kwargs):
3461 """
3462 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3463
3464 If the image file contains more than one image and the image handler
3465 is capable of retrieving these individually, this function will return
3466 the number of available images.
3467 """
3468 return _core_.Image_GetImageCount(*args, **kwargs)
3469
3470 def Image_CanReadStream(*args, **kwargs):
3471 """
3472 Image_CanReadStream(InputStream stream) -> bool
3473
3474 Returns True if the image handlers can read an image file from the
3475 data currently on the input stream, or a readable Python file-like
3476 object.
3477 """
3478 return _core_.Image_CanReadStream(*args, **kwargs)
3479
3480 def Image_AddHandler(*args, **kwargs):
3481 """Image_AddHandler(ImageHandler handler)"""
3482 return _core_.Image_AddHandler(*args, **kwargs)
3483
3484 def Image_InsertHandler(*args, **kwargs):
3485 """Image_InsertHandler(ImageHandler handler)"""
3486 return _core_.Image_InsertHandler(*args, **kwargs)
3487
3488 def Image_RemoveHandler(*args, **kwargs):
3489 """Image_RemoveHandler(String name) -> bool"""
3490 return _core_.Image_RemoveHandler(*args, **kwargs)
3491
3492 def Image_GetHandlers(*args):
3493 """Image_GetHandlers() -> PyObject"""
3494 return _core_.Image_GetHandlers(*args)
3495
3496 def Image_GetImageExtWildcard(*args):
3497 """
3498 Image_GetImageExtWildcard() -> String
3499
3500 Iterates all registered wxImageHandler objects, and returns a string
3501 containing file extension masks suitable for passing to file open/save
3502 dialog boxes.
3503 """
3504 return _core_.Image_GetImageExtWildcard(*args)
3505
3506 def Image_RGBtoHSV(*args, **kwargs):
3507 """
3508 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3509
3510 Converts a color in RGB color space to HSV color space.
3511 """
3512 return _core_.Image_RGBtoHSV(*args, **kwargs)
3513
3514 def Image_HSVtoRGB(*args, **kwargs):
3515 """
3516 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3517
3518 Converts a color in HSV color space to RGB color space.
3519 """
3520 return _core_.Image_HSVtoRGB(*args, **kwargs)
3521
3522
3523 def _ImageFromBuffer(*args, **kwargs):
3524 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3525 return _core_._ImageFromBuffer(*args, **kwargs)
3526 def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3527 """
3528 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3529 parameter must be a Python object that implements the buffer interface,
3530 such as a string, array, etc. The dataBuffer object is expected to
3531 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3532 object can optionally be supplied for the image's alpha channel data, and
3533 it is expected to be width*height bytes long.
3534
3535 The wx.Image will be created with its data and alpha pointers initialized
3536 to the memory address pointed to by the buffer objects, thus saving the
3537 time needed to copy the image data from the buffer object to the wx.Image.
3538 While this has advantages, it also has the shoot-yourself-in-the-foot
3539 risks associated with sharing a C pointer between two objects.
3540
3541 To help alleviate the risk a reference to the data and alpha buffer
3542 objects are kept with the wx.Image, so that they won't get deleted until
3543 after the wx.Image is deleted. However please be aware that it is not
3544 guaranteed that an object won't move its memory buffer to a new location
3545 when it needs to resize its contents. If that happens then the wx.Image
3546 will end up referring to an invalid memory location and could cause the
3547 application to crash. Therefore care should be taken to not manipulate
3548 the objects used for the data and alpha buffers in a way that would cause
3549 them to change size.
3550 """
3551 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3552 image._buffer = dataBuffer
3553 image._alpha = alphaBuffer
3554 return image
3555
3556 def InitAllImageHandlers():
3557 """
3558 The former functionality of InitAllImageHanders is now done internal to
3559 the _core_ extension module and so this function has become a simple NOP.
3560 """
3561 pass
3562
3563 IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3564 IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3565 PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3566 PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3567 PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3568 BMP_24BPP = _core_.BMP_24BPP
3569 BMP_8BPP = _core_.BMP_8BPP
3570 BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3571 BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3572 BMP_8BPP_RED = _core_.BMP_8BPP_RED
3573 BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3574 BMP_4BPP = _core_.BMP_4BPP
3575 BMP_1BPP = _core_.BMP_1BPP
3576 BMP_1BPP_BW = _core_.BMP_1BPP_BW
3577 class BMPHandler(ImageHandler):
3578 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3579 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3580 __repr__ = _swig_repr
3581 def __init__(self, *args, **kwargs):
3582 """
3583 __init__(self) -> BMPHandler
3584
3585 A `wx.ImageHandler` for \*.bmp bitmap files.
3586 """
3587 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3588 _core_.BMPHandler_swigregister(BMPHandler)
3589 NullImage = cvar.NullImage
3590 IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3591 IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3592 IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3593 IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3594 IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3595 IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3596 IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3597 IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3598 IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3599 IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3600 IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3601 IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3602 IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3603 IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3604 IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3605
3606 class ICOHandler(BMPHandler):
3607 """A `wx.ImageHandler` for \*.ico icon files."""
3608 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3609 __repr__ = _swig_repr
3610 def __init__(self, *args, **kwargs):
3611 """
3612 __init__(self) -> ICOHandler
3613
3614 A `wx.ImageHandler` for \*.ico icon files.
3615 """
3616 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3617 _core_.ICOHandler_swigregister(ICOHandler)
3618
3619 class CURHandler(ICOHandler):
3620 """A `wx.ImageHandler` for \*.cur cursor files."""
3621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3622 __repr__ = _swig_repr
3623 def __init__(self, *args, **kwargs):
3624 """
3625 __init__(self) -> CURHandler
3626
3627 A `wx.ImageHandler` for \*.cur cursor files.
3628 """
3629 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3630 _core_.CURHandler_swigregister(CURHandler)
3631
3632 class ANIHandler(CURHandler):
3633 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3634 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3635 __repr__ = _swig_repr
3636 def __init__(self, *args, **kwargs):
3637 """
3638 __init__(self) -> ANIHandler
3639
3640 A `wx.ImageHandler` for \*.ani animated cursor files.
3641 """
3642 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3643 _core_.ANIHandler_swigregister(ANIHandler)
3644
3645 class PNGHandler(ImageHandler):
3646 """A `wx.ImageHandler` for PNG image files."""
3647 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3648 __repr__ = _swig_repr
3649 def __init__(self, *args, **kwargs):
3650 """
3651 __init__(self) -> PNGHandler
3652
3653 A `wx.ImageHandler` for PNG image files.
3654 """
3655 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3656 _core_.PNGHandler_swigregister(PNGHandler)
3657
3658 class GIFHandler(ImageHandler):
3659 """A `wx.ImageHandler` for GIF image files."""
3660 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3661 __repr__ = _swig_repr
3662 def __init__(self, *args, **kwargs):
3663 """
3664 __init__(self) -> GIFHandler
3665
3666 A `wx.ImageHandler` for GIF image files.
3667 """
3668 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3669 _core_.GIFHandler_swigregister(GIFHandler)
3670
3671 class PCXHandler(ImageHandler):
3672 """A `wx.ImageHandler` for PCX imager files."""
3673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3674 __repr__ = _swig_repr
3675 def __init__(self, *args, **kwargs):
3676 """
3677 __init__(self) -> PCXHandler
3678
3679 A `wx.ImageHandler` for PCX imager files.
3680 """
3681 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3682 _core_.PCXHandler_swigregister(PCXHandler)
3683
3684 class JPEGHandler(ImageHandler):
3685 """A `wx.ImageHandler` for JPEG/JPG image files."""
3686 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3687 __repr__ = _swig_repr
3688 def __init__(self, *args, **kwargs):
3689 """
3690 __init__(self) -> JPEGHandler
3691
3692 A `wx.ImageHandler` for JPEG/JPG image files.
3693 """
3694 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3695 _core_.JPEGHandler_swigregister(JPEGHandler)
3696
3697 class PNMHandler(ImageHandler):
3698 """A `wx.ImageHandler` for PNM image files."""
3699 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3700 __repr__ = _swig_repr
3701 def __init__(self, *args, **kwargs):
3702 """
3703 __init__(self) -> PNMHandler
3704
3705 A `wx.ImageHandler` for PNM image files.
3706 """
3707 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3708 _core_.PNMHandler_swigregister(PNMHandler)
3709
3710 class XPMHandler(ImageHandler):
3711 """A `wx.ImageHandler` for XPM image."""
3712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3713 __repr__ = _swig_repr
3714 def __init__(self, *args, **kwargs):
3715 """
3716 __init__(self) -> XPMHandler
3717
3718 A `wx.ImageHandler` for XPM image.
3719 """
3720 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3721 _core_.XPMHandler_swigregister(XPMHandler)
3722
3723 class TIFFHandler(ImageHandler):
3724 """A `wx.ImageHandler` for TIFF image files."""
3725 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3726 __repr__ = _swig_repr
3727 def __init__(self, *args, **kwargs):
3728 """
3729 __init__(self) -> TIFFHandler
3730
3731 A `wx.ImageHandler` for TIFF image files.
3732 """
3733 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3734 _core_.TIFFHandler_swigregister(TIFFHandler)
3735
3736 class TGAHandler(ImageHandler):
3737 """A `wx.ImageHandler` for TGA image files."""
3738 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3739 __repr__ = _swig_repr
3740 def __init__(self, *args, **kwargs):
3741 """
3742 __init__(self) -> TGAHandler
3743
3744 A `wx.ImageHandler` for TGA image files.
3745 """
3746 _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs))
3747 _core_.TGAHandler_swigregister(TGAHandler)
3748
3749 QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3750 QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3751 class Quantize(object):
3752 """Performs quantization, or colour reduction, on a wxImage."""
3753 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3754 def __init__(self): raise AttributeError, "No constructor defined"
3755 __repr__ = _swig_repr
3756 def Quantize(*args, **kwargs):
3757 """
3758 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3759
3760 Reduce the colours in the source image and put the result into the
3761 destination image, setting the palette in the destination if
3762 needed. Both images may be the same, to overwrite the source image.
3763 """
3764 return _core_.Quantize_Quantize(*args, **kwargs)
3765
3766 Quantize = staticmethod(Quantize)
3767 _core_.Quantize_swigregister(Quantize)
3768
3769 def Quantize_Quantize(*args, **kwargs):
3770 """
3771 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3772
3773 Reduce the colours in the source image and put the result into the
3774 destination image, setting the palette in the destination if
3775 needed. Both images may be the same, to overwrite the source image.
3776 """
3777 return _core_.Quantize_Quantize(*args, **kwargs)
3778
3779 #---------------------------------------------------------------------------
3780
3781 class EvtHandler(Object):
3782 """Proxy of C++ EvtHandler class"""
3783 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3784 __repr__ = _swig_repr
3785 def __init__(self, *args, **kwargs):
3786 """__init__(self) -> EvtHandler"""
3787 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3788 self._setOORInfo(self)
3789
3790 def GetNextHandler(*args, **kwargs):
3791 """GetNextHandler(self) -> EvtHandler"""
3792 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3793
3794 def GetPreviousHandler(*args, **kwargs):
3795 """GetPreviousHandler(self) -> EvtHandler"""
3796 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3797
3798 def SetNextHandler(*args, **kwargs):
3799 """SetNextHandler(self, EvtHandler handler)"""
3800 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3801
3802 def SetPreviousHandler(*args, **kwargs):
3803 """SetPreviousHandler(self, EvtHandler handler)"""
3804 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3805
3806 def GetEvtHandlerEnabled(*args, **kwargs):
3807 """GetEvtHandlerEnabled(self) -> bool"""
3808 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3809
3810 def SetEvtHandlerEnabled(*args, **kwargs):
3811 """SetEvtHandlerEnabled(self, bool enabled)"""
3812 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3813
3814 def ProcessEvent(*args, **kwargs):
3815 """ProcessEvent(self, Event event) -> bool"""
3816 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3817
3818 def AddPendingEvent(*args, **kwargs):
3819 """AddPendingEvent(self, Event event)"""
3820 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3821
3822 def ProcessPendingEvents(*args, **kwargs):
3823 """ProcessPendingEvents(self)"""
3824 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3825
3826 def Connect(*args, **kwargs):
3827 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3828 return _core_.EvtHandler_Connect(*args, **kwargs)
3829
3830 def Disconnect(*args, **kwargs):
3831 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3832 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3833
3834 def _setOORInfo(*args, **kwargs):
3835 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3836 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3837 args[0].this.own(False)
3838 return val
3839
3840 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3841 """
3842 Bind an event to an event handler.
3843
3844 :param event: One of the EVT_* objects that specifies the
3845 type of event to bind,
3846
3847 :param handler: A callable object to be invoked when the
3848 event is delivered to self. Pass None to
3849 disconnect an event handler.
3850
3851 :param source: Sometimes the event originates from a
3852 different window than self, but you still
3853 want to catch it in self. (For example, a
3854 button event delivered to a frame.) By
3855 passing the source of the event, the event
3856 handling system is able to differentiate
3857 between the same event type from different
3858 controls.
3859
3860 :param id: Used to spcify the event source by ID instead
3861 of instance.
3862
3863 :param id2: Used when it is desirable to bind a handler
3864 to a range of IDs, such as with EVT_MENU_RANGE.
3865 """
3866 if source is not None:
3867 id = source.GetId()
3868 event.Bind(self, id, id2, handler)
3869
3870 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3871 """
3872 Disconencts the event handler binding for event from self.
3873 Returns True if successful.
3874 """
3875 if source is not None:
3876 id = source.GetId()
3877 return event.Unbind(self, id, id2)
3878
3879 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3880 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3881 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3882 _core_.EvtHandler_swigregister(EvtHandler)
3883
3884 #---------------------------------------------------------------------------
3885
3886 class PyEventBinder(object):
3887 """
3888 Instances of this class are used to bind specific events to event
3889 handlers.
3890 """
3891 def __init__(self, evtType, expectedIDs=0):
3892 if expectedIDs not in [0, 1, 2]:
3893 raise ValueError, "Invalid number of expectedIDs"
3894 self.expectedIDs = expectedIDs
3895
3896 if type(evtType) == list or type(evtType) == tuple:
3897 self.evtType = evtType
3898 else:
3899 self.evtType = [evtType]
3900
3901
3902 def Bind(self, target, id1, id2, function):
3903 """Bind this set of event types to target."""
3904 for et in self.evtType:
3905 target.Connect(id1, id2, et, function)
3906
3907
3908 def Unbind(self, target, id1, id2):
3909 """Remove an event binding."""
3910 success = 0
3911 for et in self.evtType:
3912 success += target.Disconnect(id1, id2, et)
3913 return success != 0
3914
3915 def _getEvtType(self):
3916 """
3917 Make it easy to get to the default wxEventType typeID for this
3918 event binder.
3919 """
3920 return self.evtType[0]
3921
3922 typeId = property(_getEvtType)
3923
3924
3925 def __call__(self, *args):
3926 """
3927 For backwards compatibility with the old EVT_* functions.
3928 Should be called with either (window, func), (window, ID,
3929 func) or (window, ID1, ID2, func) parameters depending on the
3930 type of the event.
3931 """
3932 assert len(args) == 2 + self.expectedIDs
3933 id1 = wx.ID_ANY
3934 id2 = wx.ID_ANY
3935 target = args[0]
3936 if self.expectedIDs == 0:
3937 func = args[1]
3938 elif self.expectedIDs == 1:
3939 id1 = args[1]
3940 func = args[2]
3941 elif self.expectedIDs == 2:
3942 id1 = args[1]
3943 id2 = args[2]
3944 func = args[3]
3945 else:
3946 raise ValueError, "Unexpected number of IDs"
3947
3948 self.Bind(target, id1, id2, func)
3949
3950
3951 # These two are square pegs that don't fit the PyEventBinder hole...
3952 def EVT_COMMAND(win, id, cmd, func):
3953 win.Connect(id, -1, cmd, func)
3954 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3955 win.Connect(id1, id2, cmd, func)
3956
3957
3958 #---------------------------------------------------------------------------
3959
3960 #---------------------------------------------------------------------------
3961
3962 EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3963 EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3964
3965 def NewEventType(*args):
3966 """NewEventType() -> EventType"""
3967 return _core_.NewEventType(*args)
3968 wxEVT_ANY = _core_.wxEVT_ANY
3969 wxEVT_NULL = _core_.wxEVT_NULL
3970 wxEVT_FIRST = _core_.wxEVT_FIRST
3971 wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3972 wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3973 wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3974 wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3975 wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3976 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3977 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3978 wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3979 wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3980 wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3981 wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3982 wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3983 wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3984 wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3985 wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3986 wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3987 wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3988 wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3989 wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3990 wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3991 wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3992 wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3993 wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3994 wxEVT_MOTION = _core_.wxEVT_MOTION
3995 wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3996 wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3997 wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3998 wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3999 wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
4000 wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
4001 wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
4002 wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
4003 wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
4004 wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
4005 wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
4006 wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
4007 wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
4008 wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
4009 wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
4010 wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
4011 wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
4012 wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
4013 wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
4014 wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
4015 wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
4016 wxEVT_CHAR = _core_.wxEVT_CHAR
4017 wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
4018 wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
4019 wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
4020 wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
4021 wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
4022 wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
4023 wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
4024 wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
4025 wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
4026 wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
4027 wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
4028 wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
4029 wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
4030 wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
4031 wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
4032 wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
4033 wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
4034 wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
4035 wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
4036 wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
4037 wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
4038 wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
4039 wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
4040 wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
4041 wxEVT_SIZE = _core_.wxEVT_SIZE
4042 wxEVT_MOVE = _core_.wxEVT_MOVE
4043 wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
4044 wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
4045 wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
4046 wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
4047 wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
4048 wxEVT_CREATE = _core_.wxEVT_CREATE
4049 wxEVT_DESTROY = _core_.wxEVT_DESTROY
4050 wxEVT_SHOW = _core_.wxEVT_SHOW
4051 wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
4052 wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
4053 wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
4054 wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
4055 wxEVT_PAINT = _core_.wxEVT_PAINT
4056 wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
4057 wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
4058 wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
4059 wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
4060 wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
4061 wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
4062 wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
4063 wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
4064 wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
4065 wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
4066 wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
4067 wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
4068 wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
4069 wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
4070 wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
4071 wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
4072 wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
4073 wxEVT_IDLE = _core_.wxEVT_IDLE
4074 wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4075 wxEVT_SIZING = _core_.wxEVT_SIZING
4076 wxEVT_MOVING = _core_.wxEVT_MOVING
4077 wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
4078 wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4079 wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4080 wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
4081 wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4082 wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4083 wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4084 wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4085 wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4086 wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4087 wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
4088 #
4089 # Create some event binders
4090 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4091 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4092 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4093 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4094 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4095 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4096 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4097 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4098 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4099 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4100 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4101 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4102 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
4103 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
4104 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4105 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4106 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4107 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4108 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4109 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4110 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4111 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4112 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4113 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
4114 EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
4115 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4116 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4117 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4118 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4119 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4120 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4121 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4122 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4123 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4124 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4125 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4126 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4127 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4128 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4129 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4130 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
4131 EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
4132
4133 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4134 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4135 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4136 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4137 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4138 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4139 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4140 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4141 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4142 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4143 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4144 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4145 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4146
4147 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4148 wxEVT_LEFT_UP,
4149 wxEVT_MIDDLE_DOWN,
4150 wxEVT_MIDDLE_UP,
4151 wxEVT_RIGHT_DOWN,
4152 wxEVT_RIGHT_UP,
4153 wxEVT_MOTION,
4154 wxEVT_LEFT_DCLICK,
4155 wxEVT_MIDDLE_DCLICK,
4156 wxEVT_RIGHT_DCLICK,
4157 wxEVT_ENTER_WINDOW,
4158 wxEVT_LEAVE_WINDOW,
4159 wxEVT_MOUSEWHEEL
4160 ])
4161
4162
4163 # Scrolling from wxWindow (sent to wxScrolledWindow)
4164 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
4165 wxEVT_SCROLLWIN_BOTTOM,
4166 wxEVT_SCROLLWIN_LINEUP,
4167 wxEVT_SCROLLWIN_LINEDOWN,
4168 wxEVT_SCROLLWIN_PAGEUP,
4169 wxEVT_SCROLLWIN_PAGEDOWN,
4170 wxEVT_SCROLLWIN_THUMBTRACK,
4171 wxEVT_SCROLLWIN_THUMBRELEASE,
4172 ])
4173
4174 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4175 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4176 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4177 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4178 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4179 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4180 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4181 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4182
4183 # Scrolling from wx.Slider and wx.ScrollBar
4184 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4185 wxEVT_SCROLL_BOTTOM,
4186 wxEVT_SCROLL_LINEUP,
4187 wxEVT_SCROLL_LINEDOWN,
4188 wxEVT_SCROLL_PAGEUP,
4189 wxEVT_SCROLL_PAGEDOWN,
4190 wxEVT_SCROLL_THUMBTRACK,
4191 wxEVT_SCROLL_THUMBRELEASE,
4192 wxEVT_SCROLL_CHANGED,
4193 ])
4194
4195 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4196 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4197 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4198 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4199 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4200 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4201 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4202 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4203 EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4204 EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
4205
4206 # Scrolling from wx.Slider and wx.ScrollBar, with an id
4207 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4208 wxEVT_SCROLL_BOTTOM,
4209 wxEVT_SCROLL_LINEUP,
4210 wxEVT_SCROLL_LINEDOWN,
4211 wxEVT_SCROLL_PAGEUP,
4212 wxEVT_SCROLL_PAGEDOWN,
4213 wxEVT_SCROLL_THUMBTRACK,
4214 wxEVT_SCROLL_THUMBRELEASE,
4215 wxEVT_SCROLL_CHANGED,
4216 ], 1)
4217
4218 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4219 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4220 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4221 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4222 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4223 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4224 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4225 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4226 EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4227 EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
4228
4229 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4230 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4231 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4232 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4233 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4234 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4235 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4236 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4237 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4238 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4239
4240 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4241 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4242 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4243 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4244 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4245 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4246 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4247 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4248 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4249
4250
4251 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4252 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4253 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4254 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4255 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4256 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4257 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4258
4259 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4260
4261 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4262 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4263
4264 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4265
4266 EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4267 EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4268 EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
4269
4270
4271 #---------------------------------------------------------------------------
4272
4273 class Event(Object):
4274 """
4275 An event is a structure holding information about an event passed to a
4276 callback or member function. wx.Event is an abstract base class for
4277 other event classes
4278 """
4279 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4280 def __init__(self): raise AttributeError, "No constructor defined"
4281 __repr__ = _swig_repr
4282 __swig_destroy__ = _core_.delete_Event
4283 __del__ = lambda self : None;
4284 def SetEventType(*args, **kwargs):
4285 """
4286 SetEventType(self, EventType typ)
4287
4288 Sets the specific type of the event.
4289 """
4290 return _core_.Event_SetEventType(*args, **kwargs)
4291
4292 def GetEventType(*args, **kwargs):
4293 """
4294 GetEventType(self) -> EventType
4295
4296 Returns the identifier of the given event type, such as
4297 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4298 """
4299 return _core_.Event_GetEventType(*args, **kwargs)
4300
4301 def GetEventObject(*args, **kwargs):
4302 """
4303 GetEventObject(self) -> Object
4304
4305 Returns the object (usually a window) associated with the event, if
4306 any.
4307 """
4308 return _core_.Event_GetEventObject(*args, **kwargs)
4309
4310 def SetEventObject(*args, **kwargs):
4311 """
4312 SetEventObject(self, Object obj)
4313
4314 Sets the originating object, or in other words, obj is normally the
4315 object that is sending the event.
4316 """
4317 return _core_.Event_SetEventObject(*args, **kwargs)
4318
4319 def GetTimestamp(*args, **kwargs):
4320 """GetTimestamp(self) -> long"""
4321 return _core_.Event_GetTimestamp(*args, **kwargs)
4322
4323 def SetTimestamp(*args, **kwargs):
4324 """SetTimestamp(self, long ts=0)"""
4325 return _core_.Event_SetTimestamp(*args, **kwargs)
4326
4327 def GetId(*args, **kwargs):
4328 """
4329 GetId(self) -> int
4330
4331 Returns the identifier associated with this event, such as a button
4332 command id.
4333 """
4334 return _core_.Event_GetId(*args, **kwargs)
4335
4336 def SetId(*args, **kwargs):
4337 """
4338 SetId(self, int Id)
4339
4340 Set's the ID for the event. This is usually the ID of the window that
4341 is sending the event, but it can also be a command id from a menu
4342 item, etc.
4343 """
4344 return _core_.Event_SetId(*args, **kwargs)
4345
4346 def IsCommandEvent(*args, **kwargs):
4347 """
4348 IsCommandEvent(self) -> bool
4349
4350 Returns true if the event is or is derived from `wx.CommandEvent` else
4351 it returns false. Note: Exists only for optimization purposes.
4352 """
4353 return _core_.Event_IsCommandEvent(*args, **kwargs)
4354
4355 def Skip(*args, **kwargs):
4356 """
4357 Skip(self, bool skip=True)
4358
4359 This method can be used inside an event handler to control whether
4360 further event handlers bound to this event will be called after the
4361 current one returns. Without Skip() (or equivalently if Skip(False) is
4362 used), the event will not be processed any more. If Skip(True) is
4363 called, the event processing system continues searching for a further
4364 handler function for this event, even though it has been processed
4365 already in the current handler.
4366 """
4367 return _core_.Event_Skip(*args, **kwargs)
4368
4369 def GetSkipped(*args, **kwargs):
4370 """
4371 GetSkipped(self) -> bool
4372
4373 Returns true if the event handler should be skipped, false otherwise.
4374 :see: `Skip`
4375 """
4376 return _core_.Event_GetSkipped(*args, **kwargs)
4377
4378 def ShouldPropagate(*args, **kwargs):
4379 """
4380 ShouldPropagate(self) -> bool
4381
4382 Test if this event should be propagated to the parent window or not,
4383 i.e. if the propagation level is currently greater than 0.
4384 """
4385 return _core_.Event_ShouldPropagate(*args, **kwargs)
4386
4387 def StopPropagation(*args, **kwargs):
4388 """
4389 StopPropagation(self) -> int
4390
4391 Stop the event from propagating to its parent window. Returns the old
4392 propagation level value which may be later passed to
4393 `ResumePropagation` to allow propagating the event again.
4394 """
4395 return _core_.Event_StopPropagation(*args, **kwargs)
4396
4397 def ResumePropagation(*args, **kwargs):
4398 """
4399 ResumePropagation(self, int propagationLevel)
4400
4401 Resume the event propagation by restoring the propagation level. (For
4402 example, you can use the value returned by an earlier call to
4403 `StopPropagation`.)
4404
4405 """
4406 return _core_.Event_ResumePropagation(*args, **kwargs)
4407
4408 def Clone(*args, **kwargs):
4409 """Clone(self) -> Event"""
4410 return _core_.Event_Clone(*args, **kwargs)
4411
4412 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4413 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4414 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4415 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4416 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
4417 _core_.Event_swigregister(Event)
4418
4419 #---------------------------------------------------------------------------
4420
4421 class PropagationDisabler(object):
4422 """
4423 Helper class to temporarily change an event not to propagate. Simply
4424 create an instance of this class and then whe it is destroyed the
4425 propogation of the event will be restored.
4426 """
4427 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4428 __repr__ = _swig_repr
4429 def __init__(self, *args, **kwargs):
4430 """
4431 __init__(self, Event event) -> PropagationDisabler
4432
4433 Helper class to temporarily change an event not to propagate. Simply
4434 create an instance of this class and then whe it is destroyed the
4435 propogation of the event will be restored.
4436 """
4437 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4438 __swig_destroy__ = _core_.delete_PropagationDisabler
4439 __del__ = lambda self : None;
4440 _core_.PropagationDisabler_swigregister(PropagationDisabler)
4441
4442 class PropagateOnce(object):
4443 """
4444 A helper class that will temporarily lower propagation level of an
4445 event. Simply create an instance of this class and then whe it is
4446 destroyed the propogation of the event will be restored.
4447 """
4448 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4449 __repr__ = _swig_repr
4450 def __init__(self, *args, **kwargs):
4451 """
4452 __init__(self, Event event) -> PropagateOnce
4453
4454 A helper class that will temporarily lower propagation level of an
4455 event. Simply create an instance of this class and then whe it is
4456 destroyed the propogation of the event will be restored.
4457 """
4458 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4459 __swig_destroy__ = _core_.delete_PropagateOnce
4460 __del__ = lambda self : None;
4461 _core_.PropagateOnce_swigregister(PropagateOnce)
4462
4463 #---------------------------------------------------------------------------
4464
4465 class CommandEvent(Event):
4466 """
4467 This event class contains information about command events, which
4468 originate from a variety of simple controls, as well as menus and
4469 toolbars.
4470 """
4471 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4472 __repr__ = _swig_repr
4473 def __init__(self, *args, **kwargs):
4474 """
4475 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4476
4477 This event class contains information about command events, which
4478 originate from a variety of simple controls, as well as menus and
4479 toolbars.
4480 """
4481 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4482 def GetSelection(*args, **kwargs):
4483 """
4484 GetSelection(self) -> int
4485
4486 Returns item index for a listbox or choice selection event (not valid
4487 for a deselection).
4488 """
4489 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4490
4491 def SetString(*args, **kwargs):
4492 """SetString(self, String s)"""
4493 return _core_.CommandEvent_SetString(*args, **kwargs)
4494
4495 def GetString(*args, **kwargs):
4496 """
4497 GetString(self) -> String
4498
4499 Returns item string for a listbox or choice selection event (not valid
4500 for a deselection).
4501 """
4502 return _core_.CommandEvent_GetString(*args, **kwargs)
4503
4504 def IsChecked(*args, **kwargs):
4505 """
4506 IsChecked(self) -> bool
4507
4508 This method can be used with checkbox and menu events: for the
4509 checkboxes, the method returns true for a selection event and false
4510 for a deselection one. For the menu events, this method indicates if
4511 the menu item just has become checked or unchecked (and thus only
4512 makes sense for checkable menu items).
4513 """
4514 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4515
4516 Checked = IsChecked
4517 def IsSelection(*args, **kwargs):
4518 """
4519 IsSelection(self) -> bool
4520
4521 For a listbox or similar event, returns true if it is a selection,
4522 false if it is a deselection.
4523 """
4524 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4525
4526 def SetExtraLong(*args, **kwargs):
4527 """SetExtraLong(self, long extraLong)"""
4528 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4529
4530 def GetExtraLong(*args, **kwargs):
4531 """
4532 GetExtraLong(self) -> long
4533
4534 Returns extra information dependant on the event objects type. If the
4535 event comes from a listbox selection, it is a boolean determining
4536 whether the event was a selection (true) or a deselection (false). A
4537 listbox deselection only occurs for multiple-selection boxes, and in
4538 this case the index and string values are indeterminate and the
4539 listbox must be examined by the application.
4540 """
4541 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4542
4543 def SetInt(*args, **kwargs):
4544 """SetInt(self, int i)"""
4545 return _core_.CommandEvent_SetInt(*args, **kwargs)
4546
4547 def GetInt(*args, **kwargs):
4548 """
4549 GetInt(self) -> int
4550
4551 Returns the integer identifier corresponding to a listbox, choice or
4552 radiobox selection (only if the event was a selection, not a
4553 deselection), or a boolean value representing the value of a checkbox.
4554 """
4555 return _core_.CommandEvent_GetInt(*args, **kwargs)
4556
4557 def GetClientData(*args, **kwargs):
4558 """
4559 GetClientData(self) -> PyObject
4560
4561 Returns the client data object for a listbox or choice selection event, (if any.)
4562 """
4563 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4564
4565 def SetClientData(*args, **kwargs):
4566 """
4567 SetClientData(self, PyObject clientData)
4568
4569 Associate the given client data with the item at position n.
4570 """
4571 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4572
4573 GetClientObject = GetClientData
4574 SetClientObject = SetClientData
4575
4576 def Clone(*args, **kwargs):
4577 """Clone(self) -> Event"""
4578 return _core_.CommandEvent_Clone(*args, **kwargs)
4579
4580 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4581 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4582 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4583 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4584 Selection = property(GetSelection,doc="See `GetSelection`")
4585 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4586 _core_.CommandEvent_swigregister(CommandEvent)
4587
4588 #---------------------------------------------------------------------------
4589
4590 class NotifyEvent(CommandEvent):
4591 """
4592 An instance of this class (or one of its derived classes) is sent from
4593 a control when the control's state is being changed and the control
4594 allows that change to be prevented from happening. The event handler
4595 can call `Veto` or `Allow` to tell the control what to do.
4596 """
4597 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4598 __repr__ = _swig_repr
4599 def __init__(self, *args, **kwargs):
4600 """
4601 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4602
4603 An instance of this class (or one of its derived classes) is sent from
4604 a control when the control's state is being changed and the control
4605 allows that change to be prevented from happening. The event handler
4606 can call `Veto` or `Allow` to tell the control what to do.
4607 """
4608 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4609 def Veto(*args, **kwargs):
4610 """
4611 Veto(self)
4612
4613 Prevents the change announced by this event from happening.
4614
4615 It is in general a good idea to notify the user about the reasons for
4616 vetoing the change because otherwise the applications behaviour (which
4617 just refuses to do what the user wants) might be quite surprising.
4618 """
4619 return _core_.NotifyEvent_Veto(*args, **kwargs)
4620
4621 def Allow(*args, **kwargs):
4622 """
4623 Allow(self)
4624
4625 This is the opposite of `Veto`: it explicitly allows the event to be
4626 processed. For most events it is not necessary to call this method as
4627 the events are allowed anyhow but some are forbidden by default (this
4628 will be mentioned in the corresponding event description).
4629 """
4630 return _core_.NotifyEvent_Allow(*args, **kwargs)
4631
4632 def IsAllowed(*args, **kwargs):
4633 """
4634 IsAllowed(self) -> bool
4635
4636 Returns true if the change is allowed (`Veto` hasn't been called) or
4637 false otherwise (if it was).
4638 """
4639 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4640
4641 _core_.NotifyEvent_swigregister(NotifyEvent)
4642
4643 #---------------------------------------------------------------------------
4644
4645 class ScrollEvent(CommandEvent):
4646 """
4647 A scroll event holds information about events sent from stand-alone
4648 scrollbars and sliders. Note that scrolled windows do not send
4649 instances of this event class, but send the `wx.ScrollWinEvent`
4650 instead.
4651 """
4652 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4653 __repr__ = _swig_repr
4654 def __init__(self, *args, **kwargs):
4655 """
4656 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4657 int orient=0) -> ScrollEvent
4658 """
4659 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4660 def GetOrientation(*args, **kwargs):
4661 """
4662 GetOrientation(self) -> int
4663
4664 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4665 the scrollbar.
4666 """
4667 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4668
4669 def GetPosition(*args, **kwargs):
4670 """
4671 GetPosition(self) -> int
4672
4673 Returns the position of the scrollbar.
4674 """
4675 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4676
4677 def SetOrientation(*args, **kwargs):
4678 """SetOrientation(self, int orient)"""
4679 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4680
4681 def SetPosition(*args, **kwargs):
4682 """SetPosition(self, int pos)"""
4683 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4684
4685 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4686 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4687 _core_.ScrollEvent_swigregister(ScrollEvent)
4688
4689 #---------------------------------------------------------------------------
4690
4691 class ScrollWinEvent(Event):
4692 """
4693 A wx.ScrollWinEvent holds information about scrolling and is sent from
4694 scrolling windows.
4695 """
4696 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4697 __repr__ = _swig_repr
4698 def __init__(self, *args, **kwargs):
4699 """
4700 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4701
4702 A wx.ScrollWinEvent holds information about scrolling and is sent from
4703 scrolling windows.
4704 """
4705 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4706 def GetOrientation(*args, **kwargs):
4707 """
4708 GetOrientation(self) -> int
4709
4710 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4711 the scrollbar.
4712 """
4713 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4714
4715 def GetPosition(*args, **kwargs):
4716 """
4717 GetPosition(self) -> int
4718
4719 Returns the position of the scrollbar for the thumb track and release
4720 events. Note that this field can't be used for the other events, you
4721 need to query the window itself for the current position in that case.
4722 """
4723 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4724
4725 def SetOrientation(*args, **kwargs):
4726 """SetOrientation(self, int orient)"""
4727 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4728
4729 def SetPosition(*args, **kwargs):
4730 """SetPosition(self, int pos)"""
4731 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4732
4733 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4734 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4735 _core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4736
4737 #---------------------------------------------------------------------------
4738
4739 MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4740 MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4741 MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4742 MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4743 MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4744 class MouseEvent(Event):
4745 """
4746 This event class contains information about the events generated by
4747 the mouse: they include mouse buttons press and release events and
4748 mouse move events.
4749
4750 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4751 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4752 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4753 a middle button so a portable application should avoid relying on the
4754 events from it.
4755
4756 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4757 the former returns true when the event corresponds to the left mouse
4758 button click while the latter returns true if the left mouse button is
4759 currently being pressed. For example, when the user is dragging the
4760 mouse you can use `LeftIsDown` to test whether the left mouse button
4761 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4762 `LeftIsDown` will also return true in wxWidgets whatever the
4763 underlying GUI behaviour is (which is platform-dependent). The same
4764 applies, of course, to other mouse buttons as well.
4765 """
4766 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4767 __repr__ = _swig_repr
4768 def __init__(self, *args, **kwargs):
4769 """
4770 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4771
4772 Constructs a wx.MouseEvent. Valid event types are:
4773
4774 * wxEVT_ENTER_WINDOW
4775 * wxEVT_LEAVE_WINDOW
4776 * wxEVT_LEFT_DOWN
4777 * wxEVT_LEFT_UP
4778 * wxEVT_LEFT_DCLICK
4779 * wxEVT_MIDDLE_DOWN
4780 * wxEVT_MIDDLE_UP
4781 * wxEVT_MIDDLE_DCLICK
4782 * wxEVT_RIGHT_DOWN
4783 * wxEVT_RIGHT_UP
4784 * wxEVT_RIGHT_DCLICK
4785 * wxEVT_MOTION
4786 * wxEVT_MOUSEWHEEL
4787 """
4788 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4789 def IsButton(*args, **kwargs):
4790 """
4791 IsButton(self) -> bool
4792
4793 Returns true if the event was a mouse button event (not necessarily a
4794 button down event - that may be tested using `ButtonDown`).
4795 """
4796 return _core_.MouseEvent_IsButton(*args, **kwargs)
4797
4798 def ButtonDown(*args, **kwargs):
4799 """
4800 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4801
4802 If the argument is omitted, this returns true if the event was any
4803 mouse button down event. Otherwise the argument specifies which
4804 button-down event shold be checked for (see `Button` for the possible
4805 values).
4806 """
4807 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4808
4809 def ButtonDClick(*args, **kwargs):
4810 """
4811 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4812
4813 If the argument is omitted, this returns true if the event was any
4814 mouse double click event. Otherwise the argument specifies which
4815 double click event to check for (see `Button` for the possible
4816 values).
4817 """
4818 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4819
4820 def ButtonUp(*args, **kwargs):
4821 """
4822 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4823
4824 If the argument is omitted, this returns true if the event was any
4825 mouse button up event. Otherwise the argument specifies which button
4826 up event to check for (see `Button` for the possible values).
4827 """
4828 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4829
4830 def Button(*args, **kwargs):
4831 """
4832 Button(self, int button) -> bool
4833
4834 Returns true if the identified mouse button is changing state. Valid
4835 values of button are:
4836
4837 ==================== =====================================
4838 wx.MOUSE_BTN_LEFT check if left button was pressed
4839 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4840 wx.MOUSE_BTN_RIGHT check if right button was pressed
4841 wx.MOUSE_BTN_ANY check if any button was pressed
4842 ==================== =====================================
4843
4844 """
4845 return _core_.MouseEvent_Button(*args, **kwargs)
4846
4847 def ButtonIsDown(*args, **kwargs):
4848 """ButtonIsDown(self, int but) -> bool"""
4849 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4850
4851 def GetButton(*args, **kwargs):
4852 """
4853 GetButton(self) -> int
4854
4855 Returns the mouse button which generated this event or
4856 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4857 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4858 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4859 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4860 right buttons respectively.
4861 """
4862 return _core_.MouseEvent_GetButton(*args, **kwargs)
4863
4864 def ControlDown(*args, **kwargs):
4865 """
4866 ControlDown(self) -> bool
4867
4868 Returns true if the control key was down at the time of the event.
4869 """
4870 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4871
4872 def MetaDown(*args, **kwargs):
4873 """
4874 MetaDown(self) -> bool
4875
4876 Returns true if the Meta key was down at the time of the event.
4877 """
4878 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4879
4880 def AltDown(*args, **kwargs):
4881 """
4882 AltDown(self) -> bool
4883
4884 Returns true if the Alt key was down at the time of the event.
4885 """
4886 return _core_.MouseEvent_AltDown(*args, **kwargs)
4887
4888 def ShiftDown(*args, **kwargs):
4889 """
4890 ShiftDown(self) -> bool
4891
4892 Returns true if the Shift key was down at the time of the event.
4893 """
4894 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4895
4896 def CmdDown(*args, **kwargs):
4897 """
4898 CmdDown(self) -> bool
4899
4900 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4901 platforms but the special "Apple" (a.k.a as "Command") key on
4902 Macs. It often makes sense to use it instead of, say, `ControlDown`
4903 because Cmd key is used for the same thing under Mac as Ctrl
4904 elsewhere. The Ctrl key still exists, it's just not used for this
4905 purpose. So for non-Mac platforms this is the same as `ControlDown`
4906 and Macs this is the same as `MetaDown`.
4907 """
4908 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4909
4910 def LeftDown(*args, **kwargs):
4911 """
4912 LeftDown(self) -> bool
4913
4914 Returns true if the left mouse button state changed to down.
4915 """
4916 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4917
4918 def MiddleDown(*args, **kwargs):
4919 """
4920 MiddleDown(self) -> bool
4921
4922 Returns true if the middle mouse button state changed to down.
4923 """
4924 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4925
4926 def RightDown(*args, **kwargs):
4927 """
4928 RightDown(self) -> bool
4929
4930 Returns true if the right mouse button state changed to down.
4931 """
4932 return _core_.MouseEvent_RightDown(*args, **kwargs)
4933
4934 def LeftUp(*args, **kwargs):
4935 """
4936 LeftUp(self) -> bool
4937
4938 Returns true if the left mouse button state changed to up.
4939 """
4940 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4941
4942 def MiddleUp(*args, **kwargs):
4943 """
4944 MiddleUp(self) -> bool
4945
4946 Returns true if the middle mouse button state changed to up.
4947 """
4948 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4949
4950 def RightUp(*args, **kwargs):
4951 """
4952 RightUp(self) -> bool
4953
4954 Returns true if the right mouse button state changed to up.
4955 """
4956 return _core_.MouseEvent_RightUp(*args, **kwargs)
4957
4958 def LeftDClick(*args, **kwargs):
4959 """
4960 LeftDClick(self) -> bool
4961
4962 Returns true if the event was a left button double click.
4963 """
4964 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4965
4966 def MiddleDClick(*args, **kwargs):
4967 """
4968 MiddleDClick(self) -> bool
4969
4970 Returns true if the event was a middle button double click.
4971 """
4972 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4973
4974 def RightDClick(*args, **kwargs):
4975 """
4976 RightDClick(self) -> bool
4977
4978 Returns true if the event was a right button double click.
4979 """
4980 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4981
4982 def LeftIsDown(*args, **kwargs):
4983 """
4984 LeftIsDown(self) -> bool
4985
4986 Returns true if the left mouse button is currently down, independent
4987 of the current event type.
4988
4989 Please notice that it is not the same as LeftDown which returns true
4990 if the left mouse button was just pressed. Rather, it describes the
4991 state of the mouse button before the event happened.
4992
4993 This event is usually used in the mouse event handlers which process
4994 "move mouse" messages to determine whether the user is (still)
4995 dragging the mouse.
4996 """
4997 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4998
4999 def MiddleIsDown(*args, **kwargs):
5000 """
5001 MiddleIsDown(self) -> bool
5002
5003 Returns true if the middle mouse button is currently down, independent
5004 of the current event type.
5005 """
5006 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
5007
5008 def RightIsDown(*args, **kwargs):
5009 """
5010 RightIsDown(self) -> bool
5011
5012 Returns true if the right mouse button is currently down, independent
5013 of the current event type.
5014 """
5015 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
5016
5017 def Dragging(*args, **kwargs):
5018 """
5019 Dragging(self) -> bool
5020
5021 Returns true if this was a dragging event (motion while a button is
5022 depressed).
5023 """
5024 return _core_.MouseEvent_Dragging(*args, **kwargs)
5025
5026 def Moving(*args, **kwargs):
5027 """
5028 Moving(self) -> bool
5029
5030 Returns true if this was a motion event and no mouse buttons were
5031 pressed. If any mouse button is held pressed, then this method returns
5032 false and Dragging returns true.
5033 """
5034 return _core_.MouseEvent_Moving(*args, **kwargs)
5035
5036 def Entering(*args, **kwargs):
5037 """
5038 Entering(self) -> bool
5039
5040 Returns true if the mouse was entering the window.
5041 """
5042 return _core_.MouseEvent_Entering(*args, **kwargs)
5043
5044 def Leaving(*args, **kwargs):
5045 """
5046 Leaving(self) -> bool
5047
5048 Returns true if the mouse was leaving the window.
5049 """
5050 return _core_.MouseEvent_Leaving(*args, **kwargs)
5051
5052 def GetPosition(*args, **kwargs):
5053 """
5054 GetPosition(self) -> Point
5055
5056 Returns the pixel position of the mouse in window coordinates when the
5057 event happened.
5058 """
5059 return _core_.MouseEvent_GetPosition(*args, **kwargs)
5060
5061 def GetPositionTuple(*args, **kwargs):
5062 """
5063 GetPositionTuple() -> (x,y)
5064
5065 Returns the pixel position of the mouse in window coordinates when the
5066 event happened.
5067 """
5068 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
5069
5070 def GetLogicalPosition(*args, **kwargs):
5071 """
5072 GetLogicalPosition(self, DC dc) -> Point
5073
5074 Returns the logical mouse position in pixels (i.e. translated
5075 according to the translation set for the DC, which usually indicates
5076 that the window has been scrolled).
5077 """
5078 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
5079
5080 def GetX(*args, **kwargs):
5081 """
5082 GetX(self) -> int
5083
5084 Returns X coordinate of the physical mouse event position.
5085 """
5086 return _core_.MouseEvent_GetX(*args, **kwargs)
5087
5088 def GetY(*args, **kwargs):
5089 """
5090 GetY(self) -> int
5091
5092 Returns Y coordinate of the physical mouse event position.
5093 """
5094 return _core_.MouseEvent_GetY(*args, **kwargs)
5095
5096 def GetWheelRotation(*args, **kwargs):
5097 """
5098 GetWheelRotation(self) -> int
5099
5100 Get wheel rotation, positive or negative indicates direction of
5101 rotation. Current devices all send an event when rotation is equal to
5102 +/-WheelDelta, but this allows for finer resolution devices to be
5103 created in the future. Because of this you shouldn't assume that one
5104 event is equal to 1 line or whatever, but you should be able to either
5105 do partial line scrolling or wait until +/-WheelDelta rotation values
5106 have been accumulated before scrolling.
5107 """
5108 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
5109
5110 def GetWheelDelta(*args, **kwargs):
5111 """
5112 GetWheelDelta(self) -> int
5113
5114 Get wheel delta, normally 120. This is the threshold for action to be
5115 taken, and one such action (for example, scrolling one increment)
5116 should occur for each delta.
5117 """
5118 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
5119
5120 def GetWheelAxis(*args, **kwargs):
5121 """
5122 GetWheelAxis(self) -> int
5123
5124 Gets the axis the wheel operation concerns, 0 being the y axis as on
5125 most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
5126 or horizontal trackpad scrolling.
5127 """
5128 return _core_.MouseEvent_GetWheelAxis(*args, **kwargs)
5129
5130 def GetLinesPerAction(*args, **kwargs):
5131 """
5132 GetLinesPerAction(self) -> int
5133
5134 Returns the configured number of lines (or whatever) to be scrolled
5135 per wheel action. Defaults to three.
5136 """
5137 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
5138
5139 def IsPageScroll(*args, **kwargs):
5140 """
5141 IsPageScroll(self) -> bool
5142
5143 Returns true if the system has been setup to do page scrolling with
5144 the mouse wheel instead of line scrolling.
5145 """
5146 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5147
5148 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5149 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5150 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5151 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5152 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5153 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5154 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5155 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5156 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5157 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5158 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5159 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
5160 Button = property(GetButton,doc="See `GetButton`")
5161 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5162 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5163 Position = property(GetPosition,doc="See `GetPosition`")
5164 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5165 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5166 X = property(GetX,doc="See `GetX`")
5167 Y = property(GetY,doc="See `GetY`")
5168 _core_.MouseEvent_swigregister(MouseEvent)
5169
5170 #---------------------------------------------------------------------------
5171
5172 class SetCursorEvent(Event):
5173 """
5174 A SetCursorEvent is generated when the mouse cursor is about to be set
5175 as a result of mouse motion. This event gives the application the
5176 chance to perform specific mouse cursor processing based on the
5177 current position of the mouse within the window. Use the `SetCursor`
5178 method to specify the cursor you want to be displayed.
5179 """
5180 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5181 __repr__ = _swig_repr
5182 def __init__(self, *args, **kwargs):
5183 """
5184 __init__(self, int x=0, int y=0) -> SetCursorEvent
5185
5186 Construct a new `wx.SetCursorEvent`.
5187 """
5188 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
5189 def GetX(*args, **kwargs):
5190 """
5191 GetX(self) -> int
5192
5193 Returns the X coordinate of the mouse in client coordinates.
5194 """
5195 return _core_.SetCursorEvent_GetX(*args, **kwargs)
5196
5197 def GetY(*args, **kwargs):
5198 """
5199 GetY(self) -> int
5200
5201 Returns the Y coordinate of the mouse in client coordinates.
5202 """
5203 return _core_.SetCursorEvent_GetY(*args, **kwargs)
5204
5205 def SetCursor(*args, **kwargs):
5206 """
5207 SetCursor(self, Cursor cursor)
5208
5209 Sets the cursor associated with this event.
5210 """
5211 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
5212
5213 def GetCursor(*args, **kwargs):
5214 """
5215 GetCursor(self) -> Cursor
5216
5217 Returns a reference to the cursor specified by this event.
5218 """
5219 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
5220
5221 def HasCursor(*args, **kwargs):
5222 """
5223 HasCursor(self) -> bool
5224
5225 Returns true if the cursor specified by this event is a valid cursor.
5226 """
5227 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
5228
5229 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5230 X = property(GetX,doc="See `GetX`")
5231 Y = property(GetY,doc="See `GetY`")
5232 _core_.SetCursorEvent_swigregister(SetCursorEvent)
5233
5234 #---------------------------------------------------------------------------
5235
5236 class KeyEvent(Event):
5237 """
5238 This event class contains information about keypress and character
5239 events. These events are only sent to the widget that currently has
5240 the keyboard focus.
5241
5242 Notice that there are three different kinds of keyboard events in
5243 wxWidgets: key down and up events and char events. The difference
5244 between the first two is clear - the first corresponds to a key press
5245 and the second to a key release - otherwise they are identical. Just
5246 note that if the key is maintained in a pressed state you will
5247 typically get a lot of (automatically generated) down events but only
5248 one up so it is wrong to assume that there is one up event
5249 corresponding to each down one.
5250
5251 Both key events provide untranslated key codes while the char event
5252 carries the translated one. The untranslated code for alphanumeric
5253 keys is always an upper case value. For the other keys it is one of
5254 WXK_XXX values from the keycodes table. The translated key is, in
5255 general, the character the user expects to appear as the result of the
5256 key combination when typing the text into a text entry zone, for
5257 example.
5258
5259 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5260 and the standard US keyboard): when the 'A' key is pressed, the key
5261 down event key code is equal to ASCII A == 65. But the char event key
5262 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5263 'A' keys simultaneously , the key code in key down event will still be
5264 just 'A' while the char event key code parameter will now be 'A' as
5265 well.
5266
5267 Although in this simple case it is clear that the correct key code
5268 could be found in the key down event handler by checking the value
5269 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5270 as for non alphanumeric keys or non-US keyboard layouts the
5271 translation is keyboard-layout dependent and can only be done properly
5272 by the system itself.
5273
5274 Another kind of translation is done when the control key is pressed:
5275 for example, for CTRL-A key press the key down event still carries the
5276 same key code 'A' as usual but the char event will have key code of 1,
5277 the ASCII value of this key combination.
5278
5279 You may discover how the other keys on your system behave
5280 interactively by running the KeyEvents sample in the wxPython demo and
5281 pressing some keys while the blue box at the top has the keyboard
5282 focus.
5283
5284 **Note**: If a key down event is caught and the event handler does not
5285 call event.Skip() then the coresponding char event will not
5286 happen. This is by design and enables the programs that handle both
5287 types of events to be a bit simpler.
5288
5289 **Note for Windows programmers**: The key and char events in wxWidgets
5290 are similar to but slightly different from Windows WM_KEYDOWN and
5291 WM_CHAR events. In particular, Alt-x combination will generate a char
5292 event in wxWidgets (unless it is used as an accelerator).
5293
5294 **Tip**: be sure to call event.Skip() for events that you don't
5295 process in key event function, otherwise menu shortcuts may cease to
5296 work under Windows.
5297
5298 """
5299 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5300 __repr__ = _swig_repr
5301 def __init__(self, *args, **kwargs):
5302 """
5303 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5304
5305 Construct a new `wx.KeyEvent`. Valid event types are:
5306 *
5307 """
5308 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
5309 def GetModifiers(*args, **kwargs):
5310 """
5311 GetModifiers(self) -> int
5312
5313 Returns a bitmask of the current modifier settings. Can be used to
5314 check if the key event has exactly the given modifiers without having
5315 to explicitly check that the other modifiers are not down. For
5316 example::
5317
5318 if event.GetModifers() == wx.MOD_CONTROL:
5319 DoSomething()
5320
5321 """
5322 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5323
5324 def ControlDown(*args, **kwargs):
5325 """
5326 ControlDown(self) -> bool
5327
5328 Returns ``True`` if the Control key was down at the time of the event.
5329 """
5330 return _core_.KeyEvent_ControlDown(*args, **kwargs)
5331
5332 def MetaDown(*args, **kwargs):
5333 """
5334 MetaDown(self) -> bool
5335
5336 Returns ``True`` if the Meta key was down at the time of the event.
5337 """
5338 return _core_.KeyEvent_MetaDown(*args, **kwargs)
5339
5340 def AltDown(*args, **kwargs):
5341 """
5342 AltDown(self) -> bool
5343
5344 Returns ``True`` if the Alt key was down at the time of the event.
5345 """
5346 return _core_.KeyEvent_AltDown(*args, **kwargs)
5347
5348 def ShiftDown(*args, **kwargs):
5349 """
5350 ShiftDown(self) -> bool
5351
5352 Returns ``True`` if the Shift key was down at the time of the event.
5353 """
5354 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5355
5356 def CmdDown(*args, **kwargs):
5357 """
5358 CmdDown(self) -> bool
5359
5360 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5361 platforms but the special "Apple" (a.k.a as "Command") key on
5362 Macs. It makes often sense to use it instead of, say, `ControlDown`
5363 because Cmd key is used for the same thing under Mac as Ctrl
5364 elsewhere. The Ctrl still exists, it's just not used for this
5365 purpose. So for non-Mac platforms this is the same as `ControlDown`
5366 and Macs this is the same as `MetaDown`.
5367 """
5368 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5369
5370 def HasModifiers(*args, **kwargs):
5371 """
5372 HasModifiers(self) -> bool
5373
5374 Returns true if either CTRL or ALT keys was down at the time of the
5375 key event. Note that this function does not take into account neither
5376 SHIFT nor META key states (the reason for ignoring the latter is that
5377 it is common for NUMLOCK key to be configured as META under X but the
5378 key presses even while NUMLOCK is on should be still processed
5379 normally).
5380 """
5381 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5382
5383 def GetKeyCode(*args, **kwargs):
5384 """
5385 GetKeyCode(self) -> int
5386
5387 Returns the virtual key code. ASCII events return normal ASCII values,
5388 while non-ASCII events return values such as WXK_LEFT for the left
5389 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5390 codes.
5391
5392 Note that in Unicode build, the returned value is meaningful only if
5393 the user entered a character that can be represented in current
5394 locale's default charset. You can obtain the corresponding Unicode
5395 character using `GetUnicodeKey`.
5396 """
5397 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5398
5399 def GetUnicodeKey(*args, **kwargs):
5400 """
5401 GetUnicodeKey(self) -> int
5402
5403 Returns the Unicode character corresponding to this key event. This
5404 function is only meaningfule in a Unicode build of wxPython.
5405 """
5406 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
5407
5408 GetUniChar = GetUnicodeKey
5409 def SetUnicodeKey(*args, **kwargs):
5410 """
5411 SetUnicodeKey(self, int uniChar)
5412
5413 Set the Unicode value of the key event, but only if this is a Unicode
5414 build of wxPython.
5415 """
5416 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5417
5418 def GetRawKeyCode(*args, **kwargs):
5419 """
5420 GetRawKeyCode(self) -> unsigned int
5421
5422 Returns the raw key code for this event. This is a platform-dependent
5423 scan code which should only be used in advanced
5424 applications. Currently the raw key codes are not supported by all
5425 ports.
5426 """
5427 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5428
5429 def GetRawKeyFlags(*args, **kwargs):
5430 """
5431 GetRawKeyFlags(self) -> unsigned int
5432
5433 Returns the low level key flags for this event. The flags are
5434 platform-dependent and should only be used in advanced applications.
5435 Currently the raw key flags are not supported by all ports.
5436 """
5437 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5438
5439 def GetPosition(*args, **kwargs):
5440 """
5441 GetPosition(self) -> Point
5442
5443 Find the position of the event, if applicable.
5444 """
5445 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5446
5447 def GetPositionTuple(*args, **kwargs):
5448 """
5449 GetPositionTuple() -> (x,y)
5450
5451 Find the position of the event, if applicable.
5452 """
5453 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5454
5455 def GetX(*args, **kwargs):
5456 """
5457 GetX(self) -> int
5458
5459 Returns the X position (in client coordinates) of the event, if
5460 applicable.
5461 """
5462 return _core_.KeyEvent_GetX(*args, **kwargs)
5463
5464 def GetY(*args, **kwargs):
5465 """
5466 GetY(self) -> int
5467
5468 Returns the Y position (in client coordinates) of the event, if
5469 applicable.
5470 """
5471 return _core_.KeyEvent_GetY(*args, **kwargs)
5472
5473 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5474 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5475 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5476 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5477 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5478 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5479 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5480 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5481 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5482 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5483 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5484 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5485 Position = property(GetPosition,doc="See `GetPosition`")
5486 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5487 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5488 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5489 X = property(GetX,doc="See `GetX`")
5490 Y = property(GetY,doc="See `GetY`")
5491 _core_.KeyEvent_swigregister(KeyEvent)
5492
5493 #---------------------------------------------------------------------------
5494
5495 class SizeEvent(Event):
5496 """
5497 A size event holds information about size change events. The EVT_SIZE
5498 handler function will be called when the window it is bound to has
5499 been resized.
5500
5501 Note that the size passed is of the whole window: call
5502 `wx.Window.GetClientSize` for the area which may be used by the
5503 application.
5504
5505 When a window is resized, usually only a small part of the window is
5506 damaged and and that area is all that is in the update region for the
5507 next paint event. However, if your drawing depends on the size of the
5508 window, you may need to clear the DC explicitly and repaint the whole
5509 window. In which case, you may need to call `wx.Window.Refresh` to
5510 invalidate the entire window.
5511
5512 """
5513 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5514 __repr__ = _swig_repr
5515 def __init__(self, *args, **kwargs):
5516 """
5517 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5518
5519 Construct a new ``wx.SizeEvent``.
5520 """
5521 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5522 def GetSize(*args, **kwargs):
5523 """
5524 GetSize(self) -> Size
5525
5526 Returns the entire size of the window generating the size change
5527 event.
5528 """
5529 return _core_.SizeEvent_GetSize(*args, **kwargs)
5530
5531 def GetRect(*args, **kwargs):
5532 """GetRect(self) -> Rect"""
5533 return _core_.SizeEvent_GetRect(*args, **kwargs)
5534
5535 def SetRect(*args, **kwargs):
5536 """SetRect(self, Rect rect)"""
5537 return _core_.SizeEvent_SetRect(*args, **kwargs)
5538
5539 def SetSize(*args, **kwargs):
5540 """SetSize(self, Size size)"""
5541 return _core_.SizeEvent_SetSize(*args, **kwargs)
5542
5543 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5544 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5545 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5546 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5547 _core_.SizeEvent_swigregister(SizeEvent)
5548
5549 #---------------------------------------------------------------------------
5550
5551 class MoveEvent(Event):
5552 """
5553 This event object is sent for EVT_MOVE event bindings when a window is
5554 moved to a new position.
5555 """
5556 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5557 __repr__ = _swig_repr
5558 def __init__(self, *args, **kwargs):
5559 """
5560 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5561
5562 Constructor.
5563 """
5564 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5565 def GetPosition(*args, **kwargs):
5566 """
5567 GetPosition(self) -> Point
5568
5569 Returns the position of the window generating the move change event.
5570 """
5571 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5572
5573 def GetRect(*args, **kwargs):
5574 """GetRect(self) -> Rect"""
5575 return _core_.MoveEvent_GetRect(*args, **kwargs)
5576
5577 def SetRect(*args, **kwargs):
5578 """SetRect(self, Rect rect)"""
5579 return _core_.MoveEvent_SetRect(*args, **kwargs)
5580
5581 def SetPosition(*args, **kwargs):
5582 """SetPosition(self, Point pos)"""
5583 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5584
5585 m_pos = property(GetPosition, SetPosition)
5586 m_rect = property(GetRect, SetRect)
5587
5588 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5589 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5590 _core_.MoveEvent_swigregister(MoveEvent)
5591
5592 #---------------------------------------------------------------------------
5593
5594 class PaintEvent(Event):
5595 """
5596 A paint event is sent when a window's contents needs to be repainted.
5597 Note that in an EVT_PAINT handler the application must *always* create
5598 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5599 Windows assumes that the window has not been painted yet and will send
5600 the event again, causing endless refreshes.
5601
5602 You can optimize painting by retrieving the rectangles that have been
5603 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5604 and only repainting these rectangles. The rectangles are in terms of
5605 the client area, and are unscrolled, so you will need to do some
5606 calculations using the current view position to obtain logical,
5607 scrolled units.
5608
5609 """
5610 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5611 __repr__ = _swig_repr
5612 def __init__(self, *args, **kwargs):
5613 """__init__(self, int Id=0) -> PaintEvent"""
5614 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5615 _core_.PaintEvent_swigregister(PaintEvent)
5616
5617 class NcPaintEvent(Event):
5618 """Proxy of C++ NcPaintEvent class"""
5619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5620 __repr__ = _swig_repr
5621 def __init__(self, *args, **kwargs):
5622 """__init__(self, int winid=0) -> NcPaintEvent"""
5623 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5624 _core_.NcPaintEvent_swigregister(NcPaintEvent)
5625
5626 #---------------------------------------------------------------------------
5627
5628 class EraseEvent(Event):
5629 """
5630 An erase event is sent whenever the background of a window needs to be
5631 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5632 binder. On some platforms, such as GTK+, this event is simulated
5633 (simply generated just before the paint event) and may cause flicker.
5634
5635 To paint a custom background use the `GetDC` method and use the returned
5636 device context if it is not ``None``, otherwise create a temporary
5637 `wx.ClientDC` and draw on that.
5638
5639 """
5640 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5641 __repr__ = _swig_repr
5642 def __init__(self, *args, **kwargs):
5643 """
5644 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5645
5646 Constructor
5647 """
5648 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5649 def GetDC(*args, **kwargs):
5650 """
5651 GetDC(self) -> DC
5652
5653 Returns the device context the event handler should draw upon. If
5654 ``None`` is returned then create a temporary `wx.ClientDC` and use
5655 that instead.
5656 """
5657 return _core_.EraseEvent_GetDC(*args, **kwargs)
5658
5659 DC = property(GetDC,doc="See `GetDC`")
5660 _core_.EraseEvent_swigregister(EraseEvent)
5661
5662 #---------------------------------------------------------------------------
5663
5664 class FocusEvent(Event):
5665 """
5666 A focus event is sent when a window's focus changes. The window losing
5667 focus receives an EVT_KILL_FOCUS event while the window gaining it
5668 gets an EVT_SET_FOCUS event.
5669
5670 Notice that the set focus event happens both when the user gives focus
5671 to the window (whether using the mouse or keyboard) and when it is
5672 done from the program itself using `wx.Window.SetFocus`.
5673
5674 """
5675 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5676 __repr__ = _swig_repr
5677 def __init__(self, *args, **kwargs):
5678 """
5679 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5680
5681 Constructor
5682 """
5683 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5684 def GetWindow(*args, **kwargs):
5685 """
5686 GetWindow(self) -> Window
5687
5688 Returns the other window associated with this event, that is the
5689 window which had the focus before for the EVT_SET_FOCUS event and the
5690 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5691
5692 Warning: the window returned may be None!
5693 """
5694 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5695
5696 def SetWindow(*args, **kwargs):
5697 """SetWindow(self, Window win)"""
5698 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5699
5700 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5701 _core_.FocusEvent_swigregister(FocusEvent)
5702
5703 #---------------------------------------------------------------------------
5704
5705 class ChildFocusEvent(CommandEvent):
5706 """
5707 A child focus event is sent to a (parent-)window when one of its child
5708 windows gains focus, so that the window could restore the focus back
5709 to its corresponding child if it loses it now and regains later.
5710
5711 Notice that child window is the direct child of the window receiving
5712 the event, and so may not be the actual widget recieving focus if it
5713 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5714 to get the widget that is actually receiving focus.
5715 """
5716 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5717 __repr__ = _swig_repr
5718 def __init__(self, *args, **kwargs):
5719 """
5720 __init__(self, Window win=None) -> ChildFocusEvent
5721
5722 Constructor
5723 """
5724 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5725 def GetWindow(*args, **kwargs):
5726 """
5727 GetWindow(self) -> Window
5728
5729 The window, or (grand)parent of the window which has just received the
5730 focus.
5731 """
5732 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5733
5734 Window = property(GetWindow,doc="See `GetWindow`")
5735 _core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5736
5737 #---------------------------------------------------------------------------
5738
5739 class ActivateEvent(Event):
5740 """
5741 An activate event is sent when a top-level window or the entire
5742 application is being activated or deactivated.
5743
5744 A top-level window (a dialog or frame) receives an activate event when
5745 is being activated or deactivated. This is indicated visually by the
5746 title bar changing colour, and a subwindow gaining the keyboard focus.
5747 An application is activated or deactivated when one of its frames
5748 becomes activated, or a frame becomes inactivate resulting in all
5749 application frames being inactive.
5750
5751 Please note that usually you should call event.Skip() in your handlers
5752 for these events so the default handlers will still be called, as not
5753 doing so can result in strange effects.
5754
5755 """
5756 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5757 __repr__ = _swig_repr
5758 def __init__(self, *args, **kwargs):
5759 """
5760 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5761
5762 Constructor
5763 """
5764 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5765 def GetActive(*args, **kwargs):
5766 """
5767 GetActive(self) -> bool
5768
5769 Returns true if the application or window is being activated, false
5770 otherwise.
5771 """
5772 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5773
5774 Active = property(GetActive,doc="See `GetActive`")
5775 _core_.ActivateEvent_swigregister(ActivateEvent)
5776
5777 #---------------------------------------------------------------------------
5778
5779 class InitDialogEvent(Event):
5780 """
5781 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5782 any window when `wx.Window.InitDialog` is called. Handlers for this
5783 event can transfer data to the window, or anything else that should be
5784 done before the user begins editing the form. The default handler
5785 calls `wx.Window.TransferDataToWindow`.
5786 """
5787 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5788 __repr__ = _swig_repr
5789 def __init__(self, *args, **kwargs):
5790 """
5791 __init__(self, int Id=0) -> InitDialogEvent
5792
5793 Constructor
5794 """
5795 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5796 _core_.InitDialogEvent_swigregister(InitDialogEvent)
5797
5798 #---------------------------------------------------------------------------
5799
5800 class MenuEvent(Event):
5801 """
5802 This class is used for a variety of menu-related events. Note that
5803 these do not include menu command events, which are handled by sending
5804 `wx.CommandEvent` objects.
5805
5806 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5807 text in the first field of the status bar.
5808 """
5809 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5810 __repr__ = _swig_repr
5811 def __init__(self, *args, **kwargs):
5812 """
5813 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5814
5815 Constructor
5816 """
5817 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5818 def GetMenuId(*args, **kwargs):
5819 """
5820 GetMenuId(self) -> int
5821
5822 Returns the menu identifier associated with the event. This method
5823 should be only used with the HIGHLIGHT events.
5824 """
5825 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5826
5827 def IsPopup(*args, **kwargs):
5828 """
5829 IsPopup(self) -> bool
5830
5831 Returns ``True`` if the menu which is being opened or closed is a
5832 popup menu, ``False`` if it is a normal one. This method should only
5833 be used with the OPEN and CLOSE events.
5834 """
5835 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5836
5837 def GetMenu(*args, **kwargs):
5838 """
5839 GetMenu(self) -> Menu
5840
5841 Returns the menu which is being opened or closed. This method should
5842 only be used with the OPEN and CLOSE events.
5843 """
5844 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5845
5846 Menu = property(GetMenu,doc="See `GetMenu`")
5847 MenuId = property(GetMenuId,doc="See `GetMenuId`")
5848 _core_.MenuEvent_swigregister(MenuEvent)
5849
5850 #---------------------------------------------------------------------------
5851
5852 class CloseEvent(Event):
5853 """
5854 This event class contains information about window and session close
5855 events.
5856
5857 The handler function for EVT_CLOSE is called when the user has tried
5858 to close a a frame or dialog box using the window manager controls or
5859 the system menu. It can also be invoked by the application itself
5860 programmatically, for example by calling the `wx.Window.Close`
5861 function.
5862
5863 You should check whether the application is forcing the deletion of
5864 the window using `CanVeto`. If it returns ``False``, you must destroy
5865 the window using `wx.Window.Destroy`. If the return value is ``True``,
5866 it is up to you whether you respond by destroying the window or not.
5867 For example you may wish to display a message dialog prompting to save
5868 files or to cancel the close.
5869
5870 If you don't destroy the window, you should call `Veto` to let the
5871 calling code know that you did not destroy the window. This allows the
5872 `wx.Window.Close` function to return ``True`` or ``False`` depending
5873 on whether the close instruction was honored or not.
5874 """
5875 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5876 __repr__ = _swig_repr
5877 def __init__(self, *args, **kwargs):
5878 """
5879 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5880
5881 Constructor.
5882 """
5883 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5884 def SetLoggingOff(*args, **kwargs):
5885 """
5886 SetLoggingOff(self, bool logOff)
5887
5888 Sets the 'logging off' flag.
5889 """
5890 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5891
5892 def GetLoggingOff(*args, **kwargs):
5893 """
5894 GetLoggingOff(self) -> bool
5895
5896 Returns ``True`` if the user is logging off or ``False`` if the
5897 system is shutting down. This method can only be called for end
5898 session and query end session events, it doesn't make sense for close
5899 window event.
5900 """
5901 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5902
5903 def Veto(*args, **kwargs):
5904 """
5905 Veto(self, bool veto=True)
5906
5907 Call this from your event handler to veto a system shutdown or to
5908 signal to the calling application that a window close did not happen.
5909
5910 You can only veto a shutdown or close if `CanVeto` returns true.
5911 """
5912 return _core_.CloseEvent_Veto(*args, **kwargs)
5913
5914 def GetVeto(*args, **kwargs):
5915 """GetVeto(self) -> bool"""
5916 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5917
5918 def SetCanVeto(*args, **kwargs):
5919 """
5920 SetCanVeto(self, bool canVeto)
5921
5922 Sets the 'can veto' flag.
5923 """
5924 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5925
5926 def CanVeto(*args, **kwargs):
5927 """
5928 CanVeto(self) -> bool
5929
5930 Returns true if you can veto a system shutdown or a window close
5931 event. Vetoing a window close event is not possible if the calling
5932 code wishes to force the application to exit, and so this function
5933 must be called to check this.
5934 """
5935 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5936
5937 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5938 _core_.CloseEvent_swigregister(CloseEvent)
5939
5940 #---------------------------------------------------------------------------
5941
5942 class ShowEvent(Event):
5943 """An EVT_SHOW event is sent when a window is shown or hidden."""
5944 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5945 __repr__ = _swig_repr
5946 def __init__(self, *args, **kwargs):
5947 """
5948 __init__(self, int winid=0, bool show=False) -> ShowEvent
5949
5950 An EVT_SHOW event is sent when a window is shown or hidden.
5951 """
5952 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5953 def SetShow(*args, **kwargs):
5954 """SetShow(self, bool show)"""
5955 return _core_.ShowEvent_SetShow(*args, **kwargs)
5956
5957 def GetShow(*args, **kwargs):
5958 """GetShow(self) -> bool"""
5959 return _core_.ShowEvent_GetShow(*args, **kwargs)
5960
5961 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5962 _core_.ShowEvent_swigregister(ShowEvent)
5963
5964 #---------------------------------------------------------------------------
5965
5966 class IconizeEvent(Event):
5967 """
5968 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5969 restored.
5970 """
5971 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5972 __repr__ = _swig_repr
5973 def __init__(self, *args, **kwargs):
5974 """
5975 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5976
5977 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5978 restored.
5979 """
5980 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5981 def Iconized(*args, **kwargs):
5982 """
5983 Iconized(self) -> bool
5984
5985 Returns ``True`` if the frame has been iconized, ``False`` if it has
5986 been restored.
5987 """
5988 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5989
5990 _core_.IconizeEvent_swigregister(IconizeEvent)
5991
5992 #---------------------------------------------------------------------------
5993
5994 class MaximizeEvent(Event):
5995 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5996 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5997 __repr__ = _swig_repr
5998 def __init__(self, *args, **kwargs):
5999 """
6000 __init__(self, int id=0) -> MaximizeEvent
6001
6002 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
6003 """
6004 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
6005 _core_.MaximizeEvent_swigregister(MaximizeEvent)
6006
6007 #---------------------------------------------------------------------------
6008
6009 class DropFilesEvent(Event):
6010 """
6011 This class is used for drop files events, that is, when files have
6012 been dropped onto the window. This functionality is only available
6013 under Windows. The window must have previously been enabled for
6014 dropping by calling `wx.Window.DragAcceptFiles`.
6015
6016 Important note: this is a separate implementation to the more general
6017 drag and drop implementation using `wx.FileDropTarget`, and etc. This
6018 implementation uses the older, Windows message-based approach of
6019 dropping files.
6020
6021 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
6022 events.
6023
6024 """
6025 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6026 def __init__(self): raise AttributeError, "No constructor defined"
6027 __repr__ = _swig_repr
6028 def GetPosition(*args, **kwargs):
6029 """
6030 GetPosition(self) -> Point
6031
6032 Returns the position at which the files were dropped.
6033 """
6034 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
6035
6036 def GetNumberOfFiles(*args, **kwargs):
6037 """
6038 GetNumberOfFiles(self) -> int
6039
6040 Returns the number of files dropped.
6041 """
6042 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
6043
6044 def GetFiles(*args, **kwargs):
6045 """
6046 GetFiles(self) -> PyObject
6047
6048 Returns a list of the filenames that were dropped.
6049 """
6050 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
6051
6052 Files = property(GetFiles,doc="See `GetFiles`")
6053 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
6054 Position = property(GetPosition,doc="See `GetPosition`")
6055 _core_.DropFilesEvent_swigregister(DropFilesEvent)
6056
6057 #---------------------------------------------------------------------------
6058
6059 UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
6060 UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
6061 class UpdateUIEvent(CommandEvent):
6062 """
6063 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
6064 wxWidgets to give an application the chance to update various user
6065 interface elements.
6066
6067 Without update UI events, an application has to work hard to
6068 check/uncheck, enable/disable, and set the text for elements such as
6069 menu items and toolbar buttons. The code for doing this has to be
6070 mixed up with the code that is invoked when an action is invoked for a
6071 menu item or button.
6072
6073 With update UI events, you define an event handler to look at the
6074 state of the application and change UI elements accordingly. wxWidgets
6075 will call your handler functions in idle time, so you don't have to
6076 worry where to call this code. In addition to being a clearer and more
6077 declarative method, it also means you don't have to worry whether
6078 you're updating a toolbar or menubar identifier. The same handler can
6079 update a menu item and toolbar button, if the ID values are the same.
6080
6081 Instead of directly manipulating the menu or button, you call
6082 functions in the event object, such as `Check`. wxWidgets will
6083 determine whether such a call has been made, and which UI element to
6084 update.
6085
6086 These events will work for popup menus as well as menubars. Just
6087 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6088 any UI events for the window that owns the menu.
6089
6090 If you find that the overhead of UI update processing is affecting
6091 your application, you can do one or both of the following:
6092
6093 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6094 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6095 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6096 receive update events. No other windows will receive update
6097 events.
6098
6099 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6100 value to set the delay between updates. You may need to call
6101 `wx.Window.UpdateWindowUI` at critical points, for example when
6102 a dialog is about to be shown, in case the user sees a slight
6103 delay before windows are updated.
6104
6105 Note that although events are sent in idle time, defining a EVT_IDLE
6106 handler for a window does not affect this because the events are sent
6107 from an internal idle handler.
6108
6109 wxWidgets tries to optimize update events on some platforms. On
6110 Windows and GTK+, events for menubar items are only sent when the menu
6111 is about to be shown, and not in idle time.
6112
6113 """
6114 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6115 __repr__ = _swig_repr
6116 def __init__(self, *args, **kwargs):
6117 """
6118 __init__(self, int commandId=0) -> UpdateUIEvent
6119
6120 Constructor
6121 """
6122 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
6123 def GetChecked(*args, **kwargs):
6124 """
6125 GetChecked(self) -> bool
6126
6127 Returns ``True`` if the UI element should be checked.
6128 """
6129 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
6130
6131 def GetEnabled(*args, **kwargs):
6132 """
6133 GetEnabled(self) -> bool
6134
6135 Returns ``True`` if the UI element should be enabled.
6136 """
6137 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6138
6139 def GetShown(*args, **kwargs):
6140 """
6141 GetShown(self) -> bool
6142
6143 Returns ``True`` if the UI element should be shown.
6144 """
6145 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6146
6147 def GetText(*args, **kwargs):
6148 """
6149 GetText(self) -> String
6150
6151 Returns the text that should be set for the UI element.
6152 """
6153 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6154
6155 def GetSetText(*args, **kwargs):
6156 """
6157 GetSetText(self) -> bool
6158
6159 Returns ``True`` if the application has called `SetText`. For
6160 wxWidgets internal use only.
6161 """
6162 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6163
6164 def GetSetChecked(*args, **kwargs):
6165 """
6166 GetSetChecked(self) -> bool
6167
6168 Returns ``True`` if the application has called `Check`. For wxWidgets
6169 internal use only.
6170 """
6171 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6172
6173 def GetSetEnabled(*args, **kwargs):
6174 """
6175 GetSetEnabled(self) -> bool
6176
6177 Returns ``True`` if the application has called `Enable`. For wxWidgets
6178 internal use only.
6179 """
6180 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6181
6182 def GetSetShown(*args, **kwargs):
6183 """
6184 GetSetShown(self) -> bool
6185
6186 Returns ``True`` if the application has called `Show`. For wxWidgets
6187 internal use only.
6188 """
6189 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6190
6191 def Check(*args, **kwargs):
6192 """
6193 Check(self, bool check)
6194
6195 Check or uncheck the UI element.
6196 """
6197 return _core_.UpdateUIEvent_Check(*args, **kwargs)
6198
6199 def Enable(*args, **kwargs):
6200 """
6201 Enable(self, bool enable)
6202
6203 Enable or disable the UI element.
6204 """
6205 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6206
6207 def Show(*args, **kwargs):
6208 """
6209 Show(self, bool show)
6210
6211 Show or hide the UI element.
6212 """
6213 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6214
6215 def SetText(*args, **kwargs):
6216 """
6217 SetText(self, String text)
6218
6219 Sets the text for this UI element.
6220 """
6221 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6222
6223 def SetUpdateInterval(*args, **kwargs):
6224 """
6225 SetUpdateInterval(long updateInterval)
6226
6227 Sets the interval between updates in milliseconds. Set to -1 to
6228 disable updates, or to 0 to update as frequently as possible. The
6229 default is 0.
6230
6231 Use this to reduce the overhead of UI update events if your
6232 application has a lot of windows. If you set the value to -1 or
6233 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6234 at appropriate points in your application, such as when a dialog is
6235 about to be shown.
6236 """
6237 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6238
6239 SetUpdateInterval = staticmethod(SetUpdateInterval)
6240 def GetUpdateInterval(*args, **kwargs):
6241 """
6242 GetUpdateInterval() -> long
6243
6244 Returns the current interval between updates in milliseconds. -1
6245 disables updates, 0 updates as frequently as possible.
6246 """
6247 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6248
6249 GetUpdateInterval = staticmethod(GetUpdateInterval)
6250 def CanUpdate(*args, **kwargs):
6251 """
6252 CanUpdate(Window win) -> bool
6253
6254 Returns ``True`` if it is appropriate to update (send UI update events
6255 to) this window.
6256
6257 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6258 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6259 events were last sent in idle time, and the update interval, to
6260 determine whether events should be sent to this window now. By default
6261 this will always return true because the update mode is initially
6262 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6263 events will be sent as often as possible. You can reduce the frequency
6264 that events are sent by changing the mode and/or setting an update
6265 interval.
6266
6267 """
6268 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6269
6270 CanUpdate = staticmethod(CanUpdate)
6271 def ResetUpdateTime(*args, **kwargs):
6272 """
6273 ResetUpdateTime()
6274
6275 Used internally to reset the last-updated time to the current time. It
6276 is assumed that update events are normally sent in idle time, so this
6277 is called at the end of idle processing.
6278 """
6279 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6280
6281 ResetUpdateTime = staticmethod(ResetUpdateTime)
6282 def SetMode(*args, **kwargs):
6283 """
6284 SetMode(int mode)
6285
6286 Specify how wxWidgets will send update events: to all windows, or only
6287 to those which specify that they will process the events.
6288
6289 The mode may be one of the following values:
6290
6291 ============================= ==========================================
6292 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6293 is the default setting.
6294 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6295 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6296 style set.
6297 ============================= ==========================================
6298
6299 """
6300 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6301
6302 SetMode = staticmethod(SetMode)
6303 def GetMode(*args, **kwargs):
6304 """
6305 GetMode() -> int
6306
6307 Returns a value specifying how wxWidgets will send update events: to
6308 all windows, or only to those which specify that they will process the
6309 events.
6310 """
6311 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6312
6313 GetMode = staticmethod(GetMode)
6314 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6315 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6316 Shown = property(GetShown,Show,doc="See `GetShown`")
6317 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
6318 _core_.UpdateUIEvent_swigregister(UpdateUIEvent)
6319
6320 def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
6321 """
6322 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6323
6324 Sets the interval between updates in milliseconds. Set to -1 to
6325 disable updates, or to 0 to update as frequently as possible. The
6326 default is 0.
6327
6328 Use this to reduce the overhead of UI update events if your
6329 application has a lot of windows. If you set the value to -1 or
6330 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6331 at appropriate points in your application, such as when a dialog is
6332 about to be shown.
6333 """
6334 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6335
6336 def UpdateUIEvent_GetUpdateInterval(*args):
6337 """
6338 UpdateUIEvent_GetUpdateInterval() -> long
6339
6340 Returns the current interval between updates in milliseconds. -1
6341 disables updates, 0 updates as frequently as possible.
6342 """
6343 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
6344
6345 def UpdateUIEvent_CanUpdate(*args, **kwargs):
6346 """
6347 UpdateUIEvent_CanUpdate(Window win) -> bool
6348
6349 Returns ``True`` if it is appropriate to update (send UI update events
6350 to) this window.
6351
6352 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6353 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6354 events were last sent in idle time, and the update interval, to
6355 determine whether events should be sent to this window now. By default
6356 this will always return true because the update mode is initially
6357 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6358 events will be sent as often as possible. You can reduce the frequency
6359 that events are sent by changing the mode and/or setting an update
6360 interval.
6361
6362 """
6363 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6364
6365 def UpdateUIEvent_ResetUpdateTime(*args):
6366 """
6367 UpdateUIEvent_ResetUpdateTime()
6368
6369 Used internally to reset the last-updated time to the current time. It
6370 is assumed that update events are normally sent in idle time, so this
6371 is called at the end of idle processing.
6372 """
6373 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
6374
6375 def UpdateUIEvent_SetMode(*args, **kwargs):
6376 """
6377 UpdateUIEvent_SetMode(int mode)
6378
6379 Specify how wxWidgets will send update events: to all windows, or only
6380 to those which specify that they will process the events.
6381
6382 The mode may be one of the following values:
6383
6384 ============================= ==========================================
6385 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6386 is the default setting.
6387 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6388 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6389 style set.
6390 ============================= ==========================================
6391
6392 """
6393 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6394
6395 def UpdateUIEvent_GetMode(*args):
6396 """
6397 UpdateUIEvent_GetMode() -> int
6398
6399 Returns a value specifying how wxWidgets will send update events: to
6400 all windows, or only to those which specify that they will process the
6401 events.
6402 """
6403 return _core_.UpdateUIEvent_GetMode(*args)
6404
6405 #---------------------------------------------------------------------------
6406
6407 class SysColourChangedEvent(Event):
6408 """
6409 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6410 when the user changes the colour settings using the control
6411 panel. This is only applicable under Windows.
6412
6413 The default event handler for this event propagates the event to child
6414 windows, since Windows only sends the events to top-level windows. If
6415 intercepting this event for a top-level window, remember to call
6416 `Skip` so the the base class handler will still be executed, or to
6417 pass the event on to the window's children explicitly.
6418
6419 """
6420 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6421 __repr__ = _swig_repr
6422 def __init__(self, *args, **kwargs):
6423 """
6424 __init__(self) -> SysColourChangedEvent
6425
6426 Constructor
6427 """
6428 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
6429 _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
6430
6431 #---------------------------------------------------------------------------
6432
6433 class MouseCaptureChangedEvent(Event):
6434 """
6435 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6436 a window that loses its mouse capture. This is called even if
6437 `wx.Window.ReleaseMouse` was called by the application code. Handling
6438 this event allows an application to cater for unexpected capture
6439 releases which might otherwise confuse mouse handling code.
6440
6441 This event is implemented under Windows only.
6442 """
6443 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6444 __repr__ = _swig_repr
6445 def __init__(self, *args, **kwargs):
6446 """
6447 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6448
6449 Constructor
6450 """
6451 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6452 def GetCapturedWindow(*args, **kwargs):
6453 """
6454 GetCapturedWindow(self) -> Window
6455
6456 Returns the window that gained the capture, or ``None`` if it was a
6457 non-wxWidgets window.
6458 """
6459 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6460
6461 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6462 _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6463
6464 #---------------------------------------------------------------------------
6465
6466 class MouseCaptureLostEvent(Event):
6467 """
6468 A mouse capture lost event is sent to a window that obtained mouse
6469 capture, which was subsequently loss due to "external" event, for
6470 example when a dialog box is shown or if another application captures
6471 the mouse.
6472
6473 If this happens, this event is sent to all windows that are on the
6474 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6475 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6476 if the capture changes because of a call to CaptureMouse or
6477 ReleaseMouse.
6478
6479 This event is currently emitted under Windows only.
6480
6481 """
6482 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6483 __repr__ = _swig_repr
6484 def __init__(self, *args, **kwargs):
6485 """
6486 __init__(self, int winid=0) -> MouseCaptureLostEvent
6487
6488 A mouse capture lost event is sent to a window that obtained mouse
6489 capture, which was subsequently loss due to "external" event, for
6490 example when a dialog box is shown or if another application captures
6491 the mouse.
6492
6493 If this happens, this event is sent to all windows that are on the
6494 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6495 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6496 if the capture changes because of a call to CaptureMouse or
6497 ReleaseMouse.
6498
6499 This event is currently emitted under Windows only.
6500
6501 """
6502 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6503 _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6504
6505 #---------------------------------------------------------------------------
6506
6507 class DisplayChangedEvent(Event):
6508 """
6509 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6510 resolution has changed.
6511
6512 This event is implemented under Windows only.
6513 """
6514 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6515 __repr__ = _swig_repr
6516 def __init__(self, *args, **kwargs):
6517 """__init__(self) -> DisplayChangedEvent"""
6518 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6519 _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6520
6521 #---------------------------------------------------------------------------
6522
6523 class PaletteChangedEvent(Event):
6524 """
6525 An EVT_PALETTE_CHANGED event is sent when the system palette has
6526 changed, thereby giving each window a chance to redo their own to
6527 match.
6528
6529 This event is implemented under Windows only.
6530 """
6531 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6532 __repr__ = _swig_repr
6533 def __init__(self, *args, **kwargs):
6534 """
6535 __init__(self, int id=0) -> PaletteChangedEvent
6536
6537 An EVT_PALETTE_CHANGED event is sent when the system palette has
6538 changed, thereby giving each window a chance to redo their own to
6539 match.
6540
6541 This event is implemented under Windows only.
6542 """
6543 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6544 def SetChangedWindow(*args, **kwargs):
6545 """SetChangedWindow(self, Window win)"""
6546 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6547
6548 def GetChangedWindow(*args, **kwargs):
6549 """GetChangedWindow(self) -> Window"""
6550 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6551
6552 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6553 _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6554
6555 #---------------------------------------------------------------------------
6556
6557 class QueryNewPaletteEvent(Event):
6558 """
6559 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6560 focus and should re-do its palette.
6561
6562 This event is implemented under Windows only.
6563 """
6564 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6565 __repr__ = _swig_repr
6566 def __init__(self, *args, **kwargs):
6567 """
6568 __init__(self, int winid=0) -> QueryNewPaletteEvent
6569
6570 Constructor.
6571 """
6572 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6573 def SetPaletteRealized(*args, **kwargs):
6574 """
6575 SetPaletteRealized(self, bool realized)
6576
6577 App should set this if it changes the palette.
6578 """
6579 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6580
6581 def GetPaletteRealized(*args, **kwargs):
6582 """GetPaletteRealized(self) -> bool"""
6583 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6584
6585 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6586 _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6587
6588 #---------------------------------------------------------------------------
6589
6590 class NavigationKeyEvent(Event):
6591 """
6592 EVT_NAVIGATION_KEY events are used to control moving the focus between
6593 widgets, otherwise known as tab-traversal. You woudl normally not
6594 catch navigation events in applications as there are already
6595 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6596 it useful to send navigation events in certain situations to change
6597 the focus in certain ways, although it's probably easier to just call
6598 `wx.Window.Navigate`.
6599 """
6600 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6601 __repr__ = _swig_repr
6602 def __init__(self, *args, **kwargs):
6603 """__init__(self) -> NavigationKeyEvent"""
6604 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6605 def GetDirection(*args, **kwargs):
6606 """
6607 GetDirection(self) -> bool
6608
6609 Returns ``True`` if the direction is forward, ``False`` otherwise.
6610 """
6611 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6612
6613 def SetDirection(*args, **kwargs):
6614 """
6615 SetDirection(self, bool forward)
6616
6617 Specify the direction that the navigation should take. Usually the
6618 difference between using Tab and Shift-Tab.
6619 """
6620 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6621
6622 def IsWindowChange(*args, **kwargs):
6623 """
6624 IsWindowChange(self) -> bool
6625
6626 Returns ``True`` if window change is allowed.
6627 """
6628 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6629
6630 def SetWindowChange(*args, **kwargs):
6631 """
6632 SetWindowChange(self, bool ischange)
6633
6634 Specify if the navigation should be able to change parent windows.
6635 For example, changing notebook pages, etc. This is usually implemented
6636 by using Control-Tab.
6637 """
6638 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6639
6640 def IsFromTab(*args, **kwargs):
6641 """
6642 IsFromTab(self) -> bool
6643
6644 Returns ``True`` if the navigation event is originated from the Tab
6645 key.
6646 """
6647 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6648
6649 def SetFromTab(*args, **kwargs):
6650 """
6651 SetFromTab(self, bool bIs)
6652
6653 Set to true under MSW if the event was generated using the tab key.
6654 This is required for proper navogation over radio buttons.
6655 """
6656 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6657
6658 def SetFlags(*args, **kwargs):
6659 """
6660 SetFlags(self, long flags)
6661
6662 Set the navigation flags to a combination of the following:
6663
6664 * wx.NavigationKeyEvent.IsBackward
6665 * wx.NavigationKeyEvent.IsForward
6666 * wx.NavigationKeyEvent.WinChange
6667 * wx.NavigationKeyEvent.FromTab
6668
6669 """
6670 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6671
6672 def GetCurrentFocus(*args, **kwargs):
6673 """
6674 GetCurrentFocus(self) -> Window
6675
6676 Returns the child window which currenty has the focus. May be
6677 ``None``.
6678 """
6679 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6680
6681 def SetCurrentFocus(*args, **kwargs):
6682 """
6683 SetCurrentFocus(self, Window win)
6684
6685 Set the window that has the focus.
6686 """
6687 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6688
6689 IsBackward = _core_.NavigationKeyEvent_IsBackward
6690 IsForward = _core_.NavigationKeyEvent_IsForward
6691 WinChange = _core_.NavigationKeyEvent_WinChange
6692 FromTab = _core_.NavigationKeyEvent_FromTab
6693 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6694 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6695 _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6696
6697 #---------------------------------------------------------------------------
6698
6699 class WindowCreateEvent(CommandEvent):
6700 """
6701 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6702 underlying GUI object) exists.
6703 """
6704 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6705 __repr__ = _swig_repr
6706 def __init__(self, *args, **kwargs):
6707 """
6708 __init__(self, Window win=None) -> WindowCreateEvent
6709
6710 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6711 underlying GUI object) exists.
6712 """
6713 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6714 def GetWindow(*args, **kwargs):
6715 """
6716 GetWindow(self) -> Window
6717
6718 Returns the window that this event refers to.
6719 """
6720 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6721
6722 Window = property(GetWindow,doc="See `GetWindow`")
6723 _core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6724
6725 class WindowDestroyEvent(CommandEvent):
6726 """
6727 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6728 when the GUI window is destroyed.
6729
6730 When a class derived from `wx.Window` is destroyed its destructor will
6731 have already run by the time this event is sent. Therefore this event
6732 will not usually be received at all by the window itself. Since it is
6733 received after the destructor has run, an object should not try to
6734 handle its own wx.WindowDestroyEvent, but it can be used to get
6735 notification of the destruction of another window.
6736 """
6737 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6738 __repr__ = _swig_repr
6739 def __init__(self, *args, **kwargs):
6740 """
6741 __init__(self, Window win=None) -> WindowDestroyEvent
6742
6743 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6744 when the GUI window is destroyed.
6745
6746 When a class derived from `wx.Window` is destroyed its destructor will
6747 have already run by the time this event is sent. Therefore this event
6748 will not usually be received at all by the window itself. Since it is
6749 received after the destructor has run, an object should not try to
6750 handle its own wx.WindowDestroyEvent, but it can be used to get
6751 notification of the destruction of another window.
6752 """
6753 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6754 def GetWindow(*args, **kwargs):
6755 """
6756 GetWindow(self) -> Window
6757
6758 Returns the window that this event refers to.
6759 """
6760 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6761
6762 Window = property(GetWindow,doc="See `GetWindow`")
6763 _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6764
6765 #---------------------------------------------------------------------------
6766
6767 class ContextMenuEvent(CommandEvent):
6768 """
6769 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6770 give the application a chance to show a context (popup) menu.
6771 """
6772 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6773 __repr__ = _swig_repr
6774 def __init__(self, *args, **kwargs):
6775 """
6776 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6777
6778 Constructor.
6779 """
6780 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6781 def GetPosition(*args, **kwargs):
6782 """
6783 GetPosition(self) -> Point
6784
6785 Returns the position (in screen coordinants) at which the menu should
6786 be shown.
6787 """
6788 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6789
6790 def SetPosition(*args, **kwargs):
6791 """
6792 SetPosition(self, Point pos)
6793
6794 Sets the position at which the menu should be shown.
6795 """
6796 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6797
6798 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6799 _core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6800
6801 #---------------------------------------------------------------------------
6802
6803 IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6804 IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6805 class IdleEvent(Event):
6806 """
6807 This class is used for EVT_IDLE events, which are generated and sent
6808 when the application *becomes* idle. In other words, the when the
6809 event queue becomes empty then idle events are sent to all windows (by
6810 default) and as long as none of them call `RequestMore` then there are
6811 no more idle events until after the system event queue has some normal
6812 events and then becomes empty again.
6813
6814 By default, idle events are sent to all windows. If this is causing a
6815 significant overhead in your application, you can call
6816 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6817 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6818 which should receive idle events. Then idle events will only be sent
6819 to those windows and not to any others.
6820 """
6821 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6822 __repr__ = _swig_repr
6823 def __init__(self, *args, **kwargs):
6824 """
6825 __init__(self) -> IdleEvent
6826
6827 Constructor
6828 """
6829 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6830 def RequestMore(*args, **kwargs):
6831 """
6832 RequestMore(self, bool needMore=True)
6833
6834 Tells wxWidgets that more processing is required. This function can be
6835 called by an EVT_IDLE handler for a window to indicate that the
6836 application should forward the EVT_IDLE event once more to the
6837 application windows. If no window calls this function during its
6838 EVT_IDLE handler, then the application will remain in a passive event
6839 loop until a new event is posted to the application by the windowing
6840 system.
6841 """
6842 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6843
6844 def MoreRequested(*args, **kwargs):
6845 """
6846 MoreRequested(self) -> bool
6847
6848 Returns ``True`` if the OnIdle function processing this event
6849 requested more processing time.
6850 """
6851 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6852
6853 def SetMode(*args, **kwargs):
6854 """
6855 SetMode(int mode)
6856
6857 Static method for specifying how wxWidgets will send idle events: to
6858 all windows, or only to those which specify that they will process the
6859 events.
6860
6861 The mode can be one of the following values:
6862
6863 ========================= ========================================
6864 wx.IDLE_PROCESS_ALL Send idle events to all windows
6865 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6866 the wx.WS_EX_PROCESS_IDLE extra style
6867 flag set.
6868 ========================= ========================================
6869
6870 """
6871 return _core_.IdleEvent_SetMode(*args, **kwargs)
6872
6873 SetMode = staticmethod(SetMode)
6874 def GetMode(*args, **kwargs):
6875 """
6876 GetMode() -> int
6877
6878 Static method returning a value specifying how wxWidgets will send
6879 idle events: to all windows, or only to those which specify that they
6880 will process the events.
6881 """
6882 return _core_.IdleEvent_GetMode(*args, **kwargs)
6883
6884 GetMode = staticmethod(GetMode)
6885 def CanSend(*args, **kwargs):
6886 """
6887 CanSend(Window win) -> bool
6888
6889 Returns ``True`` if it is appropriate to send idle events to this
6890 window.
6891
6892 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6893 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6894 events should be sent to this window now. By default this will always
6895 return ``True`` because the update mode is initially
6896 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6897 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6898 """
6899 return _core_.IdleEvent_CanSend(*args, **kwargs)
6900
6901 CanSend = staticmethod(CanSend)
6902 _core_.IdleEvent_swigregister(IdleEvent)
6903
6904 def IdleEvent_SetMode(*args, **kwargs):
6905 """
6906 IdleEvent_SetMode(int mode)
6907
6908 Static method for specifying how wxWidgets will send idle events: to
6909 all windows, or only to those which specify that they will process the
6910 events.
6911
6912 The mode can be one of the following values:
6913
6914 ========================= ========================================
6915 wx.IDLE_PROCESS_ALL Send idle events to all windows
6916 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6917 the wx.WS_EX_PROCESS_IDLE extra style
6918 flag set.
6919 ========================= ========================================
6920
6921 """
6922 return _core_.IdleEvent_SetMode(*args, **kwargs)
6923
6924 def IdleEvent_GetMode(*args):
6925 """
6926 IdleEvent_GetMode() -> int
6927
6928 Static method returning a value specifying how wxWidgets will send
6929 idle events: to all windows, or only to those which specify that they
6930 will process the events.
6931 """
6932 return _core_.IdleEvent_GetMode(*args)
6933
6934 def IdleEvent_CanSend(*args, **kwargs):
6935 """
6936 IdleEvent_CanSend(Window win) -> bool
6937
6938 Returns ``True`` if it is appropriate to send idle events to this
6939 window.
6940
6941 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6942 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6943 events should be sent to this window now. By default this will always
6944 return ``True`` because the update mode is initially
6945 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6946 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6947 """
6948 return _core_.IdleEvent_CanSend(*args, **kwargs)
6949
6950 #---------------------------------------------------------------------------
6951
6952 class ClipboardTextEvent(CommandEvent):
6953 """
6954 A Clipboard Text event is sent when a window intercepts a text
6955 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6956 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6957 popup menu command, etc. NOTE : under windows these events are *NOT*
6958 generated automatically for a Rich Edit text control.
6959 """
6960 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6961 __repr__ = _swig_repr
6962 def __init__(self, *args, **kwargs):
6963 """
6964 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6965
6966 A Clipboard Text event is sent when a window intercepts a text
6967 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6968 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6969 popup menu command, etc. NOTE : under windows these events are *NOT*
6970 generated automatically for a Rich Edit text control.
6971 """
6972 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6973 _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6974
6975 #---------------------------------------------------------------------------
6976
6977 class PyEvent(Event):
6978 """
6979 wx.PyEvent can be used as a base class for implementing custom event
6980 types in Python. You should derived from this class instead of
6981 `wx.Event` because this class is Python-aware and is able to transport
6982 its Python bits safely through the wxWidgets event system and have
6983 them still be there when the event handler is invoked.
6984
6985 :see: `wx.PyCommandEvent`
6986
6987 """
6988 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6989 __repr__ = _swig_repr
6990 def __init__(self, *args, **kwargs):
6991 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6992 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6993 self._SetSelf(self)
6994
6995 __swig_destroy__ = _core_.delete_PyEvent
6996 __del__ = lambda self : None;
6997 def _SetSelf(*args, **kwargs):
6998 """_SetSelf(self, PyObject self)"""
6999 return _core_.PyEvent__SetSelf(*args, **kwargs)
7000
7001 def _GetSelf(*args, **kwargs):
7002 """_GetSelf(self) -> PyObject"""
7003 return _core_.PyEvent__GetSelf(*args, **kwargs)
7004
7005 _core_.PyEvent_swigregister(PyEvent)
7006
7007 class PyCommandEvent(CommandEvent):
7008 """
7009 wx.PyCommandEvent can be used as a base class for implementing custom
7010 event types in Python, where the event shoudl travel up to parent
7011 windows looking for a handler. You should derived from this class
7012 instead of `wx.CommandEvent` because this class is Python-aware and is
7013 able to transport its Python bits safely through the wxWidgets event
7014 system and have them still be there when the event handler is invoked.
7015
7016 :see: `wx.PyEvent`
7017
7018 """
7019 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7020 __repr__ = _swig_repr
7021 def __init__(self, *args, **kwargs):
7022 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
7023 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
7024 self._SetSelf(self)
7025
7026 __swig_destroy__ = _core_.delete_PyCommandEvent
7027 __del__ = lambda self : None;
7028 def _SetSelf(*args, **kwargs):
7029 """_SetSelf(self, PyObject self)"""
7030 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
7031
7032 def _GetSelf(*args, **kwargs):
7033 """_GetSelf(self) -> PyObject"""
7034 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
7035
7036 _core_.PyCommandEvent_swigregister(PyCommandEvent)
7037
7038 class DateEvent(CommandEvent):
7039 """
7040 This event class holds information about a date change event and is
7041 used together with `wx.DatePickerCtrl`. It also serves as a base class
7042 for `wx.calendar.CalendarEvent`. Bind these event types with
7043 EVT_DATE_CHANGED.
7044 """
7045 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7046 __repr__ = _swig_repr
7047 def __init__(self, *args, **kwargs):
7048 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
7049 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
7050 def GetDate(*args, **kwargs):
7051 """
7052 GetDate(self) -> DateTime
7053
7054 Returns the date.
7055 """
7056 return _core_.DateEvent_GetDate(*args, **kwargs)
7057
7058 def SetDate(*args, **kwargs):
7059 """
7060 SetDate(self, DateTime date)
7061
7062 Sets the date carried by the event, normally only used by the library
7063 internally.
7064 """
7065 return _core_.DateEvent_SetDate(*args, **kwargs)
7066
7067 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
7068 _core_.DateEvent_swigregister(DateEvent)
7069
7070 wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
7071 EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
7072
7073 class EventBlocker(EvtHandler):
7074 """Helper class to temporarily disable event handling for a window."""
7075 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7076 __repr__ = _swig_repr
7077 def __init__(self, *args, **kwargs):
7078 """
7079 __init__(self, Window win, EventType type=wxEVT_ANY) -> EventBlocker
7080
7081 Helper class to temporarily disable event handling for a window.
7082 """
7083 _core_.EventBlocker_swiginit(self,_core_.new_EventBlocker(*args, **kwargs))
7084 __swig_destroy__ = _core_.delete_EventBlocker
7085 __del__ = lambda self : None;
7086 def Block(*args, **kwargs):
7087 """Block(self, EventType type)"""
7088 return _core_.EventBlocker_Block(*args, **kwargs)
7089
7090 _core_.EventBlocker_swigregister(EventBlocker)
7091
7092 #---------------------------------------------------------------------------
7093
7094 PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
7095 PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
7096 PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
7097 PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
7098 PRINT_WINDOWS = _core_.PRINT_WINDOWS
7099 PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
7100 class PyApp(EvtHandler):
7101 """
7102 The ``wx.PyApp`` class is an *implementation detail*, please use the
7103 `wx.App` class (or some other derived class) instead.
7104 """
7105 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7106 __repr__ = _swig_repr
7107 def __init__(self, *args, **kwargs):
7108 """
7109 __init__(self) -> PyApp
7110
7111 Create a new application object, starting the bootstrap process.
7112 """
7113 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
7114 self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp)
7115
7116 __swig_destroy__ = _core_.delete_PyApp
7117 __del__ = lambda self : None;
7118 def _setCallbackInfo(*args, **kwargs):
7119 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
7120 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7121
7122 def GetAppName(*args, **kwargs):
7123 """
7124 GetAppName(self) -> String
7125
7126 Get the application name.
7127 """
7128 return _core_.PyApp_GetAppName(*args, **kwargs)
7129
7130 def SetAppName(*args, **kwargs):
7131 """
7132 SetAppName(self, String name)
7133
7134 Set the application name. This value may be used automatically by
7135 `wx.Config` and such.
7136 """
7137 return _core_.PyApp_SetAppName(*args, **kwargs)
7138
7139 def GetClassName(*args, **kwargs):
7140 """
7141 GetClassName(self) -> String
7142
7143 Get the application's class name.
7144 """
7145 return _core_.PyApp_GetClassName(*args, **kwargs)
7146
7147 def SetClassName(*args, **kwargs):
7148 """
7149 SetClassName(self, String name)
7150
7151 Set the application's class name. This value may be used for
7152 X-resources if applicable for the platform
7153 """
7154 return _core_.PyApp_SetClassName(*args, **kwargs)
7155
7156 def GetVendorName(*args, **kwargs):
7157 """
7158 GetVendorName(self) -> String
7159
7160 Get the application's vendor name.
7161 """
7162 return _core_.PyApp_GetVendorName(*args, **kwargs)
7163
7164 def SetVendorName(*args, **kwargs):
7165 """
7166 SetVendorName(self, String name)
7167
7168 Set the application's vendor name. This value may be used
7169 automatically by `wx.Config` and such.
7170 """
7171 return _core_.PyApp_SetVendorName(*args, **kwargs)
7172
7173 def GetTraits(*args, **kwargs):
7174 """
7175 GetTraits(self) -> wxAppTraits
7176
7177 Return (and create if necessary) the app traits object to which we
7178 delegate for everything which either should be configurable by the
7179 user (then he can change the default behaviour simply by overriding
7180 CreateTraits() and returning his own traits object) or which is
7181 GUI/console dependent as then wx.AppTraits allows us to abstract the
7182 differences behind the common facade.
7183
7184 :todo: Add support for overriding CreateAppTraits in wxPython.
7185 """
7186 return _core_.PyApp_GetTraits(*args, **kwargs)
7187
7188 def ProcessPendingEvents(*args, **kwargs):
7189 """
7190 ProcessPendingEvents(self)
7191
7192 Process all events in the Pending Events list -- it is necessary to
7193 call this function to process posted events. This normally happens
7194 during each event loop iteration.
7195 """
7196 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7197
7198 def Yield(*args, **kwargs):
7199 """
7200 Yield(self, bool onlyIfNeeded=False) -> bool
7201
7202 Process all currently pending events right now, instead of waiting
7203 until return to the event loop. It is an error to call ``Yield``
7204 recursively unless the value of ``onlyIfNeeded`` is True.
7205
7206 :warning: This function is dangerous as it can lead to unexpected
7207 reentrancies (i.e. when called from an event handler it may
7208 result in calling the same event handler again), use with
7209 extreme care or, better, don't use at all!
7210
7211 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7212
7213 """
7214 return _core_.PyApp_Yield(*args, **kwargs)
7215
7216 def WakeUpIdle(*args, **kwargs):
7217 """
7218 WakeUpIdle(self)
7219
7220 Make sure that idle events are sent again.
7221 :see: `wx.WakeUpIdle`
7222 """
7223 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7224
7225 def IsMainLoopRunning(*args, **kwargs):
7226 """
7227 IsMainLoopRunning() -> bool
7228
7229 Returns True if we're running the main loop, i.e. if the events can
7230 currently be dispatched.
7231 """
7232 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7233
7234 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
7235 def MainLoop(*args, **kwargs):
7236 """
7237 MainLoop(self) -> int
7238
7239 Execute the main GUI loop, the function doesn't normally return until
7240 all top level windows have been closed and destroyed.
7241 """
7242 return _core_.PyApp_MainLoop(*args, **kwargs)
7243
7244 def Exit(*args, **kwargs):
7245 """
7246 Exit(self)
7247
7248 Exit the main loop thus terminating the application.
7249 :see: `wx.Exit`
7250 """
7251 return _core_.PyApp_Exit(*args, **kwargs)
7252
7253 def GetLayoutDirection(*args, **kwargs):
7254 """
7255 GetLayoutDirection(self) -> int
7256
7257 Return the layout direction for the current locale.
7258 """
7259 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7260
7261 def ExitMainLoop(*args, **kwargs):
7262 """
7263 ExitMainLoop(self)
7264
7265 Exit the main GUI loop during the next iteration of the main
7266 loop, (i.e. it does not stop the program immediately!)
7267 """
7268 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7269
7270 def Pending(*args, **kwargs):
7271 """
7272 Pending(self) -> bool
7273
7274 Returns True if there are unprocessed events in the event queue.
7275 """
7276 return _core_.PyApp_Pending(*args, **kwargs)
7277
7278 def Dispatch(*args, **kwargs):
7279 """
7280 Dispatch(self) -> bool
7281
7282 Process the first event in the event queue (blocks until an event
7283 appears if there are none currently)
7284 """
7285 return _core_.PyApp_Dispatch(*args, **kwargs)
7286
7287 def ProcessIdle(*args, **kwargs):
7288 """
7289 ProcessIdle(self) -> bool
7290
7291 Called from the MainLoop when the application becomes idle (there are
7292 no pending events) and sends a `wx.IdleEvent` to all interested
7293 parties. Returns True if more idle events are needed, False if not.
7294 """
7295 return _core_.PyApp_ProcessIdle(*args, **kwargs)
7296
7297 def SendIdleEvents(*args, **kwargs):
7298 """
7299 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7300
7301 Send idle event to window and all subwindows. Returns True if more
7302 idle time is requested.
7303 """
7304 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7305
7306 def IsActive(*args, **kwargs):
7307 """
7308 IsActive(self) -> bool
7309
7310 Return True if our app has focus.
7311 """
7312 return _core_.PyApp_IsActive(*args, **kwargs)
7313
7314 def SetTopWindow(*args, **kwargs):
7315 """
7316 SetTopWindow(self, Window win)
7317
7318 Set the *main* top level window
7319 """
7320 return _core_.PyApp_SetTopWindow(*args, **kwargs)
7321
7322 def GetTopWindow(*args, **kwargs):
7323 """
7324 GetTopWindow(self) -> Window
7325
7326 Return the *main* top level window (if it hadn't been set previously
7327 with SetTopWindow(), will return just some top level window and, if
7328 there not any, will return None)
7329 """
7330 return _core_.PyApp_GetTopWindow(*args, **kwargs)
7331
7332 def SetExitOnFrameDelete(*args, **kwargs):
7333 """
7334 SetExitOnFrameDelete(self, bool flag)
7335
7336 Control the exit behaviour: by default, the program will exit the main
7337 loop (and so, usually, terminate) when the last top-level program
7338 window is deleted. Beware that if you disable this behaviour (with
7339 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7340 explicitly from somewhere.
7341 """
7342 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7343
7344 def GetExitOnFrameDelete(*args, **kwargs):
7345 """
7346 GetExitOnFrameDelete(self) -> bool
7347
7348 Get the current exit behaviour setting.
7349 """
7350 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7351
7352 def SetUseBestVisual(*args, **kwargs):
7353 """
7354 SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
7355
7356 Set whether the app should try to use the best available visual on
7357 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7358 """
7359 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7360
7361 def GetUseBestVisual(*args, **kwargs):
7362 """
7363 GetUseBestVisual(self) -> bool
7364
7365 Get current UseBestVisual setting.
7366 """
7367 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7368
7369 def SetPrintMode(*args, **kwargs):
7370 """SetPrintMode(self, int mode)"""
7371 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7372
7373 def GetPrintMode(*args, **kwargs):
7374 """GetPrintMode(self) -> int"""
7375 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7376
7377 def SetAssertMode(*args, **kwargs):
7378 """
7379 SetAssertMode(self, int mode)
7380
7381 Set the OnAssert behaviour for debug and hybrid builds.
7382 """
7383 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7384
7385 def GetAssertMode(*args, **kwargs):
7386 """
7387 GetAssertMode(self) -> int
7388
7389 Get the current OnAssert behaviour setting.
7390 """
7391 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7392
7393 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
7394 """GetMacSupportPCMenuShortcuts() -> bool"""
7395 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7396
7397 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7398 def GetMacAboutMenuItemId(*args, **kwargs):
7399 """GetMacAboutMenuItemId() -> long"""
7400 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7401
7402 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7403 def GetMacPreferencesMenuItemId(*args, **kwargs):
7404 """GetMacPreferencesMenuItemId() -> long"""
7405 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7406
7407 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7408 def GetMacExitMenuItemId(*args, **kwargs):
7409 """GetMacExitMenuItemId() -> long"""
7410 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7411
7412 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7413 def GetMacHelpMenuTitleName(*args, **kwargs):
7414 """GetMacHelpMenuTitleName() -> String"""
7415 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7416
7417 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7418 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
7419 """SetMacSupportPCMenuShortcuts(bool val)"""
7420 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7421
7422 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7423 def SetMacAboutMenuItemId(*args, **kwargs):
7424 """SetMacAboutMenuItemId(long val)"""
7425 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7426
7427 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7428 def SetMacPreferencesMenuItemId(*args, **kwargs):
7429 """SetMacPreferencesMenuItemId(long val)"""
7430 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7431
7432 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7433 def SetMacExitMenuItemId(*args, **kwargs):
7434 """SetMacExitMenuItemId(long val)"""
7435 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7436
7437 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7438 def SetMacHelpMenuTitleName(*args, **kwargs):
7439 """SetMacHelpMenuTitleName(String val)"""
7440 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7441
7442 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7443 def _BootstrapApp(*args, **kwargs):
7444 """
7445 _BootstrapApp(self)
7446
7447 For internal use only
7448 """
7449 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7450
7451 def GetComCtl32Version(*args, **kwargs):
7452 """
7453 GetComCtl32Version() -> int
7454
7455 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7456 it wasn't found at all. Raises an exception on non-Windows platforms.
7457 """
7458 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7459
7460 GetComCtl32Version = staticmethod(GetComCtl32Version)
7461 def IsDisplayAvailable(*args, **kwargs):
7462 """
7463 IsDisplayAvailable() -> bool
7464
7465 Tests if it is possible to create a GUI in the current environment.
7466 This will mean different things on the different platforms.
7467
7468 * On X Windows systems this function will return ``False`` if it is
7469 not able to open a connection to the X display, which can happen
7470 if $DISPLAY is not set, or is not set correctly.
7471
7472 * On Mac OS X a ``False`` return value will mean that wx is not
7473 able to access the window manager, which can happen if logged in
7474 remotely or if running from the normal version of python instead
7475 of the framework version, (i.e., pythonw.)
7476
7477 * On MS Windows...
7478
7479 """
7480 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7481
7482 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7483 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7484 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7485 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7486 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7487 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7488 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7489 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7490 Traits = property(GetTraits,doc="See `GetTraits`")
7491 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7492 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7493 Active = property(IsActive)
7494 _core_.PyApp_swigregister(PyApp)
7495
7496 def PyApp_IsMainLoopRunning(*args):
7497 """
7498 PyApp_IsMainLoopRunning() -> bool
7499
7500 Returns True if we're running the main loop, i.e. if the events can
7501 currently be dispatched.
7502 """
7503 return _core_.PyApp_IsMainLoopRunning(*args)
7504
7505 def PyApp_GetMacSupportPCMenuShortcuts(*args):
7506 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7507 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7508
7509 def PyApp_GetMacAboutMenuItemId(*args):
7510 """PyApp_GetMacAboutMenuItemId() -> long"""
7511 return _core_.PyApp_GetMacAboutMenuItemId(*args)
7512
7513 def PyApp_GetMacPreferencesMenuItemId(*args):
7514 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7515 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7516
7517 def PyApp_GetMacExitMenuItemId(*args):
7518 """PyApp_GetMacExitMenuItemId() -> long"""
7519 return _core_.PyApp_GetMacExitMenuItemId(*args)
7520
7521 def PyApp_GetMacHelpMenuTitleName(*args):
7522 """PyApp_GetMacHelpMenuTitleName() -> String"""
7523 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7524
7525 def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7526 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7527 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7528
7529 def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7530 """PyApp_SetMacAboutMenuItemId(long val)"""
7531 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7532
7533 def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7534 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7535 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7536
7537 def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7538 """PyApp_SetMacExitMenuItemId(long val)"""
7539 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7540
7541 def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7542 """PyApp_SetMacHelpMenuTitleName(String val)"""
7543 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7544
7545 def PyApp_GetComCtl32Version(*args):
7546 """
7547 PyApp_GetComCtl32Version() -> int
7548
7549 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7550 it wasn't found at all. Raises an exception on non-Windows platforms.
7551 """
7552 return _core_.PyApp_GetComCtl32Version(*args)
7553
7554 def PyApp_IsDisplayAvailable(*args):
7555 """
7556 PyApp_IsDisplayAvailable() -> bool
7557
7558 Tests if it is possible to create a GUI in the current environment.
7559 This will mean different things on the different platforms.
7560
7561 * On X Windows systems this function will return ``False`` if it is
7562 not able to open a connection to the X display, which can happen
7563 if $DISPLAY is not set, or is not set correctly.
7564
7565 * On Mac OS X a ``False`` return value will mean that wx is not
7566 able to access the window manager, which can happen if logged in
7567 remotely or if running from the normal version of python instead
7568 of the framework version, (i.e., pythonw.)
7569
7570 * On MS Windows...
7571
7572 """
7573 return _core_.PyApp_IsDisplayAvailable(*args)
7574
7575 #---------------------------------------------------------------------------
7576
7577
7578 def Exit(*args):
7579 """
7580 Exit()
7581
7582 Force an exit of the application. Convenience for wx.GetApp().Exit()
7583 """
7584 return _core_.Exit(*args)
7585
7586 def Yield(*args):
7587 """
7588 Yield() -> bool
7589
7590 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7591 """
7592 return _core_.Yield(*args)
7593
7594 def YieldIfNeeded(*args):
7595 """
7596 YieldIfNeeded() -> bool
7597
7598 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7599 """
7600 return _core_.YieldIfNeeded(*args)
7601
7602 def SafeYield(*args, **kwargs):
7603 """
7604 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7605
7606 This function is similar to `wx.Yield`, except that it disables the
7607 user input to all program windows before calling `wx.Yield` and
7608 re-enables it again afterwards. If ``win`` is not None, this window
7609 will remain enabled, allowing the implementation of some limited user
7610 interaction.
7611
7612 :Returns: the result of the call to `wx.Yield`.
7613 """
7614 return _core_.SafeYield(*args, **kwargs)
7615
7616 def WakeUpIdle(*args):
7617 """
7618 WakeUpIdle()
7619
7620 Cause the message queue to become empty again, so idle events will be
7621 sent.
7622 """
7623 return _core_.WakeUpIdle(*args)
7624
7625 def PostEvent(*args, **kwargs):
7626 """
7627 PostEvent(EvtHandler dest, Event event)
7628
7629 Send an event to a window or other wx.EvtHandler to be processed
7630 later.
7631 """
7632 return _core_.PostEvent(*args, **kwargs)
7633
7634 def App_CleanUp(*args):
7635 """
7636 App_CleanUp()
7637
7638 For internal use only, it is used to cleanup after wxWidgets when
7639 Python shuts down.
7640 """
7641 return _core_.App_CleanUp(*args)
7642
7643 def GetApp(*args):
7644 """
7645 GetApp() -> PyApp
7646
7647 Return a reference to the current wx.App object.
7648 """
7649 return _core_.GetApp(*args)
7650
7651 def SetDefaultPyEncoding(*args, **kwargs):
7652 """
7653 SetDefaultPyEncoding(string encoding)
7654
7655 Sets the encoding that wxPython will use when it needs to convert a
7656 Python string or unicode object to or from a wxString.
7657
7658 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7659 but please be aware that the default encoding within the same locale
7660 may be slightly different on different platforms. For example, please
7661 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7662 between the common latin/roman encodings.
7663 """
7664 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7665
7666 def GetDefaultPyEncoding(*args):
7667 """
7668 GetDefaultPyEncoding() -> string
7669
7670 Gets the current encoding that wxPython will use when it needs to
7671 convert a Python string or unicode object to or from a wxString.
7672 """
7673 return _core_.GetDefaultPyEncoding(*args)
7674 #----------------------------------------------------------------------
7675
7676 class PyOnDemandOutputWindow:
7677 """
7678 A class that can be used for redirecting Python's stdout and
7679 stderr streams. It will do nothing until something is wrriten to
7680 the stream at which point it will create a Frame with a text area
7681 and write the text there.
7682 """
7683 def __init__(self, title = "wxPython: stdout/stderr"):
7684 self.frame = None
7685 self.title = title
7686 self.pos = wx.DefaultPosition
7687 self.size = (450, 300)
7688 self.parent = None
7689
7690 def SetParent(self, parent):
7691 """Set the window to be used as the popup Frame's parent."""
7692 self.parent = parent
7693
7694
7695 def CreateOutputWindow(self, st):
7696 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7697 style=wx.DEFAULT_FRAME_STYLE)
7698 self.text = wx.TextCtrl(self.frame, -1, "",
7699 style=wx.TE_MULTILINE|wx.TE_READONLY)
7700 self.text.AppendText(st)
7701 self.frame.Show(True)
7702 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7703
7704
7705 def OnCloseWindow(self, event):
7706 if self.frame is not None:
7707 self.frame.Destroy()
7708 self.frame = None
7709 self.text = None
7710
7711
7712 # These methods provide the file-like output behaviour.
7713 def write(self, text):
7714 """
7715 Create the output window if needed and write the string to it.
7716 If not called in the context of the gui thread then uses
7717 CallAfter to do the work there.
7718 """
7719 if self.frame is None:
7720 if not wx.Thread_IsMain():
7721 wx.CallAfter(self.CreateOutputWindow, text)
7722 else:
7723 self.CreateOutputWindow(text)
7724 else:
7725 if not wx.Thread_IsMain():
7726 wx.CallAfter(self.text.AppendText, text)
7727 else:
7728 self.text.AppendText(text)
7729
7730
7731 def close(self):
7732 if self.frame is not None:
7733 wx.CallAfter(self.frame.Close)
7734
7735
7736 def flush(self):
7737 pass
7738
7739
7740
7741 #----------------------------------------------------------------------
7742
7743 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7744
7745 class App(wx.PyApp):
7746 """
7747 The ``wx.App`` class represents the application and is used to:
7748
7749 * bootstrap the wxPython system and initialize the underlying
7750 gui toolkit
7751 * set and get application-wide properties
7752 * implement the windowing system main message or event loop,
7753 and to dispatch events to window instances
7754 * etc.
7755
7756 Every application must have a ``wx.App`` instance, and all
7757 creation of UI objects should be delayed until after the
7758 ``wx.App`` object has been created in order to ensure that the gui
7759 platform and wxWidgets have been fully initialized.
7760
7761 Normally you would derive from this class and implement an
7762 ``OnInit`` method that creates a frame and then calls
7763 ``self.SetTopWindow(frame)``.
7764
7765 :see: `wx.PySimpleApp` for a simpler app class that can be used
7766 directly.
7767 """
7768
7769 outputWindowClass = PyOnDemandOutputWindow
7770
7771 def __init__(self, redirect=_defRedirect, filename=None,
7772 useBestVisual=False, clearSigInt=True):
7773 """
7774 Construct a ``wx.App`` object.
7775
7776 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7777 redirected? Defaults to True on Windows and Mac, False
7778 otherwise. If `filename` is None then output will be
7779 redirected to a window that pops up as needed. (You can
7780 control what kind of window is created for the output by
7781 resetting the class variable ``outputWindowClass`` to a
7782 class of your choosing.)
7783
7784 :param filename: The name of a file to redirect output to, if
7785 redirect is True.
7786
7787 :param useBestVisual: Should the app try to use the best
7788 available visual provided by the system (only relevant on
7789 systems that have more than one visual.) This parameter
7790 must be used instead of calling `SetUseBestVisual` later
7791 on because it must be set before the underlying GUI
7792 toolkit is initialized.
7793
7794 :param clearSigInt: Should SIGINT be cleared? This allows the
7795 app to terminate upon a Ctrl-C in the console like other
7796 GUI apps will.
7797
7798 :note: You should override OnInit to do applicaition
7799 initialization to ensure that the system, toolkit and
7800 wxWidgets are fully initialized.
7801 """
7802
7803 wx.PyApp.__init__(self)
7804
7805 # make sure we can create a GUI
7806 if not self.IsDisplayAvailable():
7807
7808 if wx.Platform == "__WXMAC__":
7809 msg = """This program needs access to the screen.
7810 Please run with 'pythonw', not 'python', and only when you are logged
7811 in on the main display of your Mac."""
7812
7813 elif wx.Platform == "__WXGTK__":
7814 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7815
7816 else:
7817 msg = "Unable to create GUI"
7818 # TODO: more description is needed for wxMSW...
7819
7820 raise SystemExit(msg)
7821
7822 # This has to be done before OnInit
7823 self.SetUseBestVisual(useBestVisual)
7824
7825 # Set the default handler for SIGINT. This fixes a problem
7826 # where if Ctrl-C is pressed in the console that started this
7827 # app then it will not appear to do anything, (not even send
7828 # KeyboardInterrupt???) but will later segfault on exit. By
7829 # setting the default handler then the app will exit, as
7830 # expected (depending on platform.)
7831 if clearSigInt:
7832 try:
7833 import signal
7834 signal.signal(signal.SIGINT, signal.SIG_DFL)
7835 except:
7836 pass
7837
7838 # Save and redirect the stdio to a window?
7839 self.stdioWin = None
7840 self.saveStdio = (_sys.stdout, _sys.stderr)
7841 if redirect:
7842 self.RedirectStdio(filename)
7843
7844 # Use Python's install prefix as the default
7845 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7846
7847 # Until the new native control for wxMac is up to par, still use the generic one.
7848 wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7849
7850 # This finishes the initialization of wxWindows and then calls
7851 # the OnInit that should be present in the derived class
7852 self._BootstrapApp()
7853
7854
7855 def OnPreInit(self):
7856 """
7857 Things that must be done after _BootstrapApp has done its
7858 thing, but would be nice if they were already done by the time
7859 that OnInit is called.
7860 """
7861 wx.StockGDI._initStockObjects()
7862
7863
7864 def __del__(self, destroy=wx.PyApp.__del__):
7865 self.RestoreStdio() # Just in case the MainLoop was overridden
7866 destroy(self)
7867
7868 def Destroy(self):
7869 self.this.own(False)
7870 wx.PyApp.Destroy(self)
7871
7872 def SetTopWindow(self, frame):
7873 """Set the \"main\" top level window"""
7874 if self.stdioWin:
7875 self.stdioWin.SetParent(frame)
7876 wx.PyApp.SetTopWindow(self, frame)
7877
7878
7879 def MainLoop(self):
7880 """Execute the main GUI event loop"""
7881 wx.PyApp.MainLoop(self)
7882 self.RestoreStdio()
7883
7884
7885 def RedirectStdio(self, filename=None):
7886 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7887 if filename:
7888 _sys.stdout = _sys.stderr = open(filename, 'a')
7889 else:
7890 self.stdioWin = self.outputWindowClass()
7891 _sys.stdout = _sys.stderr = self.stdioWin
7892
7893
7894 def RestoreStdio(self):
7895 try:
7896 _sys.stdout, _sys.stderr = self.saveStdio
7897 except:
7898 pass
7899
7900
7901 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7902 """
7903 Set the title, position and/or size of the output window if
7904 the stdio has been redirected. This should be called before
7905 any output would cause the output window to be created.
7906 """
7907 if self.stdioWin:
7908 if title is not None:
7909 self.stdioWin.title = title
7910 if pos is not None:
7911 self.stdioWin.pos = pos
7912 if size is not None:
7913 self.stdioWin.size = size
7914
7915
7916
7917
7918 # change from wx.PyApp_XX to wx.App_XX
7919 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7920 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7921 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7922 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7923 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7924 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7925 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7926 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7927 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7928 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7929 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7930
7931 #----------------------------------------------------------------------------
7932
7933 class PySimpleApp(wx.App):
7934 """
7935 A simple application class. You can just create one of these and
7936 then then make your top level windows later, and not have to worry
7937 about OnInit. For example::
7938
7939 app = wx.PySimpleApp()
7940 frame = wx.Frame(None, title='Hello World')
7941 frame.Show()
7942 app.MainLoop()
7943
7944 :see: `wx.App`
7945 """
7946
7947 def __init__(self, redirect=False, filename=None,
7948 useBestVisual=False, clearSigInt=True):
7949 """
7950 :see: `wx.App.__init__`
7951 """
7952 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7953
7954 def OnInit(self):
7955 return True
7956
7957
7958
7959 # Is anybody using this one?
7960 class PyWidgetTester(wx.App):
7961 def __init__(self, size = (250, 100)):
7962 self.size = size
7963 wx.App.__init__(self, 0)
7964
7965 def OnInit(self):
7966 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7967 self.SetTopWindow(self.frame)
7968 return True
7969
7970 def SetWidget(self, widgetClass, *args, **kwargs):
7971 w = widgetClass(self.frame, *args, **kwargs)
7972 self.frame.Show(True)
7973
7974 #----------------------------------------------------------------------------
7975 # DO NOT hold any other references to this object. This is how we
7976 # know when to cleanup system resources that wxWidgets is holding. When
7977 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7978 # goes to zero and it calls the wx.App_CleanUp function.
7979
7980 class __wxPyCleanup:
7981 def __init__(self):
7982 self.cleanup = _core_.App_CleanUp
7983 def __del__(self):
7984 self.cleanup()
7985
7986 _sys.__wxPythonCleanup = __wxPyCleanup()
7987
7988 ## # another possible solution, but it gets called too early...
7989 ## import atexit
7990 ## atexit.register(_core_.wxApp_CleanUp)
7991
7992
7993 #----------------------------------------------------------------------------
7994
7995 #---------------------------------------------------------------------------
7996
7997 class EventLoop(object):
7998 """Proxy of C++ EventLoop class"""
7999 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8000 __repr__ = _swig_repr
8001 def __init__(self, *args, **kwargs):
8002 """__init__(self) -> EventLoop"""
8003 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
8004 __swig_destroy__ = _core_.delete_EventLoop
8005 __del__ = lambda self : None;
8006 def Run(*args, **kwargs):
8007 """Run(self) -> int"""
8008 return _core_.EventLoop_Run(*args, **kwargs)
8009
8010 def Exit(*args, **kwargs):
8011 """Exit(self, int rc=0)"""
8012 return _core_.EventLoop_Exit(*args, **kwargs)
8013
8014 def Pending(*args, **kwargs):
8015 """Pending(self) -> bool"""
8016 return _core_.EventLoop_Pending(*args, **kwargs)
8017
8018 def Dispatch(*args, **kwargs):
8019 """Dispatch(self) -> bool"""
8020 return _core_.EventLoop_Dispatch(*args, **kwargs)
8021
8022 def IsRunning(*args, **kwargs):
8023 """IsRunning(self) -> bool"""
8024 return _core_.EventLoop_IsRunning(*args, **kwargs)
8025
8026 def GetActive(*args, **kwargs):
8027 """GetActive() -> EventLoop"""
8028 return _core_.EventLoop_GetActive(*args, **kwargs)
8029
8030 GetActive = staticmethod(GetActive)
8031 def SetActive(*args, **kwargs):
8032 """SetActive(EventLoop loop)"""
8033 return _core_.EventLoop_SetActive(*args, **kwargs)
8034
8035 SetActive = staticmethod(SetActive)
8036 _core_.EventLoop_swigregister(EventLoop)
8037
8038 def EventLoop_GetActive(*args):
8039 """EventLoop_GetActive() -> EventLoop"""
8040 return _core_.EventLoop_GetActive(*args)
8041
8042 def EventLoop_SetActive(*args, **kwargs):
8043 """EventLoop_SetActive(EventLoop loop)"""
8044 return _core_.EventLoop_SetActive(*args, **kwargs)
8045
8046 class EventLoopActivator(object):
8047 """Proxy of C++ EventLoopActivator class"""
8048 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8049 __repr__ = _swig_repr
8050 def __init__(self, *args, **kwargs):
8051 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
8052 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
8053 __swig_destroy__ = _core_.delete_EventLoopActivator
8054 __del__ = lambda self : None;
8055 _core_.EventLoopActivator_swigregister(EventLoopActivator)
8056
8057 #---------------------------------------------------------------------------
8058
8059 ACCEL_ALT = _core_.ACCEL_ALT
8060 ACCEL_CTRL = _core_.ACCEL_CTRL
8061 ACCEL_SHIFT = _core_.ACCEL_SHIFT
8062 ACCEL_NORMAL = _core_.ACCEL_NORMAL
8063 ACCEL_CMD = _core_.ACCEL_CMD
8064 class AcceleratorEntry(object):
8065 """
8066 A class used to define items in an `wx.AcceleratorTable`. wxPython
8067 programs can choose to use wx.AcceleratorEntry objects, but using a
8068 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
8069 as well. See `__init__` for of the tuple values.
8070
8071 :see: `wx.AcceleratorTable`
8072 """
8073 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8074 __repr__ = _swig_repr
8075 def __init__(self, *args, **kwargs):
8076 """
8077 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
8078
8079 Construct a wx.AcceleratorEntry.
8080 """
8081 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
8082 __swig_destroy__ = _core_.delete_AcceleratorEntry
8083 __del__ = lambda self : None;
8084 def Set(*args, **kwargs):
8085 """
8086 Set(self, int flags, int keyCode, int cmd)
8087
8088 (Re)set the attributes of a wx.AcceleratorEntry.
8089 :see `__init__`
8090 """
8091 return _core_.AcceleratorEntry_Set(*args, **kwargs)
8092
8093 def Create(*args, **kwargs):
8094 """
8095 Create(String str) -> AcceleratorEntry
8096
8097 Create accelerator corresponding to the specified string, or None if
8098 it coulnd't be parsed.
8099 """
8100 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8101
8102 Create = staticmethod(Create)
8103 def GetFlags(*args, **kwargs):
8104 """
8105 GetFlags(self) -> int
8106
8107 Get the AcceleratorEntry's flags.
8108 """
8109 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
8110
8111 def GetKeyCode(*args, **kwargs):
8112 """
8113 GetKeyCode(self) -> int
8114
8115 Get the AcceleratorEntry's keycode.
8116 """
8117 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
8118
8119 def GetCommand(*args, **kwargs):
8120 """
8121 GetCommand(self) -> int
8122
8123 Get the AcceleratorEntry's command ID.
8124 """
8125 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
8126
8127 def IsOk(*args, **kwargs):
8128 """IsOk(self) -> bool"""
8129 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8130
8131 def ToString(*args, **kwargs):
8132 """
8133 ToString(self) -> String
8134
8135 Returns a string representation for the this accelerator. The string
8136 is formatted using the <flags>-<keycode> format where <flags> maybe a
8137 hyphen-separed list of "shift|alt|ctrl"
8138
8139 """
8140 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8141
8142 def FromString(*args, **kwargs):
8143 """
8144 FromString(self, String str) -> bool
8145
8146 Returns true if the given string correctly initialized this object.
8147 """
8148 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8149
8150 Command = property(GetCommand,doc="See `GetCommand`")
8151 Flags = property(GetFlags,doc="See `GetFlags`")
8152 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
8153 _core_.AcceleratorEntry_swigregister(AcceleratorEntry)
8154
8155 def AcceleratorEntry_Create(*args, **kwargs):
8156 """
8157 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8158
8159 Create accelerator corresponding to the specified string, or None if
8160 it coulnd't be parsed.
8161 """
8162 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8163
8164 class AcceleratorTable(Object):
8165 """
8166 An accelerator table allows the application to specify a table of
8167 keyboard shortcuts for menus or other commands. On Windows, menu or
8168 button commands are supported; on GTK, only menu commands are
8169 supported.
8170 """
8171 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8172 __repr__ = _swig_repr
8173 def __init__(self, *args, **kwargs):
8174 """
8175 __init__(entries) -> AcceleratorTable
8176
8177 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8178 items or or of 3-tuples (flags, keyCode, cmdID)
8179
8180 :see: `wx.AcceleratorEntry`
8181 """
8182 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8183 __swig_destroy__ = _core_.delete_AcceleratorTable
8184 __del__ = lambda self : None;
8185 def IsOk(*args, **kwargs):
8186 """IsOk(self) -> bool"""
8187 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
8188
8189 Ok = IsOk
8190 _core_.AcceleratorTable_swigregister(AcceleratorTable)
8191
8192 def GetAccelFromString(label):
8193 entry = AcceleratorEntry()
8194 entry.FromString(label)
8195 return entry
8196
8197 #---------------------------------------------------------------------------
8198
8199 class VisualAttributes(object):
8200 """struct containing all the visual attributes of a control"""
8201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8202 __repr__ = _swig_repr
8203 def __init__(self, *args, **kwargs):
8204 """
8205 __init__(self) -> VisualAttributes
8206
8207 struct containing all the visual attributes of a control
8208 """
8209 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8210 __swig_destroy__ = _core_.delete_VisualAttributes
8211 __del__ = lambda self : None;
8212 def _get_font(*args, **kwargs):
8213 """_get_font(self) -> Font"""
8214 return _core_.VisualAttributes__get_font(*args, **kwargs)
8215
8216 def _get_colFg(*args, **kwargs):
8217 """_get_colFg(self) -> Colour"""
8218 return _core_.VisualAttributes__get_colFg(*args, **kwargs)
8219
8220 def _get_colBg(*args, **kwargs):
8221 """_get_colBg(self) -> Colour"""
8222 return _core_.VisualAttributes__get_colBg(*args, **kwargs)
8223
8224 font = property(_get_font)
8225 colFg = property(_get_colFg)
8226 colBg = property(_get_colBg)
8227 _core_.VisualAttributes_swigregister(VisualAttributes)
8228 NullAcceleratorTable = cvar.NullAcceleratorTable
8229 PanelNameStr = cvar.PanelNameStr
8230
8231 WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8232 WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8233 WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8234 WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8235 WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8236 class Window(EvtHandler):
8237 """
8238 wx.Window is the base class for all windows and represents any visible
8239 object on the screen. All controls, top level windows and so on are
8240 wx.Windows. Sizers and device contexts are not however, as they don't
8241 appear on screen themselves.
8242
8243 """
8244 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8245 __repr__ = _swig_repr
8246 def __init__(self, *args, **kwargs):
8247 """
8248 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8249 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8250
8251 Construct and show a generic Window.
8252 """
8253 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
8254 self._setOORInfo(self)
8255
8256 def Create(*args, **kwargs):
8257 """
8258 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8259 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8260
8261 Create the GUI part of the Window for 2-phase creation mode.
8262 """
8263 return _core_.Window_Create(*args, **kwargs)
8264
8265 def Close(*args, **kwargs):
8266 """
8267 Close(self, bool force=False) -> bool
8268
8269 This function simply generates a EVT_CLOSE event whose handler usually
8270 tries to close the window. It doesn't close the window itself,
8271 however. If force is False (the default) then the window's close
8272 handler will be allowed to veto the destruction of the window.
8273 """
8274 return _core_.Window_Close(*args, **kwargs)
8275
8276 def Destroy(*args, **kwargs):
8277 """
8278 Destroy(self) -> bool
8279
8280 Destroys the window safely. Frames and dialogs are not destroyed
8281 immediately when this function is called -- they are added to a list
8282 of windows to be deleted on idle time, when all the window's events
8283 have been processed. This prevents problems with events being sent to
8284 non-existent windows.
8285
8286 Returns True if the window has either been successfully deleted, or it
8287 has been added to the list of windows pending real deletion.
8288 """
8289 args[0].this.own(False)
8290 return _core_.Window_Destroy(*args, **kwargs)
8291
8292 def DestroyChildren(*args, **kwargs):
8293 """
8294 DestroyChildren(self) -> bool
8295
8296 Destroys all children of a window. Called automatically by the
8297 destructor.
8298 """
8299 return _core_.Window_DestroyChildren(*args, **kwargs)
8300
8301 def IsBeingDeleted(*args, **kwargs):
8302 """
8303 IsBeingDeleted(self) -> bool
8304
8305 Is the window in the process of being deleted?
8306 """
8307 return _core_.Window_IsBeingDeleted(*args, **kwargs)
8308
8309 def SetLabel(*args, **kwargs):
8310 """
8311 SetLabel(self, String label)
8312
8313 Set the text which the window shows in its label if applicable.
8314 """
8315 return _core_.Window_SetLabel(*args, **kwargs)
8316
8317 def GetLabel(*args, **kwargs):
8318 """
8319 GetLabel(self) -> String
8320
8321 Generic way of getting a label from any window, for identification
8322 purposes. The interpretation of this function differs from class to
8323 class. For frames and dialogs, the value returned is the title. For
8324 buttons or static text controls, it is the button text. This function
8325 can be useful for meta-programs such as testing tools or special-needs
8326 access programs)which need to identify windows by name.
8327 """
8328 return _core_.Window_GetLabel(*args, **kwargs)
8329
8330 def SetName(*args, **kwargs):
8331 """
8332 SetName(self, String name)
8333
8334 Sets the window's name. The window name is used for ressource setting
8335 in X, it is not the same as the window title/label
8336 """
8337 return _core_.Window_SetName(*args, **kwargs)
8338
8339 def GetName(*args, **kwargs):
8340 """
8341 GetName(self) -> String
8342
8343 Returns the windows name. This name is not guaranteed to be unique;
8344 it is up to the programmer to supply an appropriate name in the window
8345 constructor or via wx.Window.SetName.
8346 """
8347 return _core_.Window_GetName(*args, **kwargs)
8348
8349 def SetWindowVariant(*args, **kwargs):
8350 """
8351 SetWindowVariant(self, int variant)
8352
8353 Sets the variant of the window/font size to use for this window, if
8354 the platform supports variants, for example, wxMac.
8355 """
8356 return _core_.Window_SetWindowVariant(*args, **kwargs)
8357
8358 def GetWindowVariant(*args, **kwargs):
8359 """GetWindowVariant(self) -> int"""
8360 return _core_.Window_GetWindowVariant(*args, **kwargs)
8361
8362 def SetId(*args, **kwargs):
8363 """
8364 SetId(self, int winid)
8365
8366 Sets the identifier of the window. Each window has an integer
8367 identifier. If the application has not provided one, an identifier
8368 will be generated. Normally, the identifier should be provided on
8369 creation and should not be modified subsequently.
8370 """
8371 return _core_.Window_SetId(*args, **kwargs)
8372
8373 def GetId(*args, **kwargs):
8374 """
8375 GetId(self) -> int
8376
8377 Returns the identifier of the window. Each window has an integer
8378 identifier. If the application has not provided one (or the default Id
8379 -1 is used) then an unique identifier with a negative value will be
8380 generated.
8381 """
8382 return _core_.Window_GetId(*args, **kwargs)
8383
8384 def NewControlId(*args, **kwargs):
8385 """
8386 NewControlId() -> int
8387
8388 Generate a control id for the controls which were not given one.
8389 """
8390 return _core_.Window_NewControlId(*args, **kwargs)
8391
8392 NewControlId = staticmethod(NewControlId)
8393 def NextControlId(*args, **kwargs):
8394 """
8395 NextControlId(int winid) -> int
8396
8397 Get the id of the control following the one with the given
8398 autogenerated) id
8399 """
8400 return _core_.Window_NextControlId(*args, **kwargs)
8401
8402 NextControlId = staticmethod(NextControlId)
8403 def PrevControlId(*args, **kwargs):
8404 """
8405 PrevControlId(int winid) -> int
8406
8407 Get the id of the control preceding the one with the given
8408 autogenerated) id
8409 """
8410 return _core_.Window_PrevControlId(*args, **kwargs)
8411
8412 PrevControlId = staticmethod(PrevControlId)
8413 def GetLayoutDirection(*args, **kwargs):
8414 """
8415 GetLayoutDirection(self) -> int
8416
8417 Get the layout direction (LTR or RTL) for this window. Returns
8418 ``wx.Layout_Default`` if layout direction is not supported.
8419 """
8420 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8421
8422 def SetLayoutDirection(*args, **kwargs):
8423 """
8424 SetLayoutDirection(self, int dir)
8425
8426 Set the layout direction (LTR or RTL) for this window.
8427 """
8428 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8429
8430 def AdjustForLayoutDirection(*args, **kwargs):
8431 """
8432 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8433
8434 Mirror coordinates for RTL layout if this window uses it and if the
8435 mirroring is not done automatically like Win32.
8436 """
8437 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8438
8439 def SetSize(*args, **kwargs):
8440 """
8441 SetSize(self, Size size)
8442
8443 Sets the size of the window in pixels.
8444 """
8445 return _core_.Window_SetSize(*args, **kwargs)
8446
8447 def SetDimensions(*args, **kwargs):
8448 """
8449 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8450
8451 Sets the position and size of the window in pixels. The sizeFlags
8452 parameter indicates the interpretation of the other params if they are
8453 equal to -1.
8454
8455 ======================== ======================================
8456 wx.SIZE_AUTO A -1 indicates that a class-specific
8457 default should be used.
8458 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8459 -1 values are supplied.
8460 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8461 interpreted as real dimensions, not
8462 default values.
8463 ======================== ======================================
8464
8465 """
8466 return _core_.Window_SetDimensions(*args, **kwargs)
8467
8468 def SetRect(*args, **kwargs):
8469 """
8470 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8471
8472 Sets the position and size of the window in pixels using a wx.Rect.
8473 """
8474 return _core_.Window_SetRect(*args, **kwargs)
8475
8476 def SetSizeWH(*args, **kwargs):
8477 """
8478 SetSizeWH(self, int width, int height)
8479
8480 Sets the size of the window in pixels.
8481 """
8482 return _core_.Window_SetSizeWH(*args, **kwargs)
8483
8484 def Move(*args, **kwargs):
8485 """
8486 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8487
8488 Moves the window to the given position.
8489 """
8490 return _core_.Window_Move(*args, **kwargs)
8491
8492 SetPosition = Move
8493 def MoveXY(*args, **kwargs):
8494 """
8495 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8496
8497 Moves the window to the given position.
8498 """
8499 return _core_.Window_MoveXY(*args, **kwargs)
8500
8501 def SetInitialSize(*args, **kwargs):
8502 """
8503 SetInitialSize(self, Size size=DefaultSize)
8504
8505 A 'Smart' SetSize that will fill in default size components with the
8506 window's *best size* values. Also set's the minsize for use with sizers.
8507 """
8508 return _core_.Window_SetInitialSize(*args, **kwargs)
8509
8510 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
8511 def Raise(*args, **kwargs):
8512 """
8513 Raise(self)
8514
8515 Raises the window to the top of the window hierarchy. In current
8516 version of wxWidgets this works both for managed and child windows.
8517 """
8518 return _core_.Window_Raise(*args, **kwargs)
8519
8520 def Lower(*args, **kwargs):
8521 """
8522 Lower(self)
8523
8524 Lowers the window to the bottom of the window hierarchy. In current
8525 version of wxWidgets this works both for managed and child windows.
8526 """
8527 return _core_.Window_Lower(*args, **kwargs)
8528
8529 def SetClientSize(*args, **kwargs):
8530 """
8531 SetClientSize(self, Size size)
8532
8533 This sets the size of the window client area in pixels. Using this
8534 function to size a window tends to be more device-independent than
8535 wx.Window.SetSize, since the application need not worry about what
8536 dimensions the border or title bar have when trying to fit the window
8537 around panel items, for example.
8538 """
8539 return _core_.Window_SetClientSize(*args, **kwargs)
8540
8541 def SetClientSizeWH(*args, **kwargs):
8542 """
8543 SetClientSizeWH(self, int width, int height)
8544
8545 This sets the size of the window client area in pixels. Using this
8546 function to size a window tends to be more device-independent than
8547 wx.Window.SetSize, since the application need not worry about what
8548 dimensions the border or title bar have when trying to fit the window
8549 around panel items, for example.
8550 """
8551 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8552
8553 def SetClientRect(*args, **kwargs):
8554 """
8555 SetClientRect(self, Rect rect)
8556
8557 This sets the size of the window client area in pixels. Using this
8558 function to size a window tends to be more device-independent than
8559 wx.Window.SetSize, since the application need not worry about what
8560 dimensions the border or title bar have when trying to fit the window
8561 around panel items, for example.
8562 """
8563 return _core_.Window_SetClientRect(*args, **kwargs)
8564
8565 def GetPosition(*args, **kwargs):
8566 """
8567 GetPosition(self) -> Point
8568
8569 Get the window's position. Notice that the position is in client
8570 coordinates for child windows and screen coordinates for the top level
8571 ones, use `GetScreenPosition` if you need screen coordinates for all
8572 kinds of windows.
8573 """
8574 return _core_.Window_GetPosition(*args, **kwargs)
8575
8576 def GetPositionTuple(*args, **kwargs):
8577 """
8578 GetPositionTuple() -> (x,y)
8579
8580 Get the window's position. Notice that the position is in client
8581 coordinates for child windows and screen coordinates for the top level
8582 ones, use `GetScreenPosition` if you need screen coordinates for all
8583 kinds of windows.
8584 """
8585 return _core_.Window_GetPositionTuple(*args, **kwargs)
8586
8587 def GetScreenPosition(*args, **kwargs):
8588 """
8589 GetScreenPosition(self) -> Point
8590
8591 Get the position of the window in screen coordinantes.
8592 """
8593 return _core_.Window_GetScreenPosition(*args, **kwargs)
8594
8595 def GetScreenPositionTuple(*args, **kwargs):
8596 """
8597 GetScreenPositionTuple() -> (x,y)
8598
8599 Get the position of the window in screen coordinantes.
8600 """
8601 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8602
8603 def GetScreenRect(*args, **kwargs):
8604 """
8605 GetScreenRect(self) -> Rect
8606
8607 Returns the size and position of the window in screen coordinantes as
8608 a `wx.Rect` object.
8609 """
8610 return _core_.Window_GetScreenRect(*args, **kwargs)
8611
8612 def GetSize(*args, **kwargs):
8613 """
8614 GetSize(self) -> Size
8615
8616 Get the window size.
8617 """
8618 return _core_.Window_GetSize(*args, **kwargs)
8619
8620 def GetSizeTuple(*args, **kwargs):
8621 """
8622 GetSizeTuple() -> (width, height)
8623
8624 Get the window size.
8625 """
8626 return _core_.Window_GetSizeTuple(*args, **kwargs)
8627
8628 def GetRect(*args, **kwargs):
8629 """
8630 GetRect(self) -> Rect
8631
8632 Returns the size and position of the window as a `wx.Rect` object.
8633 """
8634 return _core_.Window_GetRect(*args, **kwargs)
8635
8636 def GetClientSize(*args, **kwargs):
8637 """
8638 GetClientSize(self) -> Size
8639
8640 This gets the size of the window's 'client area' in pixels. The client
8641 area is the area which may be drawn on by the programmer, excluding
8642 title bar, border, scrollbars, etc.
8643 """
8644 return _core_.Window_GetClientSize(*args, **kwargs)
8645
8646 def GetClientSizeTuple(*args, **kwargs):
8647 """
8648 GetClientSizeTuple() -> (width, height)
8649
8650 This gets the size of the window's 'client area' in pixels. The client
8651 area is the area which may be drawn on by the programmer, excluding
8652 title bar, border, scrollbars, etc.
8653 """
8654 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8655
8656 def GetClientAreaOrigin(*args, **kwargs):
8657 """
8658 GetClientAreaOrigin(self) -> Point
8659
8660 Get the origin of the client area of the window relative to the
8661 window's top left corner (the client area may be shifted because of
8662 the borders, scrollbars, other decorations...)
8663 """
8664 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8665
8666 def GetClientRect(*args, **kwargs):
8667 """
8668 GetClientRect(self) -> Rect
8669
8670 Get the client area position and size as a `wx.Rect` object.
8671 """
8672 return _core_.Window_GetClientRect(*args, **kwargs)
8673
8674 def GetBestSize(*args, **kwargs):
8675 """
8676 GetBestSize(self) -> Size
8677
8678 This function returns the best acceptable minimal size for the
8679 window, if applicable. For example, for a static text control, it will
8680 be the minimal size such that the control label is not truncated. For
8681 windows containing subwindows (suzh aswx.Panel), the size returned by
8682 this function will be the same as the size the window would have had
8683 after calling Fit.
8684 """
8685 return _core_.Window_GetBestSize(*args, **kwargs)
8686
8687 def GetBestSizeTuple(*args, **kwargs):
8688 """
8689 GetBestSizeTuple() -> (width, height)
8690
8691 This function returns the best acceptable minimal size for the
8692 window, if applicable. For example, for a static text control, it will
8693 be the minimal size such that the control label is not truncated. For
8694 windows containing subwindows (suzh aswx.Panel), the size returned by
8695 this function will be the same as the size the window would have had
8696 after calling Fit.
8697 """
8698 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8699
8700 def InvalidateBestSize(*args, **kwargs):
8701 """
8702 InvalidateBestSize(self)
8703
8704 Reset the cached best size value so it will be recalculated the next
8705 time it is needed.
8706 """
8707 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8708
8709 def CacheBestSize(*args, **kwargs):
8710 """
8711 CacheBestSize(self, Size size)
8712
8713 Cache the best size so it doesn't need to be calculated again, (at least until
8714 some properties of the window change.)
8715 """
8716 return _core_.Window_CacheBestSize(*args, **kwargs)
8717
8718 def GetEffectiveMinSize(*args, **kwargs):
8719 """
8720 GetEffectiveMinSize(self) -> Size
8721
8722 This function will merge the window's best size into the window's
8723 minimum size, giving priority to the min size components, and returns
8724 the results.
8725
8726 """
8727 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
8728
8729 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8730 def GetAdjustedBestSize(self):
8731 s = self.GetBestSize()
8732 return wx.Size(max(s.width, self.GetMinWidth()),
8733 max(s.height, self.GetMinHeight()))
8734 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
8735
8736 def Center(*args, **kwargs):
8737 """
8738 Center(self, int direction=BOTH)
8739
8740 Centers the window. The parameter specifies the direction for
8741 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8742 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8743 on the entire screen and not on its parent window. If it is a
8744 top-level window and has no parent then it will always be centered
8745 relative to the screen.
8746 """
8747 return _core_.Window_Center(*args, **kwargs)
8748
8749 Centre = Center
8750 def CenterOnParent(*args, **kwargs):
8751 """
8752 CenterOnParent(self, int dir=BOTH)
8753
8754 Center with respect to the the parent window
8755 """
8756 return _core_.Window_CenterOnParent(*args, **kwargs)
8757
8758 CentreOnParent = CenterOnParent
8759 def Fit(*args, **kwargs):
8760 """
8761 Fit(self)
8762
8763 Sizes the window so that it fits around its subwindows. This function
8764 won't do anything if there are no subwindows and will only really work
8765 correctly if sizers are used for the subwindows layout. Also, if the
8766 window has exactly one subwindow it is better (faster and the result
8767 is more precise as Fit adds some margin to account for fuzziness of
8768 its calculations) to call window.SetClientSize(child.GetSize())
8769 instead of calling Fit.
8770 """
8771 return _core_.Window_Fit(*args, **kwargs)
8772
8773 def FitInside(*args, **kwargs):
8774 """
8775 FitInside(self)
8776
8777 Similar to Fit, but sizes the interior (virtual) size of a
8778 window. Mainly useful with scrolled windows to reset scrollbars after
8779 sizing changes that do not trigger a size event, and/or scrolled
8780 windows without an interior sizer. This function similarly won't do
8781 anything if there are no subwindows.
8782 """
8783 return _core_.Window_FitInside(*args, **kwargs)
8784
8785 def SetSizeHints(*args, **kwargs):
8786 """
8787 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8788 int incH=-1)
8789
8790 Allows specification of minimum and maximum window sizes, and window
8791 size increments. If a pair of values is not set (or set to -1), the
8792 default values will be used. If this function is called, the user
8793 will not be able to size the window outside the given bounds (if it is
8794 a top-level window.) Sizers will also inspect the minimum window size
8795 and will use that value if set when calculating layout.
8796
8797 The resizing increments are only significant under Motif or Xt.
8798 """
8799 return _core_.Window_SetSizeHints(*args, **kwargs)
8800
8801 def SetSizeHintsSz(*args, **kwargs):
8802 """
8803 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8804
8805 Allows specification of minimum and maximum window sizes, and window
8806 size increments. If a pair of values is not set (or set to -1), the
8807 default values will be used. If this function is called, the user
8808 will not be able to size the window outside the given bounds (if it is
8809 a top-level window.) Sizers will also inspect the minimum window size
8810 and will use that value if set when calculating layout.
8811
8812 The resizing increments are only significant under Motif or Xt.
8813 """
8814 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8815
8816 def SetVirtualSizeHints(*args, **kwargs):
8817 """
8818 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8819
8820 Allows specification of minimum and maximum virtual window sizes. If a
8821 pair of values is not set (or set to -1), the default values will be
8822 used. If this function is called, the user will not be able to size
8823 the virtual area of the window outside the given bounds.
8824 """
8825 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8826
8827 def SetVirtualSizeHintsSz(*args, **kwargs):
8828 """
8829 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8830
8831 Allows specification of minimum and maximum virtual window sizes. If a
8832 pair of values is not set (or set to -1), the default values will be
8833 used. If this function is called, the user will not be able to size
8834 the virtual area of the window outside the given bounds.
8835 """
8836 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8837
8838 def GetMaxSize(*args, **kwargs):
8839 """GetMaxSize(self) -> Size"""
8840 return _core_.Window_GetMaxSize(*args, **kwargs)
8841
8842 def GetMinSize(*args, **kwargs):
8843 """GetMinSize(self) -> Size"""
8844 return _core_.Window_GetMinSize(*args, **kwargs)
8845
8846 def SetMinSize(*args, **kwargs):
8847 """
8848 SetMinSize(self, Size minSize)
8849
8850 A more convenient method than `SetSizeHints` for setting just the
8851 min size.
8852 """
8853 return _core_.Window_SetMinSize(*args, **kwargs)
8854
8855 def SetMaxSize(*args, **kwargs):
8856 """
8857 SetMaxSize(self, Size maxSize)
8858
8859 A more convenient method than `SetSizeHints` for setting just the
8860 max size.
8861 """
8862 return _core_.Window_SetMaxSize(*args, **kwargs)
8863
8864 def GetMinWidth(*args, **kwargs):
8865 """GetMinWidth(self) -> int"""
8866 return _core_.Window_GetMinWidth(*args, **kwargs)
8867
8868 def GetMinHeight(*args, **kwargs):
8869 """GetMinHeight(self) -> int"""
8870 return _core_.Window_GetMinHeight(*args, **kwargs)
8871
8872 def GetMaxWidth(*args, **kwargs):
8873 """GetMaxWidth(self) -> int"""
8874 return _core_.Window_GetMaxWidth(*args, **kwargs)
8875
8876 def GetMaxHeight(*args, **kwargs):
8877 """GetMaxHeight(self) -> int"""
8878 return _core_.Window_GetMaxHeight(*args, **kwargs)
8879
8880 def SetVirtualSize(*args, **kwargs):
8881 """
8882 SetVirtualSize(self, Size size)
8883
8884 Set the the virtual size of a window in pixels. For most windows this
8885 is just the client area of the window, but for some like scrolled
8886 windows it is more or less independent of the screen window size.
8887 """
8888 return _core_.Window_SetVirtualSize(*args, **kwargs)
8889
8890 def SetVirtualSizeWH(*args, **kwargs):
8891 """
8892 SetVirtualSizeWH(self, int w, int h)
8893
8894 Set the the virtual size of a window in pixels. For most windows this
8895 is just the client area of the window, but for some like scrolled
8896 windows it is more or less independent of the screen window size.
8897 """
8898 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8899
8900 def GetVirtualSize(*args, **kwargs):
8901 """
8902 GetVirtualSize(self) -> Size
8903
8904 Get the the virtual size of the window in pixels. For most windows
8905 this is just the client area of the window, but for some like scrolled
8906 windows it is more or less independent of the screen window size.
8907 """
8908 return _core_.Window_GetVirtualSize(*args, **kwargs)
8909
8910 def GetVirtualSizeTuple(*args, **kwargs):
8911 """
8912 GetVirtualSizeTuple() -> (width, height)
8913
8914 Get the the virtual size of the window in pixels. For most windows
8915 this is just the client area of the window, but for some like scrolled
8916 windows it is more or less independent of the screen window size.
8917 """
8918 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8919
8920 def GetWindowBorderSize(*args, **kwargs):
8921 """
8922 GetWindowBorderSize(self) -> Size
8923
8924 Return the size of the left/right and top/bottom borders.
8925 """
8926 return _core_.Window_GetWindowBorderSize(*args, **kwargs)
8927
8928 def GetBestVirtualSize(*args, **kwargs):
8929 """
8930 GetBestVirtualSize(self) -> Size
8931
8932 Return the largest of ClientSize and BestSize (as determined by a
8933 sizer, interior children, or other means)
8934 """
8935 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8936
8937 def Show(*args, **kwargs):
8938 """
8939 Show(self, bool show=True) -> bool
8940
8941 Shows or hides the window. You may need to call Raise for a top level
8942 window if you want to bring it to top, although this is not needed if
8943 Show is called immediately after the frame creation. Returns True if
8944 the window has been shown or hidden or False if nothing was done
8945 because it already was in the requested state.
8946 """
8947 return _core_.Window_Show(*args, **kwargs)
8948
8949 def Hide(*args, **kwargs):
8950 """
8951 Hide(self) -> bool
8952
8953 Equivalent to calling Show(False).
8954 """
8955 return _core_.Window_Hide(*args, **kwargs)
8956
8957 def Enable(*args, **kwargs):
8958 """
8959 Enable(self, bool enable=True) -> bool
8960
8961 Enable or disable the window for user input. Note that when a parent
8962 window is disabled, all of its children are disabled as well and they
8963 are reenabled again when the parent is. Returns true if the window
8964 has been enabled or disabled, false if nothing was done, i.e. if the
8965 window had already been in the specified state.
8966 """
8967 return _core_.Window_Enable(*args, **kwargs)
8968
8969 def Disable(*args, **kwargs):
8970 """
8971 Disable(self) -> bool
8972
8973 Disables the window, same as Enable(false).
8974 """
8975 return _core_.Window_Disable(*args, **kwargs)
8976
8977 def IsShown(*args, **kwargs):
8978 """
8979 IsShown(self) -> bool
8980
8981 Returns true if the window is shown, false if it has been hidden.
8982 """
8983 return _core_.Window_IsShown(*args, **kwargs)
8984
8985 def IsEnabled(*args, **kwargs):
8986 """
8987 IsEnabled(self) -> bool
8988
8989 Returns true if the window is enabled for input, false otherwise.
8990 This method takes into account the enabled state of parent windows up
8991 to the top-level window.
8992 """
8993 return _core_.Window_IsEnabled(*args, **kwargs)
8994
8995 def IsThisEnabled(*args, **kwargs):
8996 """
8997 IsThisEnabled(self) -> bool
8998
8999 Returns the internal enabled state independent of the parent(s) state,
9000 i.e. the state in which the window would be if all of its parents are
9001 enabled. Use `IsEnabled` to get the effective window state.
9002 """
9003 return _core_.Window_IsThisEnabled(*args, **kwargs)
9004
9005 def IsShownOnScreen(*args, **kwargs):
9006 """
9007 IsShownOnScreen(self) -> bool
9008
9009 Returns ``True`` if the window is physically visible on the screen,
9010 i.e. it is shown and all its parents up to the toplevel window are
9011 shown as well.
9012 """
9013 return _core_.Window_IsShownOnScreen(*args, **kwargs)
9014
9015 def SetWindowStyleFlag(*args, **kwargs):
9016 """
9017 SetWindowStyleFlag(self, long style)
9018
9019 Sets the style of the window. Please note that some styles cannot be
9020 changed after the window creation and that Refresh() might need to be
9021 called after changing the others for the change to take place
9022 immediately.
9023 """
9024 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
9025
9026 def GetWindowStyleFlag(*args, **kwargs):
9027 """
9028 GetWindowStyleFlag(self) -> long
9029
9030 Gets the window style that was passed to the constructor or Create
9031 method.
9032 """
9033 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
9034
9035 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
9036 def HasFlag(*args, **kwargs):
9037 """
9038 HasFlag(self, int flag) -> bool
9039
9040 Test if the given style is set for this window.
9041 """
9042 return _core_.Window_HasFlag(*args, **kwargs)
9043
9044 def IsRetained(*args, **kwargs):
9045 """
9046 IsRetained(self) -> bool
9047
9048 Returns true if the window is retained, false otherwise. Retained
9049 windows are only available on X platforms.
9050 """
9051 return _core_.Window_IsRetained(*args, **kwargs)
9052
9053 def ToggleWindowStyle(*args, **kwargs):
9054 """
9055 ToggleWindowStyle(self, int flag) -> bool
9056
9057 Turn the flag on if it had been turned off before and vice versa,
9058 returns True if the flag is turned on by this function call.
9059 """
9060 return _core_.Window_ToggleWindowStyle(*args, **kwargs)
9061
9062 def SetExtraStyle(*args, **kwargs):
9063 """
9064 SetExtraStyle(self, long exStyle)
9065
9066 Sets the extra style bits for the window. Extra styles are the less
9067 often used style bits which can't be set with the constructor or with
9068 SetWindowStyleFlag()
9069 """
9070 return _core_.Window_SetExtraStyle(*args, **kwargs)
9071
9072 def GetExtraStyle(*args, **kwargs):
9073 """
9074 GetExtraStyle(self) -> long
9075
9076 Returns the extra style bits for the window.
9077 """
9078 return _core_.Window_GetExtraStyle(*args, **kwargs)
9079
9080 def MakeModal(*args, **kwargs):
9081 """
9082 MakeModal(self, bool modal=True)
9083
9084 Disables all other windows in the application so that the user can
9085 only interact with this window. Passing False will reverse this
9086 effect.
9087 """
9088 return _core_.Window_MakeModal(*args, **kwargs)
9089
9090 def SetThemeEnabled(*args, **kwargs):
9091 """
9092 SetThemeEnabled(self, bool enableTheme)
9093
9094 This function tells a window if it should use the system's "theme"
9095 code to draw the windows' background instead if its own background
9096 drawing code. This will only have an effect on platforms that support
9097 the notion of themes in user defined windows. One such platform is
9098 GTK+ where windows can have (very colourful) backgrounds defined by a
9099 user's selected theme.
9100
9101 Dialogs, notebook pages and the status bar have this flag set to true
9102 by default so that the default look and feel is simulated best.
9103 """
9104 return _core_.Window_SetThemeEnabled(*args, **kwargs)
9105
9106 def GetThemeEnabled(*args, **kwargs):
9107 """
9108 GetThemeEnabled(self) -> bool
9109
9110 Return the themeEnabled flag.
9111 """
9112 return _core_.Window_GetThemeEnabled(*args, **kwargs)
9113
9114 def SetFocus(*args, **kwargs):
9115 """
9116 SetFocus(self)
9117
9118 Set's the focus to this window, allowing it to receive keyboard input.
9119 """
9120 return _core_.Window_SetFocus(*args, **kwargs)
9121
9122 def SetFocusFromKbd(*args, **kwargs):
9123 """
9124 SetFocusFromKbd(self)
9125
9126 Set focus to this window as the result of a keyboard action. Normally
9127 only called internally.
9128 """
9129 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
9130
9131 def FindFocus(*args, **kwargs):
9132 """
9133 FindFocus() -> Window
9134
9135 Returns the window or control that currently has the keyboard focus,
9136 or None.
9137 """
9138 return _core_.Window_FindFocus(*args, **kwargs)
9139
9140 FindFocus = staticmethod(FindFocus)
9141 def AcceptsFocus(*args, **kwargs):
9142 """
9143 AcceptsFocus(self) -> bool
9144
9145 Can this window have focus?
9146 """
9147 return _core_.Window_AcceptsFocus(*args, **kwargs)
9148
9149 def CanAcceptFocus(*args, **kwargs):
9150 """
9151 CanAcceptFocus(self) -> bool
9152
9153 Can this window have focus right now?
9154 """
9155 return _core_.Window_CanAcceptFocus(*args, **kwargs)
9156
9157 def AcceptsFocusFromKeyboard(*args, **kwargs):
9158 """
9159 AcceptsFocusFromKeyboard(self) -> bool
9160
9161 Can this window be given focus by keyboard navigation? if not, the
9162 only way to give it focus (provided it accepts it at all) is to click
9163 it.
9164 """
9165 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
9166
9167 def CanAcceptFocusFromKeyboard(*args, **kwargs):
9168 """
9169 CanAcceptFocusFromKeyboard(self) -> bool
9170
9171 Can this window be assigned focus from keyboard right now?
9172 """
9173 return _core_.Window_CanAcceptFocusFromKeyboard(*args, **kwargs)
9174
9175 def SetCanFocus(*args, **kwargs):
9176 """SetCanFocus(self, bool canFocus)"""
9177 return _core_.Window_SetCanFocus(*args, **kwargs)
9178
9179 def NavigateIn(*args, **kwargs):
9180 """
9181 NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool
9182
9183 Navigates inside this window.
9184 """
9185 return _core_.Window_NavigateIn(*args, **kwargs)
9186
9187 def Navigate(*args, **kwargs):
9188 """
9189 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9190
9191 Does keyboard navigation starting from this window to another. This is
9192 equivalient to self.GetParent().NavigateIn().
9193 """
9194 return _core_.Window_Navigate(*args, **kwargs)
9195
9196 def MoveAfterInTabOrder(*args, **kwargs):
9197 """
9198 MoveAfterInTabOrder(self, Window win)
9199
9200 Moves this window in the tab navigation order after the specified
9201 sibling window. This means that when the user presses the TAB key on
9202 that other window, the focus switches to this window.
9203
9204 The default tab order is the same as creation order. This function
9205 and `MoveBeforeInTabOrder` allow to change it after creating all the
9206 windows.
9207
9208 """
9209 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9210
9211 def MoveBeforeInTabOrder(*args, **kwargs):
9212 """
9213 MoveBeforeInTabOrder(self, Window win)
9214
9215 Same as `MoveAfterInTabOrder` except that it inserts this window just
9216 before win instead of putting it right after it.
9217 """
9218 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9219
9220 def GetChildren(*args, **kwargs):
9221 """
9222 GetChildren(self) -> PyObject
9223
9224 Returns a list of the window's children. NOTE: Currently this is a
9225 copy of the child window list maintained by the window, so the return
9226 value of this function is only valid as long as the window's children
9227 do not change.
9228 """
9229 return _core_.Window_GetChildren(*args, **kwargs)
9230
9231 def GetParent(*args, **kwargs):
9232 """
9233 GetParent(self) -> Window
9234
9235 Returns the parent window of this window, or None if there isn't one.
9236 """
9237 return _core_.Window_GetParent(*args, **kwargs)
9238
9239 def GetGrandParent(*args, **kwargs):
9240 """
9241 GetGrandParent(self) -> Window
9242
9243 Returns the parent of the parent of this window, or None if there
9244 isn't one.
9245 """
9246 return _core_.Window_GetGrandParent(*args, **kwargs)
9247
9248 def GetTopLevelParent(*args, **kwargs):
9249 """
9250 GetTopLevelParent(self) -> Window
9251
9252 Returns the first frame or dialog in this window's parental hierarchy.
9253 """
9254 return _core_.Window_GetTopLevelParent(*args, **kwargs)
9255
9256 def IsTopLevel(*args, **kwargs):
9257 """
9258 IsTopLevel(self) -> bool
9259
9260 Returns true if the given window is a top-level one. Currently all
9261 frames and dialogs are always considered to be top-level windows (even
9262 if they have a parent window).
9263 """
9264 return _core_.Window_IsTopLevel(*args, **kwargs)
9265
9266 def Reparent(*args, **kwargs):
9267 """
9268 Reparent(self, Window newParent) -> bool
9269
9270 Reparents the window, i.e the window will be removed from its current
9271 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9272 re-inserted into another. Available on Windows and GTK. Returns True
9273 if the parent was changed, False otherwise (error or newParent ==
9274 oldParent)
9275 """
9276 return _core_.Window_Reparent(*args, **kwargs)
9277
9278 def AddChild(*args, **kwargs):
9279 """
9280 AddChild(self, Window child)
9281
9282 Adds a child window. This is called automatically by window creation
9283 functions so should not be required by the application programmer.
9284 """
9285 return _core_.Window_AddChild(*args, **kwargs)
9286
9287 def RemoveChild(*args, **kwargs):
9288 """
9289 RemoveChild(self, Window child)
9290
9291 Removes a child window. This is called automatically by window
9292 deletion functions so should not be required by the application
9293 programmer.
9294 """
9295 return _core_.Window_RemoveChild(*args, **kwargs)
9296
9297 def SetDoubleBuffered(*args, **kwargs):
9298 """
9299 SetDoubleBuffered(self, bool on)
9300
9301 Currently wxGTK2 only.
9302 """
9303 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9304
9305 def FindWindowById(*args, **kwargs):
9306 """
9307 FindWindowById(self, long winid) -> Window
9308
9309 Find a chld of this window by window ID
9310 """
9311 return _core_.Window_FindWindowById(*args, **kwargs)
9312
9313 def FindWindowByName(*args, **kwargs):
9314 """
9315 FindWindowByName(self, String name) -> Window
9316
9317 Find a child of this window by name
9318 """
9319 return _core_.Window_FindWindowByName(*args, **kwargs)
9320
9321 def GetEventHandler(*args, **kwargs):
9322 """
9323 GetEventHandler(self) -> EvtHandler
9324
9325 Returns the event handler for this window. By default, the window is
9326 its own event handler.
9327 """
9328 return _core_.Window_GetEventHandler(*args, **kwargs)
9329
9330 def SetEventHandler(*args, **kwargs):
9331 """
9332 SetEventHandler(self, EvtHandler handler)
9333
9334 Sets the event handler for this window. An event handler is an object
9335 that is capable of processing the events sent to a window. (In other
9336 words, is able to dispatch the events to handler function.) By
9337 default, the window is its own event handler, but an application may
9338 wish to substitute another, for example to allow central
9339 implementation of event-handling for a variety of different window
9340 classes.
9341
9342 It is usually better to use `wx.Window.PushEventHandler` since this sets
9343 up a chain of event handlers, where an event not handled by one event
9344 handler is handed off to the next one in the chain.
9345 """
9346 return _core_.Window_SetEventHandler(*args, **kwargs)
9347
9348 def PushEventHandler(*args, **kwargs):
9349 """
9350 PushEventHandler(self, EvtHandler handler)
9351
9352 Pushes this event handler onto the event handler stack for the window.
9353 An event handler is an object that is capable of processing the events
9354 sent to a window. (In other words, is able to dispatch the events to
9355 handler function.) By default, the window is its own event handler,
9356 but an application may wish to substitute another, for example to
9357 allow central implementation of event-handling for a variety of
9358 different window classes.
9359
9360 wx.Window.PushEventHandler allows an application to set up a chain of
9361 event handlers, where an event not handled by one event handler is
9362 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9363 to remove the event handler. Ownership of the handler is *not* given
9364 to the window, so you should be sure to pop the handler before the
9365 window is destroyed and either let PopEventHandler destroy it, or call
9366 its Destroy method yourself.
9367 """
9368 return _core_.Window_PushEventHandler(*args, **kwargs)
9369
9370 def PopEventHandler(*args, **kwargs):
9371 """
9372 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9373
9374 Removes and returns the top-most event handler on the event handler
9375 stack. If deleteHandler is True then the wx.EvtHandler object will be
9376 destroyed after it is popped, and ``None`` will be returned instead.
9377 """
9378 return _core_.Window_PopEventHandler(*args, **kwargs)
9379
9380 def RemoveEventHandler(*args, **kwargs):
9381 """
9382 RemoveEventHandler(self, EvtHandler handler) -> bool
9383
9384 Find the given handler in the event handler chain and remove (but not
9385 delete) it from the event handler chain, returns True if it was found
9386 and False otherwise (this also results in an assert failure so this
9387 function should only be called when the handler is supposed to be
9388 there.)
9389 """
9390 return _core_.Window_RemoveEventHandler(*args, **kwargs)
9391
9392 def SetValidator(*args, **kwargs):
9393 """
9394 SetValidator(self, Validator validator)
9395
9396 Deletes the current validator (if any) and sets the window validator,
9397 having called wx.Validator.Clone to create a new validator of this
9398 type.
9399 """
9400 return _core_.Window_SetValidator(*args, **kwargs)
9401
9402 def GetValidator(*args, **kwargs):
9403 """
9404 GetValidator(self) -> Validator
9405
9406 Returns a pointer to the current validator for the window, or None if
9407 there is none.
9408 """
9409 return _core_.Window_GetValidator(*args, **kwargs)
9410
9411 def Validate(*args, **kwargs):
9412 """
9413 Validate(self) -> bool
9414
9415 Validates the current values of the child controls using their
9416 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9417 style flag set, the method will also call Validate() of all child
9418 windows. Returns false if any of the validations failed.
9419 """
9420 return _core_.Window_Validate(*args, **kwargs)
9421
9422 def TransferDataToWindow(*args, **kwargs):
9423 """
9424 TransferDataToWindow(self) -> bool
9425
9426 Transfers values to child controls from data areas specified by their
9427 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9428 style flag set, the method will also call TransferDataToWindow() of
9429 all child windows.
9430 """
9431 return _core_.Window_TransferDataToWindow(*args, **kwargs)
9432
9433 def TransferDataFromWindow(*args, **kwargs):
9434 """
9435 TransferDataFromWindow(self) -> bool
9436
9437 Transfers values from child controls to data areas specified by their
9438 validators. Returns false if a transfer failed. If the window has
9439 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9440 also call TransferDataFromWindow() of all child windows.
9441 """
9442 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9443
9444 def InitDialog(*args, **kwargs):
9445 """
9446 InitDialog(self)
9447
9448 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9449 to the dialog via validators.
9450 """
9451 return _core_.Window_InitDialog(*args, **kwargs)
9452
9453 def SetAcceleratorTable(*args, **kwargs):
9454 """
9455 SetAcceleratorTable(self, AcceleratorTable accel)
9456
9457 Sets the accelerator table for this window.
9458 """
9459 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9460
9461 def GetAcceleratorTable(*args, **kwargs):
9462 """
9463 GetAcceleratorTable(self) -> AcceleratorTable
9464
9465 Gets the accelerator table for this window.
9466 """
9467 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9468
9469 def RegisterHotKey(*args, **kwargs):
9470 """
9471 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9472
9473 Registers a system wide hotkey. Every time the user presses the hotkey
9474 registered here, this window will receive a hotkey event. It will
9475 receive the event even if the application is in the background and
9476 does not have the input focus because the user is working with some
9477 other application. To bind an event handler function to this hotkey
9478 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9479 hotkey was registered successfully.
9480 """
9481 return _core_.Window_RegisterHotKey(*args, **kwargs)
9482
9483 def UnregisterHotKey(*args, **kwargs):
9484 """
9485 UnregisterHotKey(self, int hotkeyId) -> bool
9486
9487 Unregisters a system wide hotkey.
9488 """
9489 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9490
9491 def ConvertDialogPointToPixels(*args, **kwargs):
9492 """
9493 ConvertDialogPointToPixels(self, Point pt) -> Point
9494
9495 Converts a point or size from dialog units to pixels. Dialog units
9496 are used for maintaining a dialog's proportions even if the font
9497 changes. For the x dimension, the dialog units are multiplied by the
9498 average character width and then divided by 4. For the y dimension,
9499 the dialog units are multiplied by the average character height and
9500 then divided by 8.
9501 """
9502 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9503
9504 def ConvertDialogSizeToPixels(*args, **kwargs):
9505 """
9506 ConvertDialogSizeToPixels(self, Size sz) -> Size
9507
9508 Converts a point or size from dialog units to pixels. Dialog units
9509 are used for maintaining a dialog's proportions even if the font
9510 changes. For the x dimension, the dialog units are multiplied by the
9511 average character width and then divided by 4. For the y dimension,
9512 the dialog units are multiplied by the average character height and
9513 then divided by 8.
9514 """
9515 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9516
9517 def DLG_PNT(*args, **kwargs):
9518 """
9519 DLG_PNT(self, Point pt) -> Point
9520
9521 Converts a point or size from dialog units to pixels. Dialog units
9522 are used for maintaining a dialog's proportions even if the font
9523 changes. For the x dimension, the dialog units are multiplied by the
9524 average character width and then divided by 4. For the y dimension,
9525 the dialog units are multiplied by the average character height and
9526 then divided by 8.
9527 """
9528 return _core_.Window_DLG_PNT(*args, **kwargs)
9529
9530 def DLG_SZE(*args, **kwargs):
9531 """
9532 DLG_SZE(self, Size sz) -> Size
9533
9534 Converts a point or size from dialog units to pixels. Dialog units
9535 are used for maintaining a dialog's proportions even if the font
9536 changes. For the x dimension, the dialog units are multiplied by the
9537 average character width and then divided by 4. For the y dimension,
9538 the dialog units are multiplied by the average character height and
9539 then divided by 8.
9540 """
9541 return _core_.Window_DLG_SZE(*args, **kwargs)
9542
9543 def ConvertPixelPointToDialog(*args, **kwargs):
9544 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9545 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9546
9547 def ConvertPixelSizeToDialog(*args, **kwargs):
9548 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9549 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9550
9551 def WarpPointer(*args, **kwargs):
9552 """
9553 WarpPointer(self, int x, int y)
9554
9555 Moves the pointer to the given position on the window.
9556
9557 NOTE: This function is not supported under Mac because Apple Human
9558 Interface Guidelines forbid moving the mouse cursor programmatically.
9559 """
9560 return _core_.Window_WarpPointer(*args, **kwargs)
9561
9562 def CaptureMouse(*args, **kwargs):
9563 """
9564 CaptureMouse(self)
9565
9566 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9567 release the capture.
9568
9569 Note that wxWindows maintains the stack of windows having captured the
9570 mouse and when the mouse is released the capture returns to the window
9571 which had had captured it previously and it is only really released if
9572 there were no previous window. In particular, this means that you must
9573 release the mouse as many times as you capture it, unless the window
9574 receives the `wx.MouseCaptureLostEvent` event.
9575
9576 Any application which captures the mouse in the beginning of some
9577 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9578 operation when it receives the event. The event handler must not
9579 recapture mouse.
9580 """
9581 return _core_.Window_CaptureMouse(*args, **kwargs)
9582
9583 def ReleaseMouse(*args, **kwargs):
9584 """
9585 ReleaseMouse(self)
9586
9587 Releases mouse input captured with wx.Window.CaptureMouse.
9588 """
9589 return _core_.Window_ReleaseMouse(*args, **kwargs)
9590
9591 def GetCapture(*args, **kwargs):
9592 """
9593 GetCapture() -> Window
9594
9595 Returns the window which currently captures the mouse or None
9596 """
9597 return _core_.Window_GetCapture(*args, **kwargs)
9598
9599 GetCapture = staticmethod(GetCapture)
9600 def HasCapture(*args, **kwargs):
9601 """
9602 HasCapture(self) -> bool
9603
9604 Returns true if this window has the current mouse capture.
9605 """
9606 return _core_.Window_HasCapture(*args, **kwargs)
9607
9608 def Refresh(*args, **kwargs):
9609 """
9610 Refresh(self, bool eraseBackground=True, Rect rect=None)
9611
9612 Mark the specified rectangle (or the whole window) as "dirty" so it
9613 will be repainted. Causes an EVT_PAINT event to be generated and sent
9614 to the window.
9615 """
9616 return _core_.Window_Refresh(*args, **kwargs)
9617
9618 def RefreshRect(*args, **kwargs):
9619 """
9620 RefreshRect(self, Rect rect, bool eraseBackground=True)
9621
9622 Redraws the contents of the given rectangle: the area inside it will
9623 be repainted. This is the same as Refresh but has a nicer syntax.
9624 """
9625 return _core_.Window_RefreshRect(*args, **kwargs)
9626
9627 def Update(*args, **kwargs):
9628 """
9629 Update(self)
9630
9631 Calling this method immediately repaints the invalidated area of the
9632 window instead of waiting for the EVT_PAINT event to happen, (normally
9633 this would usually only happen when the flow of control returns to the
9634 event loop.) Notice that this function doesn't refresh the window and
9635 does nothing if the window has been already repainted. Use `Refresh`
9636 first if you want to immediately redraw the window (or some portion of
9637 it) unconditionally.
9638 """
9639 return _core_.Window_Update(*args, **kwargs)
9640
9641 def ClearBackground(*args, **kwargs):
9642 """
9643 ClearBackground(self)
9644
9645 Clears the window by filling it with the current background
9646 colour. Does not cause an erase background event to be generated.
9647 """
9648 return _core_.Window_ClearBackground(*args, **kwargs)
9649
9650 def Freeze(*args, **kwargs):
9651 """
9652 Freeze(self)
9653
9654 Freezes the window or, in other words, prevents any updates from
9655 taking place on screen, the window is not redrawn at all. Thaw must be
9656 called to reenable window redrawing. Calls to Freeze/Thaw may be
9657 nested, with the actual Thaw being delayed until all the nesting has
9658 been undone.
9659
9660 This method is useful for visual appearance optimization (for example,
9661 it is a good idea to use it before inserting large amount of text into
9662 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9663 for all controls so it is mostly just a hint to wxWindows and not a
9664 mandatory directive.
9665 """
9666 return _core_.Window_Freeze(*args, **kwargs)
9667
9668 def IsFrozen(*args, **kwargs):
9669 """
9670 IsFrozen(self) -> bool
9671
9672 Returns ``True`` if the window has been frozen and not thawed yet.
9673
9674 :see: `Freeze` and `Thaw`
9675 """
9676 return _core_.Window_IsFrozen(*args, **kwargs)
9677
9678 def Thaw(*args, **kwargs):
9679 """
9680 Thaw(self)
9681
9682 Reenables window updating after a previous call to Freeze. Calls to
9683 Freeze/Thaw may be nested, so Thaw must be called the same number of
9684 times that Freeze was before the window will be updated.
9685 """
9686 return _core_.Window_Thaw(*args, **kwargs)
9687
9688 def PrepareDC(*args, **kwargs):
9689 """
9690 PrepareDC(self, DC dc)
9691
9692 Call this function to prepare the device context for drawing a
9693 scrolled image. It sets the device origin according to the current
9694 scroll position.
9695 """
9696 return _core_.Window_PrepareDC(*args, **kwargs)
9697
9698 def IsDoubleBuffered(*args, **kwargs):
9699 """
9700 IsDoubleBuffered(self) -> bool
9701
9702 Returns ``True`` if the window contents is double-buffered by the
9703 system, i.e. if any drawing done on the window is really done on a
9704 temporary backing surface and transferred to the screen all at once
9705 later.
9706 """
9707 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9708
9709 def GetUpdateRegion(*args, **kwargs):
9710 """
9711 GetUpdateRegion(self) -> Region
9712
9713 Returns the region specifying which parts of the window have been
9714 damaged. Should only be called within an EVT_PAINT handler.
9715 """
9716 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9717
9718 def GetUpdateClientRect(*args, **kwargs):
9719 """
9720 GetUpdateClientRect(self) -> Rect
9721
9722 Get the update rectangle region bounding box in client coords.
9723 """
9724 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9725
9726 def IsExposed(*args, **kwargs):
9727 """
9728 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9729
9730 Returns true if the given point or rectangle area has been exposed
9731 since the last repaint. Call this in an paint event handler to
9732 optimize redrawing by only redrawing those areas, which have been
9733 exposed.
9734 """
9735 return _core_.Window_IsExposed(*args, **kwargs)
9736
9737 def IsExposedPoint(*args, **kwargs):
9738 """
9739 IsExposedPoint(self, Point pt) -> bool
9740
9741 Returns true if the given point or rectangle area has been exposed
9742 since the last repaint. Call this in an paint event handler to
9743 optimize redrawing by only redrawing those areas, which have been
9744 exposed.
9745 """
9746 return _core_.Window_IsExposedPoint(*args, **kwargs)
9747
9748 def IsExposedRect(*args, **kwargs):
9749 """
9750 IsExposedRect(self, Rect rect) -> bool
9751
9752 Returns true if the given point or rectangle area has been exposed
9753 since the last repaint. Call this in an paint event handler to
9754 optimize redrawing by only redrawing those areas, which have been
9755 exposed.
9756 """
9757 return _core_.Window_IsExposedRect(*args, **kwargs)
9758
9759 def GetDefaultAttributes(*args, **kwargs):
9760 """
9761 GetDefaultAttributes(self) -> VisualAttributes
9762
9763 Get the default attributes for an instance of this class. This is
9764 useful if you want to use the same font or colour in your own control
9765 as in a standard control -- which is a much better idea than hard
9766 coding specific colours or fonts which might look completely out of
9767 place on the user's system, especially if it uses themes.
9768 """
9769 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9770
9771 def GetClassDefaultAttributes(*args, **kwargs):
9772 """
9773 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9774
9775 Get the default attributes for this class. This is useful if you want
9776 to use the same font or colour in your own control as in a standard
9777 control -- which is a much better idea than hard coding specific
9778 colours or fonts which might look completely out of place on the
9779 user's system, especially if it uses themes.
9780
9781 The variant parameter is only relevant under Mac currently and is
9782 ignore under other platforms. Under Mac, it will change the size of
9783 the returned font. See `wx.Window.SetWindowVariant` for more about
9784 this.
9785 """
9786 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9787
9788 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9789 def SetBackgroundColour(*args, **kwargs):
9790 """
9791 SetBackgroundColour(self, Colour colour) -> bool
9792
9793 Sets the background colour of the window. Returns True if the colour
9794 was changed. The background colour is usually painted by the default
9795 EVT_ERASE_BACKGROUND event handler function under Windows and
9796 automatically under GTK. Using `wx.NullColour` will reset the window
9797 to the default background colour.
9798
9799 Note that setting the background colour may not cause an immediate
9800 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9801 calling this function.
9802
9803 Using this function will disable attempts to use themes for this
9804 window, if the system supports them. Use with care since usually the
9805 themes represent the appearance chosen by the user to be used for all
9806 applications on the system.
9807 """
9808 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9809
9810 def SetOwnBackgroundColour(*args, **kwargs):
9811 """SetOwnBackgroundColour(self, Colour colour)"""
9812 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9813
9814 def SetForegroundColour(*args, **kwargs):
9815 """
9816 SetForegroundColour(self, Colour colour) -> bool
9817
9818 Sets the foreground colour of the window. Returns True is the colour
9819 was changed. The interpretation of foreground colour is dependent on
9820 the window class; it may be the text colour or other colour, or it may
9821 not be used at all.
9822 """
9823 return _core_.Window_SetForegroundColour(*args, **kwargs)
9824
9825 def SetOwnForegroundColour(*args, **kwargs):
9826 """SetOwnForegroundColour(self, Colour colour)"""
9827 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9828
9829 def GetBackgroundColour(*args, **kwargs):
9830 """
9831 GetBackgroundColour(self) -> Colour
9832
9833 Returns the background colour of the window.
9834 """
9835 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9836
9837 def GetForegroundColour(*args, **kwargs):
9838 """
9839 GetForegroundColour(self) -> Colour
9840
9841 Returns the foreground colour of the window. The interpretation of
9842 foreground colour is dependent on the window class; it may be the text
9843 colour or other colour, or it may not be used at all.
9844 """
9845 return _core_.Window_GetForegroundColour(*args, **kwargs)
9846
9847 def InheritsBackgroundColour(*args, **kwargs):
9848 """InheritsBackgroundColour(self) -> bool"""
9849 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9850
9851 def UseBgCol(*args, **kwargs):
9852 """UseBgCol(self) -> bool"""
9853 return _core_.Window_UseBgCol(*args, **kwargs)
9854
9855 def SetBackgroundStyle(*args, **kwargs):
9856 """
9857 SetBackgroundStyle(self, int style) -> bool
9858
9859 Returns the background style of the window. The background style
9860 indicates how the background of the window is drawn.
9861
9862 ====================== ========================================
9863 wx.BG_STYLE_SYSTEM The background colour or pattern should
9864 be determined by the system
9865 wx.BG_STYLE_COLOUR The background should be a solid colour
9866 wx.BG_STYLE_CUSTOM The background will be implemented by the
9867 application.
9868 ====================== ========================================
9869
9870 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9871 a custom background, such as a tiled bitmap. Currently the style has
9872 no effect on other platforms.
9873
9874 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9875 """
9876 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9877
9878 def GetBackgroundStyle(*args, **kwargs):
9879 """
9880 GetBackgroundStyle(self) -> int
9881
9882 Returns the background style of the window.
9883
9884 :see: `SetBackgroundStyle`
9885 """
9886 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9887
9888 def HasTransparentBackground(*args, **kwargs):
9889 """
9890 HasTransparentBackground(self) -> bool
9891
9892 Returns True if this window's background is transparent (as, for
9893 example, for `wx.StaticText`) and should show the parent window's
9894 background.
9895
9896 This method is mostly used internally by the library itself and you
9897 normally shouldn't have to call it. You may, however, have to override
9898 it in your custom control classes to ensure that background is painted
9899 correctly.
9900 """
9901 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9902
9903 def SetCursor(*args, **kwargs):
9904 """
9905 SetCursor(self, Cursor cursor) -> bool
9906
9907 Sets the window's cursor. Notice that the window cursor also sets it
9908 for the children of the window implicitly.
9909
9910 The cursor may be wx.NullCursor in which case the window cursor will
9911 be reset back to default.
9912 """
9913 return _core_.Window_SetCursor(*args, **kwargs)
9914
9915 def GetCursor(*args, **kwargs):
9916 """
9917 GetCursor(self) -> Cursor
9918
9919 Return the cursor associated with this window.
9920 """
9921 return _core_.Window_GetCursor(*args, **kwargs)
9922
9923 def SetFont(*args, **kwargs):
9924 """
9925 SetFont(self, Font font) -> bool
9926
9927 Sets the font for this window.
9928 """
9929 return _core_.Window_SetFont(*args, **kwargs)
9930
9931 def SetOwnFont(*args, **kwargs):
9932 """SetOwnFont(self, Font font)"""
9933 return _core_.Window_SetOwnFont(*args, **kwargs)
9934
9935 def GetFont(*args, **kwargs):
9936 """
9937 GetFont(self) -> Font
9938
9939 Returns the default font used for this window.
9940 """
9941 return _core_.Window_GetFont(*args, **kwargs)
9942
9943 def SetCaret(*args, **kwargs):
9944 """
9945 SetCaret(self, Caret caret)
9946
9947 Sets the caret associated with the window.
9948 """
9949 return _core_.Window_SetCaret(*args, **kwargs)
9950
9951 def GetCaret(*args, **kwargs):
9952 """
9953 GetCaret(self) -> Caret
9954
9955 Returns the caret associated with the window.
9956 """
9957 return _core_.Window_GetCaret(*args, **kwargs)
9958
9959 def GetCharHeight(*args, **kwargs):
9960 """
9961 GetCharHeight(self) -> int
9962
9963 Get the (average) character size for the current font.
9964 """
9965 return _core_.Window_GetCharHeight(*args, **kwargs)
9966
9967 def GetCharWidth(*args, **kwargs):
9968 """
9969 GetCharWidth(self) -> int
9970
9971 Get the (average) character size for the current font.
9972 """
9973 return _core_.Window_GetCharWidth(*args, **kwargs)
9974
9975 def GetTextExtent(*args, **kwargs):
9976 """
9977 GetTextExtent(String string) -> (width, height)
9978
9979 Get the width and height of the text using the current font.
9980 """
9981 return _core_.Window_GetTextExtent(*args, **kwargs)
9982
9983 def GetFullTextExtent(*args, **kwargs):
9984 """
9985 GetFullTextExtent(String string, Font font=None) ->
9986 (width, height, descent, externalLeading)
9987
9988 Get the width, height, decent and leading of the text using the
9989 current or specified font.
9990 """
9991 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9992
9993 def ClientToScreenXY(*args, **kwargs):
9994 """
9995 ClientToScreenXY(int x, int y) -> (x,y)
9996
9997 Converts to screen coordinates from coordinates relative to this window.
9998 """
9999 return _core_.Window_ClientToScreenXY(*args, **kwargs)
10000
10001 def ScreenToClientXY(*args, **kwargs):
10002 """
10003 ScreenToClientXY(int x, int y) -> (x,y)
10004
10005 Converts from screen to client window coordinates.
10006 """
10007 return _core_.Window_ScreenToClientXY(*args, **kwargs)
10008
10009 def ClientToScreen(*args, **kwargs):
10010 """
10011 ClientToScreen(self, Point pt) -> Point
10012
10013 Converts to screen coordinates from coordinates relative to this window.
10014 """
10015 return _core_.Window_ClientToScreen(*args, **kwargs)
10016
10017 def ScreenToClient(*args, **kwargs):
10018 """
10019 ScreenToClient(self, Point pt) -> Point
10020
10021 Converts from screen to client window coordinates.
10022 """
10023 return _core_.Window_ScreenToClient(*args, **kwargs)
10024
10025 def HitTestXY(*args, **kwargs):
10026 """
10027 HitTestXY(self, int x, int y) -> int
10028
10029 Test where the given (in client coords) point lies
10030 """
10031 return _core_.Window_HitTestXY(*args, **kwargs)
10032
10033 def HitTest(*args, **kwargs):
10034 """
10035 HitTest(self, Point pt) -> int
10036
10037 Test where the given (in client coords) point lies
10038 """
10039 return _core_.Window_HitTest(*args, **kwargs)
10040
10041 def GetBorder(*args):
10042 """
10043 GetBorder(self, long flags) -> int
10044 GetBorder(self) -> int
10045
10046 Get border for the flags of this window
10047 """
10048 return _core_.Window_GetBorder(*args)
10049
10050 def UpdateWindowUI(*args, **kwargs):
10051 """
10052 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
10053
10054 This function sends EVT_UPDATE_UI events to the window. The particular
10055 implementation depends on the window; for example a wx.ToolBar will
10056 send an update UI event for each toolbar button, and a wx.Frame will
10057 send an update UI event for each menubar menu item. You can call this
10058 function from your application to ensure that your UI is up-to-date at
10059 a particular point in time (as far as your EVT_UPDATE_UI handlers are
10060 concerned). This may be necessary if you have called
10061 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
10062 limit the overhead that wxWindows incurs by sending update UI events
10063 in idle time.
10064 """
10065 return _core_.Window_UpdateWindowUI(*args, **kwargs)
10066
10067 def PopupMenuXY(*args, **kwargs):
10068 """
10069 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
10070
10071 Pops up the given menu at the specified coordinates, relative to this window,
10072 and returns control when the user has dismissed the menu. If a menu item is
10073 selected, the corresponding menu event is generated and will be processed as
10074 usual. If the default position is given then the current position of the
10075 mouse cursor will be used.
10076 """
10077 return _core_.Window_PopupMenuXY(*args, **kwargs)
10078
10079 def PopupMenu(*args, **kwargs):
10080 """
10081 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
10082
10083 Pops up the given menu at the specified coordinates, relative to this window,
10084 and returns control when the user has dismissed the menu. If a menu item is
10085 selected, the corresponding menu event is generated and will be processed as
10086 usual. If the default position is given then the current position of the
10087 mouse cursor will be used.
10088 """
10089 return _core_.Window_PopupMenu(*args, **kwargs)
10090
10091 def HasMultiplePages(*args, **kwargs):
10092 """HasMultiplePages(self) -> bool"""
10093 return _core_.Window_HasMultiplePages(*args, **kwargs)
10094
10095 def GetHandle(*args, **kwargs):
10096 """
10097 GetHandle(self) -> long
10098
10099 Returns the platform-specific handle (as a long integer) of the
10100 physical window. Currently on wxMac it returns the handle of the
10101 toplevel parent of the window.
10102 """
10103 return _core_.Window_GetHandle(*args, **kwargs)
10104
10105 def AssociateHandle(*args, **kwargs):
10106 """
10107 AssociateHandle(self, long handle)
10108
10109 Associate the window with a new native handle
10110 """
10111 return _core_.Window_AssociateHandle(*args, **kwargs)
10112
10113 def DissociateHandle(*args, **kwargs):
10114 """
10115 DissociateHandle(self)
10116
10117 Dissociate the current native handle from the window
10118 """
10119 return _core_.Window_DissociateHandle(*args, **kwargs)
10120
10121 def OnPaint(*args, **kwargs):
10122 """OnPaint(self, PaintEvent event)"""
10123 return _core_.Window_OnPaint(*args, **kwargs)
10124
10125 def HasScrollbar(*args, **kwargs):
10126 """
10127 HasScrollbar(self, int orient) -> bool
10128
10129 Does the window have the scrollbar for this orientation?
10130 """
10131 return _core_.Window_HasScrollbar(*args, **kwargs)
10132
10133 def SetScrollbar(*args, **kwargs):
10134 """
10135 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
10136 bool refresh=True)
10137
10138 Sets the scrollbar properties of a built-in scrollbar.
10139 """
10140 return _core_.Window_SetScrollbar(*args, **kwargs)
10141
10142 def SetScrollPos(*args, **kwargs):
10143 """
10144 SetScrollPos(self, int orientation, int pos, bool refresh=True)
10145
10146 Sets the position of one of the built-in scrollbars.
10147 """
10148 return _core_.Window_SetScrollPos(*args, **kwargs)
10149
10150 def GetScrollPos(*args, **kwargs):
10151 """
10152 GetScrollPos(self, int orientation) -> int
10153
10154 Returns the built-in scrollbar position.
10155 """
10156 return _core_.Window_GetScrollPos(*args, **kwargs)
10157
10158 def GetScrollThumb(*args, **kwargs):
10159 """
10160 GetScrollThumb(self, int orientation) -> int
10161
10162 Returns the built-in scrollbar thumb size.
10163 """
10164 return _core_.Window_GetScrollThumb(*args, **kwargs)
10165
10166 def GetScrollRange(*args, **kwargs):
10167 """
10168 GetScrollRange(self, int orientation) -> int
10169
10170 Returns the built-in scrollbar range.
10171 """
10172 return _core_.Window_GetScrollRange(*args, **kwargs)
10173
10174 def ScrollWindow(*args, **kwargs):
10175 """
10176 ScrollWindow(self, int dx, int dy, Rect rect=None)
10177
10178 Physically scrolls the pixels in the window and move child windows
10179 accordingly. Use this function to optimise your scrolling
10180 implementations, to minimise the area that must be redrawn. Note that
10181 it is rarely required to call this function from a user program.
10182 """
10183 return _core_.Window_ScrollWindow(*args, **kwargs)
10184
10185 def ScrollLines(*args, **kwargs):
10186 """
10187 ScrollLines(self, int lines) -> bool
10188
10189 If the platform and window class supports it, scrolls the window by
10190 the given number of lines down, if lines is positive, or up if lines
10191 is negative. Returns True if the window was scrolled, False if it was
10192 already on top/bottom and nothing was done.
10193 """
10194 return _core_.Window_ScrollLines(*args, **kwargs)
10195
10196 def ScrollPages(*args, **kwargs):
10197 """
10198 ScrollPages(self, int pages) -> bool
10199
10200 If the platform and window class supports it, scrolls the window by
10201 the given number of pages down, if pages is positive, or up if pages
10202 is negative. Returns True if the window was scrolled, False if it was
10203 already on top/bottom and nothing was done.
10204 """
10205 return _core_.Window_ScrollPages(*args, **kwargs)
10206
10207 def LineUp(*args, **kwargs):
10208 """
10209 LineUp(self) -> bool
10210
10211 This is just a wrapper for ScrollLines(-1).
10212 """
10213 return _core_.Window_LineUp(*args, **kwargs)
10214
10215 def LineDown(*args, **kwargs):
10216 """
10217 LineDown(self) -> bool
10218
10219 This is just a wrapper for ScrollLines(1).
10220 """
10221 return _core_.Window_LineDown(*args, **kwargs)
10222
10223 def PageUp(*args, **kwargs):
10224 """
10225 PageUp(self) -> bool
10226
10227 This is just a wrapper for ScrollPages(-1).
10228 """
10229 return _core_.Window_PageUp(*args, **kwargs)
10230
10231 def PageDown(*args, **kwargs):
10232 """
10233 PageDown(self) -> bool
10234
10235 This is just a wrapper for ScrollPages(1).
10236 """
10237 return _core_.Window_PageDown(*args, **kwargs)
10238
10239 def SetHelpText(*args, **kwargs):
10240 """
10241 SetHelpText(self, String text)
10242
10243 Sets the help text to be used as context-sensitive help for this
10244 window. Note that the text is actually stored by the current
10245 `wx.HelpProvider` implementation, and not in the window object itself.
10246 """
10247 return _core_.Window_SetHelpText(*args, **kwargs)
10248
10249 def SetHelpTextForId(*args, **kwargs):
10250 """
10251 SetHelpTextForId(self, String text)
10252
10253 Associate this help text with all windows with the same id as this
10254 one.
10255 """
10256 return _core_.Window_SetHelpTextForId(*args, **kwargs)
10257
10258 def GetHelpTextAtPoint(*args, **kwargs):
10259 """
10260 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10261
10262 Get the help string associated with the given position in this window.
10263
10264 Notice that pt may be invalid if event origin is keyboard or unknown
10265 and this method should return the global window help text then
10266
10267 """
10268 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10269
10270 def GetHelpText(*args, **kwargs):
10271 """
10272 GetHelpText(self) -> String
10273
10274 Gets the help text to be used as context-sensitive help for this
10275 window. Note that the text is actually stored by the current
10276 `wx.HelpProvider` implementation, and not in the window object itself.
10277 """
10278 return _core_.Window_GetHelpText(*args, **kwargs)
10279
10280 def SetToolTipString(*args, **kwargs):
10281 """
10282 SetToolTipString(self, String tip)
10283
10284 Attach a tooltip to the window.
10285 """
10286 return _core_.Window_SetToolTipString(*args, **kwargs)
10287
10288 def SetToolTip(*args, **kwargs):
10289 """
10290 SetToolTip(self, ToolTip tip)
10291
10292 Attach a tooltip to the window.
10293 """
10294 return _core_.Window_SetToolTip(*args, **kwargs)
10295
10296 def GetToolTip(*args, **kwargs):
10297 """
10298 GetToolTip(self) -> ToolTip
10299
10300 get the associated tooltip or None if none
10301 """
10302 return _core_.Window_GetToolTip(*args, **kwargs)
10303
10304 def SetDropTarget(*args, **kwargs):
10305 """
10306 SetDropTarget(self, DropTarget dropTarget)
10307
10308 Associates a drop target with this window. If the window already has
10309 a drop target, it is deleted.
10310 """
10311 return _core_.Window_SetDropTarget(*args, **kwargs)
10312
10313 def GetDropTarget(*args, **kwargs):
10314 """
10315 GetDropTarget(self) -> DropTarget
10316
10317 Returns the associated drop target, which may be None.
10318 """
10319 return _core_.Window_GetDropTarget(*args, **kwargs)
10320
10321 def DragAcceptFiles(*args, **kwargs):
10322 """
10323 DragAcceptFiles(self, bool accept)
10324
10325 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10326 Only functional on Windows.
10327 """
10328 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10329
10330 def SetConstraints(*args, **kwargs):
10331 """
10332 SetConstraints(self, LayoutConstraints constraints)
10333
10334 Sets the window to have the given layout constraints. If an existing
10335 layout constraints object is already owned by the window, it will be
10336 deleted. Pass None to disassociate and delete the window's current
10337 constraints.
10338
10339 You must call SetAutoLayout to tell a window to use the constraints
10340 automatically in its default EVT_SIZE handler; otherwise, you must
10341 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10342 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10343 effect.
10344 """
10345 return _core_.Window_SetConstraints(*args, **kwargs)
10346
10347 def GetConstraints(*args, **kwargs):
10348 """
10349 GetConstraints(self) -> LayoutConstraints
10350
10351 Returns a pointer to the window's layout constraints, or None if there
10352 are none.
10353 """
10354 return _core_.Window_GetConstraints(*args, **kwargs)
10355
10356 def SetAutoLayout(*args, **kwargs):
10357 """
10358 SetAutoLayout(self, bool autoLayout)
10359
10360 Determines whether the Layout function will be called automatically
10361 when the window is resized. lease note that this only happens for the
10362 windows usually used to contain children, namely `wx.Panel` and
10363 `wx.TopLevelWindow` (and the classes deriving from them).
10364
10365 This method is called implicitly by `SetSizer` but if you use
10366 `SetConstraints` you should call it manually or otherwise the window
10367 layout won't be correctly updated when its size changes.
10368 """
10369 return _core_.Window_SetAutoLayout(*args, **kwargs)
10370
10371 def GetAutoLayout(*args, **kwargs):
10372 """
10373 GetAutoLayout(self) -> bool
10374
10375 Returns the current autoLayout setting
10376 """
10377 return _core_.Window_GetAutoLayout(*args, **kwargs)
10378
10379 def Layout(*args, **kwargs):
10380 """
10381 Layout(self) -> bool
10382
10383 Invokes the constraint-based layout algorithm or the sizer-based
10384 algorithm for this window. See SetAutoLayout: when auto layout is on,
10385 this function gets called automatically by the default EVT_SIZE
10386 handler when the window is resized.
10387 """
10388 return _core_.Window_Layout(*args, **kwargs)
10389
10390 def SetSizer(*args, **kwargs):
10391 """
10392 SetSizer(self, Sizer sizer, bool deleteOld=True)
10393
10394 Sets the window to have the given layout sizer. The window will then
10395 own the object, and will take care of its deletion. If an existing
10396 layout sizer object is already owned by the window, it will be deleted
10397 if the deleteOld parameter is true. Note that this function will also
10398 call SetAutoLayout implicitly with a True parameter if the sizer is
10399 non-None, and False otherwise.
10400 """
10401 return _core_.Window_SetSizer(*args, **kwargs)
10402
10403 def SetSizerAndFit(*args, **kwargs):
10404 """
10405 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10406
10407 The same as SetSizer, except it also sets the size hints for the
10408 window based on the sizer's minimum size.
10409 """
10410 return _core_.Window_SetSizerAndFit(*args, **kwargs)
10411
10412 def GetSizer(*args, **kwargs):
10413 """
10414 GetSizer(self) -> Sizer
10415
10416 Return the sizer associated with the window by a previous call to
10417 SetSizer or None if there isn't one.
10418 """
10419 return _core_.Window_GetSizer(*args, **kwargs)
10420
10421 def SetContainingSizer(*args, **kwargs):
10422 """
10423 SetContainingSizer(self, Sizer sizer)
10424
10425 This normally does not need to be called by application code. It is
10426 called internally when a window is added to a sizer, and is used so
10427 the window can remove itself from the sizer when it is destroyed.
10428 """
10429 return _core_.Window_SetContainingSizer(*args, **kwargs)
10430
10431 def GetContainingSizer(*args, **kwargs):
10432 """
10433 GetContainingSizer(self) -> Sizer
10434
10435 Return the sizer that this window is a member of, if any, otherwise None.
10436 """
10437 return _core_.Window_GetContainingSizer(*args, **kwargs)
10438
10439 def InheritAttributes(*args, **kwargs):
10440 """
10441 InheritAttributes(self)
10442
10443 This function is (or should be, in case of custom controls) called
10444 during window creation to intelligently set up the window visual
10445 attributes, that is the font and the foreground and background
10446 colours.
10447
10448 By 'intelligently' the following is meant: by default, all windows use
10449 their own default attributes. However if some of the parent's
10450 attributes are explicitly changed (that is, using SetFont and not
10451 SetOwnFont) and if the corresponding attribute hadn't been
10452 explicitly set for this window itself, then this window takes the same
10453 value as used by the parent. In addition, if the window overrides
10454 ShouldInheritColours to return false, the colours will not be changed
10455 no matter what and only the font might.
10456
10457 This rather complicated logic is necessary in order to accommodate the
10458 different usage scenarios. The most common one is when all default
10459 attributes are used and in this case, nothing should be inherited as
10460 in modern GUIs different controls use different fonts (and colours)
10461 than their siblings so they can't inherit the same value from the
10462 parent. However it was also deemed desirable to allow to simply change
10463 the attributes of all children at once by just changing the font or
10464 colour of their common parent, hence in this case we do inherit the
10465 parents attributes.
10466
10467 """
10468 return _core_.Window_InheritAttributes(*args, **kwargs)
10469
10470 def ShouldInheritColours(*args, **kwargs):
10471 """
10472 ShouldInheritColours(self) -> bool
10473
10474 Return true from here to allow the colours of this window to be
10475 changed by InheritAttributes, returning false forbids inheriting them
10476 from the parent window.
10477
10478 The base class version returns false, but this method is overridden in
10479 wxControl where it returns true.
10480 """
10481 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10482
10483 def CanSetTransparent(*args, **kwargs):
10484 """
10485 CanSetTransparent(self) -> bool
10486
10487 Returns ``True`` if the platform supports setting the transparency for
10488 this window. Note that this method will err on the side of caution,
10489 so it is possible that this will return ``False`` when it is in fact
10490 possible to set the transparency.
10491
10492 NOTE: On X-windows systems the X server must have the composite
10493 extension loaded, and there must be a composite manager program (such
10494 as xcompmgr) running.
10495 """
10496 return _core_.Window_CanSetTransparent(*args, **kwargs)
10497
10498 def SetTransparent(*args, **kwargs):
10499 """
10500 SetTransparent(self, byte alpha) -> bool
10501
10502 Attempt to set the transparency of this window to the ``alpha`` value,
10503 returns True on success. The ``alpha`` value is an integer in the
10504 range of 0 to 255, where 0 is fully transparent and 255 is fully
10505 opaque.
10506 """
10507 return _core_.Window_SetTransparent(*args, **kwargs)
10508
10509 def PostCreate(self, pre):
10510 """
10511 Phase 3 of the 2-phase create <wink!>
10512 Call this method after precreating the window with the 2-phase create method.
10513 """
10514 self.this = pre.this
10515 self.thisown = pre.thisown
10516 pre.thisown = 0
10517 if hasattr(self, '_setOORInfo'):
10518 try:
10519 self._setOORInfo(self)
10520 except TypeError:
10521 pass
10522 if hasattr(self, '_setCallbackInfo'):
10523 try:
10524 self._setCallbackInfo(self, pre.__class__)
10525 except TypeError:
10526 pass
10527
10528 def SendSizeEvent(self):
10529 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
10530
10531 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10532 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10533 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10534 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10535 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
10536 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10537 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10538 Border = property(GetBorder,doc="See `GetBorder`")
10539 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10540 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10541 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10542 Children = property(GetChildren,doc="See `GetChildren`")
10543 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10544 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10545 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10546 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10547 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10548 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10549 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10550 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10551 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10552 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10553 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10554 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
10555 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10556 TopLevelParent = property(GetTopLevelParent,doc="See `GetTopLevelParent`")
10557 Handle = property(GetHandle,doc="See `GetHandle`")
10558 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
10559 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10560 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
10561 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
10562 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10563 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10564 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10565 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10566 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10567 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10568 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10569 Parent = property(GetParent,doc="See `GetParent`")
10570 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10571 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10572 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10573 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10574 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10575 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10576 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10577 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10578 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10579 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10580 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10581 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10582 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10583 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10584 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10585 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10586 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10587 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10588 _core_.Window_swigregister(Window)
10589
10590 def PreWindow(*args, **kwargs):
10591 """
10592 PreWindow() -> Window
10593
10594 Precreate a Window for 2-phase creation.
10595 """
10596 val = _core_.new_PreWindow(*args, **kwargs)
10597 return val
10598
10599 def Window_NewControlId(*args):
10600 """
10601 Window_NewControlId() -> int
10602
10603 Generate a control id for the controls which were not given one.
10604 """
10605 return _core_.Window_NewControlId(*args)
10606
10607 def Window_NextControlId(*args, **kwargs):
10608 """
10609 Window_NextControlId(int winid) -> int
10610
10611 Get the id of the control following the one with the given
10612 autogenerated) id
10613 """
10614 return _core_.Window_NextControlId(*args, **kwargs)
10615
10616 def Window_PrevControlId(*args, **kwargs):
10617 """
10618 Window_PrevControlId(int winid) -> int
10619
10620 Get the id of the control preceding the one with the given
10621 autogenerated) id
10622 """
10623 return _core_.Window_PrevControlId(*args, **kwargs)
10624
10625 def Window_FindFocus(*args):
10626 """
10627 Window_FindFocus() -> Window
10628
10629 Returns the window or control that currently has the keyboard focus,
10630 or None.
10631 """
10632 return _core_.Window_FindFocus(*args)
10633
10634 def Window_GetCapture(*args):
10635 """
10636 Window_GetCapture() -> Window
10637
10638 Returns the window which currently captures the mouse or None
10639 """
10640 return _core_.Window_GetCapture(*args)
10641
10642 def Window_GetClassDefaultAttributes(*args, **kwargs):
10643 """
10644 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10645
10646 Get the default attributes for this class. This is useful if you want
10647 to use the same font or colour in your own control as in a standard
10648 control -- which is a much better idea than hard coding specific
10649 colours or fonts which might look completely out of place on the
10650 user's system, especially if it uses themes.
10651
10652 The variant parameter is only relevant under Mac currently and is
10653 ignore under other platforms. Under Mac, it will change the size of
10654 the returned font. See `wx.Window.SetWindowVariant` for more about
10655 this.
10656 """
10657 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10658
10659 def DLG_PNT(win, point_or_x, y=None):
10660 """
10661 Convenience function for converting a Point or (x,y) in
10662 dialog units to pixel units.
10663 """
10664 if y is None:
10665 return win.ConvertDialogPointToPixels(point_or_x)
10666 else:
10667 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10668
10669 def DLG_SZE(win, size_width, height=None):
10670 """
10671 Convenience function for converting a Size or (w,h) in
10672 dialog units to pixel units.
10673 """
10674 if height is None:
10675 return win.ConvertDialogSizeToPixels(size_width)
10676 else:
10677 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10678
10679
10680 def FindWindowById(*args, **kwargs):
10681 """
10682 FindWindowById(long id, Window parent=None) -> Window
10683
10684 Find the first window in the application with the given id. If parent
10685 is None, the search will start from all top-level frames and dialog
10686 boxes; if non-None, the search will be limited to the given window
10687 hierarchy. The search is recursive in both cases.
10688 """
10689 return _core_.FindWindowById(*args, **kwargs)
10690
10691 def FindWindowByName(*args, **kwargs):
10692 """
10693 FindWindowByName(String name, Window parent=None) -> Window
10694
10695 Find a window by its name (as given in a window constructor or Create
10696 function call). If parent is None, the search will start from all
10697 top-level frames and dialog boxes; if non-None, the search will be
10698 limited to the given window hierarchy. The search is recursive in both
10699 cases.
10700
10701 If no window with such name is found, wx.FindWindowByLabel is called.
10702 """
10703 return _core_.FindWindowByName(*args, **kwargs)
10704
10705 def FindWindowByLabel(*args, **kwargs):
10706 """
10707 FindWindowByLabel(String label, Window parent=None) -> Window
10708
10709 Find a window by its label. Depending on the type of window, the label
10710 may be a window title or panel item label. If parent is None, the
10711 search will start from all top-level frames and dialog boxes; if
10712 non-None, the search will be limited to the given window
10713 hierarchy. The search is recursive in both cases.
10714 """
10715 return _core_.FindWindowByLabel(*args, **kwargs)
10716
10717 def Window_FromHWND(*args, **kwargs):
10718 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10719 return _core_.Window_FromHWND(*args, **kwargs)
10720
10721 def GetTopLevelWindows(*args):
10722 """
10723 GetTopLevelWindows() -> PyObject
10724
10725 Returns a list of the the application's top-level windows, (frames,
10726 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10727 by wxWidgets, and so it is only valid as long as no top-level windows
10728 are closed or new top-level windows are created.
10729
10730 """
10731 return _core_.GetTopLevelWindows(*args)
10732 #---------------------------------------------------------------------------
10733
10734 class Validator(EvtHandler):
10735 """Proxy of C++ Validator class"""
10736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10737 __repr__ = _swig_repr
10738 def __init__(self, *args, **kwargs):
10739 """__init__(self) -> Validator"""
10740 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10741 self._setOORInfo(self)
10742
10743 def Clone(*args, **kwargs):
10744 """Clone(self) -> Validator"""
10745 return _core_.Validator_Clone(*args, **kwargs)
10746
10747 def Validate(*args, **kwargs):
10748 """Validate(self, Window parent) -> bool"""
10749 return _core_.Validator_Validate(*args, **kwargs)
10750
10751 def TransferToWindow(*args, **kwargs):
10752 """TransferToWindow(self) -> bool"""
10753 return _core_.Validator_TransferToWindow(*args, **kwargs)
10754
10755 def TransferFromWindow(*args, **kwargs):
10756 """TransferFromWindow(self) -> bool"""
10757 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10758
10759 def GetWindow(*args, **kwargs):
10760 """GetWindow(self) -> Window"""
10761 return _core_.Validator_GetWindow(*args, **kwargs)
10762
10763 def SetWindow(*args, **kwargs):
10764 """SetWindow(self, Window window)"""
10765 return _core_.Validator_SetWindow(*args, **kwargs)
10766
10767 def IsSilent(*args, **kwargs):
10768 """IsSilent() -> bool"""
10769 return _core_.Validator_IsSilent(*args, **kwargs)
10770
10771 IsSilent = staticmethod(IsSilent)
10772 def SetBellOnError(*args, **kwargs):
10773 """SetBellOnError(int doIt=True)"""
10774 return _core_.Validator_SetBellOnError(*args, **kwargs)
10775
10776 SetBellOnError = staticmethod(SetBellOnError)
10777 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
10778 _core_.Validator_swigregister(Validator)
10779
10780 def Validator_IsSilent(*args):
10781 """Validator_IsSilent() -> bool"""
10782 return _core_.Validator_IsSilent(*args)
10783
10784 def Validator_SetBellOnError(*args, **kwargs):
10785 """Validator_SetBellOnError(int doIt=True)"""
10786 return _core_.Validator_SetBellOnError(*args, **kwargs)
10787
10788 class PyValidator(Validator):
10789 """Proxy of C++ PyValidator class"""
10790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10791 __repr__ = _swig_repr
10792 def __init__(self, *args, **kwargs):
10793 """__init__(self) -> PyValidator"""
10794 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10795 self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator)
10796
10797 def _setCallbackInfo(*args, **kwargs):
10798 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
10799 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10800
10801 _core_.PyValidator_swigregister(PyValidator)
10802
10803 #---------------------------------------------------------------------------
10804
10805 class Menu(EvtHandler):
10806 """Proxy of C++ Menu class"""
10807 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10808 __repr__ = _swig_repr
10809 def __init__(self, *args, **kwargs):
10810 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10811 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10812 self._setOORInfo(self)
10813
10814 def Append(*args, **kwargs):
10815 """
10816 Append(self, int id, String text=EmptyString, String help=EmptyString,
10817 int kind=ITEM_NORMAL) -> MenuItem
10818 """
10819 return _core_.Menu_Append(*args, **kwargs)
10820
10821 def AppendSeparator(*args, **kwargs):
10822 """AppendSeparator(self) -> MenuItem"""
10823 return _core_.Menu_AppendSeparator(*args, **kwargs)
10824
10825 def AppendCheckItem(*args, **kwargs):
10826 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10827 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10828
10829 def AppendRadioItem(*args, **kwargs):
10830 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10831 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10832
10833 def AppendMenu(*args, **kwargs):
10834 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10835 return _core_.Menu_AppendMenu(*args, **kwargs)
10836
10837 def AppendSubMenu(*args, **kwargs):
10838 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10839 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10840
10841 def AppendItem(*args, **kwargs):
10842 """AppendItem(self, MenuItem item) -> MenuItem"""
10843 return _core_.Menu_AppendItem(*args, **kwargs)
10844
10845 def InsertItem(*args, **kwargs):
10846 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10847 return _core_.Menu_InsertItem(*args, **kwargs)
10848
10849 def PrependItem(*args, **kwargs):
10850 """PrependItem(self, MenuItem item) -> MenuItem"""
10851 return _core_.Menu_PrependItem(*args, **kwargs)
10852
10853 def Break(*args, **kwargs):
10854 """Break(self)"""
10855 return _core_.Menu_Break(*args, **kwargs)
10856
10857 def Insert(*args, **kwargs):
10858 """
10859 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10860 int kind=ITEM_NORMAL) -> MenuItem
10861 """
10862 return _core_.Menu_Insert(*args, **kwargs)
10863
10864 def InsertSeparator(*args, **kwargs):
10865 """InsertSeparator(self, size_t pos) -> MenuItem"""
10866 return _core_.Menu_InsertSeparator(*args, **kwargs)
10867
10868 def InsertCheckItem(*args, **kwargs):
10869 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10870 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10871
10872 def InsertRadioItem(*args, **kwargs):
10873 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10874 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10875
10876 def InsertMenu(*args, **kwargs):
10877 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10878 return _core_.Menu_InsertMenu(*args, **kwargs)
10879
10880 def Prepend(*args, **kwargs):
10881 """
10882 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10883 int kind=ITEM_NORMAL) -> MenuItem
10884 """
10885 return _core_.Menu_Prepend(*args, **kwargs)
10886
10887 def PrependSeparator(*args, **kwargs):
10888 """PrependSeparator(self) -> MenuItem"""
10889 return _core_.Menu_PrependSeparator(*args, **kwargs)
10890
10891 def PrependCheckItem(*args, **kwargs):
10892 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10893 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10894
10895 def PrependRadioItem(*args, **kwargs):
10896 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10897 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10898
10899 def PrependMenu(*args, **kwargs):
10900 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10901 return _core_.Menu_PrependMenu(*args, **kwargs)
10902
10903 def Remove(*args, **kwargs):
10904 """Remove(self, int id) -> MenuItem"""
10905 return _core_.Menu_Remove(*args, **kwargs)
10906
10907 def RemoveItem(self, item):
10908 """RemoveItem(self, MenuItem item) -> MenuItem"""
10909 #// The return object is always the parameter, so return that
10910 #// proxy instead of the new one
10911 val = _core_.Menu_RemoveItem(self, item)
10912 item.this.own(val.this.own())
10913 val.this.disown()
10914 return item
10915
10916
10917 def Delete(*args, **kwargs):
10918 """Delete(self, int id) -> bool"""
10919 return _core_.Menu_Delete(*args, **kwargs)
10920
10921 def DeleteItem(*args, **kwargs):
10922 """DeleteItem(self, MenuItem item) -> bool"""
10923 return _core_.Menu_DeleteItem(*args, **kwargs)
10924
10925 def Destroy(*args, **kwargs):
10926 """
10927 Destroy(self)
10928
10929 Deletes the C++ object this Python object is a proxy for.
10930 """
10931 args[0].this.own(False)
10932 return _core_.Menu_Destroy(*args, **kwargs)
10933
10934 def DestroyId(*args, **kwargs):
10935 """DestroyId(self, int id) -> bool"""
10936 return _core_.Menu_DestroyId(*args, **kwargs)
10937
10938 def DestroyItem(*args, **kwargs):
10939 """DestroyItem(self, MenuItem item) -> bool"""
10940 return _core_.Menu_DestroyItem(*args, **kwargs)
10941
10942 def GetMenuItemCount(*args, **kwargs):
10943 """GetMenuItemCount(self) -> size_t"""
10944 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10945
10946 def GetMenuItems(*args, **kwargs):
10947 """GetMenuItems(self) -> PyObject"""
10948 return _core_.Menu_GetMenuItems(*args, **kwargs)
10949
10950 def FindItem(*args, **kwargs):
10951 """FindItem(self, String item) -> int"""
10952 return _core_.Menu_FindItem(*args, **kwargs)
10953
10954 def FindItemById(*args, **kwargs):
10955 """FindItemById(self, int id) -> MenuItem"""
10956 return _core_.Menu_FindItemById(*args, **kwargs)
10957
10958 def FindItemByPosition(*args, **kwargs):
10959 """FindItemByPosition(self, size_t position) -> MenuItem"""
10960 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10961
10962 def Enable(*args, **kwargs):
10963 """Enable(self, int id, bool enable)"""
10964 return _core_.Menu_Enable(*args, **kwargs)
10965
10966 def IsEnabled(*args, **kwargs):
10967 """IsEnabled(self, int id) -> bool"""
10968 return _core_.Menu_IsEnabled(*args, **kwargs)
10969
10970 def Check(*args, **kwargs):
10971 """Check(self, int id, bool check)"""
10972 return _core_.Menu_Check(*args, **kwargs)
10973
10974 def IsChecked(*args, **kwargs):
10975 """IsChecked(self, int id) -> bool"""
10976 return _core_.Menu_IsChecked(*args, **kwargs)
10977
10978 def SetLabel(*args, **kwargs):
10979 """SetLabel(self, int id, String label)"""
10980 return _core_.Menu_SetLabel(*args, **kwargs)
10981
10982 def GetLabel(*args, **kwargs):
10983 """GetLabel(self, int id) -> String"""
10984 return _core_.Menu_GetLabel(*args, **kwargs)
10985
10986 def SetHelpString(*args, **kwargs):
10987 """SetHelpString(self, int id, String helpString)"""
10988 return _core_.Menu_SetHelpString(*args, **kwargs)
10989
10990 def GetHelpString(*args, **kwargs):
10991 """GetHelpString(self, int id) -> String"""
10992 return _core_.Menu_GetHelpString(*args, **kwargs)
10993
10994 def SetTitle(*args, **kwargs):
10995 """SetTitle(self, String title)"""
10996 return _core_.Menu_SetTitle(*args, **kwargs)
10997
10998 def GetTitle(*args, **kwargs):
10999 """GetTitle(self) -> String"""
11000 return _core_.Menu_GetTitle(*args, **kwargs)
11001
11002 def SetEventHandler(*args, **kwargs):
11003 """SetEventHandler(self, EvtHandler handler)"""
11004 return _core_.Menu_SetEventHandler(*args, **kwargs)
11005
11006 def GetEventHandler(*args, **kwargs):
11007 """GetEventHandler(self) -> EvtHandler"""
11008 return _core_.Menu_GetEventHandler(*args, **kwargs)
11009
11010 def SetInvokingWindow(*args, **kwargs):
11011 """SetInvokingWindow(self, Window win)"""
11012 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
11013
11014 def GetInvokingWindow(*args, **kwargs):
11015 """GetInvokingWindow(self) -> Window"""
11016 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
11017
11018 def GetStyle(*args, **kwargs):
11019 """GetStyle(self) -> long"""
11020 return _core_.Menu_GetStyle(*args, **kwargs)
11021
11022 def UpdateUI(*args, **kwargs):
11023 """UpdateUI(self, EvtHandler source=None)"""
11024 return _core_.Menu_UpdateUI(*args, **kwargs)
11025
11026 def GetMenuBar(*args, **kwargs):
11027 """GetMenuBar(self) -> MenuBar"""
11028 return _core_.Menu_GetMenuBar(*args, **kwargs)
11029
11030 def Attach(*args, **kwargs):
11031 """Attach(self, wxMenuBarBase menubar)"""
11032 return _core_.Menu_Attach(*args, **kwargs)
11033
11034 def Detach(*args, **kwargs):
11035 """Detach(self)"""
11036 return _core_.Menu_Detach(*args, **kwargs)
11037
11038 def IsAttached(*args, **kwargs):
11039 """IsAttached(self) -> bool"""
11040 return _core_.Menu_IsAttached(*args, **kwargs)
11041
11042 def SetParent(*args, **kwargs):
11043 """SetParent(self, Menu parent)"""
11044 return _core_.Menu_SetParent(*args, **kwargs)
11045
11046 def GetParent(*args, **kwargs):
11047 """GetParent(self) -> Menu"""
11048 return _core_.Menu_GetParent(*args, **kwargs)
11049
11050 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
11051 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
11052 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
11053 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
11054 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
11055 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
11056 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
11057 Style = property(GetStyle,doc="See `GetStyle`")
11058 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
11059 _core_.Menu_swigregister(Menu)
11060 DefaultValidator = cvar.DefaultValidator
11061
11062 #---------------------------------------------------------------------------
11063
11064 class MenuBar(Window):
11065 """Proxy of C++ MenuBar class"""
11066 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11067 __repr__ = _swig_repr
11068 def __init__(self, *args, **kwargs):
11069 """__init__(self, long style=0) -> MenuBar"""
11070 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
11071 self._setOORInfo(self)
11072
11073 def Append(*args, **kwargs):
11074 """Append(self, Menu menu, String title) -> bool"""
11075 return _core_.MenuBar_Append(*args, **kwargs)
11076
11077 def Insert(*args, **kwargs):
11078 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
11079 return _core_.MenuBar_Insert(*args, **kwargs)
11080
11081 def GetMenuCount(*args, **kwargs):
11082 """GetMenuCount(self) -> size_t"""
11083 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
11084
11085 def GetMenu(*args, **kwargs):
11086 """GetMenu(self, size_t pos) -> Menu"""
11087 return _core_.MenuBar_GetMenu(*args, **kwargs)
11088
11089 def Replace(*args, **kwargs):
11090 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
11091 return _core_.MenuBar_Replace(*args, **kwargs)
11092
11093 def Remove(*args, **kwargs):
11094 """Remove(self, size_t pos) -> Menu"""
11095 return _core_.MenuBar_Remove(*args, **kwargs)
11096
11097 def EnableTop(*args, **kwargs):
11098 """EnableTop(self, size_t pos, bool enable)"""
11099 return _core_.MenuBar_EnableTop(*args, **kwargs)
11100
11101 def IsEnabledTop(*args, **kwargs):
11102 """IsEnabledTop(self, size_t pos) -> bool"""
11103 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
11104
11105 def SetLabelTop(*args, **kwargs):
11106 """SetLabelTop(self, size_t pos, String label)"""
11107 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
11108
11109 def GetLabelTop(*args, **kwargs):
11110 """GetLabelTop(self, size_t pos) -> String"""
11111 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
11112
11113 def FindMenuItem(*args, **kwargs):
11114 """FindMenuItem(self, String menu, String item) -> int"""
11115 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
11116
11117 def FindItemById(*args, **kwargs):
11118 """FindItemById(self, int id) -> MenuItem"""
11119 return _core_.MenuBar_FindItemById(*args, **kwargs)
11120
11121 def FindMenu(*args, **kwargs):
11122 """FindMenu(self, String title) -> int"""
11123 return _core_.MenuBar_FindMenu(*args, **kwargs)
11124
11125 def Enable(*args, **kwargs):
11126 """Enable(self, int id, bool enable)"""
11127 return _core_.MenuBar_Enable(*args, **kwargs)
11128
11129 def Check(*args, **kwargs):
11130 """Check(self, int id, bool check)"""
11131 return _core_.MenuBar_Check(*args, **kwargs)
11132
11133 def IsChecked(*args, **kwargs):
11134 """IsChecked(self, int id) -> bool"""
11135 return _core_.MenuBar_IsChecked(*args, **kwargs)
11136
11137 def IsEnabled(*args, **kwargs):
11138 """IsEnabled(self, int id) -> bool"""
11139 return _core_.MenuBar_IsEnabled(*args, **kwargs)
11140
11141 def SetLabel(*args, **kwargs):
11142 """SetLabel(self, int id, String label)"""
11143 return _core_.MenuBar_SetLabel(*args, **kwargs)
11144
11145 def GetLabel(*args, **kwargs):
11146 """GetLabel(self, int id) -> String"""
11147 return _core_.MenuBar_GetLabel(*args, **kwargs)
11148
11149 def SetHelpString(*args, **kwargs):
11150 """SetHelpString(self, int id, String helpString)"""
11151 return _core_.MenuBar_SetHelpString(*args, **kwargs)
11152
11153 def GetHelpString(*args, **kwargs):
11154 """GetHelpString(self, int id) -> String"""
11155 return _core_.MenuBar_GetHelpString(*args, **kwargs)
11156
11157 def GetFrame(*args, **kwargs):
11158 """GetFrame(self) -> wxFrame"""
11159 return _core_.MenuBar_GetFrame(*args, **kwargs)
11160
11161 def IsAttached(*args, **kwargs):
11162 """IsAttached(self) -> bool"""
11163 return _core_.MenuBar_IsAttached(*args, **kwargs)
11164
11165 def Attach(*args, **kwargs):
11166 """Attach(self, wxFrame frame)"""
11167 return _core_.MenuBar_Attach(*args, **kwargs)
11168
11169 def Detach(*args, **kwargs):
11170 """Detach(self)"""
11171 return _core_.MenuBar_Detach(*args, **kwargs)
11172
11173 def UpdateMenus(*args, **kwargs):
11174 """UpdateMenus(self)"""
11175 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
11176
11177 def SetAutoWindowMenu(*args, **kwargs):
11178 """SetAutoWindowMenu(bool enable)"""
11179 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11180
11181 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
11182 def GetAutoWindowMenu(*args, **kwargs):
11183 """GetAutoWindowMenu() -> bool"""
11184 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
11185
11186 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
11187 def GetMenus(self):
11188 """Return a list of (menu, label) items for the menus in the MenuBar. """
11189 return [(self.GetMenu(i), self.GetLabelTop(i))
11190 for i in range(self.GetMenuCount())]
11191
11192 def SetMenus(self, items):
11193 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11194 for i in range(self.GetMenuCount()-1, -1, -1):
11195 self.Remove(i)
11196 for m, l in items:
11197 self.Append(m, l)
11198
11199 Frame = property(GetFrame,doc="See `GetFrame`")
11200 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11201 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
11202 _core_.MenuBar_swigregister(MenuBar)
11203
11204 def MenuBar_SetAutoWindowMenu(*args, **kwargs):
11205 """MenuBar_SetAutoWindowMenu(bool enable)"""
11206 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11207
11208 def MenuBar_GetAutoWindowMenu(*args):
11209 """MenuBar_GetAutoWindowMenu() -> bool"""
11210 return _core_.MenuBar_GetAutoWindowMenu(*args)
11211
11212 #---------------------------------------------------------------------------
11213
11214 class MenuItem(Object):
11215 """Proxy of C++ MenuItem class"""
11216 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11217 __repr__ = _swig_repr
11218 def __init__(self, *args, **kwargs):
11219 """
11220 __init__(self, Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString,
11221 String help=EmptyString, int kind=ITEM_NORMAL,
11222 Menu subMenu=None) -> MenuItem
11223 """
11224 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11225 __swig_destroy__ = _core_.delete_MenuItem
11226 __del__ = lambda self : None;
11227 def Destroy(self): pass
11228 def GetMenu(*args, **kwargs):
11229 """GetMenu(self) -> Menu"""
11230 return _core_.MenuItem_GetMenu(*args, **kwargs)
11231
11232 def SetMenu(*args, **kwargs):
11233 """SetMenu(self, Menu menu)"""
11234 return _core_.MenuItem_SetMenu(*args, **kwargs)
11235
11236 def SetId(*args, **kwargs):
11237 """SetId(self, int id)"""
11238 return _core_.MenuItem_SetId(*args, **kwargs)
11239
11240 def GetId(*args, **kwargs):
11241 """GetId(self) -> int"""
11242 return _core_.MenuItem_GetId(*args, **kwargs)
11243
11244 def IsSeparator(*args, **kwargs):
11245 """IsSeparator(self) -> bool"""
11246 return _core_.MenuItem_IsSeparator(*args, **kwargs)
11247
11248 def SetText(*args, **kwargs):
11249 """SetText(self, String str)"""
11250 return _core_.MenuItem_SetText(*args, **kwargs)
11251
11252 def GetLabel(*args, **kwargs):
11253 """GetLabel(self) -> String"""
11254 return _core_.MenuItem_GetLabel(*args, **kwargs)
11255
11256 def GetText(*args, **kwargs):
11257 """GetText(self) -> String"""
11258 return _core_.MenuItem_GetText(*args, **kwargs)
11259
11260 def GetLabelFromText(*args, **kwargs):
11261 """GetLabelFromText(String text) -> String"""
11262 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11263
11264 GetLabelFromText = staticmethod(GetLabelFromText)
11265 def GetKind(*args, **kwargs):
11266 """GetKind(self) -> int"""
11267 return _core_.MenuItem_GetKind(*args, **kwargs)
11268
11269 def SetKind(*args, **kwargs):
11270 """SetKind(self, int kind)"""
11271 return _core_.MenuItem_SetKind(*args, **kwargs)
11272
11273 def SetCheckable(*args, **kwargs):
11274 """SetCheckable(self, bool checkable)"""
11275 return _core_.MenuItem_SetCheckable(*args, **kwargs)
11276
11277 def IsCheckable(*args, **kwargs):
11278 """IsCheckable(self) -> bool"""
11279 return _core_.MenuItem_IsCheckable(*args, **kwargs)
11280
11281 def IsSubMenu(*args, **kwargs):
11282 """IsSubMenu(self) -> bool"""
11283 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
11284
11285 def SetSubMenu(*args, **kwargs):
11286 """SetSubMenu(self, Menu menu)"""
11287 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
11288
11289 def GetSubMenu(*args, **kwargs):
11290 """GetSubMenu(self) -> Menu"""
11291 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
11292
11293 def Enable(*args, **kwargs):
11294 """Enable(self, bool enable=True)"""
11295 return _core_.MenuItem_Enable(*args, **kwargs)
11296
11297 def IsEnabled(*args, **kwargs):
11298 """IsEnabled(self) -> bool"""
11299 return _core_.MenuItem_IsEnabled(*args, **kwargs)
11300
11301 def Check(*args, **kwargs):
11302 """Check(self, bool check=True)"""
11303 return _core_.MenuItem_Check(*args, **kwargs)
11304
11305 def IsChecked(*args, **kwargs):
11306 """IsChecked(self) -> bool"""
11307 return _core_.MenuItem_IsChecked(*args, **kwargs)
11308
11309 def Toggle(*args, **kwargs):
11310 """Toggle(self)"""
11311 return _core_.MenuItem_Toggle(*args, **kwargs)
11312
11313 def SetHelp(*args, **kwargs):
11314 """SetHelp(self, String str)"""
11315 return _core_.MenuItem_SetHelp(*args, **kwargs)
11316
11317 def GetHelp(*args, **kwargs):
11318 """GetHelp(self) -> String"""
11319 return _core_.MenuItem_GetHelp(*args, **kwargs)
11320
11321 def GetAccel(*args, **kwargs):
11322 """GetAccel(self) -> AcceleratorEntry"""
11323 return _core_.MenuItem_GetAccel(*args, **kwargs)
11324
11325 def SetAccel(*args, **kwargs):
11326 """SetAccel(self, AcceleratorEntry accel)"""
11327 return _core_.MenuItem_SetAccel(*args, **kwargs)
11328
11329 def SetBitmap(*args, **kwargs):
11330 """SetBitmap(self, Bitmap bitmap)"""
11331 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11332
11333 def GetBitmap(*args, **kwargs):
11334 """GetBitmap(self) -> Bitmap"""
11335 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11336
11337 def SetFont(*args, **kwargs):
11338 """SetFont(self, Font font)"""
11339 return _core_.MenuItem_SetFont(*args, **kwargs)
11340
11341 def GetFont(*args, **kwargs):
11342 """GetFont(self) -> Font"""
11343 return _core_.MenuItem_GetFont(*args, **kwargs)
11344
11345 def SetTextColour(*args, **kwargs):
11346 """SetTextColour(self, Colour colText)"""
11347 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11348
11349 def GetTextColour(*args, **kwargs):
11350 """GetTextColour(self) -> Colour"""
11351 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11352
11353 def SetBackgroundColour(*args, **kwargs):
11354 """SetBackgroundColour(self, Colour colBack)"""
11355 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11356
11357 def GetBackgroundColour(*args, **kwargs):
11358 """GetBackgroundColour(self) -> Colour"""
11359 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11360
11361 def SetBitmaps(*args, **kwargs):
11362 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11363 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11364
11365 def SetDisabledBitmap(*args, **kwargs):
11366 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11367 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11368
11369 def GetDisabledBitmap(*args, **kwargs):
11370 """GetDisabledBitmap(self) -> Bitmap"""
11371 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11372
11373 def SetMarginWidth(*args, **kwargs):
11374 """SetMarginWidth(self, int nWidth)"""
11375 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11376
11377 def GetMarginWidth(*args, **kwargs):
11378 """GetMarginWidth(self) -> int"""
11379 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11380
11381 def GetDefaultMarginWidth(*args, **kwargs):
11382 """GetDefaultMarginWidth() -> int"""
11383 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
11384
11385 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
11386 def IsOwnerDrawn(*args, **kwargs):
11387 """IsOwnerDrawn(self) -> bool"""
11388 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11389
11390 def SetOwnerDrawn(*args, **kwargs):
11391 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11392 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11393
11394 def ResetOwnerDrawn(*args, **kwargs):
11395 """ResetOwnerDrawn(self)"""
11396 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11397
11398 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11399 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11400 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11401 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11402 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11403 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11404 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11405 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11406 Label = property(GetLabel,doc="See `GetLabel`")
11407 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11408 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11409 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11410 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11411 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
11412 _core_.MenuItem_swigregister(MenuItem)
11413
11414 def MenuItem_GetLabelFromText(*args, **kwargs):
11415 """MenuItem_GetLabelFromText(String text) -> String"""
11416 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11417
11418 def MenuItem_GetDefaultMarginWidth(*args):
11419 """MenuItem_GetDefaultMarginWidth() -> int"""
11420 return _core_.MenuItem_GetDefaultMarginWidth(*args)
11421
11422 #---------------------------------------------------------------------------
11423
11424 class Control(Window):
11425 """
11426 This is the base class for a control or 'widget'.
11427
11428 A control is generally a small window which processes user input
11429 and/or displays one or more item of data.
11430 """
11431 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11432 __repr__ = _swig_repr
11433 def __init__(self, *args, **kwargs):
11434 """
11435 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11436 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11437 String name=ControlNameStr) -> Control
11438
11439 Create a Control. Normally you should only call this from a subclass'
11440 __init__ as a plain old wx.Control is not very useful.
11441 """
11442 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
11443 self._setOORInfo(self)
11444
11445 def Create(*args, **kwargs):
11446 """
11447 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11448 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11449 String name=ControlNameStr) -> bool
11450
11451 Do the 2nd phase and create the GUI control.
11452 """
11453 return _core_.Control_Create(*args, **kwargs)
11454
11455 def GetAlignment(*args, **kwargs):
11456 """
11457 GetAlignment(self) -> int
11458
11459 Get the control alignment (left/right/centre, top/bottom/centre)
11460 """
11461 return _core_.Control_GetAlignment(*args, **kwargs)
11462
11463 def GetLabelText(*args, **kwargs):
11464 """
11465 GetLabelText(self) -> String
11466
11467 Get just the text of the label, without mnemonic characters ('&')
11468 """
11469 return _core_.Control_GetLabelText(*args, **kwargs)
11470
11471 def Command(*args, **kwargs):
11472 """
11473 Command(self, CommandEvent event)
11474
11475 Simulates the effect of the user issuing a command to the item.
11476
11477 :see: `wx.CommandEvent`
11478
11479 """
11480 return _core_.Control_Command(*args, **kwargs)
11481
11482 def RemoveMnemonics(*args, **kwargs):
11483 """
11484 RemoveMnemonics(String str) -> String
11485
11486 removes the mnemonics characters
11487 """
11488 return _core_.Control_RemoveMnemonics(*args, **kwargs)
11489
11490 RemoveMnemonics = staticmethod(RemoveMnemonics)
11491 def GetClassDefaultAttributes(*args, **kwargs):
11492 """
11493 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11494
11495 Get the default attributes for this class. This is useful if you want
11496 to use the same font or colour in your own control as in a standard
11497 control -- which is a much better idea than hard coding specific
11498 colours or fonts which might look completely out of place on the
11499 user's system, especially if it uses themes.
11500
11501 The variant parameter is only relevant under Mac currently and is
11502 ignore under other platforms. Under Mac, it will change the size of
11503 the returned font. See `wx.Window.SetWindowVariant` for more about
11504 this.
11505 """
11506 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11507
11508 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11509 Alignment = property(GetAlignment,doc="See `GetAlignment`")
11510 LabelText = property(GetLabelText,doc="See `GetLabelText`")
11511 _core_.Control_swigregister(Control)
11512 ControlNameStr = cvar.ControlNameStr
11513
11514 def PreControl(*args, **kwargs):
11515 """
11516 PreControl() -> Control
11517
11518 Precreate a Control control for 2-phase creation
11519 """
11520 val = _core_.new_PreControl(*args, **kwargs)
11521 return val
11522
11523 def Control_RemoveMnemonics(*args, **kwargs):
11524 """
11525 Control_RemoveMnemonics(String str) -> String
11526
11527 removes the mnemonics characters
11528 """
11529 return _core_.Control_RemoveMnemonics(*args, **kwargs)
11530
11531 def Control_GetClassDefaultAttributes(*args, **kwargs):
11532 """
11533 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11534
11535 Get the default attributes for this class. This is useful if you want
11536 to use the same font or colour in your own control as in a standard
11537 control -- which is a much better idea than hard coding specific
11538 colours or fonts which might look completely out of place on the
11539 user's system, especially if it uses themes.
11540
11541 The variant parameter is only relevant under Mac currently and is
11542 ignore under other platforms. Under Mac, it will change the size of
11543 the returned font. See `wx.Window.SetWindowVariant` for more about
11544 this.
11545 """
11546 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11547
11548 #---------------------------------------------------------------------------
11549
11550 class ItemContainer(object):
11551 """
11552 The wx.ItemContainer class defines an interface which is implemented
11553 by all controls which have string subitems, each of which may be
11554 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11555 as `wx.ComboBox` which implements an extended interface deriving from
11556 this one.
11557
11558 It defines the methods for accessing the control's items and although
11559 each of the derived classes implements them differently, they still
11560 all conform to the same interface.
11561
11562 The items in a wx.ItemContainer have (non empty) string labels and,
11563 optionally, client data associated with them.
11564
11565 """
11566 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11567 def __init__(self): raise AttributeError, "No constructor defined"
11568 __repr__ = _swig_repr
11569 def Append(*args, **kwargs):
11570 """
11571 Append(self, String item, PyObject clientData=None) -> int
11572
11573 Adds the item to the control, associating the given data with the item
11574 if not None. The return value is the index of the newly added item
11575 which may be different from the last one if the control is sorted (e.g.
11576 has wx.LB_SORT or wx.CB_SORT style).
11577 """
11578 return _core_.ItemContainer_Append(*args, **kwargs)
11579
11580 def AppendItems(*args, **kwargs):
11581 """
11582 AppendItems(self, List strings)
11583
11584 Apend several items at once to the control. Notice that calling this
11585 method may be much faster than appending the items one by one if you
11586 need to add a lot of items.
11587 """
11588 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11589
11590 def Insert(*args, **kwargs):
11591 """
11592 Insert(self, String item, int pos, PyObject clientData=None) -> int
11593
11594 Insert an item into the control before the item at the ``pos`` index,
11595 optionally associating some data object with the item.
11596 """
11597 return _core_.ItemContainer_Insert(*args, **kwargs)
11598
11599 def Clear(*args, **kwargs):
11600 """
11601 Clear(self)
11602
11603 Removes all items from the control.
11604 """
11605 return _core_.ItemContainer_Clear(*args, **kwargs)
11606
11607 def Delete(*args, **kwargs):
11608 """
11609 Delete(self, int n)
11610
11611 Deletes the item at the zero-based index 'n' from the control. Note
11612 that it is an error (signalled by a `wx.PyAssertionError` exception if
11613 enabled) to remove an item with the index negative or greater or equal
11614 than the number of items in the control.
11615 """
11616 return _core_.ItemContainer_Delete(*args, **kwargs)
11617
11618 def GetClientData(*args, **kwargs):
11619 """
11620 GetClientData(self, int n) -> PyObject
11621
11622 Returns the client data associated with the given item, (if any.)
11623 """
11624 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11625
11626 def SetClientData(*args, **kwargs):
11627 """
11628 SetClientData(self, int n, PyObject clientData)
11629
11630 Associate the given client data with the item at position n.
11631 """
11632 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11633
11634 def GetCount(*args, **kwargs):
11635 """
11636 GetCount(self) -> int
11637
11638 Returns the number of items in the control.
11639 """
11640 return _core_.ItemContainer_GetCount(*args, **kwargs)
11641
11642 def IsEmpty(*args, **kwargs):
11643 """
11644 IsEmpty(self) -> bool
11645
11646 Returns True if the control is empty or False if it has some items.
11647 """
11648 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11649
11650 def GetString(*args, **kwargs):
11651 """
11652 GetString(self, int n) -> String
11653
11654 Returns the label of the item with the given index.
11655 """
11656 return _core_.ItemContainer_GetString(*args, **kwargs)
11657
11658 def GetStrings(*args, **kwargs):
11659 """GetStrings(self) -> wxArrayString"""
11660 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11661
11662 def SetString(*args, **kwargs):
11663 """
11664 SetString(self, int n, String s)
11665
11666 Sets the label for the given item.
11667 """
11668 return _core_.ItemContainer_SetString(*args, **kwargs)
11669
11670 def FindString(*args, **kwargs):
11671 """
11672 FindString(self, String s) -> int
11673
11674 Finds an item whose label matches the given string. Returns the
11675 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11676 found.
11677 """
11678 return _core_.ItemContainer_FindString(*args, **kwargs)
11679
11680 def SetSelection(*args, **kwargs):
11681 """
11682 SetSelection(self, int n)
11683
11684 Sets the item at index 'n' to be the selected item.
11685 """
11686 return _core_.ItemContainer_SetSelection(*args, **kwargs)
11687
11688 def GetSelection(*args, **kwargs):
11689 """
11690 GetSelection(self) -> int
11691
11692 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11693 is selected.
11694 """
11695 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11696
11697 def SetStringSelection(*args, **kwargs):
11698 """SetStringSelection(self, String s) -> bool"""
11699 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11700
11701 def GetStringSelection(*args, **kwargs):
11702 """
11703 GetStringSelection(self) -> String
11704
11705 Returns the label of the selected item or an empty string if no item
11706 is selected.
11707 """
11708 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11709
11710 def Select(*args, **kwargs):
11711 """
11712 Select(self, int n)
11713
11714 This is the same as `SetSelection` and exists only because it is
11715 slightly more natural for controls which support multiple selection.
11716 """
11717 return _core_.ItemContainer_Select(*args, **kwargs)
11718
11719 def GetItems(self):
11720 """Return a list of the strings in the control"""
11721 return [self.GetString(i) for i in xrange(self.GetCount())]
11722
11723 def SetItems(self, items):
11724 """Clear and set the strings in the control from a list"""
11725 self.Clear()
11726 for i in items:
11727 self.Append(i)
11728
11729 Count = property(GetCount,doc="See `GetCount`")
11730 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11731 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11732 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11733 Strings = property(GetStrings,doc="See `GetStrings`")
11734 _core_.ItemContainer_swigregister(ItemContainer)
11735
11736 #---------------------------------------------------------------------------
11737
11738 class ControlWithItems(Control,ItemContainer):
11739 """
11740 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11741 wx.Control class, and is used for the base class of various controls
11742 that have items.
11743 """
11744 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11745 def __init__(self): raise AttributeError, "No constructor defined"
11746 __repr__ = _swig_repr
11747 _core_.ControlWithItems_swigregister(ControlWithItems)
11748
11749 #---------------------------------------------------------------------------
11750
11751 class SizerFlags(object):
11752 """
11753 Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
11754 to specify a lot of flags and parameters which can be unwieldy. This
11755 is where wx.SizerFlags comes in: it allows you to specify all
11756 parameters using the named methods instead. For example, instead of::
11757
11758 sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
11759
11760 you can now write::
11761
11762 sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(wx.ALL, 10))
11763
11764 This is more readable and also allows you to create wx.SizerFlags
11765 objects which can be reused for several sizer items.::
11766
11767 flagsExpand = wx.SizerFlags(1)
11768 flagsExpand.Expand().Border(wx.ALL, 10)
11769 sizer.AddF(ctrl1, flagsExpand)
11770 sizer.AddF(ctrl2, flagsExpand)
11771
11772 Note that by specification, all methods of wx.SizerFlags return the
11773 wx.SizerFlags object itself allowing chaining multiple method calls
11774 like in the examples above.
11775 """
11776 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11777 __repr__ = _swig_repr
11778 def __init__(self, *args, **kwargs):
11779 """
11780 __init__(self, int proportion=0) -> SizerFlags
11781
11782 Constructs the flags object with the specified proportion.
11783 """
11784 _core_.SizerFlags_swiginit(self,_core_.new_SizerFlags(*args, **kwargs))
11785 __swig_destroy__ = _core_.delete_SizerFlags
11786 __del__ = lambda self : None;
11787 def Proportion(*args, **kwargs):
11788 """
11789 Proportion(self, int proportion) -> SizerFlags
11790
11791 Sets the item's proportion value.
11792 """
11793 return _core_.SizerFlags_Proportion(*args, **kwargs)
11794
11795 def Align(*args, **kwargs):
11796 """
11797 Align(self, int alignment) -> SizerFlags
11798
11799 Sets the item's alignment
11800 """
11801 return _core_.SizerFlags_Align(*args, **kwargs)
11802
11803 def Expand(*args, **kwargs):
11804 """
11805 Expand(self) -> SizerFlags
11806
11807 Sets the wx.EXPAND flag, which will cause the item to be expanded to
11808 fill as much space as it is given by the sizer.
11809 """
11810 return _core_.SizerFlags_Expand(*args, **kwargs)
11811
11812 def Centre(*args, **kwargs):
11813 """
11814 Centre(self) -> SizerFlags
11815
11816 Same as `Center` for those with an alternate dialect of English.
11817 """
11818 return _core_.SizerFlags_Centre(*args, **kwargs)
11819
11820 def Center(*args, **kwargs):
11821 """
11822 Center(self) -> SizerFlags
11823
11824 Sets the centering alignment flags.
11825 """
11826 return _core_.SizerFlags_Center(*args, **kwargs)
11827
11828 def Left(*args, **kwargs):
11829 """
11830 Left(self) -> SizerFlags
11831
11832 Aligns the object to the left, a shortcut for calling
11833 Align(wx.ALIGN_LEFT)
11834 """
11835 return _core_.SizerFlags_Left(*args, **kwargs)
11836
11837 def Right(*args, **kwargs):
11838 """
11839 Right(self) -> SizerFlags
11840
11841 Aligns the object to the right, a shortcut for calling
11842 Align(wx.ALIGN_RIGHT)
11843 """
11844 return _core_.SizerFlags_Right(*args, **kwargs)
11845
11846 def Top(*args, **kwargs):
11847 """
11848 Top(self) -> SizerFlags
11849
11850 Aligns the object to the top of the available space, a shortcut for
11851 calling Align(wx.ALIGN_TOP)
11852 """
11853 return _core_.SizerFlags_Top(*args, **kwargs)
11854
11855 def Bottom(*args, **kwargs):
11856 """
11857 Bottom(self) -> SizerFlags
11858
11859 Aligns the object to the bottom of the available space, a shortcut for
11860 calling Align(wx.ALIGN_BOTTOM)
11861 """
11862 return _core_.SizerFlags_Bottom(*args, **kwargs)
11863
11864 def Shaped(*args, **kwargs):
11865 """
11866 Shaped(self) -> SizerFlags
11867
11868 Sets the wx.SHAPED flag.
11869 """
11870 return _core_.SizerFlags_Shaped(*args, **kwargs)
11871
11872 def FixedMinSize(*args, **kwargs):
11873 """
11874 FixedMinSize(self) -> SizerFlags
11875
11876 Sets the wx.FIXED_MINSIZE flag.
11877 """
11878 return _core_.SizerFlags_FixedMinSize(*args, **kwargs)
11879
11880 def Border(*args, **kwargs):
11881 """
11882 Border(self, int direction=ALL, int borderInPixels=-1) -> SizerFlags
11883
11884 Sets the border of the item in the direction(s) or sides given by the
11885 direction parameter. If the borderInPixels value is not given then
11886 the default border size (see `GetDefaultBorder`) will be used.
11887 """
11888 return _core_.SizerFlags_Border(*args, **kwargs)
11889
11890 def DoubleBorder(*args, **kwargs):
11891 """
11892 DoubleBorder(self, int direction=ALL) -> SizerFlags
11893
11894 Sets the border in the given direction to twice the default border
11895 size.
11896 """
11897 return _core_.SizerFlags_DoubleBorder(*args, **kwargs)
11898
11899 def TripleBorder(*args, **kwargs):
11900 """
11901 TripleBorder(self, int direction=ALL) -> SizerFlags
11902
11903 Sets the border in the given direction to three times the default
11904 border size.
11905 """
11906 return _core_.SizerFlags_TripleBorder(*args, **kwargs)
11907
11908 def HorzBorder(*args, **kwargs):
11909 """
11910 HorzBorder(self) -> SizerFlags
11911
11912 Sets the left and right borders to the default border size.
11913 """
11914 return _core_.SizerFlags_HorzBorder(*args, **kwargs)
11915
11916 def DoubleHorzBorder(*args, **kwargs):
11917 """
11918 DoubleHorzBorder(self) -> SizerFlags
11919
11920 Sets the left and right borders to twice the default border size.
11921 """
11922 return _core_.SizerFlags_DoubleHorzBorder(*args, **kwargs)
11923
11924 def GetDefaultBorder(*args, **kwargs):
11925 """
11926 GetDefaultBorder() -> int
11927
11928 Returns the default border size used by the other border methods
11929 """
11930 return _core_.SizerFlags_GetDefaultBorder(*args, **kwargs)
11931
11932 GetDefaultBorder = staticmethod(GetDefaultBorder)
11933 def GetProportion(*args, **kwargs):
11934 """
11935 GetProportion(self) -> int
11936
11937 Returns the proportion value to be used in the sizer item.
11938 """
11939 return _core_.SizerFlags_GetProportion(*args, **kwargs)
11940
11941 def GetFlags(*args, **kwargs):
11942 """
11943 GetFlags(self) -> int
11944
11945 Returns the flags value to be used in the sizer item.
11946 """
11947 return _core_.SizerFlags_GetFlags(*args, **kwargs)
11948
11949 def GetBorderInPixels(*args, **kwargs):
11950 """
11951 GetBorderInPixels(self) -> int
11952
11953 Returns the border value in pixels to be used in the sizer item.
11954 """
11955 return _core_.SizerFlags_GetBorderInPixels(*args, **kwargs)
11956
11957 _core_.SizerFlags_swigregister(SizerFlags)
11958
11959 def SizerFlags_GetDefaultBorder(*args):
11960 """
11961 SizerFlags_GetDefaultBorder() -> int
11962
11963 Returns the default border size used by the other border methods
11964 """
11965 return _core_.SizerFlags_GetDefaultBorder(*args)
11966
11967 class SizerItem(Object):
11968 """
11969 The wx.SizerItem class is used to track the position, size and other
11970 attributes of each item managed by a `wx.Sizer`. It is not usually
11971 necessary to use this class because the sizer elements can also be
11972 identified by their positions or window or sizer references but
11973 sometimes it may be more convenient to use wx.SizerItem directly.
11974 Also, custom classes derived from `wx.PySizer` will probably need to
11975 use the collection of wx.SizerItems held by wx.Sizer when calculating
11976 layout.
11977
11978 :see: `wx.Sizer`, `wx.GBSizerItem`
11979 """
11980 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11981 __repr__ = _swig_repr
11982 def __init__(self, *args, **kwargs):
11983 """
11984 __init__(self) -> SizerItem
11985
11986 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11987 size will need to be set before this item can be used in a Sizer.
11988
11989 You will probably never need to create a wx.SizerItem directly as they
11990 are created automatically when the sizer's Add, Insert or Prepend
11991 methods are called.
11992
11993 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11994 """
11995 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11996 __swig_destroy__ = _core_.delete_SizerItem
11997 __del__ = lambda self : None;
11998 def DeleteWindows(*args, **kwargs):
11999 """
12000 DeleteWindows(self)
12001
12002 Destroy the window or the windows in a subsizer, depending on the type
12003 of item.
12004 """
12005 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
12006
12007 def DetachSizer(*args, **kwargs):
12008 """
12009 DetachSizer(self)
12010
12011 Enable deleting the SizerItem without destroying the contained sizer.
12012 """
12013 return _core_.SizerItem_DetachSizer(*args, **kwargs)
12014
12015 def GetSize(*args, **kwargs):
12016 """
12017 GetSize(self) -> Size
12018
12019 Get the current size of the item, as set in the last Layout.
12020 """
12021 return _core_.SizerItem_GetSize(*args, **kwargs)
12022
12023 def CalcMin(*args, **kwargs):
12024 """
12025 CalcMin(self) -> Size
12026
12027 Calculates the minimum desired size for the item, including any space
12028 needed by borders.
12029 """
12030 return _core_.SizerItem_CalcMin(*args, **kwargs)
12031
12032 def SetDimension(*args, **kwargs):
12033 """
12034 SetDimension(self, Point pos, Size size)
12035
12036 Set the position and size of the space allocated for this item by the
12037 sizer, and adjust the position and size of the item (window or
12038 subsizer) to be within that space taking alignment and borders into
12039 account.
12040 """
12041 return _core_.SizerItem_SetDimension(*args, **kwargs)
12042
12043 def GetMinSize(*args, **kwargs):
12044 """
12045 GetMinSize(self) -> Size
12046
12047 Get the minimum size needed for the item.
12048 """
12049 return _core_.SizerItem_GetMinSize(*args, **kwargs)
12050
12051 def GetMinSizeWithBorder(*args, **kwargs):
12052 """
12053 GetMinSizeWithBorder(self) -> Size
12054
12055 Get the minimum size needed for the item with space for the borders
12056 added, if needed.
12057 """
12058 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
12059
12060 def SetInitSize(*args, **kwargs):
12061 """SetInitSize(self, int x, int y)"""
12062 return _core_.SizerItem_SetInitSize(*args, **kwargs)
12063
12064 def SetRatioWH(*args, **kwargs):
12065 """
12066 SetRatioWH(self, int width, int height)
12067
12068 Set the ratio item attribute.
12069 """
12070 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
12071
12072 def SetRatioSize(*args, **kwargs):
12073 """
12074 SetRatioSize(self, Size size)
12075
12076 Set the ratio item attribute.
12077 """
12078 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
12079
12080 def SetRatio(*args, **kwargs):
12081 """
12082 SetRatio(self, float ratio)
12083
12084 Set the ratio item attribute.
12085 """
12086 return _core_.SizerItem_SetRatio(*args, **kwargs)
12087
12088 def GetRatio(*args, **kwargs):
12089 """
12090 GetRatio(self) -> float
12091
12092 Set the ratio item attribute.
12093 """
12094 return _core_.SizerItem_GetRatio(*args, **kwargs)
12095
12096 def GetRect(*args, **kwargs):
12097 """
12098 GetRect(self) -> Rect
12099
12100 Returns the rectangle that the sizer item should occupy
12101 """
12102 return _core_.SizerItem_GetRect(*args, **kwargs)
12103
12104 def IsWindow(*args, **kwargs):
12105 """
12106 IsWindow(self) -> bool
12107
12108 Is this sizer item a window?
12109 """
12110 return _core_.SizerItem_IsWindow(*args, **kwargs)
12111
12112 def IsSizer(*args, **kwargs):
12113 """
12114 IsSizer(self) -> bool
12115
12116 Is this sizer item a subsizer?
12117 """
12118 return _core_.SizerItem_IsSizer(*args, **kwargs)
12119
12120 def IsSpacer(*args, **kwargs):
12121 """
12122 IsSpacer(self) -> bool
12123
12124 Is this sizer item a spacer?
12125 """
12126 return _core_.SizerItem_IsSpacer(*args, **kwargs)
12127
12128 def SetProportion(*args, **kwargs):
12129 """
12130 SetProportion(self, int proportion)
12131
12132 Set the proportion value for this item.
12133 """
12134 return _core_.SizerItem_SetProportion(*args, **kwargs)
12135
12136 def GetProportion(*args, **kwargs):
12137 """
12138 GetProportion(self) -> int
12139
12140 Get the proportion value for this item.
12141 """
12142 return _core_.SizerItem_GetProportion(*args, **kwargs)
12143
12144 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
12145 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
12146 def SetFlag(*args, **kwargs):
12147 """
12148 SetFlag(self, int flag)
12149
12150 Set the flag value for this item.
12151 """
12152 return _core_.SizerItem_SetFlag(*args, **kwargs)
12153
12154 def GetFlag(*args, **kwargs):
12155 """
12156 GetFlag(self) -> int
12157
12158 Get the flag value for this item.
12159 """
12160 return _core_.SizerItem_GetFlag(*args, **kwargs)
12161
12162 def SetBorder(*args, **kwargs):
12163 """
12164 SetBorder(self, int border)
12165
12166 Set the border value for this item.
12167 """
12168 return _core_.SizerItem_SetBorder(*args, **kwargs)
12169
12170 def GetBorder(*args, **kwargs):
12171 """
12172 GetBorder(self) -> int
12173
12174 Get the border value for this item.
12175 """
12176 return _core_.SizerItem_GetBorder(*args, **kwargs)
12177
12178 def GetWindow(*args, **kwargs):
12179 """
12180 GetWindow(self) -> Window
12181
12182 Get the window (if any) that is managed by this sizer item.
12183 """
12184 return _core_.SizerItem_GetWindow(*args, **kwargs)
12185
12186 def GetSizer(*args, **kwargs):
12187 """
12188 GetSizer(self) -> Sizer
12189
12190 Get the subsizer (if any) that is managed by this sizer item.
12191 """
12192 return _core_.SizerItem_GetSizer(*args, **kwargs)
12193
12194 def GetSpacer(*args, **kwargs):
12195 """
12196 GetSpacer(self) -> Size
12197
12198 Get the size of the spacer managed by this sizer item.
12199 """
12200 return _core_.SizerItem_GetSpacer(*args, **kwargs)
12201
12202 def SetWindow(*args, **kwargs):
12203 """
12204 SetWindow(self, Window window)
12205
12206 Set the window to be managed by this sizer item.
12207 """
12208 return _core_.SizerItem_SetWindow(*args, **kwargs)
12209
12210 def SetSizer(*args, **kwargs):
12211 """
12212 SetSizer(self, Sizer sizer)
12213
12214 Set the subsizer to be managed by this sizer item.
12215 """
12216 return _core_.SizerItem_SetSizer(*args, **kwargs)
12217
12218 def SetSpacer(*args, **kwargs):
12219 """
12220 SetSpacer(self, Size size)
12221
12222 Set the size of the spacer to be managed by this sizer item.
12223 """
12224 return _core_.SizerItem_SetSpacer(*args, **kwargs)
12225
12226 SetWindow = wx._deprecated(SetWindow, "Use `AssignWindow` instead.")
12227 SetSizer = wx._deprecated(SetSizer, "Use `AssignSizer` instead.")
12228 SetSpacer = wx._deprecated(SetSpacer, "Use `AssignSpacer` instead.")
12229
12230 def AssignWindow(*args, **kwargs):
12231 """
12232 AssignWindow(self, Window window)
12233
12234 Set the window to be managed by this sizer item.
12235 """
12236 return _core_.SizerItem_AssignWindow(*args, **kwargs)
12237
12238 def AssignSizer(*args, **kwargs):
12239 """
12240 AssignSizer(self, Sizer sizer)
12241
12242 Set the subsizer to be managed by this sizer item.
12243 """
12244 return _core_.SizerItem_AssignSizer(*args, **kwargs)
12245
12246 def AssignSpacer(*args, **kwargs):
12247 """
12248 AssignSpacer(self, Size size)
12249
12250 Set the size of the spacer to be managed by this sizer item.
12251 """
12252 return _core_.SizerItem_AssignSpacer(*args, **kwargs)
12253
12254 def Show(*args, **kwargs):
12255 """
12256 Show(self, bool show)
12257
12258 Set the show item attribute, which sizers use to determine if the item
12259 is to be made part of the layout or not. If the item is tracking a
12260 window then it is shown or hidden as needed.
12261 """
12262 return _core_.SizerItem_Show(*args, **kwargs)
12263
12264 def IsShown(*args, **kwargs):
12265 """
12266 IsShown(self) -> bool
12267
12268 Is the item to be shown in the layout?
12269 """
12270 return _core_.SizerItem_IsShown(*args, **kwargs)
12271
12272 def GetPosition(*args, **kwargs):
12273 """
12274 GetPosition(self) -> Point
12275
12276 Returns the current position of the item, as set in the last Layout.
12277 """
12278 return _core_.SizerItem_GetPosition(*args, **kwargs)
12279
12280 def GetUserData(*args, **kwargs):
12281 """
12282 GetUserData(self) -> PyObject
12283
12284 Returns the userData associated with this sizer item, or None if there
12285 isn't any.
12286 """
12287 return _core_.SizerItem_GetUserData(*args, **kwargs)
12288
12289 def SetUserData(*args, **kwargs):
12290 """
12291 SetUserData(self, PyObject userData)
12292
12293 Associate a Python object with this sizer item.
12294 """
12295 return _core_.SizerItem_SetUserData(*args, **kwargs)
12296
12297 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
12298 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
12299 MinSize = property(GetMinSize,doc="See `GetMinSize`")
12300 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
12301 Position = property(GetPosition,doc="See `GetPosition`")
12302 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
12303 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
12304 Rect = property(GetRect,doc="See `GetRect`")
12305 Size = property(GetSize,doc="See `GetSize`")
12306 Sizer = property(GetSizer,AssignSizer,doc="See `GetSizer` and `AssignSizer`")
12307 Spacer = property(GetSpacer,AssignSpacer,doc="See `GetSpacer` and `AssignSpacer`")
12308 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
12309 Window = property(GetWindow,AssignWindow,doc="See `GetWindow` and `AssignWindow`")
12310 _core_.SizerItem_swigregister(SizerItem)
12311
12312 def SizerItemWindow(*args, **kwargs):
12313 """
12314 SizerItemWindow(Window window, int proportion, int flag, int border,
12315 PyObject userData=None) -> SizerItem
12316
12317 Constructs a `wx.SizerItem` for tracking a window.
12318 """
12319 val = _core_.new_SizerItemWindow(*args, **kwargs)
12320 return val
12321
12322 def SizerItemSpacer(*args, **kwargs):
12323 """
12324 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
12325 PyObject userData=None) -> SizerItem
12326
12327 Constructs a `wx.SizerItem` for tracking a spacer.
12328 """
12329 val = _core_.new_SizerItemSpacer(*args, **kwargs)
12330 return val
12331
12332 def SizerItemSizer(*args, **kwargs):
12333 """
12334 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
12335 PyObject userData=None) -> SizerItem
12336
12337 Constructs a `wx.SizerItem` for tracking a subsizer
12338 """
12339 val = _core_.new_SizerItemSizer(*args, **kwargs)
12340 return val
12341
12342 class Sizer(Object):
12343 """
12344 wx.Sizer is the abstract base class used for laying out subwindows in
12345 a window. You cannot use wx.Sizer directly; instead, you will have to
12346 use one of the sizer classes derived from it such as `wx.BoxSizer`,
12347 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
12348 `wx.GridBagSizer`.
12349
12350 The concept implemented by sizers in wxWidgets is closely related to
12351 layout tools in other GUI toolkits, such as Java's AWT, the GTK
12352 toolkit or the Qt toolkit. It is based upon the idea of the individual
12353 subwindows reporting their minimal required size and their ability to
12354 get stretched if the size of the parent window has changed. This will
12355 most often mean that the programmer does not set the original size of
12356 a dialog in the beginning, rather the dialog will assigned a sizer and
12357 this sizer will be queried about the recommended size. The sizer in
12358 turn will query its children, which can be normal windows or contorls,
12359 empty space or other sizers, so that a hierarchy of sizers can be
12360 constructed. Note that wxSizer does not derive from wxWindow and thus
12361 do not interfere with tab ordering and requires very little resources
12362 compared to a real window on screen.
12363
12364 What makes sizers so well fitted for use in wxWidgets is the fact that
12365 every control reports its own minimal size and the algorithm can
12366 handle differences in font sizes or different window (dialog item)
12367 sizes on different platforms without problems. If for example the
12368 standard font as well as the overall design of Mac widgets requires
12369 more space than on Windows, then the initial size of a dialog using a
12370 sizer will automatically be bigger on Mac than on Windows.
12371 """
12372 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12373 def __init__(self): raise AttributeError, "No constructor defined"
12374 __repr__ = _swig_repr
12375 __swig_destroy__ = _core_.delete_Sizer
12376 __del__ = lambda self : None;
12377 def _setOORInfo(*args, **kwargs):
12378 """_setOORInfo(self, PyObject _self)"""
12379 return _core_.Sizer__setOORInfo(*args, **kwargs)
12380
12381 def Add(*args, **kwargs):
12382 """
12383 Add(self, item, int proportion=0, int flag=0, int border=0,
12384 PyObject userData=None) -> wx.SizerItem
12385
12386 Appends a child item to the sizer.
12387 """
12388 return _core_.Sizer_Add(*args, **kwargs)
12389
12390 def AddF(*args, **kwargs):
12391 """
12392 AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem
12393
12394 Similar to `Add` but uses the `wx.SizerFlags` convenience class for
12395 setting the various flags, options and borders.
12396 """
12397 return _core_.Sizer_AddF(*args, **kwargs)
12398
12399 def Insert(*args, **kwargs):
12400 """
12401 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
12402 PyObject userData=None) -> wx.SizerItem
12403
12404 Inserts a new item into the list of items managed by this sizer before
12405 the item at index *before*. See `Add` for a description of the parameters.
12406 """
12407 return _core_.Sizer_Insert(*args, **kwargs)
12408
12409 def InsertF(*args, **kwargs):
12410 """
12411 InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem
12412
12413 Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
12414 for setting the various flags, options and borders.
12415 """
12416 return _core_.Sizer_InsertF(*args, **kwargs)
12417
12418 def Prepend(*args, **kwargs):
12419 """
12420 Prepend(self, item, int proportion=0, int flag=0, int border=0,
12421 PyObject userData=None) -> wx.SizerItem
12422
12423 Adds a new item to the begining of the list of sizer items managed by
12424 this sizer. See `Add` for a description of the parameters.
12425 """
12426 return _core_.Sizer_Prepend(*args, **kwargs)
12427
12428 def PrependF(*args, **kwargs):
12429 """
12430 PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem
12431
12432 Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
12433 for setting the various flags, options and borders.
12434 """
12435 return _core_.Sizer_PrependF(*args, **kwargs)
12436
12437 def Remove(*args, **kwargs):
12438 """
12439 Remove(self, item) -> bool
12440
12441 Removes an item from the sizer and destroys it. This method does not
12442 cause any layout or resizing to take place, call `Layout` to update
12443 the layout on screen after removing a child from the sizer. The
12444 *item* parameter can be either a window, a sizer, or the zero-based
12445 index of an item to remove. Returns True if the child item was found
12446 and removed.
12447 """
12448 return _core_.Sizer_Remove(*args, **kwargs)
12449
12450 def Detach(*args, **kwargs):
12451 """
12452 Detach(self, item) -> bool
12453
12454 Detaches an item from the sizer without destroying it. This method
12455 does not cause any layout or resizing to take place, call `Layout` to
12456 do so. The *item* parameter can be either a window, a sizer, or the
12457 zero-based index of the item to be detached. Returns True if the child item
12458 was found and detached.
12459 """
12460 return _core_.Sizer_Detach(*args, **kwargs)
12461
12462 def GetItem(*args, **kwargs):
12463 """
12464 GetItem(self, item, recursive=False) -> wx.SizerItem
12465
12466 Returns the `wx.SizerItem` which holds the *item* given. The *item*
12467 parameter can be either a window, a sizer, or the zero-based index of
12468 the item to be found.
12469 """
12470 return _core_.Sizer_GetItem(*args, **kwargs)
12471
12472 def _SetItemMinSize(*args, **kwargs):
12473 """_SetItemMinSize(self, PyObject item, Size size)"""
12474 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
12475
12476 def _ReplaceWin(*args, **kwargs):
12477 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
12478 return _core_.Sizer__ReplaceWin(*args, **kwargs)
12479
12480 def _ReplaceSizer(*args, **kwargs):
12481 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12482 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12483
12484 def _ReplaceItem(*args, **kwargs):
12485 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12486 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12487
12488 def Replace(self, olditem, item, recursive=False):
12489 """
12490 Detaches the given ``olditem`` from the sizer and replaces it with
12491 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12492 detached child is destroyed only if it is not a window, (because
12493 windows are owned by their parent, not the sizer.) The
12494 ``recursive`` parameter can be used to search for the given
12495 element recursivly in subsizers.
12496
12497 This method does not cause any layout or resizing to take place,
12498 call `Layout` to do so.
12499
12500 Returns ``True`` if the child item was found and removed.
12501 """
12502 if isinstance(olditem, wx.Window):
12503 return self._ReplaceWin(olditem, item, recursive)
12504 elif isinstance(olditem, wx.Sizer):
12505 return self._ReplaceSizer(olditem, item, recursive)
12506 elif isinstance(olditem, int):
12507 return self._ReplaceItem(olditem, item)
12508 else:
12509 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12510
12511 def SetContainingWindow(*args, **kwargs):
12512 """
12513 SetContainingWindow(self, Window window)
12514
12515 Set (or unset) the window this sizer is used in.
12516 """
12517 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12518
12519 def GetContainingWindow(*args, **kwargs):
12520 """
12521 GetContainingWindow(self) -> Window
12522
12523 Get the window this sizer is used in.
12524 """
12525 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12526
12527 def SetItemMinSize(self, item, *args):
12528 """
12529 SetItemMinSize(self, item, Size size)
12530
12531 Sets the minimum size that will be allocated for an item in the sizer.
12532 The *item* parameter can be either a window, a sizer, or the
12533 zero-based index of the item. If a window or sizer is given then it
12534 will be searched for recursivly in subsizers if neccessary.
12535 """
12536 if len(args) == 2:
12537 # for backward compatibility accept separate width,height args too
12538 return self._SetItemMinSize(item, args)
12539 else:
12540 return self._SetItemMinSize(item, args[0])
12541
12542 def AddItem(*args, **kwargs):
12543 """
12544 AddItem(self, SizerItem item)
12545
12546 Adds a `wx.SizerItem` to the sizer.
12547 """
12548 return _core_.Sizer_AddItem(*args, **kwargs)
12549
12550 def InsertItem(*args, **kwargs):
12551 """
12552 InsertItem(self, int index, SizerItem item)
12553
12554 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12555 """
12556 return _core_.Sizer_InsertItem(*args, **kwargs)
12557
12558 def PrependItem(*args, **kwargs):
12559 """
12560 PrependItem(self, SizerItem item)
12561
12562 Prepends a `wx.SizerItem` to the sizer.
12563 """
12564 return _core_.Sizer_PrependItem(*args, **kwargs)
12565
12566 def AddMany(self, items):
12567 """
12568 AddMany is a convenience method for adding several items
12569 to a sizer at one time. Simply pass it a list of tuples,
12570 where each tuple consists of the parameters that you
12571 would normally pass to the `Add` method.
12572 """
12573 for item in items:
12574 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12575 item = (item, )
12576 self.Add(*item)
12577
12578 def AddSpacer(self, *args, **kw):
12579 """AddSpacer(int size) --> SizerItem
12580
12581 Add a spacer that is (size,size) pixels.
12582 """
12583 if args and type(args[0]) == int:
12584 return self.Add( (args[0],args[0] ), 0)
12585 else: # otherwise stay compatible with old AddSpacer
12586 return self.Add(*args, **kw)
12587 def PrependSpacer(self, *args, **kw):
12588 """PrependSpacer(int size) --> SizerItem
12589
12590 Prepend a spacer that is (size, size) pixels."""
12591 if args and type(args[0]) == int:
12592 return self.Prepend( (args[0],args[0] ), 0)
12593 else: # otherwise stay compatible with old PrependSpacer
12594 return self.Prepend(*args, **kw)
12595 def InsertSpacer(self, index, *args, **kw):
12596 """InsertSpacer(int index, int size) --> SizerItem
12597
12598 Insert a spacer at position index that is (size, size) pixels."""
12599 if args and type(args[0]) == int:
12600 return self.Insert( index, (args[0],args[0] ), 0)
12601 else: # otherwise stay compatible with old InsertSpacer
12602 return self.Insert(index, *args, **kw)
12603
12604
12605 def AddStretchSpacer(self, prop=1):
12606 """AddStretchSpacer(int prop=1) --> SizerItem
12607
12608 Add a stretchable spacer."""
12609 return self.Add((0,0), prop)
12610 def PrependStretchSpacer(self, prop=1):
12611 """PrependStretchSpacer(int prop=1) --> SizerItem
12612
12613 Prepend a stretchable spacer."""
12614 return self.Prepend((0,0), prop)
12615 def InsertStretchSpacer(self, index, prop=1):
12616 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12617
12618 Insert a stretchable spacer."""
12619 return self.Insert(index, (0,0), prop)
12620
12621
12622 # for backwards compatibility only, please do not use in new code
12623 def AddWindow(self, *args, **kw):
12624 """Compatibility alias for `Add`."""
12625 return self.Add(*args, **kw)
12626 def AddSizer(self, *args, **kw):
12627 """Compatibility alias for `Add`."""
12628 return self.Add(*args, **kw)
12629
12630 def PrependWindow(self, *args, **kw):
12631 """Compatibility alias for `Prepend`."""
12632 return self.Prepend(*args, **kw)
12633 def PrependSizer(self, *args, **kw):
12634 """Compatibility alias for `Prepend`."""
12635 return self.Prepend(*args, **kw)
12636
12637 def InsertWindow(self, *args, **kw):
12638 """Compatibility alias for `Insert`."""
12639 return self.Insert(*args, **kw)
12640 def InsertSizer(self, *args, **kw):
12641 """Compatibility alias for `Insert`."""
12642 return self.Insert(*args, **kw)
12643
12644 def RemoveWindow(self, *args, **kw):
12645 """Compatibility alias for `Remove`."""
12646 return self.Remove(*args, **kw)
12647 def RemoveSizer(self, *args, **kw):
12648 """Compatibility alias for `Remove`."""
12649 return self.Remove(*args, **kw)
12650 def RemovePos(self, *args, **kw):
12651 """Compatibility alias for `Remove`."""
12652 return self.Remove(*args, **kw)
12653
12654
12655 def SetDimension(*args, **kwargs):
12656 """
12657 SetDimension(self, int x, int y, int width, int height)
12658
12659 Call this to force the sizer to take the given dimension and thus
12660 force the items owned by the sizer to resize themselves according to
12661 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12662 methods.
12663 """
12664 return _core_.Sizer_SetDimension(*args, **kwargs)
12665
12666 def SetMinSize(*args, **kwargs):
12667 """
12668 SetMinSize(self, Size size)
12669
12670 Call this to give the sizer a minimal size. Normally, the sizer will
12671 calculate its minimal size based purely on how much space its children
12672 need. After calling this method `GetMinSize` will return either the
12673 minimal size as requested by its children or the minimal size set
12674 here, depending on which is bigger.
12675 """
12676 return _core_.Sizer_SetMinSize(*args, **kwargs)
12677
12678 def GetSize(*args, **kwargs):
12679 """
12680 GetSize(self) -> Size
12681
12682 Returns the current size of the space managed by the sizer.
12683 """
12684 return _core_.Sizer_GetSize(*args, **kwargs)
12685
12686 def GetPosition(*args, **kwargs):
12687 """
12688 GetPosition(self) -> Point
12689
12690 Returns the current position of the sizer's managed space.
12691 """
12692 return _core_.Sizer_GetPosition(*args, **kwargs)
12693
12694 def GetMinSize(*args, **kwargs):
12695 """
12696 GetMinSize(self) -> Size
12697
12698 Returns the minimal size of the sizer. This is either the combined
12699 minimal size of all the children and their borders or the minimal size
12700 set by SetMinSize, depending on which is bigger.
12701 """
12702 return _core_.Sizer_GetMinSize(*args, **kwargs)
12703
12704 def GetSizeTuple(self):
12705 return self.GetSize().Get()
12706 def GetPositionTuple(self):
12707 return self.GetPosition().Get()
12708 def GetMinSizeTuple(self):
12709 return self.GetMinSize().Get()
12710
12711 def RecalcSizes(*args, **kwargs):
12712 """
12713 RecalcSizes(self)
12714
12715 Using the sizes calculated by `CalcMin` reposition and resize all the
12716 items managed by this sizer. You should not need to call this directly as
12717 it is called by `Layout`.
12718 """
12719 return _core_.Sizer_RecalcSizes(*args, **kwargs)
12720
12721 def CalcMin(*args, **kwargs):
12722 """
12723 CalcMin(self) -> Size
12724
12725 This method is where the sizer will do the actual calculation of its
12726 children's minimal sizes. You should not need to call this directly as
12727 it is called by `Layout`.
12728 """
12729 return _core_.Sizer_CalcMin(*args, **kwargs)
12730
12731 def Layout(*args, **kwargs):
12732 """
12733 Layout(self)
12734
12735 This method will force the recalculation and layout of the items
12736 controlled by the sizer using the current space allocated to the
12737 sizer. Normally this is called automatically from the owning window's
12738 EVT_SIZE handler, but it is also useful to call it from user code when
12739 one of the items in a sizer change size, or items are added or
12740 removed.
12741 """
12742 return _core_.Sizer_Layout(*args, **kwargs)
12743
12744 def Fit(*args, **kwargs):
12745 """
12746 Fit(self, Window window) -> Size
12747
12748 Tell the sizer to resize the *window* to match the sizer's minimal
12749 size. This is commonly done in the constructor of the window itself in
12750 order to set its initial size to match the needs of the children as
12751 determined by the sizer. Returns the new size.
12752
12753 For a top level window this is the total window size, not the client size.
12754 """
12755 return _core_.Sizer_Fit(*args, **kwargs)
12756
12757 def FitInside(*args, **kwargs):
12758 """
12759 FitInside(self, Window window)
12760
12761 Tell the sizer to resize the *virtual size* of the *window* to match the
12762 sizer's minimal size. This will not alter the on screen size of the
12763 window, but may cause the addition/removal/alteration of scrollbars
12764 required to view the virtual area in windows which manage it.
12765
12766 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12767
12768 """
12769 return _core_.Sizer_FitInside(*args, **kwargs)
12770
12771 def SetSizeHints(*args, **kwargs):
12772 """
12773 SetSizeHints(self, Window window)
12774
12775 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12776 match the sizer's minimal size. This is commonly done in the
12777 constructor of the window itself if the window is resizable (as are
12778 many dialogs under Unix and frames on probably all platforms) in order
12779 to prevent the window from being sized smaller than the minimal size
12780 required by the sizer.
12781 """
12782 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12783
12784 def SetVirtualSizeHints(*args, **kwargs):
12785 """
12786 SetVirtualSizeHints(self, Window window)
12787
12788 Tell the sizer to set the minimal size of the window virtual area to
12789 match the sizer's minimal size. For windows with managed scrollbars
12790 this will set them appropriately.
12791
12792 :see: `wx.ScrolledWindow.SetScrollbars`
12793
12794 """
12795 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12796
12797 def Clear(*args, **kwargs):
12798 """
12799 Clear(self, bool deleteWindows=False)
12800
12801 Clear all items from the sizer, optionally destroying the window items
12802 as well.
12803 """
12804 return _core_.Sizer_Clear(*args, **kwargs)
12805
12806 def DeleteWindows(*args, **kwargs):
12807 """
12808 DeleteWindows(self)
12809
12810 Destroy all windows managed by the sizer.
12811 """
12812 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12813
12814 def GetChildren(*args, **kwargs):
12815 """
12816 GetChildren(self) -> list
12817
12818 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12819 """
12820 return _core_.Sizer_GetChildren(*args, **kwargs)
12821
12822 def Show(*args, **kwargs):
12823 """
12824 Show(self, item, bool show=True, bool recursive=false) -> bool
12825
12826 Shows or hides an item managed by the sizer. To make a sizer item
12827 disappear or reappear, use Show followed by `Layout`. The *item*
12828 parameter can be either a window, a sizer, or the zero-based index of
12829 the item. Use the recursive parameter to show or hide an item in a
12830 subsizer. Returns True if the item was found.
12831 """
12832 return _core_.Sizer_Show(*args, **kwargs)
12833
12834 def IsShown(*args, **kwargs):
12835 """
12836 IsShown(self, item)
12837
12838 Determines if the item is currently shown. To make a sizer
12839 item disappear or reappear, use Show followed by `Layout`. The *item*
12840 parameter can be either a window, a sizer, or the zero-based index of
12841 the item.
12842 """
12843 return _core_.Sizer_IsShown(*args, **kwargs)
12844
12845 def Hide(self, item, recursive=False):
12846 """
12847 A convenience method for `Show` (item, False, recursive).
12848 """
12849 return self.Show(item, False, recursive)
12850
12851 def ShowItems(*args, **kwargs):
12852 """
12853 ShowItems(self, bool show)
12854
12855 Recursively call `wx.SizerItem.Show` on all sizer items.
12856 """
12857 return _core_.Sizer_ShowItems(*args, **kwargs)
12858
12859 Children = property(GetChildren,doc="See `GetChildren`")
12860 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12861 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12862 Position = property(GetPosition,doc="See `GetPosition`")
12863 Size = property(GetSize,doc="See `GetSize`")
12864 _core_.Sizer_swigregister(Sizer)
12865
12866 class PySizer(Sizer):
12867 """
12868 wx.PySizer is a special version of `wx.Sizer` that has been
12869 instrumented to allow the C++ virtual methods to be overloaded in
12870 Python derived classes. You would derive from this class if you are
12871 wanting to implement a custom sizer in Python code. Simply implement
12872 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12873 For example::
12874
12875 class MySizer(wx.PySizer):
12876 def __init__(self):
12877 wx.PySizer.__init__(self)
12878
12879 def CalcMin(self):
12880 for item in self.GetChildren():
12881 # calculate the total minimum width and height needed
12882 # by all items in the sizer according to this sizer's
12883 # layout algorithm.
12884 ...
12885 return wx.Size(width, height)
12886
12887 def RecalcSizes(self):
12888 # find the space allotted to this sizer
12889 pos = self.GetPosition()
12890 size = self.GetSize()
12891 for item in self.GetChildren():
12892 # Recalculate (if necessary) the position and size of
12893 # each item and then call item.SetDimension to do the
12894 # actual positioning and sizing of the items within the
12895 # space alloted to this sizer.
12896 ...
12897 item.SetDimension(itemPos, itemSize)
12898
12899
12900 When `Layout` is called it first calls `CalcMin` followed by
12901 `RecalcSizes` so you can optimize a bit by saving the results of
12902 `CalcMin` and reusing them in `RecalcSizes`.
12903
12904 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12905
12906
12907 """
12908 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12909 __repr__ = _swig_repr
12910 def __init__(self, *args, **kwargs):
12911 """
12912 __init__(self) -> PySizer
12913
12914 Creates a wx.PySizer. Must be called from the __init__ in the derived
12915 class.
12916 """
12917 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12918 self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer)
12919
12920 def _setCallbackInfo(*args, **kwargs):
12921 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12922 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12923
12924 _core_.PySizer_swigregister(PySizer)
12925
12926 #---------------------------------------------------------------------------
12927
12928 class BoxSizer(Sizer):
12929 """
12930 The basic idea behind a box sizer is that windows will most often be
12931 laid out in rather simple basic geometry, typically in a row or a
12932 column or nested hierarchies of either. A wx.BoxSizer will lay out
12933 its items in a simple row or column, depending on the orientation
12934 parameter passed to the constructor.
12935 """
12936 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12937 __repr__ = _swig_repr
12938 def __init__(self, *args, **kwargs):
12939 """
12940 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12941
12942 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12943 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12944 sizer.
12945 """
12946 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12947 self._setOORInfo(self)
12948
12949 def GetOrientation(*args, **kwargs):
12950 """
12951 GetOrientation(self) -> int
12952
12953 Returns the current orientation of the sizer.
12954 """
12955 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12956
12957 def SetOrientation(*args, **kwargs):
12958 """
12959 SetOrientation(self, int orient)
12960
12961 Resets the orientation of the sizer.
12962 """
12963 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12964
12965 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12966 _core_.BoxSizer_swigregister(BoxSizer)
12967
12968 #---------------------------------------------------------------------------
12969
12970 class StaticBoxSizer(BoxSizer):
12971 """
12972 wx.StaticBoxSizer derives from and functions identically to the
12973 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12974 manages. Note that this static box must be created separately and
12975 passed to the sizer constructor.
12976 """
12977 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12978 __repr__ = _swig_repr
12979 def __init__(self, *args, **kwargs):
12980 """
12981 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12982
12983 Constructor. It takes an associated static box and the orientation
12984 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12985 ``wx.HORIZONTAL``.
12986 """
12987 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12988 self._setOORInfo(self)
12989
12990 def GetStaticBox(*args, **kwargs):
12991 """
12992 GetStaticBox(self) -> StaticBox
12993
12994 Returns the static box associated with this sizer.
12995 """
12996 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12997
12998 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12999 _core_.StaticBoxSizer_swigregister(StaticBoxSizer)
13000
13001 #---------------------------------------------------------------------------
13002
13003 class GridSizer(Sizer):
13004 """
13005 A grid sizer is a sizer which lays out its children in a
13006 two-dimensional table with all cells having the same size. In other
13007 words, the width of each cell within the grid is the width of the
13008 widest item added to the sizer and the height of each grid cell is the
13009 height of the tallest item. An optional vertical and/or horizontal
13010 gap between items can also be specified (in pixels.)
13011
13012 Items are placed in the cells of the grid in the order they are added,
13013 in row-major order. In other words, the first row is filled first,
13014 then the second, and so on until all items have been added. (If
13015 neccessary, additional rows will be added as items are added.) If you
13016 need to have greater control over the cells that items are placed in
13017 then use the `wx.GridBagSizer`.
13018
13019 """
13020 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13021 __repr__ = _swig_repr
13022 def __init__(self, *args, **kwargs):
13023 """
13024 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
13025
13026 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
13027 of columns and rows in the sizer - if either of the parameters is
13028 zero, it will be calculated to from the total number of children in
13029 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
13030 define extra space between all children.
13031 """
13032 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
13033 self._setOORInfo(self)
13034
13035 def SetCols(*args, **kwargs):
13036 """
13037 SetCols(self, int cols)
13038
13039 Sets the number of columns in the sizer.
13040 """
13041 return _core_.GridSizer_SetCols(*args, **kwargs)
13042
13043 def SetRows(*args, **kwargs):
13044 """
13045 SetRows(self, int rows)
13046
13047 Sets the number of rows in the sizer.
13048 """
13049 return _core_.GridSizer_SetRows(*args, **kwargs)
13050
13051 def SetVGap(*args, **kwargs):
13052 """
13053 SetVGap(self, int gap)
13054
13055 Sets the vertical gap (in pixels) between the cells in the sizer.
13056 """
13057 return _core_.GridSizer_SetVGap(*args, **kwargs)
13058
13059 def SetHGap(*args, **kwargs):
13060 """
13061 SetHGap(self, int gap)
13062
13063 Sets the horizontal gap (in pixels) between cells in the sizer
13064 """
13065 return _core_.GridSizer_SetHGap(*args, **kwargs)
13066
13067 def GetCols(*args, **kwargs):
13068 """
13069 GetCols(self) -> int
13070
13071 Returns the number of columns in the sizer.
13072 """
13073 return _core_.GridSizer_GetCols(*args, **kwargs)
13074
13075 def GetRows(*args, **kwargs):
13076 """
13077 GetRows(self) -> int
13078
13079 Returns the number of rows in the sizer.
13080 """
13081 return _core_.GridSizer_GetRows(*args, **kwargs)
13082
13083 def GetVGap(*args, **kwargs):
13084 """
13085 GetVGap(self) -> int
13086
13087 Returns the vertical gap (in pixels) between the cells in the sizer.
13088 """
13089 return _core_.GridSizer_GetVGap(*args, **kwargs)
13090
13091 def GetHGap(*args, **kwargs):
13092 """
13093 GetHGap(self) -> int
13094
13095 Returns the horizontal gap (in pixels) between cells in the sizer.
13096 """
13097 return _core_.GridSizer_GetHGap(*args, **kwargs)
13098
13099 def CalcRowsCols(self):
13100 """
13101 CalcRowsCols() -> (rows, cols)
13102
13103 Calculates how many rows and columns will be in the sizer based
13104 on the current number of items and also the rows, cols specified
13105 in the constructor.
13106 """
13107 nitems = len(self.GetChildren())
13108 rows = self.GetRows()
13109 cols = self.GetCols()
13110 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
13111 if cols != 0:
13112 rows = (nitems + cols - 1) / cols
13113 elif rows != 0:
13114 cols = (nitems + rows - 1) / rows
13115 return (rows, cols)
13116
13117 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
13118 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
13119 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
13120 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
13121 _core_.GridSizer_swigregister(GridSizer)
13122
13123 #---------------------------------------------------------------------------
13124
13125 FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
13126 FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
13127 FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
13128 class FlexGridSizer(GridSizer):
13129 """
13130 A flex grid sizer is a sizer which lays out its children in a
13131 two-dimensional table with all table cells in one row having the same
13132 height and all cells in one column having the same width, but all
13133 rows or all columns are not necessarily the same height or width as in
13134 the `wx.GridSizer`.
13135
13136 wx.FlexGridSizer can also size items equally in one direction but
13137 unequally ("flexibly") in the other. If the sizer is only flexible
13138 in one direction (this can be changed using `SetFlexibleDirection`), it
13139 needs to be decided how the sizer should grow in the other ("non
13140 flexible") direction in order to fill the available space. The
13141 `SetNonFlexibleGrowMode` method serves this purpose.
13142
13143
13144 """
13145 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13146 __repr__ = _swig_repr
13147 def __init__(self, *args, **kwargs):
13148 """
13149 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
13150
13151 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
13152 number of columns and rows in the sizer - if either of the parameters
13153 is zero, it will be calculated to from the total number of children in
13154 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
13155 define extra space between all children.
13156 """
13157 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
13158 self._setOORInfo(self)
13159
13160 def AddGrowableRow(*args, **kwargs):
13161 """
13162 AddGrowableRow(self, size_t idx, int proportion=0)
13163
13164 Specifies that row *idx* (starting from zero) should be grown if there
13165 is extra space available to the sizer.
13166
13167 The *proportion* parameter has the same meaning as the stretch factor
13168 for the box sizers except that if all proportions are 0, then all
13169 columns are resized equally (instead of not being resized at all).
13170 """
13171 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
13172
13173 def RemoveGrowableRow(*args, **kwargs):
13174 """
13175 RemoveGrowableRow(self, size_t idx)
13176
13177 Specifies that row *idx* is no longer growable.
13178 """
13179 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
13180
13181 def AddGrowableCol(*args, **kwargs):
13182 """
13183 AddGrowableCol(self, size_t idx, int proportion=0)
13184
13185 Specifies that column *idx* (starting from zero) should be grown if
13186 there is extra space available to the sizer.
13187
13188 The *proportion* parameter has the same meaning as the stretch factor
13189 for the box sizers except that if all proportions are 0, then all
13190 columns are resized equally (instead of not being resized at all).
13191 """
13192 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
13193
13194 def RemoveGrowableCol(*args, **kwargs):
13195 """
13196 RemoveGrowableCol(self, size_t idx)
13197
13198 Specifies that column *idx* is no longer growable.
13199 """
13200 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
13201
13202 def SetFlexibleDirection(*args, **kwargs):
13203 """
13204 SetFlexibleDirection(self, int direction)
13205
13206 Specifies whether the sizer should flexibly resize its columns, rows,
13207 or both. Argument *direction* can be one of the following values. Any
13208 other value is ignored.
13209
13210 ============== =======================================
13211 wx.VERTICAL Rows are flexibly sized.
13212 wx.HORIZONTAL Columns are flexibly sized.
13213 wx.BOTH Both rows and columns are flexibly sized
13214 (this is the default value).
13215 ============== =======================================
13216
13217 Note that this method does not trigger relayout.
13218
13219 """
13220 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
13221
13222 def GetFlexibleDirection(*args, **kwargs):
13223 """
13224 GetFlexibleDirection(self) -> int
13225
13226 Returns a value that specifies whether the sizer
13227 flexibly resizes its columns, rows, or both (default).
13228
13229 :see: `SetFlexibleDirection`
13230 """
13231 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
13232
13233 def SetNonFlexibleGrowMode(*args, **kwargs):
13234 """
13235 SetNonFlexibleGrowMode(self, int mode)
13236
13237 Specifies how the sizer should grow in the non-flexible direction if
13238 there is one (so `SetFlexibleDirection` must have been called
13239 previously). Argument *mode* can be one of the following values:
13240
13241 ========================== =================================================
13242 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
13243 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
13244 `AddGrowableCol` and `AddGrowableRow`. In this
13245 case equal sizing applies to minimum sizes of
13246 columns or rows (this is the default value).
13247 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
13248 the non flexible direction, whether they are
13249 growable or not in the flexbile direction.
13250 ========================== =================================================
13251
13252 Note that this method does not trigger relayout.
13253 """
13254 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
13255
13256 def GetNonFlexibleGrowMode(*args, **kwargs):
13257 """
13258 GetNonFlexibleGrowMode(self) -> int
13259
13260 Returns the value that specifies how the sizer grows in the
13261 non-flexible direction if there is one.
13262
13263 :see: `SetNonFlexibleGrowMode`
13264 """
13265 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
13266
13267 def GetRowHeights(*args, **kwargs):
13268 """
13269 GetRowHeights(self) -> list
13270
13271 Returns a list of integers representing the heights of each of the
13272 rows in the sizer.
13273 """
13274 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
13275
13276 def GetColWidths(*args, **kwargs):
13277 """
13278 GetColWidths(self) -> list
13279
13280 Returns a list of integers representing the widths of each of the
13281 columns in the sizer.
13282 """
13283 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
13284
13285 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
13286 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
13287 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
13288 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
13289 _core_.FlexGridSizer_swigregister(FlexGridSizer)
13290
13291 class StdDialogButtonSizer(BoxSizer):
13292 """
13293 A special sizer that knows how to order and position standard buttons
13294 in order to conform to the current platform's standards. You simply
13295 need to add each `wx.Button` to the sizer, and be sure to create the
13296 buttons using the standard ID's. Then call `Realize` and the sizer
13297 will take care of the rest.
13298
13299 """
13300 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13301 __repr__ = _swig_repr
13302 def __init__(self, *args, **kwargs):
13303 """__init__(self) -> StdDialogButtonSizer"""
13304 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
13305 def AddButton(*args, **kwargs):
13306 """
13307 AddButton(self, wxButton button)
13308
13309 Use this to add the buttons to this sizer. Do not use the `Add`
13310 method in the base class.
13311 """
13312 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
13313
13314 def Realize(*args, **kwargs):
13315 """
13316 Realize(self)
13317
13318 This funciton needs to be called after all the buttons have been added
13319 to the sizer. It will reorder them and position them in a platform
13320 specifc manner.
13321 """
13322 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
13323
13324 def SetAffirmativeButton(*args, **kwargs):
13325 """SetAffirmativeButton(self, wxButton button)"""
13326 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
13327
13328 def SetNegativeButton(*args, **kwargs):
13329 """SetNegativeButton(self, wxButton button)"""
13330 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
13331
13332 def SetCancelButton(*args, **kwargs):
13333 """SetCancelButton(self, wxButton button)"""
13334 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
13335
13336 def GetAffirmativeButton(*args, **kwargs):
13337 """GetAffirmativeButton(self) -> wxButton"""
13338 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
13339
13340 def GetApplyButton(*args, **kwargs):
13341 """GetApplyButton(self) -> wxButton"""
13342 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
13343
13344 def GetNegativeButton(*args, **kwargs):
13345 """GetNegativeButton(self) -> wxButton"""
13346 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
13347
13348 def GetCancelButton(*args, **kwargs):
13349 """GetCancelButton(self) -> wxButton"""
13350 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
13351
13352 def GetHelpButton(*args, **kwargs):
13353 """GetHelpButton(self) -> wxButton"""
13354 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
13355
13356 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
13357 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
13358 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
13359 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
13360 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
13361 _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
13362
13363 #---------------------------------------------------------------------------
13364
13365 class GBPosition(object):
13366 """
13367 This class represents the position of an item in a virtual grid of
13368 rows and columns managed by a `wx.GridBagSizer`. wxPython has
13369 typemaps that will automatically convert from a 2-element sequence of
13370 integers to a wx.GBPosition, so you can use the more pythonic
13371 representation of the position nearly transparently in Python code.
13372 """
13373 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13374 __repr__ = _swig_repr
13375 def __init__(self, *args, **kwargs):
13376 """
13377 __init__(self, int row=0, int col=0) -> GBPosition
13378
13379 This class represents the position of an item in a virtual grid of
13380 rows and columns managed by a `wx.GridBagSizer`. wxPython has
13381 typemaps that will automatically convert from a 2-element sequence of
13382 integers to a wx.GBPosition, so you can use the more pythonic
13383 representation of the position nearly transparently in Python code.
13384 """
13385 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
13386 __swig_destroy__ = _core_.delete_GBPosition
13387 __del__ = lambda self : None;
13388 def GetRow(*args, **kwargs):
13389 """GetRow(self) -> int"""
13390 return _core_.GBPosition_GetRow(*args, **kwargs)
13391
13392 def GetCol(*args, **kwargs):
13393 """GetCol(self) -> int"""
13394 return _core_.GBPosition_GetCol(*args, **kwargs)
13395
13396 def SetRow(*args, **kwargs):
13397 """SetRow(self, int row)"""
13398 return _core_.GBPosition_SetRow(*args, **kwargs)
13399
13400 def SetCol(*args, **kwargs):
13401 """SetCol(self, int col)"""
13402 return _core_.GBPosition_SetCol(*args, **kwargs)
13403
13404 def __eq__(*args, **kwargs):
13405 """
13406 __eq__(self, PyObject other) -> bool
13407
13408 Compare GBPosition for equality.
13409 """
13410 return _core_.GBPosition___eq__(*args, **kwargs)
13411
13412 def __ne__(*args, **kwargs):
13413 """
13414 __ne__(self, PyObject other) -> bool
13415
13416 Compare GBPosition for inequality.
13417 """
13418 return _core_.GBPosition___ne__(*args, **kwargs)
13419
13420 def Set(*args, **kwargs):
13421 """Set(self, int row=0, int col=0)"""
13422 return _core_.GBPosition_Set(*args, **kwargs)
13423
13424 def Get(*args, **kwargs):
13425 """Get(self) -> PyObject"""
13426 return _core_.GBPosition_Get(*args, **kwargs)
13427
13428 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
13429 def __str__(self): return str(self.Get())
13430 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
13431 def __len__(self): return len(self.Get())
13432 def __getitem__(self, index): return self.Get()[index]
13433 def __setitem__(self, index, val):
13434 if index == 0: self.SetRow(val)
13435 elif index == 1: self.SetCol(val)
13436 else: raise IndexError
13437 def __nonzero__(self): return self.Get() != (0,0)
13438 __safe_for_unpickling__ = True
13439 def __reduce__(self): return (wx.GBPosition, self.Get())
13440
13441 row = property(GetRow, SetRow)
13442 col = property(GetCol, SetCol)
13443
13444 _core_.GBPosition_swigregister(GBPosition)
13445
13446 class GBSpan(object):
13447 """
13448 This class is used to hold the row and column spanning attributes of
13449 items in a `wx.GridBagSizer`. wxPython has typemaps that will
13450 automatically convert from a 2-element sequence of integers to a
13451 wx.GBSpan, so you can use the more pythonic representation of the span
13452 nearly transparently in Python code.
13453
13454 """
13455 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13456 __repr__ = _swig_repr
13457 def __init__(self, *args, **kwargs):
13458 """
13459 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
13460
13461 Construct a new wxGBSpan, optionally setting the rowspan and
13462 colspan. The default is (1,1). (Meaning that the item occupies one
13463 cell in each direction.
13464 """
13465 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
13466 __swig_destroy__ = _core_.delete_GBSpan
13467 __del__ = lambda self : None;
13468 def GetRowspan(*args, **kwargs):
13469 """GetRowspan(self) -> int"""
13470 return _core_.GBSpan_GetRowspan(*args, **kwargs)
13471
13472 def GetColspan(*args, **kwargs):
13473 """GetColspan(self) -> int"""
13474 return _core_.GBSpan_GetColspan(*args, **kwargs)
13475
13476 def SetRowspan(*args, **kwargs):
13477 """SetRowspan(self, int rowspan)"""
13478 return _core_.GBSpan_SetRowspan(*args, **kwargs)
13479
13480 def SetColspan(*args, **kwargs):
13481 """SetColspan(self, int colspan)"""
13482 return _core_.GBSpan_SetColspan(*args, **kwargs)
13483
13484 def __eq__(*args, **kwargs):
13485 """
13486 __eq__(self, PyObject other) -> bool
13487
13488 Compare wxGBSpan for equality.
13489 """
13490 return _core_.GBSpan___eq__(*args, **kwargs)
13491
13492 def __ne__(*args, **kwargs):
13493 """
13494 __ne__(self, PyObject other) -> bool
13495
13496 Compare GBSpan for inequality.
13497 """
13498 return _core_.GBSpan___ne__(*args, **kwargs)
13499
13500 def Set(*args, **kwargs):
13501 """Set(self, int rowspan=1, int colspan=1)"""
13502 return _core_.GBSpan_Set(*args, **kwargs)
13503
13504 def Get(*args, **kwargs):
13505 """Get(self) -> PyObject"""
13506 return _core_.GBSpan_Get(*args, **kwargs)
13507
13508 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
13509 def __str__(self): return str(self.Get())
13510 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13511 def __len__(self): return len(self.Get())
13512 def __getitem__(self, index): return self.Get()[index]
13513 def __setitem__(self, index, val):
13514 if index == 0: self.SetRowspan(val)
13515 elif index == 1: self.SetColspan(val)
13516 else: raise IndexError
13517 def __nonzero__(self): return self.Get() != (0,0)
13518 __safe_for_unpickling__ = True
13519 def __reduce__(self): return (wx.GBSpan, self.Get())
13520
13521 rowspan = property(GetRowspan, SetRowspan)
13522 colspan = property(GetColspan, SetColspan)
13523
13524 _core_.GBSpan_swigregister(GBSpan)
13525
13526 class GBSizerItem(SizerItem):
13527 """
13528 The wx.GBSizerItem class is used to track the additional data about
13529 items in a `wx.GridBagSizer` such as the item's position in the grid
13530 and how many rows or columns it spans.
13531
13532 """
13533 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13534 __repr__ = _swig_repr
13535 def __init__(self, *args, **kwargs):
13536 """
13537 __init__(self) -> GBSizerItem
13538
13539 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13540 size will need to be set, as well as a position and span before this
13541 item can be used in a Sizer.
13542
13543 You will probably never need to create a wx.GBSizerItem directly as they
13544 are created automatically when the sizer's Add method is called.
13545 """
13546 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13547 __swig_destroy__ = _core_.delete_GBSizerItem
13548 __del__ = lambda self : None;
13549 def GetPos(*args, **kwargs):
13550 """
13551 GetPos(self) -> GBPosition
13552
13553 Get the grid position of the item
13554 """
13555 return _core_.GBSizerItem_GetPos(*args, **kwargs)
13556
13557 def GetPosTuple(self): return self.GetPos().Get()
13558 def GetSpan(*args, **kwargs):
13559 """
13560 GetSpan(self) -> GBSpan
13561
13562 Get the row and column spanning of the item
13563 """
13564 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
13565
13566 def GetSpanTuple(self): return self.GetSpan().Get()
13567 def SetPos(*args, **kwargs):
13568 """
13569 SetPos(self, GBPosition pos) -> bool
13570
13571 If the item is already a member of a sizer then first ensure that
13572 there is no other item that would intersect with this one at the new
13573 position, then set the new position. Returns True if the change is
13574 successful and after the next Layout() the item will be moved.
13575 """
13576 return _core_.GBSizerItem_SetPos(*args, **kwargs)
13577
13578 def SetSpan(*args, **kwargs):
13579 """
13580 SetSpan(self, GBSpan span) -> bool
13581
13582 If the item is already a member of a sizer then first ensure that
13583 there is no other item that would intersect with this one with its new
13584 spanning size, then set the new spanning. Returns True if the change
13585 is successful and after the next Layout() the item will be resized.
13586
13587 """
13588 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
13589
13590 def Intersects(*args, **kwargs):
13591 """
13592 Intersects(self, GBSizerItem other) -> bool
13593
13594 Returns True if this item and the other item instersect.
13595 """
13596 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13597
13598 def IntersectsPos(*args, **kwargs):
13599 """
13600 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13601
13602 Returns True if the given pos/span would intersect with this item.
13603 """
13604 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
13605
13606 def GetEndPos(*args, **kwargs):
13607 """
13608 GetEndPos(self) -> GBPosition
13609
13610 Get the row and column of the endpoint of this item.
13611 """
13612 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
13613
13614 def GetGBSizer(*args, **kwargs):
13615 """
13616 GetGBSizer(self) -> GridBagSizer
13617
13618 Get the sizer this item is a member of.
13619 """
13620 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
13621
13622 def SetGBSizer(*args, **kwargs):
13623 """
13624 SetGBSizer(self, GridBagSizer sizer)
13625
13626 Set the sizer this item is a member of.
13627 """
13628 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
13629
13630 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13631 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13632 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13633 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
13634 _core_.GBSizerItem_swigregister(GBSizerItem)
13635 DefaultSpan = cvar.DefaultSpan
13636
13637 def GBSizerItemWindow(*args, **kwargs):
13638 """
13639 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13640 int border, PyObject userData=None) -> GBSizerItem
13641
13642 Construct a `wx.GBSizerItem` for a window.
13643 """
13644 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
13645 return val
13646
13647 def GBSizerItemSizer(*args, **kwargs):
13648 """
13649 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13650 int border, PyObject userData=None) -> GBSizerItem
13651
13652 Construct a `wx.GBSizerItem` for a sizer
13653 """
13654 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
13655 return val
13656
13657 def GBSizerItemSpacer(*args, **kwargs):
13658 """
13659 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13660 int flag, int border, PyObject userData=None) -> GBSizerItem
13661
13662 Construct a `wx.GBSizerItem` for a spacer.
13663 """
13664 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
13665 return val
13666
13667 class GridBagSizer(FlexGridSizer):
13668 """
13669 A `wx.Sizer` that can lay out items in a virtual grid like a
13670 `wx.FlexGridSizer` but in this case explicit positioning of the items
13671 is allowed using `wx.GBPosition`, and items can optionally span more
13672 than one row and/or column using `wx.GBSpan`. The total size of the
13673 virtual grid is determined by the largest row and column that items are
13674 positioned at, adjusted for spanning.
13675
13676 """
13677 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13678 __repr__ = _swig_repr
13679 def __init__(self, *args, **kwargs):
13680 """
13681 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13682
13683 Constructor, with optional parameters to specify the gap between the
13684 rows and columns.
13685 """
13686 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
13687 self._setOORInfo(self)
13688
13689 def Add(*args, **kwargs):
13690 """
13691 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13692 int border=0, userData=None) -> wx.GBSizerItem
13693
13694 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13695 more than one row or column as specified with *span*. The remaining
13696 args behave similarly to `wx.Sizer.Add`.
13697
13698 Returns True if the item was successfully placed at the given cell
13699 position, False if something was already there.
13700
13701 """
13702 return _core_.GridBagSizer_Add(*args, **kwargs)
13703
13704 def AddItem(*args, **kwargs):
13705 """
13706 Add(self, GBSizerItem item) -> wx.GBSizerItem
13707
13708 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13709 the item was successfully placed at its given cell position, False if
13710 something was already there.
13711 """
13712 return _core_.GridBagSizer_AddItem(*args, **kwargs)
13713
13714 def GetCellSize(*args, **kwargs):
13715 """
13716 GetCellSize(self, int row, int col) -> Size
13717
13718 Get the size of the specified cell, including hgap and
13719 vgap. Only valid after a Layout.
13720 """
13721 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13722
13723 def GetEmptyCellSize(*args, **kwargs):
13724 """
13725 GetEmptyCellSize(self) -> Size
13726
13727 Get the size used for cells in the grid with no item.
13728 """
13729 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
13730
13731 def SetEmptyCellSize(*args, **kwargs):
13732 """
13733 SetEmptyCellSize(self, Size sz)
13734
13735 Set the size used for cells in the grid with no item.
13736 """
13737 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
13738
13739 def GetItemPosition(*args):
13740 """
13741 GetItemPosition(self, item) -> GBPosition
13742
13743 Get the grid position of the specified *item* where *item* is either a
13744 window or subsizer that is a member of this sizer, or a zero-based
13745 index of an item.
13746 """
13747 return _core_.GridBagSizer_GetItemPosition(*args)
13748
13749 def SetItemPosition(*args):
13750 """
13751 SetItemPosition(self, item, GBPosition pos) -> bool
13752
13753 Set the grid position of the specified *item* where *item* is either a
13754 window or subsizer that is a member of this sizer, or a zero-based
13755 index of an item. Returns True on success. If the move is not
13756 allowed (because an item is already there) then False is returned.
13757
13758 """
13759 return _core_.GridBagSizer_SetItemPosition(*args)
13760
13761 def GetItemSpan(*args):
13762 """
13763 GetItemSpan(self, item) -> GBSpan
13764
13765 Get the row/col spanning of the specified *item* where *item* is
13766 either a window or subsizer that is a member of this sizer, or a
13767 zero-based index of an item.
13768 """
13769 return _core_.GridBagSizer_GetItemSpan(*args)
13770
13771 def SetItemSpan(*args):
13772 """
13773 SetItemSpan(self, item, GBSpan span) -> bool
13774
13775 Set the row/col spanning of the specified *item* where *item* is
13776 either a window or subsizer that is a member of this sizer, or a
13777 zero-based index of an item. Returns True on success. If the move is
13778 not allowed (because an item is already there) then False is returned.
13779 """
13780 return _core_.GridBagSizer_SetItemSpan(*args)
13781
13782 def FindItem(*args):
13783 """
13784 FindItem(self, item) -> GBSizerItem
13785
13786 Find the sizer item for the given window or subsizer, returns None if
13787 not found. (non-recursive)
13788 """
13789 return _core_.GridBagSizer_FindItem(*args)
13790
13791 def GetItem(self, item):
13792 gbsi = None
13793 si = wx.FlexGridSizer.GetItem(self, item)
13794 if not si:
13795 return None
13796 if type(item) is not int:
13797 gbsi = self.FindItem(item)
13798 if gbsi: return gbsi
13799 return si
13800
13801 def FindItemAtPosition(*args, **kwargs):
13802 """
13803 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13804
13805 Return the sizer item for the given grid cell, or None if there is no
13806 item at that position. (non-recursive)
13807 """
13808 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13809
13810 def FindItemAtPoint(*args, **kwargs):
13811 """
13812 FindItemAtPoint(self, Point pt) -> GBSizerItem
13813
13814 Return the sizer item located at the point given in *pt*, or None if
13815 there is no item at that point. The (x,y) coordinates in pt correspond
13816 to the client coordinates of the window using the sizer for
13817 layout. (non-recursive)
13818 """
13819 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13820
13821 def CheckForIntersection(*args, **kwargs):
13822 """
13823 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13824
13825 Look at all items and see if any intersect (or would overlap) the
13826 given *item*. Returns True if so, False if there would be no overlap.
13827 If an *excludeItem* is given then it will not be checked for
13828 intersection, for example it may be the item we are checking the
13829 position of.
13830
13831 """
13832 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
13833
13834 def CheckForIntersectionPos(*args, **kwargs):
13835 """
13836 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13837
13838 Look at all items and see if any intersect (or would overlap) the
13839 given position and span. Returns True if so, False if there would be
13840 no overlap. If an *excludeItem* is given then it will not be checked
13841 for intersection, for example it may be the item we are checking the
13842 position of.
13843 """
13844 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13845
13846 _core_.GridBagSizer_swigregister(GridBagSizer)
13847
13848 #---------------------------------------------------------------------------
13849
13850 Left = _core_.Left
13851 Top = _core_.Top
13852 Right = _core_.Right
13853 Bottom = _core_.Bottom
13854 Width = _core_.Width
13855 Height = _core_.Height
13856 Centre = _core_.Centre
13857 Center = _core_.Center
13858 CentreX = _core_.CentreX
13859 CentreY = _core_.CentreY
13860 Unconstrained = _core_.Unconstrained
13861 AsIs = _core_.AsIs
13862 PercentOf = _core_.PercentOf
13863 Above = _core_.Above
13864 Below = _core_.Below
13865 LeftOf = _core_.LeftOf
13866 RightOf = _core_.RightOf
13867 SameAs = _core_.SameAs
13868 Absolute = _core_.Absolute
13869 class IndividualLayoutConstraint(Object):
13870 """
13871 Objects of this class are stored in the `wx.LayoutConstraints` class as
13872 one of eight possible constraints that a window can be involved in.
13873 You will never need to create an instance of
13874 wx.IndividualLayoutConstraint, rather you should create a
13875 `wx.LayoutConstraints` instance and use the individual contstraints
13876 that it contains.
13877 """
13878 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13879 def __init__(self): raise AttributeError, "No constructor defined"
13880 __repr__ = _swig_repr
13881 def Set(*args, **kwargs):
13882 """
13883 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13884
13885 Sets the properties of the constraint. Normally called by one of the
13886 convenience functions such as Above, RightOf, SameAs.
13887 """
13888 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13889
13890 def LeftOf(*args, **kwargs):
13891 """
13892 LeftOf(self, Window sibling, int marg=0)
13893
13894 Constrains this edge to be to the left of the given window, with an
13895 optional margin. Implicitly, this is relative to the left edge of the
13896 other window.
13897 """
13898 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13899
13900 def RightOf(*args, **kwargs):
13901 """
13902 RightOf(self, Window sibling, int marg=0)
13903
13904 Constrains this edge to be to the right of the given window, with an
13905 optional margin. Implicitly, this is relative to the right edge of the
13906 other window.
13907 """
13908 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13909
13910 def Above(*args, **kwargs):
13911 """
13912 Above(self, Window sibling, int marg=0)
13913
13914 Constrains this edge to be above the given window, with an optional
13915 margin. Implicitly, this is relative to the top edge of the other
13916 window.
13917 """
13918 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13919
13920 def Below(*args, **kwargs):
13921 """
13922 Below(self, Window sibling, int marg=0)
13923
13924 Constrains this edge to be below the given window, with an optional
13925 margin. Implicitly, this is relative to the bottom edge of the other
13926 window.
13927 """
13928 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13929
13930 def SameAs(*args, **kwargs):
13931 """
13932 SameAs(self, Window otherW, int edge, int marg=0)
13933
13934 Constrains this edge or dimension to be to the same as the edge of the
13935 given window, with an optional margin.
13936 """
13937 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13938
13939 def PercentOf(*args, **kwargs):
13940 """
13941 PercentOf(self, Window otherW, int wh, int per)
13942
13943 Constrains this edge or dimension to be to a percentage of the given
13944 window, with an optional margin.
13945 """
13946 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13947
13948 def Absolute(*args, **kwargs):
13949 """
13950 Absolute(self, int val)
13951
13952 Constrains this edge or dimension to be the given absolute value.
13953 """
13954 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13955
13956 def Unconstrained(*args, **kwargs):
13957 """
13958 Unconstrained(self)
13959
13960 Sets this edge or dimension to be unconstrained, that is, dependent on
13961 other edges and dimensions from which this value can be deduced.
13962 """
13963 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13964
13965 def AsIs(*args, **kwargs):
13966 """
13967 AsIs(self)
13968
13969 Sets this edge or constraint to be whatever the window's value is at
13970 the moment. If either of the width and height constraints are *as is*,
13971 the window will not be resized, but moved instead. This is important
13972 when considering panel items which are intended to have a default
13973 size, such as a button, which may take its size from the size of the
13974 button label.
13975 """
13976 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13977
13978 def GetOtherWindow(*args, **kwargs):
13979 """GetOtherWindow(self) -> Window"""
13980 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13981
13982 def GetMyEdge(*args, **kwargs):
13983 """GetMyEdge(self) -> int"""
13984 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13985
13986 def SetEdge(*args, **kwargs):
13987 """SetEdge(self, int which)"""
13988 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13989
13990 def SetValue(*args, **kwargs):
13991 """SetValue(self, int v)"""
13992 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13993
13994 def GetMargin(*args, **kwargs):
13995 """GetMargin(self) -> int"""
13996 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13997
13998 def SetMargin(*args, **kwargs):
13999 """SetMargin(self, int m)"""
14000 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
14001
14002 def GetValue(*args, **kwargs):
14003 """GetValue(self) -> int"""
14004 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
14005
14006 def GetPercent(*args, **kwargs):
14007 """GetPercent(self) -> int"""
14008 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
14009
14010 def GetOtherEdge(*args, **kwargs):
14011 """GetOtherEdge(self) -> int"""
14012 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
14013
14014 def GetDone(*args, **kwargs):
14015 """GetDone(self) -> bool"""
14016 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
14017
14018 def SetDone(*args, **kwargs):
14019 """SetDone(self, bool d)"""
14020 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
14021
14022 def GetRelationship(*args, **kwargs):
14023 """GetRelationship(self) -> int"""
14024 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
14025
14026 def SetRelationship(*args, **kwargs):
14027 """SetRelationship(self, int r)"""
14028 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
14029
14030 def ResetIfWin(*args, **kwargs):
14031 """
14032 ResetIfWin(self, Window otherW) -> bool
14033
14034 Reset constraint if it mentions otherWin
14035 """
14036 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
14037
14038 def SatisfyConstraint(*args, **kwargs):
14039 """
14040 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
14041
14042 Try to satisfy constraint
14043 """
14044 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
14045
14046 def GetEdge(*args, **kwargs):
14047 """
14048 GetEdge(self, int which, Window thisWin, Window other) -> int
14049
14050 Get the value of this edge or dimension, or if this
14051 is not determinable, -1.
14052 """
14053 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
14054
14055 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
14056 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
14057 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
14058 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
14059 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
14060 Percent = property(GetPercent,doc="See `GetPercent`")
14061 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
14062 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
14063 _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
14064
14065 class LayoutConstraints(Object):
14066 """
14067 **Note:** constraints are now deprecated and you should use sizers
14068 instead.
14069
14070 Objects of this class can be associated with a window to define its
14071 layout constraints, with respect to siblings or its parent.
14072
14073 The class consists of the following eight constraints of class
14074 wx.IndividualLayoutConstraint, some or all of which should be accessed
14075 directly to set the appropriate constraints.
14076
14077 * left: represents the left hand edge of the window
14078 * right: represents the right hand edge of the window
14079 * top: represents the top edge of the window
14080 * bottom: represents the bottom edge of the window
14081 * width: represents the width of the window
14082 * height: represents the height of the window
14083 * centreX: represents the horizontal centre point of the window
14084 * centreY: represents the vertical centre point of the window
14085
14086 Most constraints are initially set to have the relationship
14087 wxUnconstrained, which means that their values should be calculated by
14088 looking at known constraints. The exceptions are width and height,
14089 which are set to wxAsIs to ensure that if the user does not specify a
14090 constraint, the existing width and height will be used, to be
14091 compatible with panel items which often have take a default size. If
14092 the constraint is ``wx.AsIs``, the dimension will not be changed.
14093
14094 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
14095
14096 """
14097 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
14098 __repr__ = _swig_repr
14099 left = property(_core_.LayoutConstraints_left_get)
14100 top = property(_core_.LayoutConstraints_top_get)
14101 right = property(_core_.LayoutConstraints_right_get)
14102 bottom = property(_core_.LayoutConstraints_bottom_get)
14103 width = property(_core_.LayoutConstraints_width_get)
14104 height = property(_core_.LayoutConstraints_height_get)
14105 centreX = property(_core_.LayoutConstraints_centreX_get)
14106 centreY = property(_core_.LayoutConstraints_centreY_get)
14107 def __init__(self, *args, **kwargs):
14108 """__init__(self) -> LayoutConstraints"""
14109 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
14110 __swig_destroy__ = _core_.delete_LayoutConstraints
14111 __del__ = lambda self : None;
14112 def SatisfyConstraints(*args, **kwargs):
14113 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
14114 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
14115
14116 def AreSatisfied(*args, **kwargs):
14117 """AreSatisfied(self) -> bool"""
14118 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
14119
14120 _core_.LayoutConstraints_swigregister(LayoutConstraints)
14121
14122 #----------------------------------------------------------------------------
14123
14124 # Use Python's bool constants if available, make some if not
14125 try:
14126 True
14127 except NameError:
14128 __builtins__.True = 1==1
14129 __builtins__.False = 1==0
14130 def bool(value): return not not value
14131 __builtins__.bool = bool
14132
14133
14134
14135 # workarounds for bad wxRTTI names
14136 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
14137 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
14138 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
14139
14140
14141 #----------------------------------------------------------------------------
14142 # Load version numbers from __version__... Ensure that major and minor
14143 # versions are the same for both wxPython and wxWidgets.
14144
14145 from __version__ import *
14146 __version__ = VERSION_STRING
14147
14148 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
14149 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
14150 if RELEASE_VERSION != _core_.RELEASE_VERSION:
14151 import warnings
14152 warnings.warn("wxPython/wxWidgets release number mismatch")
14153
14154
14155 def version():
14156 """Returns a string containing version and port info"""
14157 ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
14158 if wx.Platform == '__WXMSW__':
14159 port = 'msw'
14160 elif wx.Platform == '__WXMAC__':
14161 port = 'mac'
14162 elif wx.Platform == '__WXGTK__':
14163 port = 'gtk'
14164 if 'gtk2' in wx.PlatformInfo:
14165 port = 'gtk2'
14166 else:
14167 port = '?'
14168
14169 return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
14170
14171
14172 #----------------------------------------------------------------------------
14173
14174 # Set wxPython's default string<-->unicode conversion encoding from
14175 # the locale, but only if Python's default hasn't been changed. (We
14176 # assume that if the user has customized it already then that is the
14177 # encoding we need to use as well.)
14178 #
14179 # The encoding selected here is used when string or unicode objects
14180 # need to be converted in order to pass them to wxWidgets. Please be
14181 # aware that the default encoding within the same locale may be
14182 # slightly different on different platforms. For example, please see
14183 # http://www.alanwood.net/demos/charsetdiffs.html for differences
14184 # between the common latin/roman encodings.
14185
14186 default = _sys.getdefaultencoding()
14187 if default == 'ascii':
14188 import locale
14189 import codecs
14190 try:
14191 if hasattr(locale, 'getpreferredencoding'):
14192 default = locale.getpreferredencoding()
14193 else:
14194 default = locale.getdefaultlocale()[1]
14195 codecs.lookup(default)
14196 except (ValueError, LookupError, TypeError):
14197 default = _sys.getdefaultencoding()
14198 del locale
14199 del codecs
14200 if default:
14201 wx.SetDefaultPyEncoding(default)
14202 del default
14203
14204 #----------------------------------------------------------------------------
14205
14206 class PyDeadObjectError(AttributeError):
14207 pass
14208
14209 class _wxPyDeadObject(object):
14210 """
14211 Instances of wx objects that are OOR capable will have their __class__
14212 changed to this class when the C++ object is deleted. This should help
14213 prevent crashes due to referencing a bogus C++ pointer.
14214 """
14215 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
14216 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
14217
14218 def __repr__(self):
14219 if not hasattr(self, "_name"):
14220 self._name = "[unknown]"
14221 return self.reprStr % self._name
14222
14223 def __getattr__(self, *args):
14224 if not hasattr(self, "_name"):
14225 self._name = "[unknown]"
14226 raise PyDeadObjectError(self.attrStr % self._name)
14227
14228 def __nonzero__(self):
14229 return 0
14230
14231
14232
14233 class PyUnbornObjectError(AttributeError):
14234 pass
14235
14236 class _wxPyUnbornObject(object):
14237 """
14238 Some stock objects are created when the wx._core module is
14239 imported, but their C++ instance is not created until the wx.App
14240 object is created and initialized. These object instances will
14241 temporarily have their __class__ changed to this class so an
14242 exception will be raised if they are used before the C++ instance
14243 is ready.
14244 """
14245
14246 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
14247 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
14248
14249 def __repr__(self):
14250 #if not hasattr(self, "_name"):
14251 # self._name = "[unknown]"
14252 return self.reprStr #% self._name
14253
14254 def __getattr__(self, *args):
14255 #if not hasattr(self, "_name"):
14256 # self._name = "[unknown]"
14257 raise PyUnbornObjectError(self.attrStr) # % self._name )
14258
14259 def __nonzero__(self):
14260 return 0
14261
14262
14263 #----------------------------------------------------------------------------
14264
14265 def CallAfter(callable, *args, **kw):
14266 """
14267 Call the specified function after the current and pending event
14268 handlers have been completed. This is also good for making GUI
14269 method calls from non-GUI threads. Any extra positional or
14270 keyword args are passed on to the callable when it is called.
14271
14272 :see: `wx.CallLater`
14273 """
14274 app = wx.GetApp()
14275 assert app is not None, 'No wx.App created yet'
14276
14277 if not hasattr(app, "_CallAfterId"):
14278 app._CallAfterId = wx.NewEventType()
14279 app.Connect(-1, -1, app._CallAfterId,
14280 lambda event: event.callable(*event.args, **event.kw) )
14281 evt = wx.PyEvent()
14282 evt.SetEventType(app._CallAfterId)
14283 evt.callable = callable
14284 evt.args = args
14285 evt.kw = kw
14286 wx.PostEvent(app, evt)
14287
14288 #----------------------------------------------------------------------------
14289
14290
14291 class CallLater:
14292 """
14293 A convenience class for `wx.Timer`, that calls the given callable
14294 object once after the given amount of milliseconds, passing any
14295 positional or keyword args. The return value of the callable is
14296 availbale after it has been run with the `GetResult` method.
14297
14298 If you don't need to get the return value or restart the timer
14299 then there is no need to hold a reference to this object. It will
14300 hold a reference to itself while the timer is running (the timer
14301 has a reference to self.Notify) but the cycle will be broken when
14302 the timer completes, automatically cleaning up the wx.CallLater
14303 object.
14304
14305 :see: `wx.CallAfter`
14306 """
14307 def __init__(self, millis, callable, *args, **kwargs):
14308 self.millis = millis
14309 self.callable = callable
14310 self.SetArgs(*args, **kwargs)
14311 self.runCount = 0
14312 self.running = False
14313 self.hasRun = False
14314 self.result = None
14315 self.timer = None
14316 self.Start()
14317
14318 def __del__(self):
14319 self.Stop()
14320
14321
14322 def Start(self, millis=None, *args, **kwargs):
14323 """
14324 (Re)start the timer
14325 """
14326 self.hasRun = False
14327 if millis is not None:
14328 self.millis = millis
14329 if args or kwargs:
14330 self.SetArgs(*args, **kwargs)
14331 self.Stop()
14332 self.timer = wx.PyTimer(self.Notify)
14333 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
14334 self.running = True
14335 Restart = Start
14336
14337
14338 def Stop(self):
14339 """
14340 Stop and destroy the timer.
14341 """
14342 if self.timer is not None:
14343 self.timer.Stop()
14344 self.timer = None
14345
14346
14347 def GetInterval(self):
14348 if self.timer is not None:
14349 return self.timer.GetInterval()
14350 else:
14351 return 0
14352
14353
14354 def IsRunning(self):
14355 return self.timer is not None and self.timer.IsRunning()
14356
14357
14358 def SetArgs(self, *args, **kwargs):
14359 """
14360 (Re)set the args passed to the callable object. This is
14361 useful in conjunction with Restart if you want to schedule a
14362 new call to the same callable object but with different
14363 parameters.
14364 """
14365 self.args = args
14366 self.kwargs = kwargs
14367
14368
14369 def HasRun(self):
14370 return self.hasRun
14371
14372 def GetResult(self):
14373 return self.result
14374
14375 def Notify(self):
14376 """
14377 The timer has expired so call the callable.
14378 """
14379 if self.callable and getattr(self.callable, 'im_self', True):
14380 self.runCount += 1
14381 self.running = False
14382 self.result = self.callable(*self.args, **self.kwargs)
14383 self.hasRun = True
14384 if not self.running:
14385 # if it wasn't restarted, then cleanup
14386 wx.CallAfter(self.Stop)
14387
14388 Interval = property(GetInterval)
14389 Result = property(GetResult)
14390
14391
14392 class FutureCall(CallLater):
14393 """A compatibility alias for `CallLater`."""
14394
14395 #----------------------------------------------------------------------------
14396 # Control which items in this module should be documented by epydoc.
14397 # We allow only classes and functions, which will help reduce the size
14398 # of the docs by filtering out the zillions of constants, EVT objects,
14399 # and etc that don't make much sense by themselves, but are instead
14400 # documented (or will be) as part of the classes/functions/methods
14401 # where they should be used.
14402
14403 class __DocFilter:
14404 """
14405 A filter for epydoc that only allows non-Ptr classes and
14406 functions, in order to reduce the clutter in the API docs.
14407 """
14408 def __init__(self, globals):
14409 self._globals = globals
14410
14411 def __call__(self, name):
14412 import types
14413 obj = self._globals.get(name, None)
14414
14415 # only document classes and function
14416 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
14417 return False
14418
14419 # skip other things that are private or will be documented as part of somethign else
14420 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
14421 return False
14422
14423 # skip functions that are duplicates of static functions in a class
14424 if name.find('_') != -1:
14425 cls = self._globals.get(name.split('_')[0], None)
14426 methname = name.split('_')[1]
14427 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
14428 return False
14429
14430 return True
14431
14432 #----------------------------------------------------------------------------
14433 #----------------------------------------------------------------------------
14434
14435 # Import other modules in this package that should show up in the
14436 # "core" wx namespace
14437 from _gdi import *
14438 from _windows import *
14439 from _controls import *
14440 from _misc import *
14441
14442 #----------------------------------------------------------------------------
14443 #----------------------------------------------------------------------------
14444
14445
14446