]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
move default button handling code from wxControlContainer to wxTLW (patch 1524441)
[wxWidgets.git] / wxPython / src / msw / _core.py
CommitLineData
554f62e9 1# This file was created automatically by SWIG 1.3.29.
d55e5bfc
RD		 2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
554f62e9
RD		 5import new
6new_instancemethod = new.instancemethod
093d3ff1 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
554f62e9 8 if (name == "thisown"): return self.this.own(value)
093d3ff1 9 if (name == "this"):
554f62e9
RD		 10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
093d3ff1
RD		 12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
554f62e9 15 if (not static) or hasattr(self,name):
093d3ff1
RD		 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):
554f62e9 24 if (name == "thisown"): return self.this.own()
093d3ff1
RD		 25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
554f62e9
RD		 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
093d3ff1
RD		 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):
554f62e9
RD		 46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
093d3ff1
RD		 48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
d55e5bfc
RD		 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
c24da6d6
RD		 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
d55e5bfc
RD		 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
57133d5c 95DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 96DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
d55e5bfc
RD		 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
d55e5bfc
RD		 103CLIP_CHILDREN = _core_.CLIP_CHILDREN
104CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
092f0ed7 105WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK
d55e5bfc
RD		 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
fef4c27a 129RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
d55e5bfc
RD		 130RB_GROUP = _core_.RB_GROUP
131RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD		 132SB_HORIZONTAL = _core_.SB_HORIZONTAL
133SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 134RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
RD		 135ST_SIZEGRIP = _core_.ST_SIZEGRIP
136ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
e9d6f3a4
RD		 137ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE
138ST_DOTS_END = _core_.ST_DOTS_END
d55e5bfc
RD		 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
9d7dfdff 174SIZE_FORCE = _core_.SIZE_FORCE
d55e5bfc
RD		 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
9d7dfdff 183ID_NONE = _core_.ID_NONE
d55e5bfc
RD		 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
fc46b7f3 197ID_PAGE_SETUP = _core_.ID_PAGE_SETUP
d55e5bfc
RD		 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
1eeb270e
RD		 204ID_HELP_INDEX = _core_.ID_HELP_INDEX
205ID_HELP_SEARCH = _core_.ID_HELP_SEARCH
d55e5bfc
RD		 206ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
207ID_PREFERENCES = _core_.ID_PREFERENCES
97ab0f6a 208ID_EDIT = _core_.ID_EDIT
d55e5bfc
RD		 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
97ab0f6a 228ID_FILE = _core_.ID_FILE
d55e5bfc
RD		 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
0f63ec68
RD		 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
d55e5bfc 279ID_HIGHEST = _core_.ID_HIGHEST
d55e5bfc
RD		 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
0f63ec68
RD		 346BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
347BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
348BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD		 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
d04418a7
RD		 371STIPPLE_MASK = _core_.STIPPLE_MASK
372STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
d55e5bfc
RD		 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
88c6b281
RD		 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
d55e5bfc
RD		 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
034e3677
RD		 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
d55e5bfc
RD		 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
9d7dfdff 672MOD_ALTGR = _core_.MOD_ALTGR
d55e5bfc 673MOD_SHIFT = _core_.MOD_SHIFT
9d7dfdff 674MOD_META = _core_.MOD_META
d55e5bfc 675MOD_WIN = _core_.MOD_WIN
9d7dfdff
RD		 676MOD_CMD = _core_.MOD_CMD
677MOD_ALL = _core_.MOD_ALL
d55e5bfc
RD		 678UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
679UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
680UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
994453b8
RD		 681Layout_Default = _core_.Layout_Default
682Layout_LeftToRight = _core_.Layout_LeftToRight
683Layout_RightToLeft = _core_.Layout_RightToLeft
d55e5bfc
RD		 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 """
554f62e9
RD		 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
d55e5bfc
RD		 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 """
b39fe951
RD		 708 args[0].this.own(False)
709 return _core_.Object_Destroy(*args, **kwargs)
d55e5bfc 710
8f514ab4
RD		 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
33d6fd3b 721 ClassName = property(GetClassName,doc="See `GetClassName`")
2131d850 722_core_.Object_swigregister(Object)
d55e5bfc 723_wxPySetDictionary = _core_._wxPySetDictionary
d55e5bfc
RD		 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
8f514ab4 747BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA
d55e5bfc
RD		 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 """
79fccf9d 785 wx.Size is a useful data structure used to represent the size of
554f62e9
RD		 786 something. It simply contains integer width and height
787 properties. In most places in wxPython where a wx.Size is
093d3ff1 788 expected a (width, height) tuple can be used instead.
d55e5bfc 789 """
554f62e9
RD		 790 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
791 __repr__ = _swig_repr
d55e5bfc
RD		 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
554f62e9 795 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 796 """
797 __init__(self, int w=0, int h=0) -> Size
798
799 Creates a size object.
800 """
554f62e9
RD		 801 _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
802 __swig_destroy__ = _core_.delete_Size
803 __del__ = lambda self : None;
d55e5bfc
RD		 804 def __eq__(*args, **kwargs):
805 """
e9d6f3a4 806 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 807
808 Test for equality of wx.Size objects.
809 """
810 return _core_.Size___eq__(*args, **kwargs)
811
812 def __ne__(*args, **kwargs):
813 """
e9d6f3a4 814 __ne__(self, PyObject other) -> bool
d55e5bfc 815
e9d6f3a4 816 Test for inequality of wx.Size objects.
d55e5bfc
RD		 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
f5263701
RD		 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
1eeb270e
RD		 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
d55e5bfc
RD		 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
79fccf9d
RD		 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.
d55e5bfc
RD		 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
79fccf9d 919 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 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
2131d850 932_core_.Size_swigregister(Size)
d55e5bfc
RD		 933
934#---------------------------------------------------------------------------
935
936class RealPoint(object):
937 """
79fccf9d
RD		 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.
d55e5bfc 941 """
554f62e9
RD		 942 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
943 __repr__ = _swig_repr
d55e5bfc
RD		 944 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
945 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
554f62e9 946 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 947 """
948 __init__(self, double x=0.0, double y=0.0) -> RealPoint
949
950 Create a wx.RealPoint object
951 """
554f62e9
RD		 952 _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
953 __swig_destroy__ = _core_.delete_RealPoint
954 __del__ = lambda self : None;
d55e5bfc
RD		 955 def __eq__(*args, **kwargs):
956 """
e9d6f3a4 957 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 958
959 Test for equality of wx.RealPoint objects.
960 """
961 return _core_.RealPoint___eq__(*args, **kwargs)
962
963 def __ne__(*args, **kwargs):
964 """
e9d6f3a4 965 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 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
79fccf9d 1003 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 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
2131d850 1016_core_.RealPoint_swigregister(RealPoint)
d55e5bfc
RD		 1017
1018#---------------------------------------------------------------------------
1019
1020class Point(object):
1021 """
79fccf9d
RD		 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.
d55e5bfc 1025 """
554f62e9
RD		 1026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1027 __repr__ = _swig_repr
d55e5bfc
RD		 1028 x = property(_core_.Point_x_get, _core_.Point_x_set)
1029 y = property(_core_.Point_y_get, _core_.Point_y_set)
554f62e9 1030 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 1031 """
1032 __init__(self, int x=0, int y=0) -> Point
1033
1034 Create a wx.Point object
1035 """
554f62e9
RD		 1036 _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
1037 __swig_destroy__ = _core_.delete_Point
1038 __del__ = lambda self : None;
d55e5bfc
RD		 1039 def __eq__(*args, **kwargs):
1040 """
e9d6f3a4 1041 __eq__(self, PyObject other) -> bool
d55e5bfc
RD		 1042
1043 Test for equality of wx.Point objects.
1044 """
1045 return _core_.Point___eq__(*args, **kwargs)
1046
1047 def __ne__(*args, **kwargs):
1048 """
e9d6f3a4 1049 __ne__(self, PyObject other) -> bool
d55e5bfc
RD		 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
79fccf9d 1103 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 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
2131d850 1116_core_.Point_swigregister(Point)
d55e5bfc
RD		 1117
1118#---------------------------------------------------------------------------
1119
1120class Rect(object):
1121 """
79fccf9d
RD		 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.
d55e5bfc 1125 """
554f62e9
RD		 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):
d55e5bfc
RD		 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 """
554f62e9
RD		 1134 _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
1135 __swig_destroy__ = _core_.delete_Rect
1136 __del__ = lambda self : None;
d55e5bfc
RD		 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
aff4cc5c
RD		 1185 def IsEmpty(*args, **kwargs):
1186 """IsEmpty(self) -> bool"""
1187 return _core_.Rect_IsEmpty(*args, **kwargs)
1188
d55e5bfc
RD		 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
5acb46e0
RD		 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
d55e5bfc
RD		 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
091fdbfa
RD		 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
d55e5bfc
RD		 1282 """
1283 return _core_.Rect_Inflate(*args, **kwargs)
1284
1285 def Deflate(*args, **kwargs):
1286 """
1287 Deflate(self, int dx, int dy) -> Rect
1288
091fdbfa
RD		 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.
d55e5bfc
RD		 1292 """
1293 return _core_.Rect_Deflate(*args, **kwargs)
1294
1295 def OffsetXY(*args, **kwargs):
1296 """
1297 OffsetXY(self, int dx, int dy)
1298
79fccf9d
RD		 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.
d55e5bfc
RD		 1302 """
1303 return _core_.Rect_OffsetXY(*args, **kwargs)
1304
1305 def Offset(*args, **kwargs):
1306 """
1307 Offset(self, Point pt)
1308
b1fcee84 1309 Same as `OffsetXY` but uses dx,dy from Point
d55e5bfc
RD		 1310 """
1311 return _core_.Rect_Offset(*args, **kwargs)
1312
1313 def Intersect(*args, **kwargs):
1314 """
1315 Intersect(self, Rect rect) -> Rect
1316
b519803b 1317 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD		 1318 """
1319 return _core_.Rect_Intersect(*args, **kwargs)
1320
b519803b
RD		 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
d55e5bfc
RD		 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 """
e9d6f3a4 1347 __eq__(self, PyObject other) -> bool
d55e5bfc 1348
e9d6f3a4 1349 Test for equality of wx.Rect objects.
d55e5bfc
RD		 1350 """
1351 return _core_.Rect___eq__(*args, **kwargs)
1352
1353 def __ne__(*args, **kwargs):
1354 """
e9d6f3a4 1355 __ne__(self, PyObject other) -> bool
d55e5bfc 1356
e9d6f3a4 1357 Test for inequality of wx.Rect objects.
d55e5bfc
RD		 1358 """
1359 return _core_.Rect___ne__(*args, **kwargs)
1360
33d6fd3b 1361 def ContainsXY(*args, **kwargs):
d55e5bfc 1362 """
33d6fd3b 1363 ContainsXY(self, int x, int y) -> bool
d55e5bfc 1364
33d6fd3b 1365 Return True if the point is inside the rect.
d55e5bfc 1366 """
33d6fd3b 1367 return _core_.Rect_ContainsXY(*args, **kwargs)
d55e5bfc 1368
33d6fd3b 1369 def Contains(*args, **kwargs):
d55e5bfc 1370 """
33d6fd3b 1371 Contains(self, Point pt) -> bool
d55e5bfc 1372
33d6fd3b 1373 Return True if the point is inside the rect.
d55e5bfc 1374 """
33d6fd3b 1375 return _core_.Rect_Contains(*args, **kwargs)
d55e5bfc 1376
33d6fd3b 1377 def ContainsRect(*args, **kwargs):
fc46b7f3 1378 """
33d6fd3b 1379 ContainsRect(self, Rect rect) -> bool
fc46b7f3
RD		 1380
1381 Returns ``True`` if the given rectangle is completely inside this
1382 rectangle or touches its boundary.
1383 """
33d6fd3b
RD		 1384 return _core_.Rect_ContainsRect(*args, **kwargs)
1385
72ef6efb
RD		 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
fc46b7f3 1392
d55e5bfc
RD		 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
b1fcee84
RD		 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
d55e5bfc
RD		 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
79fccf9d 1431 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 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
33d6fd3b
RD		 1446 Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`")
1447 BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`")
5acb46e0 1448 BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`")
33d6fd3b
RD		 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`")
5acb46e0 1456 TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`")
33d6fd3b
RD		 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`")
2131d850 1461_core_.Rect_swigregister(Rect)
d55e5bfc
RD		 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)
d55e5bfc
RD		 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)
d55e5bfc
RD		 1479 return val
1480
c1cb24a4
RD		 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)
c1cb24a4
RD		 1488 return val
1489
d55e5bfc
RD		 1490
1491def IntersectRect(*args, **kwargs):
554f62e9 1492 """
d55e5bfc
RD		 1493 IntersectRect(Rect r1, Rect r2) -> Rect
1494
1495 Calculate and return the intersection of r1 and r2.
1496 """
554f62e9 1497 return _core_.IntersectRect(*args, **kwargs)
d55e5bfc
RD		 1498#---------------------------------------------------------------------------
1499
1500class Point2D(object):
79fccf9d
RD		 1501 """
1502 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1503 with floating point values.
1504 """
554f62e9
RD		 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):
d55e5bfc
RD		 1508 """
1509 __init__(self, double x=0.0, double y=0.0) -> Point2D
1510
1511 Create a w.Point2D object.
1512 """
554f62e9 1513 _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
b39fe951
RD		 1514 __swig_destroy__ = _core_.delete_Point2D
1515 __del__ = lambda self : None;
d55e5bfc 1516 def GetFloor(*args, **kwargs):
a8eff060
RD		 1517 """
1518 GetFloor() -> (x,y)
1519
1520 Convert to integer
1521 """
d55e5bfc
RD		 1522 return _core_.Point2D_GetFloor(*args, **kwargs)
1523
1524 def GetRounded(*args, **kwargs):
a8eff060
RD		 1525 """
1526 GetRounded() -> (x,y)
1527
1528 Convert to integer
1529 """
d55e5bfc
RD		 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 """
e9d6f3a4 1596 __eq__(self, PyObject other) -> bool
d55e5bfc 1597
e9d6f3a4 1598 Test for equality of wx.Point2D objects.
d55e5bfc
RD		 1599 """
1600 return _core_.Point2D___eq__(*args, **kwargs)
1601
1602 def __ne__(*args, **kwargs):
1603 """
e9d6f3a4 1604 __ne__(self, PyObject other) -> bool
d55e5bfc 1605
e9d6f3a4 1606 Test for inequality of wx.Point2D objects.
d55e5bfc
RD		 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
79fccf9d 1624 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 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
33d6fd3b
RD		 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`")
2131d850 1641_core_.Point2D_swigregister(Point2D)
d55e5bfc
RD		 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)
d55e5bfc
RD		 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)
d55e5bfc
RD		 1659 return val
1660
1661#---------------------------------------------------------------------------
1662
70d7cb34
RD		 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
d55e5bfc
RD		 1917FromStart = _core_.FromStart
1918FromCurrent = _core_.FromCurrent
1919FromEnd = _core_.FromEnd
1920class InputStream(object):
093d3ff1 1921 """Proxy of C++ InputStream class"""
554f62e9
RD		 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):
d55e5bfc 1925 """__init__(self, PyObject p) -> InputStream"""
554f62e9
RD		 1926 _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
1927 __swig_destroy__ = _core_.delete_InputStream
1928 __del__ = lambda self : None;
d55e5bfc
RD		 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
2131d850 1993_core_.InputStream_swigregister(InputStream)
d55e5bfc
RD		 1994DefaultPosition = cvar.DefaultPosition
1995DefaultSize = cvar.DefaultSize
1996
1997class OutputStream(object):
093d3ff1 1998 """Proxy of C++ OutputStream class"""
554f62e9
RD		 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
d55e5bfc
RD		 2002 def write(*args, **kwargs):
2003 """write(self, PyObject obj)"""
2004 return _core_.OutputStream_write(*args, **kwargs)
2005
554f62e9
RD		 2006 def LastWrite(*args, **kwargs):
2007 """LastWrite(self) -> size_t"""
2008 return _core_.OutputStream_LastWrite(*args, **kwargs)
d55e5bfc 2009
2131d850 2010_core_.OutputStream_swigregister(OutputStream)
d55e5bfc
RD		 2011
2012#---------------------------------------------------------------------------
2013
2014class FSFile(Object):
093d3ff1 2015 """Proxy of C++ FSFile class"""
554f62e9
RD		 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):
d55e5bfc
RD		 2019 """
2020 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
2021 DateTime modif) -> FSFile
2022 """
554f62e9 2023 _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
554f62e9
RD		 2024 __swig_destroy__ = _core_.delete_FSFile
2025 __del__ = lambda self : None;
d55e5bfc
RD		 2026 def GetStream(*args, **kwargs):
2027 """GetStream(self) -> InputStream"""
2028 return _core_.FSFile_GetStream(*args, **kwargs)
2029
97ab0f6a
RD		 2030 def DetachStream(*args, **kwargs):
2031 """DetachStream(self)"""
2032 return _core_.FSFile_DetachStream(*args, **kwargs)
2033
d55e5bfc
RD		 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
97ab0f6a
RD		 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`")
2131d850 2055_core_.FSFile_swigregister(FSFile)
d55e5bfc
RD		 2056
2057class CPPFileSystemHandler(object):
093d3ff1 2058 """Proxy of C++ CPPFileSystemHandler class"""
554f62e9
RD		 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
50f151d7
RD		 2062 __swig_destroy__ = _core_.delete_CPPFileSystemHandler
2063 __del__ = lambda self : None;
2131d850 2064_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
d55e5bfc
RD		 2065
2066class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 2067 """Proxy of C++ FileSystemHandler class"""
554f62e9
RD		 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):
d55e5bfc 2071 """__init__(self) -> FileSystemHandler"""
554f62e9 2072 _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
c25f90f6 2073 FileSystemHandler._setCallbackInfo(self, self, FileSystemHandler)
d55e5bfc
RD		 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
97ab0f6a
RD		 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`")
2131d850 2120_core_.FileSystemHandler_swigregister(FileSystemHandler)
d55e5bfc
RD		 2121
2122class FileSystem(Object):
093d3ff1 2123 """Proxy of C++ FileSystem class"""
554f62e9
RD		 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):
d55e5bfc 2127 """__init__(self) -> FileSystem"""
554f62e9
RD		 2128 _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
2129 __swig_destroy__ = _core_.delete_FileSystem
2130 __del__ = lambda self : None;
d55e5bfc
RD		 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):
c24da6d6 2152 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD		 2153 return _core_.FileSystem_AddHandler(*args, **kwargs)
2154
2155 AddHandler = staticmethod(AddHandler)
97ab0f6a
RD		 2156 def RemoveHandler(*args, **kwargs):
2157 """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2158 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2159
2160 RemoveHandler = staticmethod(RemoveHandler)
d55e5bfc 2161 def CleanUpHandlers(*args, **kwargs):
c24da6d6 2162 """CleanUpHandlers()"""
d55e5bfc
RD		 2163 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
2164
2165 CleanUpHandlers = staticmethod(CleanUpHandlers)
2166 def FileNameToURL(*args, **kwargs):
c24da6d6 2167 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD		 2168 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
2169
2170 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD		 2171 def URLToFileName(*args, **kwargs):
2172 """URLToFileName(String url) -> String"""
2173 return _core_.FileSystem_URLToFileName(*args, **kwargs)
2174
2175 URLToFileName = staticmethod(URLToFileName)
97ab0f6a 2176 Path = property(GetPath,doc="See `GetPath`")
2131d850 2177_core_.FileSystem_swigregister(FileSystem)
d55e5bfc
RD		 2178
2179def FileSystem_AddHandler(*args, **kwargs):
554f62e9
RD		 2180 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
2181 return _core_.FileSystem_AddHandler(*args, **kwargs)
d55e5bfc 2182
97ab0f6a
RD		 2183def FileSystem_RemoveHandler(*args, **kwargs):
2184 """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler"""
2185 return _core_.FileSystem_RemoveHandler(*args, **kwargs)
2186
554f62e9
RD		 2187def FileSystem_CleanUpHandlers(*args):
2188 """FileSystem_CleanUpHandlers()"""
2189 return _core_.FileSystem_CleanUpHandlers(*args)
d55e5bfc
RD		 2190
2191def FileSystem_FileNameToURL(*args, **kwargs):
554f62e9
RD		 2192 """FileSystem_FileNameToURL(String filename) -> String"""
2193 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d55e5bfc 2194
d55e5bfc 2195def FileSystem_URLToFileName(*args, **kwargs):
554f62e9
RD		 2196 """FileSystem_URLToFileName(String url) -> String"""
2197 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 2198
d55e5bfc 2199class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 2200 """Proxy of C++ InternetFSHandler class"""
554f62e9
RD		 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):
d55e5bfc 2204 """__init__(self) -> InternetFSHandler"""
554f62e9 2205 _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
d55e5bfc
RD		 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
2131d850 2214_core_.InternetFSHandler_swigregister(InternetFSHandler)
d55e5bfc
RD		 2215
2216class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 2217 """Proxy of C++ ZipFSHandler class"""
554f62e9
RD		 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):
d55e5bfc 2221 """__init__(self) -> ZipFSHandler"""
554f62e9 2222 _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
d55e5bfc
RD		 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
2131d850 2239_core_.ZipFSHandler_swigregister(ZipFSHandler)
d55e5bfc
RD		 2240
2241
2242def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
554f62e9
RD		 2243 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2244 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d55e5bfc
RD		 2245
2246def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
554f62e9
RD		 2247 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2248 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d55e5bfc
RD		 2249
2250def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
554f62e9
RD		 2251 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2252 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD		 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'
d55e5bfc
RD		 2269
2270class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2271 """Proxy of C++ MemoryFSHandler class"""
554f62e9
RD		 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):
d55e5bfc 2275 """__init__(self) -> MemoryFSHandler"""
554f62e9 2276 _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
d55e5bfc 2277 def RemoveFile(*args, **kwargs):
c24da6d6 2278 """RemoveFile(String filename)"""
d55e5bfc
RD		 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
2131d850 2299_core_.MemoryFSHandler_swigregister(MemoryFSHandler)
d55e5bfc
RD		 2300
2301def MemoryFSHandler_RemoveFile(*args, **kwargs):
554f62e9
RD		 2302 """MemoryFSHandler_RemoveFile(String filename)"""
2303 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d55e5bfc 2304
57133d5c
RD		 2305IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2306IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2307IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
f5263701
RD		 2308IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
2309IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH
d55e5bfc
RD		 2310#---------------------------------------------------------------------------
2311
2312class ImageHandler(Object):
27fb7603
RD		 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 """
554f62e9
RD		 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
d55e5bfc
RD		 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
b02396e8
RD		 2341 def CanReadStream(*args, **kwargs):
2342 """CanReadStream(self, InputStream stream) -> bool"""
2343 return _core_.ImageHandler_CanReadStream(*args, **kwargs)
2344
d55e5bfc
RD		 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
97ab0f6a
RD		 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`")
2131d850 2365_core_.ImageHandler_swigregister(ImageHandler)
d55e5bfc 2366
9d7dfdff
RD		 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 """
554f62e9
RD		 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):
9d7dfdff
RD		 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 """
554f62e9 2423 _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
9d7dfdff
RD		 2424 self._SetSelf(self)
2425
2426 def _SetSelf(*args, **kwargs):
2427 """_SetSelf(self, PyObject self)"""
2428 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2429
2131d850 2430_core_.PyImageHandler_swigregister(PyImageHandler)
9d7dfdff 2431
d55e5bfc 2432class ImageHistogram(object):
093d3ff1 2433 """Proxy of C++ ImageHistogram class"""
554f62e9
RD		 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):
d55e5bfc 2437 """__init__(self) -> ImageHistogram"""
554f62e9 2438 _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
d55e5bfc
RD		 2439 def MakeKey(*args, **kwargs):
2440 """
7a27cf7c 2441 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 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):
a8eff060
RD		 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 """
d55e5bfc
RD		 2456 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2457
f1cbd8fa
RD		 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 """
7a27cf7c 2469 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD		 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
2131d850 2483_core_.ImageHistogram_swigregister(ImageHistogram)
d55e5bfc
RD		 2484
2485def ImageHistogram_MakeKey(*args, **kwargs):
554f62e9 2486 """
7a27cf7c 2487 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD		 2488
2489 Get the key in the histogram for the given RGB values
2490 """
554f62e9 2491 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d55e5bfc 2492
2f91e3df 2493class Image_RGBValue(object):
9d7dfdff
RD		 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 """
554f62e9
RD		 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):
9d7dfdff
RD		 2503 """
2504 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2505
2506 Constructor.
2507 """
554f62e9 2508 _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
2f91e3df
KO		 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)
2131d850 2512_core_.Image_RGBValue_swigregister(Image_RGBValue)
2f91e3df
KO		 2513
2514class Image_HSVValue(object):
9d7dfdff
RD		 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 """
554f62e9
RD		 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):
9d7dfdff
RD		 2524 """
2525 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2526
2527 Constructor.
2528 """
554f62e9 2529 _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
2f91e3df
KO		 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)
2131d850 2533_core_.Image_HSVValue_swigregister(Image_HSVValue)
2f91e3df 2534
d55e5bfc 2535class Image(Object):
7a27cf7c
RD		 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 """
554f62e9
RD		 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):
7a27cf7c
RD		 2565 """
2566 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2567
2568 Loads an image from a file.
2569 """
554f62e9
RD		 2570 _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
2571 __swig_destroy__ = _core_.delete_Image
2572 __del__ = lambda self : None;
d55e5bfc 2573 def Create(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2580 return _core_.Image_Create(*args, **kwargs)
2581
2582 def Destroy(*args, **kwargs):
2583 """
2584 Destroy(self)
2585
7a27cf7c 2586 Destroys the image data.
d55e5bfc 2587 """
b39fe951
RD		 2588 args[0].this.own(False)
2589 return _core_.Image_Destroy(*args, **kwargs)
d55e5bfc
RD		 2590
2591 def Scale(*args, **kwargs):
7a27cf7c 2592 """
f5263701 2593 Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 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
f5263701
RD		 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.
7a27cf7c 2603 """
d55e5bfc
RD		 2604 return _core_.Image_Scale(*args, **kwargs)
2605
f5263701
RD		 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
d55e5bfc 2643 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD		 2644 """
2645 ShrinkBy(self, int xFactor, int yFactor) -> Image
2646
2647 Return a version of the image scaled smaller by the given factors.
2648 """
d55e5bfc
RD		 2649 return _core_.Image_ShrinkBy(*args, **kwargs)
2650
2651 def Rescale(*args, **kwargs):
7a27cf7c 2652 """
f5263701 2653 Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2660 return _core_.Image_Rescale(*args, **kwargs)
2661
aff4cc5c 2662 def Resize(*args, **kwargs):
7a27cf7c
RD		 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 """
aff4cc5c
RD		 2676 return _core_.Image_Resize(*args, **kwargs)
2677
d55e5bfc 2678 def SetRGB(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2688 return _core_.Image_SetRGB(*args, **kwargs)
2689
aff4cc5c 2690 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD		 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 """
aff4cc5c
RD		 2698 return _core_.Image_SetRGBRect(*args, **kwargs)
2699
d55e5bfc 2700 def GetRed(*args, **kwargs):
7a27cf7c
RD		 2701 """
2702 GetRed(self, int x, int y) -> byte
2703
2704 Returns the red intensity at the given coordinate.
2705 """
d55e5bfc
RD		 2706 return _core_.Image_GetRed(*args, **kwargs)
2707
2708 def GetGreen(*args, **kwargs):
7a27cf7c
RD		 2709 """
2710 GetGreen(self, int x, int y) -> byte
2711
2712 Returns the green intensity at the given coordinate.
2713 """
d55e5bfc
RD		 2714 return _core_.Image_GetGreen(*args, **kwargs)
2715
2716 def GetBlue(*args, **kwargs):
7a27cf7c
RD		 2717 """
2718 GetBlue(self, int x, int y) -> byte
2719
2720 Returns the blue intensity at the given coordinate.
2721 """
d55e5bfc
RD		 2722 return _core_.Image_GetBlue(*args, **kwargs)
2723
2724 def SetAlpha(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2732 return _core_.Image_SetAlpha(*args, **kwargs)
2733
2734 def GetAlpha(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2746 return _core_.Image_GetAlpha(*args, **kwargs)
2747
2748 def HasAlpha(*args, **kwargs):
7a27cf7c
RD		 2749 """
2750 HasAlpha(self) -> bool
2751
2752 Returns true if this image has alpha channel, false otherwise.
2753 """
d55e5bfc
RD		 2754 return _core_.Image_HasAlpha(*args, **kwargs)
2755
68350608
RD		 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
57133d5c
RD		 2767 def IsTransparent(*args, **kwargs):
2768 """
7a27cf7c 2769 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
57133d5c 2770
7a27cf7c
RD		 2771 Returns ``True`` if this pixel is masked or has an alpha value less
2772 than the spcified threshold.
57133d5c
RD		 2773 """
2774 return _core_.Image_IsTransparent(*args, **kwargs)
2775
d55e5bfc 2776 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 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 """
d55e5bfc
RD		 2784 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2785
4cf4100f
RD		 2786 def ConvertAlphaToMask(*args, **kwargs):
2787 """
57133d5c 2788 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2789
7a27cf7c
RD		 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`.
4cf4100f
RD		 2794
2795 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2796 nothing.
2797 """
2798 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2799
8fb0e70a
RD		 2800 def ConvertColourToAlpha(*args, **kwargs):
2801 """
7a27cf7c 2802 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD		 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
d55e5bfc 2814 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2831 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2832
2833 def CanRead(*args, **kwargs):
7a27cf7c
RD		 2834 """
2835 CanRead(String filename) -> bool
2836
2837 Returns True if the image handlers can read this file.
2838 """
d55e5bfc
RD		 2839 return _core_.Image_CanRead(*args, **kwargs)
2840
2841 CanRead = staticmethod(CanRead)
2842 def GetImageCount(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2850 return _core_.Image_GetImageCount(*args, **kwargs)
2851
2852 GetImageCount = staticmethod(GetImageCount)
2853 def LoadFile(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2860 return _core_.Image_LoadFile(*args, **kwargs)
2861
2862 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2869 return _core_.Image_LoadMimeFile(*args, **kwargs)
2870
2871 def SaveFile(*args, **kwargs):
7a27cf7c
RD		 2872 """
2873 SaveFile(self, String name, int type) -> bool
2874
2875 Saves an image in the named file.
2876 """
d55e5bfc
RD		 2877 return _core_.Image_SaveFile(*args, **kwargs)
2878
2879 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD		 2880 """
2881 SaveMimeFile(self, String name, String mimetype) -> bool
2882
2883 Saves an image in the named file.
2884 """
d55e5bfc
RD		 2885 return _core_.Image_SaveMimeFile(*args, **kwargs)
2886
2887 def CanReadStream(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2895 return _core_.Image_CanReadStream(*args, **kwargs)
2896
2897 CanReadStream = staticmethod(CanReadStream)
2898 def LoadStream(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2906 return _core_.Image_LoadStream(*args, **kwargs)
2907
2908 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2915 return _core_.Image_LoadMimeStream(*args, **kwargs)
2916
b39fe951 2917 def IsOk(*args, **kwargs):
7a27cf7c 2918 """
b39fe951 2919 IsOk(self) -> bool
7a27cf7c
RD		 2920
2921 Returns true if image data is present.
2922 """
b39fe951 2923 return _core_.Image_IsOk(*args, **kwargs)
d55e5bfc 2924
b39fe951 2925 Ok = IsOk
d55e5bfc 2926 def GetWidth(*args, **kwargs):
7a27cf7c
RD		 2927 """
2928 GetWidth(self) -> int
2929
2930 Gets the width of the image in pixels.
2931 """
d55e5bfc
RD		 2932 return _core_.Image_GetWidth(*args, **kwargs)
2933
2934 def GetHeight(*args, **kwargs):
7a27cf7c
RD		 2935 """
2936 GetHeight(self) -> int
2937
2938 Gets the height of the image in pixels.
2939 """
d55e5bfc
RD		 2940 return _core_.Image_GetHeight(*args, **kwargs)
2941
2942 def GetSize(*args, **kwargs):
7a27cf7c
RD		 2943 """
2944 GetSize(self) -> Size
2945
2946 Returns the size of the image in pixels.
2947 """
d55e5bfc
RD		 2948 return _core_.Image_GetSize(*args, **kwargs)
2949
2950 def GetSubImage(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2957 return _core_.Image_GetSubImage(*args, **kwargs)
2958
aff4cc5c 2959 def Size(*args, **kwargs):
7a27cf7c
RD		 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 """
aff4cc5c
RD		 2971 return _core_.Image_Size(*args, **kwargs)
2972
d55e5bfc 2973 def Copy(*args, **kwargs):
7a27cf7c
RD		 2974 """
2975 Copy(self) -> Image
2976
2977 Returns an identical copy of the image.
2978 """
d55e5bfc
RD		 2979 return _core_.Image_Copy(*args, **kwargs)
2980
2981 def Paste(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 2988 return _core_.Image_Paste(*args, **kwargs)
2989
2990 def GetData(*args, **kwargs):
ea939623
RD		 2991 """
2992 GetData(self) -> PyObject
2993
2994 Returns a string containing a copy of the RGB bytes of the image.
2995 """
d55e5bfc
RD		 2996 return _core_.Image_GetData(*args, **kwargs)
2997
2998 def SetData(*args, **kwargs):
ea939623
RD		 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 """
d55e5bfc
RD		 3006 return _core_.Image_SetData(*args, **kwargs)
3007
3008 def GetDataBuffer(*args, **kwargs):
ea939623
RD		 3009 """
3010 GetDataBuffer(self) -> PyObject
3011
3012 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD		 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.
ea939623 3015 """
d55e5bfc
RD		 3016 return _core_.Image_GetDataBuffer(*args, **kwargs)
3017
3018 def SetDataBuffer(*args, **kwargs):
ea939623
RD		 3019 """
3020 SetDataBuffer(self, buffer data)
3021
3022 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD		 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.
ea939623 3025 """
d55e5bfc
RD		 3026 return _core_.Image_SetDataBuffer(*args, **kwargs)
3027
3028 def GetAlphaData(*args, **kwargs):
ea939623
RD		 3029 """
3030 GetAlphaData(self) -> PyObject
3031
3032 Returns a string containing a copy of the alpha bytes of the image.
3033 """
d55e5bfc
RD		 3034 return _core_.Image_GetAlphaData(*args, **kwargs)
3035
3036 def SetAlphaData(*args, **kwargs):
ea939623
RD		 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 """
d55e5bfc
RD		 3044 return _core_.Image_SetAlphaData(*args, **kwargs)
3045
3046 def GetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 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 """
d55e5bfc
RD		 3054 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
3055
3056 def SetAlphaBuffer(*args, **kwargs):
fc46b7f3
RD		 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 """
d55e5bfc
RD		 3064 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
3065
3066 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3073 return _core_.Image_SetMaskColour(*args, **kwargs)
3074
aff4cc5c
RD		 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
d55e5bfc 3083 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD		 3084 """
3085 GetMaskRed(self) -> byte
3086
3087 Gets the red component of the mask colour.
3088 """
d55e5bfc
RD		 3089 return _core_.Image_GetMaskRed(*args, **kwargs)
3090
3091 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD		 3092 """
3093 GetMaskGreen(self) -> byte
3094
3095 Gets the green component of the mask colour.
3096 """
d55e5bfc
RD		 3097 return _core_.Image_GetMaskGreen(*args, **kwargs)
3098
3099 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD		 3100 """
3101 GetMaskBlue(self) -> byte
3102
3103 Gets the blue component of the mask colour.
3104 """
d55e5bfc
RD		 3105 return _core_.Image_GetMaskBlue(*args, **kwargs)
3106
3107 def SetMask(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3114 return _core_.Image_SetMask(*args, **kwargs)
3115
3116 def HasMask(*args, **kwargs):
7a27cf7c
RD		 3117 """
3118 HasMask(self) -> bool
3119
3120 Returns ``True`` if there is a mask active, ``False`` otherwise.
3121 """
d55e5bfc
RD		 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
7a27cf7c
RD		 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.
d55e5bfc
RD		 3136 """
3137 return _core_.Image_Rotate(*args, **kwargs)
3138
3139 def Rotate90(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3146 return _core_.Image_Rotate90(*args, **kwargs)
3147
3148 def Mirror(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3155 return _core_.Image_Mirror(*args, **kwargs)
3156
3157 def Replace(*args, **kwargs):
3158 """
7a27cf7c
RD		 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)``.
d55e5bfc
RD		 3163 """
3164 return _core_.Image_Replace(*args, **kwargs)
3165
7449af73
RD		 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
d55e5bfc 3176 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3184 return _core_.Image_ConvertToMono(*args, **kwargs)
3185
3186 def SetOption(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3194 return _core_.Image_SetOption(*args, **kwargs)
3195
3196 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD		 3197 """
3198 SetOptionInt(self, String name, int value)
3199
3200 Sets an image option as an integer.
3201 """
d55e5bfc
RD		 3202 return _core_.Image_SetOptionInt(*args, **kwargs)
3203
3204 def GetOption(*args, **kwargs):
7a27cf7c
RD		 3205 """
3206 GetOption(self, String name) -> String
3207
3208 Gets the value of an image handler option.
3209 """
d55e5bfc
RD		 3210 return _core_.Image_GetOption(*args, **kwargs)
3211
3212 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3219 return _core_.Image_GetOptionInt(*args, **kwargs)
3220
3221 def HasOption(*args, **kwargs):
7a27cf7c
RD		 3222 """
3223 HasOption(self, String name) -> bool
3224
3225 Returns true if the given option is present.
3226 """
d55e5bfc
RD		 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):
c24da6d6 3238 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD		 3239 return _core_.Image_AddHandler(*args, **kwargs)
3240
3241 AddHandler = staticmethod(AddHandler)
3242 def InsertHandler(*args, **kwargs):
c24da6d6 3243 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD		 3244 return _core_.Image_InsertHandler(*args, **kwargs)
3245
3246 InsertHandler = staticmethod(InsertHandler)
3247 def RemoveHandler(*args, **kwargs):
c24da6d6 3248 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD		 3249 return _core_.Image_RemoveHandler(*args, **kwargs)
3250
3251 RemoveHandler = staticmethod(RemoveHandler)
554f62e9
RD		 3252 def GetHandlers(*args, **kwargs):
3253 """GetHandlers() -> PyObject"""
3254 return _core_.Image_GetHandlers(*args, **kwargs)
3255
3256 GetHandlers = staticmethod(GetHandlers)
d55e5bfc 3257 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc
RD		 3265 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3266
3267 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3268 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3269 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD		 3270 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3271
3272 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3273 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
d55e5bfc
RD		 3274 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3275
2f91e3df
KO		 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):
9d7dfdff
RD		 3286 """
3287 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3288
3289 Converts a color in RGB color space to HSV color space.
3290 """
2f91e3df
KO		 3291 return _core_.Image_RGBtoHSV(*args, **kwargs)
3292
3293 RGBtoHSV = staticmethod(RGBtoHSV)
3294 def HSVtoRGB(*args, **kwargs):
9d7dfdff
RD		 3295 """
3296 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3297
3298 Converts a color in HSV color space to RGB color space.
3299 """
2f91e3df
KO		 3300 return _core_.Image_HSVtoRGB(*args, **kwargs)
3301
3302 HSVtoRGB = staticmethod(HSVtoRGB)
b39fe951 3303 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD		 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`")
97ab0f6a 3312 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 3313_core_.Image_swigregister(Image)
d55e5bfc
RD		 3314
3315def ImageFromMime(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc 3322 val = _core_.new_ImageFromMime(*args, **kwargs)
d55e5bfc
RD		 3323 return val
3324
3325def ImageFromStream(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc 3332 val = _core_.new_ImageFromStream(*args, **kwargs)
d55e5bfc
RD		 3333 return val
3334
3335def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD		 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 """
d55e5bfc 3342 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d55e5bfc
RD		 3343 return val
3344
c24da6d6 3345def EmptyImage(*args, **kwargs):
ea939623
RD		 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 """
c24da6d6 3352 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD		 3353 return val
3354
3355def ImageFromBitmap(*args, **kwargs):
ea939623
RD		 3356 """
3357 ImageFromBitmap(Bitmap bitmap) -> Image
3358
3359 Construct an Image from a `wx.Bitmap`.
3360 """
d55e5bfc 3361 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d55e5bfc
RD		 3362 return val
3363
3364def ImageFromData(*args, **kwargs):
ea939623
RD		 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 """
d55e5bfc 3372 val = _core_.new_ImageFromData(*args, **kwargs)
d55e5bfc
RD		 3373 return val
3374
c9c2cf70 3375def ImageFromDataWithAlpha(*args, **kwargs):
ea939623
RD		 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
7a27cf7c
RD		 3381 length of the data must be width*height*3 bytes, and the length of the
3382 alpha data must be width*height bytes.
ea939623 3383 """
c9c2cf70 3384 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
c9c2cf70
RD		 3385 return val
3386
d55e5bfc 3387def Image_CanRead(*args, **kwargs):
554f62e9 3388 """
7a27cf7c
RD		 3389 Image_CanRead(String filename) -> bool
3390
3391 Returns True if the image handlers can read this file.
3392 """
554f62e9 3393 return _core_.Image_CanRead(*args, **kwargs)
d55e5bfc
RD		 3394
3395def Image_GetImageCount(*args, **kwargs):
554f62e9 3396 """
7a27cf7c
RD		 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 """
554f62e9 3403 return _core_.Image_GetImageCount(*args, **kwargs)
d55e5bfc
RD		 3404
3405def Image_CanReadStream(*args, **kwargs):
554f62e9 3406 """
7a27cf7c
RD		 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 """
554f62e9 3413 return _core_.Image_CanReadStream(*args, **kwargs)
d55e5bfc
RD		 3414
3415def Image_AddHandler(*args, **kwargs):
554f62e9
RD		 3416 """Image_AddHandler(ImageHandler handler)"""
3417 return _core_.Image_AddHandler(*args, **kwargs)
d55e5bfc
RD		 3418
3419def Image_InsertHandler(*args, **kwargs):
554f62e9
RD		 3420 """Image_InsertHandler(ImageHandler handler)"""
3421 return _core_.Image_InsertHandler(*args, **kwargs)
d55e5bfc
RD		 3422
3423def Image_RemoveHandler(*args, **kwargs):
554f62e9
RD		 3424 """Image_RemoveHandler(String name) -> bool"""
3425 return _core_.Image_RemoveHandler(*args, **kwargs)
d55e5bfc 3426
554f62e9
RD		 3427def Image_GetHandlers(*args):
3428 """Image_GetHandlers() -> PyObject"""
3429 return _core_.Image_GetHandlers(*args)
3430
3431def Image_GetImageExtWildcard(*args):
3432 """
7a27cf7c
RD		 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 """
554f62e9 3439 return _core_.Image_GetImageExtWildcard(*args)
d55e5bfc 3440
2f91e3df 3441def Image_RGBtoHSV(*args, **kwargs):
554f62e9 3442 """
9d7dfdff
RD		 3443 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3444
3445 Converts a color in RGB color space to HSV color space.
3446 """
554f62e9 3447 return _core_.Image_RGBtoHSV(*args, **kwargs)
2f91e3df
KO		 3448
3449def Image_HSVtoRGB(*args, **kwargs):
554f62e9 3450 """
9d7dfdff
RD		 3451 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3452
3453 Converts a color in HSV color space to RGB color space.
3454 """
554f62e9 3455 return _core_.Image_HSVtoRGB(*args, **kwargs)
2f91e3df 3456
fc46b7f3
RD		 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
eec1c382
RD		 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.
fc46b7f3
RD		 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 """
fc46b7f3
RD		 3486 image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer)
3487 image._buffer = dataBuffer
3488 image._alpha = alphaBuffer
3489 return image
3490
a07a67e6
RD		 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
d55e5bfc 3497
d55e5bfc
RD		 3498IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3499IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD		 3500PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3501PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3502PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD		 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):
27fb7603 3513 """A `wx.ImageHandler` for \*.bmp bitmap files."""
554f62e9
RD		 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):
27fb7603
RD		 3517 """
3518 __init__(self) -> BMPHandler
3519
3520 A `wx.ImageHandler` for \*.bmp bitmap files.
3521 """
554f62e9 3522 _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
2131d850 3523_core_.BMPHandler_swigregister(BMPHandler)
d55e5bfc 3524NullImage = cvar.NullImage
68350608 3525IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD		 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
68350608
RD		 3530IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3531IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3532IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3533IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD		 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
b9d6a5f3
RD		 3538IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3539IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD		 3540
3541class ICOHandler(BMPHandler):
27fb7603 3542 """A `wx.ImageHandler` for \*.ico icon files."""
554f62e9
RD		 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):
27fb7603
RD		 3546 """
3547 __init__(self) -> ICOHandler
3548
3549 A `wx.ImageHandler` for \*.ico icon files.
3550 """
554f62e9 3551 _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
2131d850 3552_core_.ICOHandler_swigregister(ICOHandler)
d55e5bfc
RD		 3553
3554class CURHandler(ICOHandler):
27fb7603 3555 """A `wx.ImageHandler` for \*.cur cursor files."""
554f62e9
RD		 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):
27fb7603
RD		 3559 """
3560 __init__(self) -> CURHandler
3561
3562 A `wx.ImageHandler` for \*.cur cursor files.
3563 """
554f62e9 3564 _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
2131d850 3565_core_.CURHandler_swigregister(CURHandler)
d55e5bfc
RD		 3566
3567class ANIHandler(CURHandler):
27fb7603 3568 """A `wx.ImageHandler` for \*.ani animated cursor files."""
554f62e9
RD		 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):
27fb7603
RD		 3572 """
3573 __init__(self) -> ANIHandler
3574
3575 A `wx.ImageHandler` for \*.ani animated cursor files.
3576 """
554f62e9 3577 _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
2131d850 3578_core_.ANIHandler_swigregister(ANIHandler)
d55e5bfc
RD		 3579
3580class PNGHandler(ImageHandler):
27fb7603 3581 """A `wx.ImageHandler` for PNG image files."""
554f62e9
RD		 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):
27fb7603
RD		 3585 """
3586 __init__(self) -> PNGHandler
3587
3588 A `wx.ImageHandler` for PNG image files.
3589 """
554f62e9 3590 _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
2131d850 3591_core_.PNGHandler_swigregister(PNGHandler)
d55e5bfc
RD		 3592
3593class GIFHandler(ImageHandler):
27fb7603 3594 """A `wx.ImageHandler` for GIF image files."""
554f62e9
RD		 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):
27fb7603
RD		 3598 """
3599 __init__(self) -> GIFHandler
3600
3601 A `wx.ImageHandler` for GIF image files.
3602 """
554f62e9 3603 _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
2131d850 3604_core_.GIFHandler_swigregister(GIFHandler)
d55e5bfc
RD		 3605
3606class PCXHandler(ImageHandler):
27fb7603 3607 """A `wx.ImageHandler` for PCX imager files."""
554f62e9
RD		 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):
27fb7603
RD		 3611 """
3612 __init__(self) -> PCXHandler
3613
3614 A `wx.ImageHandler` for PCX imager files.
3615 """
554f62e9 3616 _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
2131d850 3617_core_.PCXHandler_swigregister(PCXHandler)
d55e5bfc
RD		 3618
3619class JPEGHandler(ImageHandler):
27fb7603 3620 """A `wx.ImageHandler` for JPEG/JPG image files."""
554f62e9
RD		 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):
27fb7603
RD		 3624 """
3625 __init__(self) -> JPEGHandler
3626
3627 A `wx.ImageHandler` for JPEG/JPG image files.
3628 """
554f62e9 3629 _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
2131d850 3630_core_.JPEGHandler_swigregister(JPEGHandler)
d55e5bfc
RD		 3631
3632class PNMHandler(ImageHandler):
27fb7603 3633 """A `wx.ImageHandler` for PNM image files."""
554f62e9
RD		 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):
27fb7603
RD		 3637 """
3638 __init__(self) -> PNMHandler
3639
3640 A `wx.ImageHandler` for PNM image files.
3641 """
554f62e9 3642 _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
2131d850 3643_core_.PNMHandler_swigregister(PNMHandler)
d55e5bfc
RD		 3644
3645class XPMHandler(ImageHandler):
27fb7603 3646 """A `wx.ImageHandler` for XPM image."""
554f62e9
RD		 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):
27fb7603
RD		 3650 """
3651 __init__(self) -> XPMHandler
3652
3653 A `wx.ImageHandler` for XPM image.
3654 """
554f62e9 3655 _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
2131d850 3656_core_.XPMHandler_swigregister(XPMHandler)
d55e5bfc
RD		 3657
3658class TIFFHandler(ImageHandler):
27fb7603 3659 """A `wx.ImageHandler` for TIFF image files."""
554f62e9
RD		 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):
27fb7603
RD		 3663 """
3664 __init__(self) -> TIFFHandler
3665
3666 A `wx.ImageHandler` for TIFF image files.
3667 """
554f62e9 3668 _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
2131d850 3669_core_.TIFFHandler_swigregister(TIFFHandler)
d55e5bfc 3670
580080c5
RD		 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
c0de73ae
RD		 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."""
554f62e9
RD		 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
c0de73ae
RD		 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)
2131d850 3702_core_.Quantize_swigregister(Quantize)
c0de73ae
RD		 3703
3704def Quantize_Quantize(*args, **kwargs):
554f62e9 3705 """
c0de73ae
RD		 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 """
554f62e9 3712 return _core_.Quantize_Quantize(*args, **kwargs)
c0de73ae 3713
d55e5bfc
RD		 3714#---------------------------------------------------------------------------
3715
3716class EvtHandler(Object):
093d3ff1 3717 """Proxy of C++ EvtHandler class"""
554f62e9
RD		 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):
d55e5bfc 3721 """__init__(self) -> EvtHandler"""
554f62e9 3722 _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
d49bdf34
RD		 3723 self._setOORInfo(self)
3724
d55e5bfc
RD		 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):
f460c29d 3766 """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool"""
d55e5bfc
RD		 3767 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3768
3769 def _setOORInfo(*args, **kwargs):
093d3ff1 3770 """_setOORInfo(self, PyObject _self, bool incref=True)"""
7e08d4ef
RD		 3771 val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
3772 args[0].thisown = 0
3773 return val
d55e5bfc
RD		 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
caef1a4d
RD		 3779 :param event: One of the EVT_* objects that specifies the
3780 type of event to bind,
d55e5bfc 3781
caef1a4d
RD		 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.
d55e5bfc 3785
caef1a4d
RD		 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.
d55e5bfc 3794
caef1a4d
RD		 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.
d55e5bfc
RD		 3800 """
3801 if source is not None:
3802 id = source.GetId()
3803 event.Bind(self, id, id2, handler)
3804
c24da6d6
RD		 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)
d55e5bfc 3813
97ab0f6a
RD		 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`")
2131d850 3817_core_.EvtHandler_swigregister(EvtHandler)
d55e5bfc
RD		 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
c24da6d6
RD		 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
d55e5bfc
RD		 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
554f62e9 3891def NewEventType(*args):
f460c29d 3892 """NewEventType() -> EventType"""
554f62e9 3893 return _core_.NewEventType(*args)
d55e5bfc
RD		 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
db67f999
RD		 3956wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3957wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
d55e5bfc
RD		 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
d55e5bfc
RD		 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
0f83f5da 3979wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST
d55e5bfc
RD		 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
88c6b281 4002wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
2131d850
RD		 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
d55e5bfc
RD		 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 )
704eda0c 4028EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
d55e5bfc
RD		 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 )
704eda0c 4039EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD		 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 )
0f83f5da 4056EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST )
d55e5bfc
RD		 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)
704eda0c 4089EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
d55e5bfc
RD		 4090 wxEVT_SCROLLWIN_BOTTOM,
4091 wxEVT_SCROLLWIN_LINEUP,
4092 wxEVT_SCROLLWIN_LINEDOWN,
704eda0c 4093 wxEVT_SCROLLWIN_PAGEUP,
d55e5bfc
RD		 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
27fb7603 4108# Scrolling from wx.Slider and wx.ScrollBar
704eda0c
RD		 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,
db67f999 4117 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 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 )
db67f999
RD		 4128EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
4129EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
704eda0c 4130
27fb7603 4131# Scrolling from wx.Slider and wx.ScrollBar, with an id
704eda0c
RD		 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,
d55e5bfc 4139 wxEVT_SCROLL_THUMBRELEASE,
db67f999 4140 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD		 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)
db67f999
RD		 4151EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
4152EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD		 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
2131d850
RD		 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 )
d55e5bfc
RD		 4194
4195
4196#---------------------------------------------------------------------------
4197
4198class Event(Object):
27fb7603
RD		 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 """
554f62e9
RD		 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;
d55e5bfc 4209 def SetEventType(*args, **kwargs):
27fb7603 4210 """
f460c29d 4211 SetEventType(self, EventType typ)
27fb7603
RD		 4212
4213 Sets the specific type of the event.
4214 """
d55e5bfc
RD		 4215 return _core_.Event_SetEventType(*args, **kwargs)
4216
4217 def GetEventType(*args, **kwargs):
27fb7603 4218 """
f460c29d 4219 GetEventType(self) -> EventType
27fb7603
RD		 4220
4221 Returns the identifier of the given event type, such as
4222 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4223 """
d55e5bfc
RD		 4224 return _core_.Event_GetEventType(*args, **kwargs)
4225
4226 def GetEventObject(*args, **kwargs):
27fb7603
RD		 4227 """
4228 GetEventObject(self) -> Object
4229
4230 Returns the object (usually a window) associated with the event, if
4231 any.
4232 """
d55e5bfc
RD		 4233 return _core_.Event_GetEventObject(*args, **kwargs)
4234
4235 def SetEventObject(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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):
27fb7603
RD		 4253 """
4254 GetId(self) -> int
4255
4256 Returns the identifier associated with this event, such as a button
4257 command id.
4258 """
d55e5bfc
RD		 4259 return _core_.Event_GetId(*args, **kwargs)
4260
4261 def SetId(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4269 return _core_.Event_SetId(*args, **kwargs)
4270
4271 def IsCommandEvent(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4278 return _core_.Event_IsCommandEvent(*args, **kwargs)
4279
4280 def Skip(*args, **kwargs):
51b83b37
RD		 4281 """
4282 Skip(self, bool skip=True)
4283
6b449b19
RD		 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.
51b83b37 4291 """
d55e5bfc
RD		 4292 return _core_.Event_Skip(*args, **kwargs)
4293
4294 def GetSkipped(*args, **kwargs):
27fb7603
RD		 4295 """
4296 GetSkipped(self) -> bool
4297
4298 Returns true if the event handler should be skipped, false otherwise.
4299 :see: `Skip`
4300 """
d55e5bfc
RD		 4301 return _core_.Event_GetSkipped(*args, **kwargs)
4302
4303 def ShouldPropagate(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4310 return _core_.Event_ShouldPropagate(*args, **kwargs)
4311
4312 def StopPropagation(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4320 return _core_.Event_StopPropagation(*args, **kwargs)
4321
4322 def ResumePropagation(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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
97ab0f6a
RD		 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`")
2131d850 4342_core_.Event_swigregister(Event)
d55e5bfc
RD		 4343
4344#---------------------------------------------------------------------------
4345
4346class PropagationDisabler(object):
27fb7603
RD		 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 """
554f62e9
RD		 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):
27fb7603
RD		 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 """
554f62e9
RD		 4362 _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
4363 __swig_destroy__ = _core_.delete_PropagationDisabler
4364 __del__ = lambda self : None;
2131d850 4365_core_.PropagationDisabler_swigregister(PropagationDisabler)
d55e5bfc
RD		 4366
4367class PropagateOnce(object):
27fb7603
RD		 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 """
554f62e9
RD		 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):
27fb7603
RD		 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 """
554f62e9
RD		 4383 _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
4384 __swig_destroy__ = _core_.delete_PropagateOnce
4385 __del__ = lambda self : None;
2131d850 4386_core_.PropagateOnce_swigregister(PropagateOnce)
d55e5bfc
RD		 4387
4388#---------------------------------------------------------------------------
4389
4390class CommandEvent(Event):
27fb7603
RD		 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 """
554f62e9
RD		 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):
27fb7603 4399 """
f460c29d 4400 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
27fb7603
RD		 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 """
554f62e9 4406 _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
d55e5bfc 4407 def GetSelection(*args, **kwargs):
27fb7603
RD		 4408 """
4409 GetSelection(self) -> int
4410
4411 Returns item index for a listbox or choice selection event (not valid
4412 for a deselection).
4413 """
d55e5bfc
RD		 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):
27fb7603
RD		 4421 """
4422 GetString(self) -> String
4423
4424 Returns item string for a listbox or choice selection event (not valid
4425 for a deselection).
4426 """
d55e5bfc
RD		 4427 return _core_.CommandEvent_GetString(*args, **kwargs)
4428
4429 def IsChecked(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4439 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4440
4441 Checked = IsChecked
4442 def IsSelection(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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):
27fb7603
RD		 4456 """
4457 GetExtraLong(self) -> long
4458
5ba5649b
RD		 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.
27fb7603 4465 """
d55e5bfc
RD		 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):
27fb7603 4473 """
f460c29d 4474 GetInt(self) -> int
27fb7603 4475
5ba5649b
RD		 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.
27fb7603 4479 """
d55e5bfc
RD		 4480 return _core_.CommandEvent_GetInt(*args, **kwargs)
4481
554f62e9
RD		 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
d55e5bfc
RD		 4501 def Clone(*args, **kwargs):
4502 """Clone(self) -> Event"""
4503 return _core_.CommandEvent_Clone(*args, **kwargs)
4504
226118fc
RD		 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`")
2131d850 4511_core_.CommandEvent_swigregister(CommandEvent)
d55e5bfc
RD		 4512
4513#---------------------------------------------------------------------------
4514
4515class NotifyEvent(CommandEvent):
27fb7603
RD		 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 """
554f62e9
RD		 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):
27fb7603 4525 """
f460c29d 4526 __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
27fb7603
RD		 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 """
554f62e9 4533 _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
d55e5bfc 4534 def Veto(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4544 return _core_.NotifyEvent_Veto(*args, **kwargs)
4545
4546 def Allow(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4555 return _core_.NotifyEvent_Allow(*args, **kwargs)
4556
4557 def IsAllowed(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4564 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4565
2131d850 4566_core_.NotifyEvent_swigregister(NotifyEvent)
d55e5bfc
RD		 4567
4568#---------------------------------------------------------------------------
4569
4570class ScrollEvent(CommandEvent):
27fb7603
RD		 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 """
554f62e9
RD		 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):
d55e5bfc 4580 """
f460c29d 4581 __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0,
d55e5bfc
RD		 4582 int orient=0) -> ScrollEvent
4583 """
554f62e9 4584 _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
d55e5bfc 4585 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4586 """
4587 GetOrientation(self) -> int
4588
4589 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4590 the scrollbar.
4591 """
d55e5bfc
RD		 4592 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4593
4594 def GetPosition(*args, **kwargs):
27fb7603
RD		 4595 """
4596 GetPosition(self) -> int
4597
4598 Returns the position of the scrollbar.
4599 """
d55e5bfc
RD		 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
33d6fd3b
RD		 4610 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4611 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4612_core_.ScrollEvent_swigregister(ScrollEvent)
d55e5bfc
RD		 4613
4614#---------------------------------------------------------------------------
4615
4616class ScrollWinEvent(Event):
27fb7603
RD		 4617 """
4618 A wx.ScrollWinEvent holds information about scrolling and is sent from
4619 scrolling windows.
4620 """
554f62e9
RD		 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):
27fb7603 4624 """
f460c29d 4625 __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
27fb7603
RD		 4626
4627 A wx.ScrollWinEvent holds information about scrolling and is sent from
4628 scrolling windows.
4629 """
554f62e9 4630 _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
d55e5bfc 4631 def GetOrientation(*args, **kwargs):
27fb7603
RD		 4632 """
4633 GetOrientation(self) -> int
4634
4635 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4636 the scrollbar.
4637 """
d55e5bfc
RD		 4638 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4639
4640 def GetPosition(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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
33d6fd3b
RD		 4658 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
4659 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 4660_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
d55e5bfc
RD		 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):
27fb7603
RD		 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 """
554f62e9
RD		 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):
27fb7603 4694 """
f460c29d 4695 __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent
27fb7603
RD		 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 """
554f62e9 4713 _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
d55e5bfc 4714 def IsButton(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4721 return _core_.MouseEvent_IsButton(*args, **kwargs)
4722
4723 def ButtonDown(*args, **kwargs):
27fb7603
RD		 4724 """
4725 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4726
5ba5649b
RD		 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).
27fb7603 4731 """
d55e5bfc
RD		 4732 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4733
4734 def ButtonDClick(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4743 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4744
4745 def ButtonUp(*args, **kwargs):
27fb7603
RD		 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
5ba5649b
RD		 4750 mouse button up event. Otherwise the argument specifies which button
4751 up event to check for (see `Button` for the possible values).
27fb7603 4752 """
d55e5bfc
RD		 4753 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4754
4755 def Button(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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):
27fb7603
RD		 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 """
d55e5bfc
RD		 4787 return _core_.MouseEvent_GetButton(*args, **kwargs)
4788
4789 def ControlDown(*args, **kwargs):
27fb7603
RD		 4790 """
4791 ControlDown(self) -> bool
4792
4793 Returns true if the control key was down at the time of the event.
4794 """
d55e5bfc
RD		 4795 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4796
4797 def MetaDown(*args, **kwargs):
27fb7603
RD		 4798 """
4799 MetaDown(self) -> bool
4800
4801 Returns true if the Meta key was down at the time of the event.
4802 """
d55e5bfc
RD		 4803 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4804
4805 def AltDown(*args, **kwargs):
27fb7603
RD		 4806 """
4807 AltDown(self) -> bool
4808
4809 Returns true if the Alt key was down at the time of the event.
4810 """
d55e5bfc
RD		 4811 return _core_.MouseEvent_AltDown(*args, **kwargs)
4812
4813 def ShiftDown(*args, **kwargs):
27fb7603
RD		 4814 """
4815 ShiftDown(self) -> bool
4816
4817 Returns true if the Shift key was down at the time of the event.
4818 """
d55e5bfc
RD		 4819 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4820
412d302d
RD		 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
5ba5649b 4827 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4828 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4829 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD		 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
d55e5bfc 4835 def LeftDown(*args, **kwargs):
27fb7603
RD		 4836 """
4837 LeftDown(self) -> bool
4838
4839 Returns true if the left mouse button state changed to down.
4840 """
d55e5bfc
RD		 4841 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4842
4843 def MiddleDown(*args, **kwargs):
27fb7603
RD		 4844 """
4845 MiddleDown(self) -> bool
4846
4847 Returns true if the middle mouse button state changed to down.
4848 """
d55e5bfc
RD		 4849 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4850
4851 def RightDown(*args, **kwargs):
27fb7603
RD		 4852 """
4853 RightDown(self) -> bool
4854
4855 Returns true if the right mouse button state changed to down.
4856 """
d55e5bfc
RD		 4857 return _core_.MouseEvent_RightDown(*args, **kwargs)
4858
4859 def LeftUp(*args, **kwargs):
27fb7603
RD		 4860 """
4861 LeftUp(self) -> bool
4862
4863 Returns true if the left mouse button state changed to up.
4864 """
d55e5bfc
RD		 4865 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4866
4867 def MiddleUp(*args, **kwargs):
27fb7603
RD		 4868 """
4869 MiddleUp(self) -> bool
4870
4871 Returns true if the middle mouse button state changed to up.
4872 """
d55e5bfc
RD		 4873 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4874
4875 def RightUp(*args, **kwargs):
27fb7603
RD		 4876 """
4877 RightUp(self) -> bool
4878
4879 Returns true if the right mouse button state changed to up.
4880 """
d55e5bfc
RD		 4881 return _core_.MouseEvent_RightUp(*args, **kwargs)
4882
4883 def LeftDClick(*args, **kwargs):
27fb7603
RD		 4884 """
4885 LeftDClick(self) -> bool
4886
4887 Returns true if the event was a left button double click.
4888 """
d55e5bfc
RD		 4889 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4890
4891 def MiddleDClick(*args, **kwargs):
27fb7603
RD		 4892 """
4893 MiddleDClick(self) -> bool
4894
4895 Returns true if the event was a middle button double click.
4896 """
d55e5bfc
RD		 4897 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4898
4899 def RightDClick(*args, **kwargs):
27fb7603
RD		 4900 """
4901 RightDClick(self) -> bool
4902
4903 Returns true if the event was a right button double click.
4904 """
d55e5bfc
RD		 4905 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4906
4907 def LeftIsDown(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4922 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4923
4924 def MiddleIsDown(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4931 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4932
4933 def RightIsDown(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4940 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4941
4942 def Dragging(*args, **kwargs):
27fb7603
RD		 4943 """
4944 Dragging(self) -> bool
4945
4946 Returns true if this was a dragging event (motion while a button is
4947 depressed).
4948 """
d55e5bfc
RD		 4949 return _core_.MouseEvent_Dragging(*args, **kwargs)
4950
4951 def Moving(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 4959 return _core_.MouseEvent_Moving(*args, **kwargs)
4960
4961 def Entering(*args, **kwargs):
27fb7603
RD		 4962 """
4963 Entering(self) -> bool
4964
4965 Returns true if the mouse was entering the window.
4966 """
d55e5bfc
RD		 4967 return _core_.MouseEvent_Entering(*args, **kwargs)
4968
4969 def Leaving(*args, **kwargs):
27fb7603
RD		 4970 """
4971 Leaving(self) -> bool
4972
4973 Returns true if the mouse was leaving the window.
4974 """
d55e5bfc
RD		 4975 return _core_.MouseEvent_Leaving(*args, **kwargs)
4976
4977 def GetPosition(*args, **kwargs):
4978 """
4979 GetPosition(self) -> Point
4980
27fb7603
RD		 4981 Returns the pixel position of the mouse in window coordinates when the
4982 event happened.
d55e5bfc
RD		 4983 """
4984 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4985
4986 def GetPositionTuple(*args, **kwargs):
4987 """
4988 GetPositionTuple() -> (x,y)
4989
27fb7603
RD		 4990 Returns the pixel position of the mouse in window coordinates when the
4991 event happened.
d55e5bfc
RD		 4992 """
4993 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4994
4995 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 5003 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
5004
5005 def GetX(*args, **kwargs):
27fb7603
RD		 5006 """
5007 GetX(self) -> int
5008
5009 Returns X coordinate of the physical mouse event position.
5010 """
d55e5bfc
RD		 5011 return _core_.MouseEvent_GetX(*args, **kwargs)
5012
5013 def GetY(*args, **kwargs):
27fb7603
RD		 5014 """
5015 GetY(self) -> int
5016
5017 Returns Y coordinate of the physical mouse event position.
5018 """
d55e5bfc
RD		 5019 return _core_.MouseEvent_GetY(*args, **kwargs)
5020
5021 def GetWheelRotation(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 5033 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
5034
5035 def GetWheelDelta(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 5043 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
5044
5045 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 5052 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
5053
5054 def IsPageScroll(*args, **kwargs):
27fb7603
RD		 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 """
d55e5bfc
RD		 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)
57332a5a
RD		 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`")
2131d850 5083_core_.MouseEvent_swigregister(MouseEvent)
d55e5bfc
RD		 5084
5085#---------------------------------------------------------------------------
5086
5087class SetCursorEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 5098 """
5099 __init__(self, int x=0, int y=0) -> SetCursorEvent
5100
5101 Construct a new `wx.SetCursorEvent`.
5102 """
554f62e9 5103 _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
d55e5bfc 5104 def GetX(*args, **kwargs):
5ba5649b
RD		 5105 """
5106 GetX(self) -> int
5107
5108 Returns the X coordinate of the mouse in client coordinates.
5109 """
d55e5bfc
RD		 5110 return _core_.SetCursorEvent_GetX(*args, **kwargs)
5111
5112 def GetY(*args, **kwargs):
5ba5649b
RD		 5113 """
5114 GetY(self) -> int
5115
5116 Returns the Y coordinate of the mouse in client coordinates.
5117 """
d55e5bfc
RD		 5118 return _core_.SetCursorEvent_GetY(*args, **kwargs)
5119
5120 def SetCursor(*args, **kwargs):
5ba5649b
RD		 5121 """
5122 SetCursor(self, Cursor cursor)
5123
5124 Sets the cursor associated with this event.
5125 """
d55e5bfc
RD		 5126 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
5127
5128 def GetCursor(*args, **kwargs):
5ba5649b
RD		 5129 """
5130 GetCursor(self) -> Cursor
5131
5132 Returns a reference to the cursor specified by this event.
5133 """
d55e5bfc
RD		 5134 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
5135
5136 def HasCursor(*args, **kwargs):
5ba5649b
RD		 5137 """
5138 HasCursor(self) -> bool
5139
5140 Returns true if the cursor specified by this event is a valid cursor.
5141 """
d55e5bfc
RD		 5142 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
5143
33d6fd3b
RD		 5144 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
5145 X = property(GetX,doc="See `GetX`")
5146 Y = property(GetY,doc="See `GetY`")
2131d850 5147_core_.SetCursorEvent_swigregister(SetCursorEvent)
d55e5bfc
RD		 5148
5149#---------------------------------------------------------------------------
5150
5151class KeyEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 5217 """
f460c29d 5218 __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent
5ba5649b
RD		 5219
5220 Construct a new `wx.KeyEvent`. Valid event types are:
5221 *
5222 """
554f62e9 5223 _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
b1fcee84
RD		 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
d55e5bfc 5239 def ControlDown(*args, **kwargs):
5ba5649b
RD		 5240 """
5241 ControlDown(self) -> bool
5242
5243 Returns ``True`` if the Control key was down at the time of the event.
5244 """
d55e5bfc
RD		 5245 return _core_.KeyEvent_ControlDown(*args, **kwargs)
5246
5247 def MetaDown(*args, **kwargs):
5ba5649b
RD		 5248 """
5249 MetaDown(self) -> bool
5250
5251 Returns ``True`` if the Meta key was down at the time of the event.
5252 """
d55e5bfc
RD		 5253 return _core_.KeyEvent_MetaDown(*args, **kwargs)
5254
5255 def AltDown(*args, **kwargs):
5ba5649b
RD		 5256 """
5257 AltDown(self) -> bool
5258
5259 Returns ``True`` if the Alt key was down at the time of the event.
5260 """
d55e5bfc
RD		 5261 return _core_.KeyEvent_AltDown(*args, **kwargs)
5262
5263 def ShiftDown(*args, **kwargs):
5ba5649b
RD		 5264 """
5265 ShiftDown(self) -> bool
5266
5267 Returns ``True`` if the Shift key was down at the time of the event.
5268 """
d55e5bfc
RD		 5269 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5270
412d302d
RD		 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
5ba5649b 5277 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD		 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
d55e5bfc 5285 def HasModifiers(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5296 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5297
5298 def GetKeyCode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5312 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5313
19272049 5314 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD		 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 """
19272049 5321 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 5322
19272049 5323 GetUniChar = GetUnicodeKey
b850e7f3
RD		 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
d55e5bfc 5333 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5342 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5343
5344 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5352 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5353
5354 def GetPosition(*args, **kwargs):
5355 """
5356 GetPosition(self) -> Point
5357
5ba5649b 5358 Find the position of the event, if applicable.
d55e5bfc
RD		 5359 """
5360 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5361
5362 def GetPositionTuple(*args, **kwargs):
5363 """
5364 GetPositionTuple() -> (x,y)
5365
5ba5649b 5366 Find the position of the event, if applicable.
d55e5bfc
RD		 5367 """
5368 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5369
5370 def GetX(*args, **kwargs):
5ba5649b
RD		 5371 """
5372 GetX(self) -> int
5373
5374 Returns the X position (in client coordinates) of the event, if
5375 applicable.
5376 """
d55e5bfc
RD		 5377 return _core_.KeyEvent_GetX(*args, **kwargs)
5378
5379 def GetY(*args, **kwargs):
5ba5649b
RD		 5380 """
5381 GetY(self) -> int
5382
5383 Returns the Y position (in client coordinates) of the event, if
5384 applicable.
5385 """
d55e5bfc
RD		 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)
97ab0f6a
RD		 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`")
2131d850 5406_core_.KeyEvent_swigregister(KeyEvent)
d55e5bfc
RD		 5407
5408#---------------------------------------------------------------------------
5409
5410class SizeEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 5431 """
5432 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5433
5434 Construct a new ``wx.SizeEvent``.
5435 """
554f62e9 5436 _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
d55e5bfc 5437 def GetSize(*args, **kwargs):
5ba5649b
RD		 5438 """
5439 GetSize(self) -> Size
5440
5441 Returns the entire size of the window generating the size change
5442 event.
5443 """
d55e5bfc
RD		 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)
33d6fd3b
RD		 5460 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
5461 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
2131d850 5462_core_.SizeEvent_swigregister(SizeEvent)
d55e5bfc
RD		 5463
5464#---------------------------------------------------------------------------
5465
5466class MoveEvent(Event):
5ba5649b
RD		 5467 """
5468 This event object is sent for EVT_MOVE event bindings when a window is
5469 moved to a new position.
5470 """
554f62e9
RD		 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):
5ba5649b
RD		 5474 """
5475 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5476
5477 Constructor.
5478 """
554f62e9 5479 _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
d55e5bfc 5480 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5481 """
5482 GetPosition(self) -> Point
5483
5484 Returns the position of the window generating the move change event.
5485 """
d55e5bfc
RD		 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
fef4c27a
RD		 5500 m_pos = property(GetPosition, SetPosition)
5501 m_rect = property(GetRect, SetRect)
5502
57332a5a
RD		 5503 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
5504 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
2131d850 5505_core_.MoveEvent_swigregister(MoveEvent)
d55e5bfc
RD		 5506
5507#---------------------------------------------------------------------------
5508
5509class PaintEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
d55e5bfc 5528 """__init__(self, int Id=0) -> PaintEvent"""
554f62e9 5529 _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
2131d850 5530_core_.PaintEvent_swigregister(PaintEvent)
d55e5bfc
RD		 5531
5532class NcPaintEvent(Event):
093d3ff1 5533 """Proxy of C++ NcPaintEvent class"""
554f62e9
RD		 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):
d55e5bfc 5537 """__init__(self, int winid=0) -> NcPaintEvent"""
554f62e9 5538 _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
2131d850 5539_core_.NcPaintEvent_swigregister(NcPaintEvent)
d55e5bfc
RD		 5540
5541#---------------------------------------------------------------------------
5542
5543class EraseEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 5558 """
5559 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5560
5561 Constructor
5562 """
554f62e9 5563 _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
d55e5bfc 5564 def GetDC(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5572 return _core_.EraseEvent_GetDC(*args, **kwargs)
5573
97ab0f6a 5574 DC = property(GetDC,doc="See `GetDC`")
2131d850 5575_core_.EraseEvent_swigregister(EraseEvent)
d55e5bfc
RD		 5576
5577#---------------------------------------------------------------------------
5578
5579class FocusEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 5593 """
f460c29d 5594 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5ba5649b
RD		 5595
5596 Constructor
5597 """
554f62e9 5598 _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
d55e5bfc 5599 def GetWindow(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 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
97ab0f6a 5615 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 5616_core_.FocusEvent_swigregister(FocusEvent)
d55e5bfc
RD		 5617
5618#---------------------------------------------------------------------------
5619
5620class ChildFocusEvent(CommandEvent):
5ba5649b 5621 """
33d6fd3b
RD		 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.
5ba5649b 5630 """
554f62e9
RD		 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):
5ba5649b
RD		 5634 """
5635 __init__(self, Window win=None) -> ChildFocusEvent
5636
5637 Constructor
5638 """
554f62e9 5639 _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
d55e5bfc 5640 def GetWindow(*args, **kwargs):
5ba5649b
RD		 5641 """
5642 GetWindow(self) -> Window
5643
33d6fd3b
RD		 5644 The window, or (grand)parent of the window which has just received the
5645 focus.
5ba5649b 5646 """
d55e5bfc
RD		 5647 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5648
226118fc 5649 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 5650_core_.ChildFocusEvent_swigregister(ChildFocusEvent)
d55e5bfc
RD		 5651
5652#---------------------------------------------------------------------------
5653
5654class ActivateEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 5674 """
f460c29d 5675 __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5ba5649b
RD		 5676
5677 Constructor
5678 """
554f62e9 5679 _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
d55e5bfc 5680 def GetActive(*args, **kwargs):
5ba5649b
RD		 5681 """
5682 GetActive(self) -> bool
5683
5684 Returns true if the application or window is being activated, false
5685 otherwise.
5686 """
d55e5bfc
RD		 5687 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5688
226118fc 5689 Active = property(GetActive,doc="See `GetActive`")
2131d850 5690_core_.ActivateEvent_swigregister(ActivateEvent)
d55e5bfc
RD		 5691
5692#---------------------------------------------------------------------------
5693
5694class InitDialogEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 5705 """
5706 __init__(self, int Id=0) -> InitDialogEvent
5707
5708 Constructor
5709 """
554f62e9 5710 _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
2131d850 5711_core_.InitDialogEvent_swigregister(InitDialogEvent)
d55e5bfc
RD		 5712
5713#---------------------------------------------------------------------------
5714
5715class MenuEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 5727 """
f460c29d 5728 __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5ba5649b
RD		 5729
5730 Constructor
5731 """
554f62e9 5732 _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
d55e5bfc 5733 def GetMenuId(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5740 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5741
5742 def IsPopup(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5750 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5751
5752 def GetMenu(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5759 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5760
57332a5a
RD		 5761 Menu = property(GetMenu,doc="See `GetMenu`")
5762 MenuId = property(GetMenuId,doc="See `GetMenuId`")
2131d850 5763_core_.MenuEvent_swigregister(MenuEvent)
d55e5bfc
RD		 5764
5765#---------------------------------------------------------------------------
5766
5767class CloseEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 5793 """
f460c29d 5794 __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5ba5649b
RD		 5795
5796 Constructor.
5797 """
554f62e9 5798 _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
d55e5bfc 5799 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5800 """
5801 SetLoggingOff(self, bool logOff)
5802
5803 Sets the 'logging off' flag.
5804 """
d55e5bfc
RD		 5805 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5806
5807 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD		 5808 """
5809 GetLoggingOff(self) -> bool
5810
034e3677
RD		 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.
5ba5649b 5815 """
d55e5bfc
RD		 5816 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5817
5818 def Veto(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 5827 return _core_.CloseEvent_Veto(*args, **kwargs)
5828
5ba5649b
RD		 5829 def GetVeto(*args, **kwargs):
5830 """GetVeto(self) -> bool"""
5831 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5832
d55e5bfc 5833 def SetCanVeto(*args, **kwargs):
5ba5649b
RD		 5834 """
5835 SetCanVeto(self, bool canVeto)
5836
5837 Sets the 'can veto' flag.
5838 """
d55e5bfc
RD		 5839 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5840
5841 def CanVeto(*args, **kwargs):
5ba5649b
RD		 5842 """
5843 CanVeto(self) -> bool
d55e5bfc 5844
5ba5649b
RD		 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)
d55e5bfc 5851
226118fc 5852 LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`")
2131d850 5853_core_.CloseEvent_swigregister(CloseEvent)
d55e5bfc
RD		 5854
5855#---------------------------------------------------------------------------
5856
5857class ShowEvent(Event):
5ba5649b 5858 """An EVT_SHOW event is sent when a window is shown or hidden."""
554f62e9
RD		 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):
5ba5649b
RD		 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 """
554f62e9 5867 _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
d55e5bfc
RD		 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
33d6fd3b 5876 Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
2131d850 5877_core_.ShowEvent_swigregister(ShowEvent)
d55e5bfc
RD		 5878
5879#---------------------------------------------------------------------------
5880
5881class IconizeEvent(Event):
5ba5649b
RD		 5882 """
5883 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5884 restored.
5885 """
554f62e9
RD		 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):
5ba5649b
RD		 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 """
554f62e9 5895 _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
d55e5bfc 5896 def Iconized(*args, **kwargs):
5ba5649b
RD		 5897 """
5898 Iconized(self) -> bool
5899
5900 Returns ``True`` if the frame has been iconized, ``False`` if it has
5901 been restored.
5902 """
d55e5bfc
RD		 5903 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5904
2131d850 5905_core_.IconizeEvent_swigregister(IconizeEvent)
d55e5bfc
RD		 5906
5907#---------------------------------------------------------------------------
5908
5909class MaximizeEvent(Event):
5ba5649b 5910 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
554f62e9
RD		 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):
5ba5649b
RD		 5914 """
5915 __init__(self, int id=0) -> MaximizeEvent
5916
5917 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5918 """
554f62e9 5919 _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
2131d850 5920_core_.MaximizeEvent_swigregister(MaximizeEvent)
d55e5bfc
RD		 5921
5922#---------------------------------------------------------------------------
5923
5924class DropFilesEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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
d55e5bfc 5943 def GetPosition(*args, **kwargs):
5ba5649b
RD		 5944 """
5945 GetPosition(self) -> Point
5946
5947 Returns the position at which the files were dropped.
5948 """
d55e5bfc
RD		 5949 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5950
5951 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD		 5952 """
5953 GetNumberOfFiles(self) -> int
5954
5955 Returns the number of files dropped.
5956 """
d55e5bfc
RD		 5957 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5958
5959 def GetFiles(*args, **kwargs):
5ba5649b
RD		 5960 """
5961 GetFiles(self) -> PyObject
5962
5963 Returns a list of the filenames that were dropped.
5964 """
d55e5bfc
RD		 5965 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5966
226118fc
RD		 5967 Files = property(GetFiles,doc="See `GetFiles`")
5968 NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`")
5969 Position = property(GetPosition,doc="See `GetPosition`")
2131d850 5970_core_.DropFilesEvent_swigregister(DropFilesEvent)
d55e5bfc
RD		 5971
5972#---------------------------------------------------------------------------
5973
5974UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5975UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5976class UpdateUIEvent(CommandEvent):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 6032 """
6033 __init__(self, int commandId=0) -> UpdateUIEvent
6034
6035 Constructor
6036 """
554f62e9 6037 _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
d55e5bfc 6038 def GetChecked(*args, **kwargs):
5ba5649b
RD		 6039 """
6040 GetChecked(self) -> bool
6041
6042 Returns ``True`` if the UI element should be checked.
6043 """
d55e5bfc
RD		 6044 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
6045
6046 def GetEnabled(*args, **kwargs):
5ba5649b
RD		 6047 """
6048 GetEnabled(self) -> bool
6049
6050 Returns ``True`` if the UI element should be enabled.
6051 """
d55e5bfc
RD		 6052 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6053
554f62e9
RD		 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
d55e5bfc 6062 def GetText(*args, **kwargs):
5ba5649b
RD		 6063 """
6064 GetText(self) -> String
6065
6066 Returns the text that should be set for the UI element.
6067 """
d55e5bfc
RD		 6068 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6069
6070 def GetSetText(*args, **kwargs):
5ba5649b
RD		 6071 """
6072 GetSetText(self) -> bool
6073
6074 Returns ``True`` if the application has called `SetText`. For
6075 wxWidgets internal use only.
6076 """
d55e5bfc
RD		 6077 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6078
6079 def GetSetChecked(*args, **kwargs):
5ba5649b
RD		 6080 """
6081 GetSetChecked(self) -> bool
6082
6083 Returns ``True`` if the application has called `Check`. For wxWidgets
6084 internal use only.
6085 """
d55e5bfc
RD		 6086 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6087
6088 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD		 6089 """
6090 GetSetEnabled(self) -> bool
6091
6092 Returns ``True`` if the application has called `Enable`. For wxWidgets
6093 internal use only.
6094 """
d55e5bfc
RD		 6095 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6096
554f62e9
RD		 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
d55e5bfc 6106 def Check(*args, **kwargs):
5ba5649b
RD		 6107 """
6108 Check(self, bool check)
6109
6110 Check or uncheck the UI element.
6111 """
d55e5bfc
RD		 6112 return _core_.UpdateUIEvent_Check(*args, **kwargs)
6113
6114 def Enable(*args, **kwargs):
5ba5649b
RD		 6115 """
6116 Enable(self, bool enable)
6117
6118 Enable or disable the UI element.
6119 """
d55e5bfc
RD		 6120 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6121
554f62e9
RD		 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
d55e5bfc 6130 def SetText(*args, **kwargs):
5ba5649b
RD		 6131 """
6132 SetText(self, String text)
6133
6134 Sets the text for this UI element.
6135 """
d55e5bfc
RD		 6136 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6137
6138 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6152 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6153
6154 SetUpdateInterval = staticmethod(SetUpdateInterval)
6155 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6162 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6163
6164 GetUpdateInterval = staticmethod(GetUpdateInterval)
6165 def CanUpdate(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6183 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6184
6185 CanUpdate = staticmethod(CanUpdate)
6186 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6194 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6195
6196 ResetUpdateTime = staticmethod(ResetUpdateTime)
6197 def SetMode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6215 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6216
6217 SetMode = staticmethod(SetMode)
6218 def GetMode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6226 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6227
6228 GetMode = staticmethod(GetMode)
dba7934c
RD		 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`")
2131d850 6233_core_.UpdateUIEvent_swigregister(UpdateUIEvent)
d55e5bfc
RD		 6234
6235def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
554f62e9 6236 """
5ba5649b
RD		 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 """
554f62e9 6249 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d55e5bfc 6250
554f62e9
RD		 6251def UpdateUIEvent_GetUpdateInterval(*args):
6252 """
5ba5649b
RD		 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 """
554f62e9 6258 return _core_.UpdateUIEvent_GetUpdateInterval(*args)
d55e5bfc
RD		 6259
6260def UpdateUIEvent_CanUpdate(*args, **kwargs):
554f62e9 6261 """
5ba5649b
RD		 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 """
554f62e9 6278 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d55e5bfc 6279
554f62e9
RD		 6280def UpdateUIEvent_ResetUpdateTime(*args):
6281 """
5ba5649b
RD		 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 """
554f62e9 6288 return _core_.UpdateUIEvent_ResetUpdateTime(*args)
d55e5bfc
RD		 6289
6290def UpdateUIEvent_SetMode(*args, **kwargs):
554f62e9 6291 """
5ba5649b
RD		 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 """
554f62e9 6308 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d55e5bfc 6309
554f62e9
RD		 6310def UpdateUIEvent_GetMode(*args):
6311 """
5ba5649b
RD		 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 """
554f62e9 6318 return _core_.UpdateUIEvent_GetMode(*args)
d55e5bfc
RD		 6319
6320#---------------------------------------------------------------------------
6321
6322class SysColourChangedEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 6338 """
6339 __init__(self) -> SysColourChangedEvent
6340
6341 Constructor
6342 """
554f62e9 6343 _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
2131d850 6344_core_.SysColourChangedEvent_swigregister(SysColourChangedEvent)
d55e5bfc
RD		 6345
6346#---------------------------------------------------------------------------
6347
6348class MouseCaptureChangedEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 6361 """
6362 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6363
6364 Constructor
6365 """
554f62e9 6366 _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
d55e5bfc 6367 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6374 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6375
57332a5a 6376 CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`")
2131d850 6377_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
d55e5bfc
RD		 6378
6379#---------------------------------------------------------------------------
6380
0f83f5da
RD		 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
d55e5bfc 6422class DisplayChangedEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
d55e5bfc 6432 """__init__(self) -> DisplayChangedEvent"""
554f62e9 6433 _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
2131d850 6434_core_.DisplayChangedEvent_swigregister(DisplayChangedEvent)
d55e5bfc
RD		 6435
6436#---------------------------------------------------------------------------
6437
6438class PaletteChangedEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 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 """
554f62e9 6458 _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
d55e5bfc
RD		 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
33d6fd3b 6467 ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
2131d850 6468_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
d55e5bfc
RD		 6469
6470#---------------------------------------------------------------------------
6471
6472class QueryNewPaletteEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 6482 """
6483 __init__(self, int winid=0) -> QueryNewPaletteEvent
6484
6485 Constructor.
6486 """
554f62e9 6487 _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
d55e5bfc 6488 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD		 6489 """
6490 SetPaletteRealized(self, bool realized)
6491
6492 App should set this if it changes the palette.
6493 """
d55e5bfc
RD		 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
33d6fd3b 6500 PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
2131d850 6501_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
d55e5bfc
RD		 6502
6503#---------------------------------------------------------------------------
6504
6505class NavigationKeyEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
d55e5bfc 6518 """__init__(self) -> NavigationKeyEvent"""
554f62e9 6519 _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
d55e5bfc 6520 def GetDirection(*args, **kwargs):
5ba5649b
RD		 6521 """
6522 GetDirection(self) -> bool
6523
6524 Returns ``True`` if the direction is forward, ``False`` otherwise.
6525 """
d55e5bfc
RD		 6526 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6527
6528 def SetDirection(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6535 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6536
6537 def IsWindowChange(*args, **kwargs):
5ba5649b
RD		 6538 """
6539 IsWindowChange(self) -> bool
6540
6541 Returns ``True`` if window change is allowed.
6542 """
d55e5bfc
RD		 6543 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6544
6545 def SetWindowChange(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6553 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6554
68350608 6555 def IsFromTab(*args, **kwargs):
5ba5649b
RD		 6556 """
6557 IsFromTab(self) -> bool
6558
6559 Returns ``True`` if the navigation event is originated from the Tab
6560 key.
6561 """
68350608
RD		 6562 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6563
6564 def SetFromTab(*args, **kwargs):
5ba5649b
RD		 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 """
68350608
RD		 6571 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6572
908b74cd 6573 def SetFlags(*args, **kwargs):
5ba5649b
RD		 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 """
908b74cd
RD		 6585 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6586
d55e5bfc 6587 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6588 """
6589 GetCurrentFocus(self) -> Window
6590
6591 Returns the child window which currenty has the focus. May be
6592 ``None``.
6593 """
d55e5bfc
RD		 6594 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6595
6596 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD		 6597 """
6598 SetCurrentFocus(self, Window win)
6599
6600 Set the window that has the focus.
6601 """
d55e5bfc
RD		 6602 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6603
b0f7404b 6604 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD		 6605 IsForward = _core_.NavigationKeyEvent_IsForward
6606 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6607 FromTab = _core_.NavigationKeyEvent_FromTab
57332a5a
RD		 6608 CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`")
6609 Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`")
2131d850 6610_core_.NavigationKeyEvent_swigregister(NavigationKeyEvent)
d55e5bfc
RD		 6611
6612#---------------------------------------------------------------------------
6613
6614class WindowCreateEvent(CommandEvent):
5ba5649b
RD		 6615 """
6616 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6617 underlying GUI object) exists.
6618 """
554f62e9
RD		 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):
5ba5649b
RD		 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 """
554f62e9 6628 _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
d55e5bfc 6629 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6630 """
6631 GetWindow(self) -> Window
6632
6633 Returns the window that this event refers to.
6634 """
d55e5bfc
RD		 6635 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6636
dba7934c 6637 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6638_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
d55e5bfc
RD		 6639
6640class WindowDestroyEvent(CommandEvent):
5ba5649b 6641 """
9d7dfdff
RD		 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.
5ba5649b 6651 """
554f62e9
RD		 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):
5ba5649b
RD		 6655 """
6656 __init__(self, Window win=None) -> WindowDestroyEvent
6657
9d7dfdff
RD		 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.
5ba5649b 6667 """
554f62e9 6668 _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
d55e5bfc 6669 def GetWindow(*args, **kwargs):
5ba5649b
RD		 6670 """
6671 GetWindow(self) -> Window
6672
6673 Returns the window that this event refers to.
6674 """
d55e5bfc
RD		 6675 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6676
dba7934c 6677 Window = property(GetWindow,doc="See `GetWindow`")
2131d850 6678_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
d55e5bfc
RD		 6679
6680#---------------------------------------------------------------------------
6681
6682class ContextMenuEvent(CommandEvent):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b 6690 """
f460c29d 6691 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
5ba5649b
RD		 6692
6693 Constructor.
6694 """
554f62e9 6695 _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
d55e5bfc 6696 def GetPosition(*args, **kwargs):
5ba5649b
RD		 6697 """
6698 GetPosition(self) -> Point
6699
6700 Returns the position (in screen coordinants) at which the menu should
6701 be shown.
6702 """
d55e5bfc
RD		 6703 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6704
6705 def SetPosition(*args, **kwargs):
5ba5649b
RD		 6706 """
6707 SetPosition(self, Point pos)
6708
6709 Sets the position at which the menu should be shown.
6710 """
d55e5bfc
RD		 6711 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6712
226118fc 6713 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2131d850 6714_core_.ContextMenuEvent_swigregister(ContextMenuEvent)
d55e5bfc
RD		 6715
6716#---------------------------------------------------------------------------
6717
6718IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6719IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6720class IdleEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
5ba5649b
RD		 6739 """
6740 __init__(self) -> IdleEvent
6741
6742 Constructor
6743 """
554f62e9 6744 _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
d55e5bfc 6745 def RequestMore(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6757 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6758
6759 def MoreRequested(*args, **kwargs):
5ba5649b
RD		 6760 """
6761 MoreRequested(self) -> bool
6762
6763 Returns ``True`` if the OnIdle function processing this event
6764 requested more processing time.
6765 """
d55e5bfc
RD		 6766 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6767
6768 def SetMode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6786 return _core_.IdleEvent_SetMode(*args, **kwargs)
6787
6788 SetMode = staticmethod(SetMode)
6789 def GetMode(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6797 return _core_.IdleEvent_GetMode(*args, **kwargs)
6798
6799 GetMode = staticmethod(GetMode)
6800 def CanSend(*args, **kwargs):
5ba5649b
RD		 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 """
d55e5bfc
RD		 6814 return _core_.IdleEvent_CanSend(*args, **kwargs)
6815
6816 CanSend = staticmethod(CanSend)
2131d850 6817_core_.IdleEvent_swigregister(IdleEvent)
d55e5bfc
RD		 6818
6819def IdleEvent_SetMode(*args, **kwargs):
554f62e9 6820 """
5ba5649b
RD		 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 """
554f62e9 6837 return _core_.IdleEvent_SetMode(*args, **kwargs)
d55e5bfc 6838
554f62e9
RD		 6839def IdleEvent_GetMode(*args):
6840 """
5ba5649b
RD		 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 """
554f62e9 6847 return _core_.IdleEvent_GetMode(*args)
d55e5bfc
RD		 6848
6849def IdleEvent_CanSend(*args, **kwargs):
554f62e9 6850 """
5ba5649b
RD		 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 """
554f62e9 6863 return _core_.IdleEvent_CanSend(*args, **kwargs)
d55e5bfc
RD		 6864
6865#---------------------------------------------------------------------------
6866
2131d850
RD		 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
d55e5bfc 6892class PyEvent(Event):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
f460c29d 6906 """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent"""
554f62e9 6907 _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
5ba5649b 6908 self._SetSelf(self)
d55e5bfc 6909
554f62e9
RD		 6910 __swig_destroy__ = _core_.delete_PyEvent
6911 __del__ = lambda self : None;
5ba5649b
RD		 6912 def _SetSelf(*args, **kwargs):
6913 """_SetSelf(self, PyObject self)"""
6914 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6915
5ba5649b
RD		 6916 def _GetSelf(*args, **kwargs):
6917 """_GetSelf(self) -> PyObject"""
6918 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc 6919
2131d850 6920_core_.PyEvent_swigregister(PyEvent)
d55e5bfc
RD		 6921
6922class PyCommandEvent(CommandEvent):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
f460c29d 6937 """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
554f62e9 6938 _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
5ba5649b 6939 self._SetSelf(self)
d55e5bfc 6940
554f62e9
RD		 6941 __swig_destroy__ = _core_.delete_PyCommandEvent
6942 __del__ = lambda self : None;
5ba5649b
RD		 6943 def _SetSelf(*args, **kwargs):
6944 """_SetSelf(self, PyObject self)"""
6945 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6946
5ba5649b
RD		 6947 def _GetSelf(*args, **kwargs):
6948 """_GetSelf(self) -> PyObject"""
6949 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc 6950
2131d850 6951_core_.PyCommandEvent_swigregister(PyCommandEvent)
d55e5bfc 6952
53aa7709 6953class DateEvent(CommandEvent):
5ba5649b
RD		 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 """
554f62e9
RD		 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):
f460c29d 6963 """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent"""
554f62e9 6964 _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
53aa7709 6965 def GetDate(*args, **kwargs):
5ba5649b
RD		 6966 """
6967 GetDate(self) -> DateTime
6968
6969 Returns the date.
6970 """
53aa7709
RD		 6971 return _core_.DateEvent_GetDate(*args, **kwargs)
6972
6973 def SetDate(*args, **kwargs):
5ba5649b
RD		 6974 """
6975 SetDate(self, DateTime date)
6976
6977 Sets the date carried by the event, normally only used by the library
6978 internally.
6979 """
53aa7709
RD		 6980 return _core_.DateEvent_SetDate(*args, **kwargs)
6981
226118fc 6982 Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`")
2131d850 6983_core_.DateEvent_swigregister(DateEvent)
53aa7709
RD		 6984
6985wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6986EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6987
d55e5bfc
RD		 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):
c24da6d6
RD		 6997 """
6998 The ``wx.PyApp`` class is an *implementation detail*, please use the
6999 `wx.App` class (or some other derived class) instead.
7000 """
554f62e9
RD		 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):
d55e5bfc
RD		 7004 """
7005 __init__(self) -> PyApp
7006
7007 Create a new application object, starting the bootstrap process.
7008 """
554f62e9 7009 _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
c25f90f6 7010 self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp)
d55e5bfc 7011
554f62e9
RD		 7012 __swig_destroy__ = _core_.delete_PyApp
7013 __del__ = lambda self : None;
d55e5bfc 7014 def _setCallbackInfo(*args, **kwargs):
c25f90f6 7015 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)"""
d55e5bfc
RD		 7016 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7017
7018 def GetAppName(*args, **kwargs):
7019 """
7020 GetAppName(self) -> String
7021
7022 Get the application name.
7023 """
7024 return _core_.PyApp_GetAppName(*args, **kwargs)
7025
7026 def SetAppName(*args, **kwargs):
7027 """
7028 SetAppName(self, String name)
7029
c24da6d6
RD		 7030 Set the application name. This value may be used automatically by
7031 `wx.Config` and such.
d55e5bfc
RD		 7032 """
7033 return _core_.PyApp_SetAppName(*args, **kwargs)
7034
7035 def GetClassName(*args, **kwargs):
7036 """
7037 GetClassName(self) -> String
7038
7039 Get the application's class name.
7040 """
7041 return _core_.PyApp_GetClassName(*args, **kwargs)
7042
7043 def SetClassName(*args, **kwargs):
7044 """
7045 SetClassName(self, String name)
7046
c24da6d6
RD		 7047 Set the application's class name. This value may be used for
7048 X-resources if applicable for the platform
d55e5bfc
RD		 7049 """
7050 return _core_.PyApp_SetClassName(*args, **kwargs)
7051
7052 def GetVendorName(*args, **kwargs):
7053 """
7054 GetVendorName(self) -> String
7055
7056 Get the application's vendor name.
7057 """
7058 return _core_.PyApp_GetVendorName(*args, **kwargs)
7059
7060 def SetVendorName(*args, **kwargs):
7061 """
7062 SetVendorName(self, String name)
7063
c24da6d6
RD		 7064 Set the application's vendor name. This value may be used
7065 automatically by `wx.Config` and such.
d55e5bfc
RD		 7066 """
7067 return _core_.PyApp_SetVendorName(*args, **kwargs)
7068
7069 def GetTraits(*args, **kwargs):
7070 """
7071 GetTraits(self) -> wxAppTraits
7072
c24da6d6
RD		 7073 Return (and create if necessary) the app traits object to which we
7074 delegate for everything which either should be configurable by the
7075 user (then he can change the default behaviour simply by overriding
7076 CreateTraits() and returning his own traits object) or which is
7077 GUI/console dependent as then wx.AppTraits allows us to abstract the
7078 differences behind the common facade.
7079
7080 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD		 7081 """
7082 return _core_.PyApp_GetTraits(*args, **kwargs)
7083
7084 def ProcessPendingEvents(*args, **kwargs):
7085 """
7086 ProcessPendingEvents(self)
7087
c24da6d6
RD		 7088 Process all events in the Pending Events list -- it is necessary to
7089 call this function to process posted events. This normally happens
7090 during each event loop iteration.
d55e5bfc
RD		 7091 """
7092 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7093
7094 def Yield(*args, **kwargs):
7095 """
7096 Yield(self, bool onlyIfNeeded=False) -> bool
7097
c24da6d6
RD		 7098 Process all currently pending events right now, instead of waiting
7099 until return to the event loop. It is an error to call ``Yield``
7100 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 7101
c24da6d6 7102 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD		 7103 reentrancies (i.e. when called from an event handler it may
7104 result in calling the same event handler again), use with
7105 extreme care or, better, don't use at all!
d55e5bfc 7106
c24da6d6 7107 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 7108
d55e5bfc
RD		 7109 """
7110 return _core_.PyApp_Yield(*args, **kwargs)
7111
7112 def WakeUpIdle(*args, **kwargs):
7113 """
7114 WakeUpIdle(self)
7115
c24da6d6
RD		 7116 Make sure that idle events are sent again.
7117 :see: `wx.WakeUpIdle`
d55e5bfc
RD		 7118 """
7119 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7120
84f85550
RD		 7121 def IsMainLoopRunning(*args, **kwargs):
7122 """
7123 IsMainLoopRunning() -> bool
7124
7125 Returns True if we're running the main loop, i.e. if the events can
7126 currently be dispatched.
7127 """
7128 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7129
7130 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD		 7131 def MainLoop(*args, **kwargs):
7132 """
7133 MainLoop(self) -> int
7134
c24da6d6
RD		 7135 Execute the main GUI loop, the function doesn't normally return until
7136 all top level windows have been closed and destroyed.
d55e5bfc
RD		 7137 """
7138 return _core_.PyApp_MainLoop(*args, **kwargs)
7139
7140 def Exit(*args, **kwargs):
7141 """
7142 Exit(self)
7143
7144 Exit the main loop thus terminating the application.
c24da6d6 7145 :see: `wx.Exit`
d55e5bfc
RD		 7146 """
7147 return _core_.PyApp_Exit(*args, **kwargs)
7148
97ab0f6a
RD		 7149 def GetLayoutDirection(*args, **kwargs):
7150 """
994453b8 7151 GetLayoutDirection(self) -> int
97ab0f6a
RD		 7152
7153 Return the layout direction for the current locale.
7154 """
7155 return _core_.PyApp_GetLayoutDirection(*args, **kwargs)
7156
d55e5bfc
RD		 7157 def ExitMainLoop(*args, **kwargs):
7158 """
7159 ExitMainLoop(self)
7160
c24da6d6
RD		 7161 Exit the main GUI loop during the next iteration of the main
7162 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD		 7163 """
7164 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7165
7166 def Pending(*args, **kwargs):
7167 """
7168 Pending(self) -> bool
7169
7170 Returns True if there are unprocessed events in the event queue.
7171 """
7172 return _core_.PyApp_Pending(*args, **kwargs)
7173
7174 def Dispatch(*args, **kwargs):
7175 """
7176 Dispatch(self) -> bool
7177
7178 Process the first event in the event queue (blocks until an event
7179 appears if there are none currently)
7180 """
7181 return _core_.PyApp_Dispatch(*args, **kwargs)
7182
7183 def ProcessIdle(*args, **kwargs):
7184 """
7185 ProcessIdle(self) -> bool
7186
c24da6d6
RD		 7187 Called from the MainLoop when the application becomes idle (there are
7188 no pending events) and sends a `wx.IdleEvent` to all interested
7189 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD		 7190 """
7191 return _core_.PyApp_ProcessIdle(*args, **kwargs)
7192
7193 def SendIdleEvents(*args, **kwargs):
7194 """
7195 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7196
c24da6d6
RD		 7197 Send idle event to window and all subwindows. Returns True if more
7198 idle time is requested.
d55e5bfc
RD		 7199 """
7200 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7201
7202 def IsActive(*args, **kwargs):
7203 """
7204 IsActive(self) -> bool
7205
7206 Return True if our app has focus.
7207 """
7208 return _core_.PyApp_IsActive(*args, **kwargs)
7209
7210 def SetTopWindow(*args, **kwargs):
7211 """
7212 SetTopWindow(self, Window win)
7213
c24da6d6 7214 Set the *main* top level window
d55e5bfc
RD		 7215 """
7216 return _core_.PyApp_SetTopWindow(*args, **kwargs)
7217
7218 def GetTopWindow(*args, **kwargs):
7219 """
7220 GetTopWindow(self) -> Window
7221
c24da6d6
RD		 7222 Return the *main* top level window (if it hadn't been set previously
7223 with SetTopWindow(), will return just some top level window and, if
7224 there not any, will return None)
d55e5bfc
RD		 7225 """
7226 return _core_.PyApp_GetTopWindow(*args, **kwargs)
7227
7228 def SetExitOnFrameDelete(*args, **kwargs):
7229 """
7230 SetExitOnFrameDelete(self, bool flag)
7231
c24da6d6
RD		 7232 Control the exit behaviour: by default, the program will exit the main
7233 loop (and so, usually, terminate) when the last top-level program
7234 window is deleted. Beware that if you disable this behaviour (with
7235 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7236 explicitly from somewhere.
d55e5bfc
RD		 7237 """
7238 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7239
7240 def GetExitOnFrameDelete(*args, **kwargs):
7241 """
7242 GetExitOnFrameDelete(self) -> bool
7243
7244 Get the current exit behaviour setting.
7245 """
7246 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7247
7248 def SetUseBestVisual(*args, **kwargs):
7249 """
eccab1a7 7250 SetUseBestVisual(self, bool flag, bool forceTrueColour=False)
d55e5bfc 7251
c24da6d6
RD		 7252 Set whether the app should try to use the best available visual on
7253 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD		 7254 """
7255 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7256
7257 def GetUseBestVisual(*args, **kwargs):
7258 """
7259 GetUseBestVisual(self) -> bool
7260
7261 Get current UseBestVisual setting.
7262 """
7263 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7264
7265 def SetPrintMode(*args, **kwargs):
7266 """SetPrintMode(self, int mode)"""
7267 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7268
7269 def GetPrintMode(*args, **kwargs):
7270 """GetPrintMode(self) -> int"""
7271 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7272
7273 def SetAssertMode(*args, **kwargs):
7274 """
7275 SetAssertMode(self, int mode)
7276
79fccf9d 7277 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD		 7278 """
7279 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7280
7281 def GetAssertMode(*args, **kwargs):
7282 """
7283 GetAssertMode(self) -> int
7284
7285 Get the current OnAssert behaviour setting.
7286 """
7287 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7288
7289 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7290 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD		 7291 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7292
7293 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7294 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7295 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD		 7296 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7297
7298 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7299 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7300 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD		 7301 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7302
7303 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7304 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7305 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD		 7306 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7307
7308 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7309 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7310 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD		 7311 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7312
7313 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7314 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7315 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD		 7316 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7317
7318 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7319 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7320 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD		 7321 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7322
7323 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7324 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7325 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD		 7326 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7327
7328 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7329 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7330 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD		 7331 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7332
7333 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7334 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7335 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD		 7336 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7337
7338 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7339 def _BootstrapApp(*args, **kwargs):
7340 """
7341 _BootstrapApp(self)
7342
7343 For internal use only
7344 """
7345 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7346
7347 def GetComCtl32Version(*args, **kwargs):
7348 """
c24da6d6 7349 GetComCtl32Version() -> int
d55e5bfc 7350
c24da6d6
RD		 7351 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7352 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD		 7353 """
7354 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7355
7356 GetComCtl32Version = staticmethod(GetComCtl32Version)
33d6fd3b 7357 def IsDisplayAvailable(*args, **kwargs):
fc46b7f3 7358 """
33d6fd3b 7359 IsDisplayAvailable() -> bool
fc46b7f3
RD		 7360
7361 Tests if it is possible to create a GUI in the current environment.
7362 This will mean different things on the different platforms.
7363
7364 * On X Windows systems this function will return ``False`` if it is
7365 not able to open a connection to the X display, which can happen
7366 if $DISPLAY is not set, or is not set correctly.
7367
7368 * On Mac OS X a ``False`` return value will mean that wx is not
7369 able to access the window manager, which can happen if logged in
7370 remotely or if running from the normal version of python instead
7371 of the framework version, (i.e., pythonw.)
7372
7373 * On MS Windows...
7374
7375 """
33d6fd3b
RD		 7376 return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
7377
7378 IsDisplayAvailable = staticmethod(IsDisplayAvailable)
7379 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
7380 AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
7381 ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
7382 ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
7383 LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
7384 PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
7385 TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
7386 Traits = property(GetTraits,doc="See `GetTraits`")
7387 UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
7388 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
7389 Active = property(IsActive)
2131d850 7390_core_.PyApp_swigregister(PyApp)
d55e5bfc 7391
554f62e9
RD		 7392def PyApp_IsMainLoopRunning(*args):
7393 """
84f85550
RD		 7394 PyApp_IsMainLoopRunning() -> bool
7395
7396 Returns True if we're running the main loop, i.e. if the events can
7397 currently be dispatched.
7398 """
554f62e9 7399 return _core_.PyApp_IsMainLoopRunning(*args)
84f85550 7400
554f62e9
RD		 7401def PyApp_GetMacSupportPCMenuShortcuts(*args):
7402 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7403 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
d55e5bfc 7404
554f62e9
RD		 7405def PyApp_GetMacAboutMenuItemId(*args):
7406 """PyApp_GetMacAboutMenuItemId() -> long"""
7407 return _core_.PyApp_GetMacAboutMenuItemId(*args)
d55e5bfc 7408
554f62e9
RD		 7409def PyApp_GetMacPreferencesMenuItemId(*args):
7410 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7411 return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
d55e5bfc 7412
554f62e9
RD		 7413def PyApp_GetMacExitMenuItemId(*args):
7414 """PyApp_GetMacExitMenuItemId() -> long"""
7415 return _core_.PyApp_GetMacExitMenuItemId(*args)
d55e5bfc 7416
554f62e9
RD		 7417def PyApp_GetMacHelpMenuTitleName(*args):
7418 """PyApp_GetMacHelpMenuTitleName() -> String"""
7419 return _core_.PyApp_GetMacHelpMenuTitleName(*args)
d55e5bfc
RD		 7420
7421def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
554f62e9
RD		 7422 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7423 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d55e5bfc
RD		 7424
7425def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
554f62e9
RD		 7426 """PyApp_SetMacAboutMenuItemId(long val)"""
7427 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7428
7429def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
554f62e9
RD		 7430 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7431 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7432
7433def PyApp_SetMacExitMenuItemId(*args, **kwargs):
554f62e9
RD		 7434 """PyApp_SetMacExitMenuItemId(long val)"""
7435 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d55e5bfc
RD		 7436
7437def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
554f62e9
RD		 7438 """PyApp_SetMacHelpMenuTitleName(String val)"""
7439 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d55e5bfc 7440
554f62e9
RD		 7441def PyApp_GetComCtl32Version(*args):
7442 """
d55e5bfc
RD		 7443 PyApp_GetComCtl32Version() -> int
7444
c24da6d6
RD		 7445 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7446 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc 7447 """
554f62e9 7448 return _core_.PyApp_GetComCtl32Version(*args)
d55e5bfc 7449
33d6fd3b 7450def PyApp_IsDisplayAvailable(*args):
fc46b7f3 7451 """
33d6fd3b 7452 PyApp_IsDisplayAvailable() -> bool
fc46b7f3
RD		 7453
7454 Tests if it is possible to create a GUI in the current environment.
7455 This will mean different things on the different platforms.
7456
7457 * On X Windows systems this function will return ``False`` if it is
7458 not able to open a connection to the X display, which can happen
7459 if $DISPLAY is not set, or is not set correctly.
7460
7461 * On Mac OS X a ``False`` return value will mean that wx is not
7462 able to access the window manager, which can happen if logged in
7463 remotely or if running from the normal version of python instead
7464 of the framework version, (i.e., pythonw.)
7465
7466 * On MS Windows...
7467
7468 """
33d6fd3b 7469 return _core_.PyApp_IsDisplayAvailable(*args)
fc46b7f3 7470
d55e5bfc
RD		 7471#---------------------------------------------------------------------------
7472
7473
554f62e9
RD		 7474def Exit(*args):
7475 """
d55e5bfc
RD		 7476 Exit()
7477
7478 Force an exit of the application. Convenience for wx.GetApp().Exit()
7479 """
554f62e9 7480 return _core_.Exit(*args)
d55e5bfc 7481
554f62e9
RD		 7482def Yield(*args):
7483 """
d55e5bfc
RD		 7484 Yield() -> bool
7485
7486 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7487 """
554f62e9 7488 return _core_.Yield(*args)
d55e5bfc 7489
554f62e9
RD		 7490def YieldIfNeeded(*args):
7491 """
d55e5bfc
RD		 7492 YieldIfNeeded() -> bool
7493
7494 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7495 """
554f62e9 7496 return _core_.YieldIfNeeded(*args)
d55e5bfc
RD		 7497
7498def SafeYield(*args, **kwargs):
554f62e9 7499 """
d55e5bfc
RD		 7500 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7501
c24da6d6
RD		 7502 This function is similar to `wx.Yield`, except that it disables the
7503 user input to all program windows before calling `wx.Yield` and
7504 re-enables it again afterwards. If ``win`` is not None, this window
7505 will remain enabled, allowing the implementation of some limited user
7506 interaction.
d55e5bfc 7507
c24da6d6 7508 :Returns: the result of the call to `wx.Yield`.
d55e5bfc 7509 """
554f62e9 7510 return _core_.SafeYield(*args, **kwargs)
d55e5bfc 7511
554f62e9
RD		 7512def WakeUpIdle(*args):
7513 """
d55e5bfc
RD		 7514 WakeUpIdle()
7515
c24da6d6
RD		 7516 Cause the message queue to become empty again, so idle events will be
7517 sent.
d55e5bfc 7518 """
554f62e9 7519 return _core_.WakeUpIdle(*args)
d55e5bfc
RD		 7520
7521def PostEvent(*args, **kwargs):
554f62e9 7522 """
d55e5bfc
RD		 7523 PostEvent(EvtHandler dest, Event event)
7524
c24da6d6
RD		 7525 Send an event to a window or other wx.EvtHandler to be processed
7526 later.
d55e5bfc 7527 """
554f62e9 7528 return _core_.PostEvent(*args, **kwargs)
d55e5bfc 7529
554f62e9
RD		 7530def App_CleanUp(*args):
7531 """
d55e5bfc
RD		 7532 App_CleanUp()
7533
79fccf9d 7534 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 7535 Python shuts down.
d55e5bfc 7536 """
554f62e9 7537 return _core_.App_CleanUp(*args)
d55e5bfc 7538
554f62e9
RD		 7539def GetApp(*args):
7540 """
d55e5bfc
RD		 7541 GetApp() -> PyApp
7542
7543 Return a reference to the current wx.App object.
7544 """
554f62e9 7545 return _core_.GetApp(*args)
5cbf236d
RD		 7546
7547def SetDefaultPyEncoding(*args, **kwargs):
554f62e9 7548 """
5cbf236d
RD		 7549 SetDefaultPyEncoding(string encoding)
7550
7551 Sets the encoding that wxPython will use when it needs to convert a
7552 Python string or unicode object to or from a wxString.
62d32a5f
RD		 7553
7554 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7555 but please be aware that the default encoding within the same locale
7556 may be slightly different on different platforms. For example, please
7557 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7558 between the common latin/roman encodings.
5cbf236d 7559 """
554f62e9 7560 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5cbf236d 7561
554f62e9
RD		 7562def GetDefaultPyEncoding(*args):
7563 """
5cbf236d
RD		 7564 GetDefaultPyEncoding() -> string
7565
7566 Gets the current encoding that wxPython will use when it needs to
7567 convert a Python string or unicode object to or from a wxString.
7568 """
554f62e9 7569 return _core_.GetDefaultPyEncoding(*args)
d55e5bfc
RD		 7570#----------------------------------------------------------------------
7571
7572class PyOnDemandOutputWindow:
7573 """
7574 A class that can be used for redirecting Python's stdout and
7575 stderr streams. It will do nothing until something is wrriten to
7576 the stream at which point it will create a Frame with a text area
7577 and write the text there.
7578 """
7579 def __init__(self, title = "wxPython: stdout/stderr"):
7580 self.frame = None
7581 self.title = title
412d302d
RD		 7582 self.pos = wx.DefaultPosition
7583 self.size = (450, 300)
d55e5bfc
RD		 7584 self.parent = None
7585
7586 def SetParent(self, parent):
7587 """Set the window to be used as the popup Frame's parent."""
7588 self.parent = parent
7589
7590
7591 def CreateOutputWindow(self, st):
412d302d
RD		 7592 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7593 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 7594 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7595 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 7596 self.text.AppendText(st)
d55e5bfc 7597 self.frame.Show(True)
2131d850 7598 self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
d55e5bfc
RD		 7599
7600
7601 def OnCloseWindow(self, event):
7602 if self.frame is not None:
7603 self.frame.Destroy()
7604 self.frame = None
7605 self.text = None
7606
7607
7608 # These methods provide the file-like output behaviour.
7609 def write(self, text):
7610 """
7611 Create the output window if needed and write the string to it.
7612 If not called in the context of the gui thread then uses
7613 CallAfter to do the work there.
7614 """
7615 if self.frame is None:
7616 if not wx.Thread_IsMain():
7617 wx.CallAfter(self.CreateOutputWindow, text)
7618 else:
7619 self.CreateOutputWindow(text)
7620 else:
7621 if not wx.Thread_IsMain():
7622 wx.CallAfter(self.text.AppendText, text)
7623 else:
7624 self.text.AppendText(text)
7625
7626
7627 def close(self):
7628 if self.frame is not None:
7629 wx.CallAfter(self.frame.Close)
7630
7631
19272049
RD		 7632 def flush(self):
7633 pass
7634
7635
d55e5bfc
RD		 7636
7637#----------------------------------------------------------------------
7638
7639_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
fc46b7f3 7640
d55e5bfc
RD		 7641class App(wx.PyApp):
7642 """
c24da6d6
RD		 7643 The ``wx.App`` class represents the application and is used to:
7644
7645 * bootstrap the wxPython system and initialize the underlying
7646 gui toolkit
7647 * set and get application-wide properties
7648 * implement the windowing system main message or event loop,
7649 and to dispatch events to window instances
7650 * etc.
7651
7652 Every application must have a ``wx.App`` instance, and all
7653 creation of UI objects should be delayed until after the
7654 ``wx.App`` object has been created in order to ensure that the gui
7655 platform and wxWidgets have been fully initialized.
7656
7657 Normally you would derive from this class and implement an
7658 ``OnInit`` method that creates a frame and then calls
7659 ``self.SetTopWindow(frame)``.
7660
7661 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 7662 directly.
d55e5bfc 7663 """
c24da6d6 7664
d55e5bfc
RD		 7665 outputWindowClass = PyOnDemandOutputWindow
7666
c24da6d6
RD		 7667 def __init__(self, redirect=_defRedirect, filename=None,
7668 useBestVisual=False, clearSigInt=True):
7669 """
7670 Construct a ``wx.App`` object.
7671
7672 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7673 redirected? Defaults to True on Windows and Mac, False
7674 otherwise. If `filename` is None then output will be
7675 redirected to a window that pops up as needed. (You can
7676 control what kind of window is created for the output by
7677 resetting the class variable ``outputWindowClass`` to a
7678 class of your choosing.)
7679
7680 :param filename: The name of a file to redirect output to, if
7681 redirect is True.
7682
7683 :param useBestVisual: Should the app try to use the best
7684 available visual provided by the system (only relevant on
7685 systems that have more than one visual.) This parameter
7686 must be used instead of calling `SetUseBestVisual` later
7687 on because it must be set before the underlying GUI
7688 toolkit is initialized.
7689
7690 :param clearSigInt: Should SIGINT be cleared? This allows the
7691 app to terminate upon a Ctrl-C in the console like other
7692 GUI apps will.
7693
7694 :note: You should override OnInit to do applicaition
7695 initialization to ensure that the system, toolkit and
7696 wxWidgets are fully initialized.
7697 """
fc46b7f3 7698
d55e5bfc
RD		 7699 wx.PyApp.__init__(self)
7700
fc46b7f3 7701 # make sure we can create a GUI
33d6fd3b 7702 if not self.IsDisplayAvailable():
fc46b7f3
RD		 7703
7704 if wx.Platform == "__WXMAC__":
7705 msg = """This program needs access to the screen.
7706Please run with 'pythonw', not 'python', and only when you are logged
7707in on the main display of your Mac."""
7708
7709 elif wx.Platform == "__WXGTK__":
7710 msg ="Unable to access the X Display, is $DISPLAY set properly?"
d55e5bfc 7711
fc46b7f3
RD		 7712 else:
7713 msg = "Unable to create GUI"
7714 # TODO: more description is needed for wxMSW...
7715
7716 raise SystemExit(msg)
7717
d55e5bfc
RD		 7718 # This has to be done before OnInit
7719 self.SetUseBestVisual(useBestVisual)
7720
7721 # Set the default handler for SIGINT. This fixes a problem
7722 # where if Ctrl-C is pressed in the console that started this
7723 # app then it will not appear to do anything, (not even send
7724 # KeyboardInterrupt???) but will later segfault on exit. By
7725 # setting the default handler then the app will exit, as
7726 # expected (depending on platform.)
c24da6d6
RD		 7727 if clearSigInt:
7728 try:
7729 import signal
7730 signal.signal(signal.SIGINT, signal.SIG_DFL)
7731 except:
7732 pass
d55e5bfc
RD		 7733
7734 # Save and redirect the stdio to a window?
7735 self.stdioWin = None
7736 self.saveStdio = (_sys.stdout, _sys.stderr)
7737 if redirect:
7738 self.RedirectStdio(filename)
7739
8fb0e70a
RD		 7740 # Use Python's install prefix as the default
7741 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7742
48a0c021
RD		 7743 # Until the new native control for wxMac is up to par, still use the generic one.
7744 wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1)
7745
d55e5bfc
RD		 7746 # This finishes the initialization of wxWindows and then calls
7747 # the OnInit that should be present in the derived class
7748 self._BootstrapApp()
7749
7750
f460c29d
RD		 7751 def OnPreInit(self):
7752 """
7753 Things that must be done after _BootstrapApp has done its
7754 thing, but would be nice if they were already done by the time
7755 that OnInit is called.
7756 """
7757 wx.StockGDI._initStockObjects()
7758
7759
66af7a75
RD		 7760 def __del__(self, destroy=wx.PyApp.__del__):
7761 self.RestoreStdio() # Just in case the MainLoop was overridden
7762 destroy(self)
d55e5bfc 7763
70b7a5fe 7764 def Destroy(self):
b39fe951 7765 self.this.own(False)
70b7a5fe 7766 wx.PyApp.Destroy(self)
d55e5bfc
RD		 7767
7768 def SetTopWindow(self, frame):
7769 """Set the \"main\" top level window"""
7770 if self.stdioWin:
7771 self.stdioWin.SetParent(frame)
7772 wx.PyApp.SetTopWindow(self, frame)
7773
7774
7775 def MainLoop(self):
7776 """Execute the main GUI event loop"""
7777 wx.PyApp.MainLoop(self)
7778 self.RestoreStdio()
7779
7780
7781 def RedirectStdio(self, filename=None):
7782 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7783 if filename:
7784 _sys.stdout = _sys.stderr = open(filename, 'a')
7785 else:
7786 self.stdioWin = self.outputWindowClass()
7787 _sys.stdout = _sys.stderr = self.stdioWin
7788
7789
7790 def RestoreStdio(self):
66af7a75
RD		 7791 try:
7792 _sys.stdout, _sys.stderr = self.saveStdio
7793 except:
7794 pass
d55e5bfc
RD		 7795
7796
412d302d
RD		 7797 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7798 """
7799 Set the title, position and/or size of the output window if
f5b96ee1
RD		 7800 the stdio has been redirected. This should be called before
7801 any output would cause the output window to be created.
412d302d
RD		 7802 """
7803 if self.stdioWin:
7804 if title is not None:
7805 self.stdioWin.title = title
7806 if pos is not None:
7807 self.stdioWin.pos = pos
7808 if size is not None:
7809 self.stdioWin.size = size
7810
7811
7812
d55e5bfc 7813
c24da6d6 7814# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD		 7815App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7816App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7817App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7818App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7819App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7820App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7821App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7822App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7823App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7824App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7825App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7826
7827#----------------------------------------------------------------------------
7828
7829class PySimpleApp(wx.App):
7830 """
7831 A simple application class. You can just create one of these and
7832 then then make your top level windows later, and not have to worry
c24da6d6 7833 about OnInit. For example::
d55e5bfc 7834
c24da6d6
RD		 7835 app = wx.PySimpleApp()
7836 frame = wx.Frame(None, title='Hello World')
7837 frame.Show()
7838 app.MainLoop()
7839
7840 :see: `wx.App`
7841 """
7842
7843 def __init__(self, redirect=False, filename=None,
7844 useBestVisual=False, clearSigInt=True):
7845 """
7846 :see: `wx.App.__init__`
7847 """
7848 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD		 7849
7850 def OnInit(self):
d55e5bfc
RD		 7851 return True
7852
7853
c24da6d6 7854
d55e5bfc
RD		 7855# Is anybody using this one?
7856class PyWidgetTester(wx.App):
7857 def __init__(self, size = (250, 100)):
7858 self.size = size
7859 wx.App.__init__(self, 0)
7860
7861 def OnInit(self):
7862 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7863 self.SetTopWindow(self.frame)
7864 return True
7865
c24da6d6
RD		 7866 def SetWidget(self, widgetClass, *args, **kwargs):
7867 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD		 7868 self.frame.Show(True)
7869
7870#----------------------------------------------------------------------------
7871# DO NOT hold any other references to this object. This is how we
c24da6d6 7872# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7873# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 7874# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD		 7875
7876class __wxPyCleanup:
7877 def __init__(self):
7878 self.cleanup = _core_.App_CleanUp
7879 def __del__(self):
7880 self.cleanup()
7881
7882_sys.__wxPythonCleanup = __wxPyCleanup()
7883
7884## # another possible solution, but it gets called too early...
c24da6d6
RD		 7885## import atexit
7886## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD		 7887
7888
7889#----------------------------------------------------------------------------
7890
7891#---------------------------------------------------------------------------
7892
ae8162c8 7893class EventLoop(object):
093d3ff1 7894 """Proxy of C++ EventLoop class"""
554f62e9
RD		 7895 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7896 __repr__ = _swig_repr
7897 def __init__(self, *args, **kwargs):
ae8162c8 7898 """__init__(self) -> EventLoop"""
554f62e9
RD		 7899 _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
7900 __swig_destroy__ = _core_.delete_EventLoop
7901 __del__ = lambda self : None;
ae8162c8
RD		 7902 def Run(*args, **kwargs):
7903 """Run(self) -> int"""
7904 return _core_.EventLoop_Run(*args, **kwargs)
7905
7906 def Exit(*args, **kwargs):
7907 """Exit(self, int rc=0)"""
7908 return _core_.EventLoop_Exit(*args, **kwargs)
7909
7910 def Pending(*args, **kwargs):
7911 """Pending(self) -> bool"""
7912 return _core_.EventLoop_Pending(*args, **kwargs)
7913
7914 def Dispatch(*args, **kwargs):
7915 """Dispatch(self) -> bool"""
7916 return _core_.EventLoop_Dispatch(*args, **kwargs)
7917
7918 def IsRunning(*args, **kwargs):
7919 """IsRunning(self) -> bool"""
7920 return _core_.EventLoop_IsRunning(*args, **kwargs)
7921
7922 def GetActive(*args, **kwargs):
7923 """GetActive() -> EventLoop"""
7924 return _core_.EventLoop_GetActive(*args, **kwargs)
7925
7926 GetActive = staticmethod(GetActive)
7927 def SetActive(*args, **kwargs):
7928 """SetActive(EventLoop loop)"""
7929 return _core_.EventLoop_SetActive(*args, **kwargs)
7930
7931 SetActive = staticmethod(SetActive)
2131d850 7932_core_.EventLoop_swigregister(EventLoop)
ae8162c8 7933
554f62e9
RD		 7934def EventLoop_GetActive(*args):
7935 """EventLoop_GetActive() -> EventLoop"""
7936 return _core_.EventLoop_GetActive(*args)
ae8162c8
RD		 7937
7938def EventLoop_SetActive(*args, **kwargs):
554f62e9
RD		 7939 """EventLoop_SetActive(EventLoop loop)"""
7940 return _core_.EventLoop_SetActive(*args, **kwargs)
ae8162c8 7941
7449af73
RD		 7942class EventLoopActivator(object):
7943 """Proxy of C++ EventLoopActivator class"""
554f62e9
RD		 7944 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7945 __repr__ = _swig_repr
7946 def __init__(self, *args, **kwargs):
7449af73 7947 """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
554f62e9
RD		 7948 _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
7949 __swig_destroy__ = _core_.delete_EventLoopActivator
7950 __del__ = lambda self : None;
2131d850 7951_core_.EventLoopActivator_swigregister(EventLoopActivator)
7449af73 7952
ae8162c8
RD		 7953#---------------------------------------------------------------------------
7954
eec1c382
RD		 7955ACCEL_ALT = _core_.ACCEL_ALT
7956ACCEL_CTRL = _core_.ACCEL_CTRL
7957ACCEL_SHIFT = _core_.ACCEL_SHIFT
7958ACCEL_NORMAL = _core_.ACCEL_NORMAL
7959ACCEL_CMD = _core_.ACCEL_CMD
d55e5bfc 7960class AcceleratorEntry(object):
c24da6d6
RD		 7961 """
7962 A class used to define items in an `wx.AcceleratorTable`. wxPython
7963 programs can choose to use wx.AcceleratorEntry objects, but using a
7964 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 7965 as well. See `__init__` for of the tuple values.
c24da6d6
RD		 7966
7967 :see: `wx.AcceleratorTable`
7968 """
554f62e9
RD		 7969 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7970 __repr__ = _swig_repr
7971 def __init__(self, *args, **kwargs):
c24da6d6
RD		 7972 """
7973 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7974
7975 Construct a wx.AcceleratorEntry.
c24da6d6 7976 """
554f62e9
RD		 7977 _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
7978 __swig_destroy__ = _core_.delete_AcceleratorEntry
7979 __del__ = lambda self : None;
d55e5bfc 7980 def Set(*args, **kwargs):
c24da6d6
RD		 7981 """
7982 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7983
c24da6d6
RD		 7984 (Re)set the attributes of a wx.AcceleratorEntry.
7985 :see `__init__`
7986 """
7987 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc 7988
97ab0f6a
RD		 7989 def Create(*args, **kwargs):
7990 """
7991 Create(String str) -> AcceleratorEntry
7992
7993 Create accelerator corresponding to the specified string, or None if
7994 it coulnd't be parsed.
7995 """
7996 return _core_.AcceleratorEntry_Create(*args, **kwargs)
7997
7998 Create = staticmethod(Create)
d55e5bfc 7999 def GetFlags(*args, **kwargs):
c24da6d6
RD		 8000 """
8001 GetFlags(self) -> int
8002
8003 Get the AcceleratorEntry's flags.
8004 """
d55e5bfc
RD		 8005 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
8006
8007 def GetKeyCode(*args, **kwargs):
c24da6d6
RD		 8008 """
8009 GetKeyCode(self) -> int
8010
8011 Get the AcceleratorEntry's keycode.
8012 """
d55e5bfc
RD		 8013 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
8014
8015 def GetCommand(*args, **kwargs):
c24da6d6
RD		 8016 """
8017 GetCommand(self) -> int
8018
8019 Get the AcceleratorEntry's command ID.
8020 """
d55e5bfc
RD		 8021 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
8022
97ab0f6a
RD		 8023 def IsOk(*args, **kwargs):
8024 """IsOk(self) -> bool"""
8025 return _core_.AcceleratorEntry_IsOk(*args, **kwargs)
8026
8027 def ToString(*args, **kwargs):
8028 """
8029 ToString(self) -> String
8030
8031 Returns a string representation for the this accelerator. The string
8032 is formatted using the <flags>-<keycode> format where <flags> maybe a
8033 hyphen-separed list of "shift|alt|ctrl"
8034
8035 """
8036 return _core_.AcceleratorEntry_ToString(*args, **kwargs)
8037
8038 def FromString(*args, **kwargs):
8039 """
8040 FromString(self, String str) -> bool
8041
8042 Returns true if the given string correctly initialized this object.
8043 """
8044 return _core_.AcceleratorEntry_FromString(*args, **kwargs)
8045
226118fc
RD		 8046 Command = property(GetCommand,doc="See `GetCommand`")
8047 Flags = property(GetFlags,doc="See `GetFlags`")
8048 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
2131d850 8049_core_.AcceleratorEntry_swigregister(AcceleratorEntry)
d55e5bfc 8050
97ab0f6a
RD		 8051def AcceleratorEntry_Create(*args, **kwargs):
8052 """
8053 AcceleratorEntry_Create(String str) -> AcceleratorEntry
8054
8055 Create accelerator corresponding to the specified string, or None if
8056 it coulnd't be parsed.
8057 """
8058 return _core_.AcceleratorEntry_Create(*args, **kwargs)
8059
d55e5bfc 8060class AcceleratorTable(Object):
c24da6d6
RD		 8061 """
8062 An accelerator table allows the application to specify a table of
8063 keyboard shortcuts for menus or other commands. On Windows, menu or
8064 button commands are supported; on GTK, only menu commands are
8065 supported.
c24da6d6 8066 """
554f62e9
RD		 8067 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8068 __repr__ = _swig_repr
8069 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8070 """
8071 __init__(entries) -> AcceleratorTable
8072
c24da6d6
RD		 8073 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
8074 items or or of 3-tuples (flags, keyCode, cmdID)
8075
8076 :see: `wx.AcceleratorEntry`
d55e5bfc 8077 """
554f62e9
RD		 8078 _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
8079 __swig_destroy__ = _core_.delete_AcceleratorTable
8080 __del__ = lambda self : None;
b39fe951
RD		 8081 def IsOk(*args, **kwargs):
8082 """IsOk(self) -> bool"""
8083 return _core_.AcceleratorTable_IsOk(*args, **kwargs)
d55e5bfc 8084
b39fe951 8085 Ok = IsOk
2131d850 8086_core_.AcceleratorTable_swigregister(AcceleratorTable)
d55e5bfc
RD		 8087
8088
8089def GetAccelFromString(*args, **kwargs):
554f62e9
RD		 8090 """GetAccelFromString(String label) -> AcceleratorEntry"""
8091 return _core_.GetAccelFromString(*args, **kwargs)
d55e5bfc
RD		 8092#---------------------------------------------------------------------------
8093
8094class VisualAttributes(object):
8095 """struct containing all the visual attributes of a control"""
554f62e9
RD		 8096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8097 __repr__ = _swig_repr
8098 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8099 """
8100 __init__(self) -> VisualAttributes
8101
8102 struct containing all the visual attributes of a control
8103 """
554f62e9
RD		 8104 _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
8105 __swig_destroy__ = _core_.delete_VisualAttributes
8106 __del__ = lambda self : None;
d55e5bfc
RD		 8107 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8108 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8109 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
2131d850 8110_core_.VisualAttributes_swigregister(VisualAttributes)
d55e5bfc
RD		 8111NullAcceleratorTable = cvar.NullAcceleratorTable
8112PanelNameStr = cvar.PanelNameStr
8113
8114WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8115WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8116WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8117WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8118WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8119class Window(EvtHandler):
8120 """
8121 wx.Window is the base class for all windows and represents any visible
8122 object on the screen. All controls, top level windows and so on are
8123 wx.Windows. Sizers and device contexts are not however, as they don't
8124 appear on screen themselves.
8125
8126 """
554f62e9
RD		 8127 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
8128 __repr__ = _swig_repr
8129 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 8130 """
8131 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8132 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8133
8134 Construct and show a generic Window.
8135 """
554f62e9 8136 _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
d55e5bfc
RD		 8137 self._setOORInfo(self)
8138
8139 def Create(*args, **kwargs):
8140 """
8141 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8142 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8143
8144 Create the GUI part of the Window for 2-phase creation mode.
8145 """
8146 return _core_.Window_Create(*args, **kwargs)
8147
8148 def Close(*args, **kwargs):
8149 """
8150 Close(self, bool force=False) -> bool
8151
8152 This function simply generates a EVT_CLOSE event whose handler usually
8153 tries to close the window. It doesn't close the window itself,
8154 however. If force is False (the default) then the window's close
8155 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD		 8156 """
8157 return _core_.Window_Close(*args, **kwargs)
8158
8159 def Destroy(*args, **kwargs):
8160 """
8161 Destroy(self) -> bool
8162
8163 Destroys the window safely. Frames and dialogs are not destroyed
8164 immediately when this function is called -- they are added to a list
8165 of windows to be deleted on idle time, when all the window's events
8166 have been processed. This prevents problems with events being sent to
8167 non-existent windows.
8168
8169 Returns True if the window has either been successfully deleted, or it
8170 has been added to the list of windows pending real deletion.
8171 """
b39fe951
RD		 8172 args[0].this.own(False)
8173 return _core_.Window_Destroy(*args, **kwargs)
d55e5bfc
RD		 8174
8175 def DestroyChildren(*args, **kwargs):
8176 """
8177 DestroyChildren(self) -> bool
8178
79fccf9d
RD		 8179 Destroys all children of a window. Called automatically by the
8180 destructor.
d55e5bfc
RD		 8181 """
8182 return _core_.Window_DestroyChildren(*args, **kwargs)
8183
8184 def IsBeingDeleted(*args, **kwargs):
8185 """
8186 IsBeingDeleted(self) -> bool
8187
8188 Is the window in the process of being deleted?
8189 """
8190 return _core_.Window_IsBeingDeleted(*args, **kwargs)
8191
d55e5bfc
RD		 8192 def SetLabel(*args, **kwargs):
8193 """
8194 SetLabel(self, String label)
8195
8196 Set the text which the window shows in its label if applicable.
8197 """
8198 return _core_.Window_SetLabel(*args, **kwargs)
8199
8200 def GetLabel(*args, **kwargs):
8201 """
8202 GetLabel(self) -> String
8203
79fccf9d
RD		 8204 Generic way of getting a label from any window, for identification
8205 purposes. The interpretation of this function differs from class to
8206 class. For frames and dialogs, the value returned is the title. For
8207 buttons or static text controls, it is the button text. This function
8208 can be useful for meta-programs such as testing tools or special-needs
8209 access programs)which need to identify windows by name.
d55e5bfc
RD		 8210 """
8211 return _core_.Window_GetLabel(*args, **kwargs)
8212
8213 def SetName(*args, **kwargs):
8214 """
8215 SetName(self, String name)
8216
79fccf9d
RD		 8217 Sets the window's name. The window name is used for ressource setting
8218 in X, it is not the same as the window title/label
d55e5bfc
RD		 8219 """
8220 return _core_.Window_SetName(*args, **kwargs)
8221
8222 def GetName(*args, **kwargs):
8223 """
8224 GetName(self) -> String
8225
79fccf9d
RD		 8226 Returns the windows name. This name is not guaranteed to be unique;
8227 it is up to the programmer to supply an appropriate name in the window
8228 constructor or via wx.Window.SetName.
d55e5bfc
RD		 8229 """
8230 return _core_.Window_GetName(*args, **kwargs)
8231
8232 def SetWindowVariant(*args, **kwargs):
8233 """
8234 SetWindowVariant(self, int variant)
8235
79fccf9d
RD		 8236 Sets the variant of the window/font size to use for this window, if
8237 the platform supports variants, for example, wxMac.
d55e5bfc
RD		 8238 """
8239 return _core_.Window_SetWindowVariant(*args, **kwargs)
8240
8241 def GetWindowVariant(*args, **kwargs):
8242 """GetWindowVariant(self) -> int"""
8243 return _core_.Window_GetWindowVariant(*args, **kwargs)
8244
8245 def SetId(*args, **kwargs):
8246 """
8247 SetId(self, int winid)
8248
8249 Sets the identifier of the window. Each window has an integer
8250 identifier. If the application has not provided one, an identifier
8251 will be generated. Normally, the identifier should be provided on
8252 creation and should not be modified subsequently.
8253 """
8254 return _core_.Window_SetId(*args, **kwargs)
8255
8256 def GetId(*args, **kwargs):
8257 """
8258 GetId(self) -> int
8259
8260 Returns the identifier of the window. Each window has an integer
8261 identifier. If the application has not provided one (or the default Id
8262 -1 is used) then an unique identifier with a negative value will be
8263 generated.
8264 """
8265 return _core_.Window_GetId(*args, **kwargs)
8266
8267 def NewControlId(*args, **kwargs):
8268 """
c24da6d6 8269 NewControlId() -> int
d55e5bfc
RD		 8270
8271 Generate a control id for the controls which were not given one.
8272 """
8273 return _core_.Window_NewControlId(*args, **kwargs)
8274
8275 NewControlId = staticmethod(NewControlId)
8276 def NextControlId(*args, **kwargs):
8277 """
c24da6d6 8278 NextControlId(int winid) -> int
d55e5bfc
RD		 8279
8280 Get the id of the control following the one with the given
79fccf9d 8281 autogenerated) id
d55e5bfc
RD		 8282 """
8283 return _core_.Window_NextControlId(*args, **kwargs)
8284
8285 NextControlId = staticmethod(NextControlId)
8286 def PrevControlId(*args, **kwargs):
8287 """
c24da6d6 8288 PrevControlId(int winid) -> int
d55e5bfc
RD		 8289
8290 Get the id of the control preceding the one with the given
79fccf9d 8291 autogenerated) id
d55e5bfc
RD		 8292 """
8293 return _core_.Window_PrevControlId(*args, **kwargs)
8294
8295 PrevControlId = staticmethod(PrevControlId)
97ab0f6a
RD		 8296 def GetLayoutDirection(*args, **kwargs):
8297 """
994453b8 8298 GetLayoutDirection(self) -> int
97ab0f6a
RD		 8299
8300 Get the layout direction (LTR or RTL) for this window. Returns
8301 ``wx.Layout_Default`` if layout direction is not supported.
8302 """
8303 return _core_.Window_GetLayoutDirection(*args, **kwargs)
8304
8305 def SetLayoutDirection(*args, **kwargs):
8306 """
994453b8 8307 SetLayoutDirection(self, int dir)
97ab0f6a
RD		 8308
8309 Set the layout direction (LTR or RTL) for this window.
8310 """
8311 return _core_.Window_SetLayoutDirection(*args, **kwargs)
8312
8313 def AdjustForLayoutDirection(*args, **kwargs):
8314 """
8315 AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
8316
8317 Mirror coordinates for RTL layout if this window uses it and if the
8318 mirroring is not done automatically like Win32.
8319 """
8320 return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
8321
d55e5bfc
RD		 8322 def SetSize(*args, **kwargs):
8323 """
8324 SetSize(self, Size size)
8325
8326 Sets the size of the window in pixels.
8327 """
8328 return _core_.Window_SetSize(*args, **kwargs)
8329
8330 def SetDimensions(*args, **kwargs):
8331 """
8332 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8333
8334 Sets the position and size of the window in pixels. The sizeFlags
8335 parameter indicates the interpretation of the other params if they are
62d32a5f
RD		 8336 equal to -1.
8337
8338 ======================== ======================================
8339 wx.SIZE_AUTO A -1 indicates that a class-specific
8340 default should be used.
8341 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8342 -1 values are supplied.
8343 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8344 interpreted as real dimensions, not
8345 default values.
8346 ======================== ======================================
8347
d55e5bfc
RD		 8348 """
8349 return _core_.Window_SetDimensions(*args, **kwargs)
8350
8351 def SetRect(*args, **kwargs):
8352 """
8353 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8354
8355 Sets the position and size of the window in pixels using a wx.Rect.
8356 """
8357 return _core_.Window_SetRect(*args, **kwargs)
8358
8359 def SetSizeWH(*args, **kwargs):
8360 """
8361 SetSizeWH(self, int width, int height)
8362
8363 Sets the size of the window in pixels.
8364 """
8365 return _core_.Window_SetSizeWH(*args, **kwargs)
8366
8367 def Move(*args, **kwargs):
8368 """
8369 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8370
8371 Moves the window to the given position.
8372 """
8373 return _core_.Window_Move(*args, **kwargs)
8374
8375 SetPosition = Move
8376 def MoveXY(*args, **kwargs):
8377 """
8378 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8379
8380 Moves the window to the given position.
8381 """
8382 return _core_.Window_MoveXY(*args, **kwargs)
8383
580080c5 8384 def SetInitialSize(*args, **kwargs):
f8167d6e 8385 """
580080c5 8386 SetInitialSize(self, Size size=DefaultSize)
f8167d6e
RD		 8387
8388 A 'Smart' SetSize that will fill in default size components with the
8389 window's *best size* values. Also set's the minsize for use with sizers.
8390 """
580080c5 8391 return _core_.Window_SetInitialSize(*args, **kwargs)
f8167d6e 8392
580080c5 8393 SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`')
d55e5bfc
RD		 8394 def Raise(*args, **kwargs):
8395 """
8396 Raise(self)
8397
9d7dfdff
RD		 8398 Raises the window to the top of the window hierarchy. In current
8399 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 8400 """
8401 return _core_.Window_Raise(*args, **kwargs)
8402
8403 def Lower(*args, **kwargs):
8404 """
8405 Lower(self)
8406
9d7dfdff
RD		 8407 Lowers the window to the bottom of the window hierarchy. In current
8408 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD		 8409 """
8410 return _core_.Window_Lower(*args, **kwargs)
8411
8412 def SetClientSize(*args, **kwargs):
8413 """
8414 SetClientSize(self, Size size)
8415
8416 This sets the size of the window client area in pixels. Using this
8417 function to size a window tends to be more device-independent than
8418 wx.Window.SetSize, since the application need not worry about what
8419 dimensions the border or title bar have when trying to fit the window
8420 around panel items, for example.
8421 """
8422 return _core_.Window_SetClientSize(*args, **kwargs)
8423
8424 def SetClientSizeWH(*args, **kwargs):
8425 """
8426 SetClientSizeWH(self, int width, int height)
8427
8428 This sets the size of the window client area in pixels. Using this
8429 function to size a window tends to be more device-independent than
8430 wx.Window.SetSize, since the application need not worry about what
8431 dimensions the border or title bar have when trying to fit the window
8432 around panel items, for example.
8433 """
8434 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8435
8436 def SetClientRect(*args, **kwargs):
8437 """
8438 SetClientRect(self, Rect rect)
8439
8440 This sets the size of the window client area in pixels. Using this
8441 function to size a window tends to be more device-independent than
8442 wx.Window.SetSize, since the application need not worry about what
8443 dimensions the border or title bar have when trying to fit the window
8444 around panel items, for example.
8445 """
8446 return _core_.Window_SetClientRect(*args, **kwargs)
8447
8448 def GetPosition(*args, **kwargs):
8449 """
8450 GetPosition(self) -> Point
8451
1c71765a
RD		 8452 Get the window's position. Notice that the position is in client
8453 coordinates for child windows and screen coordinates for the top level
8454 ones, use `GetScreenPosition` if you need screen coordinates for all
8455 kinds of windows.
d55e5bfc
RD		 8456 """
8457 return _core_.Window_GetPosition(*args, **kwargs)
8458
8459 def GetPositionTuple(*args, **kwargs):
8460 """
8461 GetPositionTuple() -> (x,y)
8462
1c71765a
RD		 8463 Get the window's position. Notice that the position is in client
8464 coordinates for child windows and screen coordinates for the top level
8465 ones, use `GetScreenPosition` if you need screen coordinates for all
8466 kinds of windows.
d55e5bfc
RD		 8467 """
8468 return _core_.Window_GetPositionTuple(*args, **kwargs)
8469
1c71765a
RD		 8470 def GetScreenPosition(*args, **kwargs):
8471 """
8472 GetScreenPosition(self) -> Point
8473
8474 Get the position of the window in screen coordinantes.
8475 """
8476 return _core_.Window_GetScreenPosition(*args, **kwargs)
8477
8478 def GetScreenPositionTuple(*args, **kwargs):
8479 """
8480 GetScreenPositionTuple() -> (x,y)
8481
8482 Get the position of the window in screen coordinantes.
8483 """
8484 return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
8485
8486 def GetScreenRect(*args, **kwargs):
8487 """
8488 GetScreenRect(self) -> Rect
8489
8490 Returns the size and position of the window in screen coordinantes as
8491 a `wx.Rect` object.
8492 """
8493 return _core_.Window_GetScreenRect(*args, **kwargs)
8494
d55e5bfc
RD		 8495 def GetSize(*args, **kwargs):
8496 """
8497 GetSize(self) -> Size
8498
8499 Get the window size.
8500 """
8501 return _core_.Window_GetSize(*args, **kwargs)
8502
8503 def GetSizeTuple(*args, **kwargs):
8504 """
8505 GetSizeTuple() -> (width, height)
8506
8507 Get the window size.
8508 """
8509 return _core_.Window_GetSizeTuple(*args, **kwargs)
8510
8511 def GetRect(*args, **kwargs):
8512 """
8513 GetRect(self) -> Rect
8514
1c71765a 8515 Returns the size and position of the window as a `wx.Rect` object.
d55e5bfc
RD		 8516 """
8517 return _core_.Window_GetRect(*args, **kwargs)
8518
8519 def GetClientSize(*args, **kwargs):
8520 """
8521 GetClientSize(self) -> Size
8522
8523 This gets the size of the window's 'client area' in pixels. The client
8524 area is the area which may be drawn on by the programmer, excluding
8525 title bar, border, scrollbars, etc.
8526 """
8527 return _core_.Window_GetClientSize(*args, **kwargs)
8528
8529 def GetClientSizeTuple(*args, **kwargs):
8530 """
8531 GetClientSizeTuple() -> (width, height)
8532
8533 This gets the size of the window's 'client area' in pixels. The client
8534 area is the area which may be drawn on by the programmer, excluding
8535 title bar, border, scrollbars, etc.
8536 """
8537 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8538
8539 def GetClientAreaOrigin(*args, **kwargs):
8540 """
8541 GetClientAreaOrigin(self) -> Point
8542
8543 Get the origin of the client area of the window relative to the
8544 window's top left corner (the client area may be shifted because of
8545 the borders, scrollbars, other decorations...)
8546 """
8547 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8548
8549 def GetClientRect(*args, **kwargs):
8550 """
8551 GetClientRect(self) -> Rect
8552
629f3c1b 8553 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD		 8554 """
8555 return _core_.Window_GetClientRect(*args, **kwargs)
8556
8557 def GetBestSize(*args, **kwargs):
8558 """
8559 GetBestSize(self) -> Size
8560
248ed943 8561 This function returns the best acceptable minimal size for the
79fccf9d
RD		 8562 window, if applicable. For example, for a static text control, it will
8563 be the minimal size such that the control label is not truncated. For
8564 windows containing subwindows (suzh aswx.Panel), the size returned by
8565 this function will be the same as the size the window would have had
8566 after calling Fit.
d55e5bfc
RD		 8567 """
8568 return _core_.Window_GetBestSize(*args, **kwargs)
8569
8570 def GetBestSizeTuple(*args, **kwargs):
8571 """
8572 GetBestSizeTuple() -> (width, height)
8573
248ed943 8574 This function returns the best acceptable minimal size for the
79fccf9d
RD		 8575 window, if applicable. For example, for a static text control, it will
8576 be the minimal size such that the control label is not truncated. For
8577 windows containing subwindows (suzh aswx.Panel), the size returned by
8578 this function will be the same as the size the window would have had
8579 after calling Fit.
d55e5bfc
RD		 8580 """
8581 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8582
a001823c
RD		 8583 def InvalidateBestSize(*args, **kwargs):
8584 """
8585 InvalidateBestSize(self)
8586
8587 Reset the cached best size value so it will be recalculated the next
8588 time it is needed.
8589 """
8590 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8591
e2813725
RD		 8592 def CacheBestSize(*args, **kwargs):
8593 """
8594 CacheBestSize(self, Size size)
8595
8596 Cache the best size so it doesn't need to be calculated again, (at least until
8597 some properties of the window change.)
8598 """
8599 return _core_.Window_CacheBestSize(*args, **kwargs)
8600
580080c5 8601 def GetEffectiveMinSize(*args, **kwargs):
a001823c 8602 """
580080c5 8603 GetEffectiveMinSize(self) -> Size
a001823c
RD		 8604
8605 This function will merge the window's best size into the window's
8606 minimum size, giving priority to the min size components, and returns
8607 the results.
8608
8609 """
580080c5 8610 return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
a001823c 8611
0d82d64e 8612 GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.')
8f514ab4
RD		 8613 def GetAdjustedBestSize(self):
8614 s = self.GetBestSize()
8615 return wx.Size(max(s.width, self.GetMinWidth()),
8616 max(s.height, self.GetMinHeight()))
580080c5 8617 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
d55e5bfc
RD		 8618
8619 def Center(*args, **kwargs):
8620 """
8621 Center(self, int direction=BOTH)
8622
8623 Centers the window. The parameter specifies the direction for
8624 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8625 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8626 on the entire screen and not on its parent window. If it is a
8627 top-level window and has no parent then it will always be centered
8628 relative to the screen.
8629 """
8630 return _core_.Window_Center(*args, **kwargs)
8631
8632 Centre = Center
d55e5bfc
RD		 8633 def CenterOnParent(*args, **kwargs):
8634 """
8635 CenterOnParent(self, int dir=BOTH)
8636
8637 Center with respect to the the parent window
8638 """
8639 return _core_.Window_CenterOnParent(*args, **kwargs)
8640
8641 CentreOnParent = CenterOnParent
8642 def Fit(*args, **kwargs):
8643 """
8644 Fit(self)
8645
8646 Sizes the window so that it fits around its subwindows. This function
8647 won't do anything if there are no subwindows and will only really work
8648 correctly if sizers are used for the subwindows layout. Also, if the
8649 window has exactly one subwindow it is better (faster and the result
8650 is more precise as Fit adds some margin to account for fuzziness of
8651 its calculations) to call window.SetClientSize(child.GetSize())
8652 instead of calling Fit.
8653 """
8654 return _core_.Window_Fit(*args, **kwargs)
8655
8656 def FitInside(*args, **kwargs):
8657 """
8658 FitInside(self)
8659
8660 Similar to Fit, but sizes the interior (virtual) size of a
8661 window. Mainly useful with scrolled windows to reset scrollbars after
8662 sizing changes that do not trigger a size event, and/or scrolled
8663 windows without an interior sizer. This function similarly won't do
8664 anything if there are no subwindows.
8665 """
8666 return _core_.Window_FitInside(*args, **kwargs)
8667
03837c5c 8668 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD		 8669 """
8670 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8671 int incH=-1)
d55e5bfc
RD		 8672
8673 Allows specification of minimum and maximum window sizes, and window
8674 size increments. If a pair of values is not set (or set to -1), the
8675 default values will be used. If this function is called, the user
908b74cd
RD		 8676 will not be able to size the window outside the given bounds (if it is
8677 a top-level window.) Sizers will also inspect the minimum window size
8678 and will use that value if set when calculating layout.
8679
8680 The resizing increments are only significant under Motif or Xt.
d55e5bfc 8681 """
03837c5c 8682 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 8683
03837c5c
RD		 8684 def SetSizeHintsSz(*args, **kwargs):
8685 """
8686 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8687
8688 Allows specification of minimum and maximum window sizes, and window
8689 size increments. If a pair of values is not set (or set to -1), the
8690 default values will be used. If this function is called, the user
8691 will not be able to size the window outside the given bounds (if it is
8692 a top-level window.) Sizers will also inspect the minimum window size
8693 and will use that value if set when calculating layout.
8694
8695 The resizing increments are only significant under Motif or Xt.
8696 """
8697 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8698
8699 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8700 """
908b74cd 8701 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD		 8702
8703 Allows specification of minimum and maximum virtual window sizes. If a
8704 pair of values is not set (or set to -1), the default values will be
8705 used. If this function is called, the user will not be able to size
8706 the virtual area of the window outside the given bounds.
8707 """
03837c5c
RD		 8708 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8709
8710 def SetVirtualSizeHintsSz(*args, **kwargs):
8711 """
8712 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8713
8714 Allows specification of minimum and maximum virtual window sizes. If a
8715 pair of values is not set (or set to -1), the default values will be
8716 used. If this function is called, the user will not be able to size
8717 the virtual area of the window outside the given bounds.
8718 """
8719 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8720
908b74cd
RD		 8721 def GetMaxSize(*args, **kwargs):
8722 """GetMaxSize(self) -> Size"""
8723 return _core_.Window_GetMaxSize(*args, **kwargs)
8724
8725 def GetMinSize(*args, **kwargs):
8726 """GetMinSize(self) -> Size"""
8727 return _core_.Window_GetMinSize(*args, **kwargs)
8728
8729 def SetMinSize(*args, **kwargs):
8730 """
8731 SetMinSize(self, Size minSize)
8732
8733 A more convenient method than `SetSizeHints` for setting just the
8734 min size.
8735 """
8736 return _core_.Window_SetMinSize(*args, **kwargs)
8737
8738 def SetMaxSize(*args, **kwargs):
8739 """
8740 SetMaxSize(self, Size maxSize)
8741
8742 A more convenient method than `SetSizeHints` for setting just the
8743 max size.
8744 """
8745 return _core_.Window_SetMaxSize(*args, **kwargs)
8746
d55e5bfc
RD		 8747 def GetMinWidth(*args, **kwargs):
8748 """GetMinWidth(self) -> int"""
8749 return _core_.Window_GetMinWidth(*args, **kwargs)
8750
8751 def GetMinHeight(*args, **kwargs):
8752 """GetMinHeight(self) -> int"""
8753 return _core_.Window_GetMinHeight(*args, **kwargs)
8754
8755 def GetMaxWidth(*args, **kwargs):
8756 """GetMaxWidth(self) -> int"""
8757 return _core_.Window_GetMaxWidth(*args, **kwargs)
8758
8759 def GetMaxHeight(*args, **kwargs):
8760 """GetMaxHeight(self) -> int"""
8761 return _core_.Window_GetMaxHeight(*args, **kwargs)
8762
d55e5bfc
RD		 8763 def SetVirtualSize(*args, **kwargs):
8764 """
8765 SetVirtualSize(self, Size size)
8766
8767 Set the the virtual size of a window in pixels. For most windows this
8768 is just the client area of the window, but for some like scrolled
8769 windows it is more or less independent of the screen window size.
8770 """
8771 return _core_.Window_SetVirtualSize(*args, **kwargs)
8772
8773 def SetVirtualSizeWH(*args, **kwargs):
8774 """
8775 SetVirtualSizeWH(self, int w, int h)
8776
8777 Set the the virtual size of a window in pixels. For most windows this
8778 is just the client area of the window, but for some like scrolled
8779 windows it is more or less independent of the screen window size.
8780 """
8781 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8782
8783 def GetVirtualSize(*args, **kwargs):
8784 """
8785 GetVirtualSize(self) -> Size
8786
8787 Get the the virtual size of the window in pixels. For most windows
8788 this is just the client area of the window, but for some like scrolled
8789 windows it is more or less independent of the screen window size.
8790 """
8791 return _core_.Window_GetVirtualSize(*args, **kwargs)
8792
8793 def GetVirtualSizeTuple(*args, **kwargs):
8794 """
8795 GetVirtualSizeTuple() -> (width, height)
8796
8797 Get the the virtual size of the window in pixels. For most windows
8798 this is just the client area of the window, but for some like scrolled
8799 windows it is more or less independent of the screen window size.
8800 """
8801 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8802
8803 def GetBestVirtualSize(*args, **kwargs):
8804 """
8805 GetBestVirtualSize(self) -> Size
8806
8807 Return the largest of ClientSize and BestSize (as determined by a
8808 sizer, interior children, or other means)
8809 """
8810 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8811
8812 def Show(*args, **kwargs):
8813 """
8814 Show(self, bool show=True) -> bool
8815
8816 Shows or hides the window. You may need to call Raise for a top level
8817 window if you want to bring it to top, although this is not needed if
8818 Show is called immediately after the frame creation. Returns True if
8819 the window has been shown or hidden or False if nothing was done
8820 because it already was in the requested state.
8821 """
8822 return _core_.Window_Show(*args, **kwargs)
8823
8824 def Hide(*args, **kwargs):
8825 """
8826 Hide(self) -> bool
8827
8828 Equivalent to calling Show(False).
8829 """
8830 return _core_.Window_Hide(*args, **kwargs)
8831
8832 def Enable(*args, **kwargs):
8833 """
8834 Enable(self, bool enable=True) -> bool
8835
8836 Enable or disable the window for user input. Note that when a parent
8837 window is disabled, all of its children are disabled as well and they
8838 are reenabled again when the parent is. Returns true if the window
8839 has been enabled or disabled, false if nothing was done, i.e. if the
8840 window had already been in the specified state.
8841 """
8842 return _core_.Window_Enable(*args, **kwargs)
8843
8844 def Disable(*args, **kwargs):
8845 """
8846 Disable(self) -> bool
8847
8848 Disables the window, same as Enable(false).
8849 """
8850 return _core_.Window_Disable(*args, **kwargs)
8851
8852 def IsShown(*args, **kwargs):
8853 """
8854 IsShown(self) -> bool
8855
8856 Returns true if the window is shown, false if it has been hidden.
8857 """
8858 return _core_.Window_IsShown(*args, **kwargs)
8859
8860 def IsEnabled(*args, **kwargs):
8861 """
8862 IsEnabled(self) -> bool
8863
8864 Returns true if the window is enabled for input, false otherwise.
8865 """
8866 return _core_.Window_IsEnabled(*args, **kwargs)
8867
33d6fd3b
RD		 8868 def IsShownOnScreen(*args, **kwargs):
8869 """
8870 IsShownOnScreen(self) -> bool
8871
8872 Returns ``True`` if the window is physically visible on the screen,
8873 i.e. it is shown and all its parents up to the toplevel window are
8874 shown as well.
8875 """
8876 return _core_.Window_IsShownOnScreen(*args, **kwargs)
8877
d55e5bfc
RD		 8878 def SetWindowStyleFlag(*args, **kwargs):
8879 """
8880 SetWindowStyleFlag(self, long style)
8881
79fccf9d
RD		 8882 Sets the style of the window. Please note that some styles cannot be
8883 changed after the window creation and that Refresh() might need to be
8884 called after changing the others for the change to take place
8885 immediately.
d55e5bfc
RD		 8886 """
8887 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8888
8889 def GetWindowStyleFlag(*args, **kwargs):
8890 """
8891 GetWindowStyleFlag(self) -> long
8892
8893 Gets the window style that was passed to the constructor or Create
8894 method.
8895 """
8896 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8897
8898 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8899 def HasFlag(*args, **kwargs):
8900 """
8901 HasFlag(self, int flag) -> bool
8902
8903 Test if the given style is set for this window.
8904 """
8905 return _core_.Window_HasFlag(*args, **kwargs)
8906
8907 def IsRetained(*args, **kwargs):
8908 """
8909 IsRetained(self) -> bool
8910
8911 Returns true if the window is retained, false otherwise. Retained
8912 windows are only available on X platforms.
8913 """
8914 return _core_.Window_IsRetained(*args, **kwargs)
8915
8916 def SetExtraStyle(*args, **kwargs):
8917 """
8918 SetExtraStyle(self, long exStyle)
8919
8920 Sets the extra style bits for the window. Extra styles are the less
8921 often used style bits which can't be set with the constructor or with
8922 SetWindowStyleFlag()
8923 """
8924 return _core_.Window_SetExtraStyle(*args, **kwargs)
8925
8926 def GetExtraStyle(*args, **kwargs):
8927 """
8928 GetExtraStyle(self) -> long
8929
8930 Returns the extra style bits for the window.
8931 """
8932 return _core_.Window_GetExtraStyle(*args, **kwargs)
8933
8934 def MakeModal(*args, **kwargs):
8935 """
8936 MakeModal(self, bool modal=True)
8937
8938 Disables all other windows in the application so that the user can
8939 only interact with this window. Passing False will reverse this
8940 effect.
8941 """
8942 return _core_.Window_MakeModal(*args, **kwargs)
8943
8944 def SetThemeEnabled(*args, **kwargs):
8945 """
8946 SetThemeEnabled(self, bool enableTheme)
8947
8948 This function tells a window if it should use the system's "theme"
8949 code to draw the windows' background instead if its own background
8950 drawing code. This will only have an effect on platforms that support
8951 the notion of themes in user defined windows. One such platform is
8952 GTK+ where windows can have (very colourful) backgrounds defined by a
8953 user's selected theme.
8954
8955 Dialogs, notebook pages and the status bar have this flag set to true
8956 by default so that the default look and feel is simulated best.
8957 """
8958 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8959
8960 def GetThemeEnabled(*args, **kwargs):
8961 """
8962 GetThemeEnabled(self) -> bool
8963
8964 Return the themeEnabled flag.
8965 """
8966 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8967
8968 def SetFocus(*args, **kwargs):
8969 """
8970 SetFocus(self)
8971
8972 Set's the focus to this window, allowing it to receive keyboard input.
8973 """
8974 return _core_.Window_SetFocus(*args, **kwargs)
8975
8976 def SetFocusFromKbd(*args, **kwargs):
8977 """
8978 SetFocusFromKbd(self)
8979
8980 Set focus to this window as the result of a keyboard action. Normally
8981 only called internally.
8982 """
8983 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8984
8985 def FindFocus(*args, **kwargs):
8986 """
c24da6d6 8987 FindFocus() -> Window
d55e5bfc
RD		 8988
8989 Returns the window or control that currently has the keyboard focus,
8990 or None.
8991 """
8992 return _core_.Window_FindFocus(*args, **kwargs)
8993
8994 FindFocus = staticmethod(FindFocus)
8995 def AcceptsFocus(*args, **kwargs):
8996 """
8997 AcceptsFocus(self) -> bool
8998
8999 Can this window have focus?
9000 """
9001 return _core_.Window_AcceptsFocus(*args, **kwargs)
9002
9003 def AcceptsFocusFromKeyboard(*args, **kwargs):
9004 """
9005 AcceptsFocusFromKeyboard(self) -> bool
9006
9007 Can this window be given focus by keyboard navigation? if not, the
9008 only way to give it focus (provided it accepts it at all) is to click
9009 it.
9010 """
9011 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
9012
908b74cd
RD		 9013 def Navigate(*args, **kwargs):
9014 """
9015 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
9016
a8eff060
RD		 9017 Does keyboard navigation from this window to another, by sending a
9018 `wx.NavigationKeyEvent`.
908b74cd
RD		 9019 """
9020 return _core_.Window_Navigate(*args, **kwargs)
9021
bf26d883
RD		 9022 def MoveAfterInTabOrder(*args, **kwargs):
9023 """
9024 MoveAfterInTabOrder(self, Window win)
9025
9026 Moves this window in the tab navigation order after the specified
9027 sibling window. This means that when the user presses the TAB key on
9028 that other window, the focus switches to this window.
9029
9030 The default tab order is the same as creation order. This function
9031 and `MoveBeforeInTabOrder` allow to change it after creating all the
9032 windows.
9033
9034 """
9035 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
9036
9037 def MoveBeforeInTabOrder(*args, **kwargs):
9038 """
9039 MoveBeforeInTabOrder(self, Window win)
9040
9041 Same as `MoveAfterInTabOrder` except that it inserts this window just
9042 before win instead of putting it right after it.
9043 """
9044 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
9045
d55e5bfc
RD		 9046 def GetChildren(*args, **kwargs):
9047 """
9048 GetChildren(self) -> PyObject
9049
9050 Returns a list of the window's children. NOTE: Currently this is a
9051 copy of the child window list maintained by the window, so the return
9052 value of this function is only valid as long as the window's children
9053 do not change.
9054 """
9055 return _core_.Window_GetChildren(*args, **kwargs)
9056
9057 def GetParent(*args, **kwargs):
9058 """
9059 GetParent(self) -> Window
9060
9061 Returns the parent window of this window, or None if there isn't one.
9062 """
9063 return _core_.Window_GetParent(*args, **kwargs)
9064
9065 def GetGrandParent(*args, **kwargs):
9066 """
9067 GetGrandParent(self) -> Window
9068
79fccf9d
RD		 9069 Returns the parent of the parent of this window, or None if there
9070 isn't one.
d55e5bfc
RD		 9071 """
9072 return _core_.Window_GetGrandParent(*args, **kwargs)
9073
9074 def IsTopLevel(*args, **kwargs):
9075 """
9076 IsTopLevel(self) -> bool
9077
9078 Returns true if the given window is a top-level one. Currently all
9079 frames and dialogs are always considered to be top-level windows (even
9080 if they have a parent window).
9081 """
9082 return _core_.Window_IsTopLevel(*args, **kwargs)
9083
9084 def Reparent(*args, **kwargs):
9085 """
9086 Reparent(self, Window newParent) -> bool
9087
9088 Reparents the window, i.e the window will be removed from its current
9089 parent window (e.g. a non-standard toolbar in a wxFrame) and then
9090 re-inserted into another. Available on Windows and GTK. Returns True
9091 if the parent was changed, False otherwise (error or newParent ==
9092 oldParent)
9093 """
9094 return _core_.Window_Reparent(*args, **kwargs)
9095
9096 def AddChild(*args, **kwargs):
9097 """
9098 AddChild(self, Window child)
9099
9100 Adds a child window. This is called automatically by window creation
9101 functions so should not be required by the application programmer.
9102 """
9103 return _core_.Window_AddChild(*args, **kwargs)
9104
9105 def RemoveChild(*args, **kwargs):
9106 """
9107 RemoveChild(self, Window child)
9108
9109 Removes a child window. This is called automatically by window
9110 deletion functions so should not be required by the application
9111 programmer.
9112 """
9113 return _core_.Window_RemoveChild(*args, **kwargs)
9114
704eda0c
RD		 9115 def SetDoubleBuffered(*args, **kwargs):
9116 """
9117 SetDoubleBuffered(self, bool on)
9118
9119 Currently wxGTK2 only.
9120 """
9121 return _core_.Window_SetDoubleBuffered(*args, **kwargs)
9122
d55e5bfc
RD		 9123 def FindWindowById(*args, **kwargs):
9124 """
9125 FindWindowById(self, long winid) -> Window
9126
9127 Find a chld of this window by window ID
9128 """
9129 return _core_.Window_FindWindowById(*args, **kwargs)
9130
9131 def FindWindowByName(*args, **kwargs):
9132 """
9133 FindWindowByName(self, String name) -> Window
9134
9135 Find a child of this window by name
9136 """
9137 return _core_.Window_FindWindowByName(*args, **kwargs)
9138
9139 def GetEventHandler(*args, **kwargs):
9140 """
9141 GetEventHandler(self) -> EvtHandler
9142
9143 Returns the event handler for this window. By default, the window is
9144 its own event handler.
9145 """
9146 return _core_.Window_GetEventHandler(*args, **kwargs)
9147
9148 def SetEventHandler(*args, **kwargs):
9149 """
9150 SetEventHandler(self, EvtHandler handler)
9151
9152 Sets the event handler for this window. An event handler is an object
d49bdf34
RD		 9153 that is capable of processing the events sent to a window. (In other
9154 words, is able to dispatch the events to handler function.) By
9155 default, the window is its own event handler, but an application may
9156 wish to substitute another, for example to allow central
9157 implementation of event-handling for a variety of different window
9158 classes.
d55e5bfc 9159
79fccf9d 9160 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc 9161 up a chain of event handlers, where an event not handled by one event
d49bdf34 9162 handler is handed off to the next one in the chain.
d55e5bfc
RD		 9163 """
9164 return _core_.Window_SetEventHandler(*args, **kwargs)
9165
9166 def PushEventHandler(*args, **kwargs):
9167 """
9168 PushEventHandler(self, EvtHandler handler)
9169
9170 Pushes this event handler onto the event handler stack for the window.
9171 An event handler is an object that is capable of processing the events
d49bdf34
RD		 9172 sent to a window. (In other words, is able to dispatch the events to
9173 handler function.) By default, the window is its own event handler,
9174 but an application may wish to substitute another, for example to
9175 allow central implementation of event-handling for a variety of
9176 different window classes.
d55e5bfc
RD		 9177
9178 wx.Window.PushEventHandler allows an application to set up a chain of
9179 event handlers, where an event not handled by one event handler is
d49bdf34
RD		 9180 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
9181 to remove the event handler. Ownership of the handler is *not* given
9182 to the window, so you should be sure to pop the handler before the
9183 window is destroyed and either let PopEventHandler destroy it, or call
9184 its Destroy method yourself.
d55e5bfc
RD		 9185 """
9186 return _core_.Window_PushEventHandler(*args, **kwargs)
9187
9188 def PopEventHandler(*args, **kwargs):
9189 """
9190 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9191
9192 Removes and returns the top-most event handler on the event handler
9193 stack. If deleteHandler is True then the wx.EvtHandler object will be
d49bdf34 9194 destroyed after it is popped, and ``None`` will be returned instead.
d55e5bfc
RD		 9195 """
9196 return _core_.Window_PopEventHandler(*args, **kwargs)
9197
9198 def RemoveEventHandler(*args, **kwargs):
9199 """
9200 RemoveEventHandler(self, EvtHandler handler) -> bool
9201
79fccf9d 9202 Find the given handler in the event handler chain and remove (but not
d49bdf34 9203 delete) it from the event handler chain, returns True if it was found
79fccf9d
RD		 9204 and False otherwise (this also results in an assert failure so this
9205 function should only be called when the handler is supposed to be
9206 there.)
d55e5bfc
RD		 9207 """
9208 return _core_.Window_RemoveEventHandler(*args, **kwargs)
9209
9210 def SetValidator(*args, **kwargs):
9211 """
9212 SetValidator(self, Validator validator)
9213
9214 Deletes the current validator (if any) and sets the window validator,
9215 having called wx.Validator.Clone to create a new validator of this
9216 type.
9217 """
9218 return _core_.Window_SetValidator(*args, **kwargs)
9219
9220 def GetValidator(*args, **kwargs):
9221 """
9222 GetValidator(self) -> Validator
9223
9224 Returns a pointer to the current validator for the window, or None if
9225 there is none.
9226 """
9227 return _core_.Window_GetValidator(*args, **kwargs)
9228
9229 def Validate(*args, **kwargs):
9230 """
9231 Validate(self) -> bool
9232
9233 Validates the current values of the child controls using their
79fccf9d
RD		 9234 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9235 style flag set, the method will also call Validate() of all child
9236 windows. Returns false if any of the validations failed.
d55e5bfc
RD		 9237 """
9238 return _core_.Window_Validate(*args, **kwargs)
9239
9240 def TransferDataToWindow(*args, **kwargs):
9241 """
9242 TransferDataToWindow(self) -> bool
9243
79fccf9d
RD		 9244 Transfers values to child controls from data areas specified by their
9245 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9246 style flag set, the method will also call TransferDataToWindow() of
9247 all child windows.
d55e5bfc
RD		 9248 """
9249 return _core_.Window_TransferDataToWindow(*args, **kwargs)
9250
9251 def TransferDataFromWindow(*args, **kwargs):
9252 """
9253 TransferDataFromWindow(self) -> bool
9254
79fccf9d
RD		 9255 Transfers values from child controls to data areas specified by their
9256 validators. Returns false if a transfer failed. If the window has
9257 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9258 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD		 9259 """
9260 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9261
9262 def InitDialog(*args, **kwargs):
9263 """
9264 InitDialog(self)
9265
79fccf9d
RD		 9266 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9267 to the dialog via validators.
d55e5bfc
RD		 9268 """
9269 return _core_.Window_InitDialog(*args, **kwargs)
9270
9271 def SetAcceleratorTable(*args, **kwargs):
9272 """
9273 SetAcceleratorTable(self, AcceleratorTable accel)
9274
9275 Sets the accelerator table for this window.
9276 """
9277 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9278
9279 def GetAcceleratorTable(*args, **kwargs):
9280 """
9281 GetAcceleratorTable(self) -> AcceleratorTable
9282
9283 Gets the accelerator table for this window.
9284 """
9285 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9286
9287 def RegisterHotKey(*args, **kwargs):
9288 """
9289 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9290
9291 Registers a system wide hotkey. Every time the user presses the hotkey
9292 registered here, this window will receive a hotkey event. It will
9293 receive the event even if the application is in the background and
9294 does not have the input focus because the user is working with some
9295 other application. To bind an event handler function to this hotkey
9296 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9297 hotkey was registered successfully.
9298 """
9299 return _core_.Window_RegisterHotKey(*args, **kwargs)
9300
9301 def UnregisterHotKey(*args, **kwargs):
9302 """
9303 UnregisterHotKey(self, int hotkeyId) -> bool
9304
9305 Unregisters a system wide hotkey.
9306 """
9307 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9308
9309 def ConvertDialogPointToPixels(*args, **kwargs):
9310 """
9311 ConvertDialogPointToPixels(self, Point pt) -> Point
9312
9313 Converts a point or size from dialog units to pixels. Dialog units
9314 are used for maintaining a dialog's proportions even if the font
9315 changes. For the x dimension, the dialog units are multiplied by the
9316 average character width and then divided by 4. For the y dimension,
9317 the dialog units are multiplied by the average character height and
9318 then divided by 8.
9319 """
9320 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9321
9322 def ConvertDialogSizeToPixels(*args, **kwargs):
9323 """
9324 ConvertDialogSizeToPixels(self, Size sz) -> Size
9325
9326 Converts a point or size from dialog units to pixels. Dialog units
9327 are used for maintaining a dialog's proportions even if the font
9328 changes. For the x dimension, the dialog units are multiplied by the
9329 average character width and then divided by 4. For the y dimension,
9330 the dialog units are multiplied by the average character height and
9331 then divided by 8.
9332 """
9333 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9334
9335 def DLG_PNT(*args, **kwargs):
9336 """
9337 DLG_PNT(self, Point pt) -> Point
9338
9339 Converts a point or size from dialog units to pixels. Dialog units
9340 are used for maintaining a dialog's proportions even if the font
9341 changes. For the x dimension, the dialog units are multiplied by the
9342 average character width and then divided by 4. For the y dimension,
9343 the dialog units are multiplied by the average character height and
9344 then divided by 8.
9345 """
9346 return _core_.Window_DLG_PNT(*args, **kwargs)
9347
9348 def DLG_SZE(*args, **kwargs):
9349 """
9350 DLG_SZE(self, Size sz) -> Size
9351
9352 Converts a point or size from dialog units to pixels. Dialog units
9353 are used for maintaining a dialog's proportions even if the font
9354 changes. For the x dimension, the dialog units are multiplied by the
9355 average character width and then divided by 4. For the y dimension,
9356 the dialog units are multiplied by the average character height and
9357 then divided by 8.
9358 """
9359 return _core_.Window_DLG_SZE(*args, **kwargs)
9360
9361 def ConvertPixelPointToDialog(*args, **kwargs):
9362 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9363 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9364
9365 def ConvertPixelSizeToDialog(*args, **kwargs):
9366 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9367 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9368
9369 def WarpPointer(*args, **kwargs):
9370 """
9371 WarpPointer(self, int x, int y)
9372
9373 Moves the pointer to the given position on the window.
9374
9375 NOTE: This function is not supported under Mac because Apple Human
9376 Interface Guidelines forbid moving the mouse cursor programmatically.
9377 """
9378 return _core_.Window_WarpPointer(*args, **kwargs)
9379
9380 def CaptureMouse(*args, **kwargs):
9381 """
9382 CaptureMouse(self)
9383
9384 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9385 release the capture.
9386
9387 Note that wxWindows maintains the stack of windows having captured the
9388 mouse and when the mouse is released the capture returns to the window
9389 which had had captured it previously and it is only really released if
9390 there were no previous window. In particular, this means that you must
0f83f5da
RD		 9391 release the mouse as many times as you capture it, unless the window
9392 receives the `wx.MouseCaptureLostEvent` event.
9393
9394 Any application which captures the mouse in the beginning of some
9395 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
9396 operation when it receives the event. The event handler must not
9397 recapture mouse.
d55e5bfc
RD		 9398 """
9399 return _core_.Window_CaptureMouse(*args, **kwargs)
9400
9401 def ReleaseMouse(*args, **kwargs):
9402 """
9403 ReleaseMouse(self)
9404
9405 Releases mouse input captured with wx.Window.CaptureMouse.
9406 """
9407 return _core_.Window_ReleaseMouse(*args, **kwargs)
9408
9409 def GetCapture(*args, **kwargs):
9410 """
c24da6d6 9411 GetCapture() -> Window
d55e5bfc
RD		 9412
9413 Returns the window which currently captures the mouse or None
9414 """
9415 return _core_.Window_GetCapture(*args, **kwargs)
9416
9417 GetCapture = staticmethod(GetCapture)
9418 def HasCapture(*args, **kwargs):
9419 """
9420 HasCapture(self) -> bool
9421
9422 Returns true if this window has the current mouse capture.
9423 """
9424 return _core_.Window_HasCapture(*args, **kwargs)
9425
9426 def Refresh(*args, **kwargs):
9427 """
9428 Refresh(self, bool eraseBackground=True, Rect rect=None)
9429
9430 Mark the specified rectangle (or the whole window) as "dirty" so it
9431 will be repainted. Causes an EVT_PAINT event to be generated and sent
9432 to the window.
9433 """
9434 return _core_.Window_Refresh(*args, **kwargs)
9435
9436 def RefreshRect(*args, **kwargs):
9437 """
fef4c27a 9438 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD		 9439
9440 Redraws the contents of the given rectangle: the area inside it will
9441 be repainted. This is the same as Refresh but has a nicer syntax.
9442 """
9443 return _core_.Window_RefreshRect(*args, **kwargs)
9444
9445 def Update(*args, **kwargs):
9446 """
9447 Update(self)
9448
9449 Calling this method immediately repaints the invalidated area of the
9450 window instead of waiting for the EVT_PAINT event to happen, (normally
9451 this would usually only happen when the flow of control returns to the
9452 event loop.) Notice that this function doesn't refresh the window and
9b940138 9453 does nothing if the window has been already repainted. Use `Refresh`
d55e5bfc
RD		 9454 first if you want to immediately redraw the window (or some portion of
9455 it) unconditionally.
9456 """
9457 return _core_.Window_Update(*args, **kwargs)
9458
9459 def ClearBackground(*args, **kwargs):
9460 """
9461 ClearBackground(self)
9462
9463 Clears the window by filling it with the current background
9464 colour. Does not cause an erase background event to be generated.
9465 """
9466 return _core_.Window_ClearBackground(*args, **kwargs)
9467
9468 def Freeze(*args, **kwargs):
9469 """
9470 Freeze(self)
9471
79fccf9d
RD		 9472 Freezes the window or, in other words, prevents any updates from
9473 taking place on screen, the window is not redrawn at all. Thaw must be
9474 called to reenable window redrawing. Calls to Freeze/Thaw may be
9475 nested, with the actual Thaw being delayed until all the nesting has
9476 been undone.
d55e5bfc
RD		 9477
9478 This method is useful for visual appearance optimization (for example,
9479 it is a good idea to use it before inserting large amount of text into
9480 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9481 for all controls so it is mostly just a hint to wxWindows and not a
9482 mandatory directive.
9483 """
9484 return _core_.Window_Freeze(*args, **kwargs)
9485
33d6fd3b
RD		 9486 def IsFrozen(*args, **kwargs):
9487 """
9488 IsFrozen(self) -> bool
9489
9490 Returns ``True`` if the window has been frozen and not thawed yet.
9491
9492 :see: `Freeze` and `Thaw`
9493 """
9494 return _core_.Window_IsFrozen(*args, **kwargs)
9495
d55e5bfc
RD		 9496 def Thaw(*args, **kwargs):
9497 """
9498 Thaw(self)
9499
9500 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD		 9501 Freeze/Thaw may be nested, so Thaw must be called the same number of
9502 times that Freeze was before the window will be updated.
d55e5bfc
RD		 9503 """
9504 return _core_.Window_Thaw(*args, **kwargs)
9505
9506 def PrepareDC(*args, **kwargs):
9507 """
9508 PrepareDC(self, DC dc)
9509
9510 Call this function to prepare the device context for drawing a
9511 scrolled image. It sets the device origin according to the current
9512 scroll position.
9513 """
9514 return _core_.Window_PrepareDC(*args, **kwargs)
9515
b39fe951
RD		 9516 def IsDoubleBuffered(*args, **kwargs):
9517 """
9518 IsDoubleBuffered(self) -> bool
9519
9520 Returns ``True`` if the window contents is double-buffered by the
9521 system, i.e. if any drawing done on the window is really done on a
9522 temporary backing surface and transferred to the screen all at once
9523 later.
9524 """
9525 return _core_.Window_IsDoubleBuffered(*args, **kwargs)
9526
d55e5bfc
RD		 9527 def GetUpdateRegion(*args, **kwargs):
9528 """
9529 GetUpdateRegion(self) -> Region
9530
9531 Returns the region specifying which parts of the window have been
9532 damaged. Should only be called within an EVT_PAINT handler.
9533 """
9534 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9535
9536 def GetUpdateClientRect(*args, **kwargs):
9537 """
9538 GetUpdateClientRect(self) -> Rect
9539
9540 Get the update rectangle region bounding box in client coords.
9541 """
9542 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9543
9544 def IsExposed(*args, **kwargs):
9545 """
9546 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9547
9548 Returns true if the given point or rectangle area has been exposed
9549 since the last repaint. Call this in an paint event handler to
9550 optimize redrawing by only redrawing those areas, which have been
9551 exposed.
9552 """
9553 return _core_.Window_IsExposed(*args, **kwargs)
9554
9555 def IsExposedPoint(*args, **kwargs):
9556 """
9557 IsExposedPoint(self, Point pt) -> bool
9558
9559 Returns true if the given point or rectangle area has been exposed
9560 since the last repaint. Call this in an paint event handler to
9561 optimize redrawing by only redrawing those areas, which have been
9562 exposed.
9563 """
9564 return _core_.Window_IsExposedPoint(*args, **kwargs)
9565
9566 def IsExposedRect(*args, **kwargs):
9567 """
9568 IsExposedRect(self, Rect rect) -> bool
9569
9570 Returns true if the given point or rectangle area has been exposed
9571 since the last repaint. Call this in an paint event handler to
9572 optimize redrawing by only redrawing those areas, which have been
9573 exposed.
9574 """
9575 return _core_.Window_IsExposedRect(*args, **kwargs)
9576
9577 def GetDefaultAttributes(*args, **kwargs):
9578 """
9579 GetDefaultAttributes(self) -> VisualAttributes
9580
79fccf9d
RD		 9581 Get the default attributes for an instance of this class. This is
9582 useful if you want to use the same font or colour in your own control
9583 as in a standard control -- which is a much better idea than hard
9584 coding specific colours or fonts which might look completely out of
caef1a4d 9585 place on the user's system, especially if it uses themes.
d55e5bfc
RD		 9586 """
9587 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9588
9589 def GetClassDefaultAttributes(*args, **kwargs):
9590 """
c24da6d6 9591 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 9592
79fccf9d
RD		 9593 Get the default attributes for this class. This is useful if you want
9594 to use the same font or colour in your own control as in a standard
9595 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 9596 colours or fonts which might look completely out of place on the
9597 user's system, especially if it uses themes.
d55e5bfc
RD		 9598
9599 The variant parameter is only relevant under Mac currently and is
79fccf9d 9600 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 9601 the returned font. See `wx.Window.SetWindowVariant` for more about
9602 this.
d55e5bfc
RD		 9603 """
9604 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9605
9606 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9607 def SetBackgroundColour(*args, **kwargs):
9608 """
9609 SetBackgroundColour(self, Colour colour) -> bool
9610
9611 Sets the background colour of the window. Returns True if the colour
9612 was changed. The background colour is usually painted by the default
9613 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 9614 automatically under GTK. Using `wx.NullColour` will reset the window
9615 to the default background colour.
d55e5bfc 9616
caef1a4d 9617 Note that setting the background colour may not cause an immediate
f8167d6e 9618 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD		 9619 calling this function.
9620
f8167d6e
RD		 9621 Using this function will disable attempts to use themes for this
9622 window, if the system supports them. Use with care since usually the
9623 themes represent the appearance chosen by the user to be used for all
9624 applications on the system.
d55e5bfc
RD		 9625 """
9626 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9627
412d302d
RD		 9628 def SetOwnBackgroundColour(*args, **kwargs):
9629 """SetOwnBackgroundColour(self, Colour colour)"""
9630 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 9631
9632 def SetForegroundColour(*args, **kwargs):
9633 """
9634 SetForegroundColour(self, Colour colour) -> bool
9635
9636 Sets the foreground colour of the window. Returns True is the colour
9637 was changed. The interpretation of foreground colour is dependent on
9638 the window class; it may be the text colour or other colour, or it may
9639 not be used at all.
9640 """
9641 return _core_.Window_SetForegroundColour(*args, **kwargs)
9642
fa47d7a7
VS		 9643 def SetOwnForegroundColour(*args, **kwargs):
9644 """SetOwnForegroundColour(self, Colour colour)"""
9645 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD		 9646
9647 def GetBackgroundColour(*args, **kwargs):
9648 """
9649 GetBackgroundColour(self) -> Colour
9650
9651 Returns the background colour of the window.
9652 """
9653 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9654
9655 def GetForegroundColour(*args, **kwargs):
9656 """
9657 GetForegroundColour(self) -> Colour
9658
9659 Returns the foreground colour of the window. The interpretation of
9660 foreground colour is dependent on the window class; it may be the text
9661 colour or other colour, or it may not be used at all.
9662 """
9663 return _core_.Window_GetForegroundColour(*args, **kwargs)
9664
dcb8fc74
RD		 9665 def InheritsBackgroundColour(*args, **kwargs):
9666 """InheritsBackgroundColour(self) -> bool"""
9667 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9668
9669 def UseBgCol(*args, **kwargs):
9670 """UseBgCol(self) -> bool"""
9671 return _core_.Window_UseBgCol(*args, **kwargs)
9672
0f63ec68
RD		 9673 def SetBackgroundStyle(*args, **kwargs):
9674 """
9675 SetBackgroundStyle(self, int style) -> bool
9676
9677 Returns the background style of the window. The background style
9678 indicates how the background of the window is drawn.
9679
9680 ====================== ========================================
9681 wx.BG_STYLE_SYSTEM The background colour or pattern should
9682 be determined by the system
9683 wx.BG_STYLE_COLOUR The background should be a solid colour
9684 wx.BG_STYLE_CUSTOM The background will be implemented by the
9685 application.
9686 ====================== ========================================
9687
9688 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9689 a custom background, such as a tiled bitmap. Currently the style has
9690 no effect on other platforms.
9691
9692 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9693 """
9694 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9695
9696 def GetBackgroundStyle(*args, **kwargs):
9697 """
9698 GetBackgroundStyle(self) -> int
9699
9700 Returns the background style of the window.
9701
9702 :see: `SetBackgroundStyle`
9703 """
9704 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9705
51b83b37
RD		 9706 def HasTransparentBackground(*args, **kwargs):
9707 """
9708 HasTransparentBackground(self) -> bool
9709
9710 Returns True if this window's background is transparent (as, for
9711 example, for `wx.StaticText`) and should show the parent window's
9712 background.
9713
9714 This method is mostly used internally by the library itself and you
9715 normally shouldn't have to call it. You may, however, have to override
9716 it in your custom control classes to ensure that background is painted
9717 correctly.
9718 """
9719 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9720
d55e5bfc
RD		 9721 def SetCursor(*args, **kwargs):
9722 """
9723 SetCursor(self, Cursor cursor) -> bool
9724
9725 Sets the window's cursor. Notice that the window cursor also sets it
9726 for the children of the window implicitly.
9727
9728 The cursor may be wx.NullCursor in which case the window cursor will
9729 be reset back to default.
9730 """
9731 return _core_.Window_SetCursor(*args, **kwargs)
9732
9733 def GetCursor(*args, **kwargs):
9734 """
9735 GetCursor(self) -> Cursor
9736
9737 Return the cursor associated with this window.
9738 """
9739 return _core_.Window_GetCursor(*args, **kwargs)
9740
9741 def SetFont(*args, **kwargs):
9742 """
9743 SetFont(self, Font font) -> bool
9744
9745 Sets the font for this window.
9746 """
9747 return _core_.Window_SetFont(*args, **kwargs)
9748
fa47d7a7
VS		 9749 def SetOwnFont(*args, **kwargs):
9750 """SetOwnFont(self, Font font)"""
9751 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD		 9752
9753 def GetFont(*args, **kwargs):
9754 """
9755 GetFont(self) -> Font
9756
9757 Returns the default font used for this window.
9758 """
9759 return _core_.Window_GetFont(*args, **kwargs)
9760
9761 def SetCaret(*args, **kwargs):
9762 """
9763 SetCaret(self, Caret caret)
9764
9765 Sets the caret associated with the window.
9766 """
9767 return _core_.Window_SetCaret(*args, **kwargs)
9768
9769 def GetCaret(*args, **kwargs):
9770 """
9771 GetCaret(self) -> Caret
9772
9773 Returns the caret associated with the window.
9774 """
9775 return _core_.Window_GetCaret(*args, **kwargs)
9776
9777 def GetCharHeight(*args, **kwargs):
9778 """
9779 GetCharHeight(self) -> int
9780
9781 Get the (average) character size for the current font.
9782 """
9783 return _core_.Window_GetCharHeight(*args, **kwargs)
9784
9785 def GetCharWidth(*args, **kwargs):
9786 """
9787 GetCharWidth(self) -> int
9788
9789 Get the (average) character size for the current font.
9790 """
9791 return _core_.Window_GetCharWidth(*args, **kwargs)
9792
9793 def GetTextExtent(*args, **kwargs):
a8eff060
RD		 9794 """
9795 GetTextExtent(String string) -> (width, height)
9796
9797 Get the width and height of the text using the current font.
9798 """
d55e5bfc
RD		 9799 return _core_.Window_GetTextExtent(*args, **kwargs)
9800
9801 def GetFullTextExtent(*args, **kwargs):
9802 """
9803 GetFullTextExtent(String string, Font font=None) ->
9804 (width, height, descent, externalLeading)
9805
9806 Get the width, height, decent and leading of the text using the
9807 current or specified font.
9808 """
9809 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9810
9811 def ClientToScreenXY(*args, **kwargs):
9812 """
9813 ClientToScreenXY(int x, int y) -> (x,y)
9814
9815 Converts to screen coordinates from coordinates relative to this window.
9816 """
9817 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9818
9819 def ScreenToClientXY(*args, **kwargs):
9820 """
9821 ScreenToClientXY(int x, int y) -> (x,y)
9822
9823 Converts from screen to client window coordinates.
9824 """
9825 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9826
9827 def ClientToScreen(*args, **kwargs):
9828 """
9829 ClientToScreen(self, Point pt) -> Point
9830
9831 Converts to screen coordinates from coordinates relative to this window.
9832 """
9833 return _core_.Window_ClientToScreen(*args, **kwargs)
9834
9835 def ScreenToClient(*args, **kwargs):
9836 """
9837 ScreenToClient(self, Point pt) -> Point
9838
9839 Converts from screen to client window coordinates.
9840 """
9841 return _core_.Window_ScreenToClient(*args, **kwargs)
9842
9843 def HitTestXY(*args, **kwargs):
9844 """
9845 HitTestXY(self, int x, int y) -> int
9846
9847 Test where the given (in client coords) point lies
9848 """
9849 return _core_.Window_HitTestXY(*args, **kwargs)
9850
9851 def HitTest(*args, **kwargs):
9852 """
9853 HitTest(self, Point pt) -> int
9854
9855 Test where the given (in client coords) point lies
9856 """
9857 return _core_.Window_HitTest(*args, **kwargs)
9858
9859 def GetBorder(*args):
9860 """
9861 GetBorder(self, long flags) -> int
9862 GetBorder(self) -> int
9863
9864 Get border for the flags of this window
9865 """
9866 return _core_.Window_GetBorder(*args)
9867
9868 def UpdateWindowUI(*args, **kwargs):
9869 """
9870 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9871
9872 This function sends EVT_UPDATE_UI events to the window. The particular
9873 implementation depends on the window; for example a wx.ToolBar will
9874 send an update UI event for each toolbar button, and a wx.Frame will
9875 send an update UI event for each menubar menu item. You can call this
9876 function from your application to ensure that your UI is up-to-date at
9877 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9878 concerned). This may be necessary if you have called
5ba5649b 9879 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD		 9880 limit the overhead that wxWindows incurs by sending update UI events
9881 in idle time.
d55e5bfc
RD		 9882 """
9883 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9884
9885 def PopupMenuXY(*args, **kwargs):
9886 """
7a0b95b0 9887 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9888
7a0b95b0
RD		 9889 Pops up the given menu at the specified coordinates, relative to this window,
9890 and returns control when the user has dismissed the menu. If a menu item is
9891 selected, the corresponding menu event is generated and will be processed as
9892 usual. If the default position is given then the current position of the
9893 mouse cursor will be used.
d55e5bfc
RD		 9894 """
9895 return _core_.Window_PopupMenuXY(*args, **kwargs)
9896
9897 def PopupMenu(*args, **kwargs):
9898 """
7a0b95b0 9899 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9900
7a0b95b0
RD		 9901 Pops up the given menu at the specified coordinates, relative to this window,
9902 and returns control when the user has dismissed the menu. If a menu item is
9903 selected, the corresponding menu event is generated and will be processed as
9904 usual. If the default position is given then the current position of the
9905 mouse cursor will be used.
d55e5bfc
RD		 9906 """
9907 return _core_.Window_PopupMenu(*args, **kwargs)
9908
1eeb270e
RD		 9909 def HasMultiplePages(*args, **kwargs):
9910 """HasMultiplePages(self) -> bool"""
9911 return _core_.Window_HasMultiplePages(*args, **kwargs)
9912
d55e5bfc
RD		 9913 def GetHandle(*args, **kwargs):
9914 """
9915 GetHandle(self) -> long
9916
9917 Returns the platform-specific handle (as a long integer) of the
9918 physical window. Currently on wxMac it returns the handle of the
9919 toplevel parent of the window.
9920 """
9921 return _core_.Window_GetHandle(*args, **kwargs)
9922
629e65c2
RD		 9923 def AssociateHandle(*args, **kwargs):
9924 """
9925 AssociateHandle(self, long handle)
9926
9927 Associate the window with a new native handle
9928 """
9929 return _core_.Window_AssociateHandle(*args, **kwargs)
9930
9931 def DissociateHandle(*args, **kwargs):
9932 """
9933 DissociateHandle(self)
9934
9935 Dissociate the current native handle from the window
9936 """
9937 return _core_.Window_DissociateHandle(*args, **kwargs)
9938
d55e5bfc
RD		 9939 def OnPaint(*args, **kwargs):
9940 """OnPaint(self, PaintEvent event)"""
9941 return _core_.Window_OnPaint(*args, **kwargs)
9942
9943 def HasScrollbar(*args, **kwargs):
9944 """
9945 HasScrollbar(self, int orient) -> bool
9946
9947 Does the window have the scrollbar for this orientation?
9948 """
9949 return _core_.Window_HasScrollbar(*args, **kwargs)
9950
9951 def SetScrollbar(*args, **kwargs):
9952 """
79fccf9d 9953 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD		 9954 bool refresh=True)
9955
9956 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD		 9957 """
9958 return _core_.Window_SetScrollbar(*args, **kwargs)
9959
9960 def SetScrollPos(*args, **kwargs):
9961 """
9962 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9963
9964 Sets the position of one of the built-in scrollbars.
9965 """
9966 return _core_.Window_SetScrollPos(*args, **kwargs)
9967
9968 def GetScrollPos(*args, **kwargs):
9969 """
9970 GetScrollPos(self, int orientation) -> int
9971
9972 Returns the built-in scrollbar position.
9973 """
9974 return _core_.Window_GetScrollPos(*args, **kwargs)
9975
9976 def GetScrollThumb(*args, **kwargs):
9977 """
9978 GetScrollThumb(self, int orientation) -> int
9979
9980 Returns the built-in scrollbar thumb size.
9981 """
9982 return _core_.Window_GetScrollThumb(*args, **kwargs)
9983
9984 def GetScrollRange(*args, **kwargs):
9985 """
9986 GetScrollRange(self, int orientation) -> int
9987
9988 Returns the built-in scrollbar range.
9989 """
9990 return _core_.Window_GetScrollRange(*args, **kwargs)
9991
9992 def ScrollWindow(*args, **kwargs):
9993 """
9994 ScrollWindow(self, int dx, int dy, Rect rect=None)
9995
9996 Physically scrolls the pixels in the window and move child windows
9997 accordingly. Use this function to optimise your scrolling
9998 implementations, to minimise the area that must be redrawn. Note that
9999 it is rarely required to call this function from a user program.
d55e5bfc
RD		 10000 """
10001 return _core_.Window_ScrollWindow(*args, **kwargs)
10002
10003 def ScrollLines(*args, **kwargs):
10004 """
10005 ScrollLines(self, int lines) -> bool
10006
10007 If the platform and window class supports it, scrolls the window by
10008 the given number of lines down, if lines is positive, or up if lines
10009 is negative. Returns True if the window was scrolled, False if it was
10010 already on top/bottom and nothing was done.
10011 """
10012 return _core_.Window_ScrollLines(*args, **kwargs)
10013
10014 def ScrollPages(*args, **kwargs):
10015 """
10016 ScrollPages(self, int pages) -> bool
10017
79fccf9d 10018 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD		 10019 the given number of pages down, if pages is positive, or up if pages
10020 is negative. Returns True if the window was scrolled, False if it was
10021 already on top/bottom and nothing was done.
10022 """
10023 return _core_.Window_ScrollPages(*args, **kwargs)
10024
10025 def LineUp(*args, **kwargs):
10026 """
10027 LineUp(self) -> bool
10028
10029 This is just a wrapper for ScrollLines(-1).
10030 """
10031 return _core_.Window_LineUp(*args, **kwargs)
10032
10033 def LineDown(*args, **kwargs):
10034 """
10035 LineDown(self) -> bool
10036
10037 This is just a wrapper for ScrollLines(1).
10038 """
10039 return _core_.Window_LineDown(*args, **kwargs)
10040
10041 def PageUp(*args, **kwargs):
10042 """
10043 PageUp(self) -> bool
10044
10045 This is just a wrapper for ScrollPages(-1).
10046 """
10047 return _core_.Window_PageUp(*args, **kwargs)
10048
10049 def PageDown(*args, **kwargs):
10050 """
10051 PageDown(self) -> bool
10052
10053 This is just a wrapper for ScrollPages(1).
10054 """
10055 return _core_.Window_PageDown(*args, **kwargs)
10056
10057 def SetHelpText(*args, **kwargs):
10058 """
10059 SetHelpText(self, String text)
10060
10061 Sets the help text to be used as context-sensitive help for this
10062 window. Note that the text is actually stored by the current
f52cbe90 10063 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 10064 """
10065 return _core_.Window_SetHelpText(*args, **kwargs)
10066
10067 def SetHelpTextForId(*args, **kwargs):
10068 """
10069 SetHelpTextForId(self, String text)
10070
10071 Associate this help text with all windows with the same id as this
10072 one.
10073 """
10074 return _core_.Window_SetHelpTextForId(*args, **kwargs)
10075
b850e7f3
RD		 10076 def GetHelpTextAtPoint(*args, **kwargs):
10077 """
10078 GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
10079
10080 Get the help string associated with the given position in this window.
10081
10082 Notice that pt may be invalid if event origin is keyboard or unknown
10083 and this method should return the global window help text then
10084
10085 """
10086 return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
10087
d55e5bfc
RD		 10088 def GetHelpText(*args, **kwargs):
10089 """
10090 GetHelpText(self) -> String
10091
10092 Gets the help text to be used as context-sensitive help for this
10093 window. Note that the text is actually stored by the current
f52cbe90 10094 `wx.HelpProvider` implementation, and not in the window object itself.
d55e5bfc
RD		 10095 """
10096 return _core_.Window_GetHelpText(*args, **kwargs)
10097
10098 def SetToolTipString(*args, **kwargs):
10099 """
10100 SetToolTipString(self, String tip)
10101
10102 Attach a tooltip to the window.
10103 """
10104 return _core_.Window_SetToolTipString(*args, **kwargs)
10105
10106 def SetToolTip(*args, **kwargs):
10107 """
10108 SetToolTip(self, ToolTip tip)
10109
10110 Attach a tooltip to the window.
10111 """
10112 return _core_.Window_SetToolTip(*args, **kwargs)
10113
10114 def GetToolTip(*args, **kwargs):
10115 """
10116 GetToolTip(self) -> ToolTip
10117
10118 get the associated tooltip or None if none
10119 """
10120 return _core_.Window_GetToolTip(*args, **kwargs)
10121
10122 def SetDropTarget(*args, **kwargs):
10123 """
10124 SetDropTarget(self, DropTarget dropTarget)
10125
10126 Associates a drop target with this window. If the window already has
10127 a drop target, it is deleted.
10128 """
10129 return _core_.Window_SetDropTarget(*args, **kwargs)
10130
10131 def GetDropTarget(*args, **kwargs):
10132 """
10133 GetDropTarget(self) -> DropTarget
10134
10135 Returns the associated drop target, which may be None.
10136 """
10137 return _core_.Window_GetDropTarget(*args, **kwargs)
10138
10139 def DragAcceptFiles(*args, **kwargs):
10140 """
10141 DragAcceptFiles(self, bool accept)
10142
10143 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
5ba5649b 10144 Only functional on Windows.
d55e5bfc
RD		 10145 """
10146 return _core_.Window_DragAcceptFiles(*args, **kwargs)
10147
10148 def SetConstraints(*args, **kwargs):
10149 """
10150 SetConstraints(self, LayoutConstraints constraints)
10151
10152 Sets the window to have the given layout constraints. If an existing
10153 layout constraints object is already owned by the window, it will be
10154 deleted. Pass None to disassociate and delete the window's current
10155 constraints.
10156
10157 You must call SetAutoLayout to tell a window to use the constraints
10158 automatically in its default EVT_SIZE handler; otherwise, you must
10159 handle EVT_SIZE yourself and call Layout() explicitly. When setting
10160 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
10161 effect.
10162 """
10163 return _core_.Window_SetConstraints(*args, **kwargs)
10164
10165 def GetConstraints(*args, **kwargs):
10166 """
10167 GetConstraints(self) -> LayoutConstraints
10168
10169 Returns a pointer to the window's layout constraints, or None if there
10170 are none.
10171 """
10172 return _core_.Window_GetConstraints(*args, **kwargs)
10173
10174 def SetAutoLayout(*args, **kwargs):
10175 """
10176 SetAutoLayout(self, bool autoLayout)
10177
10178 Determines whether the Layout function will be called automatically
b1fcee84
RD		 10179 when the window is resized. lease note that this only happens for the
10180 windows usually used to contain children, namely `wx.Panel` and
10181 `wx.TopLevelWindow` (and the classes deriving from them).
10182
10183 This method is called implicitly by `SetSizer` but if you use
10184 `SetConstraints` you should call it manually or otherwise the window
10185 layout won't be correctly updated when its size changes.
d55e5bfc
RD		 10186 """
10187 return _core_.Window_SetAutoLayout(*args, **kwargs)
10188
10189 def GetAutoLayout(*args, **kwargs):
10190 """
10191 GetAutoLayout(self) -> bool
10192
10193 Returns the current autoLayout setting
10194 """
10195 return _core_.Window_GetAutoLayout(*args, **kwargs)
10196
10197 def Layout(*args, **kwargs):
10198 """
10199 Layout(self) -> bool
10200
10201 Invokes the constraint-based layout algorithm or the sizer-based
10202 algorithm for this window. See SetAutoLayout: when auto layout is on,
10203 this function gets called automatically by the default EVT_SIZE
10204 handler when the window is resized.
10205 """
10206 return _core_.Window_Layout(*args, **kwargs)
10207
10208 def SetSizer(*args, **kwargs):
10209 """
10210 SetSizer(self, Sizer sizer, bool deleteOld=True)
10211
10212 Sets the window to have the given layout sizer. The window will then
10213 own the object, and will take care of its deletion. If an existing
10214 layout sizer object is already owned by the window, it will be deleted
10215 if the deleteOld parameter is true. Note that this function will also
10216 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10217 non-None, and False otherwise.
d55e5bfc
RD		 10218 """
10219 return _core_.Window_SetSizer(*args, **kwargs)
10220
10221 def SetSizerAndFit(*args, **kwargs):
10222 """
10223 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10224
10225 The same as SetSizer, except it also sets the size hints for the
10226 window based on the sizer's minimum size.
10227 """
10228 return _core_.Window_SetSizerAndFit(*args, **kwargs)
10229
10230 def GetSizer(*args, **kwargs):
10231 """
10232 GetSizer(self) -> Sizer
10233
10234 Return the sizer associated with the window by a previous call to
10235 SetSizer or None if there isn't one.
10236 """
10237 return _core_.Window_GetSizer(*args, **kwargs)
10238
10239 def SetContainingSizer(*args, **kwargs):
10240 """
10241 SetContainingSizer(self, Sizer sizer)
10242
10243 This normally does not need to be called by application code. It is
10244 called internally when a window is added to a sizer, and is used so
10245 the window can remove itself from the sizer when it is destroyed.
10246 """
10247 return _core_.Window_SetContainingSizer(*args, **kwargs)
10248
10249 def GetContainingSizer(*args, **kwargs):
10250 """
10251 GetContainingSizer(self) -> Sizer
10252
10253 Return the sizer that this window is a member of, if any, otherwise None.
10254 """
10255 return _core_.Window_GetContainingSizer(*args, **kwargs)
10256
10257 def InheritAttributes(*args, **kwargs):
10258 """
10259 InheritAttributes(self)
10260
79fccf9d
RD		 10261 This function is (or should be, in case of custom controls) called
10262 during window creation to intelligently set up the window visual
10263 attributes, that is the font and the foreground and background
10264 colours.
10265
10266 By 'intelligently' the following is meant: by default, all windows use
10267 their own default attributes. However if some of the parent's
10268 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10269 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD		 10270 explicitly set for this window itself, then this window takes the same
10271 value as used by the parent. In addition, if the window overrides
10272 ShouldInheritColours to return false, the colours will not be changed
10273 no matter what and only the font might.
10274
ec9b55ca
RD		 10275 This rather complicated logic is necessary in order to accommodate the
10276 different usage scenarios. The most common one is when all default
79fccf9d
RD		 10277 attributes are used and in this case, nothing should be inherited as
10278 in modern GUIs different controls use different fonts (and colours)
10279 than their siblings so they can't inherit the same value from the
10280 parent. However it was also deemed desirable to allow to simply change
10281 the attributes of all children at once by just changing the font or
10282 colour of their common parent, hence in this case we do inherit the
10283 parents attributes.
10284
d55e5bfc
RD		 10285 """
10286 return _core_.Window_InheritAttributes(*args, **kwargs)
10287
10288 def ShouldInheritColours(*args, **kwargs):
10289 """
10290 ShouldInheritColours(self) -> bool
10291
10292 Return true from here to allow the colours of this window to be
79fccf9d
RD		 10293 changed by InheritAttributes, returning false forbids inheriting them
10294 from the parent window.
d55e5bfc 10295
79fccf9d
RD		 10296 The base class version returns false, but this method is overridden in
10297 wxControl where it returns true.
d55e5bfc
RD		 10298 """
10299 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10300
fc46b7f3
RD		 10301 def CanSetTransparent(*args, **kwargs):
10302 """
10303 CanSetTransparent(self) -> bool
10304
10305 Returns ``True`` if the platform supports setting the transparency for
10306 this window. Note that this method will err on the side of caution,
10307 so it is possible that this will return ``False`` when it is in fact
10308 possible to set the transparency.
10309
10310 NOTE: On X-windows systems the X server must have the composite
10311 extension loaded, and there must be a composite manager program (such
10312 as xcompmgr) running.
10313 """
10314 return _core_.Window_CanSetTransparent(*args, **kwargs)
10315
10316 def SetTransparent(*args, **kwargs):
10317 """
10318 SetTransparent(self, byte alpha) -> bool
10319
10320 Attempt to set the transparency of this window to the ``alpha`` value,
10321 returns True on success. The ``alpha`` value is an integer in the
10322 range of 0 to 255, where 0 is fully transparent and 255 is fully
10323 opaque.
10324 """
10325 return _core_.Window_SetTransparent(*args, **kwargs)
10326
d55e5bfc
RD		 10327 def PostCreate(self, pre):
10328 """
10329 Phase 3 of the 2-phase create <wink!>
10330 Call this method after precreating the window with the 2-phase create method.
10331 """
10332 self.this = pre.this
10333 self.thisown = pre.thisown
10334 pre.thisown = 0
10335 if hasattr(self, '_setOORInfo'):
10336 self._setOORInfo(self)
10337 if hasattr(self, '_setCallbackInfo'):
c25f90f6 10338 self._setCallbackInfo(self, pre.__class__)
d55e5bfc 10339
7e08d4ef 10340 def SendSizeEvent(self):
0ef86618 10341 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
7e08d4ef 10342
226118fc
RD		 10343 AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`")
10344 AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`")
10345 AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`")
10346 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
10347 BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")
580080c5 10348 EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`")
226118fc
RD		 10349 BestSize = property(GetBestSize,doc="See `GetBestSize`")
10350 BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`")
10351 Border = property(GetBorder,doc="See `GetBorder`")
10352 Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`")
10353 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
10354 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
10355 Children = property(GetChildren,doc="See `GetChildren`")
10356 ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`")
10357 ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`")
10358 ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`")
10359 Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`")
10360 ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`")
10361 Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
10362 DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`")
10363 DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`")
10364 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10365 ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`")
10366 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
10367 ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`")
226118fc
RD		 10368 GrandParent = property(GetGrandParent,doc="See `GetGrandParent`")
10369 Handle = property(GetHandle,doc="See `GetHandle`")
10370 HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`")
226118fc
RD		 10371 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
10372 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
994453b8 10373 LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`")
226118fc
RD		 10374 MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`")
10375 MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`")
10376 MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`")
10377 MinHeight = property(GetMinHeight,doc="See `GetMinHeight`")
10378 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
10379 MinWidth = property(GetMinWidth,doc="See `GetMinWidth`")
10380 Name = property(GetName,SetName,doc="See `GetName` and `SetName`")
10381 Parent = property(GetParent,doc="See `GetParent`")
10382 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
10383 Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
10384 ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`")
10385 ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`")
226118fc
RD		 10386 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
10387 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
226118fc
RD		 10388 ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`")
10389 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
10390 UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`")
10391 UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`")
10392 Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`")
10393 VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`")
10394 WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`")
10395 WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`")
10396 WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`")
97ab0f6a
RD		 10397 Shown = property(IsShown,Show,doc="See `IsShown` and `Show`")
10398 Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`")
10399 TopLevel = property(IsTopLevel,doc="See `IsTopLevel`")
2131d850 10400_core_.Window_swigregister(Window)
d55e5bfc
RD		 10401
10402def PreWindow(*args, **kwargs):
10403 """
10404 PreWindow() -> Window
10405
10406 Precreate a Window for 2-phase creation.
10407 """
10408 val = _core_.new_PreWindow(*args, **kwargs)
d55e5bfc
RD		 10409 return val
10410
554f62e9
RD		 10411def Window_NewControlId(*args):
10412 """
d55e5bfc
RD		 10413 Window_NewControlId() -> int
10414
10415 Generate a control id for the controls which were not given one.
10416 """
554f62e9 10417 return _core_.Window_NewControlId(*args)
d55e5bfc
RD		 10418
10419def Window_NextControlId(*args, **kwargs):
554f62e9 10420 """
d55e5bfc
RD		 10421 Window_NextControlId(int winid) -> int
10422
10423 Get the id of the control following the one with the given
79fccf9d 10424 autogenerated) id
d55e5bfc 10425 """
554f62e9 10426 return _core_.Window_NextControlId(*args, **kwargs)
d55e5bfc
RD		 10427
10428def Window_PrevControlId(*args, **kwargs):
554f62e9 10429 """
d55e5bfc
RD		 10430 Window_PrevControlId(int winid) -> int
10431
10432 Get the id of the control preceding the one with the given
79fccf9d 10433 autogenerated) id
d55e5bfc 10434 """
554f62e9 10435 return _core_.Window_PrevControlId(*args, **kwargs)
d55e5bfc 10436
554f62e9
RD		 10437def Window_FindFocus(*args):
10438 """
d55e5bfc
RD		 10439 Window_FindFocus() -> Window
10440
10441 Returns the window or control that currently has the keyboard focus,
10442 or None.
10443 """
554f62e9 10444 return _core_.Window_FindFocus(*args)
d55e5bfc 10445
554f62e9
RD		 10446def Window_GetCapture(*args):
10447 """
d55e5bfc
RD		 10448 Window_GetCapture() -> Window
10449
10450 Returns the window which currently captures the mouse or None
10451 """
554f62e9 10452 return _core_.Window_GetCapture(*args)
d55e5bfc
RD		 10453
10454def Window_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 10455 """
d55e5bfc
RD		 10456 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10457
79fccf9d
RD		 10458 Get the default attributes for this class. This is useful if you want
10459 to use the same font or colour in your own control as in a standard
10460 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 10461 colours or fonts which might look completely out of place on the
10462 user's system, especially if it uses themes.
d55e5bfc
RD		 10463
10464 The variant parameter is only relevant under Mac currently and is
79fccf9d 10465 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 10466 the returned font. See `wx.Window.SetWindowVariant` for more about
10467 this.
d55e5bfc 10468 """
554f62e9 10469 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 10470
10471def DLG_PNT(win, point_or_x, y=None):
10472 """
10473 Convenience function for converting a Point or (x,y) in
10474 dialog units to pixel units.
10475 """
10476 if y is None:
10477 return win.ConvertDialogPointToPixels(point_or_x)
10478 else:
10479 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10480
10481def DLG_SZE(win, size_width, height=None):
10482 """
10483 Convenience function for converting a Size or (w,h) in
10484 dialog units to pixel units.
10485 """
10486 if height is None:
10487 return win.ConvertDialogSizeToPixels(size_width)
10488 else:
10489 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10490
10491
10492def FindWindowById(*args, **kwargs):
554f62e9 10493 """
d55e5bfc
RD		 10494 FindWindowById(long id, Window parent=None) -> Window
10495
10496 Find the first window in the application with the given id. If parent
10497 is None, the search will start from all top-level frames and dialog
10498 boxes; if non-None, the search will be limited to the given window
10499 hierarchy. The search is recursive in both cases.
10500 """
554f62e9 10501 return _core_.FindWindowById(*args, **kwargs)
d55e5bfc
RD		 10502
10503def FindWindowByName(*args, **kwargs):
554f62e9 10504 """
d55e5bfc
RD		 10505 FindWindowByName(String name, Window parent=None) -> Window
10506
10507 Find a window by its name (as given in a window constructor or Create
10508 function call). If parent is None, the search will start from all
10509 top-level frames and dialog boxes; if non-None, the search will be
10510 limited to the given window hierarchy. The search is recursive in both
10511 cases.
10512
10513 If no window with such name is found, wx.FindWindowByLabel is called.
10514 """
554f62e9 10515 return _core_.FindWindowByName(*args, **kwargs)
d55e5bfc
RD		 10516
10517def FindWindowByLabel(*args, **kwargs):
554f62e9 10518 """
d55e5bfc
RD		 10519 FindWindowByLabel(String label, Window parent=None) -> Window
10520
10521 Find a window by its label. Depending on the type of window, the label
10522 may be a window title or panel item label. If parent is None, the
10523 search will start from all top-level frames and dialog boxes; if
10524 non-None, the search will be limited to the given window
10525 hierarchy. The search is recursive in both cases.
10526 """
554f62e9 10527 return _core_.FindWindowByLabel(*args, **kwargs)
d55e5bfc
RD		 10528
10529def Window_FromHWND(*args, **kwargs):
554f62e9
RD		 10530 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10531 return _core_.Window_FromHWND(*args, **kwargs)
3215336e 10532
554f62e9
RD		 10533def GetTopLevelWindows(*args):
10534 """
3215336e
RD		 10535 GetTopLevelWindows() -> PyObject
10536
10537 Returns a list of the the application's top-level windows, (frames,
10538 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10539 by wxWidgets, and so it is only valid as long as no top-level windows
10540 are closed or new top-level windows are created.
10541
10542 """
554f62e9 10543 return _core_.GetTopLevelWindows(*args)
d55e5bfc
RD		 10544#---------------------------------------------------------------------------
10545
10546class Validator(EvtHandler):
093d3ff1 10547 """Proxy of C++ Validator class"""
554f62e9
RD		 10548 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10549 __repr__ = _swig_repr
10550 def __init__(self, *args, **kwargs):
d55e5bfc 10551 """__init__(self) -> Validator"""
554f62e9 10552 _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
d55e5bfc
RD		 10553 self._setOORInfo(self)
10554
10555 def Clone(*args, **kwargs):
10556 """Clone(self) -> Validator"""
10557 return _core_.Validator_Clone(*args, **kwargs)
10558
10559 def Validate(*args, **kwargs):
10560 """Validate(self, Window parent) -> bool"""
10561 return _core_.Validator_Validate(*args, **kwargs)
10562
10563 def TransferToWindow(*args, **kwargs):
10564 """TransferToWindow(self) -> bool"""
10565 return _core_.Validator_TransferToWindow(*args, **kwargs)
10566
10567 def TransferFromWindow(*args, **kwargs):
10568 """TransferFromWindow(self) -> bool"""
10569 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10570
10571 def GetWindow(*args, **kwargs):
10572 """GetWindow(self) -> Window"""
10573 return _core_.Validator_GetWindow(*args, **kwargs)
10574
10575 def SetWindow(*args, **kwargs):
10576 """SetWindow(self, Window window)"""
10577 return _core_.Validator_SetWindow(*args, **kwargs)
10578
10579 def IsSilent(*args, **kwargs):
c24da6d6 10580 """IsSilent() -> bool"""
d55e5bfc
RD		 10581 return _core_.Validator_IsSilent(*args, **kwargs)
10582
10583 IsSilent = staticmethod(IsSilent)
10584 def SetBellOnError(*args, **kwargs):
c24da6d6 10585 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD		 10586 return _core_.Validator_SetBellOnError(*args, **kwargs)
10587
10588 SetBellOnError = staticmethod(SetBellOnError)
dba7934c 10589 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 10590_core_.Validator_swigregister(Validator)
d55e5bfc 10591
554f62e9
RD		 10592def Validator_IsSilent(*args):
10593 """Validator_IsSilent() -> bool"""
10594 return _core_.Validator_IsSilent(*args)
d55e5bfc
RD		 10595
10596def Validator_SetBellOnError(*args, **kwargs):
554f62e9
RD		 10597 """Validator_SetBellOnError(int doIt=True)"""
10598 return _core_.Validator_SetBellOnError(*args, **kwargs)
d55e5bfc
RD		 10599
10600class PyValidator(Validator):
093d3ff1 10601 """Proxy of C++ PyValidator class"""
554f62e9
RD		 10602 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10603 __repr__ = _swig_repr
10604 def __init__(self, *args, **kwargs):
d55e5bfc 10605 """__init__(self) -> PyValidator"""
554f62e9 10606 _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
c25f90f6 10607 self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator)
d55e5bfc
RD		 10608
10609 def _setCallbackInfo(*args, **kwargs):
c25f90f6 10610 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)"""
d55e5bfc
RD		 10611 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10612
2131d850 10613_core_.PyValidator_swigregister(PyValidator)
d55e5bfc
RD		 10614
10615#---------------------------------------------------------------------------
10616
10617class Menu(EvtHandler):
093d3ff1 10618 """Proxy of C++ Menu class"""
554f62e9
RD		 10619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10620 __repr__ = _swig_repr
10621 def __init__(self, *args, **kwargs):
d55e5bfc 10622 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
554f62e9 10623 _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
d55e5bfc
RD		 10624 self._setOORInfo(self)
10625
10626 def Append(*args, **kwargs):
97ab0f6a
RD		 10627 """
10628 Append(self, int id, String text=EmptyString, String help=EmptyString,
10629 int kind=ITEM_NORMAL) -> MenuItem
10630 """
d55e5bfc
RD		 10631 return _core_.Menu_Append(*args, **kwargs)
10632
10633 def AppendSeparator(*args, **kwargs):
10634 """AppendSeparator(self) -> MenuItem"""
10635 return _core_.Menu_AppendSeparator(*args, **kwargs)
10636
10637 def AppendCheckItem(*args, **kwargs):
10638 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10639 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10640
10641 def AppendRadioItem(*args, **kwargs):
10642 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10643 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10644
10645 def AppendMenu(*args, **kwargs):
10646 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10647 return _core_.Menu_AppendMenu(*args, **kwargs)
10648
50efceee
RD		 10649 def AppendSubMenu(*args, **kwargs):
10650 """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem"""
10651 return _core_.Menu_AppendSubMenu(*args, **kwargs)
10652
d55e5bfc
RD		 10653 def AppendItem(*args, **kwargs):
10654 """AppendItem(self, MenuItem item) -> MenuItem"""
10655 return _core_.Menu_AppendItem(*args, **kwargs)
10656
d55e5bfc
RD		 10657 def InsertItem(*args, **kwargs):
10658 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10659 return _core_.Menu_InsertItem(*args, **kwargs)
10660
554f62e9
RD		 10661 def PrependItem(*args, **kwargs):
10662 """PrependItem(self, MenuItem item) -> MenuItem"""
10663 return _core_.Menu_PrependItem(*args, **kwargs)
10664
10665 def Break(*args, **kwargs):
10666 """Break(self)"""
10667 return _core_.Menu_Break(*args, **kwargs)
10668
d55e5bfc
RD		 10669 def Insert(*args, **kwargs):
10670 """
97ab0f6a 10671 Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString,
d55e5bfc
RD		 10672 int kind=ITEM_NORMAL) -> MenuItem
10673 """
10674 return _core_.Menu_Insert(*args, **kwargs)
10675
10676 def InsertSeparator(*args, **kwargs):
10677 """InsertSeparator(self, size_t pos) -> MenuItem"""
10678 return _core_.Menu_InsertSeparator(*args, **kwargs)
10679
10680 def InsertCheckItem(*args, **kwargs):
10681 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10682 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10683
10684 def InsertRadioItem(*args, **kwargs):
10685 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10686 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10687
10688 def InsertMenu(*args, **kwargs):
10689 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10690 return _core_.Menu_InsertMenu(*args, **kwargs)
10691
d55e5bfc 10692 def Prepend(*args, **kwargs):
97ab0f6a
RD		 10693 """
10694 Prepend(self, int id, String text=EmptyString, String help=EmptyString,
10695 int kind=ITEM_NORMAL) -> MenuItem
10696 """
d55e5bfc
RD		 10697 return _core_.Menu_Prepend(*args, **kwargs)
10698
10699 def PrependSeparator(*args, **kwargs):
10700 """PrependSeparator(self) -> MenuItem"""
10701 return _core_.Menu_PrependSeparator(*args, **kwargs)
10702
10703 def PrependCheckItem(*args, **kwargs):
10704 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10705 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10706
10707 def PrependRadioItem(*args, **kwargs):
10708 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10709 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10710
10711 def PrependMenu(*args, **kwargs):
10712 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10713 return _core_.Menu_PrependMenu(*args, **kwargs)
10714
10715 def Remove(*args, **kwargs):
10716 """Remove(self, int id) -> MenuItem"""
10717 return _core_.Menu_Remove(*args, **kwargs)
10718
10719 def RemoveItem(*args, **kwargs):
10720 """RemoveItem(self, MenuItem item) -> MenuItem"""
10721 return _core_.Menu_RemoveItem(*args, **kwargs)
10722
10723 def Delete(*args, **kwargs):
10724 """Delete(self, int id) -> bool"""
10725 return _core_.Menu_Delete(*args, **kwargs)
10726
10727 def DeleteItem(*args, **kwargs):
10728 """DeleteItem(self, MenuItem item) -> bool"""
10729 return _core_.Menu_DeleteItem(*args, **kwargs)
10730
10731 def Destroy(*args, **kwargs):
10732 """
10733 Destroy(self)
10734
10735 Deletes the C++ object this Python object is a proxy for.
10736 """
b39fe951
RD		 10737 args[0].this.own(False)
10738 return _core_.Menu_Destroy(*args, **kwargs)
d55e5bfc
RD		 10739
10740 def DestroyId(*args, **kwargs):
b39fe951
RD		 10741 """DestroyId(self, int id) -> bool"""
10742 return _core_.Menu_DestroyId(*args, **kwargs)
d55e5bfc
RD		 10743
10744 def DestroyItem(*args, **kwargs):
b39fe951
RD		 10745 """DestroyItem(self, MenuItem item) -> bool"""
10746 return _core_.Menu_DestroyItem(*args, **kwargs)
d55e5bfc
RD		 10747
10748 def GetMenuItemCount(*args, **kwargs):
10749 """GetMenuItemCount(self) -> size_t"""
10750 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10751
10752 def GetMenuItems(*args, **kwargs):
10753 """GetMenuItems(self) -> PyObject"""
10754 return _core_.Menu_GetMenuItems(*args, **kwargs)
10755
10756 def FindItem(*args, **kwargs):
10757 """FindItem(self, String item) -> int"""
10758 return _core_.Menu_FindItem(*args, **kwargs)
10759
10760 def FindItemById(*args, **kwargs):
10761 """FindItemById(self, int id) -> MenuItem"""
10762 return _core_.Menu_FindItemById(*args, **kwargs)
10763
10764 def FindItemByPosition(*args, **kwargs):
10765 """FindItemByPosition(self, size_t position) -> MenuItem"""
10766 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10767
10768 def Enable(*args, **kwargs):
10769 """Enable(self, int id, bool enable)"""
10770 return _core_.Menu_Enable(*args, **kwargs)
10771
10772 def IsEnabled(*args, **kwargs):
10773 """IsEnabled(self, int id) -> bool"""
10774 return _core_.Menu_IsEnabled(*args, **kwargs)
10775
10776 def Check(*args, **kwargs):
10777 """Check(self, int id, bool check)"""
10778 return _core_.Menu_Check(*args, **kwargs)
10779
10780 def IsChecked(*args, **kwargs):
10781 """IsChecked(self, int id) -> bool"""
10782 return _core_.Menu_IsChecked(*args, **kwargs)
10783
10784 def SetLabel(*args, **kwargs):
10785 """SetLabel(self, int id, String label)"""
10786 return _core_.Menu_SetLabel(*args, **kwargs)
10787
10788 def GetLabel(*args, **kwargs):
10789 """GetLabel(self, int id) -> String"""
10790 return _core_.Menu_GetLabel(*args, **kwargs)
10791
10792 def SetHelpString(*args, **kwargs):
10793 """SetHelpString(self, int id, String helpString)"""
10794 return _core_.Menu_SetHelpString(*args, **kwargs)
10795
10796 def GetHelpString(*args, **kwargs):
10797 """GetHelpString(self, int id) -> String"""
10798 return _core_.Menu_GetHelpString(*args, **kwargs)
10799
10800 def SetTitle(*args, **kwargs):
10801 """SetTitle(self, String title)"""
10802 return _core_.Menu_SetTitle(*args, **kwargs)
10803
10804 def GetTitle(*args, **kwargs):
10805 """GetTitle(self) -> String"""
10806 return _core_.Menu_GetTitle(*args, **kwargs)
10807
10808 def SetEventHandler(*args, **kwargs):
10809 """SetEventHandler(self, EvtHandler handler)"""
10810 return _core_.Menu_SetEventHandler(*args, **kwargs)
10811
10812 def GetEventHandler(*args, **kwargs):
10813 """GetEventHandler(self) -> EvtHandler"""
10814 return _core_.Menu_GetEventHandler(*args, **kwargs)
10815
10816 def SetInvokingWindow(*args, **kwargs):
10817 """SetInvokingWindow(self, Window win)"""
10818 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10819
10820 def GetInvokingWindow(*args, **kwargs):
10821 """GetInvokingWindow(self) -> Window"""
10822 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10823
10824 def GetStyle(*args, **kwargs):
10825 """GetStyle(self) -> long"""
10826 return _core_.Menu_GetStyle(*args, **kwargs)
10827
10828 def UpdateUI(*args, **kwargs):
10829 """UpdateUI(self, EvtHandler source=None)"""
10830 return _core_.Menu_UpdateUI(*args, **kwargs)
10831
10832 def GetMenuBar(*args, **kwargs):
10833 """GetMenuBar(self) -> MenuBar"""
10834 return _core_.Menu_GetMenuBar(*args, **kwargs)
10835
10836 def Attach(*args, **kwargs):
10837 """Attach(self, wxMenuBarBase menubar)"""
10838 return _core_.Menu_Attach(*args, **kwargs)
10839
10840 def Detach(*args, **kwargs):
10841 """Detach(self)"""
10842 return _core_.Menu_Detach(*args, **kwargs)
10843
10844 def IsAttached(*args, **kwargs):
10845 """IsAttached(self) -> bool"""
10846 return _core_.Menu_IsAttached(*args, **kwargs)
10847
10848 def SetParent(*args, **kwargs):
10849 """SetParent(self, Menu parent)"""
10850 return _core_.Menu_SetParent(*args, **kwargs)
10851
10852 def GetParent(*args, **kwargs):
10853 """GetParent(self) -> Menu"""
10854 return _core_.Menu_GetParent(*args, **kwargs)
10855
57332a5a
RD		 10856 EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`")
10857 HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`")
10858 InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`")
10859 MenuBar = property(GetMenuBar,doc="See `GetMenuBar`")
10860 MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`")
10861 MenuItems = property(GetMenuItems,doc="See `GetMenuItems`")
10862 Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`")
10863 Style = property(GetStyle,doc="See `GetStyle`")
10864 Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`")
2131d850 10865_core_.Menu_swigregister(Menu)
d55e5bfc
RD		 10866DefaultValidator = cvar.DefaultValidator
10867
10868#---------------------------------------------------------------------------
10869
10870class MenuBar(Window):
093d3ff1 10871 """Proxy of C++ MenuBar class"""
554f62e9
RD		 10872 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
10873 __repr__ = _swig_repr
10874 def __init__(self, *args, **kwargs):
d55e5bfc 10875 """__init__(self, long style=0) -> MenuBar"""
554f62e9 10876 _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
d55e5bfc
RD		 10877 self._setOORInfo(self)
10878
10879 def Append(*args, **kwargs):
10880 """Append(self, Menu menu, String title) -> bool"""
10881 return _core_.MenuBar_Append(*args, **kwargs)
10882
10883 def Insert(*args, **kwargs):
10884 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10885 return _core_.MenuBar_Insert(*args, **kwargs)
10886
10887 def GetMenuCount(*args, **kwargs):
10888 """GetMenuCount(self) -> size_t"""
10889 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10890
10891 def GetMenu(*args, **kwargs):
10892 """GetMenu(self, size_t pos) -> Menu"""
10893 return _core_.MenuBar_GetMenu(*args, **kwargs)
10894
10895 def Replace(*args, **kwargs):
10896 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10897 return _core_.MenuBar_Replace(*args, **kwargs)
10898
10899 def Remove(*args, **kwargs):
10900 """Remove(self, size_t pos) -> Menu"""
10901 return _core_.MenuBar_Remove(*args, **kwargs)
10902
10903 def EnableTop(*args, **kwargs):
10904 """EnableTop(self, size_t pos, bool enable)"""
10905 return _core_.MenuBar_EnableTop(*args, **kwargs)
10906
10907 def IsEnabledTop(*args, **kwargs):
10908 """IsEnabledTop(self, size_t pos) -> bool"""
10909 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10910
10911 def SetLabelTop(*args, **kwargs):
10912 """SetLabelTop(self, size_t pos, String label)"""
10913 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10914
10915 def GetLabelTop(*args, **kwargs):
10916 """GetLabelTop(self, size_t pos) -> String"""
10917 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10918
10919 def FindMenuItem(*args, **kwargs):
10920 """FindMenuItem(self, String menu, String item) -> int"""
10921 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10922
10923 def FindItemById(*args, **kwargs):
10924 """FindItemById(self, int id) -> MenuItem"""
10925 return _core_.MenuBar_FindItemById(*args, **kwargs)
10926
10927 def FindMenu(*args, **kwargs):
10928 """FindMenu(self, String title) -> int"""
10929 return _core_.MenuBar_FindMenu(*args, **kwargs)
10930
10931 def Enable(*args, **kwargs):
10932 """Enable(self, int id, bool enable)"""
10933 return _core_.MenuBar_Enable(*args, **kwargs)
10934
10935 def Check(*args, **kwargs):
10936 """Check(self, int id, bool check)"""
10937 return _core_.MenuBar_Check(*args, **kwargs)
10938
10939 def IsChecked(*args, **kwargs):
10940 """IsChecked(self, int id) -> bool"""
10941 return _core_.MenuBar_IsChecked(*args, **kwargs)
10942
10943 def IsEnabled(*args, **kwargs):
10944 """IsEnabled(self, int id) -> bool"""
10945 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10946
10947 def SetLabel(*args, **kwargs):
10948 """SetLabel(self, int id, String label)"""
10949 return _core_.MenuBar_SetLabel(*args, **kwargs)
10950
10951 def GetLabel(*args, **kwargs):
10952 """GetLabel(self, int id) -> String"""
10953 return _core_.MenuBar_GetLabel(*args, **kwargs)
10954
10955 def SetHelpString(*args, **kwargs):
10956 """SetHelpString(self, int id, String helpString)"""
10957 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10958
10959 def GetHelpString(*args, **kwargs):
10960 """GetHelpString(self, int id) -> String"""
10961 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10962
10963 def GetFrame(*args, **kwargs):
10964 """GetFrame(self) -> wxFrame"""
10965 return _core_.MenuBar_GetFrame(*args, **kwargs)
10966
10967 def IsAttached(*args, **kwargs):
10968 """IsAttached(self) -> bool"""
10969 return _core_.MenuBar_IsAttached(*args, **kwargs)
10970
10971 def Attach(*args, **kwargs):
10972 """Attach(self, wxFrame frame)"""
10973 return _core_.MenuBar_Attach(*args, **kwargs)
10974
10975 def Detach(*args, **kwargs):
10976 """Detach(self)"""
10977 return _core_.MenuBar_Detach(*args, **kwargs)
10978
587d0f36
RD		 10979 def UpdateMenus(*args, **kwargs):
10980 """UpdateMenus(self)"""
10981 return _core_.MenuBar_UpdateMenus(*args, **kwargs)
10982
db67f999
RD		 10983 def SetAutoWindowMenu(*args, **kwargs):
10984 """SetAutoWindowMenu(bool enable)"""
10985 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10986
10987 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10988 def GetAutoWindowMenu(*args, **kwargs):
10989 """GetAutoWindowMenu() -> bool"""
10990 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10991
10992 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
97ab0f6a
RD		 10993 def GetMenus(self):
10994 """Return a list of (menu, label) items for the menus in the MenuBar. """
10995 return [(self.GetMenu(i), self.GetLabelTop(i))
10996 for i in range(self.GetMenuCount())]
10997
10998 def SetMenus(self, items):
10999 """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
11000 for i in range(self.GetMenuCount()-1, -1, -1):
11001 self.Remove(i)
11002 for m, l in items:
11003 self.Append(m, l)
11004
57332a5a
RD		 11005 Frame = property(GetFrame,doc="See `GetFrame`")
11006 Menu = property(GetMenu,doc="See `GetMenu`")
11007 MenuCount = property(GetMenuCount,doc="See `GetMenuCount`")
11008 Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`")
2131d850 11009_core_.MenuBar_swigregister(MenuBar)
d55e5bfc 11010
db67f999 11011def MenuBar_SetAutoWindowMenu(*args, **kwargs):
554f62e9
RD		 11012 """MenuBar_SetAutoWindowMenu(bool enable)"""
11013 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
db67f999 11014
554f62e9
RD		 11015def MenuBar_GetAutoWindowMenu(*args):
11016 """MenuBar_GetAutoWindowMenu() -> bool"""
11017 return _core_.MenuBar_GetAutoWindowMenu(*args)
db67f999 11018
d55e5bfc
RD		 11019#---------------------------------------------------------------------------
11020
11021class MenuItem(Object):
093d3ff1 11022 """Proxy of C++ MenuItem class"""
554f62e9
RD		 11023 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11024 __repr__ = _swig_repr
11025 def __init__(self, *args, **kwargs):
d55e5bfc
RD		 11026 """
11027 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
11028 String help=EmptyString, int kind=ITEM_NORMAL,
11029 Menu subMenu=None) -> MenuItem
11030 """
554f62e9
RD		 11031 _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
11032 __swig_destroy__ = _core_.delete_MenuItem
11033 __del__ = lambda self : None;
d55e5bfc
RD		 11034 def GetMenu(*args, **kwargs):
11035 """GetMenu(self) -> Menu"""
11036 return _core_.MenuItem_GetMenu(*args, **kwargs)
11037
11038 def SetMenu(*args, **kwargs):
11039 """SetMenu(self, Menu menu)"""
11040 return _core_.MenuItem_SetMenu(*args, **kwargs)
11041
11042 def SetId(*args, **kwargs):
11043 """SetId(self, int id)"""
11044 return _core_.MenuItem_SetId(*args, **kwargs)
11045
11046 def GetId(*args, **kwargs):
11047 """GetId(self) -> int"""
11048 return _core_.MenuItem_GetId(*args, **kwargs)
11049
11050 def IsSeparator(*args, **kwargs):
11051 """IsSeparator(self) -> bool"""
11052 return _core_.MenuItem_IsSeparator(*args, **kwargs)
11053
11054 def SetText(*args, **kwargs):
11055 """SetText(self, String str)"""
11056 return _core_.MenuItem_SetText(*args, **kwargs)
11057
11058 def GetLabel(*args, **kwargs):
11059 """GetLabel(self) -> String"""
11060 return _core_.MenuItem_GetLabel(*args, **kwargs)
11061
11062 def GetText(*args, **kwargs):
11063 """GetText(self) -> String"""
11064 return _core_.MenuItem_GetText(*args, **kwargs)
11065
11066 def GetLabelFromText(*args, **kwargs):
c24da6d6 11067 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD		 11068 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
11069
11070 GetLabelFromText = staticmethod(GetLabelFromText)
11071 def GetKind(*args, **kwargs):
11072 """GetKind(self) -> int"""
11073 return _core_.MenuItem_GetKind(*args, **kwargs)
11074
11075 def SetKind(*args, **kwargs):
11076 """SetKind(self, int kind)"""
11077 return _core_.MenuItem_SetKind(*args, **kwargs)
11078
11079 def SetCheckable(*args, **kwargs):
11080 """SetCheckable(self, bool checkable)"""
11081 return _core_.MenuItem_SetCheckable(*args, **kwargs)
11082
11083 def IsCheckable(*args, **kwargs):
11084 """IsCheckable(self) -> bool"""
11085 return _core_.MenuItem_IsCheckable(*args, **kwargs)
11086
11087 def IsSubMenu(*args, **kwargs):
11088 """IsSubMenu(self) -> bool"""
11089 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
11090
11091 def SetSubMenu(*args, **kwargs):
11092 """SetSubMenu(self, Menu menu)"""
11093 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
11094
11095 def GetSubMenu(*args, **kwargs):
11096 """GetSubMenu(self) -> Menu"""
11097 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
11098
11099 def Enable(*args, **kwargs):
11100 """Enable(self, bool enable=True)"""
11101 return _core_.MenuItem_Enable(*args, **kwargs)
11102
11103 def IsEnabled(*args, **kwargs):
11104 """IsEnabled(self) -> bool"""
11105 return _core_.MenuItem_IsEnabled(*args, **kwargs)
11106
11107 def Check(*args, **kwargs):
11108 """Check(self, bool check=True)"""
11109 return _core_.MenuItem_Check(*args, **kwargs)
11110
11111 def IsChecked(*args, **kwargs):
11112 """IsChecked(self) -> bool"""
11113 return _core_.MenuItem_IsChecked(*args, **kwargs)
11114
11115 def Toggle(*args, **kwargs):
11116 """Toggle(self)"""
11117 return _core_.MenuItem_Toggle(*args, **kwargs)
11118
11119 def SetHelp(*args, **kwargs):
11120 """SetHelp(self, String str)"""
11121 return _core_.MenuItem_SetHelp(*args, **kwargs)
11122
11123 def GetHelp(*args, **kwargs):
11124 """GetHelp(self) -> String"""
11125 return _core_.MenuItem_GetHelp(*args, **kwargs)
11126
11127 def GetAccel(*args, **kwargs):
11128 """GetAccel(self) -> AcceleratorEntry"""
11129 return _core_.MenuItem_GetAccel(*args, **kwargs)
11130
11131 def SetAccel(*args, **kwargs):
11132 """SetAccel(self, AcceleratorEntry accel)"""
11133 return _core_.MenuItem_SetAccel(*args, **kwargs)
11134
7449af73
RD		 11135 def SetBitmap(*args, **kwargs):
11136 """SetBitmap(self, Bitmap bitmap)"""
11137 return _core_.MenuItem_SetBitmap(*args, **kwargs)
11138
11139 def GetBitmap(*args, **kwargs):
11140 """GetBitmap(self) -> Bitmap"""
11141 return _core_.MenuItem_GetBitmap(*args, **kwargs)
11142
d55e5bfc
RD		 11143 def SetFont(*args, **kwargs):
11144 """SetFont(self, Font font)"""
11145 return _core_.MenuItem_SetFont(*args, **kwargs)
11146
11147 def GetFont(*args, **kwargs):
11148 """GetFont(self) -> Font"""
11149 return _core_.MenuItem_GetFont(*args, **kwargs)
11150
11151 def SetTextColour(*args, **kwargs):
11152 """SetTextColour(self, Colour colText)"""
11153 return _core_.MenuItem_SetTextColour(*args, **kwargs)
11154
11155 def GetTextColour(*args, **kwargs):
11156 """GetTextColour(self) -> Colour"""
11157 return _core_.MenuItem_GetTextColour(*args, **kwargs)
11158
11159 def SetBackgroundColour(*args, **kwargs):
11160 """SetBackgroundColour(self, Colour colBack)"""
11161 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
11162
11163 def GetBackgroundColour(*args, **kwargs):
11164 """GetBackgroundColour(self) -> Colour"""
11165 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
11166
11167 def SetBitmaps(*args, **kwargs):
11168 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
11169 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
11170
11171 def SetDisabledBitmap(*args, **kwargs):
11172 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
11173 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
11174
11175 def GetDisabledBitmap(*args, **kwargs):
11176 """GetDisabledBitmap(self) -> Bitmap"""
11177 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
11178
11179 def SetMarginWidth(*args, **kwargs):
11180 """SetMarginWidth(self, int nWidth)"""
11181 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
11182
11183 def GetMarginWidth(*args, **kwargs):
11184 """GetMarginWidth(self) -> int"""
11185 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
11186
11187 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 11188 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD		 11189 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
11190
11191 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
11192 def IsOwnerDrawn(*args, **kwargs):
11193 """IsOwnerDrawn(self) -> bool"""
11194 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
11195
11196 def SetOwnerDrawn(*args, **kwargs):
11197 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
11198 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
11199
11200 def ResetOwnerDrawn(*args, **kwargs):
11201 """ResetOwnerDrawn(self)"""
11202 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
11203
57332a5a
RD		 11204 Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`")
11205 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
11206 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
11207 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
11208 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
11209 Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`")
11210 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
11211 Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`")
11212 Label = property(GetLabel,doc="See `GetLabel`")
11213 MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`")
11214 Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`")
11215 SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`")
11216 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
11217 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
2131d850 11218_core_.MenuItem_swigregister(MenuItem)
d55e5bfc
RD		 11219
11220def MenuItem_GetLabelFromText(*args, **kwargs):
554f62e9
RD		 11221 """MenuItem_GetLabelFromText(String text) -> String"""
11222 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d55e5bfc 11223
554f62e9
RD		 11224def MenuItem_GetDefaultMarginWidth(*args):
11225 """MenuItem_GetDefaultMarginWidth() -> int"""
11226 return _core_.MenuItem_GetDefaultMarginWidth(*args)
d55e5bfc
RD		 11227
11228#---------------------------------------------------------------------------
11229
11230class Control(Window):
11231 """
11232 This is the base class for a control or 'widget'.
11233
79fccf9d
RD		 11234 A control is generally a small window which processes user input
11235 and/or displays one or more item of data.
d55e5bfc 11236 """
554f62e9
RD		 11237 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11238 __repr__ = _swig_repr
11239 def __init__(self, *args, **kwargs):
d55e5bfc 11240 """
248ed943
RD		 11241 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
11242 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 11243 String name=ControlNameStr) -> Control
11244
79fccf9d
RD		 11245 Create a Control. Normally you should only call this from a subclass'
11246 __init__ as a plain old wx.Control is not very useful.
d55e5bfc 11247 """
554f62e9 11248 _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
d55e5bfc
RD		 11249 self._setOORInfo(self)
11250
11251 def Create(*args, **kwargs):
11252 """
248ed943
RD		 11253 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
11254 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 11255 String name=ControlNameStr) -> bool
11256
11257 Do the 2nd phase and create the GUI control.
11258 """
11259 return _core_.Control_Create(*args, **kwargs)
11260
1eeb270e
RD		 11261 def GetAlignment(*args, **kwargs):
11262 """
11263 GetAlignment(self) -> int
11264
11265 Get the control alignment (left/right/centre, top/bottom/centre)
11266 """
11267 return _core_.Control_GetAlignment(*args, **kwargs)
11268
0f83f5da 11269 def GetLabelText(*args, **kwargs):
1eeb270e 11270 """
1eeb270e
RD		 11271 GetLabelText(self) -> String
11272
11273 Get just the text of the label, without mnemonic characters ('&')
11274 """
0f83f5da 11275 return _core_.Control_GetLabelText(*args, **kwargs)
1eeb270e 11276
d55e5bfc
RD		 11277 def Command(*args, **kwargs):
11278 """
11279 Command(self, CommandEvent event)
11280
79fccf9d
RD		 11281 Simulates the effect of the user issuing a command to the item.
11282
11283 :see: `wx.CommandEvent`
11284
d55e5bfc
RD		 11285 """
11286 return _core_.Control_Command(*args, **kwargs)
11287
a001823c 11288 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 11289 """
a001823c 11290 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 11291
a001823c
RD		 11292 Get the default attributes for this class. This is useful if you want
11293 to use the same font or colour in your own control as in a standard
11294 control -- which is a much better idea than hard coding specific
11295 colours or fonts which might look completely out of place on the
11296 user's system, especially if it uses themes.
f8167d6e 11297
a001823c
RD		 11298 The variant parameter is only relevant under Mac currently and is
11299 ignore under other platforms. Under Mac, it will change the size of
11300 the returned font. See `wx.Window.SetWindowVariant` for more about
11301 this.
f8167d6e 11302 """
d55e5bfc
RD		 11303 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11304
11305 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
226118fc 11306 Alignment = property(GetAlignment,doc="See `GetAlignment`")
226118fc 11307 LabelText = property(GetLabelText,doc="See `GetLabelText`")
2131d850 11308_core_.Control_swigregister(Control)
d55e5bfc
RD		 11309ControlNameStr = cvar.ControlNameStr
11310
11311def PreControl(*args, **kwargs):
11312 """
11313 PreControl() -> Control
11314
11315 Precreate a Control control for 2-phase creation
11316 """
11317 val = _core_.new_PreControl(*args, **kwargs)
d55e5bfc
RD		 11318 return val
11319
11320def Control_GetClassDefaultAttributes(*args, **kwargs):
554f62e9 11321 """
a001823c
RD		 11322 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11323
11324 Get the default attributes for this class. This is useful if you want
11325 to use the same font or colour in your own control as in a standard
11326 control -- which is a much better idea than hard coding specific
11327 colours or fonts which might look completely out of place on the
11328 user's system, especially if it uses themes.
11329
11330 The variant parameter is only relevant under Mac currently and is
11331 ignore under other platforms. Under Mac, it will change the size of
11332 the returned font. See `wx.Window.SetWindowVariant` for more about
11333 this.
11334 """
554f62e9 11335 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
d55e5bfc
RD		 11336
11337#---------------------------------------------------------------------------
11338
11339class ItemContainer(object):
11340 """
53aa7709
RD		 11341 The wx.ItemContainer class defines an interface which is implemented
11342 by all controls which have string subitems, each of which may be
11343 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11344 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 11345 this one.
d55e5bfc 11346
79fccf9d
RD		 11347 It defines the methods for accessing the control's items and although
11348 each of the derived classes implements them differently, they still
11349 all conform to the same interface.
d55e5bfc 11350
79fccf9d
RD		 11351 The items in a wx.ItemContainer have (non empty) string labels and,
11352 optionally, client data associated with them.
d55e5bfc
RD		 11353
11354 """
554f62e9
RD		 11355 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11356 def __init__(self): raise AttributeError, "No constructor defined"
11357 __repr__ = _swig_repr
d55e5bfc
RD		 11358 def Append(*args, **kwargs):
11359 """
11360 Append(self, String item, PyObject clientData=None) -> int
11361
79fccf9d
RD		 11362 Adds the item to the control, associating the given data with the item
11363 if not None. The return value is the index of the newly added item
11364 which may be different from the last one if the control is sorted (e.g.
11365 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD		 11366 """
11367 return _core_.ItemContainer_Append(*args, **kwargs)
11368
11369 def AppendItems(*args, **kwargs):
11370 """
f5b96ee1 11371 AppendItems(self, List strings)
d55e5bfc 11372
79fccf9d
RD		 11373 Apend several items at once to the control. Notice that calling this
11374 method may be much faster than appending the items one by one if you
11375 need to add a lot of items.
d55e5bfc
RD		 11376 """
11377 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11378
11379 def Insert(*args, **kwargs):
11380 """
d359a380 11381 Insert(self, String item, int pos, PyObject clientData=None) -> int
d55e5bfc 11382
79fccf9d 11383 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD		 11384 optionally associating some data object with the item.
11385 """
11386 return _core_.ItemContainer_Insert(*args, **kwargs)
11387
11388 def Clear(*args, **kwargs):
11389 """
11390 Clear(self)
11391
11392 Removes all items from the control.
11393 """
11394 return _core_.ItemContainer_Clear(*args, **kwargs)
11395
11396 def Delete(*args, **kwargs):
11397 """
d359a380 11398 Delete(self, int n)
d55e5bfc 11399
79fccf9d
RD		 11400 Deletes the item at the zero-based index 'n' from the control. Note
11401 that it is an error (signalled by a `wx.PyAssertionError` exception if
11402 enabled) to remove an item with the index negative or greater or equal
11403 than the number of items in the control.
d55e5bfc
RD		 11404 """
11405 return _core_.ItemContainer_Delete(*args, **kwargs)
11406
53aa7709
RD		 11407 def GetClientData(*args, **kwargs):
11408 """
d359a380 11409 GetClientData(self, int n) -> PyObject
53aa7709
RD		 11410
11411 Returns the client data associated with the given item, (if any.)
11412 """
11413 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11414
11415 def SetClientData(*args, **kwargs):
11416 """
d359a380 11417 SetClientData(self, int n, PyObject clientData)
53aa7709
RD		 11418
11419 Associate the given client data with the item at position n.
11420 """
11421 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11422
d55e5bfc
RD		 11423 def GetCount(*args, **kwargs):
11424 """
d359a380 11425 GetCount(self) -> int
d55e5bfc
RD		 11426
11427 Returns the number of items in the control.
11428 """
11429 return _core_.ItemContainer_GetCount(*args, **kwargs)
11430
11431 def IsEmpty(*args, **kwargs):
11432 """
11433 IsEmpty(self) -> bool
11434
11435 Returns True if the control is empty or False if it has some items.
11436 """
11437 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11438
11439 def GetString(*args, **kwargs):
11440 """
d359a380 11441 GetString(self, int n) -> String
d55e5bfc
RD		 11442
11443 Returns the label of the item with the given index.
11444 """
11445 return _core_.ItemContainer_GetString(*args, **kwargs)
11446
11447 def GetStrings(*args, **kwargs):
11448 """GetStrings(self) -> wxArrayString"""
11449 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11450
11451 def SetString(*args, **kwargs):
11452 """
d359a380 11453 SetString(self, int n, String s)
d55e5bfc
RD		 11454
11455 Sets the label for the given item.
11456 """
11457 return _core_.ItemContainer_SetString(*args, **kwargs)
11458
11459 def FindString(*args, **kwargs):
11460 """
11461 FindString(self, String s) -> int
11462
11463 Finds an item whose label matches the given string. Returns the
79fccf9d
RD		 11464 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11465 found.
d55e5bfc
RD		 11466 """
11467 return _core_.ItemContainer_FindString(*args, **kwargs)
11468
53aa7709 11469 def SetSelection(*args, **kwargs):
d55e5bfc 11470 """
53aa7709 11471 SetSelection(self, int n)
d55e5bfc
RD		 11472
11473 Sets the item at index 'n' to be the selected item.
11474 """
53aa7709 11475 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 11476
d55e5bfc
RD		 11477 def GetSelection(*args, **kwargs):
11478 """
11479 GetSelection(self) -> int
11480
79fccf9d
RD		 11481 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11482 is selected.
d55e5bfc
RD		 11483 """
11484 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11485
53aa7709
RD		 11486 def SetStringSelection(*args, **kwargs):
11487 """SetStringSelection(self, String s) -> bool"""
11488 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11489
d55e5bfc
RD		 11490 def GetStringSelection(*args, **kwargs):
11491 """
11492 GetStringSelection(self) -> String
11493
79fccf9d
RD		 11494 Returns the label of the selected item or an empty string if no item
11495 is selected.
d55e5bfc
RD		 11496 """
11497 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11498
53aa7709 11499 def Select(*args, **kwargs):
d55e5bfc 11500 """
53aa7709 11501 Select(self, int n)
d55e5bfc 11502
53aa7709
RD		 11503 This is the same as `SetSelection` and exists only because it is
11504 slightly more natural for controls which support multiple selection.
d55e5bfc 11505 """
53aa7709 11506 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc 11507
97ab0f6a
RD		 11508 def GetItems(self):
11509 """Return a list of the strings in the control"""
11510 return [self.GetString(i) for i in xrange(self.GetCount())]
11511
11512 def SetItems(self, items):
11513 """Clear and set the strings in the control from a list"""
11514 self.Clear()
11515 for i in items:
11516 self.Append(i)
11517
11518 Count = property(GetCount,doc="See `GetCount`")
11519 Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`")
11520 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
11521 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
11522 Strings = property(GetStrings,doc="See `GetStrings`")
2131d850 11523_core_.ItemContainer_swigregister(ItemContainer)
d55e5bfc
RD		 11524
11525#---------------------------------------------------------------------------
11526
11527class ControlWithItems(Control,ItemContainer):
11528 """
79fccf9d
RD		 11529 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11530 wx.Control class, and is used for the base class of various controls
11531 that have items.
d55e5bfc 11532 """
554f62e9
RD		 11533 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11534 def __init__(self): raise AttributeError, "No constructor defined"
11535 __repr__ = _swig_repr
2131d850 11536_core_.ControlWithItems_swigregister(ControlWithItems)
d55e5bfc
RD		 11537
11538#---------------------------------------------------------------------------
11539
11540class SizerItem(Object):
248ed943
RD		 11541 """
11542 The wx.SizerItem class is used to track the position, size and other
f460c29d
RD		 11543 attributes of each item managed by a `wx.Sizer`. It is not usually
11544 necessary to use this class because the sizer elements can also be
11545 identified by their positions or window or sizer references but
11546 sometimes it may be more convenient to use wx.SizerItem directly.
11547 Also, custom classes derived from `wx.PySizer` will probably need to
11548 use the collection of wx.SizerItems held by wx.Sizer when calculating
11549 layout.
248ed943
RD		 11550
11551 :see: `wx.Sizer`, `wx.GBSizerItem`
11552 """
554f62e9
RD		 11553 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11554 __repr__ = _swig_repr
11555 def __init__(self, *args, **kwargs):
248ed943
RD		 11556 """
11557 __init__(self) -> SizerItem
11558
11559 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11560 size will need to be set before this item can be used in a Sizer.
11561
11562 You will probably never need to create a wx.SizerItem directly as they
11563 are created automatically when the sizer's Add, Insert or Prepend
11564 methods are called.
11565
11566 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11567 """
554f62e9
RD		 11568 _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
11569 __swig_destroy__ = _core_.delete_SizerItem
11570 __del__ = lambda self : None;
d55e5bfc 11571 def DeleteWindows(*args, **kwargs):
248ed943
RD		 11572 """
11573 DeleteWindows(self)
11574
11575 Destroy the window or the windows in a subsizer, depending on the type
11576 of item.
11577 """
d55e5bfc
RD		 11578 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11579
11580 def DetachSizer(*args, **kwargs):
248ed943
RD		 11581 """
11582 DetachSizer(self)
11583
11584 Enable deleting the SizerItem without destroying the contained sizer.
11585 """
d55e5bfc
RD		 11586 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11587
11588 def GetSize(*args, **kwargs):
248ed943
RD		 11589 """
11590 GetSize(self) -> Size
11591
11592 Get the current size of the item, as set in the last Layout.
11593 """
d55e5bfc
RD		 11594 return _core_.SizerItem_GetSize(*args, **kwargs)
11595
11596 def CalcMin(*args, **kwargs):
248ed943
RD		 11597 """
11598 CalcMin(self) -> Size
11599
11600 Calculates the minimum desired size for the item, including any space
11601 needed by borders.
11602 """
d55e5bfc
RD		 11603 return _core_.SizerItem_CalcMin(*args, **kwargs)
11604
11605 def SetDimension(*args, **kwargs):
248ed943
RD		 11606 """
11607 SetDimension(self, Point pos, Size size)
11608
11609 Set the position and size of the space allocated for this item by the
11610 sizer, and adjust the position and size of the item (window or
11611 subsizer) to be within that space taking alignment and borders into
11612 account.
11613 """
d55e5bfc
RD		 11614 return _core_.SizerItem_SetDimension(*args, **kwargs)
11615
11616 def GetMinSize(*args, **kwargs):
248ed943
RD		 11617 """
11618 GetMinSize(self) -> Size
11619
11620 Get the minimum size needed for the item.
11621 """
d55e5bfc
RD		 11622 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11623
a001823c
RD		 11624 def GetMinSizeWithBorder(*args, **kwargs):
11625 """
11626 GetMinSizeWithBorder(self) -> Size
11627
11628 Get the minimum size needed for the item with space for the borders
11629 added, if needed.
11630 """
11631 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11632
d55e5bfc
RD		 11633 def SetInitSize(*args, **kwargs):
11634 """SetInitSize(self, int x, int y)"""
11635 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11636
11637 def SetRatioWH(*args, **kwargs):
248ed943
RD		 11638 """
11639 SetRatioWH(self, int width, int height)
11640
11641 Set the ratio item attribute.
11642 """
d55e5bfc
RD		 11643 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11644
11645 def SetRatioSize(*args, **kwargs):
248ed943
RD		 11646 """
11647 SetRatioSize(self, Size size)
11648
11649 Set the ratio item attribute.
11650 """
d55e5bfc
RD		 11651 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11652
11653 def SetRatio(*args, **kwargs):
248ed943
RD		 11654 """
11655 SetRatio(self, float ratio)
11656
11657 Set the ratio item attribute.
11658 """
d55e5bfc
RD		 11659 return _core_.SizerItem_SetRatio(*args, **kwargs)
11660
11661 def GetRatio(*args, **kwargs):
248ed943
RD		 11662 """
11663 GetRatio(self) -> float
11664
11665 Set the ratio item attribute.
11666 """
d55e5bfc
RD		 11667 return _core_.SizerItem_GetRatio(*args, **kwargs)
11668
c1cb24a4
RD		 11669 def GetRect(*args, **kwargs):
11670 """
11671 GetRect(self) -> Rect
11672
11673 Returns the rectangle that the sizer item should occupy
11674 """
11675 return _core_.SizerItem_GetRect(*args, **kwargs)
11676
d55e5bfc 11677 def IsWindow(*args, **kwargs):
248ed943
RD		 11678 """
11679 IsWindow(self) -> bool
11680
11681 Is this sizer item a window?
11682 """
d55e5bfc
RD		 11683 return _core_.SizerItem_IsWindow(*args, **kwargs)
11684
11685 def IsSizer(*args, **kwargs):
248ed943
RD		 11686 """
11687 IsSizer(self) -> bool
11688
11689 Is this sizer item a subsizer?
11690 """
d55e5bfc
RD		 11691 return _core_.SizerItem_IsSizer(*args, **kwargs)
11692
11693 def IsSpacer(*args, **kwargs):
248ed943
RD		 11694 """
11695 IsSpacer(self) -> bool
11696
11697 Is this sizer item a spacer?
11698 """
d55e5bfc
RD		 11699 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11700
11701 def SetProportion(*args, **kwargs):
248ed943
RD		 11702 """
11703 SetProportion(self, int proportion)
11704
11705 Set the proportion value for this item.
11706 """
d55e5bfc
RD		 11707 return _core_.SizerItem_SetProportion(*args, **kwargs)
11708
11709 def GetProportion(*args, **kwargs):
248ed943
RD		 11710 """
11711 GetProportion(self) -> int
11712
11713 Get the proportion value for this item.
11714 """
d55e5bfc
RD		 11715 return _core_.SizerItem_GetProportion(*args, **kwargs)
11716
248ed943
RD		 11717 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11718 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 11719 def SetFlag(*args, **kwargs):
248ed943
RD		 11720 """
11721 SetFlag(self, int flag)
11722
11723 Set the flag value for this item.
11724 """
d55e5bfc
RD		 11725 return _core_.SizerItem_SetFlag(*args, **kwargs)
11726
11727 def GetFlag(*args, **kwargs):
248ed943
RD		 11728 """
11729 GetFlag(self) -> int
11730
11731 Get the flag value for this item.
11732 """
d55e5bfc
RD		 11733 return _core_.SizerItem_GetFlag(*args, **kwargs)
11734
11735 def SetBorder(*args, **kwargs):
248ed943
RD		 11736 """
11737 SetBorder(self, int border)
11738
11739 Set the border value for this item.
11740 """
d55e5bfc
RD		 11741 return _core_.SizerItem_SetBorder(*args, **kwargs)
11742
11743 def GetBorder(*args, **kwargs):
248ed943
RD		 11744 """
11745 GetBorder(self) -> int
11746
11747 Get the border value for this item.
11748 """
d55e5bfc
RD		 11749 return _core_.SizerItem_GetBorder(*args, **kwargs)
11750
11751 def GetWindow(*args, **kwargs):
248ed943
RD		 11752 """
11753 GetWindow(self) -> Window
11754
11755 Get the window (if any) that is managed by this sizer item.
11756 """
d55e5bfc
RD		 11757 return _core_.SizerItem_GetWindow(*args, **kwargs)
11758
11759 def SetWindow(*args, **kwargs):
248ed943
RD		 11760 """
11761 SetWindow(self, Window window)
11762
11763 Set the window to be managed by this sizer item.
11764 """
d55e5bfc
RD		 11765 return _core_.SizerItem_SetWindow(*args, **kwargs)
11766
11767 def GetSizer(*args, **kwargs):
248ed943
RD		 11768 """
11769 GetSizer(self) -> Sizer
11770
11771 Get the subsizer (if any) that is managed by this sizer item.
11772 """
d55e5bfc
RD		 11773 return _core_.SizerItem_GetSizer(*args, **kwargs)
11774
11775 def SetSizer(*args, **kwargs):
248ed943
RD		 11776 """
11777 SetSizer(self, Sizer sizer)
11778
11779 Set the subsizer to be managed by this sizer item.
11780 """
d55e5bfc
RD		 11781 return _core_.SizerItem_SetSizer(*args, **kwargs)
11782
11783 def GetSpacer(*args, **kwargs):
248ed943
RD		 11784 """
11785 GetSpacer(self) -> Size
11786
11787 Get the size of the spacer managed by this sizer item.
11788 """
d55e5bfc
RD		 11789 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11790
11791 def SetSpacer(*args, **kwargs):
248ed943
RD		 11792 """
11793 SetSpacer(self, Size size)
11794
11795 Set the size of the spacer to be managed by this sizer item.
11796 """
d55e5bfc
RD		 11797 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11798
11799 def Show(*args, **kwargs):
248ed943
RD		 11800 """
11801 Show(self, bool show)
11802
11803 Set the show item attribute, which sizers use to determine if the item
11804 is to be made part of the layout or not. If the item is tracking a
11805 window then it is shown or hidden as needed.
11806 """
d55e5bfc
RD		 11807 return _core_.SizerItem_Show(*args, **kwargs)
11808
11809 def IsShown(*args, **kwargs):
248ed943
RD		 11810 """
11811 IsShown(self) -> bool
11812
11813 Is the item to be shown in the layout?
11814 """
d55e5bfc
RD		 11815 return _core_.SizerItem_IsShown(*args, **kwargs)
11816
11817 def GetPosition(*args, **kwargs):
248ed943
RD		 11818 """
11819 GetPosition(self) -> Point
11820
11821 Returns the current position of the item, as set in the last Layout.
11822 """
d55e5bfc
RD		 11823 return _core_.SizerItem_GetPosition(*args, **kwargs)
11824
11825 def GetUserData(*args, **kwargs):
248ed943
RD		 11826 """
11827 GetUserData(self) -> PyObject
11828
11829 Returns the userData associated with this sizer item, or None if there
11830 isn't any.
11831 """
d55e5bfc
RD		 11832 return _core_.SizerItem_GetUserData(*args, **kwargs)
11833
7449af73
RD		 11834 def SetUserData(*args, **kwargs):
11835 """
11836 SetUserData(self, PyObject userData)
11837
11838 Associate a Python object with this sizer item.
11839 """
11840 return _core_.SizerItem_SetUserData(*args, **kwargs)
11841
33d6fd3b
RD		 11842 Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
11843 Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
11844 MinSize = property(GetMinSize,doc="See `GetMinSize`")
11845 MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
11846 Position = property(GetPosition,doc="See `GetPosition`")
11847 Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
11848 Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
11849 Rect = property(GetRect,doc="See `GetRect`")
11850 Size = property(GetSize,doc="See `GetSize`")
11851 Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
11852 Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
11853 UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
11854 Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
2131d850 11855_core_.SizerItem_swigregister(SizerItem)
d55e5bfc 11856
248ed943 11857def SizerItemWindow(*args, **kwargs):
d55e5bfc 11858 """
248ed943
RD		 11859 SizerItemWindow(Window window, int proportion, int flag, int border,
11860 PyObject userData=None) -> SizerItem
11861
11862 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 11863 """
248ed943 11864 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 11865 return val
11866
248ed943 11867def SizerItemSpacer(*args, **kwargs):
d55e5bfc 11868 """
248ed943
RD		 11869 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11870 PyObject userData=None) -> SizerItem
11871
11872 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 11873 """
248ed943 11874 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 11875 return val
11876
11877def SizerItemSizer(*args, **kwargs):
11878 """
11879 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD		 11880 PyObject userData=None) -> SizerItem
11881
11882 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD		 11883 """
11884 val = _core_.new_SizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 11885 return val
11886
11887class Sizer(Object):
248ed943
RD		 11888 """
11889 wx.Sizer is the abstract base class used for laying out subwindows in
11890 a window. You cannot use wx.Sizer directly; instead, you will have to
11891 use one of the sizer classes derived from it such as `wx.BoxSizer`,
1d5ee749
RD		 11892 `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
11893 `wx.GridBagSizer`.
248ed943
RD		 11894
11895 The concept implemented by sizers in wxWidgets is closely related to
11896 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11897 toolkit or the Qt toolkit. It is based upon the idea of the individual
11898 subwindows reporting their minimal required size and their ability to
11899 get stretched if the size of the parent window has changed. This will
11900 most often mean that the programmer does not set the original size of
11901 a dialog in the beginning, rather the dialog will assigned a sizer and
11902 this sizer will be queried about the recommended size. The sizer in
11903 turn will query its children, which can be normal windows or contorls,
11904 empty space or other sizers, so that a hierarchy of sizers can be
11905 constructed. Note that wxSizer does not derive from wxWindow and thus
11906 do not interfere with tab ordering and requires very little resources
11907 compared to a real window on screen.
11908
11909 What makes sizers so well fitted for use in wxWidgets is the fact that
11910 every control reports its own minimal size and the algorithm can
11911 handle differences in font sizes or different window (dialog item)
11912 sizes on different platforms without problems. If for example the
11913 standard font as well as the overall design of Mac widgets requires
11914 more space than on Windows, then the initial size of a dialog using a
11915 sizer will automatically be bigger on Mac than on Windows.
11916 """
554f62e9
RD		 11917 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
11918 def __init__(self): raise AttributeError, "No constructor defined"
11919 __repr__ = _swig_repr
11920 __swig_destroy__ = _core_.delete_Sizer
11921 __del__ = lambda self : None;
d55e5bfc
RD		 11922 def _setOORInfo(*args, **kwargs):
11923 """_setOORInfo(self, PyObject _self)"""
11924 return _core_.Sizer__setOORInfo(*args, **kwargs)
11925
11926 def Add(*args, **kwargs):
11927 """
248ed943 11928 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11929 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11930
11931 Appends a child item to the sizer.
d55e5bfc
RD		 11932 """
11933 return _core_.Sizer_Add(*args, **kwargs)
11934
11935 def Insert(*args, **kwargs):
11936 """
248ed943 11937 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11938 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11939
11940 Inserts a new item into the list of items managed by this sizer before
11941 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD		 11942 """
11943 return _core_.Sizer_Insert(*args, **kwargs)
11944
11945 def Prepend(*args, **kwargs):
11946 """
248ed943 11947 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11948 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 11949
11950 Adds a new item to the begining of the list of sizer items managed by
11951 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD		 11952 """
11953 return _core_.Sizer_Prepend(*args, **kwargs)
11954
11955 def Remove(*args, **kwargs):
248ed943
RD		 11956 """
11957 Remove(self, item) -> bool
11958
11959 Removes an item from the sizer and destroys it. This method does not
11960 cause any layout or resizing to take place, call `Layout` to update
11961 the layout on screen after removing a child from the sizer. The
11962 *item* parameter can be either a window, a sizer, or the zero-based
11963 index of an item to remove. Returns True if the child item was found
11964 and removed.
11965 """
d55e5bfc
RD		 11966 return _core_.Sizer_Remove(*args, **kwargs)
11967
1a6bba1e 11968 def Detach(*args, **kwargs):
248ed943
RD		 11969 """
11970 Detach(self, item) -> bool
11971
11972 Detaches an item from the sizer without destroying it. This method
11973 does not cause any layout or resizing to take place, call `Layout` to
11974 do so. The *item* parameter can be either a window, a sizer, or the
11975 zero-based index of the item to be detached. Returns True if the child item
11976 was found and detached.
11977 """
1a6bba1e
RD		 11978 return _core_.Sizer_Detach(*args, **kwargs)
11979
c1cb24a4
RD		 11980 def GetItem(*args, **kwargs):
11981 """
11982 GetItem(self, item) -> wx.SizerItem
11983
11984 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11985 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11986 the item to be found.
c1cb24a4
RD		 11987 """
11988 return _core_.Sizer_GetItem(*args, **kwargs)
11989
d55e5bfc
RD		 11990 def _SetItemMinSize(*args, **kwargs):
11991 """_SetItemMinSize(self, PyObject item, Size size)"""
11992 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11993
97ab0f6a
RD		 11994 def _ReplaceWin(*args, **kwargs):
11995 """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool"""
11996 return _core_.Sizer__ReplaceWin(*args, **kwargs)
11997
11998 def _ReplaceSizer(*args, **kwargs):
11999 """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool"""
12000 return _core_.Sizer__ReplaceSizer(*args, **kwargs)
12001
12002 def _ReplaceItem(*args, **kwargs):
12003 """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool"""
12004 return _core_.Sizer__ReplaceItem(*args, **kwargs)
12005
12006 def Replace(self, olditem, item, recursive=False):
12007 """
12008 Detaches the given ``olditem`` from the sizer and replaces it with
12009 ``item`` which can be a window, sizer, or `wx.SizerItem`. The
12010 detached child is destroyed only if it is not a window, (because
12011 windows are owned by their parent, not the sizer.) The
12012 ``recursive`` parameter can be used to search for the given
12013 element recursivly in subsizers.
12014
12015 This method does not cause any layout or resizing to take place,
12016 call `Layout` to do so.
12017
12018 Returns ``True`` if the child item was found and removed.
12019 """
12020 if isinstance(olditem, wx.Window):
12021 return self._ReplaceWin(olditem, item, recursive)
12022 elif isinstnace(olditem, wx.Sizer):
12023 return self._ReplaceSizer(olditem, item, recursive)
12024 elif isinstnace(olditem, int):
12025 return self._ReplaceItem(olditem, item)
12026 else:
12027 raise TypeError("Expected Window, Sizer, or integer for first parameter.")
12028
12029 def SetContainingWindow(*args, **kwargs):
12030 """
12031 SetContainingWindow(self, Window window)
12032
12033 Set (or unset) the window this sizer is used in.
12034 """
12035 return _core_.Sizer_SetContainingWindow(*args, **kwargs)
12036
12037 def GetContainingWindow(*args, **kwargs):
12038 """
12039 GetContainingWindow(self) -> Window
12040
12041 Get the window this sizer is used in.
12042 """
12043 return _core_.Sizer_GetContainingWindow(*args, **kwargs)
12044
248ed943
RD		 12045 def SetItemMinSize(self, item, *args):
12046 """
12047 SetItemMinSize(self, item, Size size)
12048
12049 Sets the minimum size that will be allocated for an item in the sizer.
12050 The *item* parameter can be either a window, a sizer, or the
12051 zero-based index of the item. If a window or sizer is given then it
12052 will be searched for recursivly in subsizers if neccessary.
12053 """
12054 if len(args) == 2:
12055 # for backward compatibility accept separate width,height args too
12056 return self._SetItemMinSize(item, args)
12057 else:
12058 return self._SetItemMinSize(item, args[0])
12059
d55e5bfc 12060 def AddItem(*args, **kwargs):
248ed943
RD		 12061 """
12062 AddItem(self, SizerItem item)
12063
12064 Adds a `wx.SizerItem` to the sizer.
12065 """
d55e5bfc
RD		 12066 return _core_.Sizer_AddItem(*args, **kwargs)
12067
12068 def InsertItem(*args, **kwargs):
248ed943
RD		 12069 """
12070 InsertItem(self, int index, SizerItem item)
12071
12072 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
12073 """
d55e5bfc
RD		 12074 return _core_.Sizer_InsertItem(*args, **kwargs)
12075
12076 def PrependItem(*args, **kwargs):
248ed943
RD		 12077 """
12078 PrependItem(self, SizerItem item)
12079
12080 Prepends a `wx.SizerItem` to the sizer.
12081 """
d55e5bfc
RD		 12082 return _core_.Sizer_PrependItem(*args, **kwargs)
12083
248ed943 12084 def AddMany(self, items):
c24da6d6
RD		 12085 """
12086 AddMany is a convenience method for adding several items
12087 to a sizer at one time. Simply pass it a list of tuples,
12088 where each tuple consists of the parameters that you
12089 would normally pass to the `Add` method.
12090 """
248ed943
RD		 12091 for item in items:
12092 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
12093 item = (item, )
12094 self.Add(*item)
d55e5bfc 12095
0d2c9713
RD		 12096 def AddSpacer(self, *args, **kw):
12097 """AddSpacer(int size) --> SizerItem
12098
12099 Add a spacer that is (size,size) pixels.
12100 """
12101 if args and type(args[0]) == int:
12102 return self.Add( (args[0],args[0] ), 0)
12103 else: # otherwise stay compatible with old AddSpacer
12104 return self.Add(*args, **kw)
12105 def PrependSpacer(self, *args, **kw):
12106 """PrependSpacer(int size) --> SizerItem
12107
12108 Prepend a spacer that is (size, size) pixels."""
12109 if args and type(args[0]) == int:
12110 return self.Prepend( (args[0],args[0] ), 0)
12111 else: # otherwise stay compatible with old PrependSpacer
12112 return self.Prepend(*args, **kw)
12113 def InsertSpacer(self, index, *args, **kw):
12114 """InsertSpacer(int index, int size) --> SizerItem
12115
12116 Insert a spacer at position index that is (size, size) pixels."""
12117 if args and type(args[0]) == int:
12118 return self.Insert( index, (args[0],args[0] ), 0)
12119 else: # otherwise stay compatible with old InsertSpacer
12120 return self.Insert(index, *args, **kw)
12121
12122
12123 def AddStretchSpacer(self, prop=1):
12124 """AddStretchSpacer(int prop=1) --> SizerItem
12125
12126 Add a stretchable spacer."""
12127 return self.Add((0,0), prop)
12128 def PrependStretchSpacer(self, prop=1):
12129 """PrependStretchSpacer(int prop=1) --> SizerItem
12130
12131 Prepend a stretchable spacer."""
12132 return self.Prepend((0,0), prop)
12133 def InsertStretchSpacer(self, index, prop=1):
12134 """InsertStretchSpacer(int index, int prop=1) --> SizerItem
12135
12136 Insert a stretchable spacer."""
12137 return self.Insert(index, (0,0), prop)
12138
12139
d55e5bfc 12140 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD		 12141 def AddWindow(self, *args, **kw):
12142 """Compatibility alias for `Add`."""
12143 return self.Add(*args, **kw)
12144 def AddSizer(self, *args, **kw):
12145 """Compatibility alias for `Add`."""
12146 return self.Add(*args, **kw)
b9d6a5f3
RD		 12147
12148 def PrependWindow(self, *args, **kw):
12149 """Compatibility alias for `Prepend`."""
12150 return self.Prepend(*args, **kw)
12151 def PrependSizer(self, *args, **kw):
12152 """Compatibility alias for `Prepend`."""
12153 return self.Prepend(*args, **kw)
b9d6a5f3
RD		 12154
12155 def InsertWindow(self, *args, **kw):
12156 """Compatibility alias for `Insert`."""
12157 return self.Insert(*args, **kw)
12158 def InsertSizer(self, *args, **kw):
12159 """Compatibility alias for `Insert`."""
b9d6a5f3
RD		 12160 return self.Insert(*args, **kw)
12161
12162 def RemoveWindow(self, *args, **kw):
12163 """Compatibility alias for `Remove`."""
12164 return self.Remove(*args, **kw)
12165 def RemoveSizer(self, *args, **kw):
12166 """Compatibility alias for `Remove`."""
12167 return self.Remove(*args, **kw)
12168 def RemovePos(self, *args, **kw):
12169 """Compatibility alias for `Remove`."""
12170 return self.Remove(*args, **kw)
d55e5bfc
RD		 12171
12172
d55e5bfc 12173 def SetDimension(*args, **kwargs):
248ed943
RD		 12174 """
12175 SetDimension(self, int x, int y, int width, int height)
12176
12177 Call this to force the sizer to take the given dimension and thus
12178 force the items owned by the sizer to resize themselves according to
12179 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
12180 methods.
12181 """
d55e5bfc
RD		 12182 return _core_.Sizer_SetDimension(*args, **kwargs)
12183
12184 def SetMinSize(*args, **kwargs):
248ed943
RD		 12185 """
12186 SetMinSize(self, Size size)
12187
12188 Call this to give the sizer a minimal size. Normally, the sizer will
12189 calculate its minimal size based purely on how much space its children
12190 need. After calling this method `GetMinSize` will return either the
12191 minimal size as requested by its children or the minimal size set
12192 here, depending on which is bigger.
12193 """
d55e5bfc
RD		 12194 return _core_.Sizer_SetMinSize(*args, **kwargs)
12195
12196 def GetSize(*args, **kwargs):
248ed943
RD		 12197 """
12198 GetSize(self) -> Size
12199
12200 Returns the current size of the space managed by the sizer.
12201 """
d55e5bfc
RD		 12202 return _core_.Sizer_GetSize(*args, **kwargs)
12203
12204 def GetPosition(*args, **kwargs):
248ed943
RD		 12205 """
12206 GetPosition(self) -> Point
12207
12208 Returns the current position of the sizer's managed space.
12209 """
d55e5bfc
RD		 12210 return _core_.Sizer_GetPosition(*args, **kwargs)
12211
12212 def GetMinSize(*args, **kwargs):
248ed943
RD		 12213 """
12214 GetMinSize(self) -> Size
12215
12216 Returns the minimal size of the sizer. This is either the combined
12217 minimal size of all the children and their borders or the minimal size
12218 set by SetMinSize, depending on which is bigger.
12219 """
d55e5bfc
RD		 12220 return _core_.Sizer_GetMinSize(*args, **kwargs)
12221
12222 def GetSizeTuple(self):
1a6bba1e 12223 return self.GetSize().Get()
d55e5bfc 12224 def GetPositionTuple(self):
1a6bba1e 12225 return self.GetPosition().Get()
d55e5bfc 12226 def GetMinSizeTuple(self):
1a6bba1e 12227 return self.GetMinSize().Get()
d55e5bfc
RD		 12228
12229 def RecalcSizes(*args, **kwargs):
248ed943
RD		 12230 """
12231 RecalcSizes(self)
12232
12233 Using the sizes calculated by `CalcMin` reposition and resize all the
12234 items managed by this sizer. You should not need to call this directly as
12235 it is called by `Layout`.
12236 """
d55e5bfc
RD		 12237 return _core_.Sizer_RecalcSizes(*args, **kwargs)
12238
12239 def CalcMin(*args, **kwargs):
248ed943
RD		 12240 """
12241 CalcMin(self) -> Size
12242
12243 This method is where the sizer will do the actual calculation of its
12244 children's minimal sizes. You should not need to call this directly as
12245 it is called by `Layout`.
12246 """
d55e5bfc
RD		 12247 return _core_.Sizer_CalcMin(*args, **kwargs)
12248
12249 def Layout(*args, **kwargs):
248ed943
RD		 12250 """
12251 Layout(self)
12252
12253 This method will force the recalculation and layout of the items
12254 controlled by the sizer using the current space allocated to the
12255 sizer. Normally this is called automatically from the owning window's
12256 EVT_SIZE handler, but it is also useful to call it from user code when
12257 one of the items in a sizer change size, or items are added or
12258 removed.
12259 """
d55e5bfc
RD		 12260 return _core_.Sizer_Layout(*args, **kwargs)
12261
12262 def Fit(*args, **kwargs):
248ed943
RD		 12263 """
12264 Fit(self, Window window) -> Size
12265
12266 Tell the sizer to resize the *window* to match the sizer's minimal
12267 size. This is commonly done in the constructor of the window itself in
12268 order to set its initial size to match the needs of the children as
12269 determined by the sizer. Returns the new size.
12270
12271 For a top level window this is the total window size, not the client size.
12272 """
d55e5bfc
RD		 12273 return _core_.Sizer_Fit(*args, **kwargs)
12274
12275 def FitInside(*args, **kwargs):
248ed943
RD		 12276 """
12277 FitInside(self, Window window)
12278
12279 Tell the sizer to resize the *virtual size* of the *window* to match the
12280 sizer's minimal size. This will not alter the on screen size of the
12281 window, but may cause the addition/removal/alteration of scrollbars
12282 required to view the virtual area in windows which manage it.
12283
12284 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
12285
12286 """
d55e5bfc
RD		 12287 return _core_.Sizer_FitInside(*args, **kwargs)
12288
12289 def SetSizeHints(*args, **kwargs):
248ed943
RD		 12290 """
12291 SetSizeHints(self, Window window)
12292
12293 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
12294 match the sizer's minimal size. This is commonly done in the
12295 constructor of the window itself if the window is resizable (as are
12296 many dialogs under Unix and frames on probably all platforms) in order
12297 to prevent the window from being sized smaller than the minimal size
12298 required by the sizer.
12299 """
d55e5bfc
RD		 12300 return _core_.Sizer_SetSizeHints(*args, **kwargs)
12301
12302 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD		 12303 """
12304 SetVirtualSizeHints(self, Window window)
12305
12306 Tell the sizer to set the minimal size of the window virtual area to
12307 match the sizer's minimal size. For windows with managed scrollbars
12308 this will set them appropriately.
12309
12310 :see: `wx.ScrolledWindow.SetScrollbars`
12311
12312 """
d55e5bfc
RD		 12313 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
12314
12315 def Clear(*args, **kwargs):
248ed943
RD		 12316 """
12317 Clear(self, bool deleteWindows=False)
12318
12319 Clear all items from the sizer, optionally destroying the window items
12320 as well.
12321 """
d55e5bfc
RD		 12322 return _core_.Sizer_Clear(*args, **kwargs)
12323
12324 def DeleteWindows(*args, **kwargs):
248ed943
RD		 12325 """
12326 DeleteWindows(self)
12327
12328 Destroy all windows managed by the sizer.
12329 """
d55e5bfc
RD		 12330 return _core_.Sizer_DeleteWindows(*args, **kwargs)
12331
12332 def GetChildren(*args, **kwargs):
248ed943 12333 """
51b83b37 12334 GetChildren(self) -> list
248ed943
RD		 12335
12336 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
12337 """
d55e5bfc
RD		 12338 return _core_.Sizer_GetChildren(*args, **kwargs)
12339
12340 def Show(*args, **kwargs):
248ed943 12341 """
ae8162c8 12342 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 12343
248ed943
RD		 12344 Shows or hides an item managed by the sizer. To make a sizer item
12345 disappear or reappear, use Show followed by `Layout`. The *item*
12346 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD		 12347 the item. Use the recursive parameter to show or hide an item in a
12348 subsizer. Returns True if the item was found.
248ed943
RD		 12349 """
12350 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD		 12351
12352 def IsShown(*args, **kwargs):
248ed943
RD		 12353 """
12354 IsShown(self, item)
12355
b1fcee84 12356 Determines if the item is currently shown. To make a sizer
248ed943
RD		 12357 item disappear or reappear, use Show followed by `Layout`. The *item*
12358 parameter can be either a window, a sizer, or the zero-based index of
12359 the item.
12360 """
d55e5bfc
RD		 12361 return _core_.Sizer_IsShown(*args, **kwargs)
12362
629e65c2 12363 def Hide(self, item, recursive=False):
248ed943 12364 """
27fb7603 12365 A convenience method for `Show` (item, False, recursive).
248ed943 12366 """
06759a38 12367 return self.Show(item, False, recursive)
248ed943 12368
d55e5bfc 12369 def ShowItems(*args, **kwargs):
248ed943
RD		 12370 """
12371 ShowItems(self, bool show)
12372
84f85550 12373 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12374 """
d55e5bfc
RD		 12375 return _core_.Sizer_ShowItems(*args, **kwargs)
12376
33d6fd3b
RD		 12377 Children = property(GetChildren,doc="See `GetChildren`")
12378 ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
12379 MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
12380 Position = property(GetPosition,doc="See `GetPosition`")
12381 Size = property(GetSize,doc="See `GetSize`")
2131d850 12382_core_.Sizer_swigregister(Sizer)
d55e5bfc
RD		 12383
12384class PySizer(Sizer):
248ed943
RD		 12385 """
12386 wx.PySizer is a special version of `wx.Sizer` that has been
12387 instrumented to allow the C++ virtual methods to be overloaded in
12388 Python derived classes. You would derive from this class if you are
12389 wanting to implement a custom sizer in Python code. Simply implement
12390 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12391 For example::
12392
12393 class MySizer(wx.PySizer):
12394 def __init__(self):
12395 wx.PySizer.__init__(self)
12396
12397 def CalcMin(self):
12398 for item in self.GetChildren():
12399 # calculate the total minimum width and height needed
12400 # by all items in the sizer according to this sizer's
12401 # layout algorithm.
12402 ...
12403 return wx.Size(width, height)
12404
12405 def RecalcSizes(self):
12406 # find the space allotted to this sizer
12407 pos = self.GetPosition()
12408 size = self.GetSize()
12409 for item in self.GetChildren():
12410 # Recalculate (if necessary) the position and size of
12411 # each item and then call item.SetDimension to do the
12412 # actual positioning and sizing of the items within the
12413 # space alloted to this sizer.
12414 ...
12415 item.SetDimension(itemPos, itemSize)
12416
12417
12418 When `Layout` is called it first calls `CalcMin` followed by
12419 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 12420 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD		 12421
12422 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12423
12424
12425 """
554f62e9
RD		 12426 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12427 __repr__ = _swig_repr
12428 def __init__(self, *args, **kwargs):
248ed943
RD		 12429 """
12430 __init__(self) -> PySizer
12431
12432 Creates a wx.PySizer. Must be called from the __init__ in the derived
12433 class.
12434 """
554f62e9 12435 _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
c25f90f6 12436 self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer)
d55e5bfc
RD		 12437
12438 def _setCallbackInfo(*args, **kwargs):
12439 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12440 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12441
2131d850 12442_core_.PySizer_swigregister(PySizer)
d55e5bfc
RD		 12443
12444#---------------------------------------------------------------------------
12445
12446class BoxSizer(Sizer):
248ed943
RD		 12447 """
12448 The basic idea behind a box sizer is that windows will most often be
12449 laid out in rather simple basic geometry, typically in a row or a
12450 column or nested hierarchies of either. A wx.BoxSizer will lay out
12451 its items in a simple row or column, depending on the orientation
12452 parameter passed to the constructor.
12453 """
554f62e9
RD		 12454 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12455 __repr__ = _swig_repr
12456 def __init__(self, *args, **kwargs):
248ed943
RD		 12457 """
12458 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12459
12460 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12461 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12462 sizer.
12463 """
554f62e9 12464 _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
d55e5bfc
RD		 12465 self._setOORInfo(self)
12466
12467 def GetOrientation(*args, **kwargs):
248ed943
RD		 12468 """
12469 GetOrientation(self) -> int
12470
12471 Returns the current orientation of the sizer.
12472 """
d55e5bfc
RD		 12473 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12474
12475 def SetOrientation(*args, **kwargs):
248ed943
RD		 12476 """
12477 SetOrientation(self, int orient)
d55e5bfc 12478
248ed943
RD		 12479 Resets the orientation of the sizer.
12480 """
12481 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc 12482
226118fc 12483 Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
2131d850 12484_core_.BoxSizer_swigregister(BoxSizer)
d55e5bfc
RD		 12485
12486#---------------------------------------------------------------------------
12487
12488class StaticBoxSizer(BoxSizer):
248ed943
RD		 12489 """
12490 wx.StaticBoxSizer derives from and functions identically to the
12491 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12492 manages. Note that this static box must be created separately and
12493 passed to the sizer constructor.
12494 """
554f62e9
RD		 12495 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12496 __repr__ = _swig_repr
12497 def __init__(self, *args, **kwargs):
248ed943
RD		 12498 """
12499 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12500
12501 Constructor. It takes an associated static box and the orientation
12502 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12503 ``wx.HORIZONTAL``.
12504 """
554f62e9 12505 _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
d55e5bfc
RD		 12506 self._setOORInfo(self)
12507
12508 def GetStaticBox(*args, **kwargs):
248ed943
RD		 12509 """
12510 GetStaticBox(self) -> StaticBox
d55e5bfc 12511
248ed943
RD		 12512 Returns the static box associated with this sizer.
12513 """
12514 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc 12515
33d6fd3b 12516 StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
2131d850 12517_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
d55e5bfc
RD		 12518
12519#---------------------------------------------------------------------------
12520
12521class GridSizer(Sizer):
248ed943
RD		 12522 """
12523 A grid sizer is a sizer which lays out its children in a
12524 two-dimensional table with all cells having the same size. In other
12525 words, the width of each cell within the grid is the width of the
12526 widest item added to the sizer and the height of each grid cell is the
12527 height of the tallest item. An optional vertical and/or horizontal
12528 gap between items can also be specified (in pixels.)
12529
12530 Items are placed in the cells of the grid in the order they are added,
12531 in row-major order. In other words, the first row is filled first,
12532 then the second, and so on until all items have been added. (If
12533 neccessary, additional rows will be added as items are added.) If you
12534 need to have greater control over the cells that items are placed in
12535 then use the `wx.GridBagSizer`.
12536
12537 """
554f62e9
RD		 12538 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12539 __repr__ = _swig_repr
12540 def __init__(self, *args, **kwargs):
248ed943
RD		 12541 """
12542 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12543
12544 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12545 of columns and rows in the sizer - if either of the parameters is
12546 zero, it will be calculated to from the total number of children in
12547 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12548 define extra space between all children.
12549 """
554f62e9 12550 _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
d55e5bfc
RD		 12551 self._setOORInfo(self)
12552
d55e5bfc 12553 def SetCols(*args, **kwargs):
248ed943
RD		 12554 """
12555 SetCols(self, int cols)
12556
12557 Sets the number of columns in the sizer.
12558 """
d55e5bfc
RD		 12559 return _core_.GridSizer_SetCols(*args, **kwargs)
12560
12561 def SetRows(*args, **kwargs):
248ed943
RD		 12562 """
12563 SetRows(self, int rows)
12564
12565 Sets the number of rows in the sizer.
12566 """
d55e5bfc
RD		 12567 return _core_.GridSizer_SetRows(*args, **kwargs)
12568
12569 def SetVGap(*args, **kwargs):
248ed943
RD		 12570 """
12571 SetVGap(self, int gap)
12572
12573 Sets the vertical gap (in pixels) between the cells in the sizer.
12574 """
d55e5bfc
RD		 12575 return _core_.GridSizer_SetVGap(*args, **kwargs)
12576
12577 def SetHGap(*args, **kwargs):
248ed943
RD		 12578 """
12579 SetHGap(self, int gap)
12580
12581 Sets the horizontal gap (in pixels) between cells in the sizer
12582 """
d55e5bfc
RD		 12583 return _core_.GridSizer_SetHGap(*args, **kwargs)
12584
12585 def GetCols(*args, **kwargs):
248ed943
RD		 12586 """
12587 GetCols(self) -> int
12588
12589 Returns the number of columns in the sizer.
12590 """
d55e5bfc
RD		 12591 return _core_.GridSizer_GetCols(*args, **kwargs)
12592
12593 def GetRows(*args, **kwargs):
248ed943
RD		 12594 """
12595 GetRows(self) -> int
12596
12597 Returns the number of rows in the sizer.
12598 """
d55e5bfc
RD		 12599 return _core_.GridSizer_GetRows(*args, **kwargs)
12600
12601 def GetVGap(*args, **kwargs):
248ed943
RD		 12602 """
12603 GetVGap(self) -> int
12604
12605 Returns the vertical gap (in pixels) between the cells in the sizer.
12606 """
d55e5bfc
RD		 12607 return _core_.GridSizer_GetVGap(*args, **kwargs)
12608
12609 def GetHGap(*args, **kwargs):
248ed943
RD		 12610 """
12611 GetHGap(self) -> int
12612
12613 Returns the horizontal gap (in pixels) between cells in the sizer.
12614 """
d55e5bfc
RD		 12615 return _core_.GridSizer_GetHGap(*args, **kwargs)
12616
554f62e9
RD		 12617 def CalcRowsCols(self):
12618 """
12619 CalcRowsCols() -> (rows, cols)
d55e5bfc 12620
554f62e9
RD		 12621 Calculates how many rows and columns will be in the sizer based
12622 on the current number of items and also the rows, cols specified
12623 in the constructor.
12624 """
12625 nitems = len(self.GetChildren())
12626 rows = self.GetRows()
12627 cols = self.GetCols()
12628 assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
12629 if cols != 0:
12630 rows = (nitems + cols - 1) / cols
12631 elif rows != 0:
12632 cols = (nitems + rows - 1) / rows
12633 return (rows, cols)
12634
97ab0f6a
RD		 12635 Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`")
12636 HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`")
12637 Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`")
12638 VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`")
2131d850 12639_core_.GridSizer_swigregister(GridSizer)
d55e5bfc
RD		 12640
12641#---------------------------------------------------------------------------
12642
12643FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12644FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12645FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12646class FlexGridSizer(GridSizer):
248ed943
RD		 12647 """
12648 A flex grid sizer is a sizer which lays out its children in a
12649 two-dimensional table with all table cells in one row having the same
12650 height and all cells in one column having the same width, but all
12651 rows or all columns are not necessarily the same height or width as in
12652 the `wx.GridSizer`.
12653
12654 wx.FlexGridSizer can also size items equally in one direction but
12655 unequally ("flexibly") in the other. If the sizer is only flexible
12656 in one direction (this can be changed using `SetFlexibleDirection`), it
12657 needs to be decided how the sizer should grow in the other ("non
12658 flexible") direction in order to fill the available space. The
12659 `SetNonFlexibleGrowMode` method serves this purpose.
12660
12661
12662 """
554f62e9
RD		 12663 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12664 __repr__ = _swig_repr
12665 def __init__(self, *args, **kwargs):
248ed943
RD		 12666 """
12667 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12668
12669 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12670 number of columns and rows in the sizer - if either of the parameters
12671 is zero, it will be calculated to from the total number of children in
12672 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12673 define extra space between all children.
12674 """
554f62e9 12675 _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
d55e5bfc
RD		 12676 self._setOORInfo(self)
12677
248ed943
RD		 12678 def AddGrowableRow(*args, **kwargs):
12679 """
12680 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 12681
248ed943
RD		 12682 Specifies that row *idx* (starting from zero) should be grown if there
12683 is extra space available to the sizer.
d55e5bfc 12684
248ed943
RD		 12685 The *proportion* parameter has the same meaning as the stretch factor
12686 for the box sizers except that if all proportions are 0, then all
12687 columns are resized equally (instead of not being resized at all).
12688 """
d55e5bfc
RD		 12689 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12690
12691 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD		 12692 """
12693 RemoveGrowableRow(self, size_t idx)
12694
12695 Specifies that row *idx* is no longer growable.
12696 """
d55e5bfc
RD		 12697 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12698
12699 def AddGrowableCol(*args, **kwargs):
248ed943
RD		 12700 """
12701 AddGrowableCol(self, size_t idx, int proportion=0)
12702
12703 Specifies that column *idx* (starting from zero) should be grown if
12704 there is extra space available to the sizer.
12705
12706 The *proportion* parameter has the same meaning as the stretch factor
12707 for the box sizers except that if all proportions are 0, then all
12708 columns are resized equally (instead of not being resized at all).
12709 """
d55e5bfc
RD		 12710 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12711
12712 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD		 12713 """
12714 RemoveGrowableCol(self, size_t idx)
12715
12716 Specifies that column *idx* is no longer growable.
12717 """
d55e5bfc
RD		 12718 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12719
12720 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12721 """
12722 SetFlexibleDirection(self, int direction)
12723
12724 Specifies whether the sizer should flexibly resize its columns, rows,
12725 or both. Argument *direction* can be one of the following values. Any
12726 other value is ignored.
12727
12728 ============== =======================================
12729 wx.VERTICAL Rows are flexibly sized.
12730 wx.HORIZONTAL Columns are flexibly sized.
12731 wx.BOTH Both rows and columns are flexibly sized
12732 (this is the default value).
12733 ============== =======================================
12734
12735 Note that this method does not trigger relayout.
12736
12737 """
d55e5bfc
RD		 12738 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12739
12740 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD		 12741 """
12742 GetFlexibleDirection(self) -> int
12743
12744 Returns a value that specifies whether the sizer
12745 flexibly resizes its columns, rows, or both (default).
12746
12747 :see: `SetFlexibleDirection`
12748 """
d55e5bfc
RD		 12749 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12750
12751 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12752 """
12753 SetNonFlexibleGrowMode(self, int mode)
12754
12755 Specifies how the sizer should grow in the non-flexible direction if
12756 there is one (so `SetFlexibleDirection` must have been called
12757 previously). Argument *mode* can be one of the following values:
12758
12759 ========================== =================================================
12760 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12761 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12762 `AddGrowableCol` and `AddGrowableRow`. In this
12763 case equal sizing applies to minimum sizes of
12764 columns or rows (this is the default value).
12765 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12766 the non flexible direction, whether they are
12767 growable or not in the flexbile direction.
12768 ========================== =================================================
12769
12770 Note that this method does not trigger relayout.
248ed943 12771 """
d55e5bfc
RD		 12772 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12773
12774 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 12775 """
12776 GetNonFlexibleGrowMode(self) -> int
12777
12778 Returns the value that specifies how the sizer grows in the
12779 non-flexible direction if there is one.
12780
12781 :see: `SetNonFlexibleGrowMode`
12782 """
d55e5bfc
RD		 12783 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12784
12785 def GetRowHeights(*args, **kwargs):
a8eff060
RD		 12786 """
12787 GetRowHeights(self) -> list
12788
12789 Returns a list of integers representing the heights of each of the
12790 rows in the sizer.
12791 """
d55e5bfc
RD		 12792 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12793
12794 def GetColWidths(*args, **kwargs):
a8eff060
RD		 12795 """
12796 GetColWidths(self) -> list
12797
12798 Returns a list of integers representing the widths of each of the
12799 columns in the sizer.
12800 """
d55e5bfc
RD		 12801 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12802
97ab0f6a
RD		 12803 ColWidths = property(GetColWidths,doc="See `GetColWidths`")
12804 FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`")
12805 NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`")
12806 RowHeights = property(GetRowHeights,doc="See `GetRowHeights`")
2131d850 12807_core_.FlexGridSizer_swigregister(FlexGridSizer)
d55e5bfc 12808
62d32a5f
RD		 12809class StdDialogButtonSizer(BoxSizer):
12810 """
12811 A special sizer that knows how to order and position standard buttons
12812 in order to conform to the current platform's standards. You simply
12813 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12814 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD		 12815 will take care of the rest.
12816
12817 """
554f62e9
RD		 12818 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12819 __repr__ = _swig_repr
12820 def __init__(self, *args, **kwargs):
62d32a5f 12821 """__init__(self) -> StdDialogButtonSizer"""
554f62e9 12822 _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
62d32a5f
RD		 12823 def AddButton(*args, **kwargs):
12824 """
12825 AddButton(self, wxButton button)
12826
12827 Use this to add the buttons to this sizer. Do not use the `Add`
12828 method in the base class.
12829 """
12830 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12831
53aa7709 12832 def Realize(*args, **kwargs):
62d32a5f 12833 """
53aa7709 12834 Realize(self)
62d32a5f
RD		 12835
12836 This funciton needs to be called after all the buttons have been added
12837 to the sizer. It will reorder them and position them in a platform
12838 specifc manner.
12839 """
53aa7709 12840 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 12841
12842 def SetAffirmativeButton(*args, **kwargs):
12843 """SetAffirmativeButton(self, wxButton button)"""
12844 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12845
12846 def SetNegativeButton(*args, **kwargs):
12847 """SetNegativeButton(self, wxButton button)"""
12848 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12849
12850 def SetCancelButton(*args, **kwargs):
12851 """SetCancelButton(self, wxButton button)"""
12852 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD		 12853
12854 def GetAffirmativeButton(*args, **kwargs):
12855 """GetAffirmativeButton(self) -> wxButton"""
12856 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12857
12858 def GetApplyButton(*args, **kwargs):
12859 """GetApplyButton(self) -> wxButton"""
12860 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12861
12862 def GetNegativeButton(*args, **kwargs):
12863 """GetNegativeButton(self) -> wxButton"""
12864 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12865
12866 def GetCancelButton(*args, **kwargs):
12867 """GetCancelButton(self) -> wxButton"""
12868 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12869
12870 def GetHelpButton(*args, **kwargs):
12871 """GetHelpButton(self) -> wxButton"""
12872 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12873
33d6fd3b
RD		 12874 AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
12875 ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
12876 CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
12877 HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
12878 NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
2131d850 12879_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
62d32a5f 12880
d55e5bfc
RD		 12881#---------------------------------------------------------------------------
12882
12883class GBPosition(object):
248ed943
RD		 12884 """
12885 This class represents the position of an item in a virtual grid of
12886 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12887 typemaps that will automatically convert from a 2-element sequence of
12888 integers to a wx.GBPosition, so you can use the more pythonic
12889 representation of the position nearly transparently in Python code.
12890 """
554f62e9
RD		 12891 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12892 __repr__ = _swig_repr
12893 def __init__(self, *args, **kwargs):
248ed943
RD		 12894 """
12895 __init__(self, int row=0, int col=0) -> GBPosition
12896
12897 This class represents the position of an item in a virtual grid of
12898 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12899 typemaps that will automatically convert from a 2-element sequence of
12900 integers to a wx.GBPosition, so you can use the more pythonic
12901 representation of the position nearly transparently in Python code.
12902 """
554f62e9
RD		 12903 _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
12904 __swig_destroy__ = _core_.delete_GBPosition
12905 __del__ = lambda self : None;
d55e5bfc
RD		 12906 def GetRow(*args, **kwargs):
12907 """GetRow(self) -> int"""
12908 return _core_.GBPosition_GetRow(*args, **kwargs)
12909
12910 def GetCol(*args, **kwargs):
12911 """GetCol(self) -> int"""
12912 return _core_.GBPosition_GetCol(*args, **kwargs)
12913
12914 def SetRow(*args, **kwargs):
12915 """SetRow(self, int row)"""
12916 return _core_.GBPosition_SetRow(*args, **kwargs)
12917
12918 def SetCol(*args, **kwargs):
12919 """SetCol(self, int col)"""
12920 return _core_.GBPosition_SetCol(*args, **kwargs)
12921
12922 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 12923 """
12924 __eq__(self, PyObject other) -> bool
12925
12926 Compare GBPosition for equality.
12927 """
d55e5bfc
RD		 12928 return _core_.GBPosition___eq__(*args, **kwargs)
12929
12930 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 12931 """
12932 __ne__(self, PyObject other) -> bool
12933
12934 Compare GBPosition for inequality.
12935 """
d55e5bfc
RD		 12936 return _core_.GBPosition___ne__(*args, **kwargs)
12937
12938 def Set(*args, **kwargs):
12939 """Set(self, int row=0, int col=0)"""
12940 return _core_.GBPosition_Set(*args, **kwargs)
12941
12942 def Get(*args, **kwargs):
12943 """Get(self) -> PyObject"""
12944 return _core_.GBPosition_Get(*args, **kwargs)
12945
79fccf9d 12946 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 12947 def __str__(self): return str(self.Get())
12948 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12949 def __len__(self): return len(self.Get())
12950 def __getitem__(self, index): return self.Get()[index]
12951 def __setitem__(self, index, val):
12952 if index == 0: self.SetRow(val)
12953 elif index == 1: self.SetCol(val)
12954 else: raise IndexError
12955 def __nonzero__(self): return self.Get() != (0,0)
12956 __safe_for_unpickling__ = True
12957 def __reduce__(self): return (wx.GBPosition, self.Get())
12958
12959 row = property(GetRow, SetRow)
12960 col = property(GetCol, SetCol)
12961
2131d850 12962_core_.GBPosition_swigregister(GBPosition)
d55e5bfc
RD		 12963
12964class GBSpan(object):
248ed943
RD		 12965 """
12966 This class is used to hold the row and column spanning attributes of
12967 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12968 automatically convert from a 2-element sequence of integers to a
12969 wx.GBSpan, so you can use the more pythonic representation of the span
12970 nearly transparently in Python code.
12971
12972 """
554f62e9
RD		 12973 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
12974 __repr__ = _swig_repr
12975 def __init__(self, *args, **kwargs):
248ed943
RD		 12976 """
12977 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12978
12979 Construct a new wxGBSpan, optionally setting the rowspan and
12980 colspan. The default is (1,1). (Meaning that the item occupies one
12981 cell in each direction.
12982 """
554f62e9
RD		 12983 _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
12984 __swig_destroy__ = _core_.delete_GBSpan
12985 __del__ = lambda self : None;
d55e5bfc
RD		 12986 def GetRowspan(*args, **kwargs):
12987 """GetRowspan(self) -> int"""
12988 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12989
12990 def GetColspan(*args, **kwargs):
12991 """GetColspan(self) -> int"""
12992 return _core_.GBSpan_GetColspan(*args, **kwargs)
12993
12994 def SetRowspan(*args, **kwargs):
12995 """SetRowspan(self, int rowspan)"""
12996 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12997
12998 def SetColspan(*args, **kwargs):
12999 """SetColspan(self, int colspan)"""
13000 return _core_.GBSpan_SetColspan(*args, **kwargs)
13001
13002 def __eq__(*args, **kwargs):
e9d6f3a4
RD		 13003 """
13004 __eq__(self, PyObject other) -> bool
13005
13006 Compare wxGBSpan for equality.
13007 """
d55e5bfc
RD		 13008 return _core_.GBSpan___eq__(*args, **kwargs)
13009
13010 def __ne__(*args, **kwargs):
e9d6f3a4
RD		 13011 """
13012 __ne__(self, PyObject other) -> bool
13013
13014 Compare GBSpan for inequality.
13015 """
d55e5bfc
RD		 13016 return _core_.GBSpan___ne__(*args, **kwargs)
13017
13018 def Set(*args, **kwargs):
13019 """Set(self, int rowspan=1, int colspan=1)"""
13020 return _core_.GBSpan_Set(*args, **kwargs)
13021
13022 def Get(*args, **kwargs):
13023 """Get(self) -> PyObject"""
13024 return _core_.GBSpan_Get(*args, **kwargs)
13025
79fccf9d 13026 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 13027 def __str__(self): return str(self.Get())
13028 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
13029 def __len__(self): return len(self.Get())
13030 def __getitem__(self, index): return self.Get()[index]
13031 def __setitem__(self, index, val):
13032 if index == 0: self.SetRowspan(val)
13033 elif index == 1: self.SetColspan(val)
13034 else: raise IndexError
13035 def __nonzero__(self): return self.Get() != (0,0)
13036 __safe_for_unpickling__ = True
13037 def __reduce__(self): return (wx.GBSpan, self.Get())
13038
13039 rowspan = property(GetRowspan, SetRowspan)
13040 colspan = property(GetColspan, SetColspan)
13041
2131d850 13042_core_.GBSpan_swigregister(GBSpan)
d55e5bfc
RD		 13043
13044class GBSizerItem(SizerItem):
248ed943
RD		 13045 """
13046 The wx.GBSizerItem class is used to track the additional data about
13047 items in a `wx.GridBagSizer` such as the item's position in the grid
13048 and how many rows or columns it spans.
13049
13050 """
554f62e9
RD		 13051 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13052 __repr__ = _swig_repr
13053 def __init__(self, *args, **kwargs):
248ed943
RD		 13054 """
13055 __init__(self) -> GBSizerItem
13056
13057 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
13058 size will need to be set, as well as a position and span before this
13059 item can be used in a Sizer.
13060
13061 You will probably never need to create a wx.GBSizerItem directly as they
13062 are created automatically when the sizer's Add method is called.
13063 """
554f62e9
RD		 13064 _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
13065 __swig_destroy__ = _core_.delete_GBSizerItem
13066 __del__ = lambda self : None;
d55e5bfc 13067 def GetPos(*args, **kwargs):
248ed943
RD		 13068 """
13069 GetPos(self) -> GBPosition
13070
13071 Get the grid position of the item
13072 """
d55e5bfc
RD		 13073 return _core_.GBSizerItem_GetPos(*args, **kwargs)
13074
13075 def GetPosTuple(self): return self.GetPos().Get()
13076 def GetSpan(*args, **kwargs):
248ed943
RD		 13077 """
13078 GetSpan(self) -> GBSpan
13079
13080 Get the row and column spanning of the item
13081 """
d55e5bfc
RD		 13082 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
13083
13084 def GetSpanTuple(self): return self.GetSpan().Get()
13085 def SetPos(*args, **kwargs):
248ed943
RD		 13086 """
13087 SetPos(self, GBPosition pos) -> bool
13088
13089 If the item is already a member of a sizer then first ensure that
13090 there is no other item that would intersect with this one at the new
13091 position, then set the new position. Returns True if the change is
13092 successful and after the next Layout() the item will be moved.
13093 """
d55e5bfc
RD		 13094 return _core_.GBSizerItem_SetPos(*args, **kwargs)
13095
13096 def SetSpan(*args, **kwargs):
248ed943
RD		 13097 """
13098 SetSpan(self, GBSpan span) -> bool
13099
13100 If the item is already a member of a sizer then first ensure that
13101 there is no other item that would intersect with this one with its new
13102 spanning size, then set the new spanning. Returns True if the change
13103 is successful and after the next Layout() the item will be resized.
13104
13105 """
d55e5bfc
RD		 13106 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
13107
248ed943 13108 def Intersects(*args, **kwargs):
d55e5bfc
RD		 13109 """
13110 Intersects(self, GBSizerItem other) -> bool
248ed943
RD		 13111
13112 Returns True if this item and the other item instersect.
d55e5bfc 13113 """
248ed943
RD		 13114 return _core_.GBSizerItem_Intersects(*args, **kwargs)
13115
13116 def IntersectsPos(*args, **kwargs):
13117 """
13118 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
13119
13120 Returns True if the given pos/span would intersect with this item.
13121 """
13122 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD		 13123
13124 def GetEndPos(*args, **kwargs):
248ed943
RD		 13125 """
13126 GetEndPos(self) -> GBPosition
13127
13128 Get the row and column of the endpoint of this item.
13129 """
d55e5bfc
RD		 13130 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
13131
13132 def GetGBSizer(*args, **kwargs):
248ed943
RD		 13133 """
13134 GetGBSizer(self) -> GridBagSizer
13135
13136 Get the sizer this item is a member of.
13137 """
d55e5bfc
RD		 13138 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
13139
13140 def SetGBSizer(*args, **kwargs):
248ed943
RD		 13141 """
13142 SetGBSizer(self, GridBagSizer sizer)
13143
13144 Set the sizer this item is a member of.
13145 """
d55e5bfc
RD		 13146 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
13147
97ab0f6a
RD		 13148 EndPos = property(GetEndPos,doc="See `GetEndPos`")
13149 GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`")
13150 Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`")
13151 Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`")
2131d850 13152_core_.GBSizerItem_swigregister(GBSizerItem)
d55e5bfc
RD		 13153DefaultSpan = cvar.DefaultSpan
13154
13155def GBSizerItemWindow(*args, **kwargs):
13156 """
13157 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13158 int border, PyObject userData=None) -> GBSizerItem
13159
13160 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD		 13161 """
13162 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 13163 return val
13164
13165def GBSizerItemSizer(*args, **kwargs):
13166 """
13167 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 13168 int border, PyObject userData=None) -> GBSizerItem
13169
13170 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD		 13171 """
13172 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d55e5bfc
RD		 13173 return val
13174
13175def GBSizerItemSpacer(*args, **kwargs):
13176 """
13177 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD		 13178 int flag, int border, PyObject userData=None) -> GBSizerItem
13179
13180 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD		 13181 """
13182 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 13183 return val
13184
13185class GridBagSizer(FlexGridSizer):
248ed943
RD		 13186 """
13187 A `wx.Sizer` that can lay out items in a virtual grid like a
13188 `wx.FlexGridSizer` but in this case explicit positioning of the items
13189 is allowed using `wx.GBPosition`, and items can optionally span more
13190 than one row and/or column using `wx.GBSpan`. The total size of the
13191 virtual grid is determined by the largest row and column that items are
13192 positioned at, adjusted for spanning.
13193
13194 """
554f62e9
RD		 13195 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13196 __repr__ = _swig_repr
13197 def __init__(self, *args, **kwargs):
248ed943
RD		 13198 """
13199 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
13200
13201 Constructor, with optional parameters to specify the gap between the
13202 rows and columns.
13203 """
554f62e9 13204 _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
c9c2cf70
RD		 13205 self._setOORInfo(self)
13206
d55e5bfc
RD		 13207 def Add(*args, **kwargs):
13208 """
248ed943 13209 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 13210 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD		 13211
13212 Adds an item to the sizer at the grid cell *pos*, optionally spanning
13213 more than one row or column as specified with *span*. The remaining
13214 args behave similarly to `wx.Sizer.Add`.
13215
13216 Returns True if the item was successfully placed at the given cell
13217 position, False if something was already there.
13218
d55e5bfc
RD		 13219 """
13220 return _core_.GridBagSizer_Add(*args, **kwargs)
13221
13222 def AddItem(*args, **kwargs):
248ed943 13223 """
c1cb24a4 13224 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD		 13225
13226 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
13227 the item was successfully placed at its given cell position, False if
13228 something was already there.
13229 """
d55e5bfc
RD		 13230 return _core_.GridBagSizer_AddItem(*args, **kwargs)
13231
84f85550
RD		 13232 def GetCellSize(*args, **kwargs):
13233 """
13234 GetCellSize(self, int row, int col) -> Size
13235
13236 Get the size of the specified cell, including hgap and
13237 vgap. Only valid after a Layout.
13238 """
13239 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
13240
d55e5bfc 13241 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13242 """
13243 GetEmptyCellSize(self) -> Size
13244
13245 Get the size used for cells in the grid with no item.
13246 """
d55e5bfc
RD		 13247 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
13248
13249 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD		 13250 """
13251 SetEmptyCellSize(self, Size sz)
13252
13253 Set the size used for cells in the grid with no item.
13254 """
d55e5bfc
RD		 13255 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
13256
13257 def GetItemPosition(*args):
13258 """
248ed943
RD		 13259 GetItemPosition(self, item) -> GBPosition
13260
13261 Get the grid position of the specified *item* where *item* is either a
13262 window or subsizer that is a member of this sizer, or a zero-based
13263 index of an item.
d55e5bfc
RD		 13264 """
13265 return _core_.GridBagSizer_GetItemPosition(*args)
13266
13267 def SetItemPosition(*args):
13268 """
248ed943
RD		 13269 SetItemPosition(self, item, GBPosition pos) -> bool
13270
13271 Set the grid position of the specified *item* where *item* is either a
13272 window or subsizer that is a member of this sizer, or a zero-based
13273 index of an item. Returns True on success. If the move is not
13274 allowed (because an item is already there) then False is returned.
13275
d55e5bfc
RD		 13276 """
13277 return _core_.GridBagSizer_SetItemPosition(*args)
13278
13279 def GetItemSpan(*args):
13280 """
248ed943
RD		 13281 GetItemSpan(self, item) -> GBSpan
13282
13283 Get the row/col spanning of the specified *item* where *item* is
13284 either a window or subsizer that is a member of this sizer, or a
13285 zero-based index of an item.
d55e5bfc
RD		 13286 """
13287 return _core_.GridBagSizer_GetItemSpan(*args)
13288
13289 def SetItemSpan(*args):
13290 """
248ed943
RD		 13291 SetItemSpan(self, item, GBSpan span) -> bool
13292
13293 Set the row/col spanning of the specified *item* where *item* is
13294 either a window or subsizer that is a member of this sizer, or a
13295 zero-based index of an item. Returns True on success. If the move is
13296 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD		 13297 """
13298 return _core_.GridBagSizer_SetItemSpan(*args)
13299
13300 def FindItem(*args):
13301 """
248ed943
RD		 13302 FindItem(self, item) -> GBSizerItem
13303
13304 Find the sizer item for the given window or subsizer, returns None if
13305 not found. (non-recursive)
d55e5bfc
RD		 13306 """
13307 return _core_.GridBagSizer_FindItem(*args)
13308
13309 def FindItemAtPosition(*args, **kwargs):
248ed943
RD		 13310 """
13311 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
13312
13313 Return the sizer item for the given grid cell, or None if there is no
13314 item at that position. (non-recursive)
13315 """
d55e5bfc
RD		 13316 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
13317
13318 def FindItemAtPoint(*args, **kwargs):
248ed943
RD		 13319 """
13320 FindItemAtPoint(self, Point pt) -> GBSizerItem
13321
13322 Return the sizer item located at the point given in *pt*, or None if
13323 there is no item at that point. The (x,y) coordinates in pt correspond
13324 to the client coordinates of the window using the sizer for
13325 layout. (non-recursive)
13326 """
d55e5bfc
RD		 13327 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
13328
248ed943
RD		 13329 def CheckForIntersection(*args, **kwargs):
13330 """
13331 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 13332
248ed943
RD		 13333 Look at all items and see if any intersect (or would overlap) the
13334 given *item*. Returns True if so, False if there would be no overlap.
13335 If an *excludeItem* is given then it will not be checked for
13336 intersection, for example it may be the item we are checking the
13337 position of.
d55e5bfc 13338
248ed943
RD		 13339 """
13340 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 13341
248ed943 13342 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 13343 """
248ed943
RD		 13344 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13345
13346 Look at all items and see if any intersect (or would overlap) the
13347 given position and span. Returns True if so, False if there would be
13348 no overlap. If an *excludeItem* is given then it will not be checked
13349 for intersection, for example it may be the item we are checking the
13350 position of.
d55e5bfc 13351 """
248ed943 13352 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc 13353
2131d850 13354_core_.GridBagSizer_swigregister(GridBagSizer)
d55e5bfc
RD		 13355
13356#---------------------------------------------------------------------------
13357
13358Left = _core_.Left
13359Top = _core_.Top
13360Right = _core_.Right
13361Bottom = _core_.Bottom
13362Width = _core_.Width
13363Height = _core_.Height
13364Centre = _core_.Centre
13365Center = _core_.Center
13366CentreX = _core_.CentreX
13367CentreY = _core_.CentreY
13368Unconstrained = _core_.Unconstrained
13369AsIs = _core_.AsIs
13370PercentOf = _core_.PercentOf
13371Above = _core_.Above
13372Below = _core_.Below
13373LeftOf = _core_.LeftOf
13374RightOf = _core_.RightOf
13375SameAs = _core_.SameAs
13376Absolute = _core_.Absolute
13377class IndividualLayoutConstraint(Object):
13378 """
79fccf9d
RD		 13379 Objects of this class are stored in the `wx.LayoutConstraints` class as
13380 one of eight possible constraints that a window can be involved in.
13381 You will never need to create an instance of
13382 wx.IndividualLayoutConstraint, rather you should create a
13383 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 13384 that it contains.
d55e5bfc 13385 """
554f62e9
RD		 13386 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13387 def __init__(self): raise AttributeError, "No constructor defined"
13388 __repr__ = _swig_repr
d55e5bfc 13389 def Set(*args, **kwargs):
79fccf9d
RD		 13390 """
13391 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13392
13393 Sets the properties of the constraint. Normally called by one of the
13394 convenience functions such as Above, RightOf, SameAs.
13395 """
d55e5bfc
RD		 13396 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13397
13398 def LeftOf(*args, **kwargs):
13399 """
13400 LeftOf(self, Window sibling, int marg=0)
13401
79fccf9d
RD		 13402 Constrains this edge to be to the left of the given window, with an
13403 optional margin. Implicitly, this is relative to the left edge of the
13404 other window.
d55e5bfc
RD		 13405 """
13406 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13407
13408 def RightOf(*args, **kwargs):
13409 """
13410 RightOf(self, Window sibling, int marg=0)
13411
79fccf9d
RD		 13412 Constrains this edge to be to the right of the given window, with an
13413 optional margin. Implicitly, this is relative to the right edge of the
13414 other window.
d55e5bfc
RD		 13415 """
13416 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13417
13418 def Above(*args, **kwargs):
13419 """
13420 Above(self, Window sibling, int marg=0)
13421
79fccf9d
RD		 13422 Constrains this edge to be above the given window, with an optional
13423 margin. Implicitly, this is relative to the top edge of the other
13424 window.
d55e5bfc
RD		 13425 """
13426 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13427
13428 def Below(*args, **kwargs):
13429 """
13430 Below(self, Window sibling, int marg=0)
13431
79fccf9d
RD		 13432 Constrains this edge to be below the given window, with an optional
13433 margin. Implicitly, this is relative to the bottom edge of the other
13434 window.
d55e5bfc
RD		 13435 """
13436 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13437
13438 def SameAs(*args, **kwargs):
13439 """
13440 SameAs(self, Window otherW, int edge, int marg=0)
13441
79fccf9d
RD		 13442 Constrains this edge or dimension to be to the same as the edge of the
13443 given window, with an optional margin.
d55e5bfc
RD		 13444 """
13445 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13446
13447 def PercentOf(*args, **kwargs):
13448 """
13449 PercentOf(self, Window otherW, int wh, int per)
13450
79fccf9d
RD		 13451 Constrains this edge or dimension to be to a percentage of the given
13452 window, with an optional margin.
d55e5bfc
RD		 13453 """
13454 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13455
13456 def Absolute(*args, **kwargs):
13457 """
13458 Absolute(self, int val)
13459
79fccf9d 13460 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD		 13461 """
13462 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13463
13464 def Unconstrained(*args, **kwargs):
13465 """
13466 Unconstrained(self)
13467
79fccf9d
RD		 13468 Sets this edge or dimension to be unconstrained, that is, dependent on
13469 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD		 13470 """
13471 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13472
13473 def AsIs(*args, **kwargs):
13474 """
13475 AsIs(self)
13476
79fccf9d
RD		 13477 Sets this edge or constraint to be whatever the window's value is at
13478 the moment. If either of the width and height constraints are *as is*,
13479 the window will not be resized, but moved instead. This is important
13480 when considering panel items which are intended to have a default
13481 size, such as a button, which may take its size from the size of the
13482 button label.
d55e5bfc
RD		 13483 """
13484 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13485
13486 def GetOtherWindow(*args, **kwargs):
13487 """GetOtherWindow(self) -> Window"""
13488 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13489
13490 def GetMyEdge(*args, **kwargs):
13491 """GetMyEdge(self) -> int"""
13492 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13493
13494 def SetEdge(*args, **kwargs):
13495 """SetEdge(self, int which)"""
13496 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13497
13498 def SetValue(*args, **kwargs):
13499 """SetValue(self, int v)"""
13500 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13501
13502 def GetMargin(*args, **kwargs):
13503 """GetMargin(self) -> int"""
13504 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13505
13506 def SetMargin(*args, **kwargs):
13507 """SetMargin(self, int m)"""
13508 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13509
13510 def GetValue(*args, **kwargs):
13511 """GetValue(self) -> int"""
13512 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13513
13514 def GetPercent(*args, **kwargs):
13515 """GetPercent(self) -> int"""
13516 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13517
13518 def GetOtherEdge(*args, **kwargs):
13519 """GetOtherEdge(self) -> int"""
13520 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13521
13522 def GetDone(*args, **kwargs):
13523 """GetDone(self) -> bool"""
13524 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13525
13526 def SetDone(*args, **kwargs):
13527 """SetDone(self, bool d)"""
13528 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13529
13530 def GetRelationship(*args, **kwargs):
13531 """GetRelationship(self) -> int"""
13532 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13533
13534 def SetRelationship(*args, **kwargs):
13535 """SetRelationship(self, int r)"""
13536 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13537
13538 def ResetIfWin(*args, **kwargs):
13539 """
13540 ResetIfWin(self, Window otherW) -> bool
13541
13542 Reset constraint if it mentions otherWin
13543 """
13544 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13545
13546 def SatisfyConstraint(*args, **kwargs):
13547 """
13548 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13549
13550 Try to satisfy constraint
13551 """
13552 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13553
13554 def GetEdge(*args, **kwargs):
13555 """
13556 GetEdge(self, int which, Window thisWin, Window other) -> int
13557
13558 Get the value of this edge or dimension, or if this
13559 is not determinable, -1.
13560 """
13561 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13562
97ab0f6a
RD		 13563 Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`")
13564 Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`")
13565 MyEdge = property(GetMyEdge,doc="See `GetMyEdge`")
13566 OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`")
13567 OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`")
13568 Percent = property(GetPercent,doc="See `GetPercent`")
13569 Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`")
13570 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2131d850 13571_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
d55e5bfc
RD		 13572
13573class LayoutConstraints(Object):
13574 """
79fccf9d
RD		 13575 **Note:** constraints are now deprecated and you should use sizers
13576 instead.
d55e5bfc 13577
79fccf9d
RD		 13578 Objects of this class can be associated with a window to define its
13579 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD		 13580
13581 The class consists of the following eight constraints of class
13582 wx.IndividualLayoutConstraint, some or all of which should be accessed
13583 directly to set the appropriate constraints.
13584
13585 * left: represents the left hand edge of the window
13586 * right: represents the right hand edge of the window
13587 * top: represents the top edge of the window
13588 * bottom: represents the bottom edge of the window
13589 * width: represents the width of the window
13590 * height: represents the height of the window
13591 * centreX: represents the horizontal centre point of the window
13592 * centreY: represents the vertical centre point of the window
13593
79fccf9d
RD		 13594 Most constraints are initially set to have the relationship
13595 wxUnconstrained, which means that their values should be calculated by
13596 looking at known constraints. The exceptions are width and height,
13597 which are set to wxAsIs to ensure that if the user does not specify a
13598 constraint, the existing width and height will be used, to be
13599 compatible with panel items which often have take a default size. If
13600 the constraint is ``wx.AsIs``, the dimension will not be changed.
13601
13602 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD		 13603
13604 """
554f62e9
RD		 13605 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
13606 __repr__ = _swig_repr
d55e5bfc
RD		 13607 left = property(_core_.LayoutConstraints_left_get)
13608 top = property(_core_.LayoutConstraints_top_get)
13609 right = property(_core_.LayoutConstraints_right_get)
13610 bottom = property(_core_.LayoutConstraints_bottom_get)
13611 width = property(_core_.LayoutConstraints_width_get)
13612 height = property(_core_.LayoutConstraints_height_get)
13613 centreX = property(_core_.LayoutConstraints_centreX_get)
13614 centreY = property(_core_.LayoutConstraints_centreY_get)
554f62e9 13615 def __init__(self, *args, **kwargs):
d55e5bfc 13616 """__init__(self) -> LayoutConstraints"""
554f62e9
RD		 13617 _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
13618 __swig_destroy__ = _core_.delete_LayoutConstraints
13619 __del__ = lambda self : None;
d55e5bfc
RD		 13620 def SatisfyConstraints(*args, **kwargs):
13621 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13622 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13623
13624 def AreSatisfied(*args, **kwargs):
13625 """AreSatisfied(self) -> bool"""
13626 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13627
2131d850 13628_core_.LayoutConstraints_swigregister(LayoutConstraints)
d55e5bfc
RD		 13629
13630#----------------------------------------------------------------------------
13631
13632# Use Python's bool constants if available, make some if not
13633try:
13634 True
13635except NameError:
13636 __builtins__.True = 1==1
13637 __builtins__.False = 1==0
13638 def bool(value): return not not value
13639 __builtins__.bool = bool
13640
13641
13642
13643# workarounds for bad wxRTTI names
13644__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13645__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13646__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13647
13648
13649#----------------------------------------------------------------------------
13650# Load version numbers from __version__... Ensure that major and minor
0f63ec68 13651# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD		 13652
13653from __version__ import *
13654__version__ = VERSION_STRING
13655
0f63ec68
RD		 13656assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13657assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD		 13658if RELEASE_VERSION != _core_.RELEASE_VERSION:
13659 import warnings
0f63ec68 13660 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc 13661
f9bf356b
RD		 13662
13663def version():
13664 """Returns a string containing version and port info"""
13665 ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
13666 if wx.Platform == '__WXMSW__':
13667 port = 'msw'
13668 elif wx.Platform == '__WXMAC__':
13669 port = 'mac'
13670 elif wx.Platform == '__WXGTK__':
13671 port = 'gtk'
13672 if 'gtk2' in wx.PlatformInfo:
13673 port = 'gtk2'
13674 else:
13675 port = '?'
13676
13677 return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
13678
13679
d55e5bfc
RD		 13680#----------------------------------------------------------------------------
13681
70b7a5fe
RD		 13682# Set wxPython's default string<-->unicode conversion encoding from
13683# the locale, but only if Python's default hasn't been changed. (We
13684# assume that if the user has customized it already then that is the
13685# encoding we need to use as well.)
13686#
13687# The encoding selected here is used when string or unicode objects
13688# need to be converted in order to pass them to wxWidgets. Please be
13689# aware that the default encoding within the same locale may be
13690# slightly different on different platforms. For example, please see
62d32a5f
RD		 13691# http://www.alanwood.net/demos/charsetdiffs.html for differences
13692# between the common latin/roman encodings.
396fb509
RD		 13693
13694default = _sys.getdefaultencoding()
13695if default == 'ascii':
13696 import locale
13697 import codecs
13698 try:
13699 default = locale.getdefaultlocale()[1]
13700 codecs.lookup(default)
70b7a5fe 13701 except (ValueError, LookupError, TypeError):
396fb509
RD		 13702 default = _sys.getdefaultencoding()
13703 del locale
13704 del codecs
5cbf236d
RD		 13705if default:
13706 wx.SetDefaultPyEncoding(default)
13707del default
5cbf236d
RD		 13708
13709#----------------------------------------------------------------------------
13710
d55e5bfc
RD		 13711class PyDeadObjectError(AttributeError):
13712 pass
13713
13714class _wxPyDeadObject(object):
13715 """
13716 Instances of wx objects that are OOR capable will have their __class__
13717 changed to this class when the C++ object is deleted. This should help
13718 prevent crashes due to referencing a bogus C++ pointer.
13719 """
13720 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13721 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13722
13723 def __repr__(self):
13724 if not hasattr(self, "_name"):
13725 self._name = "[unknown]"
13726 return self.reprStr % self._name
13727
13728 def __getattr__(self, *args):
13729 if not hasattr(self, "_name"):
13730 self._name = "[unknown]"
13731 raise PyDeadObjectError(self.attrStr % self._name)
13732
13733 def __nonzero__(self):
13734 return 0
13735
13736
13737
13738class PyUnbornObjectError(AttributeError):
13739 pass
13740
13741class _wxPyUnbornObject(object):
13742 """
13743 Some stock objects are created when the wx._core module is
13744 imported, but their C++ instance is not created until the wx.App
13745 object is created and initialized. These object instances will
13746 temporarily have their __class__ changed to this class so an
13747 exception will be raised if they are used before the C++ instance
13748 is ready.
13749 """
13750
13751 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13752 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13753
13754 def __repr__(self):
13755 #if not hasattr(self, "_name"):
13756 # self._name = "[unknown]"
13757 return self.reprStr #% self._name
13758
13759 def __getattr__(self, *args):
13760 #if not hasattr(self, "_name"):
13761 # self._name = "[unknown]"
13762 raise PyUnbornObjectError(self.attrStr) # % self._name )
13763
13764 def __nonzero__(self):
13765 return 0
13766
13767
13768#----------------------------------------------------------------------------
d55e5bfc
RD		 13769
13770def CallAfter(callable, *args, **kw):
13771 """
13772 Call the specified function after the current and pending event
13773 handlers have been completed. This is also good for making GUI
0439c23b
RD		 13774 method calls from non-GUI threads. Any extra positional or
13775 keyword args are passed on to the callable when it is called.
13776
846c181b 13777 :see: `wx.CallLater`
d55e5bfc
RD		 13778 """
13779 app = wx.GetApp()
a001823c 13780 assert app is not None, 'No wx.App created yet'
d55e5bfc 13781
891bb194
RD		 13782 if not hasattr(app, "_CallAfterId"):
13783 app._CallAfterId = wx.NewEventType()
13784 app.Connect(-1, -1, app._CallAfterId,
13785 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 13786 evt = wx.PyEvent()
891bb194 13787 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD		 13788 evt.callable = callable
13789 evt.args = args
13790 evt.kw = kw
13791 wx.PostEvent(app, evt)
13792
d55e5bfc
RD		 13793#----------------------------------------------------------------------------
13794
13795
846c181b 13796class CallLater:
d55e5bfc 13797 """
8ac8dba0 13798 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD		 13799 object once after the given amount of milliseconds, passing any
13800 positional or keyword args. The return value of the callable is
0439c23b 13801 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD		 13802
13803 If you don't need to get the return value or restart the timer
13804 then there is no need to hold a reference to this object. It will
13805 hold a reference to itself while the timer is running (the timer
13806 has a reference to self.Notify) but the cycle will be broken when
846c181b 13807 the timer completes, automatically cleaning up the wx.CallLater
d55e5bfc 13808 object.
0439c23b
RD		 13809
13810 :see: `wx.CallAfter`
d55e5bfc
RD		 13811 """
13812 def __init__(self, millis, callable, *args, **kwargs):
13813 self.millis = millis
13814 self.callable = callable
13815 self.SetArgs(*args, **kwargs)
13816 self.runCount = 0
13817 self.running = False
13818 self.hasRun = False
13819 self.result = None
13820 self.timer = None
13821 self.Start()
13822
13823 def __del__(self):
13824 self.Stop()
13825
13826
13827 def Start(self, millis=None, *args, **kwargs):
13828 """
13829 (Re)start the timer
13830 """
13831 self.hasRun = False
13832 if millis is not None:
13833 self.millis = millis
13834 if args or kwargs:
13835 self.SetArgs(*args, **kwargs)
13836 self.Stop()
13837 self.timer = wx.PyTimer(self.Notify)
13838 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13839 self.running = True
13840 Restart = Start
13841
13842
13843 def Stop(self):
13844 """
13845 Stop and destroy the timer.
13846 """
13847 if self.timer is not None:
13848 self.timer.Stop()
13849 self.timer = None
13850
13851
13852 def GetInterval(self):
13853 if self.timer is not None:
13854 return self.timer.GetInterval()
13855 else:
13856 return 0
13857
13858
13859 def IsRunning(self):
13860 return self.timer is not None and self.timer.IsRunning()
13861
13862
13863 def SetArgs(self, *args, **kwargs):
13864 """
13865 (Re)set the args passed to the callable object. This is
13866 useful in conjunction with Restart if you want to schedule a
13867 new call to the same callable object but with different
13868 parameters.
13869 """
13870 self.args = args
13871 self.kwargs = kwargs
13872
13873
13874 def HasRun(self):
13875 return self.hasRun
13876
13877 def GetResult(self):
13878 return self.result
13879
13880 def Notify(self):
13881 """
13882 The timer has expired so call the callable.
13883 """
13884 if self.callable and getattr(self.callable, 'im_self', True):
13885 self.runCount += 1
13886 self.running = False
13887 self.result = self.callable(*self.args, **self.kwargs)
13888 self.hasRun = True
13889 if not self.running:
13890 # if it wasn't restarted, then cleanup
13891 wx.CallAfter(self.Stop)
13892
97ab0f6a
RD		 13893 Interval = property(GetInterval)
13894 Result = property(GetResult)
d55e5bfc
RD		 13895
13896
846c181b
RD		 13897class FutureCall(CallLater):
13898 """A compatibility alias for `CallLater`."""
13899
d55e5bfc
RD		 13900#----------------------------------------------------------------------------
13901# Control which items in this module should be documented by epydoc.
13902# We allow only classes and functions, which will help reduce the size
13903# of the docs by filtering out the zillions of constants, EVT objects,
13904# and etc that don't make much sense by themselves, but are instead
13905# documented (or will be) as part of the classes/functions/methods
13906# where they should be used.
13907
c24da6d6
RD		 13908class __DocFilter:
13909 """
13910 A filter for epydoc that only allows non-Ptr classes and
0f83f5da 13911 functions, in order to reduce the clutter in the API docs.
c24da6d6
RD		 13912 """
13913 def __init__(self, globals):
13914 self._globals = globals
13915
13916 def __call__(self, name):
13917 import types
13918 obj = self._globals.get(name, None)
0f83f5da
RD		 13919
13920 # only document classes and function
c24da6d6
RD		 13921 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13922 return False
0f83f5da
RD		 13923
13924 # skip other things that are private or will be documented as part of somethign else
554f62e9 13925 if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
c24da6d6 13926 return False
0f83f5da
RD		 13927
13928 # skip functions that are duplicates of static functions in a class
13929 if name.find('_') != -1:
13930 cls = self._globals.get(name.split('_')[0], None)
13931 methname = name.split('_')[1]
13932 if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
13933 return False
13934
c24da6d6 13935 return True
d55e5bfc
RD		 13936
13937#----------------------------------------------------------------------------
13938#----------------------------------------------------------------------------
13939
13940# Import other modules in this package that should show up in the
13941# "core" wx namespace
13942from _gdi import *
13943from _windows import *
13944from _controls import *
13945from _misc import *
13946
d55e5bfc
RD		 13947#----------------------------------------------------------------------------
13948#----------------------------------------------------------------------------
13949
13950
7449af73 13951
wxWidgets (Impactor)