]> git.saurik.com Git - wxWidgets.git/blame_incremental - wxPython/src/mac/_core.py
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Some more details about CollapsiblePane
[wxWidgets.git] / wxPython / src / mac / _core.py
... / ...
CommitLineData
1# This file was created automatically by SWIG 1.3.29.
2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
5import new
6new_instancemethod = new.instancemethod
7def _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
20def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
23def _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
29def _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
34import types
35try:
36 _object = types.ObjectType
37 _newclass = 1
38except AttributeError:
39 class _object : pass
40 _newclass = 0
41del types
42
43
44def _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.
60import sys as _sys
61wx = _sys.modules[__name__]
62
63
64#----------------------------------------------------------------------------
65
66def _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
83NOT_FOUND = _core_.NOT_FOUND
84VSCROLL = _core_.VSCROLL
85HSCROLL = _core_.HSCROLL
86CAPTION = _core_.CAPTION
87DOUBLE_BORDER = _core_.DOUBLE_BORDER
88SUNKEN_BORDER = _core_.SUNKEN_BORDER
89RAISED_BORDER = _core_.RAISED_BORDER
90BORDER = _core_.BORDER
91SIMPLE_BORDER = _core_.SIMPLE_BORDER
92STATIC_BORDER = _core_.STATIC_BORDER
93TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
94NO_BORDER = _core_.NO_BORDER
95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
97TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
98WANTS_CHARS = _core_.WANTS_CHARS
99POPUP_WINDOW = _core_.POPUP_WINDOW
100CENTER_FRAME = _core_.CENTER_FRAME
101CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
102CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
106ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
107RETAINED = _core_.RETAINED
108BACKINGSTORE = _core_.BACKINGSTORE
109COLOURED = _core_.COLOURED
110FIXED_LENGTH = _core_.FIXED_LENGTH
111LB_NEEDED_SB = _core_.LB_NEEDED_SB
112LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
113LB_SORT = _core_.LB_SORT
114LB_SINGLE = _core_.LB_SINGLE
115LB_MULTIPLE = _core_.LB_MULTIPLE
116LB_EXTENDED = _core_.LB_EXTENDED
117LB_OWNERDRAW = _core_.LB_OWNERDRAW
118LB_HSCROLL = _core_.LB_HSCROLL
119PROCESS_ENTER = _core_.PROCESS_ENTER
120PASSWORD = _core_.PASSWORD
121CB_SIMPLE = _core_.CB_SIMPLE
122CB_DROPDOWN = _core_.CB_DROPDOWN
123CB_SORT = _core_.CB_SORT
124CB_READONLY = _core_.CB_READONLY
125RA_HORIZONTAL = _core_.RA_HORIZONTAL
126RA_VERTICAL = _core_.RA_VERTICAL
127RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
128RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
129RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
135ST_SIZEGRIP = _core_.ST_SIZEGRIP
136ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
137ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
138ST_DOTS_END = _core_.ST_DOTS_END
139FLOOD_SURFACE = _core_.FLOOD_SURFACE
140FLOOD_BORDER = _core_.FLOOD_BORDER
141ODDEVEN_RULE = _core_.ODDEVEN_RULE
142WINDING_RULE = _core_.WINDING_RULE
143TOOL_TOP = _core_.TOOL_TOP
144TOOL_BOTTOM = _core_.TOOL_BOTTOM
145TOOL_LEFT = _core_.TOOL_LEFT
146TOOL_RIGHT = _core_.TOOL_RIGHT
147OK = _core_.OK
148YES_NO = _core_.YES_NO
149CANCEL = _core_.CANCEL
150YES = _core_.YES
151NO = _core_.NO
152NO_DEFAULT = _core_.NO_DEFAULT
153YES_DEFAULT = _core_.YES_DEFAULT
154ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
155ICON_HAND = _core_.ICON_HAND
156ICON_QUESTION = _core_.ICON_QUESTION
157ICON_INFORMATION = _core_.ICON_INFORMATION
158ICON_STOP = _core_.ICON_STOP
159ICON_ASTERISK = _core_.ICON_ASTERISK
160ICON_MASK = _core_.ICON_MASK
161ICON_WARNING = _core_.ICON_WARNING
162ICON_ERROR = _core_.ICON_ERROR
163FORWARD = _core_.FORWARD
164BACKWARD = _core_.BACKWARD
165RESET = _core_.RESET
166HELP = _core_.HELP
167MORE = _core_.MORE
168SETUP = _core_.SETUP
169SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
170SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
171SIZE_AUTO = _core_.SIZE_AUTO
172SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
173SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
174SIZE_FORCE = _core_.SIZE_FORCE
175PORTRAIT = _core_.PORTRAIT
176LANDSCAPE = _core_.LANDSCAPE
177PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
178PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
179PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
180PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
181ID_ANY = _core_.ID_ANY
182ID_SEPARATOR = _core_.ID_SEPARATOR
183ID_NONE = _core_.ID_NONE
184ID_LOWEST = _core_.ID_LOWEST
185ID_OPEN = _core_.ID_OPEN
186ID_CLOSE = _core_.ID_CLOSE
187ID_NEW = _core_.ID_NEW
188ID_SAVE = _core_.ID_SAVE
189ID_SAVEAS = _core_.ID_SAVEAS
190ID_REVERT = _core_.ID_REVERT
191ID_EXIT = _core_.ID_EXIT
192ID_UNDO = _core_.ID_UNDO
193ID_REDO = _core_.ID_REDO
194ID_HELP = _core_.ID_HELP
195ID_PRINT = _core_.ID_PRINT
196ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
197ID_PAGE_SETUP = _core_.ID_PAGE_SETUP
198ID_PREVIEW = _core_.ID_PREVIEW
199ID_ABOUT = _core_.ID_ABOUT
200ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
201ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
202ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
203ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
204ID_HELP_INDEX = _core_.ID_HELP_INDEX
205ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
208ID_EDIT = _core_.ID_EDIT
209ID_CUT = _core_.ID_CUT
210ID_COPY = _core_.ID_COPY
211ID_PASTE = _core_.ID_PASTE
212ID_CLEAR = _core_.ID_CLEAR
213ID_FIND = _core_.ID_FIND
214ID_DUPLICATE = _core_.ID_DUPLICATE
215ID_SELECTALL = _core_.ID_SELECTALL
216ID_DELETE = _core_.ID_DELETE
217ID_REPLACE = _core_.ID_REPLACE
218ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
219ID_PROPERTIES = _core_.ID_PROPERTIES
220ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
221ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
222ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
223ID_VIEW_LIST = _core_.ID_VIEW_LIST
224ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
225ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
226ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
227ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
228ID_FILE = _core_.ID_FILE
229ID_FILE1 = _core_.ID_FILE1
230ID_FILE2 = _core_.ID_FILE2
231ID_FILE3 = _core_.ID_FILE3
232ID_FILE4 = _core_.ID_FILE4
233ID_FILE5 = _core_.ID_FILE5
234ID_FILE6 = _core_.ID_FILE6
235ID_FILE7 = _core_.ID_FILE7
236ID_FILE8 = _core_.ID_FILE8
237ID_FILE9 = _core_.ID_FILE9
238ID_OK = _core_.ID_OK
239ID_CANCEL = _core_.ID_CANCEL
240ID_APPLY = _core_.ID_APPLY
241ID_YES = _core_.ID_YES
242ID_NO = _core_.ID_NO
243ID_STATIC = _core_.ID_STATIC
244ID_FORWARD = _core_.ID_FORWARD
245ID_BACKWARD = _core_.ID_BACKWARD
246ID_DEFAULT = _core_.ID_DEFAULT
247ID_MORE = _core_.ID_MORE
248ID_SETUP = _core_.ID_SETUP
249ID_RESET = _core_.ID_RESET
250ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
251ID_YESTOALL = _core_.ID_YESTOALL
252ID_NOTOALL = _core_.ID_NOTOALL
253ID_ABORT = _core_.ID_ABORT
254ID_RETRY = _core_.ID_RETRY
255ID_IGNORE = _core_.ID_IGNORE
256ID_ADD = _core_.ID_ADD
257ID_REMOVE = _core_.ID_REMOVE
258ID_UP = _core_.ID_UP
259ID_DOWN = _core_.ID_DOWN
260ID_HOME = _core_.ID_HOME
261ID_REFRESH = _core_.ID_REFRESH
262ID_STOP = _core_.ID_STOP
263ID_INDEX = _core_.ID_INDEX
264ID_BOLD = _core_.ID_BOLD
265ID_ITALIC = _core_.ID_ITALIC
266ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
267ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
268ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
269ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
270ID_UNDERLINE = _core_.ID_UNDERLINE
271ID_INDENT = _core_.ID_INDENT
272ID_UNINDENT = _core_.ID_UNINDENT
273ID_ZOOM_100 = _core_.ID_ZOOM_100
274ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
275ID_ZOOM_IN = _core_.ID_ZOOM_IN
276ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
277ID_UNDELETE = _core_.ID_UNDELETE
278ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
279ID_HIGHEST = _core_.ID_HIGHEST
280MENU_TEAROFF = _core_.MENU_TEAROFF
281MB_DOCKABLE = _core_.MB_DOCKABLE
282NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
283FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
284LI_HORIZONTAL = _core_.LI_HORIZONTAL
285LI_VERTICAL = _core_.LI_VERTICAL
286WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
287WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
288WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
289WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
290WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
291WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
292MM_TEXT = _core_.MM_TEXT
293MM_LOMETRIC = _core_.MM_LOMETRIC
294MM_HIMETRIC = _core_.MM_HIMETRIC
295MM_LOENGLISH = _core_.MM_LOENGLISH
296MM_HIENGLISH = _core_.MM_HIENGLISH
297MM_TWIPS = _core_.MM_TWIPS
298MM_ISOTROPIC = _core_.MM_ISOTROPIC
299MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
300MM_POINTS = _core_.MM_POINTS
301MM_METRIC = _core_.MM_METRIC
302CENTRE = _core_.CENTRE
303CENTER = _core_.CENTER
304HORIZONTAL = _core_.HORIZONTAL
305VERTICAL = _core_.VERTICAL
306BOTH = _core_.BOTH
307LEFT = _core_.LEFT
308RIGHT = _core_.RIGHT
309UP = _core_.UP
310DOWN = _core_.DOWN
311TOP = _core_.TOP
312BOTTOM = _core_.BOTTOM
313NORTH = _core_.NORTH
314SOUTH = _core_.SOUTH
315WEST = _core_.WEST
316EAST = _core_.EAST
317ALL = _core_.ALL
318ALIGN_NOT = _core_.ALIGN_NOT
319ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
320ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
321ALIGN_LEFT = _core_.ALIGN_LEFT
322ALIGN_TOP = _core_.ALIGN_TOP
323ALIGN_RIGHT = _core_.ALIGN_RIGHT
324ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
325ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
326ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
327ALIGN_CENTER = _core_.ALIGN_CENTER
328ALIGN_CENTRE = _core_.ALIGN_CENTRE
329ALIGN_MASK = _core_.ALIGN_MASK
330STRETCH_NOT = _core_.STRETCH_NOT
331SHRINK = _core_.SHRINK
332GROW = _core_.GROW
333EXPAND = _core_.EXPAND
334SHAPED = _core_.SHAPED
335FIXED_MINSIZE = _core_.FIXED_MINSIZE
336TILE = _core_.TILE
337ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
338BORDER_DEFAULT = _core_.BORDER_DEFAULT
339BORDER_NONE = _core_.BORDER_NONE
340BORDER_STATIC = _core_.BORDER_STATIC
341BORDER_SIMPLE = _core_.BORDER_SIMPLE
342BORDER_RAISED = _core_.BORDER_RAISED
343BORDER_SUNKEN = _core_.BORDER_SUNKEN
344BORDER_DOUBLE = _core_.BORDER_DOUBLE
345BORDER_MASK = _core_.BORDER_MASK
346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
349DEFAULT = _core_.DEFAULT
350DECORATIVE = _core_.DECORATIVE
351ROMAN = _core_.ROMAN
352SCRIPT = _core_.SCRIPT
353SWISS = _core_.SWISS
354MODERN = _core_.MODERN
355TELETYPE = _core_.TELETYPE
356VARIABLE = _core_.VARIABLE
357FIXED = _core_.FIXED
358NORMAL = _core_.NORMAL
359LIGHT = _core_.LIGHT
360BOLD = _core_.BOLD
361ITALIC = _core_.ITALIC
362SLANT = _core_.SLANT
363SOLID = _core_.SOLID
364DOT = _core_.DOT
365LONG_DASH = _core_.LONG_DASH
366SHORT_DASH = _core_.SHORT_DASH
367DOT_DASH = _core_.DOT_DASH
368USER_DASH = _core_.USER_DASH
369TRANSPARENT = _core_.TRANSPARENT
370STIPPLE = _core_.STIPPLE
371STIPPLE_MASK = _core_.STIPPLE_MASK
372STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
373BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376CROSS_HATCH = _core_.CROSS_HATCH
377HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378VERTICAL_HATCH = _core_.VERTICAL_HATCH
379JOIN_BEVEL = _core_.JOIN_BEVEL
380JOIN_MITER = _core_.JOIN_MITER
381JOIN_ROUND = _core_.JOIN_ROUND
382CAP_ROUND = _core_.CAP_ROUND
383CAP_PROJECTING = _core_.CAP_PROJECTING
384CAP_BUTT = _core_.CAP_BUTT
385CLEAR = _core_.CLEAR
386XOR = _core_.XOR
387INVERT = _core_.INVERT
388OR_REVERSE = _core_.OR_REVERSE
389AND_REVERSE = _core_.AND_REVERSE
390COPY = _core_.COPY
391AND = _core_.AND
392AND_INVERT = _core_.AND_INVERT
393NO_OP = _core_.NO_OP
394NOR = _core_.NOR
395EQUIV = _core_.EQUIV
396SRC_INVERT = _core_.SRC_INVERT
397OR_INVERT = _core_.OR_INVERT
398NAND = _core_.NAND
399OR = _core_.OR
400SET = _core_.SET
401WXK_BACK = _core_.WXK_BACK
402WXK_TAB = _core_.WXK_TAB
403WXK_RETURN = _core_.WXK_RETURN
404WXK_ESCAPE = _core_.WXK_ESCAPE
405WXK_SPACE = _core_.WXK_SPACE
406WXK_DELETE = _core_.WXK_DELETE
407WXK_START = _core_.WXK_START
408WXK_LBUTTON = _core_.WXK_LBUTTON
409WXK_RBUTTON = _core_.WXK_RBUTTON
410WXK_CANCEL = _core_.WXK_CANCEL
411WXK_MBUTTON = _core_.WXK_MBUTTON
412WXK_CLEAR = _core_.WXK_CLEAR
413WXK_SHIFT = _core_.WXK_SHIFT
414WXK_ALT = _core_.WXK_ALT
415WXK_CONTROL = _core_.WXK_CONTROL
416WXK_MENU = _core_.WXK_MENU
417WXK_PAUSE = _core_.WXK_PAUSE
418WXK_CAPITAL = _core_.WXK_CAPITAL
419WXK_PRIOR = _core_.WXK_PRIOR
420WXK_NEXT = _core_.WXK_NEXT
421WXK_END = _core_.WXK_END
422WXK_HOME = _core_.WXK_HOME
423WXK_LEFT = _core_.WXK_LEFT
424WXK_UP = _core_.WXK_UP
425WXK_RIGHT = _core_.WXK_RIGHT
426WXK_DOWN = _core_.WXK_DOWN
427WXK_SELECT = _core_.WXK_SELECT
428WXK_PRINT = _core_.WXK_PRINT
429WXK_EXECUTE = _core_.WXK_EXECUTE
430WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431WXK_INSERT = _core_.WXK_INSERT
432WXK_HELP = _core_.WXK_HELP
433WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443WXK_MULTIPLY = _core_.WXK_MULTIPLY
444WXK_ADD = _core_.WXK_ADD
445WXK_SEPARATOR = _core_.WXK_SEPARATOR
446WXK_SUBTRACT = _core_.WXK_SUBTRACT
447WXK_DECIMAL = _core_.WXK_DECIMAL
448WXK_DIVIDE = _core_.WXK_DIVIDE
449WXK_F1 = _core_.WXK_F1
450WXK_F2 = _core_.WXK_F2
451WXK_F3 = _core_.WXK_F3
452WXK_F4 = _core_.WXK_F4
453WXK_F5 = _core_.WXK_F5
454WXK_F6 = _core_.WXK_F6
455WXK_F7 = _core_.WXK_F7
456WXK_F8 = _core_.WXK_F8
457WXK_F9 = _core_.WXK_F9
458WXK_F10 = _core_.WXK_F10
459WXK_F11 = _core_.WXK_F11
460WXK_F12 = _core_.WXK_F12
461WXK_F13 = _core_.WXK_F13
462WXK_F14 = _core_.WXK_F14
463WXK_F15 = _core_.WXK_F15
464WXK_F16 = _core_.WXK_F16
465WXK_F17 = _core_.WXK_F17
466WXK_F18 = _core_.WXK_F18
467WXK_F19 = _core_.WXK_F19
468WXK_F20 = _core_.WXK_F20
469WXK_F21 = _core_.WXK_F21
470WXK_F22 = _core_.WXK_F22
471WXK_F23 = _core_.WXK_F23
472WXK_F24 = _core_.WXK_F24
473WXK_NUMLOCK = _core_.WXK_NUMLOCK
474WXK_SCROLL = _core_.WXK_SCROLL
475WXK_PAGEUP = _core_.WXK_PAGEUP
476WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
595PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
596PAPER_A6 = _core_.PAPER_A6
597PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
598PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
599PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
600PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
601PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
602PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
603PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
604PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
605PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
606PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
607PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
608PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
609PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
610PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
611PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
612PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
613PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
614PAPER_B6_JIS = _core_.PAPER_B6_JIS
615PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
616PAPER_12X11 = _core_.PAPER_12X11
617PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
618PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
619PAPER_P16K = _core_.PAPER_P16K
620PAPER_P32K = _core_.PAPER_P32K
621PAPER_P32KBIG = _core_.PAPER_P32KBIG
622PAPER_PENV_1 = _core_.PAPER_PENV_1
623PAPER_PENV_2 = _core_.PAPER_PENV_2
624PAPER_PENV_3 = _core_.PAPER_PENV_3
625PAPER_PENV_4 = _core_.PAPER_PENV_4
626PAPER_PENV_5 = _core_.PAPER_PENV_5
627PAPER_PENV_6 = _core_.PAPER_PENV_6
628PAPER_PENV_7 = _core_.PAPER_PENV_7
629PAPER_PENV_8 = _core_.PAPER_PENV_8
630PAPER_PENV_9 = _core_.PAPER_PENV_9
631PAPER_PENV_10 = _core_.PAPER_PENV_10
632PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
633PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
634PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
635PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
636PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
637PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
638PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
639PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
640PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
641PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
642PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
643PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
644PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
645DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
646DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
647DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
648ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
649ITEM_NORMAL = _core_.ITEM_NORMAL
650ITEM_CHECK = _core_.ITEM_CHECK
651ITEM_RADIO = _core_.ITEM_RADIO
652ITEM_MAX = _core_.ITEM_MAX
653HT_NOWHERE = _core_.HT_NOWHERE
654HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
655HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
656HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
657HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
658HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
659HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
660HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
661HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
662HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
663HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
664HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
665HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
666HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
667HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
668HT_MAX = _core_.HT_MAX
669MOD_NONE = _core_.MOD_NONE
670MOD_ALT = _core_.MOD_ALT
671MOD_CONTROL = _core_.MOD_CONTROL
672MOD_ALTGR = _core_.MOD_ALTGR
673MOD_SHIFT = _core_.MOD_SHIFT
674MOD_META = _core_.MOD_META
675MOD_WIN = _core_.MOD_WIN
676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
678UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
679UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
680UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
681Layout_Default = _core_.Layout_Default
682Layout_LeftToRight = _core_.Layout_LeftToRight
683Layout_RightToLeft = _core_.Layout_RightToLeft
684#---------------------------------------------------------------------------
685
686class Object(object):
687 """
688 The base class for most wx objects, although in wxPython not
689 much functionality is needed nor exposed.
690 """
691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
692 def __init__(self): raise AttributeError, "No constructor defined"
693 __repr__ = _swig_repr
694 def GetClassName(*args, **kwargs):
695 """
696 GetClassName(self) -> String
697
698 Returns the class name of the C++ class using wxRTTI.
699 """
700 return _core_.Object_GetClassName(*args, **kwargs)
701
702 def Destroy(*args, **kwargs):
703 """
704 Destroy(self)
705
706 Deletes the C++ object this Python object is a proxy for.
707 """
708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
710
711 def IsSameAs(*args, **kwargs):
712 """
713 IsSameAs(self, Object p) -> bool
714
715 For wx.Objects that use C++ reference counting internally, this method
716 can be used to determine if two objects are referencing the same data
717 object.
718 """
719 return _core_.Object_IsSameAs(*args, **kwargs)
720
721 ClassName = property(GetClassName,doc="See `GetClassName`")
722_core_.Object_swigregister(Object)
723_wxPySetDictionary = _core_._wxPySetDictionary
724cvar = _core_.cvar
725EmptyString = cvar.EmptyString
726
727#---------------------------------------------------------------------------
728
729BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
730BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
731BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
732BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
733BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
734BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
735BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
736BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
737BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
738BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
739BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
740BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
741BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
742BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
743BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
744BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
745BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
746BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
747BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
748BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
749BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
750CURSOR_NONE = _core_.CURSOR_NONE
751CURSOR_ARROW = _core_.CURSOR_ARROW
752CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
753CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
754CURSOR_CHAR = _core_.CURSOR_CHAR
755CURSOR_CROSS = _core_.CURSOR_CROSS
756CURSOR_HAND = _core_.CURSOR_HAND
757CURSOR_IBEAM = _core_.CURSOR_IBEAM
758CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
759CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
760CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
761CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
762CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
763CURSOR_PENCIL = _core_.CURSOR_PENCIL
764CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
765CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
766CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
767CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
768CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
769CURSOR_SIZENS = _core_.CURSOR_SIZENS
770CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
771CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
772CURSOR_SIZING = _core_.CURSOR_SIZING
773CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
774CURSOR_WAIT = _core_.CURSOR_WAIT
775CURSOR_WATCH = _core_.CURSOR_WATCH
776CURSOR_BLANK = _core_.CURSOR_BLANK
777CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
778CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
779CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
780CURSOR_MAX = _core_.CURSOR_MAX
781#---------------------------------------------------------------------------
782
783class Size(object):
784 """
785 wx.Size is a useful data structure used to represent the size of
786 something. It simply contains integer width and height
787 properties. In most places in wxPython where a wx.Size is
788 expected a (width, height) tuple can be used instead.
789 """
790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
791 __repr__ = _swig_repr
792 width = property(_core_.Size_width_get, _core_.Size_width_set)
793 height = property(_core_.Size_height_get, _core_.Size_height_set)
794 x = width; y = height
795 def __init__(self, *args, **kwargs):
796 """
797 __init__(self, int w=0, int h=0) -> Size
798
799 Creates a size object.
800 """
801 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
802 __swig_destroy__ = _core_.delete_Size
803 __del__ = lambda self : None;
804 def __eq__(*args, **kwargs):
805 """
806 __eq__(self, PyObject other) -> bool
807
808 Test for equality of wx.Size objects.
809 """
810 return _core_.Size___eq__(*args, **kwargs)
811
812 def __ne__(*args, **kwargs):
813 """
814 __ne__(self, PyObject other) -> bool
815
816 Test for inequality of wx.Size objects.
817 """
818 return _core_.Size___ne__(*args, **kwargs)
819
820 def __add__(*args, **kwargs):
821 """
822 __add__(self, Size sz) -> Size
823
824 Add sz's proprties to this and return the result.
825 """
826 return _core_.Size___add__(*args, **kwargs)
827
828 def __sub__(*args, **kwargs):
829 """
830 __sub__(self, Size sz) -> Size
831
832 Subtract sz's properties from this and return the result.
833 """
834 return _core_.Size___sub__(*args, **kwargs)
835
836 def IncTo(*args, **kwargs):
837 """
838 IncTo(self, Size sz)
839
840 Increments this object so that both of its dimensions are not less
841 than the corresponding dimensions of the size.
842 """
843 return _core_.Size_IncTo(*args, **kwargs)
844
845 def DecTo(*args, **kwargs):
846 """
847 DecTo(self, Size sz)
848
849 Decrements this object so that both of its dimensions are not greater
850 than the corresponding dimensions of the size.
851 """
852 return _core_.Size_DecTo(*args, **kwargs)
853
854 def IncBy(*args, **kwargs):
855 """IncBy(self, int dx, int dy)"""
856 return _core_.Size_IncBy(*args, **kwargs)
857
858 def DecBy(*args, **kwargs):
859 """DecBy(self, int dx, int dy)"""
860 return _core_.Size_DecBy(*args, **kwargs)
861
862 def Scale(*args, **kwargs):
863 """
864 Scale(self, float xscale, float yscale)
865
866 Scales the dimensions of this object by the given factors.
867 """
868 return _core_.Size_Scale(*args, **kwargs)
869
870 def Set(*args, **kwargs):
871 """
872 Set(self, int w, int h)
873
874 Set both width and height.
875 """
876 return _core_.Size_Set(*args, **kwargs)
877
878 def SetWidth(*args, **kwargs):
879 """SetWidth(self, int w)"""
880 return _core_.Size_SetWidth(*args, **kwargs)
881
882 def SetHeight(*args, **kwargs):
883 """SetHeight(self, int h)"""
884 return _core_.Size_SetHeight(*args, **kwargs)
885
886 def GetWidth(*args, **kwargs):
887 """GetWidth(self) -> int"""
888 return _core_.Size_GetWidth(*args, **kwargs)
889
890 def GetHeight(*args, **kwargs):
891 """GetHeight(self) -> int"""
892 return _core_.Size_GetHeight(*args, **kwargs)
893
894 def IsFullySpecified(*args, **kwargs):
895 """
896 IsFullySpecified(self) -> bool
897
898 Returns True if both components of the size are non-default values.
899 """
900 return _core_.Size_IsFullySpecified(*args, **kwargs)
901
902 def SetDefaults(*args, **kwargs):
903 """
904 SetDefaults(self, Size size)
905
906 Combine this size with the other one replacing the default components
907 of this object (i.e. equal to -1) with those of the other.
908 """
909 return _core_.Size_SetDefaults(*args, **kwargs)
910
911 def Get(*args, **kwargs):
912 """
913 Get() -> (width,height)
914
915 Returns the width and height properties as a tuple.
916 """
917 return _core_.Size_Get(*args, **kwargs)
918
919 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
920 def __str__(self): return str(self.Get())
921 def __repr__(self): return 'wx.Size'+str(self.Get())
922 def __len__(self): return len(self.Get())
923 def __getitem__(self, index): return self.Get()[index]
924 def __setitem__(self, index, val):
925 if index == 0: self.width = val
926 elif index == 1: self.height = val
927 else: raise IndexError
928 def __nonzero__(self): return self.Get() != (0,0)
929 __safe_for_unpickling__ = True
930 def __reduce__(self): return (wx.Size, self.Get())
931
932_core_.Size_swigregister(Size)
933
934#---------------------------------------------------------------------------
935
936class RealPoint(object):
937 """
938 A data structure for representing a point or position with floating
939 point x and y properties. In wxPython most places that expect a
940 wx.RealPoint can also accept a (x,y) tuple.
941 """
942 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
943 __repr__ = _swig_repr
944 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
945 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
946 def __init__(self, *args, **kwargs):
947 """
948 __init__(self, double x=0.0, double y=0.0) -> RealPoint
949
950 Create a wx.RealPoint object
951 """
952 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
953 __swig_destroy__ = _core_.delete_RealPoint
954 __del__ = lambda self : None;
955 def __eq__(*args, **kwargs):
956 """
957 __eq__(self, PyObject other) -> bool
958
959 Test for equality of wx.RealPoint objects.
960 """
961 return _core_.RealPoint___eq__(*args, **kwargs)
962
963 def __ne__(*args, **kwargs):
964 """
965 __ne__(self, PyObject other) -> bool
966
967 Test for inequality of wx.RealPoint objects.
968 """
969 return _core_.RealPoint___ne__(*args, **kwargs)
970
971 def __add__(*args, **kwargs):
972 """
973 __add__(self, RealPoint pt) -> RealPoint
974
975 Add pt's proprties to this and return the result.
976 """
977 return _core_.RealPoint___add__(*args, **kwargs)
978
979 def __sub__(*args, **kwargs):
980 """
981 __sub__(self, RealPoint pt) -> RealPoint
982
983 Subtract pt's proprties from this and return the result
984 """
985 return _core_.RealPoint___sub__(*args, **kwargs)
986
987 def Set(*args, **kwargs):
988 """
989 Set(self, double x, double y)
990
991 Set both the x and y properties
992 """
993 return _core_.RealPoint_Set(*args, **kwargs)
994
995 def Get(*args, **kwargs):
996 """
997 Get() -> (x,y)
998
999 Return the x and y properties as a tuple.
1000 """
1001 return _core_.RealPoint_Get(*args, **kwargs)
1002
1003 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1004 def __str__(self): return str(self.Get())
1005 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
1006 def __len__(self): return len(self.Get())
1007 def __getitem__(self, index): return self.Get()[index]
1008 def __setitem__(self, index, val):
1009 if index == 0: self.x = val
1010 elif index == 1: self.y = val
1011 else: raise IndexError
1012 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1013 __safe_for_unpickling__ = True
1014 def __reduce__(self): return (wx.RealPoint, self.Get())
1015
1016_core_.RealPoint_swigregister(RealPoint)
1017
1018#---------------------------------------------------------------------------
1019
1020class Point(object):
1021 """
1022 A data structure for representing a point or position with integer x
1023 and y properties. Most places in wxPython that expect a wx.Point can
1024 also accept a (x,y) tuple.
1025 """
1026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1027 __repr__ = _swig_repr
1028 x = property(_core_.Point_x_get, _core_.Point_x_set)
1029 y = property(_core_.Point_y_get, _core_.Point_y_set)
1030 def __init__(self, *args, **kwargs):
1031 """
1032 __init__(self, int x=0, int y=0) -> Point
1033
1034 Create a wx.Point object
1035 """
1036 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1037 __swig_destroy__ = _core_.delete_Point
1038 __del__ = lambda self : None;
1039 def __eq__(*args, **kwargs):
1040 """
1041 __eq__(self, PyObject other) -> bool
1042
1043 Test for equality of wx.Point objects.
1044 """
1045 return _core_.Point___eq__(*args, **kwargs)
1046
1047 def __ne__(*args, **kwargs):
1048 """
1049 __ne__(self, PyObject other) -> bool
1050
1051 Test for inequality of wx.Point objects.
1052 """
1053 return _core_.Point___ne__(*args, **kwargs)
1054
1055 def __add__(*args, **kwargs):
1056 """
1057 __add__(self, Point pt) -> Point
1058
1059 Add pt's proprties to this and return the result.
1060 """
1061 return _core_.Point___add__(*args, **kwargs)
1062
1063 def __sub__(*args, **kwargs):
1064 """
1065 __sub__(self, Point pt) -> Point
1066
1067 Subtract pt's proprties from this and return the result
1068 """
1069 return _core_.Point___sub__(*args, **kwargs)
1070
1071 def __iadd__(*args, **kwargs):
1072 """
1073 __iadd__(self, Point pt) -> Point
1074
1075 Add pt to this object.
1076 """
1077 return _core_.Point___iadd__(*args, **kwargs)
1078
1079 def __isub__(*args, **kwargs):
1080 """
1081 __isub__(self, Point pt) -> Point
1082
1083 Subtract pt from this object.
1084 """
1085 return _core_.Point___isub__(*args, **kwargs)
1086
1087 def Set(*args, **kwargs):
1088 """
1089 Set(self, long x, long y)
1090
1091 Set both the x and y properties
1092 """
1093 return _core_.Point_Set(*args, **kwargs)
1094
1095 def Get(*args, **kwargs):
1096 """
1097 Get() -> (x,y)
1098
1099 Return the x and y properties as a tuple.
1100 """
1101 return _core_.Point_Get(*args, **kwargs)
1102
1103 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1104 def __str__(self): return str(self.Get())
1105 def __repr__(self): return 'wx.Point'+str(self.Get())
1106 def __len__(self): return len(self.Get())
1107 def __getitem__(self, index): return self.Get()[index]
1108 def __setitem__(self, index, val):
1109 if index == 0: self.x = val
1110 elif index == 1: self.y = val
1111 else: raise IndexError
1112 def __nonzero__(self): return self.Get() != (0,0)
1113 __safe_for_unpickling__ = True
1114 def __reduce__(self): return (wx.Point, self.Get())
1115
1116_core_.Point_swigregister(Point)
1117
1118#---------------------------------------------------------------------------
1119
1120class Rect(object):
1121 """
1122 A class for representing and manipulating rectangles. It has x, y,
1123 width and height properties. In wxPython most palces that expect a
1124 wx.Rect can also accept a (x,y,width,height) tuple.
1125 """
1126 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1127 __repr__ = _swig_repr
1128 def __init__(self, *args, **kwargs):
1129 """
1130 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1131
1132 Create a new Rect object.
1133 """
1134 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1135 __swig_destroy__ = _core_.delete_Rect
1136 __del__ = lambda self : None;
1137 def GetX(*args, **kwargs):
1138 """GetX(self) -> int"""
1139 return _core_.Rect_GetX(*args, **kwargs)
1140
1141 def SetX(*args, **kwargs):
1142 """SetX(self, int x)"""
1143 return _core_.Rect_SetX(*args, **kwargs)
1144
1145 def GetY(*args, **kwargs):
1146 """GetY(self) -> int"""
1147 return _core_.Rect_GetY(*args, **kwargs)
1148
1149 def SetY(*args, **kwargs):
1150 """SetY(self, int y)"""
1151 return _core_.Rect_SetY(*args, **kwargs)
1152
1153 def GetWidth(*args, **kwargs):
1154 """GetWidth(self) -> int"""
1155 return _core_.Rect_GetWidth(*args, **kwargs)
1156
1157 def SetWidth(*args, **kwargs):
1158 """SetWidth(self, int w)"""
1159 return _core_.Rect_SetWidth(*args, **kwargs)
1160
1161 def GetHeight(*args, **kwargs):
1162 """GetHeight(self) -> int"""
1163 return _core_.Rect_GetHeight(*args, **kwargs)
1164
1165 def SetHeight(*args, **kwargs):
1166 """SetHeight(self, int h)"""
1167 return _core_.Rect_SetHeight(*args, **kwargs)
1168
1169 def GetPosition(*args, **kwargs):
1170 """GetPosition(self) -> Point"""
1171 return _core_.Rect_GetPosition(*args, **kwargs)
1172
1173 def SetPosition(*args, **kwargs):
1174 """SetPosition(self, Point p)"""
1175 return _core_.Rect_SetPosition(*args, **kwargs)
1176
1177 def GetSize(*args, **kwargs):
1178 """GetSize(self) -> Size"""
1179 return _core_.Rect_GetSize(*args, **kwargs)
1180
1181 def SetSize(*args, **kwargs):
1182 """SetSize(self, Size s)"""
1183 return _core_.Rect_SetSize(*args, **kwargs)
1184
1185 def IsEmpty(*args, **kwargs):
1186 """IsEmpty(self) -> bool"""
1187 return _core_.Rect_IsEmpty(*args, **kwargs)
1188
1189 def GetTopLeft(*args, **kwargs):
1190 """GetTopLeft(self) -> Point"""
1191 return _core_.Rect_GetTopLeft(*args, **kwargs)
1192
1193 def SetTopLeft(*args, **kwargs):
1194 """SetTopLeft(self, Point p)"""
1195 return _core_.Rect_SetTopLeft(*args, **kwargs)
1196
1197 def GetBottomRight(*args, **kwargs):
1198 """GetBottomRight(self) -> Point"""
1199 return _core_.Rect_GetBottomRight(*args, **kwargs)
1200
1201 def SetBottomRight(*args, **kwargs):
1202 """SetBottomRight(self, Point p)"""
1203 return _core_.Rect_SetBottomRight(*args, **kwargs)
1204
1205 def GetTopRight(*args, **kwargs):
1206 """GetTopRight(self) -> Point"""
1207 return _core_.Rect_GetTopRight(*args, **kwargs)
1208
1209 def SetTopRight(*args, **kwargs):
1210 """SetTopRight(self, Point p)"""
1211 return _core_.Rect_SetTopRight(*args, **kwargs)
1212
1213 def GetBottomLeft(*args, **kwargs):
1214 """GetBottomLeft(self) -> Point"""
1215 return _core_.Rect_GetBottomLeft(*args, **kwargs)
1216
1217 def SetBottomLeft(*args, **kwargs):
1218 """SetBottomLeft(self, Point p)"""
1219 return _core_.Rect_SetBottomLeft(*args, **kwargs)
1220
1221 def GetLeft(*args, **kwargs):
1222 """GetLeft(self) -> int"""
1223 return _core_.Rect_GetLeft(*args, **kwargs)
1224
1225 def GetTop(*args, **kwargs):
1226 """GetTop(self) -> int"""
1227 return _core_.Rect_GetTop(*args, **kwargs)
1228
1229 def GetBottom(*args, **kwargs):
1230 """GetBottom(self) -> int"""
1231 return _core_.Rect_GetBottom(*args, **kwargs)
1232
1233 def GetRight(*args, **kwargs):
1234 """GetRight(self) -> int"""
1235 return _core_.Rect_GetRight(*args, **kwargs)
1236
1237 def SetLeft(*args, **kwargs):
1238 """SetLeft(self, int left)"""
1239 return _core_.Rect_SetLeft(*args, **kwargs)
1240
1241 def SetRight(*args, **kwargs):
1242 """SetRight(self, int right)"""
1243 return _core_.Rect_SetRight(*args, **kwargs)
1244
1245 def SetTop(*args, **kwargs):
1246 """SetTop(self, int top)"""
1247 return _core_.Rect_SetTop(*args, **kwargs)
1248
1249 def SetBottom(*args, **kwargs):
1250 """SetBottom(self, int bottom)"""
1251 return _core_.Rect_SetBottom(*args, **kwargs)
1252
1253 position = property(GetPosition, SetPosition)
1254 size = property(GetSize, SetSize)
1255 left = property(GetLeft, SetLeft)
1256 right = property(GetRight, SetRight)
1257 top = property(GetTop, SetTop)
1258 bottom = property(GetBottom, SetBottom)
1259
1260 def Inflate(*args, **kwargs):
1261 """
1262 Inflate(self, int dx, int dy) -> Rect
1263
1264 Increases the size of the rectangle.
1265
1266 The left border is moved farther left and the right border is moved
1267 farther right by ``dx``. The upper border is moved farther up and the
1268 bottom border is moved farther down by ``dy``. (Note the the width and
1269 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1270 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1271 opposite happens: the rectangle size decreases in the respective
1272 direction.
1273
1274 The change is made to the rectangle inplace, if instead you need a
1275 copy that is inflated, preserving the original then make the copy
1276 first::
1277
1278 copy = wx.Rect(*original)
1279 copy.Inflate(10,15)
1280
1281
1282 """
1283 return _core_.Rect_Inflate(*args, **kwargs)
1284
1285 def Deflate(*args, **kwargs):
1286 """
1287 Deflate(self, int dx, int dy) -> Rect
1288
1289 Decrease the rectangle size. This method is the opposite of `Inflate`
1290 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1291 `Inflate` for a full description.
1292 """
1293 return _core_.Rect_Deflate(*args, **kwargs)
1294
1295 def OffsetXY(*args, **kwargs):
1296 """
1297 OffsetXY(self, int dx, int dy)
1298
1299 Moves the rectangle by the specified offset. If dx is positive, the
1300 rectangle is moved to the right, if dy is positive, it is moved to the
1301 bottom, otherwise it is moved to the left or top respectively.
1302 """
1303 return _core_.Rect_OffsetXY(*args, **kwargs)
1304
1305 def Offset(*args, **kwargs):
1306 """
1307 Offset(self, Point pt)
1308
1309 Same as `OffsetXY` but uses dx,dy from Point
1310 """
1311 return _core_.Rect_Offset(*args, **kwargs)
1312
1313 def Intersect(*args, **kwargs):
1314 """
1315 Intersect(self, Rect rect) -> Rect
1316
1317 Returns the intersectsion of this rectangle and rect.
1318 """
1319 return _core_.Rect_Intersect(*args, **kwargs)
1320
1321 def Union(*args, **kwargs):
1322 """
1323 Union(self, Rect rect) -> Rect
1324
1325 Returns the union of this rectangle and rect.
1326 """
1327 return _core_.Rect_Union(*args, **kwargs)
1328
1329 def __add__(*args, **kwargs):
1330 """
1331 __add__(self, Rect rect) -> Rect
1332
1333 Add the properties of rect to this rectangle and return the result.
1334 """
1335 return _core_.Rect___add__(*args, **kwargs)
1336
1337 def __iadd__(*args, **kwargs):
1338 """
1339 __iadd__(self, Rect rect) -> Rect
1340
1341 Add the properties of rect to this rectangle, updating this rectangle.
1342 """
1343 return _core_.Rect___iadd__(*args, **kwargs)
1344
1345 def __eq__(*args, **kwargs):
1346 """
1347 __eq__(self, PyObject other) -> bool
1348
1349 Test for equality of wx.Rect objects.
1350 """
1351 return _core_.Rect___eq__(*args, **kwargs)
1352
1353 def __ne__(*args, **kwargs):
1354 """
1355 __ne__(self, PyObject other) -> bool
1356
1357 Test for inequality of wx.Rect objects.
1358 """
1359 return _core_.Rect___ne__(*args, **kwargs)
1360
1361 def ContainsXY(*args, **kwargs):
1362 """
1363 ContainsXY(self, int x, int y) -> bool
1364
1365 Return True if the point is inside the rect.
1366 """
1367 return _core_.Rect_ContainsXY(*args, **kwargs)
1368
1369 def Contains(*args, **kwargs):
1370 """
1371 Contains(self, Point pt) -> bool
1372
1373 Return True if the point is inside the rect.
1374 """
1375 return _core_.Rect_Contains(*args, **kwargs)
1376
1377 def ContainsRect(*args, **kwargs):
1378 """
1379 ContainsRect(self, Rect rect) -> bool
1380
1381 Returns ``True`` if the given rectangle is completely inside this
1382 rectangle or touches its boundary.
1383 """
1384 return _core_.Rect_ContainsRect(*args, **kwargs)
1385
1386 #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
1387 #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
1388 #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
1389 Inside = Contains
1390 InsideXY = ContainsXY
1391 InsideRect = ContainsRect
1392
1393 def Intersects(*args, **kwargs):
1394 """
1395 Intersects(self, Rect rect) -> bool
1396
1397 Returns True if the rectangles have a non empty intersection.
1398 """
1399 return _core_.Rect_Intersects(*args, **kwargs)
1400
1401 def CenterIn(*args, **kwargs):
1402 """
1403 CenterIn(self, Rect r, int dir=BOTH) -> Rect
1404
1405 Center this rectangle within the one passed to the method, which is
1406 usually, but not necessarily, the larger one.
1407 """
1408 return _core_.Rect_CenterIn(*args, **kwargs)
1409
1410 CentreIn = CenterIn
1411 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1412 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1413 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1414 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1415 def Set(*args, **kwargs):
1416 """
1417 Set(self, int x=0, int y=0, int width=0, int height=0)
1418
1419 Set all rectangle properties.
1420 """
1421 return _core_.Rect_Set(*args, **kwargs)
1422
1423 def Get(*args, **kwargs):
1424 """
1425 Get() -> (x,y,width,height)
1426
1427 Return the rectangle properties as a tuple.
1428 """
1429 return _core_.Rect_Get(*args, **kwargs)
1430
1431 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1432 def __str__(self): return str(self.Get())
1433 def __repr__(self): return 'wx.Rect'+str(self.Get())
1434 def __len__(self): return len(self.Get())
1435 def __getitem__(self, index): return self.Get()[index]
1436 def __setitem__(self, index, val):
1437 if index == 0: self.x = val
1438 elif index == 1: self.y = val
1439 elif index == 2: self.width = val
1440 elif index == 3: self.height = val
1441 else: raise IndexError
1442 def __nonzero__(self): return self.Get() != (0,0,0,0)
1443 __safe_for_unpickling__ = True
1444 def __reduce__(self): return (wx.Rect, self.Get())
1445
1446 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1447 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
1448 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
1449 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1450 Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`")
1451 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
1452 Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
1453 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
1454 Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`")
1455 TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`")
1456 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
1457 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
1458 X = property(GetX,SetX,doc="See `GetX` and `SetX`")
1459 Y = property(GetY,SetY,doc="See `GetY` and `SetY`")
1460 Empty = property(IsEmpty,doc="See `IsEmpty`")
1461_core_.Rect_swigregister(Rect)
1462
1463def RectPP(*args, **kwargs):
1464 """
1465 RectPP(Point topLeft, Point bottomRight) -> Rect
1466
1467 Create a new Rect object from Points representing two corners.
1468 """
1469 val = _core_.new_RectPP(*args, **kwargs)
1470 return val
1471
1472def RectPS(*args, **kwargs):
1473 """
1474 RectPS(Point pos, Size size) -> Rect
1475
1476 Create a new Rect from a position and size.
1477 """
1478 val = _core_.new_RectPS(*args, **kwargs)
1479 return val
1480
1481def RectS(*args, **kwargs):
1482 """
1483 RectS(Size size) -> Rect
1484
1485 Create a new Rect from a size only.
1486 """
1487 val = _core_.new_RectS(*args, **kwargs)
1488 return val
1489
1490
1491def IntersectRect(*args, **kwargs):
1492 """
1493 IntersectRect(Rect r1, Rect r2) -> Rect
1494
1495 Calculate and return the intersection of r1 and r2.
1496 """
1497 return _core_.IntersectRect(*args, **kwargs)
1498#---------------------------------------------------------------------------
1499
1500class Point2D(object):
1501 """
1502 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503 with floating point values.
1504 """
1505 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1506 __repr__ = _swig_repr
1507 def __init__(self, *args, **kwargs):
1508 """
1509 __init__(self, double x=0.0, double y=0.0) -> Point2D
1510
1511 Create a w.Point2D object.
1512 """
1513 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
1514 __swig_destroy__ = _core_.delete_Point2D
1515 __del__ = lambda self : None;
1516 def GetFloor(*args, **kwargs):
1517 """
1518 GetFloor() -> (x,y)
1519
1520 Convert to integer
1521 """
1522 return _core_.Point2D_GetFloor(*args, **kwargs)
1523
1524 def GetRounded(*args, **kwargs):
1525 """
1526 GetRounded() -> (x,y)
1527
1528 Convert to integer
1529 """
1530 return _core_.Point2D_GetRounded(*args, **kwargs)
1531
1532 def GetVectorLength(*args, **kwargs):
1533 """GetVectorLength(self) -> double"""
1534 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1535
1536 def GetVectorAngle(*args, **kwargs):
1537 """GetVectorAngle(self) -> double"""
1538 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1539
1540 def SetVectorLength(*args, **kwargs):
1541 """SetVectorLength(self, double length)"""
1542 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1543
1544 def SetVectorAngle(*args, **kwargs):
1545 """SetVectorAngle(self, double degrees)"""
1546 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1547
1548 def SetPolarCoordinates(self, angle, length):
1549 self.SetVectorLength(length)
1550 self.SetVectorAngle(angle)
1551 def Normalize(self):
1552 self.SetVectorLength(1.0)
1553
1554 def GetDistance(*args, **kwargs):
1555 """GetDistance(self, Point2D pt) -> double"""
1556 return _core_.Point2D_GetDistance(*args, **kwargs)
1557
1558 def GetDistanceSquare(*args, **kwargs):
1559 """GetDistanceSquare(self, Point2D pt) -> double"""
1560 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1561
1562 def GetDotProduct(*args, **kwargs):
1563 """GetDotProduct(self, Point2D vec) -> double"""
1564 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1565
1566 def GetCrossProduct(*args, **kwargs):
1567 """GetCrossProduct(self, Point2D vec) -> double"""
1568 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1569
1570 def __neg__(*args, **kwargs):
1571 """
1572 __neg__(self) -> Point2D
1573
1574 the reflection of this point
1575 """
1576 return _core_.Point2D___neg__(*args, **kwargs)
1577
1578 def __iadd__(*args, **kwargs):
1579 """__iadd__(self, Point2D pt) -> Point2D"""
1580 return _core_.Point2D___iadd__(*args, **kwargs)
1581
1582 def __isub__(*args, **kwargs):
1583 """__isub__(self, Point2D pt) -> Point2D"""
1584 return _core_.Point2D___isub__(*args, **kwargs)
1585
1586 def __imul__(*args, **kwargs):
1587 """__imul__(self, Point2D pt) -> Point2D"""
1588 return _core_.Point2D___imul__(*args, **kwargs)
1589
1590 def __idiv__(*args, **kwargs):
1591 """__idiv__(self, Point2D pt) -> Point2D"""
1592 return _core_.Point2D___idiv__(*args, **kwargs)
1593
1594 def __eq__(*args, **kwargs):
1595 """
1596 __eq__(self, PyObject other) -> bool
1597
1598 Test for equality of wx.Point2D objects.
1599 """
1600 return _core_.Point2D___eq__(*args, **kwargs)
1601
1602 def __ne__(*args, **kwargs):
1603 """
1604 __ne__(self, PyObject other) -> bool
1605
1606 Test for inequality of wx.Point2D objects.
1607 """
1608 return _core_.Point2D___ne__(*args, **kwargs)
1609
1610 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1611 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1612 def Set(*args, **kwargs):
1613 """Set(self, double x=0, double y=0)"""
1614 return _core_.Point2D_Set(*args, **kwargs)
1615
1616 def Get(*args, **kwargs):
1617 """
1618 Get() -> (x,y)
1619
1620 Return x and y properties as a tuple.
1621 """
1622 return _core_.Point2D_Get(*args, **kwargs)
1623
1624 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1625 def __str__(self): return str(self.Get())
1626 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1627 def __len__(self): return len(self.Get())
1628 def __getitem__(self, index): return self.Get()[index]
1629 def __setitem__(self, index, val):
1630 if index == 0: self.x = val
1631 elif index == 1: self.y = val
1632 else: raise IndexError
1633 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1634 __safe_for_unpickling__ = True
1635 def __reduce__(self): return (wx.Point2D, self.Get())
1636
1637 Floor = property(GetFloor,doc="See `GetFloor`")
1638 Rounded = property(GetRounded,doc="See `GetRounded`")
1639 VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
1640 VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
1641_core_.Point2D_swigregister(Point2D)
1642
1643def Point2DCopy(*args, **kwargs):
1644 """
1645 Point2DCopy(Point2D pt) -> Point2D
1646
1647 Create a w.Point2D object.
1648 """
1649 val = _core_.new_Point2DCopy(*args, **kwargs)
1650 return val
1651
1652def Point2DFromPoint(*args, **kwargs):
1653 """
1654 Point2DFromPoint(Point pt) -> Point2D
1655
1656 Create a w.Point2D object.
1657 """
1658 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1659 return val
1660
1661#---------------------------------------------------------------------------
1662
1663Inside = _core_.Inside
1664OutLeft = _core_.OutLeft
1665OutRight = _core_.OutRight
1666OutTop = _core_.OutTop
1667OutBottom = _core_.OutBottom
1668class Rect2D(object):
1669 """
1670 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1671 with floating point component values.
1672 """
1673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1674 __repr__ = _swig_repr
1675 def __init__(self, *args, **kwargs):
1676 """
1677 __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D
1678
1679 wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system
1680 with floating point component values.
1681 """
1682 _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs))
1683 __swig_destroy__ = _core_.delete_Rect2D
1684 __del__ = lambda self : None;
1685 def GetPosition(*args, **kwargs):
1686 """GetPosition(self) -> Point2D"""
1687 return _core_.Rect2D_GetPosition(*args, **kwargs)
1688
1689 def GetSize(*args, **kwargs):
1690 """GetSize(self) -> Size"""
1691 return _core_.Rect2D_GetSize(*args, **kwargs)
1692
1693 def GetLeft(*args, **kwargs):
1694 """GetLeft(self) -> wxDouble"""
1695 return _core_.Rect2D_GetLeft(*args, **kwargs)
1696
1697 def SetLeft(*args, **kwargs):
1698 """SetLeft(self, wxDouble n)"""
1699 return _core_.Rect2D_SetLeft(*args, **kwargs)
1700
1701 def MoveLeftTo(*args, **kwargs):
1702 """MoveLeftTo(self, wxDouble n)"""
1703 return _core_.Rect2D_MoveLeftTo(*args, **kwargs)
1704
1705 def GetTop(*args, **kwargs):
1706 """GetTop(self) -> wxDouble"""
1707 return _core_.Rect2D_GetTop(*args, **kwargs)
1708
1709 def SetTop(*args, **kwargs):
1710 """SetTop(self, wxDouble n)"""
1711 return _core_.Rect2D_SetTop(*args, **kwargs)
1712
1713 def MoveTopTo(*args, **kwargs):
1714 """MoveTopTo(self, wxDouble n)"""
1715 return _core_.Rect2D_MoveTopTo(*args, **kwargs)
1716
1717 def GetBottom(*args, **kwargs):
1718 """GetBottom(self) -> wxDouble"""
1719 return _core_.Rect2D_GetBottom(*args, **kwargs)
1720
1721 def SetBottom(*args, **kwargs):
1722 """SetBottom(self, wxDouble n)"""
1723 return _core_.Rect2D_SetBottom(*args, **kwargs)
1724
1725 def MoveBottomTo(*args, **kwargs):
1726 """MoveBottomTo(self, wxDouble n)"""
1727 return _core_.Rect2D_MoveBottomTo(*args, **kwargs)
1728
1729 def GetRight(*args, **kwargs):
1730 """GetRight(self) -> wxDouble"""
1731 return _core_.Rect2D_GetRight(*args, **kwargs)
1732
1733 def SetRight(*args, **kwargs):
1734 """SetRight(self, wxDouble n)"""
1735 return _core_.Rect2D_SetRight(*args, **kwargs)
1736
1737 def MoveRightTo(*args, **kwargs):
1738 """MoveRightTo(self, wxDouble n)"""
1739 return _core_.Rect2D_MoveRightTo(*args, **kwargs)
1740
1741 def GetLeftTop(*args, **kwargs):
1742 """GetLeftTop(self) -> Point2D"""
1743 return _core_.Rect2D_GetLeftTop(*args, **kwargs)
1744
1745 def SetLeftTop(*args, **kwargs):
1746 """SetLeftTop(self, Point2D pt)"""
1747 return _core_.Rect2D_SetLeftTop(*args, **kwargs)
1748
1749 def MoveLeftTopTo(*args, **kwargs):
1750 """MoveLeftTopTo(self, Point2D pt)"""
1751 return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs)
1752
1753 def GetLeftBottom(*args, **kwargs):
1754 """GetLeftBottom(self) -> Point2D"""
1755 return _core_.Rect2D_GetLeftBottom(*args, **kwargs)
1756
1757 def SetLeftBottom(*args, **kwargs):
1758 """SetLeftBottom(self, Point2D pt)"""
1759 return _core_.Rect2D_SetLeftBottom(*args, **kwargs)
1760
1761 def MoveLeftBottomTo(*args, **kwargs):
1762 """MoveLeftBottomTo(self, Point2D pt)"""
1763 return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs)
1764
1765 def GetRightTop(*args, **kwargs):
1766 """GetRightTop(self) -> Point2D"""
1767 return _core_.Rect2D_GetRightTop(*args, **kwargs)
1768
1769 def SetRightTop(*args, **kwargs):
1770 """SetRightTop(self, Point2D pt)"""
1771 return _core_.Rect2D_SetRightTop(*args, **kwargs)
1772
1773 def MoveRightTopTo(*args, **kwargs):
1774 """MoveRightTopTo(self, Point2D pt)"""
1775 return _core_.Rect2D_MoveRightTopTo(*args, **kwargs)
1776
1777 def GetRightBottom(*args, **kwargs):
1778 """GetRightBottom(self) -> Point2D"""
1779 return _core_.Rect2D_GetRightBottom(*args, **kwargs)
1780
1781 def SetRightBottom(*args, **kwargs):
1782 """SetRightBottom(self, Point2D pt)"""
1783 return _core_.Rect2D_SetRightBottom(*args, **kwargs)
1784
1785 def MoveRightBottomTo(*args, **kwargs):
1786 """MoveRightBottomTo(self, Point2D pt)"""
1787 return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs)
1788
1789 def GetCentre(*args, **kwargs):
1790 """GetCentre(self) -> Point2D"""
1791 return _core_.Rect2D_GetCentre(*args, **kwargs)
1792
1793 def SetCentre(*args, **kwargs):
1794 """SetCentre(self, Point2D pt)"""
1795 return _core_.Rect2D_SetCentre(*args, **kwargs)
1796
1797 def MoveCentreTo(*args, **kwargs):
1798 """MoveCentreTo(self, Point2D pt)"""
1799 return _core_.Rect2D_MoveCentreTo(*args, **kwargs)
1800
1801 def GetOutcode(*args, **kwargs):
1802 """GetOutcode(self, Point2D pt) -> int"""
1803 return _core_.Rect2D_GetOutcode(*args, **kwargs)
1804
1805 def Contains(*args, **kwargs):
1806 """Contains(self, Point2D pt) -> bool"""
1807 return _core_.Rect2D_Contains(*args, **kwargs)
1808
1809 def ContainsRect(*args, **kwargs):
1810 """ContainsRect(self, Rect2D rect) -> bool"""
1811 return _core_.Rect2D_ContainsRect(*args, **kwargs)
1812
1813 def IsEmpty(*args, **kwargs):
1814 """IsEmpty(self) -> bool"""
1815 return _core_.Rect2D_IsEmpty(*args, **kwargs)
1816
1817 def HaveEqualSize(*args, **kwargs):
1818 """HaveEqualSize(self, Rect2D rect) -> bool"""
1819 return _core_.Rect2D_HaveEqualSize(*args, **kwargs)
1820
1821 def Inset(*args):
1822 """
1823 Inset(self, wxDouble x, wxDouble y)
1824 Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom)
1825 """
1826 return _core_.Rect2D_Inset(*args)
1827
1828 def Offset(*args, **kwargs):
1829 """Offset(self, Point2D pt)"""
1830 return _core_.Rect2D_Offset(*args, **kwargs)
1831
1832 def ConstrainTo(*args, **kwargs):
1833 """ConstrainTo(self, Rect2D rect)"""
1834 return _core_.Rect2D_ConstrainTo(*args, **kwargs)
1835
1836 def Interpolate(*args, **kwargs):
1837 """Interpolate(self, int widthfactor, int heightfactor) -> Point2D"""
1838 return _core_.Rect2D_Interpolate(*args, **kwargs)
1839
1840 def Intersect(*args, **kwargs):
1841 """Intersect(self, Rect2D otherRect)"""
1842 return _core_.Rect2D_Intersect(*args, **kwargs)
1843
1844 def CreateIntersection(*args, **kwargs):
1845 """CreateIntersection(self, Rect2D otherRect) -> Rect2D"""
1846 return _core_.Rect2D_CreateIntersection(*args, **kwargs)
1847
1848 def Intersects(*args, **kwargs):
1849 """Intersects(self, Rect2D rect) -> bool"""
1850 return _core_.Rect2D_Intersects(*args, **kwargs)
1851
1852 def Union(*args, **kwargs):
1853 """Union(self, Rect2D otherRect)"""
1854 return _core_.Rect2D_Union(*args, **kwargs)
1855
1856 def CreateUnion(*args, **kwargs):
1857 """CreateUnion(self, Rect2D otherRect) -> Rect2D"""
1858 return _core_.Rect2D_CreateUnion(*args, **kwargs)
1859
1860 def Scale(*args):
1861 """
1862 Scale(self, wxDouble f)
1863 Scale(self, int num, int denum)
1864 """
1865 return _core_.Rect2D_Scale(*args)
1866
1867 def __eq__(*args, **kwargs):
1868 """
1869 __eq__(self, PyObject other) -> bool
1870
1871 Test for equality of wx.Rect2D objects.
1872 """
1873 return _core_.Rect2D___eq__(*args, **kwargs)
1874
1875 def __ne__(*args, **kwargs):
1876 """
1877 __ne__(self, PyObject other) -> bool
1878
1879 Test for inequality of wx.Rect2D objects.
1880 """
1881 return _core_.Rect2D___ne__(*args, **kwargs)
1882
1883 x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set)
1884 y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set)
1885 width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set)
1886 height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set)
1887 def Set(*args, **kwargs):
1888 """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)"""
1889 return _core_.Rect2D_Set(*args, **kwargs)
1890
1891 def Get(*args, **kwargs):
1892 """
1893 Get() -> (x,y, width, height)
1894
1895 Return x, y, width and height y properties as a tuple.
1896 """
1897 return _core_.Rect2D_Get(*args, **kwargs)
1898
1899 def __str__(self): return str(self.Get())
1900 def __repr__(self): return 'wx.Rect2D'+str(self.Get())
1901 def __len__(self): return len(self.Get())
1902 def __getitem__(self, index): return self.Get()[index]
1903 def __setitem__(self, index, val):
1904 if index == 0: self.x = val
1905 elif index == 1: self.y = val
1906 elif index == 2: self.width = val
1907 elif index == 3: self.height = val
1908 else: raise IndexError
1909 def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0)
1910 __safe_for_unpickling__ = True
1911 def __reduce__(self): return (wx.Rect2D, self.Get())
1912
1913_core_.Rect2D_swigregister(Rect2D)
1914
1915#---------------------------------------------------------------------------
1916
1917FromStart = _core_.FromStart
1918FromCurrent = _core_.FromCurrent
1919FromEnd = _core_.FromEnd
1920class InputStream(object):
1921 """Proxy of C++ InputStream class"""
1922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1923 __repr__ = _swig_repr
1924 def __init__(self, *args, **kwargs):
1925 """__init__(self, PyObject p) -> InputStream"""
1926 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1927 __swig_destroy__ = _core_.delete_InputStream
1928 __del__ = lambda self : None;
1929 def close(*args, **kwargs):
1930 """close(self)"""
1931 return _core_.InputStream_close(*args, **kwargs)
1932
1933 def flush(*args, **kwargs):
1934 """flush(self)"""
1935 return _core_.InputStream_flush(*args, **kwargs)
1936
1937 def eof(*args, **kwargs):
1938 """eof(self) -> bool"""
1939 return _core_.InputStream_eof(*args, **kwargs)
1940
1941 def read(*args, **kwargs):
1942 """read(self, int size=-1) -> PyObject"""
1943 return _core_.InputStream_read(*args, **kwargs)
1944
1945 def readline(*args, **kwargs):
1946 """readline(self, int size=-1) -> PyObject"""
1947 return _core_.InputStream_readline(*args, **kwargs)
1948
1949 def readlines(*args, **kwargs):
1950 """readlines(self, int sizehint=-1) -> PyObject"""
1951 return _core_.InputStream_readlines(*args, **kwargs)
1952
1953 def seek(*args, **kwargs):
1954 """seek(self, int offset, int whence=0)"""
1955 return _core_.InputStream_seek(*args, **kwargs)
1956
1957 def tell(*args, **kwargs):
1958 """tell(self) -> int"""
1959 return _core_.InputStream_tell(*args, **kwargs)
1960
1961 def Peek(*args, **kwargs):
1962 """Peek(self) -> char"""
1963 return _core_.InputStream_Peek(*args, **kwargs)
1964
1965 def GetC(*args, **kwargs):
1966 """GetC(self) -> char"""
1967 return _core_.InputStream_GetC(*args, **kwargs)
1968
1969 def LastRead(*args, **kwargs):
1970 """LastRead(self) -> size_t"""
1971 return _core_.InputStream_LastRead(*args, **kwargs)
1972
1973 def CanRead(*args, **kwargs):
1974 """CanRead(self) -> bool"""
1975 return _core_.InputStream_CanRead(*args, **kwargs)
1976
1977 def Eof(*args, **kwargs):
1978 """Eof(self) -> bool"""
1979 return _core_.InputStream_Eof(*args, **kwargs)
1980
1981 def Ungetch(*args, **kwargs):
1982 """Ungetch(self, char c) -> bool"""
1983 return _core_.InputStream_Ungetch(*args, **kwargs)
1984
1985 def SeekI(*args, **kwargs):
1986 """SeekI(self, long pos, int mode=FromStart) -> long"""
1987 return _core_.InputStream_SeekI(*args, **kwargs)
1988
1989 def TellI(*args, **kwargs):
1990 """TellI(self) -> long"""
1991 return _core_.InputStream_TellI(*args, **kwargs)
1992
1993_core_.InputStream_swigregister(InputStream)
1994DefaultPosition = cvar.DefaultPosition
1995DefaultSize = cvar.DefaultSize
1996
1997class OutputStream(object):
1998 """Proxy of C++ OutputStream class"""
1999 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2000 def __init__(self): raise AttributeError, "No constructor defined"
2001 __repr__ = _swig_repr
2002 def write(*args, **kwargs):
2003 """write(self, PyObject obj)"""
2004 return _core_.OutputStream_write(*args, **kwargs)
2005
2006 def LastWrite(*args, **kwargs):
2007 """LastWrite(self) -> size_t"""
2008 return _core_.OutputStream_LastWrite(*args, **kwargs)
2009
2010_core_.OutputStream_swigregister(OutputStream)
2011
2012#---------------------------------------------------------------------------
2013
2014class FSFile(Object):
2015 """Proxy of C++ FSFile class"""
2016 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2017 __repr__ = _swig_repr
2018 def __init__(self, *args, **kwargs):
2019 """
2020 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2021 DateTime modif) -> FSFile
2022 """
2023 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
2024 __swig_destroy__ = _core_.delete_FSFile
2025 __del__ = lambda self : None;
2026 def GetStream(*args, **kwargs):
2027 """GetStream(self) -> InputStream"""
2028 return _core_.FSFile_GetStream(*args, **kwargs)
2029
2030 def DetachStream(*args, **kwargs):
2031 """DetachStream(self)"""
2032 return _core_.FSFile_DetachStream(*args, **kwargs)
2033
2034 def GetMimeType(*args, **kwargs):
2035 """GetMimeType(self) -> String"""
2036 return _core_.FSFile_GetMimeType(*args, **kwargs)
2037
2038 def GetLocation(*args, **kwargs):
2039 """GetLocation(self) -> String"""
2040 return _core_.FSFile_GetLocation(*args, **kwargs)
2041
2042 def GetAnchor(*args, **kwargs):
2043 """GetAnchor(self) -> String"""
2044 return _core_.FSFile_GetAnchor(*args, **kwargs)
2045
2046 def GetModificationTime(*args, **kwargs):
2047 """GetModificationTime(self) -> DateTime"""
2048 return _core_.FSFile_GetModificationTime(*args, **kwargs)
2049
2050 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2051 Location = property(GetLocation,doc="See `GetLocation`")
2052 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2053 ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`")
2054 Stream = property(GetStream,doc="See `GetStream`")
2055_core_.FSFile_swigregister(FSFile)
2056
2057class CPPFileSystemHandler(object):
2058 """Proxy of C++ CPPFileSystemHandler class"""
2059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2060 def __init__(self): raise AttributeError, "No constructor defined"
2061 __repr__ = _swig_repr
2062 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2063 __del__ = lambda self : None;
2064_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
2065
2066class FileSystemHandler(CPPFileSystemHandler):
2067 """Proxy of C++ FileSystemHandler class"""
2068 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2069 __repr__ = _swig_repr
2070 def __init__(self, *args, **kwargs):
2071 """__init__(self) -> FileSystemHandler"""
2072 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
2073 self._setCallbackInfo(self, FileSystemHandler)
2074
2075 def _setCallbackInfo(*args, **kwargs):
2076 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2077 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
2078
2079 def CanOpen(*args, **kwargs):
2080 """CanOpen(self, String location) -> bool"""
2081 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
2082
2083 def OpenFile(*args, **kwargs):
2084 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2085 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
2086
2087 def FindFirst(*args, **kwargs):
2088 """FindFirst(self, String spec, int flags=0) -> String"""
2089 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
2090
2091 def FindNext(*args, **kwargs):
2092 """FindNext(self) -> String"""
2093 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
2094
2095 def GetProtocol(*args, **kwargs):
2096 """GetProtocol(self, String location) -> String"""
2097 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
2098
2099 def GetLeftLocation(*args, **kwargs):
2100 """GetLeftLocation(self, String location) -> String"""
2101 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
2102
2103 def GetAnchor(*args, **kwargs):
2104 """GetAnchor(self, String location) -> String"""
2105 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
2106
2107 def GetRightLocation(*args, **kwargs):
2108 """GetRightLocation(self, String location) -> String"""
2109 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
2110
2111 def GetMimeTypeFromExt(*args, **kwargs):
2112 """GetMimeTypeFromExt(self, String location) -> String"""
2113 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
2114
2115 Anchor = property(GetAnchor,doc="See `GetAnchor`")
2116 LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`")
2117 MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`")
2118 Protocol = property(GetProtocol,doc="See `GetProtocol`")
2119 RightLocation = property(GetRightLocation,doc="See `GetRightLocation`")
2120_core_.FileSystemHandler_swigregister(FileSystemHandler)
2121
2122class FileSystem(Object):
2123 """Proxy of C++ FileSystem class"""
2124 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2125 __repr__ = _swig_repr
2126 def __init__(self, *args, **kwargs):
2127 """__init__(self) -> FileSystem"""
2128 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2129 __swig_destroy__ = _core_.delete_FileSystem
2130 __del__ = lambda self : None;
2131 def ChangePathTo(*args, **kwargs):
2132 """ChangePathTo(self, String location, bool is_dir=False)"""
2133 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
2134
2135 def GetPath(*args, **kwargs):
2136 """GetPath(self) -> String"""
2137 return _core_.FileSystem_GetPath(*args, **kwargs)
2138
2139 def OpenFile(*args, **kwargs):
2140 """OpenFile(self, String location) -> FSFile"""
2141 return _core_.FileSystem_OpenFile(*args, **kwargs)
2142
2143 def FindFirst(*args, **kwargs):
2144 """FindFirst(self, String spec, int flags=0) -> String"""
2145 return _core_.FileSystem_FindFirst(*args, **kwargs)
2146
2147 def FindNext(*args, **kwargs):
2148 """FindNext(self) -> String"""
2149 return _core_.FileSystem_FindNext(*args, **kwargs)
2150
2151 def AddHandler(*args, **kwargs):
2152 """AddHandler(CPPFileSystemHandler handler)"""
2153 return _core_.FileSystem_AddHandler(*args, **kwargs)
2154
2155 AddHandler = staticmethod(AddHandler)
2156 def RemoveHandler(*args, **kwargs):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2159
2160 RemoveHandler = staticmethod(RemoveHandler)
2161 def CleanUpHandlers(*args, **kwargs):
2162 """CleanUpHandlers()"""
2163 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
2164
2165 CleanUpHandlers = staticmethod(CleanUpHandlers)
2166 def FileNameToURL(*args, **kwargs):
2167 """FileNameToURL(String filename) -> String"""
2168 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2169
2170 FileNameToURL = staticmethod(FileNameToURL)
2171 def URLToFileName(*args, **kwargs):
2172 """URLToFileName(String url) -> String"""
2173 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2174
2175 URLToFileName = staticmethod(URLToFileName)
2176 Path = property(GetPath,doc="See `GetPath`")
2177_core_.FileSystem_swigregister(FileSystem)
2178
2179def FileSystem_AddHandler(*args, **kwargs):
2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_.FileSystem_AddHandler(*args, **kwargs)
2182
2183def FileSystem_RemoveHandler(*args, **kwargs):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2186
2187def FileSystem_CleanUpHandlers(*args):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_.FileSystem_CleanUpHandlers(*args)
2190
2191def FileSystem_FileNameToURL(*args, **kwargs):
2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2194
2195def FileSystem_URLToFileName(*args, **kwargs):
2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2198
2199class InternetFSHandler(CPPFileSystemHandler):
2200 """Proxy of C++ InternetFSHandler class"""
2201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2202 __repr__ = _swig_repr
2203 def __init__(self, *args, **kwargs):
2204 """__init__(self) -> InternetFSHandler"""
2205 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
2206 def CanOpen(*args, **kwargs):
2207 """CanOpen(self, String location) -> bool"""
2208 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
2209
2210 def OpenFile(*args, **kwargs):
2211 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2212 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
2213
2214_core_.InternetFSHandler_swigregister(InternetFSHandler)
2215
2216class ZipFSHandler(CPPFileSystemHandler):
2217 """Proxy of C++ ZipFSHandler class"""
2218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2219 __repr__ = _swig_repr
2220 def __init__(self, *args, **kwargs):
2221 """__init__(self) -> ZipFSHandler"""
2222 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
2223 def CanOpen(*args, **kwargs):
2224 """CanOpen(self, String location) -> bool"""
2225 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
2226
2227 def OpenFile(*args, **kwargs):
2228 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2229 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
2230
2231 def FindFirst(*args, **kwargs):
2232 """FindFirst(self, String spec, int flags=0) -> String"""
2233 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
2234
2235 def FindNext(*args, **kwargs):
2236 """FindNext(self) -> String"""
2237 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
2238
2239_core_.ZipFSHandler_swigregister(ZipFSHandler)
2240
2241
2242def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
2245
2246def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
2249
2250def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
2253def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2254 """
2255 Add 'file' to the memory filesystem. The dataItem parameter can
2256 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2257 arbitrary data. If a bitmap or image is used then the imgType
2258 parameter should specify what kind of image file it should be
2259 written as, wx.BITMAP_TYPE_PNG, etc.
2260 """
2261 if isinstance(dataItem, wx.Image):
2262 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2263 elif isinstance(dataItem, wx.Bitmap):
2264 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2265 elif type(dataItem) == str:
2266 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2267 else:
2268 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
2269
2270class MemoryFSHandler(CPPFileSystemHandler):
2271 """Proxy of C++ MemoryFSHandler class"""
2272 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2273 __repr__ = _swig_repr
2274 def __init__(self, *args, **kwargs):
2275 """__init__(self) -> MemoryFSHandler"""
2276 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
2277 def RemoveFile(*args, **kwargs):
2278 """RemoveFile(String filename)"""
2279 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2280
2281 RemoveFile = staticmethod(RemoveFile)
2282 AddFile = staticmethod(MemoryFSHandler_AddFile)
2283 def CanOpen(*args, **kwargs):
2284 """CanOpen(self, String location) -> bool"""
2285 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2286
2287 def OpenFile(*args, **kwargs):
2288 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2289 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2290
2291 def FindFirst(*args, **kwargs):
2292 """FindFirst(self, String spec, int flags=0) -> String"""
2293 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2294
2295 def FindNext(*args, **kwargs):
2296 """FindNext(self) -> String"""
2297 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2298
2299_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
2300
2301def MemoryFSHandler_RemoveFile(*args, **kwargs):
2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2304
2305IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2306IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2307IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
2308IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2309IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
2310#---------------------------------------------------------------------------
2311
2312class ImageHandler(Object):
2313 """
2314 This is the base class for implementing image file loading/saving, and
2315 image creation from data. It is used within `wx.Image` and is not
2316 normally seen by the application.
2317 """
2318 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2319 def __init__(self): raise AttributeError, "No constructor defined"
2320 __repr__ = _swig_repr
2321 def GetName(*args, **kwargs):
2322 """GetName(self) -> String"""
2323 return _core_.ImageHandler_GetName(*args, **kwargs)
2324
2325 def GetExtension(*args, **kwargs):
2326 """GetExtension(self) -> String"""
2327 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2328
2329 def GetType(*args, **kwargs):
2330 """GetType(self) -> long"""
2331 return _core_.ImageHandler_GetType(*args, **kwargs)
2332
2333 def GetMimeType(*args, **kwargs):
2334 """GetMimeType(self) -> String"""
2335 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2336
2337 def CanRead(*args, **kwargs):
2338 """CanRead(self, String name) -> bool"""
2339 return _core_.ImageHandler_CanRead(*args, **kwargs)
2340
2341 def CanReadStream(*args, **kwargs):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2344
2345 def SetName(*args, **kwargs):
2346 """SetName(self, String name)"""
2347 return _core_.ImageHandler_SetName(*args, **kwargs)
2348
2349 def SetExtension(*args, **kwargs):
2350 """SetExtension(self, String extension)"""
2351 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2352
2353 def SetType(*args, **kwargs):
2354 """SetType(self, long type)"""
2355 return _core_.ImageHandler_SetType(*args, **kwargs)
2356
2357 def SetMimeType(*args, **kwargs):
2358 """SetMimeType(self, String mimetype)"""
2359 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2360
2361 Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`")
2362 MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`")
2363 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
2364 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2365_core_.ImageHandler_swigregister(ImageHandler)
2366
2367class PyImageHandler(ImageHandler):
2368 """
2369 This is the base class for implementing image file loading/saving, and
2370 image creation from data, all written in Python. To create a custom
2371 image handler derive a new class from wx.PyImageHandler and provide
2372 the following methods::
2373
2374 def DoCanRead(self, stream) --> bool
2375 '''Check if this handler can read the image on the stream'''
2376
2377 def LoadFile(self, image, stream, verbose, index) --> bool
2378 '''Load image data from the stream and load it into image.'''
2379
2380 def SaveFile(self, image, stream, verbose) --> bool
2381 '''Save the iamge data in image to the stream using
2382 this handler's image file format.'''
2383
2384 def GetImageCount(self, stream) --> int
2385 '''If this image format can hold more than one image,
2386 how many does the image on the stream have?'''
2387
2388 To activate your handler create an instance of it and pass it to
2389 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2390 `SetExtension` from your constructor.
2391
2392 """
2393 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2394 __repr__ = _swig_repr
2395 def __init__(self, *args, **kwargs):
2396 """
2397 __init__(self) -> PyImageHandler
2398
2399 This is the base class for implementing image file loading/saving, and
2400 image creation from data, all written in Python. To create a custom
2401 image handler derive a new class from wx.PyImageHandler and provide
2402 the following methods::
2403
2404 def DoCanRead(self, stream) --> bool
2405 '''Check if this handler can read the image on the stream'''
2406
2407 def LoadFile(self, image, stream, verbose, index) --> bool
2408 '''Load image data from the stream and load it into image.'''
2409
2410 def SaveFile(self, image, stream, verbose) --> bool
2411 '''Save the iamge data in image to the stream using
2412 this handler's image file format.'''
2413
2414 def GetImageCount(self, stream) --> int
2415 '''If this image format can hold more than one image,
2416 how many does the image on the stream have?'''
2417
2418 To activate your handler create an instance of it and pass it to
2419 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2420 `SetExtension` from your constructor.
2421
2422 """
2423 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
2424 self._SetSelf(self)
2425
2426 def _SetSelf(*args, **kwargs):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2429
2430_core_.PyImageHandler_swigregister(PyImageHandler)
2431
2432class ImageHistogram(object):
2433 """Proxy of C++ ImageHistogram class"""
2434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2435 __repr__ = _swig_repr
2436 def __init__(self, *args, **kwargs):
2437 """__init__(self) -> ImageHistogram"""
2438 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
2439 def MakeKey(*args, **kwargs):
2440 """
2441 MakeKey(byte r, byte g, byte b) -> unsigned long
2442
2443 Get the key in the histogram for the given RGB values
2444 """
2445 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2446
2447 MakeKey = staticmethod(MakeKey)
2448 def FindFirstUnusedColour(*args, **kwargs):
2449 """
2450 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2451
2452 Find first colour that is not used in the image and has higher RGB
2453 values than startR, startG, startB. Returns a tuple consisting of a
2454 success flag and rgb values.
2455 """
2456 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2457
2458 def GetCount(*args, **kwargs):
2459 """
2460 GetCount(self, unsigned long key) -> unsigned long
2461
2462 Returns the pixel count for the given key. Use `MakeKey` to create a
2463 key value from a RGB tripple.
2464 """
2465 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2466
2467 def GetCountRGB(*args, **kwargs):
2468 """
2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
2470
2471 Returns the pixel count for the given RGB values.
2472 """
2473 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2474
2475 def GetCountColour(*args, **kwargs):
2476 """
2477 GetCountColour(self, Colour colour) -> unsigned long
2478
2479 Returns the pixel count for the given `wx.Colour` value.
2480 """
2481 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2482
2483_core_.ImageHistogram_swigregister(ImageHistogram)
2484
2485def ImageHistogram_MakeKey(*args, **kwargs):
2486 """
2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
2488
2489 Get the key in the histogram for the given RGB values
2490 """
2491 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2492
2493class Image_RGBValue(object):
2494 """
2495 An object that contains values for red, green and blue which represent
2496 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2497 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2498 color space.
2499 """
2500 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2501 __repr__ = _swig_repr
2502 def __init__(self, *args, **kwargs):
2503 """
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2505
2506 Constructor.
2507 """
2508 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2509 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2510 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2511 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2512_core_.Image_RGBValue_swigregister(Image_RGBValue)
2513
2514class Image_HSVValue(object):
2515 """
2516 An object that contains values for hue, saturation and value which
2517 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2518 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2519 color space.
2520 """
2521 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2522 __repr__ = _swig_repr
2523 def __init__(self, *args, **kwargs):
2524 """
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2526
2527 Constructor.
2528 """
2529 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2530 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2531 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2532 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2533_core_.Image_HSVValue_swigregister(Image_HSVValue)
2534
2535class Image(Object):
2536 """
2537 A platform-independent image class. An image can be created from
2538 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2539 variety of formats. Functions are available to set and get image
2540 bits, so it can be used for basic image manipulation.
2541
2542 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2543 platform-specific `wx.Bitmap` object must be created from it using the
2544 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2545 device context, using `wx.DC.DrawBitmap`.
2546
2547 One colour value of the image may be used as a mask colour which will
2548 lead to the automatic creation of a `wx.Mask` object associated to the
2549 bitmap object.
2550
2551 wx.Image supports alpha channel data, that is in addition to a byte
2552 for the red, green and blue colour components for each pixel it also
2553 stores a byte representing the pixel opacity. An alpha value of 0
2554 corresponds to a transparent pixel (null opacity) while a value of 255
2555 means that the pixel is 100% opaque.
2556
2557 Unlike RGB data, not all images have an alpha channel and before using
2558 `GetAlpha` you should check if this image contains an alpha channel
2559 with `HasAlpha`. Note that currently only images loaded from PNG files
2560 with transparency information will have an alpha channel.
2561 """
2562 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2563 __repr__ = _swig_repr
2564 def __init__(self, *args, **kwargs):
2565 """
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2567
2568 Loads an image from a file.
2569 """
2570 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2571 __swig_destroy__ = _core_.delete_Image
2572 __del__ = lambda self : None;
2573 def Create(*args, **kwargs):
2574 """
2575 Create(self, int width, int height, bool clear=True)
2576
2577 Creates a fresh image. If clear is ``True``, the new image will be
2578 initialized to black. Otherwise, the image data will be uninitialized.
2579 """
2580 return _core_.Image_Create(*args, **kwargs)
2581
2582 def Destroy(*args, **kwargs):
2583 """
2584 Destroy(self)
2585
2586 Destroys the image data.
2587 """
2588 args[0].this.own(False)
2589 return _core_.Image_Destroy(*args, **kwargs)
2590
2591 def Scale(*args, **kwargs):
2592 """
2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2594
2595 Returns a scaled version of the image. This is also useful for scaling
2596 bitmaps in general as the only other way to scale bitmaps is to blit a
2597 `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter
2598 specifies what method to use for resampling the image. It can be
2599 either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
2600 method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
2601 bicubic and box averaging resampling methods for upsampling and
2602 downsampling respectively.
2603 """
2604 return _core_.Image_Scale(*args, **kwargs)
2605
2606 def ResampleBox(*args, **kwargs):
2607 """ResampleBox(self, int width, int height) -> Image"""
2608 return _core_.Image_ResampleBox(*args, **kwargs)
2609
2610 def ResampleBicubic(*args, **kwargs):
2611 """ResampleBicubic(self, int width, int height) -> Image"""
2612 return _core_.Image_ResampleBicubic(*args, **kwargs)
2613
2614 def Blur(*args, **kwargs):
2615 """
2616 Blur(self, int radius) -> Image
2617
2618 Blurs the image in both horizontal and vertical directions by the
2619 specified pixel ``radius``. This should not be used when using a
2620 single mask colour for transparency.
2621 """
2622 return _core_.Image_Blur(*args, **kwargs)
2623
2624 def BlurHorizontal(*args, **kwargs):
2625 """
2626 BlurHorizontal(self, int radius) -> Image
2627
2628 Blurs the image in the horizontal direction only. This should not be
2629 used when using a single mask colour for transparency.
2630
2631 """
2632 return _core_.Image_BlurHorizontal(*args, **kwargs)
2633
2634 def BlurVertical(*args, **kwargs):
2635 """
2636 BlurVertical(self, int radius) -> Image
2637
2638 Blurs the image in the vertical direction only. This should not be
2639 used when using a single mask colour for transparency.
2640 """
2641 return _core_.Image_BlurVertical(*args, **kwargs)
2642
2643 def ShrinkBy(*args, **kwargs):
2644 """
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2646
2647 Return a version of the image scaled smaller by the given factors.
2648 """
2649 return _core_.Image_ShrinkBy(*args, **kwargs)
2650
2651 def Rescale(*args, **kwargs):
2652 """
2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
2654
2655 Changes the size of the image in-place by scaling it: after a call to
2656 this function, the image will have the given width and height.
2657
2658 Returns the (modified) image itself.
2659 """
2660 return _core_.Image_Rescale(*args, **kwargs)
2661
2662 def Resize(*args, **kwargs):
2663 """
2664 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2665
2666 Changes the size of the image in-place without scaling it, by adding
2667 either a border with the given colour or cropping as necessary. The
2668 image is pasted into a new image with the given size and background
2669 colour at the position pos relative to the upper left of the new
2670 image. If red = green = blue = -1 then use either the current mask
2671 colour if set or find, use, and set a suitable mask colour for any
2672 newly exposed areas.
2673
2674 Returns the (modified) image itself.
2675 """
2676 return _core_.Image_Resize(*args, **kwargs)
2677
2678 def SetRGB(*args, **kwargs):
2679 """
2680 SetRGB(self, int x, int y, byte r, byte g, byte b)
2681
2682 Sets the pixel at the given coordinate. This routine performs
2683 bounds-checks for the coordinate so it can be considered a safe way to
2684 manipulate the data, but in some cases this might be too slow so that
2685 the data will have to be set directly. In that case you will have to
2686 get access to the image data using the `GetData` method.
2687 """
2688 return _core_.Image_SetRGB(*args, **kwargs)
2689
2690 def SetRGBRect(*args, **kwargs):
2691 """
2692 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2693
2694 Sets the colour of the pixels within the given rectangle. This routine
2695 performs bounds-checks for the rectangle so it can be considered a
2696 safe way to manipulate the data.
2697 """
2698 return _core_.Image_SetRGBRect(*args, **kwargs)
2699
2700 def GetRed(*args, **kwargs):
2701 """
2702 GetRed(self, int x, int y) -> byte
2703
2704 Returns the red intensity at the given coordinate.
2705 """
2706 return _core_.Image_GetRed(*args, **kwargs)
2707
2708 def GetGreen(*args, **kwargs):
2709 """
2710 GetGreen(self, int x, int y) -> byte
2711
2712 Returns the green intensity at the given coordinate.
2713 """
2714 return _core_.Image_GetGreen(*args, **kwargs)
2715
2716 def GetBlue(*args, **kwargs):
2717 """
2718 GetBlue(self, int x, int y) -> byte
2719
2720 Returns the blue intensity at the given coordinate.
2721 """
2722 return _core_.Image_GetBlue(*args, **kwargs)
2723
2724 def SetAlpha(*args, **kwargs):
2725 """
2726 SetAlpha(self, int x, int y, byte alpha)
2727
2728 Sets the alpha value for the given pixel. This function should only be
2729 called if the image has alpha channel data, use `HasAlpha` to check
2730 for this.
2731 """
2732 return _core_.Image_SetAlpha(*args, **kwargs)
2733
2734 def GetAlpha(*args, **kwargs):
2735 """
2736 GetAlpha(self, int x, int y) -> byte
2737
2738 Returns the alpha value for the given pixel. This function may only be
2739 called for the images with alpha channel, use `HasAlpha` to check for
2740 this.
2741
2742 The returned value is the *opacity* of the image, i.e. the value of 0
2743 corresponds to the fully transparent pixels while the value of 255 to
2744 the fully opaque pixels.
2745 """
2746 return _core_.Image_GetAlpha(*args, **kwargs)
2747
2748 def HasAlpha(*args, **kwargs):
2749 """
2750 HasAlpha(self) -> bool
2751
2752 Returns true if this image has alpha channel, false otherwise.
2753 """
2754 return _core_.Image_HasAlpha(*args, **kwargs)
2755
2756 def InitAlpha(*args, **kwargs):
2757 """
2758 InitAlpha(self)
2759
2760 Initializes the image alpha channel data. It is an error to call it if
2761 the image already has alpha data. If it doesn't, alpha data will be by
2762 default initialized to all pixels being fully opaque. But if the image
2763 has a a mask colour, all mask pixels will be completely transparent.
2764 """
2765 return _core_.Image_InitAlpha(*args, **kwargs)
2766
2767 def IsTransparent(*args, **kwargs):
2768 """
2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2770
2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
2773 """
2774 return _core_.Image_IsTransparent(*args, **kwargs)
2775
2776 def FindFirstUnusedColour(*args, **kwargs):
2777 """
2778 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2779
2780 Find first colour that is not used in the image and has higher RGB
2781 values than startR, startG, startB. Returns a tuple consisting of a
2782 success flag and rgb values.
2783 """
2784 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2785
2786 def ConvertAlphaToMask(*args, **kwargs):
2787 """
2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
2789
2790 If the image has alpha channel, this method converts it to mask. All
2791 pixels with alpha value less than ``threshold`` are replaced with the
2792 mask colour and the alpha channel is removed. The mask colour is
2793 chosen automatically using `FindFirstUnusedColour`.
2794
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2796 nothing.
2797 """
2798 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2799
2800 def ConvertColourToAlpha(*args, **kwargs):
2801 """
2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
2803
2804 This method converts an image where the original alpha information is
2805 only available as a shades of a colour (actually shades of grey)
2806 typically when you draw anti-aliased text into a bitmap. The DC
2807 drawing routines draw grey values on the black background although
2808 they actually mean to draw white with differnt alpha values. This
2809 method reverses it, assuming a black (!) background and white text.
2810 The method will then fill up the whole image with the colour given.
2811 """
2812 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2813
2814 def SetMaskFromImage(*args, **kwargs):
2815 """
2816 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2817
2818 Sets the image's mask so that the pixels that have RGB value of
2819 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2820 by first finding an unused colour in the image, setting this colour as
2821 the mask colour and then using this colour to draw all pixels in the
2822 image who corresponding pixel in mask has given RGB value.
2823
2824 Returns ``False`` if ``mask`` does not have same dimensions as the
2825 image or if there is no unused colour left. Returns ``True`` if the
2826 mask was successfully applied.
2827
2828 Note that this method involves computing the histogram, which is
2829 computationally intensive operation.
2830 """
2831 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2832
2833 def CanRead(*args, **kwargs):
2834 """
2835 CanRead(String filename) -> bool
2836
2837 Returns True if the image handlers can read this file.
2838 """
2839 return _core_.Image_CanRead(*args, **kwargs)
2840
2841 CanRead = staticmethod(CanRead)
2842 def GetImageCount(*args, **kwargs):
2843 """
2844 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2845
2846 If the image file contains more than one image and the image handler
2847 is capable of retrieving these individually, this function will return
2848 the number of available images.
2849 """
2850 return _core_.Image_GetImageCount(*args, **kwargs)
2851
2852 GetImageCount = staticmethod(GetImageCount)
2853 def LoadFile(*args, **kwargs):
2854 """
2855 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2856
2857 Loads an image from a file. If no handler type is provided, the
2858 library will try to autodetect the format.
2859 """
2860 return _core_.Image_LoadFile(*args, **kwargs)
2861
2862 def LoadMimeFile(*args, **kwargs):
2863 """
2864 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2865
2866 Loads an image from a file, specifying the image type with a MIME type
2867 string.
2868 """
2869 return _core_.Image_LoadMimeFile(*args, **kwargs)
2870
2871 def SaveFile(*args, **kwargs):
2872 """
2873 SaveFile(self, String name, int type) -> bool
2874
2875 Saves an image in the named file.
2876 """
2877 return _core_.Image_SaveFile(*args, **kwargs)
2878
2879 def SaveMimeFile(*args, **kwargs):
2880 """
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2882
2883 Saves an image in the named file.
2884 """
2885 return _core_.Image_SaveMimeFile(*args, **kwargs)
2886
2887 def CanReadStream(*args, **kwargs):
2888 """
2889 CanReadStream(InputStream stream) -> bool
2890
2891 Returns True if the image handlers can read an image file from the
2892 data currently on the input stream, or a readable Python file-like
2893 object.
2894 """
2895 return _core_.Image_CanReadStream(*args, **kwargs)
2896
2897 CanReadStream = staticmethod(CanReadStream)
2898 def LoadStream(*args, **kwargs):
2899 """
2900 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2901
2902 Loads an image from an input stream or a readable Python file-like
2903 object. If no handler type is provided, the library will try to
2904 autodetect the format.
2905 """
2906 return _core_.Image_LoadStream(*args, **kwargs)
2907
2908 def LoadMimeStream(*args, **kwargs):
2909 """
2910 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2911
2912 Loads an image from an input stream or a readable Python file-like
2913 object, using a MIME type string to specify the image file format.
2914 """
2915 return _core_.Image_LoadMimeStream(*args, **kwargs)
2916
2917 def IsOk(*args, **kwargs):
2918 """
2919 IsOk(self) -> bool
2920
2921 Returns true if image data is present.
2922 """
2923 return _core_.Image_IsOk(*args, **kwargs)
2924
2925 Ok = IsOk
2926 def GetWidth(*args, **kwargs):
2927 """
2928 GetWidth(self) -> int
2929
2930 Gets the width of the image in pixels.
2931 """
2932 return _core_.Image_GetWidth(*args, **kwargs)
2933
2934 def GetHeight(*args, **kwargs):
2935 """
2936 GetHeight(self) -> int
2937
2938 Gets the height of the image in pixels.
2939 """
2940 return _core_.Image_GetHeight(*args, **kwargs)
2941
2942 def GetSize(*args, **kwargs):
2943 """
2944 GetSize(self) -> Size
2945
2946 Returns the size of the image in pixels.
2947 """
2948 return _core_.Image_GetSize(*args, **kwargs)
2949
2950 def GetSubImage(*args, **kwargs):
2951 """
2952 GetSubImage(self, Rect rect) -> Image
2953
2954 Returns a sub image of the current one as long as the rect belongs
2955 entirely to the image.
2956 """
2957 return _core_.Image_GetSubImage(*args, **kwargs)
2958
2959 def Size(*args, **kwargs):
2960 """
2961 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2962
2963 Returns a resized version of this image without scaling it by adding
2964 either a border with the given colour or cropping as necessary. The
2965 image is pasted into a new image with the given size and background
2966 colour at the position ``pos`` relative to the upper left of the new
2967 image. If red = green = blue = -1 then use either the current mask
2968 colour if set or find, use, and set a suitable mask colour for any
2969 newly exposed areas.
2970 """
2971 return _core_.Image_Size(*args, **kwargs)
2972
2973 def Copy(*args, **kwargs):
2974 """
2975 Copy(self) -> Image
2976
2977 Returns an identical copy of the image.
2978 """
2979 return _core_.Image_Copy(*args, **kwargs)
2980
2981 def Paste(*args, **kwargs):
2982 """
2983 Paste(self, Image image, int x, int y)
2984
2985 Pastes ``image`` into this instance and takes care of the mask colour
2986 and any out of bounds problems.
2987 """
2988 return _core_.Image_Paste(*args, **kwargs)
2989
2990 def GetData(*args, **kwargs):
2991 """
2992 GetData(self) -> PyObject
2993
2994 Returns a string containing a copy of the RGB bytes of the image.
2995 """
2996 return _core_.Image_GetData(*args, **kwargs)
2997
2998 def SetData(*args, **kwargs):
2999 """
3000 SetData(self, buffer data)
3001
3002 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
3003 either a string or a buffer object holding the data and the length of
3004 the data must be width*height*3.
3005 """
3006 return _core_.Image_SetData(*args, **kwargs)
3007
3008 def GetDataBuffer(*args, **kwargs):
3009 """
3010 GetDataBuffer(self) -> PyObject
3011
3012 Returns a writable Python buffer object that is pointing at the RGB
3013 image data buffer inside the wx.Image. You need to ensure that you do
3014 not use this buffer object after the image has been destroyed.
3015 """
3016 return _core_.Image_GetDataBuffer(*args, **kwargs)
3017
3018 def SetDataBuffer(*args, **kwargs):
3019 """
3020 SetDataBuffer(self, buffer data)
3021
3022 Sets the internal image data pointer to point at a Python buffer
3023 object. This can save making an extra copy of the data but you must
3024 ensure that the buffer object lives longer than the wx.Image does.
3025 """
3026 return _core_.Image_SetDataBuffer(*args, **kwargs)
3027
3028 def GetAlphaData(*args, **kwargs):
3029 """
3030 GetAlphaData(self) -> PyObject
3031
3032 Returns a string containing a copy of the alpha bytes of the image.
3033 """
3034 return _core_.Image_GetAlphaData(*args, **kwargs)
3035
3036 def SetAlphaData(*args, **kwargs):
3037 """
3038 SetAlphaData(self, buffer alpha)
3039
3040 Resets the Image's alpha data from a buffer of bytes. Accepts either
3041 a string or a buffer object holding the data and the length of the
3042 data must be width*height.
3043 """
3044 return _core_.Image_SetAlphaData(*args, **kwargs)
3045
3046 def GetAlphaBuffer(*args, **kwargs):
3047 """
3048 GetAlphaBuffer(self) -> PyObject
3049
3050 Returns a writable Python buffer object that is pointing at the Alpha
3051 data buffer inside the wx.Image. You need to ensure that you do not
3052 use this buffer object after the image has been destroyed.
3053 """
3054 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
3055
3056 def SetAlphaBuffer(*args, **kwargs):
3057 """
3058 SetAlphaBuffer(self, buffer alpha)
3059
3060 Sets the internal image alpha pointer to point at a Python buffer
3061 object. This can save making an extra copy of the data but you must
3062 ensure that the buffer object lives as long as the wx.Image does.
3063 """
3064 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
3065
3066 def SetMaskColour(*args, **kwargs):
3067 """
3068 SetMaskColour(self, byte r, byte g, byte b)
3069
3070 Sets the mask colour for this image (and tells the image to use the
3071 mask).
3072 """
3073 return _core_.Image_SetMaskColour(*args, **kwargs)
3074
3075 def GetOrFindMaskColour(*args, **kwargs):
3076 """
3077 GetOrFindMaskColour() -> (r,g,b)
3078
3079 Get the current mask colour or find a suitable colour.
3080 """
3081 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
3082
3083 def GetMaskRed(*args, **kwargs):
3084 """
3085 GetMaskRed(self) -> byte
3086
3087 Gets the red component of the mask colour.
3088 """
3089 return _core_.Image_GetMaskRed(*args, **kwargs)
3090
3091 def GetMaskGreen(*args, **kwargs):
3092 """
3093 GetMaskGreen(self) -> byte
3094
3095 Gets the green component of the mask colour.
3096 """
3097 return _core_.Image_GetMaskGreen(*args, **kwargs)
3098
3099 def GetMaskBlue(*args, **kwargs):
3100 """
3101 GetMaskBlue(self) -> byte
3102
3103 Gets the blue component of the mask colour.
3104 """
3105 return _core_.Image_GetMaskBlue(*args, **kwargs)
3106
3107 def SetMask(*args, **kwargs):
3108 """
3109 SetMask(self, bool mask=True)
3110
3111 Specifies whether there is a mask or not. The area of the mask is
3112 determined by the current mask colour.
3113 """
3114 return _core_.Image_SetMask(*args, **kwargs)
3115
3116 def HasMask(*args, **kwargs):
3117 """
3118 HasMask(self) -> bool
3119
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3121 """
3122 return _core_.Image_HasMask(*args, **kwargs)
3123
3124 def Rotate(*args, **kwargs):
3125 """
3126 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
3127 Point offset_after_rotation=None) -> Image
3128
3129 Rotates the image about the given point, by ``angle`` radians. Passing
3130 ``True`` to ``interpolating`` results in better image quality, but is
3131 slower. If the image has a mask, then the mask colour is used for the
3132 uncovered pixels in the rotated image background. Otherwise, black
3133 will be used as the fill colour.
3134
3135 Returns the rotated image, leaving this image intact.
3136 """
3137 return _core_.Image_Rotate(*args, **kwargs)
3138
3139 def Rotate90(*args, **kwargs):
3140 """
3141 Rotate90(self, bool clockwise=True) -> Image
3142
3143 Returns a copy of the image rotated 90 degrees in the direction
3144 indicated by ``clockwise``.
3145 """
3146 return _core_.Image_Rotate90(*args, **kwargs)
3147
3148 def Mirror(*args, **kwargs):
3149 """
3150 Mirror(self, bool horizontally=True) -> Image
3151
3152 Returns a mirrored copy of the image. The parameter ``horizontally``
3153 indicates the orientation.
3154 """
3155 return _core_.Image_Mirror(*args, **kwargs)
3156
3157 def Replace(*args, **kwargs):
3158 """
3159 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
3160
3161 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
3162 ``(r2,g2,b2)``.
3163 """
3164 return _core_.Image_Replace(*args, **kwargs)
3165
3166 def ConvertToGreyscale(*args, **kwargs):
3167 """
3168 ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
3169
3170 Convert to greyscale image. Uses the luminance component (Y) of the
3171 image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
3172 defaults to ITU-T BT.601
3173 """
3174 return _core_.Image_ConvertToGreyscale(*args, **kwargs)
3175
3176 def ConvertToMono(*args, **kwargs):
3177 """
3178 ConvertToMono(self, byte r, byte g, byte b) -> Image
3179
3180 Returns monochromatic version of the image. The returned image has
3181 white colour where the original has ``(r,g,b)`` colour and black
3182 colour everywhere else.
3183 """
3184 return _core_.Image_ConvertToMono(*args, **kwargs)
3185
3186 def SetOption(*args, **kwargs):
3187 """
3188 SetOption(self, String name, String value)
3189
3190 Sets an image handler defined option. For example, when saving as a
3191 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
3192 number between 0 and 100 (0 is terrible, 100 is very good).
3193 """
3194 return _core_.Image_SetOption(*args, **kwargs)
3195
3196 def SetOptionInt(*args, **kwargs):
3197 """
3198 SetOptionInt(self, String name, int value)
3199
3200 Sets an image option as an integer.
3201 """
3202 return _core_.Image_SetOptionInt(*args, **kwargs)
3203
3204 def GetOption(*args, **kwargs):
3205 """
3206 GetOption(self, String name) -> String
3207
3208 Gets the value of an image handler option.
3209 """
3210 return _core_.Image_GetOption(*args, **kwargs)
3211
3212 def GetOptionInt(*args, **kwargs):
3213 """
3214 GetOptionInt(self, String name) -> int
3215
3216 Gets the value of an image handler option as an integer. If the given
3217 option is not present, the function returns 0.
3218 """
3219 return _core_.Image_GetOptionInt(*args, **kwargs)
3220
3221 def HasOption(*args, **kwargs):
3222 """
3223 HasOption(self, String name) -> bool
3224
3225 Returns true if the given option is present.
3226 """
3227 return _core_.Image_HasOption(*args, **kwargs)
3228
3229 def CountColours(*args, **kwargs):
3230 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
3231 return _core_.Image_CountColours(*args, **kwargs)
3232
3233 def ComputeHistogram(*args, **kwargs):
3234 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
3235 return _core_.Image_ComputeHistogram(*args, **kwargs)
3236
3237 def AddHandler(*args, **kwargs):
3238 """AddHandler(ImageHandler handler)"""
3239 return _core_.Image_AddHandler(*args, **kwargs)
3240
3241 AddHandler = staticmethod(AddHandler)
3242 def InsertHandler(*args, **kwargs):
3243 """InsertHandler(ImageHandler handler)"""
3244 return _core_.Image_InsertHandler(*args, **kwargs)
3245
3246 InsertHandler = staticmethod(InsertHandler)
3247 def RemoveHandler(*args, **kwargs):
3248 """RemoveHandler(String name) -> bool"""
3249 return _core_.Image_RemoveHandler(*args, **kwargs)
3250
3251 RemoveHandler = staticmethod(RemoveHandler)
3252 def GetHandlers(*args, **kwargs):
3253 """GetHandlers() -> PyObject"""
3254 return _core_.Image_GetHandlers(*args, **kwargs)
3255
3256 GetHandlers = staticmethod(GetHandlers)
3257 def GetImageExtWildcard(*args, **kwargs):
3258 """
3259 GetImageExtWildcard() -> String
3260
3261 Iterates all registered wxImageHandler objects, and returns a string
3262 containing file extension masks suitable for passing to file open/save
3263 dialog boxes.
3264 """
3265 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3266
3267 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3268 def ConvertToBitmap(*args, **kwargs):
3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
3270 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3271
3272 def ConvertToMonoBitmap(*args, **kwargs):
3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
3274 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3275
3276 def RotateHue(*args, **kwargs):
3277 """
3278 RotateHue(self, double angle)
3279
3280 Rotates the hue of each pixel of the image. Hue is a double in the
3281 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3282 """
3283 return _core_.Image_RotateHue(*args, **kwargs)
3284
3285 def RGBtoHSV(*args, **kwargs):
3286 """
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3288
3289 Converts a color in RGB color space to HSV color space.
3290 """
3291 return _core_.Image_RGBtoHSV(*args, **kwargs)
3292
3293 RGBtoHSV = staticmethod(RGBtoHSV)
3294 def HSVtoRGB(*args, **kwargs):
3295 """
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3297
3298 Converts a color in HSV color space to RGB color space.
3299 """
3300 return _core_.Image_HSVtoRGB(*args, **kwargs)
3301
3302 HSVtoRGB = staticmethod(HSVtoRGB)
3303 def __nonzero__(self): return self.IsOk()
3304 AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`")
3305 AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`")
3306 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
3307 DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`")
3308 Height = property(GetHeight,doc="See `GetHeight`")
3309 MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`")
3310 MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`")
3311 MaskRed = property(GetMaskRed,doc="See `GetMaskRed`")
3312 Width = property(GetWidth,doc="See `GetWidth`")
3313_core_.Image_swigregister(Image)
3314
3315def ImageFromMime(*args, **kwargs):
3316 """
3317 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3318
3319 Loads an image from a file, using a MIME type string (such as
3320 'image/jpeg') to specify image type.
3321 """
3322 val = _core_.new_ImageFromMime(*args, **kwargs)
3323 return val
3324
3325def ImageFromStream(*args, **kwargs):
3326 """
3327 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3328
3329 Loads an image from an input stream, or any readable Python file-like
3330 object.
3331 """
3332 val = _core_.new_ImageFromStream(*args, **kwargs)
3333 return val
3334
3335def ImageFromStreamMime(*args, **kwargs):
3336 """
3337 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3338
3339 Loads an image from an input stream, or any readable Python file-like
3340 object, specifying the image format with a MIME type string.
3341 """
3342 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3343 return val
3344
3345def EmptyImage(*args, **kwargs):
3346 """
3347 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3348
3349 Construct an empty image of a given size, optionally setting all
3350 pixels to black.
3351 """
3352 val = _core_.new_EmptyImage(*args, **kwargs)
3353 return val
3354
3355def ImageFromBitmap(*args, **kwargs):
3356 """
3357 ImageFromBitmap(Bitmap bitmap) -> Image
3358
3359 Construct an Image from a `wx.Bitmap`.
3360 """
3361 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3362 return val
3363
3364def ImageFromData(*args, **kwargs):
3365 """
3366 ImageFromData(int width, int height, buffer data) -> Image
3367
3368 Construct an Image from a buffer of RGB bytes. Accepts either a
3369 string or a buffer object holding the data and the length of the data
3370 must be width*height*3.
3371 """
3372 val = _core_.new_ImageFromData(*args, **kwargs)
3373 return val
3374
3375def ImageFromDataWithAlpha(*args, **kwargs):
3376 """
3377 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3378
3379 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3380 Accepts either a string or a buffer object holding the data and the
3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
3383 """
3384 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3385 return val
3386
3387def Image_CanRead(*args, **kwargs):
3388 """
3389 Image_CanRead(String filename) -> bool
3390
3391 Returns True if the image handlers can read this file.
3392 """
3393 return _core_.Image_CanRead(*args, **kwargs)
3394
3395def Image_GetImageCount(*args, **kwargs):
3396 """
3397 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3398
3399 If the image file contains more than one image and the image handler
3400 is capable of retrieving these individually, this function will return
3401 the number of available images.
3402 """
3403 return _core_.Image_GetImageCount(*args, **kwargs)
3404
3405def Image_CanReadStream(*args, **kwargs):
3406 """
3407 Image_CanReadStream(InputStream stream) -> bool
3408
3409 Returns True if the image handlers can read an image file from the
3410 data currently on the input stream, or a readable Python file-like
3411 object.
3412 """
3413 return _core_.Image_CanReadStream(*args, **kwargs)
3414
3415def Image_AddHandler(*args, **kwargs):
3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_.Image_AddHandler(*args, **kwargs)
3418
3419def Image_InsertHandler(*args, **kwargs):
3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_.Image_InsertHandler(*args, **kwargs)
3422
3423def Image_RemoveHandler(*args, **kwargs):
3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_.Image_RemoveHandler(*args, **kwargs)
3426
3427def Image_GetHandlers(*args):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_.Image_GetHandlers(*args)
3430
3431def Image_GetImageExtWildcard(*args):
3432 """
3433 Image_GetImageExtWildcard() -> String
3434
3435 Iterates all registered wxImageHandler objects, and returns a string
3436 containing file extension masks suitable for passing to file open/save
3437 dialog boxes.
3438 """
3439 return _core_.Image_GetImageExtWildcard(*args)
3440
3441def Image_RGBtoHSV(*args, **kwargs):
3442 """
3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3444
3445 Converts a color in RGB color space to HSV color space.
3446 """
3447 return _core_.Image_RGBtoHSV(*args, **kwargs)
3448
3449def Image_HSVtoRGB(*args, **kwargs):
3450 """
3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3452
3453 Converts a color in HSV color space to RGB color space.
3454 """
3455 return _core_.Image_HSVtoRGB(*args, **kwargs)
3456
3457
3458def _ImageFromBuffer(*args, **kwargs):
3459 """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image"""
3460 return _core_._ImageFromBuffer(*args, **kwargs)
3461def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None):
3462 """
3463 Creates a `wx.Image` from the data in dataBuffer. The dataBuffer
3464 parameter must be a Python object that implements the buffer interface,
3465 such as a string, array, etc. The dataBuffer object is expected to
3466 contain a series of RGB bytes and be width*height*3 bytes long. A buffer
3467 object can optionally be supplied for the image's alpha channel data, and
3468 it is expected to be width*height bytes long.
3469
3470 The wx.Image will be created with its data and alpha pointers initialized
3471 to the memory address pointed to by the buffer objects, thus saving the
3472 time needed to copy the image data from the buffer object to the wx.Image.
3473 While this has advantages, it also has the shoot-yourself-in-the-foot
3474 risks associated with sharing a C pointer between two objects.
3475
3476 To help alleviate the risk a reference to the data and alpha buffer
3477 objects are kept with the wx.Image, so that they won't get deleted until
3478 after the wx.Image is deleted. However please be aware that it is not
3479 guaranteed that an object won't move its memory buffer to a new location
3480 when it needs to resize its contents. If that happens then the wx.Image
3481 will end up referring to an invalid memory location and could cause the
3482 application to crash. Therefore care should be taken to not manipulate
3483 the objects used for the data and alpha buffers in a way that would cause
3484 them to change size.
3485 """
3486 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3487 image._buffer = dataBuffer
3488 image._alpha = alphaBuffer
3489 return image
3490
3491def InitAllImageHandlers():
3492 """
3493 The former functionality of InitAllImageHanders is now done internal to
3494 the _core_ extension module and so this function has become a simple NOP.
3495 """
3496 pass
3497
3498IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3499IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
3500PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3501PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3502PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
3503BMP_24BPP = _core_.BMP_24BPP
3504BMP_8BPP = _core_.BMP_8BPP
3505BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3506BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3507BMP_8BPP_RED = _core_.BMP_8BPP_RED
3508BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3509BMP_4BPP = _core_.BMP_4BPP
3510BMP_1BPP = _core_.BMP_1BPP
3511BMP_1BPP_BW = _core_.BMP_1BPP_BW
3512class BMPHandler(ImageHandler):
3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
3514 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3515 __repr__ = _swig_repr
3516 def __init__(self, *args, **kwargs):
3517 """
3518 __init__(self) -> BMPHandler
3519
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3521 """
3522 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
3523_core_.BMPHandler_swigregister(BMPHandler)
3524NullImage = cvar.NullImage
3525IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
3526IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3527IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3528IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3529IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
3530IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3531IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
3532IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
3533IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
3534IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3535IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3536IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3537IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
3538IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3539IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
3540
3541class ICOHandler(BMPHandler):
3542 """A `wx.ImageHandler` for \*.ico icon files."""
3543 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3544 __repr__ = _swig_repr
3545 def __init__(self, *args, **kwargs):
3546 """
3547 __init__(self) -> ICOHandler
3548
3549 A `wx.ImageHandler` for \*.ico icon files.
3550 """
3551 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
3552_core_.ICOHandler_swigregister(ICOHandler)
3553
3554class CURHandler(ICOHandler):
3555 """A `wx.ImageHandler` for \*.cur cursor files."""
3556 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3557 __repr__ = _swig_repr
3558 def __init__(self, *args, **kwargs):
3559 """
3560 __init__(self) -> CURHandler
3561
3562 A `wx.ImageHandler` for \*.cur cursor files.
3563 """
3564 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
3565_core_.CURHandler_swigregister(CURHandler)
3566
3567class ANIHandler(CURHandler):
3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
3569 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3570 __repr__ = _swig_repr
3571 def __init__(self, *args, **kwargs):
3572 """
3573 __init__(self) -> ANIHandler
3574
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3576 """
3577 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
3578_core_.ANIHandler_swigregister(ANIHandler)
3579
3580class PNGHandler(ImageHandler):
3581 """A `wx.ImageHandler` for PNG image files."""
3582 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3583 __repr__ = _swig_repr
3584 def __init__(self, *args, **kwargs):
3585 """
3586 __init__(self) -> PNGHandler
3587
3588 A `wx.ImageHandler` for PNG image files.
3589 """
3590 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
3591_core_.PNGHandler_swigregister(PNGHandler)
3592
3593class GIFHandler(ImageHandler):
3594 """A `wx.ImageHandler` for GIF image files."""
3595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3596 __repr__ = _swig_repr
3597 def __init__(self, *args, **kwargs):
3598 """
3599 __init__(self) -> GIFHandler
3600
3601 A `wx.ImageHandler` for GIF image files.
3602 """
3603 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
3604_core_.GIFHandler_swigregister(GIFHandler)
3605
3606class PCXHandler(ImageHandler):
3607 """A `wx.ImageHandler` for PCX imager 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) -> PCXHandler
3613
3614 A `wx.ImageHandler` for PCX imager files.
3615 """
3616 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
3617_core_.PCXHandler_swigregister(PCXHandler)
3618
3619class JPEGHandler(ImageHandler):
3620 """A `wx.ImageHandler` for JPEG/JPG image 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) -> JPEGHandler
3626
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3628 """
3629 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
3630_core_.JPEGHandler_swigregister(JPEGHandler)
3631
3632class PNMHandler(ImageHandler):
3633 """A `wx.ImageHandler` for PNM image 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) -> PNMHandler
3639
3640 A `wx.ImageHandler` for PNM image files.
3641 """
3642 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
3643_core_.PNMHandler_swigregister(PNMHandler)
3644
3645class XPMHandler(ImageHandler):
3646 """A `wx.ImageHandler` for XPM image."""
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) -> XPMHandler
3652
3653 A `wx.ImageHandler` for XPM image.
3654 """
3655 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
3656_core_.XPMHandler_swigregister(XPMHandler)
3657
3658class TIFFHandler(ImageHandler):
3659 """A `wx.ImageHandler` for TIFF 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) -> TIFFHandler
3665
3666 A `wx.ImageHandler` for TIFF image files.
3667 """
3668 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
3669_core_.TIFFHandler_swigregister(TIFFHandler)
3670
3671class TGAHandler(ImageHandler):
3672 """A `wx.ImageHandler` for TGA image 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) -> TGAHandler
3678
3679 A `wx.ImageHandler` for TGA image files.
3680 """
3681 _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs))
3682_core_.TGAHandler_swigregister(TGAHandler)
3683
3684QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3685QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3686class Quantize(object):
3687 """Performs quantization, or colour reduction, on a wxImage."""
3688 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3689 def __init__(self): raise AttributeError, "No constructor defined"
3690 __repr__ = _swig_repr
3691 def Quantize(*args, **kwargs):
3692 """
3693 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3694
3695 Reduce the colours in the source image and put the result into the
3696 destination image, setting the palette in the destination if
3697 needed. Both images may be the same, to overwrite the source image.
3698 """
3699 return _core_.Quantize_Quantize(*args, **kwargs)
3700
3701 Quantize = staticmethod(Quantize)
3702_core_.Quantize_swigregister(Quantize)
3703
3704def Quantize_Quantize(*args, **kwargs):
3705 """
3706 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3707
3708 Reduce the colours in the source image and put the result into the
3709 destination image, setting the palette in the destination if
3710 needed. Both images may be the same, to overwrite the source image.
3711 """
3712 return _core_.Quantize_Quantize(*args, **kwargs)
3713
3714#---------------------------------------------------------------------------
3715
3716class EvtHandler(Object):
3717 """Proxy of C++ EvtHandler class"""
3718 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3719 __repr__ = _swig_repr
3720 def __init__(self, *args, **kwargs):
3721 """__init__(self) -> EvtHandler"""
3722 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
3723 self._setOORInfo(self)
3724
3725 def GetNextHandler(*args, **kwargs):
3726 """GetNextHandler(self) -> EvtHandler"""
3727 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3728
3729 def GetPreviousHandler(*args, **kwargs):
3730 """GetPreviousHandler(self) -> EvtHandler"""
3731 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3732
3733 def SetNextHandler(*args, **kwargs):
3734 """SetNextHandler(self, EvtHandler handler)"""
3735 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3736
3737 def SetPreviousHandler(*args, **kwargs):
3738 """SetPreviousHandler(self, EvtHandler handler)"""
3739 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3740
3741 def GetEvtHandlerEnabled(*args, **kwargs):
3742 """GetEvtHandlerEnabled(self) -> bool"""
3743 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3744
3745 def SetEvtHandlerEnabled(*args, **kwargs):
3746 """SetEvtHandlerEnabled(self, bool enabled)"""
3747 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3748
3749 def ProcessEvent(*args, **kwargs):
3750 """ProcessEvent(self, Event event) -> bool"""
3751 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3752
3753 def AddPendingEvent(*args, **kwargs):
3754 """AddPendingEvent(self, Event event)"""
3755 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3756
3757 def ProcessPendingEvents(*args, **kwargs):
3758 """ProcessPendingEvents(self)"""
3759 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3760
3761 def Connect(*args, **kwargs):
3762 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3763 return _core_.EvtHandler_Connect(*args, **kwargs)
3764
3765 def Disconnect(*args, **kwargs):
3766 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
3767 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3768
3769 def _setOORInfo(*args, **kwargs):
3770 """_setOORInfo(self, PyObject _self, bool incref=True)"""
3771 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3772 args[0].thisown = 0
3773 return val
3774
3775 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3776 """
3777 Bind an event to an event handler.
3778
3779 :param event: One of the EVT_* objects that specifies the
3780 type of event to bind,
3781
3782 :param handler: A callable object to be invoked when the
3783 event is delivered to self. Pass None to
3784 disconnect an event handler.
3785
3786 :param source: Sometimes the event originates from a
3787 different window than self, but you still
3788 want to catch it in self. (For example, a
3789 button event delivered to a frame.) By
3790 passing the source of the event, the event
3791 handling system is able to differentiate
3792 between the same event type from different
3793 controls.
3794
3795 :param id: Used to spcify the event source by ID instead
3796 of instance.
3797
3798 :param id2: Used when it is desirable to bind a handler
3799 to a range of IDs, such as with EVT_MENU_RANGE.
3800 """
3801 if source is not None:
3802 id = source.GetId()
3803 event.Bind(self, id, id2, handler)
3804
3805 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3806 """
3807 Disconencts the event handler binding for event from self.
3808 Returns True if successful.
3809 """
3810 if source is not None:
3811 id = source.GetId()
3812 return event.Unbind(self, id, id2)
3813
3814 EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`")
3815 NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`")
3816 PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`")
3817_core_.EvtHandler_swigregister(EvtHandler)
3818
3819#---------------------------------------------------------------------------
3820
3821class PyEventBinder(object):
3822 """
3823 Instances of this class are used to bind specific events to event
3824 handlers.
3825 """
3826 def __init__(self, evtType, expectedIDs=0):
3827 if expectedIDs not in [0, 1, 2]:
3828 raise ValueError, "Invalid number of expectedIDs"
3829 self.expectedIDs = expectedIDs
3830
3831 if type(evtType) == list or type(evtType) == tuple:
3832 self.evtType = evtType
3833 else:
3834 self.evtType = [evtType]
3835
3836
3837 def Bind(self, target, id1, id2, function):
3838 """Bind this set of event types to target."""
3839 for et in self.evtType:
3840 target.Connect(id1, id2, et, function)
3841
3842
3843 def Unbind(self, target, id1, id2):
3844 """Remove an event binding."""
3845 success = 0
3846 for et in self.evtType:
3847 success += target.Disconnect(id1, id2, et)
3848 return success != 0
3849
3850
3851 def __call__(self, *args):
3852 """
3853 For backwards compatibility with the old EVT_* functions.
3854 Should be called with either (window, func), (window, ID,
3855 func) or (window, ID1, ID2, func) parameters depending on the
3856 type of the event.
3857 """
3858 assert len(args) == 2 + self.expectedIDs
3859 id1 = wx.ID_ANY
3860 id2 = wx.ID_ANY
3861 target = args[0]
3862 if self.expectedIDs == 0:
3863 func = args[1]
3864 elif self.expectedIDs == 1:
3865 id1 = args[1]
3866 func = args[2]
3867 elif self.expectedIDs == 2:
3868 id1 = args[1]
3869 id2 = args[2]
3870 func = args[3]
3871 else:
3872 raise ValueError, "Unexpected number of IDs"
3873
3874 self.Bind(target, id1, id2, func)
3875
3876
3877# These two are square pegs that don't fit the PyEventBinder hole...
3878def EVT_COMMAND(win, id, cmd, func):
3879 win.Connect(id, -1, cmd, func)
3880def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3881 win.Connect(id1, id2, cmd, func)
3882
3883
3884#---------------------------------------------------------------------------
3885
3886#---------------------------------------------------------------------------
3887
3888EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3889EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3890
3891def NewEventType(*args):
3892 """NewEventType() -> EventType"""
3893 return _core_.NewEventType(*args)
3894wxEVT_NULL = _core_.wxEVT_NULL
3895wxEVT_FIRST = _core_.wxEVT_FIRST
3896wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3897wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3898wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3899wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3900wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3901wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3902wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3903wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3904wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3905wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3906wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3907wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3908wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3909wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3910wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3911wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3912wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3913wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3914wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3915wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3916wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3917wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3918wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3919wxEVT_MOTION = _core_.wxEVT_MOTION
3920wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3921wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3922wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3923wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3924wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3925wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3926wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3927wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3928wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3929wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3930wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3931wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3932wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3933wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3934wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3935wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3936wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3937wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3938wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3939wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3940wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3941wxEVT_CHAR = _core_.wxEVT_CHAR
3942wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3943wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3944wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3945wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3946wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3947wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3948wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3949wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3950wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3951wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3952wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3953wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3954wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3955wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3956wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3957wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
3958wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3959wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3960wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3961wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3962wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3963wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3964wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3965wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3966wxEVT_SIZE = _core_.wxEVT_SIZE
3967wxEVT_MOVE = _core_.wxEVT_MOVE
3968wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3969wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3970wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3971wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3972wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3973wxEVT_CREATE = _core_.wxEVT_CREATE
3974wxEVT_DESTROY = _core_.wxEVT_DESTROY
3975wxEVT_SHOW = _core_.wxEVT_SHOW
3976wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3977wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3978wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3979wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
3980wxEVT_PAINT = _core_.wxEVT_PAINT
3981wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3982wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3983wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3984wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3985wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3986wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3987wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3988wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3989wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3990wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3991wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3992wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3993wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3994wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3995wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3996wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3997wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3998wxEVT_IDLE = _core_.wxEVT_IDLE
3999wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
4000wxEVT_SIZING = _core_.wxEVT_SIZING
4001wxEVT_MOVING = _core_.wxEVT_MOVING
4002wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
4003wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY
4004wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT
4005wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE
4006wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
4007wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
4008wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
4009wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
4010wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
4011wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
4012wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
4013#
4014# Create some event binders
4015EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
4016EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
4017EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
4018EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
4019EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
4020EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4021EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4022EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
4023EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
4024EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
4025EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
4026EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
4027EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
4028EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
4029EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
4030EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
4031EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
4032EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
4033EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
4034EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
4035EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
4036EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
4037EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
4038EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
4039EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
4040EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
4041EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
4042EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
4043EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
4044EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
4045EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
4046EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
4047EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
4048EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
4049EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
4050EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
4051EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
4052EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
4053EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
4054EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
4055EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
4056EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
4057
4058EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
4059EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
4060EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
4061EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
4062EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
4063EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
4064EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
4065EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
4066EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
4067EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
4068EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
4069EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
4070EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
4071
4072EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
4073 wxEVT_LEFT_UP,
4074 wxEVT_MIDDLE_DOWN,
4075 wxEVT_MIDDLE_UP,
4076 wxEVT_RIGHT_DOWN,
4077 wxEVT_RIGHT_UP,
4078 wxEVT_MOTION,
4079 wxEVT_LEFT_DCLICK,
4080 wxEVT_MIDDLE_DCLICK,
4081 wxEVT_RIGHT_DCLICK,
4082 wxEVT_ENTER_WINDOW,
4083 wxEVT_LEAVE_WINDOW,
4084 wxEVT_MOUSEWHEEL
4085 ])
4086
4087
4088# Scrolling from wxWindow (sent to wxScrolledWindow)
4089EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
4090 wxEVT_SCROLLWIN_BOTTOM,
4091 wxEVT_SCROLLWIN_LINEUP,
4092 wxEVT_SCROLLWIN_LINEDOWN,
4093 wxEVT_SCROLLWIN_PAGEUP,
4094 wxEVT_SCROLLWIN_PAGEDOWN,
4095 wxEVT_SCROLLWIN_THUMBTRACK,
4096 wxEVT_SCROLLWIN_THUMBRELEASE,
4097 ])
4098
4099EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
4100EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
4101EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
4102EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
4103EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
4104EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
4105EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
4106EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
4107
4108# Scrolling from wx.Slider and wx.ScrollBar
4109EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4110 wxEVT_SCROLL_BOTTOM,
4111 wxEVT_SCROLL_LINEUP,
4112 wxEVT_SCROLL_LINEDOWN,
4113 wxEVT_SCROLL_PAGEUP,
4114 wxEVT_SCROLL_PAGEDOWN,
4115 wxEVT_SCROLL_THUMBTRACK,
4116 wxEVT_SCROLL_THUMBRELEASE,
4117 wxEVT_SCROLL_CHANGED,
4118 ])
4119
4120EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
4121EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
4122EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
4123EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
4124EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
4125EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
4126EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
4127EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
4128EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4129EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
4130
4131# Scrolling from wx.Slider and wx.ScrollBar, with an id
4132EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
4133 wxEVT_SCROLL_BOTTOM,
4134 wxEVT_SCROLL_LINEUP,
4135 wxEVT_SCROLL_LINEDOWN,
4136 wxEVT_SCROLL_PAGEUP,
4137 wxEVT_SCROLL_PAGEDOWN,
4138 wxEVT_SCROLL_THUMBTRACK,
4139 wxEVT_SCROLL_THUMBRELEASE,
4140 wxEVT_SCROLL_CHANGED,
4141 ], 1)
4142
4143EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
4144EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
4145EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
4146EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
4147EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
4148EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
4149EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
4150EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
4151EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4152EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
4153
4154EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
4155EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
4156EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
4157EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
4158EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
4159EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
4160EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
4161EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
4162EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
4163EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
4164
4165EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
4166EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
4167EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
4168EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
4169EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
4170EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
4171EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
4172EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
4173EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
4174
4175
4176EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
4177EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
4178EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
4179EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
4180EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
4181EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
4182EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
4183
4184EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4185
4186EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4187EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4188
4189EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4190
4191EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT )
4192EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY )
4193EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE )
4194
4195
4196#---------------------------------------------------------------------------
4197
4198class Event(Object):
4199 """
4200 An event is a structure holding information about an event passed to a
4201 callback or member function. wx.Event is an abstract base class for
4202 other event classes
4203 """
4204 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4205 def __init__(self): raise AttributeError, "No constructor defined"
4206 __repr__ = _swig_repr
4207 __swig_destroy__ = _core_.delete_Event
4208 __del__ = lambda self : None;
4209 def SetEventType(*args, **kwargs):
4210 """
4211 SetEventType(self, EventType typ)
4212
4213 Sets the specific type of the event.
4214 """
4215 return _core_.Event_SetEventType(*args, **kwargs)
4216
4217 def GetEventType(*args, **kwargs):
4218 """
4219 GetEventType(self) -> EventType
4220
4221 Returns the identifier of the given event type, such as
4222 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4223 """
4224 return _core_.Event_GetEventType(*args, **kwargs)
4225
4226 def GetEventObject(*args, **kwargs):
4227 """
4228 GetEventObject(self) -> Object
4229
4230 Returns the object (usually a window) associated with the event, if
4231 any.
4232 """
4233 return _core_.Event_GetEventObject(*args, **kwargs)
4234
4235 def SetEventObject(*args, **kwargs):
4236 """
4237 SetEventObject(self, Object obj)
4238
4239 Sets the originating object, or in other words, obj is normally the
4240 object that is sending the event.
4241 """
4242 return _core_.Event_SetEventObject(*args, **kwargs)
4243
4244 def GetTimestamp(*args, **kwargs):
4245 """GetTimestamp(self) -> long"""
4246 return _core_.Event_GetTimestamp(*args, **kwargs)
4247
4248 def SetTimestamp(*args, **kwargs):
4249 """SetTimestamp(self, long ts=0)"""
4250 return _core_.Event_SetTimestamp(*args, **kwargs)
4251
4252 def GetId(*args, **kwargs):
4253 """
4254 GetId(self) -> int
4255
4256 Returns the identifier associated with this event, such as a button
4257 command id.
4258 """
4259 return _core_.Event_GetId(*args, **kwargs)
4260
4261 def SetId(*args, **kwargs):
4262 """
4263 SetId(self, int Id)
4264
4265 Set's the ID for the event. This is usually the ID of the window that
4266 is sending the event, but it can also be a command id from a menu
4267 item, etc.
4268 """
4269 return _core_.Event_SetId(*args, **kwargs)
4270
4271 def IsCommandEvent(*args, **kwargs):
4272 """
4273 IsCommandEvent(self) -> bool
4274
4275 Returns true if the event is or is derived from `wx.CommandEvent` else
4276 it returns false. Note: Exists only for optimization purposes.
4277 """
4278 return _core_.Event_IsCommandEvent(*args, **kwargs)
4279
4280 def Skip(*args, **kwargs):
4281 """
4282 Skip(self, bool skip=True)
4283
4284 This method can be used inside an event handler to control whether
4285 further event handlers bound to this event will be called after the
4286 current one returns. Without Skip() (or equivalently if Skip(False) is
4287 used), the event will not be processed any more. If Skip(True) is
4288 called, the event processing system continues searching for a further
4289 handler function for this event, even though it has been processed
4290 already in the current handler.
4291 """
4292 return _core_.Event_Skip(*args, **kwargs)
4293
4294 def GetSkipped(*args, **kwargs):
4295 """
4296 GetSkipped(self) -> bool
4297
4298 Returns true if the event handler should be skipped, false otherwise.
4299 :see: `Skip`
4300 """
4301 return _core_.Event_GetSkipped(*args, **kwargs)
4302
4303 def ShouldPropagate(*args, **kwargs):
4304 """
4305 ShouldPropagate(self) -> bool
4306
4307 Test if this event should be propagated to the parent window or not,
4308 i.e. if the propagation level is currently greater than 0.
4309 """
4310 return _core_.Event_ShouldPropagate(*args, **kwargs)
4311
4312 def StopPropagation(*args, **kwargs):
4313 """
4314 StopPropagation(self) -> int
4315
4316 Stop the event from propagating to its parent window. Returns the old
4317 propagation level value which may be later passed to
4318 `ResumePropagation` to allow propagating the event again.
4319 """
4320 return _core_.Event_StopPropagation(*args, **kwargs)
4321
4322 def ResumePropagation(*args, **kwargs):
4323 """
4324 ResumePropagation(self, int propagationLevel)
4325
4326 Resume the event propagation by restoring the propagation level. (For
4327 example, you can use the value returned by an earlier call to
4328 `StopPropagation`.)
4329
4330 """
4331 return _core_.Event_ResumePropagation(*args, **kwargs)
4332
4333 def Clone(*args, **kwargs):
4334 """Clone(self) -> Event"""
4335 return _core_.Event_Clone(*args, **kwargs)
4336
4337 EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`")
4338 EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`")
4339 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4340 Skipped = property(GetSkipped,doc="See `GetSkipped`")
4341 Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`")
4342_core_.Event_swigregister(Event)
4343
4344#---------------------------------------------------------------------------
4345
4346class PropagationDisabler(object):
4347 """
4348 Helper class to temporarily change an event not to propagate. Simply
4349 create an instance of this class and then whe it is destroyed the
4350 propogation of the event will be restored.
4351 """
4352 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4353 __repr__ = _swig_repr
4354 def __init__(self, *args, **kwargs):
4355 """
4356 __init__(self, Event event) -> PropagationDisabler
4357
4358 Helper class to temporarily change an event not to propagate. Simply
4359 create an instance of this class and then whe it is destroyed the
4360 propogation of the event will be restored.
4361 """
4362 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4363 __swig_destroy__ = _core_.delete_PropagationDisabler
4364 __del__ = lambda self : None;
4365_core_.PropagationDisabler_swigregister(PropagationDisabler)
4366
4367class PropagateOnce(object):
4368 """
4369 A helper class that will temporarily lower propagation level of an
4370 event. Simply create an instance of this class and then whe it is
4371 destroyed the propogation of the event will be restored.
4372 """
4373 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4374 __repr__ = _swig_repr
4375 def __init__(self, *args, **kwargs):
4376 """
4377 __init__(self, Event event) -> PropagateOnce
4378
4379 A helper class that will temporarily lower propagation level of an
4380 event. Simply create an instance of this class and then whe it is
4381 destroyed the propogation of the event will be restored.
4382 """
4383 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4384 __swig_destroy__ = _core_.delete_PropagateOnce
4385 __del__ = lambda self : None;
4386_core_.PropagateOnce_swigregister(PropagateOnce)
4387
4388#---------------------------------------------------------------------------
4389
4390class CommandEvent(Event):
4391 """
4392 This event class contains information about command events, which
4393 originate from a variety of simple controls, as well as menus and
4394 toolbars.
4395 """
4396 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4397 __repr__ = _swig_repr
4398 def __init__(self, *args, **kwargs):
4399 """
4400 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4401
4402 This event class contains information about command events, which
4403 originate from a variety of simple controls, as well as menus and
4404 toolbars.
4405 """
4406 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
4407 def GetSelection(*args, **kwargs):
4408 """
4409 GetSelection(self) -> int
4410
4411 Returns item index for a listbox or choice selection event (not valid
4412 for a deselection).
4413 """
4414 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4415
4416 def SetString(*args, **kwargs):
4417 """SetString(self, String s)"""
4418 return _core_.CommandEvent_SetString(*args, **kwargs)
4419
4420 def GetString(*args, **kwargs):
4421 """
4422 GetString(self) -> String
4423
4424 Returns item string for a listbox or choice selection event (not valid
4425 for a deselection).
4426 """
4427 return _core_.CommandEvent_GetString(*args, **kwargs)
4428
4429 def IsChecked(*args, **kwargs):
4430 """
4431 IsChecked(self) -> bool
4432
4433 This method can be used with checkbox and menu events: for the
4434 checkboxes, the method returns true for a selection event and false
4435 for a deselection one. For the menu events, this method indicates if
4436 the menu item just has become checked or unchecked (and thus only
4437 makes sense for checkable menu items).
4438 """
4439 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4440
4441 Checked = IsChecked
4442 def IsSelection(*args, **kwargs):
4443 """
4444 IsSelection(self) -> bool
4445
4446 For a listbox or similar event, returns true if it is a selection,
4447 false if it is a deselection.
4448 """
4449 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4450
4451 def SetExtraLong(*args, **kwargs):
4452 """SetExtraLong(self, long extraLong)"""
4453 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4454
4455 def GetExtraLong(*args, **kwargs):
4456 """
4457 GetExtraLong(self) -> long
4458
4459 Returns extra information dependant on the event objects type. If the
4460 event comes from a listbox selection, it is a boolean determining
4461 whether the event was a selection (true) or a deselection (false). A
4462 listbox deselection only occurs for multiple-selection boxes, and in
4463 this case the index and string values are indeterminate and the
4464 listbox must be examined by the application.
4465 """
4466 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4467
4468 def SetInt(*args, **kwargs):
4469 """SetInt(self, int i)"""
4470 return _core_.CommandEvent_SetInt(*args, **kwargs)
4471
4472 def GetInt(*args, **kwargs):
4473 """
4474 GetInt(self) -> int
4475
4476 Returns the integer identifier corresponding to a listbox, choice or
4477 radiobox selection (only if the event was a selection, not a
4478 deselection), or a boolean value representing the value of a checkbox.
4479 """
4480 return _core_.CommandEvent_GetInt(*args, **kwargs)
4481
4482 def GetClientData(*args, **kwargs):
4483 """
4484 GetClientData(self) -> PyObject
4485
4486 Returns the client data object for a listbox or choice selection event, (if any.)
4487 """
4488 return _core_.CommandEvent_GetClientData(*args, **kwargs)
4489
4490 def SetClientData(*args, **kwargs):
4491 """
4492 SetClientData(self, PyObject clientData)
4493
4494 Associate the given client data with the item at position n.
4495 """
4496 return _core_.CommandEvent_SetClientData(*args, **kwargs)
4497
4498 GetClientObject = GetClientData
4499 SetClientObject = SetClientData
4500
4501 def Clone(*args, **kwargs):
4502 """Clone(self) -> Event"""
4503 return _core_.CommandEvent_Clone(*args, **kwargs)
4504
4505 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
4506 ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`")
4507 ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`")
4508 Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`")
4509 Selection = property(GetSelection,doc="See `GetSelection`")
4510 String = property(GetString,SetString,doc="See `GetString` and `SetString`")
4511_core_.CommandEvent_swigregister(CommandEvent)
4512
4513#---------------------------------------------------------------------------
4514
4515class NotifyEvent(CommandEvent):
4516 """
4517 An instance of this class (or one of its derived classes) is sent from
4518 a control when the control's state is being changed and the control
4519 allows that change to be prevented from happening. The event handler
4520 can call `Veto` or `Allow` to tell the control what to do.
4521 """
4522 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4523 __repr__ = _swig_repr
4524 def __init__(self, *args, **kwargs):
4525 """
4526 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4527
4528 An instance of this class (or one of its derived classes) is sent from
4529 a control when the control's state is being changed and the control
4530 allows that change to be prevented from happening. The event handler
4531 can call `Veto` or `Allow` to tell the control what to do.
4532 """
4533 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
4534 def Veto(*args, **kwargs):
4535 """
4536 Veto(self)
4537
4538 Prevents the change announced by this event from happening.
4539
4540 It is in general a good idea to notify the user about the reasons for
4541 vetoing the change because otherwise the applications behaviour (which
4542 just refuses to do what the user wants) might be quite surprising.
4543 """
4544 return _core_.NotifyEvent_Veto(*args, **kwargs)
4545
4546 def Allow(*args, **kwargs):
4547 """
4548 Allow(self)
4549
4550 This is the opposite of `Veto`: it explicitly allows the event to be
4551 processed. For most events it is not necessary to call this method as
4552 the events are allowed anyhow but some are forbidden by default (this
4553 will be mentioned in the corresponding event description).
4554 """
4555 return _core_.NotifyEvent_Allow(*args, **kwargs)
4556
4557 def IsAllowed(*args, **kwargs):
4558 """
4559 IsAllowed(self) -> bool
4560
4561 Returns true if the change is allowed (`Veto` hasn't been called) or
4562 false otherwise (if it was).
4563 """
4564 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4565
4566_core_.NotifyEvent_swigregister(NotifyEvent)
4567
4568#---------------------------------------------------------------------------
4569
4570class ScrollEvent(CommandEvent):
4571 """
4572 A scroll event holds information about events sent from stand-alone
4573 scrollbars and sliders. Note that scrolled windows do not send
4574 instnaces of this event class, but send the `wx.ScrollWinEvent`
4575 instead.
4576 """
4577 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4578 __repr__ = _swig_repr
4579 def __init__(self, *args, **kwargs):
4580 """
4581 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4582 int orient=0) -> ScrollEvent
4583 """
4584 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
4585 def GetOrientation(*args, **kwargs):
4586 """
4587 GetOrientation(self) -> int
4588
4589 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4590 the scrollbar.
4591 """
4592 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4593
4594 def GetPosition(*args, **kwargs):
4595 """
4596 GetPosition(self) -> int
4597
4598 Returns the position of the scrollbar.
4599 """
4600 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4601
4602 def SetOrientation(*args, **kwargs):
4603 """SetOrientation(self, int orient)"""
4604 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4605
4606 def SetPosition(*args, **kwargs):
4607 """SetPosition(self, int pos)"""
4608 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4609
4610 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4611 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4612_core_.ScrollEvent_swigregister(ScrollEvent)
4613
4614#---------------------------------------------------------------------------
4615
4616class ScrollWinEvent(Event):
4617 """
4618 A wx.ScrollWinEvent holds information about scrolling and is sent from
4619 scrolling windows.
4620 """
4621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4622 __repr__ = _swig_repr
4623 def __init__(self, *args, **kwargs):
4624 """
4625 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4626
4627 A wx.ScrollWinEvent holds information about scrolling and is sent from
4628 scrolling windows.
4629 """
4630 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
4631 def GetOrientation(*args, **kwargs):
4632 """
4633 GetOrientation(self) -> int
4634
4635 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4636 the scrollbar.
4637 """
4638 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4639
4640 def GetPosition(*args, **kwargs):
4641 """
4642 GetPosition(self) -> int
4643
4644 Returns the position of the scrollbar for the thumb track and release
4645 events. Note that this field can't be used for the other events, you
4646 need to query the window itself for the current position in that case.
4647 """
4648 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4649
4650 def SetOrientation(*args, **kwargs):
4651 """SetOrientation(self, int orient)"""
4652 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4653
4654 def SetPosition(*args, **kwargs):
4655 """SetPosition(self, int pos)"""
4656 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4657
4658 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4659 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
4660_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
4661
4662#---------------------------------------------------------------------------
4663
4664MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4665MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4666MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4667MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4668MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4669class MouseEvent(Event):
4670 """
4671 This event class contains information about the events generated by
4672 the mouse: they include mouse buttons press and release events and
4673 mouse move events.
4674
4675 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4676 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4677 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4678 a middle button so a portable application should avoid relying on the
4679 events from it.
4680
4681 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4682 the former returns true when the event corresponds to the left mouse
4683 button click while the latter returns true if the left mouse button is
4684 currently being pressed. For example, when the user is dragging the
4685 mouse you can use `LeftIsDown` to test whether the left mouse button
4686 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4687 `LeftIsDown` will also return true in wxWidgets whatever the
4688 underlying GUI behaviour is (which is platform-dependent). The same
4689 applies, of course, to other mouse buttons as well.
4690 """
4691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4692 __repr__ = _swig_repr
4693 def __init__(self, *args, **kwargs):
4694 """
4695 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
4696
4697 Constructs a wx.MouseEvent. Valid event types are:
4698
4699 * wxEVT_ENTER_WINDOW
4700 * wxEVT_LEAVE_WINDOW
4701 * wxEVT_LEFT_DOWN
4702 * wxEVT_LEFT_UP
4703 * wxEVT_LEFT_DCLICK
4704 * wxEVT_MIDDLE_DOWN
4705 * wxEVT_MIDDLE_UP
4706 * wxEVT_MIDDLE_DCLICK
4707 * wxEVT_RIGHT_DOWN
4708 * wxEVT_RIGHT_UP
4709 * wxEVT_RIGHT_DCLICK
4710 * wxEVT_MOTION
4711 * wxEVT_MOUSEWHEEL
4712 """
4713 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
4714 def IsButton(*args, **kwargs):
4715 """
4716 IsButton(self) -> bool
4717
4718 Returns true if the event was a mouse button event (not necessarily a
4719 button down event - that may be tested using `ButtonDown`).
4720 """
4721 return _core_.MouseEvent_IsButton(*args, **kwargs)
4722
4723 def ButtonDown(*args, **kwargs):
4724 """
4725 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4726
4727 If the argument is omitted, this returns true if the event was any
4728 mouse button down event. Otherwise the argument specifies which
4729 button-down event shold be checked for (see `Button` for the possible
4730 values).
4731 """
4732 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4733
4734 def ButtonDClick(*args, **kwargs):
4735 """
4736 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4737
4738 If the argument is omitted, this returns true if the event was any
4739 mouse double click event. Otherwise the argument specifies which
4740 double click event to check for (see `Button` for the possible
4741 values).
4742 """
4743 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4744
4745 def ButtonUp(*args, **kwargs):
4746 """
4747 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4748
4749 If the argument is omitted, this returns true if the event was any
4750 mouse button up event. Otherwise the argument specifies which button
4751 up event to check for (see `Button` for the possible values).
4752 """
4753 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4754
4755 def Button(*args, **kwargs):
4756 """
4757 Button(self, int button) -> bool
4758
4759 Returns true if the identified mouse button is changing state. Valid
4760 values of button are:
4761
4762 ==================== =====================================
4763 wx.MOUSE_BTN_LEFT check if left button was pressed
4764 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4765 wx.MOUSE_BTN_RIGHT check if right button was pressed
4766 wx.MOUSE_BTN_ANY check if any button was pressed
4767 ==================== =====================================
4768
4769 """
4770 return _core_.MouseEvent_Button(*args, **kwargs)
4771
4772 def ButtonIsDown(*args, **kwargs):
4773 """ButtonIsDown(self, int but) -> bool"""
4774 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4775
4776 def GetButton(*args, **kwargs):
4777 """
4778 GetButton(self) -> int
4779
4780 Returns the mouse button which generated this event or
4781 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4782 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4783 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4784 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4785 right buttons respectively.
4786 """
4787 return _core_.MouseEvent_GetButton(*args, **kwargs)
4788
4789 def ControlDown(*args, **kwargs):
4790 """
4791 ControlDown(self) -> bool
4792
4793 Returns true if the control key was down at the time of the event.
4794 """
4795 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4796
4797 def MetaDown(*args, **kwargs):
4798 """
4799 MetaDown(self) -> bool
4800
4801 Returns true if the Meta key was down at the time of the event.
4802 """
4803 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4804
4805 def AltDown(*args, **kwargs):
4806 """
4807 AltDown(self) -> bool
4808
4809 Returns true if the Alt key was down at the time of the event.
4810 """
4811 return _core_.MouseEvent_AltDown(*args, **kwargs)
4812
4813 def ShiftDown(*args, **kwargs):
4814 """
4815 ShiftDown(self) -> bool
4816
4817 Returns true if the Shift key was down at the time of the event.
4818 """
4819 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4820
4821 def CmdDown(*args, **kwargs):
4822 """
4823 CmdDown(self) -> bool
4824
4825 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4826 platforms but the special "Apple" (a.k.a as "Command") key on
4827 Macs. It often makes sense to use it instead of, say, `ControlDown`
4828 because Cmd key is used for the same thing under Mac as Ctrl
4829 elsewhere. The Ctrl key still exists, it's just not used for this
4830 purpose. So for non-Mac platforms this is the same as `ControlDown`
4831 and Macs this is the same as `MetaDown`.
4832 """
4833 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4834
4835 def LeftDown(*args, **kwargs):
4836 """
4837 LeftDown(self) -> bool
4838
4839 Returns true if the left mouse button state changed to down.
4840 """
4841 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4842
4843 def MiddleDown(*args, **kwargs):
4844 """
4845 MiddleDown(self) -> bool
4846
4847 Returns true if the middle mouse button state changed to down.
4848 """
4849 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4850
4851 def RightDown(*args, **kwargs):
4852 """
4853 RightDown(self) -> bool
4854
4855 Returns true if the right mouse button state changed to down.
4856 """
4857 return _core_.MouseEvent_RightDown(*args, **kwargs)
4858
4859 def LeftUp(*args, **kwargs):
4860 """
4861 LeftUp(self) -> bool
4862
4863 Returns true if the left mouse button state changed to up.
4864 """
4865 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4866
4867 def MiddleUp(*args, **kwargs):
4868 """
4869 MiddleUp(self) -> bool
4870
4871 Returns true if the middle mouse button state changed to up.
4872 """
4873 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4874
4875 def RightUp(*args, **kwargs):
4876 """
4877 RightUp(self) -> bool
4878
4879 Returns true if the right mouse button state changed to up.
4880 """
4881 return _core_.MouseEvent_RightUp(*args, **kwargs)
4882
4883 def LeftDClick(*args, **kwargs):
4884 """
4885 LeftDClick(self) -> bool
4886
4887 Returns true if the event was a left button double click.
4888 """
4889 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4890
4891 def MiddleDClick(*args, **kwargs):
4892 """
4893 MiddleDClick(self) -> bool
4894
4895 Returns true if the event was a middle button double click.
4896 """
4897 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4898
4899 def RightDClick(*args, **kwargs):
4900 """
4901 RightDClick(self) -> bool
4902
4903 Returns true if the event was a right button double click.
4904 """
4905 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4906
4907 def LeftIsDown(*args, **kwargs):
4908 """
4909 LeftIsDown(self) -> bool
4910
4911 Returns true if the left mouse button is currently down, independent
4912 of the current event type.
4913
4914 Please notice that it is not the same as LeftDown which returns true
4915 if the left mouse button was just pressed. Rather, it describes the
4916 state of the mouse button before the event happened.
4917
4918 This event is usually used in the mouse event handlers which process
4919 "move mouse" messages to determine whether the user is (still)
4920 dragging the mouse.
4921 """
4922 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4923
4924 def MiddleIsDown(*args, **kwargs):
4925 """
4926 MiddleIsDown(self) -> bool
4927
4928 Returns true if the middle mouse button is currently down, independent
4929 of the current event type.
4930 """
4931 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4932
4933 def RightIsDown(*args, **kwargs):
4934 """
4935 RightIsDown(self) -> bool
4936
4937 Returns true if the right mouse button is currently down, independent
4938 of the current event type.
4939 """
4940 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4941
4942 def Dragging(*args, **kwargs):
4943 """
4944 Dragging(self) -> bool
4945
4946 Returns true if this was a dragging event (motion while a button is
4947 depressed).
4948 """
4949 return _core_.MouseEvent_Dragging(*args, **kwargs)
4950
4951 def Moving(*args, **kwargs):
4952 """
4953 Moving(self) -> bool
4954
4955 Returns true if this was a motion event and no mouse buttons were
4956 pressed. If any mouse button is held pressed, then this method returns
4957 false and Dragging returns true.
4958 """
4959 return _core_.MouseEvent_Moving(*args, **kwargs)
4960
4961 def Entering(*args, **kwargs):
4962 """
4963 Entering(self) -> bool
4964
4965 Returns true if the mouse was entering the window.
4966 """
4967 return _core_.MouseEvent_Entering(*args, **kwargs)
4968
4969 def Leaving(*args, **kwargs):
4970 """
4971 Leaving(self) -> bool
4972
4973 Returns true if the mouse was leaving the window.
4974 """
4975 return _core_.MouseEvent_Leaving(*args, **kwargs)
4976
4977 def GetPosition(*args, **kwargs):
4978 """
4979 GetPosition(self) -> Point
4980
4981 Returns the pixel position of the mouse in window coordinates when the
4982 event happened.
4983 """
4984 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4985
4986 def GetPositionTuple(*args, **kwargs):
4987 """
4988 GetPositionTuple() -> (x,y)
4989
4990 Returns the pixel position of the mouse in window coordinates when the
4991 event happened.
4992 """
4993 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4994
4995 def GetLogicalPosition(*args, **kwargs):
4996 """
4997 GetLogicalPosition(self, DC dc) -> Point
4998
4999 Returns the logical mouse position in pixels (i.e. translated
5000 according to the translation set for the DC, which usually indicates
5001 that the window has been scrolled).
5002 """
5003 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
5004
5005 def GetX(*args, **kwargs):
5006 """
5007 GetX(self) -> int
5008
5009 Returns X coordinate of the physical mouse event position.
5010 """
5011 return _core_.MouseEvent_GetX(*args, **kwargs)
5012
5013 def GetY(*args, **kwargs):
5014 """
5015 GetY(self) -> int
5016
5017 Returns Y coordinate of the physical mouse event position.
5018 """
5019 return _core_.MouseEvent_GetY(*args, **kwargs)
5020
5021 def GetWheelRotation(*args, **kwargs):
5022 """
5023 GetWheelRotation(self) -> int
5024
5025 Get wheel rotation, positive or negative indicates direction of
5026 rotation. Current devices all send an event when rotation is equal to
5027 +/-WheelDelta, but this allows for finer resolution devices to be
5028 created in the future. Because of this you shouldn't assume that one
5029 event is equal to 1 line or whatever, but you should be able to either
5030 do partial line scrolling or wait until +/-WheelDelta rotation values
5031 have been accumulated before scrolling.
5032 """
5033 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
5034
5035 def GetWheelDelta(*args, **kwargs):
5036 """
5037 GetWheelDelta(self) -> int
5038
5039 Get wheel delta, normally 120. This is the threshold for action to be
5040 taken, and one such action (for example, scrolling one increment)
5041 should occur for each delta.
5042 """
5043 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
5044
5045 def GetLinesPerAction(*args, **kwargs):
5046 """
5047 GetLinesPerAction(self) -> int
5048
5049 Returns the configured number of lines (or whatever) to be scrolled
5050 per wheel action. Defaults to three.
5051 """
5052 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
5053
5054 def IsPageScroll(*args, **kwargs):
5055 """
5056 IsPageScroll(self) -> bool
5057
5058 Returns true if the system has been setup to do page scrolling with
5059 the mouse wheel instead of line scrolling.
5060 """
5061 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
5062
5063 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
5064 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
5065 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
5066 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
5067 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
5068 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
5069 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
5070 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
5071 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
5072 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
5073 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
5074 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
5075 Button = property(GetButton,doc="See `GetButton`")
5076 LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`")
5077 LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`")
5078 Position = property(GetPosition,doc="See `GetPosition`")
5079 WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`")
5080 WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`")
5081 X = property(GetX,doc="See `GetX`")
5082 Y = property(GetY,doc="See `GetY`")
5083_core_.MouseEvent_swigregister(MouseEvent)
5084
5085#---------------------------------------------------------------------------
5086
5087class SetCursorEvent(Event):
5088 """
5089 A SetCursorEvent is generated when the mouse cursor is about to be set
5090 as a result of mouse motion. This event gives the application the
5091 chance to perform specific mouse cursor processing based on the
5092 current position of the mouse within the window. Use the `SetCursor`
5093 method to specify the cursor you want to be displayed.
5094 """
5095 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5096 __repr__ = _swig_repr
5097 def __init__(self, *args, **kwargs):
5098 """
5099 __init__(self, int x=0, int y=0) -> SetCursorEvent
5100
5101 Construct a new `wx.SetCursorEvent`.
5102 """
5103 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
5104 def GetX(*args, **kwargs):
5105 """
5106 GetX(self) -> int
5107
5108 Returns the X coordinate of the mouse in client coordinates.
5109 """
5110 return _core_.SetCursorEvent_GetX(*args, **kwargs)
5111
5112 def GetY(*args, **kwargs):
5113 """
5114 GetY(self) -> int
5115
5116 Returns the Y coordinate of the mouse in client coordinates.
5117 """
5118 return _core_.SetCursorEvent_GetY(*args, **kwargs)
5119
5120 def SetCursor(*args, **kwargs):
5121 """
5122 SetCursor(self, Cursor cursor)
5123
5124 Sets the cursor associated with this event.
5125 """
5126 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
5127
5128 def GetCursor(*args, **kwargs):
5129 """
5130 GetCursor(self) -> Cursor
5131
5132 Returns a reference to the cursor specified by this event.
5133 """
5134 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
5135
5136 def HasCursor(*args, **kwargs):
5137 """
5138 HasCursor(self) -> bool
5139
5140 Returns true if the cursor specified by this event is a valid cursor.
5141 """
5142 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
5143
5144 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5145 X = property(GetX,doc="See `GetX`")
5146 Y = property(GetY,doc="See `GetY`")
5147_core_.SetCursorEvent_swigregister(SetCursorEvent)
5148
5149#---------------------------------------------------------------------------
5150
5151class KeyEvent(Event):
5152 """
5153 This event class contains information about keypress and character
5154 events. These events are only sent to the widget that currently has
5155 the keyboard focus.
5156
5157 Notice that there are three different kinds of keyboard events in
5158 wxWidgets: key down and up events and char events. The difference
5159 between the first two is clear - the first corresponds to a key press
5160 and the second to a key release - otherwise they are identical. Just
5161 note that if the key is maintained in a pressed state you will
5162 typically get a lot of (automatically generated) down events but only
5163 one up so it is wrong to assume that there is one up event
5164 corresponding to each down one.
5165
5166 Both key events provide untranslated key codes while the char event
5167 carries the translated one. The untranslated code for alphanumeric
5168 keys is always an upper case value. For the other keys it is one of
5169 WXK_XXX values from the keycodes table. The translated key is, in
5170 general, the character the user expects to appear as the result of the
5171 key combination when typing the text into a text entry zone, for
5172 example.
5173
5174 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5175 and the standard US keyboard): when the 'A' key is pressed, the key
5176 down event key code is equal to ASCII A == 65. But the char event key
5177 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5178 'A' keys simultaneously , the key code in key down event will still be
5179 just 'A' while the char event key code parameter will now be 'A' as
5180 well.
5181
5182 Although in this simple case it is clear that the correct key code
5183 could be found in the key down event handler by checking the value
5184 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5185 as for non alphanumeric keys or non-US keyboard layouts the
5186 translation is keyboard-layout dependent and can only be done properly
5187 by the system itself.
5188
5189 Another kind of translation is done when the control key is pressed:
5190 for example, for CTRL-A key press the key down event still carries the
5191 same key code 'A' as usual but the char event will have key code of 1,
5192 the ASCII value of this key combination.
5193
5194 You may discover how the other keys on your system behave
5195 interactively by running the KeyEvents sample in the wxPython demo and
5196 pressing some keys while the blue box at the top has the keyboard
5197 focus.
5198
5199 **Note**: If a key down event is caught and the event handler does not
5200 call event.Skip() then the coresponding char event will not
5201 happen. This is by design and enables the programs that handle both
5202 types of events to be a bit simpler.
5203
5204 **Note for Windows programmers**: The key and char events in wxWidgets
5205 are similar to but slightly different from Windows WM_KEYDOWN and
5206 WM_CHAR events. In particular, Alt-x combination will generate a char
5207 event in wxWidgets (unless it is used as an accelerator).
5208
5209 **Tip**: be sure to call event.Skip() for events that you don't
5210 process in key event function, otherwise menu shortcuts may cease to
5211 work under Windows.
5212
5213 """
5214 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5215 __repr__ = _swig_repr
5216 def __init__(self, *args, **kwargs):
5217 """
5218 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5219
5220 Construct a new `wx.KeyEvent`. Valid event types are:
5221 *
5222 """
5223 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
5224 def GetModifiers(*args, **kwargs):
5225 """
5226 GetModifiers(self) -> int
5227
5228 Returns a bitmask of the current modifier settings. Can be used to
5229 check if the key event has exactly the given modifiers without having
5230 to explicitly check that the other modifiers are not down. For
5231 example::
5232
5233 if event.GetModifers() == wx.MOD_CONTROL:
5234 DoSomething()
5235
5236 """
5237 return _core_.KeyEvent_GetModifiers(*args, **kwargs)
5238
5239 def ControlDown(*args, **kwargs):
5240 """
5241 ControlDown(self) -> bool
5242
5243 Returns ``True`` if the Control key was down at the time of the event.
5244 """
5245 return _core_.KeyEvent_ControlDown(*args, **kwargs)
5246
5247 def MetaDown(*args, **kwargs):
5248 """
5249 MetaDown(self) -> bool
5250
5251 Returns ``True`` if the Meta key was down at the time of the event.
5252 """
5253 return _core_.KeyEvent_MetaDown(*args, **kwargs)
5254
5255 def AltDown(*args, **kwargs):
5256 """
5257 AltDown(self) -> bool
5258
5259 Returns ``True`` if the Alt key was down at the time of the event.
5260 """
5261 return _core_.KeyEvent_AltDown(*args, **kwargs)
5262
5263 def ShiftDown(*args, **kwargs):
5264 """
5265 ShiftDown(self) -> bool
5266
5267 Returns ``True`` if the Shift key was down at the time of the event.
5268 """
5269 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5270
5271 def CmdDown(*args, **kwargs):
5272 """
5273 CmdDown(self) -> bool
5274
5275 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5276 platforms but the special "Apple" (a.k.a as "Command") key on
5277 Macs. It makes often sense to use it instead of, say, `ControlDown`
5278 because Cmd key is used for the same thing under Mac as Ctrl
5279 elsewhere. The Ctrl still exists, it's just not used for this
5280 purpose. So for non-Mac platforms this is the same as `ControlDown`
5281 and Macs this is the same as `MetaDown`.
5282 """
5283 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5284
5285 def HasModifiers(*args, **kwargs):
5286 """
5287 HasModifiers(self) -> bool
5288
5289 Returns true if either CTRL or ALT keys was down at the time of the
5290 key event. Note that this function does not take into account neither
5291 SHIFT nor META key states (the reason for ignoring the latter is that
5292 it is common for NUMLOCK key to be configured as META under X but the
5293 key presses even while NUMLOCK is on should be still processed
5294 normally).
5295 """
5296 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5297
5298 def GetKeyCode(*args, **kwargs):
5299 """
5300 GetKeyCode(self) -> int
5301
5302 Returns the virtual key code. ASCII events return normal ASCII values,
5303 while non-ASCII events return values such as WXK_LEFT for the left
5304 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5305 codes.
5306
5307 Note that in Unicode build, the returned value is meaningful only if
5308 the user entered a character that can be represented in current
5309 locale's default charset. You can obtain the corresponding Unicode
5310 character using `GetUnicodeKey`.
5311 """
5312 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5313
5314 def GetUnicodeKey(*args, **kwargs):
5315 """
5316 GetUnicodeKey(self) -> int
5317
5318 Returns the Unicode character corresponding to this key event. This
5319 function is only meaningfule in a Unicode build of wxPython.
5320 """
5321 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
5322
5323 GetUniChar = GetUnicodeKey
5324 def SetUnicodeKey(*args, **kwargs):
5325 """
5326 SetUnicodeKey(self, int uniChar)
5327
5328 Set the Unicode value of the key event, but only if this is a Unicode
5329 build of wxPython.
5330 """
5331 return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs)
5332
5333 def GetRawKeyCode(*args, **kwargs):
5334 """
5335 GetRawKeyCode(self) -> unsigned int
5336
5337 Returns the raw key code for this event. This is a platform-dependent
5338 scan code which should only be used in advanced
5339 applications. Currently the raw key codes are not supported by all
5340 ports.
5341 """
5342 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5343
5344 def GetRawKeyFlags(*args, **kwargs):
5345 """
5346 GetRawKeyFlags(self) -> unsigned int
5347
5348 Returns the low level key flags for this event. The flags are
5349 platform-dependent and should only be used in advanced applications.
5350 Currently the raw key flags are not supported by all ports.
5351 """
5352 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5353
5354 def GetPosition(*args, **kwargs):
5355 """
5356 GetPosition(self) -> Point
5357
5358 Find the position of the event, if applicable.
5359 """
5360 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5361
5362 def GetPositionTuple(*args, **kwargs):
5363 """
5364 GetPositionTuple() -> (x,y)
5365
5366 Find the position of the event, if applicable.
5367 """
5368 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5369
5370 def GetX(*args, **kwargs):
5371 """
5372 GetX(self) -> int
5373
5374 Returns the X position (in client coordinates) of the event, if
5375 applicable.
5376 """
5377 return _core_.KeyEvent_GetX(*args, **kwargs)
5378
5379 def GetY(*args, **kwargs):
5380 """
5381 GetY(self) -> int
5382
5383 Returns the Y position (in client coordinates) of the event, if
5384 applicable.
5385 """
5386 return _core_.KeyEvent_GetY(*args, **kwargs)
5387
5388 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5389 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5390 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5391 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5392 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5393 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5394 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5395 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5396 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5397 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5398 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5399 Modifiers = property(GetModifiers,doc="See `GetModifiers`")
5400 Position = property(GetPosition,doc="See `GetPosition`")
5401 RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`")
5402 RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`")
5403 UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`")
5404 X = property(GetX,doc="See `GetX`")
5405 Y = property(GetY,doc="See `GetY`")
5406_core_.KeyEvent_swigregister(KeyEvent)
5407
5408#---------------------------------------------------------------------------
5409
5410class SizeEvent(Event):
5411 """
5412 A size event holds information about size change events. The EVT_SIZE
5413 handler function will be called when the window it is bound to has
5414 been resized.
5415
5416 Note that the size passed is of the whole window: call
5417 `wx.Window.GetClientSize` for the area which may be used by the
5418 application.
5419
5420 When a window is resized, usually only a small part of the window is
5421 damaged and and that area is all that is in the update region for the
5422 next paint event. However, if your drawing depends on the size of the
5423 window, you may need to clear the DC explicitly and repaint the whole
5424 window. In which case, you may need to call `wx.Window.Refresh` to
5425 invalidate the entire window.
5426
5427 """
5428 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5429 __repr__ = _swig_repr
5430 def __init__(self, *args, **kwargs):
5431 """
5432 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5433
5434 Construct a new ``wx.SizeEvent``.
5435 """
5436 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
5437 def GetSize(*args, **kwargs):
5438 """
5439 GetSize(self) -> Size
5440
5441 Returns the entire size of the window generating the size change
5442 event.
5443 """
5444 return _core_.SizeEvent_GetSize(*args, **kwargs)
5445
5446 def GetRect(*args, **kwargs):
5447 """GetRect(self) -> Rect"""
5448 return _core_.SizeEvent_GetRect(*args, **kwargs)
5449
5450 def SetRect(*args, **kwargs):
5451 """SetRect(self, Rect rect)"""
5452 return _core_.SizeEvent_SetRect(*args, **kwargs)
5453
5454 def SetSize(*args, **kwargs):
5455 """SetSize(self, Size size)"""
5456 return _core_.SizeEvent_SetSize(*args, **kwargs)
5457
5458 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5459 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5460 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5461 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
5462_core_.SizeEvent_swigregister(SizeEvent)
5463
5464#---------------------------------------------------------------------------
5465
5466class MoveEvent(Event):
5467 """
5468 This event object is sent for EVT_MOVE event bindings when a window is
5469 moved to a new position.
5470 """
5471 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5472 __repr__ = _swig_repr
5473 def __init__(self, *args, **kwargs):
5474 """
5475 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5476
5477 Constructor.
5478 """
5479 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
5480 def GetPosition(*args, **kwargs):
5481 """
5482 GetPosition(self) -> Point
5483
5484 Returns the position of the window generating the move change event.
5485 """
5486 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5487
5488 def GetRect(*args, **kwargs):
5489 """GetRect(self) -> Rect"""
5490 return _core_.MoveEvent_GetRect(*args, **kwargs)
5491
5492 def SetRect(*args, **kwargs):
5493 """SetRect(self, Rect rect)"""
5494 return _core_.MoveEvent_SetRect(*args, **kwargs)
5495
5496 def SetPosition(*args, **kwargs):
5497 """SetPosition(self, Point pos)"""
5498 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5499
5500 m_pos = property(GetPosition, SetPosition)
5501 m_rect = property(GetRect, SetRect)
5502
5503 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5504 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5505_core_.MoveEvent_swigregister(MoveEvent)
5506
5507#---------------------------------------------------------------------------
5508
5509class PaintEvent(Event):
5510 """
5511 A paint event is sent when a window's contents needs to be repainted.
5512 Note that in an EVT_PAINT handler the application must *always* create
5513 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5514 Windows assumes that the window has not been painted yet and will send
5515 the event again, causing endless refreshes.
5516
5517 You can optimize painting by retrieving the rectangles that have been
5518 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5519 and only repainting these rectangles. The rectangles are in terms of
5520 the client area, and are unscrolled, so you will need to do some
5521 calculations using the current view position to obtain logical,
5522 scrolled units.
5523
5524 """
5525 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5526 __repr__ = _swig_repr
5527 def __init__(self, *args, **kwargs):
5528 """__init__(self, int Id=0) -> PaintEvent"""
5529 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
5530_core_.PaintEvent_swigregister(PaintEvent)
5531
5532class NcPaintEvent(Event):
5533 """Proxy of C++ NcPaintEvent class"""
5534 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5535 __repr__ = _swig_repr
5536 def __init__(self, *args, **kwargs):
5537 """__init__(self, int winid=0) -> NcPaintEvent"""
5538 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
5539_core_.NcPaintEvent_swigregister(NcPaintEvent)
5540
5541#---------------------------------------------------------------------------
5542
5543class EraseEvent(Event):
5544 """
5545 An erase event is sent whenever the background of a window needs to be
5546 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5547 binder. On some platforms, such as GTK+, this event is simulated
5548 (simply generated just before the paint event) and may cause flicker.
5549
5550 To paint a custom background use the `GetDC` method and use the returned
5551 device context if it is not ``None``, otherwise create a temporary
5552 `wx.ClientDC` and draw on that.
5553
5554 """
5555 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5556 __repr__ = _swig_repr
5557 def __init__(self, *args, **kwargs):
5558 """
5559 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5560
5561 Constructor
5562 """
5563 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
5564 def GetDC(*args, **kwargs):
5565 """
5566 GetDC(self) -> DC
5567
5568 Returns the device context the event handler should draw upon. If
5569 ``None`` is returned then create a temporary `wx.ClientDC` and use
5570 that instead.
5571 """
5572 return _core_.EraseEvent_GetDC(*args, **kwargs)
5573
5574 DC = property(GetDC,doc="See `GetDC`")
5575_core_.EraseEvent_swigregister(EraseEvent)
5576
5577#---------------------------------------------------------------------------
5578
5579class FocusEvent(Event):
5580 """
5581 A focus event is sent when a window's focus changes. The window losing
5582 focus receives an EVT_KILL_FOCUS event while the window gaining it
5583 gets an EVT_SET_FOCUS event.
5584
5585 Notice that the set focus event happens both when the user gives focus
5586 to the window (whether using the mouse or keyboard) and when it is
5587 done from the program itself using `wx.Window.SetFocus`.
5588
5589 """
5590 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5591 __repr__ = _swig_repr
5592 def __init__(self, *args, **kwargs):
5593 """
5594 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5595
5596 Constructor
5597 """
5598 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
5599 def GetWindow(*args, **kwargs):
5600 """
5601 GetWindow(self) -> Window
5602
5603 Returns the other window associated with this event, that is the
5604 window which had the focus before for the EVT_SET_FOCUS event and the
5605 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5606
5607 Warning: the window returned may be None!
5608 """
5609 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5610
5611 def SetWindow(*args, **kwargs):
5612 """SetWindow(self, Window win)"""
5613 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5614
5615 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
5616_core_.FocusEvent_swigregister(FocusEvent)
5617
5618#---------------------------------------------------------------------------
5619
5620class ChildFocusEvent(CommandEvent):
5621 """
5622 A child focus event is sent to a (parent-)window when one of its child
5623 windows gains focus, so that the window could restore the focus back
5624 to its corresponding child if it loses it now and regains later.
5625
5626 Notice that child window is the direct child of the window receiving
5627 the event, and so may not be the actual widget recieving focus if it
5628 is further down the containment heirarchy. Use `wx.Window.FindFocus`
5629 to get the widget that is actually receiving focus.
5630 """
5631 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5632 __repr__ = _swig_repr
5633 def __init__(self, *args, **kwargs):
5634 """
5635 __init__(self, Window win=None) -> ChildFocusEvent
5636
5637 Constructor
5638 """
5639 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
5640 def GetWindow(*args, **kwargs):
5641 """
5642 GetWindow(self) -> Window
5643
5644 The window, or (grand)parent of the window which has just received the
5645 focus.
5646 """
5647 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5648
5649 Window = property(GetWindow,doc="See `GetWindow`")
5650_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
5651
5652#---------------------------------------------------------------------------
5653
5654class ActivateEvent(Event):
5655 """
5656 An activate event is sent when a top-level window or the entire
5657 application is being activated or deactivated.
5658
5659 A top-level window (a dialog or frame) receives an activate event when
5660 is being activated or deactivated. This is indicated visually by the
5661 title bar changing colour, and a subwindow gaining the keyboard focus.
5662 An application is activated or deactivated when one of its frames
5663 becomes activated, or a frame becomes inactivate resulting in all
5664 application frames being inactive.
5665
5666 Please note that usually you should call event.Skip() in your handlers
5667 for these events so the default handlers will still be called, as not
5668 doing so can result in strange effects.
5669
5670 """
5671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5672 __repr__ = _swig_repr
5673 def __init__(self, *args, **kwargs):
5674 """
5675 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5676
5677 Constructor
5678 """
5679 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
5680 def GetActive(*args, **kwargs):
5681 """
5682 GetActive(self) -> bool
5683
5684 Returns true if the application or window is being activated, false
5685 otherwise.
5686 """
5687 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5688
5689 Active = property(GetActive,doc="See `GetActive`")
5690_core_.ActivateEvent_swigregister(ActivateEvent)
5691
5692#---------------------------------------------------------------------------
5693
5694class InitDialogEvent(Event):
5695 """
5696 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5697 any window when `wx.Window.InitDialog` is called. Handlers for this
5698 event can transfer data to the window, or anything else that should be
5699 done before the user begins editing the form. The default handler
5700 calls `wx.Window.TransferDataToWindow`.
5701 """
5702 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5703 __repr__ = _swig_repr
5704 def __init__(self, *args, **kwargs):
5705 """
5706 __init__(self, int Id=0) -> InitDialogEvent
5707
5708 Constructor
5709 """
5710 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
5711_core_.InitDialogEvent_swigregister(InitDialogEvent)
5712
5713#---------------------------------------------------------------------------
5714
5715class MenuEvent(Event):
5716 """
5717 This class is used for a variety of menu-related events. Note that
5718 these do not include menu command events, which are handled by sending
5719 `wx.CommandEvent` objects.
5720
5721 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5722 text in the first field of the status bar.
5723 """
5724 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5725 __repr__ = _swig_repr
5726 def __init__(self, *args, **kwargs):
5727 """
5728 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5729
5730 Constructor
5731 """
5732 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
5733 def GetMenuId(*args, **kwargs):
5734 """
5735 GetMenuId(self) -> int
5736
5737 Returns the menu identifier associated with the event. This method
5738 should be only used with the HIGHLIGHT events.
5739 """
5740 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5741
5742 def IsPopup(*args, **kwargs):
5743 """
5744 IsPopup(self) -> bool
5745
5746 Returns ``True`` if the menu which is being opened or closed is a
5747 popup menu, ``False`` if it is a normal one. This method should only
5748 be used with the OPEN and CLOSE events.
5749 """
5750 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5751
5752 def GetMenu(*args, **kwargs):
5753 """
5754 GetMenu(self) -> Menu
5755
5756 Returns the menu which is being opened or closed. This method should
5757 only be used with the OPEN and CLOSE events.
5758 """
5759 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5760
5761 Menu = property(GetMenu,doc="See `GetMenu`")
5762 MenuId = property(GetMenuId,doc="See `GetMenuId`")
5763_core_.MenuEvent_swigregister(MenuEvent)
5764
5765#---------------------------------------------------------------------------
5766
5767class CloseEvent(Event):
5768 """
5769 This event class contains information about window and session close
5770 events.
5771
5772 The handler function for EVT_CLOSE is called when the user has tried
5773 to close a a frame or dialog box using the window manager controls or
5774 the system menu. It can also be invoked by the application itself
5775 programmatically, for example by calling the `wx.Window.Close`
5776 function.
5777
5778 You should check whether the application is forcing the deletion of
5779 the window using `CanVeto`. If it returns ``False``, you must destroy
5780 the window using `wx.Window.Destroy`. If the return value is ``True``,
5781 it is up to you whether you respond by destroying the window or not.
5782 For example you may wish to display a message dialog prompting to save
5783 files or to cancel the close.
5784
5785 If you don't destroy the window, you should call `Veto` to let the
5786 calling code know that you did not destroy the window. This allows the
5787 `wx.Window.Close` function to return ``True`` or ``False`` depending
5788 on whether the close instruction was honored or not.
5789 """
5790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5791 __repr__ = _swig_repr
5792 def __init__(self, *args, **kwargs):
5793 """
5794 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5795
5796 Constructor.
5797 """
5798 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
5799 def SetLoggingOff(*args, **kwargs):
5800 """
5801 SetLoggingOff(self, bool logOff)
5802
5803 Sets the 'logging off' flag.
5804 """
5805 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5806
5807 def GetLoggingOff(*args, **kwargs):
5808 """
5809 GetLoggingOff(self) -> bool
5810
5811 Returns ``True`` if the user is logging off or ``False`` if the
5812 system is shutting down. This method can only be called for end
5813 session and query end session events, it doesn't make sense for close
5814 window event.
5815 """
5816 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5817
5818 def Veto(*args, **kwargs):
5819 """
5820 Veto(self, bool veto=True)
5821
5822 Call this from your event handler to veto a system shutdown or to
5823 signal to the calling application that a window close did not happen.
5824
5825 You can only veto a shutdown or close if `CanVeto` returns true.
5826 """
5827 return _core_.CloseEvent_Veto(*args, **kwargs)
5828
5829 def GetVeto(*args, **kwargs):
5830 """GetVeto(self) -> bool"""
5831 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5832
5833 def SetCanVeto(*args, **kwargs):
5834 """
5835 SetCanVeto(self, bool canVeto)
5836
5837 Sets the 'can veto' flag.
5838 """
5839 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5840
5841 def CanVeto(*args, **kwargs):
5842 """
5843 CanVeto(self) -> bool
5844
5845 Returns true if you can veto a system shutdown or a window close
5846 event. Vetoing a window close event is not possible if the calling
5847 code wishes to force the application to exit, and so this function
5848 must be called to check this.
5849 """
5850 return _core_.CloseEvent_CanVeto(*args, **kwargs)
5851
5852 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
5853_core_.CloseEvent_swigregister(CloseEvent)
5854
5855#---------------------------------------------------------------------------
5856
5857class ShowEvent(Event):
5858 """An EVT_SHOW event is sent when a window is shown or hidden."""
5859 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5860 __repr__ = _swig_repr
5861 def __init__(self, *args, **kwargs):
5862 """
5863 __init__(self, int winid=0, bool show=False) -> ShowEvent
5864
5865 An EVT_SHOW event is sent when a window is shown or hidden.
5866 """
5867 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
5868 def SetShow(*args, **kwargs):
5869 """SetShow(self, bool show)"""
5870 return _core_.ShowEvent_SetShow(*args, **kwargs)
5871
5872 def GetShow(*args, **kwargs):
5873 """GetShow(self) -> bool"""
5874 return _core_.ShowEvent_GetShow(*args, **kwargs)
5875
5876 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
5877_core_.ShowEvent_swigregister(ShowEvent)
5878
5879#---------------------------------------------------------------------------
5880
5881class IconizeEvent(Event):
5882 """
5883 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5884 restored.
5885 """
5886 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5887 __repr__ = _swig_repr
5888 def __init__(self, *args, **kwargs):
5889 """
5890 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5891
5892 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5893 restored.
5894 """
5895 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
5896 def Iconized(*args, **kwargs):
5897 """
5898 Iconized(self) -> bool
5899
5900 Returns ``True`` if the frame has been iconized, ``False`` if it has
5901 been restored.
5902 """
5903 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5904
5905_core_.IconizeEvent_swigregister(IconizeEvent)
5906
5907#---------------------------------------------------------------------------
5908
5909class MaximizeEvent(Event):
5910 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
5911 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5912 __repr__ = _swig_repr
5913 def __init__(self, *args, **kwargs):
5914 """
5915 __init__(self, int id=0) -> MaximizeEvent
5916
5917 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5918 """
5919 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
5920_core_.MaximizeEvent_swigregister(MaximizeEvent)
5921
5922#---------------------------------------------------------------------------
5923
5924class DropFilesEvent(Event):
5925 """
5926 This class is used for drop files events, that is, when files have
5927 been dropped onto the window. This functionality is only available
5928 under Windows. The window must have previously been enabled for
5929 dropping by calling `wx.Window.DragAcceptFiles`.
5930
5931 Important note: this is a separate implementation to the more general
5932 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5933 implementation uses the older, Windows message-based approach of
5934 dropping files.
5935
5936 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5937 events.
5938
5939 """
5940 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5941 def __init__(self): raise AttributeError, "No constructor defined"
5942 __repr__ = _swig_repr
5943 def GetPosition(*args, **kwargs):
5944 """
5945 GetPosition(self) -> Point
5946
5947 Returns the position at which the files were dropped.
5948 """
5949 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5950
5951 def GetNumberOfFiles(*args, **kwargs):
5952 """
5953 GetNumberOfFiles(self) -> int
5954
5955 Returns the number of files dropped.
5956 """
5957 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5958
5959 def GetFiles(*args, **kwargs):
5960 """
5961 GetFiles(self) -> PyObject
5962
5963 Returns a list of the filenames that were dropped.
5964 """
5965 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5966
5967 Files = property(GetFiles,doc="See `GetFiles`")
5968 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5969 Position = property(GetPosition,doc="See `GetPosition`")
5970_core_.DropFilesEvent_swigregister(DropFilesEvent)
5971
5972#---------------------------------------------------------------------------
5973
5974UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5975UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5976class UpdateUIEvent(CommandEvent):
5977 """
5978 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5979 wxWidgets to give an application the chance to update various user
5980 interface elements.
5981
5982 Without update UI events, an application has to work hard to
5983 check/uncheck, enable/disable, and set the text for elements such as
5984 menu items and toolbar buttons. The code for doing this has to be
5985 mixed up with the code that is invoked when an action is invoked for a
5986 menu item or button.
5987
5988 With update UI events, you define an event handler to look at the
5989 state of the application and change UI elements accordingly. wxWidgets
5990 will call your handler functions in idle time, so you don't have to
5991 worry where to call this code. In addition to being a clearer and more
5992 declarative method, it also means you don't have to worry whether
5993 you're updating a toolbar or menubar identifier. The same handler can
5994 update a menu item and toolbar button, if the ID values are the same.
5995
5996 Instead of directly manipulating the menu or button, you call
5997 functions in the event object, such as `Check`. wxWidgets will
5998 determine whether such a call has been made, and which UI element to
5999 update.
6000
6001 These events will work for popup menus as well as menubars. Just
6002 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
6003 any UI events for the window that owns the menu.
6004
6005 If you find that the overhead of UI update processing is affecting
6006 your application, you can do one or both of the following:
6007
6008 1. Call `wx.UpdateUIEvent.SetMode` with a value of
6009 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
6010 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
6011 receive update events. No other windows will receive update
6012 events.
6013
6014 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
6015 value to set the delay between updates. You may need to call
6016 `wx.Window.UpdateWindowUI` at critical points, for example when
6017 a dialog is about to be shown, in case the user sees a slight
6018 delay before windows are updated.
6019
6020 Note that although events are sent in idle time, defining a EVT_IDLE
6021 handler for a window does not affect this because the events are sent
6022 from an internal idle handler.
6023
6024 wxWidgets tries to optimize update events on some platforms. On
6025 Windows and GTK+, events for menubar items are only sent when the menu
6026 is about to be shown, and not in idle time.
6027
6028 """
6029 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6030 __repr__ = _swig_repr
6031 def __init__(self, *args, **kwargs):
6032 """
6033 __init__(self, int commandId=0) -> UpdateUIEvent
6034
6035 Constructor
6036 """
6037 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
6038 def GetChecked(*args, **kwargs):
6039 """
6040 GetChecked(self) -> bool
6041
6042 Returns ``True`` if the UI element should be checked.
6043 """
6044 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
6045
6046 def GetEnabled(*args, **kwargs):
6047 """
6048 GetEnabled(self) -> bool
6049
6050 Returns ``True`` if the UI element should be enabled.
6051 """
6052 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6053
6054 def GetShown(*args, **kwargs):
6055 """
6056 GetShown(self) -> bool
6057
6058 Returns ``True`` if the UI element should be shown.
6059 """
6060 return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
6061
6062 def GetText(*args, **kwargs):
6063 """
6064 GetText(self) -> String
6065
6066 Returns the text that should be set for the UI element.
6067 """
6068 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6069
6070 def GetSetText(*args, **kwargs):
6071 """
6072 GetSetText(self) -> bool
6073
6074 Returns ``True`` if the application has called `SetText`. For
6075 wxWidgets internal use only.
6076 """
6077 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6078
6079 def GetSetChecked(*args, **kwargs):
6080 """
6081 GetSetChecked(self) -> bool
6082
6083 Returns ``True`` if the application has called `Check`. For wxWidgets
6084 internal use only.
6085 """
6086 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6087
6088 def GetSetEnabled(*args, **kwargs):
6089 """
6090 GetSetEnabled(self) -> bool
6091
6092 Returns ``True`` if the application has called `Enable`. For wxWidgets
6093 internal use only.
6094 """
6095 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6096
6097 def GetSetShown(*args, **kwargs):
6098 """
6099 GetSetShown(self) -> bool
6100
6101 Returns ``True`` if the application has called `Show`. For wxWidgets
6102 internal use only.
6103 """
6104 return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
6105
6106 def Check(*args, **kwargs):
6107 """
6108 Check(self, bool check)
6109
6110 Check or uncheck the UI element.
6111 """
6112 return _core_.UpdateUIEvent_Check(*args, **kwargs)
6113
6114 def Enable(*args, **kwargs):
6115 """
6116 Enable(self, bool enable)
6117
6118 Enable or disable the UI element.
6119 """
6120 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6121
6122 def Show(*args, **kwargs):
6123 """
6124 Show(self, bool show)
6125
6126 Show or hide the UI element.
6127 """
6128 return _core_.UpdateUIEvent_Show(*args, **kwargs)
6129
6130 def SetText(*args, **kwargs):
6131 """
6132 SetText(self, String text)
6133
6134 Sets the text for this UI element.
6135 """
6136 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6137
6138 def SetUpdateInterval(*args, **kwargs):
6139 """
6140 SetUpdateInterval(long updateInterval)
6141
6142 Sets the interval between updates in milliseconds. Set to -1 to
6143 disable updates, or to 0 to update as frequently as possible. The
6144 default is 0.
6145
6146 Use this to reduce the overhead of UI update events if your
6147 application has a lot of windows. If you set the value to -1 or
6148 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6149 at appropriate points in your application, such as when a dialog is
6150 about to be shown.
6151 """
6152 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6153
6154 SetUpdateInterval = staticmethod(SetUpdateInterval)
6155 def GetUpdateInterval(*args, **kwargs):
6156 """
6157 GetUpdateInterval() -> long
6158
6159 Returns the current interval between updates in milliseconds. -1
6160 disables updates, 0 updates as frequently as possible.
6161 """
6162 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6163
6164 GetUpdateInterval = staticmethod(GetUpdateInterval)
6165 def CanUpdate(*args, **kwargs):
6166 """
6167 CanUpdate(Window win) -> bool
6168
6169 Returns ``True`` if it is appropriate to update (send UI update events
6170 to) this window.
6171
6172 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6173 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6174 events were last sent in idle time, and the update interval, to
6175 determine whether events should be sent to this window now. By default
6176 this will always return true because the update mode is initially
6177 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6178 events will be sent as often as possible. You can reduce the frequency
6179 that events are sent by changing the mode and/or setting an update
6180 interval.
6181
6182 """
6183 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6184
6185 CanUpdate = staticmethod(CanUpdate)
6186 def ResetUpdateTime(*args, **kwargs):
6187 """
6188 ResetUpdateTime()
6189
6190 Used internally to reset the last-updated time to the current time. It
6191 is assumed that update events are normally sent in idle time, so this
6192 is called at the end of idle processing.
6193 """
6194 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6195
6196 ResetUpdateTime = staticmethod(ResetUpdateTime)
6197 def SetMode(*args, **kwargs):
6198 """
6199 SetMode(int mode)
6200
6201 Specify how wxWidgets will send update events: to all windows, or only
6202 to those which specify that they will process the events.
6203
6204 The mode may be one of the following values:
6205
6206 ============================= ==========================================
6207 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6208 is the default setting.
6209 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6210 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6211 style set.
6212 ============================= ==========================================
6213
6214 """
6215 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6216
6217 SetMode = staticmethod(SetMode)
6218 def GetMode(*args, **kwargs):
6219 """
6220 GetMode() -> int
6221
6222 Returns a value specifying how wxWidgets will send update events: to
6223 all windows, or only to those which specify that they will process the
6224 events.
6225 """
6226 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6227
6228 GetMode = staticmethod(GetMode)
6229 Checked = property(GetChecked,Check,doc="See `GetChecked`")
6230 Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`")
6231 Shown = property(GetShown,Show,doc="See `GetShown`")
6232 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
6233_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
6234
6235def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
6236 """
6237 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6238
6239 Sets the interval between updates in milliseconds. Set to -1 to
6240 disable updates, or to 0 to update as frequently as possible. The
6241 default is 0.
6242
6243 Use this to reduce the overhead of UI update events if your
6244 application has a lot of windows. If you set the value to -1 or
6245 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6246 at appropriate points in your application, such as when a dialog is
6247 about to be shown.
6248 """
6249 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6250
6251def UpdateUIEvent_GetUpdateInterval(*args):
6252 """
6253 UpdateUIEvent_GetUpdateInterval() -> long
6254
6255 Returns the current interval between updates in milliseconds. -1
6256 disables updates, 0 updates as frequently as possible.
6257 """
6258 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
6259
6260def UpdateUIEvent_CanUpdate(*args, **kwargs):
6261 """
6262 UpdateUIEvent_CanUpdate(Window win) -> bool
6263
6264 Returns ``True`` if it is appropriate to update (send UI update events
6265 to) this window.
6266
6267 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6268 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6269 events were last sent in idle time, and the update interval, to
6270 determine whether events should be sent to this window now. By default
6271 this will always return true because the update mode is initially
6272 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6273 events will be sent as often as possible. You can reduce the frequency
6274 that events are sent by changing the mode and/or setting an update
6275 interval.
6276
6277 """
6278 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6279
6280def UpdateUIEvent_ResetUpdateTime(*args):
6281 """
6282 UpdateUIEvent_ResetUpdateTime()
6283
6284 Used internally to reset the last-updated time to the current time. It
6285 is assumed that update events are normally sent in idle time, so this
6286 is called at the end of idle processing.
6287 """
6288 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
6289
6290def UpdateUIEvent_SetMode(*args, **kwargs):
6291 """
6292 UpdateUIEvent_SetMode(int mode)
6293
6294 Specify how wxWidgets will send update events: to all windows, or only
6295 to those which specify that they will process the events.
6296
6297 The mode may be one of the following values:
6298
6299 ============================= ==========================================
6300 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6301 is the default setting.
6302 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6303 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6304 style set.
6305 ============================= ==========================================
6306
6307 """
6308 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6309
6310def UpdateUIEvent_GetMode(*args):
6311 """
6312 UpdateUIEvent_GetMode() -> int
6313
6314 Returns a value specifying how wxWidgets will send update events: to
6315 all windows, or only to those which specify that they will process the
6316 events.
6317 """
6318 return _core_.UpdateUIEvent_GetMode(*args)
6319
6320#---------------------------------------------------------------------------
6321
6322class SysColourChangedEvent(Event):
6323 """
6324 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6325 when the user changes the colour settings using the control
6326 panel. This is only applicable under Windows.
6327
6328 The default event handler for this event propagates the event to child
6329 windows, since Windows only sends the events to top-level windows. If
6330 intercepting this event for a top-level window, remember to call
6331 `Skip` so the the base class handler will still be executed, or to
6332 pass the event on to the window's children explicitly.
6333
6334 """
6335 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6336 __repr__ = _swig_repr
6337 def __init__(self, *args, **kwargs):
6338 """
6339 __init__(self) -> SysColourChangedEvent
6340
6341 Constructor
6342 """
6343 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
6344_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
6345
6346#---------------------------------------------------------------------------
6347
6348class MouseCaptureChangedEvent(Event):
6349 """
6350 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6351 a window that loses its mouse capture. This is called even if
6352 `wx.Window.ReleaseMouse` was called by the application code. Handling
6353 this event allows an application to cater for unexpected capture
6354 releases which might otherwise confuse mouse handling code.
6355
6356 This event is implemented under Windows only.
6357 """
6358 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6359 __repr__ = _swig_repr
6360 def __init__(self, *args, **kwargs):
6361 """
6362 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6363
6364 Constructor
6365 """
6366 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
6367 def GetCapturedWindow(*args, **kwargs):
6368 """
6369 GetCapturedWindow(self) -> Window
6370
6371 Returns the window that gained the capture, or ``None`` if it was a
6372 non-wxWidgets window.
6373 """
6374 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6375
6376 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
6377_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
6378
6379#---------------------------------------------------------------------------
6380
6381class MouseCaptureLostEvent(Event):
6382 """
6383 A mouse capture lost event is sent to a window that obtained mouse
6384 capture, which was subsequently loss due to "external" event, for
6385 example when a dialog box is shown or if another application captures
6386 the mouse.
6387
6388 If this happens, this event is sent to all windows that are on the
6389 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6390 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6391 if the capture changes because of a call to CaptureMouse or
6392 ReleaseMouse.
6393
6394 This event is currently emitted under Windows only.
6395
6396 """
6397 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6398 __repr__ = _swig_repr
6399 def __init__(self, *args, **kwargs):
6400 """
6401 __init__(self, int winid=0) -> MouseCaptureLostEvent
6402
6403 A mouse capture lost event is sent to a window that obtained mouse
6404 capture, which was subsequently loss due to "external" event, for
6405 example when a dialog box is shown or if another application captures
6406 the mouse.
6407
6408 If this happens, this event is sent to all windows that are on the
6409 capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but
6410 didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent
6411 if the capture changes because of a call to CaptureMouse or
6412 ReleaseMouse.
6413
6414 This event is currently emitted under Windows only.
6415
6416 """
6417 _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs))
6418_core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent)
6419
6420#---------------------------------------------------------------------------
6421
6422class DisplayChangedEvent(Event):
6423 """
6424 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6425 resolution has changed.
6426
6427 This event is implemented under Windows only.
6428 """
6429 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6430 __repr__ = _swig_repr
6431 def __init__(self, *args, **kwargs):
6432 """__init__(self) -> DisplayChangedEvent"""
6433 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
6434_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
6435
6436#---------------------------------------------------------------------------
6437
6438class PaletteChangedEvent(Event):
6439 """
6440 An EVT_PALETTE_CHANGED event is sent when the system palette has
6441 changed, thereby giving each window a chance to redo their own to
6442 match.
6443
6444 This event is implemented under Windows only.
6445 """
6446 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6447 __repr__ = _swig_repr
6448 def __init__(self, *args, **kwargs):
6449 """
6450 __init__(self, int id=0) -> PaletteChangedEvent
6451
6452 An EVT_PALETTE_CHANGED event is sent when the system palette has
6453 changed, thereby giving each window a chance to redo their own to
6454 match.
6455
6456 This event is implemented under Windows only.
6457 """
6458 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
6459 def SetChangedWindow(*args, **kwargs):
6460 """SetChangedWindow(self, Window win)"""
6461 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6462
6463 def GetChangedWindow(*args, **kwargs):
6464 """GetChangedWindow(self) -> Window"""
6465 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6466
6467 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
6468_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
6469
6470#---------------------------------------------------------------------------
6471
6472class QueryNewPaletteEvent(Event):
6473 """
6474 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6475 focus and should re-do its palette.
6476
6477 This event is implemented under Windows only.
6478 """
6479 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6480 __repr__ = _swig_repr
6481 def __init__(self, *args, **kwargs):
6482 """
6483 __init__(self, int winid=0) -> QueryNewPaletteEvent
6484
6485 Constructor.
6486 """
6487 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
6488 def SetPaletteRealized(*args, **kwargs):
6489 """
6490 SetPaletteRealized(self, bool realized)
6491
6492 App should set this if it changes the palette.
6493 """
6494 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6495
6496 def GetPaletteRealized(*args, **kwargs):
6497 """GetPaletteRealized(self) -> bool"""
6498 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6499
6500 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
6501_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
6502
6503#---------------------------------------------------------------------------
6504
6505class NavigationKeyEvent(Event):
6506 """
6507 EVT_NAVIGATION_KEY events are used to control moving the focus between
6508 widgets, otherwise known as tab-traversal. You woudl normally not
6509 catch navigation events in applications as there are already
6510 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6511 it useful to send navigation events in certain situations to change
6512 the focus in certain ways, although it's probably easier to just call
6513 `wx.Window.Navigate`.
6514 """
6515 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6516 __repr__ = _swig_repr
6517 def __init__(self, *args, **kwargs):
6518 """__init__(self) -> NavigationKeyEvent"""
6519 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
6520 def GetDirection(*args, **kwargs):
6521 """
6522 GetDirection(self) -> bool
6523
6524 Returns ``True`` if the direction is forward, ``False`` otherwise.
6525 """
6526 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6527
6528 def SetDirection(*args, **kwargs):
6529 """
6530 SetDirection(self, bool forward)
6531
6532 Specify the direction that the navigation should take. Usually the
6533 difference between using Tab and Shift-Tab.
6534 """
6535 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6536
6537 def IsWindowChange(*args, **kwargs):
6538 """
6539 IsWindowChange(self) -> bool
6540
6541 Returns ``True`` if window change is allowed.
6542 """
6543 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6544
6545 def SetWindowChange(*args, **kwargs):
6546 """
6547 SetWindowChange(self, bool ischange)
6548
6549 Specify if the navigation should be able to change parent windows.
6550 For example, changing notebook pages, etc. This is usually implemented
6551 by using Control-Tab.
6552 """
6553 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6554
6555 def IsFromTab(*args, **kwargs):
6556 """
6557 IsFromTab(self) -> bool
6558
6559 Returns ``True`` if the navigation event is originated from the Tab
6560 key.
6561 """
6562 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6563
6564 def SetFromTab(*args, **kwargs):
6565 """
6566 SetFromTab(self, bool bIs)
6567
6568 Set to true under MSW if the event was generated using the tab key.
6569 This is required for proper navogation over radio buttons.
6570 """
6571 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6572
6573 def SetFlags(*args, **kwargs):
6574 """
6575 SetFlags(self, long flags)
6576
6577 Set the navigation flags to a combination of the following:
6578
6579 * wx.NavigationKeyEvent.IsBackward
6580 * wx.NavigationKeyEvent.IsForward
6581 * wx.NavigationKeyEvent.WinChange
6582 * wx.NavigationKeyEvent.FromTab
6583
6584 """
6585 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6586
6587 def GetCurrentFocus(*args, **kwargs):
6588 """
6589 GetCurrentFocus(self) -> Window
6590
6591 Returns the child window which currenty has the focus. May be
6592 ``None``.
6593 """
6594 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6595
6596 def SetCurrentFocus(*args, **kwargs):
6597 """
6598 SetCurrentFocus(self, Window win)
6599
6600 Set the window that has the focus.
6601 """
6602 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6603
6604 IsBackward = _core_.NavigationKeyEvent_IsBackward
6605 IsForward = _core_.NavigationKeyEvent_IsForward
6606 WinChange = _core_.NavigationKeyEvent_WinChange
6607 FromTab = _core_.NavigationKeyEvent_FromTab
6608 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6609 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
6610_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
6611
6612#---------------------------------------------------------------------------
6613
6614class WindowCreateEvent(CommandEvent):
6615 """
6616 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6617 underlying GUI object) exists.
6618 """
6619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6620 __repr__ = _swig_repr
6621 def __init__(self, *args, **kwargs):
6622 """
6623 __init__(self, Window win=None) -> WindowCreateEvent
6624
6625 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6626 underlying GUI object) exists.
6627 """
6628 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
6629 def GetWindow(*args, **kwargs):
6630 """
6631 GetWindow(self) -> Window
6632
6633 Returns the window that this event refers to.
6634 """
6635 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6636
6637 Window = property(GetWindow,doc="See `GetWindow`")
6638_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
6639
6640class WindowDestroyEvent(CommandEvent):
6641 """
6642 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6643 when the GUI window is destroyed.
6644
6645 When a class derived from `wx.Window` is destroyed its destructor will
6646 have already run by the time this event is sent. Therefore this event
6647 will not usually be received at all by the window itself. Since it is
6648 received after the destructor has run, an object should not try to
6649 handle its own wx.WindowDestroyEvent, but it can be used to get
6650 notification of the destruction of another window.
6651 """
6652 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6653 __repr__ = _swig_repr
6654 def __init__(self, *args, **kwargs):
6655 """
6656 __init__(self, Window win=None) -> WindowDestroyEvent
6657
6658 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6659 when the GUI window is destroyed.
6660
6661 When a class derived from `wx.Window` is destroyed its destructor will
6662 have already run by the time this event is sent. Therefore this event
6663 will not usually be received at all by the window itself. Since it is
6664 received after the destructor has run, an object should not try to
6665 handle its own wx.WindowDestroyEvent, but it can be used to get
6666 notification of the destruction of another window.
6667 """
6668 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
6669 def GetWindow(*args, **kwargs):
6670 """
6671 GetWindow(self) -> Window
6672
6673 Returns the window that this event refers to.
6674 """
6675 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6676
6677 Window = property(GetWindow,doc="See `GetWindow`")
6678_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
6679
6680#---------------------------------------------------------------------------
6681
6682class ContextMenuEvent(CommandEvent):
6683 """
6684 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6685 give the application a chance to show a context (popup) menu.
6686 """
6687 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6688 __repr__ = _swig_repr
6689 def __init__(self, *args, **kwargs):
6690 """
6691 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6692
6693 Constructor.
6694 """
6695 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
6696 def GetPosition(*args, **kwargs):
6697 """
6698 GetPosition(self) -> Point
6699
6700 Returns the position (in screen coordinants) at which the menu should
6701 be shown.
6702 """
6703 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6704
6705 def SetPosition(*args, **kwargs):
6706 """
6707 SetPosition(self, Point pos)
6708
6709 Sets the position at which the menu should be shown.
6710 """
6711 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6712
6713 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6714_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
6715
6716#---------------------------------------------------------------------------
6717
6718IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6719IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6720class IdleEvent(Event):
6721 """
6722 This class is used for EVT_IDLE events, which are generated and sent
6723 when the application *becomes* idle. In other words, the when the
6724 event queue becomes empty then idle events are sent to all windows (by
6725 default) and as long as none of them call `RequestMore` then there are
6726 no more idle events until after the system event queue has some normal
6727 events and then becomes empty again.
6728
6729 By default, idle events are sent to all windows. If this is causing a
6730 significant overhead in your application, you can call
6731 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6732 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6733 which should receive idle events. Then idle events will only be sent
6734 to those windows and not to any others.
6735 """
6736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6737 __repr__ = _swig_repr
6738 def __init__(self, *args, **kwargs):
6739 """
6740 __init__(self) -> IdleEvent
6741
6742 Constructor
6743 """
6744 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
6745 def RequestMore(*args, **kwargs):
6746 """
6747 RequestMore(self, bool needMore=True)
6748
6749 Tells wxWidgets that more processing is required. This function can be
6750 called by an EVT_IDLE handler for a window to indicate that the
6751 application should forward the EVT_IDLE event once more to the
6752 application windows. If no window calls this function during its
6753 EVT_IDLE handler, then the application will remain in a passive event
6754 loop until a new event is posted to the application by the windowing
6755 system.
6756 """
6757 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6758
6759 def MoreRequested(*args, **kwargs):
6760 """
6761 MoreRequested(self) -> bool
6762
6763 Returns ``True`` if the OnIdle function processing this event
6764 requested more processing time.
6765 """
6766 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6767
6768 def SetMode(*args, **kwargs):
6769 """
6770 SetMode(int mode)
6771
6772 Static method for specifying how wxWidgets will send idle events: to
6773 all windows, or only to those which specify that they will process the
6774 events.
6775
6776 The mode can be one of the following values:
6777
6778 ========================= ========================================
6779 wx.IDLE_PROCESS_ALL Send idle events to all windows
6780 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6781 the wx.WS_EX_PROCESS_IDLE extra style
6782 flag set.
6783 ========================= ========================================
6784
6785 """
6786 return _core_.IdleEvent_SetMode(*args, **kwargs)
6787
6788 SetMode = staticmethod(SetMode)
6789 def GetMode(*args, **kwargs):
6790 """
6791 GetMode() -> int
6792
6793 Static method returning a value specifying how wxWidgets will send
6794 idle events: to all windows, or only to those which specify that they
6795 will process the events.
6796 """
6797 return _core_.IdleEvent_GetMode(*args, **kwargs)
6798
6799 GetMode = staticmethod(GetMode)
6800 def CanSend(*args, **kwargs):
6801 """
6802 CanSend(Window win) -> bool
6803
6804 Returns ``True`` if it is appropriate to send idle events to this
6805 window.
6806
6807 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6808 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6809 events should be sent to this window now. By default this will always
6810 return ``True`` because the update mode is initially
6811 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6812 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6813 """
6814 return _core_.IdleEvent_CanSend(*args, **kwargs)
6815
6816 CanSend = staticmethod(CanSend)
6817_core_.IdleEvent_swigregister(IdleEvent)
6818
6819def IdleEvent_SetMode(*args, **kwargs):
6820 """
6821 IdleEvent_SetMode(int mode)
6822
6823 Static method for specifying how wxWidgets will send idle events: to
6824 all windows, or only to those which specify that they will process the
6825 events.
6826
6827 The mode can be one of the following values:
6828
6829 ========================= ========================================
6830 wx.IDLE_PROCESS_ALL Send idle events to all windows
6831 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6832 the wx.WS_EX_PROCESS_IDLE extra style
6833 flag set.
6834 ========================= ========================================
6835
6836 """
6837 return _core_.IdleEvent_SetMode(*args, **kwargs)
6838
6839def IdleEvent_GetMode(*args):
6840 """
6841 IdleEvent_GetMode() -> int
6842
6843 Static method returning a value specifying how wxWidgets will send
6844 idle events: to all windows, or only to those which specify that they
6845 will process the events.
6846 """
6847 return _core_.IdleEvent_GetMode(*args)
6848
6849def IdleEvent_CanSend(*args, **kwargs):
6850 """
6851 IdleEvent_CanSend(Window win) -> bool
6852
6853 Returns ``True`` if it is appropriate to send idle events to this
6854 window.
6855
6856 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6857 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6858 events should be sent to this window now. By default this will always
6859 return ``True`` because the update mode is initially
6860 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6861 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6862 """
6863 return _core_.IdleEvent_CanSend(*args, **kwargs)
6864
6865#---------------------------------------------------------------------------
6866
6867class ClipboardTextEvent(CommandEvent):
6868 """
6869 A Clipboard Text event is sent when a window intercepts a text
6870 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6871 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6872 popup menu command, etc. NOTE : under windows these events are *NOT*
6873 generated automatically for a Rich Edit text control.
6874 """
6875 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6876 __repr__ = _swig_repr
6877 def __init__(self, *args, **kwargs):
6878 """
6879 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent
6880
6881 A Clipboard Text event is sent when a window intercepts a text
6882 copy/cut/paste message, i.e. the user has cut/copied/pasted data
6883 from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a
6884 popup menu command, etc. NOTE : under windows these events are *NOT*
6885 generated automatically for a Rich Edit text control.
6886 """
6887 _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs))
6888_core_.ClipboardTextEvent_swigregister(ClipboardTextEvent)
6889
6890#---------------------------------------------------------------------------
6891
6892class PyEvent(Event):
6893 """
6894 wx.PyEvent can be used as a base class for implementing custom event
6895 types in Python. You should derived from this class instead of
6896 `wx.Event` because this class is Python-aware and is able to transport
6897 its Python bits safely through the wxWidgets event system and have
6898 them still be there when the event handler is invoked.
6899
6900 :see: `wx.PyCommandEvent`
6901
6902 """
6903 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6904 __repr__ = _swig_repr
6905 def __init__(self, *args, **kwargs):
6906 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
6907 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
6908 self._SetSelf(self)
6909
6910 __swig_destroy__ = _core_.delete_PyEvent
6911 __del__ = lambda self : None;
6912 def _SetSelf(*args, **kwargs):
6913 """_SetSelf(self, PyObject self)"""
6914 return _core_.PyEvent__SetSelf(*args, **kwargs)
6915
6916 def _GetSelf(*args, **kwargs):
6917 """_GetSelf(self) -> PyObject"""
6918 return _core_.PyEvent__GetSelf(*args, **kwargs)
6919
6920_core_.PyEvent_swigregister(PyEvent)
6921
6922class PyCommandEvent(CommandEvent):
6923 """
6924 wx.PyCommandEvent can be used as a base class for implementing custom
6925 event types in Python, where the event shoudl travel up to parent
6926 windows looking for a handler. You should derived from this class
6927 instead of `wx.CommandEvent` because this class is Python-aware and is
6928 able to transport its Python bits safely through the wxWidgets event
6929 system and have them still be there when the event handler is invoked.
6930
6931 :see: `wx.PyEvent`
6932
6933 """
6934 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6935 __repr__ = _swig_repr
6936 def __init__(self, *args, **kwargs):
6937 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
6938 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
6939 self._SetSelf(self)
6940
6941 __swig_destroy__ = _core_.delete_PyCommandEvent
6942 __del__ = lambda self : None;
6943 def _SetSelf(*args, **kwargs):
6944 """_SetSelf(self, PyObject self)"""
6945 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
6946
6947 def _GetSelf(*args, **kwargs):
6948 """_GetSelf(self) -> PyObject"""
6949 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
6950
6951_core_.PyCommandEvent_swigregister(PyCommandEvent)
6952
6953class DateEvent(CommandEvent):
6954 """
6955 This event class holds information about a date change event and is
6956 used together with `wx.DatePickerCtrl`. It also serves as a base class
6957 for `wx.calendar.CalendarEvent`. Bind these event types with
6958 EVT_DATE_CHANGED.
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 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
6964 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
6965 def GetDate(*args, **kwargs):
6966 """
6967 GetDate(self) -> DateTime
6968
6969 Returns the date.
6970 """
6971 return _core_.DateEvent_GetDate(*args, **kwargs)
6972
6973 def SetDate(*args, **kwargs):
6974 """
6975 SetDate(self, DateTime date)
6976
6977 Sets the date carried by the event, normally only used by the library
6978 internally.
6979 """
6980 return _core_.DateEvent_SetDate(*args, **kwargs)
6981
6982 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
6983_core_.DateEvent_swigregister(DateEvent)
6984
6985wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6986EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6987
6988#---------------------------------------------------------------------------
6989
6990PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6991PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6992PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6993PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6994PRINT_WINDOWS = _core_.PRINT_WINDOWS
6995PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6996class PyApp(EvtHandler):
6997 """
6998 The ``wx.PyApp`` class is an *implementation detail*, please use the
6999 `wx.App` class (or some other derived class) instead.
7000 """
7001 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7002 __repr__ = _swig_repr
7003 def __init__(self, *args, **kwargs):
7004 """
7005 __init__(self) -> PyApp
7006
7007 Create a new application object, starting the bootstrap process.
7008 """
7009 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
7010 self._setCallbackInfo(self, PyApp, False)
7011 self._setOORInfo(self, False)
7012
7013 __swig_destroy__ = _core_.delete_PyApp
7014 __del__ = lambda self : None;
7015 def _setCallbackInfo(*args, **kwargs):
7016 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
7017 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7018
7019 def GetAppName(*args, **kwargs):
7020 """
7021 GetAppName(self) -> String
7022
7023 Get the application name.
7024 """
7025 return _core_.PyApp_GetAppName(*args, **kwargs)
7026
7027 def SetAppName(*args, **kwargs):
7028 """
7029 SetAppName(self, String name)
7030
7031 Set the application name. This value may be used automatically by
7032 `wx.Config` and such.
7033 """
7034 return _core_.PyApp_SetAppName(*args, **kwargs)
7035
7036 def GetClassName(*args, **kwargs):
7037 """
7038 GetClassName(self) -> String
7039
7040 Get the application's class name.
7041 """
7042 return _core_.PyApp_GetClassName(*args, **kwargs)
7043
7044 def SetClassName(*args, **kwargs):
7045 """
7046 SetClassName(self, String name)
7047
7048 Set the application's class name. This value may be used for
7049 X-resources if applicable for the platform
7050 """
7051 return _core_.PyApp_SetClassName(*args, **kwargs)
7052
7053 def GetVendorName(*args, **kwargs):
7054 """
7055 GetVendorName(self) -> String
7056
7057 Get the application's vendor name.
7058 """
7059 return _core_.PyApp_GetVendorName(*args, **kwargs)
7060
7061 def SetVendorName(*args, **kwargs):
7062 """
7063 SetVendorName(self, String name)
7064
7065 Set the application's vendor name. This value may be used
7066 automatically by `wx.Config` and such.
7067 """
7068 return _core_.PyApp_SetVendorName(*args, **kwargs)
7069
7070 def GetTraits(*args, **kwargs):
7071 """
7072 GetTraits(self) -> wxAppTraits
7073
7074 Return (and create if necessary) the app traits object to which we
7075 delegate for everything which either should be configurable by the
7076 user (then he can change the default behaviour simply by overriding
7077 CreateTraits() and returning his own traits object) or which is
7078 GUI/console dependent as then wx.AppTraits allows us to abstract the
7079 differences behind the common facade.
7080
7081 :todo: Add support for overriding CreateAppTraits in wxPython.
7082 """
7083 return _core_.PyApp_GetTraits(*args, **kwargs)
7084
7085 def ProcessPendingEvents(*args, **kwargs):
7086 """
7087 ProcessPendingEvents(self)
7088
7089 Process all events in the Pending Events list -- it is necessary to
7090 call this function to process posted events. This normally happens
7091 during each event loop iteration.
7092 """
7093 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7094
7095 def Yield(*args, **kwargs):
7096 """
7097 Yield(self, bool onlyIfNeeded=False) -> bool
7098
7099 Process all currently pending events right now, instead of waiting
7100 until return to the event loop. It is an error to call ``Yield``
7101 recursively unless the value of ``onlyIfNeeded`` is True.
7102
7103 :warning: This function is dangerous as it can lead to unexpected
7104 reentrancies (i.e. when called from an event handler it may
7105 result in calling the same event handler again), use with
7106 extreme care or, better, don't use at all!
7107
7108 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
7109
7110 """
7111 return _core_.PyApp_Yield(*args, **kwargs)
7112
7113 def WakeUpIdle(*args, **kwargs):
7114 """
7115 WakeUpIdle(self)
7116
7117 Make sure that idle events are sent again.
7118 :see: `wx.WakeUpIdle`
7119 """
7120 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7121
7122 def IsMainLoopRunning(*args, **kwargs):
7123 """
7124 IsMainLoopRunning() -> bool
7125
7126 Returns True if we're running the main loop, i.e. if the events can
7127 currently be dispatched.
7128 """
7129 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7130
7131 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
7132 def MainLoop(*args, **kwargs):
7133 """
7134 MainLoop(self) -> int
7135
7136 Execute the main GUI loop, the function doesn't normally return until
7137 all top level windows have been closed and destroyed.
7138 """
7139 return _core_.PyApp_MainLoop(*args, **kwargs)
7140
7141 def Exit(*args, **kwargs):
7142 """
7143 Exit(self)
7144
7145 Exit the main loop thus terminating the application.
7146 :see: `wx.Exit`
7147 """
7148 return _core_.PyApp_Exit(*args, **kwargs)
7149
7150 def GetLayoutDirection(*args, **kwargs):
7151 """
7152 GetLayoutDirection(self) -> int
7153
7154 Return the layout direction for the current locale.
7155 """
7156 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7157
7158 def ExitMainLoop(*args, **kwargs):
7159 """
7160 ExitMainLoop(self)
7161
7162 Exit the main GUI loop during the next iteration of the main
7163 loop, (i.e. it does not stop the program immediately!)
7164 """
7165 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7166
7167 def Pending(*args, **kwargs):
7168 """
7169 Pending(self) -> bool
7170
7171 Returns True if there are unprocessed events in the event queue.
7172 """
7173 return _core_.PyApp_Pending(*args, **kwargs)
7174
7175 def Dispatch(*args, **kwargs):
7176 """
7177 Dispatch(self) -> bool
7178
7179 Process the first event in the event queue (blocks until an event
7180 appears if there are none currently)
7181 """
7182 return _core_.PyApp_Dispatch(*args, **kwargs)
7183
7184 def ProcessIdle(*args, **kwargs):
7185 """
7186 ProcessIdle(self) -> bool
7187
7188 Called from the MainLoop when the application becomes idle (there are
7189 no pending events) and sends a `wx.IdleEvent` to all interested
7190 parties. Returns True if more idle events are needed, False if not.
7191 """
7192 return _core_.PyApp_ProcessIdle(*args, **kwargs)
7193
7194 def SendIdleEvents(*args, **kwargs):
7195 """
7196 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7197
7198 Send idle event to window and all subwindows. Returns True if more
7199 idle time is requested.
7200 """
7201 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7202
7203 def IsActive(*args, **kwargs):
7204 """
7205 IsActive(self) -> bool
7206
7207 Return True if our app has focus.
7208 """
7209 return _core_.PyApp_IsActive(*args, **kwargs)
7210
7211 def SetTopWindow(*args, **kwargs):
7212 """
7213 SetTopWindow(self, Window win)
7214
7215 Set the *main* top level window
7216 """
7217 return _core_.PyApp_SetTopWindow(*args, **kwargs)
7218
7219 def GetTopWindow(*args, **kwargs):
7220 """
7221 GetTopWindow(self) -> Window
7222
7223 Return the *main* top level window (if it hadn't been set previously
7224 with SetTopWindow(), will return just some top level window and, if
7225 there not any, will return None)
7226 """
7227 return _core_.PyApp_GetTopWindow(*args, **kwargs)
7228
7229 def SetExitOnFrameDelete(*args, **kwargs):
7230 """
7231 SetExitOnFrameDelete(self, bool flag)
7232
7233 Control the exit behaviour: by default, the program will exit the main
7234 loop (and so, usually, terminate) when the last top-level program
7235 window is deleted. Beware that if you disable this behaviour (with
7236 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7237 explicitly from somewhere.
7238 """
7239 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7240
7241 def GetExitOnFrameDelete(*args, **kwargs):
7242 """
7243 GetExitOnFrameDelete(self) -> bool
7244
7245 Get the current exit behaviour setting.
7246 """
7247 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7248
7249 def SetUseBestVisual(*args, **kwargs):
7250 """
7251 SetUseBestVisual(self, bool flag)
7252
7253 Set whether the app should try to use the best available visual on
7254 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
7255 """
7256 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7257
7258 def GetUseBestVisual(*args, **kwargs):
7259 """
7260 GetUseBestVisual(self) -> bool
7261
7262 Get current UseBestVisual setting.
7263 """
7264 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7265
7266 def SetPrintMode(*args, **kwargs):
7267 """SetPrintMode(self, int mode)"""
7268 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7269
7270 def GetPrintMode(*args, **kwargs):
7271 """GetPrintMode(self) -> int"""
7272 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7273
7274 def SetAssertMode(*args, **kwargs):
7275 """
7276 SetAssertMode(self, int mode)
7277
7278 Set the OnAssert behaviour for debug and hybrid builds.
7279 """
7280 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7281
7282 def GetAssertMode(*args, **kwargs):
7283 """
7284 GetAssertMode(self) -> int
7285
7286 Get the current OnAssert behaviour setting.
7287 """
7288 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7289
7290 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
7291 """GetMacSupportPCMenuShortcuts() -> bool"""
7292 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7293
7294 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7295 def GetMacAboutMenuItemId(*args, **kwargs):
7296 """GetMacAboutMenuItemId() -> long"""
7297 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7298
7299 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7300 def GetMacPreferencesMenuItemId(*args, **kwargs):
7301 """GetMacPreferencesMenuItemId() -> long"""
7302 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7303
7304 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7305 def GetMacExitMenuItemId(*args, **kwargs):
7306 """GetMacExitMenuItemId() -> long"""
7307 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7308
7309 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7310 def GetMacHelpMenuTitleName(*args, **kwargs):
7311 """GetMacHelpMenuTitleName() -> String"""
7312 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7313
7314 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7315 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
7316 """SetMacSupportPCMenuShortcuts(bool val)"""
7317 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7318
7319 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7320 def SetMacAboutMenuItemId(*args, **kwargs):
7321 """SetMacAboutMenuItemId(long val)"""
7322 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7323
7324 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7325 def SetMacPreferencesMenuItemId(*args, **kwargs):
7326 """SetMacPreferencesMenuItemId(long val)"""
7327 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7328
7329 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7330 def SetMacExitMenuItemId(*args, **kwargs):
7331 """SetMacExitMenuItemId(long val)"""
7332 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7333
7334 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7335 def SetMacHelpMenuTitleName(*args, **kwargs):
7336 """SetMacHelpMenuTitleName(String val)"""
7337 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7338
7339 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7340 def _BootstrapApp(*args, **kwargs):
7341 """
7342 _BootstrapApp(self)
7343
7344 For internal use only
7345 """
7346 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7347
7348 def GetComCtl32Version(*args, **kwargs):
7349 """
7350 GetComCtl32Version() -> int
7351
7352 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7353 it wasn't found at all. Raises an exception on non-Windows platforms.
7354 """
7355 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7356
7357 GetComCtl32Version = staticmethod(GetComCtl32Version)
7358 def IsDisplayAvailable(*args, **kwargs):
7359 """
7360 IsDisplayAvailable() -> bool
7361
7362 Tests if it is possible to create a GUI in the current environment.
7363 This will mean different things on the different platforms.
7364
7365 * On X Windows systems this function will return ``False`` if it is
7366 not able to open a connection to the X display, which can happen
7367 if $DISPLAY is not set, or is not set correctly.
7368
7369 * On Mac OS X a ``False`` return value will mean that wx is not
7370 able to access the window manager, which can happen if logged in
7371 remotely or if running from the normal version of python instead
7372 of the framework version, (i.e., pythonw.)
7373
7374 * On MS Windows...
7375
7376 """
7377 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7378
7379 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7380 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7381 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7382 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7383 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7384 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7385 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7386 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7387 Traits = property(GetTraits,doc="See `GetTraits`")
7388 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7389 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7390 Active = property(IsActive)
7391_core_.PyApp_swigregister(PyApp)
7392
7393def PyApp_IsMainLoopRunning(*args):
7394 """
7395 PyApp_IsMainLoopRunning() -> bool
7396
7397 Returns True if we're running the main loop, i.e. if the events can
7398 currently be dispatched.
7399 """
7400 return _core_.PyApp_IsMainLoopRunning(*args)
7401
7402def PyApp_GetMacSupportPCMenuShortcuts(*args):
7403 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7404 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
7405
7406def PyApp_GetMacAboutMenuItemId(*args):
7407 """PyApp_GetMacAboutMenuItemId() -> long"""
7408 return _core_.PyApp_GetMacAboutMenuItemId(*args)
7409
7410def PyApp_GetMacPreferencesMenuItemId(*args):
7411 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7412 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
7413
7414def PyApp_GetMacExitMenuItemId(*args):
7415 """PyApp_GetMacExitMenuItemId() -> long"""
7416 return _core_.PyApp_GetMacExitMenuItemId(*args)
7417
7418def PyApp_GetMacHelpMenuTitleName(*args):
7419 """PyApp_GetMacHelpMenuTitleName() -> String"""
7420 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
7421
7422def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7423 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7424 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7425
7426def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7427 """PyApp_SetMacAboutMenuItemId(long val)"""
7428 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7429
7430def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7431 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7432 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7433
7434def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7435 """PyApp_SetMacExitMenuItemId(long val)"""
7436 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7437
7438def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7439 """PyApp_SetMacHelpMenuTitleName(String val)"""
7440 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7441
7442def PyApp_GetComCtl32Version(*args):
7443 """
7444 PyApp_GetComCtl32Version() -> int
7445
7446 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7447 it wasn't found at all. Raises an exception on non-Windows platforms.
7448 """
7449 return _core_.PyApp_GetComCtl32Version(*args)
7450
7451def PyApp_IsDisplayAvailable(*args):
7452 """
7453 PyApp_IsDisplayAvailable() -> bool
7454
7455 Tests if it is possible to create a GUI in the current environment.
7456 This will mean different things on the different platforms.
7457
7458 * On X Windows systems this function will return ``False`` if it is
7459 not able to open a connection to the X display, which can happen
7460 if $DISPLAY is not set, or is not set correctly.
7461
7462 * On Mac OS X a ``False`` return value will mean that wx is not
7463 able to access the window manager, which can happen if logged in
7464 remotely or if running from the normal version of python instead
7465 of the framework version, (i.e., pythonw.)
7466
7467 * On MS Windows...
7468
7469 """
7470 return _core_.PyApp_IsDisplayAvailable(*args)
7471
7472#---------------------------------------------------------------------------
7473
7474
7475def Exit(*args):
7476 """
7477 Exit()
7478
7479 Force an exit of the application. Convenience for wx.GetApp().Exit()
7480 """
7481 return _core_.Exit(*args)
7482
7483def Yield(*args):
7484 """
7485 Yield() -> bool
7486
7487 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7488 """
7489 return _core_.Yield(*args)
7490
7491def YieldIfNeeded(*args):
7492 """
7493 YieldIfNeeded() -> bool
7494
7495 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7496 """
7497 return _core_.YieldIfNeeded(*args)
7498
7499def SafeYield(*args, **kwargs):
7500 """
7501 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7502
7503 This function is similar to `wx.Yield`, except that it disables the
7504 user input to all program windows before calling `wx.Yield` and
7505 re-enables it again afterwards. If ``win`` is not None, this window
7506 will remain enabled, allowing the implementation of some limited user
7507 interaction.
7508
7509 :Returns: the result of the call to `wx.Yield`.
7510 """
7511 return _core_.SafeYield(*args, **kwargs)
7512
7513def WakeUpIdle(*args):
7514 """
7515 WakeUpIdle()
7516
7517 Cause the message queue to become empty again, so idle events will be
7518 sent.
7519 """
7520 return _core_.WakeUpIdle(*args)
7521
7522def PostEvent(*args, **kwargs):
7523 """
7524 PostEvent(EvtHandler dest, Event event)
7525
7526 Send an event to a window or other wx.EvtHandler to be processed
7527 later.
7528 """
7529 return _core_.PostEvent(*args, **kwargs)
7530
7531def App_CleanUp(*args):
7532 """
7533 App_CleanUp()
7534
7535 For internal use only, it is used to cleanup after wxWidgets when
7536 Python shuts down.
7537 """
7538 return _core_.App_CleanUp(*args)
7539
7540def GetApp(*args):
7541 """
7542 GetApp() -> PyApp
7543
7544 Return a reference to the current wx.App object.
7545 """
7546 return _core_.GetApp(*args)
7547
7548def SetDefaultPyEncoding(*args, **kwargs):
7549 """
7550 SetDefaultPyEncoding(string encoding)
7551
7552 Sets the encoding that wxPython will use when it needs to convert a
7553 Python string or unicode object to or from a wxString.
7554
7555 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7556 but please be aware that the default encoding within the same locale
7557 may be slightly different on different platforms. For example, please
7558 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7559 between the common latin/roman encodings.
7560 """
7561 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7562
7563def GetDefaultPyEncoding(*args):
7564 """
7565 GetDefaultPyEncoding() -> string
7566
7567 Gets the current encoding that wxPython will use when it needs to
7568 convert a Python string or unicode object to or from a wxString.
7569 """
7570 return _core_.GetDefaultPyEncoding(*args)
7571#----------------------------------------------------------------------
7572
7573class PyOnDemandOutputWindow:
7574 """
7575 A class that can be used for redirecting Python's stdout and
7576 stderr streams. It will do nothing until something is wrriten to
7577 the stream at which point it will create a Frame with a text area
7578 and write the text there.
7579 """
7580 def __init__(self, title = "wxPython: stdout/stderr"):
7581 self.frame = None
7582 self.title = title
7583 self.pos = wx.DefaultPosition
7584 self.size = (450, 300)
7585 self.parent = None
7586
7587 def SetParent(self, parent):
7588 """Set the window to be used as the popup Frame's parent."""
7589 self.parent = parent
7590
7591
7592 def CreateOutputWindow(self, st):
7593 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7594 style=wx.DEFAULT_FRAME_STYLE)
7595 self.text = wx.TextCtrl(self.frame, -1, "",
7596 style=wx.TE_MULTILINE|wx.TE_READONLY)
7597 self.text.AppendText(st)
7598 self.frame.Show(True)
7599 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
7600
7601
7602 def OnCloseWindow(self, event):
7603 if self.frame is not None:
7604 self.frame.Destroy()
7605 self.frame = None
7606 self.text = None
7607
7608
7609 # These methods provide the file-like output behaviour.
7610 def write(self, text):
7611 """
7612 Create the output window if needed and write the string to it.
7613 If not called in the context of the gui thread then uses
7614 CallAfter to do the work there.
7615 """
7616 if self.frame is None:
7617 if not wx.Thread_IsMain():
7618 wx.CallAfter(self.CreateOutputWindow, text)
7619 else:
7620 self.CreateOutputWindow(text)
7621 else:
7622 if not wx.Thread_IsMain():
7623 wx.CallAfter(self.text.AppendText, text)
7624 else:
7625 self.text.AppendText(text)
7626
7627
7628 def close(self):
7629 if self.frame is not None:
7630 wx.CallAfter(self.frame.Close)
7631
7632
7633 def flush(self):
7634 pass
7635
7636
7637
7638#----------------------------------------------------------------------
7639
7640_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7641
7642class App(wx.PyApp):
7643 """
7644 The ``wx.App`` class represents the application and is used to:
7645
7646 * bootstrap the wxPython system and initialize the underlying
7647 gui toolkit
7648 * set and get application-wide properties
7649 * implement the windowing system main message or event loop,
7650 and to dispatch events to window instances
7651 * etc.
7652
7653 Every application must have a ``wx.App`` instance, and all
7654 creation of UI objects should be delayed until after the
7655 ``wx.App`` object has been created in order to ensure that the gui
7656 platform and wxWidgets have been fully initialized.
7657
7658 Normally you would derive from this class and implement an
7659 ``OnInit`` method that creates a frame and then calls
7660 ``self.SetTopWindow(frame)``.
7661
7662 :see: `wx.PySimpleApp` for a simpler app class that can be used
7663 directly.
7664 """
7665
7666 outputWindowClass = PyOnDemandOutputWindow
7667
7668 def __init__(self, redirect=_defRedirect, filename=None,
7669 useBestVisual=False, clearSigInt=True):
7670 """
7671 Construct a ``wx.App`` object.
7672
7673 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7674 redirected? Defaults to True on Windows and Mac, False
7675 otherwise. If `filename` is None then output will be
7676 redirected to a window that pops up as needed. (You can
7677 control what kind of window is created for the output by
7678 resetting the class variable ``outputWindowClass`` to a
7679 class of your choosing.)
7680
7681 :param filename: The name of a file to redirect output to, if
7682 redirect is True.
7683
7684 :param useBestVisual: Should the app try to use the best
7685 available visual provided by the system (only relevant on
7686 systems that have more than one visual.) This parameter
7687 must be used instead of calling `SetUseBestVisual` later
7688 on because it must be set before the underlying GUI
7689 toolkit is initialized.
7690
7691 :param clearSigInt: Should SIGINT be cleared? This allows the
7692 app to terminate upon a Ctrl-C in the console like other
7693 GUI apps will.
7694
7695 :note: You should override OnInit to do applicaition
7696 initialization to ensure that the system, toolkit and
7697 wxWidgets are fully initialized.
7698 """
7699
7700 wx.PyApp.__init__(self)
7701
7702 # make sure we can create a GUI
7703 if not self.IsDisplayAvailable():
7704
7705 if wx.Platform == "__WXMAC__":
7706 msg = """This program needs access to the screen.
7707Please run with 'pythonw', not 'python', and only when you are logged
7708in on the main display of your Mac."""
7709
7710 elif wx.Platform == "__WXGTK__":
7711 msg ="Unable to access the X Display, is $DISPLAY set properly?"
7712
7713 else:
7714 msg = "Unable to create GUI"
7715 # TODO: more description is needed for wxMSW...
7716
7717 raise SystemExit(msg)
7718
7719 # This has to be done before OnInit
7720 self.SetUseBestVisual(useBestVisual)
7721
7722 # Set the default handler for SIGINT. This fixes a problem
7723 # where if Ctrl-C is pressed in the console that started this
7724 # app then it will not appear to do anything, (not even send
7725 # KeyboardInterrupt???) but will later segfault on exit. By
7726 # setting the default handler then the app will exit, as
7727 # expected (depending on platform.)
7728 if clearSigInt:
7729 try:
7730 import signal
7731 signal.signal(signal.SIGINT, signal.SIG_DFL)
7732 except:
7733 pass
7734
7735 # Save and redirect the stdio to a window?
7736 self.stdioWin = None
7737 self.saveStdio = (_sys.stdout, _sys.stderr)
7738 if redirect:
7739 self.RedirectStdio(filename)
7740
7741 # Use Python's install prefix as the default
7742 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7743
7744 # Until the new native control for wxMac is up to par, still use the generic one.
7745 wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7746
7747 # This finishes the initialization of wxWindows and then calls
7748 # the OnInit that should be present in the derived class
7749 self._BootstrapApp()
7750
7751
7752 def OnPreInit(self):
7753 """
7754 Things that must be done after _BootstrapApp has done its
7755 thing, but would be nice if they were already done by the time
7756 that OnInit is called.
7757 """
7758 wx.StockGDI._initStockObjects()
7759
7760
7761 def __del__(self, destroy=wx.PyApp.__del__):
7762 self.RestoreStdio() # Just in case the MainLoop was overridden
7763 destroy(self)
7764
7765 def Destroy(self):
7766 self.this.own(False)
7767 wx.PyApp.Destroy(self)
7768
7769 def SetTopWindow(self, frame):
7770 """Set the \"main\" top level window"""
7771 if self.stdioWin:
7772 self.stdioWin.SetParent(frame)
7773 wx.PyApp.SetTopWindow(self, frame)
7774
7775
7776 def MainLoop(self):
7777 """Execute the main GUI event loop"""
7778 wx.PyApp.MainLoop(self)
7779 self.RestoreStdio()
7780
7781
7782 def RedirectStdio(self, filename=None):
7783 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7784 if filename:
7785 _sys.stdout = _sys.stderr = open(filename, 'a')
7786 else:
7787 self.stdioWin = self.outputWindowClass()
7788 _sys.stdout = _sys.stderr = self.stdioWin
7789
7790
7791 def RestoreStdio(self):
7792 try:
7793 _sys.stdout, _sys.stderr = self.saveStdio
7794 except:
7795 pass
7796
7797
7798 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7799 """
7800 Set the title, position and/or size of the output window if
7801 the stdio has been redirected. This should be called before
7802 any output would cause the output window to be created.
7803 """
7804 if self.stdioWin:
7805 if title is not None:
7806 self.stdioWin.title = title
7807 if pos is not None:
7808 self.stdioWin.pos = pos
7809 if size is not None:
7810 self.stdioWin.size = size
7811
7812
7813
7814
7815# change from wx.PyApp_XX to wx.App_XX
7816App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7817App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7818App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7819App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7820App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7821App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7822App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7823App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7824App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7825App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7826App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7827
7828#----------------------------------------------------------------------------
7829
7830class PySimpleApp(wx.App):
7831 """
7832 A simple application class. You can just create one of these and
7833 then then make your top level windows later, and not have to worry
7834 about OnInit. For example::
7835
7836 app = wx.PySimpleApp()
7837 frame = wx.Frame(None, title='Hello World')
7838 frame.Show()
7839 app.MainLoop()
7840
7841 :see: `wx.App`
7842 """
7843
7844 def __init__(self, redirect=False, filename=None,
7845 useBestVisual=False, clearSigInt=True):
7846 """
7847 :see: `wx.App.__init__`
7848 """
7849 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
7850
7851 def OnInit(self):
7852 return True
7853
7854
7855
7856# Is anybody using this one?
7857class PyWidgetTester(wx.App):
7858 def __init__(self, size = (250, 100)):
7859 self.size = size
7860 wx.App.__init__(self, 0)
7861
7862 def OnInit(self):
7863 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7864 self.SetTopWindow(self.frame)
7865 return True
7866
7867 def SetWidget(self, widgetClass, *args, **kwargs):
7868 w = widgetClass(self.frame, *args, **kwargs)
7869 self.frame.Show(True)
7870
7871#----------------------------------------------------------------------------
7872# DO NOT hold any other references to this object. This is how we
7873# know when to cleanup system resources that wxWidgets is holding. When
7874# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
7875# goes to zero and it calls the wx.App_CleanUp function.
7876
7877class __wxPyCleanup:
7878 def __init__(self):
7879 self.cleanup = _core_.App_CleanUp
7880 def __del__(self):
7881 self.cleanup()
7882
7883_sys.__wxPythonCleanup = __wxPyCleanup()
7884
7885## # another possible solution, but it gets called too early...
7886## import atexit
7887## atexit.register(_core_.wxApp_CleanUp)
7888
7889
7890#----------------------------------------------------------------------------
7891
7892#---------------------------------------------------------------------------
7893
7894class EventLoop(object):
7895 """Proxy of C++ EventLoop class"""
7896 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7897 __repr__ = _swig_repr
7898 def __init__(self, *args, **kwargs):
7899 """__init__(self) -> EventLoop"""
7900 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7901 __swig_destroy__ = _core_.delete_EventLoop
7902 __del__ = lambda self : None;
7903 def Run(*args, **kwargs):
7904 """Run(self) -> int"""
7905 return _core_.EventLoop_Run(*args, **kwargs)
7906
7907 def Exit(*args, **kwargs):
7908 """Exit(self, int rc=0)"""
7909 return _core_.EventLoop_Exit(*args, **kwargs)
7910
7911 def Pending(*args, **kwargs):
7912 """Pending(self) -> bool"""
7913 return _core_.EventLoop_Pending(*args, **kwargs)
7914
7915 def Dispatch(*args, **kwargs):
7916 """Dispatch(self) -> bool"""
7917 return _core_.EventLoop_Dispatch(*args, **kwargs)
7918
7919 def IsRunning(*args, **kwargs):
7920 """IsRunning(self) -> bool"""
7921 return _core_.EventLoop_IsRunning(*args, **kwargs)
7922
7923 def GetActive(*args, **kwargs):
7924 """GetActive() -> EventLoop"""
7925 return _core_.EventLoop_GetActive(*args, **kwargs)
7926
7927 GetActive = staticmethod(GetActive)
7928 def SetActive(*args, **kwargs):
7929 """SetActive(EventLoop loop)"""
7930 return _core_.EventLoop_SetActive(*args, **kwargs)
7931
7932 SetActive = staticmethod(SetActive)
7933_core_.EventLoop_swigregister(EventLoop)
7934
7935def EventLoop_GetActive(*args):
7936 """EventLoop_GetActive() -> EventLoop"""
7937 return _core_.EventLoop_GetActive(*args)
7938
7939def EventLoop_SetActive(*args, **kwargs):
7940 """EventLoop_SetActive(EventLoop loop)"""
7941 return _core_.EventLoop_SetActive(*args, **kwargs)
7942
7943class EventLoopActivator(object):
7944 """Proxy of C++ EventLoopActivator class"""
7945 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7946 __repr__ = _swig_repr
7947 def __init__(self, *args, **kwargs):
7948 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
7949 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7950 __swig_destroy__ = _core_.delete_EventLoopActivator
7951 __del__ = lambda self : None;
7952_core_.EventLoopActivator_swigregister(EventLoopActivator)
7953
7954#---------------------------------------------------------------------------
7955
7956ACCEL_ALT = _core_.ACCEL_ALT
7957ACCEL_CTRL = _core_.ACCEL_CTRL
7958ACCEL_SHIFT = _core_.ACCEL_SHIFT
7959ACCEL_NORMAL = _core_.ACCEL_NORMAL
7960ACCEL_CMD = _core_.ACCEL_CMD
7961class AcceleratorEntry(object):
7962 """
7963 A class used to define items in an `wx.AcceleratorTable`. wxPython
7964 programs can choose to use wx.AcceleratorEntry objects, but using a
7965 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
7966 as well. See `__init__` for of the tuple values.
7967
7968 :see: `wx.AcceleratorTable`
7969 """
7970 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7971 __repr__ = _swig_repr
7972 def __init__(self, *args, **kwargs):
7973 """
7974 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7975
7976 Construct a wx.AcceleratorEntry.
7977 """
7978 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7979 __swig_destroy__ = _core_.delete_AcceleratorEntry
7980 __del__ = lambda self : None;
7981 def Set(*args, **kwargs):
7982 """
7983 Set(self, int flags, int keyCode, int cmd)
7984
7985 (Re)set the attributes of a wx.AcceleratorEntry.
7986 :see `__init__`
7987 """
7988 return _core_.AcceleratorEntry_Set(*args, **kwargs)
7989
7990 def Create(*args, **kwargs):
7991 """
7992 Create(String str) -> AcceleratorEntry
7993
7994 Create accelerator corresponding to the specified string, or None if
7995 it coulnd't be parsed.
7996 """
7997 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7998
7999 Create = staticmethod(Create)
8000 def GetFlags(*args, **kwargs):
8001 """
8002 GetFlags(self) -> int
8003
8004 Get the AcceleratorEntry's flags.
8005 """
8006 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
8007
8008 def GetKeyCode(*args, **kwargs):
8009 """
8010 GetKeyCode(self) -> int
8011
8012 Get the AcceleratorEntry's keycode.
8013 """
8014 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
8015
8016 def GetCommand(*args, **kwargs):
8017 """
8018 GetCommand(self) -> int
8019
8020 Get the AcceleratorEntry's command ID.
8021 """
8022 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
8023
8024 def IsOk(*args, **kwargs):
8025 """IsOk(self) -> bool"""
8026 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8027
8028 def ToString(*args, **kwargs):
8029 """
8030 ToString(self) -> String
8031
8032 Returns a string representation for the this accelerator. The string
8033 is formatted using the <flags>-<keycode> format where <flags> maybe a
8034 hyphen-separed list of "shift|alt|ctrl"
8035
8036 """
8037 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8038
8039 def FromString(*args, **kwargs):
8040 """
8041 FromString(self, String str) -> bool
8042
8043 Returns true if the given string correctly initialized this object.
8044 """
8045 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8046
8047 Command = property(GetCommand,doc="See `GetCommand`")
8048 Flags = property(GetFlags,doc="See `GetFlags`")
8049 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
8050_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
8051
8052def AcceleratorEntry_Create(*args, **kwargs):
8053 """
8054 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8055
8056 Create accelerator corresponding to the specified string, or None if
8057 it coulnd't be parsed.
8058 """
8059 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8060
8061class AcceleratorTable(Object):
8062 """
8063 An accelerator table allows the application to specify a table of
8064 keyboard shortcuts for menus or other commands. On Windows, menu or
8065 button commands are supported; on GTK, only menu commands are
8066 supported.
8067 """
8068 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8069 __repr__ = _swig_repr
8070 def __init__(self, *args, **kwargs):
8071 """
8072 __init__(entries) -> AcceleratorTable
8073
8074 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8075 items or or of 3-tuples (flags, keyCode, cmdID)
8076
8077 :see: `wx.AcceleratorEntry`
8078 """
8079 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8080 __swig_destroy__ = _core_.delete_AcceleratorTable
8081 __del__ = lambda self : None;
8082 def IsOk(*args, **kwargs):
8083 """IsOk(self) -> bool"""
8084 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
8085
8086 Ok = IsOk
8087_core_.AcceleratorTable_swigregister(AcceleratorTable)
8088
8089
8090def GetAccelFromString(*args, **kwargs):
8091 """GetAccelFromString(String label) -> AcceleratorEntry"""
8092 return _core_.GetAccelFromString(*args, **kwargs)
8093#---------------------------------------------------------------------------
8094
8095class VisualAttributes(object):
8096 """struct containing all the visual attributes of a control"""
8097 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8098 __repr__ = _swig_repr
8099 def __init__(self, *args, **kwargs):
8100 """
8101 __init__(self) -> VisualAttributes
8102
8103 struct containing all the visual attributes of a control
8104 """
8105 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8106 __swig_destroy__ = _core_.delete_VisualAttributes
8107 __del__ = lambda self : None;
8108 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8109 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8110 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
8111_core_.VisualAttributes_swigregister(VisualAttributes)
8112NullAcceleratorTable = cvar.NullAcceleratorTable
8113PanelNameStr = cvar.PanelNameStr
8114
8115WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8116WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8117WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8118WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8119WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8120class Window(EvtHandler):
8121 """
8122 wx.Window is the base class for all windows and represents any visible
8123 object on the screen. All controls, top level windows and so on are
8124 wx.Windows. Sizers and device contexts are not however, as they don't
8125 appear on screen themselves.
8126
8127 """
8128 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8129 __repr__ = _swig_repr
8130 def __init__(self, *args, **kwargs):
8131 """
8132 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8133 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8134
8135 Construct and show a generic Window.
8136 """
8137 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
8138 self._setOORInfo(self)
8139
8140 def Create(*args, **kwargs):
8141 """
8142 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8143 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8144
8145 Create the GUI part of the Window for 2-phase creation mode.
8146 """
8147 return _core_.Window_Create(*args, **kwargs)
8148
8149 def Close(*args, **kwargs):
8150 """
8151 Close(self, bool force=False) -> bool
8152
8153 This function simply generates a EVT_CLOSE event whose handler usually
8154 tries to close the window. It doesn't close the window itself,
8155 however. If force is False (the default) then the window's close
8156 handler will be allowed to veto the destruction of the window.
8157 """
8158 return _core_.Window_Close(*args, **kwargs)
8159
8160 def Destroy(*args, **kwargs):
8161 """
8162 Destroy(self) -> bool
8163
8164 Destroys the window safely. Frames and dialogs are not destroyed
8165 immediately when this function is called -- they are added to a list
8166 of windows to be deleted on idle time, when all the window's events
8167 have been processed. This prevents problems with events being sent to
8168 non-existent windows.
8169
8170 Returns True if the window has either been successfully deleted, or it
8171 has been added to the list of windows pending real deletion.
8172 """
8173 args[0].this.own(False)
8174 return _core_.Window_Destroy(*args, **kwargs)
8175
8176 def DestroyChildren(*args, **kwargs):
8177 """
8178 DestroyChildren(self) -> bool
8179
8180 Destroys all children of a window. Called automatically by the
8181 destructor.
8182 """
8183 return _core_.Window_DestroyChildren(*args, **kwargs)
8184
8185 def IsBeingDeleted(*args, **kwargs):
8186 """
8187 IsBeingDeleted(self) -> bool
8188
8189 Is the window in the process of being deleted?
8190 """
8191 return _core_.Window_IsBeingDeleted(*args, **kwargs)
8192
8193 def SetLabel(*args, **kwargs):
8194 """
8195 SetLabel(self, String label)
8196
8197 Set the text which the window shows in its label if applicable.
8198 """
8199 return _core_.Window_SetLabel(*args, **kwargs)
8200
8201 def GetLabel(*args, **kwargs):
8202 """
8203 GetLabel(self) -> String
8204
8205 Generic way of getting a label from any window, for identification
8206 purposes. The interpretation of this function differs from class to
8207 class. For frames and dialogs, the value returned is the title. For
8208 buttons or static text controls, it is the button text. This function
8209 can be useful for meta-programs such as testing tools or special-needs
8210 access programs)which need to identify windows by name.
8211 """
8212 return _core_.Window_GetLabel(*args, **kwargs)
8213
8214 def SetName(*args, **kwargs):
8215 """
8216 SetName(self, String name)
8217
8218 Sets the window's name. The window name is used for ressource setting
8219 in X, it is not the same as the window title/label
8220 """
8221 return _core_.Window_SetName(*args, **kwargs)
8222
8223 def GetName(*args, **kwargs):
8224 """
8225 GetName(self) -> String
8226
8227 Returns the windows name. This name is not guaranteed to be unique;
8228 it is up to the programmer to supply an appropriate name in the window
8229 constructor or via wx.Window.SetName.
8230 """
8231 return _core_.Window_GetName(*args, **kwargs)
8232
8233 def SetWindowVariant(*args, **kwargs):
8234 """
8235 SetWindowVariant(self, int variant)
8236
8237 Sets the variant of the window/font size to use for this window, if
8238 the platform supports variants, for example, wxMac.
8239 """
8240 return _core_.Window_SetWindowVariant(*args, **kwargs)
8241
8242 def GetWindowVariant(*args, **kwargs):
8243 """GetWindowVariant(self) -> int"""
8244 return _core_.Window_GetWindowVariant(*args, **kwargs)
8245
8246 def SetId(*args, **kwargs):
8247 """
8248 SetId(self, int winid)
8249
8250 Sets the identifier of the window. Each window has an integer
8251 identifier. If the application has not provided one, an identifier
8252 will be generated. Normally, the identifier should be provided on
8253 creation and should not be modified subsequently.
8254 """
8255 return _core_.Window_SetId(*args, **kwargs)
8256
8257 def GetId(*args, **kwargs):
8258 """
8259 GetId(self) -> int
8260
8261 Returns the identifier of the window. Each window has an integer
8262 identifier. If the application has not provided one (or the default Id
8263 -1 is used) then an unique identifier with a negative value will be
8264 generated.
8265 """
8266 return _core_.Window_GetId(*args, **kwargs)
8267
8268 def NewControlId(*args, **kwargs):
8269 """
8270 NewControlId() -> int
8271
8272 Generate a control id for the controls which were not given one.
8273 """
8274 return _core_.Window_NewControlId(*args, **kwargs)
8275
8276 NewControlId = staticmethod(NewControlId)
8277 def NextControlId(*args, **kwargs):
8278 """
8279 NextControlId(int winid) -> int
8280
8281 Get the id of the control following the one with the given
8282 autogenerated) id
8283 """
8284 return _core_.Window_NextControlId(*args, **kwargs)
8285
8286 NextControlId = staticmethod(NextControlId)
8287 def PrevControlId(*args, **kwargs):
8288 """
8289 PrevControlId(int winid) -> int
8290
8291 Get the id of the control preceding the one with the given
8292 autogenerated) id
8293 """
8294 return _core_.Window_PrevControlId(*args, **kwargs)
8295
8296 PrevControlId = staticmethod(PrevControlId)
8297 def GetLayoutDirection(*args, **kwargs):
8298 """
8299 GetLayoutDirection(self) -> int
8300
8301 Get the layout direction (LTR or RTL) for this window. Returns
8302 ``wx.Layout_Default`` if layout direction is not supported.
8303 """
8304 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8305
8306 def SetLayoutDirection(*args, **kwargs):
8307 """
8308 SetLayoutDirection(self, int dir)
8309
8310 Set the layout direction (LTR or RTL) for this window.
8311 """
8312 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8313
8314 def AdjustForLayoutDirection(*args, **kwargs):
8315 """
8316 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8317
8318 Mirror coordinates for RTL layout if this window uses it and if the
8319 mirroring is not done automatically like Win32.
8320 """
8321 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8322
8323 def SetSize(*args, **kwargs):
8324 """
8325 SetSize(self, Size size)
8326
8327 Sets the size of the window in pixels.
8328 """
8329 return _core_.Window_SetSize(*args, **kwargs)
8330
8331 def SetDimensions(*args, **kwargs):
8332 """
8333 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8334
8335 Sets the position and size of the window in pixels. The sizeFlags
8336 parameter indicates the interpretation of the other params if they are
8337 equal to -1.
8338
8339 ======================== ======================================
8340 wx.SIZE_AUTO A -1 indicates that a class-specific
8341 default should be used.
8342 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8343 -1 values are supplied.
8344 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8345 interpreted as real dimensions, not
8346 default values.
8347 ======================== ======================================
8348
8349 """
8350 return _core_.Window_SetDimensions(*args, **kwargs)
8351
8352 def SetRect(*args, **kwargs):
8353 """
8354 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8355
8356 Sets the position and size of the window in pixels using a wx.Rect.
8357 """
8358 return _core_.Window_SetRect(*args, **kwargs)
8359
8360 def SetSizeWH(*args, **kwargs):
8361 """
8362 SetSizeWH(self, int width, int height)
8363
8364 Sets the size of the window in pixels.
8365 """
8366 return _core_.Window_SetSizeWH(*args, **kwargs)
8367
8368 def Move(*args, **kwargs):
8369 """
8370 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8371
8372 Moves the window to the given position.
8373 """
8374 return _core_.Window_Move(*args, **kwargs)
8375
8376 SetPosition = Move
8377 def MoveXY(*args, **kwargs):
8378 """
8379 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8380
8381 Moves the window to the given position.
8382 """
8383 return _core_.Window_MoveXY(*args, **kwargs)
8384
8385 def SetInitialSize(*args, **kwargs):
8386 """
8387 SetInitialSize(self, Size size=DefaultSize)
8388
8389 A 'Smart' SetSize that will fill in default size components with the
8390 window's *best size* values. Also set's the minsize for use with sizers.
8391 """
8392 return _core_.Window_SetInitialSize(*args, **kwargs)
8393
8394 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
8395 def Raise(*args, **kwargs):
8396 """
8397 Raise(self)
8398
8399 Raises the window to the top of the window hierarchy. In current
8400 version of wxWidgets this works both for manage and child windows.
8401 """
8402 return _core_.Window_Raise(*args, **kwargs)
8403
8404 def Lower(*args, **kwargs):
8405 """
8406 Lower(self)
8407
8408 Lowers the window to the bottom of the window hierarchy. In current
8409 version of wxWidgets this works both for manage and child windows.
8410 """
8411 return _core_.Window_Lower(*args, **kwargs)
8412
8413 def SetClientSize(*args, **kwargs):
8414 """
8415 SetClientSize(self, Size size)
8416
8417 This sets the size of the window client area in pixels. Using this
8418 function to size a window tends to be more device-independent than
8419 wx.Window.SetSize, since the application need not worry about what
8420 dimensions the border or title bar have when trying to fit the window
8421 around panel items, for example.
8422 """
8423 return _core_.Window_SetClientSize(*args, **kwargs)
8424
8425 def SetClientSizeWH(*args, **kwargs):
8426 """
8427 SetClientSizeWH(self, int width, int height)
8428
8429 This sets the size of the window client area in pixels. Using this
8430 function to size a window tends to be more device-independent than
8431 wx.Window.SetSize, since the application need not worry about what
8432 dimensions the border or title bar have when trying to fit the window
8433 around panel items, for example.
8434 """
8435 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8436
8437 def SetClientRect(*args, **kwargs):
8438 """
8439 SetClientRect(self, Rect rect)
8440
8441 This sets the size of the window client area in pixels. Using this
8442 function to size a window tends to be more device-independent than
8443 wx.Window.SetSize, since the application need not worry about what
8444 dimensions the border or title bar have when trying to fit the window
8445 around panel items, for example.
8446 """
8447 return _core_.Window_SetClientRect(*args, **kwargs)
8448
8449 def GetPosition(*args, **kwargs):
8450 """
8451 GetPosition(self) -> Point
8452
8453 Get the window's position. Notice that the position is in client
8454 coordinates for child windows and screen coordinates for the top level
8455 ones, use `GetScreenPosition` if you need screen coordinates for all
8456 kinds of windows.
8457 """
8458 return _core_.Window_GetPosition(*args, **kwargs)
8459
8460 def GetPositionTuple(*args, **kwargs):
8461 """
8462 GetPositionTuple() -> (x,y)
8463
8464 Get the window's position. Notice that the position is in client
8465 coordinates for child windows and screen coordinates for the top level
8466 ones, use `GetScreenPosition` if you need screen coordinates for all
8467 kinds of windows.
8468 """
8469 return _core_.Window_GetPositionTuple(*args, **kwargs)
8470
8471 def GetScreenPosition(*args, **kwargs):
8472 """
8473 GetScreenPosition(self) -> Point
8474
8475 Get the position of the window in screen coordinantes.
8476 """
8477 return _core_.Window_GetScreenPosition(*args, **kwargs)
8478
8479 def GetScreenPositionTuple(*args, **kwargs):
8480 """
8481 GetScreenPositionTuple() -> (x,y)
8482
8483 Get the position of the window in screen coordinantes.
8484 """
8485 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8486
8487 def GetScreenRect(*args, **kwargs):
8488 """
8489 GetScreenRect(self) -> Rect
8490
8491 Returns the size and position of the window in screen coordinantes as
8492 a `wx.Rect` object.
8493 """
8494 return _core_.Window_GetScreenRect(*args, **kwargs)
8495
8496 def GetSize(*args, **kwargs):
8497 """
8498 GetSize(self) -> Size
8499
8500 Get the window size.
8501 """
8502 return _core_.Window_GetSize(*args, **kwargs)
8503
8504 def GetSizeTuple(*args, **kwargs):
8505 """
8506 GetSizeTuple() -> (width, height)
8507
8508 Get the window size.
8509 """
8510 return _core_.Window_GetSizeTuple(*args, **kwargs)
8511
8512 def GetRect(*args, **kwargs):
8513 """
8514 GetRect(self) -> Rect
8515
8516 Returns the size and position of the window as a `wx.Rect` object.
8517 """
8518 return _core_.Window_GetRect(*args, **kwargs)
8519
8520 def GetClientSize(*args, **kwargs):
8521 """
8522 GetClientSize(self) -> Size
8523
8524 This gets the size of the window's 'client area' in pixels. The client
8525 area is the area which may be drawn on by the programmer, excluding
8526 title bar, border, scrollbars, etc.
8527 """
8528 return _core_.Window_GetClientSize(*args, **kwargs)
8529
8530 def GetClientSizeTuple(*args, **kwargs):
8531 """
8532 GetClientSizeTuple() -> (width, height)
8533
8534 This gets the size of the window's 'client area' in pixels. The client
8535 area is the area which may be drawn on by the programmer, excluding
8536 title bar, border, scrollbars, etc.
8537 """
8538 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8539
8540 def GetClientAreaOrigin(*args, **kwargs):
8541 """
8542 GetClientAreaOrigin(self) -> Point
8543
8544 Get the origin of the client area of the window relative to the
8545 window's top left corner (the client area may be shifted because of
8546 the borders, scrollbars, other decorations...)
8547 """
8548 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8549
8550 def GetClientRect(*args, **kwargs):
8551 """
8552 GetClientRect(self) -> Rect
8553
8554 Get the client area position and size as a `wx.Rect` object.
8555 """
8556 return _core_.Window_GetClientRect(*args, **kwargs)
8557
8558 def GetBestSize(*args, **kwargs):
8559 """
8560 GetBestSize(self) -> Size
8561
8562 This function returns the best acceptable minimal size for the
8563 window, if applicable. For example, for a static text control, it will
8564 be the minimal size such that the control label is not truncated. For
8565 windows containing subwindows (suzh aswx.Panel), the size returned by
8566 this function will be the same as the size the window would have had
8567 after calling Fit.
8568 """
8569 return _core_.Window_GetBestSize(*args, **kwargs)
8570
8571 def GetBestSizeTuple(*args, **kwargs):
8572 """
8573 GetBestSizeTuple() -> (width, height)
8574
8575 This function returns the best acceptable minimal size for the
8576 window, if applicable. For example, for a static text control, it will
8577 be the minimal size such that the control label is not truncated. For
8578 windows containing subwindows (suzh aswx.Panel), the size returned by
8579 this function will be the same as the size the window would have had
8580 after calling Fit.
8581 """
8582 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8583
8584 def InvalidateBestSize(*args, **kwargs):
8585 """
8586 InvalidateBestSize(self)
8587
8588 Reset the cached best size value so it will be recalculated the next
8589 time it is needed.
8590 """
8591 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8592
8593 def CacheBestSize(*args, **kwargs):
8594 """
8595 CacheBestSize(self, Size size)
8596
8597 Cache the best size so it doesn't need to be calculated again, (at least until
8598 some properties of the window change.)
8599 """
8600 return _core_.Window_CacheBestSize(*args, **kwargs)
8601
8602 def GetEffectiveMinSize(*args, **kwargs):
8603 """
8604 GetEffectiveMinSize(self) -> Size
8605
8606 This function will merge the window's best size into the window's
8607 minimum size, giving priority to the min size components, and returns
8608 the results.
8609
8610 """
8611 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
8612
8613 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8614 def GetAdjustedBestSize(self):
8615 s = self.GetBestSize()
8616 return wx.Size(max(s.width, self.GetMinWidth()),
8617 max(s.height, self.GetMinHeight()))
8618 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
8619
8620 def Center(*args, **kwargs):
8621 """
8622 Center(self, int direction=BOTH)
8623
8624 Centers the window. The parameter specifies the direction for
8625 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8626 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8627 on the entire screen and not on its parent window. If it is a
8628 top-level window and has no parent then it will always be centered
8629 relative to the screen.
8630 """
8631 return _core_.Window_Center(*args, **kwargs)
8632
8633 Centre = Center
8634 def CenterOnParent(*args, **kwargs):
8635 """
8636 CenterOnParent(self, int dir=BOTH)
8637
8638 Center with respect to the the parent window
8639 """
8640 return _core_.Window_CenterOnParent(*args, **kwargs)
8641
8642 CentreOnParent = CenterOnParent
8643 def Fit(*args, **kwargs):
8644 """
8645 Fit(self)
8646
8647 Sizes the window so that it fits around its subwindows. This function
8648 won't do anything if there are no subwindows and will only really work
8649 correctly if sizers are used for the subwindows layout. Also, if the
8650 window has exactly one subwindow it is better (faster and the result
8651 is more precise as Fit adds some margin to account for fuzziness of
8652 its calculations) to call window.SetClientSize(child.GetSize())
8653 instead of calling Fit.
8654 """
8655 return _core_.Window_Fit(*args, **kwargs)
8656
8657 def FitInside(*args, **kwargs):
8658 """
8659 FitInside(self)
8660
8661 Similar to Fit, but sizes the interior (virtual) size of a
8662 window. Mainly useful with scrolled windows to reset scrollbars after
8663 sizing changes that do not trigger a size event, and/or scrolled
8664 windows without an interior sizer. This function similarly won't do
8665 anything if there are no subwindows.
8666 """
8667 return _core_.Window_FitInside(*args, **kwargs)
8668
8669 def SetSizeHints(*args, **kwargs):
8670 """
8671 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8672 int incH=-1)
8673
8674 Allows specification of minimum and maximum window sizes, and window
8675 size increments. If a pair of values is not set (or set to -1), the
8676 default values will be used. If this function is called, the user
8677 will not be able to size the window outside the given bounds (if it is
8678 a top-level window.) Sizers will also inspect the minimum window size
8679 and will use that value if set when calculating layout.
8680
8681 The resizing increments are only significant under Motif or Xt.
8682 """
8683 return _core_.Window_SetSizeHints(*args, **kwargs)
8684
8685 def SetSizeHintsSz(*args, **kwargs):
8686 """
8687 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8688
8689 Allows specification of minimum and maximum window sizes, and window
8690 size increments. If a pair of values is not set (or set to -1), the
8691 default values will be used. If this function is called, the user
8692 will not be able to size the window outside the given bounds (if it is
8693 a top-level window.) Sizers will also inspect the minimum window size
8694 and will use that value if set when calculating layout.
8695
8696 The resizing increments are only significant under Motif or Xt.
8697 """
8698 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8699
8700 def SetVirtualSizeHints(*args, **kwargs):
8701 """
8702 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
8703
8704 Allows specification of minimum and maximum virtual window sizes. If a
8705 pair of values is not set (or set to -1), the default values will be
8706 used. If this function is called, the user will not be able to size
8707 the virtual area of the window outside the given bounds.
8708 """
8709 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8710
8711 def SetVirtualSizeHintsSz(*args, **kwargs):
8712 """
8713 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8714
8715 Allows specification of minimum and maximum virtual window sizes. If a
8716 pair of values is not set (or set to -1), the default values will be
8717 used. If this function is called, the user will not be able to size
8718 the virtual area of the window outside the given bounds.
8719 """
8720 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
8721
8722 def GetMaxSize(*args, **kwargs):
8723 """GetMaxSize(self) -> Size"""
8724 return _core_.Window_GetMaxSize(*args, **kwargs)
8725
8726 def GetMinSize(*args, **kwargs):
8727 """GetMinSize(self) -> Size"""
8728 return _core_.Window_GetMinSize(*args, **kwargs)
8729
8730 def SetMinSize(*args, **kwargs):
8731 """
8732 SetMinSize(self, Size minSize)
8733
8734 A more convenient method than `SetSizeHints` for setting just the
8735 min size.
8736 """
8737 return _core_.Window_SetMinSize(*args, **kwargs)
8738
8739 def SetMaxSize(*args, **kwargs):
8740 """
8741 SetMaxSize(self, Size maxSize)
8742
8743 A more convenient method than `SetSizeHints` for setting just the
8744 max size.
8745 """
8746 return _core_.Window_SetMaxSize(*args, **kwargs)
8747
8748 def GetMinWidth(*args, **kwargs):
8749 """GetMinWidth(self) -> int"""
8750 return _core_.Window_GetMinWidth(*args, **kwargs)
8751
8752 def GetMinHeight(*args, **kwargs):
8753 """GetMinHeight(self) -> int"""
8754 return _core_.Window_GetMinHeight(*args, **kwargs)
8755
8756 def GetMaxWidth(*args, **kwargs):
8757 """GetMaxWidth(self) -> int"""
8758 return _core_.Window_GetMaxWidth(*args, **kwargs)
8759
8760 def GetMaxHeight(*args, **kwargs):
8761 """GetMaxHeight(self) -> int"""
8762 return _core_.Window_GetMaxHeight(*args, **kwargs)
8763
8764 def SetVirtualSize(*args, **kwargs):
8765 """
8766 SetVirtualSize(self, Size size)
8767
8768 Set the the virtual size of a window in pixels. For most windows this
8769 is just the client area of the window, but for some like scrolled
8770 windows it is more or less independent of the screen window size.
8771 """
8772 return _core_.Window_SetVirtualSize(*args, **kwargs)
8773
8774 def SetVirtualSizeWH(*args, **kwargs):
8775 """
8776 SetVirtualSizeWH(self, int w, int h)
8777
8778 Set the the virtual size of a window in pixels. For most windows this
8779 is just the client area of the window, but for some like scrolled
8780 windows it is more or less independent of the screen window size.
8781 """
8782 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8783
8784 def GetVirtualSize(*args, **kwargs):
8785 """
8786 GetVirtualSize(self) -> Size
8787
8788 Get the the virtual size of the window in pixels. For most windows
8789 this is just the client area of the window, but for some like scrolled
8790 windows it is more or less independent of the screen window size.
8791 """
8792 return _core_.Window_GetVirtualSize(*args, **kwargs)
8793
8794 def GetVirtualSizeTuple(*args, **kwargs):
8795 """
8796 GetVirtualSizeTuple() -> (width, height)
8797
8798 Get the the virtual size of the window in pixels. For most windows
8799 this is just the client area of the window, but for some like scrolled
8800 windows it is more or less independent of the screen window size.
8801 """
8802 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8803
8804 def GetBestVirtualSize(*args, **kwargs):
8805 """
8806 GetBestVirtualSize(self) -> Size
8807
8808 Return the largest of ClientSize and BestSize (as determined by a
8809 sizer, interior children, or other means)
8810 """
8811 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8812
8813 def Show(*args, **kwargs):
8814 """
8815 Show(self, bool show=True) -> bool
8816
8817 Shows or hides the window. You may need to call Raise for a top level
8818 window if you want to bring it to top, although this is not needed if
8819 Show is called immediately after the frame creation. Returns True if
8820 the window has been shown or hidden or False if nothing was done
8821 because it already was in the requested state.
8822 """
8823 return _core_.Window_Show(*args, **kwargs)
8824
8825 def Hide(*args, **kwargs):
8826 """
8827 Hide(self) -> bool
8828
8829 Equivalent to calling Show(False).
8830 """
8831 return _core_.Window_Hide(*args, **kwargs)
8832
8833 def Enable(*args, **kwargs):
8834 """
8835 Enable(self, bool enable=True) -> bool
8836
8837 Enable or disable the window for user input. Note that when a parent
8838 window is disabled, all of its children are disabled as well and they
8839 are reenabled again when the parent is. Returns true if the window
8840 has been enabled or disabled, false if nothing was done, i.e. if the
8841 window had already been in the specified state.
8842 """
8843 return _core_.Window_Enable(*args, **kwargs)
8844
8845 def Disable(*args, **kwargs):
8846 """
8847 Disable(self) -> bool
8848
8849 Disables the window, same as Enable(false).
8850 """
8851 return _core_.Window_Disable(*args, **kwargs)
8852
8853 def IsShown(*args, **kwargs):
8854 """
8855 IsShown(self) -> bool
8856
8857 Returns true if the window is shown, false if it has been hidden.
8858 """
8859 return _core_.Window_IsShown(*args, **kwargs)
8860
8861 def IsEnabled(*args, **kwargs):
8862 """
8863 IsEnabled(self) -> bool
8864
8865 Returns true if the window is enabled for input, false otherwise.
8866 """
8867 return _core_.Window_IsEnabled(*args, **kwargs)
8868
8869 def IsShownOnScreen(*args, **kwargs):
8870 """
8871 IsShownOnScreen(self) -> bool
8872
8873 Returns ``True`` if the window is physically visible on the screen,
8874 i.e. it is shown and all its parents up to the toplevel window are
8875 shown as well.
8876 """
8877 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8878
8879 def SetWindowStyleFlag(*args, **kwargs):
8880 """
8881 SetWindowStyleFlag(self, long style)
8882
8883 Sets the style of the window. Please note that some styles cannot be
8884 changed after the window creation and that Refresh() might need to be
8885 called after changing the others for the change to take place
8886 immediately.
8887 """
8888 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8889
8890 def GetWindowStyleFlag(*args, **kwargs):
8891 """
8892 GetWindowStyleFlag(self) -> long
8893
8894 Gets the window style that was passed to the constructor or Create
8895 method.
8896 """
8897 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8898
8899 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8900 def HasFlag(*args, **kwargs):
8901 """
8902 HasFlag(self, int flag) -> bool
8903
8904 Test if the given style is set for this window.
8905 """
8906 return _core_.Window_HasFlag(*args, **kwargs)
8907
8908 def IsRetained(*args, **kwargs):
8909 """
8910 IsRetained(self) -> bool
8911
8912 Returns true if the window is retained, false otherwise. Retained
8913 windows are only available on X platforms.
8914 """
8915 return _core_.Window_IsRetained(*args, **kwargs)
8916
8917 def SetExtraStyle(*args, **kwargs):
8918 """
8919 SetExtraStyle(self, long exStyle)
8920
8921 Sets the extra style bits for the window. Extra styles are the less
8922 often used style bits which can't be set with the constructor or with
8923 SetWindowStyleFlag()
8924 """
8925 return _core_.Window_SetExtraStyle(*args, **kwargs)
8926
8927 def GetExtraStyle(*args, **kwargs):
8928 """
8929 GetExtraStyle(self) -> long
8930
8931 Returns the extra style bits for the window.
8932 """
8933 return _core_.Window_GetExtraStyle(*args, **kwargs)
8934
8935 def MakeModal(*args, **kwargs):
8936 """
8937 MakeModal(self, bool modal=True)
8938
8939 Disables all other windows in the application so that the user can
8940 only interact with this window. Passing False will reverse this
8941 effect.
8942 """
8943 return _core_.Window_MakeModal(*args, **kwargs)
8944
8945 def SetThemeEnabled(*args, **kwargs):
8946 """
8947 SetThemeEnabled(self, bool enableTheme)
8948
8949 This function tells a window if it should use the system's "theme"
8950 code to draw the windows' background instead if its own background
8951 drawing code. This will only have an effect on platforms that support
8952 the notion of themes in user defined windows. One such platform is
8953 GTK+ where windows can have (very colourful) backgrounds defined by a
8954 user's selected theme.
8955
8956 Dialogs, notebook pages and the status bar have this flag set to true
8957 by default so that the default look and feel is simulated best.
8958 """
8959 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8960
8961 def GetThemeEnabled(*args, **kwargs):
8962 """
8963 GetThemeEnabled(self) -> bool
8964
8965 Return the themeEnabled flag.
8966 """
8967 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8968
8969 def SetFocus(*args, **kwargs):
8970 """
8971 SetFocus(self)
8972
8973 Set's the focus to this window, allowing it to receive keyboard input.
8974 """
8975 return _core_.Window_SetFocus(*args, **kwargs)
8976
8977 def SetFocusFromKbd(*args, **kwargs):
8978 """
8979 SetFocusFromKbd(self)
8980
8981 Set focus to this window as the result of a keyboard action. Normally
8982 only called internally.
8983 """
8984 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8985
8986 def FindFocus(*args, **kwargs):
8987 """
8988 FindFocus() -> Window
8989
8990 Returns the window or control that currently has the keyboard focus,
8991 or None.
8992 """
8993 return _core_.Window_FindFocus(*args, **kwargs)
8994
8995 FindFocus = staticmethod(FindFocus)
8996 def AcceptsFocus(*args, **kwargs):
8997 """
8998 AcceptsFocus(self) -> bool
8999
9000 Can this window have focus?
9001 """
9002 return _core_.Window_AcceptsFocus(*args, **kwargs)
9003
9004 def AcceptsFocusFromKeyboard(*args, **kwargs):
9005 """
9006 AcceptsFocusFromKeyboard(self) -> bool
9007
9008 Can this window be given focus by keyboard navigation? if not, the
9009 only way to give it focus (provided it accepts it at all) is to click
9010 it.
9011 """
9012 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
9013
9014 def Navigate(*args, **kwargs):
9015 """
9016 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9017
9018 Does keyboard navigation from this window to another, by sending a
9019 `wx.NavigationKeyEvent`.
9020 """
9021 return _core_.Window_Navigate(*args, **kwargs)
9022
9023 def MoveAfterInTabOrder(*args, **kwargs):
9024 """
9025 MoveAfterInTabOrder(self, Window win)
9026
9027 Moves this window in the tab navigation order after the specified
9028 sibling window. This means that when the user presses the TAB key on
9029 that other window, the focus switches to this window.
9030
9031 The default tab order is the same as creation order. This function
9032 and `MoveBeforeInTabOrder` allow to change it after creating all the
9033 windows.
9034
9035 """
9036 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9037
9038 def MoveBeforeInTabOrder(*args, **kwargs):
9039 """
9040 MoveBeforeInTabOrder(self, Window win)
9041
9042 Same as `MoveAfterInTabOrder` except that it inserts this window just
9043 before win instead of putting it right after it.
9044 """
9045 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9046
9047 def GetChildren(*args, **kwargs):
9048 """
9049 GetChildren(self) -> PyObject
9050
9051 Returns a list of the window's children. NOTE: Currently this is a
9052 copy of the child window list maintained by the window, so the return
9053 value of this function is only valid as long as the window's children
9054 do not change.
9055 """
9056 return _core_.Window_GetChildren(*args, **kwargs)
9057
9058 def GetParent(*args, **kwargs):
9059 """
9060 GetParent(self) -> Window
9061
9062 Returns the parent window of this window, or None if there isn't one.
9063 """
9064 return _core_.Window_GetParent(*args, **kwargs)
9065
9066 def GetGrandParent(*args, **kwargs):
9067 """
9068 GetGrandParent(self) -> Window
9069
9070 Returns the parent of the parent of this window, or None if there
9071 isn't one.
9072 """
9073 return _core_.Window_GetGrandParent(*args, **kwargs)
9074
9075 def IsTopLevel(*args, **kwargs):
9076 """
9077 IsTopLevel(self) -> bool
9078
9079 Returns true if the given window is a top-level one. Currently all
9080 frames and dialogs are always considered to be top-level windows (even
9081 if they have a parent window).
9082 """
9083 return _core_.Window_IsTopLevel(*args, **kwargs)
9084
9085 def Reparent(*args, **kwargs):
9086 """
9087 Reparent(self, Window newParent) -> bool
9088
9089 Reparents the window, i.e the window will be removed from its current
9090 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9091 re-inserted into another. Available on Windows and GTK. Returns True
9092 if the parent was changed, False otherwise (error or newParent ==
9093 oldParent)
9094 """
9095 return _core_.Window_Reparent(*args, **kwargs)
9096
9097 def AddChild(*args, **kwargs):
9098 """
9099 AddChild(self, Window child)
9100
9101 Adds a child window. This is called automatically by window creation
9102 functions so should not be required by the application programmer.
9103 """
9104 return _core_.Window_AddChild(*args, **kwargs)
9105
9106 def RemoveChild(*args, **kwargs):
9107 """
9108 RemoveChild(self, Window child)
9109
9110 Removes a child window. This is called automatically by window
9111 deletion functions so should not be required by the application
9112 programmer.
9113 """
9114 return _core_.Window_RemoveChild(*args, **kwargs)
9115
9116 def SetDoubleBuffered(*args, **kwargs):
9117 """
9118 SetDoubleBuffered(self, bool on)
9119
9120 Currently wxGTK2 only.
9121 """
9122 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9123
9124 def FindWindowById(*args, **kwargs):
9125 """
9126 FindWindowById(self, long winid) -> Window
9127
9128 Find a chld of this window by window ID
9129 """
9130 return _core_.Window_FindWindowById(*args, **kwargs)
9131
9132 def FindWindowByName(*args, **kwargs):
9133 """
9134 FindWindowByName(self, String name) -> Window
9135
9136 Find a child of this window by name
9137 """
9138 return _core_.Window_FindWindowByName(*args, **kwargs)
9139
9140 def GetEventHandler(*args, **kwargs):
9141 """
9142 GetEventHandler(self) -> EvtHandler
9143
9144 Returns the event handler for this window. By default, the window is
9145 its own event handler.
9146 """
9147 return _core_.Window_GetEventHandler(*args, **kwargs)
9148
9149 def SetEventHandler(*args, **kwargs):
9150 """
9151 SetEventHandler(self, EvtHandler handler)
9152
9153 Sets the event handler for this window. An event handler is an object
9154 that is capable of processing the events sent to a window. (In other
9155 words, is able to dispatch the events to handler function.) By
9156 default, the window is its own event handler, but an application may
9157 wish to substitute another, for example to allow central
9158 implementation of event-handling for a variety of different window
9159 classes.
9160
9161 It is usually better to use `wx.Window.PushEventHandler` since this sets
9162 up a chain of event handlers, where an event not handled by one event
9163 handler is handed off to the next one in the chain.
9164 """
9165 return _core_.Window_SetEventHandler(*args, **kwargs)
9166
9167 def PushEventHandler(*args, **kwargs):
9168 """
9169 PushEventHandler(self, EvtHandler handler)
9170
9171 Pushes this event handler onto the event handler stack for the window.
9172 An event handler is an object that is capable of processing the events
9173 sent to a window. (In other words, is able to dispatch the events to
9174 handler function.) By default, the window is its own event handler,
9175 but an application may wish to substitute another, for example to
9176 allow central implementation of event-handling for a variety of
9177 different window classes.
9178
9179 wx.Window.PushEventHandler allows an application to set up a chain of
9180 event handlers, where an event not handled by one event handler is
9181 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9182 to remove the event handler. Ownership of the handler is *not* given
9183 to the window, so you should be sure to pop the handler before the
9184 window is destroyed and either let PopEventHandler destroy it, or call
9185 its Destroy method yourself.
9186 """
9187 return _core_.Window_PushEventHandler(*args, **kwargs)
9188
9189 def PopEventHandler(*args, **kwargs):
9190 """
9191 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9192
9193 Removes and returns the top-most event handler on the event handler
9194 stack. If deleteHandler is True then the wx.EvtHandler object will be
9195 destroyed after it is popped, and ``None`` will be returned instead.
9196 """
9197 return _core_.Window_PopEventHandler(*args, **kwargs)
9198
9199 def RemoveEventHandler(*args, **kwargs):
9200 """
9201 RemoveEventHandler(self, EvtHandler handler) -> bool
9202
9203 Find the given handler in the event handler chain and remove (but not
9204 delete) it from the event handler chain, returns True if it was found
9205 and False otherwise (this also results in an assert failure so this
9206 function should only be called when the handler is supposed to be
9207 there.)
9208 """
9209 return _core_.Window_RemoveEventHandler(*args, **kwargs)
9210
9211 def SetValidator(*args, **kwargs):
9212 """
9213 SetValidator(self, Validator validator)
9214
9215 Deletes the current validator (if any) and sets the window validator,
9216 having called wx.Validator.Clone to create a new validator of this
9217 type.
9218 """
9219 return _core_.Window_SetValidator(*args, **kwargs)
9220
9221 def GetValidator(*args, **kwargs):
9222 """
9223 GetValidator(self) -> Validator
9224
9225 Returns a pointer to the current validator for the window, or None if
9226 there is none.
9227 """
9228 return _core_.Window_GetValidator(*args, **kwargs)
9229
9230 def Validate(*args, **kwargs):
9231 """
9232 Validate(self) -> bool
9233
9234 Validates the current values of the child controls using their
9235 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9236 style flag set, the method will also call Validate() of all child
9237 windows. Returns false if any of the validations failed.
9238 """
9239 return _core_.Window_Validate(*args, **kwargs)
9240
9241 def TransferDataToWindow(*args, **kwargs):
9242 """
9243 TransferDataToWindow(self) -> bool
9244
9245 Transfers values to child controls from data areas specified by their
9246 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9247 style flag set, the method will also call TransferDataToWindow() of
9248 all child windows.
9249 """
9250 return _core_.Window_TransferDataToWindow(*args, **kwargs)
9251
9252 def TransferDataFromWindow(*args, **kwargs):
9253 """
9254 TransferDataFromWindow(self) -> bool
9255
9256 Transfers values from child controls to data areas specified by their
9257 validators. Returns false if a transfer failed. If the window has
9258 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9259 also call TransferDataFromWindow() of all child windows.
9260 """
9261 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9262
9263 def InitDialog(*args, **kwargs):
9264 """
9265 InitDialog(self)
9266
9267 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9268 to the dialog via validators.
9269 """
9270 return _core_.Window_InitDialog(*args, **kwargs)
9271
9272 def SetAcceleratorTable(*args, **kwargs):
9273 """
9274 SetAcceleratorTable(self, AcceleratorTable accel)
9275
9276 Sets the accelerator table for this window.
9277 """
9278 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9279
9280 def GetAcceleratorTable(*args, **kwargs):
9281 """
9282 GetAcceleratorTable(self) -> AcceleratorTable
9283
9284 Gets the accelerator table for this window.
9285 """
9286 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9287
9288 def RegisterHotKey(*args, **kwargs):
9289 """
9290 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9291
9292 Registers a system wide hotkey. Every time the user presses the hotkey
9293 registered here, this window will receive a hotkey event. It will
9294 receive the event even if the application is in the background and
9295 does not have the input focus because the user is working with some
9296 other application. To bind an event handler function to this hotkey
9297 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9298 hotkey was registered successfully.
9299 """
9300 return _core_.Window_RegisterHotKey(*args, **kwargs)
9301
9302 def UnregisterHotKey(*args, **kwargs):
9303 """
9304 UnregisterHotKey(self, int hotkeyId) -> bool
9305
9306 Unregisters a system wide hotkey.
9307 """
9308 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9309
9310 def ConvertDialogPointToPixels(*args, **kwargs):
9311 """
9312 ConvertDialogPointToPixels(self, Point pt) -> Point
9313
9314 Converts a point or size from dialog units to pixels. Dialog units
9315 are used for maintaining a dialog's proportions even if the font
9316 changes. For the x dimension, the dialog units are multiplied by the
9317 average character width and then divided by 4. For the y dimension,
9318 the dialog units are multiplied by the average character height and
9319 then divided by 8.
9320 """
9321 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9322
9323 def ConvertDialogSizeToPixels(*args, **kwargs):
9324 """
9325 ConvertDialogSizeToPixels(self, Size sz) -> Size
9326
9327 Converts a point or size from dialog units to pixels. Dialog units
9328 are used for maintaining a dialog's proportions even if the font
9329 changes. For the x dimension, the dialog units are multiplied by the
9330 average character width and then divided by 4. For the y dimension,
9331 the dialog units are multiplied by the average character height and
9332 then divided by 8.
9333 """
9334 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9335
9336 def DLG_PNT(*args, **kwargs):
9337 """
9338 DLG_PNT(self, Point pt) -> Point
9339
9340 Converts a point or size from dialog units to pixels. Dialog units
9341 are used for maintaining a dialog's proportions even if the font
9342 changes. For the x dimension, the dialog units are multiplied by the
9343 average character width and then divided by 4. For the y dimension,
9344 the dialog units are multiplied by the average character height and
9345 then divided by 8.
9346 """
9347 return _core_.Window_DLG_PNT(*args, **kwargs)
9348
9349 def DLG_SZE(*args, **kwargs):
9350 """
9351 DLG_SZE(self, Size sz) -> Size
9352
9353 Converts a point or size from dialog units to pixels. Dialog units
9354 are used for maintaining a dialog's proportions even if the font
9355 changes. For the x dimension, the dialog units are multiplied by the
9356 average character width and then divided by 4. For the y dimension,
9357 the dialog units are multiplied by the average character height and
9358 then divided by 8.
9359 """
9360 return _core_.Window_DLG_SZE(*args, **kwargs)
9361
9362 def ConvertPixelPointToDialog(*args, **kwargs):
9363 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9364 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9365
9366 def ConvertPixelSizeToDialog(*args, **kwargs):
9367 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9368 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9369
9370 def WarpPointer(*args, **kwargs):
9371 """
9372 WarpPointer(self, int x, int y)
9373
9374 Moves the pointer to the given position on the window.
9375
9376 NOTE: This function is not supported under Mac because Apple Human
9377 Interface Guidelines forbid moving the mouse cursor programmatically.
9378 """
9379 return _core_.Window_WarpPointer(*args, **kwargs)
9380
9381 def CaptureMouse(*args, **kwargs):
9382 """
9383 CaptureMouse(self)
9384
9385 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9386 release the capture.
9387
9388 Note that wxWindows maintains the stack of windows having captured the
9389 mouse and when the mouse is released the capture returns to the window
9390 which had had captured it previously and it is only really released if
9391 there were no previous window. In particular, this means that you must
9392 release the mouse as many times as you capture it, unless the window
9393 receives the `wx.MouseCaptureLostEvent` event.
9394
9395 Any application which captures the mouse in the beginning of some
9396 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9397 operation when it receives the event. The event handler must not
9398 recapture mouse.
9399 """
9400 return _core_.Window_CaptureMouse(*args, **kwargs)
9401
9402 def ReleaseMouse(*args, **kwargs):
9403 """
9404 ReleaseMouse(self)
9405
9406 Releases mouse input captured with wx.Window.CaptureMouse.
9407 """
9408 return _core_.Window_ReleaseMouse(*args, **kwargs)
9409
9410 def GetCapture(*args, **kwargs):
9411 """
9412 GetCapture() -> Window
9413
9414 Returns the window which currently captures the mouse or None
9415 """
9416 return _core_.Window_GetCapture(*args, **kwargs)
9417
9418 GetCapture = staticmethod(GetCapture)
9419 def HasCapture(*args, **kwargs):
9420 """
9421 HasCapture(self) -> bool
9422
9423 Returns true if this window has the current mouse capture.
9424 """
9425 return _core_.Window_HasCapture(*args, **kwargs)
9426
9427 def Refresh(*args, **kwargs):
9428 """
9429 Refresh(self, bool eraseBackground=True, Rect rect=None)
9430
9431 Mark the specified rectangle (or the whole window) as "dirty" so it
9432 will be repainted. Causes an EVT_PAINT event to be generated and sent
9433 to the window.
9434 """
9435 return _core_.Window_Refresh(*args, **kwargs)
9436
9437 def RefreshRect(*args, **kwargs):
9438 """
9439 RefreshRect(self, Rect rect, bool eraseBackground=True)
9440
9441 Redraws the contents of the given rectangle: the area inside it will
9442 be repainted. This is the same as Refresh but has a nicer syntax.
9443 """
9444 return _core_.Window_RefreshRect(*args, **kwargs)
9445
9446 def Update(*args, **kwargs):
9447 """
9448 Update(self)
9449
9450 Calling this method immediately repaints the invalidated area of the
9451 window instead of waiting for the EVT_PAINT event to happen, (normally
9452 this would usually only happen when the flow of control returns to the
9453 event loop.) Notice that this function doesn't refresh the window and
9454 does nothing if the window has been already repainted. Use `Refresh`
9455 first if you want to immediately redraw the window (or some portion of
9456 it) unconditionally.
9457 """
9458 return _core_.Window_Update(*args, **kwargs)
9459
9460 def ClearBackground(*args, **kwargs):
9461 """
9462 ClearBackground(self)
9463
9464 Clears the window by filling it with the current background
9465 colour. Does not cause an erase background event to be generated.
9466 """
9467 return _core_.Window_ClearBackground(*args, **kwargs)
9468
9469 def Freeze(*args, **kwargs):
9470 """
9471 Freeze(self)
9472
9473 Freezes the window or, in other words, prevents any updates from
9474 taking place on screen, the window is not redrawn at all. Thaw must be
9475 called to reenable window redrawing. Calls to Freeze/Thaw may be
9476 nested, with the actual Thaw being delayed until all the nesting has
9477 been undone.
9478
9479 This method is useful for visual appearance optimization (for example,
9480 it is a good idea to use it before inserting large amount of text into
9481 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9482 for all controls so it is mostly just a hint to wxWindows and not a
9483 mandatory directive.
9484 """
9485 return _core_.Window_Freeze(*args, **kwargs)
9486
9487 def IsFrozen(*args, **kwargs):
9488 """
9489 IsFrozen(self) -> bool
9490
9491 Returns ``True`` if the window has been frozen and not thawed yet.
9492
9493 :see: `Freeze` and `Thaw`
9494 """
9495 return _core_.Window_IsFrozen(*args, **kwargs)
9496
9497 def Thaw(*args, **kwargs):
9498 """
9499 Thaw(self)
9500
9501 Reenables window updating after a previous call to Freeze. Calls to
9502 Freeze/Thaw may be nested, so Thaw must be called the same number of
9503 times that Freeze was before the window will be updated.
9504 """
9505 return _core_.Window_Thaw(*args, **kwargs)
9506
9507 def PrepareDC(*args, **kwargs):
9508 """
9509 PrepareDC(self, DC dc)
9510
9511 Call this function to prepare the device context for drawing a
9512 scrolled image. It sets the device origin according to the current
9513 scroll position.
9514 """
9515 return _core_.Window_PrepareDC(*args, **kwargs)
9516
9517 def IsDoubleBuffered(*args, **kwargs):
9518 """
9519 IsDoubleBuffered(self) -> bool
9520
9521 Returns ``True`` if the window contents is double-buffered by the
9522 system, i.e. if any drawing done on the window is really done on a
9523 temporary backing surface and transferred to the screen all at once
9524 later.
9525 """
9526 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9527
9528 def GetUpdateRegion(*args, **kwargs):
9529 """
9530 GetUpdateRegion(self) -> Region
9531
9532 Returns the region specifying which parts of the window have been
9533 damaged. Should only be called within an EVT_PAINT handler.
9534 """
9535 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9536
9537 def GetUpdateClientRect(*args, **kwargs):
9538 """
9539 GetUpdateClientRect(self) -> Rect
9540
9541 Get the update rectangle region bounding box in client coords.
9542 """
9543 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9544
9545 def IsExposed(*args, **kwargs):
9546 """
9547 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9548
9549 Returns true if the given point or rectangle area has been exposed
9550 since the last repaint. Call this in an paint event handler to
9551 optimize redrawing by only redrawing those areas, which have been
9552 exposed.
9553 """
9554 return _core_.Window_IsExposed(*args, **kwargs)
9555
9556 def IsExposedPoint(*args, **kwargs):
9557 """
9558 IsExposedPoint(self, Point pt) -> bool
9559
9560 Returns true if the given point or rectangle area has been exposed
9561 since the last repaint. Call this in an paint event handler to
9562 optimize redrawing by only redrawing those areas, which have been
9563 exposed.
9564 """
9565 return _core_.Window_IsExposedPoint(*args, **kwargs)
9566
9567 def IsExposedRect(*args, **kwargs):
9568 """
9569 IsExposedRect(self, Rect rect) -> bool
9570
9571 Returns true if the given point or rectangle area has been exposed
9572 since the last repaint. Call this in an paint event handler to
9573 optimize redrawing by only redrawing those areas, which have been
9574 exposed.
9575 """
9576 return _core_.Window_IsExposedRect(*args, **kwargs)
9577
9578 def GetDefaultAttributes(*args, **kwargs):
9579 """
9580 GetDefaultAttributes(self) -> VisualAttributes
9581
9582 Get the default attributes for an instance of this class. This is
9583 useful if you want to use the same font or colour in your own control
9584 as in a standard control -- which is a much better idea than hard
9585 coding specific colours or fonts which might look completely out of
9586 place on the user's system, especially if it uses themes.
9587 """
9588 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9589
9590 def GetClassDefaultAttributes(*args, **kwargs):
9591 """
9592 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
9593
9594 Get the default attributes for this class. This is useful if you want
9595 to use the same font or colour in your own control as in a standard
9596 control -- which is a much better idea than hard coding specific
9597 colours or fonts which might look completely out of place on the
9598 user's system, especially if it uses themes.
9599
9600 The variant parameter is only relevant under Mac currently and is
9601 ignore under other platforms. Under Mac, it will change the size of
9602 the returned font. See `wx.Window.SetWindowVariant` for more about
9603 this.
9604 """
9605 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9606
9607 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9608 def SetBackgroundColour(*args, **kwargs):
9609 """
9610 SetBackgroundColour(self, Colour colour) -> bool
9611
9612 Sets the background colour of the window. Returns True if the colour
9613 was changed. The background colour is usually painted by the default
9614 EVT_ERASE_BACKGROUND event handler function under Windows and
9615 automatically under GTK. Using `wx.NullColour` will reset the window
9616 to the default background colour.
9617
9618 Note that setting the background colour may not cause an immediate
9619 refresh, so you may wish to call `ClearBackground` or `Refresh` after
9620 calling this function.
9621
9622 Using this function will disable attempts to use themes for this
9623 window, if the system supports them. Use with care since usually the
9624 themes represent the appearance chosen by the user to be used for all
9625 applications on the system.
9626 """
9627 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9628
9629 def SetOwnBackgroundColour(*args, **kwargs):
9630 """SetOwnBackgroundColour(self, Colour colour)"""
9631 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
9632
9633 def SetForegroundColour(*args, **kwargs):
9634 """
9635 SetForegroundColour(self, Colour colour) -> bool
9636
9637 Sets the foreground colour of the window. Returns True is the colour
9638 was changed. The interpretation of foreground colour is dependent on
9639 the window class; it may be the text colour or other colour, or it may
9640 not be used at all.
9641 """
9642 return _core_.Window_SetForegroundColour(*args, **kwargs)
9643
9644 def SetOwnForegroundColour(*args, **kwargs):
9645 """SetOwnForegroundColour(self, Colour colour)"""
9646 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
9647
9648 def GetBackgroundColour(*args, **kwargs):
9649 """
9650 GetBackgroundColour(self) -> Colour
9651
9652 Returns the background colour of the window.
9653 """
9654 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9655
9656 def GetForegroundColour(*args, **kwargs):
9657 """
9658 GetForegroundColour(self) -> Colour
9659
9660 Returns the foreground colour of the window. The interpretation of
9661 foreground colour is dependent on the window class; it may be the text
9662 colour or other colour, or it may not be used at all.
9663 """
9664 return _core_.Window_GetForegroundColour(*args, **kwargs)
9665
9666 def InheritsBackgroundColour(*args, **kwargs):
9667 """InheritsBackgroundColour(self) -> bool"""
9668 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9669
9670 def UseBgCol(*args, **kwargs):
9671 """UseBgCol(self) -> bool"""
9672 return _core_.Window_UseBgCol(*args, **kwargs)
9673
9674 def SetBackgroundStyle(*args, **kwargs):
9675 """
9676 SetBackgroundStyle(self, int style) -> bool
9677
9678 Returns the background style of the window. The background style
9679 indicates how the background of the window is drawn.
9680
9681 ====================== ========================================
9682 wx.BG_STYLE_SYSTEM The background colour or pattern should
9683 be determined by the system
9684 wx.BG_STYLE_COLOUR The background should be a solid colour
9685 wx.BG_STYLE_CUSTOM The background will be implemented by the
9686 application.
9687 ====================== ========================================
9688
9689 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9690 a custom background, such as a tiled bitmap. Currently the style has
9691 no effect on other platforms.
9692
9693 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9694 """
9695 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9696
9697 def GetBackgroundStyle(*args, **kwargs):
9698 """
9699 GetBackgroundStyle(self) -> int
9700
9701 Returns the background style of the window.
9702
9703 :see: `SetBackgroundStyle`
9704 """
9705 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9706
9707 def HasTransparentBackground(*args, **kwargs):
9708 """
9709 HasTransparentBackground(self) -> bool
9710
9711 Returns True if this window's background is transparent (as, for
9712 example, for `wx.StaticText`) and should show the parent window's
9713 background.
9714
9715 This method is mostly used internally by the library itself and you
9716 normally shouldn't have to call it. You may, however, have to override
9717 it in your custom control classes to ensure that background is painted
9718 correctly.
9719 """
9720 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9721
9722 def SetCursor(*args, **kwargs):
9723 """
9724 SetCursor(self, Cursor cursor) -> bool
9725
9726 Sets the window's cursor. Notice that the window cursor also sets it
9727 for the children of the window implicitly.
9728
9729 The cursor may be wx.NullCursor in which case the window cursor will
9730 be reset back to default.
9731 """
9732 return _core_.Window_SetCursor(*args, **kwargs)
9733
9734 def GetCursor(*args, **kwargs):
9735 """
9736 GetCursor(self) -> Cursor
9737
9738 Return the cursor associated with this window.
9739 """
9740 return _core_.Window_GetCursor(*args, **kwargs)
9741
9742 def SetFont(*args, **kwargs):
9743 """
9744 SetFont(self, Font font) -> bool
9745
9746 Sets the font for this window.
9747 """
9748 return _core_.Window_SetFont(*args, **kwargs)
9749
9750 def SetOwnFont(*args, **kwargs):
9751 """SetOwnFont(self, Font font)"""
9752 return _core_.Window_SetOwnFont(*args, **kwargs)
9753
9754 def GetFont(*args, **kwargs):
9755 """
9756 GetFont(self) -> Font
9757
9758 Returns the default font used for this window.
9759 """
9760 return _core_.Window_GetFont(*args, **kwargs)
9761
9762 def SetCaret(*args, **kwargs):
9763 """
9764 SetCaret(self, Caret caret)
9765
9766 Sets the caret associated with the window.
9767 """
9768 return _core_.Window_SetCaret(*args, **kwargs)
9769
9770 def GetCaret(*args, **kwargs):
9771 """
9772 GetCaret(self) -> Caret
9773
9774 Returns the caret associated with the window.
9775 """
9776 return _core_.Window_GetCaret(*args, **kwargs)
9777
9778 def GetCharHeight(*args, **kwargs):
9779 """
9780 GetCharHeight(self) -> int
9781
9782 Get the (average) character size for the current font.
9783 """
9784 return _core_.Window_GetCharHeight(*args, **kwargs)
9785
9786 def GetCharWidth(*args, **kwargs):
9787 """
9788 GetCharWidth(self) -> int
9789
9790 Get the (average) character size for the current font.
9791 """
9792 return _core_.Window_GetCharWidth(*args, **kwargs)
9793
9794 def GetTextExtent(*args, **kwargs):
9795 """
9796 GetTextExtent(String string) -> (width, height)
9797
9798 Get the width and height of the text using the current font.
9799 """
9800 return _core_.Window_GetTextExtent(*args, **kwargs)
9801
9802 def GetFullTextExtent(*args, **kwargs):
9803 """
9804 GetFullTextExtent(String string, Font font=None) ->
9805 (width, height, descent, externalLeading)
9806
9807 Get the width, height, decent and leading of the text using the
9808 current or specified font.
9809 """
9810 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9811
9812 def ClientToScreenXY(*args, **kwargs):
9813 """
9814 ClientToScreenXY(int x, int y) -> (x,y)
9815
9816 Converts to screen coordinates from coordinates relative to this window.
9817 """
9818 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9819
9820 def ScreenToClientXY(*args, **kwargs):
9821 """
9822 ScreenToClientXY(int x, int y) -> (x,y)
9823
9824 Converts from screen to client window coordinates.
9825 """
9826 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9827
9828 def ClientToScreen(*args, **kwargs):
9829 """
9830 ClientToScreen(self, Point pt) -> Point
9831
9832 Converts to screen coordinates from coordinates relative to this window.
9833 """
9834 return _core_.Window_ClientToScreen(*args, **kwargs)
9835
9836 def ScreenToClient(*args, **kwargs):
9837 """
9838 ScreenToClient(self, Point pt) -> Point
9839
9840 Converts from screen to client window coordinates.
9841 """
9842 return _core_.Window_ScreenToClient(*args, **kwargs)
9843
9844 def HitTestXY(*args, **kwargs):
9845 """
9846 HitTestXY(self, int x, int y) -> int
9847
9848 Test where the given (in client coords) point lies
9849 """
9850 return _core_.Window_HitTestXY(*args, **kwargs)
9851
9852 def HitTest(*args, **kwargs):
9853 """
9854 HitTest(self, Point pt) -> int
9855
9856 Test where the given (in client coords) point lies
9857 """
9858 return _core_.Window_HitTest(*args, **kwargs)
9859
9860 def GetBorder(*args):
9861 """
9862 GetBorder(self, long flags) -> int
9863 GetBorder(self) -> int
9864
9865 Get border for the flags of this window
9866 """
9867 return _core_.Window_GetBorder(*args)
9868
9869 def UpdateWindowUI(*args, **kwargs):
9870 """
9871 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9872
9873 This function sends EVT_UPDATE_UI events to the window. The particular
9874 implementation depends on the window; for example a wx.ToolBar will
9875 send an update UI event for each toolbar button, and a wx.Frame will
9876 send an update UI event for each menubar menu item. You can call this
9877 function from your application to ensure that your UI is up-to-date at
9878 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9879 concerned). This may be necessary if you have called
9880 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
9881 limit the overhead that wxWindows incurs by sending update UI events
9882 in idle time.
9883 """
9884 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9885
9886 def PopupMenuXY(*args, **kwargs):
9887 """
9888 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
9889
9890 Pops up the given menu at the specified coordinates, relative to this window,
9891 and returns control when the user has dismissed the menu. If a menu item is
9892 selected, the corresponding menu event is generated and will be processed as
9893 usual. If the default position is given then the current position of the
9894 mouse cursor will be used.
9895 """
9896 return _core_.Window_PopupMenuXY(*args, **kwargs)
9897
9898 def PopupMenu(*args, **kwargs):
9899 """
9900 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
9901
9902 Pops up the given menu at the specified coordinates, relative to this window,
9903 and returns control when the user has dismissed the menu. If a menu item is
9904 selected, the corresponding menu event is generated and will be processed as
9905 usual. If the default position is given then the current position of the
9906 mouse cursor will be used.
9907 """
9908 return _core_.Window_PopupMenu(*args, **kwargs)
9909
9910 def HasMultiplePages(*args, **kwargs):
9911 """HasMultiplePages(self) -> bool"""
9912 return _core_.Window_HasMultiplePages(*args, **kwargs)
9913
9914 def GetHandle(*args, **kwargs):
9915 """
9916 GetHandle(self) -> long
9917
9918 Returns the platform-specific handle (as a long integer) of the
9919 physical window. Currently on wxMac it returns the handle of the
9920 toplevel parent of the window.
9921 """
9922 return _core_.Window_GetHandle(*args, **kwargs)
9923
9924 def AssociateHandle(*args, **kwargs):
9925 """
9926 AssociateHandle(self, long handle)
9927
9928 Associate the window with a new native handle
9929 """
9930 return _core_.Window_AssociateHandle(*args, **kwargs)
9931
9932 def DissociateHandle(*args, **kwargs):
9933 """
9934 DissociateHandle(self)
9935
9936 Dissociate the current native handle from the window
9937 """
9938 return _core_.Window_DissociateHandle(*args, **kwargs)
9939
9940 def HasScrollbar(*args, **kwargs):
9941 """
9942 HasScrollbar(self, int orient) -> bool
9943
9944 Does the window have the scrollbar for this orientation?
9945 """
9946 return _core_.Window_HasScrollbar(*args, **kwargs)
9947
9948 def SetScrollbar(*args, **kwargs):
9949 """
9950 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
9951 bool refresh=True)
9952
9953 Sets the scrollbar properties of a built-in scrollbar.
9954 """
9955 return _core_.Window_SetScrollbar(*args, **kwargs)
9956
9957 def SetScrollPos(*args, **kwargs):
9958 """
9959 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9960
9961 Sets the position of one of the built-in scrollbars.
9962 """
9963 return _core_.Window_SetScrollPos(*args, **kwargs)
9964
9965 def GetScrollPos(*args, **kwargs):
9966 """
9967 GetScrollPos(self, int orientation) -> int
9968
9969 Returns the built-in scrollbar position.
9970 """
9971 return _core_.Window_GetScrollPos(*args, **kwargs)
9972
9973 def GetScrollThumb(*args, **kwargs):
9974 """
9975 GetScrollThumb(self, int orientation) -> int
9976
9977 Returns the built-in scrollbar thumb size.
9978 """
9979 return _core_.Window_GetScrollThumb(*args, **kwargs)
9980
9981 def GetScrollRange(*args, **kwargs):
9982 """
9983 GetScrollRange(self, int orientation) -> int
9984
9985 Returns the built-in scrollbar range.
9986 """
9987 return _core_.Window_GetScrollRange(*args, **kwargs)
9988
9989 def ScrollWindow(*args, **kwargs):
9990 """
9991 ScrollWindow(self, int dx, int dy, Rect rect=None)
9992
9993 Physically scrolls the pixels in the window and move child windows
9994 accordingly. Use this function to optimise your scrolling
9995 implementations, to minimise the area that must be redrawn. Note that
9996 it is rarely required to call this function from a user program.
9997 """
9998 return _core_.Window_ScrollWindow(*args, **kwargs)
9999
10000 def ScrollLines(*args, **kwargs):
10001 """
10002 ScrollLines(self, int lines) -> bool
10003
10004 If the platform and window class supports it, scrolls the window by
10005 the given number of lines down, if lines is positive, or up if lines
10006 is negative. Returns True if the window was scrolled, False if it was
10007 already on top/bottom and nothing was done.
10008 """
10009 return _core_.Window_ScrollLines(*args, **kwargs)
10010
10011 def ScrollPages(*args, **kwargs):
10012 """
10013 ScrollPages(self, int pages) -> bool
10014
10015 If the platform and window class supports it, scrolls the window by
10016 the given number of pages down, if pages is positive, or up if pages
10017 is negative. Returns True if the window was scrolled, False if it was
10018 already on top/bottom and nothing was done.
10019 """
10020 return _core_.Window_ScrollPages(*args, **kwargs)
10021
10022 def LineUp(*args, **kwargs):
10023 """
10024 LineUp(self) -> bool
10025
10026 This is just a wrapper for ScrollLines(-1).
10027 """
10028 return _core_.Window_LineUp(*args, **kwargs)
10029
10030 def LineDown(*args, **kwargs):
10031 """
10032 LineDown(self) -> bool
10033
10034 This is just a wrapper for ScrollLines(1).
10035 """
10036 return _core_.Window_LineDown(*args, **kwargs)
10037
10038 def PageUp(*args, **kwargs):
10039 """
10040 PageUp(self) -> bool
10041
10042 This is just a wrapper for ScrollPages(-1).
10043 """
10044 return _core_.Window_PageUp(*args, **kwargs)
10045
10046 def PageDown(*args, **kwargs):
10047 """
10048 PageDown(self) -> bool
10049
10050 This is just a wrapper for ScrollPages(1).
10051 """
10052 return _core_.Window_PageDown(*args, **kwargs)
10053
10054 def SetHelpText(*args, **kwargs):
10055 """
10056 SetHelpText(self, String text)
10057
10058 Sets the help text to be used as context-sensitive help for this
10059 window. Note that the text is actually stored by the current
10060 `wx.HelpProvider` implementation, and not in the window object itself.
10061 """
10062 return _core_.Window_SetHelpText(*args, **kwargs)
10063
10064 def SetHelpTextForId(*args, **kwargs):
10065 """
10066 SetHelpTextForId(self, String text)
10067
10068 Associate this help text with all windows with the same id as this
10069 one.
10070 """
10071 return _core_.Window_SetHelpTextForId(*args, **kwargs)
10072
10073 def GetHelpTextAtPoint(*args, **kwargs):
10074 """
10075 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10076
10077 Get the help string associated with the given position in this window.
10078
10079 Notice that pt may be invalid if event origin is keyboard or unknown
10080 and this method should return the global window help text then
10081
10082 """
10083 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10084
10085 def GetHelpText(*args, **kwargs):
10086 """
10087 GetHelpText(self) -> String
10088
10089 Gets the help text to be used as context-sensitive help for this
10090 window. Note that the text is actually stored by the current
10091 `wx.HelpProvider` implementation, and not in the window object itself.
10092 """
10093 return _core_.Window_GetHelpText(*args, **kwargs)
10094
10095 def SetToolTipString(*args, **kwargs):
10096 """
10097 SetToolTipString(self, String tip)
10098
10099 Attach a tooltip to the window.
10100 """
10101 return _core_.Window_SetToolTipString(*args, **kwargs)
10102
10103 def SetToolTip(*args, **kwargs):
10104 """
10105 SetToolTip(self, ToolTip tip)
10106
10107 Attach a tooltip to the window.
10108 """
10109 return _core_.Window_SetToolTip(*args, **kwargs)
10110
10111 def GetToolTip(*args, **kwargs):
10112 """
10113 GetToolTip(self) -> ToolTip
10114
10115 get the associated tooltip or None if none
10116 """
10117 return _core_.Window_GetToolTip(*args, **kwargs)
10118
10119 def SetDropTarget(*args, **kwargs):
10120 """
10121 SetDropTarget(self, DropTarget dropTarget)
10122
10123 Associates a drop target with this window. If the window already has
10124 a drop target, it is deleted.
10125 """
10126 return _core_.Window_SetDropTarget(*args, **kwargs)
10127
10128 def GetDropTarget(*args, **kwargs):
10129 """
10130 GetDropTarget(self) -> DropTarget
10131
10132 Returns the associated drop target, which may be None.
10133 """
10134 return _core_.Window_GetDropTarget(*args, **kwargs)
10135
10136 def DragAcceptFiles(*args, **kwargs):
10137 """
10138 DragAcceptFiles(self, bool accept)
10139
10140 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
10141 Only functional on Windows.
10142 """
10143 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10144
10145 def SetConstraints(*args, **kwargs):
10146 """
10147 SetConstraints(self, LayoutConstraints constraints)
10148
10149 Sets the window to have the given layout constraints. If an existing
10150 layout constraints object is already owned by the window, it will be
10151 deleted. Pass None to disassociate and delete the window's current
10152 constraints.
10153
10154 You must call SetAutoLayout to tell a window to use the constraints
10155 automatically in its default EVT_SIZE handler; otherwise, you must
10156 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10157 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10158 effect.
10159 """
10160 return _core_.Window_SetConstraints(*args, **kwargs)
10161
10162 def GetConstraints(*args, **kwargs):
10163 """
10164 GetConstraints(self) -> LayoutConstraints
10165
10166 Returns a pointer to the window's layout constraints, or None if there
10167 are none.
10168 """
10169 return _core_.Window_GetConstraints(*args, **kwargs)
10170
10171 def SetAutoLayout(*args, **kwargs):
10172 """
10173 SetAutoLayout(self, bool autoLayout)
10174
10175 Determines whether the Layout function will be called automatically
10176 when the window is resized. lease note that this only happens for the
10177 windows usually used to contain children, namely `wx.Panel` and
10178 `wx.TopLevelWindow` (and the classes deriving from them).
10179
10180 This method is called implicitly by `SetSizer` but if you use
10181 `SetConstraints` you should call it manually or otherwise the window
10182 layout won't be correctly updated when its size changes.
10183 """
10184 return _core_.Window_SetAutoLayout(*args, **kwargs)
10185
10186 def GetAutoLayout(*args, **kwargs):
10187 """
10188 GetAutoLayout(self) -> bool
10189
10190 Returns the current autoLayout setting
10191 """
10192 return _core_.Window_GetAutoLayout(*args, **kwargs)
10193
10194 def Layout(*args, **kwargs):
10195 """
10196 Layout(self) -> bool
10197
10198 Invokes the constraint-based layout algorithm or the sizer-based
10199 algorithm for this window. See SetAutoLayout: when auto layout is on,
10200 this function gets called automatically by the default EVT_SIZE
10201 handler when the window is resized.
10202 """
10203 return _core_.Window_Layout(*args, **kwargs)
10204
10205 def SetSizer(*args, **kwargs):
10206 """
10207 SetSizer(self, Sizer sizer, bool deleteOld=True)
10208
10209 Sets the window to have the given layout sizer. The window will then
10210 own the object, and will take care of its deletion. If an existing
10211 layout sizer object is already owned by the window, it will be deleted
10212 if the deleteOld parameter is true. Note that this function will also
10213 call SetAutoLayout implicitly with a True parameter if the sizer is
10214 non-None, and False otherwise.
10215 """
10216 return _core_.Window_SetSizer(*args, **kwargs)
10217
10218 def SetSizerAndFit(*args, **kwargs):
10219 """
10220 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10221
10222 The same as SetSizer, except it also sets the size hints for the
10223 window based on the sizer's minimum size.
10224 """
10225 return _core_.Window_SetSizerAndFit(*args, **kwargs)
10226
10227 def GetSizer(*args, **kwargs):
10228 """
10229 GetSizer(self) -> Sizer
10230
10231 Return the sizer associated with the window by a previous call to
10232 SetSizer or None if there isn't one.
10233 """
10234 return _core_.Window_GetSizer(*args, **kwargs)
10235
10236 def SetContainingSizer(*args, **kwargs):
10237 """
10238 SetContainingSizer(self, Sizer sizer)
10239
10240 This normally does not need to be called by application code. It is
10241 called internally when a window is added to a sizer, and is used so
10242 the window can remove itself from the sizer when it is destroyed.
10243 """
10244 return _core_.Window_SetContainingSizer(*args, **kwargs)
10245
10246 def GetContainingSizer(*args, **kwargs):
10247 """
10248 GetContainingSizer(self) -> Sizer
10249
10250 Return the sizer that this window is a member of, if any, otherwise None.
10251 """
10252 return _core_.Window_GetContainingSizer(*args, **kwargs)
10253
10254 def InheritAttributes(*args, **kwargs):
10255 """
10256 InheritAttributes(self)
10257
10258 This function is (or should be, in case of custom controls) called
10259 during window creation to intelligently set up the window visual
10260 attributes, that is the font and the foreground and background
10261 colours.
10262
10263 By 'intelligently' the following is meant: by default, all windows use
10264 their own default attributes. However if some of the parent's
10265 attributes are explicitly changed (that is, using SetFont and not
10266 SetOwnFont) and if the corresponding attribute hadn't been
10267 explicitly set for this window itself, then this window takes the same
10268 value as used by the parent. In addition, if the window overrides
10269 ShouldInheritColours to return false, the colours will not be changed
10270 no matter what and only the font might.
10271
10272 This rather complicated logic is necessary in order to accommodate the
10273 different usage scenarios. The most common one is when all default
10274 attributes are used and in this case, nothing should be inherited as
10275 in modern GUIs different controls use different fonts (and colours)
10276 than their siblings so they can't inherit the same value from the
10277 parent. However it was also deemed desirable to allow to simply change
10278 the attributes of all children at once by just changing the font or
10279 colour of their common parent, hence in this case we do inherit the
10280 parents attributes.
10281
10282 """
10283 return _core_.Window_InheritAttributes(*args, **kwargs)
10284
10285 def ShouldInheritColours(*args, **kwargs):
10286 """
10287 ShouldInheritColours(self) -> bool
10288
10289 Return true from here to allow the colours of this window to be
10290 changed by InheritAttributes, returning false forbids inheriting them
10291 from the parent window.
10292
10293 The base class version returns false, but this method is overridden in
10294 wxControl where it returns true.
10295 """
10296 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10297
10298 def CanSetTransparent(*args, **kwargs):
10299 """
10300 CanSetTransparent(self) -> bool
10301
10302 Returns ``True`` if the platform supports setting the transparency for
10303 this window. Note that this method will err on the side of caution,
10304 so it is possible that this will return ``False`` when it is in fact
10305 possible to set the transparency.
10306
10307 NOTE: On X-windows systems the X server must have the composite
10308 extension loaded, and there must be a composite manager program (such
10309 as xcompmgr) running.
10310 """
10311 return _core_.Window_CanSetTransparent(*args, **kwargs)
10312
10313 def SetTransparent(*args, **kwargs):
10314 """
10315 SetTransparent(self, byte alpha) -> bool
10316
10317 Attempt to set the transparency of this window to the ``alpha`` value,
10318 returns True on success. The ``alpha`` value is an integer in the
10319 range of 0 to 255, where 0 is fully transparent and 255 is fully
10320 opaque.
10321 """
10322 return _core_.Window_SetTransparent(*args, **kwargs)
10323
10324 def PostCreate(self, pre):
10325 """
10326 Phase 3 of the 2-phase create <wink!>
10327 Call this method after precreating the window with the 2-phase create method.
10328 """
10329 self.this = pre.this
10330 self.thisown = pre.thisown
10331 pre.thisown = 0
10332 if hasattr(self, '_setOORInfo'):
10333 self._setOORInfo(self)
10334 if hasattr(self, '_setCallbackInfo'):
10335 self._setCallbackInfo(self, self.__class__)
10336
10337 def SendSizeEvent(self):
10338 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
10339
10340 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10341 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10342 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10343 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10344 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
10345 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
10346 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10347 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10348 Border = property(GetBorder,doc="See `GetBorder`")
10349 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10350 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10351 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10352 Children = property(GetChildren,doc="See `GetChildren`")
10353 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10354 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10355 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10356 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10357 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10358 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10359 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10360 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10361 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10362 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10363 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10364 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
10365 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10366 Handle = property(GetHandle,doc="See `GetHandle`")
10367 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
10368 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10369 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
10370 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
10371 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10372 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10373 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10374 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10375 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10376 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10377 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10378 Parent = property(GetParent,doc="See `GetParent`")
10379 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10380 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10381 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10382 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
10383 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10384 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
10385 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10386 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10387 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10388 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10389 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10390 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10391 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10392 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10393 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
10394 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10395 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10396 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
10397_core_.Window_swigregister(Window)
10398
10399def PreWindow(*args, **kwargs):
10400 """
10401 PreWindow() -> Window
10402
10403 Precreate a Window for 2-phase creation.
10404 """
10405 val = _core_.new_PreWindow(*args, **kwargs)
10406 return val
10407
10408def Window_NewControlId(*args):
10409 """
10410 Window_NewControlId() -> int
10411
10412 Generate a control id for the controls which were not given one.
10413 """
10414 return _core_.Window_NewControlId(*args)
10415
10416def Window_NextControlId(*args, **kwargs):
10417 """
10418 Window_NextControlId(int winid) -> int
10419
10420 Get the id of the control following the one with the given
10421 autogenerated) id
10422 """
10423 return _core_.Window_NextControlId(*args, **kwargs)
10424
10425def Window_PrevControlId(*args, **kwargs):
10426 """
10427 Window_PrevControlId(int winid) -> int
10428
10429 Get the id of the control preceding the one with the given
10430 autogenerated) id
10431 """
10432 return _core_.Window_PrevControlId(*args, **kwargs)
10433
10434def Window_FindFocus(*args):
10435 """
10436 Window_FindFocus() -> Window
10437
10438 Returns the window or control that currently has the keyboard focus,
10439 or None.
10440 """
10441 return _core_.Window_FindFocus(*args)
10442
10443def Window_GetCapture(*args):
10444 """
10445 Window_GetCapture() -> Window
10446
10447 Returns the window which currently captures the mouse or None
10448 """
10449 return _core_.Window_GetCapture(*args)
10450
10451def Window_GetClassDefaultAttributes(*args, **kwargs):
10452 """
10453 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10454
10455 Get the default attributes for this class. This is useful if you want
10456 to use the same font or colour in your own control as in a standard
10457 control -- which is a much better idea than hard coding specific
10458 colours or fonts which might look completely out of place on the
10459 user's system, especially if it uses themes.
10460
10461 The variant parameter is only relevant under Mac currently and is
10462 ignore under other platforms. Under Mac, it will change the size of
10463 the returned font. See `wx.Window.SetWindowVariant` for more about
10464 this.
10465 """
10466 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10467
10468def DLG_PNT(win, point_or_x, y=None):
10469 """
10470 Convenience function for converting a Point or (x,y) in
10471 dialog units to pixel units.
10472 """
10473 if y is None:
10474 return win.ConvertDialogPointToPixels(point_or_x)
10475 else:
10476 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10477
10478def DLG_SZE(win, size_width, height=None):
10479 """
10480 Convenience function for converting a Size or (w,h) in
10481 dialog units to pixel units.
10482 """
10483 if height is None:
10484 return win.ConvertDialogSizeToPixels(size_width)
10485 else:
10486 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10487
10488
10489def FindWindowById(*args, **kwargs):
10490 """
10491 FindWindowById(long id, Window parent=None) -> Window
10492
10493 Find the first window in the application with the given id. If parent
10494 is None, the search will start from all top-level frames and dialog
10495 boxes; if non-None, the search will be limited to the given window
10496 hierarchy. The search is recursive in both cases.
10497 """
10498 return _core_.FindWindowById(*args, **kwargs)
10499
10500def FindWindowByName(*args, **kwargs):
10501 """
10502 FindWindowByName(String name, Window parent=None) -> Window
10503
10504 Find a window by its name (as given in a window constructor or Create
10505 function call). If parent is None, the search will start from all
10506 top-level frames and dialog boxes; if non-None, the search will be
10507 limited to the given window hierarchy. The search is recursive in both
10508 cases.
10509
10510 If no window with such name is found, wx.FindWindowByLabel is called.
10511 """
10512 return _core_.FindWindowByName(*args, **kwargs)
10513
10514def FindWindowByLabel(*args, **kwargs):
10515 """
10516 FindWindowByLabel(String label, Window parent=None) -> Window
10517
10518 Find a window by its label. Depending on the type of window, the label
10519 may be a window title or panel item label. If parent is None, the
10520 search will start from all top-level frames and dialog boxes; if
10521 non-None, the search will be limited to the given window
10522 hierarchy. The search is recursive in both cases.
10523 """
10524 return _core_.FindWindowByLabel(*args, **kwargs)
10525
10526def Window_FromHWND(*args, **kwargs):
10527 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10528 return _core_.Window_FromHWND(*args, **kwargs)
10529
10530def GetTopLevelWindows(*args):
10531 """
10532 GetTopLevelWindows() -> PyObject
10533
10534 Returns a list of the the application's top-level windows, (frames,
10535 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10536 by wxWidgets, and so it is only valid as long as no top-level windows
10537 are closed or new top-level windows are created.
10538
10539 """
10540 return _core_.GetTopLevelWindows(*args)
10541#---------------------------------------------------------------------------
10542
10543class Validator(EvtHandler):
10544 """Proxy of C++ Validator class"""
10545 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10546 __repr__ = _swig_repr
10547 def __init__(self, *args, **kwargs):
10548 """__init__(self) -> Validator"""
10549 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
10550 self._setOORInfo(self)
10551
10552 def Clone(*args, **kwargs):
10553 """Clone(self) -> Validator"""
10554 return _core_.Validator_Clone(*args, **kwargs)
10555
10556 def Validate(*args, **kwargs):
10557 """Validate(self, Window parent) -> bool"""
10558 return _core_.Validator_Validate(*args, **kwargs)
10559
10560 def TransferToWindow(*args, **kwargs):
10561 """TransferToWindow(self) -> bool"""
10562 return _core_.Validator_TransferToWindow(*args, **kwargs)
10563
10564 def TransferFromWindow(*args, **kwargs):
10565 """TransferFromWindow(self) -> bool"""
10566 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10567
10568 def GetWindow(*args, **kwargs):
10569 """GetWindow(self) -> Window"""
10570 return _core_.Validator_GetWindow(*args, **kwargs)
10571
10572 def SetWindow(*args, **kwargs):
10573 """SetWindow(self, Window window)"""
10574 return _core_.Validator_SetWindow(*args, **kwargs)
10575
10576 def IsSilent(*args, **kwargs):
10577 """IsSilent() -> bool"""
10578 return _core_.Validator_IsSilent(*args, **kwargs)
10579
10580 IsSilent = staticmethod(IsSilent)
10581 def SetBellOnError(*args, **kwargs):
10582 """SetBellOnError(int doIt=True)"""
10583 return _core_.Validator_SetBellOnError(*args, **kwargs)
10584
10585 SetBellOnError = staticmethod(SetBellOnError)
10586 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
10587_core_.Validator_swigregister(Validator)
10588
10589def Validator_IsSilent(*args):
10590 """Validator_IsSilent() -> bool"""
10591 return _core_.Validator_IsSilent(*args)
10592
10593def Validator_SetBellOnError(*args, **kwargs):
10594 """Validator_SetBellOnError(int doIt=True)"""
10595 return _core_.Validator_SetBellOnError(*args, **kwargs)
10596
10597class PyValidator(Validator):
10598 """Proxy of C++ PyValidator class"""
10599 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10600 __repr__ = _swig_repr
10601 def __init__(self, *args, **kwargs):
10602 """__init__(self) -> PyValidator"""
10603 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
10604
10605 self._setCallbackInfo(self, PyValidator, 1)
10606 self._setOORInfo(self)
10607
10608 def _setCallbackInfo(*args, **kwargs):
10609 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10610 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10611
10612_core_.PyValidator_swigregister(PyValidator)
10613
10614#---------------------------------------------------------------------------
10615
10616class Menu(EvtHandler):
10617 """Proxy of C++ Menu class"""
10618 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10619 __repr__ = _swig_repr
10620 def __init__(self, *args, **kwargs):
10621 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10622 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
10623 self._setOORInfo(self)
10624
10625 def Append(*args, **kwargs):
10626 """
10627 Append(self, int id, String text=EmptyString, String help=EmptyString,
10628 int kind=ITEM_NORMAL) -> MenuItem
10629 """
10630 return _core_.Menu_Append(*args, **kwargs)
10631
10632 def AppendSeparator(*args, **kwargs):
10633 """AppendSeparator(self) -> MenuItem"""
10634 return _core_.Menu_AppendSeparator(*args, **kwargs)
10635
10636 def AppendCheckItem(*args, **kwargs):
10637 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10638 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10639
10640 def AppendRadioItem(*args, **kwargs):
10641 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10642 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10643
10644 def AppendMenu(*args, **kwargs):
10645 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10646 return _core_.Menu_AppendMenu(*args, **kwargs)
10647
10648 def AppendSubMenu(*args, **kwargs):
10649 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10650 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10651
10652 def AppendItem(*args, **kwargs):
10653 """AppendItem(self, MenuItem item) -> MenuItem"""
10654 return _core_.Menu_AppendItem(*args, **kwargs)
10655
10656 def InsertItem(*args, **kwargs):
10657 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10658 return _core_.Menu_InsertItem(*args, **kwargs)
10659
10660 def PrependItem(*args, **kwargs):
10661 """PrependItem(self, MenuItem item) -> MenuItem"""
10662 return _core_.Menu_PrependItem(*args, **kwargs)
10663
10664 def Break(*args, **kwargs):
10665 """Break(self)"""
10666 return _core_.Menu_Break(*args, **kwargs)
10667
10668 def Insert(*args, **kwargs):
10669 """
10670 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
10671 int kind=ITEM_NORMAL) -> MenuItem
10672 """
10673 return _core_.Menu_Insert(*args, **kwargs)
10674
10675 def InsertSeparator(*args, **kwargs):
10676 """InsertSeparator(self, size_t pos) -> MenuItem"""
10677 return _core_.Menu_InsertSeparator(*args, **kwargs)
10678
10679 def InsertCheckItem(*args, **kwargs):
10680 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10681 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10682
10683 def InsertRadioItem(*args, **kwargs):
10684 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10685 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10686
10687 def InsertMenu(*args, **kwargs):
10688 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10689 return _core_.Menu_InsertMenu(*args, **kwargs)
10690
10691 def Prepend(*args, **kwargs):
10692 """
10693 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10694 int kind=ITEM_NORMAL) -> MenuItem
10695 """
10696 return _core_.Menu_Prepend(*args, **kwargs)
10697
10698 def PrependSeparator(*args, **kwargs):
10699 """PrependSeparator(self) -> MenuItem"""
10700 return _core_.Menu_PrependSeparator(*args, **kwargs)
10701
10702 def PrependCheckItem(*args, **kwargs):
10703 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10704 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10705
10706 def PrependRadioItem(*args, **kwargs):
10707 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10708 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10709
10710 def PrependMenu(*args, **kwargs):
10711 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10712 return _core_.Menu_PrependMenu(*args, **kwargs)
10713
10714 def Remove(*args, **kwargs):
10715 """Remove(self, int id) -> MenuItem"""
10716 return _core_.Menu_Remove(*args, **kwargs)
10717
10718 def RemoveItem(*args, **kwargs):
10719 """RemoveItem(self, MenuItem item) -> MenuItem"""
10720 return _core_.Menu_RemoveItem(*args, **kwargs)
10721
10722 def Delete(*args, **kwargs):
10723 """Delete(self, int id) -> bool"""
10724 return _core_.Menu_Delete(*args, **kwargs)
10725
10726 def DeleteItem(*args, **kwargs):
10727 """DeleteItem(self, MenuItem item) -> bool"""
10728 return _core_.Menu_DeleteItem(*args, **kwargs)
10729
10730 def Destroy(*args, **kwargs):
10731 """
10732 Destroy(self)
10733
10734 Deletes the C++ object this Python object is a proxy for.
10735 """
10736 args[0].this.own(False)
10737 return _core_.Menu_Destroy(*args, **kwargs)
10738
10739 def DestroyId(*args, **kwargs):
10740 """DestroyId(self, int id) -> bool"""
10741 return _core_.Menu_DestroyId(*args, **kwargs)
10742
10743 def DestroyItem(*args, **kwargs):
10744 """DestroyItem(self, MenuItem item) -> bool"""
10745 return _core_.Menu_DestroyItem(*args, **kwargs)
10746
10747 def GetMenuItemCount(*args, **kwargs):
10748 """GetMenuItemCount(self) -> size_t"""
10749 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10750
10751 def GetMenuItems(*args, **kwargs):
10752 """GetMenuItems(self) -> PyObject"""
10753 return _core_.Menu_GetMenuItems(*args, **kwargs)
10754
10755 def FindItem(*args, **kwargs):
10756 """FindItem(self, String item) -> int"""
10757 return _core_.Menu_FindItem(*args, **kwargs)
10758
10759 def FindItemById(*args, **kwargs):
10760 """FindItemById(self, int id) -> MenuItem"""
10761 return _core_.Menu_FindItemById(*args, **kwargs)
10762
10763 def FindItemByPosition(*args, **kwargs):
10764 """FindItemByPosition(self, size_t position) -> MenuItem"""
10765 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10766
10767 def Enable(*args, **kwargs):
10768 """Enable(self, int id, bool enable)"""
10769 return _core_.Menu_Enable(*args, **kwargs)
10770
10771 def IsEnabled(*args, **kwargs):
10772 """IsEnabled(self, int id) -> bool"""
10773 return _core_.Menu_IsEnabled(*args, **kwargs)
10774
10775 def Check(*args, **kwargs):
10776 """Check(self, int id, bool check)"""
10777 return _core_.Menu_Check(*args, **kwargs)
10778
10779 def IsChecked(*args, **kwargs):
10780 """IsChecked(self, int id) -> bool"""
10781 return _core_.Menu_IsChecked(*args, **kwargs)
10782
10783 def SetLabel(*args, **kwargs):
10784 """SetLabel(self, int id, String label)"""
10785 return _core_.Menu_SetLabel(*args, **kwargs)
10786
10787 def GetLabel(*args, **kwargs):
10788 """GetLabel(self, int id) -> String"""
10789 return _core_.Menu_GetLabel(*args, **kwargs)
10790
10791 def SetHelpString(*args, **kwargs):
10792 """SetHelpString(self, int id, String helpString)"""
10793 return _core_.Menu_SetHelpString(*args, **kwargs)
10794
10795 def GetHelpString(*args, **kwargs):
10796 """GetHelpString(self, int id) -> String"""
10797 return _core_.Menu_GetHelpString(*args, **kwargs)
10798
10799 def SetTitle(*args, **kwargs):
10800 """SetTitle(self, String title)"""
10801 return _core_.Menu_SetTitle(*args, **kwargs)
10802
10803 def GetTitle(*args, **kwargs):
10804 """GetTitle(self) -> String"""
10805 return _core_.Menu_GetTitle(*args, **kwargs)
10806
10807 def SetEventHandler(*args, **kwargs):
10808 """SetEventHandler(self, EvtHandler handler)"""
10809 return _core_.Menu_SetEventHandler(*args, **kwargs)
10810
10811 def GetEventHandler(*args, **kwargs):
10812 """GetEventHandler(self) -> EvtHandler"""
10813 return _core_.Menu_GetEventHandler(*args, **kwargs)
10814
10815 def SetInvokingWindow(*args, **kwargs):
10816 """SetInvokingWindow(self, Window win)"""
10817 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10818
10819 def GetInvokingWindow(*args, **kwargs):
10820 """GetInvokingWindow(self) -> Window"""
10821 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10822
10823 def GetStyle(*args, **kwargs):
10824 """GetStyle(self) -> long"""
10825 return _core_.Menu_GetStyle(*args, **kwargs)
10826
10827 def UpdateUI(*args, **kwargs):
10828 """UpdateUI(self, EvtHandler source=None)"""
10829 return _core_.Menu_UpdateUI(*args, **kwargs)
10830
10831 def GetMenuBar(*args, **kwargs):
10832 """GetMenuBar(self) -> MenuBar"""
10833 return _core_.Menu_GetMenuBar(*args, **kwargs)
10834
10835 def Attach(*args, **kwargs):
10836 """Attach(self, wxMenuBarBase menubar)"""
10837 return _core_.Menu_Attach(*args, **kwargs)
10838
10839 def Detach(*args, **kwargs):
10840 """Detach(self)"""
10841 return _core_.Menu_Detach(*args, **kwargs)
10842
10843 def IsAttached(*args, **kwargs):
10844 """IsAttached(self) -> bool"""
10845 return _core_.Menu_IsAttached(*args, **kwargs)
10846
10847 def SetParent(*args, **kwargs):
10848 """SetParent(self, Menu parent)"""
10849 return _core_.Menu_SetParent(*args, **kwargs)
10850
10851 def GetParent(*args, **kwargs):
10852 """GetParent(self) -> Menu"""
10853 return _core_.Menu_GetParent(*args, **kwargs)
10854
10855 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10856 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10857 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10858 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10859 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10860 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10861 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10862 Style = property(GetStyle,doc="See `GetStyle`")
10863 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
10864_core_.Menu_swigregister(Menu)
10865DefaultValidator = cvar.DefaultValidator
10866
10867#---------------------------------------------------------------------------
10868
10869class MenuBar(Window):
10870 """Proxy of C++ MenuBar class"""
10871 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10872 __repr__ = _swig_repr
10873 def __init__(self, *args, **kwargs):
10874 """__init__(self, long style=0) -> MenuBar"""
10875 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
10876 self._setOORInfo(self)
10877
10878 def Append(*args, **kwargs):
10879 """Append(self, Menu menu, String title) -> bool"""
10880 return _core_.MenuBar_Append(*args, **kwargs)
10881
10882 def Insert(*args, **kwargs):
10883 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10884 return _core_.MenuBar_Insert(*args, **kwargs)
10885
10886 def GetMenuCount(*args, **kwargs):
10887 """GetMenuCount(self) -> size_t"""
10888 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10889
10890 def GetMenu(*args, **kwargs):
10891 """GetMenu(self, size_t pos) -> Menu"""
10892 return _core_.MenuBar_GetMenu(*args, **kwargs)
10893
10894 def Replace(*args, **kwargs):
10895 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10896 return _core_.MenuBar_Replace(*args, **kwargs)
10897
10898 def Remove(*args, **kwargs):
10899 """Remove(self, size_t pos) -> Menu"""
10900 return _core_.MenuBar_Remove(*args, **kwargs)
10901
10902 def EnableTop(*args, **kwargs):
10903 """EnableTop(self, size_t pos, bool enable)"""
10904 return _core_.MenuBar_EnableTop(*args, **kwargs)
10905
10906 def IsEnabledTop(*args, **kwargs):
10907 """IsEnabledTop(self, size_t pos) -> bool"""
10908 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10909
10910 def SetLabelTop(*args, **kwargs):
10911 """SetLabelTop(self, size_t pos, String label)"""
10912 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10913
10914 def GetLabelTop(*args, **kwargs):
10915 """GetLabelTop(self, size_t pos) -> String"""
10916 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10917
10918 def FindMenuItem(*args, **kwargs):
10919 """FindMenuItem(self, String menu, String item) -> int"""
10920 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10921
10922 def FindItemById(*args, **kwargs):
10923 """FindItemById(self, int id) -> MenuItem"""
10924 return _core_.MenuBar_FindItemById(*args, **kwargs)
10925
10926 def FindMenu(*args, **kwargs):
10927 """FindMenu(self, String title) -> int"""
10928 return _core_.MenuBar_FindMenu(*args, **kwargs)
10929
10930 def Enable(*args, **kwargs):
10931 """Enable(self, int id, bool enable)"""
10932 return _core_.MenuBar_Enable(*args, **kwargs)
10933
10934 def Check(*args, **kwargs):
10935 """Check(self, int id, bool check)"""
10936 return _core_.MenuBar_Check(*args, **kwargs)
10937
10938 def IsChecked(*args, **kwargs):
10939 """IsChecked(self, int id) -> bool"""
10940 return _core_.MenuBar_IsChecked(*args, **kwargs)
10941
10942 def IsEnabled(*args, **kwargs):
10943 """IsEnabled(self, int id) -> bool"""
10944 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10945
10946 def SetLabel(*args, **kwargs):
10947 """SetLabel(self, int id, String label)"""
10948 return _core_.MenuBar_SetLabel(*args, **kwargs)
10949
10950 def GetLabel(*args, **kwargs):
10951 """GetLabel(self, int id) -> String"""
10952 return _core_.MenuBar_GetLabel(*args, **kwargs)
10953
10954 def SetHelpString(*args, **kwargs):
10955 """SetHelpString(self, int id, String helpString)"""
10956 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10957
10958 def GetHelpString(*args, **kwargs):
10959 """GetHelpString(self, int id) -> String"""
10960 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10961
10962 def GetFrame(*args, **kwargs):
10963 """GetFrame(self) -> wxFrame"""
10964 return _core_.MenuBar_GetFrame(*args, **kwargs)
10965
10966 def IsAttached(*args, **kwargs):
10967 """IsAttached(self) -> bool"""
10968 return _core_.MenuBar_IsAttached(*args, **kwargs)
10969
10970 def Attach(*args, **kwargs):
10971 """Attach(self, wxFrame frame)"""
10972 return _core_.MenuBar_Attach(*args, **kwargs)
10973
10974 def Detach(*args, **kwargs):
10975 """Detach(self)"""
10976 return _core_.MenuBar_Detach(*args, **kwargs)
10977
10978 def UpdateMenus(*args, **kwargs):
10979 """UpdateMenus(self)"""
10980 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10981
10982 def SetAutoWindowMenu(*args, **kwargs):
10983 """SetAutoWindowMenu(bool enable)"""
10984 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10985
10986 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10987 def GetAutoWindowMenu(*args, **kwargs):
10988 """GetAutoWindowMenu() -> bool"""
10989 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10990
10991 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
10992 def GetMenus(self):
10993 """Return a list of (menu, label) items for the menus in the MenuBar. """
10994 return [(self.GetMenu(i), self.GetLabelTop(i))
10995 for i in range(self.GetMenuCount())]
10996
10997 def SetMenus(self, items):
10998 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
10999 for i in range(self.GetMenuCount()-1, -1, -1):
11000 self.Remove(i)
11001 for m, l in items:
11002 self.Append(m, l)
11003
11004 Frame = property(GetFrame,doc="See `GetFrame`")
11005 Menu = property(GetMenu,doc="See `GetMenu`")
11006 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11007 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
11008_core_.MenuBar_swigregister(MenuBar)
11009
11010def MenuBar_SetAutoWindowMenu(*args, **kwargs):
11011 """MenuBar_SetAutoWindowMenu(bool enable)"""
11012 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
11013
11014def MenuBar_GetAutoWindowMenu(*args):
11015 """MenuBar_GetAutoWindowMenu() -> bool"""
11016 return _core_.MenuBar_GetAutoWindowMenu(*args)
11017
11018#---------------------------------------------------------------------------
11019
11020class MenuItem(Object):
11021 """Proxy of C++ MenuItem class"""
11022 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11023 __repr__ = _swig_repr
11024 def __init__(self, *args, **kwargs):
11025 """
11026 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11027 String help=EmptyString, int kind=ITEM_NORMAL,
11028 Menu subMenu=None) -> MenuItem
11029 """
11030 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11031 __swig_destroy__ = _core_.delete_MenuItem
11032 __del__ = lambda self : None;
11033 def GetMenu(*args, **kwargs):
11034 """GetMenu(self) -> Menu"""
11035 return _core_.MenuItem_GetMenu(*args, **kwargs)
11036
11037 def SetMenu(*args, **kwargs):
11038 """SetMenu(self, Menu menu)"""
11039 return _core_.MenuItem_SetMenu(*args, **kwargs)
11040
11041 def SetId(*args, **kwargs):
11042 """SetId(self, int id)"""
11043 return _core_.MenuItem_SetId(*args, **kwargs)
11044
11045 def GetId(*args, **kwargs):
11046 """GetId(self) -> int"""
11047 return _core_.MenuItem_GetId(*args, **kwargs)
11048
11049 def IsSeparator(*args, **kwargs):
11050 """IsSeparator(self) -> bool"""
11051 return _core_.MenuItem_IsSeparator(*args, **kwargs)
11052
11053 def SetText(*args, **kwargs):
11054 """SetText(self, String str)"""
11055 return _core_.MenuItem_SetText(*args, **kwargs)
11056
11057 def GetLabel(*args, **kwargs):
11058 """GetLabel(self) -> String"""
11059 return _core_.MenuItem_GetLabel(*args, **kwargs)
11060
11061 def GetText(*args, **kwargs):
11062 """GetText(self) -> String"""
11063 return _core_.MenuItem_GetText(*args, **kwargs)
11064
11065 def GetLabelFromText(*args, **kwargs):
11066 """GetLabelFromText(String text) -> String"""
11067 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11068
11069 GetLabelFromText = staticmethod(GetLabelFromText)
11070 def GetKind(*args, **kwargs):
11071 """GetKind(self) -> int"""
11072 return _core_.MenuItem_GetKind(*args, **kwargs)
11073
11074 def SetKind(*args, **kwargs):
11075 """SetKind(self, int kind)"""
11076 return _core_.MenuItem_SetKind(*args, **kwargs)
11077
11078 def SetCheckable(*args, **kwargs):
11079 """SetCheckable(self, bool checkable)"""
11080 return _core_.MenuItem_SetCheckable(*args, **kwargs)
11081
11082 def IsCheckable(*args, **kwargs):
11083 """IsCheckable(self) -> bool"""
11084 return _core_.MenuItem_IsCheckable(*args, **kwargs)
11085
11086 def IsSubMenu(*args, **kwargs):
11087 """IsSubMenu(self) -> bool"""
11088 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
11089
11090 def SetSubMenu(*args, **kwargs):
11091 """SetSubMenu(self, Menu menu)"""
11092 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
11093
11094 def GetSubMenu(*args, **kwargs):
11095 """GetSubMenu(self) -> Menu"""
11096 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
11097
11098 def Enable(*args, **kwargs):
11099 """Enable(self, bool enable=True)"""
11100 return _core_.MenuItem_Enable(*args, **kwargs)
11101
11102 def IsEnabled(*args, **kwargs):
11103 """IsEnabled(self) -> bool"""
11104 return _core_.MenuItem_IsEnabled(*args, **kwargs)
11105
11106 def Check(*args, **kwargs):
11107 """Check(self, bool check=True)"""
11108 return _core_.MenuItem_Check(*args, **kwargs)
11109
11110 def IsChecked(*args, **kwargs):
11111 """IsChecked(self) -> bool"""
11112 return _core_.MenuItem_IsChecked(*args, **kwargs)
11113
11114 def Toggle(*args, **kwargs):
11115 """Toggle(self)"""
11116 return _core_.MenuItem_Toggle(*args, **kwargs)
11117
11118 def SetHelp(*args, **kwargs):
11119 """SetHelp(self, String str)"""
11120 return _core_.MenuItem_SetHelp(*args, **kwargs)
11121
11122 def GetHelp(*args, **kwargs):
11123 """GetHelp(self) -> String"""
11124 return _core_.MenuItem_GetHelp(*args, **kwargs)
11125
11126 def GetAccel(*args, **kwargs):
11127 """GetAccel(self) -> AcceleratorEntry"""
11128 return _core_.MenuItem_GetAccel(*args, **kwargs)
11129
11130 def SetAccel(*args, **kwargs):
11131 """SetAccel(self, AcceleratorEntry accel)"""
11132 return _core_.MenuItem_SetAccel(*args, **kwargs)
11133
11134 def SetBitmap(*args, **kwargs):
11135 """SetBitmap(self, Bitmap bitmap)"""
11136 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11137
11138 def GetBitmap(*args, **kwargs):
11139 """GetBitmap(self) -> Bitmap"""
11140 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11141
11142 def SetFont(*args, **kwargs):
11143 """SetFont(self, Font font)"""
11144 return _core_.MenuItem_SetFont(*args, **kwargs)
11145
11146 def GetFont(*args, **kwargs):
11147 """GetFont(self) -> Font"""
11148 return _core_.MenuItem_GetFont(*args, **kwargs)
11149
11150 def SetTextColour(*args, **kwargs):
11151 """SetTextColour(self, Colour colText)"""
11152 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11153
11154 def GetTextColour(*args, **kwargs):
11155 """GetTextColour(self) -> Colour"""
11156 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11157
11158 def SetBackgroundColour(*args, **kwargs):
11159 """SetBackgroundColour(self, Colour colBack)"""
11160 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11161
11162 def GetBackgroundColour(*args, **kwargs):
11163 """GetBackgroundColour(self) -> Colour"""
11164 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11165
11166 def SetBitmaps(*args, **kwargs):
11167 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11168 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11169
11170 def SetDisabledBitmap(*args, **kwargs):
11171 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11172 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11173
11174 def GetDisabledBitmap(*args, **kwargs):
11175 """GetDisabledBitmap(self) -> Bitmap"""
11176 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11177
11178 def SetMarginWidth(*args, **kwargs):
11179 """SetMarginWidth(self, int nWidth)"""
11180 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11181
11182 def GetMarginWidth(*args, **kwargs):
11183 """GetMarginWidth(self) -> int"""
11184 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11185
11186 def GetDefaultMarginWidth(*args, **kwargs):
11187 """GetDefaultMarginWidth() -> int"""
11188 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
11189
11190 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
11191 def IsOwnerDrawn(*args, **kwargs):
11192 """IsOwnerDrawn(self) -> bool"""
11193 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11194
11195 def SetOwnerDrawn(*args, **kwargs):
11196 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11197 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11198
11199 def ResetOwnerDrawn(*args, **kwargs):
11200 """ResetOwnerDrawn(self)"""
11201 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11202
11203 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11204 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11205 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11206 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11207 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11208 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11209 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11210 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11211 Label = property(GetLabel,doc="See `GetLabel`")
11212 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11213 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11214 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11215 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11216 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
11217_core_.MenuItem_swigregister(MenuItem)
11218
11219def MenuItem_GetLabelFromText(*args, **kwargs):
11220 """MenuItem_GetLabelFromText(String text) -> String"""
11221 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11222
11223def MenuItem_GetDefaultMarginWidth(*args):
11224 """MenuItem_GetDefaultMarginWidth() -> int"""
11225 return _core_.MenuItem_GetDefaultMarginWidth(*args)
11226
11227#---------------------------------------------------------------------------
11228
11229class Control(Window):
11230 """
11231 This is the base class for a control or 'widget'.
11232
11233 A control is generally a small window which processes user input
11234 and/or displays one or more item of data.
11235 """
11236 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11237 __repr__ = _swig_repr
11238 def __init__(self, *args, **kwargs):
11239 """
11240 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11241 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11242 String name=ControlNameStr) -> Control
11243
11244 Create a Control. Normally you should only call this from a subclass'
11245 __init__ as a plain old wx.Control is not very useful.
11246 """
11247 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
11248 self._setOORInfo(self)
11249
11250 def Create(*args, **kwargs):
11251 """
11252 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11253 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
11254 String name=ControlNameStr) -> bool
11255
11256 Do the 2nd phase and create the GUI control.
11257 """
11258 return _core_.Control_Create(*args, **kwargs)
11259
11260 def GetAlignment(*args, **kwargs):
11261 """
11262 GetAlignment(self) -> int
11263
11264 Get the control alignment (left/right/centre, top/bottom/centre)
11265 """
11266 return _core_.Control_GetAlignment(*args, **kwargs)
11267
11268 def GetLabelText(*args, **kwargs):
11269 """
11270 GetLabelText(self) -> String
11271
11272 Get just the text of the label, without mnemonic characters ('&')
11273 """
11274 return _core_.Control_GetLabelText(*args, **kwargs)
11275
11276 def Command(*args, **kwargs):
11277 """
11278 Command(self, CommandEvent event)
11279
11280 Simulates the effect of the user issuing a command to the item.
11281
11282 :see: `wx.CommandEvent`
11283
11284 """
11285 return _core_.Control_Command(*args, **kwargs)
11286
11287 def GetClassDefaultAttributes(*args, **kwargs):
11288 """
11289 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11290
11291 Get the default attributes for this class. This is useful if you want
11292 to use the same font or colour in your own control as in a standard
11293 control -- which is a much better idea than hard coding specific
11294 colours or fonts which might look completely out of place on the
11295 user's system, especially if it uses themes.
11296
11297 The variant parameter is only relevant under Mac currently and is
11298 ignore under other platforms. Under Mac, it will change the size of
11299 the returned font. See `wx.Window.SetWindowVariant` for more about
11300 this.
11301 """
11302 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11303
11304 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11305 Alignment = property(GetAlignment,doc="See `GetAlignment`")
11306 LabelText = property(GetLabelText,doc="See `GetLabelText`")
11307_core_.Control_swigregister(Control)
11308ControlNameStr = cvar.ControlNameStr
11309
11310def PreControl(*args, **kwargs):
11311 """
11312 PreControl() -> Control
11313
11314 Precreate a Control control for 2-phase creation
11315 """
11316 val = _core_.new_PreControl(*args, **kwargs)
11317 return val
11318
11319def Control_GetClassDefaultAttributes(*args, **kwargs):
11320 """
11321 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11322
11323 Get the default attributes for this class. This is useful if you want
11324 to use the same font or colour in your own control as in a standard
11325 control -- which is a much better idea than hard coding specific
11326 colours or fonts which might look completely out of place on the
11327 user's system, especially if it uses themes.
11328
11329 The variant parameter is only relevant under Mac currently and is
11330 ignore under other platforms. Under Mac, it will change the size of
11331 the returned font. See `wx.Window.SetWindowVariant` for more about
11332 this.
11333 """
11334 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11335
11336#---------------------------------------------------------------------------
11337
11338class ItemContainer(object):
11339 """
11340 The wx.ItemContainer class defines an interface which is implemented
11341 by all controls which have string subitems, each of which may be
11342 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11343 as `wx.ComboBox` which implements an extended interface deriving from
11344 this one.
11345
11346 It defines the methods for accessing the control's items and although
11347 each of the derived classes implements them differently, they still
11348 all conform to the same interface.
11349
11350 The items in a wx.ItemContainer have (non empty) string labels and,
11351 optionally, client data associated with them.
11352
11353 """
11354 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11355 def __init__(self): raise AttributeError, "No constructor defined"
11356 __repr__ = _swig_repr
11357 def Append(*args, **kwargs):
11358 """
11359 Append(self, String item, PyObject clientData=None) -> int
11360
11361 Adds the item to the control, associating the given data with the item
11362 if not None. The return value is the index of the newly added item
11363 which may be different from the last one if the control is sorted (e.g.
11364 has wx.LB_SORT or wx.CB_SORT style).
11365 """
11366 return _core_.ItemContainer_Append(*args, **kwargs)
11367
11368 def AppendItems(*args, **kwargs):
11369 """
11370 AppendItems(self, List strings)
11371
11372 Apend several items at once to the control. Notice that calling this
11373 method may be much faster than appending the items one by one if you
11374 need to add a lot of items.
11375 """
11376 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11377
11378 def Insert(*args, **kwargs):
11379 """
11380 Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
11381
11382 Insert an item into the control before the item at the ``pos`` index,
11383 optionally associating some data object with the item.
11384 """
11385 return _core_.ItemContainer_Insert(*args, **kwargs)
11386
11387 def Clear(*args, **kwargs):
11388 """
11389 Clear(self)
11390
11391 Removes all items from the control.
11392 """
11393 return _core_.ItemContainer_Clear(*args, **kwargs)
11394
11395 def Delete(*args, **kwargs):
11396 """
11397 Delete(self, unsigned int n)
11398
11399 Deletes the item at the zero-based index 'n' from the control. Note
11400 that it is an error (signalled by a `wx.PyAssertionError` exception if
11401 enabled) to remove an item with the index negative or greater or equal
11402 than the number of items in the control.
11403 """
11404 return _core_.ItemContainer_Delete(*args, **kwargs)
11405
11406 def GetClientData(*args, **kwargs):
11407 """
11408 GetClientData(self, unsigned int n) -> PyObject
11409
11410 Returns the client data associated with the given item, (if any.)
11411 """
11412 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11413
11414 def SetClientData(*args, **kwargs):
11415 """
11416 SetClientData(self, unsigned int n, PyObject clientData)
11417
11418 Associate the given client data with the item at position n.
11419 """
11420 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11421
11422 def GetCount(*args, **kwargs):
11423 """
11424 GetCount(self) -> unsigned int
11425
11426 Returns the number of items in the control.
11427 """
11428 return _core_.ItemContainer_GetCount(*args, **kwargs)
11429
11430 def IsEmpty(*args, **kwargs):
11431 """
11432 IsEmpty(self) -> bool
11433
11434 Returns True if the control is empty or False if it has some items.
11435 """
11436 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11437
11438 def GetString(*args, **kwargs):
11439 """
11440 GetString(self, unsigned int n) -> String
11441
11442 Returns the label of the item with the given index.
11443 """
11444 return _core_.ItemContainer_GetString(*args, **kwargs)
11445
11446 def GetStrings(*args, **kwargs):
11447 """GetStrings(self) -> wxArrayString"""
11448 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11449
11450 def SetString(*args, **kwargs):
11451 """
11452 SetString(self, unsigned int n, String s)
11453
11454 Sets the label for the given item.
11455 """
11456 return _core_.ItemContainer_SetString(*args, **kwargs)
11457
11458 def FindString(*args, **kwargs):
11459 """
11460 FindString(self, String s) -> int
11461
11462 Finds an item whose label matches the given string. Returns the
11463 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11464 found.
11465 """
11466 return _core_.ItemContainer_FindString(*args, **kwargs)
11467
11468 def SetSelection(*args, **kwargs):
11469 """
11470 SetSelection(self, int n)
11471
11472 Sets the item at index 'n' to be the selected item.
11473 """
11474 return _core_.ItemContainer_SetSelection(*args, **kwargs)
11475
11476 def GetSelection(*args, **kwargs):
11477 """
11478 GetSelection(self) -> int
11479
11480 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11481 is selected.
11482 """
11483 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11484
11485 def SetStringSelection(*args, **kwargs):
11486 """SetStringSelection(self, String s) -> bool"""
11487 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11488
11489 def GetStringSelection(*args, **kwargs):
11490 """
11491 GetStringSelection(self) -> String
11492
11493 Returns the label of the selected item or an empty string if no item
11494 is selected.
11495 """
11496 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11497
11498 def Select(*args, **kwargs):
11499 """
11500 Select(self, int n)
11501
11502 This is the same as `SetSelection` and exists only because it is
11503 slightly more natural for controls which support multiple selection.
11504 """
11505 return _core_.ItemContainer_Select(*args, **kwargs)
11506
11507 def GetItems(self):
11508 """Return a list of the strings in the control"""
11509 return [self.GetString(i) for i in xrange(self.GetCount())]
11510
11511 def SetItems(self, items):
11512 """Clear and set the strings in the control from a list"""
11513 self.Clear()
11514 for i in items:
11515 self.Append(i)
11516
11517 Count = property(GetCount,doc="See `GetCount`")
11518 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11519 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11520 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11521 Strings = property(GetStrings,doc="See `GetStrings`")
11522_core_.ItemContainer_swigregister(ItemContainer)
11523
11524#---------------------------------------------------------------------------
11525
11526class ControlWithItems(Control,ItemContainer):
11527 """
11528 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11529 wx.Control class, and is used for the base class of various controls
11530 that have items.
11531 """
11532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11533 def __init__(self): raise AttributeError, "No constructor defined"
11534 __repr__ = _swig_repr
11535_core_.ControlWithItems_swigregister(ControlWithItems)
11536
11537#---------------------------------------------------------------------------
11538
11539class SizerItem(Object):
11540 """
11541 The wx.SizerItem class is used to track the position, size and other
11542 attributes of each item managed by a `wx.Sizer`. It is not usually
11543 necessary to use this class because the sizer elements can also be
11544 identified by their positions or window or sizer references but
11545 sometimes it may be more convenient to use wx.SizerItem directly.
11546 Also, custom classes derived from `wx.PySizer` will probably need to
11547 use the collection of wx.SizerItems held by wx.Sizer when calculating
11548 layout.
11549
11550 :see: `wx.Sizer`, `wx.GBSizerItem`
11551 """
11552 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11553 __repr__ = _swig_repr
11554 def __init__(self, *args, **kwargs):
11555 """
11556 __init__(self) -> SizerItem
11557
11558 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11559 size will need to be set before this item can be used in a Sizer.
11560
11561 You will probably never need to create a wx.SizerItem directly as they
11562 are created automatically when the sizer's Add, Insert or Prepend
11563 methods are called.
11564
11565 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11566 """
11567 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11568 __swig_destroy__ = _core_.delete_SizerItem
11569 __del__ = lambda self : None;
11570 def DeleteWindows(*args, **kwargs):
11571 """
11572 DeleteWindows(self)
11573
11574 Destroy the window or the windows in a subsizer, depending on the type
11575 of item.
11576 """
11577 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11578
11579 def DetachSizer(*args, **kwargs):
11580 """
11581 DetachSizer(self)
11582
11583 Enable deleting the SizerItem without destroying the contained sizer.
11584 """
11585 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11586
11587 def GetSize(*args, **kwargs):
11588 """
11589 GetSize(self) -> Size
11590
11591 Get the current size of the item, as set in the last Layout.
11592 """
11593 return _core_.SizerItem_GetSize(*args, **kwargs)
11594
11595 def CalcMin(*args, **kwargs):
11596 """
11597 CalcMin(self) -> Size
11598
11599 Calculates the minimum desired size for the item, including any space
11600 needed by borders.
11601 """
11602 return _core_.SizerItem_CalcMin(*args, **kwargs)
11603
11604 def SetDimension(*args, **kwargs):
11605 """
11606 SetDimension(self, Point pos, Size size)
11607
11608 Set the position and size of the space allocated for this item by the
11609 sizer, and adjust the position and size of the item (window or
11610 subsizer) to be within that space taking alignment and borders into
11611 account.
11612 """
11613 return _core_.SizerItem_SetDimension(*args, **kwargs)
11614
11615 def GetMinSize(*args, **kwargs):
11616 """
11617 GetMinSize(self) -> Size
11618
11619 Get the minimum size needed for the item.
11620 """
11621 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11622
11623 def GetMinSizeWithBorder(*args, **kwargs):
11624 """
11625 GetMinSizeWithBorder(self) -> Size
11626
11627 Get the minimum size needed for the item with space for the borders
11628 added, if needed.
11629 """
11630 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11631
11632 def SetInitSize(*args, **kwargs):
11633 """SetInitSize(self, int x, int y)"""
11634 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11635
11636 def SetRatioWH(*args, **kwargs):
11637 """
11638 SetRatioWH(self, int width, int height)
11639
11640 Set the ratio item attribute.
11641 """
11642 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11643
11644 def SetRatioSize(*args, **kwargs):
11645 """
11646 SetRatioSize(self, Size size)
11647
11648 Set the ratio item attribute.
11649 """
11650 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11651
11652 def SetRatio(*args, **kwargs):
11653 """
11654 SetRatio(self, float ratio)
11655
11656 Set the ratio item attribute.
11657 """
11658 return _core_.SizerItem_SetRatio(*args, **kwargs)
11659
11660 def GetRatio(*args, **kwargs):
11661 """
11662 GetRatio(self) -> float
11663
11664 Set the ratio item attribute.
11665 """
11666 return _core_.SizerItem_GetRatio(*args, **kwargs)
11667
11668 def GetRect(*args, **kwargs):
11669 """
11670 GetRect(self) -> Rect
11671
11672 Returns the rectangle that the sizer item should occupy
11673 """
11674 return _core_.SizerItem_GetRect(*args, **kwargs)
11675
11676 def IsWindow(*args, **kwargs):
11677 """
11678 IsWindow(self) -> bool
11679
11680 Is this sizer item a window?
11681 """
11682 return _core_.SizerItem_IsWindow(*args, **kwargs)
11683
11684 def IsSizer(*args, **kwargs):
11685 """
11686 IsSizer(self) -> bool
11687
11688 Is this sizer item a subsizer?
11689 """
11690 return _core_.SizerItem_IsSizer(*args, **kwargs)
11691
11692 def IsSpacer(*args, **kwargs):
11693 """
11694 IsSpacer(self) -> bool
11695
11696 Is this sizer item a spacer?
11697 """
11698 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11699
11700 def SetProportion(*args, **kwargs):
11701 """
11702 SetProportion(self, int proportion)
11703
11704 Set the proportion value for this item.
11705 """
11706 return _core_.SizerItem_SetProportion(*args, **kwargs)
11707
11708 def GetProportion(*args, **kwargs):
11709 """
11710 GetProportion(self) -> int
11711
11712 Get the proportion value for this item.
11713 """
11714 return _core_.SizerItem_GetProportion(*args, **kwargs)
11715
11716 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11717 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
11718 def SetFlag(*args, **kwargs):
11719 """
11720 SetFlag(self, int flag)
11721
11722 Set the flag value for this item.
11723 """
11724 return _core_.SizerItem_SetFlag(*args, **kwargs)
11725
11726 def GetFlag(*args, **kwargs):
11727 """
11728 GetFlag(self) -> int
11729
11730 Get the flag value for this item.
11731 """
11732 return _core_.SizerItem_GetFlag(*args, **kwargs)
11733
11734 def SetBorder(*args, **kwargs):
11735 """
11736 SetBorder(self, int border)
11737
11738 Set the border value for this item.
11739 """
11740 return _core_.SizerItem_SetBorder(*args, **kwargs)
11741
11742 def GetBorder(*args, **kwargs):
11743 """
11744 GetBorder(self) -> int
11745
11746 Get the border value for this item.
11747 """
11748 return _core_.SizerItem_GetBorder(*args, **kwargs)
11749
11750 def GetWindow(*args, **kwargs):
11751 """
11752 GetWindow(self) -> Window
11753
11754 Get the window (if any) that is managed by this sizer item.
11755 """
11756 return _core_.SizerItem_GetWindow(*args, **kwargs)
11757
11758 def SetWindow(*args, **kwargs):
11759 """
11760 SetWindow(self, Window window)
11761
11762 Set the window to be managed by this sizer item.
11763 """
11764 return _core_.SizerItem_SetWindow(*args, **kwargs)
11765
11766 def GetSizer(*args, **kwargs):
11767 """
11768 GetSizer(self) -> Sizer
11769
11770 Get the subsizer (if any) that is managed by this sizer item.
11771 """
11772 return _core_.SizerItem_GetSizer(*args, **kwargs)
11773
11774 def SetSizer(*args, **kwargs):
11775 """
11776 SetSizer(self, Sizer sizer)
11777
11778 Set the subsizer to be managed by this sizer item.
11779 """
11780 return _core_.SizerItem_SetSizer(*args, **kwargs)
11781
11782 def GetSpacer(*args, **kwargs):
11783 """
11784 GetSpacer(self) -> Size
11785
11786 Get the size of the spacer managed by this sizer item.
11787 """
11788 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11789
11790 def SetSpacer(*args, **kwargs):
11791 """
11792 SetSpacer(self, Size size)
11793
11794 Set the size of the spacer to be managed by this sizer item.
11795 """
11796 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11797
11798 def Show(*args, **kwargs):
11799 """
11800 Show(self, bool show)
11801
11802 Set the show item attribute, which sizers use to determine if the item
11803 is to be made part of the layout or not. If the item is tracking a
11804 window then it is shown or hidden as needed.
11805 """
11806 return _core_.SizerItem_Show(*args, **kwargs)
11807
11808 def IsShown(*args, **kwargs):
11809 """
11810 IsShown(self) -> bool
11811
11812 Is the item to be shown in the layout?
11813 """
11814 return _core_.SizerItem_IsShown(*args, **kwargs)
11815
11816 def GetPosition(*args, **kwargs):
11817 """
11818 GetPosition(self) -> Point
11819
11820 Returns the current position of the item, as set in the last Layout.
11821 """
11822 return _core_.SizerItem_GetPosition(*args, **kwargs)
11823
11824 def GetUserData(*args, **kwargs):
11825 """
11826 GetUserData(self) -> PyObject
11827
11828 Returns the userData associated with this sizer item, or None if there
11829 isn't any.
11830 """
11831 return _core_.SizerItem_GetUserData(*args, **kwargs)
11832
11833 def SetUserData(*args, **kwargs):
11834 """
11835 SetUserData(self, PyObject userData)
11836
11837 Associate a Python object with this sizer item.
11838 """
11839 return _core_.SizerItem_SetUserData(*args, **kwargs)
11840
11841 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11842 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11843 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11844 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11845 Position = property(GetPosition,doc="See `GetPosition`")
11846 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11847 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11848 Rect = property(GetRect,doc="See `GetRect`")
11849 Size = property(GetSize,doc="See `GetSize`")
11850 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11851 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11852 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11853 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
11854_core_.SizerItem_swigregister(SizerItem)
11855
11856def SizerItemWindow(*args, **kwargs):
11857 """
11858 SizerItemWindow(Window window, int proportion, int flag, int border,
11859 PyObject userData=None) -> SizerItem
11860
11861 Constructs a `wx.SizerItem` for tracking a window.
11862 """
11863 val = _core_.new_SizerItemWindow(*args, **kwargs)
11864 return val
11865
11866def SizerItemSpacer(*args, **kwargs):
11867 """
11868 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11869 PyObject userData=None) -> SizerItem
11870
11871 Constructs a `wx.SizerItem` for tracking a spacer.
11872 """
11873 val = _core_.new_SizerItemSpacer(*args, **kwargs)
11874 return val
11875
11876def SizerItemSizer(*args, **kwargs):
11877 """
11878 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
11879 PyObject userData=None) -> SizerItem
11880
11881 Constructs a `wx.SizerItem` for tracking a subsizer
11882 """
11883 val = _core_.new_SizerItemSizer(*args, **kwargs)
11884 return val
11885
11886class Sizer(Object):
11887 """
11888 wx.Sizer is the abstract base class used for laying out subwindows in
11889 a window. You cannot use wx.Sizer directly; instead, you will have to
11890 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11891 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11892 `wx.GridBagSizer`.
11893
11894 The concept implemented by sizers in wxWidgets is closely related to
11895 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11896 toolkit or the Qt toolkit. It is based upon the idea of the individual
11897 subwindows reporting their minimal required size and their ability to
11898 get stretched if the size of the parent window has changed. This will
11899 most often mean that the programmer does not set the original size of
11900 a dialog in the beginning, rather the dialog will assigned a sizer and
11901 this sizer will be queried about the recommended size. The sizer in
11902 turn will query its children, which can be normal windows or contorls,
11903 empty space or other sizers, so that a hierarchy of sizers can be
11904 constructed. Note that wxSizer does not derive from wxWindow and thus
11905 do not interfere with tab ordering and requires very little resources
11906 compared to a real window on screen.
11907
11908 What makes sizers so well fitted for use in wxWidgets is the fact that
11909 every control reports its own minimal size and the algorithm can
11910 handle differences in font sizes or different window (dialog item)
11911 sizes on different platforms without problems. If for example the
11912 standard font as well as the overall design of Mac widgets requires
11913 more space than on Windows, then the initial size of a dialog using a
11914 sizer will automatically be bigger on Mac than on Windows.
11915 """
11916 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11917 def __init__(self): raise AttributeError, "No constructor defined"
11918 __repr__ = _swig_repr
11919 __swig_destroy__ = _core_.delete_Sizer
11920 __del__ = lambda self : None;
11921 def _setOORInfo(*args, **kwargs):
11922 """_setOORInfo(self, PyObject _self)"""
11923 return _core_.Sizer__setOORInfo(*args, **kwargs)
11924
11925 def Add(*args, **kwargs):
11926 """
11927 Add(self, item, int proportion=0, int flag=0, int border=0,
11928 PyObject userData=None) -> wx.SizerItem
11929
11930 Appends a child item to the sizer.
11931 """
11932 return _core_.Sizer_Add(*args, **kwargs)
11933
11934 def Insert(*args, **kwargs):
11935 """
11936 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
11937 PyObject userData=None) -> wx.SizerItem
11938
11939 Inserts a new item into the list of items managed by this sizer before
11940 the item at index *before*. See `Add` for a description of the parameters.
11941 """
11942 return _core_.Sizer_Insert(*args, **kwargs)
11943
11944 def Prepend(*args, **kwargs):
11945 """
11946 Prepend(self, item, int proportion=0, int flag=0, int border=0,
11947 PyObject userData=None) -> wx.SizerItem
11948
11949 Adds a new item to the begining of the list of sizer items managed by
11950 this sizer. See `Add` for a description of the parameters.
11951 """
11952 return _core_.Sizer_Prepend(*args, **kwargs)
11953
11954 def Remove(*args, **kwargs):
11955 """
11956 Remove(self, item) -> bool
11957
11958 Removes an item from the sizer and destroys it. This method does not
11959 cause any layout or resizing to take place, call `Layout` to update
11960 the layout on screen after removing a child from the sizer. The
11961 *item* parameter can be either a window, a sizer, or the zero-based
11962 index of an item to remove. Returns True if the child item was found
11963 and removed.
11964 """
11965 return _core_.Sizer_Remove(*args, **kwargs)
11966
11967 def Detach(*args, **kwargs):
11968 """
11969 Detach(self, item) -> bool
11970
11971 Detaches an item from the sizer without destroying it. This method
11972 does not cause any layout or resizing to take place, call `Layout` to
11973 do so. The *item* parameter can be either a window, a sizer, or the
11974 zero-based index of the item to be detached. Returns True if the child item
11975 was found and detached.
11976 """
11977 return _core_.Sizer_Detach(*args, **kwargs)
11978
11979 def GetItem(*args, **kwargs):
11980 """
11981 GetItem(self, item) -> wx.SizerItem
11982
11983 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11984 parameter can be either a window, a sizer, or the zero-based index of
11985 the item to be found.
11986 """
11987 return _core_.Sizer_GetItem(*args, **kwargs)
11988
11989 def _SetItemMinSize(*args, **kwargs):
11990 """_SetItemMinSize(self, PyObject item, Size size)"""
11991 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11992
11993 def _ReplaceWin(*args, **kwargs):
11994 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11995 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11996
11997 def _ReplaceSizer(*args, **kwargs):
11998 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
11999 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12000
12001 def _ReplaceItem(*args, **kwargs):
12002 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12003 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12004
12005 def Replace(self, olditem, item, recursive=False):
12006 """
12007 Detaches the given ``olditem`` from the sizer and replaces it with
12008 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12009 detached child is destroyed only if it is not a window, (because
12010 windows are owned by their parent, not the sizer.) The
12011 ``recursive`` parameter can be used to search for the given
12012 element recursivly in subsizers.
12013
12014 This method does not cause any layout or resizing to take place,
12015 call `Layout` to do so.
12016
12017 Returns ``True`` if the child item was found and removed.
12018 """
12019 if isinstance(olditem, wx.Window):
12020 return self._ReplaceWin(olditem, item, recursive)
12021 elif isinstnace(olditem, wx.Sizer):
12022 return self._ReplaceSizer(olditem, item, recursive)
12023 elif isinstnace(olditem, int):
12024 return self._ReplaceItem(olditem, item)
12025 else:
12026 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12027
12028 def SetContainingWindow(*args, **kwargs):
12029 """
12030 SetContainingWindow(self, Window window)
12031
12032 Set (or unset) the window this sizer is used in.
12033 """
12034 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12035
12036 def GetContainingWindow(*args, **kwargs):
12037 """
12038 GetContainingWindow(self) -> Window
12039
12040 Get the window this sizer is used in.
12041 """
12042 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12043
12044 def SetItemMinSize(self, item, *args):
12045 """
12046 SetItemMinSize(self, item, Size size)
12047
12048 Sets the minimum size that will be allocated for an item in the sizer.
12049 The *item* parameter can be either a window, a sizer, or the
12050 zero-based index of the item. If a window or sizer is given then it
12051 will be searched for recursivly in subsizers if neccessary.
12052 """
12053 if len(args) == 2:
12054 # for backward compatibility accept separate width,height args too
12055 return self._SetItemMinSize(item, args)
12056 else:
12057 return self._SetItemMinSize(item, args[0])
12058
12059 def AddItem(*args, **kwargs):
12060 """
12061 AddItem(self, SizerItem item)
12062
12063 Adds a `wx.SizerItem` to the sizer.
12064 """
12065 return _core_.Sizer_AddItem(*args, **kwargs)
12066
12067 def InsertItem(*args, **kwargs):
12068 """
12069 InsertItem(self, int index, SizerItem item)
12070
12071 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12072 """
12073 return _core_.Sizer_InsertItem(*args, **kwargs)
12074
12075 def PrependItem(*args, **kwargs):
12076 """
12077 PrependItem(self, SizerItem item)
12078
12079 Prepends a `wx.SizerItem` to the sizer.
12080 """
12081 return _core_.Sizer_PrependItem(*args, **kwargs)
12082
12083 def AddMany(self, items):
12084 """
12085 AddMany is a convenience method for adding several items
12086 to a sizer at one time. Simply pass it a list of tuples,
12087 where each tuple consists of the parameters that you
12088 would normally pass to the `Add` method.
12089 """
12090 for item in items:
12091 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12092 item = (item, )
12093 self.Add(*item)
12094
12095 def AddSpacer(self, *args, **kw):
12096 """AddSpacer(int size) --> SizerItem
12097
12098 Add a spacer that is (size,size) pixels.
12099 """
12100 if args and type(args[0]) == int:
12101 return self.Add( (args[0],args[0] ), 0)
12102 else: # otherwise stay compatible with old AddSpacer
12103 return self.Add(*args, **kw)
12104 def PrependSpacer(self, *args, **kw):
12105 """PrependSpacer(int size) --> SizerItem
12106
12107 Prepend a spacer that is (size, size) pixels."""
12108 if args and type(args[0]) == int:
12109 return self.Prepend( (args[0],args[0] ), 0)
12110 else: # otherwise stay compatible with old PrependSpacer
12111 return self.Prepend(*args, **kw)
12112 def InsertSpacer(self, index, *args, **kw):
12113 """InsertSpacer(int index, int size) --> SizerItem
12114
12115 Insert a spacer at position index that is (size, size) pixels."""
12116 if args and type(args[0]) == int:
12117 return self.Insert( index, (args[0],args[0] ), 0)
12118 else: # otherwise stay compatible with old InsertSpacer
12119 return self.Insert(index, *args, **kw)
12120
12121
12122 def AddStretchSpacer(self, prop=1):
12123 """AddStretchSpacer(int prop=1) --> SizerItem
12124
12125 Add a stretchable spacer."""
12126 return self.Add((0,0), prop)
12127 def PrependStretchSpacer(self, prop=1):
12128 """PrependStretchSpacer(int prop=1) --> SizerItem
12129
12130 Prepend a stretchable spacer."""
12131 return self.Prepend((0,0), prop)
12132 def InsertStretchSpacer(self, index, prop=1):
12133 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12134
12135 Insert a stretchable spacer."""
12136 return self.Insert(index, (0,0), prop)
12137
12138
12139 # for backwards compatibility only, please do not use in new code
12140 def AddWindow(self, *args, **kw):
12141 """Compatibility alias for `Add`."""
12142 return self.Add(*args, **kw)
12143 def AddSizer(self, *args, **kw):
12144 """Compatibility alias for `Add`."""
12145 return self.Add(*args, **kw)
12146
12147 def PrependWindow(self, *args, **kw):
12148 """Compatibility alias for `Prepend`."""
12149 return self.Prepend(*args, **kw)
12150 def PrependSizer(self, *args, **kw):
12151 """Compatibility alias for `Prepend`."""
12152 return self.Prepend(*args, **kw)
12153
12154 def InsertWindow(self, *args, **kw):
12155 """Compatibility alias for `Insert`."""
12156 return self.Insert(*args, **kw)
12157 def InsertSizer(self, *args, **kw):
12158 """Compatibility alias for `Insert`."""
12159 return self.Insert(*args, **kw)
12160
12161 def RemoveWindow(self, *args, **kw):
12162 """Compatibility alias for `Remove`."""
12163 return self.Remove(*args, **kw)
12164 def RemoveSizer(self, *args, **kw):
12165 """Compatibility alias for `Remove`."""
12166 return self.Remove(*args, **kw)
12167 def RemovePos(self, *args, **kw):
12168 """Compatibility alias for `Remove`."""
12169 return self.Remove(*args, **kw)
12170
12171
12172 def SetDimension(*args, **kwargs):
12173 """
12174 SetDimension(self, int x, int y, int width, int height)
12175
12176 Call this to force the sizer to take the given dimension and thus
12177 force the items owned by the sizer to resize themselves according to
12178 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12179 methods.
12180 """
12181 return _core_.Sizer_SetDimension(*args, **kwargs)
12182
12183 def SetMinSize(*args, **kwargs):
12184 """
12185 SetMinSize(self, Size size)
12186
12187 Call this to give the sizer a minimal size. Normally, the sizer will
12188 calculate its minimal size based purely on how much space its children
12189 need. After calling this method `GetMinSize` will return either the
12190 minimal size as requested by its children or the minimal size set
12191 here, depending on which is bigger.
12192 """
12193 return _core_.Sizer_SetMinSize(*args, **kwargs)
12194
12195 def GetSize(*args, **kwargs):
12196 """
12197 GetSize(self) -> Size
12198
12199 Returns the current size of the space managed by the sizer.
12200 """
12201 return _core_.Sizer_GetSize(*args, **kwargs)
12202
12203 def GetPosition(*args, **kwargs):
12204 """
12205 GetPosition(self) -> Point
12206
12207 Returns the current position of the sizer's managed space.
12208 """
12209 return _core_.Sizer_GetPosition(*args, **kwargs)
12210
12211 def GetMinSize(*args, **kwargs):
12212 """
12213 GetMinSize(self) -> Size
12214
12215 Returns the minimal size of the sizer. This is either the combined
12216 minimal size of all the children and their borders or the minimal size
12217 set by SetMinSize, depending on which is bigger.
12218 """
12219 return _core_.Sizer_GetMinSize(*args, **kwargs)
12220
12221 def GetSizeTuple(self):
12222 return self.GetSize().Get()
12223 def GetPositionTuple(self):
12224 return self.GetPosition().Get()
12225 def GetMinSizeTuple(self):
12226 return self.GetMinSize().Get()
12227
12228 def RecalcSizes(*args, **kwargs):
12229 """
12230 RecalcSizes(self)
12231
12232 Using the sizes calculated by `CalcMin` reposition and resize all the
12233 items managed by this sizer. You should not need to call this directly as
12234 it is called by `Layout`.
12235 """
12236 return _core_.Sizer_RecalcSizes(*args, **kwargs)
12237
12238 def CalcMin(*args, **kwargs):
12239 """
12240 CalcMin(self) -> Size
12241
12242 This method is where the sizer will do the actual calculation of its
12243 children's minimal sizes. You should not need to call this directly as
12244 it is called by `Layout`.
12245 """
12246 return _core_.Sizer_CalcMin(*args, **kwargs)
12247
12248 def Layout(*args, **kwargs):
12249 """
12250 Layout(self)
12251
12252 This method will force the recalculation and layout of the items
12253 controlled by the sizer using the current space allocated to the
12254 sizer. Normally this is called automatically from the owning window's
12255 EVT_SIZE handler, but it is also useful to call it from user code when
12256 one of the items in a sizer change size, or items are added or
12257 removed.
12258 """
12259 return _core_.Sizer_Layout(*args, **kwargs)
12260
12261 def Fit(*args, **kwargs):
12262 """
12263 Fit(self, Window window) -> Size
12264
12265 Tell the sizer to resize the *window* to match the sizer's minimal
12266 size. This is commonly done in the constructor of the window itself in
12267 order to set its initial size to match the needs of the children as
12268 determined by the sizer. Returns the new size.
12269
12270 For a top level window this is the total window size, not the client size.
12271 """
12272 return _core_.Sizer_Fit(*args, **kwargs)
12273
12274 def FitInside(*args, **kwargs):
12275 """
12276 FitInside(self, Window window)
12277
12278 Tell the sizer to resize the *virtual size* of the *window* to match the
12279 sizer's minimal size. This will not alter the on screen size of the
12280 window, but may cause the addition/removal/alteration of scrollbars
12281 required to view the virtual area in windows which manage it.
12282
12283 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12284
12285 """
12286 return _core_.Sizer_FitInside(*args, **kwargs)
12287
12288 def SetSizeHints(*args, **kwargs):
12289 """
12290 SetSizeHints(self, Window window)
12291
12292 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12293 match the sizer's minimal size. This is commonly done in the
12294 constructor of the window itself if the window is resizable (as are
12295 many dialogs under Unix and frames on probably all platforms) in order
12296 to prevent the window from being sized smaller than the minimal size
12297 required by the sizer.
12298 """
12299 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12300
12301 def SetVirtualSizeHints(*args, **kwargs):
12302 """
12303 SetVirtualSizeHints(self, Window window)
12304
12305 Tell the sizer to set the minimal size of the window virtual area to
12306 match the sizer's minimal size. For windows with managed scrollbars
12307 this will set them appropriately.
12308
12309 :see: `wx.ScrolledWindow.SetScrollbars`
12310
12311 """
12312 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12313
12314 def Clear(*args, **kwargs):
12315 """
12316 Clear(self, bool deleteWindows=False)
12317
12318 Clear all items from the sizer, optionally destroying the window items
12319 as well.
12320 """
12321 return _core_.Sizer_Clear(*args, **kwargs)
12322
12323 def DeleteWindows(*args, **kwargs):
12324 """
12325 DeleteWindows(self)
12326
12327 Destroy all windows managed by the sizer.
12328 """
12329 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12330
12331 def GetChildren(*args, **kwargs):
12332 """
12333 GetChildren(self) -> list
12334
12335 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12336 """
12337 return _core_.Sizer_GetChildren(*args, **kwargs)
12338
12339 def Show(*args, **kwargs):
12340 """
12341 Show(self, item, bool show=True, bool recursive=false) -> bool
12342
12343 Shows or hides an item managed by the sizer. To make a sizer item
12344 disappear or reappear, use Show followed by `Layout`. The *item*
12345 parameter can be either a window, a sizer, or the zero-based index of
12346 the item. Use the recursive parameter to show or hide an item in a
12347 subsizer. Returns True if the item was found.
12348 """
12349 return _core_.Sizer_Show(*args, **kwargs)
12350
12351 def IsShown(*args, **kwargs):
12352 """
12353 IsShown(self, item)
12354
12355 Determines if the item is currently shown. To make a sizer
12356 item disappear or reappear, use Show followed by `Layout`. The *item*
12357 parameter can be either a window, a sizer, or the zero-based index of
12358 the item.
12359 """
12360 return _core_.Sizer_IsShown(*args, **kwargs)
12361
12362 def Hide(self, item, recursive=False):
12363 """
12364 A convenience method for `Show` (item, False, recursive).
12365 """
12366 return self.Show(item, False, recursive)
12367
12368 def ShowItems(*args, **kwargs):
12369 """
12370 ShowItems(self, bool show)
12371
12372 Recursively call `wx.SizerItem.Show` on all sizer items.
12373 """
12374 return _core_.Sizer_ShowItems(*args, **kwargs)
12375
12376 Children = property(GetChildren,doc="See `GetChildren`")
12377 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12378 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12379 Position = property(GetPosition,doc="See `GetPosition`")
12380 Size = property(GetSize,doc="See `GetSize`")
12381_core_.Sizer_swigregister(Sizer)
12382
12383class PySizer(Sizer):
12384 """
12385 wx.PySizer is a special version of `wx.Sizer` that has been
12386 instrumented to allow the C++ virtual methods to be overloaded in
12387 Python derived classes. You would derive from this class if you are
12388 wanting to implement a custom sizer in Python code. Simply implement
12389 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12390 For example::
12391
12392 class MySizer(wx.PySizer):
12393 def __init__(self):
12394 wx.PySizer.__init__(self)
12395
12396 def CalcMin(self):
12397 for item in self.GetChildren():
12398 # calculate the total minimum width and height needed
12399 # by all items in the sizer according to this sizer's
12400 # layout algorithm.
12401 ...
12402 return wx.Size(width, height)
12403
12404 def RecalcSizes(self):
12405 # find the space allotted to this sizer
12406 pos = self.GetPosition()
12407 size = self.GetSize()
12408 for item in self.GetChildren():
12409 # Recalculate (if necessary) the position and size of
12410 # each item and then call item.SetDimension to do the
12411 # actual positioning and sizing of the items within the
12412 # space alloted to this sizer.
12413 ...
12414 item.SetDimension(itemPos, itemSize)
12415
12416
12417 When `Layout` is called it first calls `CalcMin` followed by
12418 `RecalcSizes` so you can optimize a bit by saving the results of
12419 `CalcMin` and reusing them in `RecalcSizes`.
12420
12421 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12422
12423
12424 """
12425 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12426 __repr__ = _swig_repr
12427 def __init__(self, *args, **kwargs):
12428 """
12429 __init__(self) -> PySizer
12430
12431 Creates a wx.PySizer. Must be called from the __init__ in the derived
12432 class.
12433 """
12434 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
12435 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12436
12437 def _setCallbackInfo(*args, **kwargs):
12438 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12439 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12440
12441_core_.PySizer_swigregister(PySizer)
12442
12443#---------------------------------------------------------------------------
12444
12445class BoxSizer(Sizer):
12446 """
12447 The basic idea behind a box sizer is that windows will most often be
12448 laid out in rather simple basic geometry, typically in a row or a
12449 column or nested hierarchies of either. A wx.BoxSizer will lay out
12450 its items in a simple row or column, depending on the orientation
12451 parameter passed to the constructor.
12452 """
12453 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12454 __repr__ = _swig_repr
12455 def __init__(self, *args, **kwargs):
12456 """
12457 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12458
12459 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12460 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12461 sizer.
12462 """
12463 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
12464 self._setOORInfo(self)
12465
12466 def GetOrientation(*args, **kwargs):
12467 """
12468 GetOrientation(self) -> int
12469
12470 Returns the current orientation of the sizer.
12471 """
12472 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12473
12474 def SetOrientation(*args, **kwargs):
12475 """
12476 SetOrientation(self, int orient)
12477
12478 Resets the orientation of the sizer.
12479 """
12480 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
12481
12482 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
12483_core_.BoxSizer_swigregister(BoxSizer)
12484
12485#---------------------------------------------------------------------------
12486
12487class StaticBoxSizer(BoxSizer):
12488 """
12489 wx.StaticBoxSizer derives from and functions identically to the
12490 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12491 manages. Note that this static box must be created separately and
12492 passed to the sizer constructor.
12493 """
12494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12495 __repr__ = _swig_repr
12496 def __init__(self, *args, **kwargs):
12497 """
12498 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12499
12500 Constructor. It takes an associated static box and the orientation
12501 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12502 ``wx.HORIZONTAL``.
12503 """
12504 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
12505 self._setOORInfo(self)
12506
12507 def GetStaticBox(*args, **kwargs):
12508 """
12509 GetStaticBox(self) -> StaticBox
12510
12511 Returns the static box associated with this sizer.
12512 """
12513 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
12514
12515 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
12516_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
12517
12518#---------------------------------------------------------------------------
12519
12520class GridSizer(Sizer):
12521 """
12522 A grid sizer is a sizer which lays out its children in a
12523 two-dimensional table with all cells having the same size. In other
12524 words, the width of each cell within the grid is the width of the
12525 widest item added to the sizer and the height of each grid cell is the
12526 height of the tallest item. An optional vertical and/or horizontal
12527 gap between items can also be specified (in pixels.)
12528
12529 Items are placed in the cells of the grid in the order they are added,
12530 in row-major order. In other words, the first row is filled first,
12531 then the second, and so on until all items have been added. (If
12532 neccessary, additional rows will be added as items are added.) If you
12533 need to have greater control over the cells that items are placed in
12534 then use the `wx.GridBagSizer`.
12535
12536 """
12537 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12538 __repr__ = _swig_repr
12539 def __init__(self, *args, **kwargs):
12540 """
12541 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12542
12543 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12544 of columns and rows in the sizer - if either of the parameters is
12545 zero, it will be calculated to from the total number of children in
12546 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12547 define extra space between all children.
12548 """
12549 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
12550 self._setOORInfo(self)
12551
12552 def SetCols(*args, **kwargs):
12553 """
12554 SetCols(self, int cols)
12555
12556 Sets the number of columns in the sizer.
12557 """
12558 return _core_.GridSizer_SetCols(*args, **kwargs)
12559
12560 def SetRows(*args, **kwargs):
12561 """
12562 SetRows(self, int rows)
12563
12564 Sets the number of rows in the sizer.
12565 """
12566 return _core_.GridSizer_SetRows(*args, **kwargs)
12567
12568 def SetVGap(*args, **kwargs):
12569 """
12570 SetVGap(self, int gap)
12571
12572 Sets the vertical gap (in pixels) between the cells in the sizer.
12573 """
12574 return _core_.GridSizer_SetVGap(*args, **kwargs)
12575
12576 def SetHGap(*args, **kwargs):
12577 """
12578 SetHGap(self, int gap)
12579
12580 Sets the horizontal gap (in pixels) between cells in the sizer
12581 """
12582 return _core_.GridSizer_SetHGap(*args, **kwargs)
12583
12584 def GetCols(*args, **kwargs):
12585 """
12586 GetCols(self) -> int
12587
12588 Returns the number of columns in the sizer.
12589 """
12590 return _core_.GridSizer_GetCols(*args, **kwargs)
12591
12592 def GetRows(*args, **kwargs):
12593 """
12594 GetRows(self) -> int
12595
12596 Returns the number of rows in the sizer.
12597 """
12598 return _core_.GridSizer_GetRows(*args, **kwargs)
12599
12600 def GetVGap(*args, **kwargs):
12601 """
12602 GetVGap(self) -> int
12603
12604 Returns the vertical gap (in pixels) between the cells in the sizer.
12605 """
12606 return _core_.GridSizer_GetVGap(*args, **kwargs)
12607
12608 def GetHGap(*args, **kwargs):
12609 """
12610 GetHGap(self) -> int
12611
12612 Returns the horizontal gap (in pixels) between cells in the sizer.
12613 """
12614 return _core_.GridSizer_GetHGap(*args, **kwargs)
12615
12616 def CalcRowsCols(self):
12617 """
12618 CalcRowsCols() -> (rows, cols)
12619
12620 Calculates how many rows and columns will be in the sizer based
12621 on the current number of items and also the rows, cols specified
12622 in the constructor.
12623 """
12624 nitems = len(self.GetChildren())
12625 rows = self.GetRows()
12626 cols = self.GetCols()
12627 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12628 if cols != 0:
12629 rows = (nitems + cols - 1) / cols
12630 elif rows != 0:
12631 cols = (nitems + rows - 1) / rows
12632 return (rows, cols)
12633
12634 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12635 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12636 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12637 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
12638_core_.GridSizer_swigregister(GridSizer)
12639
12640#---------------------------------------------------------------------------
12641
12642FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12643FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12644FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12645class FlexGridSizer(GridSizer):
12646 """
12647 A flex grid sizer is a sizer which lays out its children in a
12648 two-dimensional table with all table cells in one row having the same
12649 height and all cells in one column having the same width, but all
12650 rows or all columns are not necessarily the same height or width as in
12651 the `wx.GridSizer`.
12652
12653 wx.FlexGridSizer can also size items equally in one direction but
12654 unequally ("flexibly") in the other. If the sizer is only flexible
12655 in one direction (this can be changed using `SetFlexibleDirection`), it
12656 needs to be decided how the sizer should grow in the other ("non
12657 flexible") direction in order to fill the available space. The
12658 `SetNonFlexibleGrowMode` method serves this purpose.
12659
12660
12661 """
12662 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12663 __repr__ = _swig_repr
12664 def __init__(self, *args, **kwargs):
12665 """
12666 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12667
12668 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12669 number of columns and rows in the sizer - if either of the parameters
12670 is zero, it will be calculated to from the total number of children in
12671 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12672 define extra space between all children.
12673 """
12674 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
12675 self._setOORInfo(self)
12676
12677 def AddGrowableRow(*args, **kwargs):
12678 """
12679 AddGrowableRow(self, size_t idx, int proportion=0)
12680
12681 Specifies that row *idx* (starting from zero) should be grown if there
12682 is extra space available to the sizer.
12683
12684 The *proportion* parameter has the same meaning as the stretch factor
12685 for the box sizers except that if all proportions are 0, then all
12686 columns are resized equally (instead of not being resized at all).
12687 """
12688 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12689
12690 def RemoveGrowableRow(*args, **kwargs):
12691 """
12692 RemoveGrowableRow(self, size_t idx)
12693
12694 Specifies that row *idx* is no longer growable.
12695 """
12696 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12697
12698 def AddGrowableCol(*args, **kwargs):
12699 """
12700 AddGrowableCol(self, size_t idx, int proportion=0)
12701
12702 Specifies that column *idx* (starting from zero) should be grown if
12703 there is extra space available to the sizer.
12704
12705 The *proportion* parameter has the same meaning as the stretch factor
12706 for the box sizers except that if all proportions are 0, then all
12707 columns are resized equally (instead of not being resized at all).
12708 """
12709 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12710
12711 def RemoveGrowableCol(*args, **kwargs):
12712 """
12713 RemoveGrowableCol(self, size_t idx)
12714
12715 Specifies that column *idx* is no longer growable.
12716 """
12717 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12718
12719 def SetFlexibleDirection(*args, **kwargs):
12720 """
12721 SetFlexibleDirection(self, int direction)
12722
12723 Specifies whether the sizer should flexibly resize its columns, rows,
12724 or both. Argument *direction* can be one of the following values. Any
12725 other value is ignored.
12726
12727 ============== =======================================
12728 wx.VERTICAL Rows are flexibly sized.
12729 wx.HORIZONTAL Columns are flexibly sized.
12730 wx.BOTH Both rows and columns are flexibly sized
12731 (this is the default value).
12732 ============== =======================================
12733
12734 Note that this method does not trigger relayout.
12735
12736 """
12737 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12738
12739 def GetFlexibleDirection(*args, **kwargs):
12740 """
12741 GetFlexibleDirection(self) -> int
12742
12743 Returns a value that specifies whether the sizer
12744 flexibly resizes its columns, rows, or both (default).
12745
12746 :see: `SetFlexibleDirection`
12747 """
12748 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12749
12750 def SetNonFlexibleGrowMode(*args, **kwargs):
12751 """
12752 SetNonFlexibleGrowMode(self, int mode)
12753
12754 Specifies how the sizer should grow in the non-flexible direction if
12755 there is one (so `SetFlexibleDirection` must have been called
12756 previously). Argument *mode* can be one of the following values:
12757
12758 ========================== =================================================
12759 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12760 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12761 `AddGrowableCol` and `AddGrowableRow`. In this
12762 case equal sizing applies to minimum sizes of
12763 columns or rows (this is the default value).
12764 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12765 the non flexible direction, whether they are
12766 growable or not in the flexbile direction.
12767 ========================== =================================================
12768
12769 Note that this method does not trigger relayout.
12770 """
12771 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12772
12773 def GetNonFlexibleGrowMode(*args, **kwargs):
12774 """
12775 GetNonFlexibleGrowMode(self) -> int
12776
12777 Returns the value that specifies how the sizer grows in the
12778 non-flexible direction if there is one.
12779
12780 :see: `SetNonFlexibleGrowMode`
12781 """
12782 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12783
12784 def GetRowHeights(*args, **kwargs):
12785 """
12786 GetRowHeights(self) -> list
12787
12788 Returns a list of integers representing the heights of each of the
12789 rows in the sizer.
12790 """
12791 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12792
12793 def GetColWidths(*args, **kwargs):
12794 """
12795 GetColWidths(self) -> list
12796
12797 Returns a list of integers representing the widths of each of the
12798 columns in the sizer.
12799 """
12800 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12801
12802 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12803 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12804 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12805 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
12806_core_.FlexGridSizer_swigregister(FlexGridSizer)
12807
12808class StdDialogButtonSizer(BoxSizer):
12809 """
12810 A special sizer that knows how to order and position standard buttons
12811 in order to conform to the current platform's standards. You simply
12812 need to add each `wx.Button` to the sizer, and be sure to create the
12813 buttons using the standard ID's. Then call `Realize` and the sizer
12814 will take care of the rest.
12815
12816 """
12817 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12818 __repr__ = _swig_repr
12819 def __init__(self, *args, **kwargs):
12820 """__init__(self) -> StdDialogButtonSizer"""
12821 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
12822 def AddButton(*args, **kwargs):
12823 """
12824 AddButton(self, wxButton button)
12825
12826 Use this to add the buttons to this sizer. Do not use the `Add`
12827 method in the base class.
12828 """
12829 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12830
12831 def Realize(*args, **kwargs):
12832 """
12833 Realize(self)
12834
12835 This funciton needs to be called after all the buttons have been added
12836 to the sizer. It will reorder them and position them in a platform
12837 specifc manner.
12838 """
12839 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
12840
12841 def SetAffirmativeButton(*args, **kwargs):
12842 """SetAffirmativeButton(self, wxButton button)"""
12843 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12844
12845 def SetNegativeButton(*args, **kwargs):
12846 """SetNegativeButton(self, wxButton button)"""
12847 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12848
12849 def SetCancelButton(*args, **kwargs):
12850 """SetCancelButton(self, wxButton button)"""
12851 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
12852
12853 def GetAffirmativeButton(*args, **kwargs):
12854 """GetAffirmativeButton(self) -> wxButton"""
12855 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12856
12857 def GetApplyButton(*args, **kwargs):
12858 """GetApplyButton(self) -> wxButton"""
12859 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12860
12861 def GetNegativeButton(*args, **kwargs):
12862 """GetNegativeButton(self) -> wxButton"""
12863 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12864
12865 def GetCancelButton(*args, **kwargs):
12866 """GetCancelButton(self) -> wxButton"""
12867 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12868
12869 def GetHelpButton(*args, **kwargs):
12870 """GetHelpButton(self) -> wxButton"""
12871 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12872
12873 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12874 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12875 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12876 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12877 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
12878_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
12879
12880#---------------------------------------------------------------------------
12881
12882class GBPosition(object):
12883 """
12884 This class represents the position of an item in a virtual grid of
12885 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12886 typemaps that will automatically convert from a 2-element sequence of
12887 integers to a wx.GBPosition, so you can use the more pythonic
12888 representation of the position nearly transparently in Python code.
12889 """
12890 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12891 __repr__ = _swig_repr
12892 def __init__(self, *args, **kwargs):
12893 """
12894 __init__(self, int row=0, int col=0) -> GBPosition
12895
12896 This class represents the position of an item in a virtual grid of
12897 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12898 typemaps that will automatically convert from a 2-element sequence of
12899 integers to a wx.GBPosition, so you can use the more pythonic
12900 representation of the position nearly transparently in Python code.
12901 """
12902 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12903 __swig_destroy__ = _core_.delete_GBPosition
12904 __del__ = lambda self : None;
12905 def GetRow(*args, **kwargs):
12906 """GetRow(self) -> int"""
12907 return _core_.GBPosition_GetRow(*args, **kwargs)
12908
12909 def GetCol(*args, **kwargs):
12910 """GetCol(self) -> int"""
12911 return _core_.GBPosition_GetCol(*args, **kwargs)
12912
12913 def SetRow(*args, **kwargs):
12914 """SetRow(self, int row)"""
12915 return _core_.GBPosition_SetRow(*args, **kwargs)
12916
12917 def SetCol(*args, **kwargs):
12918 """SetCol(self, int col)"""
12919 return _core_.GBPosition_SetCol(*args, **kwargs)
12920
12921 def __eq__(*args, **kwargs):
12922 """
12923 __eq__(self, PyObject other) -> bool
12924
12925 Compare GBPosition for equality.
12926 """
12927 return _core_.GBPosition___eq__(*args, **kwargs)
12928
12929 def __ne__(*args, **kwargs):
12930 """
12931 __ne__(self, PyObject other) -> bool
12932
12933 Compare GBPosition for inequality.
12934 """
12935 return _core_.GBPosition___ne__(*args, **kwargs)
12936
12937 def Set(*args, **kwargs):
12938 """Set(self, int row=0, int col=0)"""
12939 return _core_.GBPosition_Set(*args, **kwargs)
12940
12941 def Get(*args, **kwargs):
12942 """Get(self) -> PyObject"""
12943 return _core_.GBPosition_Get(*args, **kwargs)
12944
12945 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
12946 def __str__(self): return str(self.Get())
12947 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12948 def __len__(self): return len(self.Get())
12949 def __getitem__(self, index): return self.Get()[index]
12950 def __setitem__(self, index, val):
12951 if index == 0: self.SetRow(val)
12952 elif index == 1: self.SetCol(val)
12953 else: raise IndexError
12954 def __nonzero__(self): return self.Get() != (0,0)
12955 __safe_for_unpickling__ = True
12956 def __reduce__(self): return (wx.GBPosition, self.Get())
12957
12958 row = property(GetRow, SetRow)
12959 col = property(GetCol, SetCol)
12960
12961_core_.GBPosition_swigregister(GBPosition)
12962
12963class GBSpan(object):
12964 """
12965 This class is used to hold the row and column spanning attributes of
12966 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12967 automatically convert from a 2-element sequence of integers to a
12968 wx.GBSpan, so you can use the more pythonic representation of the span
12969 nearly transparently in Python code.
12970
12971 """
12972 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12973 __repr__ = _swig_repr
12974 def __init__(self, *args, **kwargs):
12975 """
12976 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12977
12978 Construct a new wxGBSpan, optionally setting the rowspan and
12979 colspan. The default is (1,1). (Meaning that the item occupies one
12980 cell in each direction.
12981 """
12982 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12983 __swig_destroy__ = _core_.delete_GBSpan
12984 __del__ = lambda self : None;
12985 def GetRowspan(*args, **kwargs):
12986 """GetRowspan(self) -> int"""
12987 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12988
12989 def GetColspan(*args, **kwargs):
12990 """GetColspan(self) -> int"""
12991 return _core_.GBSpan_GetColspan(*args, **kwargs)
12992
12993 def SetRowspan(*args, **kwargs):
12994 """SetRowspan(self, int rowspan)"""
12995 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12996
12997 def SetColspan(*args, **kwargs):
12998 """SetColspan(self, int colspan)"""
12999 return _core_.GBSpan_SetColspan(*args, **kwargs)
13000
13001 def __eq__(*args, **kwargs):
13002 """
13003 __eq__(self, PyObject other) -> bool
13004
13005 Compare wxGBSpan for equality.
13006 """
13007 return _core_.GBSpan___eq__(*args, **kwargs)
13008
13009 def __ne__(*args, **kwargs):
13010 """
13011 __ne__(self, PyObject other) -> bool
13012
13013 Compare GBSpan for inequality.
13014 """
13015 return _core_.GBSpan___ne__(*args, **kwargs)
13016
13017 def Set(*args, **kwargs):
13018 """Set(self, int rowspan=1, int colspan=1)"""
13019 return _core_.GBSpan_Set(*args, **kwargs)
13020
13021 def Get(*args, **kwargs):
13022 """Get(self) -> PyObject"""
13023 return _core_.GBSpan_Get(*args, **kwargs)
13024
13025 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
13026 def __str__(self): return str(self.Get())
13027 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13028 def __len__(self): return len(self.Get())
13029 def __getitem__(self, index): return self.Get()[index]
13030 def __setitem__(self, index, val):
13031 if index == 0: self.SetRowspan(val)
13032 elif index == 1: self.SetColspan(val)
13033 else: raise IndexError
13034 def __nonzero__(self): return self.Get() != (0,0)
13035 __safe_for_unpickling__ = True
13036 def __reduce__(self): return (wx.GBSpan, self.Get())
13037
13038 rowspan = property(GetRowspan, SetRowspan)
13039 colspan = property(GetColspan, SetColspan)
13040
13041_core_.GBSpan_swigregister(GBSpan)
13042
13043class GBSizerItem(SizerItem):
13044 """
13045 The wx.GBSizerItem class is used to track the additional data about
13046 items in a `wx.GridBagSizer` such as the item's position in the grid
13047 and how many rows or columns it spans.
13048
13049 """
13050 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13051 __repr__ = _swig_repr
13052 def __init__(self, *args, **kwargs):
13053 """
13054 __init__(self) -> GBSizerItem
13055
13056 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13057 size will need to be set, as well as a position and span before this
13058 item can be used in a Sizer.
13059
13060 You will probably never need to create a wx.GBSizerItem directly as they
13061 are created automatically when the sizer's Add method is called.
13062 """
13063 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13064 __swig_destroy__ = _core_.delete_GBSizerItem
13065 __del__ = lambda self : None;
13066 def GetPos(*args, **kwargs):
13067 """
13068 GetPos(self) -> GBPosition
13069
13070 Get the grid position of the item
13071 """
13072 return _core_.GBSizerItem_GetPos(*args, **kwargs)
13073
13074 def GetPosTuple(self): return self.GetPos().Get()
13075 def GetSpan(*args, **kwargs):
13076 """
13077 GetSpan(self) -> GBSpan
13078
13079 Get the row and column spanning of the item
13080 """
13081 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
13082
13083 def GetSpanTuple(self): return self.GetSpan().Get()
13084 def SetPos(*args, **kwargs):
13085 """
13086 SetPos(self, GBPosition pos) -> bool
13087
13088 If the item is already a member of a sizer then first ensure that
13089 there is no other item that would intersect with this one at the new
13090 position, then set the new position. Returns True if the change is
13091 successful and after the next Layout() the item will be moved.
13092 """
13093 return _core_.GBSizerItem_SetPos(*args, **kwargs)
13094
13095 def SetSpan(*args, **kwargs):
13096 """
13097 SetSpan(self, GBSpan span) -> bool
13098
13099 If the item is already a member of a sizer then first ensure that
13100 there is no other item that would intersect with this one with its new
13101 spanning size, then set the new spanning. Returns True if the change
13102 is successful and after the next Layout() the item will be resized.
13103
13104 """
13105 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
13106
13107 def Intersects(*args, **kwargs):
13108 """
13109 Intersects(self, GBSizerItem other) -> bool
13110
13111 Returns True if this item and the other item instersect.
13112 """
13113 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13114
13115 def IntersectsPos(*args, **kwargs):
13116 """
13117 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13118
13119 Returns True if the given pos/span would intersect with this item.
13120 """
13121 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
13122
13123 def GetEndPos(*args, **kwargs):
13124 """
13125 GetEndPos(self) -> GBPosition
13126
13127 Get the row and column of the endpoint of this item.
13128 """
13129 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
13130
13131 def GetGBSizer(*args, **kwargs):
13132 """
13133 GetGBSizer(self) -> GridBagSizer
13134
13135 Get the sizer this item is a member of.
13136 """
13137 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
13138
13139 def SetGBSizer(*args, **kwargs):
13140 """
13141 SetGBSizer(self, GridBagSizer sizer)
13142
13143 Set the sizer this item is a member of.
13144 """
13145 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
13146
13147 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13148 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13149 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13150 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
13151_core_.GBSizerItem_swigregister(GBSizerItem)
13152DefaultSpan = cvar.DefaultSpan
13153
13154def GBSizerItemWindow(*args, **kwargs):
13155 """
13156 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
13157 int border, PyObject userData=None) -> GBSizerItem
13158
13159 Construct a `wx.GBSizerItem` for a window.
13160 """
13161 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
13162 return val
13163
13164def GBSizerItemSizer(*args, **kwargs):
13165 """
13166 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
13167 int border, PyObject userData=None) -> GBSizerItem
13168
13169 Construct a `wx.GBSizerItem` for a sizer
13170 """
13171 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
13172 return val
13173
13174def GBSizerItemSpacer(*args, **kwargs):
13175 """
13176 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
13177 int flag, int border, PyObject userData=None) -> GBSizerItem
13178
13179 Construct a `wx.GBSizerItem` for a spacer.
13180 """
13181 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
13182 return val
13183
13184class GridBagSizer(FlexGridSizer):
13185 """
13186 A `wx.Sizer` that can lay out items in a virtual grid like a
13187 `wx.FlexGridSizer` but in this case explicit positioning of the items
13188 is allowed using `wx.GBPosition`, and items can optionally span more
13189 than one row and/or column using `wx.GBSpan`. The total size of the
13190 virtual grid is determined by the largest row and column that items are
13191 positioned at, adjusted for spanning.
13192
13193 """
13194 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13195 __repr__ = _swig_repr
13196 def __init__(self, *args, **kwargs):
13197 """
13198 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13199
13200 Constructor, with optional parameters to specify the gap between the
13201 rows and columns.
13202 """
13203 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
13204 self._setOORInfo(self)
13205
13206 def Add(*args, **kwargs):
13207 """
13208 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
13209 int border=0, userData=None) -> wx.GBSizerItem
13210
13211 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13212 more than one row or column as specified with *span*. The remaining
13213 args behave similarly to `wx.Sizer.Add`.
13214
13215 Returns True if the item was successfully placed at the given cell
13216 position, False if something was already there.
13217
13218 """
13219 return _core_.GridBagSizer_Add(*args, **kwargs)
13220
13221 def AddItem(*args, **kwargs):
13222 """
13223 Add(self, GBSizerItem item) -> wx.GBSizerItem
13224
13225 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13226 the item was successfully placed at its given cell position, False if
13227 something was already there.
13228 """
13229 return _core_.GridBagSizer_AddItem(*args, **kwargs)
13230
13231 def GetCellSize(*args, **kwargs):
13232 """
13233 GetCellSize(self, int row, int col) -> Size
13234
13235 Get the size of the specified cell, including hgap and
13236 vgap. Only valid after a Layout.
13237 """
13238 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13239
13240 def GetEmptyCellSize(*args, **kwargs):
13241 """
13242 GetEmptyCellSize(self) -> Size
13243
13244 Get the size used for cells in the grid with no item.
13245 """
13246 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
13247
13248 def SetEmptyCellSize(*args, **kwargs):
13249 """
13250 SetEmptyCellSize(self, Size sz)
13251
13252 Set the size used for cells in the grid with no item.
13253 """
13254 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
13255
13256 def GetItemPosition(*args):
13257 """
13258 GetItemPosition(self, item) -> GBPosition
13259
13260 Get the grid position of the specified *item* where *item* is either a
13261 window or subsizer that is a member of this sizer, or a zero-based
13262 index of an item.
13263 """
13264 return _core_.GridBagSizer_GetItemPosition(*args)
13265
13266 def SetItemPosition(*args):
13267 """
13268 SetItemPosition(self, item, GBPosition pos) -> bool
13269
13270 Set the grid position of the specified *item* where *item* is either a
13271 window or subsizer that is a member of this sizer, or a zero-based
13272 index of an item. Returns True on success. If the move is not
13273 allowed (because an item is already there) then False is returned.
13274
13275 """
13276 return _core_.GridBagSizer_SetItemPosition(*args)
13277
13278 def GetItemSpan(*args):
13279 """
13280 GetItemSpan(self, item) -> GBSpan
13281
13282 Get the row/col spanning of the specified *item* where *item* is
13283 either a window or subsizer that is a member of this sizer, or a
13284 zero-based index of an item.
13285 """
13286 return _core_.GridBagSizer_GetItemSpan(*args)
13287
13288 def SetItemSpan(*args):
13289 """
13290 SetItemSpan(self, item, GBSpan span) -> bool
13291
13292 Set the row/col spanning of the specified *item* where *item* is
13293 either a window or subsizer that is a member of this sizer, or a
13294 zero-based index of an item. Returns True on success. If the move is
13295 not allowed (because an item is already there) then False is returned.
13296 """
13297 return _core_.GridBagSizer_SetItemSpan(*args)
13298
13299 def FindItem(*args):
13300 """
13301 FindItem(self, item) -> GBSizerItem
13302
13303 Find the sizer item for the given window or subsizer, returns None if
13304 not found. (non-recursive)
13305 """
13306 return _core_.GridBagSizer_FindItem(*args)
13307
13308 def FindItemAtPosition(*args, **kwargs):
13309 """
13310 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13311
13312 Return the sizer item for the given grid cell, or None if there is no
13313 item at that position. (non-recursive)
13314 """
13315 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13316
13317 def FindItemAtPoint(*args, **kwargs):
13318 """
13319 FindItemAtPoint(self, Point pt) -> GBSizerItem
13320
13321 Return the sizer item located at the point given in *pt*, or None if
13322 there is no item at that point. The (x,y) coordinates in pt correspond
13323 to the client coordinates of the window using the sizer for
13324 layout. (non-recursive)
13325 """
13326 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13327
13328 def CheckForIntersection(*args, **kwargs):
13329 """
13330 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
13331
13332 Look at all items and see if any intersect (or would overlap) the
13333 given *item*. Returns True if so, False if there would be no overlap.
13334 If an *excludeItem* is given then it will not be checked for
13335 intersection, for example it may be the item we are checking the
13336 position of.
13337
13338 """
13339 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
13340
13341 def CheckForIntersectionPos(*args, **kwargs):
13342 """
13343 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13344
13345 Look at all items and see if any intersect (or would overlap) the
13346 given position and span. Returns True if so, False if there would be
13347 no overlap. If an *excludeItem* is given then it will not be checked
13348 for intersection, for example it may be the item we are checking the
13349 position of.
13350 """
13351 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
13352
13353_core_.GridBagSizer_swigregister(GridBagSizer)
13354
13355#---------------------------------------------------------------------------
13356
13357Left = _core_.Left
13358Top = _core_.Top
13359Right = _core_.Right
13360Bottom = _core_.Bottom
13361Width = _core_.Width
13362Height = _core_.Height
13363Centre = _core_.Centre
13364Center = _core_.Center
13365CentreX = _core_.CentreX
13366CentreY = _core_.CentreY
13367Unconstrained = _core_.Unconstrained
13368AsIs = _core_.AsIs
13369PercentOf = _core_.PercentOf
13370Above = _core_.Above
13371Below = _core_.Below
13372LeftOf = _core_.LeftOf
13373RightOf = _core_.RightOf
13374SameAs = _core_.SameAs
13375Absolute = _core_.Absolute
13376class IndividualLayoutConstraint(Object):
13377 """
13378 Objects of this class are stored in the `wx.LayoutConstraints` class as
13379 one of eight possible constraints that a window can be involved in.
13380 You will never need to create an instance of
13381 wx.IndividualLayoutConstraint, rather you should create a
13382 `wx.LayoutConstraints` instance and use the individual contstraints
13383 that it contains.
13384 """
13385 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13386 def __init__(self): raise AttributeError, "No constructor defined"
13387 __repr__ = _swig_repr
13388 def Set(*args, **kwargs):
13389 """
13390 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13391
13392 Sets the properties of the constraint. Normally called by one of the
13393 convenience functions such as Above, RightOf, SameAs.
13394 """
13395 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13396
13397 def LeftOf(*args, **kwargs):
13398 """
13399 LeftOf(self, Window sibling, int marg=0)
13400
13401 Constrains this edge to be to the left of the given window, with an
13402 optional margin. Implicitly, this is relative to the left edge of the
13403 other window.
13404 """
13405 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13406
13407 def RightOf(*args, **kwargs):
13408 """
13409 RightOf(self, Window sibling, int marg=0)
13410
13411 Constrains this edge to be to the right of the given window, with an
13412 optional margin. Implicitly, this is relative to the right edge of the
13413 other window.
13414 """
13415 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13416
13417 def Above(*args, **kwargs):
13418 """
13419 Above(self, Window sibling, int marg=0)
13420
13421 Constrains this edge to be above the given window, with an optional
13422 margin. Implicitly, this is relative to the top edge of the other
13423 window.
13424 """
13425 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13426
13427 def Below(*args, **kwargs):
13428 """
13429 Below(self, Window sibling, int marg=0)
13430
13431 Constrains this edge to be below the given window, with an optional
13432 margin. Implicitly, this is relative to the bottom edge of the other
13433 window.
13434 """
13435 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13436
13437 def SameAs(*args, **kwargs):
13438 """
13439 SameAs(self, Window otherW, int edge, int marg=0)
13440
13441 Constrains this edge or dimension to be to the same as the edge of the
13442 given window, with an optional margin.
13443 """
13444 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13445
13446 def PercentOf(*args, **kwargs):
13447 """
13448 PercentOf(self, Window otherW, int wh, int per)
13449
13450 Constrains this edge or dimension to be to a percentage of the given
13451 window, with an optional margin.
13452 """
13453 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13454
13455 def Absolute(*args, **kwargs):
13456 """
13457 Absolute(self, int val)
13458
13459 Constrains this edge or dimension to be the given absolute value.
13460 """
13461 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13462
13463 def Unconstrained(*args, **kwargs):
13464 """
13465 Unconstrained(self)
13466
13467 Sets this edge or dimension to be unconstrained, that is, dependent on
13468 other edges and dimensions from which this value can be deduced.
13469 """
13470 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13471
13472 def AsIs(*args, **kwargs):
13473 """
13474 AsIs(self)
13475
13476 Sets this edge or constraint to be whatever the window's value is at
13477 the moment. If either of the width and height constraints are *as is*,
13478 the window will not be resized, but moved instead. This is important
13479 when considering panel items which are intended to have a default
13480 size, such as a button, which may take its size from the size of the
13481 button label.
13482 """
13483 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13484
13485 def GetOtherWindow(*args, **kwargs):
13486 """GetOtherWindow(self) -> Window"""
13487 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13488
13489 def GetMyEdge(*args, **kwargs):
13490 """GetMyEdge(self) -> int"""
13491 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13492
13493 def SetEdge(*args, **kwargs):
13494 """SetEdge(self, int which)"""
13495 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13496
13497 def SetValue(*args, **kwargs):
13498 """SetValue(self, int v)"""
13499 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13500
13501 def GetMargin(*args, **kwargs):
13502 """GetMargin(self) -> int"""
13503 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13504
13505 def SetMargin(*args, **kwargs):
13506 """SetMargin(self, int m)"""
13507 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13508
13509 def GetValue(*args, **kwargs):
13510 """GetValue(self) -> int"""
13511 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13512
13513 def GetPercent(*args, **kwargs):
13514 """GetPercent(self) -> int"""
13515 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13516
13517 def GetOtherEdge(*args, **kwargs):
13518 """GetOtherEdge(self) -> int"""
13519 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13520
13521 def GetDone(*args, **kwargs):
13522 """GetDone(self) -> bool"""
13523 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13524
13525 def SetDone(*args, **kwargs):
13526 """SetDone(self, bool d)"""
13527 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13528
13529 def GetRelationship(*args, **kwargs):
13530 """GetRelationship(self) -> int"""
13531 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13532
13533 def SetRelationship(*args, **kwargs):
13534 """SetRelationship(self, int r)"""
13535 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13536
13537 def ResetIfWin(*args, **kwargs):
13538 """
13539 ResetIfWin(self, Window otherW) -> bool
13540
13541 Reset constraint if it mentions otherWin
13542 """
13543 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13544
13545 def SatisfyConstraint(*args, **kwargs):
13546 """
13547 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13548
13549 Try to satisfy constraint
13550 """
13551 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13552
13553 def GetEdge(*args, **kwargs):
13554 """
13555 GetEdge(self, int which, Window thisWin, Window other) -> int
13556
13557 Get the value of this edge or dimension, or if this
13558 is not determinable, -1.
13559 """
13560 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13561
13562 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13563 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13564 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13565 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13566 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13567 Percent = property(GetPercent,doc="See `GetPercent`")
13568 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13569 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
13570_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
13571
13572class LayoutConstraints(Object):
13573 """
13574 **Note:** constraints are now deprecated and you should use sizers
13575 instead.
13576
13577 Objects of this class can be associated with a window to define its
13578 layout constraints, with respect to siblings or its parent.
13579
13580 The class consists of the following eight constraints of class
13581 wx.IndividualLayoutConstraint, some or all of which should be accessed
13582 directly to set the appropriate constraints.
13583
13584 * left: represents the left hand edge of the window
13585 * right: represents the right hand edge of the window
13586 * top: represents the top edge of the window
13587 * bottom: represents the bottom edge of the window
13588 * width: represents the width of the window
13589 * height: represents the height of the window
13590 * centreX: represents the horizontal centre point of the window
13591 * centreY: represents the vertical centre point of the window
13592
13593 Most constraints are initially set to have the relationship
13594 wxUnconstrained, which means that their values should be calculated by
13595 looking at known constraints. The exceptions are width and height,
13596 which are set to wxAsIs to ensure that if the user does not specify a
13597 constraint, the existing width and height will be used, to be
13598 compatible with panel items which often have take a default size. If
13599 the constraint is ``wx.AsIs``, the dimension will not be changed.
13600
13601 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
13602
13603 """
13604 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13605 __repr__ = _swig_repr
13606 left = property(_core_.LayoutConstraints_left_get)
13607 top = property(_core_.LayoutConstraints_top_get)
13608 right = property(_core_.LayoutConstraints_right_get)
13609 bottom = property(_core_.LayoutConstraints_bottom_get)
13610 width = property(_core_.LayoutConstraints_width_get)
13611 height = property(_core_.LayoutConstraints_height_get)
13612 centreX = property(_core_.LayoutConstraints_centreX_get)
13613 centreY = property(_core_.LayoutConstraints_centreY_get)
13614 def __init__(self, *args, **kwargs):
13615 """__init__(self) -> LayoutConstraints"""
13616 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13617 __swig_destroy__ = _core_.delete_LayoutConstraints
13618 __del__ = lambda self : None;
13619 def SatisfyConstraints(*args, **kwargs):
13620 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13621 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13622
13623 def AreSatisfied(*args, **kwargs):
13624 """AreSatisfied(self) -> bool"""
13625 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13626
13627_core_.LayoutConstraints_swigregister(LayoutConstraints)
13628
13629#----------------------------------------------------------------------------
13630
13631# Use Python's bool constants if available, make some if not
13632try:
13633 True
13634except NameError:
13635 __builtins__.True = 1==1
13636 __builtins__.False = 1==0
13637 def bool(value): return not not value
13638 __builtins__.bool = bool
13639
13640
13641
13642# workarounds for bad wxRTTI names
13643__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13644__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13645__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13646
13647
13648#----------------------------------------------------------------------------
13649# Load version numbers from __version__... Ensure that major and minor
13650# versions are the same for both wxPython and wxWidgets.
13651
13652from __version__ import *
13653__version__ = VERSION_STRING
13654
13655assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13656assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
13657if RELEASE_VERSION != _core_.RELEASE_VERSION:
13658 import warnings
13659 warnings.warn("wxPython/wxWidgets release number mismatch")
13660
13661#----------------------------------------------------------------------------
13662
13663# Set wxPython's default string<-->unicode conversion encoding from
13664# the locale, but only if Python's default hasn't been changed. (We
13665# assume that if the user has customized it already then that is the
13666# encoding we need to use as well.)
13667#
13668# The encoding selected here is used when string or unicode objects
13669# need to be converted in order to pass them to wxWidgets. Please be
13670# aware that the default encoding within the same locale may be
13671# slightly different on different platforms. For example, please see
13672# http://www.alanwood.net/demos/charsetdiffs.html for differences
13673# between the common latin/roman encodings.
13674
13675default = _sys.getdefaultencoding()
13676if default == 'ascii':
13677 import locale
13678 import codecs
13679 try:
13680 default = locale.getdefaultlocale()[1]
13681 codecs.lookup(default)
13682 except (ValueError, LookupError, TypeError):
13683 default = _sys.getdefaultencoding()
13684 del locale
13685 del codecs
13686if default:
13687 wx.SetDefaultPyEncoding(default)
13688del default
13689
13690#----------------------------------------------------------------------------
13691
13692class PyDeadObjectError(AttributeError):
13693 pass
13694
13695class _wxPyDeadObject(object):
13696 """
13697 Instances of wx objects that are OOR capable will have their __class__
13698 changed to this class when the C++ object is deleted. This should help
13699 prevent crashes due to referencing a bogus C++ pointer.
13700 """
13701 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13702 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13703
13704 def __repr__(self):
13705 if not hasattr(self, "_name"):
13706 self._name = "[unknown]"
13707 return self.reprStr % self._name
13708
13709 def __getattr__(self, *args):
13710 if not hasattr(self, "_name"):
13711 self._name = "[unknown]"
13712 raise PyDeadObjectError(self.attrStr % self._name)
13713
13714 def __nonzero__(self):
13715 return 0
13716
13717
13718
13719class PyUnbornObjectError(AttributeError):
13720 pass
13721
13722class _wxPyUnbornObject(object):
13723 """
13724 Some stock objects are created when the wx._core module is
13725 imported, but their C++ instance is not created until the wx.App
13726 object is created and initialized. These object instances will
13727 temporarily have their __class__ changed to this class so an
13728 exception will be raised if they are used before the C++ instance
13729 is ready.
13730 """
13731
13732 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13733 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13734
13735 def __repr__(self):
13736 #if not hasattr(self, "_name"):
13737 # self._name = "[unknown]"
13738 return self.reprStr #% self._name
13739
13740 def __getattr__(self, *args):
13741 #if not hasattr(self, "_name"):
13742 # self._name = "[unknown]"
13743 raise PyUnbornObjectError(self.attrStr) # % self._name )
13744
13745 def __nonzero__(self):
13746 return 0
13747
13748
13749#----------------------------------------------------------------------------
13750
13751def CallAfter(callable, *args, **kw):
13752 """
13753 Call the specified function after the current and pending event
13754 handlers have been completed. This is also good for making GUI
13755 method calls from non-GUI threads. Any extra positional or
13756 keyword args are passed on to the callable when it is called.
13757
13758 :see: `wx.CallLater`
13759 """
13760 app = wx.GetApp()
13761 assert app is not None, 'No wx.App created yet'
13762
13763 if not hasattr(app, "_CallAfterId"):
13764 app._CallAfterId = wx.NewEventType()
13765 app.Connect(-1, -1, app._CallAfterId,
13766 lambda event: event.callable(*event.args, **event.kw) )
13767 evt = wx.PyEvent()
13768 evt.SetEventType(app._CallAfterId)
13769 evt.callable = callable
13770 evt.args = args
13771 evt.kw = kw
13772 wx.PostEvent(app, evt)
13773
13774#----------------------------------------------------------------------------
13775
13776
13777class CallLater:
13778 """
13779 A convenience class for `wx.Timer`, that calls the given callable
13780 object once after the given amount of milliseconds, passing any
13781 positional or keyword args. The return value of the callable is
13782 availbale after it has been run with the `GetResult` method.
13783
13784 If you don't need to get the return value or restart the timer
13785 then there is no need to hold a reference to this object. It will
13786 hold a reference to itself while the timer is running (the timer
13787 has a reference to self.Notify) but the cycle will be broken when
13788 the timer completes, automatically cleaning up the wx.CallLater
13789 object.
13790
13791 :see: `wx.CallAfter`
13792 """
13793 def __init__(self, millis, callable, *args, **kwargs):
13794 self.millis = millis
13795 self.callable = callable
13796 self.SetArgs(*args, **kwargs)
13797 self.runCount = 0
13798 self.running = False
13799 self.hasRun = False
13800 self.result = None
13801 self.timer = None
13802 self.Start()
13803
13804 def __del__(self):
13805 self.Stop()
13806
13807
13808 def Start(self, millis=None, *args, **kwargs):
13809 """
13810 (Re)start the timer
13811 """
13812 self.hasRun = False
13813 if millis is not None:
13814 self.millis = millis
13815 if args or kwargs:
13816 self.SetArgs(*args, **kwargs)
13817 self.Stop()
13818 self.timer = wx.PyTimer(self.Notify)
13819 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13820 self.running = True
13821 Restart = Start
13822
13823
13824 def Stop(self):
13825 """
13826 Stop and destroy the timer.
13827 """
13828 if self.timer is not None:
13829 self.timer.Stop()
13830 self.timer = None
13831
13832
13833 def GetInterval(self):
13834 if self.timer is not None:
13835 return self.timer.GetInterval()
13836 else:
13837 return 0
13838
13839
13840 def IsRunning(self):
13841 return self.timer is not None and self.timer.IsRunning()
13842
13843
13844 def SetArgs(self, *args, **kwargs):
13845 """
13846 (Re)set the args passed to the callable object. This is
13847 useful in conjunction with Restart if you want to schedule a
13848 new call to the same callable object but with different
13849 parameters.
13850 """
13851 self.args = args
13852 self.kwargs = kwargs
13853
13854
13855 def HasRun(self):
13856 return self.hasRun
13857
13858 def GetResult(self):
13859 return self.result
13860
13861 def Notify(self):
13862 """
13863 The timer has expired so call the callable.
13864 """
13865 if self.callable and getattr(self.callable, 'im_self', True):
13866 self.runCount += 1
13867 self.running = False
13868 self.result = self.callable(*self.args, **self.kwargs)
13869 self.hasRun = True
13870 if not self.running:
13871 # if it wasn't restarted, then cleanup
13872 wx.CallAfter(self.Stop)
13873
13874 Interval = property(GetInterval)
13875 Result = property(GetResult)
13876
13877
13878class FutureCall(CallLater):
13879 """A compatibility alias for `CallLater`."""
13880
13881#----------------------------------------------------------------------------
13882# Control which items in this module should be documented by epydoc.
13883# We allow only classes and functions, which will help reduce the size
13884# of the docs by filtering out the zillions of constants, EVT objects,
13885# and etc that don't make much sense by themselves, but are instead
13886# documented (or will be) as part of the classes/functions/methods
13887# where they should be used.
13888
13889class __DocFilter:
13890 """
13891 A filter for epydoc that only allows non-Ptr classes and
13892 functions, in order to reduce the clutter in the API docs.
13893 """
13894 def __init__(self, globals):
13895 self._globals = globals
13896
13897 def __call__(self, name):
13898 import types
13899 obj = self._globals.get(name, None)
13900
13901 # only document classes and function
13902 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13903 return False
13904
13905 # skip other things that are private or will be documented as part of somethign else
13906 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
13907 return False
13908
13909 # skip functions that are duplicates of static functions in a class
13910 if name.find('_') != -1:
13911 cls = self._globals.get(name.split('_')[0], None)
13912 methname = name.split('_')[1]
13913 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13914 return False
13915
13916 return True
13917
13918#----------------------------------------------------------------------------
13919#----------------------------------------------------------------------------
13920
13921# Import other modules in this package that should show up in the
13922# "core" wx namespace
13923from _gdi import *
13924from _windows import *
13925from _controls import *
13926from _misc import *
13927
13928#----------------------------------------------------------------------------
13929#----------------------------------------------------------------------------
13930
13931
13932
wxWidgets (Impactor)